ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
coldfusion.service.mxml 

Chart  - AS3 CF

Packagecoldfusion.service.mxml
Classpublic class Chart
InheritanceChart Inheritance BasicService Inheritance InternalConfig Inheritance Object

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

The proxy class for chart services that are exposed by ColdFusion. This class extends from the BasicService class that has common functionality built across services.



Public Properties
 PropertyDefined By
 Inheritedaction : String
Action string for the service.
BasicService
  backgroundColor : String
Color of the area between the data background and the chart border, around labels and around the legend.
Chart
 InheritedcfContextRoot : String
Context root of the ColdFusion server.
InternalConfig
 InheritedcfPort : int
Port where the ColdFusion server is running.
InternalConfig
 InheritedcfServer : String
Name or IP address of the ColdFusion server.
InternalConfig
  chartHeight : String
Height of the chart.
Chart
  chartSeries : Array
Defines the chart style in which the data displays: bar, line, pie, and so on.
Chart
  chartWidth : String
Width of the chart.
Chart
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  dataBackgroundColor : String
Color of area around chart data.
Chart
 Inheriteddestination : String
Specifies the destination for the remoting call.
InternalConfig
  font : String
Name of text font: arial times courier arialunicodeMS
Chart
  fontBold : String
Whether to make the text bold: yes no
Chart
  fontItalic : String
Whether to make the text italicized: yes no
Chart
  fontSize : String
Font size.
Chart
  foregroundColor : String
Color of text, grid lines, and labels.
Chart
  format : String
File format in which to save the graph: flash jpg png
Chart
  gridLines : String
Number of grid lines to display on the value axis, including axis; positive integer.
Chart
  labelFormat : String
Format for y-axis labels: number currency percent date
Chart
  markerSize : String
Size of data point marker in pixels; integer.
Chart
  piesliceStyle : String
Applies to the cfchartseriestype attribute value pie: solid: displays pie as if unsliced. sliced: displays pie as if sliced.
Chart
  scaleFrom : String
Y-axis minimum value; integer.
Chart
  scaleTo : String
Y-axis maximum value; integer.
Chart
 InheritedsecureHttp : Boolean
Boolean value that specifies if secure HTTP is used: yes: uses secure HTTP no: does not use secure HTTP
InternalConfig
  seriesPlacement : String
Relative positions of series in charts that have more than one data series: default: ColdFusion determines relative positions, based on graph types cluster stacked percent
Chart
 InheritedservicePassword : String
Password to access ColdFusion services.
InternalConfig
 InheritedserviceUserName : String
Username to access ColdFusion services.
InternalConfig
  show3d : String
Whether to display the chart with three-dimensional appearance: yes no
Chart
  showBorder : String
Whether to display a border around the chart: yes no
Chart
  showLegend : String
Whether to display the legend if the chart contains more than one data series: yes no
Chart
  showMarkers : String
Whether to display markers at data points in line, curve, and scatter graphs: yes no
Chart
  showxGridLines : String
Whether to display x-axis gridlines: yes no
Chart
  showyGridLines : String
Whether to display y-axis gridlines: yes no
Chart
  sortXAxis : String
Whether to display column labels in alphabetic order along the x axis: yes no Ignored if the xAxisType attribute is scale.
Chart
  tipBgColor : String
Background color of tips.
Chart
  tipStyle : String
Determines the action that opens a pop-up window to display information about the current chart element.
Chart
  title : String
Title of the chart.
Chart
  url : String
URL to open if the user clicks item in a data series; the onClick destination page.
Chart
  xAxisTitle : String
Title that appears on the x axis; text.
Chart
  xAxisType : String
Whether the x axis indicates data or is numeric: category: The axis indicates the data category.
Chart
  xOffset : String
Number of units by which to display the chart as angled, horizontally.
Chart
  yAxisTitle : String
Title of the y axis; text.
Chart
  yAxisType : String
Currently has no effect, as the y axis is always used for data values.
Chart
  yOffset : String
Number of units by which to display the chart as angled, vertically.
Chart
Public Methods
 MethodDefined By
  
Creates an instance of the Chart class.
Chart
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
BasicService
 Inherited
Dispatches an event into the event flow.
BasicService
  
Sends the information to the ColdFusion service based on the action and the attributes that the user sets.
Chart
 Inherited
Returns the RemoteObject instance used by the proxy classes to make the remote object call.
BasicService
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
BasicService
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
BasicService
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
BasicService
Events
 Event Summary Defined By
 InheritedDispatched when a ColdFusion service call fails.BasicService
 InheritedDispatched when a ColdFusion service call returns successfully.BasicService
Property Detail

backgroundColor

property
public var backgroundColor:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Color of the area between the data background and the chart border, around labels and around the legend. Hexadecimal value or supported named color.

chartHeight

property 
public var chartHeight:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Height of the chart. Integer number of pixels.

The default value is 240.

chartSeries

property 
public var chartSeries:Array

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Defines the chart style in which the data displays: bar, line, pie, and so on.

chartWidth

property 
public var chartWidth:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Width of the chart. Integer number of pixels.

The default value is 320.

dataBackgroundColor

