Class MultiKPIComponent

new MultiKPIComponent()

Methods

PermalinkaddKPI


addKPI($id, $opts)

Adds an individual KPI

Params
NameTypeDescription
$id String A unique id for the KPI
$opts ComponentKPIProperties Array of options
Properties Show
NameTypeDescription
caption string The caption to display for the component KPI
numberFormatFlag boolean If set to true, the number will be formatted as per the options.
numberHumanize boolean Uses K, M and B to denote thousands, millions and billions respectively.
numberPrefix string Adds a string perfix to the number.
numberSuffix string Adds a string suffix to the number.
numberDecimalPoints number Number of decimal places to show.

PermalinkupdateKPI


updateKPI($id, $opts)

Updates an existing KPI

Params
NameTypeDescription
$id String The unique id for the individual KPI
$opts ComponentKPIProperties Array of options
Properties Show
NameTypeDescription
caption string The caption to display for the component KPI
numberFormatFlag boolean If set to true, the number will be formatted as per the options.
numberHumanize boolean Uses K, M and B to denote thousands, millions and billions respectively.
numberPrefix string Adds a string perfix to the number.
numberSuffix string Adds a string suffix to the number.
numberDecimalPoints number Number of decimal places to show.

PermalinkdeleteKPI


deleteKPI($id)

Deletes an existing KPI

Params
NameTypeDescription
$id String The unique id for the individual KPI

PermalinksetKPICaptionColor


setKPICaptionColor($id, $color)

Sets a caption color for a KPI

Params
NameTypeDescription
$id String The unique id for the individual KPI
$color String Color for the caption

PermalinksetKPIValueColor


setKPIValueColor($id, $opts)

Sets a value color for a KPI

Params
NameTypeDescription
$id String The unique id for the individual KPI
$opts String Color for the value

PermalinkgetType


getType()

Gets the type of this component

Params
None

Inherited Methods