ChartScrollbarSettings

Type class

ChartScrollbarSettings settings set's settings for chart scrollbar. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of ChartScrollbar class will be used.

Inheritance

ChartScrollbarSettings does not extend any other symbol.

ChartScrollbarSettings is not extended by any other symbol.

Properties

autoGridCount
#

Type boolean

Default true

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

backgroundAlpha
#

Type number

Background opacity.

backgroundColor
#

Type color

Background color of the scrollbar.

color
#

Type color

Text color.

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.

enabled
#

Type boolean

Default true

Set false if you don't need scrollbar.

fontSize
#

Type number

Font size.

graphFillAlpha
#

Type number

Graph fill opacity.

graphFillColor
#

Type color

Graph fill color.

graphLineAlpha
#

Type number

Graph line opacity.

graphLineColor
#

Type color

Graph line color.

graphType
#

Type string

Type of chart scrollbar's graph. 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

Grid opacity.

gridColor
#

Type color

Grid color.

gridCount
#

Type number

Grid count. You should set autoGridCount to false in order this property to work.

height
#

Type number

Default 40

Height of scrollbar, in pixels.

hideResizeGrips
#

Type boolean

Default false

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

markPeriodChange
#

Type boolean

Specifies if category axis of scrollbar should mark period change with a different date format.

position
#

Type string

Default bottom

Position of a scrollbar. Possible values are "top" and "bottom".

resizeEnabled
#

Type boolean

Default true

Specifies whether scrollbar has a resize feature.

scrollDuration
#

Type number

Duration of scrolling, when the user clicks on scrollbar's background, in seconds. Note, updateOnReleaseOnly should be set to false in order animation to happen.

selectedBackgroundAlpha
#

Type number

Selected background opacity.

selectedBackgroundColor
#

Type color

Selected background color.

selectedGraphFillAlpha
#

Type number

Selected graph'sfill opacity.

selectedGraphFillColor
#

Type color

Selected graph'sfill color.

selectedGraphLineAlpha
#

Type number

Selected graph'sline opacity.

selectedGraphLineColor
#

Type color

Selected graph's line color.

updateOnReleaseOnly
#

Type boolean

Default true

Specifies if the chart should be updated while dragging/resizing the scrollbar or only at the moment when user releases mouse button. Usefull when working with large data sets.

usePeriod
#

Type string

This is very important feature for those, who work with large data sets. You can tell ChartScrollbar what period it should use for it's graph and save a lot of time for rendering of this graph. For example, if your minPeriod is "DD" (days), set usePeriod = "WW" (weeks) and you will have 7 times less data points in scrollbar's graph. Note, the period you specify here should be set in CategoryAxesSettings.groupToPeriods.

Methods

ChartScrollbarSettings does not have any methods.

Events

ChartScrollbarSettings does not have any events.

Adapters

ChartScrollbarSettings does not have any adapters.