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

NameTypeOptionalDefaultDescripton
oGraphBiGraphBaseThe graph that the chart is part of
oSeriesBiChartSeriesThe series that the chart is displaying

Properties

NameTypegetsetDescripton
barSpacingNumbercheckedThis 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.
explodeNumbercheckedThe amount to move the pie chart sections from the middle
fillAngleNumbercheckedThe fill angle used when painting the chart.
fillColorStringcheckedThe fill color for the chart
fillColor2StringcheckedThe alternate fill color used when fill type is gradient
fillOpacityNumbercheckedThe fill opacity for the chart
fillTypeStringcheckedThe fill type used when painting the chart
graphBiGraphcheckedThe graphs that the chart is part of.
markerTypeStringcheckedThe marker type for the line chart. Valid values are

circle
square
trianle
diamond
markerVisibleStringcheckedWhether markers are visible for the chart
seriesBiChartSeriescheckedThe series that the chart is displaying.
strokeColorStringcheckedThe stroke color for the chart
strokeOpacityNumbercheckedThe stroke opacity for the chart
strokeWidthNumbercheckedThe stroke width for the chart
supportsCategoryAxisBooleancheckedWhether this type of graph supports a category axis
supportsGridLinesBooleancheckedWhether this type of graph supports grid lines
supportsValueAxisBooleancheckedWhether this type of graph supports a value axis
titleStringcheckedReturns the title of the series being displayed

Methods

NameDescription
getComponentByCategoryIdReturns the component (if any) that is being used to display the chart point given by the category id.
getIconHtmlReturns 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 ( sCatId )

Parameters

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

NameTypeOptionalDefaultDescripton
bHasTextBooleanBoolean whether the icon should be used with text
bEnabledBooleanWhether the icon is enabled
sIconPositionStringThe position of the icon. Valid values are "left", "right" "top" and "bottom"
nIconTextGapNumberThe gap between the text and the icon
sClassNameStringcheckedOptional class name to put on the HTML element representing the icon.

Return Type

String