BiChartPresentationManager

This class is used to find the properties for different visual aspects of of the graph.

This class extends BiObject and therefore all methods and fields available for BiObject are also available for BiChartPresentationManager .

Constructor

new BiChartPresentationManager ( oGraph )

Parameters

NameTypeOptionalDefaultDescripton
oGraphBiGraphThe graph that the presentation manager is part of

Properties

None.

Methods

NameDescription
getBarSpacingForPointReturns the bar spacing for the graph. The bar spacing is the same for the entire graph so the arguments are not used.
getDefaultColorReturns the default color for the point with the given ids
getDefaultMarkerReturns the default marker type for the point with the given ids
getExplodeForPointReturns the explode value (the distance to move the pie chart section) for the point with the given ids
getFillAngleForPointReturns the fill angle for the point with the given ids
getFillColor2ForPointReturns the alternate fill color for the point with the given ids
getFillColorForPointReturns the fill color for the point with the given ids
getFillOpacityForPointReturns the fill opacity for the point with the given ids
getFillTypeForPointReturns the fill type for the point with the given ids
getMarkerTypeForPointReturns the marker type for the point with the given ids
getMarkerVisibleForPointReturns whether the marker should be visible for the point with the given ids
getStrokeColorForPointReturns the stroke color for the point with the given ids
getStrokeOpacityForPointReturns the stroke opacity for the point with the given ids
getStrokeWidthForPointReturns the stroke width for the point with the given ids
setBarSpacingForPointSets the bar spacing for the graph. Since the bar spacing is the same for all charts in the graph the sSeriesId and sCategoryId arguments are ignored here.
setExplodeForPointSets the explode value for the point with the given ids
setFillAngleForPointSets the fill angle for the point with the given ids
setFillColor2ForPointSets the alternate fill color for the point with the given ids
setFillColorForPointSets the fill color for the point with the given ids
setFillOpacityForPointSets the fill opacity for the point with the given ids
setFillTypeForPointSets the fill type for the point with the given ids
setMarkerTypeForPointSets the marker type for the point with the given ids
setMarkerVisibleForPointSets the marker visible for the point with the given ids
setStrokeColorForPointSets the stroke color for the point with the given ids
setStrokeOpacityForPointSets the stroke opacity for the point with the given ids
setStrokeWidthForPointSets the stroke width for the point with the given ids

Events

None.

Static Methods

None.

Static Fields

None.

Remarks

Visual changes to points should be done using this class instead of directly changing BiAbstractChart or BiAbstractChartSection.

Method Details

getBarSpacingForPoint

Returns the bar spacing for the graph. The bar spacing is the same for the entire graph so the arguments are not used.

Syntax

