DateTimePeriod Class
A date-time period that is used to select a predefined range in the Range Filter and Date Filter items.
#Declaration
export class DateTimePeriod extends TypedSerializableModel
#Remarks
The DateTimePeriod objects are predefined date-time periods in Range Filter and Date Filter items. The RangeFilterItem.dateTimePeriods and DateFilterItem.dateTimePeriods properties provide access to the collections of DateTimePeriod objects.
Use the DateTimePeriod static methods to create a predefined period. To create a custom period, instantiate the DateTimePeriod class and perform the following steps:
- Specify the boundaries. Create the FixedDateTimePeriodLimit or FlowDateTimePeriodLimit class objects and assign them to the DateTimePeriod.start and DateTimePeriod.end properties.
Note
If you do not specify Date
Time /DatePeriod. start Time , the selection begins from the start/end of the visible range.Period. end - Specify the period name. Assign a string to the DateTimePeriod.name property.
#Inheritance
#constructor
Initializes a new instance of the DateTimePeriod
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
#argumentInterval Property
#Declaration
argumentInterval: ko.Observable<DevExpress.Dashboard.Model.DateTimeGroupInterval>
#Property Value
Type |
---|
Observable<Date |
#end Property
#Declaration
end: DevExpress.Dashboard.Model.LimitContainer
#Property Value
Type |
---|
Limit |
#name Property
Specifies the name of the date-time period.
#Declaration
name: ko.Observable<string>
#Property Value
Type | Description |
---|---|
Observable<string> | A string that specifies the name of the date-time period. |
#Remarks
You can assign the name value to the RangeFilterItem.defaultDateTimePeriodName property to specify the default selected range for the Range Filter.
#start Property
#Declaration
start: DevExpress.Dashboard.Model.LimitContainer
#Property Value
Type |
---|
Limit |
#Methods
#format(value) Method
#Declaration
format(
value: Date
): string
#Parameters
Name | Type |
---|---|
value | Date |
#Returns
Type |
---|
string |
#getDateFormat Method
#Declaration
getDateFormat(): DevExpress.Dashboard.Internal.Data.DateTimeFormatInfoType
#Returns
Type |
---|
Date |
#getDateTimeValue Method
#Declaration
getDateTimeValue(): DevExpress.Dashboard.Internal.Viewer.IRange
#Returns
Type |
---|
IRange |
#getInfo Method
For internal use.
#Declaration
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray
#Returns
Type | Description |
---|---|
ISerialization |
An array of objects that provide serialization info. |