All docs
V19.1
24.2
The page you are viewing does not exist in version 24.2.
24.1
The page you are viewing does not exist in version 24.1.
23.2
The page you are viewing does not exist in version 23.2.
23.1
The page you are viewing does not exist in version 23.1.
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
19.1
18.2
18.1
17.2
Box
Map
Vue
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery Chart - scrollBar

Specifies the settings of the scroll bar.

Type:

Object

The scroll bar allows a user to pan the chart. To use it, you need to enable zooming and panning in your chart.

By default, the scroll bar is hidden. To make it visible, set the visible field of the scrollBar object to true. Using other fields of this object you can adjust the scroll bar appearance settings, including color, width and opacity.

View Demo

color

Specifies the color of the scroll bar.

Type:

String

Default Value: 'gray'

This option supports the following colors:

offset

Specifies the spacing between the scroll bar and the chart's plot in pixels.

Type:

Number

Default Value: 5

opacity

Specifies the opacity of the scroll bar.

Type:

Number

Default Value: undefined

position

Specifies the position of the scroll bar in the chart.

Type:

String

Default Value: 'top'
Accepted Values: 'bottom' | 'left' | 'right' | 'top'

Depending on whether the chart is rotated or not, this option accepts different values. In a non-rotated chart, you can assign either 'top' or 'bottom' to this option. In a rotated chart, this option accepts either 'left' or 'right'.

visible

Specifies whether the scroll bar is visible or not.

Type:

Boolean

Default Value: false

NOTE
Making the scroll bar visible can be useful only if panning is enabled in your chart.

width

Specifies the width of the scroll bar in pixels.

Type:

Number

Default Value: 10