共用方式為


使用啟動程式以提升效能

powerbi.bootstrap 是用戶端 SDK 2.9.0 版中引進的方法,可協助開發人員更快內嵌 Power BI 實體並取得更好的效能。

使用 powerbi.embed 內嵌報表需要多個參數,例如 reportIdembedURLaccessToken。 這些參數不一定可以立即使用。

powerbi.bootstrap 可讓您開始內嵌,才能使用所有必要的參數。 啟動程式 API 會準備並初始化 iframe。

收到必要的參數之後,應該在同一個 HTML 元素上呼叫 powerbi.embed(element, config)

啟動程式 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;
}

設定參數:

  • 類型(必要):您想要內嵌的實體類型,例如 'report'、'dashboard'、'tile'、'qna'或 'visual'。
  • 主機名:如果您還沒有 embedURL,則可以提供主機名。 主機名是內嵌 URL 的功能變數名稱。 例如,如果內嵌 URL 是 'https://app.powerbi.com/reportEmbed',則主機名是 'https://app.powerbi.com/'。 如果未提供主機名稱或 embedUrl,則會使用預設主機名 https://app.powerbi.com/
  • embedUrl:您稍後會提供給 powerbi.embed 的相同內嵌 URL。 如果未提供主機名稱或 embedUrl,則會使用預設主機名 https://app.powerbi.com/
  • 設定:若要在行動版面配置中內嵌報表,或提供地區設定(語言),請在初始設定中包含這些參數。

啟動程式範例

下列範例提供內嵌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 方法。