Skip to content

API Reference

Observed Observer edited this page Oct 13, 2023 · 1 revision

Here's the API documentation for the pygwalker.walk:

Parameter Type Default Description
dataset Union[DataFrame, Connector] - The dataframe or connector to be used.
gid Union[int, str] None ID for the GraphicWalker container div, formatted as 'gwalker-{gid}'.
env Literal['Jupyter', 'Streamlit', 'JupyterWidget'] 'JupyterWidget' Environment using pygwalker.
fieldSpecs Optional[Dict[str, FieldSpec]] None Specifications of fields. Will be automatically inferred from dataset if not specified.
hideDataSourceConfig bool True If True, hides DataSource import and export button.
themeKey Literal['vega', 'g2'] 'g2' Theme type for the GraphicWalker.
dark Literal['media', 'light', 'dark'] 'media' Theme setting. 'media' will auto-detect the OS theme.
return_html bool False If True, returns the result as an HTML string.
spec str "" Chart configuration data. Can be a configuration ID, JSON, or remote file URL.
use_preview bool True If True, uses the preview function.
store_chart_data bool False If True and spec is a JSON file, saves the chart to disk.
use_kernel_calc bool False If True, uses kernel computation for data.
**kwargs Any - Additional keyword arguments.

You can also check more API reference and tutorials at kanaries document