Service class

router: Router

Property Value

Given an HTML element and entityType, creates a new component instance, and bootstrap the iframe for embedding.

function bootstrap(element: HTMLElement, config: any): Embed

Parameters

Returns

Creates new report

function createReport(element: HTMLElement, config?: any): Embed

Parameters

Returns

Given a configuration based on an HTML element, if the component has already been created and attached to the element, reuses the component instance and existing iframe, otherwise creates a new component instance.

function embed(element: HTMLElement, config?: any): Embed

Parameters

Returns

Returns an instance of the component associated with the element.

function get(element: HTMLElement): Embed

Parameters

Returns

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

Parameters

Returns

Given a configuration based on an HTML element, if the component has already been created and attached to the element, reuses the component instance and existing iframe, otherwise creates a new component instance. This is used for the phased embedding API, once element is loaded successfully, one can call 'render' on it.

function load(element: HTMLElement, config?: any): Embed

Parameters

Returns

API for warm starting powerbi embedded endpoints. Use this API to preload Power BI Embedded in the background.

function preload(config?: any, element?: HTMLElement): HTMLIFrameElement

Parameters

Returns

Creates new dataset

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

Parameters

Returns

Given an HTML element that has a component embedded within it, removes the component from the list of embedded components, removes the association between the element and the component, and removes the iframe.

function reset(element: HTMLElement)

Parameters