Struct vega_lite_3::LayerSpecBuilder

pub struct LayerSpecBuilder { /* fields omitted */ }

Builder for LayerSpec.

Methods

impl LayerSpecBuilder

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

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

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 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<LayerSpec, String>

Builds a new LayerSpec.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for LayerSpecBuilder

fn clone(&self) -> LayerSpecBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for LayerSpecBuilder

fn default() -> LayerSpecBuilder

Returns the "default value" for a type.