Struct vega_lite_4::MultiSelectionConfig
source · pub struct MultiSelectionConfig {
pub bind: Option<LegendBinding>,
pub clear: Option<ClearUnion>,
pub empty: Option<Empty>,
pub encodings: Option<Vec<SingleDefUnitChannel>>,
pub fields: Option<Vec<String>>,
pub init: Option<Vec<HashMap<String, Option<SelectionInit>>>>,
pub nearest: Option<bool>,
pub on: Option<OnUnion>,
pub resolve: Option<SelectionResolution>,
pub toggle: Option<Translate>,
}
Expand description
The default definition for a
multi
selection. All
properties and transformations for a multi selection definition (except type
) may be
specified here.
For instance, setting multi
to {"toggle": "event.altKey"}
adds additional values to
multi selections when clicking with the alt-key pressed by default.
Fields§
§bind: Option<LegendBinding>
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.
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<Vec<HashMap<String, Option<SelectionInit>>>>
Initialize the selection with a mapping between projected channels or field names and an initial value (or array of 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.
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.
Trait Implementations§
source§impl Clone for MultiSelectionConfig
impl Clone for MultiSelectionConfig
source§fn clone(&self) -> MultiSelectionConfig
fn clone(&self) -> MultiSelectionConfig
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more