PivotFieldCollection Class

File
wijmo.olap.js
Module
wijmo.olap
Base Class
ObservableArray
Show
   

Represents a collection of PivotField objects.

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(engine: PivotEngine): PivotFieldCollection

Initializes a new instance of the PivotFieldCollection class.

Parameters
Returns
PivotFieldCollection

Properties

engine

Gets a reference to the PivotEngine that owns this PivotFieldCollection.

Type
PivotEngine

isUpdating

Gets a value that indicates whether notifications are currently suspended (see beginUpdate and endUpdate).

Inherited From
ObservableArray
Type

maxItems

Gets or sets the maximum number of fields allowed in this collection.

This property is set to null by default, which means any number of items is allowed.

Type
number

Methods

beginUpdate

beginUpdate(): void

Suspends notifications until the next call to endUpdate.

Inherited From
ObservableArray
Returns
void

clear

clear(): void

Removes all items from the array.

Inherited From
ObservableArray
Returns
void

deferUpdate

deferUpdate(fn: Function): void

Executes a function within a beginUpdate/endUpdate block.

The collection will not be refreshed until the function finishes. This method ensures endUpdate is called even if the function throws an exception.

Parameters
Inherited From
ObservableArray
Returns
void

endUpdate

endUpdate(): void

Resumes notifications suspended by a call to beginUpdate.

Inherited From
ObservableArray
Returns
void

getField

getField(key: string): PivotField

Gets a field by key.

Parameters
Returns
PivotField

implementsInterface

implementsInterface(interfaceName: string): boolean

Returns true if the caller queries for a supported interface.

Parameters
Inherited From
ObservableArray
Returns
boolean

indexOf

indexOf(searchElement: any, fromIndex?: number): number

Searches for an item in the array.

Parameters
Inherited From
ObservableArray
Returns
number

insert

insert(index: number, item: any): void

Inserts an item at a specific position in the array.

Parameters
Inherited From
ObservableArray
Returns
void

onCollectionChanged

onCollectionChanged(e?: NotifyCollectionChangedEventArgs): void

Raises the collectionChanged event.

Parameters
Inherited From
ObservableArray
Returns
void

push

push(...item: any[]): number

Overridden to allow pushing fields by header.

Parameters
Returns
number

remove

remove(item: any): boolean

Removes an item from the array.

Parameters
Inherited From
ObservableArray
Returns
boolean

removeAt

removeAt(index: number): void

Removes an item at a specific position in the array.

Parameters
Inherited From
ObservableArray
Returns
void

setAt

setAt(index: number, item: any): void

Assigns an item at a specific position in the array.

Parameters
Inherited From
ObservableArray
Returns
void

slice

slice(begin?: number, end?: number): any[]

Creates a shallow copy of a portion of an array.

Parameters
Inherited From
ObservableArray
Returns
any[]

sort

sort(compareFn?: Function): this

Sorts the elements of the array in place.

Parameters
Inherited From
ObservableArray
Returns
this

splice

splice(index: number, count: number, item?: any): any[]

Removes and/or adds items to the array.

Parameters
Inherited From
ObservableArray
Returns
any[]

Events

collectionChanged

Occurs when the collection changes.

Inherited From
ObservableArray
Arguments
NotifyCollectionChangedEventArgs