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.

Inheritance

ChartCursorSettings does not extend any other symbol.

ChartCursorSettings is not extended by any other symbol.

Properties

balloonPointerOrientation
#

Type string

Default horizontal

Specifies orientation of value balloon pointer.

bulletsEnabled
#

Type boolean

Specifies if bullet for each graph will follow the cursor.

bulletSize
#

Type number

Size of bullets, following the cursor.

categoryBalloonAlpha
#

Type number

Opacity of the category balloon.

categoryBalloonColor
#

Type color

Color of the category balloon.

categoryBalloonDateFormats
#

Type object[]

Default [{
  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 boolean

Specifies whether category balloon is enabled.

categoryBalloonText
#

Type string

Default [[category]]

You can have [[category]] - [[toCategory]] tags in there and show category ranges this way.

color
#

Type color

Default #FFFFFF

Text color.

cursorAlpha
#

Type number

Opacity of the cursor line.

cursorColor
#

Type color

Color of the cursor line.

cursorPosition
#

Type string

Possible values: start, middle, mouse.

enabled
#

Type boolean

Default true

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

fullWidth
#

Type boolean

Default 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
#

Type number

Default 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
#

Type boolean

Default true

his makes cursor and balloons to remain after user touches the chart.

leaveCursor
#

Type boolean

Default 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
#

Type boolean

Default false

If you set this to true, Stock Chart will display value balloons on currently hovered panel only.

pan
#

Type boolean

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

selectWithoutZooming
#

Type boolean

Default false

Specifies if cursor should only mark selected area but not zoom-in after user releases mouse button.

showNextAvailable
#

Type boolean

Default 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
#

Type boolean

Default 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
#

Type number

Opacity of value line. Will use cursorAlpha value if not set.

valueLineBalloonEnabled
#

Type boolean

Default 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
#

Type boolean

Default 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
#

Type boolean

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.

Adapters

ChartCursorSettings does not have any adapters.