Aracılığıyla paylaş


Görselin özelliklerini alma

Görselin özellikleri, görselleştirme türünün kabul edebildiği veri rolleridir. Örneğin, bu görüntüde Görselleştirme bölmesinde kümelenmiş sütun grafiğin görsel özellikleri gösterilir.

Düzenleme modunun Görselleştirme bölmesinde seçilen kümelenmiş sütun grafiği ve özelliklerini gösteren ekran görüntüsü.

Rapor veya görsel düzeyinde hangi verilerin görüntüleneceğini belirlemek için görselin özelliklerini alın. Özellikleri almak için kullanılan API'lerin her ikisi de IVisualCapabilitiesdöndürür.

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

dataRoles bir görselin beklediği rolleri ve bu rollerin nasıl doldurulması gerektiğini tanımlayın. Bu veriler aşağıdaki görsel veri bağlama API'lerini kullanmak için gereklidir. Bu API'lerin her biri giriş parametresi olarak hedef dataRolename bekler.

dataRoles IVisualDataRole arabirimi tarafından temsil edilir:

interface IVisualDataRole {
    name: string;
    kind: VisualDataRoleKind;
    kindPreference?: VisualDataRoleKindPreference;
    displayName?: string;
    description?: string;
}
  • ad - VisualDataRoleiçin benzersiz tanımlayıcı.
  • tür - Görsel verilerin rol türünü gösterir.
  • kindPreference - Kullanılacak rol türüyle ilgili görsel tercihi gösterir.
  • displayName - Rolün görünen adı.
  • açıklama - Araç ipucu metni.

Hem kullanıma hazır hem de raporda yüklü özel görseller için görsel meta verileri alabilirsiniz.

Rapor düzeyinde görsel özellikler edinme

Rapor düzeyinde görüntülenen görsel verileri bulmak için getVisualCapabilities API'sini kullanın.

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

Örnek

Aşağıda, rapor düzeyinde görsel çubuk grafiğindeki özellikleri bulmaya yönelik bir kod örneği verilmiştir.

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

Görsel düzeyde görsel özellikler edinme

Görsel düzeyde hangi verilerin görüntüleneceğini belirlemek için getCapabilities API'sini kullanın.

getCapabilities(): Promise<models.IVisualCapabilities>

Örnek

Aşağıda görsel düzeyindeki bir görselin özelliklerini bulmaya yönelik bir kod örneği verilmiştir.

let capabilities = await visual.getCapabilities();

Örneğin, bir clusteredColumnChart özelliklerini almak aşağıdakileri döndürür:

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