BiChartCategory

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

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

NameTypeOptionalDefaultDescripton
oGraphBiGraphThe graph that the category belongs to
sIdStringThe id of the category
sTitleStringcheckedThe title of the category

Properties

NameTypegetsetDescripton
idStringcheckedThe id of the category
indexNumbercheckedThe index of the category
titleStringcheckedcheckedThe title of the category

Methods

NameDescription
fromXmlElementSerializes the category to an XML element (sub tree)
toXmlElementSerializes the category to an XML element (sub tree)

Events

None.

Static Methods

NameDescription
fromXmlElementCreates 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

Serializes the category to an XML element (sub tree)

Syntax

object.fromXmlElement ( oNode )

Parameters

NameTypeOptionalDefaultDescripton
oNodeBiXmlDocumentThe XML document to create the element in

Return Type

BiXmlDocument

toXmlElement

Serializes the category to an XML element (sub tree)

Syntax

object.toXmlElement ( oDoc )

Parameters

NameTypeOptionalDefaultDescripton
oDocBiXmlDocumentThe 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

NameTypeOptionalDefaultDescripton
oGraphBiGraphThe graph that the category belongs to
oNodeXmlElementThe element describing the category

Return Type

BiChartCategory