パフォーマンスを向上させるためにブートストラップを使用する

[アーティクル]
05/22/2023

powerbi.bootstrap は、開発者が Power BI エンティティをより迅速に埋め込み、パフォーマンスを向上させるために、クライアント SDK バージョン 2.9.0 で導入されたメソッドです。

を使用してpowerbi.embedレポートを埋め込むには、などのembedURLreportIdaccessToken複数のパラメーターが必要です。これらのパラメーターは、常にすぐに使用できるわけではありません。

powerbi.bootstrap では、必要なすべてのパラメーターが使用可能になる前に埋め込みを開始できます。ブートストラップ API により、iframe の準備と初期化が実行されます。

必要なパラメーターを受信した後、 powerbi.embed(element, config) 同じ HTML 要素でを呼び出す必要があります。

ブートストラップ API

メソッドは powerbi.bootstrap(element, config) 、と同じ powerbi.embed(...)要素と構成を受け取ります。

/**
    * Given an HTML element and entityType, creates a new component instance, and bootstrap the iframe for embedding.
    *
    * @param {HTMLElement} an HTML Element where you need to embed. must be the same div element you will use in powerbi.embed.
    * @param {IBootstrapEmbedConfiguration} config: a bootstrap config.
    */
bootstrap(element: HTMLElement, config: IBootstrapEmbedConfiguration): embed.Embed;

ブートストラップ埋め込み構成

interface IBootstrapEmbedConfiguration {
  type: string;
  hostname?: string;
  embedUrl?: string;
  settings?: ISettings;
}

構成パラメーター:

type (必須): 埋め込むエンティティの種類 ('report'、'dashboard'、'tile'、'qna'、'visual' など)。
hostname: まだを持っていない場合は embedURL 、ホスト名を指定できます。ホスト名は埋め込み URL のドメイン名です。たとえば、埋め込み URL が '' のhttps://app.powerbi.com/reportEmbed場合、ホスト名は 'https://app.powerbi.com/' になります。 hostname または embedUrl が指定されていない場合は、既定のホスト名 https://app.powerbi.com/であるが使用されます。
embedUrl: 後で powerbi.embed に提供するのと同じ埋め込み URL。 hostname または embedUrl が指定されていない場合は、既定のホスト名 https://app.powerbi.com/であるが使用されます。
settings: モバイルレイアウトにレポートを埋め込むか、ロケール (言語) を指定するには、これらのパラメーターを初期設定に含めます。

ブートストラップのサンプル

次のサンプルでは、Power BI エンティティを埋め込むときにブートストラップメソッドのリファレンスを提供します。

注意

埋め込みパラメーターを受け取った後、必ずを呼び出 powerbi.embed してください。

レポートを埋め込むためのブートストラップを実行するには:

powerbi.bootstrap(
        reportContainerDivElement,
        {
            type: 'report',
        }
    );

ダッシュボードを埋め込むためのブートストラップを実行するには:

powerbi.bootstrap(
        reportContainerDivElement,
        {
            type: 'dashboard',
            embedUrl: "https://app.powerbi.com/dashboardEmbed?dashboardId=06e3ba63-47ea-4579-b010-fdb5484b325a&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6mLndpbmRvd3MubmV0In0="
        }
    );

ホスト名のみを使用してレポートを埋め込むためのブートストラップを行う場合:

powerbi.bootstrap(
        reportContainerDivElement,
        {
            type: 'report',
            hostname: "https://app.powerbi.com"
        }
    );

モバイルレイアウトでレポートを埋め込むためのブートストラップを実行するには:

powerbi.bootstrap(
        reportContainerDivElement,
        {
            type: 'report',
            hostname: "https://app.powerbi.com",
            settings: {
	            layoutType: models.LayoutType.MobilePortrait
            }
        }
    );

制限事項

次のブートストラップされたエンティティは、を呼び出 powerbi.reset(element)さないと変更できません。
- コンポーネントの種類 (レポート、ダッシュボード): たとえば、レポートをブートストラップする場合、同じ HTML 要素にのみレポートを埋め込むことができます。
- レイアウト (デスクトップ/モバイル)
- ロケール (言語)
ページ分割されたレポートを埋め込む場合、powerbi.bootstrap メソッドはサポートされません。

パフォーマンスを向上させるためにブートストラップを使用する

ブートストラップ API

ブートストラップ埋め込み構成

ブートストラップのサンプル

制限事項

次のステップ

その他のリソース