vega-lite-api

vl.configInterval(…values)

Configure interval selections.

configInterval Method Overview

configInterval API Reference

# configInterval.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.

# configInterval.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.

# configInterval.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.

# configInterval.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.

# configInterval.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:

Default value: global.

See also: resolve examples in the documentation.

# configInterval.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.

# configInterval.type(value)

Determines the default event processing and data query for the selection. Vega-Lite currently supports two selection types:

# configInterval.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.