@univerjs-pro/engine-pivot v0.5.0-beta.1 • Docs

Class: PivotTableLabelField

Represents a label field in a pivot table.

Extends

PivotTableFieldBase

Constructors

new PivotTableLabelField()

new PivotTableLabelField(
   dataFieldId, 
   id, 
   displayName, 
   sourceName): PivotTableLabelField

Parameters

Parameter	Type	Default value
`dataFieldId`	`string`	`undefined`
`id`	`string`	`undefined`
`displayName`	`string`	`''`
`sourceName`	`string`	`undefined`

Returns

PivotTableLabelField

Overrides

PivotTableFieldBase.constructor

Defined in

pivot/table-field.ts:185

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`dataFieldId`	`readonly`	`string`	The base data field id of the field.	`PivotTableFieldBase`.`dataFieldId`	pivot/table-field.ts:38
`displayName`	`public`	`string`	The display name of the field. the default value is the data field name.	`PivotTableFieldBase`.`displayName`	pivot/table-field.ts:44
`filterInfo`	`public`	`IPivotTableFilterInfo`	-	-	pivot/table-field.ts:184
`format`	`public`	`undefined` \| `string`	-	`PivotTableFieldBase`.`format`	pivot/table-field.ts:45
`id`	`readonly`	`string`	The unique identifier of the field.	`PivotTableFieldBase`.`id`	pivot/table-field.ts:39
`lossLessProperty?`	`public`	`any`	thr public object to save the property not defined but should be saved.	`PivotTableFieldBase`.`lossLessProperty`	pivot/table-field.ts:47
`sortInfo`	`public`	`undefined` \| `IPivotTableSortInfo`	-	-	pivot/table-field.ts:183
`sourceName`	`readonly`	`string`	-	`PivotTableFieldBase`.`sourceName`	pivot/table-field.ts:40

Methods

fromJSON()

abstract fromJSON(data): void

Parameters

Parameter	Type	Description
`data`	`IPivotTableLabelFieldJSON`	the data config a field.

Returns

void

Overrides

PivotTableFieldBase.fromJSON

Defined in

pivot/table-field.ts:247

getDataFieldId()

getDataFieldId(): string

Returns

string

Inherited from

PivotTableFieldBase.getDataFieldId

Defined in

pivot/table-field.ts:78

getDisplayName()

getDisplayName(): string

Returns

string

Inherited from

PivotTableFieldBase.getDisplayName

Defined in

pivot/table-field.ts:94

getFilterInfo()

getFilterInfo(): IPivotTableFilterInfo

Returns

IPivotTableFilterInfo

The filter information of the label field.

Method

getFilterInfo

Description

Get the filter information of the label field.

Defined in

pivot/table-field.ts:221

getFormat()

getFormat(): undefined | string

Returns

undefined | string

Inherited from

PivotTableFieldBase.getFormat

Defined in

pivot/table-field.ts:82

getId()

getId(): string

Returns

string

Inherited from

PivotTableFieldBase.getId

Defined in

pivot/table-field.ts:56

getQueryData()

abstract getQueryData(): IPivotTableLabelFieldQueryData

Returns

IPivotTableLabelFieldQueryData

the query data of the field.

Overrides

PivotTableFieldBase.getQueryData

Defined in

pivot/table-field.ts:225

getSortInfo()

getSortInfo(): undefined | IPivotTableSortInfo

Returns

undefined | IPivotTableSortInfo

The sort information of the label field.

Method

getSortInfo

Description

Get the sort information of the label field.

Defined in

pivot/table-field.ts:203

getSourceName()

getSourceName(): string

the read only name in collection

Returns

string

the source name of the field, which is the name of the data field.

Inherited from

PivotTableFieldBase.getSourceName

Defined in

pivot/table-field.ts:64

setDataFieldId()

setDataFieldId(dataFieldId): void

Parameters

Parameter	Type
`dataFieldId`	`string`

Returns

void

Inherited from

PivotTableFieldBase.setDataFieldId

Defined in

pivot/table-field.ts:73

setDisplayName()

setDisplayName(displayName): void

Parameters

Parameter	Type
`displayName`	`string`

Returns

void

Inherited from

PivotTableFieldBase.setDisplayName

Defined in

pivot/table-field.ts:90

setFilterInfo()

setFilterInfo(filterInfo): void

Parameters

Parameter	Type	Description
`filterInfo`	`IPivotTableFilterInfo`	The filter information of the label field. the manual filter, custom filter or value filter is opposite to each other.

Returns

void

Method

setFilterInfo

Description

Set the filter information of the label field. Only one of the manual filter, custom filter or value filter can be effective.

Defined in

pivot/table-field.ts:212

setFormat()

setFormat(format): void

Parameters

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

Returns

void

Inherited from

PivotTableFieldBase.setFormat

Defined in

pivot/table-field.ts:86

setSortInfo()

setSortInfo(sortInfo): void

Parameters

Parameter	Type	Description
`sortInfo`	`undefined` \| `IPivotTableSortInfo`	The sort information of the label field.

Returns

void

Method

setSortInfo

Description

Set the sort information of the label field.

Defined in

pivot/table-field.ts:194

setSourceName()

setSourceName(sourceName): void

Parameters

Parameter	Type
`sourceName`	`string`

Returns

void

Inherited from

PivotTableFieldBase.setSourceName

Defined in

pivot/table-field.ts:68

toJSON()

abstract toJSON(): IPivotTableLabelFieldJSON

Returns

IPivotTableLabelFieldJSON

Overrides

PivotTableFieldBase.toJSON

Defined in

pivot/table-field.ts:235

Pivottablefieldbase Pivottablevaluefield