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

Name Type Optional Default Descripton
oGraph BiGraph The graph this point is a part of
sSeriesId String The id of the series this point describes
sCategoryId String The id of the category this point describes

Properties

Name Type get set Descripton
categoryId String checked The id of the category this point descibes
explode Number checked checked The amount to move the pie chart section from the middle
fillAngle Number checked checked The fill angle used when painting the section of the chart this point descibes.
fillColor String checked checked The fill color for the section of the chart this point descibes
fillColor2 String checked checked The alternate fill color used when fill type is gradient
fillOpacity Number checked checked The fill opacity for the section of the chart this point descibes
fillType String checked checked The fill type used when painting the section of the chart this point descibes
markerType String checked checked The marker type for the section of the chart this point descibes
markerVisible String checked checked Whether markers are visible for the section of the chart this point descibes
seriesId String checked The id of the series this point descibes
strokeColor String checked checked The stroke color for the section of the chart this point descibes
strokeOpacity Number checked checked The stroke opacity for the section of the chart this point descibes

Methods

Name Description
fromXmlElement Gets the properties for the point from an XML Element.
getComponent Returns the component (if any) that is used to display the point in the chart
hasExplode Returns true if the explode property has been set on the point
hasFillAngle Returns true if the fillAngle property has been set on the point
hasFillColor Returns true if the fillColor property has been set on the point
hasFillColor2 Returns true if the fillColor2 property has been set on the point
hasFillOpacity Returns true if the fillOpacity property has been set on the point
hasFillType Returns true if the fillType property has been set on the point
hasMarkerType Returns true if the markerType property has been set on the point
hasMarkerVisible Returns true if the markerVisible property has been set on the point
hasStrokeColor Returns true if the strokeColor property has been set on the point
hasStrokeOpacity Returns true if the strokeOpacity property has been set on the point
toXmlElement Serializes the point to an XML element

Events

None.

Static Methods

Name Description
fromXmlElement Creates 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

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

Return Type

void

getComponent

Returns the component (if any) that is used to display the point in the chart

Syntax

object.getComponent
 (
 
 )

Parameters

Return Type

hasExplode

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

Syntax

object.hasExplode
 (
 
 )

Parameters

Return Type

Boolean

hasFillAngle

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

Syntax

object.hasFillAngle
 (
 
 )

Parameters

Return Type

Boolean

hasFillColor

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

Syntax

object.hasFillColor
 (
 
 )

Parameters

Return Type

Boolean

hasFillColor2

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

Syntax

object.hasFillColor2
 (
 
 )

Parameters

Return Type

Boolean

hasFillOpacity

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

Syntax

object.hasFillOpacity
 (
 
 )

Parameters

Return Type

Boolean

hasFillType

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

Syntax

object.hasFillType
 (
 
 )

Parameters

Return Type

Boolean

hasMarkerType

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

Syntax

object.hasMarkerType
 (
 
 )

Parameters

Return Type

Boolean

hasMarkerVisible

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

Syntax

object.hasMarkerVisible
 (
 
 )

Parameters

Return Type

Boolean

hasStrokeColor

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

Syntax

object.hasStrokeColor
 (
 
 )

Parameters

Return Type

Boolean

hasStrokeOpacity

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

Syntax

object.hasStrokeOpacity
 (
 
 )

Parameters

Return Type

Boolean

toXmlElement

Serializes the point to an XML element

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 point object from an XML element describing that point.

Syntax

BiChartPoint
 .
 fromXmlElement
 (
 oGraph,oNode
 )

Parameters

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

Return Type

BiChartPoint