ビジュアルの機能を取得する

ビジュアルの機能は、視覚化の種類で受け入れられるデータ ロールです。 たとえば、この画像は、[視覚化] ペインの クラスター化縦棒グラフ の視覚機能を示しています。

ビジュアルの機能を取得して、レポートまたはビジュアル レベルで表示されるデータを決定します。 機能を取得するために使用される両方の API は、IVisualCapabilitiesを返します。

export interface IVisualCapabilities {
  dataRoles?: IVisualDataRole[];
}

dataRoles ビジュアルが期待するロールと、それらのロールを設定する方法を定義します。 このデータは、次のビジュアル データ バインディング API を使用するために必要です。 これらの各 API は、入力パラメーターとしてターゲット dataRolename を受け取ります。

dataRoles は、IVisualDataRole インターフェイスによって表されます。

interface IVisualDataRole {
    name: string;
    kind: VisualDataRoleKind;
    kindPreference?: VisualDataRoleKindPreference;
    displayName?: string;
    description?: string;
}

• 名前 - VisualDataRoleの一意の識別子です。
• 種類 - ビジュアル データのロールの種類を示します。
• kindPreference - 使用するロールの種類に関する視覚的な優先設定を示します。
• displayName - ロールの表示名。
• 説明 - ヒントのテキスト。

レポートにインストールされている既定のビジュアルとカスタム ビジュアルの両方のビジュアル メタデータを取得できます。

レポート レベルでビジュアル機能を取得する方法

getVisualCapabilities API を使用して、レポート レベルで表示されるビジュアル データを検索します。

getVisualCapabilities(visualType: string): Promise<models.IVisualCapabilities>

例

レポート レベルでビジュアルを 横棒グラフの機能を見つけるためのコード例を次に示します。

let capabilities = await report.getVisualCapabilities('barChart');

ビジュアル レベルでビジュアル機能を取得する方法

getCapabilities API を使用して、ビジュアル レベルで表示されるデータを決定します。

getCapabilities(): Promise<models.IVisualCapabilities>

例

ビジュアル レベルでビジュアル内の機能を見つけるためのコード例を次に示します。

let capabilities = await visual.getCapabilities();

たとえば、clusteredColumnChart の機能を取得すると、次のものが返されます。

{
    "dataRoles": [
        {
            "name": "Category",
            "displayName": "Axis",
            "description": "Fields to place on the horizontal or vertical axis",
            "kind": 0
        },
        {
            "name": "Series",
            "displayName": "Legend",
            "description": "The categorical field to show for color",
            "kind": 0
        },
        {
            "name": "Y",
            "displayName": "Values",
            "description": "The numeric amounts to plot",
            "kind": 1
        },
        {
            "name": "Rows",
            "displayName": "Small multiples",
            "description": "Split your visual into multiple, smaller visuals based on your selected fields",
            "kind": 0
        },
        {
            "name": "Tooltips",
            "displayName": "Tooltips",
            "description": "Add additional data fields that people can see in the tooltip when they hover on part of this visualization.",
            "kind": 1
        }
    ]
}

関連コンテンツ

• ページとビジュアルの を取得する
• データ フィールドの構成
• レポート ビジュアル のメニュー コマンドを変更する
• ビジュアル ヘッダーの を非表示または表示する