Struct vega_lite_4::SingleSelectionConfig

pub struct SingleSelectionConfig {
    pub bind: Option<SingleBind>,
    pub clear: Option<ClearUnion>,
    pub empty: Option<Empty>,
    pub encodings: Option<Vec<SingleDefUnitChannel>>,
    pub fields: Option<Vec<String>>,
    pub init: Option<HashMap<String, Option<SelectionInit>>>,
    pub nearest: Option<bool>,
    pub on: Option<OnUnion>,
    pub resolve: Option<SelectionResolution>,
}

The default definition for a single selection. All properties and transformations for a single selection definition (except type) may be specified here.

For instance, setting single to {"on": "dblclick"} populates single selections on double-click by default.

Fields

bind: Option<SingleBind>

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.

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<HashMap<String, Option<SelectionInit>>>

Initialize the selection with a mapping between projected channels or field names and 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<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.

Trait Implementations

impl Clone for SingleSelectionConfig

fn clone(&self) -> SingleSelectionConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SingleSelectionConfig

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

Formats the value using the given formatter.

impl Default for SingleSelectionConfig

fn default() -> SingleSelectionConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SingleSelectionConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SingleSelectionConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.