5.20192.631
SheetCollection Wijmo API Class

SheetCollection クラス

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

階層

コンストラクタ

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<any>[]): any[]
  • concat(...items: (T | ConcatArray<T>)[]): any[]
  • 2つ以上の配列を結合します。

    引数

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

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

    戻り値 any[]

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

    引数

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

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

    戻り値 any[]

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(): void

entries

  • entries(): IterableIterator<[number, any]>
  • Returns an iterable of key, value pairs for every entry in the array

    戻り値 IterableIterator<[number, any]>

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: any, start?: number, end?: number): this
  • Returns the this object after filling the section identified by start and end with value

    引数

    • value: any

      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(callbackfn: Object, thisArg?: any): S[]
  • filter(callbackfn: Object, thisArg?: any): any[]
  • コールバック関数で指定された条件を満たす配列の要素を返します。

    Type parameters

    • S: any

    引数

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

    戻り値 any[]

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

getValidSheetName

  • getValidSheetName(currentSheet: Sheet): string
  • シートの有効な名前を取得します。

    引数

    • currentSheet: Sheet

      有効な名前を取得するSheet

    戻り値 string

hide

  • hide(pos: number): boolean
  • 指定した位置にあるシートを非表示にします。

    引数

    • pos: number

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

    戻り値 boolean

implementsInterface

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

    引数

    • interfaceName: string

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

    戻り値 boolean

    True if the caller queries for a supported interface.

includes

  • includes(searchElement: any, fromIndex?: number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    引数

    • searchElement: any

      The element to search for.

    • オプション fromIndex: number

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

    戻り値 boolean

indexOf

  • indexOf(searchElement: any, fromIndex?: number): number
  • 配列内で項目を検索します。

    引数

    • searchElement: any

      配列内で検索する要素。

    • オプション fromIndex: number

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

    戻り値 number

    The index of the item in the array, or -1 if the item was not found.

insert

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

    引数

    • index: number

      項目を追加する位置。

    • item: any

      配列に追加する項目。

    戻り値 void

isValidSheetName

  • isValidSheetName(sheet: Sheet): boolean
  • シート名が有効かどうかをチェックします。

    引数

    • sheet: Sheet

      名前をチェックするSheet

    戻り値 boolean

join

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

    引数

    • オプション separator: string

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

    戻り値 string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    戻り値 IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: any, fromIndex?: number): number
  • 配列内で指定された値が最後に見つかった位置のインデックスを返します。

    引数

    • searchElement: any

      配列内で検索する値。

    • オプション fromIndex: number

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

    戻り値 number

map

  • map(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: any[]): number
  • 配列の末尾に1つ以上の項目を追加します。 基本クラスObservableArray のpushメソッドをオーバーライドします。

    引数

    • Rest ...item: any[]

    戻り値 number

    The new length of the array.

remove

  • remove(item: any): boolean
  • 配列から項目を削除します。

    引数

    • item: any

      削除する項目。

    戻り値 boolean

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

removeAt

  • removeAt(index: number): void
  • 配列内の指定した位置にある項目を削除します。

    引数

    • index: number

      削除する項目の位置。

    戻り値 void

reverse

  • reverse(): any[]
  • 配列の要素の順番を反転させます。

    戻り値 any[]

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: any): void
  • 配列内の指定した位置にある項目を設定します。

    引数

    • index: number

      項目を設定する位置。

    • item: any

      配列に設定する項目。

    戻り値 void

shift

  • shift(): any | undefined
  • 配列から最初の要素を取り除き、その要素を返します。

    戻り値 any | undefined

show

  • show(pos: number): boolean
  • 指定した位置にあるSheet の非表示を解除して選択します。

    引数

    • pos: number

      表示するシートの位置。

    戻り値 boolean

slice

  • slice(begin?: number, end?: number): any[]
  • 配列の一部のシャローコピーを作成します。

    引数

    • オプション begin: number

      コピーを開始する位置。

    • オプション end: number

      コピーを終了する位置。

    戻り値 any[]

    A shallow copy of a portion of an array.

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

    A copy of the sorted array.

splice

  • splice(index: number, count: number, item?: any): any[]
  • 配列からの項目の削除、または配列への項目の追加を行います。 基本クラスObservableArray のspliceメソッドをオーバーライドします。

    引数

    • index: number

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

    • count: number

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

    • オプション item: any

      配列に追加する項目。

    戻り値 any[]

    An array containing the removed elements.

toLocaleString

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

    戻り値 string

toString

  • toString(): string
  • 配列の文字列表現を返します。

    戻り値 string

unshift

  • unshift(...items: any[]): number
  • 配列の先頭に1つ以上の新しい要素を追加します。

    引数

    • Rest ...items: any[]

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

    戻り値 number

values

  • values(): IterableIterator<any>
  • Returns an iterable of values in the array

    戻り値 IterableIterator<any>

イベント

collectionChanged

collectionChanged: Event

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

selectedSheetChanged

selectedSheetChanged: Event

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

sheetCleared

sheetCleared: Event

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

sheetNameChanged

sheetNameChanged: Event

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

sheetVisibleChanged

sheetVisibleChanged: Event

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