ChartCursorSettings settings set's settings for chart cursor. 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 ChartCursor class will be used.
| Property | Type | Default | Description |
|---|---|---|---|
| balloonPointerOrientation | String | horizontal | Specifies orientation of value balloon pointer. |
| bulletsEnabled | Boolean | Specifies if bullet for each graph will follow the cursor. | |
| bulletSize | Number | Size of bullets, following the cursor. | |
| categoryBalloonAlpha | Number | Opacity of the category balloon. | |
| categoryBalloonColor | Color | Color of the category balloon. | |
| categoryBalloonDateFormats | Array[Object] | [{period:"YYYY", format:"YYYY"}, {period:"MM", format:"MMM, YYYY"}, {period:"WW", format:"MMM DD, YYYY"}, {period:"DD", format:"MMM DD, YYYY"}, {period:"hh", format:"JJ:NN"}, {period:"mm", format:"JJ:NN"}, {period:"ss", format:"JJ:NN:SS"}, {period:"fff", format:"JJ:NN:SS"}] | Array of date format objects. Date format object must have "period" and "format" items. Available periods are: fff - millisecond, ss - second, mm - minute, hh - hour, DD - date, WW - week, MM - month, YYYY - year. |
| categoryBalloonEnabled | Boolean | Specifies whether category balloon is enabled. | |
| categoryBalloonFunction | Allows formatting any category balloon text you want. categoryBalloonFunction should return a string which will be displayed in a balloon. When categoryBalloonFunction is called, category value (or date) is passed as an argument. | ||
| categoryBalloonText | String | [[category]] | You can have [[category]] - [[toCategory]] tags in there and show category ranges this way. |
| color | Color | #FFFFFF | Text color. |
| cursorAlpha | Number | Opacity of the cursor line. | |
| cursorColor | Color | Color of the cursor line. | |
| cursorPosition | String | Possible values: start, middle, mouse. | |
| enabled | Boolean | true | Set this to "false" if you don't want chart cursor to appear in your charts. |
| fullWidth | Boolean | false | If set to true, instead of a cursor line user will see a fill which width will always be equal to the width of one data item. We'd recommend setting cursorAlpha to 0.1 or some other small number if using this feature. |
| graphBulletSize | Number | 1.7 | Size of a graph's bullet (if available) at the cursor position. If you don't want the bullet to change it's size, set this property to 1. |
| leaveAfterTouch | Boolean | true | his makes cursor and balloons to remain after user touches the chart. |
| leaveCursor | Boolean | false | Specifies if cursor should be left at it's last position. Useful for touch devices - user might want to see the balloons after he moves finger away. |
| onePanelOnly | Boolean | false | If you set this to true, Stock Chart will display value balloons on currently hovered panel only. |
| pan | Boolean | If this is set to true, the user will be able to pan the chart instead of zooming. | |
| selectWithoutZooming | Boolean | false | Specifies if cursor should only mark selected area but not zoom-in after user releases mouse button. |
| showNextAvailable | Boolean | false | If true, the graph will display balloon on next available data point if currently hovered item doesn't have value for this graph. |
| valueBalloonsEnabled | Boolean | false | Specifies whether value balloons are enabled. In case they are not, the balloons might be displayed anyway, when the user rolls-over the column or bullet. |
| valueLineAlpha | Number | Opacity of value line. Will use cursorAlpha value if not set. | |
| valueLineBalloonEnabled | Boolean | false | Specifies if value balloon next to value axis labels should be displayed. If you have more than one axis, set valueLineAxis property of ChartCursor to indicate which axis should display the balloon. |
| valueLineEnabled | Boolean | false | Specifies if cursor of Serial chart should display horizontal (or vertical if chart is rotated) line. This line might help users to compare distant values of a chart. You can also enable value balloon on this line by setting valueLineAxis property of ChartCursor. |
| zoomable | Boolean | Specifies if the user can zoom-in the chart. If pan is set to true, zoomable is switched to false automatically. |