API de Exportação HTML do PyGWalker

Use pygwalker.to_html(...) quando precisar de uma string HTML estática. Exportações estáticas são apenas para navegador: elas não oferecem suporte a computação ativa em kernel ou nuvem.

import pygwalker as pyg
 
html = pyg.to_html(
    df,
    spec_path="./gw_config.json",
    computation="browser",
)

Limitação do HTML estático

HTML estático não tem kernel Python ativo nem callback de nuvem. O PyGWalker rejeita:

pyg.to_html(df, computation="kernel")
pyg.to_html(df, computation="cloud")
pyg.to_html(df, kernel_computation=True)
pyg.to_html(df, cloud_computation=True)
pyg.to_html(df, use_kernel_calc=True)

Use computation="browser" ou omita a opção de computação. Use APIs de Notebook, Streamlit, Gradio ou modo webserver quando precisar de computação ativa em kernel ou nuvem.

`pygwalker.to_html`

to_html retorna uma string HTML de iframe incorporável.

import pathlib
import pygwalker as pyg
 
html = pyg.to_html(df, spec_path="./gw_config.json", computation="browser")
pathlib.Path("pygwalker.html").write_text(html, encoding="utf-8")

Assinatura:

pyg.to_html(
    df,
    gid=None,
    *,
    spec="",
    spec_path=None,
    field_specs=None,
    theme_key="g2",
    appearance="media",
    default_tab="vis",
    computation=None,
    **kwargs,
) -> str

df pode ser um pandas DataFrame, polars DataFrame, pyarrow Table ou pygwalker.Walker reutilizável.

Exporte de um `Walker` reutilizável

Crie um Walker quando o mesmo estado de gráfico também deve renderizar em notebooks ou apps.

import pygwalker as pyg
 
walker = pyg.Walker(
    df,
    spec_path="./gw_config.json",
    computation="browser",
)
 
html = pyg.to_html(walker, width="100%", height="720px")

Quando to_html recebe um Walker, passe dimensões de renderização como argumentos nomeados width e height. Opções de construção como spec_path, field_specs, appearance e computation devem ser definidas no Walker original.

walker.to_html(iframe_width=None, iframe_height=None) e walker.to_html_without_iframe() oferecem o mesmo comportamento de exportação estática e também rejeitam computação ativa em kernel/cloud.

Helpers de tabela e renderer

Use estes helpers quando não precisar do explorador completo.

from pygwalker.api.html import to_table_html, to_render_html
 
table_html = to_table_html(df, spec_path="./gw_config.json", computation="browser")
render_html = to_render_html(df, spec_path="./gw_config.json", computation="browser")

Assinaturas:

to_table_html(
    df,
    *,
    spec_path=None,
    theme_key="g2",
    appearance="media",
    computation=None,
    **kwargs,
) -> str
 
to_render_html(
    df,
    spec="",
    *,
    spec_path=None,
    theme_key="g2",
    appearance="media",
    computation=None,
    **kwargs,
) -> str

Helper de prévia de gráfico

to_chart_html renderiza um único gráfico a partir de uma spec Graphic Walker ou Vega.

from pygwalker.api.html import to_chart_html
 
chart_html = to_chart_html(
    df,
    spec=chart_spec,
    spec_type="graphic-walker",
)

Assinatura:

to_chart_html(
    dataset,
    spec,
    *,
    spec_type="graphic-walker",
    theme_key="g2",
    appearance="media",
) -> str

dataset pode ser um DataFrame, pyarrow Table, Connector de banco de dados ou string no estilo de conector.

Armadilhas comuns

Armadilha	Correção
Exportar dados locais grandes com computação em kernel	Use um backend ativo em vez de HTML estático.
Passar um `Walker` mais `spec_path` para `to_html`	Coloque `spec_path` em `pyg.Walker(...)`.
Começar novos exemplos estáticos com `kernel_computation=True`	Use `computation="browser"`.
Esperar que usuários editem e salvem estado de gráfico em uma exportação estática	Use um backend ativo de notebook/app com `spec_io_mode="rw"`.