DateTime axis in TypeScript 3D Chart control

18 Nov 20182 minutes to read

DateTime axis

DateTime axis uses date time scale and displays the date time values as axis labels in the specified format.

Note: To use datetime axis, we need to inject DateTime3D module using Chart3D.Inject(DateTime3D) method and set the valueType of axis to DateTime.

DateTime category axis

DateTime category axis is used to display the date time values with non-linear intervals. For example, the business days alone have been depicted in a week here.

Note: To use datetime category axis, we need to inject DateTimeCategory3D module using the Chart3D.Inject(DateTimeCategory3D) method and set the valueType of axis to DateTimeCategory.

Range

Range of an axis will be calculated automatically based on the provided data. You can also customize the range of an axis using minimum, maximum and interval properties.

Interval customization

Date time intervals can be customized by using the interval and intervalType properties of the axis. For example, when you set interval as 2 and intervalType as Years, it considers 2 years as interval. DateTime axis supports following interval types,

  • Auto
  • Years
  • Months
  • Days
  • Hours
  • Minutes
  • Seconds

Applying padding to the range

Padding can be applied to the minimum and maximum extremes of the range by using the rangePadding property. DateTime axis supports the following types of padding,

  • None
  • Round
  • Additional

DateTime - None

When the rangePadding is set to None, minimum and maximum of an axis is based on the data.

DateTime - Round

When the rangePadding is set to Round, minimum and maximum will be rounded to the nearest possible value, which is divisible by interval. For example, when the minimum is 15th Jan, interval is 1 and interval type is Month, then the axis minimum will be Jan 1st.

DateTime - Additional

When the rangePadding is set to Additional, interval of an axis will be padded to the minimum and maximum of the axis.

Label format

The date can be formatted and parsed to all globalize format using the labelFormat property in an axis.

The following table describes the result of applying some common date time formats to the labelFormat property.

Label Value Label Format Property Value Result Description
new Date(2000, 03, 10) EEEE Monday The Date is displayed in day format.
new Date(2000, 03, 10) yMd 04/10/2000 The Date is displayed in month/date/year format.
new Date(2000, 03, 10) MMM Apr The Shorthand month for the date is displayed.
new Date(2000, 03, 10) hm 12:00 AM Time of the date value is displayed as label.
new Date(2000, 03, 10) hms 12:00:00 AM The Label is displayed in hours:minutes:seconds format.

Custom label format

Axis also supports custom label format using placeholder like {value}°C, in which the value represent the axis label e.g 20°C.