Class: PivotModel

Defined in: pivot/model.ts:23

PivotModel represents a config model for a pivot table.

Description

The pivot model is a class that stores the pivot table’s configuration information.

Constructors

new PivotModel()

new PivotModel(): PivotModel

Defined in: pivot/model.ts:91

Returns

PivotModel

Properties

Property	Type	Default value	Description	Defined in
`_changeStack`	`IPivotTableChangeSet`[]	`undefined`	-	pivot/model.ts:84
`collapseInfo`	`Record`<`string`, `boolean` \| `Record`<`string`, `boolean`>>	`{}`	The collapse information of the pivot table. Which data structure is {fieldId: boolean	{item: boolean}}
`columnFields`	`string`[]	`[]`	An array of column fields id.	pivot/model.ts:32
`dimension`	`Record`<`string`, `PivotTableLabelField`>	`{}`	A object of dimension fields, which key is the field id and value is the field.	pivot/model.ts:52
`filterFields`	`string`[]	`[]`	An array of filter fields id.	pivot/model.ts:42
`hiddenFields`	`string`[]	`[]`	An array of hidden fields id.	pivot/model.ts:47
`layout`	`PivotLayoutTypeEnum`	`PivotLayoutTypeEnum.tabular`	The layout type of the pivot table.	pivot/model.ts:73
`measure`	`Record`<`string`, `PivotTableValueField`>	`{}`	A object of measure fields, which key is the field id and value is the field.	pivot/model.ts:57
`options`	`IPivotTableOptions`	`undefined`	Creates an instance of PivotModel.	pivot/model.ts:82
`rowFields`	`string`[]	`[]`	An array of row fields id.	pivot/model.ts:27
`valueFields`	`string`[]	`[]`	An array of value fields id.	pivot/model.ts:37
`valueIndex`	`number`	`-1`	The special ΣValue fields order index in the dimension fields	pivot/model.ts:63
`valuePosition`	`PivotTableValuePositionEnum`	`PivotTableValuePositionEnum.None`	The special ΣValue fields position in row or column area.	pivot/model.ts:68

Methods

addField()

addField(
   field, 
   area, 
   index?): void

Defined in: pivot/model.ts:270

Parameters

Parameter	Type	Description
`field`	\| `PivotTableValueField` \| `PivotTableLabelField`	the field to be added.
`area`	`PivotTableFiledAreaEnum`	The area to add the field.
`index`?	`number`	The index of the field in the area.

Returns

void

Description

Add a field to the pivot table.

cloneBufferModel()

cloneBufferModel(): PivotModel

Defined in: pivot/model.ts:694

Returns

PivotModel

endChangeStack()

endChangeStack(): IPivotTableChangeSet[]

Defined in: pivot/model.ts:103

Returns

IPivotTableChangeSet[]

fromJSON()

fromJSON(data): void

Defined in: pivot/model.ts:638

Parameters

Parameter	Type
`data`	`IPivotTableSnapshot`

Returns

void

getDirty()

getDirty(): boolean

Defined in: pivot/model.ts:122

get the dirty status of the pivot table.

Returns

boolean

The dirty status of the pivot table.

getFieldById()

getFieldById(fieldId): 
  | undefined
  | PivotTableValueField
  | PivotTableLabelField

Defined in: pivot/model.ts:380

Parameters

Parameter	Type
`fieldId`	`string`

Returns

| undefined | PivotTableValueField | PivotTableLabelField

getFieldFormat()

getFieldFormat(fieldId): undefined | string

Defined in: pivot/model.ts:180

Parameters

Parameter	Type
`fieldId`	`string`

Returns

undefined | string

getFieldPositionInfoById()

getFieldPositionInfoById(fieldId): {
  area:   | undefined
     | PivotTableFiledAreaEnum;
  index: number;
}

Defined in: pivot/model.ts:321

Parameters

Parameter	Type	Description
`fieldId`	`string`	The id of the field.

Returns

{
  area:   | undefined
     | PivotTableFiledAreaEnum;
  index: number;
}

PositionInfo - The position info of the field. if the field is not in the pivot table, the area will be undefined and the index will be -1.

Name	Type	Defined in
`area`	\| `undefined` \| `PivotTableFiledAreaEnum`	pivot/model.ts:321
`index`	`number`	pivot/model.ts:321

Description

Get where the field bo be position info by field id.

getFieldsAreaByType()

getFieldsAreaByType(type): string[]

Defined in: pivot/model.ts:365

Parameters

Parameter	Type
`type`	`PivotTableFiledAreaEnum`

Returns

string[]

getFilterInfo()

getFilterInfo(fieldId): 
  | undefined
  | IPivotTableFilterInfo

Defined in: pivot/model.ts:226

Parameters

Parameter	Type
`fieldId`	`string`

Returns

| undefined | IPivotTableFilterInfo

getOptions()

getOptions(): IPivotTableOptions

Defined in: pivot/model.ts:145

Get the options of the pivot table. It is a copy of the options.

Returns

IPivotTableOptions

The options of the pivot table.

getQueryData()

getQueryData(): IPivotTableQueryData

Defined in: pivot/model.ts:599

Represents the query data of the pivot table.Which is used to query the data from the data collection.

Returns

IPivotTableQueryData

The query data of the pivot table.

getSortInfo()

getSortInfo(fieldId): 
  | undefined
  | IPivotTableSortInfo

Defined in: pivot/model.ts:219

Parameters

Parameter	Type
`fieldId`	`string`

Returns

