Struct vega_lite_3::AreaConfigBuilder

pub struct AreaConfigBuilder { /* fields omitted */ }

Builder for AreaConfig.

Methods

impl AreaConfigBuilder

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

The horizontal alignment of the text. One of "left", "right", "center".

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

The rotation angle of the text, in degrees.

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

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

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

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: ■ "#4682b4"

Note: This property cannot be used in a style config.

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

The radius in pixels of rounded rectangle corners.

Default value: 0

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

The mouse cursor used over the mark. Any valid CSS cursor type can be used.

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

The direction of the text. One of "ltr" (left-to-right) or "rtl" (right-to-left). This property determines on which side is truncated in response to the limit parameter.

Default value: "ltr"

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

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

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

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

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

The ellipsis string for text truncated in response to the limit parameter.

Default value: "…"

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

Default Fill Color. This has higher precedence than config.color

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 point, line and rule; otherwise, true.

Note: This property cannot be used in a style config.

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

The fill opacity (value between [0,1]).

Default value: 1

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

The typeface to set the text in (e.g., "Helvetica Neue").

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

The font size, in pixels.

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

The font style (e.g., "italic").

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

The font weight. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, ..., 900 where "normal" = 400 and "bold" = 700).

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

Height of the marks.

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

A URL to load upon mouse click. If defined, the mark acts as a hyperlink.

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

The line interpolation method to use for line and area marks. One of the following:

• "linear": piecewise linear segments, as in a polyline.
• "linear-closed": close the linear segments to form a polygon.
• "step": alternate between horizontal and vertical segments, as in a step function.
• "step-before": alternate between vertical and horizontal segments, as in a step function.
• "step-after": alternate between horizontal and vertical segments, as in a step function.
• "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 limit<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

The maximum length of the text mark in pixels. The text value will be automatically truncated if the rendered size exceeds the limit.

Default value: 0, indicating no limit

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 opacity<VALUE: Into<f64>>(&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.

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

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

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

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

Shape of the point marks. Supported values include:

• plotting shapes: "circle", "square", "cross", "diamond", "triangle-up", "triangle-down", "triangle-right", or "triangle-left".
• the line symbol "stroke"
• centered directional shapes "arrow", "wedge", or "triangle"
• a custom SVG path string (For correct sizing, custom shape paths should be defined within a square bounding box with coordinates ranging from -1 to 1 along both the x and y dimensions.)

Default value: "circle"

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

Default size for marks.

• For point/circle/square, this represents the pixel area of the marks. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

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

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

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

The stroke cap for line ending style. One of "butt", "round", or "square".

Default value: "square"

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

An array of alternating stroke, space lengths for creating dashed or dotted lines.

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

The offset (in pixels) into which to begin drawing with the stroke dash array.

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

The stroke line join method. One of "miter", "round" or "bevel".

Default value: "miter"

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

The miter limit at which to bevel a line join.

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

The stroke opacity (value between [0,1]).

Default value: 1

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

The stroke width, in pixels.

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

Depending on the interpolation type, sets the tension parameter (for line and area marks).

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

Placeholder text if the text channel is not specified

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

Polar coordinate angle, in radians, of the text label from the origin determined by the x and y properties. Values for theta follow the same convention of arc mark startAngle and endAngle properties: angles are measured in radians, with 0 indicating "north".

pub fn tooltip<VALUE: Into<RemovableValue<TooltipUnion>>>(
    &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 {"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, then no tooltip will be used.

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

Width of the marks.

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 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<XUnion>>(&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 build(&self) -> Result<AreaConfig, String>

Builds a new AreaConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for AreaConfigBuilder

fn clone(&self) -> AreaConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for AreaConfigBuilder

fn default() -> AreaConfigBuilder

Returns the "default value" for a type.