TimeAxis Class
TimeAxis manages time data on an axis.
Item Index
Attributes
Methods
_getKeyArray
-
key -
data
Gets an array of values based on a key.
Parameters:
Returns:
_getNumber
-
val
Parses value into a number.
Parameters:
-
valObjectValue to parse into a number
Returns:
_setDataByKey
-
key -
data
Sets data by key
formatLabel
-
value -
format
Formats a label based on the axis type and optionally specified format.
Returns:
Properties
_dataType
Unknown
private
Type of data used in Axis.
Attributes
labelFormat
String
Pattern used by the labelFunction to format a label.
Fires event labelFormatChange
Fires when the value for the configuration attribute labelFormat is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
labelFunction
Function
Method used for formatting a label. This attribute allows for the default label formatting method to overridden.
The method use would need to implement the arguments below and return a String or an HTMLElement. The default
implementation of the method returns a String. The output of this method will be rendered to the DOM using
appendChild. If you override the labelFunction method and return an html string, you will also need to override
the Axis' appendLabelFunction to accept html as a String.
- val
- Label to be formatted. (
String) - format
- STRFTime string used to format the label. (optional)
Fires event labelFunctionChange
Fires when the value for the configuration attribute labelFunction is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
maximum
Number
The maximum value that will appear on an axis. Unless explicitly set, this value is calculated by the Axis.
Fires event maximumChange
Fires when the value for the configuration attribute maximum is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
minimum
Number
The minimum value that will appear on an axis. Unless explicitly set, this value is calculated by the Axis.
Fires event minimumChange
Fires when the value for the configuration attribute minimum is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
setMax
Boolean
private
readonly
Indicates whether the maximum is calculated or explicitly set.
Fires event setMaxChange
Fires when the value for the configuration attribute setMax is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
setMin
Boolean
private
readonly
Indicates whether the minimum is calculated or explicitly set.
Fires event setMinChange
Fires when the value for the configuration attribute setMin is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added: