AxisType Class
AxisType is an abstract class that manages the data for an axis.
Item Index
Methods
Methods
_dataProviderChangeHandler
-
e
Handles changes to dataProvider.
Parameters:
-
eObjectEvent object.
_getKeyArray
-
key -
data
Gets an array of values based on a key.
Parameters:
Returns:
_hasDataOverflow
()
protected
Checks to see if data extends beyond the range of the axis. If so, that data will need to be hidden. This method is internal, temporary and subject to removal in the future.
Returns:
_keyChangeHandler
-
e
Updates the Axis after a change in keys.
Parameters:
-
eObjectEvent object.
_setDataByKey
-
key -
data
Sets data by key
_updateMinAndMax
()
private
Calculates the maximum and minimum values for the Axis.
_updateTotalData
()
private
Updates the total data array.
addKey
-
value
Adds an array to the key hash.
Parameters:
-
valueObjectIndicates what key to use in retrieving the array.
bindUI
()
private
getDataByKey
-
value
Returns an array of values based on an identifier key.
Parameters:
-
valueStringvalue used to identify the array
Returns:
getEdgeOffset
-
ct -
l
Gets the distance that the first and last ticks are offset from there respective edges.
Returns:
getKeyValueAt
-
key -
index
Returns a value based of a key value and an index.
Returns:
getLabelByIndex
-
i -
l
Calculates and returns a value based on the number of labels and the index of the current label.
Returns:
getMajorUnitDistance
-
len -
uiLen -
majorUnit
Returns the distance between major units on an axis.
Parameters:
Returns:
getMaximumValue
()
Returns a string corresponding to the last label on an axis.
Returns:
getMinimumValue
()
Returns a string corresponding to the first label on an axis.
Returns:
getTotalMajorUnits
()
Returns the total number of majorUnits that will appear on an axis.
Returns:
initializer
()
private
removeKey
-
value
Removes an array from the key hash.
Parameters:
-
valueStringIndicates what key to use in removing from the hash.
Properties
Attributes
data
Array
Array of axis data
Fires event dataChange
Fires when the value for the configuration attribute data 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:
dataMaximum
Number
The maximum value contained in the data array. Used for
maximum when autoMax is true.
Fires event dataMaximumChange
Fires when the value for the configuration attribute dataMaximum 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:
dataMinimum
Number
The minimum value contained in the data array. Used for
minimum when autoMin is true.
Fires event dataMinimumChange
Fires when the value for the configuration attribute dataMinimum 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:
dataProvider
Array
Instance of ChartDataProvider that the class uses
to build its own data.
Fires event dataProviderChange
Fires when the value for the configuration attribute dataProvider 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:
keyCollection
Array
Array containing all the keys in the axis.
Fires event keyCollectionChange
Fires when the value for the configuration attribute keyCollection 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:
keys
Object
Hash of array identifed by a string value.
Fires event keysChange
Fires when the value for the configuration attribute keys 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.
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.
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:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
setMax
Boolean
Determines whether the maximum is calculated or explicitly set by the user.
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
Determines whether the minimum is calculated or explicitly set by the user.
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:
type
String
Returns the type of axis data
- time
- Manages time data
- stacked
- Manages stacked numeric data
- numeric
- Manages numeric data
- category
- Manages categorical data
Fires event typeChange
Fires when the value for the configuration attribute type 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: