Class TimeAxis
- extends AxisType
TimeAxis manages time data on an axis.
Constructor
TimeAxis
(
config
)
- Parameters:
-
config
<Object>
(optional) Configuration parameters for the Chart.
Properties
GUID
- private String
Constant used to generate unique id.
Properties inherited from Axis:
Methods
private
void
_getKeyArray
(
)
private
void
_getNumber
(
)
private
void
_setDataByKey
(
)
(override)
getLabelByIndex
(
i
,
l
)
Calculates and returns a value based on the number of labels and the index of
the current label.
- Parameters:
-
i
<Number>
Index of the label.
-
l
<Number>
Total number of labels.
- Returns:
- String
Methods inherited from AxisType:
_dataProviderChangeHandler,
_getKeyArray,
_keyChangeHandler,
_setDataByKey,
_updateMinAndMax,
_updateTotalData,
addKey,
bindUI,
getDataByKey,
getKeyValueAt,
getLabelByIndex,
getMajorUnitDistance,
getTotalMajorUnits,
removeKey
Methods inherited from Axis:
_clearLabelCache,
_createLabelCache,
_dataChangeHandler,
_drawAxis,
_getDefaultStyles,
_handleSizeChange,
_positionChangeHandler,
_setCanvas,
_updateHandler,
drawLine,
getFirstPoint,
getLabel,
getLastPoint,
getLayout,
getLength,
getLineEnd,
getNextPoint,
getPosition,
renderUI,
syncUI
Events
labelFormatChange
(
event
)
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:
-
event
<Event.Facade>
An Event Facade object with the following attribute specific properties added: - prevVal
- The value of the attribute, prior to it being set
- newVal
- The value the attribute is to be set to
- attrName
- The name of the attribute being set
- subAttrName
- If setting a property within the attribute's value, the name of the sub-attribute property being set
labelFunctionChange
(
event
)
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:
-
event
<Event.Facade>
An Event Facade object with the following attribute specific properties added: - prevVal
- The value of the attribute, prior to it being set
- newVal
- The value the attribute is to be set to
- attrName
- The name of the attribute being set
- subAttrName
- If setting a property within the attribute's value, the name of the sub-attribute property being set
maximumChange
(
event
)
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:
-
event
<Event.Facade>
An Event Facade object with the following attribute specific properties added: - prevVal
- The value of the attribute, prior to it being set
- newVal
- The value the attribute is to be set to
- attrName
- The name of the attribute being set
- subAttrName
- If setting a property within the attribute's value, the name of the sub-attribute property being set
minimumChange
(
event
)
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:
-
event
<Event.Facade>
An Event Facade object with the following attribute specific properties added: - prevVal
- The value of the attribute, prior to it being set
- newVal
- The value the attribute is to be set to
- attrName
- The name of the attribute being set
- subAttrName
- If setting a property within the attribute's value, the name of the sub-attribute property being set
Events inherited from Axis:
Configuration Attributes
Pattern used by the labelFunction to format a label.
The maximum value that will appear on an axis.
The minimum value that will appear on an axis.
Configuration attributes inherited from AxisType:
Configuration attributes inherited from Renderer:
Configuration attributes inherited from Axis: