BiAbstractChartSectionBase
Used as base class for marker, column rect and pie chart section. These are used to create the visual presentation for the data points of a chart.
This class extends BiComponent and therefore all methods and fields available for BiComponent are also available for BiAbstractChartSectionBase .
Constructor
new BiAbstractChartSectionBase ( oChart,oCategory )
Parameters
| Name | Type | Optional | Default | Descripton |
oChart | | The chart that the chart section is part of | ||
oCategory | | The category that the chart section is displaying |
Properties
| Name | Type | get | set | Descripton |
category | |  | The category that the chart section is displaying | |
chart | | | The chart that the chart section is part of | |
contextMenu | | | Returns the context menu for the section. This returns null if no specific context menu is available for the section. | |
explode | Number | | | The amount to move the pie chart section from the center (percentage of radius) |
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 | | | The graphs that the chart section is part of | |
markerType | String | | | The marker type for the chart |
markerVisible | String | | | Whether markers are visible for the chart |
series | | | The series that the chart section is displaying | |
strokeColor | String | | | The stroke color for the chart |
strokeOpacity | Number | | | The stroke opacity for the chart |
title | String | | Returns the title of the category the section is part of | |
toolTip | | | Returns the tool tip to show. If this returns null no tool tip is used for the section. |
Methods
| Name | Description |
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. |
hasExplode | Returns true if the explode property has been set on the section |
hasFillAngle | Returns true if the fillAngle property has been set on the section |
hasFillColor | Returns true if the fillColor property has been set on the section |
hasFillColor2 | Returns true if the fillColor2 property has been set on the section |
hasFillOpacity | Returns true if the fillOpacity property has been set on the section |
hasFillType | Returns true if the fillType property has been set on the section |
hasMarkerType | Returns true if the markerType property has been set on the section |
hasMarkerVisible | Returns true if the markerVisible property has been set on the section |
hasStrokeColor | Returns true if the strokeColor property has been set on the section |
hasStrokeOpacity | Returns true if the strokeOpacity property has been set on the section |
Events
None.
Static Methods
None.
Static Fields
None.
Remarks
It is preferred to set the properties on the graph presentation manager instead of directly setting it on the section. Setting the property on the presentation manager makes it persist when changing the type of the chart and other changes that require the sections to be recreated.
Method Details
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 | Optional | | class name to put on the HTML element representing |
Return Type
String
hasExplode
Returns true if the explode property has been set on the section
Syntax
object.hasExplode ( ) Parameters
No arguments.
Return Type
Boolean
hasFillAngle
Returns true if the fillAngle property has been set on the section
Syntax
object.hasFillAngle ( ) Parameters
No arguments.
Return Type
Boolean
hasFillColor
Returns true if the fillColor property has been set on the section
Syntax
object.hasFillColor ( ) Parameters
No arguments.
Return Type
Boolean
hasFillColor2
Returns true if the fillColor2 property has been set on the section
Syntax
object.hasFillColor2 ( ) Parameters
No arguments.
Return Type
Boolean
hasFillOpacity
Returns true if the fillOpacity property has been set on the section
Syntax
object.hasFillOpacity ( ) Parameters
No arguments.
Return Type
Boolean
hasFillType
Returns true if the fillType property has been set on the section
Syntax
object.hasFillType ( ) Parameters
No arguments.
Return Type
Boolean
hasMarkerType
Returns true if the markerType property has been set on the section
Syntax
object.hasMarkerType ( ) Parameters
No arguments.
Return Type
Boolean
hasMarkerVisible
Returns true if the markerVisible property has been set on the section
Syntax
object.hasMarkerVisible ( ) Parameters
No arguments.
Return Type
Boolean
hasStrokeColor
Returns true if the strokeColor property has been set on the section
Syntax
object.hasStrokeColor ( ) Parameters
No arguments.
Return Type
Boolean
hasStrokeOpacity
Returns true if the strokeOpacity property has been set on the section
Syntax
object.hasStrokeOpacity ( ) Parameters
No arguments.
Return Type
Boolean