altair.selection_interval¶
-
altair.
selection_interval
(self, type=Undefined, bind=Undefined, clear=Undefined, empty=Undefined, encodings=Undefined, fields=Undefined, init=Undefined, mark=Undefined, on=Undefined, resolve=Undefined, translate=Undefined, zoom=Undefined, **kwds)¶ Create a selection with type=’interval’ Mapping(required=[type])
- Attributes
- typeenum(‘interval’)
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
.
- bindenum(‘scales’)
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.
- 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 tonone
, 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.
- init
SelectionInitIntervalMapping
Initialize the selection with a mapping between projected channels or field names and arrays of initial values.
See also: init documentation.
- mark
BrushConfig
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.
- 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.
- resolve
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.
- translateanyOf(string, boolean)
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.
- zoomanyOf(string, boolean)
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, onlywheel
events are supported.Default value:
true
, which corresponds towheel!
.See also: zoom documentation.