Information on this website refers to a deprecated product, and is provided only for historical reference. Please use the Version Switcher above to select an appropriate documentation website for the product you are using.

ChartScrollbar

Type class

ChartScrollbar class displays chart scrollbar. Supported by AmSerialChart and AmXYChart.

Example of how scrollbar is added to the chart:

var chart = new AmCharts.AmSerialChart();
var chartScrollbar = new AmCharts.ChartScrollbar();
chart.addChartScrollbar(chartScrollbar);

Inheritance

ChartScrollbar does not extend any other symbol.

ChartScrollbar is not extended by any other symbol.

Properties

autoGridCount
#

Type boolean

Default false

Specifies whether number of gridCount is specified automatically, acoarding to the axis size.

backgroundAlpha
#

Type number

Default 1

Background opacity.

backgroundColor
#

Type string

Default #D4D4D4

Background color of the scrollbar.

categoryAxis
#

Type CategoryAxis

Default instance of CategoryAxis

Read-only. Category axis of the scrollbar.

color
#

Type string

Default

Text color. Will use chart's color if not set.

dragIconHeight
#

Type number

Default 18

Height of resize grip image. Note, you should also update the image in amcharts/images folder if you don't want it to be distorted because of resizing.

dragIconWidth
#

Type number

Default 11

Width of resize grip image. Note, you should also update the image in amcharts/images folder if you don't want it to be distorted because of resizing.

graph
#

Type AmGraph

Default

Specifies which graph will be displayed in the scrollbar. Only Serial chart's scrollbar can display a graph.

graphFillAlpha
#

Type number

Default 0.1

Graph fill opacity. Value range is 0 - 1.

graphFillColor
#

Type string

Default #000000

Graph fill color.

graphLineAlpha
#

Type number

Default 0

Graph line opacity. Value range is 0 - 1.

graphLineColor
#

Type string

Default #000000

Graph line color.

graphType
#

Type string

Default

by default the graph type is the same as the original graph's type, however in case of candlestick or ohlc you might want to show line graph in the scrollbar. Possible values are: "line", "column", "step", "smoothedLine", "candlestick", "ohlc".

gridAlpha
#

Type number

Default 0.7

Grid opacity. Value range is 0 - 1.

gridColor
#

Type string

Default #FFFFFF

Grid color.

gridCount
#

Type number

Default 0

The number of grid lines.

hideResizeGrips
#

Type boolean

Default false

Specifies whether resize grips are hidden when mouse is away from the scrollbar.

maximum
#

Type number

Maximum value of ValueAxis of ChartScrollbar. Calculated automatically, of not set.

minimum
#

Type number

Minimum value of ValueAxis of ChartScrollbar. Calculated automatically, of not set.

resizeEnabled
#

Type boolean

Default true

Specifies whether scrollbar has a resize feature.

scrollbarHeight
#

Type number

Default 20

Height (width, if chart is rotated) of a scrollbar.

scrollDuration
#

Type number

Default 2

Duration of scrolling, when the user clicks on scrollbar's background, in seconds.

selectedBackgroundAlpha
#

Type number

Default 1

Selected backround opacity.

selectedBackgroundColor
#

Type string

Default #EFEFEF

Selected background color.

selectedGraphFillAlpha
#

Type number

Default 0.5

Selected graph's fill opacity. Value range is 0 - 1.

selectedGraphFillColor
#

Type string

Default #000000

Selected graph's fill color.

selectedGraphLineAlpha
#

Type number

Default 0

Selected graph's line opacity. Value range is 0 - 1.

selectedGraphLineColor
#

Type string

Default #000000

Selected graph's line color.

updateOnReleaseOnly
#

Type boolean

Default false

Specifies if the chart should be updated while dragging/resizing the scrollbar or only at the moment when user releases mouse button.

Methods

ChartScrollbar does not have any methods.

Events

ChartScrollbar does not have any events.

Adapters

ChartScrollbar does not have any adapters.