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	BiGraph			The graph that the chart presentation is part of
oSeries	BiChartSeries			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
markerType	String			The marker type for the line chart. Valid values are circle square trianle diamond
markerVisible	String			Whether markers are visible for the chart
strokeColor	String			The stroke color for the chart
strokeOpacity	Number			The stroke opacity for 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
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

Return Type

Boolean

hasExplode

Returns true if the explode property has been set on the chart presentation

Syntax

object.hasExplode
 (
 
 )
 

Parameters

Return Type

Boolean

hasFillAngle

Returns true if the fillAngle property has been set on the chart presentation

Syntax

object.hasFillAngle
 (
 
 )
 

Parameters

Return Type

Boolean

hasFillColor

Returns true if the fillColor property has been set on the chart presentation

Syntax

object.hasFillColor
 (
 
 )
 

Parameters

Return Type

Boolean

hasFillColor2

Returns true if the fillColor2 property has been set on the chart presentation

Syntax

object.hasFillColor2
 (
 
 )
 

Parameters

Return Type

Boolean

hasFillOpacity

Returns true if the fillOpacity property has been set on the chart presentation

Syntax

object.hasFillOpacity
 (
 
 )
 

Parameters

Return Type

Boolean

hasFillType

Returns true if the fillType property has been set on the chart presentation

Syntax

object.hasFillType
 (
 
 )
 

Parameters

Return Type

Boolean

hasMarkerType

Returns true if the markerType property has been set on the chart presentation

Syntax

object.hasMarkerType
 (
 
 )
 

Parameters

Return Type

Boolean

hasMarkerVisible

Returns true if the markerVisible property has been set on the chart presentation

Syntax

object.hasMarkerVisible
 (
 
 )
 

Parameters

Return Type

Boolean

hasStrokeColor

Returns true if the strokeColor property has been set on the chart presentation

Syntax

object.hasStrokeColor
 (
 
 )
 

Parameters

Return Type

Boolean

hasStrokeOpacity

Returns true if the strokeOpacity property has been set on the chart presentation

Syntax

object.hasStrokeOpacity
 (
 
 )
 

Parameters

Return Type

Boolean

toXmlElement

Serializes the chart presentation 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 new chart presentation object from an XML element

Syntax

BiChartPresentation
 .
 fromXmlElement
 (
 oGraph,oNode
 )
 

Parameters

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

Return Type

BiChartPresentation