ChartZoomSettingsProps

Defines the configuration options for enabling and customizing zooming and panning in the chart.

Props

The following table outlines the props for the ChartZoomSettingsProps:

NameTypeDefaultDescription
accessibility
{}

Provides accessibility options for zoom-related UI elements. Enhances screen reader support and keyboard navigation for zoom controls.

mode
'XY'

Specifies the zooming direction for chart interactions. This property controls which axes can be zoomed when using the chart's zoom features. Selecting the appropriate mode allows users to focus on specific dimensions of the data. Available options:

  • XY: Enables both horizontal and vertical zooming, allowing users to zoom freely in any direction.
  • X: Enables horizontal zooming only, restricting zoom operations to the X-axis.
  • Y: Enables vertical zooming only, restricting zoom operations to the Y-axis. Note: The selectionZoom property must be set to true for this setting to take effect.
mouseWheelZoom
boolean
false

Enables chart zooming using the mouse wheel for desktop users. Scroll up to zoom in and scroll down to zoom out.

pan
boolean
false

Enables chart panning without requiring toolbar interaction. When enabled, users can pan a zoomed chart directly by clicking and dragging.

pinchZoom
boolean
false

Enables zooming with pinch gestures on touch-enabled devices. Users can pinch in to zoom in and pinch out to zoom out.

selectionZoom
boolean
false

Enables zooming by selecting a rectangular region within the chart area. Users can click and drag to define the region they want to zoom into.

toolbar
{ visible: false, items: ['ZoomIn', 'ZoomOut', 'Pan', 'Reset'] }

Provides configuration settings for the zoom toolbar displayed on the chart. Lets you control its visibility, toolbar items, and position within the chart area.