Struct vega_lite_4::Y2Class

pub struct Y2Class {
    pub aggregate: Option<Aggregate>,
    pub bin: Option<Value>,
    pub field: Option<Field>,
    pub time_unit: Option<TimeUnit>,
    pub title: RemovableValue<PurpleText>,
    pub value: Option<YUnion>,
}

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

The value of this channel can be a number or a string "height" for the height of the plot.

A field definition of a secondary channel that shares a scale with another primary channel. For example, x2, xError and xError2 share the same scale with x.

Definition object for a constant value (primitive value or gradient definition) of an encoding channel.

Fields

aggregate: Option<Aggregate>

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

Default value: undefined (None)

See also: aggregate documentation.

bin: Option<Value>

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.

field: Option<Field>

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.

time_unit: Option<TimeUnit>

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.

title: RemovableValue<PurpleText>

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.

value: Option<YUnion>

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

Trait Implementations

impl Clone for Y2Class

fn clone(&self) -> Y2Class

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Y2Class

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Y2Class

fn default() -> Y2Class

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Y2Class

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Y2Class

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.