BiGraphBase

This is the abstract base class for BiGraph and BiGraph2. If Mozilla support is needed use BiGraph2. If line chart and/or pie chart is needed then use BiGraph.

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

Constructor

new BiGraphBase ( )

Parameters

No parameters.

Properties

Name	Type	get	set	Descripton
autoScale	Boolean			Allows you turn off the automatic scaling of the graph
categories	BiChartCategory[]			This is an array containing the categories used for the data of the graph. After this property is changed the graph component needs to be updated.
categoryAxis	BiChartCategoryAxis			This property points to the category axis component
chartArea	BiChartArea			This property points to the chart area component
charts	BiAbstractChart[]			This is an array containing the chart components used to display the charts.
chartType	String			The type of the chart. Available types are: bar column grid line pie percentagestackedbar percentagestackedcolum stackedbar stackedcolumn grid
fontSize	Number			Sets the font size for the legend and axes. If autoScale is true then this does not apply.
grid	BiGridChart			This property returns the grid used as the grid chart if the chart type is set to grid. Otherwise this is null.
gridLines	BiChartGridLines			This property points to the grid lines component
legend	BiChartLegend			This property points to the legend component
points	BiChartPoint[]			This is an array containing the points used for the data of the graph.
presentationManager	BiChartPresentationManager			This returns the presentation manager for the graph
series	BiChartSeries[]			This is an array containing the series used for the data of the graph. After this property is changed the graph component needs to be updated.
valueAxis	BiChartValueAxis			This property points to the value axis component

Methods

Name	Description
addCategory	Adds a category to the categories collection
addPoint	Adds a point to the points collection
addSeries	Adds a series to the series collection
clearCategories	Removes all categories from the categories collection
clearPoints	Removes all points from the points collection
clearSeries	Removes all series from the series collection
fromXmlDocument	This takes an XML document describing the graph data and the graph presentation and makes the graph reflect that information.
getCategoryById	Returns the category with the given id
getChartForSeries	Returns the chart component used to display the series.
getChartPresentationBySeriesId	This returns the chart presentation used to describe how to render chart belonging to a series.
getComponentByIds	This returns the component used to render the section for a certain data point.
getContextMenuForPoint	This method is used to return the context menu for a certain point. Override this method to provide yout own menus.
getPointByIds	Returns the point with the given series id and the given category id
getSeriesById	Returns the series with the given id
getToolTipForPoint	This method is used to return the tool tip to show for a certain point. Override this method to provide yout own tool tips.
removeCategory	Removes a category from the categories collection
removePoint	Removes a point from the points collection
removeSeries	Removes a series from the series collection
toXmlDocument	Serializes the graph to an XML document.
update	Updates the graph and recreates the internal charts. This should be called after changes to the graph.
updatePoint	Updates the graph and recreates the internal representations for the given point. This should be called after changes to a point or a series. Leaving out the category makes this update all the points in the given series.

Events

Name	Type	Bubbles	Descripton
pointclick	BiChartMouseEvent		Fires when the user clicks on a point in the graph
pointcontextmenu	BiChartMouseEvent		Fires when the user right clicks on a point
pointdblclick	BiChartMouseEvent		Fires when the user double clicks on a point
pointmousedown	BiChartMouseEvent		Fires when the user presses down the mouse button on a point
pointmousemove	BiChartMouseEvent		Fires when the user moves the mouse over a point
pointmouseout	BiChartMouseEvent		Fires when the mouse pointer leaves a point
pointmouseover	BiChartMouseEvent		Fires when the mouse pointer enters a point
pointmouseup	BiChartMouseEvent		Fires when the releases the mouse button on a point
pointmousewheel	BiChartMouseEvent		This event is fired when the user scrolls the mouse wheel over a point

Static Methods

None.

Static Fields

None.

Remarks

None.

Method Details

addCategory

Adds a category to the categories collection

Syntax

