Nota
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Propina
Para experimentar con las API en tiempo real, con su propio informe o un informe de ejemplo, visite el área de juegos de análisis insertado de Power BI
La API de cliente de Power BI es una biblioteca del lado cliente que permite controlar mediante programación el contenido insertado de Power BI mediante JavaScript o TypeScript.
Use las API de cliente para comunicarse entre elementos de Power BI (como informes y paneles) y el código de la aplicación. Esto le ofrece la flexibilidad de crear una experiencia de usuario final de acuerdo con el diseño.
¿Cómo funciona la biblioteca cliente?
Las API de cliente se comunican con un elemento de Power BI incrustado, como un informe o un panel. El iframe crea una separación entre la aplicación de hospedaje y el elemento de Power BI, asegurándose de que los datos están protegidos.
aplicación cliente: la captura de pantalla completa es un ejemplo de una aplicación cliente.
informe insertado: el informe incrustado que se muestra actualmente en la aplicación.
límite de iFrame: el informe incrustado se hospeda dentro de un iFrame. El diagrama describe su límite.
API de cliente: use las API de cliente para comunicarse entre la aplicación web y el componente incrustado. Por ejemplo, al llamar a
report.setPage(…)se cambiará la página activa del informe. Después de cambiar la página, el informe emitirá un evento pageChanged y puede agregar código adicional en el controlador de eventos. Para obtener más información, vea de navegación de página.
¿Qué incluye este conjunto de documentación?
En este conjunto de documentación se enumeran las API de los siguientes componentes:
powerbi-client: la biblioteca cliente principal de Power BI que incluye todas las API de cliente de Power BI, excepto powerbi-report-authoring. Esta biblioteca define las clases de los distintos elementos de Power BI que se pueden insertar. La biblioteca powerbi-client
permite controlar el contenido que va a insertar. powerbi-models: contiene los modelos de objetos para las API de cliente de Power BI. Para cada modelo hay una interfaz typeScript, una definición de esquema JSON y una función de validación para asegurarse de que un objeto determinado es un modelo válido.
powerbi-report-authoring: extensión de la biblioteca cliente. Estas API ayudan a crear objetos visuales y a crear el informe después de cargarlo. La biblioteca de powerbi-report-authoring permite editar los informes insertados mediante programación.
El conjunto de documentación también incluye artículos que explican cómo usar las API, junto con ejemplos de código. Los artículos se dividen en las secciones siguientes:
Información general: información adicional sobre el análisis insertado de Power BI.
Playground muestra: aprenda a usar análisis insertados en las aplicaciones rápidamente mediante el área de juegos de análisis insertado de Power BI.
Iniciar inserción: aprenda a insertar cada uno de los elementos de Power BI, como informes y paneles.
conceptos básicos: obtenga información sobre algunos de los conceptos con los que todos los desarrolladores deben estar familiarizados.
inserción de informes: conceptos de inserción adicionales aplicables solo a los informes.
Operaciones de informes: ajuste el informe insertado para que proporcione una mejor experiencia de usuario para sus clientes.
Insertar informes para la organización: cree mejores informes insertados al insertar mediante la inserción de para su organización solución.
creación de informes : artículos dedicados a las API de powerbi-report-authoring, lo que le permite crear y personalizar visualizaciones después de cargar el informe.
La entrada Recursos incluye recursos útiles para desarrolladores de Power BI.
Nota
Se recomienda revisar estos artículos al experimentar con la área de juegos de análisis insertado de Power BI.