Struct vega_lite_4::MultiSelectionConfigBuilder

pub struct MultiSelectionConfigBuilder { /* private fields */ }

Builder for MultiSelectionConfig.

Implementations

impl MultiSelectionConfigBuilder

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

When set, a selection is populated by interacting with the corresponding legend. Direct manipulation interaction is disabled by default; to re-enable it, set the selection’s on property.

Legend bindings are restricted to selections that only specify a single field or encoding.

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

Clears the selection, emptying it of all values. Can be a Event Stream 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<Vec<HashMap<String, Option<SelectionInit>>>>>( &mut self, value: VALUE ) -> &mut Self

Initialize the selection with a mapping between projected channels or field names and an initial value (or array of 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<OnUnion>>(&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 toggle<VALUE: Into<Translate>>(&mut self, value: VALUE) -> &mut Self

Controls whether data values should be toggled or only ever inserted into multi selections. Can be true, false (for insertion only), or a Vega expression.

Default value: true, which corresponds to event.shiftKey (i.e., data values are toggled when a user interacts with the shift-key pressed).

Setting the value to the Vega expression "true" will toggle data values without the user pressing the shift-key.

See also: toggle documentation.

pub fn build( &self ) -> Result<MultiSelectionConfig, MultiSelectionConfigBuilderError>

Builds a new MultiSelectionConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for MultiSelectionConfigBuilder

fn clone(&self) -> MultiSelectionConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for MultiSelectionConfigBuilder

fn default() -> Self

Returns the “default value” for a type.