ObservableArray: unshift()

対象の ObservableArray の先頭に指定した個数の要素を挿入します。

info
  • 中間の位置への要素の挿入には splice() 関数を使用します
  • 末尾への要素の挿入には push() 関数を使用します
  • 先頭の要素の削除および取り出しには shift() 関数を使用します

構文

observableArray.unshift(insertCount) => number

引数

  • insertCount: number

    対象の ObservableArray の先頭に挿入する新しい要素の個数を示す整数です。

    • 既定では 1 が使用されます

返値: number

挿入後の ObservableArray の要素数を返します。

解説

対象の ObservableArray の先頭に指定した個数の要素を挿入します。

note
  • この関数により、対象の ObservableArray と同期しているバインディングターゲットに対してそれらが実装する syncComponents() が呼び出されます。syncComponents() は要素の削除および挿入操作（SPLICE）に対する同期処理を行います。