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

Wijmo.Arraybase

ArrayBase クラス

通知機能のあるArrayクラスの基本クラス。

階層

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

  • ArrayBase クラスの新しいインスタンスを初期化します。

    戻り値 ArrayBase

プロパティ

length

length: number

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

メソッド

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

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

    引数

    • target: number

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

    • start: number

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

    • オプション end: number

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

    戻り値 this

entries

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

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

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

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

    引数

    • value: any

      配列に設定する値。

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

  • 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

includes

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

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

    引数

    • searchElement: any

      検索する要素。

    • オプション fromIndex: number

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

    戻り値 boolean

indexOf

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

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

    引数

    • searchElement: any

      配列内で検索する値。

    • オプション fromIndex: number

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

    戻り値 number

join

  • join(separator?: string): string

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

    引数

    • オプション separator: string

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

    戻り値 string

keys

  • keys(): IterableIterator<number>

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

    戻り値 IterableIterator<number>

lastIndexOf

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

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

    引数

    • searchElement: any

      配列内で検索する値。

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

pop

  • pop(): any | undefined

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

    戻り値 any | undefined

push

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

  • 新しい要素を配列に追加した後、その配列の新しい長さを返します。

    引数

    • Rest ...items: any[]

      配列の新しい要素。

    戻り値 number

reverse

  • reverse(): any[]

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

    戻り値 any[]

shift

  • shift(): any | undefined

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

    戻り値 any | undefined

slice

  • slice(start?: number, end?: number): any[]

  • 配列の一部を返します。

    引数

    • オプション start: number

      配列の指定された部分の開始位置。

    • オプション end: number

      配列の指定された部分の終了位置。

    戻り値 any[]

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?: Object): this

  • 配列をソートします。

    引数

    • オプション compareFn: Object

      要素の順序を決定するために使用される関数の名前。 省略すると、要素はASCII文字の昇順でソートされます。

    戻り値 this

splice

  • splice(start: number, deleteCount?: number): any[]
  • splice(start: number, deleteCount: number, ...items: any[]): any[]

  • 配列から要素を削除し、必要に応じてその位置に新しい要素を挿入し、削除された要素を返します。

    引数

    • start: number

      要素の削除を開始する配列内の0から始まる位置。

    • オプション deleteCount: number

      削除する要素の数。

    戻り値 any[]

  • 配列から要素を削除し、必要に応じてその位置に新しい要素を挿入し、削除された要素を返します。

    引数

    • start: number

      要素の削除を開始する配列内の0から始まる位置。

    • deleteCount: number

      削除する要素の数。

    • Rest ...items: any[]

      削除された要素の位置に配列に挿入する要素。

    戻り値 any[]

toLocaleString

  • toLocaleString(): string

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

    戻り値 string

toString

  • toString(): string

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

    戻り値 string

unshift

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

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

    引数

    • Rest ...items: any[]

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

    戻り値 number

values

  • values(): IterableIterator<any>

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

    戻り値 IterableIterator<any>