Service class

パッケージ:

powerbi-client

Power BI サービス埋め込みコンポーネント。これは、他のすべての Power BI コンポーネントをアプリケーションに埋め込むエントリ ポイントです

プロパティ

router

メソッド

bootstrap(HTMLElement, IBootstrapEmbedConfiguration | IComponentEmbedConfiguration)	HTML 要素と entityType を指定すると、新しいコンポーネント インスタンスが作成され、埋め込み用に iframe がブートストラップされます。
createReport(HTMLElement, IEmbedConfiguration | IReportCreateConfiguration)	新しいレポートを作成します
embed(HTMLElement, IEmbedConfigurationBase | IComponentEmbedConfiguration)	HTML 要素に基づく構成を指定すると、コンポーネントが既に作成され、要素にアタッチされている場合は、コンポーネント インスタンスと既存の iframe を再利用し、それ以外の場合は新しいコンポーネント インスタンスを作成します。
get(HTMLElement)	要素に関連付けられているコンポーネントのインスタンスを返します。
invokeSDKHook(Function, IExtendedRequest, Response)
load(HTMLElement, IEmbedConfigurationBase | IComponentEmbedConfiguration)	HTML 要素に基づく構成を指定すると、コンポーネントが既に作成され、要素にアタッチされている場合は、コンポーネント インスタンスと既存の iframe を再利用し、それ以外の場合は新しいコンポーネント インスタンスを作成します。 これは、段階的埋め込み API に使用されます。要素が正常に読み込まれたら、その要素に対して 'render' を呼び出すことができます。
preload(IEmbedConfigurationBase | IComponentEmbedConfiguration, HTMLElement)	ウォーム開始 powerbi 埋め込みエンドポイント用の API。 この API を使用して、Power BI Embedded をバックグラウンドでプリロードします。
quickCreate(HTMLElement, IQuickCreateConfiguration)	新しいデータセットを作成します
reset(HTMLElement)	コンポーネントが埋め込まれている HTML 要素を指定すると、埋め込みコンポーネントの一覧からコンポーネントを削除し、要素とコンポーネントの間の関連付けを削除して、iframe を削除します。

プロパティの詳細

router

router: Router

プロパティ値

Router

メソッドの詳細

bootstrap(HTMLElement, IBootstrapEmbedConfiguration | IComponentEmbedConfiguration)

HTML 要素と entityType を指定すると、新しいコンポーネント インスタンスが作成され、埋め込み用に iframe がブートストラップされます。

function bootstrap(element: HTMLElement, config: IBootstrapEmbedConfiguration | IComponentEmbedConfiguration): Embed

パラメーター

element

HTMLElement

config

IBootstrapEmbedConfiguration | IComponentEmbedConfiguration

戻り値

Embed

createReport(HTMLElement, IEmbedConfiguration | IReportCreateConfiguration)

新しいレポートを作成します

function createReport(element: HTMLElement, config?: IEmbedConfiguration | IReportCreateConfiguration): Embed

パラメーター

element

HTMLElement

config

IEmbedConfiguration | IReportCreateConfiguration

戻り値

Embed

embed(HTMLElement, IEmbedConfigurationBase | IComponentEmbedConfiguration)

HTML 要素に基づく構成を指定すると、コンポーネントが既に作成され、要素にアタッチされている場合は、コンポーネント インスタンスと既存の iframe を再利用し、それ以外の場合は新しいコンポーネント インスタンスを作成します。

function embed(element: HTMLElement, config?: IEmbedConfigurationBase | IComponentEmbedConfiguration): Embed

パラメーター

element

HTMLElement

config

IEmbedConfigurationBase | IComponentEmbedConfiguration

戻り値

Embed

get(HTMLElement)

要素に関連付けられているコンポーネントのインスタンスを返します。

function get(element: HTMLElement): Embed

パラメーター

element

HTMLElement

戻り値

Embed

invokeSDKHook(Function, IExtendedRequest, Response)

function invokeSDKHook(hook: Function, req: IExtendedRequest, res: Response): Promise<void>

パラメーター

hook

Function

req

IExtendedRequest

res

Response

戻り値

Promise<void>

load(HTMLElement, IEmbedConfigurationBase | IComponentEmbedConfiguration)

HTML 要素に基づく構成を指定すると、コンポーネントが既に作成され、要素にアタッチされている場合は、コンポーネント インスタンスと既存の iframe を再利用し、それ以外の場合は新しいコンポーネント インスタンスを作成します。 これは、段階的埋め込み API に使用されます。要素が正常に読み込まれたら、その要素に対して 'render' を呼び出すことができます。

function load(element: HTMLElement, config?: IEmbedConfigurationBase | IComponentEmbedConfiguration): Embed

パラメーター

element

HTMLElement

config

IEmbedConfigurationBase | IComponentEmbedConfiguration

戻り値

Embed

preload(IEmbedConfigurationBase | IComponentEmbedConfiguration, HTMLElement)

ウォーム開始 powerbi 埋め込みエンドポイント用の API。 この API を使用して、Power BI Embedded をバックグラウンドでプリロードします。

function preload(config?: IEmbedConfigurationBase | IComponentEmbedConfiguration, element?: HTMLElement): HTMLIFrameElement

パラメーター

config

IEmbedConfigurationBase | IComponentEmbedConfiguration

element

HTMLElement

戻り値

HTMLIFrameElement

quickCreate(HTMLElement, IQuickCreateConfiguration)

新しいデータセットを作成します

function quickCreate(element: HTMLElement, config?: IQuickCreateConfiguration): Embed

パラメーター

element

HTMLElement

config

IQuickCreateConfiguration

戻り値

Embed

reset(HTMLElement)

コンポーネントが埋め込まれている HTML 要素を指定すると、埋め込みコンポーネントの一覧からコンポーネントを削除し、要素とコンポーネントの間の関連付けを削除して、iframe を削除します。

function reset(element: HTMLElement)

パラメーター

element

HTMLElement