Struct vega_lite_4::SelectionDefBuilder
source · pub struct SelectionDefBuilder { /* private fields */ }
Expand description
Builder for SelectionDef
.
Implementations§
source§impl SelectionDefBuilder
impl SelectionDefBuilder
sourcepub fn bind<VALUE: Into<BindUnion>>(&mut self, value: VALUE) -> &mut Self
pub fn bind<VALUE: Into<BindUnion>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn clear<VALUE: Into<ClearUnion>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn empty<VALUE: Into<Empty>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn encodings<VALUE: Into<Vec<SingleDefUnitChannel>>>(
&mut self,
value: VALUE
) -> &mut Self
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.
sourcepub fn fields<VALUE: Into<Vec<String>>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn init<VALUE: Into<Init>>(&mut self, value: VALUE) -> &mut Self
pub fn init<VALUE: Into<Init>>(&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.
sourcepub fn nearest<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn on<VALUE: Into<OnUnion>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn resolve<VALUE: Into<SelectionResolution>>(
&mut self,
value: VALUE
) -> &mut Self
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.
sourcepub fn selection_def_type<VALUE: Into<SelectionDefType>>(
&mut self,
value: VALUE
) -> &mut Self
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 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
.
sourcepub fn toggle<VALUE: Into<Translate>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn mark<VALUE: Into<BrushConfig>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn translate<VALUE: Into<Translate>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn zoom<VALUE: Into<Translate>>(&mut self, value: VALUE) -> &mut Self
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.
sourcepub fn build(&self) -> Result<SelectionDef, SelectionDefBuilderError>
pub fn build(&self) -> Result<SelectionDef, SelectionDefBuilderError>
Trait Implementations§
source§impl Clone for SelectionDefBuilder
impl Clone for SelectionDefBuilder
source§fn clone(&self) -> SelectionDefBuilder
fn clone(&self) -> SelectionDefBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more