pub struct SingleSelectionConfigBuilder { /* private fields */ }
Expand description
Builder for SingleSelectionConfig
.
Implementations§
source§impl SingleSelectionConfigBuilder
impl SingleSelectionConfigBuilder
sourcepub fn bind<VALUE: Into<SingleBind>>(&mut self, value: VALUE) -> &mut Self
pub fn bind<VALUE: Into<SingleBind>>(&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.
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<HashMap<String, Option<SelectionInit>>>>(
&mut self,
value: VALUE
) -> &mut Self
pub fn init<VALUE: Into<HashMap<String, Option<SelectionInit>>>>( &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.
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 build(
&self
) -> Result<SingleSelectionConfig, SingleSelectionConfigBuilderError>
pub fn build( &self ) -> Result<SingleSelectionConfig, SingleSelectionConfigBuilderError>
Trait Implementations§
source§impl Clone for SingleSelectionConfigBuilder
impl Clone for SingleSelectionConfigBuilder
source§fn clone(&self) -> SingleSelectionConfigBuilder
fn clone(&self) -> SingleSelectionConfigBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more