FlowDateTimePeriodLimit Class
A floating date-time value used to specify boundaries for the DateTimePeriod.
#Declaration
export class FlowDateTimePeriodLimit extends SerializableModel
#Remarks
The FlowDateTimePeriodLimit class allows you to specify a date-time value to define DateTimePeriod boundaries. The FlowDateTimePeriodLimit.interval property specifies the interval between the current date and the required date. The FlowDateTimePeriodLimit.Offset property allows you to set the number of such intervals.
Note
Note that the Flow
#Inheritance
#constructor
Initializes a new instance of the FlowDateTimePeriodLimit
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 |
#interval Property
Specifies the interval between the current date and the required date.
#Declaration
interval: ko.Observable<DevExpress.Dashboard.Model.DateTimeInterval>
#Property Value
Type | Description |
---|---|
Observable<Date |
A string that specifies the interval between the current date and the required date. |
#Remarks
Use the FlowDateTimePeriodLimit.offset property to specify the number of intervals.
Note
Note that the Flow
#isEmpty Property
#Declaration
isEmpty: ko.Observable<boolean>
#Property Value
Type |
---|
Observable<boolean> |
#offset Property
Specifies the number of intervals specified using the FlowDateTimePeriodLimit.interval property.
#Declaration
offset: ko.Observable<number>
#Property Value
Type | Description |
---|---|
Observable<number> | An integer value that specifies the number of intervals. |
#Remarks
The FlowDateTimePeriodLimit.interval property specifies the interval between the current date and the required date. The Offset property allows you to set the number of such intervals.
Note
Note that the Flow
#Methods
#getInfo Method
For internal use.
#Declaration
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray
#Returns
Type | Description |
---|---|
ISerialization |
An array of objects that provide serialization info. |