PivotDateTimeRangeGroupSettings

PivotDateTimeRangeGroupSettings class

Represents the field grouped by date time range.

class PivotDateTimeRangeGroupSettings extends PivotFieldGroupSettings;

Constructors

NameDescription
constructor(PivotFieldGroupSettings)Constructs from a parent object convertible to this.

Properties

PropertyTypeDescription
startDateReadonly. Gets the start date time of the group.
endDateReadonly. Gets the end date time of the group.
intervalnumberReadonly. Gets the internal of the group.
groupByTypesPivotGroupByType[]Readonly. Gets the types of grouping by date time.

Methods

MethodDescription
isGroupedBy(PivotGroupByType)Check whether the field is grouped by the type.
getType()Gets the data time group type.

constructor(PivotFieldGroupSettings)

Constructs from a parent object convertible to this.

constructor(obj: PivotFieldGroupSettings);

Parameters:

ParameterTypeDescription
objPivotFieldGroupSettingsThe parent object.

start

Readonly. Gets the start date time of the group.

start : Date;

end

Readonly. Gets the end date time of the group.

end : Date;

interval

Readonly. Gets the internal of the group.

interval : number;

groupByTypes

Readonly. Gets the types of grouping by date time.

groupByTypes : PivotGroupByType[];

isGroupedBy(PivotGroupByType)

Check whether the field is grouped by the type.

isGroupedBy(type: PivotGroupByType) : boolean;

Parameters:

ParameterTypeDescription
typePivotGroupByTypeThe group type

getType()

Gets the data time group type.

getType() : PivotFieldGroupType;

Returns

PivotFieldGroupType