Skip to content

API de Componentes do PyGWalker

Use pygwalker.component(...) quando quiser criar gráficos PyGWalker com cadeias de métodos Python em vez de usar apenas o explorador de arrastar e 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()

Fábrica

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 pode ser um pandas DataFrame, polars DataFrame, pyarrow Table, Connector de banco de dados ou string no estilo de conector.

Use spec_path para um arquivo local de estado de gráfico. Use computation para código novo; kernel_computation é legado e tem remoção programada para o PyGWalker 0.7.0.

Métodos de marca

Métodos de marca retornam uma cópia de Component, então cadeias são seguras para reutilização.

MétodoMarca do gráfico
.bar()Barra
.line()Linha
.area()Área
.trail()Trilha
.scatter()Ponto/dispersão
.circle()Círculo
.tick()Marca
.rect()Retângulo
.arc()Arco
.text()Texto
.box()Box plot
.table()Tabela
.poi()Ponto geográfico de interesse

Codificações

Use .encode(...) para mapear campos para canais visuais.

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

Canais suportados:

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

x e y também podem receber uma lista de campos. Expressões agregadas como sum(revenue) usam o modelo de agregação do Graphic Walker.

Layout e modos

Defina tamanho e opções de layout do gráfico com .layout(...).

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

Alterne modos de renderização com:

MétodoUso
.profiling()Renderiza o modo de perfil/tabela.
.explorer()Renderiza o explorador completo ao redor do estado atual do gráfico.
.copy()Cria uma cópia explícita antes de ramificar uma cadeia de gráfico.
.to_html()Retorna HTML para o componente atual.

Limites de exportação estática

.to_html() de componente é HTML estático. Exportações de componente em explorer e profiling rejeitam computação ativa em kernel/cloud:

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

Use um adaptador ativo como APIs de Notebook, Streamlit ou Gradio quando o gráfico precisar de computação em kernel ou nuvem.

Guias Relacionados