BiChartPoint

This class is used to describe how to display a data point in the graph. Each point is bound to a series and a category.

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

Constructor

new BiChartPoint ( oGraph,sSeriesId,sCategoryId )

Parameters

NameTypeOptionalDefaultDescripton
oGraphBiGraphThe graph this point is a part of
sSeriesIdStringThe id of the series this point describes
sCategoryIdStringThe id of the category this point describes

Properties

NameTypegetsetDescripton
categoryIdcheckedThe id of the category this point descibes
componentBiAbstractChartSectioncheckedReturns the component (if any) that is used to display the point in the chart
explodecheckedcheckedThe amount to move the pie chart section from the middle
fillAnglecheckedcheckedThe fill angle used when painting the section of the chart this point descibes.
fillColorcheckedcheckedThe fill color for the section of the chart this point descibes
fillColor2checkedcheckedThe alternate fill color used when fill type is gradient
fillOpacitycheckedcheckedThe fill opacity for the section of the chart this point descibes
fillTypecheckedcheckedThe fill type used when painting the section of the chart this point descibes
markerTypecheckedcheckedThe marker type for the section of the chart this point descibes
markerVisiblecheckedcheckedWhether markers are visible for the section of the chart this point descibes
seriesIdcheckedThe id of the series this point descibes
strokeColorcheckedcheckedThe stroke color for the section of the chart this point descibes
strokeOpacitycheckedcheckedThe stroke opacity for the section of the chart this point descibes

Methods

NameDescription
fromXmlElementGets the properties for the point from an XML Element.
hasExplodeReturns true if the explode property has been set on the point
hasFillAngleReturns true if the fillAngle property has been set on the point
hasFillColorReturns true if the fillColor property has been set on the point
hasFillColor2Returns true if the fillColor2 property has been set on the point
hasFillOpacityReturns true if the fillOpacity property has been set on the point
hasFillTypeReturns true if the fillType property has been set on the point
hasMarkerTypeReturns true if the markerType property has been set on the point
hasMarkerVisibleReturns true if the markerVisible property has been set on the point
hasStrokeColorReturns true if the strokeColor property has been set on the point
hasStrokeOpacityReturns true if the strokeOpacity property has been set on the point
toXmlElementSerializes the point to an XML element

Events

None.

Static Methods

NameDescription
fromXmlElementCreates a point object from an XML element describing that point.

Static Fields

None.

Remarks

None.

Method Details

fromXmlElement

Gets the properties for the point from an XML Element.

Syntax

object.fromXmlElement ( oNode )

Parameters

NameTypeOptionalDefaultDescripton
oNodeXmlElementThe element describing the point

Return Type

void

hasExplode

Returns true if the explode property has been set on the point

Syntax

object.hasExplode ( )

Parameters

No arguments.

Return Type

Boolean

hasFillAngle

Returns true if the fillAngle property has been set on the point

Syntax

object.hasFillAngle ( )

Parameters

No arguments.

Return Type

Boolean

hasFillColor

Returns true if the fillColor property has been set on the point

Syntax

object.hasFillColor ( )

Parameters

No arguments.

Return Type

Boolean

hasFillColor2

Returns true if the fillColor2 property has been set on the point

Syntax

object.hasFillColor2 ( )

Parameters

No arguments.

Return Type

Boolean

hasFillOpacity

Returns true if the fillOpacity property has been set on the point

Syntax

object.hasFillOpacity ( )

Parameters

No arguments.

Return Type

Boolean

hasFillType

Returns true if the fillType property has been set on the point

Syntax

object.hasFillType ( )

Parameters

No arguments.

Return Type

Boolean

hasMarkerType

Returns true if the markerType property has been set on the point

Syntax

object.hasMarkerType ( )

Parameters

No arguments.

Return Type

Boolean

hasMarkerVisible

Returns true if the markerVisible property has been set on the point

Syntax

object.hasMarkerVisible ( )

Parameters

No arguments.

Return Type

Boolean

hasStrokeColor

Returns true if the strokeColor property has been set on the point

Syntax

object.hasStrokeColor ( )

Parameters

No arguments.

Return Type

Boolean

hasStrokeOpacity

Returns true if the strokeOpacity property has been set on the point

Syntax

object.hasStrokeOpacity ( )

Parameters

No arguments.

Return Type

Boolean

toXmlElement

Serializes the point to an XML element

Syntax

object.toXmlElement ( oDoc )

Parameters

NameTypeOptionalDefaultDescripton
oDocBiXmlDocumentThe XML document to create the element in

Return Type

Element

Static Method Details

fromXmlElement

Creates a point object from an XML element describing that point.

Syntax

BiChartPoint . fromXmlElement ( oGraph,oNode )

Parameters

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

Return Type

BiChartPoint