Bagikan melalui

Mendapatkan kemampuan visual

Kemampuan visual adalah peran data yang dapat diterima oleh jenis visualisasi. Misalnya, gambar ini memperlihatkan kemampuan visual bagan kolom terkluster di panel Visualisasi .

Cuplikan layar yang memperlihatkan bagan kolom berkluster dipilih di panel Visualisasi mode Edit dan kemampuannya.

Dapatkan kemampuan visual untuk menentukan data apa yang ditampilkan di tingkat laporan atau visual. Kedua API yang digunakan untuk mendapatkan kemampuan mengembalikan IVisualCapabilities.

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

dataRoles menentukan peran yang diharapkan visual dan bagaimana peran tersebut harus diisi. Data ini diperlukan untuk menggunakan API pengikatan data visual berikut. Masing-masing API ini mengharapkan target dataRolename sebagai parameter input.

dataRoles diwakili oleh antarmuka IVisualDataRole:

interface IVisualDataRole {
    name: string;
    kind: VisualDataRoleKind;
    kindPreference?: VisualDataRoleKindPreference;
    displayName?: string;
    description?: string;
}
  • nama - Pengidentifikasi unik untuk VisualDataRole.
  • jenis - Menunjukkan jenis peran untuk data visual.
  • kindPreference - Menunjukkan preferensi visual tentang jenis peran apa yang akan digunakan.
  • displayName - Nama tampilan peran.
  • deskripsi - Teks untuk tipsalat.

Anda dapat mengambil metadata visual untuk visual out-of-the-box dan kustom yang diinstal pada laporan.

Cara mendapatkan kemampuan visual di tingkat laporan

Gunakan API getVisualCapabilities untuk menemukan data visual yang ditampilkan di tingkat laporan.

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

Contoh

Di bawah ini adalah contoh kode untuk menemukan kemampuan dalam bagan batang visual di tingkat laporan.

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

Cara mendapatkan kemampuan visual di tingkat visual

Gunakan API getCapabilities untuk menentukan data apa yang ditampilkan di tingkat visual.

getCapabilities(): Promise<models.IVisualCapabilities>

Contoh

Di bawah ini adalah contoh kode untuk menemukan kemampuan dalam visual di tingkat visual.

let capabilities = await visual.getCapabilities();

Misalnya, mendapatkan kemampuan untuk clusteredColumnChart mengembalikan hal berikut:

{
    "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
        }
    ]
}

Konten terkait

  • Last updated on