Share via

ControlAddIn PowerBIManagement

Namespace: System.Integration.PowerBI

Methods

SetToken

Initializes the token to be used when embedding Power BI content

procedure SetToken(AuthToken: Text)

Parameters

Name Type Description
AuthToken Text

EmbedPowerBIReport

Initializes the Power BI embed Report into the page

procedure EmbedPowerBIReport(ReportLink: Text, ReportId: Text, PageName: Text)

Parameters

Name Type Description
ReportLink Text
ReportId Text
PageName Text

EmbedPowerBIDashboard

Initializes the Power BI embed Dashboard into the page

procedure EmbedPowerBIDashboard(DashboardLink: Text, DashboardId: Text)

Parameters

Name Type Description
DashboardLink Text
DashboardId Text

EmbedPowerBIDashboardTile

Initializes the Power BI embed Dashboard Tile into the page

procedure EmbedPowerBIDashboardTile(DashboardTileLink: Text, DashboardId: Text, TileId: Text)

Parameters

Name Type Description
DashboardTileLink Text
DashboardId Text
TileId Text

EmbedPowerBIReportVisual

Initializes the Power BI embed Report Visual into the page

procedure EmbedPowerBIReportVisual(ReportVisualLink: Text, ReportId: Text, PageName: Text, VisualName: Text)

Parameters

Name Type Description
ReportVisualLink Text
ReportId Text
PageName Text
VisualName Text

FullScreen

Enters full screen mode for the current embed

procedure FullScreen()

UpdateReportFilters

Updates the report filters with the provided new filters

procedure UpdateReportFilters(Filters: Text)

Parameters

Name Type Description
Filters Text

Remarks

The new filters will replace any existing report filter for the same table columns

RemoveReportFilters

Removes the current report level filters

procedure RemoveReportFilters()

UpdatePageFilters

Updates the page filters with the provided new filters

procedure UpdatePageFilters(Filters: Text)

Parameters

Name Type Description
Filters Text

Remarks

The new filters will replace any existing page filter for the same table columns

RemovePageFilters

Removes the current page level filters

procedure RemovePageFilters()

SetPage

Changes the active page of the report

procedure SetPage(PageName: Text)

Parameters

Name Type Description
PageName Text

The name of the new page to set as active

SetLocale

Changes the locale used to render the embedded element. If not specified, it will use the default Power BI language.

procedure SetLocale(NewLocale: Text)

Parameters

Name Type Description
NewLocale Text

The locale to use, for example "en-us".

SetBookmarksVisible

Controls whether the bookmark selection pane will be visible in the embed experience. Defaults to false.

procedure SetBookmarksVisible(Visible: Boolean)

Parameters

Name Type Description
Visible Boolean

Whether bookmarks should be visible.

SetFiltersVisible

Controls whether the filter pane will be visible in the embed experience. Defaults to false.

procedure SetFiltersVisible(Visible: Boolean)

Parameters

Name Type Description
Visible Boolean

Whether filters should be visible.

SetPageSelectionVisible

Controls whether the page selection bar will be visible in the embed experience. Defaults to false.

procedure SetPageSelectionVisible(Visible: Boolean)

Parameters

Name Type Description
Visible Boolean

Whether page selection should be visible.

SetTransparentBackground

Controls whether the report background should be set to transparent regardless of the actual color. Defaults to false.

procedure SetTransparentBackground(Transparent: Boolean)

Parameters

Name Type Description
Transparent Boolean

AddBottomPadding

Controls whether the addin includes a bottom padding that makes it look nicer in some embedded scenarios. Defaults to false.

procedure AddBottomPadding(AddPadding: Boolean)

Parameters

Name Type Description
AddPadding Boolean

Whether the bottom padding should be added.

SetSettings

Obsolete

This element will become obsolete from version 26.0. Use SetBookmarksVisible, SetFiltersVisible, AddBottomPadding, SetTransparentBackground, and SetPageSelectionVisible instead. The other options are no longer supported.

Sets the properties for the embed experience

[Obsolete(Use SetBookmarksVisible, SetFiltersVisible, AddBottomPadding, SetTransparentBackground, and SetPageSelectionVisible instead. The other options are no longer supported.,26.0)]
procedure SetSettings(ShowBookmarkSelection: Boolean, ShowFilters: Boolean, ShowPageSelection: Boolean, ShowZoomBar: Boolean, ForceTransparentBackground: Boolean, ForceFitToPage: Boolean, AddBottomPadding: Boolean)

Parameters

Name Type Description
ShowBookmarkSelection Boolean

Shows the bookmark selection pane.
ShowFilters Boolean

Shows the bookmark selection pane.
ShowPageSelection Boolean

