Struct vega_lite_4::LegendConfigBuilder

pub struct LegendConfigBuilder { /* fields omitted */ }

Builder for LegendConfig.

Implementations

impl LegendConfigBuilder

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

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

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

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

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

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

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

The direction of the legend, one of "vertical" or "horizontal".

Default value: - For top-/bottom-oriented legends, "horizontal" - For left-/right-oriented legends, "vertical" - For top/bottom-left/right-oriented legends, "horizontal" for gradient legends and "vertical" for symbol legends.

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

Disable legend by default

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

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

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

Max legend length for a horizontal gradient when config.legend.gradientLength is undefined.

Default value: 200

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

Min legend length for a horizontal gradient when config.legend.gradientLength is undefined.

Default value: 100

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

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

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

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

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

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

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

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

Max legend length for a vertical gradient when config.legend.gradientLength is undefined.

Default value: 200

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

Min legend length for a vertical gradient when config.legend.gradientLength is undefined.

Default value: 100

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

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

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

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

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

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

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

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

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

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

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

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

The strategy to use for resolving overlap of labels in gradient legends. If false, no overlap reduction is attempted. If set to true or "parity", a strategy of removing every other label is used. If set to "greedy", a linear scan of the labels is performed, removing any label that overlaps with the last visible label (this often works better for log-scaled axes).

Default value: "greedy" for log scales otherwise true`.

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

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

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

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

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

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

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

The orientation of the legend, which determines how the legend is positioned within the scene. One of "left", "right", "top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right", "none".

Default value: "right"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Set to null to disable title for the axis, legend, or header.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The opacity of unselected legend entries.

Default value: 0.35.

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

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

Builds a new LegendConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for LegendConfigBuilder

pub fn clone(&self) -> LegendConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for LegendConfigBuilder

pub fn default() -> LegendConfigBuilder

Returns the "default value" for a type.