Struct vega_lite_4::LayerElementBuilder

pub struct LayerElementBuilder { /* private fields */ }

Builder for LayerElement.

Implementations

impl LayerElementBuilder

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<LayerEncoding>>( &mut self, value: VALUE ) -> &mut Self

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.

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.

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.

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

Name of the visualization for later reference.

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

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.

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

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

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

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.

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 selection<VALUE: Into<HashMap<String, SelectionDef>>>( &mut self, value: VALUE ) -> &mut Self

A key-value mapping between selection names and definitions.

pub fn build(&self) -> Result<LayerElement, LayerElementBuilderError>

Builds a new LayerElement.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for LayerElementBuilder

fn clone(&self) -> LayerElementBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for LayerElementBuilder

fn default() -> Self

Returns the “default value” for a type.