property 
public var dataBackgroundColor:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Color of area around chart data. Hexadecimal value or supported named color.

The default value is white.

font

property 
public var font:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Name of text font:

  • arial
  • times
  • courier
  • arialunicodeMS

The default value is arial.

fontBold

property 
public var fontBold:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether to make the text bold:

  • yes
  • no

The default value is no.

fontItalic

property 
public var fontItalic:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether to make the text italicized:

  • yes
  • no

The default value is no.

fontSize

property 
public var fontSize:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Font size. If the number is not an integer, ColdFusion rounds the number up to the next integer.

The default value is 11.

foregroundColor

property 
public var foregroundColor:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Color of text, grid lines, and labels. Hexadecimal value or supported named color.

The default value is black.

format

property 
public var format:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

File format in which to save the graph:

  • flash
  • jpg
  • png

The default value is flash.

gridLines

property 
public var gridLines:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Number of grid lines to display on the value axis, including axis; positive integer.

The default value is 10, including top and bottom.

labelFormat

property 
public var labelFormat:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Format for y-axis labels:

  • number
  • currency
  • percent
  • date

The default value is number.

markerSize

property 
public var markerSize:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Size of data point marker in pixels; integer.

The default value is (Automatic).

piesliceStyle

property 
public var piesliceStyle:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Applies to the cfchartseriestype attribute value pie:

  • solid: displays pie as if unsliced.
  • sliced: displays pie as if sliced.

The default value is sliced.

scaleFrom

property 
public var scaleFrom:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Y-axis minimum value; integer.

The default value is Determined by data.

scaleTo

property 
public var scaleTo:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Y-axis maximum value; integer.

The default value is Determined by data.

seriesPlacement

property 
public var seriesPlacement:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Relative positions of series in charts that have more than one data series:

  • default: ColdFusion determines relative positions, based on graph types
  • cluster
  • stacked
  • percent

The default value is default.

show3d

property 
public var show3d:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether to display the chart with three-dimensional appearance:

  • yes
  • no

The default value is yes.

showBorder

property 
public var showBorder:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether to display a border around the chart:

  • yes
  • no

The default value is no.

showLegend

property 
public var showLegend:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether to display the legend if the chart contains more than one data series:

  • yes
  • no

The default value is yes.

showMarkers

property 
public var showMarkers:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether to display markers at data points in line, curve, and scatter graphs:

  • yes
  • no

The default value is yes.

showxGridLines

property 
public var showxGridLines:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether to display x-axis gridlines:

  • yes
  • no

The default value is no.

showyGridLines

property 
public var showyGridLines:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether to display y-axis gridlines:

  • yes
  • no

The default value is yes.

sortXAxis

property 
public var sortXAxis:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether to display column labels in alphabetic order along the x axis:

  • yes
  • no
Ignored if the xAxisType attribute is scale.

The default value is no.

tipBgColor

property 
public var tipBgColor:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Background color of tips. Applies only to Flash format graph files. Hexadecimal value or supported named color.

The default value is white.

tipStyle

property 
public var tipStyle:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Determines the action that opens a pop-up window to display information about the current chart element.

  • mouseDown: Displays if the user positions the cursor at the element and clicks the mouse. Applies only to Flash format graph files. (For other formats, this option functions the same as mouseOver.)
  • mouseOver: Displays if the user positions the cursor at the element.
  • none: Suppresses display

The default value is mouseOver.

title

property 
public var title:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Title of the chart.

url

property 
public var url:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

URL to open if the user clicks item in a data series; the onClick destination page. You can specify variables within the URL string; ColdFusion passes current values of the variables:

  • $VALUE$: The value of the selected row. If none, the value is an empty string.
  • $ITEMLABEL$: The label of the selected item. If none, the value is an empty string.
  • $SERIESLABEL$: The label of the selected series. If none, the value is an empty string.
  • "javascript:...": Executes a client-side script.

xAxisTitle

property 
public var xAxisTitle:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Title that appears on the x axis; text.

xAxisType

property 
public var xAxisType:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether the x axis indicates data or is numeric:

  • category: The axis indicates the data category. Data is sorted according to the sortXAxis attribute.
  • scale: The axis is numeric. All cfchartdataitem attribute values must be numeric. The x axis is automatically sorted numerically.

The default value is category.

xOffset

property 
public var xOffset:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Number of units by which to display the chart as angled, horizontally. Applies if show3D="yes". The number can be between -1 and 1, where "-1" specifies 90 degrees left and "1" specifies 90 degrees right.

The default value is 0.1.

yAxisTitle

property 
public var yAxisTitle:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Title of the y axis; text.

yAxisType

property 
public var yAxisType:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Currently has no effect, as the y axis is always used for data values.

The default value is category.

yOffset

property 
public var yOffset:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Number of units by which to display the chart as angled, vertically. Applies if show3D="yes". The number can be between -1 and 1, where "-1" specifies 90 degrees left and "1" specifies 90 degrees right.

The default value is 0.1.

Constructor Detail

Chart

()Constructor
public function Chart()

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Creates an instance of the Chart class.

Method Detail

execute

()method
public function execute():void

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Sends the information to the ColdFusion service based on the action and the attributes that the user sets.