no versions found for ApplicationFrameworkReferences / Utility/observablearray_shift / en

ObservableArray: shift()

対象の ObservableArray の先頭の要素を削除して取り出します。

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

構文

observableArray.shift() => ObservableObject?

返値: ObservableObject?

対象の ObservableArray の先頭から削除した ObservableObject を返します。ObservableArray が空だった場合、null と等価な値を返します。

解説

対象の ObservableArray の先頭の要素を削除して取り出します。

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