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

NameTypeOptionalDefaultDescripton
oGraphBiGraphThe graph that the chart presentation is part of
oSeriesBiChartSeriesThe series that the chart presentation is representing

Properties

NameTypegetsetDescripton
barSpacingNumbercheckedchecked 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.
explodeNumbercheckedcheckedThe amount to move the pie chart sections from the middle
fillAngleNumbercheckedcheckedThe fill angle used when painting the chart.
fillColorStringcheckedcheckedThe fill color for the chart
fillColor2StringcheckedcheckedThe alternate fill color used when fill type is gradient
fillOpacityNumbercheckedcheckedThe fill opacity for the chart
fillTypeStringcheckedcheckedThe fill type used when painting the chart
graphBiGraphcheckedThe graph that the chart presentation is part of
markerTypeStringcheckedcheckedThe marker type for the line chart. Valid values are

circle
square
triangle
diamond
markerVisibleBooleancheckedcheckedWhether markers are visible for the chart
seriesBiChartSeriescheckedThe series that the chart presentation is representing
strokeColorStringcheckedcheckedThe stroke color for the chart
strokeOpacityNumbercheckedcheckedThe stroke opacity for the chart
strokeWidthNumbercheckedcheckedThe stroke width of the chart

Methods

NameDescription
fromXmlElementGets the properties of the chart presentation an XML element
hasBarSpacingReturns true if the barSpacing property has been set on the chart presentation
hasExplodeReturns true if the explode property has been set on the chart presentation
hasFillAngleReturns true if the fillAngle property has been set on the chart presentation
hasFillColorReturns true if the fillColor property has been set on the chart presentation
hasFillColor2Returns true if the fillColor2 property has been set on the chart presentation
hasFillOpacityReturns true if the fillOpacity property has been set on the chart presentation
hasFillTypeReturns true if the fillType property has been set on the chart presentation
hasMarkerTypeReturns true if the markerType property has been set on the chart presentation
hasMarkerVisibleReturns true if the markerVisible property has been set on the chart presentation
hasStrokeColorReturns true if the strokeColor property has been set on the chart presentation
hasStrokeOpacityReturns true if the strokeOpacity property has been set on the chart presentation
hasStrokeWidthReturns true if the strokeWidth property has been set on the chart presentation
toXmlElementSerializes the chart presentation to an XML element

Events

None.

Static Methods

NameDescription
fromXmlElementCreates 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

NameTypeOptionalDefaultDescripton
oNodeXmlElementThe 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

NameTypeOptionalDefaultDescripton
oDocBiXmlDocumentThe 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

NameTypeOptionalDefaultDescripton
oGraphBiGraphThe graph that the presentationchart belongs to
oNodeXmlElementThe element describing the chart presentation

Return Type

BiChartPresentation