altair.IntervalSelectionConfig

class altair.IntervalSelectionConfig(type=Undefined, clear=Undefined, encodings=Undefined, fields=Undefined, mark=Undefined, on=Undefined, resolve=Undefined, translate=Undefined, zoom=Undefined, **kwds)

IntervalSelectionConfig schema wrapper.

Parameters:

typeLiteral[‘interval’]

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.

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.

markdict, 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 examples in the 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.

translatestr, bool

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 [pointerdown, window:pointerup] > window:pointermove!. This default allows users to clicks and drags within an interval selection to reposition it.

See also: translate examples in the documentation.

zoomstr, bool

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.

__init__(type=Undefined, clear=Undefined, encodings=Undefined, fields=Undefined, mark=Undefined, on=Undefined, resolve=Undefined, translate=Undefined, zoom=Undefined, **kwds)

Methods

__init__([type, 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.