Important version information!

You are browsing a class reference for Version 2 of the JavaScript Charts. If you are using Version 3 (current), please click here.

ChartScrollbarSettings

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.

Properties

PropertyTypeDefaultDescription
autoGridCountBooleantrueSpecifies whether number of gridCount is specified automatically, according to the axis size.
backgroundAlphaNumber Background opacity.
backgroundColorString Background color of the scrollbar.
colorString Text color.
dragIconHeightNumber18Height 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.
dragIconWidthNumber11Width 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.
enabledBooleantrueSet false if you don't need scrollbar.
fontSizeNumber Font size.
graphAmGraph Specifies which graph will be displayed in the scrollbar.
graphFillAlphaNumber Graph fill opacity.
graphFillColorString Graph fill color.
graphLineAlphaNumber Graph line opacity.
graphLineColorString Graph line color.
graphTypeString 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.
gridAlphaNumber Grid opacity.
gridColorString Grid color.
gridCountNumber Grid count. You should set autoGridCount to false in order this property to work.
heightNumber40Height of scrollbar, in pixels.
hideResizeGripsBooleanfalseSpecifies whether resize grips are hidden when mouse is away from the scrollbar.
scrollDurationNumber Duration of scrolling, when the user clicks on scrollbar's background, in seconds.
selectedBackgroundAlphaNumber Selected background opacity.
selectedBackgroundColorString Selected background color.
selectedGraphFillAlphaNumber Selected graph'sfill opacity.
selectedGraphFillColorString Selected graph'sfill color.
selectedGraphLineAlphaNumber Selected graph'sline opacity.
selectedGraphLineColorString Selected graph's line color.
updateOnReleaseOnlyBooleantrueSpecifies 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.
usePeriodStringThis 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 class does not have any methods.

Events

ChartScrollbarSettings class does not have any events.