変数

変数は、モジュール作成者が Workshop モジュール内でのデータの流れを設定するために使用します。利用可能な変数タイプの一覧は以下に記載されています。

Workshop モジュール内の既存の変数にアクセスしたり、新しい変数を定義したりするには、左サイドバーにある変数メニューを開きます。

変数パネル（上図）には、モジュール内に現在存在する変数の一覧、新しい変数を追加するためのプラス + オプション、名前または一意の ID で変数を検索するための入力欄、変数リネージグラフを開くためのオプション、定義タイプや有効になっている設定に基づいて変数を表示するためのフィルターが表示されます。変数の一覧には、関連する変数をすばやく見つけられるように区分が設けられています。ウィジェットを選択している場合は、そのウィジェットで使用されている変数が区分内に表示されます。ウィジェットを選択していない場合は、アクティブなページで使用されている変数が区分内に表示されます。

左側の一覧から変数を選択すると、変数一覧の右側に開くウィンドウで、その変数の設定を表示および変更できます。次の設定オプションを利用できます。

• 変数名： 変数名または鉛筆アイコンを選択して、名前を編集します。モジュールの内容を明確にし、後で変数を見つけやすくするために、分かりやすい名前を使用します。名前はモジュール内で一意である必要があります。既存の変数と名前が重複する場合、Workshop は数値の接尾辞を追加します。照合では大文字と小文字が区別されないため、MyVar と myvar は重複と見なされます。名前をクリアすると、Workshop は以前の値を復元します。変数パネルはフォルダーに対応していないため、変数をアルファベット順でグループ化するには、名前の接頭辞として $page_ や $tab_ などのコンテキストを示す識別子を付け、その後にページ名またはタブ名を続けます。たとえば、$page_Dashboard_filterState や $tab_Overview_selectedObject を使用します。

• 変数の定義タイプ： 変数名の横には、変数の定義方法とデータの設定方法を選択するドロップダウンメニューがあります。利用可能な選択肢は、選択した変数タイプによって異なり、次のようなものが含まれます。

  • 静的： 手動で設定する変数値に使用します。
  • 関数： 関数ベースで動的に計算される変数に使用します。
  • オブジェクトセットの集計： オブジェクトセットの集計から導出される変数に使用します。
  • オブジェクトプロパティ： 単一のオブジェクトの選択したプロパティ値に紐づく変数に使用します。
    • 注：複雑でパフォーマンスの低いオブジェクトプロパティは、Workshop の変数としては利用できません。
  • オブジェクトセット定義： 選択したオブジェクトタイプ、フィルター、リンクされたオブジェクトの走査によって定義されるオブジェクトセット変数専用です。
  • 変数の変換： 一般的な操作を順に適用して変数値を定義するために使用します。他の変数を参照することもできます。詳細については、変数の変換のドキュメントを参照してください。
  • SQLクエリ： モジュール内のオブジェクトセットや他の変数に対してオントロジー SQL クエリを実行して計算される変数に使用します。詳細については、SQL クエリ変数のドキュメントを参照してください。

• 変数を削除（ゴミ箱アイコン）： モジュール内で（ウィジェットや下流の変数から）使用されていない変数は削除できます。

• 現在の変数を基に新規変数を作成（オブジェクトセット変数のみ）： 変数の複製ボタンの横にある現在の変数を基に新規変数を作成ボタンを使用すると、現在のオブジェクトセットを自動的に入力とする新しいオブジェクトセット変数を作成できます。これは、ソース変数への参照を維持しながら、既存のオブジェクトセットの設定を基に新しい設定を作成したい場合に便利です。

• 変数の定義の設定： 変数の詳細を設定する、画面のメイン部分です。ここに表示されるオプションは、選択した変数タイプおよび変数の定義タイプによって変わり、画面上に説明が表示されます。

• 変数の設定： 変数の設定パネルでは、外部 ID と、その変数に対して有効にする以下の機能を設定できます。

  • モジュールインターフェース
  • ルーティング
  • 状態の保存

以下のスクリーンショットは、オブジェクトセット変数の設定例を示しています。

以下のスクリーンショットは、文字列配列変数の設定例を示しています。

変数の遅延読み込み

表示モードおよび編集モードでは、Workshop は、表示されているウィジェット、レイアウト、または必要とされる別の変数で値が必要になるまで、変数の計算を遅延できます。これは埋め込みモジュール内の変数にも適用されます。たとえば、非表示のタブでのみ使用される変数の計算は、そのタブが表示されるまで待機できます。ただし、レイアウトの表示設定の制御など、一部の用途では、セクションが非表示の間も計算が行われることがあります。詳細については、読み込みとデータの更新を参照してください。

変数の読み込みインジケーター

Workshop は、変数を評価している間、読み込みインジケーターを表示します。

変数タイプ

Workshop は、次の変数タイプに対応しています。

