Struct vega_lite_4::LegendBuilder
source · pub struct LegendBuilder { /* private fields */ }
Expand description
Builder for Legend
.
Implementations§
source§impl LegendBuilder
impl LegendBuilder
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<Box<Color>>>( &mut self, value: VALUE ) -> &mut Self
sourcepub fn direction<VALUE: Into<Orientation>>(&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-orient
ed legends, "horizontal"
- For
left-/right-orient
ed legends, "vertical"
- For top/bottom-left/right-orient
ed
legends, "horizontal"
for gradient legends and "vertical"
for symbol legends.
pub fn fill_color<VALUE: Into<Box<Color>>>(&mut self, value: VALUE) -> &mut Self
sourcepub fn format<VALUE: Into<Format>>(&mut self, value: VALUE) -> &mut Self
pub fn format<VALUE: Into<Format>>(&mut self, value: VALUE) -> &mut Self
When used with the default "number"
and "time"
format type, the text formatting
pattern for labels of guides (axes, legends, headers) and text marks.
- If the format type is
"number"
(e.g., for quantitative fields), this is D3’s number format pattern. - If the format type is"time"
(e.g., for temporal fields), this is D3’s time format pattern.
See the format documentation for more examples.
When used with a custom
formatType
, this
value will be passed as format
alongside datum.value
to the registered function.
Default value: Derived from numberFormat config for number format and from timeFormat config for time format.
sourcepub fn format_type<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
pub fn format_type<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
The format type for labels. One of "number"
, "time"
, or a registered custom format
type.
Default value: - "time"
for temporal fields and ordinal and nominal fields with
timeUnit
. - "number"
for quantitative fields as well as ordinal and nominal fields
without timeUnit
.
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<Box<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 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<Box<Color>>>( &mut self, value: VALUE ) -> &mut Self
sourcepub fn label_expr<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
pub fn label_expr<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
Vega expression for customizing labels.
Note: The label text and value can be assessed via the label
and value
properties
of the legend’s backing datum
object.
pub fn label_font<VALUE: Into<Box<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<Box<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
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 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
sourcepub fn orient<VALUE: Into<LegendOrient>>(&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<Box<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_fill_color<VALUE: Into<Box<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<Box<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<Box<Color>>>( &mut self, value: VALUE ) -> &mut Self
pub fn tick_count<VALUE: Into<TickCount>>(&mut self, value: VALUE) -> &mut Self
sourcepub fn tick_min_step<VALUE: Into<CornerRadiusUnion>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn tick_min_step<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
The minimum desired step between legend ticks, in terms of scale domain values. For
example, a value of 1
indicates that ticks should not be less than 1 unit apart. If
tickMinStep
is specified, the tickCount
value will be adjusted, if necessary, to
enforce the minimum step value.
Default value: undefined
sourcepub fn title<VALUE: Into<RemovableValue<LegendText>>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn title<VALUE: Into<RemovableValue<LegendText>>>( &mut self, value: VALUE ) -> &mut Self
A title for the field. If null
, the title will be removed.
Default value: derived from the field’s name and transformation function
(aggregate
, bin
and timeUnit
). If the field has an aggregate function, the function
is displayed as part of the title (e.g., "Sum of Profit"
). If the field is binned or
has a time unit applied, the applied function is shown in parentheses (e.g., "Profit (binned)"
, "Transaction Date (year-month)"
). Otherwise, the title is simply the field
name.
Notes:
-
You can customize the default field title format by providing the
fieldTitle
property in the config orfieldTitle
function via thecompile
function’s options. -
If both field definition’s
title
and axis, header, or legendtitle
are defined, axis/header/legend title will be used.
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<Box<Color>>>( &mut self, value: VALUE ) -> &mut Self
pub fn title_font<VALUE: Into<Box<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<Box<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
sourcepub fn legend_type<VALUE: Into<LegendType>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn legend_type<VALUE: Into<LegendType>>( &mut self, value: VALUE ) -> &mut Self
The type of the legend. Use "symbol"
to create a discrete legend and "gradient"
for a
continuous color gradient.
Default value: "gradient"
for non-binned quantitative fields and temporal fields;
"symbol"
otherwise.
sourcepub fn values<VALUE: Into<Values>>(&mut self, value: VALUE) -> &mut Self
pub fn values<VALUE: Into<Values>>(&mut self, value: VALUE) -> &mut Self
Explicitly set the visible legend values.
Trait Implementations§
source§impl Clone for LegendBuilder
impl Clone for LegendBuilder
source§fn clone(&self) -> LegendBuilder
fn clone(&self) -> LegendBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more