Chart class for the YUI Charts widget.
Constructor
YAHOO.widget.Chart
(
type
,
containerId
,
dataSource
,
attributes
)
- Parameters:
-
type
<String>
The char type. May be "line", "column", "bar", or "pie"
-
containerId
<HTMLElement>
Container element for the Flash Player instance.
-
dataSource
<YAHOO.util.DataSource>
DataSource instance.
-
attributes
<object>
(optional) Object literal of configuration values.
Properties
Storage for the dataSource attribute.
Storage for the dataTipFunction attribute.
Indicates whether all attributes have been set and
the dataSource may be passed to the SWF.
The id returned from the DataSource's setInterval function.
The time, in ms, between requests for data.
_request
- private object
Storage for the request attribute.
Storage for the series attribute.
_type
- private String
The type of this chart instance.
Chart.SWFURL
- private static final object
Storage for the dataTipFunction attribute.
Default Value: "assets/charts.swf"
Methods
private
void
_getCategoryNames
(
)
Getter for the categoryNames attribute.
private
void
_getDataSource
(
)
Getter for the dataSource attribute.
private
void
_getDataTipFunction
(
)
Getter for the dataTipFunction attribute.
private
void
_getPolling
(
)
Getter for the polling attribute.
private
void
_getRequest
(
)
Getter for the request attribute.
private
void
_getSeriesDefs
(
)
Getter for the series attribute.
private
void
_initAttributes
(
)
Initializes the attributes.
private
void
_loadDataHandler
(
)
Called when the DataSource receives new data. The series definitions are used
to build a data provider for the SWF chart.
private
void
_loadHandler
(
)
Called when the SWF is ready for communication. Sets the type, initializes
the styles, and sets the DataSource.
private
void
_refreshData
(
)
Sends the request to the DataSource.
private
void
_setCategoryNames
(
)
Setter for the categoryNames attribute.
private
void
_setDataSource
(
)
Setter for the dataSource attribute.
private
void
_setDataTipFunction
(
)
Setter for the dataTipFunction attribute.
private
void
_setPolling
(
)
Setter for the polling attribute.
private
void
_setRequest
(
)
Setter for the request attribute.
private
void
_setSeriesDefs
(
)
Setter for the series attribute.
void
setSeriesStyles
(
styles
)
Sets the styles on all series in the Chart.
- Parameters:
-
styles <Array>
Initializer for all Chart series styles.
- Returns:
void
void
setStyle
(
name
,
value
)
Sets a single style value on the Chart instance.
- Parameters:
-
name <String>
Name of the Chart style value to change.
-
value <Object>
New value to pass to the Chart style.
- Returns:
void
void
setStyles
(
styles
)
Resets all styles on the Chart instance.
- Parameters:
-
styles <Object>
Initializer for all Chart styles.
- Returns:
void
String
toString
(
)
Public accessor to the unique name of the Chart instance.
- Returns:
String
- Unique name of the Chart instance.
Events
beforeCategoryNamesChange
(
eventInfo
)
Fires before the value for the configuration attribute 'categoryNames' changes. Return false to cancel the attribute change.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the current attribute value and the new value.
beforeDataSourceChange
(
eventInfo
)
Fires before the value for the configuration attribute 'dataSource' changes. Return false to cancel the attribute change.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the current attribute value and the new value.
beforeDataTipFunctionChange
(
eventInfo
)
Fires before the value for the configuration attribute 'dataTipFunction' changes. Return false to cancel the attribute change.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the current attribute value and the new value.
beforePollingChange
(
eventInfo
)
Fires before the value for the configuration attribute 'polling' changes. Return false to cancel the attribute change.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the current attribute value and the new value.
beforeRequestChange
(
eventInfo
)
Fires before the value for the configuration attribute 'request' changes. Return false to cancel the attribute change.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the current attribute value and the new value.
beforeSeriesChange
(
eventInfo
)
Fires before the value for the configuration attribute 'series' changes. Return false to cancel the attribute change.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the current attribute value and the new value.
categoryNamesChange
(
eventInfo
)
Fires when the value for the configuration attribute 'categoryNames' changes.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the previous attribute value and the new value.
dataSourceChange
(
eventInfo
)
Fires when the value for the configuration attribute 'dataSource' changes.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the previous attribute value and the new value.
dataTipFunctionChange
(
eventInfo
)
Fires when the value for the configuration attribute 'dataTipFunction' changes.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the previous attribute value and the new value.
itemClickEvent
(
event.type
,
event.item
,
event.index
,
event.seriesIndex
,
event.x
,
event.y
)
Fires when the user clicks an item renderer in the chart with the mouse.
- Parameters:
-
event.type <String>
The event type
-
event.item <Object>
The data displayed by the renderer
-
event.index <Number>
The position within the series that the item appears.
-
event.seriesIndex <Number>
The position within the series definition that the series appears.
-
event.x <Number>
The horizontal position of the mouse, relative to the SWF.
-
event.y <Number>
The vertical position of the mouse, relative to the SWF.
itemDoubleClickEvent
(
event.type
,
event.item
,
event.index
,
event.seriesIndex
,
event.x
,
event.y
)
Fires when the user double-clicks an item renderer in the chart with the mouse.
- Parameters:
-
event.type <String>
The event type
-
event.item <Object>
The data displayed by the renderer
-
event.index <Number>
The position within the series that the item appears.
-
event.seriesIndex <Number>
The position within the series definition that the series appears.
-
event.x <Number>
The horizontal position of the mouse, relative to the SWF.
-
event.y <Number>
The vertical position of the mouse, relative to the SWF.
itemDragEndEvent
(
event.type
,
event.item
,
event.index
,
event.seriesIndex
,
event.x
,
event.y
)
Fires when the user releases the mouse during a drag action.
- Parameters:
-
event.type <String>
The event type
-
event.item <Object>
The data displayed by the renderer
-
event.index <Number>
The position within the series that the item appears.
-
event.seriesIndex <Number>
The position within the series definition that the series appears.
-
event.x <Number>
The horizontal position of the mouse, relative to the SWF.
-
event.y <Number>
The vertical position of the mouse, relative to the SWF.
itemDragEvent
(
event.type
,
event.item
,
event.index
,
event.seriesIndex
,
event.x
,
event.y
)
Fires when the user moves the mouse during a drag action.
- Parameters:
-
event.type <String>
The event type
-
event.item <Object>
The data displayed by the renderer
-
event.index <Number>
The position within the series that the item appears.
-
event.seriesIndex <Number>
The position within the series definition that the series appears.
-
event.x <Number>
The horizontal position of the mouse, relative to the SWF.
-
event.y <Number>
The vertical position of the mouse, relative to the SWF.
itemDragStartEvent
(
event.type
,
event.item
,
event.index
,
event.seriesIndex
,
event.x
,
event.y
)
Fires when the user presses the mouse down on an item to initiate a drag action.
- Parameters:
-
event.type <String>
The event type
-
event.item <Object>
The data displayed by the renderer
-
event.index <Number>
The position within the series that the item appears.
-
event.seriesIndex <Number>
The position within the series definition that the series appears.
-
event.x <Number>
The horizontal position of the mouse, relative to the SWF.
-
event.y <Number>
The vertical position of the mouse, relative to the SWF.
itemMouseOutEvent
(
event.type
,
event.item
,
event.index
,
event.seriesIndex
,
event.x
,
event.y
)
Fires when the user moves the mouse out of the bounds of an item renderer in the chart.
- Parameters:
-
event.type <String>
The event type
-
event.item <Object>
The data displayed by the renderer
-
event.index <Number>
The position within the series that the item appears.
-
event.seriesIndex <Number>
The position within the series definition that the series appears.
-
event.x <Number>
The horizontal position of the mouse, relative to the SWF.
-
event.y <Number>
The vertical position of the mouse, relative to the SWF.
itemMouseOverEvent
(
event.type
,
event.item
,
event.index
,
event.seriesIndex
,
event.x
,
event.y
)
Fires when the user moves the mouse over the bounds of an item renderer in the chart.
- Parameters:
-
event.type <String>
The event type
-
event.item <Object>
The data displayed by the renderer
-
event.index <Number>
The position within the series that the item appears.
-
event.seriesIndex <Number>
The position within the series definition that the series appears.
-
event.x <Number>
The horizontal position of the mouse, relative to the SWF.
-
event.y <Number>
The vertical position of the mouse, relative to the SWF.
pollingChange
(
eventInfo
)
Fires when the value for the configuration attribute 'polling' changes.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the previous attribute value and the new value.
requestChange
(
eventInfo
)
Fires when the value for the configuration attribute 'request' changes.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the previous attribute value and the new value.
seriesChange
(
eventInfo
)
Fires when the value for the configuration attribute 'series' changes.
- Parameters:
-
eventInfo <{oldValue: any, newValue: any}>
An object containing the previous attribute value and the new value.
Configuration Attributes
Defines the names of the categories to be displayed in the Chart..
The DataSource instance to display in the Chart.
The string representation of a globally-accessible function
that may be called by the SWF to generate the datatip text for a Chart's item.
A numeric value indicating the number of milliseconds between
polling requests to the DataSource.
Request to be sent to the Chart's DataSource.
Defines the series to be displayed by the Chart.