@univerjs-pro/engine-pivot v0.5.4

Class: abstract PivotTableFieldBase

Defined in: pivot/table-field.ts:34

Represents a base class for the field in a pivot table.

Description

The base class for the field in a pivot table.

Extended by

• PivotTableLabelField
• PivotTableValueField

Constructors

new PivotTableFieldBase()

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

Defined in: pivot/table-field.ts:49

Parameters

Returns

PivotTableFieldBase

Properties

Methods

fromJSON()

abstract fromJSON(data): void

Defined in: pivot/table-field.ts:105

Parameters

Returns

void

getDataFieldId()

getDataFieldId(): string

Defined in: pivot/table-field.ts:78

Returns

string

getDisplayName()

getDisplayName(): string

Defined in: pivot/table-field.ts:94

Returns

string

getFormat()

getFormat(): undefined | string

Defined in: pivot/table-field.ts:82

Returns

undefined | string

getId()

getId(): string

Defined in: pivot/table-field.ts:56

Returns

string

getQueryData()

abstract getQueryData(): object

Defined in: pivot/table-field.ts:110

Returns

object

• the query data of the field.

getSourceName()

getSourceName(): string

Defined in: pivot/table-field.ts:64

• the read only name in collection

Returns

string

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

setDataFieldId()

setDataFieldId(dataFieldId): void

Defined in: pivot/table-field.ts:73

Parameters

Returns

void

setDisplayName()

setDisplayName(displayName): void

Defined in: pivot/table-field.ts:90

Parameters

Returns

void

setFormat()

setFormat(format): void

Defined in: pivot/table-field.ts:86

Parameters

Returns

void

setSourceName()

setSourceName(sourceName): void

Defined in: pivot/table-field.ts:68

Parameters

Returns

void

toJSON()

abstract toJSON(): object

Defined in: pivot/table-field.ts:100

Returns

object