ChartCursorSettings

Type class

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.

Sources

This information about ChartCursorSettings is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

ChartCursorSettings does not extend any other symbol.

ChartCursorSettings is not extended by any other symbol.

Properties

#bulletsEnabled

Type booleanDefault

Specifies if bullet for each graph will follow the cursor.

#bulletSize

Type numberDefault

Size of bullets, following the cursor.

#categoryBalloonAlpha

Type numberDefault

Opacity of the category balloon.

#categoryBalloonColor

Type stringDefault

Color of the category balloon.

#categoryBalloonDateFormats

Type arrayDefault [{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

Type booleanDefault

Specifies whether category balloon is enabled.

#cursorAlpha

Type numberDefault

Opacity of the cursor line.

#cursorColor

Type stringDefault

Color of the cursor line.

#cursorPosition

Type stringDefault

Possible values: "start", "middle" and "mouse".

#enabled

Type booleanDefault true

Set this to "false" if you don't want chart cursor to appear in your charts.

#pan

Type booleanDefault

If this is set to true, the user will be able to pan the chart instead of zooming.

#valueBalloonsEnabled

Type booleanDefault 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.

#zoomable

Type booleanDefault

Specifies if the user can zoom-in the chart. If pan is set to true, zoomable is switched to false automatically.

Methods

ChartCursorSettings does not have any methods.

Events

ChartCursorSettings does not have any events.