GLQL表示タイプ
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
表示タイプは、埋め込みビューがGLQLクエリの結果をどのようにレンダリングするかを制御します。ビューのソースでdisplayパラメータを使用して、表示タイプを設定します。
displayパラメータを設定しない場合、結果はリストとしてレンダリングされます。
一部の表示タイプは任意のクエリで動作します。その他は、データをディメンションとメトリクスに集約するアナリティクスモードでのみ動作します。
次の表示タイプはすべてのモードで利用できます:
| 表示タイプ | displayの値 | 説明 |
|---|---|---|
| テーブル | table | 結果ごとに1行、フィールドごとに1列のテーブル。 |
| リスト | list | 結果の順序なしリスト。 |
| 順序付きリスト | orderedList | 結果の番号付きリスト。 |
次の表示タイプはアナリティクスモードでのみ利用できます:
| 表示タイプ | displayの値 | 説明 |
|---|---|---|
| シングル統計 | stat | 集約された単一のメトリクスが大きな値として表示されます。 |
| 縦棒チャート | columnChart | 定義されたディメンションによってカテゴリー間でメトリクスを比較するチャート。 |
| 折れ線チャート | lineChart | 1つ以上のメトリクスをディメンションにわたる線としてプロットし、トレンドを示すチャート。 |
テーブル
テーブルは、結果ごとに1行、フィールドごとに1列をレンダリングします。
テーブルを列で並べ替えるには、列のヘッダーを選択します。このビューは、ビューに読み込まれた行を並べ替えます。結果セット全体ではありません。
例
gitlab-org/gitlabプロジェクトで現在のユーザーに割り当てられた最初の5つのオープンイシューをテーブルとして、title、state、health、epic、milestone、weight、およびupdated列とともに表示するには:
```glql
display: table
title: My open issues
fields: title, state, health, epic, milestone, weight, updated
limit: 5
query: type = Issue AND project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```リスト
リストは結果を順序なしリストとしてレンダリングします。リストはデフォルトの表示タイプです。
例
gitlab-org/gitlabプロジェクトで現在のユーザーに割り当てられた最初の5つのオープンイシューをリストとして、期限日で最も早いものから順に並べ替え、title、health、およびdueフィールドを表示するには:
```glql
display: list
fields: title, health, due
limit: 5
sort: due asc
query: type = Issue AND project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```順序付きリスト
順序付きリストは結果を番号付きリストとしてレンダリングします。結果の順序が意味のある場合(例えばランキングなど)は、順序付きリストを使用します。
例
gitlab-org/gitlabプロジェクトで現在のユーザーに割り当てられた最初の5つのオープンイシューを順序付きリストとして、期限日で最も早いものから順に並べ替え、title、health、およびdueフィールドを表示するには:
```glql
display: orderedList
fields: title, health, due
limit: 5
sort: due asc
query: type = Issue AND project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```シングル統計
シングル統計は、アナリティクスモードからの集約された1つのメトリクスを大きな値として可視化します。合計や割合など、重要な数値を強調するにはシングル統計を使用します。
シングル統計には以下が必要です:
- アナリティクスモード。
mode: analyticsで設定します。 - 1つのメトリクスのみ。
metricsパラメータで設定します。 dimensionsなし。
値はメトリクスに基づいて自動的にフォーマットされます。例えば、カウントは千の区切りを使用し、割合はパーセンテージとして表示されます。
例
過去30日間のコード提案の総数をシングル統計として表示するには:
```glql
display: stat
mode: analytics
query: type = CodeSuggestion and timestamp >= -30d
metrics: totalCount
```縦棒チャート
縦棒チャートは、アナリティクスモードからの集約されたデータを可視化します。ディメンションで定義されたカテゴリー間でメトリクスを比較するには、縦棒チャートを使用します。
縦棒チャートには以下が必要です:
- アナリティクスモード。
mode: analyticsで設定します。 - 結果をグループ化するための1つまたは2つの
dimensions。 - プロットするメトリクスが少なくとも1つ(
metricsパラメータを使用)。
ディメンションとメトリクスの数がチャートのレンダリング方法を決定します:
- 1つ以上のメトリクスを持つ1つのディメンションは、各メトリクスの列をプロットします。これらの列をスタックするには、
displayConfigの下にstacked: trueを設定します。 - 1つのメトリクスを持つ2つのディメンションは、2番目のディメンションでグループ化された積み重ね縦棒チャートをプロットします。2つのディメンションでは、1つのメトリクスのみを使用できます。
例
過去30日間のコード提案の使用状況を言語別に縦棒チャートとして表示するには:
```glql
display: columnChart
mode: analytics
query: type = CodeSuggestion and timestamp >= -30d
dimensions: language
metrics: totalCount
```メトリクスを並べてプロットする代わりに、単一の列にスタックするには:
```glql
display: columnChart
displayConfig:
stacked: true
mode: analytics
query: type = CodeSuggestion and timestamp >= -30d
dimensions: language
metrics: acceptedCount, rejectedCount
```折れ線チャート
折れ線チャートは、アナリティクスモードからの集約されたデータを1つ以上の線として可視化します。時間経過など、ディメンションにわたるメトリクスの変化を示すには、折れ線チャートを使用します。
折れ線チャートには以下が必要です:
- アナリティクスモード。
mode: analyticsで設定します。 - X軸に正確に1つの
dimension。 - プロットする
metricが少なくとも1つ。各メトリクスは個別の線としてレンダリングされます。
例
過去30日間のコード提案の使用状況を言語別に折れ線チャートとして、総提案数に1本、承認された提案数に1本の線を表示するには:
```glql
display: lineChart
mode: analytics
query: type = CodeSuggestion and timestamp >= -30d
dimensions: language
metrics: totalCount, acceptedCount
```ページネーションのサポート
すべてのモードで利用可能な表示タイプは、結果の最初のページを表示し、追加のページをフェッチするための更に表示アクションを提供します。詳細については、ページネーションを参照してください。
アナリティクスモードの可視化はページネーションをサポートしていません。それらはすべての集約された結果を一度にレンダリングします。