ASP.NET MVC Controls
PivotFieldCollection Class
File
wijmo.olap.js
Module
wijmo.olap
Base Class
ObservableArray

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
  • fn: Function

    Function to be executed without updates.

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
  • key: string

    key to look for.

Returns
PivotField

implementsInterface

implementsInterface(interfaceName: string): boolean

Returns true if the caller queries for a supported interface.

Parameters
  • interfaceName: string

    Name of the interface to look for.

Inherited From
ObservableArray
Returns
boolean

indexOf

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

Searches for an item in the array.

Parameters
  • searchElement: any

    Element to locate in the array.

  • fromIndex: number Optional

    The index where the search should start.

Inherited From
ObservableArray
Returns
number

insert

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

Inserts an item at a specific position in the array.

Parameters
  • index: number

    Position where the item will be added.

  • item: any

    Item to add to the array.

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
  • ...item: any[]

    One or more PivotField objects to add to the array.

Returns
number

remove

remove(item: any): boolean

Removes an item from the array.

Parameters
  • item: any

    Item to remove.

Inherited From
ObservableArray
Returns
boolean

removeAt

removeAt(index: number): void

Removes an item at a specific position in the array.

Parameters
  • index: number

    Position of the item to remove.

Inherited From
ObservableArray
Returns
void

setAt

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

Assigns an item at a specific position in the array.

Parameters
  • index: number

    Position where the item will be assigned.

  • item: any

    Item to assign to the array.

Inherited From
ObservableArray
Returns
void

slice

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

Creates a shallow copy of a portion of an array.

Parameters
  • begin: number Optional

    Position where the copy starts.

  • end: number Optional

    Position where the copy ends.

Inherited From
ObservableArray
Returns
any[]

sort

sort(compareFn?: Function): any[]

Sorts the elements of the array in place.

Parameters
  • compareFn: Function Optional

    Specifies a function that defines the sort order. If specified, the function should take two arguments and should return -1, +1, or 0 to indicate the first argument is smaller, greater than, or equal to the second argument. If omitted, the array is sorted in dictionary order according to the string conversion of each element.

Inherited From
ObservableArray
Returns
any[]

splice

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

Removes and/or adds items to the array.

Parameters
  • index: number

    Position where items will be added or removed.

  • count: number

    Number of items to remove from the array.

  • item: any Optional

    Item to add to the array.

Inherited From
ObservableArray
Returns
any[]

Events

collectionChanged

Occurs when the collection changes.

Inherited From
ObservableArray
Arguments
NotifyCollectionChangedEventArgs

 

 


Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback