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 | | 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 | | ![]() | The id of the category this point descibes | |
component | | ![]() | Returns the component (if any) that is used to display the point in the chart | |
explode | | ![]() | ![]() | The amount to move the pie chart section from the middle |
fillAngle | | ![]() | ![]() | The fill angle used when painting the section of the chart this point descibes. |
fillColor | | ![]() | ![]() | The fill color for the section of the chart this point descibes |
fillColor2 | | ![]() | ![]() | The alternate fill color used when fill type is gradient |
fillOpacity | | ![]() | ![]() | The fill opacity for the section of the chart this point descibes |
fillType | | ![]() | ![]() | The fill type used when painting the section of the chart this point descibes |
markerType | | ![]() | ![]() | The marker type for the section of the chart this point descibes |
markerVisible | | ![]() | ![]() | Whether markers are visible for the section of the chart this point descibes |
seriesId | | ![]() | The id of the series this point descibes | |
strokeColor | | ![]() | ![]() | The stroke color for the section of the chart this point descibes |
strokeOpacity | | ![]() | ![]() | 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. |
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
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
| Name | Type | Optional | Default | Descripton |
oDoc | | The 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
| Name | Type | Optional | Default | Descripton |
oGraph | | The graph that the point belongs to | ||
oNode | XmlElement | The element describing the point |
