Azure Data Explorer ダッシュボードでパラメーターを使用する
パラメーターは、Azure Data Explorer ダッシュボードのフィルターの構成要素として使用されます。 これらはダッシュボード スコープで管理されます。これらをクエリに追加して、基になるビジュアルによって表示されるデータをフィルター処理することができます。 クエリでは、1 つ以上のパラメーターを使用できます。
このドキュメントでは、ダッシュボードでのパラメーターとリンクされたフィルターの作成と使用について説明します。 パラメーターは、フィルター バーでパラメーター値 を選択するか 、クロスフィルターを使用して、ダッシュボードビジュアルをフィルター処理するために使用できます。
この記事で使用するクエリ例は、サンプル ギャラリーのStormEvents
テーブルに基づいています。
Note
パラメーター管理は、ダッシュボード エディター の編集 モードで使用できます。
前提条件
- Azure Data Explorer ダッシュボードを使用してデータを視覚化する
- Azure Data Explorer ダッシュボードに対するエディターのアクセス許可
- ビジュアルを含むダッシュボード
パラメーターの一覧を表示する
すべてのダッシュボード パラメーターの一覧を表示するには、ダッシュボードの上部にある [パラメーター] ボタンを選択します。
パラメーターを作成する
パラメーターを作成するには:
表示モードから編集モードに切り替えます。
ダッシュボードの上部にある [ パラメーター] ボタンを選択します。
右側のウィンドウの上部にある [ + 新しいパラメーター ] ボタンを選択します。
パラメーターに関連する プロパティ を入力します。
サポートされているプロパティ
[ パラメーターの追加 ] ペインで、次のプロパティを構成します。
フィールド | 説明 |
---|---|
Label | ダッシュボードまたは編集カードに表示されるパラメーターの名前。 |
パラメーターの種類 | 次のいずれかのパラメーター:
|
[変数名] | クエリで使用されるパラメーターの名前。 ヒント: 変数名の先頭にアンダースコア文字 (_) などの固有の文字を付けると、クエリの作成時に見つけやすくなります。 |
データの種類 | パラメーター値のデータ型。 |
[Show on pages](ページに表示) | このパラメーターが表示されるページを選択します。 [すべて選択] オプションを選択すると、すべてのページにこのパラメーターが表示されます。 |
ソース | パラメーター値のソース。
|
既定値 | フィルターの既定値。 フィルターは、ダッシュボードの初期レンダリング時に常に既定値で開始されます。 |
[Add a Select all value](「すべて選択」の値を追加) | 単一選択と複数選択のパラメーターの種類にのみ適用されます。 すべてのパラメーター値のデータを取得するために使用します。 この値は、その機能を提供するためにクエリに組み込む必要があります。 このようなクエリを作成するその他の例については、「 複数選択クエリ ベースのパラメーターを使用する」を参照してください。 |
パラメーターの管理
上部のバーから [パラメーター] を選択すると、 既存のパラメーターの一覧を表示できます。 各パラメーター カードで、鉛筆ウィジェットを選択してパラメーターを編集するか、[その他 ]...] メニューを選択してパラメーターを複製、削除、または移動します。
パラメーター カードでは、以下の表示を確認することができます。
- パラメーターの表示名
- 変数名
- パラメーターが使用されたクエリの数
- パラメーターがピン留めされているページ
パラメーター カードは、ドラッグ アンド ドロップするか、[ 移動 > 先] オプションを使用して新しい場所を選択して並べ替えることができます。
クエリでパラメーターを使用する
フィルターを対象のクエリ ビジュアルに適用できるようにするには、クエリでパラメーターを使用する必要があります。 定義が完了すると、[クエリ] ページのフィルターの上部バーとクエリの intellisense にパラメーターが表示されます。
注意
パラメーターがクエリで使用されていない場合、フィルターは非アクティブなままになります。 クエリにパラメーターを追加すると、フィルターがアクティブになります。
パラメーターの種類
次のように、いくつかのダッシュボード パラメーターの種類がサポートされています。
- 既定の時間範囲パラメーター
- 単一選択の固定値パラメーター
- 複数選択の固定値パラメーター
- 単一選択クエリ ベースのパラメーター
- 複数選択クエリ ベースのパラメーター
- フリー テキスト パラメーター
- データ ソース パラメーター
次の例では、さまざまなパラメーターの種類に対してクエリでパラメーターを使用する方法について説明します。
既定の時間範囲パラメーター
既定では、すべてのダッシュボードに "時間の範囲" パラメーターがあります。 これは、クエリで使用されている場合にのみ、ダッシュボードにフィルターとして表示されます。 次の例に示すように、クエリで既定の時間の範囲パラメーターを使用するには、パラメーター キーワード _startTime
および _endTime
を使用します。
StormEvents
| where StartTime between (_startTime.._endTime)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
保存すると、時間の範囲フィルターがダッシュボードに表示されます。 これで、カードでのデータのフィルター処理に使用できるようになります。 次のようにドロップダウンから選択して、ダッシュボードをフィルター処理できます。時間の範囲 (過去 x 分/時間/日) または カスタムの時間の範囲。
単一選択の固定値パラメーター
固定値パラメーターは、ユーザーによって指定された定義済みの値に基づいています。 次の例では、単一選択の固定値パラメーターを作成する方法を示します。
単一選択の固定値パラメーターを作成する
[パラメーター] を選択して [パラメーター] ペインを開き、 [新しいパラメーター] を選択します。
詳細を次のように入力します。
ラベル: イベントの種類
パラメーターの種類:Single selection (単一選択)
変数名:
_eventType
データ型:String
Pin as dashboard filter (ダッシュボード フィルターとしてピン留め) : オン
ソース:Fixed values (固定値)
この例では、次の値を使用します。
値 パラメーターの表示名 雷雨風 雷雨の風 ひょう ひょう 鉄砲水 フラッシュ フラッド 干ばつ 干ばつ 冬の天気 冬の天気 Add a Select all value (「すべて選択」の値を追加):オフ
既定値: Thunderstorm Wind
[完了] を選択してパラメーターを作成します。
パラメーターは [ パラメーター ] サイド ペインに表示できますが、現在、どのビジュアルでも使用されていません。
単一選択の固定値パラメーターを使用する
変数名を使用して、新しい Event TypTope パラメーターを使用してサンプル クエリを
_eventType
実行します。StormEvents | where StartTime between (_startTime.._endTime) | where EventType == _eventType | summarize TotalEvents = count() by State | top 5 by TotalEvents
新しいパラメーターは、ダッシュボードの上部にあるパラメーターの一覧に表示されます。
さまざまな値を選択して、ビジュアルを更新します。
複数選択の固定値パラメーター
固定値パラメーターは、ユーザーによって指定された定義済みの値に基づいています。 次の例では、複数選択の固定値パラメーターを作成して使用する方法を示します。
複数選択の固定値パラメーターを作成する
[パラメーター] を選択して [パラメーター] ペインを開き、 [新しいパラメーター] を選択します。
「 単一選択の固定値パラメーターを使用する 」で説明されているように、次の変更を加えた詳細を入力します。
- ラベル: イベントの種類
- パラメーターの種類:複数選択
-
変数名:
_eventType
[完了] を選択してパラメーターを作成します。
新しいパラメーターは [パラメーター] のサイド ペインに表示されますが、現在はどのビジュアルでも使用されていません。
複数選択の固定値パラメーターを使用する
変数を使用して、新しい Event Type パラメーターを使用してサンプル クエリを
_eventType
実行します。StormEvents | where StartTime between (_startTime.._endTime) | where EventType in (_eventType) or isempty(_eventType) | summarize TotalEvents = count() by State | top 5 by TotalEvents
新しいパラメーターは、ダッシュボードの上部にあるパラメーターの一覧に表示されます。
1 つまたは複数の異なる値を選択して、ビジュアルを更新します。
単一選択クエリ ベースのパラメーター
クエリベースのパラメーター値は、パラメーターのクエリを実行することで、ダッシュボードの読み込み時に取得されます。 次の例では、単一選択のクエリベース パラメーターを作成して使用する方法を示します。
単一選択クエリ ベースのパラメーターを作成する
[パラメーター] を選択して [パラメーター] ペインを開き、 [新しいパラメーター] を選択します。
「 単一選択の固定値パラメーターを使用する 」で説明されているように、次の変更を加えた詳細を入力します。
ラベル: 状態
変数名:
_state
ソース:クエリ
データ ソース: StormEventsSample
[ クエリの編集] を 選択し、次のクエリを入力します。 [完了] を選択します。
StormEvents | where StartTime between (_startTime.._endTime) | where EventType in (_eventType) or isempty(_eventType) | summarize TotalEvents = count() by State | top 5 by TotalEvents | project State
値: State
表示名: State
既定値: 既定値を選択する
[完了] を選択してパラメーターを作成します。
単一選択クエリ ベースのパラメーターを使用する
新しい State パラメーターを使用した次のサンプル クエリでは、 変数を
_state
使用します。StormEvents | where StartTime between (_startTime.._endTime) | where EventType in (_eventType) or isempty(_eventType) | where State == _state | summarize TotalEvents = count() by State | top 5 by TotalEvents
新しいパラメーターは、ダッシュボードの上部にあるパラメーターの一覧に表示されます。
さまざまな値を選択して、ビジュアルを更新します。
複数選択クエリ ベースのパラメーター
クエリベースのパラメーター値は、ユーザー指定のクエリを実行することで、ダッシュボードの読み込み時に取得されます。 次の例では、複数選択のクエリベースのパラメーターを作成する方法を示します。
複数選択クエリ ベースのパラメーターを作成する
[ パラメーター] を 選択して [ パラメーター ] ペインを開き、 [ + 新しいパラメーター] を選択します。
-
- 「 単一選択の固定値パラメーターを使用する 」で説明されているように、次の変更を加えた詳細を入力します。
- ラベル: 状態
- パラメーターの種類:複数選択
-
変数名:
_state
[完了] を選択してパラメーターを作成します。
複数選択クエリ ベースのパラメーターを使用する
次のサンプル クエリでは、 変数を使用して新しい State パラメーターを
_state
使用します。StormEvents | where StartTime between (_startTime.._endTime) | where EventType in (_eventType) or isempty(_eventType) | where State in (_state) or isempty(_state) | summarize TotalEvents = count() by State | top 5 by TotalEvents
Note
このサンプルでは、
isempty()
関数で空の値をチェックすることによって、 [すべて選択] オプションを使用します。新しいパラメーターは、ダッシュボードの上部にあるパラメーターの一覧に表示されます。
1 つまたは複数の異なる値を選択して、ビジュアルを更新します。
フリー テキスト パラメーター
自由記載パラメーターには値は含まれていません。 独自の値を取り込むことができます。
自由記載パラメーターを作成する
[ パラメーター] を 選択して [ パラメーター ] ペインを開き、 [ + 新しいパラメーター] を選択します。
詳細を次のように入力します。
- ラベル: 状態
- パラメーターの種類:自由記載
- 変数名: _state
- データ型:String
- 既定値:既定値なし
フリー テキスト パラメーターを使用する
変数名を使用して、新しい State パラメーターを使用してサンプル クエリを
_state
実行します。StormEvents | where StartTime between (_startTime.._endTime) | where EventType in (_eventType) or isempty(_eventType) | where State contains _state | summarize TotalEvents = count() by State | top 5 by TotalEvents
データ ソース パラメーター
ダッシュボードに データ ソースを追加 したら、使用可能なデータ ソースを 1 つ以上選択するパラメーターを作成できます。 このパラメーターは、タイルやその他のパラメーターで使用できます。
データ ソース パラメーターを作成する
[ パラメーター] を 選択して [ パラメーター ] ペインを開き、 [ + 新しいパラメーター] を選択します。
詳細を次のように入力します。
- ラベル: ソース
- パラメーターの種類: データ ソース
- ページに表示: すべて選択
- 値: すべて選択
- 既定値: StormEventsSample
[完了] を選択します。
新しいパラメーターが、ダッシュボードの上部にあるパラメーター一覧に表示されます。
データ ソース パラメーターを使用する
新規または既存のタイルのクエリに移動します。
[ ソース] で、[ データ ソース パラメーター] で新しいパラメーターの名前を選択します。 上記で作成したパラメーターについては、[クラスター] を選択 します。
[変更の適用] を選択します。
クラスター パラメーターを使用して、この接続されたクエリのデータ ソースを変更します。
クロスフィルター パラメーター
クロスフィルターを使用すると、1 つのビジュアルで値を選択できます。また、折れ線グラフや散布図など、すべてのダッシュボード ビジュアルがフィルター処理され、関連データのみが表示されます。 クロスフィルターを使用すると、ダッシュボード上部のパラメーターリストのパラメーターに相当する値を選択した場合と同じ結果が得られます。
クロスフィルターの定義
クロスフィルターを作成するには、ビジュアルで オプションを有効にし、データのフィルター処理に使用するパラメーターを指定する必要があります。
クロスフィルターを追加するタイルのクエリに移動します。
[ビジュアル] を選択します。
右側のペインで、[相互作用] を選択し、[クロスフィルター] をオンにします。
必要に応じて、 相互作用 の種類を指定します。 既定値 は Point で、ビジュアルで値を選択できます。 タイム チャートなどの値の範囲を選択するには、[ドラッグ] を選択 します。
値の指定に使用する列と、クエリのフィルター処理に使用するパラメーターの両方を指定します。
重要
列とパラメーターのデータ型は同じである必要があります。
クロスフィルターを使用してデータを操作する
クロスフィルターを定義したら、それを使用してデータを操作できます。 クロスフィルターを定義したビジュアルで、データ ポイントを選択し、その値を使用して現在のダッシュボード ページをフィルター処理できます。 テーブル ビジュアルの場合は、関連するセルを右クリックしてデータ ポイントを選択し、コンテキスト メニューの [クロスフィルター] を選択します。
クロスフィルターをリセットするには、選択したビジュアルの上部にある [リセット] を選択します。
ドリルスルーをダッシュボードのパラメーターとして使用する
ドリルスルーを使用すると、ビジュアル内で値を選択し、その値を使用して同じダッシュボード内のターゲット ページ内のビジュアルをフィルター処理できます。 ターゲット ページをオープンする際に、関連するフィルターで値が事前に選択されます。 折れ線グラフや散布図などのページ上のビジュアルがフィルター処理され、関連データのみが表示されます。
ドリルスルーの定義
ドリルスルーを作成するには、まずビジュアル内でドリルスルーをオンにしてから、必要に応じて 1 つ以上のドリルスルーを追加する必要があります。
ドリルスルーを追加しようとしているビジュアルを編集します。 [ビジュアル] タブが選択されていることを確認します。
右側のペインで、[相互作用] を選択してから、[ドリルスルー] をオンにします。
[ドリルスルー] の下で、[新規作成] を選択し、次の情報を指定します。 必要に応じて、[別のペアを追加] を選択し、ターゲット ページに対して複数のパラメーターを追加します。 別のパラメーターを使用して現在のダッシュボード内の他のページにドリルスルーを追加するには、この手順を繰り返します。
フィールド 説明 送信先ページ 定義したパラメーターを使用したドリルスルー先の 1 つ以上のターゲット ページ。 列 ターゲット ページ内のパラメーターの値として使用する、クエリ結果の列。 パラメーター 列の値を使用したターゲット ページ内のビジュアルのフィルター処理に使用するパラメーター。 メモ 省略可能な簡単な説明。 重要
列とパラメーターのペアのデータ型が同じである必要があります。
ドリルスルーを使用してデータを操作する
ドリルスルーを定義し終えたら、それらのドリルスルーを使用してデータを操作できます。 そのためには、ドリルスルーを定義したビジュアルまたはテーブルで、データ ポイントを右クリックし、[Drill through to](ドリルスルー先)>ドリルスルー先ページを選択します。 データ ポイントからの値が、ターゲット ページ上のビジュアルをフィルター処理するパラメーターとして使用されます。
ソース ページに戻すには、移行先ページの右上にある [リセット] を選択 します。 ドリルスルーにより割り当てられたすべてのフィルターがリセットされます。
単一および複数選択フィルターにフィルター検索を使用する
単一および複数選択フィルターに、必要な値を入力します。 フィルターが更新され、検索語句に一致する値のみが表示されます。