Struct vega_lite_4::NormalizedSpecSpecBuilder

source ·

pub struct NormalizedSpecSpecBuilder { /* private fields */ }

Expand description

Builder for NormalizedSpecSpec.

Implementations§

source §

impl NormalizedSpecSpecBuilder

source

pub fn align<VALUE: Into<Box<VegaliteAlign>>>( &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".

source

pub fn bounds<VALUE: Into<Box<Bounds>>>(&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"

source

pub fn center<VALUE: Into<Box<Center>>>(&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

source

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.

source

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

Description of this mark for commenting purpose.

source

pub fn encoding<VALUE: Into<SpecEncoding>>(&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.

source

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

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.

Deprecated: Please avoid using width in a unit spec that’s a part of a layer spec.

source

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.

source

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

Name of the visualization for later reference.

source

pub fn projection<VALUE: Into<Box<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.

source

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

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

source

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

A key-value mapping between selection names and definitions.

source

pub fn spacing<VALUE: Into<Box<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

source

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

Title for the plot.

source

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.

source

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

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

Default value: none (transparent)

Deprecated: Please avoid using width in a unit spec that’s a part of a layer spec.

source

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

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.

Deprecated: Please avoid using width in a unit spec that’s a part of a layer spec.

source

pub fn layer<VALUE: Into<Vec<LayerElement>>>( &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.

source

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:

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)
Setting the columns to 1 is equivalent to vconcat (for concat) and to using the row channel (for facet and repeat).

source

pub fn repeat<VALUE: Into<Box<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 to as {"repeat": "repeat"}. The repeated views are laid out in a wrapped row. You can set the number of columns to control the wrapping. 2) An object that maps "row" and/or "column" to the listed 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.

source