Что такое API клиента встроенной аналитики Power BI?

Кончик

Чтобы поэкспериментировать с API в режиме реального времени, используя собственный отчет или пример отчета, посетите площадки встроенной аналитики Power BI

API клиента Power BI — это клиентская библиотека, которая позволяет программно управлять внедренным содержимым Power BI с помощью JavaScript или TypeScript.

Используйте клиентские API для обмена данными между элементами Power BI (такими как отчеты и панели мониторинга) и кодом приложения. Это обеспечивает гибкость создания пользовательского интерфейса в соответствии с вашим проектом.

Как работает клиентская библиотека?

API клиента взаимодействуют с внедренным элементом Power BI, например отчетом или панелью мониторинга. Iframe создает разделение между приложением размещения и элементом Power BI, чтобы убедиться, что данные защищены.

• клиентское приложение. Снимок экрана является примером клиентского приложения.

• внедренный отчет — внедренный отчет, отображаемый в приложении.

• границы iFrame — внедренный отчет размещается в iFrame. Схема описывает ее границу.

• клиентские API. Используйте клиентские API для обмена данными между веб-приложением и внедренным компонентом. Например, при вызове report.setPage(…) активной странице отчета изменится. После изменения страницы событие pageChanged будет выдаваться отчетом, и вы можете добавить дополнительный код в обработчик событий. Дополнительные сведения см. в навигации по страницам.

Что включает этот набор документации?

В этом наборе документации перечислены API для следующих компонентов:

• powerbi-client — основная клиентская библиотека Power BI, которая включает все API клиента Power BI, кроме powerbi-report-authoring. Эта библиотека определяет классы для различных элементов Power BI, которые могут быть внедрены. Библиотека powerbi-client позволяет управлять внедренным содержимым.

• powerbi-models — содержит объектные модели для API клиента Power BI. Для каждой модели существует интерфейс TypeScript, определение схемы JSON и функция проверки, чтобы гарантировать, что данный объект является допустимой моделью.

• powerbi-report-authoring — расширение клиентской библиотеки. Эти API помогают создавать визуальные элементы и создавать отчет после загрузки. Библиотека powerbi-report-authoring позволяет программным способом изменять внедренные отчеты.

В наборе документации также содержатся статьи, которые объясняют, как использовать API, а также примеры кода. Статьи разделены на следующие разделы:

• обзор . Дополнительные сведения об встроенной аналитике Power BI.

• детская площадка демонстрирует. Узнайте, как быстро использовать встроенную аналитику в приложениях с помощью игровой площадки встроенной аналитики Power BI.

• начало внедрения. Узнайте, как внедрить каждый из элементов Power BI, таких как отчеты и панели мониторинга.

• основные понятия. Узнайте о некоторых понятиях, с которыми должен ознакомиться каждый разработчик.

• отчета, внедряющего. Дополнительные понятия внедрения применимы только для отчетов.

• операции с отчетами — настройте внедренный отчет, чтобы обеспечить более удобный пользовательский интерфейс для клиентов.

• Внедрение отчетов для вашей организации . Создавайте более внедренные отчеты при внедрении с помощью внедрения решения организации.

• создание отчетов . Статьи, посвященные API-интерфейсов powerbi-report-authoring, что позволяет создавать и персонализировать визуализации после загрузки отчета.

Запись ресурсов включает ресурсы, полезные для разработчиков Power BI.

Заметка

Рекомендуется ознакомиться с этими статьями при эксперименте с платформы встроенной аналитики Power BI.

Связанное содержимое

• Понимание различных решений внедрения
• встроенной аналитики Power BI