PivotDateTimeRangeGroupSettings

PivotDateTimeRangeGroupSettings class

Represents the field grouped by date time range.

class PivotDateTimeRangeGroupSettings extends PivotFieldGroupSettings;

Constructors

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

Properties

Property	Type	Description
start	Date	Readonly. Gets the start date time of the group.
end	Date	Readonly. Gets the end date time of the group.
interval	number	Readonly. Gets the internal of the group.
groupByTypes	PivotGroupByType[]	Readonly. Gets the types of grouping by date time.

Methods

Method	Description
getStart()	@deprecated. Please use the ‘start’ property instead. Gets the start date time of the group.
getEnd()	@deprecated. Please use the ’end’ property instead. Gets the end date time of the group.
getInterval()	@deprecated. Please use the ‘interval’ property instead. Gets the internal of the group.
getGroupByTypes()	@deprecated. Please use the ‘groupByTypes’ property instead. 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.
getType()	Gets the data time group type.

constructor(PivotFieldGroupSettings)

Constructs from a parent object convertible to this.

constructor(obj: PivotFieldGroupSettings);

Parameters:

Parameter	Type	Description
obj	PivotFieldGroupSettings	The 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[];

getStart()

@deprecated. Please use the ‘start’ property instead. Gets the start date time of the group.

getStart() : Date;

getEnd()

@deprecated. Please use the ’end’ property instead. Gets the end date time of the group.

getEnd() : Date;

getInterval()

@deprecated. Please use the ‘interval’ property instead. Gets the internal of the group.

getInterval() : number;

getGroupByTypes()

@deprecated. Please use the ‘groupByTypes’ property instead. Gets the types of grouping by date time.

getGroupByTypes() : PivotGroupByType[];

Returns

PivotGroupByType[]

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;

getType()

Gets the data time group type.

getType() : PivotFieldGroupType;

Returns

PivotFieldGroupType