[][src]Struct vega_lite_3::Config

pub struct Config {
    pub area: Option<AreaConfig>,
    pub autosize: Option<Autosize>,
    pub axis: Option<AxisConfig>,
    pub axis_band: Option<AxisConfig>,
    pub axis_bottom: Option<AxisConfig>,
    pub axis_left: Option<AxisConfig>,
    pub axis_right: Option<AxisConfig>,
    pub axis_top: Option<AxisConfig>,
    pub axis_x: Option<AxisConfig>,
    pub axis_y: Option<AxisConfig>,
    pub background: Option<String>,
    pub bar: Option<RectConfig>,
    pub boxplot: Option<BoxPlotConfig>,
    pub circle: Option<MarkConfig>,
    pub concat: Option<CompositionConfig>,
    pub count_title: Option<String>,
    pub errorband: Option<ErrorBandConfig>,
    pub errorbar: Option<ErrorBarConfig>,
    pub facet: Option<CompositionConfig>,
    pub field_title: Option<FieldTitle>,
    pub geoshape: Option<MarkConfig>,
    pub header: Option<HeaderConfig>,
    pub header_column: Option<HeaderConfig>,
    pub header_facet: Option<HeaderConfig>,
    pub header_row: Option<HeaderConfig>,
    pub invalid_values: RemovableValue<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<Projection>,
    pub range: Option<HashMap<String, RangeValue>>,
    pub rect: Option<RectConfig>,
    pub repeat: Option<CompositionConfig>,
    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, BaseMarkConfig>>,
    pub text: Option<TextConfig>,
    pub tick: Option<TickConfig>,
    pub time_format: Option<String>,
    pub title: Option<BaseTitleConfig>,
    pub trail: Option<LineConfig>,
    pub view: Option<ViewConfig>,
}

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

Specific axis config for axes with "band" scales.

axis_bottom: Option<AxisConfig>

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

axis_left: Option<AxisConfig>

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

axis_right: Option<AxisConfig>

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

axis_top: Option<AxisConfig>

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

axis_x: Option<AxisConfig>

X-axis specific config.

axis_y: Option<AxisConfig>

Y-axis specific config.

background: Option<String>

CSS color property to use as the background of the whole Vega-Lite view

Default value: none (transparent)

bar: Option<RectConfig>

Bar-Specific Config

boxplot: Option<BoxPlotConfig>

Box Config

circle: Option<MarkConfig>

Circle-Specific Config

concat: Option<CompositionConfig>

Default configuration for all concatenation view composition operators (concat, hconcat, and vconcat)

count_title: Option<String>

Default axis and legend title for count fields.

Default value: 'Count of Records.

errorband: Option<ErrorBandConfig>

ErrorBand Config

errorbar: Option<ErrorBarConfig>

ErrorBar Config

facet: Option<CompositionConfig>

Default configuration for the facet view composition operator

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 headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

header_column: Option<HeaderConfig>

Header configuration, which determines default properties for column headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

header_facet: Option<HeaderConfig>

Header configuration, which determines default properties for non-row/column facet headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

header_row: Option<HeaderConfig>

Header configuration, which determines default properties for row headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

invalid_values: RemovableValue<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 guide labels and text marks. 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<Projection>

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, RangeValue>>

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

Rect-Specific Config

repeat: Option<CompositionConfig>

Default configuration for the repeat view composition operator

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, BaseMarkConfig>>

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 time format for raw time values (without time units) in text marks, legend labels and header labels.

Default value: "%b %d, %Y" Note: Axes automatically determine format each label automatically so this config would not affect axes.

title: Option<BaseTitleConfig>

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

impl Clone for Config[src]

impl Debug for Config[src]

impl Default for Config[src]

impl<'de> Deserialize<'de> for Config[src]

impl Serialize for Config[src]

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: Deserialize<'de>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.