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

Wijmo_Grid_Sheet.Sheetcollection

SheetCollection クラス

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

階層

  • any
    • SheetCollection

プロパティ

メソッド

イベント

プロパティ

selectedIndex

selectedIndex: number

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

メソッド

clear

  • clear(): void

  • SheetCollectionをクリアします。

    戻り値 void

getValidSheetName

  • getValidSheetName(currentSheet: Sheet): string

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

    引数

    • currentSheet: Sheet

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

    戻り値 string

hide

  • hide(pos: number): boolean

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

    引数

    • pos: number

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

    戻り値 boolean

insert

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

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

    引数

    • index: number

      項目を追加する位置。

    • item: any

      配列に追加する項目。

    戻り値 void

isValidSheetName

  • isValidSheetName(sheet: Sheet): boolean

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

    引数

    • sheet: Sheet

      名前をチェックするSheet。

    戻り値 boolean

onSelectedSheetChanged

onSheetCleared

  • onSheetCleared(): void

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

    戻り値 void

onSheetNameChanged

onSheetVisibleChanged

push

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

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

    引数

    • Rest ...item: any[]

    戻り値 number

    The new length of the array.

removeAt

  • removeAt(index: number): void

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

    引数

    • index: number

      削除する項目の位置。

    戻り値 void

selectFirst

  • selectFirst(): boolean

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

    戻り値 boolean

selectLast

  • selectLast(): boolean

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

    戻り値 boolean

selectNext

  • selectNext(): boolean

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

    戻り値 boolean

selectPrevious

  • selectPrevious(): boolean

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

    戻り値 boolean

show

  • show(pos: number): boolean

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

    引数

    • pos: number

      表示するシートの位置。

    戻り値 boolean

splice

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

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

    引数

    • index: number

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

    • count: number

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

    • オプション item: any

      配列に追加する項目。

    戻り値 any[]

    An array containing the removed elements.

イベント

selectedSheetChanged

selectedSheetChanged: Event

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

sheetCleared

sheetCleared: Event

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

sheetNameChanged

sheetNameChanged: Event

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

sheetVisibleChanged

sheetVisibleChanged: Event

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