KPIValueOptions

class KPIValueOptions
getIgnoreList()
property type
Type: string
Default: “number”
property valueFontSize
property aggregate

Combine several records of data into single records.

For example, if you have a list of sales records, you can aggregate it to determine the Average or Total sales.

Type: bool
Default: false
property groupBy

If you are combining several records using the aggregate option, then you can use groupBy to specify how the records should be grouped.

For instance, if you have a list of sales records with different categories, you can set groupBy as the category, and a large sales table gets condensed into a concise list of the total/average/etc sales amount for each category.

Type: string
Default: “(unset)”
property countDistinct

Use countDistinct to count the number of distinct occurences of the value expression.

Type: bool
Default: false
property aggregateFunction

The SQL Function that is used for aggregation.

Please consult the manual of your database provider for a full list of aggregate functions. However, commonly supported functions are:

  • “SUM”
  • “AVG”
  • “MIN”
  • “MAX”
  • “STDDEV”
Type: string
Default: “SUM”
property limitTo

In case there is data available for previous values of the KPI use the limitTo option to specify the maximum number of values to take and display on the screen.

Type: int
Default: 15
property name

The name of the column

Type: string
Default: “”
property timeFormatString

The time format string

Options: “d” - short date - “11/6/2010”

TODO: Add the remaining options

Type: string
Default: “d”
property numberPrefix

Using this attribute, you could add prefix to all the numbers. For example, to represent all dollars figures, you could specify this attribute to ‘$’ to show like $40000, $50000.

Type: string
Default: “(unset)”
property numberSuffix

Using this attribute, you could add a suffix to all the numbers. For example, to represent all dollars figures, you could specify this attribute to ‘%’ to show like 33%, 53%.

Type: string
Default: “(unset)”
property formatNumber

If this is set to false, the number will not be formatted. It will be shown without commas or decimals.

Type: boolean
Default: true
property decimals

Number of decimal places all items in the chart will be rounded to

Type: int
Default: “(unset)”

Start building interactive, mobile-friendly Dashboards in PHP. See DemosDownload