Compartir a través de

Ocultar o mostrar encabezados visuales

  • Artículo

Los informes de Power BI que inserte en aplicaciones contienen objetos visuales, como gráficos, mapas térmicos y medidores. Estos objetos visuales tienen encabezados que hacen que las acciones estén disponibles para los usuarios. Al usar Power BI, puede ocultar o mostrar el encabezado de cada objeto visual de un informe. Cada objeto visual tiene una tarjeta en la sección formato de del panel visualizaciones de denominado encabezado Visual. Puede usar esa tarjeta para activar y desactivar el encabezado del objeto visual. Obtenga más información sobre los encabezados visuales de encabezados visuales.

Algunos ejemplos de acciones en encabezados visuales son:

  • Abrir el objeto visual en modo de enfoque.
  • Explorar en profundidad o hacia arriba.
  • Ver qué filtros y segmentaciones se aplican actualmente al objeto visual.
  • Abrir el menú de opciones del objeto visual.

A veces resulta útil ocultar estas acciones. Por ejemplo, cuando dos objetos visuales se superponen, es posible que no desee mostrar los encabezados de ambos objetos visuales.

Esta API proporciona una manera de ocultar o mostrar encabezados de todos los objetos visuales de un informe o solo específicos. Puede configurar la visibilidad en la carga del informe o puede llamar al método Report updateSettings para cambiar la visibilidad después de cargar un informe, consulte Actualizar la configuración del informe en tiempo de ejecución.

Puede usar la API en muchos escenarios, incluidos los siguientes casos de uso:

  • Oculte solo algunos de los encabezados visuales de un informe.
  • Use la lógica de negocios en una aplicación, como un clic de botón, para ocultar o mostrar un encabezado después de cargar un informe.

Cómo ocultar o mostrar encabezados visuales

Para ocultar o mostrar encabezados visuales en la API, configure determinados parámetros en la configuración de un informe. Consulte Configuración de las opciones de informe para obtener información general sobre cómo configurar opciones en informes insertados.

Configuración del encabezado visual

Con los encabezados visuales, la visibilidad es actualmente la única opción que puede configurar. Para ocultar o mostrar encabezados, proporcione una lista de objetos de configuración de encabezado visual. Cada uno contiene un objeto de configuración y también puede incluir un selector. Selectores identificar los objetos visuales a los que está aplicando la configuración. Obtenga más información sobre los selectores de Selectores.

El tipo del objeto de configuración que se proporciona a la API es IVisualSettings. Más adelante en este artículo, encontrará ejemplos que muestran cómo usar esta interfaz en el código. modelos de Power BI enumera todas las definiciones de interfaz que usan los ejemplos.

Tenga en cuenta los siguientes puntos:

  • El selector es opcional en esta configuración. Cuando no enumera ningún selector, la API aplica la configuración a todos los objetos visuales del informe.
  • Al usar selectores, puede especificar objetos visuales por nombre o por tipo. Para obtener los nombres y los tipos de los objetos visuales de una página determinada, use el método Page getVisuals.

Reglas de precedencia

La API aplica las opciones de configuración en el orden siguiente:

  • Configuración que se guarda en el informe.
  • Configuración que defina en el objeto de configuración de inserción, que la API se aplica a la carga.
  • Configuración que proporcione a la API de updateSettings.

Si se puede aplicar más de una configuración a un objeto visual, la API usa la última configuración que se aplica. El Ocultar todo, pero un encabezado visual ejemplo en la sección siguiente, muestra este punto.

Ejemplos

Estos ejemplos muestran diferentes formas de usar la API para ocultar o mostrar encabezados visuales.

Ocultar todos los encabezados visuales

Este escenario sencillo proporciona a los clientes una vista de informe limpia ocultando todos los encabezados visuales de un informe:

let embedConfig = {
    ...
    settings: {
        ...
        visualSettings: {
            visualHeaders: [
                {
                    settings: {
                        visible: false
                    }
                    /* No selector is listed. The API hides the headers of all the visuals in the report. */
                }
            ]
        }
    }
};
...
let report = powerbi.embed(embedContainer, embedConfig);

Ocultar el encabezado de un objeto visual específico

En este ejemplo se usa un selector para aplicar una configuración de visibilidad a un solo objeto visual. Este escenario aparece cuando se quiere ocultar la funcionalidad que no tiene sentido para un objeto visual. Use este código en ese caso:

let embedConfig = {
    ...
    settings: {
        ...
        visualSettings: {
            visualHeaders: [
                {
                    settings: {
                        visible: false
                    },
                    selector: {
                        $schema: "http://powerbi.com/product/schema#visualSelector",
                        visualName: <The name of the visual>  // You can retrieve the name by using getVisuals.
                    }
                }
            ]
        }
    }
};
...
let report = powerbi.embed(embedContainer, embedConfig);

Ocultar todo menos un encabezado visual

Use este código para ocultar todos los encabezados visuales de un informe, excepto el encabezado de un objeto visual específico:

let embedConfig = {
    ...
    settings: {
        ...
        visualSettings: {
            visualHeaders: [
                {
                    settings: {
                        visible: false
                    }
                    /* No selector is listed. The API hides the headers of all the visuals in the report. */
                },
                {
                    settings: {
                        visible: true
                    },
                    selector: {
                        $schema: "http://powerbi.com/product/schema#visualSelector",
                        visualName: <The name of the visual> // You can retrieve the name by using getVisuals.
                    }
                }
            ]
        }
    }
};
...
let report = powerbi.embed(embedContainer, embedConfig);

Si desea que haya más de un encabezado visible, puede ampliar este código. Configure instancias adicionales de IVisualHeader con el parámetro visible en settings establecido en true. Para cada objeto visual que debe tener un encabezado visible, agregue una instancia de IVisualHeader a la lista.

Consideraciones y limitaciones

  • Solo puede controlar la visibilidad de los encabezados visuales si el informe que insertó está en modo de vista.
  • Solo puede ocultar o mostrar el encabezado completo de un objeto visual. No se puede configurar la visibilidad de elementos específicos en el menú de encabezado.
  • Cuando se usa un selector para especificar el nombre o el tipo de un objeto visual, use el método Page getVisuals para obtener el nombre del objeto visual, que es un identificador único. No configure el selector con el título del objeto visual.
  • Si un usuario guarda un informe que insertó con la API, la configuración visual que definió se guardará en el informe. Para evitar esta situación, configure el informe con un nivel de permiso de View en lugar de Edit o Save.

Contenido relacionado