PivotZoomSettings

10 Oct 20251 minute to read

Allow options to customize the pivot chart zooming with different properties such as enablePinchZooming, enableSelectionZooming,
enableDeferredZooming, enableMouseWheelZooming, zoom modes, toolbarItems, enableScrollbar and enablePan.

Properties

enableDeferredZooming boolean

If set to true, zooming will be performed on mouse up. It requires enableSelectionZooming to be true.

...
   zoomSettings: {
     enableSelectionZooming: true,
     enableDeferredZooming: false
   }
...

Defaults to false

enableMouseWheelZooming boolean

If set to true, chart can be zoomed by using mouse wheel.

Defaults to false

enablePan boolean

Specifies whether chart needs to be panned by default.

Defaults to false.

enablePinchZooming boolean

If to true, chart can be pinched to zoom in / zoom out.

Defaults to false

enableScrollbar boolean

Specifies whether axis needs to have scrollbar.

Defaults to true.

enableSelectionZooming boolean

If set to true, chart can be zoomed by a rectangular selecting region on the plot area.

Defaults to true

mode ZoomMode

Allows to specify whether to allow zooming vertically or horizontally or in both ways. They are,

  • x: Chart can be zoomed horizontally.
  • y: Chart can be zoomed vertically.
  • x,y: Chart can be zoomed both vertically and horizontally.
    It requires enableSelectionZooming to be true. 
    ...
zoomSettings: {
   enableSelectionZooming: true,
   mode: 'XY'
 },
...

Defaults to ‘XY’

toolbarItems ToolbarItems[]

Allows to set the toolkit options for the zooming as follows:

  • Zoom - Renders the zoom button.
  • ZoomIn - Renders the zoomIn button.
  • ZoomOut - Renders the zoomOut button.
  • Pan - Renders the pan button.
  • Reset - Renders the reset button.

Defaults to ’[“Zoom”, “ZoomIn”, “ZoomOut”, “Pan”, “Reset”]’