Struct vega_lite_3::SingleSelectionConfigBuilder

pub struct SingleSelectionConfigBuilder { /* fields omitted */ }

Builder for SingleSelectionConfig.

Methods

impl SingleSelectionConfigBuilder

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

Establish a two-way binding between a single selection and input elements (also known as dynamic query widgets). A binding takes the form of Vega's input element binding definition or can be a mapping between projected field/encodings and binding definitions.

See also: bind documentation.

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

Clears the selection, emptying it of all values. Can be an EventStream or false to disable.

Default value: dblclick.

See also: clear documentation.

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

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

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

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

See also: encodings documentation.

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

An array of field names whose values must match for a data tuple to fall within the selection.

See also: fields documentation.

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

Initialize the selection with a mapping between projected channels or field names and initial values.

See also: init documentation.

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

When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.

See also: nearest documentation.

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

A Vega event stream (object or selector) that triggers the selection. For interval selections, the event stream must specify a start and end.

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

With layered and multi-view displays, a strategy that determines how selections' data queries are resolved when applied in a filter transform, conditional encoding rule, or scale domain.

See also: resolve documentation.

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

Builds a new SingleSelectionConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for SingleSelectionConfigBuilder

fn clone(&self) -> SingleSelectionConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SingleSelectionConfigBuilder

fn default() -> SingleSelectionConfigBuilder

Returns the "default value" for a type.