BiChartCategory

This class is used to describe the categories of the data for a graph.

This class extends BiObject and therefore all methods and fields available for BiObject are also available for BiChartCategory .

Constructor

new BiChartCategory ( oGraph,sId [ ,sTitle ] )

Parameters

Name Type Optional Default Descripton
oGraph BiGraph The graph that the category belongs to
sId String The id of the category
sTitle String checked The title of the category

Properties

Name Type get set Descripton
id String checked The id of the category
index Number checked The index of the category
title String checked checked The title of the category

Methods

Name Description
fromXmlElement Sets the properties of the category from an XML element
toXmlElement Serializes the category to an XML element (sub tree)

Events

None.

Static Methods

Name Description
fromXmlElement Creates a new category object from an XML element

Static Fields

None.

Remarks

Changing the category does not update the chart. The graph components needs to be updated manually.

Method Details

fromXmlElement

Sets the properties of the category from an XML element

Syntax

object.fromXmlElement
 (
 oNode
 )
 

Parameters

Name Type Optional Default Descripton
oNode XmlElement The element describing the category

Return Type

void

toXmlElement

Serializes the category to an XML element (sub tree)

Syntax

object.toXmlElement
 (
 oDoc
 )
 

Parameters

Name Type Optional Default Descripton
oDoc BiXmlDocument The XML document to create the element in

Return Type

XmlElement

Static Method Details

fromXmlElement

Creates a new category object from an XML element

Syntax

BiChartCategory
 .
 fromXmlElement
 (
 oGraph,oNode
 )
 

Parameters

Name Type Optional Default Descripton
oGraph BiGraph The graph that the category belongs to
oNode XmlElement The element describing the category

Return Type

BiChartCategory