Skip to content
PYGWALKER
Referência da API
HTML Exports

Guia da API HTML do PyGWalker

O PyGWalker permite renderizar a interface do Graphic Walker em qualquer aplicação que suporte renderização HTML. Este guia explica como usar a API HTML de forma eficaz.

Nota Importante

A API HTML atual é projetada apenas para computação no front-end. Pode não ser adequada para grandes conjuntos de dados devido a limitações de desempenho.

Usando to_html()

A função to_html() é o método principal para gerar saída HTML a partir do seu 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 da Função

ParâmetroTipoPadrãoDescrição
datasetDataFrame-O DataFrame de entrada. Veja Dataset Of Walker para mais detalhes.
gidUnion[int, str]NoneID para o div do container do GraphicWalker. Formato: 'gwalker-{gid}'. Gerado automaticamente se None.
field_specsOptional[Dict[str, FieldSpec]]NoneEspecificações de campo. Inferido automaticamente a partir de dataset se não especificado.
theme_keyLiteral['vega', 'g2']'g2'Tipo de tema para o GraphicWalker.
appearanceLiteral['media', 'light', 'dark']'media'Configuração de tema. 'media' detecta automaticamente o tema do sistema operacional.
specstr""Dados de configuração do gráfico. Pode ser um ID de configuração, JSON ou URL de arquivo remoto.
default_tabLiteral["data", "vis"]"vis"Aba padrão a ser exibida quando a interface é carregada.
**kwargsAny-Argumentos opcionais adicionais.

Exemplos

Exportando para um Arquivo HTML

Você pode salvar o HTML gerado em um arquivo para uso posterior ou compartilhamento:

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 com Shiny

O PyGWalker pode ser integrado em aplicações Shiny. Para um guia detalhado e exemplo, consulte nosso tutorial de integração com Shiny.

Melhores Práticas

  1. Considerações de Desempenho: Tenha em mente o tamanho do conjunto de dados ao usar a API HTML, pois ela processa os dados no lado do cliente.
  2. Customização: Utilize o parâmetro field_specs para ajustar como seus dados são interpretados e exibidos.
  3. Temas: Experimente diferentes configurações de theme_key e appearance para combinar com o visual e sensação da sua aplicação.
  4. Integração: Ao integrar com frameworks web como Shiny, certifique-se de lidar adequadamente com a saída HTML dentro da estrutura da sua aplicação.

Para usos mais avançados e exemplos de integração, consulte a documentação do PyGWalker.

on shiny