ChartScrollbarProps

Defines configuration options for enabling and customizing the scrollbar associated with an axis.

Props

The following table outlines the props for the ChartScrollbarProps:

NameTypeDefaultDescription
enable
boolean
true

Enables or disables the scrollbar for the associated axis.

enableZoom
boolean
false

Specifies whether interactions on the scrollbar can modify the zoom factor of the axis. When set to false, scrollbar interaction performs panning only without changing zoom level.

position
ScrollbarPosition
'PlaceNextToAxisLine'

Specifies the position of the scrollbar relative to the axis. Available options:

  • Top: Places the scrollbar at the top of the chart. Applicable only for horizontal scrollbars.
  • Bottom: Places the scrollbar at the bottom of the chart. Applicable only for horizontal scrollbars.
  • Left: Places the scrollbar on the left side of the chart. Applicable only for vertical scrollbars.
  • Right: Places the scrollbar on the right side of the chart. Applicable only for vertical scrollbars.
  • PlaceNextToAxisLine: Places the scrollbar next to the axis line.
resizeCircle
ResizeCircleSettingProps
{ circleColor: '#E6E6E6', borderColor: '#9E9E9E', borderWidth: 1, arrowColor: '#6E6E6E' }

Configures the resize handles shown on the scrollbar thumb.

thickness
number
14

Specifies the thickness of the scrollbar track. For horizontal scrollbars this represents height; for vertical scrollbars, this represents width.

thumbColor
string
'#9E9E9E'

Specifies the fill color of the scrollbar thumb.

thumbRadius
number
6

Defines the corner radius of the scrollbar thumb.

trackColor
string
'#E0E0E0'

Specifies the background color of the scrollbar track.

trackRadius
number
6

Defines the corner radius of the scrollbar track.