Skip to content

API Component PyGWalker

Utilisez pygwalker.component(...) lorsque vous voulez construire des graphiques PyGWalker avec des chaînes de méthodes Python, pas seulement avec l'explorateur glisser-déposer.

import pygwalker as pyg
 
chart = (
    pyg.component(df, spec_path="./gw_config.json", computation="browser")
    .bar()
    .encode(x="category", y="sum(revenue)", color="region")
    .layout(width=720, height=420)
)
 
html = chart.to_html()

Factory

pyg.component(
    dataset,
    *,
    field_specs=None,
    spec="",
    spec_path=None,
    spec_io_mode="rw",
    theme_key="vega",
    appearance="media",
    show_cloud_tool=False,
    computation=None,
    kernel_computation=None,
    kanaries_api_key="",
    **kwargs,
) -> Component

dataset peut être une DataFrame pandas, une DataFrame polars, une pyarrow Table, un Connector de base de données ou une chaîne de style connecteur.

Utilisez spec_path pour un fichier local d'état des graphiques. Utilisez computation pour le nouveau code ; kernel_computation est hérité et sa suppression est prévue dans PyGWalker 0.7.0.

Méthodes de mark

Les méthodes de mark retournent un Component copié, ce qui rend les chaînes sûres à réutiliser.

MéthodeMark du graphique
.bar()Barres
.line()Ligne
.area()Aire
.trail()Traînée
.scatter()Points/scatter
.circle()Cercle
.tick()Tick
.rect()Rectangle
.arc()Arc
.text()Texte
.box()Boîte à moustaches
.table()Table
.poi()Point d'intérêt géographique

Encodages

Utilisez .encode(...) pour mapper des champs à des canaux visuels.

chart = (
    pyg.component(df)
    .scatter()
    .encode(
        x="ad_spend",
        y="revenue",
        color="channel",
        size="sum(orders)",
    )
)

Canaux pris en charge :

encode(
    x="",
    y="",
    color="",
    opacity="",
    size="",
    shape="",
    radius="",
    theta="",
    longitude="",
    latitude="",
    geoid="",
    details="",
    text="",
)

x et y peuvent aussi recevoir une liste de champs. Les expressions d'agrégation comme sum(revenue) utilisent le modèle d'agrégation de Graphic Walker.

Layout et modes

Définissez la taille du graphique et les options de disposition avec .layout(...).

chart = chart.layout(mode="fixed", width=640, height=360)

Changez de mode de rendu avec :

MéthodeUtilisation
.profiling()Rendre le mode profiling/table.
.explorer()Rendre l'explorateur complet autour de l'état actuel du graphique.
.copy()Créer une copie explicite avant de dériver une chaîne de graphique.
.to_html()Retourner le HTML du composant actuel.

Limites de l'export statique

Le .to_html() des composants est du HTML statique. Les exports de composants explorer et profiling refusent le calcul kernel/cloud en direct :

# Use browser computation when exporting component HTML.
component = pyg.component(df, computation="browser")
html = component.explorer().to_html()

Utilisez un adaptateur actif comme API Notebook, Streamlit ou Gradio lorsque le graphique a besoin du calcul kernel ou cloud.

Guides associés