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

ウィジェット

ウィジェットは Workshop ユーザーにコンテンツを表示し、モジュールのユーザーインターフェースの中核となる構成要素です。よく使われるウィジェットには、フィルターリスト、オブジェクトテーブル、ボタングループがあります。モジュール作成者は、モジュールのレイアウトにウィジェットを配置し、ユースケースに必要な入力変数と出力変数、表示オプション、アクションを設定して、Workshop でアプリケーションを構築します。

モジュールにウィジェットを追加するには、空のセクションにカーソルを合わせて + ウィジェットを追加ボタンを表示し、選択します。セクションまたはモジュールのヘッダーにある + ボタンを選択することもできます。次に、開いたウィジェットセレクターのモーダルで、目的のウィジェットを選択します。

ウィジェットセレクターのモーダルのスクリーンショット

ウィジェットの設定

Workshop モジュールにウィジェットを追加したら、ウィジェットを選択すると、画面の右側に設定オプションが表示されます。以下の例では、フィルターリストウィジェットの設定方法を示しながら、Workshop ウィジェットに共通する基本概念を説明します。

ウィジェットの設定

ウィジェットの主要な設定オプションは、ウィジェットの設定タブにあります。ここでモジュール作成者は、ウィジェットの入力変数と出力変数(つまり、ウィジェットに最初に入力されるデータと、該当する場合は、ウィジェットによって生成されて出力されるデータ)に加えて、その他の設定オプションや表示オプションを設定します。

以下のスクリーンショットは、新しく追加され、まだ設定されていないフィルターリストウィジェットの初期状態を示しています。

フィルターリストウィジェットの空の設定のスクリーンショット

上に示したフィルターリストウィジェットの例では、主要な設定オプションは次のとおりです。

  • オブジェクトセット: フィルターリストウィジェットの入力変数であり、利用可能なフィルターの選択肢を決定します。この設定には、この Workshop モジュールの別の場所で定義された既存のオブジェクトセット変数、または新しく作成するオブジェクトセット変数を指定できます。
  • フィルターリスト: ウィジェットに表示されるフィルターの選択肢を決定します。この設定オプションは、オブジェクトセットが設定されると、より詳細に表示されます。初期オブジェクトセット内のプロパティタイプが表示され、すべてのプロパティを対象としたキーワード検索や、リンクされたオブジェクトの有無による絞り込みができるようになります。
  • ユーザーによるフィルターの追加と削除を許可: このオプションを有効にすると、モジュールユーザーが表示されるフィルターを追加したり削除したりできるユーザーインターフェースがウィジェットに追加されます。
  • アウトプットのフィルター変数: ウィジェットの出力となるオブジェクトセットフィルター変数です。このフィルターを別のオブジェクトセット変数に適用して、指定した変数内のオブジェクトを絞り込めます。デフォルトでは、モジュールにフィルターリストウィジェットを追加すると、出力変数が作成されます。

以下のスクリーンショットは、設定後のフィルターリストのウィジェットの設定タブの例を示しています。

フィルターリストウィジェットの設定完了後のスクリーンショット

メタデータ

メタデータタブでは、ウィジェットの名前を変更したり、ウィジェットの生の JSON 設定にアクセスしたりできます。

ウィジェット名オプションを編集すると、Workshop 全体で現在のウィジェットがどのような名前で参照されるかに影響します。特に、レイアウトパネルのコンポーネント名や、デフォルトの変数名に反映されます。

ウィジェットの生の設定には、現在のウィジェットの設定が JSON でどのように保存されているかが表示されます。上級のモジュール作成者は、この設定を生の形式ですばやく表示、編集、コピーできます。

表示

表示タブでは、現在のウィジェットのサイズを設定でき、モジュール作成者はサイズ指定を「自動 (最大)」、「絶対」、「Flex」の間で切り替えられます。

  • 自動 (最大): 最大の高さを設定しつつ、ウィジェットの内容に基づいて高さを自動的に調整します。このオプションは、列レイアウト内のウィジェットの幅の設定には利用できません。
  • 絶対: ウィジェットの固定サイズをピクセル単位で指定します。
  • Flex: 現在のモジュール内のほかのウィジェットに対する、このウィジェットの高さまたは幅の比率を指定します。これにより、画面サイズや解像度が変わったときに、ウィジェットのサイズが適切に調整されます。

表示タブには、ユーザーがモジュール内を移動するときに、ウィジェットがいつマウントおよびアンマウントされるかを制御する表示の最適化設定もあります。これらの設定は、ローカルの状態を保持するカスタムウィジェット、初回読み込みの負荷が高いウィジェット、またはユーザーが頻繁に戻ってくるウィジェットに役立ちます。詳細は、ウィジェットの表示の最適化を参照してください。

ウィジェットを再利用する

ウィジェットを設定した後は、コピーしてモジュール内の任意の場所で再利用できます。この機能は、複雑なウィジェット設定を再現する際に特に便利です。ただし、ウィジェットの設定が時間の経過とともに頻繁に変更される可能性がある場合は、埋め込み Workshop モジュールウィジェットの方が適している場合があります。ウィジェットをコピーして再利用するには、ウィジェットを選択し、Cmd+C(macOS)または Ctrl+C(Windows)を使用します。Cmd+V(macOS)または Ctrl+V(Windows)を使用すると、左側のパネルのレイアウトセクションの下部にある未使用のウィジェット領域にウィジェットを貼り付けられます。モジュールにウィジェットを追加するには、+ ウィジェットを追加を選択し、ウィジェットセレクターのモーダルの未使用のウィジェットタブでそのウィジェットを探します。

ウィジェットセレクターのモーダルで、貼り付けた未使用のウィジェットを探します。

また、セクションの複製に使うコントロールを使用して、ウィジェットをコピー、切り取り、貼り付けることもできます。

入力変数と出力変数

入力変数と出力変数は、Workshop モジュール内のデータの流れを制御します。

入力変数は、特定のウィジェットに渡されるデータを定義します。通常、そのデータはウィジェット内に表示されます。入力変数の例として、オブジェクトテーブル、フィルターリスト、チャート、マップの各ウィジェットに渡されるオブジェクトセット入力があります。

出力変数は、特定のウィジェットから渡され、その後、下流のウィジェットや別の変数で使用されるデータを定義します。出力変数の例には、オブジェクトテーブルウィジェットが生成する「選択されたオブジェクト」のオブジェクトセット出力や、文字列ドロップダウンウィジェットが生成する「選択された値」の文字列出力があります。

上記のウィジェット設定の例には、オブジェクトテーブルウィジェットの入力変数(オブジェクトセット)と出力変数(アクティブなオブジェクトと選択されたオブジェクト)の設定方法に関する詳細が含まれています。変数全般の詳細は、変数のドキュメントを参照してください。

ウィジェットの種類

ウィジェットは、情報の可視化から、Workshop モジュール内でのイベントやデータのライトバックのトリガーまで、さまざまな用途に使えます。以下のカテゴリーは、Workshop のウィジェットの機能を大まかに分類したものです。