altair.selection_multi

altair.selection_multi(self, type=Undefined, bind=Undefined, clear=Undefined, empty=Undefined, encodings=Undefined, fields=Undefined, init=Undefined, nearest=Undefined, on=Undefined, resolve=Undefined, toggle=Undefined, **kwds)

Create a selection with type=’multi’ Mapping(required=[type])

Attributes

typestring

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 on click. - "multi" – to select multiple discrete data value; the first value is selected on click and additional values toggled on shift- click. - "interval" – to select a continuous range of data values on drag.

bindLegendBinding

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.

clearanyOf(Stream, string, boolean)

Clears the selection, emptying it of all values. Can be a Event Stream or false to disable.

Default value: dblclick.

See also: clear documentation.

emptyenum(‘all’, ‘none’)

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

encodingsList(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.

fieldsList(FieldName)

An array of field names whose values must match for a data tuple to fall within the selection.

See also: fields documentation.

initList(SelectionInitMapping)

Initialize the selection with a mapping between projected channels or field names and an initial value (or array of values).

See also: init documentation.

nearestboolean

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.

onanyOf(Stream, string)

A Vega event stream (object or selector) that triggers the selection. For interval selections, the event stream must specify a start and end.

resolveSelectionResolution

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.

toggleanyOf(string, boolean)

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.