Struct vega_lite_3::ViewBackgroundBuilder

pub struct ViewBackgroundBuilder { /* fields omitted */ }

Builder for ViewBackground.

Methods

impl ViewBackgroundBuilder

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

The fill color.

Default value: undefined

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

The stroke color.

Default value: "#ddd"

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

A string or array of strings indicating the name of custom styles to apply to the view background. 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.

Default value: "cell" Note: Any specified view background properties will augment the default style.

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

Builds a new ViewBackground.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ViewBackgroundBuilder

fn clone(&self) -> ViewBackgroundBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ViewBackgroundBuilder

fn default() -> ViewBackgroundBuilder

Returns the "default value" for a type.