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

Wijmo_Grid.Columncollection

ColumnCollection クラス

FlexGrid コントロール内のColumn オブジェクトのコレクションを表します。

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

プロパティ

defaultSize

defaultSize: number

コレクションの要素のデフォルトサイズを取得または設定します。

describedById

describedById: string

列ヘッダの説明を含む要素のIDを取得または設定します。

このIDは、すべての列ヘッダ要素の aria-describedby 属性の値として使用されます。 列固有の場合は、 代わりに列の Column.describedById を使用します。

firstVisibleIndex

firstVisibleIndex: number

最初の表示可能な列（アウトラインツリーが表示される列）のインデックスを取得します。

frozen

frozen: number

コレクションに含まれる固定行または固定列の数を取得または設定します。

静止行および静止列はスクロールされず、グリッドの上または左に（固定セルに隣接して）固定されます。 ただし、固定セルとは異なり、 静止セルは通常のセルと同じように選択して編集できます。

frozenEnd

frozenEnd: number

コレクションの最後に固定された行または列の数を取得または設定します。

固定された行と列はスクロールされず、固定セルの横のグリッドの上部または左側に残ります。

grid

grid: FlexGrid

このコレクション を所有するFlexGrid。

isUpdating

isUpdating: boolean

通知が現在中断されているかどうかを示す値を取得します（beginUpdate およびendUpdate を参照）。

lastFrozen

lastFrozen: RowCol | null

最後に固定された列または行を取得します (右/下が固定されている場合、カウントはそれぞれ右から左、下から上になります)

length

length: number

配列の長さを取得または設定します。 これは、配列で定義された最も高い要素より1つ大きい値です。

maxSize

maxSize: number

コレクションの要素の最大サイズを取得または設定します。

minSize

minSize: number

コレクションの要素の最小サイズを取得または設定します。

visibleLength

visibleLength: number

コレクション内(Row.isVisible )に表示される要素の数を取得します。

メソッド

beginUpdate

  • beginUpdate(): void

canMoveElement

  • canMoveElement(src: number, dst: number, adjustFrozenCount?: boolean): boolean

  • 要素をある位置から別の位置に移動できるかどうかをチェックします。

    引数

    • src: number

      移動する要素のインデックス。

    • dst: number

      要素の移動先の位置。末尾に移動する場合は-1を指定します。

    • オプション adjustFrozenCount: boolean

      固定領域に出入りされるときに、固定された要素の数を調整するかどうか。

    戻り値 boolean

    移動が有効な場合はtrue、それ以外の場合はfalseを返します。

clear

  • clear(): void

  • 配列からすべての項目を削除します。

    戻り値 void

concat

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

  • 2つ以上の配列を結合します。

    引数

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

      array1の末尾に追加する追加項目。

    戻り値 Column[]

  • 2つ以上の配列を結合します。

    引数

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

      array1の末尾に追加する追加項目。

    戻り値 Column[]

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

  • beginUpdate/endUpdate ブロック内で関数を実行します。

    この関数が終了するまでコレクションはリフレッシュされません。 このメソッドは、関数が例外を生成した場合でもendUpdate が呼び出されるようにします。

    引数

    • fn: Function

      更新なしで実行する関数。

    戻り値 void

endUpdate

  • endUpdate(isSilent?: boolean): void

  • beginUpdate の呼び出しによって中断された通知を再開します。

    引数

    • オプション isSilent: boolean

      更新をサイレントに終了するかどうか、つまり collectionChanged イベントを発生させずに終了するかどうか

    戻り値 void

entries

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

  • 配列の各要素のキーと値のペアを持つ反復可能オブジェクトを返します。

    戻り値 IterableIterator<[number, Column]>

every

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

  • 配列内のすべての要素が指定されたテストに合格するかどうかテストを実行します。

    引数

    • callbackfn: Object

      引数を 3 つまで受け取る関数。 every メソッドは、array1 の各要素に対して、callbackfn が false を返すか、または配列の末尾に到達するまで callbackfn 関数を呼び出します。

    • オプション thisArg: any

      this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。

    戻り値 boolean

