Struct vega_lite_3::SpecBuilder

pub struct SpecBuilder { /* fields omitted */ }

Builder for Spec.

Methods

impl SpecBuilder

pub fn align<VALUE: Into<AlignUnion>>(&mut self, value: VALUE) -> &mut Self

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

pub fn bounds<VALUE: Into<BoundsEnum>>(&mut self, value: VALUE) -> &mut Self

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"

pub fn center<VALUE: Into<VegaliteCenter>>(&mut self, value: VALUE) -> &mut Self

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

pub fn columns<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

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

pub fn data<VALUE: Into<RemovableValue<UrlData>>>(
    &mut self,
    value: VALUE
) -> &mut Self

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.

pub fn description<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Description of this mark for commenting purpose.

pub fn encoding<VALUE: Into<Encoding>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn height<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn mark<VALUE: Into<AnyMark>>(&mut self, value: VALUE) -> &mut Self

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

pub fn name<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Name of the visualization for later reference.

pub fn projection<VALUE: Into<Projection>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn resolve<VALUE: Into<Resolve>>(&mut self, value: VALUE) -> &mut Self

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

pub fn selection<VALUE: Into<HashMap<String, SelectionDef>>>(
    &mut self,
    value: VALUE
) -> &mut Self

A key-value mapping between selection names and definitions.

pub fn spacing<VALUE: Into<Spacing>>(&mut self, value: VALUE) -> &mut Self

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

pub fn title<VALUE: Into<Title>>(&mut self, value: VALUE) -> &mut Self

Title for the plot.

pub fn transform<VALUE: Into<Vec<Transform>>>(
    &mut self,
    value: VALUE
) -> &mut Self

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

pub fn view<VALUE: Into<ViewBackground>>(&mut self, value: VALUE) -> &mut Self

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

Default value: none (transparent)

pub fn width<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn layer<VALUE: Into<Vec<LayerSpec>>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn facet<VALUE: Into<Facet>>(&mut self, value: VALUE) -> &mut Self

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

pub fn spec<VALUE: Into<SpecClass>>(&mut self, value: VALUE) -> &mut Self

A specification of the view that gets faceted.

A specification of the view that gets repeated.

pub fn repeat<VALUE: Into<RepeatUnion>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn concat<VALUE: Into<Vec<Spec>>>(&mut self, value: VALUE) -> &mut Self

A list of views to be concatenated.

pub fn vconcat<VALUE: Into<Vec<Spec>>>(&mut self, value: VALUE) -> &mut Self

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

pub fn hconcat<VALUE: Into<Vec<Spec>>>(&mut self, value: VALUE) -> &mut Self

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

pub fn build(&self) -> Result<Spec, String>

Builds a new Spec.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for SpecBuilder

fn clone(&self) -> SpecBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SpecBuilder

fn default() -> SpecBuilder

Returns the "default value" for a type.