[−][src]Struct vega_lite_3::SelectionDef
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 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.
clear: Option<Value>
Clears the selection, emptying it of all values. Can be an
EventStream 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<SelectionDefInit>
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<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.
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 onclick
.multi
-- to select multiple discrete data value; the first value is selected onclick
and additional values toggled on shift-click
.interval
-- to select a continuous range of data values ondrag
.
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 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
[src]
fn clone(&self) -> SelectionDef
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for SelectionDef
[src]
impl Default for SelectionDef
[src]
fn default() -> SelectionDef
[src]
impl<'de> Deserialize<'de> for SelectionDef
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Serialize for SelectionDef
[src]
Auto Trait Implementations
impl RefUnwindSafe for SelectionDef
impl Send for SelectionDef
impl Sync for SelectionDef
impl Unpin for SelectionDef
impl UnwindSafe for SelectionDef
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,