-
Wijmo
- Arraybase
- Binding
- Canceleventargs
- Clipboard
- Collectionview
- Collectionviewgroup
- Color
- Control
- Datetime
- Event
- Eventargs
- Globalize
- Groupdescription
- Notifycollectionchangedeventargs
- Observablearray
- Pagechangingeventargs
- Interop
- Point
- Printdocument
- Propertychangedeventargs
- Propertygroupdescription
- Rect
- Requesterroreventargs
- Size
- Sortdescription
- Tooltip
- Tooltipeventargs
- Aggregate
- Datatype
- Key
- Notifycollectionchangedaction
- Popupposition
- Sortnulls
- Tooltiptrigger
- Ibindinginfo
- Icollectionview
- Ieditablecollectionview
- Ihttprequestoptions
- Inotifycollectionchanged
- Iqueryinterface
- Ipagedcollectionview
- Barcode
- Chart
- Cloud
- Gauge
- Grid
- Input
- Nav
- Odata
- Olap
- Touch
- Undo
- Rest
- Viewer
- Xlsx
- Interops
PivotFieldCollection Class
PivotFieldCollection Class
Heirarchy
-
ObservableArray<PivotField>
- PivotFieldCollection
Constructors
Properties
Methods
Events
Constructors
constructor
-
Initializes a new instance of the PivotFieldCollection class.
Parameters
-
engine: PivotEngine
PivotEngine that owns this PivotFieldCollection.
Returns PivotFieldCollection
-
Properties
engine
Gets a reference to the PivotEngine that owns this PivotFieldCollection.
isUpdating
Gets a value that indicates whether notifications are currently suspended (see beginUpdate and endUpdate).
length
Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.
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.
Methods
at
-
Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.
Parameters
-
index: number
Returns PivotField | undefined
-
beginUpdate
-
Suspends notifications until the next call to endUpdate.
Returns void
clear
-
Removes all items from the array.
Returns void
concat
-
Combines two or more arrays.
Parameters
-
Rest ...items: ConcatArray<PivotField>[]
Additional items to add to the end of array1.
Returns PivotField[]
-
-
Combines two or more arrays.
Parameters
-
Rest ...items: (T | ConcatArray<T>)[]
Additional items to add to the end of array1.
Returns PivotField[]
-
deferUpdate
-
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.
Returns void
-
endUpdate
-
Resumes notifications suspended by a call to beginUpdate.
Parameters
-
Optional isSilent: boolean
whether to end update silently i.e without raising collectionChanged event
Returns void
-
entries
-
Returns an iterable of key, value pairs for every entry in the array
Returns IterableIterator<[number, PivotField]>
every
-
Determines whether all the members of an array satisfy the specified test.
Parameters
-
callbackfn: Object
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
-
filter
-
Returns the elements of an array that meet the condition specified in a callback function.
Type parameters
-
S: PivotField
Parameters
-
callbackfn: Object
A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
-
-
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
-
callbackfn: Object
A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns PivotField[]
-
forEach
-
Performs the specified action for each element in an array.
Parameters
-
callbackfn: Object
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void
-
getField
-
Gets a field by key.
Parameters
-
key: string
PivotField.key to look for.
Returns PivotField
-
implementsInterface
-
Returns true if the caller queries for a supported interface.
Parameters
-
interfaceName: string
Name of the interface to look for.
Returns boolean
True if the caller queries for a supported interface.
-
indexOf
-
Searches for an item in the array.
Parameters
-
searchElement: PivotField
Element to locate in the array.
-
Optional fromIndex: number
The index where the search should start.
Returns number
The index of the item in the array, or -1 if the item was not found.
-
insert
-
Inserts an item at a specific position in the array.
Parameters
-
index: number
Position where the item will be added.
-
item: PivotField
Item to add to the array.
Returns void
-
join
-
Adds all the elements of an array separated by the specified separator string.
Parameters
-
Optional separator: string
A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string
-
keys
-
Returns an iterable of keys in the array
Returns IterableIterator<number>
lastIndexOf
-
Returns the index of the last occurrence of a specified value in an array.
Parameters
-
searchElement: PivotField
The value to locate in the array.
-
Optional fromIndex: number
The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number
-
map
-
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Type parameters
-
U
Parameters
-
callbackfn: Object
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]
-
onCollectionChanged
-
Raises the collectionChanged event.
Parameters
-
Optional e: NotifyCollectionChangedEventArgs<any>
Contains a description of the change.
Returns void
-
push
-
Overridden to allow pushing fields by header.
Parameters
-
Rest ...item: any[]
Returns number
The new length of the array.
-
remove
-
Removes an item from the array.
Parameters
-
item: PivotField
Item to remove.
Returns boolean
True if the item was removed, false if it wasn't found in the array.
-
removeAt
-
Removes an item at a specific position in the array.
Parameters
-
index: number
Position of the item to remove.
Returns void
-
reverse
-
Reverses the elements in an Array.
Returns PivotField[]
setAt
-
Assigns an item at a specific position in the array.
Parameters
-
index: number
Position where the item will be assigned.
-
item: PivotField
Item to assign to the array.
Returns void
-
shift
-
Removes the first element from the array and returns that element.
This method changes the length of the array.
Returns PivotField
slice
-
Creates a shallow copy of a portion of an array.
Parameters
-
Optional begin: number
Position where the copy starts.
-
Optional end: number
Position where the copy ends.
Returns PivotField[]
A shallow copy of a portion of an array.
-
some
-
Determines whether the specified callback function returns true for any element of an array.
Parameters
-
callbackfn: Object
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
-
sort
-
Sorts the elements of the array in place.
Parameters
-
Optional compareFn: Function
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.
Returns this
A copy of the sorted array.
-
splice
-
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.
-
Rest ...item: PivotField[]
Returns PivotField[]
An array containing the removed elements.
-
toLocaleString
-
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.
Returns string
toString
-
Returns a string representation of an array.
Returns string
unshift
-
Adds one or more elements to the beginning of the array and returns the new length of the array.
Parameters
-
Rest ...items: PivotField[]
Returns number
The new length of the array.
-
values
-
Returns an iterable of values in the array
Returns IterableIterator<PivotField>
Events
collectionChanged
Occurs when the collection changes.
Represents a collection of PivotField objects.