Skip to content
PYGWALKER
Referencia de API
API de componentes

API de componentes de PyGWalker

Usa pygwalker.component(...) cuando quieras crear gráficos de PyGWalker con cadenas de métodos en Python en lugar de usar solo el explorador de arrastrar y soltar.

import pygwalker as pyg
 
chart = (
    pyg.component(df, spec_path="./gw_config.json", computation="browser")
    .bar()
    .encode(x="category", y="sum(revenue)", color="region")
    .layout(width=720, height=420)
)
 
html = chart.to_html()

Factory

pyg.component(
    dataset,
    *,
    field_specs=None,
    spec="",
    spec_path=None,
    spec_io_mode="rw",
    theme_key="vega",
    appearance="media",
    show_cloud_tool=False,
    computation=None,
    kernel_computation=None,
    kanaries_api_key="",
    **kwargs,
) -> Component

dataset puede ser un pandas DataFrame, polars DataFrame, pyarrow Table, Connector de base de datos o cadena con estilo de conector.

Usa spec_path para un archivo local de estado de gráficos. Usa computation para código nuevo; kernel_computation es heredado y está programado para eliminarse en PyGWalker 0.7.0.

Métodos de marca

Los métodos de marca devuelven una copia de Component, así que las cadenas son seguras para reutilizarse.

MétodoMarca de gráfico
.bar()Barras
.line()Línea
.area()Área
.trail()Trail
.scatter()Puntos/scatter
.circle()Círculo
.tick()Tick
.rect()Rectángulo
.arc()Arco
.text()Texto
.box()Diagrama de caja
.table()Tabla
.poi()Punto de interés geográfico

Codificaciones

Usa .encode(...) para mapear campos a canales visuales.

chart = (
    pyg.component(df)
    .scatter()
    .encode(
        x="ad_spend",
        y="revenue",
        color="channel",
        size="sum(orders)",
    )
)

Canales compatibles:

encode(
    x="",
    y="",
    color="",
    opacity="",
    size="",
    shape="",
    radius="",
    theta="",
    longitude="",
    latitude="",
    geoid="",
    details="",
    text="",
)

x e y también pueden recibir una lista de campos. Las expresiones de agregación como sum(revenue) usan el modelo de agregación de Graphic Walker.

Layout y modos

Configura el tamaño y las opciones de layout del gráfico con .layout(...).

chart = chart.layout(mode="fixed", width=640, height=360)

Cambia modos de renderizado con:

MétodoUso
.profiling()Renderiza el modo de perfilado/tabla.
.explorer()Renderiza el explorador completo alrededor del estado de gráfico actual.
.copy()Crea una copia explícita antes de ramificar una cadena de gráfico.
.to_html()Devuelve HTML para el componente actual.

Límites de exportación estática

.to_html() de Component es HTML estático. Las exportaciones de componentes en modo explorador y perfilado rechazan computación kernel/cloud activa:

# Use browser computation when exporting component HTML.
component = pyg.component(df, computation="browser")
html = component.explorer().to_html()

Usa un adaptador activo como API para notebooks, Streamlit o Gradio cuando el gráfico necesite computación kernel o cloud.

Guías relacionadas