ビジュアル ヘッダーの表示/非表示を切り替える

アプリに埋め込む Power BI レポートには、グラフ、ヒート マップ、ゲージなどのビジュアルが含まれています。 これらのビジュアルには、ユーザーがアクションを使用できるようにするヘッダーがあります。 Power BI を使用する場合は、レポート内の各ビジュアルのヘッダーを非表示または表示できます。 各ビジュアルには、visual ヘッダーと呼ばれる 視覚化 ウィンドウの [の書式設定] セクション カードがあります。 そのカードを使用して、ビジュアルのヘッダーのオンとオフを切り替えることができます。 ビジュアル ヘッダーの詳細については、Visual ヘッダーを参照してください。

ビジュアル ヘッダーのアクションの例を次に示します。

• フォーカス モードでビジュアルを開きます。
• ドリルダウンまたはドリルダウン。
• ビジュアルに現在適用されているフィルターとスライサーを表示する。
• ビジュアルのオプション メニューを開きます。

これらのアクションを非表示にした方が便利な場合があります。 たとえば、2 つのビジュアルが重なる場合、両方のビジュアルのヘッダーを表示したくない場合があります。

この API は、レポート内のすべてのビジュアルまたは特定のビジュアルのみのヘッダーを非表示または表示する方法を提供します。 レポートの読み込みの可視性を構成することも、レポートの読み込み後に Report updateSettings メソッドを呼び出して可視性を変更することもできます。実行時のレポート設定の更新 を参照してください。

API は、次のユース ケースなど、多くのシナリオで使用できます。

• レポート内のビジュアル ヘッダーの一部のみを非表示にします。
• レポートの読み込み後にヘッダーを非表示または表示するには、ボタンクリックなどのビジネス ロジックをアプリで使用します。

ビジュアル ヘッダーを非表示または表示する方法

API でビジュアル ヘッダーを非表示または表示するには、レポートの設定で特定のパラメーターを構成します。 埋め込みレポートのオプションの構成に関する一般的な情報については、「レポート設定の構成 を参照してください。

ビジュアル ヘッダーの設定

ビジュアル ヘッダーでは、現在、可視性のみが構成できる設定です。 ヘッダーを非表示または表示するには、ビジュアル ヘッダー構成オブジェクトの一覧を指定します。 それぞれに設定オブジェクトが含まれており、セレクターを含めることもできます。 セレクター、設定を適用するビジュアルを識別します。 セレクターの詳細については、セレクターを参照してください。

API に提供する構成オブジェクトの型は、IVisualSettingsです。 この記事の後半では、コードでこのインターフェイス 使用する方法を示す 例を紹介します。 Power BI モデル、例で使用するすべてのインターフェイス定義が一覧表示されます。

次の点に注意してください。

• セレクターは、これらの設定では省略可能です。 セレクターを一覧表示しない場合、API はレポート内のすべてのビジュアルに設定を適用します。
• セレクターを使用する場合は、名前または種類によってビジュアルを指定できます。 特定のページ内のビジュアルの名前と種類を取得するには、Page getVisuals メソッドを使用します。

優先順位ルール

API は、次の順序で構成設定を適用します。

• レポートに保存される設定。
• API が読み込み時に適用する埋め込み構成オブジェクトで定義する設定。
• updateSettings API に指定する設定。

ビジュアルに複数の設定を適用できる場合、API は適用される最後の設定を使用します。 1 つのビジュアル ヘッダーを含むすべてを非表示にする、次のセクションの例はこの点を示しています。

例

これらの例では、API を使用してビジュアル ヘッダーを非表示または表示するさまざまな方法を示します。

すべてのビジュアル ヘッダーを非表示にする

この単純なシナリオでは、レポート内のすべてのビジュアル ヘッダーを非表示にして、クリーンなレポート ビューをユーザーに提供します。

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

特定のビジュアルのヘッダーを非表示にする

この例では、セレクターを使用して、表示設定を 1 つのビジュアルに適用します。 このシナリオは、ビジュアルにとって意味のない機能を非表示にする場合に発生します。 その場合は、次のコードを使用します。

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

1 つのビジュアル ヘッダーを含むすべてを非表示にする

特定のビジュアルのヘッダーを除くレポート内のすべてのビジュアル ヘッダーを非表示にするには、次のコードを使用します。

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

複数のヘッダーを表示する場合は、このコードを拡張できます。 trueに設定 settings、visible パラメーターを使用して、IVisualHeader の追加インスタンスを設定します。 表示可能なヘッダーが必要なビジュアルごとに、1 つの IVisualHeader インスタンスを一覧に追加します。

考慮事項と制限事項

• 埋め込むレポートが表示モードの場合にのみ、ビジュアル ヘッダーの表示を制御できます。
• 非表示または表示できるのは、ビジュアルのヘッダー全体のみです。 ヘッダー メニューで特定の項目の表示を構成することはできません。
• セレクターを使用してビジュアルの名前または型を指定する場合は、Page getVisuals メソッドを使用して、一意の識別子であるビジュアルの名前を取得します。 ビジュアルのタイトルでセレクターを構成しないでください。
• API で埋め込んだレポートをユーザーが保存すると、定義したビジュアル設定がレポートに保存されます。 この状況を回避するには、Edit または Saveではなく、View のアクセス許可レベルでレポートを構成します。

関連コンテンツ

• レポート設定の構成
• セレクターを使用して、影響を受けるビジュアルを制御
• get-visuals.md