Guía de la API HTML de PyGWalker
PyGWalker te permite renderizar la interfaz de Graphic Walker en cualquier aplicación que soporte la renderización HTML. Esta guía explica cómo usar la API HTML de manera efectiva.
Nota Importante
La API HTML actual está diseñada solo para cálculos en el frontend. Puede que no sea adecuada para conjuntos de datos grandes debido a limitaciones de rendimiento.
Uso de to_html()
La función to_html() es el método principal para generar salida HTML desde tu DataFrame.
Uso Básico
import pygwalker as pyg
import pandas as pd
df = pd.read_csv('data.csv')
html_str = pyg.to_html(df)Parámetros de la Función
| Parámetro | Tipo | Predeterminado | Descripción |
|---|---|---|---|
| dataset | DataFrame | - | El DataFrame de entrada. Ver Dataset Of Walker para más detalles. |
| gid | Unión[int, str] | None | ID para el div contenedor de GraphicWalker. Formato: 'gwalker-{gid}'. Auto-generado si es None. |
| field_specs | Opcional[Dict[str, FieldSpec]] | None | Especificaciones de campo. Inferido automáticamente del dataset si no se especifica. |
| theme_key | Literal['vega', 'g2'] | 'g2' | Tipo de tema para GraphicWalker. |
| appearance | Literal['media', 'light', 'dark'] | 'media' | Configuración de tema. 'media' detecta automáticamente el tema del sistema operativo. |
| spec | str | "" | Datos de configuración del gráfico. Puede ser un ID de configuración, JSON, o URL de archivo remoto. |
| default_tab | Literal["data", "vis"] | "vis" | Pestaña predeterminada al cargar la interfaz. |
| **kwargs | Any | - | Argumentos adicionales. |
Ejemplos
Exportando a un Archivo HTML
Puedes guardar el HTML generado en un archivo para su uso posterior o compartirlo:
import pandas as pd
import pygwalker as pyg
df = pd.read_csv('data.csv')
with open("pygwalker_demo.html", "w", encoding="utf-8") as f:
f.write(pyg.to_html(df))Usando PyGWalker con Shiny
PyGWalker puede integrarse en aplicaciones de Shiny. Para una guía detallada y un ejemplo, consulta nuestro tutorial de integración con Shiny.
Mejores Prácticas
- Consideraciones de Rendimiento: Ten en cuenta el tamaño del conjunto de datos al usar la API HTML, ya que procesa datos en el lado del cliente.
- Personalización: Utiliza el parámetro
field_specspara ajustar cómo se interpreta y muestra tu data. - Tematización: Experimenta con diferentes configuraciones de
theme_keyyappearancepara que coincidan con la apariencia de tu aplicación. - Integración: Al integrar con marcos web como Shiny, asegúrate de manejar la salida HTML adecuadamente dentro de la estructura de tu aplicación.
Para un uso más avanzado y ejemplos de integración, consulta la documentación de PyGWalker.