次の方法で共有

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

  • [アーティクル]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

優先順位の規則

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

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

ビジュアルに複数の設定を適用できる場合、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);

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

制限事項

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

次のステップ

レポート設定の構成

セレクターを使用して、影響を受けるビジュアルを制御する

get-visuals.md