Guia da API PyGWalker Jupyter

Este guia explica como usar o PyGWalker em notebooks Jupyter, cobrindo as principais funções e seus parâmetros.

Funções Principais

1. `walk()`

Cria uma instância interativa do GraphicWalker.

import pygwalker as pyg
 
walker = pyg.walk(dataset)

2. `render()`

Renderiza uma configuração específica de gráfico.

import pygwalker as pyg
 
walker = pyg.render(dataset, spec="./gw_config.json")

3. `table()`

Exibe o conjunto de dados como uma tabela interativa.

import pygwalker as pyg
 
walker = pyg.table(dataset)

Parâmetros Comuns

Parâmetro	Tipo	Padrão	Descrição
dataset	Union[DataFrame, Connector]	-	Dados de entrada. Veja Dataset Of Walker para mais detalhes.
gid	Union[int, str]	None	ID do div do contêiner do GraphicWalker. Formato: 'gwalker-{gid}'. Auto-gerado se None.
field_specs	Optional[Dict[str, FieldSpec]]	None	Especificações de campo. Inferido automaticamente se não especificado.
theme_key	Literal['vega', 'g2']	'g2'	Tipo de tema para o GraphicWalker.
appearance	Literal['media', 'light', 'dark']	'media'	Configuração de tema. 'media' detecta automaticamente o tema do OS.
spec	str	""	Dados de configuração do gráfico (ID, JSON ou URL).
kernel_computation	bool	None	Ativa computação de alto desempenho para conjuntos de dados maiores.
kanaries_api_key	str	""	Chave da API do Kanaries.
default_tab	Literal["data", "vis"]	"vis"	Aba padrão para mostrar (apenas para `walk()`).
cloud_computation	bool	False	Ativa a computação em nuvem (faz upload dos dados para a nuvem Kanaries).

Melhores Práticas e Dicas

Grandes Conjuntos de Dados: Para arquivos CSV > 1GB, use kernel_computation=True para ativar o processamento de alto desempenho.
Tematização:
- Defina o tema com appearance='light' ou appearance='dark'.
- Se o tema do PyGWalker não corresponder ao do Jupyter, configure explicitamente a aparência.
Salvando Gráficos:
- Salve em um arquivo ou exporte como código.
- Guia detalhado sobre como salvar e compartilhar (opens in a new tab)
Desempenho: Use kernel_computation=True para conjuntos de dados maiores para aproveitar o motor interno baseado em DuckDB.
Computação em Nuvem: Defina cloud_computation=True para usar a nuvem Kanaries para processamento de dados (requer chave de API).

Exemplos

Para uso mais avançado e exemplos de integração, consulte a documentação do PyGWalker (opens in a new tab).

Perguntas Frequentes

Meu pygwalker não consegue lidar com CSV > 1GB, o que devo fazer?

O PyGWalker possui um motor interno baseado em DuckDB que permite manipular conjuntos de dados muito maiores com alto desempenho. Você pode ativá-lo com o parâmetro kernel_computation=True.

Como definir o tema do pygwalker (claro ou escuro)?

Você pode definir o tema com o parâmetro appearance. Valores disponíveis: dark | light | media. O padrão é media, que será automaticamente ajustado pelo sistema.

Por que meu pygwalker está escuro, mas meu jupyter está claro?

O pygwalker segue o tema do sistema por padrão. No entanto, alguns jupyters não conseguem seguir o tema do sistema. Você pode definir o tema com appearance='light' para fazer com que o pygwalker use o tema claro.

Como salvar os gráficos do pygwalker no jupyter?

Existem duas maneiras de salvar os gráficos e o estado do pygwalker. Salve em um arquivo ou exporte como código. Mais detalhes (opens in a new tab)

Dataset Streamlit Component