[−][src]Struct vega_lite_4::LegendConfig

pub struct LegendConfig {
    pub aria: Option<Aria>,
    pub clip_height: Option<CornerRadiusUnion>,
    pub column_padding: Option<CornerRadiusUnion>,
    pub columns: Option<CornerRadiusUnion>,
    pub corner_radius: Option<CornerRadiusUnion>,
    pub description: Option<Color>,
    pub direction: Option<Orientation>,
    pub disable: Option<bool>,
    pub fill_color: Option<Color>,
    pub gradient_direction: Option<Direction>,
    pub gradient_horizontal_max_length: Option<f64>,
    pub gradient_horizontal_min_length: Option<f64>,
    pub gradient_label_limit: Option<CornerRadiusUnion>,
    pub gradient_label_offset: Option<CornerRadiusUnion>,
    pub gradient_length: Option<FontSize>,
    pub gradient_opacity: Option<CornerRadiusUnion>,
    pub gradient_stroke_color: Option<Color>,
    pub gradient_stroke_width: Option<FontSize>,
    pub gradient_thickness: Option<FontSize>,
    pub gradient_vertical_max_length: Option<f64>,
    pub gradient_vertical_min_length: Option<f64>,
    pub grid_align: Option<GridAlign>,
    pub label_align: Option<TitleAlignUnion>,
    pub label_baseline: Option<TextBaseline>,
    pub label_color: Option<Color>,
    pub label_font: Option<Color>,
    pub label_font_size: Option<FontSize>,
    pub label_font_style: Option<Color>,
    pub label_font_weight: Option<FontWeightUnion>,
    pub label_limit: Option<CornerRadiusUnion>,
    pub label_offset: Option<CornerRadiusUnion>,
    pub label_opacity: Option<CornerRadiusUnion>,
    pub label_overlap: Option<LabelOverlapUnion>,
    pub label_padding: Option<CornerRadiusUnion>,
    pub label_separation: Option<CornerRadiusUnion>,
    pub layout: Option<BackgroundExprRef>,
    pub legend_x: Option<CornerRadiusUnion>,
    pub legend_y: Option<CornerRadiusUnion>,
    pub offset: Option<CornerRadiusUnion>,
    pub orient: Option<LegendOrient>,
    pub padding: Option<CornerRadiusUnion>,
    pub row_padding: Option<CornerRadiusUnion>,
    pub stroke_color: Option<Color>,
    pub stroke_dash: Option<StrokeDashUnion>,
    pub stroke_width: Option<CornerRadiusUnion>,
    pub symbol_base_fill_color: Option<Color>,
    pub symbol_base_stroke_color: Option<Color>,
    pub symbol_dash: Option<StrokeDashUnion>,
    pub symbol_dash_offset: Option<CornerRadiusUnion>,
    pub symbol_direction: Option<Direction>,
    pub symbol_fill_color: Option<Color>,
    pub symbol_limit: Option<CornerRadiusUnion>,
    pub symbol_offset: Option<CornerRadiusUnion>,
    pub symbol_opacity: Option<CornerRadiusUnion>,
    pub symbol_size: Option<FontSize>,
    pub symbol_stroke_color: Option<Color>,
    pub symbol_stroke_width: Option<FontSize>,
    pub symbol_type: Option<Color>,
    pub tick_count: Option<TickCount>,
    pub title: RemovableValue<Value>,
    pub title_align: Option<TitleAlignUnion>,
    pub title_anchor: Option<TitleAnchorUnion>,
    pub title_baseline: Option<TextBaseline>,
    pub title_color: Option<Color>,
    pub title_font: Option<Color>,
    pub title_font_size: Option<CornerRadiusUnion>,
    pub title_font_style: Option<Color>,
    pub title_font_weight: Option<FontWeightUnion>,
    pub title_limit: Option<FontSize>,
    pub title_line_height: Option<CornerRadiusUnion>,
    pub title_opacity: Option<CornerRadiusUnion>,
    pub title_orient: Option<TitleOrientUnion>,
    pub title_padding: Option<CornerRadiusUnion>,
    pub unselected_opacity: Option<f64>,
    pub zindex: Option<FontSize>,
}

