FigureCollection.set_preferred¶
Select an attached valid figure; requires dataset:update or notebook:update.
Dispatches to the target's preferred-figure PUT endpoint. For a single
REST catalog operation use Dataset.set_preferred_figure or
Notebook.set_preferred_figure.
Signature¶
set_preferred(target: Dataset | Notebook, figure_id: str) -> Dataset | Notebook
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
target |
Dataset \| Notebook |
yes | - |
figure_id |
str |
yes | - |
Fields¶
| Field |
|---|
target |
figure_id |
Return shape¶
Dataset | Notebook
Permission¶
This is a local SDK helper. It does not call the CloudSprite HTTP API.
Usage¶
figure_collection.set_preferred(target, figure_id)