fill

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

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

    引数

    • value: Column

      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): Column[]

  • コールバック関数で指定された条件を満たす配列の要素を返します。

    Type parameters

    引数

    • callbackfn: Object

      引数を 3 つまで受け取る関数。 filter メソッドは、配列内の各要素に対して callbackfn 関数を 1 回呼び出します。

    • オプション thisArg: any

      this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。

    戻り値 S[]

  • コールバック関数で指定された条件を満たす配列の要素を返します。

    引数

    • callbackfn: Object

      引数を 3 つまで受け取る関数。 filter メソッドは、配列内の各要素に対して callbackfn 関数を 1 回呼び出します。

    • オプション thisArg: any

      this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。

    戻り値 Column[]

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

  • 配列内の各要素に対して指定されたアクションを実行します。

    引数

    • callbackfn: Object

      引数を 3 つまで受け取る関数。 forEach メソッドは、配列内の各要素に対して callbackfn 関数を 1 回呼び出します。

    • オプション thisArg: any

      this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。

    戻り値 void

getColumn

  • getColumn(name: string | number): Column

  • 列を名前、連結またはインデックスで取得します。

    このメソッドは、名前で列を検索します。指定された名前を持つ列が見つからない場合は、 バインディングによって検索します。検索では大文字と小文字が区別されます。

    引数

    • name: string | number

      検索する名前、連結またはインデックス。

    戻り値 Column

    指定された名前または連結を含む列。見つからない場合はnull。

getFrozenSize

  • getFrozenSize(): number

getItemAt

  • getItemAt(position: number): number

  • 指定した物理位置にある要素のインデックスを取得します。

    引数

    • position: number

      コレクションの項目の位置（ピクセル単位）。

    戻り値 number

getNextCell

  • getNextCell(index: number, move: SelMove, pageSize?: number): any

  • 選択を変更するために次の表示可能なセルを検索します。

    引数

    • index: number

      検索の開始インデックス。

    • move: SelMove

      移動のタイプ（サイズと方向）。

    • オプション pageSize: number

      ページのサイズ（移動がページアップ/ダウンの場合）。

    戻り値 any

getTotalSize

  • getTotalSize(): number

implementsInterface

  • implementsInterface(interfaceName: string): boolean

  • 指定したインタフェースがサポートされている場合、trueを返します。

    引数

    • interfaceName: string

      調べるインタフェースの名前。

    戻り値 boolean

    指定したインタフェースがサポートされている場合は、trueです。

includes

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

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

    引数

    • searchElement: Column

      The element to search for.

    • オプション fromIndex: number

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

    戻り値 boolean

indexOf

  • indexOf(name: any): number

  • 名前または連結に基づいて列のインデックスを取得します。

    このメソッドは、名前で列を検索します。指定された名前を持つ列が見つからない場合は、 バインディングによって検索します。検索では大文字と小文字が区別されます。

    引数

    • name: any

      検索する名前または連結。

    戻り値 number

    指定された名前または連結を含む列のインデックス。見つからない場合は-1。

insert

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

  • 配列内の指定した位置に項目を挿入します。

    引数

    • index: number

      項目を追加する位置。

    • item: Column

      配列に追加する項目。

    戻り値 void

isFrozen

  • isFrozen(index: number): boolean

  • 列または行が固定されているかどうかを確認します。this.frozen < 0 の場合を考慮します。

    引数

    • index: number

      チェックする行または列のインデックス。

    戻り値 boolean

join

  • join(separator?: string): string

  • 指定されたセパレータによって分離された配列のすべての要素を追加します。

    引数

    • オプション separator: string

      返された文字列内で配列の要素を次の要素から分離するために使用される文字列。 引数を省略すると、配列要素はコンマで区切られます。

    戻り値 string

keys

  • keys(): IterableIterator<number>

  • 配列内のキーを持つ反復可能オブジェクトを返します。

    戻り値 IterableIterator<number>

