[−][src]Struct vega_lite_4::OverlayMarkDef
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<Color>
aria_role_description: Option<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>
clip: Option<bool>
Whether a mark be clipped to the enclosing group’s width and height.
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<Color>
dir: Option<Dir>
dx: Option<CornerRadiusUnion>
dy: Option<CornerRadiusUnion>
ellipsis: Option<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<Color>
font_size: Option<FontSize>
font_style: Option<Color>
font_weight: Option<FontWeightUnion>
height: Option<CornerRadiusUnion>
href: Option<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_break: Option<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>
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.
radius2_offset: Option<CornerRadiusUnion>
Offset for radius2.
radius_offset: Option<CornerRadiusUnion>
Offset for radius.
shape: Option<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>
style: Option<LegendText>
A string or array of strings indicating the name of custom styles to apply to the mark. A
style is a named collection of mark property defaults defined within the style
configuration. If style is
an array, later styles will override earlier styles. Any mark
properties explicitly
defined within the encoding
will override a style default.
Default value: The mark's name. For example, a bar mark will have style "bar"
by
default. Note: Any specified style will augment the default style. For example, a bar
mark with "style": "foo"
will receive from config.style.bar
and config.style.foo
(the specified style "foo"
has higher precedence).
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.
theta2_offset: Option<CornerRadiusUnion>
Offset for theta2.
theta_offset: Option<CornerRadiusUnion>
Offset for theta.
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<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.
x2_offset: Option<CornerRadiusUnion>
Offset for x2-position.
x_offset: Option<CornerRadiusUnion>
Offset for x-position.
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.
y2_offset: Option<CornerRadiusUnion>
Offset for y2-position.
y_offset: Option<CornerRadiusUnion>
Offset for y-position.
Trait Implementations
impl Clone for OverlayMarkDef
[src]
pub fn clone(&self) -> OverlayMarkDef
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for OverlayMarkDef
[src]
impl Default for OverlayMarkDef
[src]
pub fn default() -> OverlayMarkDef
[src]
impl<'de> Deserialize<'de> for OverlayMarkDef
[src]
pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl From<OverlayMarkDef> for Line
[src]
pub fn from(original: OverlayMarkDef) -> Line
[src]
impl From<OverlayMarkDef> for PointUnion
[src]
pub fn from(original: OverlayMarkDef) -> PointUnion
[src]
impl Serialize for OverlayMarkDef
[src]
Auto Trait Implementations
impl RefUnwindSafe for OverlayMarkDef
[src]
impl Send for OverlayMarkDef
[src]
impl Sync for OverlayMarkDef
[src]
impl Unpin for OverlayMarkDef
[src]
impl UnwindSafe for OverlayMarkDef
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,