提示
若要使用自己的报表或示例报表实时试验 API,请访问 Power BI 嵌入式分析操场
Power BI 客户端 API 是一个客户端库,可用于使用 JavaScript 或 TypeScript 以编程方式控制嵌入式 Power BI 内容。
使用客户端 API 在 Power BI 项(如报表和仪表板)与应用程序代码之间进行通信。 这样可以灵活地根据设计构建最终用户体验。
客户端库的工作原理是什么?
客户端 API 与嵌入式 Power BI 项(例如报表或仪表板)通信。 iframe 在托管应用和 Power BI 项之间创建分隔,确保数据受到保护。
客户端应用程序 - 整个屏幕截图是客户端应用程序的示例。
嵌入报表 - 应用程序中当前显示的嵌入报表。
iFrame 边界 - 嵌入报表托管在 iFrame 内。 此图概述了其边界。
客户端 API - 使用客户端 API 在 Web 应用程序和嵌入式组件之间通信。 例如,调用
report.setPage(…)
报表的活动页将更改。 更改页面后,报表将发出 pageChanged 事件,你可以在事件处理程序中添加其他代码。 有关详细信息,请参阅 页面导航。
本文档集包括哪些内容?
本文档集列出了以下组件的 API:
powerbi-client - 主 Power BI 客户端库,其中包括除 powerbi-report-authoring之外的所有 Power BI 客户端 API。 此库定义可嵌入的不同 Power BI 项的类。 powerbi-client 库允许你控制要嵌入的内容。
powerbi 模型 - 包含 Power BI 客户端 API 的对象模型。 对于每个模型,都有一个 TypeScript 接口、一个 JSON 架构定义和一个验证函数,以确保给定对象是有效的模型。
powerbi-report-authoring - 客户端库的扩展。 这些 API 有助于在加载报表后创建视觉对象和创作报表。 powerbi-report-authoring 库允许以编程方式编辑嵌入的报表。
文档集还包括介绍如何使用 API 以及代码示例的文章。 这些文章分为以下部分:
概述 - 有关 Power BI 嵌入式分析的其他信息。
Playground 展示 - 了解如何使用 Power BI 嵌入式分析操场快速在应用中使用嵌入式分析。
开始嵌入 - 了解如何嵌入每个 Power BI 项,例如报表和仪表板。
基本概念 - 了解每个开发人员应熟悉的一些概念。
报表嵌入 - 其他嵌入概念仅适用于报表。
报表操作 - 调整嵌入报表,以便为客户提供更好的用户体验。
为组织嵌入报表 - 在为组织 解决方案嵌入嵌入时创建更好的嵌入报表。 报表创作 - 专用于 powerbi-report 创作 API 的文章,允许在加载报表后创建和个性化可视化效果。
资源 项包括对 Power BI 开发人员有用的资源。
注意
建议在试验 Power BI 嵌入式分析操场时查看这些文章。