class Dashboard (View source)

Constants

VERSION

Google's dashboard version

VIZ_PACKAGE

Javascript chart package.

VIZ_CLASS

Javascript chart class.

Methods

__construct( Label $label)

Builds a new Dashboard with identifying label.

bind( ControlWrapper|array $controlWraps, ChartWrapper|array $chartWraps)

Binds ControlWrappers to ChartWrappers in the dashboard.

array
getBindings()

Fetch the dashboard's bindings.

array
getBoundCharts()

Fetch the dashboard's bound charts from the wrappers.

getLabel()

Returns the dashboard label.

setBindings( array $bindings)

Batch add an array of bindings.

Details

at line 50
__construct( Label $label)

Builds a new Dashboard with identifying label.

Parameters

Label $label

at line 69
Dashboard bind( ControlWrapper|array $controlWraps, ChartWrapper|array $chartWraps)

Binds ControlWrappers to ChartWrappers in the dashboard.

  • A OneToOne binding is created if single wrappers are passed.
  • If a single ControlWrapper is passed with an array of ChartWrappers, a OneToMany binding is created.
  • If an array of ControlWrappers is passed with one ChartWrapper, then a ManyToOne binding is created.

Parameters

ControlWrapper|array $controlWraps
ChartWrapper|array $chartWraps

Return Value

Dashboard

Exceptions

InvalidBindings

at line 81
array getBindings()

Fetch the dashboard's bindings.

Return Value

array

at line 91
array getBoundCharts()

Fetch the dashboard's bound charts from the wrappers.

Return Value

array

at line 111
Label getLabel()

Returns the dashboard label.

Return Value

Label

at line 125
Dashboard setBindings( array $bindings)

Batch add an array of bindings.

This method can set all bindings at once instead of chaining multiple bind methods.

Parameters

array $bindings

Return Value

Dashboard

Exceptions

InvalidBindings