Skip to content
PYGWALKER
Core APIs

Core APIs

pygwalker.walk()

import pygwalker as pyg
 
pyg.walk()

Parameters

  • dataset, a dataframe or datasource connection.
  • use_kernel_calc, enable a high performance engine to handle all the computations.
  • spec, the specification of visualizations. It can be a json file path contains the specification or a string of the specification.
  • use_preview, enable the preview mode.
  • dark, enable the dark mode. available values: dark | light | media. Default by media which will be automatically switched by the system.

pygwalker.to_html()

Exports pygwalker as html template.

import pygwalker as pyg
 
pyg.to_html(df, spec=vis_spec)

This is used when you want to embed pygwalker in a web app.

Related Q&A

My pygwalker cannot handle CSV > 1GB, what should I do?

PyGWalker has a internal engine based on DuckDB which allows you to handle much larger dataset with high performance. You can enable it with use_kernel_calc=True parameter.

How to set pygwalker's theme (light or dark)?

You can set the theme with dark parameter. Available values: dark | light | media. Default by media which will be automatically switched by the system.

Why my pygwalker is dark but my juypter is light?

pygwalker follows the system theme by default. But some juypters cannot follow the system theme. You can set the theme with dark='light' to make pygwalker to use light theme.

How to save the charts of pygwalker in juypter?

There is two ways to save pygwalker's charts and state. Save it into a file or export as code. More details (opens in a new tab)