FigureCollection.clear_preferred¶
Clear the selected figure, restoring the target's normal graph view.
Requires dataset:update or notebook:update. Single-endpoint catalog
methods are Dataset.clear_preferred_figure and Notebook.clear_preferred_figure.
Signature¶
clear_preferred(target: Dataset | Notebook) -> Dataset | Notebook
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
target |
Dataset \| Notebook |
yes | - |
Fields¶
| Field |
|---|
target |
Return shape¶
Dataset | Notebook
Permission¶
This is a local SDK helper. It does not call the CloudSprite HTTP API.
Usage¶
figure_collection.clear_preferred(target)