| Package | com.amcharts.stock |
| Class | public class ChartCursorSettings |
| Inheritance | ChartCursorSettings  flash.events.EventDispatcher |
If a property has no default value and it is not defined, default styles and properties of ChartCursor will be used. Check AmChartsBundle documentation to see these defaults.
You can set chart-specific properties and styles directly on ChartCursor classes only if a property doesn't have default value here. Note, properties set have higher priority.
| Property | Defined by | ||
|---|---|---|---|
| bulletsEnabled : Boolean
Specifies if bullet for each graph will follow the cursor.
| ChartCursorSettings | ||
| bulletSize : Number
Size of bullets, following the cursor.
| ChartCursorSettings | ||
| categoryBalloonAlpha : Number
Opacity of the category balloon.
| ChartCursorSettings | ||
| categoryBalloonColor : Number
Opacity of the category balloon.
| ChartCursorSettings | ||
| categoryBalloonDateFormats : Array
Array of date format objects.
| ChartCursorSettings | ||
| categoryBalloonEnabled : Boolean
Specifies whether category balloon is enabled.
| ChartCursorSettings | ||
| crosshair : Boolean
If crosshair is set to true, a value line will also be displayed and will follow the mouse
This affects serial chart only, as XY chart shows crosshair by default.
| ChartCursorSettings | ||
| cursorAlpha : Number
Opacity of the cursor line.
| ChartCursorSettings | ||
| cursorColor : Number
Color of the cursor line.
| ChartCursorSettings | ||
| cursorPosition : String
Position of a cursor.
| ChartCursorSettings | ||
| enabled : Boolean
Specifies whether cursor is enabled.
| ChartCursorSettings | ||
| pan : Boolean
If this is set to true, the user will be able to pan the chart instead of zooming.
| ChartCursorSettings | ||
| selectionAlpha : Number
Opacity of the selection.
| ChartCursorSettings | ||
| selectWithoutZooming : Boolean
Specifies if the user can select (mark) chart without zooming it.
| ChartCursorSettings | ||
| showValueAxisValue : Boolean
Chart Cursor can also display value of Value axis (do not mix with value balloons - they display value of a graph).
| ChartCursorSettings | ||
| valueAxisBalloonAlpha : Number
Opacity of value axis balloon.
| ChartCursorSettings | ||
| valueAxisBalloonColor : Number
Color of value axis balloon.
| ChartCursorSettings | ||
| valueAxisBalloonTextColor : Number
Color of value axis balloon text.
| ChartCursorSettings | ||
| valueBalloonsEnabled : Boolean
Specifies whether value balloons are enabled.
| ChartCursorSettings | ||
| zoomable : Boolean
Specifies if the user can zoom-in the chart.
| ChartCursorSettings | ||
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| ChartCursorSettings | ||
|
categoryBalloonDateFormat(period:String):String
Returns category balloon date format of a period.
| ChartCursorSettings | ||
| bulletsEnabled | property |
bulletsEnabled:Boolean [read-write]Specifies if bullet for each graph will follow the cursor.
Implementation public function get bulletsEnabled():Boolean
public function set bulletsEnabled(value:Boolean):void
| bulletSize | property |
bulletSize:Number [read-write]Size of bullets, following the cursor.
Implementation public function get bulletSize():Number
public function set bulletSize(value:Number):void
| categoryBalloonAlpha | property |
categoryBalloonAlpha:Number [read-write]Opacity of the category balloon.
Implementation public function get categoryBalloonAlpha():Number
public function set categoryBalloonAlpha(value:Number):void
| categoryBalloonColor | property |
categoryBalloonColor:Number [read-write]Opacity of the category balloon.
Implementation public function get categoryBalloonColor():Number
public function set categoryBalloonColor(value:Number):void
| categoryBalloonDateFormats | property |
categoryBalloonDateFormats:Array [read-write]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. format can contain any string supported by mx.formatters.DateFormatter class. For example: {period:"DD", format:"MMM DD"}
The default value is [{period:"YYYY", format:"YYYY"}, {period:"MM", format:"MMM DD, 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"}].
public function get categoryBalloonDateFormats():Array
public function set categoryBalloonDateFormats(value:Array):void
| categoryBalloonEnabled | property |
categoryBalloonEnabled:Boolean [read-write]Specifies whether category balloon is enabled.
Implementation public function get categoryBalloonEnabled():Boolean
public function set categoryBalloonEnabled(value:Boolean):void
| crosshair | property |
crosshair:Boolean [read-write]If crosshair is set to true, a value line will also be displayed and will follow the mouse This affects serial chart only, as XY chart shows crosshair by default. Vertical (value) zooming is not possible in Serial chart event crosshair is displayed.
Implementation public function get crosshair():Boolean
public function set crosshair(value:Boolean):void
| cursorAlpha | property |
cursorAlpha:Number [read-write]Opacity of the cursor line.
Implementation public function get cursorAlpha():Number
public function set cursorAlpha(value:Number):void
| cursorColor | property |
cursorColor:Number [read-write]Color of the cursor line.
Implementation public function get cursorColor():Number
public function set cursorColor(value:Number):void
| cursorPosition | property |
cursorPosition:String [read-write]Position of a cursor. 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 instead glueing to the nearest data point, set "mouse" here. Possible values are: start, middle, mouse.
Implementation public function get cursorPosition():String
public function set cursorPosition(value:String):void
| enabled | property |
enabled:Boolean [read-write]Specifies whether cursor is enabled.
The default value is true.
public function get enabled():Boolean
public function set enabled(value:Boolean):void
| pan | property |
pan:Boolean [read-write]If this is set to true, the user will be able to pan the chart instead of zooming.
Implementation public function get pan():Boolean
public function set pan(value:Boolean):void
| selectionAlpha | property |
selectionAlpha:Number [read-write]Opacity of the selection.
Implementation public function get selectionAlpha():Number
public function set selectionAlpha(value:Number):void
| selectWithoutZooming | property |
selectWithoutZooming:Boolean [read-write]Specifies if the user can select (mark) chart without zooming it. zoomable should be set to true in order this to work.
Implementation public function get selectWithoutZooming():Boolean
public function set selectWithoutZooming(value:Boolean):void
| showValueAxisValue | property |
showValueAxisValue:Boolean [read-write]Chart Cursor can also display value of Value axis (do not mix with value balloons - they display value of a graph). If this is set to true, value of first value axis will be displayed for each panel.
The default value is false.
public function get showValueAxisValue():Boolean
public function set showValueAxisValue(value:Boolean):void
| valueAxisBalloonAlpha | property |
valueAxisBalloonAlpha:Number [read-write]Opacity of value axis balloon.
Implementation public function get valueAxisBalloonAlpha():Number
public function set valueAxisBalloonAlpha(value:Number):void
| valueAxisBalloonColor | property |
valueAxisBalloonColor:Number [read-write]Color of value axis balloon.
Implementation public function get valueAxisBalloonColor():Number
public function set valueAxisBalloonColor(value:Number):void
| valueAxisBalloonTextColor | property |
valueAxisBalloonTextColor:Number [read-write]Color of value axis balloon text.
Implementation public function get valueAxisBalloonTextColor():Number
public function set valueAxisBalloonTextColor(value:Number):void
| valueBalloonsEnabled | property |
valueBalloonsEnabled:Boolean [read-write]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.
The default value is false.
public function get valueBalloonsEnabled():Boolean
public function set valueBalloonsEnabled(value:Boolean):void
| zoomable | property |
zoomable:Boolean [read-write]Specifies if the user can zoom-in the chart. If pan is set to true, zoomable is switched to false automatically.
Implementation public function get zoomable():Boolean
public function set zoomable(value:Boolean):void
| ChartCursorSettings | () | constructor |
public function ChartCursorSettings()Constructor.
| categoryBalloonDateFormat | () | method |
public function categoryBalloonDateFormat(period:String):StringReturns category balloon date format of a period.
Parametersperiod:String |
String |