[]
【重要】2024年1月公開のアップデート「未適用」のお客様へ デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Wijmo_Grid.Columngroupcollection

ColumnGroupCollection クラス

Extends the ObservableArray class to track column group changes.

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

プロパティ

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.

owner

owner: FlexGrid | ColumnGroup | null

Gets the FlexGrid or ColumnGroup that owns this collection.

メソッド

beginUpdate

  • beginUpdate(): void

clear

  • clear(): void

concat

  • Combines two or more arrays.

    引数

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

      Additional items to add to the end of array1.

    戻り値 ColumnGroup[]

  • Combines two or more arrays.

    引数

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

      Additional items to add to the end of array1.

    戻り値 ColumnGroup[]

copyWithin

  • copyWithin(target: number, start: number, end?: number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    引数

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • オプション end: number

      If not specified, length of the this object is used as its default value.

    戻り値 this

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.

    引数

    • fn: Function

      Function to be executed without updates.

    戻り値 void

endUpdate

  • endUpdate(): void

entries

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

    戻り値 IterableIterator<[number, ColumnGroup]>

every

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

  • Determines whether all the members of an array satisfy the specified test.

    引数

    • 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.

    • オプション 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.

    戻り値 boolean

fill

  • fill(value: ColumnGroup, start?: number, end?: number): this

  • Returns the this object after filling the section identified by start and end with value

    引数

    • value: ColumnGroup

      value to fill array section with

    • オプション start: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • オプション end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    戻り値 this

filter

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

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

    Type 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.

    • オプション 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.

    戻り値 S[]

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

    引数

    • 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.

    • オプション 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.

    戻り値 ColumnGroup[]

findIndex

  • findIndex(predicate: Object, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    引数

    • predicate: Object

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • オプション thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    戻り値 number

forEach

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

  • Performs the specified action for each element in an array.

    引数

    • callbackfn: Object

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • オプション 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.

    戻り値 void

getColumn

  • Gets a column group by name, binding, or index.

    If name parameter is of number type, the method returns the child column group by index. If name parameter is of string type, the method searches the column group by name. If a column with the given name is not found, it searches by binding. The searches are case-sensitive.

    引数

    • name: string | number

      The name, binding, or index to find.

    戻り値 ColumnGroup

    The column group with the specified name, binding or index, or null if not found.

implementsInterface

  • implementsInterface(interfaceName: string): boolean

  • Returns true if the caller queries for a supported interface.

    引数

    • interfaceName: string

      Name of the interface to look for.

    戻り値 boolean

    True if the caller queries for a supported interface.

includes

  • includes(searchElement: ColumnGroup, fromIndex?: number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    引数

    • searchElement: ColumnGroup

      The element to search for.

    • オプション fromIndex: number

      The position in this array at which to begin searching for searchElement.

    戻り値 boolean

indexOf

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

  • Searches for an item in the array.

    引数

    • searchElement: ColumnGroup

      Element to locate in the array.

    • オプション fromIndex: number

      The index where the search should start.

    戻り値 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.

    引数

    • index: number

      Position where the item will be added.

    • item: ColumnGroup

      Item to add to the array.

    戻り値 void

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    引数

    • オプション 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.

    戻り値 string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    戻り値 IterableIterator<number>

lastIndexOf

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

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

    引数

    • searchElement: ColumnGroup

      The value to locate in the array.

    • オプション 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.

    戻り値 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

    引数

    • 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.

    • オプション 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.

    戻り値 U[]

push

  • Appends an item to the array.

    引数

    戻り値 number

    The new length of the array.

remove

  • Removes an item from the array.

    引数

    戻り値 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.

    引数

    • index: number

      Position of the item to remove.

    戻り値 void

reverse

  • Reverses the elements in an Array.

    戻り値 ColumnGroup[]

setAt

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

    引数

    • index: number

      Position where the item will be assigned.

    • item: ColumnGroup

      Item to assign to the array.

    戻り値 void

shift

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

    This method changes the length of the array.

    戻り値 ColumnGroup

slice

  • Creates a shallow copy of a portion of an array.

    引数

    • オプション begin: number

      Position where the copy starts.

    • オプション end: number

      Position where the copy ends.

    戻り値 ColumnGroup[]

    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.

    引数

    • 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.

    • オプション 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.

    戻り値 boolean

sort

  • sort(compareFn?: Function): this

  • Sorts the elements of the array in place.

    引数

    • オプション 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.

    戻り値 this

    A copy of the sorted array.

splice

  • Removes or adds items to the array.

    引数

    • index: number

      Position where items are to be added or removed.

    • count: number

      Number of items to remove from the array.

    • Rest ...item: ColumnGroup[]

    戻り値 ColumnGroup[]

    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.

    戻り値 string

toString

  • toString(): string

  • Returns a string representation of an array.

    戻り値 string

unshift

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

    引数

    戻り値 number

    The new length of the array.

values

  • Returns an iterable of values in the array

    戻り値 IterableIterator<ColumnGroup>

イベント

collectionChanged

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

Occurs when the collection changes.