ドキュメントの検索
karat

+

K

APIリファレンス ↗

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

ウィジェット

ウィジェットは、Workshopモジュールのユーザーインターフェースの基本的な構成要素です。一般的に使用されるウィジェットには、Filter List、Object Table、Button Group ウィジェットなどがあります。モジュールビルダーは、ウィジェットをインターフェースに配置し、必要な入力、出力、表示オプション、アクションをウィジェットで設定することにより、Workshopでアプリケーションを構築します。

利用可能なウィジェットにアクセスするには、モジュールの任意の空欄部分で Set section contents ボタンを選択し、利用可能な New widget オプションから選択します。

new_widget_2

ウィジェットの設定

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

ウィジェットの設定

ウィジェットの主要な設定オプションは、Widget setup タブ内にあります。ここでは、モジュールビルダーがウィジェットの入力変数と出力変数(例:初期にウィジェットに表示するデータと、適用するとウィジェットから生成され出力されるデータ)を設定し、その他の設定と表示オプションを指定します。

以下は、新しく追加されたまだ設定されていないObject Tableウィジェットの初期状態のスクリーンショットです:

object_table_widget

上記のまだ設定されていないObject Tableウィジェットの例では、主要な設定オプションは次のとおりです:

  • Object set: これはObject Tableウィジェットへの入力変数で、Object Table内に表示されるデータを決定します。これは、このWorkshopモジュールの他の部分で定義された既存のオブジェクトセット変数、またはオントロジーからのオブジェクトタイプを受け入れます。
  • 行: これは、Object Table内に表示される行を決定します。この設定オプションは、初期のオブジェクトセットが初期化された後に詳細に表示され、初期のオブジェクトセット内で見られるプロパティタイプを表示します。
  • Number of frozen columns / Number of lines to display per row / Default sort / Combine multiple object types: これらの設定オプションはすべて、Object Table内のデータの表示に影響を与え、特定のワークフローに最適にカスタマイズすることができます。
  • Active object: これはObject Tableの2つの出力変数の1つで、現在のWorkshopモジュールの他のウィジェットで使用するために、テーブル内の現在アクティブ/ハイライトされたオブジェクトを出力します。
  • Enable multi-select: これを true に切り替えると、Object Tableで一度に複数のオブジェクトを選択することができます。これらの複数のオブジェクト選択は、出力されて別のウィジェットに変数として渡されることができます(例えば、Button Groupウィジェットを介して一括でアクションを行うためなど)。
  • Selected objects: これはObject Tableの2つの出力変数の2つ目で、現在のWorkshopモジュールの他のウィジェットで使用するために、テーブル内で現在選択されているオブジェクトを出力します。
  • On active object selection: このオプションを使用すると、モジュールビルダーは、テーブル内で行が選択されたときにトリガーされるWorkshopイベントを設定することができます(例えば、より詳細なオブジェクトビューを持つドロワーを表示させるためなど)。

以下のスクリーンショットは、設定が完了したObject Tableの Widget setup タブの例を示しています:

object_table_widget_2

メタデータ

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

Widget Name オプションを編集すると、現在のウィジェットがWorkshop内で参照される方法に影響を与えます。これは、Pages & Layers パネル内のLayer、およびデフォルトの変数名内で特に顕著です。

Raw Widget Configuration は、現在のウィジェットの設定がJSONで保存されている方法を表示し、高度なモジュールビルダーに、この設定を生の形式で素早く表示、編集、またはコピーするオプションを提供します。

object_table_widget_3

表示

Displayタブでは、現在のウィジェットのサイズの設定が可能で、モジュールビルダーはAuto、Absolute、Flexのサイジングを切り替えることができます。

  • Autoは、ウィジェットの内容に基づいてウィジェットの高さまたは幅を自動的にスケーリングします。
  • Absoluteは、モジュールビルダーがウィジェットの固定ピクセルサイズを指定することを可能にします。
  • Flexは、モジュールビルダーがこのウィジェットの高さまたは幅の比率を現在のモジュール内の他のウィジェットと比較して指定することを可能にし、スクリーンサイズや解像度が変わったときにウィジェットが適切にスケーリングすることができます。

結果のウィジェット

上記で説明した例の設定は、以下に示すようなObject Tableを生成します:

object_table_widget_4

ウィジェットの再利用

ウィジェットを設定した後、モジュールの任意の場所で再利用することができます。これは、複雑なウィジェット設定を再作成する場合に特に便利です。これを行うには、ウィジェットを選択し、Cmd+C(macOS)またはCtrl+C(Windows)を使用してウィジェットをコピーします。Cmd+V(macOS)またはCtrl+V(Windows)を使用してウィジェットを Unused widgets エリアに貼り付けます。このエリアは、左側のパネルの Layouts セクションの下部に位置しています。+ Add widget を選択してモジュールに追加し、Search widgets ポップアップの Unused widgets タブから探します。

Find the pasted, unused widget in the widget search pop-up window.

入力と出力

入力変数と出力変数は、Workshopモジュール内でデータがどのように移動するかを制御します。

入力変数は、特定のウィジェットに渡されるデータを定義します。これは通常、ウィジェット内に表示されるためのものです。入力変数の例としては、Object Table、Filter List、Charts、Mapウィジェットに渡されるオブジェクトセット入力があります。

出力変数は、特定のウィジェットから渡されるデータを定義します。これは通常、次の下流のウィジェットで消費されるためのものです。出力変数の例としては、Object Tableウィジェットが生成する"Selected Objects"オブジェクトセット出力や、String Dropdownウィジェットが生成する"Selected Value“文字列出力があります。

上記のウィジェット設定の例には、入力変数(オブジェクトセット)と出力変数(アクティブオブジェクトと選択オブジェクト)がObject Tableウィジェットでどのように設定可能であるかについての詳細が含まれています。変数についての詳細は、変数のドキュメンテーションを参照してください。

ウィジェットの種類

ウィジェットは、情報の視覚化から、Workshopモジュール内でイベントやデータの書き戻しがトリガーされるまで、様々な用途を提供します。以下のカテゴリーは、Workshopのウィジェットの機能を大まかに分けています: