You are browsing a class reference for deprecated Version 2 of the JavaScript Charts.
Documentation for other versions: amCharts 4 (current) or amCharts 3.
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);
Property | Type | Default | Description |
---|---|---|---|
autoGridCount | Boolean | false | Specifies whether number of gridCount is specified automatically, acoarding to the axis size. |
backgroundAlpha | Number | 1 | Background opacity. |
backgroundColor | String | #D4D4D4 | Background color of the scrollbar. |
categoryAxis | CategoryAxis | instance of CategoryAxis | Read-only. Category axis of the scrollbar. |
color | String | Text color. Will use chart's color if not set. | |
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. |
graph | AmGraph | Specifies which graph will be displayed in the scrollbar. Only Serial chart's scrollbar can display a graph. | |
graphFillAlpha | Number | 0.1 | Graph fill opacity. Value range is 0 - 1. |
graphFillColor | String | #000000 | Graph fill color. |
graphLineAlpha | Number | 0 | Graph line opacity. Value range is 0 - 1. |
graphLineColor | String | #000000 | Graph line color. |
graphType | String | 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 | 0.7 | Grid opacity. Value range is 0 - 1. |
gridColor | String | #FFFFFF | Grid color. |
gridCount | Number | 0 | The number of grid lines. |
hideResizeGrips | Boolean | false | Specifies whether resize grips are hidden when mouse is away from the scrollbar. |
maximum | Number | Maximum value of ValueAxis of ChartScrollbar. Calculated automatically, of not set. | |
minimum | Number | Minimum value of ValueAxis of ChartScrollbar. Calculated automatically, of not set. | |
resizeEnabled | Boolean | true | Specifies whether scrollbar has a resize feature. |
scrollbarHeight | Number | 20 | Height (width, if chart is rotated) of a scrollbar. |
scrollDuration | Number | 2 | Duration of scrolling, when the user clicks on scrollbar's background, in seconds. |
selectedBackgroundAlpha | Number | 1 | Selected backround opacity. |
selectedBackgroundColor | String | #EFEFEF | Selected background color. |
selectedGraphFillAlpha | Number | 0.5 | Selected graph's fill opacity. Value range is 0 - 1. |
selectedGraphFillColor | String | #000000 | Selected graph's fill color. |
selectedGraphLineAlpha | Number | 0 | Selected graph's line opacity. Value range is 0 - 1. |
selectedGraphLineColor | String | #000000 | Selected graph's line color. |
updateOnReleaseOnly | Boolean | false | Specifies if the chart should be updated while dragging/resizing the scrollbar or only at the moment when user releases mouse button. |