#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# TimeImpl Class

Defined in: `charts/js/TimeImpl.js:9`
Module: axis-time-base
Parent Module: charts

TimeImpl contains logic for time data. TimeImpl is used by the following classes:

- TimeAxisBase
- TimeAxis

## Constructor

### `TimeImpl`

()

Defined in `charts/js/TimeImpl.js:9`

- Index
- Methods
- Properties
- Attributes

## Item Index

### Methods

- _getKeyArray
- _getNumber
- _getSetMax
- _getSetMin
- _maximumGetter
- _maximumSetter
- _minimumGetter
- _minimumSetter
- _updateMinAndMax
- formatLabel

### Properties

- _dataType
- _type
- GUID

### Attributes

- labelFormat
- labelFunction

## Methods

### `_getKeyArray`

(

- `key`
- `data`

)
private

Defined in `charts/js/TimeImpl.js:186`

Gets an array of values based on a key.

#### Parameters:

- `key` String

  Value key associated with the data array.

- `data` Array

  Array in which the data resides.

#### Returns:

Array

### `_getNumber`

(

- `val`

)
private

Defined in `charts/js/TimeImpl.js:277`

Parses value into a number.

#### Parameters:

- `val` Object

  Value to parse into a number

#### Returns:

Number

### `_getSetMax`

() private

Defined in `charts/js/TimeImpl.js:124`

Indicates whether or not the maximum attribute has been explicitly set.

#### Returns:

Boolean

### `_getSetMin`

() private

Defined in `charts/js/TimeImpl.js:137`

Indicates whether or not the minimum attribute has been explicitly set.

#### Returns:

Boolean

### `_maximumGetter`

() private

Defined in `charts/js/TimeImpl.js:64`

Getter method for maximum attribute.

#### Returns:

Number

### `_maximumSetter`

(

- `value`

)
private

Defined in `charts/js/TimeImpl.js:81`

Setter method for maximum attribute.

#### Parameters:

- `value` Object

### `_minimumGetter`

() private

Defined in `charts/js/TimeImpl.js:94`

Getter method for minimum attribute.

#### Returns:

Number

### `_minimumSetter`

(

- `value`

)
private

Defined in `charts/js/TimeImpl.js:111`

Setter method for minimum attribute.

#### Parameters:

- `value` Object

### `_updateMinAndMax`

() private

Defined in `charts/js/TimeImpl.js:241`

Calculates the maximum and minimum values for the `Axis`.

### `formatLabel`

(

- `value`
- `format`

)

Defined in `charts/js/TimeImpl.js:150`

Formats a label based on the axis type and optionally specified format.

#### Parameters:

- `value` Object
- `format` Object

  Pattern used to format the value.

#### Returns:

String

## Properties

### `_dataType`

Unknown private

Defined in `charts/js/TimeImpl.js:177`

Type of data used in `Axis`.

### `_type`

Unknown private

Defined in `charts/js/TimeImpl.js:55`

Type of data used in `Data`.

### `GUID`

String private

Defined in `charts/js/TimeImpl.js:168`

Constant used to generate unique id.

## Attributes

### `labelFormat`

String

Defined in `charts/js/TimeImpl.js:43`

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

Defined in `charts/js/TimeImpl.js:28`

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.