DateRangeUI
class DateRangeUI extends DataRange (View source)
DateRangeUI Object
Customization for DateRange Filters in Dashboards.
Constants
| TYPE |
Type of UI object
|
Methods
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 number of ticks (fixed positions in the range bar) the slider thumbs can occupy.
The amount to increment for unit increments of the range extents.
The amount to increment for block increments of the range extents.
Whether to have labels next to the slider displaying extents of the selected range.
The slider orientation. Either 'horizontal' or 'vertical'.
Sets the format for dates in the control.
Details
in
DataRange at line 46
__construct(
array $config = array())
Builds a new Date or Number RangeUI 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.
in
DataRange at line 62
DataRange
step(
int|float $step)
The minimum possible change when dragging the slider thumbs.
in
DataRange at line 75
DataRange
ticks(
int|float $ticks)
The number of ticks (fixed positions in the range bar) the slider thumbs can occupy.
in
DataRange at line 90
DataRange
unitIncrement(
int|float $unitIncrement)
The amount to increment for unit increments of the range extents.
A unit increment is equivalent to using the arrow keys to move a slider thumb.
in
DataRange at line 105
DataRange
blockIncrement(
int|float $blockIncrement)
The amount to increment for block increments of the range extents.
A block increment is equivalent to using the pgUp and pgDown keys to move the slider thumbs.
in
DataRange at line 118
DataRange
showRangeValues(
string $showRangeValues)
Whether to have labels next to the slider displaying extents of the selected range.
in
DataRange at line 131
DataRange
orientation(
string $orientation)
The slider orientation. Either 'horizontal' or 'vertical'.
at line 38
DateRangeUI
format(
array $formatConfig)
Sets the format for dates in the control.