注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

モジュールインターフェース

モジュールインターフェースは、埋め込み時に親モジュールの変数にマッピングでき、URL から初期化できる変数の集まりです。モジュールインターフェースは、Workshop モジュールの API と考えることができます。

モジュールインターフェース変数は、オブジェクトタイプ間の共通プロパティとリンクを定義するオントロジーインターフェースとは異なります。モジュールインターフェース変数は、埋め込みと URL による初期化に使用する Workshop モジュールの入力と出力を定義します。

モジュールインターフェースに変数を追加するには、変数の設定パネルに移動し、外部IDを追加して、モジュールインターフェースのトグルが有効になっていることを確認してください。必要に応じて、モジュールインターフェース変数に表示名と説明を設定できます。これらは、モジュールが埋め込まれたとき、または Workshop モジュールを開くイベントで使用されたときに表示されます。

モジュールインターフェースの設定

埋め込みモジュールのインターフェース

モジュールを埋め込むと、そのモジュールのモジュールインターフェース変数が利用可能になり、親モジュールの変数を子モジュールのインターフェース変数にマッピングできます。親モジュールと埋め込まれた子モジュールの間でインターフェース変数をマッピングすると、Workshop は親モジュールの変数定義を使用し、埋め込みモジュール自体のインターフェース変数定義を無視します。詳細は、埋め込みモジュールのドキュメントのインターフェースの設定を参照してください。

モジュールインターフェース変数を使用して、親モジュールと子モジュールの間、または兄弟関係にある埋め込みモジュールの間で情報をやり取りします。これらの共有インターフェース変数によって、選択されたオブジェクト、選択されたタブ、オーバーレイの表示の有無などの共有状態を管理できます。変数によるレイアウト状態の制御について詳しくは、変数に基づくレイアウトを参照してください。埋め込みモジュールはイベントを通じてインターフェース変数の値を変更できるため、これらの変数を参照するほかの箇所も更新された値に応じて動作できます。詳しくは、埋め込みモジュール間で情報をやり取りするを参照してください。

Workshop モジュールを開くイベント

Workshop モジュールを開くイベントを使用すると、以下で説明する URL の手動作成が不要になります。選択したモジュールのインターフェースが表示され、現在のモジュールから選択したモジュールのインターフェース変数に変数の値を渡せます。イベントが呼び出されると、URL は現在の値を使用して選択したモジュールを開きます。

編集モードでモジュールへの参照からモジュールを開くと（たとえば、埋め込まれた子モジュールを専用のエディターで開く場合）、参照元のモジュールから渡されたモジュールインターフェース変数の現在の値を使用してモジュールが開きます。これにより、参照元と同じ状態を使用して、開いたモジュールをデバッグできます。

モジュールインターフェース変数を使用して URL を作成する

Workshop モジュールを開くイベントを使用せずに、URL を手動で動的に生成することもできます。モジュールインターフェース変数の値を URL クエリパラメーターに設定すると、アプリケーションの状態へのカスタムリンクを共有できます。そのためには、以下の手順に沿って進めます。

Workshop アプリにログインします。
ブラウザーから URL をコピーします。編集モードではなく閲覧モードになっていることを確認してください。この URL は固定されているため、適切な権限を持つほかのユーザーと共有できます。
次に、編集モードに戻ります。
左サイドバーにある変数メニューを選択します。
新規変数 > 文字列 > 静的を作成します。
変数の設定タブに移動し、外部IDを追加します。
ステップ2の URL の末尾に ? を追加し、その後に外部ID、=、設定する値を続けます。たとえば、?interfaceVariable=123 です。アンパサンド & に続けて別の外部ID、等号 =、値を追加すると、ほかのモジュールインターフェース変数も追加できます。

モジュールインターフェース変数は、モジュールの初回読み込み時に URL パラメーターから初期化されます。モジュールの読み込み後に URL を変更しても、変数の値は動的に更新されません。実行時に変数の値を更新するには、変数の値を設定イベントやモジュール読み込み時イベントなどの Workshop イベントを使用します。

これでリンクを使用できるようになり、モジュールインターフェース変数には URL に設定された値が設定されます。このリンクは、変数変換を使用して動的に生成できます。その際の値は、アクションフォーム、関数、またはほかの変数変換から取得できます。

テスト目的で URL 内の /latest/ を /dev/ に変更すると、リンクは Workshop アプリケーションの最後に公開されたバージョンではなく、最後に保存されたバージョンにリダイレクトされるようになります。

Carbon ナビゲーション

Carbon ナビゲーションでのモジュールインターフェース変数の使用については、こちらを参照してください。Carbon がサポートする変数のデータ型にはいくつかの制限があり、Carbon のモジュールタブのパラメーターを設定する際は、外部IDに variable. というプレフィックスを付ける必要があることに注意してください。

Carbon は Workshop のモジュールタブ間を移動する際にオブジェクトセットフィルター変数をサポートしているため、タブ間でフィルターの値を渡せます。