| undefined | IPivotTableSortInfo

getValueIndex()

getValueIndex(): number

Defined in: pivot/model.ts:537

The special ΣValue fields order index in the dimension fields

Returns

number

the index

getValuePosition()

getValuePosition(): PivotTableValuePositionEnum

Defined in: pivot/model.ts:541

Returns

PivotTableValuePositionEnum

isColMultiMeasure()

isColMultiMeasure(): boolean

Defined in: pivot/model.ts:549

Whether the pivot table has the special ΣValue fields in column area.

Returns

boolean

has or not.

isEmpty()

isEmpty(): boolean

Defined in: pivot/model.ts:573

Returns

boolean

isExistFieldName()

isExistFieldName(fieldName): boolean

Defined in: pivot/model.ts:390

Parameters

Parameter	Type
`fieldName`	`string`

Returns

boolean

isRowMultiMeasure()

isRowMultiMeasure(): boolean

Defined in: pivot/model.ts:566

Whether the pivot table has the special ΣValue fields in row area.

Returns

boolean

has or not.

iterateField()

iterateField(callback): void

Defined in: pivot/model.ts:233

Parameters

Parameter	Type
`callback`	(`field`) => `void`

Returns

void

iterateFieldByArea()

iterateFieldByArea(area, callback): void

Defined in: pivot/model.ts:254

Parameters

Parameter	Type
`area`	`PivotTableFiledAreaEnum`
`callback`	(`field`) => `void`

Returns

void

iterateFieldDim()

iterateFieldDim(callback): void

Defined in: pivot/model.ts:242

Parameters

Parameter	Type
`callback`	(`field`) => `void`

Returns

void

iterateFieldMeasure()

iterateFieldMeasure(callback): void

Defined in: pivot/model.ts:248

Parameters

Parameter	Type
`callback`	(`field`) => `void`

Returns

void

removeField()

removeField(fieldId): void

Defined in: pivot/model.ts:441

Parameters

Parameter	Type	Description
`fieldId`	`string`	The id of the field to be removed.

Returns

void

-void

Description

Remove a field from the pivot table by the field id.

renameField()

renameField(fieldId, displayName): void

Defined in: pivot/model.ts:410

Parameters

Parameter	Type	Description
`fieldId`	`string`	The id of the field to be renamed.
`displayName`	`string`	The new display name of the field.

Returns

void

Description

Rename a field in the pivot table.

setCollapse()

setCollapse(
   fieldId, 
   collapse, 
   item?): void

Defined in: pivot/model.ts:155

Parameters

Parameter	Type	Description
`fieldId`	`string`	The id of the field.
`collapse`	`boolean`	The collapse status of the field.
`item`?	`string`	The item of the field.

Returns

void

Description

Set the collapse status of the field. Those properties are used to save the collapse status of the field in the pivot table.

setDirty()

setDirty(dirty): void

Defined in: pivot/model.ts:114

set a dirty status to flag the pivot table whether it is changed.

Parameters

Parameter	Type
`dirty`	`boolean`

Returns

void

setFieldFormat()

setFieldFormat(fieldId, format): void

Defined in: pivot/model.ts:190

Parameters

Parameter	Type
`fieldId`	`string`
`format`	`undefined` \| `string`

Returns

void

setFilterInfo()

setFilterInfo(fieldId, filterInfo): void

Defined in: pivot/model.ts:168

Parameters

Parameter	Type
`fieldId`	`string`
`filterInfo`	`IPivotTableFilterInfo`

Returns

void

setOptions()

setOptions(options): void

Defined in: pivot/model.ts:131

Set the options of the pivot table.

Parameters

Parameter	Type	Description
`options`	`IPivotTableOptions`	The options to be set.

Returns

void

setSortInfo()

setSortInfo(fieldId, sortInfo): void

Defined in: pivot/model.ts:206

Parameters

Parameter	Type
`fieldId`	`string`
`sortInfo`	\| `undefined` \| `IPivotTableSortInfo`

Returns

void

setSubtotalType()

setSubtotalType(tableFieldId, subtotal): void

Defined in: pivot/model.ts:582

set or update a field’s subtotal type. , the table field must in the value area.

Parameters

Parameter	Type	Description
`tableFieldId`	`string`	The id of the pivot table field.
`subtotal`	`PivotSubtotalTypeEnum`	The subtotal type.

Returns

void

startChangeStack()

startChangeStack(): void

Defined in: pivot/model.ts:99

Returns

void

toJSON()

toJSON(): IPivotTableSnapshot

Defined in: pivot/model.ts:667

Returns

IPivotTableSnapshot

updateFieldPosition()

updateFieldPosition(
   fieldId, 
   area, 
   index): void

Defined in: pivot/model.ts:465

Parameters

Parameter	Type
`fieldId`	`string`
`area`	`PivotTableFiledAreaEnum`
`index`	`number`

Returns

void

updateFieldSourceInfo()

updateFieldSourceInfo(
   fieldId, 
   sourceName, 
   dataFieldId): void

Defined in: pivot/model.ts:343

Parameters

Parameter	Type
`fieldId`	`string`
`sourceName`	`string`
`dataFieldId`	`string`

Returns

void

updateValuePosition()

updateValuePosition(valuePosition, valueIndex): void

Defined in: pivot/model.ts:522

Update the value position of the pivot table.

Parameters

Parameter	Type
`valuePosition`	`PivotTableValuePositionEnum`
`valueIndex`	`number`

Returns

void

Pageviewitem Pivottable