Page interface

Package:

powerbi-report-authoring

Power BI report page component

Methods

createVisual(Page, string, IVisualLayout, boolean)	Creates an empty visual of a specific type. IMPORTANT: Visuals which are not installed in visualization pane cannot be added. This is true for custom visuals that are not installed and native visuals that were uninstalled.
deleteVisual(Page, string)	Deletes a visual by a visual name.

Method Details

createVisual(Page, string, IVisualLayout, boolean)

Creates an empty visual of a specific type. IMPORTANT: Visuals which are not installed in visualization pane cannot be added. This is true for custom visuals that are not installed and native visuals that were uninstalled.

function createVisual(this: Page, visualType: string, layout?: IVisualLayout, autoFocus?: boolean): Promise<IVisualResponse>

Parameters

this

Page

visualType

string

The type of the visual to create.

layout

IVisualLayout

– Optional. The layout which will be applied to the new visual. Default: a best effort to put a new visual in an empty space on the canvas.

autoFocus

boolean

– Optional. Focus on the new visual after creation.

Returns

Promise<IVisualResponse>

deleteVisual(Page, string)

Deletes a visual by a visual name.

function deleteVisual(this: Page, visualName: string): Promise<void>

Parameters

this

Page

visualName

string

– The name of the visual to delete.

Returns

Promise<void>