TimeImpl Class
+ + + + +TimeImpl contains logic for time data. TimeImpl is used by the following classes:
+ +-
+
- TimeAxisBase +
- TimeAxis +
Constructor
+TimeImpl
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
- Index + + +
- Methods + + +
- Properties + + +
- Attributes + + +
Item Index
+ + +Methods
+ +-
+
+
- + _getKeyArray + + + + + +
- + _getNumber + + + + + +
- + _getSetMax + + + + + +
- + _getSetMin + + + + + +
- + _maximumGetter + + + + + +
- + _maximumSetter + + + + + +
- + _minimumGetter + + + + + +
- + _minimumSetter + + + + + +
- + _updateMinAndMax + + + + + +
- + formatLabel + + + + + +
Attributes
+ +-
+
+
- + labelFormat + + +
- + labelFunction + + +
Methods
+ + +_getKeyArray
+
+
+ -
+
+
-
+
+
key+ +
+
+ -
+
+
data+ +
+
+
Gets an array of values based on a key.
+Parameters:
+ + +Returns:
+ +_getNumber
+
+
+ -
+
+
-
+
+
val+ +
+
+
Parses value into a number.
+Parameters:
+ +-
+
+
-
+
+
val+ Object + + + + +++ + +Value to parse into a number
+
+
+
Returns:
+ +_getSetMax
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether or not the maximum attribute has been explicitly set.
+Returns:
+ +_getSetMin
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether or not the minimum attribute has been explicitly set.
+Returns:
+ +_maximumGetter
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Getter method for maximum attribute.
+Returns:
+ +_maximumSetter
+
+
+ -
+
+
-
+
+
value+ +
+
+
Setter method for maximum attribute.
+Parameters:
+ +-
+
+
-
+
+
value+ Object + + + + ++ ++ + +
+
+
_minimumGetter
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Getter method for minimum attribute.
+Returns:
+ +_minimumSetter
+
+
+ -
+
+
-
+
+
value+ +
+
+
Setter method for minimum attribute.
+Parameters:
+ +-
+
+
-
+
+
value+ Object + + + + ++ ++ + +
+
+
_updateMinAndMax
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Calculates the maximum and minimum values for the Axis.
formatLabel
+
+
+ -
+
+
-
+
+
value+ +
+
+ -
+
+
format+ +
+
+
Formats a label based on the axis type and optionally specified format.
+Parameters:
+ + +Returns:
+ +Properties
+ + +_dataType
+ Unknown
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Type of data used in Axis.
_type
+ Unknown
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Type of data used in Data.
GUID
+ String
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Constant used to generate unique id.
+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:
+ +-
+
-
+
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 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:
+ +-
+
-
+
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.+
+
+ -
+