Struct vega_lite_3::SelectionDefBuilder

pub struct SelectionDefBuilder { /* fields omitted */ }

Builder for SelectionDef.

Methods

impl SelectionDefBuilder

pub fn bind<VALUE: Into<SelectionDefBind>>(&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.

Establishes a two-way binding between the interval selection and the scales used within the same view. This allows a user to interactively pan and zoom the view.

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<SelectionDefInit>>(&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.

Initialize the selection with a mapping between projected channels or field names and an initial value (or array of values).

See also: init documentation.

Initialize the selection with a mapping between projected channels or field names and arrays of 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 selection_def_type<VALUE: Into<SelectionDefType>>(
    &mut self,
    value: VALUE
) -> &mut Self

Determines the default event processing and data query for the selection. Vega-Lite currently supports three selection types:

• single -- to select a single discrete data value on click.
• multi -- to select multiple discrete data value; the first value is selected on click and additional values toggled on shift-click.
• interval -- to select a continuous range of data values on drag.

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

See also: toggle documentation.

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

An interval selection also adds a rectangle mark to depict the extents of the interval. The mark property can be used to customize the appearance of the mark.

See also: mark documentation.

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

When truthy, allows a user to interactively move an interval selection back-and-forth. Can be true, false (to disable panning), or a Vega event stream definition which must include a start and end event to trigger continuous panning.

Default value: true, which corresponds to [mousedown, window:mouseup] > window:mousemove! which corresponds to clicks and dragging within an interval selection to reposition it.

See also: translate documentation.

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

When truthy, allows a user to interactively resize an interval selection. Can be true, false (to disable zooming), or a Vega event stream definition. Currently, only wheel events are supported.

Default value: true, which corresponds to wheel!.

See also: zoom documentation.

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

Builds a new SelectionDef.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for SelectionDefBuilder

fn clone(&self) -> SelectionDefBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SelectionDefBuilder

fn default() -> SelectionDefBuilder

Returns the "default value" for a type.