Struct vega_lite::SelectionDef

pub struct SelectionDef {
    pub bind: Option<SelectionDefBind>,
    pub empty: Option<VgLayoutAlign>,
    pub encodings: Option<Vec<SingleDefChannel>>,
    pub fields: Option<Vec<String>>,
    pub nearest: Option<bool>,
    pub on: Option<Value>,
    pub resolve: Option<SelectionResolution>,
    pub selection_def_type: SelectionDefType,
    pub toggle: Option<Translate>,
    pub mark: Option<BrushConfig>,
    pub translate: Option<Translate>,
    pub zoom: Option<Translate>,
}

Fields

bind: Option<SelectionDefBind>

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 the bind transform documentation for more information.

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.

empty: Option<VgLayoutAlign>

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<SingleDefChannel>>

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

fields: Option<Vec<String>>

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

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 the nearest transform documentation for more information.

on: Option<Value>

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.

selection_def_type: SelectionDefType

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

See the toggle transform documentation for more information.

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.

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.

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

Trait Implementations

impl Debug for SelectionDef

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

Formats the value using the given formatter.

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.