setSize
Availability
Flash Player 6.
Usage
myBarChart.setSize(width, height)
Parameters
width The new width in pixels.
height The new height in pixels.
Returns
Nothing.
Description
Method; lets the user specify the width (in pixels) and height of the component.
Example
The following code makes a BarChart 300 pixels wide and 200 pixels high:
myBarChart.setSize(300,200);
addItemAt
Availability
Flash Player 6.
Usage
myBarChart.addItemAt(index, value)
Parameters
index The position for inserting the value into the data provider.
value An object or primitive data type.
Returns
Nothing.
Description
Method; adds an object or value to a specified index position in the chart’s data provider and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code adds an item called “Flash5Magic”, author “Sam” with price 34 as the third item in the chart.
chart.addItemAt(3, {title:"Flash5Magic", author:"Sam", price:34});
addItem
Availability
Flash Player 6.
Usage
myBarChart.addItem(value)
Parameters
value An object or primitive data type.
Returns
Nothing.
Description
Method; pushes an object or value to the top of the chart's data provider contents, much like the “push” method in arrays, and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code adds an item called “Flash5Magic”, author “Sam” with price 34 to the chart.
chart.addItem({title:"Flash5Magic", author:"Sam", price:34});
removeItemAt
Availability
Flash Player 6.
Usage
myBarChart.removeItemAt(index)
Parameters
index An integer index number of an item in the chart’s data provider.
Returns
The item to be removed from the data provider.
Description
Method; removes an item from the chart's data provider at the specified index position and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code removes the second item from the chart, and returns that item into a variable.
deadItem = chart.removeItemAt(2);
removeAll
Availability
Flash Player 6.
Usage
myBarChart.removeAll()
Parameters
None.
Returns
Nothing.
Description
Method; clears out all the contents of the chart's data provider, rendering it empty and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code removes all items from the chart:
chart.removeItemAt(2);
sortItemsBy
Availability
Flash Player 6.
Usage
myBarChart.sortItemsBy(fieldName, order)
Parameters
fieldName A string specifying the name of the field used for sorting. This will normally be “label” or “data”.
order A string specifying whether to sort the items in ascending order (ASC) or descending order (DESC).
Returns
Nothing.
Description
Method; sorts the items in the chart and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code sorts the chart by descending price:
chart.sortItemsBy("price", "DESC");
getLength
Availability
Flash Player 6.
Usage
myBarChart.getLength()
Parameters
None.
Returns
An integer. The number of items in the data provider object.
Description
Method; retrieves the number of items in the chart's data provider. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code returns the number of items in the chart:
itemCount = chart.getLength();
getItemAt
Availability
Flash Player 6.
Usage
myBarChart.getItemAt(index)
Parameters
index An integer specifying the index of the item to retrieve.
Returns
An item in the chart’s data provider at the specified index as an object.
Description
Method; returns the item at the specified index as an object. If there is no item at the specified index, the method returns undefined. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code prints the title of the third item in the chart.
myItem = chart.getItemAt(3);
trace(myItem["title"]);
setDataProvider
Availability
Flash Player 6.
Usage
myBarChart.setDataProvider(dataProvider)
Parameters
dataProvider An array of text strings listing the items to add, an instance of the Array object specifying the items to add, or an instance of the DataProvider class.
Returns
Nothing.
Description
Method; registers an outside variable (dataProvider, which must be an instance of DataProvider class) to the component, and registers as a view to listen for any updates to the DataProvider. Any updates to the data provider will trigger a modelChanged event, which causes the graph to re-render itself. If the user has predefined a list of values in the component parameter, setting a data provider will override those values.
Example
The following code creates a data provider with three items and sets it on the chart.
var theData = new DataProviderClass();
var items = new Array({stock: "Apples", value: 19}, {stock: "Oranges", value:60}, {stock: "Pears", value: 5});
for (var i = 0; i < items.length; i++) {
theData.addItem(items[i]);
}
chart.setDataProvider(theData);
setLabelSource
Availability
Flash Player 6.
Usage
myBarChart.setLabelSource(fieldName)
Parameters
fieldName A string value that should correspond with a field name in the recordset (which is defined as an object in the DataProvider API).
Returns
true if a field name exists and false if the field name is invalid.
Description
Method; sets the fieldName of the recordset that provides the labels for the independent variable ( x axis). It also causes the graph to re-render itself via the invalidate method (coalesces multiple function calls into a single function call for optimization).
Example
This code sets the chart's label source to the “MovieTitle” field in a recordset.
myBarGraph.setLabelSource("MovieTitle");
getLabelSource
Availability
Flash Player 6.
Usage
myBarChart.getLabelSource()
Parameters
None.
Returns
The field name.
Description
Method; returns the field name of the recordset that provides the labels for the y axis.
Example
The following code prints the label source of the chart:
var labelSource = chart.getLabelSource();
trace("Label Source: " + labelSource);
setValueSource
Availability
Flash Player 6.
Usage
myBarChart.setValueSource(fieldName)
Parameters
fieldName A string value that should correspond with a field name in the recordset (which is defined as an object in the DataProvider API).
Returns
true if a field name exists and false if the field name is invalid.
Description
Method; sets the field name of the recordset column that will provide the numeric values for the y axis.
Example
This code sets the value source to a recordset field called “MovieRating”.
myBarGraph.setValueSource("MovieRating");
getValueSource
Availability
Flash Player 6.
Usage
myBarChart.getValueSource()
Parameters
None.
Returns
The recordset field name.
Description
Method; returns the field name of the recordset that provides the labels for the x axis.
Example
The following code prints the value source of the chart:
var valueSource = chart.getValueSource();
trace("Value Source: " + valueSource);
setChartTitle
Availability
Flash Player 6.
Usage
myBarChart.setChartTitle(title)
Parameters
title A string value that sets the title of the chart.
Returns
Nothing.
Description
Method; sets the title of the chart.
Example
The following code makes the chart have the title “Car Sales Per Month” and re-renders the chart.
myBarGraph.setChartTitle("Car Sales Per Month");
getChartTitle
Availability
Flash Player 6.
Usage
myBarChart.getChartTitle()
Parameters
None.
Returns
The chart title.
Description
Method; gets the title of the chart.
Example
The following code prints the chart title:
var title = chart.getChartTitle();
trace("The chart title is: " + title);
setXAxisTitle
Availability
Flash Player 6.
Usage
myBarChart.setXAxisTitle(title)
Parameters
title A string value.
Returns
Nothing.
Description
Method; sets the title of the x axis.
Example
The following code set the x axis of the chart to “Car Sales Per Month”.
myBarGraph.setXAxisTitle("Car Sales Per Month");
getXAxisTitle
Availability
Flash Player 6.
Usage
myBarChart.getXAxisTitle()
Parameters
None.
Returns
The x axis parameters.
Description
Method; gets the title of the x axis.
Example
The following code prints the title of the x axis:
var title = chart.getXAxisTitle();
trace("The X axis title is: " + title);
setYAxisTitle
Availability
Flash Player 6.
Usage
myBarChart.setYAxisTitle(title)
Parameters
title A string value.
Returns
Nothing.
Description
Method; sets the title of the y axis.
Example
The following code sets the y axis of the chart to “Car Sales Per Month”.
myBarGraph.setYAxisTitle("Car Sales Per Month");
getYAxisTitle
Availability
Flash Player 6.
Usage
myBarChart.getYAxisTitle()
Parameters
None.
Returns
The y axis title.
Description
Method; gets the title of the y axis.
Example
The following code prints the title of the y axis:
var title = chart.getYAxisTitle();
trace("The Y axis title is: " + title);
setEnabled
Availability
Flash Player 6.
Usage
myBarChart.setEnabled(enable)
Parameters
enable A Boolean value specifying whether the BarChart is enabled ( true ) or disabled ( false ).
Returns
Nothing.
Description
Method; based on a similar method defined in FComboBox. Determines whether the component is enabled ( true ) or disabled ( false ). If the component is disabled, it does not accept mouse or keyboard interaction from the user. If you omit the parameter, this method defaults to true .
Example
The following code disables chart1:
chart1.setEnabled(false);
getEnabled
Availability
Flash Player 6.
Usage
myBarChart.getEnabled()
Parameters
None.
Returns
A Boolean value indicating whether the component is enabled ( true ) or disabled ( false ).
Description
Method; indicates whether the component is enabled.
Example
The following code uses getEnabled to determine whether the component is enabled or disabled and displays the result in the Output window.
trace(chart1.getEnabled());
setChartEventHandler
Availability
Flash Player 6.
Usage
myBarChart.setChartEventHandler(functionName, eventName, [location])
Parameters
functionName A string value that should correspond with a function name.
eventName A string value that should correspond to either “onPress”, “onRelease”, “onRollOver”, or “onRollOut”.
location This parameter is optional.
Returns
Nothing.
Description
Method; based on the setChangeHandler() method defined in FComboBox and FListBox. Specifies a change handler to call when the mouse cursor interacts with a marker in the graph (i.e., bar, pie wedge, line graph plot, etc.). You can specify the same change handler function for more than one component; the function always accepts the instance of the component that has changed as a parameter. Calling this method overrides the Chart Event Handlers parameter value specified in authoring.
The triggered function will receive two parameters: a reference to the component, and an index number for the recordset item associated with the marker (bar, wedge, line plot) in the chart.
Example
When the mouse cursor is released over a marker, a function named “selectRecord” will be called in the timeline containing the component, and the selectRecord function will receive two arguments: a reference to the component and a reference to the recordset item:
containerTimeline.selectRecord = function (componentRef, record) { if (componentRef == myBarGraph) {
trace(record["price"]);
}
}
setSize
Availability
Flash Player 6.
Usage
myLineChart.setSize(width, height)
Parameters
width The new width in pixels.
height The new height in pixels.
Returns
Nothing.
Description
Method; lets the user specify the width (in pixels) and height of the component.
Example
The following code makes a LineChart 300 pixels wide and 200 pixels high:
myLineChart.setSize(300,200);
setHighlights
Availability
Flash Player 6.
Usage
myLineChart.setHighlights(showHighlights)
Parameters
showHighlights A Boolean value specifying whether the highlights should be shown.
Returns
Nothing.
Description
Method; accepts a Boolean parameter to determine whether the line highlights should be shown.
Example
The following code hides the highlights:
chart.setHighlights(false);
The following code shows the highlights:
chart.setHighlights(true);
getHighlights
Availability
Flash Player 6.
Usage
myLineChart.getHighlights()
Parameters
None.
Returns
A Boolean value returning ( true ) if line highlights will be shown or ( false ) if not.
Description
Method; returns a Boolean value that determines whether the line highlights will be shown.
Example
The following code prints whether line highlighting is on:
var highlights = chart.getHighlights(false);
trace("Line highlighting is " + highlights);
setLineWeight
Availability
Flash Player 6.
Usage
myLineChart.setLineWeight(weight)
Parameters
weight The line weight (stroke height).
Returns
Nothing.
Description
Method; sets the line weight (stroke height) of the line in the line chart. Accepted values start from 0 (hairline) and upwards.
Example
The following code sets the line weight to 20 (very thick line).
chart.setLineWeight(20);
The following code sets the line weight to 0 (hairline weight).
chart.setLineWeight(0);
getLineWeight
Availability
Flash Player 6.
Usage
myLineChart.getLineWeight()
Parameters
None.
Returns
The line weight.
Description
Method; gets the line weight (stroke height) of the line in the line chart.
Example
The following code prints the line weight:
var lineWeight = chart.getLineWeight();
trace("Line Weight: " + lineWeight);
setLineColor
Availability
Flash Player 6.
Usage
myLineChart.setLineColor(color)
Parameters
color The color of the line in hexidecimal format.
Returns
Nothing.
Description
Method; sets the color of the line to a hexidecimal value.
Example
The following code sets the color to blue:
chart.setLineColor (0xFF0000);
getLineColor
Availability
Flash Player 6.
Usage
myLineChart.getLineColor()
Parameters
None.
Returns
The line color.
Description
Method; returns the color of the line.
Example
The following code prints the line color:
var lineColor = chart.getLineColor();
trace("Line Color: " + lineColor);
addItemAt
Availability
Flash Player 6.
Usage
myLineChart.addItemAt(index, value)
Parameters
index The position for inserting the value into the data provider.
value An object or primitive data type.
Returns
Nothing.
Description
Method; adds an object or value to a specified index position in the chart’s data provider and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code adds an item called “Flash5Magic”, author “Sam” with price 34 as the third item in the chart.
chart.addItemAt(3, {title:"Flash5Magic", author:"Sam", price:34});
addItem
Availability
Flash Player 6.
Usage
myLineChart.addItem(value)
Parameters
value An object or primitive data type.
Returns
Nothing.
Description
Method; pushes an object or value to the top of the chart's data provider contents, much like the “push” method in arrays and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code adds an item called “Flash5Magic”, author “Sam” with price 34 to the chart.
chart.addItem({title:"Flash5Magic", author:"Sam", price:34});
removeItemAt
Availability
Flash Player 6.
Usage
myLineChart.removeItemAt(index)
Parameters
index An integer index number of an item in the chart’s data provider.
Returns
The item to be removed from the data provider.
Description
Method; removes an item from the chart's data provider at the specified index position and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code removes the second item from the chart, and returns that item into a variable.
deadItem = chart.removeItemAt(2);
removeAll
Availability
Flash Player 6.
Usage
myLineChart.removeAll()
Parameters
None.
Returns
Nothing.
Description
Method; clears out all the contents of the chart's data provider, rendering it empty; and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code removes all items from the chart:
chart.removeItemAt(2);
sortItemsBy
Availability
Flash Player 6.
Usage
myLineChart.sortItemsBy(fieldName, order)
Parameters
fieldName A string specifying the name of the field used for sorting. This will normally be “label” or “data”.
order A string specifying whether to sort the items in ascending order (ASC) or descending order (DESC).
Returns
Nothing.
Description
Method; sorts the items in the chart and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code sorts the chart by descending price:
chart.sortItemsBy("price", "DESC");
getLength
Availability
Flash Player 6.
Usage
myLineChart.getLength()
Parameters
None.
Returns
An integer. The number of items in the data provider object.
Description
Method; retrieves the number of items in the chart's data provider. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code returns the number of items in the chart.
itemCount = chart.getLength();
getItemAt
Availability
Flash Player 6.
Usage
myLineChart.getItemAt(index)
Parameters
index An integer specifying the index of the item to retrieve.
Returns
An item in the chart’s data provider at the specified index as an object.
Description
Method; returns the item at the specified index as an object. If there is no item at the specified index, the method returns undefined. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code prints the title of the third item in the chart.
myItem = chart.getItemAt(3);
trace(myItem["title"]);
setDataProvider
Availability
Flash Player 6.
Usage
myLineChart.setDataProvider(dataProvider)
Parameters
dataProvider An array of text strings listing the items to add, an instance of the Array object specifying the items to add, or an instance of the DataProvider class.
Returns
Nothing.
Description
Method; registers an outside variable (dataProvider, which must be an instance of DataProvider class) to the component, and registers as a view to listen for any updates to the DataProvider. Any updates to the data provider will trigger a modelChanged event, which causes the graph to re-render itself. If the user has predefined a list of values in the component parameter, setting a data provider will override those values.
Example
The following code creates a data provider with three items and sets it on the chart.
var theData = new DataProviderClass();
var items = new Array({stock: "Apples", value: 19}, {stock: "Oranges", value:60}, {stock: "Pears", value: 5});
for (var i = 0; i < items.length; i++) {
theData.addItem(items[i]);
}
chart.setDataProvider(theData);
setLabelSource
Availability
Flash Player 6.
Usage
myLineChart.setLabelSource(fieldName)
Parameters
fieldName A string value that should correspond with a field name in the recordset (which is defined as an object in the DataProvider API).
Returns
true if a field name exists and false if the field name is invalid.
Description
Method; sets the fieldName of the recordset that provides the labels for the independent variable ( x axis). It also causes the graph to re-render itself via the invalidate method (coalesces multiple function calls into a single function call for optimization).
Example
This code sets the chart's label source to the “MovieTitle” field in a recordset.
myLineGraph.setLabelSource("MovieTitle");
getLabelSource
Availability
Flash Player 6.
Usage
myLineChart.getLabelSource()
Parameters
None.
Returns
The field name.
Description
Method; returns the field name of the recordset that provides the labels for the y axis.
Example
The following code prints the label source of the chart:
var labelSource = chart.getLabelSource();
trace("Label Source: " + labelSource);
setValueSource
Availability
Flash Player 6.
Usage
myLineChart.setValueSource(fieldName)
Parameters
fieldName A string value that should correspond with a field name in the recordset (which is defined as an object in the DataProvider API).
Returns
true if a field name exists and false if the field name is invalid.
Description
Method; sets the field name of the recordset column which will provide the numeric values for the y axis.
Example
This code sets the value source to a recordset field called “MovieRating”.
myLineGraph.setValueSource("MovieRating");
getValueSource
Availability
Flash Player 6.
Usage
myLineChart.getValueSource()
Parameters
None.
Returns
The recordset field name.
Description
Method; returns the field name of the recordset which provides the labels for the x axis.
Example
The following code prints the value source of the chart:
var valueSource = chart.getValueSource();
trace("Value Source: " + valueSource);
setChartTitle
Availability
Flash Player 6.
Usage
myLineChart.setChartTitle(title)
Parameters
title A string value that sets the title of the chart.
Returns
Nothing.
Description
Method; sets the title of the chart.
Example
The following code makes the chart have the title “Car Sales Per Month” and re-renders the chart.
myLineGraph.setChartTitle("Car Sales Per Month");
getChartTitle
Availability
Flash Player 6.
Usage
myLineChart.getChartTitle()
Parameters
None.
Returns
The chart title.
Description
Method; gets the title of the chart.
Example
The following code prints the chart title:
var title = chart.getChartTitle();
trace("The chart title is: " + title);
setXAxisTitle
Availability
Flash Player 6.
Usage
myLineChart.setXAxisTitle(title)
Parameters
title A string value.
Returns
Nothing.
Description
Method; sets the title of the x axis.
Example
The following code sets the x axis of the chart to “Car Sales Per Month”.
myLineGraph.setXAxisTitle("Car Sales Per Month");
getXAxisTitle
Availability
Flash Player 6.
Usage
myLineChart.getXAxisTitle()
Parameters
None.
Returns
The x axis parameters.
Description
Method; gets the title of the x axis.
Example
The following code prints the title of the x axis:
var title = chart.getXAxisTitle();
trace("The X axis title is: " + title);
setYAxisTitle
Availability
Flash Player 6.
Usage
myLineChart.setYAxisTitle(title)
Parameters
title A string value.
Returns
Nothing.
Description
Method; sets the title of the y axis.
Example
The following code set the y axis of the chart to “Car Sales Per Month”.
myLineGraph.setYAxisTitle("Car Sales Per Month");
getYAxisTitle
Availability
Flash Player 6.
Usage
myLineChart.getYAxisTitle()
Parameters
None.
Returns
The y axis title.
Description
Method; gets the title of the y axis.
Example
The following code prints the title of the y axis:
var title = chart.getYAxisTitle();
trace("The Y axis title is: " + title);
setEnabled
Availability
Flash Player 6.
Usage
myLineChart.setEnabled(enable)
Parameters
enable A Boolean value specifying whether the BarChart is enabled ( true ) or disabled ( false ).
Returns
Nothing.
Description
Method; based on a similar method defined in FComboBox. Determines whether the component is enabled ( true ) or disabled ( false ). If the component is disabled, it does not accept mouse or keyboard interaction from the user. If you omit the parameter, this method defaults to true .
Example
The following code disables chart1:
chart1.setEnabled(false);
getEnabled
Availability
Flash Player 6.
Usage
myLineChart.getEnabled()
Parameters
None.
Returns
A Boolean value indicating whether the component is enabled ( true ) or disabled ( false ).
Description
Method; indicates whether the component is enabled.
Example
The following code uses getEnabled to determine whether the component is enabled or disabled and displays the result in the Output window.
trace(chart1.getEnabled());
setChartEventHandler
Availability
Flash Player 6.
Usage
myLineChart.setChartEventHandler(functionName, eventName, [location])
Parameters
functionName A string value that should correspond with a function name.
eventName A string value that should correspond to either “onPress”, “onRelease”, “onRollOver”, or “onRollOut”.
location This parameter is optional.
Returns
Nothing.
Description
Method; based on the setChangeHandler() method defined in FComboBox and FListBox. Specifies a change handler to call when the mouse cursor interacts with a marker in the graph (i.e., bar, pie wedge, line graph plot, etc.). You can specify the same change handler function for more than one component; the function always accepts the instance of the component that has changed as a parameter. Calling this method overrides the Chart Event Handlers parameter value specified in authoring.
The triggered function will receive two parameters: a reference to the component, and an index number for the recordset item associated with the marker (bar, wedge, line plot) in the chart.
Example
When the mouse cursor is released over a marker, a function named “selectRecord” will be called in the timeline containing the component, and the selectRecord function will receive two arguments: a reference to the component, and a reference to the recordset item:
containerTimeline.selectRecord = function (componentRef, record) { if (componentRef == myLineGraph) {
trace(record["price"]);
}
}
setSize
Availability
Flash Player 6.
Usage
myPieChart.setSize(width, height)
Parameters
width The new width in pixels.
height The new height in pixels.
Returns
Nothing.
Description
Method; lets the user specify the width (in pixels) and height of the component.
Example
The following code makes a PieChart 300 pixels wide and 200 pixels high:
myPieChart.setSize(300,200);
addItemAt
Availability
Flash Player 6.
Usage
myPieChart.addItemAt(index, value)
Parameters
index The position for inserting the value into the data provider.
value An object or primitive data type.
Returns
Nothing.
Description
Method; adds an object or value to a specified index position in the chart’s data provider and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code adds an item called “Flash5Magic”, author “Sam” with price 34 as the third item in the chart.
chart.addItemAt(3, {title:"Flash5Magic", author:"Sam", price:34});
addItem
Availability
Flash Player 6.
Usage
myPieChart.addItem(value)
Parameters
value An object or primitive data type.
Returns
Nothing.
Description
Method; pushes an object or value to the top of the chart's data provider contents, much like the “push” method in arrays, and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code adds an item called “Flash5Magic”, author “Sam” with price 34 to the chart.
chart.addItem({title:"Flash5Magic", author:"Sam", price:34});
removeItemAt
Availability
Flash Player 6.
Usage
myPieChart.removeItemAt(index)
Parameters
index An integer index number of an item in the chart’s data provider.
Returns
The item to be removed from the data provider.
Description
Method; removes an item from the chart's data provider at the specified index position and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code removes the second item from the chart, and returns that item into a variable.
deadItem = chart.removeItemAt(2);
removeAll
Availability
Flash Player 6.
Usage
myPieChart.removeAll()
Parameters
None.
Returns
Nothing.
Description
Method; clears out all the contents of the chart's data provider, rendering it empty; and triggers the chart to redraw itself. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code removes all items from the chart:
chart.removeItemAt(2);
sortItemsBy
Availability
Flash Player 6.
Usage
myPieChart.sortItemsBy(fieldName, order)
Parameters
fieldName A string specifying the name of the field used for sorting. This will normally be “label” or “data”.
order A string specifying whether to sort the items in ascending order (ASC) or descending order (DESC).
Returns
Nothing.
Description
Method; sorts the items in the chart and triggers the chart to redraw itself. A cover method for manipulating a registered Data Provider indirectly through the chart instance.
Example
The following code sorts the chart by descending price:
chart.sortItemsBy("price", "DESC");
getLength
Availability
Flash Player 6.
Usage
myPieChart.getLength()
Parameters
None.
Returns
An integer. The number of items in the data provider object.
Description
Method; retrieves the number of items in the chart's data provider. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code returns the number of items in the chart:
itemCount = chart.getLength();
getItemAt
Availability
Flash Player 6.
Usage
myPieChart.getItemAt(index)
Parameters
index An integer specifying the index of the item to retrieve.
Returns
An item in the chart’s data provider at the specified index as an object.
Description
Method; returns the item at the specified index as an object. If there is no item at the specified index, the method returns undefined. A cover method for manipulating a registered data provider indirectly through the chart instance.
Example
The following code prints the title of the third item in the chart:
myItem = chart.getItemAt(3);
trace(myItem["title"]);
setDataProvider
Availability
Flash Player 6.
Usage
myPieChart.setDataProvider(dataProvider)
Parameters
dataProvider An array of text strings listing the items to add, an instance of the Array object specifying the items to add, or an instance of the DataProvider class.
Returns
Nothing.
Description
Method; registers an outside variable (dataProvider, which must be an instance of DataProvider class) to the component, and registers as a view to listen for any updates to the DataProvider. Any updates to the data provider will trigger a modelChanged event, which causes the graph to re-render itself. If the user has predefined a list of values in the component parameter, setting a data provider will override those values.
Example
The following code creates a data provider with three items and sets it on the chart.
var theData = new DataProviderClass();
var items = new Array({stock: "Apples", value: 19}, {stock: "Oranges", value:60}, {stock: "Pears", value: 5});
for (var i = 0; i < items.length; i++) {
theData.addItem(items[i]);
}
chart.setDataProvider(theData);
setLabelSource
Availability
Flash Player 6.
Usage
myPieChart.setLabelSource(fieldName)
Parameters
fieldName A string value that should correspond with a field name in the recordset (which is defined as an object in the DataProvider API).
Returns
true if a field name exists and false if the field name is invalid.
Description
Method; sets the fieldName of the recordset that provides the labels for the independent variable ( x axis). It also causes the graph to re-render itself via the invalidate method (coalesces multiple function calls into a single function call for optimization).
Example
This code sets the chart's label source to the “MovieTitle” field in a recordset.
myPieChart.setLabelSource("MovieTitle");
getLabelSource
Availability
Flash Player 6.
Usage
myPieChart.getLabelSource()
Parameters
None.
Returns
The field name.
Description
Method; returns the field name of the recordset that provides the labels for the y axis.
Example
The following code prints the label source of the chart:
var labelSource = chart.getLabelSource();
trace("Label Source: " + labelSource);
setValueSource
Availability
Flash Player 6.
Usage
myPieChart.setValueSource(fieldName)
Parameters
fieldName A string value that should correspond with a field name in the recordset (which is defined as an object in the DataProvider API).
Returns
true if a field name exists and false if the field name is invalid.
Description
Method; sets the field name of the recordset column that will provide the numeric values for the y axis.
Example
This code sets the value source to a recordset field called “MovieRating”.
myPieChart.setValueSource("MovieRating");
getValueSource
Availability
Flash Player 6.
Usage
myPieChart.getValueSource()
Parameters
None.
Returns
The recordset field name.
Description
Method; returns the field name of the recordset that provides the labels for the x axis.
Example
The following code prints the value source of the chart:
var valueSource = chart.getValueSource();
trace("Value Source: " + valueSource);
setChartTitle
Availability
Flash Player 6.
Usage
myPieChart.setChartTitle(title)
Parameters
title A string value that sets the title of the chart.
Returns
Nothing.
Description
Method; sets the title of the chart.
Example
The following code makes the chart have the title “Car Sales Per Month” and re-renders the chart.
myPieChart.setChartTitle("Car Sales Per Month");
getChartTitle
Availability
Flash Player 6.
Usage
myPieChart.getChartTitle()
Parameters
None.
Returns
The chart title.
Description
Method; gets the title of the chart.
Example
The following code prints the chart title:
var title = chart.getChartTitle();
trace("The chart title is: " + title);
setXAxisTitle
Availability
Flash Player 6.
Usage
myPieChart.setXAxisTitle(title)
Parameters
title A string value.
Returns
Nothing.
Description
Method; sets the title of the x axis.
Example
The following code sets the x axis of the chart to “Car Sales Per Month”.
myPieChart.setXAxisTitle("Car Sales Per Month");
getXAxisTitle
Availability
Flash Player 6.
Usage
myPieChart.getXAxisTitle()
Parameters
None.
Returns
The x axis parameters.
Description
Method; gets the title of the x axis.
Example
The following code prints the title of the x axis:
var title = chart.getXAxisTitle();
trace("The X axis title is: " + title);
setYAxisTitle
Availability
Flash Player 6.
Usage
myPieChart.setYAxisTitle(title)
Parameters
title A string value.
Returns
Nothing.
Description
Method; sets the title of the y axis.
Example
The following code set the y axis of the chart to “Car Sales Per Month”.
myPieChart.setYAxisTitle("Car Sales Per Month");
getYAxisTitle
Availability
Flash Player 6.
Usage
myPieChart.getYAxisTitle()
Parameters
None.
Returns
The y axis title.
Description
Method; gets the title of the y axis.
Example
The following code prints the title of the y axis:
var title = chart.getYAxisTitle();
trace("The Y axis title is: " + title);
setEnabled
Availability
Flash Player 6.
Usage
myPieChart.setEnabled(enable)
Parameters
enable A Boolean value specifying whether the BarChart is enabled ( true ) or disabled ( false ).
Returns
Nothing.
Description
Method; based on a similar method defined in FComboBox. Determines whether the component is enabled ( true ) or disabled ( false ). If the component is disabled, it does not accept mouse or keyboard interaction from the user. If you omit the parameter, this method defaults to true .
Example
The following code disables chart1:
chart1.setEnabled(false);
getEnabled
Availability
Flash Player 6.
Usage
myPieChart.getEnabled()
Parameters
None.
Returns
A Boolean value indicating whether the component is enabled ( true ) or disabled ( false ).
Description
Method; indicates whether the component is enabled.
Example
The following code uses getEnabled to determine whether the component is enabled or disabled and displays the result in the Output window.
trace(chart1.getEnabled());
setChartEventHandler
Availability
Flash Player 6.
Usage
myPieChart.setChartEventHandler(functionName, eventName, [location])
Parameters
functionName A string value that should correspond with a function name.
eventName A string value that should correspond to either “onPress”, “onRelease”, “onRollOver”, or “onRollOut”.
location This parameter is optional.
Returns
Nothing.
Description
Method; based on the setChangeHandler() method defined in FComboBox and FListBox. Specifies a change handler to call when the mouse cursor interacts with a marker in the graph (i.e., bar, pie wedge, line graph plot, etc.). You can specify the same change handler function for more than one component; the function always accepts the instance of the component that has changed as a parameter. Calling this method overrides the Chart Event Handlers parameter value specified in authoring.
The triggered function will receive two parameters: a reference to the component, and an index number for the recordset item associated with the marker (bar, wedge, line plot) in the chart.
Example
When the mouse cursor is released over a marker, a function named “selectRecord” will be called in the timeline containing the component, and the selectRecord function will receive two arguments: a reference to the component and a reference to the recordset item:
containerTimeline.selectRecord = function (componentRef, record) { if (componentRef == myPieGraph) {
trace(record["price"]);
}
}