Struct vega_lite_4::Def
source · pub struct Def {Show 94 fields
pub def_box: Option<DefBox>,
pub clip: Option<bool>,
pub color: Option<MarkConfigExprOrSignalRefColor>,
pub extent: Option<MarkDefExtent>,
pub median: Option<DefBox>,
pub opacity: Option<CornerRadiusUnion>,
pub orient: Option<Orientation>,
pub outliers: Option<DefBox>,
pub rule: Option<DefBox>,
pub size: Option<CornerRadiusUnion>,
pub ticks: Option<DefBox>,
pub def_type: Option<Mark>,
pub thickness: Option<f64>,
pub band: Option<DefBox>,
pub borders: Option<DefBox>,
pub interpolate: Option<MarkConfigExprOrSignalRefInterpolate>,
pub tension: Option<Opacity>,
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 band_size: Option<f64>,
pub baseline: Option<TextBaseline>,
pub bin_spacing: Option<f64>,
pub blend: Option<BlendUnion>,
pub continuous_band_size: Option<f64>,
pub corner_radius: Option<CornerRadiusUnion>,
pub corner_radius_bottom_left: Option<CornerRadiusUnion>,
pub corner_radius_bottom_right: Option<CornerRadiusUnion>,
pub corner_radius_end: 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 discrete_band_size: Option<f64>,
pub dx: Option<CornerRadiusUnion>,
pub dy: Option<CornerRadiusUnion>,
pub ellipsis: Option<Box<Color>>,
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 invalid: RemovableValue<Invalid>,
pub limit: Option<CornerRadiusUnion>,
pub line: Option<Line>,
pub line_break: Option<Box<Color>>,
pub line_height: Option<CornerRadiusUnion>,
pub order: Option<bool>,
pub outer_radius: Option<CornerRadiusUnion>,
pub pad_angle: Option<CornerRadiusUnion>,
pub point: Option<PointUnion>,
pub radius: Option<CornerRadiusUnion>,
pub radius2: Option<CornerRadiusUnion>,
pub radius2_offset: Option<CornerRadiusUnion>,
pub radius_offset: Option<CornerRadiusUnion>,
pub shape: Option<Box<Color>>,
pub smooth: Option<Aria>,
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 style: Option<LegendText>,
pub text: Option<ConditionalPredicateValueDefTextExprRefText>,
pub theta: Option<CornerRadiusUnion>,
pub theta2: Option<CornerRadiusUnion>,
pub theta2_offset: Option<CornerRadiusUnion>,
pub theta_offset: 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 x2_offset: Option<CornerRadiusUnion>,
pub x_offset: Option<CornerRadiusUnion>,
pub y: Option<YUnion>,
pub y2: Option<YUnion>,
pub y2_offset: Option<CornerRadiusUnion>,
pub y_offset: Option<CornerRadiusUnion>,
}Fields§
§def_box: Option<DefBox>§clip: Option<bool>Whether a composite mark be clipped to the enclosing group’s width and height.
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.
extent: Option<MarkDefExtent>The extent of the whiskers. Available options include: - "min-max": min and max are the
lower and upper whiskers respectively. - A number representing multiple of the
interquartile range. This number will be multiplied by the IQR to determine whisker
boundary, which spans from the smallest data to the largest data within the range [Q1 -
k * IQR, Q3 + k * IQR] where Q1 and Q3 are the first and third quartiles while IQR
is the interquartile range (Q3-Q1).
Default value: 1.5.
The extent of the rule. Available options include: - "ci": Extend the rule to the
confidence interval of the mean. - "stderr": The size of rule are set to the value of
standard error, extending from the mean. - "stdev": The size of rule are set to the
value of standard deviation, extending from the mean. - "iqr": Extend the rule to the
q1 and q3.
Default value: "stderr".
The extent of the band. Available options include: - "ci": Extend the band to the
confidence interval of the mean. - "stderr": The size of band are set to the value of
standard error, extending from the mean. - "stdev": The size of band are set to the
value of standard deviation, extending from the mean. - "iqr": Extend the band to the
q1 and q3.
Default value: "stderr".
median: Option<DefBox>§opacity: Option<CornerRadiusUnion>The opacity (value between [0,1]) of the mark.
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.
orient: Option<Orientation>Orientation of the box plot. This is normally automatically determined based on types of
fields on x and y channels. However, an explicit orient be specified when the
orientation is ambiguous.
Default value: "vertical".
Orientation of the error bar. This is normally automatically determined, but can be specified when the orientation is ambiguous and cannot be automatically determined.
Orientation of the error band. This is normally automatically determined, but can be specified when the orientation is ambiguous and cannot be automatically determined.
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.
outliers: Option<DefBox>§rule: Option<DefBox>§size: Option<CornerRadiusUnion>Size of the box and median tick of a box plot
Size of the ticks of an error bar
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.
ticks: Option<DefBox>§def_type: Option<Mark>The mark type. This could a primitive mark type (one of "bar", "circle", "square",
"tick", "line", "area", "point", "geoshape", "rule", and "text") or a
composite mark type ("boxplot", "errorband", "errorbar").
thickness: Option<f64>Thickness of the ticks and the bar of an error bar
Thickness of the tick mark.
Default value: 1
band: Option<DefBox>§borders: Option<DefBox>§interpolate: Option<MarkConfigExprOrSignalRefInterpolate>The line interpolation method for the error band. One of the following: - "linear":
piecewise linear segments, as in a polyline. - "linear-closed": close the linear
segments to form a polygon. - "step": a piecewise constant function (a step function)
consisting of alternating horizontal and vertical lines. The y-value changes at the
midpoint of each pair of adjacent x-values. - "step-before": a piecewise constant
function (a step function) consisting of alternating horizontal and vertical lines. The
y-value changes before the x-value. - "step-after": a piecewise constant function (a
step function) consisting of alternating horizontal and vertical lines. The y-value
changes after the x-value. - "basis": a B-spline, with control point duplication on the
ends. - "basis-open": an open B-spline; may not intersect the start or end. -
"basis-closed": a closed B-spline, as in a loop. - "cardinal": a Cardinal spline,
with control point duplication on the ends. - "cardinal-open": an open Cardinal spline;
may not intersect the start or end, but will intersect other control points. -
"cardinal-closed": a closed Cardinal spline, as in a loop. - "bundle": equivalent to
basis, except the tension parameter is used to straighten the spline. - "monotone":
cubic interpolation that preserves monotonicity in y.
tension: Option<Opacity>The tension parameter for the interpolation type of the error band.
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>§band_size: Option<f64>The width of the ticks.
Default value: 3/4 of step (width step for horizontal ticks and height step for vertical ticks).
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.
bin_spacing: Option<f64>Offset between bars for binned field. The ideal value for this is either 0 (preferred by statisticians) or 1 (Vega-Lite default, D3 example style).
Default value: 1
blend: Option<BlendUnion>§continuous_band_size: Option<f64>The default size of the bars on continuous scales.
Default value: 5
corner_radius: Option<CornerRadiusUnion>§corner_radius_bottom_left: Option<CornerRadiusUnion>§corner_radius_bottom_right: Option<CornerRadiusUnion>§corner_radius_end: Option<CornerRadiusUnion>- For vertical bars, top-left and top-right corner radius. - For horizontal bars, top-right and bottom-right corner radius.
corner_radius_top_left: Option<CornerRadiusUnion>§corner_radius_top_right: Option<CornerRadiusUnion>§cursor: Option<CursorUnion>§description: Option<Box<Color>>§dir: Option<Dir>§discrete_band_size: Option<f64>The default size of the bars with discrete dimensions. If unspecified, the default size
is step-2, which provides 2 pixel offset between bars.
dx: Option<CornerRadiusUnion>§dy: Option<CornerRadiusUnion>§ellipsis: Option<Box<Color>>§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.
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>§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.
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.
radius2_offset: Option<CornerRadiusUnion>Offset for radius2.
radius_offset: Option<CornerRadiusUnion>Offset for radius.
shape: Option<Box<Color>>§smooth: Option<Aria>§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).
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
tooltipistrueor{"content": "encoding"}, then all fields fromencodingwill be used. - Iftooltipis{"content": "data"}, then all fields that appear in the highlighted data point will be used. - If set tonullorfalse, 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.
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.