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

Class: abstract PivotTableFieldBase

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

Parameters

Returns

PivotTableFieldBase

Defined in

pivot/table-field.ts:49

Properties

Methods

fromJSON()

abstract fromJSON(data): void

Parameters

Returns

void

Defined in

pivot/table-field.ts:105

getDataFieldId()

getDataFieldId(): string

Returns

string

Defined in

pivot/table-field.ts:78

getDisplayName()

getDisplayName(): string

Returns

string

Defined in

pivot/table-field.ts:94

getFormat()

getFormat(): undefined | string

Returns

undefined | string

Defined in

pivot/table-field.ts:82

getId()

getId(): string

Returns

string

Defined in

pivot/table-field.ts:56

getQueryData()

abstract getQueryData(): object

Returns

object

• the query data of the field.

Defined in

pivot/table-field.ts:110

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.

Defined in

pivot/table-field.ts:64

setDataFieldId()

setDataFieldId(dataFieldId): void

Parameters

Returns

void

Defined in

pivot/table-field.ts:73

setDisplayName()

setDisplayName(displayName): void

Parameters

Returns

void

Defined in

pivot/table-field.ts:90

setFormat()

setFormat(format): void

Parameters

Returns

void

Defined in

pivot/table-field.ts:86

setSourceName()

setSourceName(sourceName): void

Parameters

Returns

void

Defined in

pivot/table-field.ts:68

toJSON()

abstract toJSON(): object

Returns

object

Defined in

pivot/table-field.ts:100