Struct vega_lite_3::ScaleConfigBuilder

pub struct ScaleConfigBuilder { /* fields omitted */ }

Builder for ScaleConfig.

Methods

impl ScaleConfigBuilder

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

Default inner padding for x and y band-ordinal scales.

Default value:

• barBandPaddingInner for bar marks (0.1 by default)
• rectBandPaddingInner for rect and other marks (0 by default)

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

Default outer padding for x and y band-ordinal scales.

Default value: paddingInner/2 (which makes _width/height = number of unique values

• step_)

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

Default inner padding for x and y band-ordinal scales of "bar" marks.

Default value: 0.1

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

Default outer padding for x and y band-ordinal scales of "bar" marks. If not specified, by default, band scale's paddingOuter is paddingInner/2.

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

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

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

Default padding for continuous scales.

Default: 5 for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; 0 otherwise.

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

The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's rangeStep - 1.

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

The default max value for mapping quantitative fields to text's size/fontSize.

Default value: 40

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

Default max opacity for mapping a field to opacity.

Default value: 0.8

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

Default max value for point size scale.

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

Default max strokeWidth for the scale of strokeWidth for rule and line marks and of size for trail marks.

Default value: 4

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

The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

Default value: 2

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

The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

Default value: 8

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

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

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

Default minimum value for point size scale with zero=false.

Default value: 9

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

Default minimum strokeWidth for the scale of strokeWidth for rule and line marks and of size for trail marks with zero=false.

Default value: 1

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

Default outer padding for x and y point-ordinal scales.

Default value: 0.5 (which makes width/height = number of unique values * step)

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

Default range cardinality for quantile scale.

Default value: 4

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

Default range cardinality for quantize scale.

Default value: 4

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

Default range step for band and point scales of (1) the y channel and (2) the x channel when the mark is not text.

Default value: 20

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

Default inner padding for x and y band-ordinal scales of "rect" marks.

Default value: 0

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

Default outer padding for x and y band-ordinal scales of "rect" marks. If not specified, by default, band scale's paddingOuter is paddingInner/2.

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

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. (Only available for x, y, and size scales.)

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

Default range step for x band and point scales of text marks.

Default value: 90

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

Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting domain to "unaggregate" for aggregated quantitative fields by default.

This property only works with aggregate functions that produce values within the raw data domain ("mean", "average", "median", "q1", "q3", "min", "max"). For other aggregations that produce values outside of the raw data domain (e.g. "count", "sum"), this property is ignored.

Default value: false

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

Builds a new ScaleConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ScaleConfigBuilder

fn clone(&self) -> ScaleConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ScaleConfigBuilder

fn default() -> ScaleConfigBuilder

Returns the "default value" for a type.