Viewer API

Viewer API は、ビューアとの対話に使用する一連の JavaScript 関数です。ビューアのほとんどのフレームには、他の場所から呼び出し可能な JavaScript 関数が埋め込まれています。使用可能な関数の詳細は、オンラインの 『Viewer API リファレンス』を参照してください。

Viewer API 関数を実行するには、ページに埋め込まれた JavaScript から API 関数を呼び出します。呼び出しには、一般的な方法が 3 つあります。

• Web レイアウト内に[スクリプトを起動]コマンドを定義する。この方法は、ツール バー、タスク リスト、または右クリック メニューから直接 Viewer API を呼び出す場合に使用します。
• 非表示のスクリプト フレームにページをロードし、ページのロード時にスクリプトを実行する。この方法は、Infrastructure Map Server ページでの操作の結果に応じて、ページを再ロードすることなくビューアを変更する場合に使用します。
• タスク ペイン フレーム内にロードされたページから JavaScript コールを実行する。JavaScript は、最初にページをロードしたとき、またはユーザとの対話の結果として実行できます。

フレーム間の関係を理解することが重要です。JavaScript は単一のフレームのコンテキストで実行されますが、フレーム階層に他のフレームを配置することで、それらのフレームから関数を呼び出すこともできます。次のフレームは、ビューアのメイン フレームの子です。

• tbFrame
• mapFrame
• formFrame
• scriptFrame
• taskFrame

taskPaneFrame は taskFrame の子フレームです。

カスタム JavaScript コードはメイン フレーム、スクリプト フレーム、またはタスク ペイン フレームのコンテキストで実行できます。

[スクリプトを起動]コマンドとして定義された JavaScript はメイン フレームのコンテキストで実行されます。他のフレームに存在する関数を実行するには、フレーム名および関数名で関数を識別します。たとえば、次の例では、メイン フレームから mapFrame の ZoomToView() 関数を呼び出します。

mapFrame.ZoomToView(xLoc, yLoc, newScale, true);

scriptFrame にロードされた JavaScript は、parent を使用して 1 つ上の階層に移動する必要があります。次に例を示します。

parent.mapFrame.ZoomToView(xLoc, yLoc, newScale, true);

taskPaneFrame にロードされた JavaScript は、parent.parent を使用して 2 つ上の階層に移動する必要があります。次に例を示します。

parent.parent.mapFrame.ZoomToView(xLoc, yLoc, newScale, true);

ほとんどの Viewer API は、 サイト サーバへのリクエストを生成し、ビューアのデータを再表示するか、ビューアの状態の変更をサイト サーバに通知します。これらのリクエストは自動的に生成されます。