ons.orientation

画面のオリエンテーション検知のためのユーティリティメソッドを収めているオブジェクトです。

メソッド概要 #

シグネチャ 概要
isPortrait() オリエンテーションがportraitモードかどうかを返します。
isLandscape() オリエンテーションがlandscapeモードかどうかを返します。
on(eventName, listener) イベントリスナーを追加します。
once(eventName, listener) 一度だけ呼び出されるイベントリスナーを追加します。
off(eventName, [listener]) イベントリスナーを削除します。もしイベントリスナーを指定しなかった場合には、そのイベントに紐づく全てのイベントリスナーが削除されます。

イベント概要 #

名前 概要
change デバイスのオリエンテーションが変化した際に発火します。

メソッド

isPortrait(): Boolean #

オリエンテーションがportraitモードかどうかを返します。

返り値: オリエンテーションがportraitモードの場合にtrueになります。

isLandscape(): Boolean #

オリエンテーションがlandscapeモードかどうかを返します。

返り値: オリエンテーションがlandscapeモードの場合にtrueになります。

on(eventName, listener) #

イベントリスナーを追加します。

パラメーター
名前 概要
eventName String イベント名を指定します。
listener Function このイベントが発火された際に呼び出される関数オブジェクトを指定します。

once(eventName, listener) #

一度だけ呼び出されるイベントリスナーを追加します。

パラメーター
名前 概要
eventName String イベント名を指定します。
listener Function イベントが発火した際に呼び出される関数オブジェクトを指定します。

off(eventName, [listener]) #

イベントリスナーを削除します。もしイベントリスナーを指定しなかった場合には、そのイベントに紐づく全てのイベントリスナーが削除されます。

パラメーター
名前 概要
eventName String イベント名を指定します。
listener Function 削除するイベントリスナーを指定します。

イベント

change #

デバイスのオリエンテーションが変化した際に発火します。

パラメーター
名前 概要
event Object イベントオブジェクトです。
event.isPortrait Boolean 現在のオリエンテーションがportraitの場合にtrueを返します。

議論 #