Namespace: scene

h5. scene

Members

(static) method

シーン遷移時のHTMLデータ取得時のHTTPメソッド

シーン遷移時のmethodパラメータに指定するHTMLデータ取得時のHTTPメソッドを表す定数です

h5.scene.method.GET
"get" … GETメソッドで取得します(デフォルト)。
h5.scene.method.ONCE
"post" … POSTメソッドで取得します。ブラウザバックなどで再表示はできなくなります。
Source:

(static) navigationType

シーン遷移時のパターン

シーン遷移時のnavigationTypeパラメータに指定する遷移時のパターンを表す定数です

h5.scene.navigationType.NORMAL
"normal" … URLに開発者指定のパラメーターを入れます(デフォルト)。ブラウザバック等でパラメーター含めて再表示可能です。
h5.scene.navigationType.ONCE
"once" … URLに開発者指定のパラメーターを入れません。フレームワーク用パラメーターのみとなります。
h5.scene.navigationType.SILENT
"silent" … URLは変化させずに遷移します。
Source:

(static) urlHistoryMode

メインシーンコンテナのURL履歴保持方法列挙体

メインシーンコンテナURL履歴保持方法です。何れかをh5.settings.scene.urlHistoryModeに指定します。

h5.scene.urlHistoryMode.HASH
"hash" … シーン遷移パラメーターをハッシュに格納する。
h5.scene.urlHistoryMode.NONE
"none" … URLを変更しない。
h5.scene.urlHistoryMode.FULLRELOAD
"fullreload" … Ajaxを使用せず、ページ全体を再読み込みする(通常の遷移)。
h5.scene.urlHistoryMode.HISTORY
"history"(デフォルト) … HTML5 History APIを使用してURLを変更する。History APIが使用できない場合はハッシュを使用する。
h5.scene.urlHistoryMode.HISTORY_OR_HASH
"historyOrHash" … "history"と同義。
h5.scene.urlHistoryMode.HISTORY_OR_ERROR
"historyOrError" … HTML5 History APIを使用してURLを変更する。History APIが使用できない場合はエラーとする。
h5.scene.urlHistoryMode.HISTORY_OR_NONE
"historyOrNone" … HTML5 History APIを使用してURLを変更する。History APIが使用できない場合はURLを変更せずに遷移する。
h5.scene.urlHistoryMode.HISTORY_OR_FULLRELOAD
"historyOrFullreload" … HTML5 History APIを使用してURLを変更する。History APIが使用できない場合はAjaxを使用せずに遷移する(通常遷移)。
Source:

Methods

(static) createSceneContainer(element, isMainopt) → {SceneContainerController}

シーンコンテナインスタンスを生成します.
Parameters:
Name Type Attributes Default Description
element Element シーンコンテナ生成対象要素。
isMain Boolean <optional>
false メインシーンコンテナとするか否か。
メインシーンコンテナとする
true
メインシーンコンテナとしない
false(デフォルト)
Returns:
生成したシーンコンテナのインスタンス。
Type
SceneContainerController
Source:

(static) getMainSceneContainer() → {SceneContainerController}

メインシーンコンテナのインスタンスを取得します。
Returns:
メインシーンコンテナのインスタンス。未作成の場合はnull。
Type
SceneContainerController
Source:

(static) getSceneContainerByName(name) → {SceneContainerController}

シーンコンテナを取得します

第1引数に取得対象とする要素のdata-h5-scene-container属性まはたdata-h5-main-scene-container属性の値を文字列で指定します。該当する要素に対応するシーンコンテナを返します。

Parameters:
Name Type Description
name String 取得対象とする要素のdata-h5-scene-container属性まはたdata-h5-main-scene-container属性の値を文字列で指定します。
Returns:
該当するシーンコンテナ。ない場合はnullを返します。
Type
SceneContainerController
Source:

(static) getSceneContainers(rootElementopt) → {Array.<SceneContainerController>}

指定要素およびその配下のシーンコンテナを取得します
Parameters:
Name Type Attributes Default Description
rootElement DOM | jQuery | stroing <optional>
document.body 走査先頭要素。要素またはセレクタを指定します。指定しない場合はドキュメント全体を対象とします。
option.deep boolean <optional>
true 子孫要素にバインドされているコントローラも含めるかどうか(デフォルトは含める)
Returns:
シーンコンテナの配列。
Type
Array.<SceneContainerController>
Source:

(static) init()

シーン機能の初回適用を行います。

ドキュメント全体に対し、DATA属性に基づいて、コントローラーのバインドとシーンコンテナの生成を行います。
2回目以降の実行は無視されます。

Source: