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

Wijmo_Grid_Sheet.Sheetcollection

SheetCollection クラス

Sheet オブジェクトのコレクションを定義します。

Type parameters

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

プロパティ

isUpdating

isUpdating: boolean

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

length

length: number

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

selectedIndex

selectedIndex: number

現在選択されているシートのインデックスを取得または設定します。

メソッド

beginUpdate

  • beginUpdate(): void

clear

  • clear(): void

  • SheetCollectionをクリアします。

    戻り値 void

concat

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

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

    引数

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

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

    戻り値 T[]

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

    引数

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

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

    戻り値 T[]

copyWithin

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

  • startとendで識別される配列の一部をtargetから始まる同じ配列にコピーした後、 thisオブジェクトを返します。

    引数

    • target: number

      target が負の場合、target は length + targetとして扱われます。 ここで、length は配列の長さです。

    • start: number

      start が負の場合、start は length+start として扱われます。 ここで、length は配列の長さです。

    • オプション end: number

      指定されない場合は、このオブジェクトの長さがデフォルト値として使用されます。

    戻り値 this

deferUpdate

  • deferUpdate(fn: Function): void

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

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

    引数

    • fn: Function

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

    戻り値 void

endUpdate

  • endUpdate(): void

entries

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

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

    戻り値 IterableIterator<[number, T]>

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: T, start?: number, end?: number): this

  • startとendによって識別されるセクションに値を設定して、このオブジェクトを返します。

    引数

    • value: T

      配列に設定する値。

    • オプション start: number

      配列値の設定に使用する開始インデックス。 start が負の場合、start は length+start として扱われます。 ここで、length は配列の長さです。

    • オプション end: number

      配列値の設定に使用する終了インデックス。 end が負の場合、end は length+end として扱われます。

    戻り値 this

filter

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

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

    Type parameters

    • S: T

    引数

    • 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 値として使用されます。

    戻り値 T[]

findIndex

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

  • predicate が true を返す配列内の最初の要素のインデックスを返します。 そうでなければ、-1 を返します。

    引数

    • predicate: Object

      find メソッドは、predicateが true を返すまで、配列の各要素に対して昇順に predicate を 1 回呼び出します。 そのような要素が見つかると、findIndex はすぐにその要素の値を返します。 そうでなければ、-1 を返します。

    • オプション thisArg: any

      指定した場合は、predicate が呼び出されるたびに this 値として使用されます。指定されていない場合は、undefined が使用されます。

    戻り値 number

forEach

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

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

    引数

    • callbackfn: Object

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

    • オプション thisArg: any

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

    戻り値 void

getValidSheetName

  • getValidSheetName(currentSheet: T): string

  • シートの有効な名前を取得します。

    引数

    • currentSheet: T

      有効な名前を取得するSheet。

    戻り値 string

hide

  • hide(pos: number): boolean

  • 指定した位置にあるシートを非表示にします。

    引数

    • pos: number

      非表示にするシートの位置。

    戻り値 boolean

implementsInterface

  • implementsInterface(interfaceName: string): boolean

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

    引数

    • interfaceName: string

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

    戻り値 boolean

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

includes

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

  • 特定の要素が配列に含まれているかどうかを true または false で返します。

    引数

    • searchElement: T

      検索する要素。

    • オプション fromIndex: number

      配列内で searchElement の検索を開始する位置。

    戻り値 boolean

indexOf

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

  • 配列内で項目を検索します。

    引数

    • searchElement: T

      配列内で検索する要素。

    • オプション fromIndex: number

      検索を開始するインデックス。

    戻り値 number

    配列内の項目のインデックス。項目が見つからない場合は-1。

insert

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

  • 配列内の指定した位置に項目を挿入します。基本クラスであるObservableArray のinsertメソッドをオーバーライドします。

    引数

    • index: number

      項目を追加する位置。

    • item: T

      配列に追加する項目。

    戻り値 void

isValidSheetName

  • isValidSheetName(sheet: T): boolean

  • シート名が有効かどうかをチェックします。

    引数

    • sheet: T

      名前をチェックするSheet。

    戻り値 boolean

join

  • join(separator?: string): string

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

    引数

    • オプション separator: string

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

    戻り値 string

keys

  • keys(): IterableIterator<number>

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

    戻り値 IterableIterator<number>

lastIndexOf

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

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

    引数

    • searchElement: T

      配列内で検索する値。

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

onSelectedSheetChanged

onSheetCleared

  • onSheetCleared(): void

  • sheetClearedイベントを発生させます。

    戻り値 void

onSheetNameChanged

onSheetVisibleChanged

push

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

  • 配列の末尾に1つ以上の項目を追加します。 基本クラスObservableArray のpushメソッドをオーバーライドします。

    引数

    • Rest ...item: T[]

    戻り値 number

    配列の新しい長さ。

remove

  • remove(item: T): boolean

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

    引数

    • item: T

      削除する項目。

    戻り値 boolean

    項目が削除された場合はtrue、配列に見つからない場合はfalse。

removeAt

  • removeAt(index: number): void

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

    引数

    • index: number

      削除する項目の位置。

    戻り値 void

reverse

  • reverse(): T[]

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

    戻り値 T[]

selectFirst

  • selectFirst(): boolean

  • FlexSheet コントロールで最初のシートを選択します。

    戻り値 boolean

selectLast

  • selectLast(): boolean

  • オーナーである FlexSheet コントロールで最後のシートを選択します。

    戻り値 boolean

selectNext

  • selectNext(): boolean

  • オーナーである FlexSheet コントロールで次のシートを選択します。

    戻り値 boolean

selectPrevious

  • selectPrevious(): boolean

  • オーナーである FlexSheet コントロールで 前のシートを選択します。

    戻り値 boolean

setAt

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

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

    引数

    • index: number

      項目を設定する位置。

    • item: T

      配列に設定する項目。

    戻り値 void

shift

  • shift(): T | undefined

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

    戻り値 T | undefined

show

  • show(pos: number): boolean

  • 指定した位置にあるSheet の非表示を解除して選択します。

    引数

    • pos: number

      表示するシートの位置。

    戻り値 boolean

slice

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

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

    引数

    • オプション begin: number

      コピーを開始する位置。

    • オプション end: number

      コピーを終了する位置。

    戻り値 T[]

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

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

  • 配列からの項目の削除、または配列への項目の追加を行います。 基本クラスObservableArray のspliceメソッドをオーバーライドします。

    引数

    • index: number

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

    • count: number

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

    • Rest ...item: T[]

    戻り値 any[]

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

toLocaleString

  • toLocaleString(): string

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

    戻り値 string

toString

  • toString(): string

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

    戻り値 string

unshift

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

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

    引数

    • Rest ...items: T[]

      配列の先頭に追加する1つ以上の要素。

    戻り値 number

values

  • values(): IterableIterator<T>

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

    戻り値 IterableIterator<T>

イベント

collectionChanged

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

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

selectedSheetChanged

selectedSheetChanged: Event<SheetCollection<Sheet>, EventArgs>

selectedIndexプロパティが変更されたときに発生します。

sheetCleared

sheetCleared: Event<SheetCollection<Sheet>, EventArgs>

SheetCollection がクリアされたときに発生します。

sheetNameChanged

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

コレクション内のシートの名前が変更された後に発生します。

sheetVisibleChanged

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

コレクション内のシートの表示/非表示が変更された後に発生します。