Struct vega_lite_4::SpecClass

pub struct SpecClass {
    pub data: RemovableValue<UrlData>,
    pub description: Option<String>,
    pub encoding: Option<Encoding>,
    pub height: Option<HeightUnion>,
    pub layer: Option<Vec<LayerSpec>>,
    pub name: Option<String>,
    pub projection: Option<Projection>,
    pub resolve: Option<Resolve>,
    pub title: Option<Text>,
    pub transform: Option<Vec<Transform>>,
    pub view: Option<ViewBackground>,
    pub width: Option<HeightUnion>,
    pub bounds: Option<BoundsEnum>,
    pub mark: Option<AnyMark>,
    pub selection: Option<HashMap<String, SelectionDef>>,
    pub align: Option<AlignUnion>,
    pub center: Option<VegaliteCenter>,
    pub columns: Option<f64>,
    pub facet: Option<Facet>,
    pub spacing: Option<Spacing>,
    pub spec: Option<Box<SpecClass>>,
    pub repeat: Option<RepeatUnion>,
    pub concat: Option<Vec<Spec>>,
    pub vconcat: Option<Vec<Spec>>,
    pub hconcat: Option<Vec<Spec>>,
}

A specification of the view that gets faceted.

A full layered plot specification, which may contains encoding and projection properties that will be applied to underlying unit (single-view) specifications.

Unit spec that can have a composite mark and row or column channels (shorthand for a facet spec).

A specification of the view that gets repeated.

Any specification in Vega-Lite.

Base interface for a facet specification.

Base interface for a repeat specification.

Base interface for a generalized concatenation specification.

Base interface for a vertical concatenation specification.

Base interface for a horizontal concatenation specification.

Fields

data: RemovableValue<UrlData>

An object describing the data source. Set to null to ignore the parent's data source. If no data is set, it is derived from the parent.

description: Option<String>

Description of this mark for commenting purpose.

encoding: Option<Encoding>

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

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

height: Option<HeightUnion>

The height of a visualization.

• For a plot with a continuous y-field, height should be a number.
• For a plot with either a discrete y-field or no y-field, height can be either a number indicating a fixed height or an object in the form of {step: number} defining the height per discrete step. (No y-field is equivalent to having one discrete step.)
• To enable responsive sizing on height, it should be set to "container".

Default value: Based on config.view.continuousHeight for a plot with a continuous y-field and config.view.discreteHeight otherwise.

Note: For plots with row and column channels, this represents the height of a single view and the "container" option cannot be used.

See also: height documentation.

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. Instead, use the facet operator and place a layer inside a facet.

name: Option<String>

Name of the visualization for later reference.

projection: Option<Projection>

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

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.

resolve: Option<Resolve>

Scale, axis, and legend resolutions for view composition specifications.

title: Option<Text>

Title for the plot.

transform: Option<Vec<Transform>>

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

view: Option<ViewBackground>

An object defining the view background's fill and stroke.

Default value: none (transparent)

width: Option<HeightUnion>

The width of a visualization.

• For a plot with a continuous x-field, width should be a number.
• For a plot with either a discrete x-field or no x-field, width can be either a number indicating a fixed width or an object in the form of {step: number} defining the width per discrete step. (No x-field is equivalent to having one discrete step.)
• To enable responsive sizing on width, it should be set to "container".

Default value: Based on config.view.continuousWidth for a plot with a continuous x-field and config.view.discreteWidth otherwise.

Note: For plots with row and column channels, this represents the width of a single view and the "container" option cannot be used.

See also: width documentation.

bounds: Option<BoundsEnum>

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"

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.

selection: Option<HashMap<String, SelectionDef>>

A key-value mapping between selection names and definitions.

align: Option<AlignUnion>

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

center: Option<VegaliteCenter>

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

columns: Option<f64>

The number of columns to include in the view composition layout.

Default value: undefined -- An infinite number of columns (a single row) will be assumed. This is equivalent to hconcat (for concat) and to using the column channel (for facet and repeat).

Note:

1. This property is only for:

• the general (wrappable) concat operator (not hconcat/vconcat)
• the facet and repeat operator with one field/repetition definition (without row/column nesting)

2. Setting the columns to 1 is equivalent to vconcat (for concat) and to using the row channel (for facet and repeat).

facet: Option<Facet>

Definition for how to facet the data. One of:

1. a field definition for faceting the plot by one field
2. An object that maps row and column channels to their field definitions

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: Depends on "spacing" property of the view composition configuration (20 by default)

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

Default value: 10

spec: Option<Box<SpecClass>>

A specification of the view that gets faceted.

A specification of the view that gets repeated.

repeat: Option<RepeatUnion>

Definition for fields to be repeated. One of:

1. An array of fields to be repeated. If "repeat" is an array, the field can be referred using {"repeat": "repeat"}
2. An object that mapped "row" and/or "column" to the listed of fields to be repeated along the particular orientations. The objects {"repeat": "row"} and {"repeat": "column"} can be used to refer to the repeated field respectively.

concat: Option<Vec<Spec>>

A list of views to be concatenated.

vconcat: Option<Vec<Spec>>

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

hconcat: Option<Vec<Spec>>

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

Trait Implementations

impl Clone for SpecClass

fn clone(&self) -> SpecClass

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpecClass

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

Formats the value using the given formatter.

impl Default for SpecClass

fn default() -> SpecClass

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for SpecClass

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

Deserialize this value from the given Serde deserializer.

impl Serialize for SpecClass

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

Serialize this value into the given Serde serializer.