vl.selectInterval(name)
Define or reference a interval selection parameter.
selectInterval Method OverviewselectInterval API Reference# selectInterval.bind(bind)
Input element bindings for this parameter.
See: bind documentation.
The behavior of this method depends on the argument type:
EventTarget, sets the bind.element property.bind property.# selectInterval.clear(value)
Clears the selection, emptying it of all values. This property can be a Event Stream or false to disable clear.
Default value: dblclick.
See also: clear examples in the documentation.
# selectInterval.empty(…values)
Returns a selection reference including an empty predicate selection. If false, empty predicate will not select all values.
# selectInterval.encoding(…values)
Returns a selection reference including an encoding channel to extract selected values for, when a selection is projected over multiple fields or encodings.
# selectInterval.encodings(…value)
An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.
See also: The projection with encodings and fields section in the documentation.
# selectInterval.field(…values)
Returns a selection reference including a field name to extract selected values for, when a selection is projected over multiple fields or encodings.
# selectInterval.init(value)
Initialize the selection with a mapping between projected channels or field names and initial values. This method provides backwards compatiblity with earlier API versions; it is deprecated and may be removed in future versions. Use values() instead.
# selectInterval.key(…values)
Returns a selection reference including a key in data to lookup, when a selection is used within a lookup transform.
# selectInterval.mark(value)
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 examples in the documentation.
# selectInterval.name(name)
A unique name for the selection parameter. Selection names should be valid JavaScript identifiers: they should contain only alphanumeric characters (or “$”, or “_”) and may not start with a digit. Reserved keywords that may not be used as parameter names are “datum”, “event”, “item”, and “parent”.
# selectInterval.on(value)
A Vega event stream (object or selector) that triggers the selection. For interval selections, the event stream must specify a start and end.
See also: on examples in the documentation.
# selectInterval.resolve(value)
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.
One of:
"global" – only one brush exists for the entire SPLOM. When the user begins to drag, any previous brushes are cleared, and a new one is constructed."union" – each cell contains its own brush, and points are highlighted if they lie within any of these individual brushes."intersect" – each cell contains its own brush, and points are highlighted only if they fall within all of these individual brushes.Default value: global.
See also: resolve examples in the documentation.
# selectInterval.translate(value)
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. Discrete panning (e.g., pressing the left/right arrow keys) will be supported in future versions.
Default value: true, which corresponds to [mousedown, window:mouseup] > window:mousemove!. This default allows users to clicks and drags within an interval selection to reposition it.
See also: translate examples in the documentation.
# selectInterval.type(value)
Determines the default event processing and data query for the selection. Vega-Lite currently supports two selection types:
"point" – to select multiple discrete data values; 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.# selectInterval.value(value)
Initialize the selection with a mapping between projected channels or field names and initial values.
# selectInterval.views(views)
By default, top-level selections are applied to every view in the visualization. If this property is specified, selections will only be applied to views with the given names.
# selectInterval.zoom(value)
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, only wheel events are supported, but custom event streams can still be used to specify filters, debouncing, and throttling. Future versions will expand the set of events that can trigger this transformation.
Default value: true, which corresponds to wheel!. This default allows users to use the mouse wheel to resize an interval selection.
See also: zoom examples in the documentation.