Shows the pane to select the report page.
ShowZoomBar Boolean

Shows the bookmark selection pane.
ForceTransparentBackground Boolean

Forces a transparent background to the embed.
ForceFitToPage Boolean

Forces the Fit To Page behaviour for the embed.
AddBottomPadding Boolean

Controls whether a padding is needed on the bottom of the page (useful in case the embed is the only element displayed on the page).

InitializeFrame

Obsolete

This element will become obsolete from version 25.0. Use SetSettings, SetToken and then EmbedReport instead.

Sets the properties for the browser frame containing the embed

[Obsolete(Use SetSettings, SetToken and then EmbedReport instead.,25.0)]
procedure InitializeFrame(FullPage: Boolean, Ratio: Text)

Parameters

Name Type Description
FullPage Boolean
Ratio Text

InitializeReport

Obsolete

This element will become obsolete from version 24.0. Use SetSettings, SetToken and then EmbedReport instead.

Initializes the Power BI Embed into the page

[Obsolete(Use SetSettings, SetToken and then EmbedReport instead.,24.0)]
procedure InitializeReport(ReportLink: Text, ReportId: Text, AuthToken: Text, PowerBIApi: Text)

Parameters

Name Type Description
ReportLink Text
ReportId Text
AuthToken Text
PowerBIApi Text

EmbedReportWithOptions

Obsolete

This element will become obsolete from version 25.0. Use SetSettings, SetToken and then EmbedReport instead.

Initializes the Power BI embed Report into the page, with additional options

[Obsolete(Use SetSettings, SetToken and then EmbedReport instead.,25.0)]
procedure EmbedReportWithOptions(ReportLink: Text, ReportId: Text, AuthToken: Text, PageName: Text, ShowPanes: Boolean)

Parameters

Name Type Description
ReportLink Text
ReportId Text
AuthToken Text
PageName Text
ShowPanes Boolean

ViewMode

Obsolete

This element will become obsolete from version 25.0. Switching between edit more and view mode is no longer supported. Only view mode will be supported going forward.

Changes the current mode into View

[Obsolete(Switching between edit more and view mode is no longer supported. Only view mode will be supported going forward.,25.0)]
procedure ViewMode()

EditMode

Obsolete

This element will become obsolete from version 25.0. Switching between edit more and view mode is no longer supported. Only view mode will be supported going forward.

Changes the current mode into Edit

[Obsolete(Switching between edit more and view mode is no longer supported. Only view mode will be supported going forward.,25.0)]
procedure EditMode()

EmbedReport

Obsolete

This element will become obsolete from version 25.0. Call the procedure SetToken, and then use EmbedPowerBIReport instead.

Initializes the Power BI embed Report into the page

[Obsolete(Call the procedure SetToken, and then use EmbedPowerBIReport instead.,25.0)]
procedure EmbedReport(ReportLink: Text, ReportId: Text, AuthToken: Text, PageName: Text)

Parameters

Name Type Description
ReportLink Text
ReportId Text
AuthToken Text
PageName Text

EmbedDashboard

Obsolete

This element will become obsolete from version 25.0. Call the procedure SetToken, and then use EmbedPowerBIDashboard instead.

Initializes the Power BI embed Dashboard into the page

[Obsolete(Call the procedure SetToken, and then use EmbedPowerBIDashboard instead.,25.0)]
procedure EmbedDashboard(DashboardLink: Text, DashboardId: Text, AuthToken: Text)

Parameters

Name Type Description
DashboardLink Text
DashboardId Text
AuthToken Text

EmbedDashboardTile

Obsolete

This element will become obsolete from version 25.0. Call the procedure SetToken, and then use the EmbedPowerBIDashboardTile instead.

Initializes the Power BI embed Dashboard Tile into the page

[Obsolete(Call the procedure SetToken, and then use the EmbedPowerBIDashboardTile instead.,25.0)]
procedure EmbedDashboardTile(DashboardTileLink: Text, DashboardId: Text, TileId: Text, AuthToken: Text)

Parameters

Name Type Description
DashboardTileLink Text
DashboardId Text
TileId Text
AuthToken Text

EmbedReportVisual

Obsolete

This element will become obsolete from version 25.0. Call the procedure SetToken, and then use EmbedPowerBIReportVisual instead.

Initializes the Power BI embed Report Visual into the page

[Obsolete(Call the procedure SetToken, and then use EmbedPowerBIReportVisual instead.,25.0)]
procedure EmbedReportVisual(ReportVisualLink: Text, ReportId: Text, PageName: Text, VisualName: Text, AuthToken: Text)

Parameters

Name Type Description
ReportVisualLink Text
ReportId Text
PageName Text
VisualName Text
AuthToken Text

See also