Legend configuration, which determines default properties for all legends. For a full list of legend configuration options, please see the corresponding section of in the legend documentation.

Fields

aria: Option<Aria>clip_height: Option<CornerRadiusUnion>column_padding: Option<CornerRadiusUnion>columns: Option<CornerRadiusUnion>corner_radius: Option<CornerRadiusUnion>description: Option<Color>direction: Option<Orientation>

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.

disable: Option<bool>

Disable legend by default

fill_color: Option<Color>gradient_direction: Option<Direction>gradient_horizontal_max_length: Option<f64>

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

Default value: 200

gradient_horizontal_min_length: Option<f64>

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

Default value: 100

gradient_label_limit: Option<CornerRadiusUnion>gradient_label_offset: Option<CornerRadiusUnion>gradient_length: Option<FontSize>gradient_opacity: Option<CornerRadiusUnion>gradient_stroke_color: Option<Color>gradient_stroke_width: Option<FontSize>gradient_thickness: Option<FontSize>gradient_vertical_max_length: Option<f64>

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

Default value: 200

gradient_vertical_min_length: Option<f64>

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

Default value: 100

grid_align: Option<GridAlign>label_align: Option<TitleAlignUnion>label_baseline: Option<TextBaseline>label_color: Option<Color>label_font: Option<Color>label_font_size: Option<FontSize>label_font_style: Option<Color>label_font_weight: Option<FontWeightUnion>label_limit: Option<CornerRadiusUnion>label_offset: Option<CornerRadiusUnion>label_opacity: Option<CornerRadiusUnion>label_overlap: Option<LabelOverlapUnion>

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`.

label_padding: Option<CornerRadiusUnion>label_separation: Option<CornerRadiusUnion>layout: Option<BackgroundExprRef>legend_x: Option<CornerRadiusUnion>legend_y: Option<CornerRadiusUnion>offset: Option<CornerRadiusUnion>orient: Option<LegendOrient>

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"

padding: Option<CornerRadiusUnion>row_padding: Option<CornerRadiusUnion>stroke_color: Option<Color>stroke_dash: Option<StrokeDashUnion>stroke_width: Option<CornerRadiusUnion>symbol_base_fill_color: Option<Color>symbol_base_stroke_color: Option<Color>symbol_dash: Option<StrokeDashUnion>symbol_dash_offset: Option<CornerRadiusUnion>symbol_direction: Option<Direction>symbol_fill_color: Option<Color>symbol_limit: Option<CornerRadiusUnion>symbol_offset: Option<CornerRadiusUnion>symbol_opacity: Option<CornerRadiusUnion>symbol_size: Option<FontSize>symbol_stroke_color: Option<Color>symbol_stroke_width: Option<FontSize>symbol_type: Option<Color>tick_count: Option<TickCount>title: RemovableValue<Value>

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

title_align: Option<TitleAlignUnion>title_anchor: Option<TitleAnchorUnion>title_baseline: Option<TextBaseline>title_color: Option<Color>title_font: Option<Color>title_font_size: Option<CornerRadiusUnion>title_font_style: Option<Color>title_font_weight: Option<FontWeightUnion>title_limit: Option<FontSize>title_line_height: Option<CornerRadiusUnion>title_opacity: Option<CornerRadiusUnion>title_orient: Option<TitleOrientUnion>title_padding: Option<CornerRadiusUnion>unselected_opacity: Option<f64>

The opacity of unselected legend entries.

Default value: 0.35.

zindex: Option<FontSize>

Trait Implementations

impl Clone for LegendConfig[src]

impl Debug for LegendConfig[src]

impl Default for LegendConfig[src]

impl<'de> Deserialize<'de> for LegendConfig[src]

impl Serialize for LegendConfig[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.