Struct vega_lite::Vegalite

pub struct Vegalite {

    pub schema: Option<String>,
    pub autosize: Option<Autosize>,
    pub background: Option<String>,
    pub config: Option<Config>,
    pub data: Option<Data>,
    pub datasets: Option<HashMap<String, InlineDatasetValue>>,
    pub description: Option<String>,
    pub encoding: Option<Encoding>,
    pub height: Option<f64>,
    pub mark: Option<AnyMark>,
    pub name: Option<String>,
    pub padding: Option<Padding>,
    pub projection: Option<Projection>,
    pub selection: Option<HashMap<String, SelectionDef>>,
    pub title: Option<Title>,
    pub transform: Option<Vec<Transform>>,
    pub width: Option<f64>,
    pub align: Option<Align>,
    pub bounds: Option<Bounds>,
    pub center: Option<Center>,
    pub facet: Option<FacetMapping>,
    pub resolve: Option<Resolve>,
    pub spacing: Option<Spacing>,
    pub spec: Box<Option<SpecClass>>,
    pub layer: Option<Vec<LayerSpec>>,
    pub repeat: Option<Repeat>,
    pub vconcat: Option<Vec<Spec>>,
    pub hconcat: Option<Vec<Spec>>,
}

Fields

schema: Option<String>

URL to JSON schema for a Vega-Lite specification. Unless you have a reason to change this, use https://vega.github.io/schema/vega-lite/v2.json. Setting the $schema property allows automatic validation and autocomplete in editors that support JSON schema.

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

background: Option<String>

CSS color property to use as the background of visualization.

Default value: none (transparent)

config: Option<Config>

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

data: Option<Data>

An object describing the data source

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.

description: Option<String>

Description of this mark for commenting purpose.

encoding: Option<Encoding>

A key-value mapping between encoding channels and definition of fields.

A shared key-value mapping between encoding channels and definition of fields in the underlying layers.

height: Option<f64>

The height of a visualization.

Default value:

• If a view’s autosize type is "fit" or its y-channel has a continuous scale, the height will be the value of config.view.height.
• For y-axis with a band or point scale: if rangeStep is a numeric value or unspecified, the height is determined by the range step, paddings, and the cardinality of the field mapped to y-channel. Otherwise, if the rangeStep is null, the height will be the value of config.view.height.
• If no field is mapped to y channel, the height will be the value of rangeStep.

Note: For plots with row and column channels, this represents the height of a single view.

See also: The documentation for width and height contains more examples.

mark: Option<AnyMark>

A string describing the mark type (one of "bar", "circle", "square", "tick", "line", "area", "point", "rule", "geoshape", and "text") or a mark definition object.

name: Option<String>

Name of the visualization for later reference.

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

projection: Option<Projection>

An object defining properties of geographic projection, which will be applied to shape path for "geoshape" marks and to latitude and "longitude" channels for other marks.

An object defining properties of the geographic projection shared by underlying layers.

selection: Option<HashMap<String, SelectionDef>>

A key-value mapping between selection names and definitions.

title: Option<Title>

Title for the plot.

transform: Option<Vec<Transform>>

An array of data transformations such as filter and new field calculation.

width: Option<f64>

The width of a visualization.

Default value: This will be determined by the following rules:

• If a view’s autosize type is "fit" or its x-channel has a continuous scale, the width will be the value of config.view.width.
• For x-axis with a band or point scale: if rangeStep is a numeric value or unspecified, the width is determined by the range step, paddings, and the cardinality of the field mapped to x-channel. Otherwise, if the rangeStep is null, the width will be the value of config.view.width.
• If no field is mapped to x channel, the width will be the value of config.scale.textXRangeStep for text mark and the value of rangeStep for other marks.

Note: For plots with row and column channels, this represents the width of a single view.

See also: The documentation for width and height contains more examples.

align: Option<Align>

The alignment to apply to grid rows and columns. The supported string values are "all", "each", and "none".

• For "none", a flow layout will be used, in which adjacent subviews are simply placed one after the other.
• For "each", subviews will be aligned into a clean grid structure, but each row or column may be of variable size.
• For "all", subviews will be aligned and each row or column will be sized identically based on the maximum observed size. String values for this property will be applied to both grid rows and columns.

Alternatively, an object value of the form {"row": string, "column": string} can be used to supply different alignments for rows and columns.

Default value: "all".

bounds: Option<Bounds>

The bounds calculation method to use for determining the extent of a sub-plot. One of full (the default) or flush.

• If set to full, the entire calculated bounds (including axes, title, and legend) will be used.
• If set to flush, only the specified width and height values for the sub-view will be used. The flush setting can be useful when attempting to place sub-plots without axes or legends into a uniform grid structure.

Default value: "full"

center: Option<Center>

Boolean flag indicating if subviews should be centered relative to their respective rows or columns.

An object value of the form {"row": boolean, "column": boolean} can be used to supply different centering values for rows and columns.

Default value: false

Boolean flag indicating if subviews should be centered relative to their respective rows or columns.

Default value: false

facet: Option<FacetMapping>

An object that describes mappings between row and column channels and their field definitions.

resolve: Option<Resolve>

Scale, axis, and legend resolutions for facets.

Scale, axis, and legend resolutions for layers.

Scale and legend resolutions for repeated charts.

Scale, axis, and legend resolutions for vertically concatenated charts.

Scale, axis, and legend resolutions for horizontally concatenated charts.

spacing: Option<Spacing>

The spacing in pixels between sub-views of the composition operator. An object of the form {"row": number, "column": number} can be used to set different spacing values for rows and columns.

Default value: 10

The spacing in pixels between sub-views of the concat operator.

Default value: 10

spec: Box<Option<SpecClass>>

A specification of the view that gets faceted.

layer: Option<Vec<LayerSpec>>

Layer or single view specifications to be layered.

Note: Specifications inside layer cannot use row and column channels as layering facet specifications is not allowed.

repeat: Option<Repeat>

An object that describes what fields should be repeated into views that are laid out as a row or column.

vconcat: Option<Vec<Spec>>

A list of views that should be concatenated and put into a column.

hconcat: Option<Vec<Spec>>

A list of views that should be concatenated and put into a row.

Trait Implementations

impl Debug for Vegalite

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Vegalite

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Vegalite

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

Serialize this value into the given Serde serializer.