BiChartPresentation
This class is used to define the presentation attributes for a chart.
This class extends BiObject and therefore all methods and fields available for BiObject are also available for BiChartPresentation .
Constructor
new BiChartPresentation ( oGraph,oSeries )
Parameters
| Name | Type | Optional | Default | Descripton |
oGraph | | The graph that the chart presentation is part of | ||
oSeries | | The series that the chart presentation is representing |
Properties
| Name | Type | get | set | Descripton |
barSpacing | Number | ![]() | ![]() | This is the relative distance between the bars or columns of different categories. 1 means that the distance is the same as the width/height of the column/bar. 0 means that there is no spacing. |
explode | Number | ![]() | ![]() | The amount to move the pie chart sections from the middle |
fillAngle | Number | ![]() | ![]() | The fill angle used when painting the chart. |
fillColor | String | ![]() | ![]() | The fill color for the chart |
fillColor2 | String | ![]() | ![]() | The alternate fill color used when fill type is gradient |
fillOpacity | Number | ![]() | ![]() | The fill opacity for the chart |
fillType | String | ![]() | ![]() | The fill type used when painting the chart |
graph | | ![]() | The graph that the chart presentation is part of | |
markerType | String | ![]() | ![]() | The marker type for the line chart. Valid values are circle square triangle diamond |
markerVisible | Boolean | ![]() | ![]() | Whether markers are visible for the chart |
series | | ![]() | The series that the chart presentation is representing | |
strokeColor | String | ![]() | ![]() | The stroke color for the chart |
strokeOpacity | Number | ![]() | ![]() | The stroke opacity for the chart |
strokeWidth | Number | ![]() | ![]() | The stroke width of the chart |
Methods
| Name | Description |
fromXmlElement | Gets the properties of the chart presentation an XML element |
hasBarSpacing | Returns true if the barSpacing property has been set on the chart presentation |
hasExplode | Returns true if the explode property has been set on the chart presentation |
hasFillAngle | Returns true if the fillAngle property has been set on the chart presentation |
hasFillColor | Returns true if the fillColor property has been set on the chart presentation |
hasFillColor2 | Returns true if the fillColor2 property has been set on the chart presentation |
hasFillOpacity | Returns true if the fillOpacity property has been set on the chart presentation |
hasFillType | Returns true if the fillType property has been set on the chart presentation |
hasMarkerType | Returns true if the markerType property has been set on the chart presentation |
hasMarkerVisible | Returns true if the markerVisible property has been set on the chart presentation |
hasStrokeColor | Returns true if the strokeColor property has been set on the chart presentation |
hasStrokeOpacity | Returns true if the strokeOpacity property has been set on the chart presentation |
hasStrokeWidth | Returns true if the strokeWidth property has been set on the chart presentation |
toXmlElement | Serializes the chart presentation to an XML element |
Events
None.
Static Methods
| Name | Description |
fromXmlElement | Creates a new chart presentation object from an XML element |
Static Fields
None.
Remarks
Changes to this might not become updated until the chart is updated. It is therefore bettter to use the BiChartPresentationManager.
Method Details
fromXmlElement
Gets the properties of the chart presentation an XML element
Syntax
object.fromXmlElement ( oNode ) Parameters
| Name | Type | Optional | Default | Descripton |
oNode | XmlElement | The element describing the chart presentation |
Return Type
void
hasBarSpacing
Returns true if the barSpacing property has been set on the chart presentation
Syntax
object.hasBarSpacing ( ) Parameters
No arguments.
Return Type
Boolean
hasExplode
Returns true if the explode property has been set on the chart presentation
Syntax
object.hasExplode ( ) Parameters
No arguments.
Return Type
Boolean
hasFillAngle
Returns true if the fillAngle property has been set on the chart presentation
Syntax
object.hasFillAngle ( ) Parameters
No arguments.
Return Type
Boolean
hasFillColor
Returns true if the fillColor property has been set on the chart presentation
Syntax
object.hasFillColor ( ) Parameters
No arguments.
Return Type
Boolean
hasFillColor2
Returns true if the fillColor2 property has been set on the chart presentation
Syntax
object.hasFillColor2 ( ) Parameters
No arguments.
Return Type
Boolean
hasFillOpacity
Returns true if the fillOpacity property has been set on the chart presentation
Syntax
object.hasFillOpacity ( ) Parameters
No arguments.
Return Type
Boolean
hasFillType
Returns true if the fillType property has been set on the chart presentation
Syntax
object.hasFillType ( ) Parameters
No arguments.
Return Type
Boolean
hasMarkerType
Returns true if the markerType property has been set on the chart presentation
Syntax
object.hasMarkerType ( ) Parameters
No arguments.
Return Type
Boolean
hasMarkerVisible
Returns true if the markerVisible property has been set on the chart presentation
Syntax
object.hasMarkerVisible ( ) Parameters
No arguments.
Return Type
Boolean
hasStrokeColor
Returns true if the strokeColor property has been set on the chart presentation
Syntax
object.hasStrokeColor ( ) Parameters
No arguments.
Return Type
Boolean
hasStrokeOpacity
Returns true if the strokeOpacity property has been set on the chart presentation
Syntax
object.hasStrokeOpacity ( ) Parameters
No arguments.
Return Type
Boolean
hasStrokeWidth
Returns true if the strokeWidth property has been set on the chart presentation
Syntax
object.hasStrokeWidth ( ) Parameters
No arguments.
Return Type
Boolean
toXmlElement
Serializes the chart presentation 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
XmlElement
Static Method Details
fromXmlElement
Creates a new chart presentation object from an XML element
Syntax
BiChartPresentation . fromXmlElement ( oGraph,oNode ) Parameters
| Name | Type | Optional | Default | Descripton |
oGraph | | The graph that the presentationchart belongs to | ||
oNode | XmlElement | The element describing the chart presentation |