lastIndexOf

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

  • 配列内で指定された値が最後に見つかった位置のインデックスを返します。

    引数

    • searchElement: Column

      配列内で検索する値。

    • オプション fromIndex: number

      検索を開始する配列インデックス。 fromIndexを省略すると、検索は配列の最後のインデックスから開始されます。

    戻り値 number

map

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

  • 定義されたコールバック関数を配列の各要素に対して呼び出し、結果を含む配列を返します。

    Type parameters

    • U

    引数

    • callbackfn: Object

      引数を 3 つまで受け取る関数。 map メソッドは、配列内の各要素に対して callbackfn 関数を 1 回呼び出します。

    • オプション thisArg: any

      this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。

    戻り値 U[]

moveElement

  • moveElement(src: number, dst: number, adjustFrozenCount?: boolean): boolean

  • 要素をある位置から別の位置に移動します。

    引数

    • src: number

      移動する要素のインデックス。

    • dst: number

      要素の移動先を示す位置（末尾に移動する場合は-1）。

    • オプション adjustFrozenCount: boolean

      固定領域に出入りされるときに、固定された要素の数を調整するかどうか。

    戻り値 boolean

    要素が移動された場合はtrue、それ以外の場合はfalseを返します。

onCollectionChanged

push

remove

  • remove(item: Column): boolean

  • 配列から項目を削除します。

    引数

    • item: Column

      削除する項目。

    戻り値 boolean

    アイテムが削除された場合は true、配列内に見つからなかった場合は false。

removeAt

  • removeAt(index: number): void

  • 配列内の指定した位置にある項目を削除します。

    引数

    • index: number

      削除する項目の位置。

    戻り値 void

reverse

  • 配列の要素の順番を反転させます。

    戻り値 Column[]

setAt

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

  • 配列内の指定した位置にある項目を設定します。

    引数

    • index: number

      項目を設定する位置。

    • item: Column

      配列に設定する項目。

    戻り値 void

shift

  • 配列から最初の要素を削除し、その要素を返します。

    このメソッドは配列の長さを変更します。

    戻り値 Column

slice

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

  • 配列の一部のシャローコピーを作成します。

    引数

    • オプション begin: number

      コピーを開始する位置。

    • オプション end: number

      コピーを終了する位置。

    戻り値 Column[]

    配列の一部のシャローコピー。

some

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

  • 指定されたコールバック関数が配列ののいずれかの要素に対して true を返すかどうかを決定します。

    引数

    • callbackfn: Object

      引数を 3 つまで受け取る関数。 some メソッドは、array1 の各要素に対して、callbackfn が trueを返すか、または配列の末尾に到達するまで callbackfn 関数を呼び出します。

    • オプション thisArg: any

      this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。

    戻り値 boolean

sort

  • sort(compareFn?: Function): this

  • 配列の要素を適切な位置にソートします。

    引数

    • オプション compareFn: Function

      ソート順序を定義する関数を指定します。 この関数は2つの引数を受け取り、 -1（最初の引数の方が2番目の引数より小さい場合）、+1（大きい場合）、0（等しい場合）のいずれかの値を返す必要があります。 これを省略した場合は、各要素の文字列変換に従って辞書順にソートされます。

    戻り値 this

    ソートされた配列のコピー。

splice

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

  • 配列からの項目の削除、または配列への項目の追加を行います。

    引数

    • index: number

      項目を追加または削除する位置。

    • count: number

      配列から削除する項目の数。

    • Rest ...item: Column[]

    戻り値 Column[]

    削除された要素を含む配列。

toLocaleString

  • toLocaleString(): string

  • 配列の文字列表現を返します。 要素は、toLocalStringメソッドを使用して文字列に変換されます。

    戻り値 string

toString

  • toString(): string

  • 配列の文字列表現を返します。

    戻り値 string

unshift

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

  • 配列の先頭に 1 つ以上の要素を追加し、配列の新しい長さを返します。

    引数

    戻り値 number

    配列の新しい長さ。

values

  • values(): IterableIterator<Column>

  • 配列内の値を持つ反復可能オブジェクトを返します。

    戻り値 IterableIterator<Column>

イベント

collectionChanged

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

コレクションが変更されたときに発生します。