Struct vega_lite_4::MarkConfigBuilder
source · pub struct MarkConfigBuilder { /* private fields */ }
Expand description
Builder for MarkConfig
.
Implementations§
source§impl MarkConfigBuilder
impl MarkConfigBuilder
sourcepub fn align<VALUE: Into<TitleAlignUnion>>(&mut self, value: VALUE) -> &mut Self
pub fn align<VALUE: Into<TitleAlignUnion>>(&mut self, value: VALUE) -> &mut Self
The horizontal alignment of the text or ranged marks (area, bar, image, rect, rule). One
of "left"
, "right"
, "center"
.
Note: Expression reference is not supported for range marks.
pub fn angle<VALUE: Into<Angle>>(&mut self, value: VALUE) -> &mut Self
pub fn aria<VALUE: Into<Aria>>(&mut self, value: VALUE) -> &mut Self
pub fn aria_role<VALUE: Into<Box<Color>>>(&mut self, value: VALUE) -> &mut Self
pub fn aria_role_description<VALUE: Into<Box<Color>>>( &mut self, value: VALUE ) -> &mut Self
pub fn aspect<VALUE: Into<Aria>>(&mut self, value: VALUE) -> &mut Self
sourcepub fn baseline<VALUE: Into<TextBaseline>>(&mut self, value: VALUE) -> &mut Self
pub fn baseline<VALUE: Into<TextBaseline>>(&mut self, value: VALUE) -> &mut Self
For text marks, the vertical text baseline. One of "alphabetic"
(default), "top"
,
"middle"
, "bottom"
, "line-top"
, "line-bottom"
, or an expression reference that
provides one of the valid values. The "line-top"
and "line-bottom"
values operate
similarly to "top"
and "bottom"
, but are calculated relative to the lineHeight
rather than fontSize
alone.
For range marks, the vertical alignment of the marks. One of "top"
, "middle"
,
"bottom"
.
Note: Expression reference is not supported for range marks.
pub fn blend<VALUE: Into<BlendUnion>>(&mut self, value: VALUE) -> &mut Self
sourcepub fn color<VALUE: Into<MarkConfigExprOrSignalRefColor>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn color<VALUE: Into<MarkConfigExprOrSignalRefColor>>( &mut self, value: VALUE ) -> &mut Self
Default color.
Default value: ■ "#4682b4"
Note: - This property cannot be used in a style
config. - The fill
and
stroke
properties have higher precedence than color
and will override color
.
pub fn corner_radius<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn corner_radius_bottom_left<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn corner_radius_bottom_right<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn corner_radius_top_left<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn corner_radius_top_right<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn cursor<VALUE: Into<CursorUnion>>(&mut self, value: VALUE) -> &mut Self
pub fn description<VALUE: Into<Box<Color>>>( &mut self, value: VALUE ) -> &mut Self
pub fn dir<VALUE: Into<Dir>>(&mut self, value: VALUE) -> &mut Self
pub fn dx<VALUE: Into<CornerRadiusUnion>>(&mut self, value: VALUE) -> &mut Self
pub fn dy<VALUE: Into<CornerRadiusUnion>>(&mut self, value: VALUE) -> &mut Self
pub fn ellipsis<VALUE: Into<Box<Color>>>(&mut self, value: VALUE) -> &mut Self
pub fn end_angle<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
sourcepub fn fill<VALUE: Into<MarkConfigExprOrSignalRefFill>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn fill<VALUE: Into<MarkConfigExprOrSignalRefFill>>( &mut self, value: VALUE ) -> &mut Self
Default fill color. This property has higher precedence than config.color
. Set to
null
to remove fill.
Default value: (None)
sourcepub fn filled<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self
pub fn filled<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self
Whether the mark’s color should be used as fill color instead of stroke color.
Default value: false
for all point
, line
, and rule
marks as well as
geoshape
marks for
graticule
data sources;
otherwise, true
.
Note: This property cannot be used in a style config.
pub fn fill_opacity<VALUE: Into<Opacity>>(&mut self, value: VALUE) -> &mut Self
pub fn font<VALUE: Into<Box<Color>>>(&mut self, value: VALUE) -> &mut Self
pub fn font_size<VALUE: Into<FontSize>>(&mut self, value: VALUE) -> &mut Self
pub fn font_style<VALUE: Into<Box<Color>>>(&mut self, value: VALUE) -> &mut Self
pub fn font_weight<VALUE: Into<FontWeightUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn height<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn href<VALUE: Into<Box<Color>>>(&mut self, value: VALUE) -> &mut Self
sourcepub fn inner_radius<VALUE: Into<CornerRadiusUnion>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn inner_radius<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
The inner radius in pixels of arc marks. innerRadius
is an alias for radius2
.
pub fn interpolate<VALUE: Into<MarkConfigExprOrSignalRefInterpolate>>( &mut self, value: VALUE ) -> &mut Self
sourcepub fn invalid<VALUE: Into<RemovableValue<Invalid>>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn invalid<VALUE: Into<RemovableValue<Invalid>>>( &mut self, value: VALUE ) -> &mut Self
Defines how Vega-Lite should handle marks for invalid values (null
and NaN
). - If set
to "filter"
(default), all data items with null values will be skipped (for line,
trail, and area marks) or filtered (for other marks). - If null
, all data items are
included. In this case, invalid values will be interpreted as zeroes.
pub fn limit<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn line_break<VALUE: Into<Box<Color>>>(&mut self, value: VALUE) -> &mut Self
pub fn line_height<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
sourcepub fn opacity<VALUE: Into<CornerRadiusUnion>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn opacity<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
The overall opacity (value between [0,1]).
Default value: 0.7
for non-aggregate plots with point
, tick
, circle
, or
square
marks or layered bar
charts and 1
otherwise.
sourcepub fn order<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self
pub fn order<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self
For line and trail marks, this order
property can be set to null
or false
to make
the lines use the original order in the data sources.
sourcepub fn orient<VALUE: Into<Orientation>>(&mut self, value: VALUE) -> &mut Self
pub fn orient<VALUE: Into<Orientation>>(&mut self, value: VALUE) -> &mut Self
The orientation of a non-stacked bar, tick, area, and line charts. The value is either
horizontal (default) or vertical. - For bar, rule and tick, this determines whether the
size of the bar and tick should be applied to x or y dimension. - For area, this property
determines the orient property of the Vega output. - For line and trail marks, this
property determines the sort order of the points in the line if config.sortLineBy
is
not specified. For stacked charts, this is always determined by the orientation of the
stack; therefore explicitly specified value will be ignored.
sourcepub fn outer_radius<VALUE: Into<CornerRadiusUnion>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn outer_radius<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
The outer radius in pixels of arc marks. outerRadius
is an alias for radius
.
pub fn pad_angle<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
sourcepub fn radius<VALUE: Into<CornerRadiusUnion>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn radius<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
For arc mark, the primary (outer) radius in pixels.
For text marks, polar coordinate radial offset, in pixels, of the text from the origin
determined by the x
and y
properties.
sourcepub fn radius2<VALUE: Into<CornerRadiusUnion>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn radius2<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
The secondary (inner) radius in pixels of arc marks.
pub fn shape<VALUE: Into<Box<Color>>>(&mut self, value: VALUE) -> &mut Self
sourcepub fn size<VALUE: Into<CornerRadiusUnion>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn size<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
Default size for marks. - For point
/circle
/square
, this represents the pixel area
of the marks. Note that this value sets the area of the symbol; the side lengths will
increase with the square root of this value. - For bar
, this represents the band size
of the bar, in pixels. - For text
, this represents the font size, in pixels.
Default value: - 30
for point, circle, square marks; width/height’s step
- 2
for bar marks with discrete dimensions; - 5
for bar marks with continuous dimensions; -
11
for text marks.
pub fn smooth<VALUE: Into<Aria>>(&mut self, value: VALUE) -> &mut Self
pub fn start_angle<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
sourcepub fn stroke<VALUE: Into<MarkConfigExprOrSignalRefFill>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn stroke<VALUE: Into<MarkConfigExprOrSignalRefFill>>( &mut self, value: VALUE ) -> &mut Self
Default stroke color. This property has higher precedence than config.color
. Set to
null
to remove stroke.
Default value: (None)
pub fn stroke_cap<VALUE: Into<Cap>>(&mut self, value: VALUE) -> &mut Self
pub fn stroke_dash<VALUE: Into<StrokeDashUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn stroke_dash_offset<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn stroke_join<VALUE: Into<StrokeJoinUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn stroke_miter_limit<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn stroke_offset<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn stroke_opacity<VALUE: Into<Opacity>>( &mut self, value: VALUE ) -> &mut Self
pub fn stroke_width<VALUE: Into<FontSize>>(&mut self, value: VALUE) -> &mut Self
pub fn tension<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
pub fn text<VALUE: Into<ConditionalPredicateValueDefTextExprRefText>>( &mut self, value: VALUE ) -> &mut Self
sourcepub fn theta<VALUE: Into<CornerRadiusUnion>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn theta<VALUE: Into<CornerRadiusUnion>>( &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.
sourcepub fn theta2<VALUE: Into<CornerRadiusUnion>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn theta2<VALUE: Into<CornerRadiusUnion>>( &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.
sourcepub fn time_unit_band<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
pub fn time_unit_band<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
Default relative band size for a time unit. If set to 1
, the bandwidth of the marks
will be equal to the time unit band step. If set to 0.5
, bandwidth of the marks will be
half of the time unit band step.
sourcepub fn time_unit_band_position<VALUE: Into<f64>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn time_unit_band_position<VALUE: Into<f64>>( &mut self, value: VALUE ) -> &mut Self
Default relative band position for a time unit. If set to 0
, the marks will be
positioned at the beginning of the time unit band step. If set to 0.5
, the marks will
be positioned in the middle of the time unit band step.
sourcepub fn tooltip<VALUE: Into<MarkConfigExprOrSignalRefTooltip>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn tooltip<VALUE: Into<MarkConfigExprOrSignalRefTooltip>>( &mut self, value: VALUE ) -> &mut Self
The tooltip text string to show upon mouse hover or an object defining which fields should the tooltip be derived from.
- If
tooltip
istrue
or{"content": "encoding"}
, then all fields fromencoding
will be used. - Iftooltip
is{"content": "data"}
, then all fields that appear in the highlighted data point will be used. - If set tonull
orfalse
, then no tooltip will be used.
See the tooltip
documentation for
a detailed discussion about tooltip in Vega-Lite.
Default value: null
pub fn url<VALUE: Into<Box<Color>>>(&mut self, value: VALUE) -> &mut Self
pub fn width<VALUE: Into<CornerRadiusUnion>>( &mut self, value: VALUE ) -> &mut Self
sourcepub fn x<VALUE: Into<XUnion>>(&mut self, value: VALUE) -> &mut Self
pub fn x<VALUE: Into<XUnion>>(&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.
sourcepub fn x2<VALUE: Into<XUnion>>(&mut self, value: VALUE) -> &mut Self
pub fn x2<VALUE: Into<XUnion>>(&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.
sourcepub fn y<VALUE: Into<YUnion>>(&mut self, value: VALUE) -> &mut Self
pub fn y<VALUE: Into<YUnion>>(&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.
sourcepub fn y2<VALUE: Into<YUnion>>(&mut self, value: VALUE) -> &mut Self
pub fn y2<VALUE: Into<YUnion>>(&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.
sourcepub fn build(&self) -> Result<MarkConfig, MarkConfigBuilderError>
pub fn build(&self) -> Result<MarkConfig, MarkConfigBuilderError>
Trait Implementations§
source§impl Clone for MarkConfigBuilder
impl Clone for MarkConfigBuilder
source§fn clone(&self) -> MarkConfigBuilder
fn clone(&self) -> MarkConfigBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more