ChartRangeUI
class ChartRangeUI extends UI (View source)
ChartRangeUI Object
Customization for ChartRange Filters in Dashboards.
Constants
| TYPE |
Type of UI object
|
Methods
Creates a new ChartRangeUI object
Shortcut method to set the value of an option and return $this.
Parses the config array by passing the values through each method to check validity against if the option exists.
A separator string appended to the label, to visually separate the label from the control.
Whether the label should display above or beside the control.
The type of the chart drawn inside the control.
No description
No description
The minimum selectable range size (range.end - range.start), specified in data value units.
If true, range thumbs are snapped to the nearest data points.
Details
at line 51
__construct(
array $config = array())
Creates a new ChartRangeUI object
in
JsonConfig at line 64
mixed
__get(
string $option)
Get the value of a set option via magic method.
in
JsonConfig at line 75
Options
getOptions()
Gets the Options object for the JsonConfig
in
JsonConfig at line 90
JsonConfig
setOption(
string $option,
mixed $value)
Shortcut method to set the value of an option and return $this.
In order to maintain backwards compatibility, ConfigObjects will be unwrapped.
in
JsonConfig at line 106
setOptions(
array $config)
Parses the config array by passing the values through each method to check validity against if the option exists.
in
JsonConfig at line 275
array
jsonSerialize()
Custom serialization of the JsonConfig object.
in
UI at line 41
string
getType()
Returns the UI object type
in
UI at line 55
UI
label(
string $label)
The label to display next to the category picker.
If unspecified, the label of the column the control operates on will be used.
in
UI at line 67
UI
labelSeparator(
string $labelSeparator)
A separator string appended to the label, to visually separate the label from the control.
in
UI at line 83
UI
labelStacking(
string $labelStacking)
Whether the label should display above or beside the control.
Accepted values: - 'vertical' - 'horizontal'
in
UI at line 100
UI
cssClass(
string $cssClass)
The CSS class to assign to the control, for custom styling.
at line 77
ChartRangeUI
chartType(
string $chartType)
The type of the chart drawn inside the control.
Accepted values are: - 'AreaChart' - 'LineChart' - 'ComboChart' - 'ScatterChart'
at line 92
chartOptions()
at line 100
chartView()
at line 115
ChartRangeUI
minRangeSize(
int|float $minRangeSize)
The minimum selectable range size (range.end - range.start), specified in data value units.
For a numeric axis, it is a number (not necessarily an integer). For a date, datetime or timeofday axis, it is an integer that specifies the difference in milliseconds.
at line 129
ChartRangeUI
snapToData(
boolean $snapToData)
If true, range thumbs are snapped to the nearest data points.
In this case, the end points of the range returned by getState() are necessarily values in the data table.