ZoomCharts Documentation
Version: 1.21.1 (2024-11-08)

TimeChart.settings.interaction.selection

This section is defined by the type TimeChartSettingsInteractionSelection.

Configurable settings to select specific time period by dragging on the time axis.

Properties

clearOnDropdownUnitMismatch: boolean
Default value: false
Introduced in version 1.18.0.

Specifies if the selection area should be cleared/removed when display unit dropdown menu is changed to a unit where the selection will no longer start and end on a whole unit

clearOnRightClick: boolean
Default value: true
Introduced in version 1.18.0.

Specifies if the selection area should be cleared/removed on right click. By default right click will clear selection.

enabled: boolean
Default value: true

Enable/disable selection

moveByDragging: boolean
Default value: false
Introduced in version 1.14.0.

Specifies if the selection area can be moved by dragging it. By default the whole chart is moved instead.

resizeSensitivity: number
Default value: 2
Introduced in version 1.14.0.

Specifies the speed by which the selection is resized by dragging it up and down. Requires moveByDragging to be enabled.

Note - set to 0 to disable the resize gesture.

resizeTolerance: number
Default value: 20
Introduced in version 1.14.0.

Specifies how much the pointer must move vertically for the resize to start. Requires moveByDragging to be enabled.

tolerance: number
Default value: 6

Distance in pixels to both sides of the selection left/right edges that can be used to drag the selection area to expand/collapse it.

zoomOutSelectionMode: "clear" | "mismatch" | "keep"
Default value: "clear"
Introduced in version 1.18.14.

Specifies what should happen to the selection when zoom out is used

Valid values:
  • clear - Selection is cleared on zoom out
  • mismatch - Selection is cleared if it's incompatible with new display unit
  • keep - Selection is always kept
X