panel-graphic-walker 0.2.1

A project providing a Graphic Walker Pane for use with HoloViz Panel.

✨ panel-graphic-walker

panel-graphic-walker provides the GraphicWalker Pane to utilize the Graphic Walker data exploration tool within notebooks and Panel data applications.

This project is in early stages, so if you find a version that suits your needs, it’s recommended to pin your version, as updates may introduce changes. Please note that displaying larger datasets (>= 10 MB) may not be possible depending on your environment.

Installation

Install panel-graphic-walker via pip:

pip install panel-graphic-walker

Usage

Basic Graphic Walker Pane

Here’s an example of how to create a simple GraphicWalker pane:

import pandas as pd
import panel as pn

from panel_gwalker import GraphicWalker

pn.extension()

df = pd.read_csv("https://datasets.holoviz.org/windturbines/v1/windturbines.csv.gz", nrows=10000)

GraphicWalker(df).servable()

Configuring Fields

You may also configure the fields (data columns) manually:

import pandas as pd
import panel as pn

from panel_gwalker import GraphicWalker

pn.extension()

df = pd.read_csv("https://datasets.holoviz.org/windturbines/v1/windturbines.csv.gz", nrows=10000)

fields = [
    {
        "fid": "t_county",
        "name": "t_county",
        "semanticType": "nominal",
        "analyticType": "dimension",
    },
    {
        "fid": "t_model",
        "name": "t_model",
        "semanticType": "nominal",
        "analyticType": "dimension",
    },
    {
        "fid": "t_cap",
        "name": "t_cap",
        "semanticType": "quantitative",
        "analyticType": "measure",
    },
]

GraphicWalker(df, fields=fields).servable()

Configuring the Appearance

By default, the appearance is determined by pn.config.theme. However, you can manually change this, for example, to media, which corresponds to the user's preference as set in the browser.

import pandas as pd
import panel as pn

from panel_gwalker import GraphicWalker

pn.extension()

df = pd.read_csv(
    "https://datasets.holoviz.org/windturbines/v1/windturbines.csv.gz", nrows=10000
)

GraphicWalker(df, appearance="media").servable()

Additional Configuration

Extra configuration options are available via the Graphic Walker API. For instance, you can change the language to Japanese:

import pandas as pd
import panel as pn

from panel_gwalker import GraphicWalker

pn.extension()

df = pd.read_csv(
    "https://datasets.holoviz.org/windturbines/v1/windturbines.csv.gz", nrows=10000
)

config = {
   "i18nLang": "ja-JP"
}

GraphicWalker(df, config=config).servable()

App with File Upload

API

Parameters

• object (DataFrame): The data for exploration. Please note that if you update the object, then the existing chart(s) will not be deleted and you will have to create a new one manually to use the new dataset.
• appearance (string): Optional dark mode preference: 'media', 'dark', 'light' or 'panel' (default). If 'panel' the the appearance is derived from pn.config.theme.
• computation (str): The computation configuration. Currently only 'client' is supported.
• fields (list): Optional specification of fields (columns).
• config (dict): Optional additional configuration for Graphic Walker. See the Graphic Walker API for more details.

Vision

Our dream is that this package is super simple to use and supports your use cases:

• Great documentation including examples.
• Supports your preferred data backend including Pandas, Polars and DuckDB.
• Supports persisting and reusing Graphic Walker specifications.
• Scales to even the largest datasets only limited by your server or cluster.

❤️ Contributions

Contributions and co-maintainers are very welcome! Please submit issues or pull requests to the GitHub repository. Check out the DEVELOPER_GUIDE for more information.