You are browsing a class reference for deprecated Version 2 of the JavaScript Charts.
Documentation for other versions: amCharts 4 (current) or amCharts 3.
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.
| Property | Type | Default | Description |
|---|---|---|---|
| autoGridCount | Boolean | true | Specifies whether number of gridCount is specified automatically, according to the axis size. |
| backgroundAlpha | Number | Background opacity. | |
| backgroundColor | String | Background color of the scrollbar. | |
| color | String | Text color. | |
| dragIconHeight | Number | 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 | Number | 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 | Boolean | true | Set false if you don't need scrollbar. |
| fontSize | Number | Font size. | |
| graph | AmGraph | Specifies which graph will be displayed in the scrollbar. | |
| graphFillAlpha | Number | Graph fill opacity. | |
| graphFillColor | String | Graph fill color. | |
| graphLineAlpha | Number | Graph line opacity. | |
| graphLineColor | String | Graph line color. | |
| graphType | 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 | Number | Grid opacity. | |
| gridColor | String | Grid color. | |
| gridCount | Number | Grid count. You should set autoGridCount to false in order this property to work. | |
| height | Number | 40 | Height of scrollbar, in pixels. |
| hideResizeGrips | Boolean | false | Specifies whether resize grips are hidden when mouse is away from the scrollbar. |
| scrollDuration | Number | Duration of scrolling, when the user clicks on scrollbar's background, in seconds. | |
| selectedBackgroundAlpha | Number | Selected background opacity. | |
| selectedBackgroundColor | String | Selected background color. | |
| selectedGraphFillAlpha | Number | Selected graph'sfill opacity. | |
| selectedGraphFillColor | String | Selected graph'sfill color. | |
| selectedGraphLineAlpha | Number | Selected graph'sline opacity. | |
| selectedGraphLineColor | String | Selected graph's line color. | |
| updateOnReleaseOnly | Boolean | 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 | 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. |