object.addCategory
 (
 oCategory
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oCategory	BiChartCategory			The category to add

Return Type

void

addPoint

Adds a point to the points collection

Syntax

object.addPoint
 (
 oPoint
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oPoint	BiChartPoint			The point to add

Return Type

void

addSeries

Adds a series to the series collection

Syntax

object.addSeries
 (
 oSeries
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oSeries	BiChartSeries			The series to add

Return Type

void

clearCategories

Removes all categories from the categories collection

Syntax

object.clearCategories
 (
 
 )
 

Parameters

No arguments.

Return Type

void

clearPoints

Removes all points from the points collection

Syntax

object.clearPoints
 (
 
 )
 

Parameters

No arguments.

Return Type

void

clearSeries

Removes all series from the series collection

Syntax

object.clearSeries
 (
 
 )
 

Parameters

No arguments.

Return Type

void

fromXmlDocument

This takes an XML document describing the graph data and the graph presentation and makes the graph reflect that information.

Syntax

object.fromXmlDocument
 (
 oDocument
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oDocument	BiXmlDocument			The XML document describing the graph

Return Type

void

getCategoryById

Returns the category with the given id

Syntax

object.getCategoryById
 (
 sId
 )
 

Parameters

Name	Type	Optional	Default	Descripton
sId	String			The id of the category to retrieve

Return Type

BiChartCategory

getChartForSeries

Returns the chart component used to display the series.

Syntax

object.getChartForSeries
 (
 oSeries
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oSeries	BiChartSeries			The series to get the chart for

Return Type

BiAbstractChart

getChartPresentationBySeriesId

This returns the chart presentation used to describe how to render chart belonging to a series.

Syntax

object.getChartPresentationBySeriesId
 (
 sSeriesId
 )
 

Parameters

Name	Type	Optional	Default	Descripton
sSeriesId	String			The id of the series to get the presentation for

Return Type

BiChartPresentation

getComponentByIds

This returns the component used to render the section for a certain data point.

Syntax

object.getComponentByIds
 (
 sSeriesId,sCategoryId
 )
 

Parameters

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

Return Type

BiAbstractChartSection

getContextMenuForPoint

This method is used to return the context menu for a certain point. Override this method to provide yout own menus.

Syntax

object.getContextMenuForPoint
 (
 oSeries,oCategory
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oSeries	BiChartSeries			The series to get the tool tip for
oCategory	BiChartCategory			The category to get the tool tip for

Return Type

BiMenu

getPointByIds

Returns the point with the given series id and the given category id

Syntax

object.getPointByIds
 (
 sSeriesId,sCategoryId
 )
 

Parameters

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

Return Type

BiChartPoint

getSeriesById

Returns the series with the given id

Syntax

object.getSeriesById
 (
 sId
 )
 

Parameters

Name	Type	Optional	Default	Descripton
sId	String			The id of the series to retrieve

Return Type

BiChartSeries

getToolTipForPoint

This method is used to return the tool tip to show for a certain point. Override this method to provide yout own tool tips.

Syntax

object.getToolTipForPoint
 (
 oSeries,oCategory
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oSeries	BiChartSeries			The series to get the tool tip for
oCategory	BiChartCategory			The category to get the tool tip for

Return Type

BiToolTip

removeCategory

Removes a category from the categories collection

Syntax

object.removeCategory
 (
 oCategory
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oCategory	BiChartCategory			The category to remove

Return Type

void

removePoint

Removes a point from the points collection

Syntax

object.removePoint
 (
 oPoint
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oPoint	BiChartPoint			The point to remove

Return Type

void

removeSeries

Removes a series from the series collection

Syntax

object.removeSeries
 (
 oSeries
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oSeries	BiChartSeries			The series to remove

Return Type

void

toXmlDocument

Serializes the graph to an XML document.

Syntax

object.toXmlDocument
 (
 
 )
 

Parameters

No arguments.

Return Type

BiXmlDocument

update

Updates the graph and recreates the internal charts. This should be called after changes to the graph.

Syntax

object.update
 (
 
 )
 

Parameters

No arguments.

Return Type

void

updatePoint

Updates the graph and recreates the internal representations for the given point. This should be called after changes to a point or a series. Leaving out the category makes this update all the points in the given series.

Syntax

object.updatePoint
 (
 sSeriesId
 [
 ,sCategoryId
 ]
 
 )
 

Parameters

Name	Type	Optional	Default	Descripton
sSeriesId	string			The id of the series that the graph should be update to reflect. This usually updates the chart assosciated with the series.
sCategoryId	string			The id of the category that the graph should be update to reflect. If provided this means that a point should be udpated. This usually updates means that a certain bar or marker is updated.

Return Type

void