vl.selectPoint(name)
Define or reference a point selection parameter.
selectPoint Method OverviewselectPoint API Reference# selectPoint.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.# selectPoint.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.
# selectPoint.empty(…values)
Returns a selection reference including an empty predicate selection. If false, empty predicate will not select all values.
# selectPoint.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.
# selectPoint.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.
# selectPoint.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.
# selectPoint.fields(…value)
An array of field names whose values must match for a data tuple to fall within the selection.
See also: The projection with encodings and fields section in the documentation.
# selectPoint.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.
# selectPoint.key(…values)
Returns a selection reference including a key in data to lookup, when a selection is used within a lookup transform.
# selectPoint.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”.
# selectPoint.nearest(value)
When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.
Default value: false, which means that data values must be interacted with directly (e.g., clicked on) to be added to the selection.
See also: nearest examples documentation.
# selectPoint.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.
# selectPoint.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.
# selectPoint.toggle(value)
Controls whether data values should be toggled (inserted or removed from a point selection) or only ever inserted into point selections.
One of:
true – the default behavior, which corresponds to "event.shiftKey". As a result, data values are toggled when the user interacts with the shift-key pressed.false – disables toggling behaviour; the selection will only ever contain a single data value corresponding to the most recent interaction.true, the data value is toggled into or out of the point selection. If the expression evaluates to false, the point selection is first cleared, and the data value is then inserted. For example, setting the value to the Vega expression "true" will toggle data values without the user pressing the shift-key.Default value: true
See also: toggle examples in the documentation.
# selectPoint.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.# selectPoint.value(value)
Initialize the selection with a mapping between projected channels or field names and initial values.
# selectPoint.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.