gadgets.views


メソッド

gadgets.views.bind

URL テンプレートに、渡された環境内の変数をバインドして、URL 文字列を作成します。

パラメータ

名前

説明

urlTemplate

String

コンテナビューの URL テンプレート。

environment

Array

文字列型の指定された変数のセット。 (例: [OWNER | PATH | PARAMS | NAME])

返り値

説明

String

URL文字列

gadgets.views.getCurrentView

現在のビューを返します。

パラメータ

なし

返り値

説明

gadgets.views.View

現在のビュー

サンプル

gadgets.views.getParams

このビューでこのガジェットに渡されるパラメータを返します。

パラメータ

なし

返り値

説明

Map.<String, String>

パラメータマップ

gadgets.views.getSupportedViews

サポートされているすべてのビューのマップを返します。各 gadgets.view.View の名前をキーとして利用します。

パラメータ

なし

返り値

説明

Map<gadgets.views.ViewType, String, gadgets.views.View>

name 属性をキーとして利用した、サポートされているすべてのビュー。

gadgets.views.requestNavigateTo

パラメータ

名前

説明

view

String | gadgets.views.View

遷移先のビューを表す文字列あるいはgadgets.views.Viewオブジェクト。

opt_params

Object

遷移後のアプリケーションに渡されるパラメータ。

opt_ownerId

String

現在はサポートされていません。

現在のビューから別のビューにユーザの画面を遷移させるために使われます。現在は、canvasビューへの遷移のみがサポートされています。opt_paramsで渡されたパラメータは、遷移後のアプリケーション内でgadgets.views.getParams()を用いることで取得できます。

サンプル

gadgets.views.View.bind

ビューの URL テンプレートに、渡された環境内の変数をバインドして、URL 文字列を作成します。

パラメータ

名前

説明

environment

Array

文字列型の指定された変数のセット。 (例: [OWNER | PATH | PARAMS | NAME])

返り値

説明

String

URL文字列

gadgets.views.View.getName

このビューの名前を返します。

パラメータ

なし

返り値

説明

String

ビュー名。

サンプル

gadgets.views.View.getUrlTemplate

サポートされていません。

gadgets.views.View.isOnlyVisibleGadget

指定したガジェットが、このビューに表示される唯一のガジェットである場合は true を返します。キャンバス ページや最大化モードでは、ほとんどの場合 true になりますが、プロフィール ページやダッシュボード モードではほとんどの場合 false になります。

パラメータ

なし

返り値

説明

boolean

指定したガジェットがこのビューに表示される唯一のガジェットである場合は true、それ以外の場合は false。

サンプル

gadgets.views.ViewType

gadgets.views.ViewType.HOME

提供予定です。

gadgets.views.ViewType.PROFILE

提供予定です。

gadgets.views.ViewType.CANVAS

Canvas ビューです。

gadgets.views.ViewType.PREVIEW

サポートされていません。

更新履歴

  • 2013/03/15
    • ドキュメント移行

PREVIOUS

gadgets.util

NEXT

gadgets.window