Struct vega_lite::Config

source ·
pub struct Config {
Show 40 fields pub area: Option<AreaConfig>, pub autosize: Option<Autosize>, pub axis: Option<AxisConfig>, pub axis_band: Option<VgAxisConfig>, pub axis_bottom: Option<VgAxisConfig>, pub axis_left: Option<VgAxisConfig>, pub axis_right: Option<VgAxisConfig>, pub axis_top: Option<VgAxisConfig>, pub axis_x: Option<VgAxisConfig>, pub axis_y: Option<VgAxisConfig>, pub background: Option<String>, pub bar: Option<BarConfig>, pub circle: Option<MarkConfig>, pub count_title: Option<String>, pub datasets: Option<HashMap<String, InlineDatasetValue>>, pub field_title: Option<FieldTitle>, pub geoshape: Option<MarkConfig>, pub header: Option<HeaderConfig>, pub invalid_values: Option<InvalidValues>, pub legend: Option<LegendConfig>, pub line: Option<LineConfig>, pub mark: Option<MarkConfig>, pub number_format: Option<String>, pub padding: Option<Padding>, pub point: Option<MarkConfig>, pub projection: Option<ProjectionConfig>, pub range: Option<HashMap<String, ConfigRange>>, pub rect: Option<MarkConfig>, pub rule: Option<MarkConfig>, pub scale: Option<ScaleConfig>, pub selection: Option<SelectionConfig>, pub square: Option<MarkConfig>, pub stack: Option<StackOffset>, pub style: Option<HashMap<String, VgMarkConfig>>, pub text: Option<TextConfig>, pub tick: Option<TickConfig>, pub time_format: Option<String>, pub title: Option<VgTitleConfig>, pub trail: Option<LineConfig>, pub view: Option<ViewConfig>,
}
Expand description

Vega-Lite configuration object. This property can only be defined at the top-level of a specification.

Fields§

§area: Option<AreaConfig>

Area-Specific Config

§autosize: Option<Autosize>

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don’t use rangeStep.

Default value: pad

§axis: Option<AxisConfig>

Axis configuration, which determines default properties for all x and y axes. For a full list of axis configuration options, please see the corresponding section of the axis documentation.

§axis_band: Option<VgAxisConfig>

Specific axis config for axes with “band” scales.

§axis_bottom: Option<VgAxisConfig>

Specific axis config for x-axis along the bottom edge of the chart.

§axis_left: Option<VgAxisConfig>

Specific axis config for y-axis along the left edge of the chart.

§axis_right: Option<VgAxisConfig>

Specific axis config for y-axis along the right edge of the chart.

§axis_top: Option<VgAxisConfig>

Specific axis config for x-axis along the top edge of the chart.

§axis_x: Option<VgAxisConfig>

X-axis specific config.

§axis_y: Option<VgAxisConfig>

Y-axis specific config.

§background: Option<String>

CSS color property to use as the background of visualization.

Default value: none (transparent)

§bar: Option<BarConfig>

Bar-Specific Config

§circle: Option<MarkConfig>

Circle-Specific Config

§count_title: Option<String>

Default axis and legend title for count fields.

Default value: 'Number of Records'.

§datasets: Option<HashMap<String, InlineDatasetValue>>

A global data store for named datasets. This is a mapping from names to inline datasets. This can be an array of objects or primitive values or a string. Arrays of primitive values are ingested as objects with a data property.

§field_title: Option<FieldTitle>

Defines how Vega-Lite generates title for fields. There are three possible styles:

  • "verbal" (Default) - displays function in a verbal style (e.g., “Sum of field”, “Year-month of date”, “field (binned)”).
  • "function" - displays function using parentheses and capitalized texts (e.g., “SUM(field)”, “YEARMONTH(date)”, “BIN(field)”).
  • "plain" - displays only the field name without functions (e.g., “field”, “date”, “field”).
§geoshape: Option<MarkConfig>

Geoshape-Specific Config

§header: Option<HeaderConfig>

Header configuration, which determines default properties for all header. For a full list of header configuration options, please see the corresponding section of in the header documentation.

§invalid_values: Option<InvalidValues>

Defines how Vega-Lite should handle invalid values (null and NaN).

  • If set to "filter" (default), all data items with null values will be skipped (for line, trail, and area marks) or filtered (for other marks).
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
§legend: Option<LegendConfig>

Legend configuration, which determines default properties for all legends. For a full list of legend configuration options, please see the corresponding section of in the legend documentation.

§line: Option<LineConfig>

Line-Specific Config

§mark: Option<MarkConfig>

Mark Config

§number_format: Option<String>

D3 Number format for axis labels and text tables. For example “s” for SI units. Use D3’s number format pattern.

§padding: Option<Padding>

The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides. If an object, the value should have the format {"left": 5, "top": 5, "right": 5, "bottom": 5} to specify padding for each side of the visualization.

Default value: 5

§point: Option<MarkConfig>

Point-Specific Config

§projection: Option<ProjectionConfig>

Projection configuration, which determines default properties for all projections. For a full list of projection configuration options, please see the corresponding section of the projection documentation.

§range: Option<HashMap<String, ConfigRange>>

An object hash that defines default range arrays or schemes for using with scales. For a full list of scale range configuration options, please see the corresponding section of the scale documentation.

§rect: Option<MarkConfig>

Rect-Specific Config

§rule: Option<MarkConfig>

Rule-Specific Config

§scale: Option<ScaleConfig>

Scale configuration determines default properties for all scales. For a full list of scale configuration options, please see the corresponding section of the scale documentation.

§selection: Option<SelectionConfig>

An object hash for defining default properties for each type of selections.

§square: Option<MarkConfig>

Square-Specific Config

§stack: Option<StackOffset>

Default stack offset for stackable mark.

§style: Option<HashMap<String, VgMarkConfig>>

An object hash that defines key-value mappings to determine default properties for marks with a given style. The keys represent styles names; the values have to be valid mark configuration objects.

§text: Option<TextConfig>

Text-Specific Config

§tick: Option<TickConfig>

Tick-Specific Config

§time_format: Option<String>

Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use D3’s time format pattern.

Default value: '' (The format will be automatically determined).

§title: Option<VgTitleConfig>

Title configuration, which determines default properties for all titles. For a full list of title configuration options, please see the corresponding section of the title documentation.

§trail: Option<LineConfig>

Trail-Specific Config

§view: Option<ViewConfig>

Default properties for single view plots.

Trait Implementations§

Formats the value using the given formatter. Read more
Deserialize this value from the given Serde deserializer. Read more
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.