Struct vega_lite_4::ParameterBuilder

pub struct ParameterBuilder { /* private fields */ }

Builder for Parameter.

Implementations

impl ParameterBuilder

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

Binds the parameter to an external input element such as a slider, selection list or radio button group.

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

A text description of the parameter, useful for inline documentation.

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

An expression for the value of the parameter. This expression may include other parameters, in which case the parameter will automatically update in response to upstream parameter changes.

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

Required. A unique name for the parameter. Parameter names should be valid JavaScript identifiers: they should contain only alphanumeric characters (or “$”, or “_”) and may not start with a digit. Reserved keywords that may not be used as parameter names are “datum”, “event”, “item”, and “parent”.

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

The initial value of the parameter.

Default value: undefined

pub fn build(&self) -> Result<Parameter, ParameterBuilderError>

Builds a new Parameter.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ParameterBuilder

fn clone(&self) -> ParameterBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ParameterBuilder

fn default() -> Self

Returns the “default value” for a type.