PivotDateTimeRangeGroupSettings
Contents
[
Hide
]PivotDateTimeRangeGroupSettings class
Represents the field grouped by date time range.
class PivotDateTimeRangeGroupSettings extends PivotFieldGroupSettings;
Constructors
| Name | Description |
|---|---|
| constructor(PivotFieldGroupSettings) | Constructs from a parent object convertible to this. |
Methods
| Method | Description |
|---|---|
| getType() | Gets the data time group type. |
| getStart() | Gets the start date time of the group. |
| getEnd() | Gets the end date time of the group. |
| getInterval() | Gets the internal of the group. |
| getGroupByTypes() | Gets the types of grouping by date time. |
| isGroupedBy(PivotGroupByType) | Check whether the field is grouped by the type. |
| isNull() | Checks whether the implementation object is null. |
constructor(PivotFieldGroupSettings)
Constructs from a parent object convertible to this.
constructor(obj: PivotFieldGroupSettings);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | PivotFieldGroupSettings | The parent object. |
getType()
Gets the data time group type.
getType() : PivotFieldGroupType;
Returns
getStart()
Gets the start date time of the group.
getStart() : Date;
getEnd()
Gets the end date time of the group.
getEnd() : Date;
getInterval()
Gets the internal of the group.
getInterval() : number;
getGroupByTypes()
Gets the types of grouping by date time.
getGroupByTypes() : PivotGroupByType[];
Returns
isGroupedBy(PivotGroupByType)
Check whether the field is grouped by the type.
isGroupedBy(type: PivotGroupByType) : boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | PivotGroupByType | The group type |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;