BiAbstractChartBase

This is the abstract base class for BiAbstractChart and BiAbstractChart2. All the charts in BiGraph and BiGraph2 extend either BiAbstractChart or BiAbstractChart2.

This class extends BiComponent and therefore all methods and fields available for BiComponent are also available for BiAbstractChartBase .

Constructor

new BiAbstractChartBase ( oGraph,oSeries )

Parameters

Name	Type	Optional	Default	Descripton
oGraph	BiGraphBase			The graph that the chart is part of
oSeries	BiChartSeries			The series that the chart is displaying

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	BiGraph			The graphs that the chart is part of
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
series	BiChartSeries			The series that the chart is displaying
strokeColor	String			The stroke color for the chart
strokeOpacity	Number			The stroke opacity for the chart
supportsCategoryAxis	Boolean			Whether this type of graph supports a category axis
supportsGridLines	Boolean			Whether this type of graph supports grid lines
supportsValueAxis	Boolean			Whether this type of graph supports a value axis
title	String			Returns the title of the series being displayed

Methods

Name	Description
getComponentByCategoryId	Returns the component (if any) that is being used to display the chart point given by the category id.
getIconHtml	Returns the HTML code needed to display an icon representing the chart. Implementing this function allows the component to act as an icon for a label.

Events

None.

Static Methods

None.

Static Fields

None.

Remarks

None.

Method Details

getComponentByCategoryId

Returns the component (if any) that is being used to display the chart point given by the category id.

Syntax

object.getComponentByCategoryId
 (
 sCategoryId
 )
 

Parameters

Name	Type	Optional	Default	Descripton
sCategoryId	String			The id of the category to get the component for

Return Type

BiAbstractChartSectionBase

getIconHtml

Returns the HTML code needed to display an icon representing the chart. Implementing this function allows the component to act as an icon for a label.

Syntax

object.getIconHtml
 (
 bHasText,bEnabled,sIconPosition,nIconTextGap
 [
 ,sClassName
 ]
 
 )
 

Parameters

Name	Type	Optional	Default	Descripton
bHasText	Boolean			Boolean whether the icon should be used with text
bEnabled	Boolean			Whether the icon is enabled
sIconPosition	String			The position of the icon. Valid values are "left", "right" "top" and "bottom".
nIconTextGap	Number			The gap between the text and the icon.
sClassName	String			Optional class name to put on the HTML element representing the icon.

Return Type

String