EQL問合せでのトークンの使用

カスタム視覚化コンポーネントのEQL問合せでは、EQL問合せでのトークンの置換がサポートされています。トークンは単にEQL問合せ内の変数で、コンポーネントの「ビジュアライゼーション設定」パネルのユーザー・インタフェース・コントロールに対応します。コントロールには、属性(メトリックまたはディメンション)、ビュー、データ・ビューおよびソートが含まれます。たとえば、EQL問合せのソート・トークンにより、プロジェクト・ユーザーが選択するためのコンポーネント構成にASCまたはDSCソート・コントロールが作成されます。ディメンション・トークンにより、プロジェクト・ユーザーが選択する属性のドロップダウン・メニューが作成されます。

EQL問合せでは、トークンは%metric_1%などのパーセント記号(%)で囲まれた文字列です。次に、5つのトークン(%metric_1%、%groupby_1%、%dataview%、%sort%、%num_recs%)を含むEQL文の例を示します:

RETURN data AS SELECT
%metric_1% AS metric,
%groupby_1% AS groupby
FROM "%dataview%"
GROUP BY groupby
ORDER BY metric %sort%
PAGE(0,%num_recs%);

Studioでは、コンポーネントの「ビジュアライゼーション設定」パネルのユーザー構成に基づいて、トークンが値に置換されます。この値は、Studioが問合せを実行してコンポーネントの結果を生成する際に使用されます。

トークン・タイプ

トークンは、トークンが表すデータのタイプおよびコンポーネントがトークン値を取得する方法によって識別されます。次の表に、各トークン・タイプを示し、EQL問合せを実行する前にStudioがトークンを値に置換する方法について説明します。

トークン・タイプ	値	置換値の例
属性(メトリックまたはディメンション・サブタイプ)	属性トークンは、メトリックまたはディメンションのいずれかを表します。「メトリック」トークンは、メトリックおよび集計関数のメニューを表します。コンポーネントの構成中、メトリック・トークンのデータ型を選択して、プロジェクト・ユーザーが選択できる属性を特定します。同様に、コンポーネントの構成中に、集計関数(SUMなど)を選択して、プロジェクト・ユーザーが選択できる属性を判別することもできます。メトリック・トークンは、プロジェクト・ユーザーがコンポーネントの「ビジュアライゼーション設定」パネルから属性および集計関数を選択したときに置換されます。「ディメンション」トークンは、プロジェクト・ユーザーが選択する属性のドロップダウン・メニューを表します。コンポーネントの構成時に、ディメンション・トークンのデータ型を選択して、プロジェクト・ユーザーが選択できる属性を決定します。たとえば、文字列のデータ型を選択した場合は、文字列属性のみを選択できます。ユーザーがコンポーネントの「ビジュアライゼーション設定」パネルから属性を選択すると、ディメンション・トークンが置換されます。メトリック・トークンとディメンション・トークンのどちらのタイプも、属性をユーザー・インタフェース・メニューに移入するために取得されるデータ・ビューを指定するビュー・トークンに関連付けられています。属性トークン値は、JavaScript APIを使用して設定することもできます。	SUM(p_price)
View	ビュー・トークンは、プロジェクト・ユーザーが選択するデータ・ビューのドロップダウン・メニューを表します。コンポーネントの「ビジュアライゼーション設定」パネルからデータ・ビューを選択すると、トークンが置き換えられます。ビュー・トークン値は、JavaScript APIを使用して設定することもできます。	p_price
ソート	ソート・トークンは、プロジェクト・ユーザーが選択するためのコンポーネント構成におけるASCまたはDESCソート制御を表します。ユーザーがコンポーネントの「ビジュアライゼーション設定」パネルからソート方向(ASCまたはDESC)を選択すると、トークンが置換されます。 ASCがデフォルト値です。ソート・トークン値は、JavaScript APIを使用して設定することもできます。	ASC
データ	データ・トークン値は、JavaScript APIを使用して設定する必要があります。

トークンの詳細は、「カスタム視覚化コンポーネントJavaScript APIリファレンス」を参照してください。

トークンの代替例

トークンを使用するEQL問合せの例は次のとおりです:

RETURN data AS SELECT
%metric_1% AS metric,
%groupby_1% AS groupby
FROM "%dataview%"
GROUP BY groupby
ORDER BY metric %sort%
PAGE(0,%num_recs%);

次に、トークンに置換される値を使用した同じEQL問合せを示します:

RETURN data AS SELECT
SUM(p_price) AS metric,
p_color AS groupby
FROM "wine_dataset"
GROUP BY groupby
ORDER BY metric ASC
PAGE(0,20);