Struct vega_lite_3::DefWithConditionMarkPropFieldDefStringNull

pub struct DefWithConditionMarkPropFieldDefStringNull {
    pub aggregate: Option<Aggregate>,
    pub bin: Option<PurpleBin>,
    pub condition: Option<ColorCondition>,
    pub field: Option<Field>,
    pub legend: RemovableValue<Legend>,
    pub scale: RemovableValue<Scale>,
    pub sort: RemovableValue<Sort>,
    pub time_unit: Option<TimeUnit>,
    pub title: RemovableValue<String>,
    pub def_with_condition_mark_prop_field_def_string_null_type: Option<StandardType>,
    pub value: Option<String>,
}

Color of the marks – either fill or stroke color based on the filled property of mark definition. By default, color represents fill color for "area", "bar", "tick", "text", "trail", "circle", and "square" / stroke color for "line" and "point".

Default value: If undefined, the default color depends on mark config's color property.

Note:

1. For fine-grained control over both fill and stroke colors of the marks, please use the fill and stroke channels. If either fill or stroke channel is specified, color channel will be ignored.
2. See the scale documentation for more information about customizing color scheme.

Fill color of the marks. Default value: If undefined, the default color depends on mark config's color property.

Note: When using fill channel, color channel will be ignored. To customize both fill and stroke, please use fill and stroke channels (not fill and color).

Stroke color of the marks. Default value: If undefined, the default color depends on mark config's color property.

Note: When using stroke channel, color channel will be ignored. To customize both stroke and fill, please use stroke and fill channels (not stroke and color).

A FieldDef with Condition { condition: {value: ...}, field: ..., ... }

A ValueDef with Condition<ValueDef | FieldDef> where either the condition or the value are optional. { condition: {field: ...} | {value: ...}, value: ..., }

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<PurpleBin>

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.

condition: Option<ColorCondition>

One or more value definition(s) with a selection or a test predicate.

Note: A field definition's condition property can only contain conditional value definitions since Vega-Lite only allows at most one encoded field per encoding channel.

A field definition or one or more value definition(s) with a selection predicate.

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.

legend: RemovableValue<Legend>

An object defining properties of the legend. If null, the legend for the encoding channel will be removed.

Default value: If undefined, default legend properties are applied.

See also: legend documentation.

scale: RemovableValue<Scale>

An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels.

If null, the scale will be disabled and the data value will be directly encoded.

Default value: If undefined, default scale properties are applied.

See also: scale documentation.

sort: RemovableValue<Sort>

Sort order for the encoded field.

For continuous fields (quantitative or temporal), sort can be either "ascending" or "descending".

For discrete fields, sort can be one of the following:

• "ascending" or "descending" -- for sorting by the values' natural order in Javascript.
• A sort-by-encoding definition for sorting by another encoding channel. (This type of sort definition is not available for row and column channels.)
• A sort field definition for sorting by another field.
• An array specifying the field values in preferred order. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be date-time definition objects. In addition, for time units "month" and "day", the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., "Mon", "Tue").
• null indicating no sort.

Default value: "ascending"

Note: null is not supported for row and column.

See also: sort documentation.

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<String>

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.

def_with_condition_mark_prop_field_def_string_null_type: Option<StandardType>

The encoded field's type of measurement ("quantitative", "temporal", "ordinal", or "nominal"). It can also be a "geojson" type for encoding 'geoshape'.

Note:

• Data values for a temporal field can be either a date-time string (e.g., "2015-03-07 12:32:17", "17:01", "2015-03-16". "2015") or a timestamp number (e.g., 1552199579097).
• Data type describes the semantics of the data rather than the primitive data types (number, string, etc.). The same primitive data type can have different types of measurement. For example, numeric data can represent quantitative, ordinal, or nominal data.
• When using with bin, the type property can be either "quantitative" (for using a linear bin scale) or "ordinal" (for using an ordinal bin scale).
• When using with timeUnit, the type property can be either "temporal" (for using a temporal scale) or "ordinal" (for using an ordinal scale).
• When using with aggregate, the type property refers to the post-aggregation data type. For example, we can calculate count distinct of a categorical field "cat" using {"aggregate": "distinct", "field": "cat", "type": "quantitative"}. The "type" of the aggregate output is "quantitative".
• Secondary channels (e.g., x2, y2, xError, yError) do not have type as they have exactly the same type as their primary channels (e.g., x, y).

See also: type documentation.

value: Option<String>

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

Trait Implementations

impl Clone for DefWithConditionMarkPropFieldDefStringNull

fn clone(&self) -> DefWithConditionMarkPropFieldDefStringNull

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DefWithConditionMarkPropFieldDefStringNull

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

Formats the value using the given formatter.

impl Default for DefWithConditionMarkPropFieldDefStringNull

fn default() -> DefWithConditionMarkPropFieldDefStringNull

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for DefWithConditionMarkPropFieldDefStringNull

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

Deserialize this value from the given Serde deserializer.

impl Serialize for DefWithConditionMarkPropFieldDefStringNull

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

Serialize this value into the given Serde serializer.