Udostępnij za pośrednictwem

Uzyskiwanie możliwości wizualizacji

  • Artykuł

Możliwości wizualizacji to role danych, które mogą akceptować typ wizualizacji. Na przykład na tym obrazie przedstawiono możliwości wizualne wykresu kolumnowego klastrowanego w okienku Wizualizacja.

Zrzut ekranu przedstawiający wykres kolumnowy grupowany wybrany w okienku Wizualizacja trybu edycji i jego możliwości.

Uzyskaj możliwości wizualizacji, aby określić, jakie dane są wyświetlane na poziomie raportu lub wizualizacji. Oba interfejsy API używane do uzyskiwania możliwości zwracają IVisualCapabilities.

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

dataRoles zdefiniować role oczekiwane przez wizualizację i sposób wypełniania tych ról. Te dane są wymagane do korzystania z następujących interfejsów API powiązania danych wizualnych. Każdy z tych interfejsów API oczekuje docelowego dataRolename jako parametru wejściowego.

dataRoles są reprezentowane przez interfejs IVisualDataRole:

interface IVisualDataRole {
    name: string;
    kind: VisualDataRoleKind;
    kindPreference?: VisualDataRoleKindPreference;
    displayName?: string;
    description?: string;
}
  • nazwa — unikatowy identyfikator VisualDataRole.
  • rodzaj — wskazuje rodzaj roli danych wizualnych.
  • kindPreference — wskazuje preferencję wizualizacji dotyczącą rodzaju roli do użycia.
  • displayName — nazwa wyświetlana roli.
  • opis — tekst etykietki narzędzia.

Metadane wizualizacji można pobierać zarówno dla wbudowanych, jak i niestandardowych wizualizacji zainstalowanych w raporcie.

Jak uzyskać możliwości wizualne na poziomie raportu

Użyj interfejsu API getVisualCapabilities, aby znaleźć dane wizualne wyświetlane na poziomie raportu.

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

Przykład

Poniżej przedstawiono przykładowy kod umożliwiający znalezienie możliwości na wykresie słupkowym wizualizacji na poziomie raportu.

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

Jak uzyskać możliwości wizualizacji na poziomie wizualizacji

Użyj interfejsu API getCapabilities, aby określić, jakie dane są wyświetlane na poziomie wizualizacji.

getCapabilities(): Promise<models.IVisualCapabilities>

Przykład

Poniżej przedstawiono przykładowy kod umożliwiający znalezienie możliwości w wizualizacji na poziomie wizualizacji.

let capabilities = await visual.getCapabilities();

Na przykład uzyskanie możliwości clusteredColumnChart zwraca następujące elementy:

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

Powiązana zawartość