DataItemDateTimeFormat Class
Contains formatting settings for date-time values.
#Declaration
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.
#Inheritance
#constructor
Initializes a new instance of the DataItemDateTimeFormat
class.
#Declaration
constructor(
modelJson?: any,
serializer?: DevExpress.Analytics.Utils.ModelSerializer
)
#Parameters
Name | Type | Description |
---|---|---|
model |
any | A JSON object used for dashboard deserialization. Do not pass this parameter directly. |
serializer | Model |
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
dateFormat: ko.Observable<DevExpress.Dashboard.Model.DateFormat>
#Property Value
Type | Description |
---|---|
Observable<Date |
A Date |
#dateHourFormat Property
Specifies the format type associated with the DateHour group interval.
#Declaration
dateHourFormat: ko.Observable<DevExpress.Dashboard.Model.DateTimeFormat>
#Property Value
Type | Description |
---|---|
Observable<Date |
A Date |
#dateHourMinuteFormat Property
#Declaration
dateHourMinuteFormat: ko.Observable<DevExpress.Dashboard.Model.DateTimeFormat>
#Property Value
Type |
---|
Observable<Date |
#dateTimeFormat Property
#Declaration
dateTimeFormat: ko.Observable<DevExpress.Dashboard.Model.DateTimeFormat>
#Property Value
Type |
---|
Observable<Date |
#dayOfWeekFormat Property
#Declaration
dayOfWeekFormat: ko.Observable<DevExpress.Dashboard.Model.DayOfWeekFormat>
#Property Value
Type |
---|
Observable<Day |
#exactDateFormat Property
#Declaration
exactDateFormat: ko.Observable<DevExpress.Dashboard.Model.ExactDateFormat>
#Property Value
Type |
---|
Observable<Exact |
#hourFormat Property
#Declaration
hourFormat: ko.Observable<DevExpress.Dashboard.Model.HourFormat>
#Property Value
Type |
---|
Observable<Hour |
#monthFormat Property
#Declaration
monthFormat: ko.Observable<DevExpress.Dashboard.Model.MonthFormat>
#Property Value
Type |
---|
Observable<Month |
#quarterFormat Property
#Declaration
quarterFormat: ko.Observable<DevExpress.Dashboard.Model.QuarterFormat>
#Property Value
Type |
---|
Observable<Quarter |
#yearFormat Property
#Declaration
yearFormat: ko.Observable<DevExpress.Dashboard.Model.YearFormat>
#Property Value
Type |
---|
Observable<Year |
#Methods
#getInfo Method
For internal use.
#Declaration
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray
#Returns
Type | Description |
---|---|
ISerialization |
An array of objects that provide serialization info. |