Struct vega_lite_4::AreaConfig
source · pub struct AreaConfig {Show 71 fields
pub align: Option<TitleAlignUnion>,
pub angle: Option<Angle>,
pub aria: Option<Aria>,
pub aria_role: Option<Box<Color>>,
pub aria_role_description: Option<Box<Color>>,
pub aspect: Option<Aria>,
pub baseline: Option<TextBaseline>,
pub blend: Option<BlendUnion>,
pub color: Option<MarkConfigExprOrSignalRefColor>,
pub corner_radius: Option<CornerRadiusUnion>,
pub corner_radius_bottom_left: Option<CornerRadiusUnion>,
pub corner_radius_bottom_right: Option<CornerRadiusUnion>,
pub corner_radius_top_left: Option<CornerRadiusUnion>,
pub corner_radius_top_right: Option<CornerRadiusUnion>,
pub cursor: Option<CursorUnion>,
pub description: Option<Box<Color>>,
pub dir: Option<Dir>,
pub dx: Option<CornerRadiusUnion>,
pub dy: Option<CornerRadiusUnion>,
pub ellipsis: Option<Box<Color>>,
pub end_angle: Option<CornerRadiusUnion>,
pub fill: Option<MarkConfigExprOrSignalRefFill>,
pub filled: Option<bool>,
pub fill_opacity: Option<Opacity>,
pub font: Option<Box<Color>>,
pub font_size: Option<FontSize>,
pub font_style: Option<Box<Color>>,
pub font_weight: Option<FontWeightUnion>,
pub height: Option<CornerRadiusUnion>,
pub href: Option<Box<Color>>,
pub inner_radius: Option<CornerRadiusUnion>,
pub interpolate: Option<MarkConfigExprOrSignalRefInterpolate>,
pub invalid: RemovableValue<Invalid>,
pub limit: Option<CornerRadiusUnion>,
pub line: Option<Line>,
pub line_break: Option<Box<Color>>,
pub line_height: Option<CornerRadiusUnion>,
pub opacity: Option<CornerRadiusUnion>,
pub order: Option<bool>,
pub orient: Option<Orientation>,
pub outer_radius: Option<CornerRadiusUnion>,
pub pad_angle: Option<CornerRadiusUnion>,
pub point: Option<PointUnion>,
pub radius: Option<CornerRadiusUnion>,
pub radius2: Option<CornerRadiusUnion>,
pub shape: Option<Box<Color>>,
pub size: Option<CornerRadiusUnion>,
pub smooth: Option<Aria>,
pub start_angle: Option<CornerRadiusUnion>,
pub stroke: Option<MarkConfigExprOrSignalRefFill>,
pub stroke_cap: Option<Cap>,
pub stroke_dash: Option<StrokeDashUnion>,
pub stroke_dash_offset: Option<CornerRadiusUnion>,
pub stroke_join: Option<StrokeJoinUnion>,
pub stroke_miter_limit: Option<CornerRadiusUnion>,
pub stroke_offset: Option<CornerRadiusUnion>,
pub stroke_opacity: Option<Opacity>,
pub stroke_width: Option<FontSize>,
pub tension: Option<CornerRadiusUnion>,
pub text: Option<ConditionalPredicateValueDefTextExprRefText>,
pub theta: Option<CornerRadiusUnion>,
pub theta2: Option<CornerRadiusUnion>,
pub time_unit_band: Option<f64>,
pub time_unit_band_position: Option<f64>,
pub tooltip: Option<MarkConfigExprOrSignalRefTooltip>,
pub url: Option<Box<Color>>,
pub width: Option<CornerRadiusUnion>,
pub x: Option<XUnion>,
pub x2: Option<XUnion>,
pub y: Option<YUnion>,
pub y2: Option<YUnion>,
}
Expand description
Area-Specific Config
Fields§
§align: Option<TitleAlignUnion>
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.
angle: Option<Angle>
§aria: Option<Aria>
§aria_role: Option<Box<Color>>
§aria_role_description: Option<Box<Color>>
§aspect: Option<Aria>
§baseline: Option<TextBaseline>
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.
blend: Option<BlendUnion>
§color: Option<MarkConfigExprOrSignalRefColor>
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
.
corner_radius: Option<CornerRadiusUnion>
§corner_radius_bottom_left: Option<CornerRadiusUnion>
§corner_radius_bottom_right: Option<CornerRadiusUnion>
§corner_radius_top_left: Option<CornerRadiusUnion>
§corner_radius_top_right: Option<CornerRadiusUnion>
§cursor: Option<CursorUnion>
§description: Option<Box<Color>>
§dir: Option<Dir>
§dx: Option<CornerRadiusUnion>
§dy: Option<CornerRadiusUnion>
§ellipsis: Option<Box<Color>>
§end_angle: Option<CornerRadiusUnion>
§fill: Option<MarkConfigExprOrSignalRefFill>
Default fill color. This property has higher precedence than config.color
. Set to
null
to remove fill.
Default value: (None)
filled: Option<bool>
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.
fill_opacity: Option<Opacity>
§font: Option<Box<Color>>
§font_size: Option<FontSize>
§font_style: Option<Box<Color>>
§font_weight: Option<FontWeightUnion>
§height: Option<CornerRadiusUnion>
§href: Option<Box<Color>>
§inner_radius: Option<CornerRadiusUnion>
The inner radius in pixels of arc marks. innerRadius
is an alias for radius2
.
interpolate: Option<MarkConfigExprOrSignalRefInterpolate>
§invalid: RemovableValue<Invalid>
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.
limit: Option<CornerRadiusUnion>
§line: Option<Line>
A flag for overlaying line on top of area marks, or an object defining the properties of the overlayed lines.
-
If this value is an empty object (
{}
) ortrue
, lines with default properties will be used. -
If this value is
false
, no lines would be automatically added to area marks.
Default value: false
.
line_break: Option<Box<Color>>
§line_height: Option<CornerRadiusUnion>
§opacity: Option<CornerRadiusUnion>
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.
order: Option<bool>
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.
orient: Option<Orientation>
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.
outer_radius: Option<CornerRadiusUnion>
The outer radius in pixels of arc marks. outerRadius
is an alias for radius
.
pad_angle: Option<CornerRadiusUnion>
§point: Option<PointUnion>
A flag for overlaying points on top of line or area marks, or an object defining the properties of the overlayed points.
-
If this property is
"transparent"
, transparent points will be used (for enhancing tooltips and selections). -
If this property is an empty object (
{}
) ortrue
, filled points with default properties will be used. -
If this property is
false
, no points would be automatically added to line or area marks.
Default value: false
.
radius: Option<CornerRadiusUnion>
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.
radius2: Option<CornerRadiusUnion>
The secondary (inner) radius in pixels of arc marks.
shape: Option<Box<Color>>
§size: Option<CornerRadiusUnion>
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.
smooth: Option<Aria>
§start_angle: Option<CornerRadiusUnion>
§stroke: Option<MarkConfigExprOrSignalRefFill>
Default stroke color. This property has higher precedence than config.color
. Set to
null
to remove stroke.
Default value: (None)
stroke_cap: Option<Cap>
§stroke_dash: Option<StrokeDashUnion>
§stroke_dash_offset: Option<CornerRadiusUnion>
§stroke_join: Option<StrokeJoinUnion>
§stroke_miter_limit: Option<CornerRadiusUnion>
§stroke_offset: Option<CornerRadiusUnion>
§stroke_opacity: Option<Opacity>
§stroke_width: Option<FontSize>
§tension: Option<CornerRadiusUnion>
§text: Option<ConditionalPredicateValueDefTextExprRefText>
§theta: Option<CornerRadiusUnion>
-
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.
theta2: Option<CornerRadiusUnion>
The end angle of arc marks in radians. A value of 0 indicates up or “north”, increasing values proceed clockwise.
time_unit_band: Option<f64>
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.
time_unit_band_position: Option<f64>
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.
tooltip: Option<MarkConfigExprOrSignalRefTooltip>
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
url: Option<Box<Color>>
§width: Option<CornerRadiusUnion>
§x: Option<XUnion>
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.
x2: Option<XUnion>
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.
y: Option<YUnion>
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.
y2: Option<YUnion>
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.
Trait Implementations§
source§impl Clone for AreaConfig
impl Clone for AreaConfig
source§fn clone(&self) -> AreaConfig
fn clone(&self) -> AreaConfig
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more