Masquer ou afficher les en-têtes visuels

  • Article

Les rapports Power BI que vous incorporez dans des applications contiennent des visuels, tels que des graphiques, des cartes thermiques et des jauges. Ces visuels ont des en-têtes qui rendent les actions accessibles aux utilisateurs. Lorsque vous utilisez Power BI, vous pouvez masquer ou afficher l’en-tête de chaque visuel dans un rapport. Chaque visuel a une carte dans la section Mise en forme du volet Visualisations appelé en-tête visuel. Vous pouvez utiliser cette carte pour activer et désactiver l’en-tête du visuel. En savoir plus sur les en-têtes visuels dans en-têtes visuels.

Voici quelques exemples d’actions dans les en-têtes visuels :

  • Ouverture du visuel en mode focus.
  • Descendre ou monter.
  • Affichage des filtres et segments actuellement appliqués au visuel.
  • Ouverture du menu options du visuel.

Parfois, il est utile de masquer ces actions. Par exemple, lorsque deux visuels se chevauchent, vous ne souhaiterez peut-être pas afficher les en-têtes des deux visuels.

Cette API permet de masquer ou d’afficher les en-têtes de tous les visuels d’un rapport ou d’un seul élément spécifique. Vous pouvez configurer la visibilité sur le chargement du rapport ou appeler la méthode Report updateSettings pour modifier la visibilité une fois qu’un rapport a été chargé, consultez Mettre à jour les paramètres de rapport au moment de l’exécution.

Vous pouvez utiliser l’API dans de nombreux scénarios, y compris les cas d’usage suivants :

  • Masquez uniquement certains en-têtes visuels dans un rapport.
  • Utilisez la logique métier dans une application, telle qu’un clic sur le bouton, pour masquer ou afficher un en-tête après le chargement d’un rapport.

Comment masquer ou afficher des en-têtes visuels

Pour masquer ou afficher des en-têtes visuels dans l’API, vous configurez certains paramètres dans les paramètres d’un rapport. Consultez Configurer les paramètres de rapport pour obtenir des informations générales sur la configuration des options dans les rapports incorporés.

Paramètres d’en-tête visuel

Avec les en-têtes visuels, la visibilité est actuellement le seul paramètre que vous pouvez configurer. Pour masquer ou afficher des en-têtes, vous fournissez une liste d’objets de configuration d’en-tête visuel. Chacun contient un objet de paramètres et peut également inclure un sélecteur. sélecteurs identifier les visuels auxquels vous appliquez les paramètres. En savoir plus sur les sélecteurs dans sélecteurs.

Le type de l’objet de configuration que vous fournissez à l’API est IVisualSettings. Plus loin dans cet article, vous trouverez exemples qui montrent comment utiliser cette interface dans votre code. modèles Power BI répertorie toutes les définitions d’interface utilisées par les exemples.

Notez les points suivants :

  • Le sélecteur est facultatif dans ces paramètres. Lorsque vous ne répertoriez aucun sélecteur, l’API applique vos paramètres à tous les visuels du rapport.
  • Lorsque vous utilisez des sélecteurs, vous pouvez spécifier des visuels par nom ou par type. Pour obtenir les noms et les types des visuels dans une page donnée, utilisez la page getVisuals méthode.

Règles de précédence

L’API applique les paramètres de configuration dans l’ordre suivant :

  • Paramètres enregistrés dans le rapport.
  • Paramètres que vous définissez dans l’objet de configuration incorporé, que l’API s’applique au chargement.
  • Paramètres que vous fournissez à l’API updateSettings.

Si plusieurs paramètres peuvent s’appliquer à un visuel, l’API utilise le dernier paramètre qui s’applique. La Masquer tout mais un en-tête visuel exemple dans la section suivante illustre ce point.

Exemples

Ces exemples montrent différentes façons d’utiliser l’API pour masquer ou afficher des en-têtes visuels.

Masquer tous les en-têtes visuels

Ce scénario simple fournit aux clients une vue de rapport propre en masquant tous les en-têtes visuels d’un rapport :

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);

Masquer l’en-tête d’un visuel spécifique

Cet exemple utilise un sélecteur pour appliquer un paramètre de visibilité à un seul visuel. Ce scénario s’affiche lorsque vous souhaitez masquer les fonctionnalités qui n’ont pas de sens pour un visuel. Utilisez ce code dans ce cas :

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);

Masquer tout mais un seul en-tête visuel

Utilisez ce code pour masquer tous les en-têtes visuels d’un rapport, à l’exception de l’en-tête d’un visuel spécifique :

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 vous souhaitez rendre plusieurs en-têtes visibles, vous pouvez étendre ce code. Configurez des instances supplémentaires de IVisualHeader avec le paramètre visible dans settings définie sur true. Pour chaque visuel qui doit avoir un en-tête visible, ajoutez une instance IVisualHeader à la liste.

Considérations et limitations

  • Vous pouvez uniquement contrôler la visibilité des en-têtes visuels si le rapport que vous incorporez est en mode affichage.
  • Vous ne pouvez masquer ou afficher que l’en-tête entier d’un visuel. Vous ne pouvez pas configurer la visibilité des éléments spécifiques dans le menu d’en-tête.
  • Lorsque vous utilisez un sélecteur pour spécifier le nom ou le type d’un visuel, utilisez la page méthode getVisuals pour obtenir le nom du visuel, qui est un identificateur unique. Ne configurez pas le sélecteur avec le titre du visuel.
  • Si un utilisateur enregistre un rapport que vous incorporez avec l’API, les paramètres visuels que vous avez définis sont enregistrés dans le rapport. Vous pouvez éviter cette situation en configurant le rapport avec un niveau d’autorisation de View au lieu de Edit ou de Save.

Contenu connexe