Create class

套件:

powerbi-client

Power BI 報表建立者元件

Extends

Embed

建構函式

Create(Service, HTMLElement, IEmbedConfiguration | IReportCreateConfiguration, boolean, boolean)

方法

getId()	從第一個可用位置取得數據集標識碼：createConfig 或內嵌 URL。
isSaved()	會檢查報表是否已儲存。 report.isSaved()
validate(IEmbedConfigurationBase)	驗證建立報表組態。

繼承的方法

exitFullscreen()	要求瀏覽器結束全螢幕模式。
fullscreen()	要求瀏覽器以全螢幕模式呈現元件的 iframe。
getCorrelationId()	取得目前內嵌會話的 correlationId。 // Get the correlationId for the current embed session report.getCorrelationId() .then(correlationId => { ... });
off<T>(string, IEventHandler<T>)	從處理程式清單中移除一或多個事件處理程式。 如果指定現有句柄函式的參考，請移除特定處理程式。 如果未指定處理程式，請移除指定之事件名稱的所有處理程式。 report.off('pageChanged') or const logHandler = function (event) { console.log(event); }; report.off('pageChanged', logHandler);
on<T>(string, IEventHandler<T>)	加入特定事件的事件處理程式。 report.on('pageChanged', (event) => { console.log('PageChanged: ', event.page.name); });
reload()	使用現有的組態重載內嵌。 例如，對於報表，這會有效地清除所有篩選，並讓第一頁處於作用中狀態，以模擬將報表重設為載入的狀態。 report.reload();
removeComponentTabIndex(number)	拿掉專案的 tabindex 屬性
save()	儲存報表。
saveAs(ISaveAsParameters)	SaveAs 報表。
setAccessToken(string)	設定 accessToken。
setComponentTabIndex(number)	設定專案的 tabindex 屬性
setComponentTitle(string)	設定輔助功能的元件標題。 如果是 iframe，這個方法將會變更 iframe 標題。

建構函式詳細資料

Create(Service, HTMLElement, IEmbedConfiguration | IReportCreateConfiguration, boolean, boolean)

new Create(service: Service, element: HTMLElement, config: IEmbedConfiguration | IReportCreateConfiguration, phasedRender?: boolean, isBootstrap?: boolean)

參數

service

Service

element

HTMLElement

config

IEmbedConfiguration | IReportCreateConfiguration

phasedRender

boolean

isBootstrap

boolean

方法詳細資料

getId()

從第一個可用位置取得數據集標識碼：createConfig 或內嵌 URL。

function getId(): string

傳回

string

isSaved()

會檢查報表是否已儲存。

report.isSaved()

function isSaved(): Promise<boolean>

傳回

Promise<boolean>

validate(IEmbedConfigurationBase)

驗證建立報表組態。

function validate(config: IEmbedConfigurationBase): IError[]

參數

config

IEmbedConfigurationBase

傳回

IError[]

繼承的方法的詳細資料

exitFullscreen()

要求瀏覽器結束全螢幕模式。

function exitFullscreen()

繼承自 Embed.exitFullscreen

fullscreen()

要求瀏覽器以全螢幕模式呈現元件的 iframe。

function fullscreen()

繼承自 Embed.fullscreen

getCorrelationId()

取得目前內嵌會話的 correlationId。

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });

function getCorrelationId(): Promise<string>

傳回

Promise<string>

繼承自 Embed.getCorrelationId

off<T>(string, IEventHandler<T>)

從處理程式清單中移除一或多個事件處理程式。 如果指定現有句柄函式的參考，請移除特定處理程式。 如果未指定處理程式，請移除指定之事件名稱的所有處理程式。

report.off('pageChanged')

or

const logHandler = function (event) {
   console.log(event);
};

report.off('pageChanged', logHandler);

function off<T>(eventName: string, handler?: IEventHandler<T>)

參數

eventName

string

handler

IEventHandler<T>

繼承自 Embed.off

on<T>(string, IEventHandler<T>)

加入特定事件的事件處理程式。

report.on('pageChanged', (event) => {
  console.log('PageChanged: ', event.page.name);
});

function on<T>(eventName: string, handler: IEventHandler<T>)

參數

eventName

string

handler

IEventHandler<T>

繼承自 Embed.on

reload()

使用現有的組態重載內嵌。 例如，對於報表，這會有效地清除所有篩選，並讓第一頁處於作用中狀態，以模擬將報表重設為載入的狀態。

report.reload();

function reload(): Promise<void>

傳回

Promise<void>

繼承自 Embed.reload

removeComponentTabIndex(number)

拿掉專案的 tabindex 屬性

function removeComponentTabIndex(_tabIndex?: number)

參數

_tabIndex

number

繼承自 Embed.removeComponentTabIndex

save()

儲存報表。

function save(): Promise<void>

傳回

Promise<void>

繼承自 Embed.save

saveAs(ISaveAsParameters)

SaveAs 報表。

function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>

參數

saveAsParameters

ISaveAsParameters

傳回

Promise<void>

繼承自 Embed.saveAs

setAccessToken(string)

設定 accessToken。

function setAccessToken(accessToken: string): Promise<void>

參數

accessToken

string

傳回

Promise<void>

繼承自 Embed.setAccessToken

setComponentTabIndex(number)

設定專案的 tabindex 屬性

function setComponentTabIndex(tabIndex?: number)

參數

tabIndex

number

繼承自 Embed.setComponentTabIndex

setComponentTitle(string)

設定輔助功能的元件標題。 如果是 iframe，這個方法將會變更 iframe 標題。

function setComponentTitle(title: string)

參數

title

string

繼承自 Embed.setComponentTitle