Class NumericAxis
- extends AxisType
- Known Subclasses:
-
StackedAxis
NumericAxis manages numeric data on an axis.
Constructor
NumericAxis
(
config
)
- Parameters:
-
config
<Object>
(optional) Configuration parameters for the Chart.
Properties inherited from Axis:
Methods
private
void
_getMinimumUnit
(
)
private
void
_getNiceNumber
(
)
private
void
_roundDownToNearest
(
)
Rounds a Number down to the nearest multiple of an input. For example, by rounding
16 down to the nearest 10, you will receive 10. Similar to the built-in function Math.floor().
private
void
_roundMinAndMax
(
)
private
void
_roundToNearest
(
)
Rounds a Number to the nearest multiple of an input. For example, by rounding
16 to the nearest 10, you will receive 20. Similar to the built-in function Math.round().
private
void
_roundToPrecision
(
)
Rounds a number to a certain level of precision. Useful for limiting the number of
decimal places on a fractional number.
private
void
_roundUpToNearest
(
)
Rounds a Number up to the nearest multiple of an input. For example, by rounding
16 up to the nearest 10, you will receive 20. Similar to the built-in function Math.ceil().
private
void
_updateMinAndMax
(
)
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
alwaysShowZeroChange
(
event
)
Fires when the value for the configuration attribute 'alwaysShowZero' 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
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
Events inherited from Axis:
Configuration Attributes
Indicates whether 0 should always be displayed.
Hash of properties used by the labelFunction to format a
label.
Configuration attributes inherited from AxisType:
Configuration attributes inherited from Renderer:
Configuration attributes inherited from Axis: