ルーティング

Workshop のルーティングでは、モジュールの特定の状態やビューを URL に書き込むことができ、ユーザーはリンクを共有することで、これらのビューをほかのユーザーと簡単に共有できます。

ルーティングを有効にする

Workshop モジュールのルーティングを有効にするには、左側の設定パネルのページセクションに移動し、ルーティングを有効化オプションをオンにします。

ページセクションには、ルーティングで使用するページの概要が表示されます。また、以下のように、使用中の変数を表示する追加パネルもあります。

ページのルーティング

ルーティングを有効にすると、現在のページの ID が URL に書き込まれます。ページIDが定義されていないページでは、ページIDは URL に書き込まれません。ページを読み込むと、ユーザーはモジュールのデフォルトページに戻ります。

変数のルーティング

ルーティングを使用して、モジュールインターフェースで使用するように設定された変数の値を保存し、共有することもできます。ルーティングを有効にすると、ルーティングの URL 更新動作が設定された変数の現在の値が、URL のクエリパラメーターとして直接書き込まれます。

モジュールインターフェースの変数を URL に含めるには、以下の設定オプションのいずれかを使用します。

• 表示中のウィジェットまたはレイアウトで使用されている場合にURLに含める： 以下の条件を満たす場合にのみ、変数の値が URL に含まれます。
  • 値が変数のデフォルト値ではない
  • 現在のビューに表示されるウィジェットまたはレイアウトで変数が使用されている
• 常に URL に含める： 値が変数のデフォルト値でない場合、変数の値が常に URL に含まれます。
• URL に含めない： ルーティングのトグルが無効になっている場合、変数の値が URL に含まれることはありません。

クエリパラメーターのキーがモジュールインターフェース変数の外部IDと一致する場合、設定された URL への包含動作に関係なく、クエリパラメーターの値が変数の初期値として使用されます。

制限事項

URL でサポートされていない変数タイプ

以下の変数タイプは URL で使用できません。

• オブジェクトセットフィルター変数
• オブジェクトセット変数は、RID で指定された単一のオブジェクトに限定されます

ただし、ほかのルーティング変数を使用して、上記の変数タイプを間接的に定義できます。たとえば、ルーティングで使用する文字列変数を作成し、この文字列変数を使用してオブジェクトセットフィルター変数のデフォルト値を定義できます。

埋め込みモジュールからのルーティング設定の継承なし

Workshop モジュールを埋め込んでも、埋め込みモジュールのルーティング設定は引き継がれません。埋め込みモジュールの変数の値をルーティングで使用するには、必要な変数を子モジュールのモジュールインターフェースに追加し、埋め込みモジュールの設定で親モジュールのルーティング変数を渡します。