嵌入报告
- 版本 :2023.1(当前版本)
嵌入报告
提示
尝试在Power BI Embedded Analytics Playground的探索我们的 API部分中嵌入报告或使用我们的客户端 API 进行试验。
本文介绍了在应用程序中嵌入 Power BI 报表的步骤。在 Power BI 的报表中了解有关报表的更多信息。
如何嵌入报告
在应用中嵌入 Power BI 内容时,可以使用配置对象来定义要嵌入的内容并指定内容的设置。然后将该对象传递给 API。有关详细信息,请参阅配置报告设置。
嵌入现有报告
嵌入已存在的报告时,请使用IReportLoadConfiguration类型的配置对象。
打字稿复制
interface IReportLoadConfiguration {
accessToken: string;
bookmark?: models.IApplyBookmarkRequest;
contrastMode?: models.ContrastMode;
datasetBinding?: models.IDatasetBinding;
embedUrl?: string;
filters?: models.ReportLevelFilters[];
id: string;
pageName?: string;
permissions?: models.Permissions;
settings?: models.IEmbedSettings;
slicers?: models.ISlicer[];
theme?: models.IReportTheme;
tokenType?: models.TokenType; type: string;
viewMode?: models.ViewMode;
}
该接口包括以下属性:
accessToken
- 使你能够访问你嵌入的 Power BI 数据的令牌。请参阅了解不同的嵌入解决方案以了解有关访问令牌的更多信息。datasetBinding
- 定义嵌入式报表使用的数据模式的数据集。有关数据集的更多信息,请参阅将数据集动态绑定到报表。embedUrl
- 您要嵌入的报告的 URL。此 URL 成为iframe
包含嵌入式报告的 HTML 元素的来源。具体来说,API 将 URL 分配src
给iframe
. 您可以使用报告 API来获取此 URL。两个例子是:报告 - 在组中获取报告
报告 - 在组中获取报告
id
- 您要嵌入的 Power BI 报表的 ID。permissions
- 您授予用户的嵌入式报表操作。这些值可用:Read
- 用户可以查看报告。ReadWrite
- 用户可以查看、编辑和保存报告。Copy
- 用户可以使用另存为来保存报告的副本。Create
- 用户可以创建新报告。All
- 用户可以创建、查看、编辑、保存和保存报告的副本。tokenType
- 允许您访问您嵌入的 Power BI 数据的令牌类型。有关详细信息,请参阅了解不同的嵌入解决方案。
如果
models.TokenType.Aad
您要为您的组织嵌入(用户拥有数据),请使用。如果
models.TokenType.Embed
您要为客户嵌入(应用程序拥有数据),请使用。type
- 您要嵌入的内容类型。用于'report'
Power BI 报告。
该IReportLoadConfiguration
接口还包含其他属性。有关这些属性的信息,请参阅配置报告设置:
bookmark
contrastMode
filters
pageName
settings
slicers
theme
viewMode
嵌入新报告
当您嵌入从数据集创建的新报表时,请使用 类型的配置对象IReportCreateConfiguration
。
打字稿复制
interface IReportCreateConfiguration {
accessToken: string;
datasetId: string;
embedUrl?: string;
settings?: models.IEmbedSettings;
theme?: IReportTheme;
tokenType?: models.TokenType; type: string;
}
此界面中的属性与IReportLoadConfiguration
界面中的属性类似,但有以下不同:
datasetId
- 定义新报告使用的数据模式的数据集的 ID。embedUrl
- 定义新报告使用的数据模式的数据集的 URL。此 URL 成为iframe
包含嵌入式报告的 HTML 元素的来源。具体来说,API 将 URL 分配src
给iframe
. 您可以使用数据集 API来获取此 URL。两个例子是:数据集 - 获取分组中的数据集
数据集 - 获取组中的数据集
有关编辑和创建报告的信息,请参阅创建、编辑和保存嵌入式报告。
例子
以下示例显示了如何嵌入报告:
Javascript复制
// Set up the configuration object that determines what to embed and how to embed it.let embedConfiguration = { accessToken: anAccessToken, embedUrl: anEmbedUrl, id: aReportId, permissions: somePermissions, tokenType: aTokenType, type: 'report'};
// Get a reference to the HTML element that contains the embedded report.let embedContainer = $('#embedContainer')[0];
// Embed the report.let report = powerbi.embed(embedContainer, embedConfiguration);