Compartir a través de

Obtención de las funcionalidades de un objeto visual

  • Artículo

Las funcionalidades de un objeto visual son roles de datos que el tipo de visualización puede aceptar. Por ejemplo, esta imagen muestra las funcionalidades visuales de un gráfico de columnas agrupadas en el panel visualización de .

Captura de pantalla que muestra un gráfico de columnas agrupadas seleccionado en el panel Visualización del modo de edición y sus funcionalidades.

Obtenga las funcionalidades de un objeto visual para determinar qué datos se muestran en el nivel de informe o objeto visual. Ambas API usadas para obtener funcionalidades devuelven IVisualCapabilities.

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

dataRoles definir los roles que espera un objeto visual y cómo se deben rellenar esos roles. Estos datos son necesarios para usar las siguientes API de enlace de datos visuales. Cada una de estas API espera el dataRolename de destino como parámetro de entrada.

dataRoles se representan mediante la interfaz IVisualDataRole:

interface IVisualDataRole {
    name: string;
    kind: VisualDataRoleKind;
    kindPreference?: VisualDataRoleKindPreference;
    displayName?: string;
    description?: string;
}
  • nombre: identificador único de VisualDataRole.
  • tipo: indica el tipo de rol para los datos visuales.
  • kindPreference: indica la preferencia visual sobre qué tipo de rol usar.
  • displayName: el nombre para mostrar del rol.
  • descripción: el texto de la información sobre herramientas.

Puede recuperar metadatos visuales para objetos visuales predefinidos y personalizados instalados en el informe.

Obtención de funcionalidades visuales en el nivel de informe

Use la API de getVisualCapabilities para buscar los datos visuales que se muestran en el nivel de informe.

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

Ejemplo

A continuación se muestra un ejemplo de código para buscar las funcionalidades en un gráfico de barras de objeto visual en el nivel de informe.

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

Cómo obtener funcionalidades visuales en el nivel visual

Use la API de getCapabilities para determinar qué datos se muestran en el nivel visual.

getCapabilities(): Promise<models.IVisualCapabilities>

Ejemplo

A continuación se muestra un ejemplo de código para buscar las funcionalidades en un objeto visual en el nivel visual.

let capabilities = await visual.getCapabilities();

Por ejemplo, obtener las funcionalidades de un clusteredColumnChart devuelve lo siguiente:

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

Contenido relacionado