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.

ChartCursorSettings

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.

Properties

PropertyTypeDefaultDescription
bulletsEnabledBoolean Specifies if bullet for each graph will follow the cursor.
bulletSizeNumber Size of bullets, following the cursor.
categoryBalloonAlphaNumber Opacity of the category balloon.
categoryBalloonColorString Color of the category balloon.
categoryBalloonDateFormatsArray[{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.
categoryBalloonEnabledBoolean Specifies whether category balloon is enabled.
cursorAlphaNumber Opacity of the cursor line.
cursorColorString Color of the cursor line.
cursorPositionString Possible values: "start", "middle" and "mouse".
enabledBooleantrueSet this to "false" if you don't want chart cursor to appear in your charts.
panBoolean If this is set to true, the user will be able to pan the chart instead of zooming.
valueBalloonsEnabledBooleanfalseSpecifies 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.
zoomableBoolean Specifies if the user can zoom-in the chart. If pan is set to true, zoomable is switched to false automatically.

Methods

ChartCursorSettings class does not have any methods.

Events

ChartCursorSettings class does not have any events.