ChartCursor – amCharts Version 2 Documentation

Type class

ChartCursor is a class which displays a cursor which follows the mouse. In case of Serial chart it also shows value and category balloons.

Example of how cursor is added to the chart:

var chart = new AmCharts.AmSerialChart();
var chartCursor = new AmCharts.ChartCursor();
chart.addChartCursor(chartCursor);

Inheritance

ChartCursor does not extend any other symbol.

ChartCursor is not extended by any other symbol.

Properties

bulletsEnabled #	Type `boolean` Default `false` Specifies if bullet for each graph will follow the cursor.
bulletSize #	Type `number` Default `8` Size of bullets, following the cursor.
categoryBalloonAlpha #	Type `number` Default `1` Opacity of the category balloon.
categoryBalloonColor #	Type `string` Default Color of the category balloon. cursorColor is used if not set.
categoryBalloonDateFormat #	Type `string` Default `MMM DD, YYYY` Category balloon date format (used only if category axis parses dates). Check this page for instructions on how to format dates.
categoryBalloonEnabled #	Type `boolean` Default `true` Specifies whether category balloon is enabled.
categoryBalloonFunction #	Type `Function` 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.
color #	Type `string` Default `#FFFFFF` Text color.
cursorAlpha #	Type `number` Default `1` Opacity of the cursor line.
cursorColor #	Type `string` Default `#CC0000` Color of the cursor line.
cursorPosition #	Type `string` Default Specifies where the cursor line should be placed - on the beginning of the period (day, hour, etc) or in the middle (only when parseDates property of categoryAxis is set to true). If you want the cursor to follow mouse and not to glue to the nearest data point, set "mouse" here. Possible values are: "start", "middle", "mouse".
enabled #	Type `boolean` Default `true` Specifies whether cursor is enabled.
oneBalloonOnly #	Type `boolean` Default `false` If this is set to true, only one balloon at a time will be displayed. Note, this is quite CPU consuming.
pan #	Type `boolean` Default `false` If this is set to true, the user will be able to pan the chart (Serial only) instead of zooming.
selectionAlpha #	Type `number` Default Opacity of the selection.
selectWithoutZooming #	Type `boolean` Default `false` Specifies if cursor should only mark selected area but not zoom-in after user releases mouse button.
valueBalloonsEnabled #	Type `boolean` Default `true` 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 `boolean` Default `true` Specifies if the user can zoom-in the chart. If pan is set to true, zoomable is switched to false automatically.
zooming #	Type `boolean` Default Indicates if currently user is selecting some chart area to zoom-in.

Methods

addListener( `type`, `handler` ) #	Returns `void` Adds event listener to the object. type - string like 'changed' (should be listed in 'events' section of this class or classes which extend this class). handler - function which is called when event happens
hideCursor() #	Returns `void` Hides cursor.
removeListener( `obj`, `type`, `handler` ) #	Returns `void` Removes event listener from the object.
showCursorAt( `category` ) #	Returns `void` You can force cursor to appear at specified cateogry or date.

addListener(
type,
handler
)

Returns void

Adds event listener to the object.

type - string like 'changed' (should be listed in 'events' section of this class or classes which extend this class). handler - function which is called when event happens

hideCursor()

Returns void

Hides cursor.

removeListener(
  obj,
  type,
  handler
)

Returns void

Removes event listener from the object.

showCursorAt(
category
)

Returns void

You can force cursor to appear at specified cateogry or date.

Events

#changed	Param `{type:"changed", index:Number, zooming:Boolean, mostCloseGraph:AmGraph, chart:AmChart }` Dispatched when cursor position is changed. "index" is a series index over which chart cursors currently is. "zooming" specifies if user is currently zooming (is selecting) the chart. mostCloseGraph property is set only when oneBalloonOnly is set to true.
#onHideCursor	Param `{type:"onHideCursor", chart:AmChart}` Dispatched when cursor is hidden.
#selected	Param `{type:"changed", index:Number, zooming:Boolean, chart:AmChart}` Dispatched if selectWithoutZooming is set to true and when user selects some period. start and end are indices or time stamp (when categoryAxis.parseDates is true) of selection start/end.
#zoomed	Param `{type:"changed", index:Number, zooming:Boolean, chart:AmChart}` Dispatched when user zooms to some period. start and end are indices or time stamp (when categoryAxis.parseDates is true) of selection start/end.

Adapters

ChartCursor does not have any adapters.