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.

Sources

This information about ChartScrollbarSettings is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

ChartScrollbarSettings does not extend any other symbol.

ChartScrollbarSettings is not extended by any other symbol.

Properties

#autoGridCount

Type booleanDefault true

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

#backgroundAlpha

Type numberDefault

Background opacity.

#backgroundColor

Type stringDefault

Background color of the scrollbar.

#color

Type stringDefault

Text color.

#dragIconHeight

Type numberDefault 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 numberDefault 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 booleanDefault true

Set false if you don't need scrollbar.

#fontSize

Type numberDefault

Font size.

#graph

Type AmGraphDefault

Specifies which graph will be displayed in the scrollbar.

#graphFillAlpha

Type numberDefault

Graph fill opacity.

#graphFillColor

Type stringDefault

Graph fill color.

#graphLineAlpha

Type numberDefault

Graph line opacity.

#graphLineColor

Type stringDefault

Graph line color.

#graphType

Type stringDefault

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 numberDefault

Grid opacity.

#gridColor

Type stringDefault

Grid color.

#gridCount

Type numberDefault

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

#height

Type numberDefault 40

Height of scrollbar, in pixels.

#hideResizeGrips

Type booleanDefault false

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

#scrollDuration

Type numberDefault

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

#selectedBackgroundAlpha

Type numberDefault

Selected background opacity.

#selectedBackgroundColor

Type stringDefault

Selected background color.

#selectedGraphFillAlpha

Type numberDefault

Selected graph'sfill opacity.

#selectedGraphFillColor

Type stringDefault

Selected graph'sfill color.

#selectedGraphLineAlpha

Type numberDefault

Selected graph'sline opacity.

#selectedGraphLineColor

Type stringDefault

Selected graph's line color.

#updateOnReleaseOnly

Type booleanDefault 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.