Wijmo
Grid
Sheet
5.20231.904
wijmo.grid.sheet Class SheetCollection Wijmo API Class

SheetCollection Class

Defines the collection of the Sheet objects.

Type parameters

Heirarchy

Constructors

Properties

Methods

Events

Constructors

constructor

Properties

isUpdating

isUpdating: boolean

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

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

selectedIndex

selectedIndex: number

Gets or sets the index of the currently selected sheet.

Methods

at

  • at(index: number): T | undefined

  • 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 T | undefined

beginUpdate

  • beginUpdate(): void

clear

  • clear(): void

concat

  • concat(...items: ConcatArray<T>[]): T[]
  • concat(...items: (T | ConcatArray<T>)[]): T[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<T>[]

      Additional items to add to the end of array1.

    Returns T[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns T[]

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.

    Returns void

endUpdate

  • endUpdate(): void

entries

  • entries(): IterableIterator<[number, T]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, T]>

every

  • every(callbackfn: Object, thisArg?: any): boolean

  • 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

  • filter<S>(callbackfn: Object, thisArg?: any): S[]
  • filter(callbackfn: Object, thisArg?: any): T[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: T

    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 T[]

forEach

  • forEach(callbackfn: Object, thisArg?: any): void

  • 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

getValidSheetName

  • getValidSheetName(currentSheet: T): string

  • Gets the valid name for the sheet.

    Parameters

    • currentSheet: T

      The Sheet need get the valid name.

    Returns string

hide

  • hide(pos: number): boolean

  • Hides the sheet at the specified position.

    Parameters

    • pos: number

      The position of the sheet to hide.

    Returns boolean

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.

    Returns boolean

    True if the caller queries for a supported interface.

indexOf

  • indexOf(searchElement: T, fromIndex?: number): number

  • Searches for an item in the array.

    Parameters

    • searchElement: T

      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

  • insert(index: number, item: T): void

  • Inserts an item at a specific position in the array.

    Parameters

    • index: number

      Position where the item will be added.

    • item: T

      Item to add to the array.

    Returns void

isValidSheetName

  • isValidSheetName(sheet: T): boolean

  • Checks whether the sheet name is valid.

    Parameters

    • sheet: T

      The Sheet for which the name needs to check.

    Returns boolean

join

  • join(separator?: string): string

  • 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

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: T, fromIndex?: number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: T

      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

  • map<U>(callbackfn: Object, thisArg?: any): U[]

  • 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[]

onSelectedSheetChanged

onSheetCleared

  • onSheetCleared(): void

  • Raises the sheetCleared event.

    Returns void

onSheetNameChanged

onSheetVisibleChanged

push

  • push(...item: T[]): number

  • Adds one or more items to the end of the array. Overrides the push method of its base class ObservableArray.

    Parameters

    • Rest ...item: T[]

    Returns number

    The new length of the array.

remove

  • remove(item: T): boolean

  • Removes an item from the array.

    Parameters

    • item: T

      Item to remove.

    Returns boolean

    True if the item was removed, false if it wasn't found in the array.

removeAt

  • removeAt(index: number): void

  • Removes an item at a specific position in the array.

    Parameters

    • index: number

      Position of the item to remove.

    Returns void

reverse

  • reverse(): T[]

  • Reverses the elements in an Array.

    Returns T[]

selectFirst

  • selectFirst(): boolean

  • Selects the first sheet in the FlexSheet control.

    Returns boolean

selectLast

  • selectLast(): boolean

  • Selects the last sheet in the owner FlexSheet control.

    Returns boolean

selectNext

  • selectNext(): boolean

  • Select the next sheet in the owner FlexSheet control.

    Returns boolean

selectPrevious

  • selectPrevious(): boolean

  • Selects the previous sheet in the owner FlexSheet control.

    Returns boolean

setAt

  • setAt(index: number, item: T): void

  • Assigns an item at a specific position in the array.

    Parameters

    • index: number

      Position where the item will be assigned.

    • item: T

      Item to assign to the array.

    Returns void

shift

  • shift(): T

  • Removes the first element from the array and returns that element.

    This method changes the length of the array.

    Returns T

show

  • show(pos: number): boolean

  • Unhide and selects the Sheet at the specified position.

    Parameters

    • pos: number

      The position of the sheet to show.

    Returns boolean

slice

  • slice(begin?: number, end?: number): T[]

  • 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 T[]

    A shallow copy of a portion of an array.

some

  • some(callbackfn: Object, thisArg?: any): boolean

  • 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

  • sort(compareFn?: Function): this

  • 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

  • splice(index: number, count: number, ...item: T[]): any[]

  • Removes and/or adds items to the array. Overrides the splice method of its base class ObservableArray.

    Parameters

    • index: number

      Position where items will be added or removed.

    • count: number

      Number of items to remove from the array.

    • Rest ...item: T[]

    Returns any[]

    An array containing the removed elements.

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: T[]): number

  • Adds one or more elements to the beginning of the array and returns the new length of the array.

    Parameters

    • Rest ...items: T[]

    Returns number

    The new length of the array.

values

  • values(): IterableIterator<T>

  • Returns an iterable of values in the array

    Returns IterableIterator<T>

Events

collectionChanged

collectionChanged: Event<ObservableArray<T>, NotifyCollectionChangedEventArgs<T>>

Occurs when the collection changes.

selectedSheetChanged

selectedSheetChanged: Event<SheetCollection<Sheet>, EventArgs>

Occurs when the selectedIndex property changes.

sheetCleared

sheetCleared: Event<SheetCollection<Sheet>, EventArgs>

Occurs when the SheetCollection is cleared.

sheetNameChanged

sheetNameChanged: Event<SheetCollection<Sheet>, NotifyCollectionChangedEventArgs<any>>

Occurs after the name of the sheet in the collection has changed.

sheetVisibleChanged

sheetVisibleChanged: Event<SheetCollection<Sheet>, NotifyCollectionChangedEventArgs<any>>

Occurs after the visible of the sheet in the collection has changed.