altair.PointSelectionConfigWithoutType#

class altair.PointSelectionConfigWithoutType(clear=Undefined, encodings=Undefined, fields=Undefined, nearest=Undefined, on=Undefined, resolve=Undefined, toggle=Undefined, **kwds)#

PointSelectionConfigWithoutType schema wrapper.

Parameters:
clearstr, bool, dict, Stream, EventStream, MergedStream, DerivedStream

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.

encodingsSequence[SingleDefUnitChannel, Literal[‘x’, ‘y’, ‘xOffset’, ‘yOffset’, ‘x2’, ‘y2’, ‘longitude’, ‘latitude’, ‘longitude2’, ‘latitude2’, ‘theta’, ‘theta2’, ‘radius’, ‘radius2’, ‘color’, ‘fill’, ‘stroke’, ‘opacity’, ‘fillOpacity’, ‘strokeOpacity’, ‘strokeWidth’, ‘strokeDash’, ‘size’, ‘angle’, ‘shape’, ‘key’, ‘text’, ‘href’, ‘url’, ‘description’]]

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.

fieldsSequence[str, FieldName]

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.

nearestbool

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.

onstr, dict, Stream, EventStream, MergedStream, DerivedStream

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.

resolveSelectionResolution, Literal[‘global’, ‘union’, ‘intersect’]

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.

togglestr, bool

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.

  • A Vega expression which is re-evaluated as the user interacts. If the expression evaluates to 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.

__init__(clear=Undefined, encodings=Undefined, fields=Undefined, nearest=Undefined, on=Undefined, resolve=Undefined, toggle=Undefined, **kwds)#

Methods

__init__([clear, encodings, fields, ...])

copy([deep, ignore])

Return a copy of the object.

from_dict(dct[, validate])

Construct class from a dictionary representation.

from_json(json_string[, validate])

Instantiate the object from a valid JSON string.

resolve_references([schema])

Resolve references in the context of this object's schema or root schema.

to_dict([validate, ignore, context])

Return a dictionary representation of the object.

to_json([validate, indent, sort_keys, ...])

Emit the JSON representation for this object as a string.

validate(instance[, schema])

Validate the instance against the class schema in the context of the rootschema.

validate_property(name, value[, schema])

Validate a property against property schema in the context of the rootschema.
On this page