object.getBarSpacingForPoint ( [ sSeriesId [ ,sCategoryId ] ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringcheckedThe series id of the point (unused)
sCategoryIdStringcheckedThe category id of the point (unused)

Return Type

Number

getDefaultColor

Returns the default color for the point with the given ids

Syntax

object.getDefaultColor ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe id of the series
sCategoryIdStringcheckedThe id of the category

Return Type

String

getDefaultMarker

Returns the default marker type for the point with the given ids

Syntax

object.getDefaultMarker ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe id of the series
sCategoryIdStringcheckedThe id of the category

Return Type

String

getExplodeForPoint

Returns the explode value (the distance to move the pie chart section) for the point with the given ids

Syntax

object.getExplodeForPoint ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringcheckedThe category id of the point

Return Type

Number

getFillAngleForPoint

Returns the fill angle for the point with the given ids

Syntax

object.getFillAngleForPoint ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringcheckedThe category id of the point

Return Type

Number

getFillColor2ForPoint

Returns the alternate fill color for the point with the given ids

Syntax

object.getFillColor2ForPoint ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringcheckedThe category id of the point

Return Type

String

getFillColorForPoint

Returns the fill color for the point with the given ids

Syntax

object.getFillColorForPoint ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringcheckedThe category id of the point

Return Type

String

getFillOpacityForPoint

Returns the fill opacity for the point with the given ids

Syntax

object.getFillOpacityForPoint ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringcheckedThe category id of the point

Return Type

Number

getFillTypeForPoint

Returns the fill type for the point with the given ids

Syntax

object.getFillTypeForPoint ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringcheckedThe category id of the point

Return Type

String

getMarkerTypeForPoint

Returns the marker type for the point with the given ids

Syntax

object.getMarkerTypeForPoint ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringcheckedThe category id of the point

Return Type

String

getMarkerVisibleForPoint

Returns whether the marker should be visible for the point with the given ids

Syntax

object.getMarkerVisibleForPoint ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringcheckedThe category id of the point

Return Type

Boolean

getStrokeColorForPoint

Returns the stroke color for the point with the given ids

Syntax

object.getStrokeColorForPoint ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringcheckedThe category id of the point

Return Type

String

getStrokeOpacityForPoint

Returns the stroke opacity for the point with the given ids

Syntax

object.getStrokeOpacityForPoint ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringcheckedThe category id of the point

Return Type

Number

getStrokeWidthForPoint

Returns the stroke width for the point with the given ids

Syntax

object.getStrokeWidthForPoint ( sSeriesId [ ,sCategoryId ] )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringcheckedThe category id of the point

Return Type

Number

setBarSpacingForPoint

Sets the bar spacing for the graph. Since the bar spacing is the same for all charts in the graph the sSeriesId and sCategoryId arguments are ignored here.

Syntax

object.setBarSpacingForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdNullUnused
sCategoryIdNullUnused
oArgNumberThe bar spacing for the graph

Return Type

void

setExplodeForPoint

Sets the explode value for the point with the given ids

Syntax

object.setExplodeForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringThe category id of the point
oArgNumberThe explode value for the point

Return Type

void

setFillAngleForPoint

Sets the fill angle for the point with the given ids

Syntax

object.setFillAngleForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringThe category id of the point
oArgStringThe fill angle for the point

Return Type

void

setFillColor2ForPoint

Sets the alternate fill color for the point with the given ids

Syntax

object.setFillColor2ForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringThe category id of the point
oArgStringThe alternate fill color for the point

Return Type

void

setFillColorForPoint

Sets the fill color for the point with the given ids

Syntax

object.setFillColorForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringThe category id of the point
oArgStringThe fill color for the point

Return Type

void

setFillOpacityForPoint

Sets the fill opacity for the point with the given ids

Syntax

object.setFillOpacityForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringThe category id of the point
oArgNumberThe fill opacity for the point

Return Type

void

setFillTypeForPoint

Sets the fill type for the point with the given ids

Syntax

object.setFillTypeForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringThe category id of the point
oArgStringThe fill type for the point

Return Type

void

setMarkerTypeForPoint

Sets the marker type for the point with the given ids

Syntax

object.setMarkerTypeForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringThe category id of the point
oArgStringThe marker type for the point

Return Type

void

setMarkerVisibleForPoint

Sets the marker visible for the point with the given ids

Syntax

object.setMarkerVisibleForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringThe category id of the point
oArgStringThe marker visible for the point

Return Type

void

setStrokeColorForPoint

Sets the stroke color for the point with the given ids

Syntax

object.setStrokeColorForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringThe category id of the point
oArgStringThe stroke color for the point

Return Type

void

setStrokeOpacityForPoint

Sets the stroke opacity for the point with the given ids

Syntax

object.setStrokeOpacityForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringThe category id of the point
oArgStringThe stroke opacity for the point

Return Type

void

setStrokeWidthForPoint

Sets the stroke width for the point with the given ids

Syntax

object.setStrokeWidthForPoint ( sSeriesId,sCategoryId,oArg )

Parameters

NameTypeOptionalDefaultDescripton
sSeriesIdStringThe series id of the point
sCategoryIdStringThe category id of the point
oArgNumberThe stroke width for the point

Return Type

void