NumericImpl Class
+ + + + +NumericImpl contains logic for numeric data. NumericImpl is used by the following classes:
+ +-
+
- NumericAxisBase +
- NumericAxis +
Constructor
+NumericImpl
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
- Index + + +
- Methods + + +
- Properties + + +
- Attributes + + +
Item Index
+ + +Methods
+ +-
+
+
- + _getMinimumUnit + + + + + +
- + _getNiceNumber + + + + + +
- + _roundDownToNearest + + + + + +
- + _roundMinAndMax + + + + + +
- + _roundToNearest + + + + + +
- + _roundToPrecision + + + + + +
- + _roundUpToNearest + + + + + +
- + + + + + + +
- + _updateMinAndMax + + + + + +
- + getTotalByKey + + + + + +
- + initializer + + + + + +
Properties
+ +-
+
+
- + _type + + + + + +
Attributes
+ +-
+
+
- + alwaysShowZero + + +
- + labelFormat + + +
- + labelFunction + + +
- + roundingMethod + + +
Methods
+ + +_getMinimumUnit
+
+
+ -
+
+
-
+
+
max+ +
+
+ -
+
+
min+ +
+
+ -
+
+
units+ +
+
+
Helper method for getting a roundingUnit when calculating the minimum and maximum values.
Parameters:
+ + +Returns:
+ +_getNiceNumber
+
+
+ -
+
+
-
+
+
roundingUnit+ +
+
+
Calculates a nice rounding unit based on the range.
+Parameters:
+ +-
+
+
-
+
+
roundingUnit+ Number + + + + +++ + +The calculated rounding unit.
+
+
+
Returns:
+ +_roundDownToNearest
+
+
+ -
+
+
-
+
+
number+ +
+
+ -
+
+
nearest+ +
+
+
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().
+Parameters:
+ + +Returns:
+ +_roundMinAndMax
+
+
+ -
+
+
-
+
+
min+ +
+
+ -
+
+
max+ +
+
+
Rounds the mimimum and maximum values based on the roundingUnit attribute.
_roundToNearest
+
+
+ -
+
+
-
+
+
number+ +
+
+ -
+
+
nearest+ +
+
+
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().
+Parameters:
+ + +Returns:
+ +_roundToPrecision
+
+
+ -
+
+
-
+
+
number+ +
+
+ -
+
+
precision+ +
+
+
Rounds a number to a certain level of precision. Useful for limiting the number of +decimal places on a fractional number.
+Parameters:
+ + +Returns:
+ +_roundUpToNearest
+
+
+ -
+
+
-
+
+
number+ +
+
+ -
+
+
nearest+ +
+
+
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().
+Parameters:
+ + +Returns:
+ +-
+
+
-
+
+
value+ +
+
+ -
+
+
format+ +
+
+
Formats a label based on the axis type and optionally specified format.
+Parameters:
+ + +Returns:
+ +_updateMinAndMax
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Calculates the maximum and minimum values for the Data.
getTotalByKey
+
+
+ -
+
+
-
+
+
key+ +
+
+
Returns the sum of all values per key.
+Parameters:
+ +-
+
+
-
+
+
key+ String + + + + +++ + +The identifier for the array whose values will be calculated.
+
+
+
Returns:
+ +initializer
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+ + +_type
+ Unknown
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Type of data used in Data.
Attributes
+ + +alwaysShowZero
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether 0 should always be displayed.
+Fires event alwaysShowZeroChange
+
+
+ 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:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
labelFormat
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Object containing properties 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:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
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 Data' appendLabelFunction to accept html as a String.
-
+
- val
- Label to be formatted. (
String)
+ - format
- Object containing properties 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:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
roundingMethod
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates how to round unit values. +
-
+
- niceNumber
- Units will be smoothed based on the number of ticks and data range. +
- auto
- If the range is greater than 1, the units will be rounded. +
- numeric value
- Units will be equal to the numeric value. +
- null
- No rounding will occur. +
Default: niceNumber
+ + + +Fires event roundingMethodChange
+
+
+ Fires when the value for the configuration attribute roundingMethod 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:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+