Struct vega_lite_4::SelectionDef

pub struct SelectionDef {

    pub bind: Option<BindUnion>,
    pub clear: Option<ClearUnion>,
    pub empty: Option<Empty>,
    pub encodings: Option<Vec<SingleDefUnitChannel>>,
    pub fields: Option<Vec<String>>,
    pub init: Option<Init>,
    pub nearest: Option<bool>,
    pub on: Option<OnUnion>,
    pub resolve: Option<SelectionResolution>,
    pub selection_def_type: Option<SelectionDefType>,
    pub toggle: Option<Translate>,
    pub mark: Option<BrushConfig>,
    pub translate: Option<Translate>,
    pub zoom: Option<Translate>,
}

Fields

bind: Option<BindUnion>

When set, a selection is populated by input elements (also known as dynamic query widgets) or 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.

Query widget 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.

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.

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.

clear: Option<ClearUnion>

Clears the selection, emptying it of all values. Can be a Event Stream or false to disable.

Default value: dblclick.

See also: clear documentation.

empty: Option<Empty>

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

encodings: Option<Vec<SingleDefUnitChannel>>

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.

fields: Option<Vec<String>>

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

See also: fields documentation.

init: Option<Init>

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.

nearest: Option<bool>

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.

on: Option<OnUnion>

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

resolve: Option<SelectionResolution>

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.

selection_def_type: Option<SelectionDefType>

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.

toggle: Option<Translate>

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.

mark: Option<BrushConfig>

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.

translate: Option<Translate>

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.

zoom: Option<Translate>

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.

Trait Implementations

impl Clone for SelectionDef

fn clone(&self) -> SelectionDef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SelectionDef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SelectionDef

fn default() -> SelectionDef

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SelectionDef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SelectionDef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.