Struct vega_lite_4::SpecEncodingBuilder

pub struct SpecEncodingBuilder { /* private fields */ }

Builder for SpecEncoding.

Implementations

impl SpecEncodingBuilder

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

Rotation angle of point and text marks.

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

Color of the marks – either fill or stroke color based on the filled property of mark definition. By default, color represents fill color for "area", "bar", "tick", "text", "trail", "circle", and "square" / stroke color for "line" and "point".

Default value: If undefined, the default color depends on mark config’s color property.

Note: 1) For fine-grained control over both fill and stroke colors of the marks, please use the fill and stroke channels. The fill or stroke encodings have higher precedence than color, thus may override the color encoding if conflicting encodings are specified. 2) See the scale documentation for more information about customizing color scheme.

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

A field definition for the horizontal facet of trellis plots.

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

A text description of this mark for ARIA accessibility (SVG output only). For SVG output the "aria-label" attribute will be set to this description.

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

Additional levels of detail for grouping data in aggregate views and in line, trail, and area marks without mapping data to a specific visual channel.

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

A field definition for the (flexible) facet of trellis plots.

If either row or column is specified, this channel will be ignored.

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

Fill color of the marks. Default value: If undefined, the default color depends on mark config’s color property.

Note: The fill encoding has higher precedence than color, thus may override the color encoding if conflicting encodings are specified.

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

Fill opacity of the marks.

Default value: If undefined, the default opacity depends on mark config’s fillOpacity property.

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

A URL to load upon mouse click.

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

A data field to use as a unique key for data binding. When a visualization’s data is updated, the key value will be used to match data elements to existing mark instances. Use a key channel to enable object constancy for transitions over dynamic data.

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

Latitude position of geographically projected marks.

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

Latitude-2 position for geographically projected ranged "area", "bar", "rect", and "rule".

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

Longitude position of geographically projected marks.

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

Longitude-2 position for geographically projected ranged "area", "bar", "rect", and "rule".

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

Opacity of the marks.

Default value: If undefined, the default opacity depends on mark config’s opacity property.

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

Order of the marks. - For stacked marks, this order channel encodes stack order. - For line and trail marks, this order channel encodes order of data points in the lines. This can be useful for creating a connected scatterplot. Setting order to {"value": null} makes the line marks use the original order in the data sources. - Otherwise, this order channel encodes layer order of the marks.

Note: In aggregate plots, order field should be aggregated to avoid creating additional aggregation grouping.

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

The outer radius in pixels of arc marks.

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

The inner radius in pixels of arc marks.

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

A field definition for the vertical facet of trellis plots.

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

Shape of the mark.

1. For point marks the supported values include: - plotting shapes: "circle", "square", "cross", "diamond", "triangle-up", "triangle-down", "triangle-right", or "triangle-left". - the line symbol "stroke" - centered directional shapes "arrow", "wedge", or "triangle" - a custom SVG path string (For correct sizing, custom shape paths should be defined within a square bounding box with coordinates ranging from -1 to 1 along both the x and y dimensions.)

2. For geoshape marks it should be a field definition of the geojson data

Default value: If undefined, the default shape depends on mark config’s shape property. ("circle" if unset.)

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

Size of the mark. - For "point", "square" and "circle", – the symbol size, or pixel area of the mark. - For "bar" and "tick" – the bar and tick’s size. - For "text" – the text’s font size. - Size is unsupported for "line", "area", and "rect". (Use "trail" instead of line with varying size)

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

Stroke color of the marks. Default value: If undefined, the default color depends on mark config’s color property.

Note: The stroke encoding has higher precedence than color, thus may override the color encoding if conflicting encodings are specified.

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

Stroke dash of the marks.

Default value: [1,0] (No dash).

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

Stroke opacity of the marks.

Default value: If undefined, the default opacity depends on mark config’s strokeOpacity property.

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

Stroke width of the marks.

Default value: If undefined, the default stroke width depends on mark config’s strokeWidth property.

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

Text of the text mark.

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

• For arc marks, the arc length in radians if theta2 is not specified, otherwise the start arc angle. (A value of 0 indicates up or “north”, increasing values proceed clockwise.)

• For text marks, polar coordinate angle in radians.

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

The end angle of arc marks in radians. A value of 0 indicates up or “north”, increasing values proceed clockwise.

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

The tooltip text to show upon mouse hover. Specifying tooltip encoding overrides the tooltip property in the mark definition.

See the tooltip documentation for a detailed discussion about tooltip in Vega-Lite.

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

The URL of an image mark.

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

X coordinates of the marks, or width of horizontal "bar" and "area" without specified x2 or width.

The value of this channel can be a number or a string "width" for the width of the plot.

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

X2 coordinates for ranged "area", "bar", "rect", and "rule".

The value of this channel can be a number or a string "width" for the width of the plot.

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

Error value of x coordinates for error specified "errorbar" and "errorband".

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

Secondary error value of x coordinates for error specified "errorbar" and "errorband".

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

Y coordinates of the marks, or height of vertical "bar" and "area" without specified y2 or height.

The value of this channel can be a number or a string "height" for the height of the plot.

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

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

The value of this channel can be a number or a string "height" for the height of the plot.

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

Error value of y coordinates for error specified "errorbar" and "errorband".

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

Secondary error value of y coordinates for error specified "errorbar" and "errorband".

pub fn build(&self) -> Result<SpecEncoding, SpecEncodingBuilderError>

Builds a new SpecEncoding.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for SpecEncodingBuilder

fn clone(&self) -> SpecEncodingBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SpecEncodingBuilder

fn default() -> Self

Returns the “default value” for a type.