Dimensions
Dimensions オブジェクトは、キャンバスアプリケーションが表示される iFrame のサイズに関するコンテキスト情報を含む、JSON 形式のオブジェクトです。
| 項目 | 説明 |
|---|---|
| clientHeight | clientHeight の値は、SignedRequest 内のキャンバスアプリケーションに送信され、最も外側の div 要素の高さを設定するために使用できます。この項目は、モバイルデバイスからアクセスするアプリケーションの高さを設定するのに便利です。この項目は、sr.context.environment.dimensions.clientHeight として参照できます。sr は、解析された署名付き要求の JavaScript オブジェクトです。 |
| clientWidth | clientWidth の値は、SignedRequest 内のキャンバスアプリケーションに送信され、最も外側の div 要素の幅を設定するために使用できます。この項目は、モバイルデバイスからアクセスするアプリケーションの幅を設定するのに便利です。この項目は、sr.context.environment.dimensions.clientWidth として参照できます。sr は、解析された署名付き要求の JavaScript オブジェクトです。 |
| height | iFrame の高さ (ピクセル単位)。 |
| width | iFrame の幅 (ピクセル単位)。 |
| maxHeight | iFrame の高さの最大値 (ピクセル単位)。デフォルト値は 2,000 です。「infinite」(無限) も有効な値です。 |
| maxWidth | iFrame の幅の最大値 (ピクセル単位)。デフォルト値は 1,000 です。「infinite」(無限) も有効な値です。 |
次のコードスニペットに、Dimensions オブジェクトの例を示します。