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

Name Type Optional Default Descripton
oGraph BiGraph The graph that the presentation manager is part of

Properties

None.

Methods

Name Description
getBarSpacingForPoint Returns the bar spacing for the graph. The bar spacing is the same for the entire graph so the arguments are not used.
getDefaultColor Returns the default color for the point with the given ids
getDefaultMarker Returns the default marker type for the point with the given ids
getExplodeForPoint Returns the explode value (the distance to move the pie chart section) for the point with the given ids
getFillAngleForPoint Returns the fill angle for the point with the given ids
getFillColor2ForPoint Returns the alternate fill color for the point with the given ids
getFillColorForPoint Returns the fill color for the point with the given ids
getFillOpacityForPoint Returns the fill opacity for the point with the given ids
getFillTypeForPoint Returns the fill type for the point with the given ids
getMarkerTypeForPoint Returns the marker type for the point with the given ids
getMarkerVisibleForPoint Returns whether the marker should be visible for the point with the given ids
getStrokeColorForPoint Returns the stroke color for the point with the given ids
getStrokeOpacityForPoint Returns the stroke opacity for the point with the given ids
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.
setExplodeForPoint Sets the explode value for the point with the given ids
setFillAngleForPoint Sets the fill angle for the point with the given ids
setFillColor2ForPoint Sets the alternate fill color for the point with the given ids
setFillColorForPoint Sets the fill color for the point with the given ids
setFillOpacityForPoint Sets the fill opacity for the point with the given ids
setFillTypeForPoint Sets the fill type for the point with the given ids
setMarkerTypeForPoint Sets the marker type for the point with the given ids
setMarkerVisibleForPoint Sets the marker visible for the point with the given ids
setStrokeColorForPoint Sets the stroke color for the point with the given ids
setStrokeOpacityForPoint Sets the stroke opacity 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 the BiAbstractChart or the 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

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String checked The category id of the point

Return Type

Number

getDefaultColor

Returns the default color for the point with the given ids

Syntax

object.getDefaultColor
 (
 sSeriesId
 [
 ,sCategoryId
 ]
 
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The id of the series
sCategoryId String checked The 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

Name Type Optional Default Descripton
sSeriesId String The id of the series
sCategoryId String checked The 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

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String checked The 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

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String checked The 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

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String checked The 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

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String checked The 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

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String checked The 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

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String checked The 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

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String checked The 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

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String checked The 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

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String checked The 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

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String checked The 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,nBarSpacing
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String The category id of the point
nBarSpacing Number The 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,nExplode
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String The category id of the point
nExplode Number The 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,nFillAngle
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String The category id of the point
nFillAngle Number The 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,sFillColor2
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String The category id of the point
sFillColor2 String The altrenate 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,sFillColor
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String The category id of the point
sFillColor String The 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,nFillOpacity
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String The category id of the point
nFillOpacity Number The 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,sFillType
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String The category id of the point
sFillType String The 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,sMarkerType
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String The category id of the point
sMarkerType String The 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,bMarkerVisible
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String The category id of the point
bMarkerVisible Boolean The 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,sStrokeColor
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String The category id of the point
sStrokeColor String The 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,nStrokeOpacity
 )
 

Parameters

Name Type Optional Default Descripton
sSeriesId String The series id of the point
sCategoryId String The category id of the point
nStrokeOpacity Number The stroke opacity for the point

Return Type

void