Skip to main content

DataItemDateTimeFormat Class

Contains formatting settings for date-time values.

#Declaration

TypeScript
export class DataItemDateTimeFormat extends SerializableModel

#Remarks

The DataItemDateTimeFormat class provides settings that allow you to select format types for date-time dimension values displayed for different group intervals (like Year, Month, Year-Quarter, etc.). This class defines a number of properties used to specify a format type that corresponds to a particular group interval.

Note that date-time fields can originate measures. If a measure calculates a maximum or minimum summary, the resulting values are of the date-time type. These values are formatted with the DataItemDateTimeFormat.dateFormat setting. For measures, all other settings provided by this class are ignored.

Use the DataItem.dateTimeFormat property to access date-time format settings.

#Inherited Members

#Inheritance

SerializableModel
DataItemDateTimeFormat

#constructor

Initializes a new instance of the DataItemDateTimeFormat class.

#Declaration

TypeScript
constructor(
    modelJson?: any,
    serializer?: DevExpress.Analytics.Utils.ModelSerializer
)

#Parameters

Name Type Description
modelJson any

A JSON object used for dashboard deserialization. Do not pass this parameter directly.

serializer ModelSerializer

An object used for dashboard deserialization. Do not pass this parameter directly.

#Properties

#dateFormat Property

Specifies the format type associated with the DayMonthYear group interval.

#Declaration

TypeScript
dateFormat: ko.Observable<DevExpress.Dashboard.Model.DateFormat>

#Property Value

Type Description
Observable<DateFormat>

A DateFormat value that specifies the format type associated with the DayMonthYear group interval.

#dateHourFormat Property

Specifies the format type associated with the DateHour group interval.

#Declaration

TypeScript
dateHourFormat: ko.Observable<DevExpress.Dashboard.Model.DateTimeFormat>

#Property Value

Type Description
Observable<DateTimeFormat>

A DateTimeFormat value that specifies the format type associated with the DayDateHour group interval.

#dateHourMinuteFormat Property

#Declaration

TypeScript
dateHourMinuteFormat: ko.Observable<DevExpress.Dashboard.Model.DateTimeFormat>

#Property Value

Type
Observable<DateTimeFormat>

#dateTimeFormat Property

#Declaration

TypeScript
dateTimeFormat: ko.Observable<DevExpress.Dashboard.Model.DateTimeFormat>

#Property Value

Type
Observable<DateTimeFormat>

#dayOfWeekFormat Property

#Declaration

TypeScript
dayOfWeekFormat: ko.Observable<DevExpress.Dashboard.Model.DayOfWeekFormat>

#Property Value

Type
Observable<DayOfWeekFormat>

#exactDateFormat Property

#Declaration

TypeScript
exactDateFormat: ko.Observable<DevExpress.Dashboard.Model.ExactDateFormat>

#Property Value

Type
Observable<ExactDateFormat>

#hourFormat Property

#Declaration

TypeScript
hourFormat: ko.Observable<DevExpress.Dashboard.Model.HourFormat>

#Property Value

Type
Observable<HourFormat>

#monthFormat Property

#Declaration

TypeScript
monthFormat: ko.Observable<DevExpress.Dashboard.Model.MonthFormat>

#Property Value

Type
Observable<MonthFormat>

#quarterFormat Property

#Declaration

TypeScript
quarterFormat: ko.Observable<DevExpress.Dashboard.Model.QuarterFormat>

#Property Value

Type
Observable<QuarterFormat>

#yearFormat Property

#Declaration

TypeScript
yearFormat: ko.Observable<DevExpress.Dashboard.Model.YearFormat>

#Property Value

Type
Observable<YearFormat>

#Methods

#getInfo Method

For internal use.

#Declaration

TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

#Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.