Class Graph

Object
   |
   +--Graph

class Graph

Defined in graph.js

Version: 1.1

Author: Mathieu HENRI, Opera Software ASA

Field Detail

bgColor

String bgColor

the background limit colors ( '#ffcc99' by default )

dataSets

<private> Array dataSets

fgColor

String fgColor

the foreground limit colors ( '#336600' by default )

height

String height

the height of the graphs ( '360px' by default )

labels

<private> Array labels

rendererMethodPrefix

<private> String rendererMethodPrefix

'renderer_' use this prefix to name the renderer methods you add to the prototype

title

String title

'untitled Graph'

width

String width

the width of the graphs ( '480px' by default )

Graph

Graph()

Graph class. This class eases the creation and display of data

Version: 1.1

Author: Mathieu HENRI, Opera Software ASA

addDataSet

Boolean addDataSet( <String> _dataId, <Array> _dataSet, <String> _color )

adds a set of data. The data set will be rejected if it does not have as many values as the labels of the Graph.

Parameters:
_dataId - the id of the dataSet
_dataSet - an array of numbers
_color - [OPTIONNAL] the color to use for this dataSet

Returns:

See:
- getDataSets()
- getDataRange()

getDataRange

Object getDataRange()

get the min/max range of the dataSets. Especially meant to be used in the renderer methods.

Returns:
an object with the minimum and maximum properties, or NULL

See:
- addDataSet()

getDataSetColor

String getDataSetColor( <Number> index )

get the color of a given dataSet or a stable pseudo random color in the [ bgColor ; fgColor ] range. Especially meant to be used in the renderer methods.

Parameters:
index - the index of the dataSet

Returns:
false if the index is invalid or a color

getDataSets

Array getDataSets()

get the labels. Especially meant to be used in the renderer methods.

Returns:
the array of dataSets

See:
- addDataSet()

getLabels

Array getLabels()

get the labels. Especially meant to be used in the renderer methods.

Returns:
the array of labels

See:
- setLabels()

isArray

 <private> Boolean isArray( what )

check if a variable is an Array.

Parameters:
what - the variable to test

Returns:

listStyles

Array listStyles()

list the renderers.

Returns:
an array with the name of the renderer methods ( without the rendererMethodPrefix )

render

Boolean render( <String> _style, <HTMLElement> _renderTarget )

render the graph

Parameters:
_style - the renderer to use
_renderTarget - [OPTIONNAL] the HTMLElement where the graph must be rendered, document.body by default

renderer_accumulatedLines

Boolean renderer_accumulatedLines( svg )

'accumulatedLines' graph renderer

Parameters:
svg - {SVGElement} the SVG render target

Version: 0.1

renderer_bars

Boolean renderer_bars( svg )

'bars' graph renderer

Parameters:
svg - {SVGElement} the SVG render target

Version: 1.0

renderer_lines

Boolean renderer_lines( svg )

'lines' graph renderer

Parameters:
svg - {SVGElement} the SVG render target

Version: 0.9

renderer_pie

Boolean renderer_pie( svg )

'pie' graph renderer

Parameters:
svg - {SVGElement} the SVG render target

Version: 1.0

reset

 <private> void reset()

reset the graph.

setLabels

Boolean setLabels( <Array> _labels )

set the labels. This will reset the entire Graph if there is not as many labels as before.

Parameters:
_labels - the array of labels

Returns:

See:
- getLabels()
- reset()