Struct vega_lite_4::DefBuilder

pub struct DefBuilder { /* fields omitted */ }

Builder for Def.

Implementations

impl DefBuilder

pub fn def_box<VALUE: Into<DefBox>>(&mut self, value: VALUE) -> &mut Self

pub fn clip<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

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.

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 extent<VALUE: Into<MarkDefExtent>>(&mut self, value: VALUE) -> &mut Self

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".

pub fn median<VALUE: Into<DefBox>>(&mut self, value: VALUE) -> &mut Self

pub fn opacity<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

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.

pub fn orient<VALUE: Into<Orientation>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn outliers<VALUE: Into<DefBox>>(&mut self, value: VALUE) -> &mut Self

pub fn rule<VALUE: Into<DefBox>>(&mut self, value: VALUE) -> &mut Self

pub fn size<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

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.

pub fn ticks<VALUE: Into<DefBox>>(&mut self, value: VALUE) -> &mut Self

pub fn def_type<VALUE: Into<Mark>>(&mut self, value: VALUE) -> &mut Self

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").

pub fn thickness<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

Thickness of the ticks and the bar of an error bar

Thickness of the tick mark.

Default value: 1

pub fn band<VALUE: Into<DefBox>>(&mut self, value: VALUE) -> &mut Self

pub fn borders<VALUE: Into<DefBox>>(&mut self, value: VALUE) -> &mut Self

pub fn interpolate<VALUE: Into<MarkConfigExprOrSignalRefInterpolate>>(
    &mut self,
    value: VALUE
) -> &mut Self

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.

pub fn tension<VALUE: Into<Opacity>>(&mut self, value: VALUE) -> &mut Self

The tension parameter for the interpolation type of the error band.

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<Color>>(&mut self, value: VALUE) -> &mut Self

pub fn aria_role_description<VALUE: Into<Color>>(
    &mut self,
    value: VALUE
) -> &mut Self

pub fn aspect<VALUE: Into<Aria>>(&mut self, value: VALUE) -> &mut Self

pub fn band_size<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

The width of the ticks.

Default value: 3/4 of step (width step for horizontal ticks and height step for vertical ticks).

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 bin_spacing<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

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

pub fn blend<VALUE: Into<BlendUnion>>(&mut self, value: VALUE) -> &mut Self

pub fn continuous_band_size<VALUE: Into<f64>>(
    &mut self,
    value: VALUE
) -> &mut Self

The default size of the bars on continuous scales.

Default value: 5

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_end<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

• For vertical bars, top-left and top-right corner radius. - For horizontal bars, top-right and bottom-right corner radius.

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<Color>>(&mut self, value: VALUE) -> &mut Self

pub fn dir<VALUE: Into<Dir>>(&mut self, value: VALUE) -> &mut Self

pub fn discrete_band_size<VALUE: Into<f64>>(
    &mut self,
    value: VALUE
) -> &mut Self

The default size of the bars with discrete dimensions. If unspecified, the default size is step-2, which provides 2 pixel offset between bars.

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<Color>>(&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)

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<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<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<Color>>(&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 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<VALUE: Into<Line>>(&mut self, value: VALUE) -> &mut Self

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 ({}) or true, lines with default properties will be used.

• If this value is false, no lines would be automatically added to area marks.

Default value: false.

pub fn line_break<VALUE: Into<Color>>(&mut self, value: VALUE) -> &mut Self

pub fn line_height<VALUE: Into<CornerRadiusUnion>>(
    &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.

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

pub fn point<VALUE: Into<PointUnion>>(&mut self, value: VALUE) -> &mut Self

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 ({}) or true, 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.

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.

pub fn radius2<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

The secondary (inner) radius in pixels of arc marks.

pub fn radius2_offset<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

Offset for radius2.

pub fn radius_offset<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

Offset for radius.

pub fn shape<VALUE: Into<Color>>(&mut self, value: VALUE) -> &mut Self

pub fn smooth<VALUE: Into<Aria>>(&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 style<VALUE: Into<LegendText>>(&mut self, value: VALUE) -> &mut Self

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).

pub fn text<VALUE: Into<ConditionalPredicateValueDefTextExprRefText>>(
    &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.

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.

pub fn theta2_offset<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

Offset for theta2.

pub fn theta_offset<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

Offset for theta.

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.

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.

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 is true or {"content": "encoding"}, then all fields from encoding will be used. - If tooltip is {"content": "data"}, then all fields that appear in the highlighted data point will be used. - If set to null or false, 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<Color>>(&mut self, value: VALUE) -> &mut Self

pub fn width<VALUE: Into<CornerRadiusUnion>>(
    &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.

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.

pub fn x2_offset<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

Offset for x2-position.

pub fn x_offset<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

Offset for x-position.

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.

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.

pub fn y2_offset<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

Offset for y2-position.

pub fn y_offset<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

Offset for y-position.

pub fn build(&self) -> Result<Def, String>

Builds a new Def.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for DefBuilder

pub fn clone(&self) -> DefBuilder

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for DefBuilder

pub fn default() -> DefBuilder

Returns the "default value" for a type.