Class: PivotTableLabelField

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

Represents a label field in a pivot table.

Extends

PivotTableFieldBase

Constructors

new PivotTableLabelField()

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

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

Parameters

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

Returns

PivotTableLabelField

Overrides

PivotTableFieldBase.constructor

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

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

Parameters

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

Returns

void

Overrides

PivotTableFieldBase.fromJSON

getDataFieldId()

getDataFieldId(): string

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

Returns

string

Inherited from

PivotTableFieldBase.getDataFieldId

getDisplayName()

getDisplayName(): string

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

Returns

string

Inherited from

PivotTableFieldBase.getDisplayName

getFilterInfo()

getFilterInfo(): IPivotTableFilterInfo

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

Returns

IPivotTableFilterInfo

The filter information of the label field.

Method

getFilterInfo

Description

Get the filter information of the label field.

getFormat()

getFormat(): undefined | string

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

Returns

undefined | string

Inherited from

PivotTableFieldBase.getFormat

getId()

getId(): string

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

Returns

string

Inherited from

PivotTableFieldBase.getId

getQueryData()

abstract getQueryData(): IPivotTableLabelFieldQueryData

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

Returns

IPivotTableLabelFieldQueryData

the query data of the field.

Overrides

PivotTableFieldBase.getQueryData

getSortInfo()

getSortInfo(): 
  | undefined
  | IPivotTableSortInfo

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

Returns

| undefined | IPivotTableSortInfo

The sort information of the label field.

Method

getSortInfo

Description

Get the sort information of the label 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.

Inherited from

PivotTableFieldBase.getSourceName

setDataFieldId()

setDataFieldId(dataFieldId): void

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

Parameters

Parameter	Type
`dataFieldId`	`string`

Returns

void

Inherited from

PivotTableFieldBase.setDataFieldId

setDisplayName()

setDisplayName(displayName): void

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

Parameters

Parameter	Type
`displayName`	`string`

Returns

void

Inherited from

PivotTableFieldBase.setDisplayName

setFilterInfo()

setFilterInfo(filterInfo): void

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

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.

setFormat()

setFormat(format): void

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

Parameters

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

Returns

void

Inherited from

PivotTableFieldBase.setFormat

setSortInfo()

setSortInfo(sortInfo): void

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

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.

setSourceName()

setSourceName(sourceName): void

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

Parameters

Parameter	Type
`sourceName`	`string`

Returns

void

Inherited from

PivotTableFieldBase.setSourceName

toJSON()

abstract toJSON(): IPivotTableLabelFieldJSON

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

Returns

IPivotTableLabelFieldJSON

Overrides

PivotTableFieldBase.toJSON

Pivottablefieldbase Pivottablevaluefield