A plot is a definition of a Plotly figure that can be stored and shared on Wizata.
Attributes
| Name | Type | Description |
|---|---|---|
| plot_id | The UUID of the plot. None for a deployed plot, which is addressed by key instead — see below. | |
| name | A simple name helping the user identifying the plot. | |
| figure | Plotly figure defining the plot itself. | |
| key | DEV-6026 — the deterministic identity of a DEPLOYED plot, <pipeline key>/<twin key>/<plot script>.<input dataframe>. An experiment plot is one blob per execution addressed by plot_id and fetched with GET /plots/<id>/; a deployed plot is one blob per (pipeline, twin, plot step) that is overwritten, so it has no uuid at all. plot_id is deliberately left None in that case rather than minted and dropped: a uuid that looks addressable via GET /plots/<id> but is not would be its own trap. Note the identity is the plot STEP — its script and input dataframe, both from the pipeline definition — and not name, which stays the display label, so relabelling a chart cannot orphan its blob. |
Methods
api_id()
Id of the plot (plot_id)
return: string formatted UUID of the plot, None for a deployed plot — it is not a backend entity, so there is no id to send.
api_key()
return current object logical unique key (e.g. hardware_id, key, name).
returns None if the entity has no logical key.
endpoint()
Name of the endpoints used to manipulate plots.
return: Endpoint name.
from_json()
Load the Plot entity from a dictionary representation of the Plot.
| Name | Type | Default | Description |
|---|---|---|---|
| obj | Dict version of the Plot. |
set_id()
specify the id_value neutrally
| Name | Type | Default | Description |
|---|---|---|---|
| id_value | |||
| return: |
to_json()
Convert the plot to a dictionary compatible to JSON format.
| Name | Type | Default | Description |
|---|---|---|---|
| target | str | None | |
| return: dictionary representation of the Plot object. |