Struct vega_lite_4::YError2ClassBuilder

pub struct YError2ClassBuilder { /* private fields */ }

Builder for YError2Class.

Implementations

impl YError2ClassBuilder

pub fn aggregate<VALUE: Into<Aggregate>>(&mut self, value: VALUE) -> &mut Self

Aggregation function for the field (e.g., "mean", "sum", "median", "min", "max", "count").

Default value: undefined (None)

See also: aggregate documentation.

pub fn band<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

For rect-based marks (rect, bar, and image), mark size relative to bandwidth of band scales, bins or time units. If set to 1, the mark size is set to the bandwidth, the bin interval, or the time unit interval. If set to 0.5, the mark size is half of the bandwidth or the time unit interval.

For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to 0, the marks will be positioned at the beginning of the band. If set to 0.5, the marks will be positioned in the middle of the band.

pub fn bin<VALUE: Into<Value>>(&mut self, value: VALUE) -> &mut Self

A flag for binning a quantitative field, an object defining binning parameters, or indicating that the data for x or y channel are binned before they are imported into Vega-Lite ("binned").

• If true, default binning parameters will be applied.

• If "binned", this indicates that the data for the x (or y) channel are already binned. You can map the bin-start field to x (or y) and the bin-end field to x2 (or y2). The scale and axis will be formatted similar to binning in Vega-Lite. To adjust the axis ticks based on the bin step, you can also set the axis’s tickMinStep property.

Default value: false

See also: bin documentation.

pub fn field<VALUE: Into<Field>>(&mut self, value: VALUE) -> &mut Self

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

See also: field documentation.

Notes: 1) Dots (.) and brackets ([ and ]) can be used to access nested objects (e.g., "field": "foo.bar" and "field": "foo['bar']"). If field names contain dots or brackets but are not nested, you can use \\ to escape dots and brackets (e.g., "a\\.b" and "a\\[0\\]"). See more details about escaping in the field documentation. 2) field is not required if aggregate is count.

pub fn time_unit<VALUE: Into<TimeUnitUnion>>( &mut self, value: VALUE ) -> &mut Self

Time unit (e.g., year, yearmonth, month, hours) for a temporal field. or a temporal field that gets casted as ordinal.

Default value: undefined (None)

See also: timeUnit documentation.

pub fn title<VALUE: Into<RemovableValue<LegendText>>>( &mut self, value: VALUE ) -> &mut Self

A title for the field. If null, the title will be removed.

Default value: derived from the field’s name and transformation function (aggregate, bin and timeUnit). If the field has an aggregate function, the function is displayed as part of the title (e.g., "Sum of Profit"). If the field is binned or has a time unit applied, the applied function is shown in parentheses (e.g., "Profit (binned)", "Transaction Date (year-month)"). Otherwise, the title is simply the field name.

Notes:

1. You can customize the default field title format by providing the fieldTitle property in the config or fieldTitle function via the compile function’s options.

2. If both field definition’s title and axis, header, or legend title are defined, axis/header/legend title will be used.

pub fn value<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

A constant value in visual domain (e.g., "red" / "#0099ff" / gradient definition for color, values between 0 to 1 for opacity).

pub fn build(&self) -> Result<YError2Class, YError2ClassBuilderError>

Builds a new YError2Class.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for YError2ClassBuilder

fn clone(&self) -> YError2ClassBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for YError2ClassBuilder

fn default() -> Self

Returns the “default value” for a type.