• 配列： ブール値、日付、数値、Geopoint、Geoshape、文字列、タイムスタンプ、または構造体の値の配列を受け入れます。
• ブール値：true または false の値を受け入れます。静的な値、または関数、集計、オブジェクトプロパティの出力から初期化されます。
• 日付： 日付を受け入れます。静的な値、または関数、集計、オブジェクトプロパティの出力から初期化されます。
• Geopoint： Geopoint を受け入れます。オブジェクトプロパティから初期化されます。
• Geoshape： Geoshape を受け入れます。オブジェクトプロパティまたは関数の出力から初期化されます。
• 数値： 整数と浮動小数点数の両方を含む数値を受け入れます。静的な値、または関数、集計、オブジェクトプロパティの出力から初期化されます。
• オブジェクトセット： 1個以上のオブジェクトの集合を格納します。オブジェクトタイプ、オントロジーインターフェース、または別のオブジェクトセット変数から初期化します。その後、プロパティ値やフィルター変数で絞り込んだり、関連検索を通じてリンクされたオブジェクトにピボットしたりできます。また、共通プロパティタイプやオブジェクトベースのリンクタイプを通じて、他のオブジェクトタイプにピボットすることもできます。
• オブジェクトセットフィルター： オブジェクトセット変数を絞り込むために使用する、プロパティタイプとプロパティ値のペアの集合を格納します。オブジェクトタイプと、プロパティタイプとプロパティ値からなるフィルターのペアの集合から初期化されます。詳細については、オブジェクトセットフィルター変数を参照してください。
• 文字列： テキストを受け入れます。静的な値、または関数、集計、オブジェクトプロパティの出力から初期化されます。
• 構造体： 文字列のフィールドIDを値に対応付ける複合データ型を格納します。現在、入れ子の構造体には対応していませんが、構造体フィールドの値には、それ以外のすべての Workshop 変数タイプを使用できます。関数の出力から初期化されます。詳細については、構造体変数を参照してください。
• タイムスタンプ： タイムスタンプを受け入れます。静的な値、または関数、集計、オブジェクトプロパティの出力から初期化されます。
• 時系列セット： 単一のオブジェクトの時系列プロパティを格納し、必要に応じて時系列変換を適用できます。詳細については、Workshop の時系列プロパティを参照してください。

変数値の再計算

サポートされている変数定義では、変数値の再計算によって、Workshop が値を自動的に再計算するか、イベントでトリガーされた場合にのみ再計算するか、モジュールの読み込み時およびイベントでトリガーされた場合に再計算するかを制御します。利用可能なオプション、サポートされている定義、制限については、変数の再計算の動作を参照してください。

変数のリネージグラフ

変数のリネージグラフを開くには、変数パネルのヘッダーにあるネットワークハブアイコンを選択します。グラフには、モジュール内の変数とウィジェットが互いにどのように依存しているかが表示されます。このグラフを使って、再計算の動作をデバッグしたり、変数を読み書きするウィジェットを追跡したり、アプリケーション要素間の関係を把握したりできます。

特定の変数を探索するには、変数パネルでその変数を選択し、詳細パネルの変数の使用状況にあるデータフローを見るを選択します。Workshop はグラフを開き、その変数と、直接の上流の依存関係および下流でその変数を使用する要素を追加します。既存のグラフノードはそのまま保持されます。グラフが開いている間にリストから別の変数を選択すると、その変数だけが追加されます。グラフを閉じて再度開いても、ノードは保持されます。

グラフを展開する

グラフ上の各ノードは、変数またはウィジェットを表します。依存関係があるノードには、上端と下端に山形の矢印があります。矢印を選択すると、ノードの親（上流の依存関係）または子（下流で使用する要素）が展開され、モジュール内の一連の関係を追跡できます。グラフのヘッダーにあるすべて表示操作を使うと、アプリケーション全体のグラフに展開できます。クリアを使うと、すべてのノードが削除され、詳細パネルが閉じます。

グラフのヘッダーにある元に戻すオプションとやり直しオプションでは、モジュール自体の元に戻す／やり直しコントロールと同様に、展開、折りたたみ、選択の操作履歴を前後に移動できます。

各ノードには、変数が使用されているページとオーバーレイ、および変数が計算された時刻を表示できます。

ページとオーバーレイ

ノードには、そのノードが参照されているページとオーバーレイを示すタグが付いています。ヘッダーのページとオーバーレイを表示を切り替えると、使用されている各ページとオーバーレイを一覧表示する凡例が表示されます。凡例には、表示されているグラフノードに含まれるページとオーバーレイのみが表示されるため、リストの範囲はグラフで確認できる内容に限定されます。

計算時刻

ヘッダーの計算時刻を表示を切り替えると、変数ごとの時刻情報が表示されます。計算時刻は、アプリケーション内で変数の値が最後に計算された時刻（ユーザーに表示される時刻）を指し、基となるデータがアプリケーションの外部で最終更新された時刻ではありません。再計算に時間がかかる変数は、構造の見直しの候補となる場合があります。たとえば、複雑な関数ベースの変数を小さな部分に分割したり、上流の変数の再計算の動作を変更して不要な処理を避けたりできます。