- \GraphRenderer
- \GraphRenderer_BalancesOffsetsTable
class (none) \ GraphRenderer_BalancesOffsetsTable
Method Summary
Name | Description |
---|---|
__construct() | |
canHaveTechnicals() |
Can this graph have technicals? If this returns true , then the resulting data will always be sorted. By default, returns true . |
getChartType() |
What type of chart is this rendered as? By default, returns linechart . |
getData($days) | |
getTitle() | Get the title of this graph |
hasSubheading() |
Does this graph have a subheading? By default, returns true . |
requiresUser() |
Does rendering this graph require a user? By default, returns false . |
usesDays() |
Does this function require a days parameter? If true , then the returned data will be stripped based on the keys returned in the data - assumes that the data uses dates as keys. By default, returns true . |
usesSummaries() |
Does this graph use summaries which may be out of date for a user? By default, returns false . |
Inherited Method Summary
Name | Description |
---|---|
convertGraphToProportional($original) | Relabel all columns to have ' %' prefix, and reformat all data to be proportional based on the sum of each row. Uses the output of #getData(). (from GraphRenderer) |
getClasses() | (from GraphRenderer) |
getCustomSubheading() |
Calculate the custom subheading value for this graph, or false if this graph does not have a custom subheading defined (and subheadings calculated through #hasSubheading() will use default sum/array logic). By default, returns false . (from GraphRenderer)
|
getLabel() |
Get the label that should be associated with the #getURL(), or false if there shouldn't be any. Should be wrapped in ct(). (from GraphRenderer)
|
getTitleArgs() | Get any localisation (i18n) string arguments for the title given in #getTitle(). By default, returns an empty array. (from GraphRenderer) |
getURL() |
Get the URL that the title of this graph should link to, or false if it should not link anywhere (from GraphRenderer)
|
getUser() | (from GraphRenderer) |
requiresAdmin() |
Does rendering this graph require an admin user? By default, returns false . (from GraphRenderer)
|
setUser($user_id) | (from GraphRenderer) |
public function __construct()
- Overrides:
- __construct()
public function canHaveTechnicals()
Can this graph have technicals? If this returns
true
, then the resulting data will always be sorted. By default, returnstrue
. (from canHaveTechnicals)
- Overrides:
- canHaveTechnicals()
public function getChartType()
What type of chart is this rendered as? By default, returns
linechart
. (from getChartType)
- Overrides:
- getChartType()
public function getData($days)
- Overrides:
- getData($days)
- Returns:
an array of (columns => [column], data => [(date, value)], last_updated => (date or false))
public function getTitle()
Get the title of this graph (from getTitle)
- Overrides:
- getTitle()
- See:
public function hasSubheading()
Does this graph have a subheading? By default, returns
true
. (from hasSubheading)
- Overrides:
- hasSubheading()
- See:
public function requiresUser()
Does rendering this graph require a user? By default, returns
false
. (from requiresUser)
- Overrides:
- requiresUser()
public function usesDays()
Does this function require a days parameter? If
true
, then the returned data will be stripped based on the keys returned in the data - assumes that the data uses dates as keys. By default, returnstrue
. (from usesDays)
- Overrides:
- usesDays()
public function usesSummaries()
Does this graph use summaries which may be out of date for a user? By default, returns
false
. (from usesSummaries)
- Overrides:
- usesSummaries()