Skip to content

PyGWalker Komponenten-API

Verwenden Sie pygwalker.component(...), wenn Sie PyGWalker-Diagramme mit Python-Methodenketten erstellen möchten, statt nur den Drag-and-drop-Explorer zu nutzen.

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 kann ein pandas DataFrame, polars DataFrame, pyarrow Table, Datenbank-Connector oder connectorartiger String sein.

Verwenden Sie spec_path für eine lokale Diagrammzustandsdatei. Verwenden Sie computation für neuen Code; kernel_computation ist legacy und zur Entfernung in PyGWalker 0.7.0 vorgesehen.

Mark-Methoden

Mark-Methoden geben eine kopierte Component zurück, sodass Ketten sicher wiederverwendet werden können.

MethodeDiagramm-Mark
.bar()Balken
.line()Linie
.area()Fläche
.trail()Trail
.scatter()Punkt/Scatter
.circle()Kreis
.tick()Tick
.rect()Rechteck
.arc()Arc
.text()Text
.box()Boxplot
.table()Tabelle
.poi()Geografischer Point of Interest

Encodings

Verwenden Sie .encode(...), um Felder visuellen Kanälen zuzuordnen.

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

Unterstützte Kanäle:

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

x und y können auch eine Liste von Feldern erhalten. Aggregationsausdrücke wie sum(revenue) verwenden das Aggregationsmodell von Graphic Walker.

Layout und Modi

Setzen Sie Diagrammgröße und Layoutoptionen mit .layout(...).

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

Render-Modi wechseln Sie mit:

MethodeVerwendung
.profiling()Rendert den Profiling-/Tabellenmodus.
.explorer()Rendert den vollständigen Explorer um den aktuellen Diagrammzustand.
.copy()Erstellt eine explizite Kopie, bevor eine Diagrammkette verzweigt wird.
.to_html()Gibt HTML für die aktuelle Komponente zurück.

Grenzen statischer Exporte

Komponenten-.to_html() ist statisches HTML. Explorer- und Profiling-Komponentenexporte lehnen Live-Kernel-/Cloud-Berechnung ab:

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

Verwenden Sie einen Live-Adapter wie Notebook-APIs, Streamlit oder Gradio, wenn das Diagramm Kernel- oder Cloud-Berechnung benötigt.

Verwandte Anleitungen