Notebook.set_preferred_figure

Select an attached valid figure as this notebook's view (notebook:update).

Signature

set_preferred_figure(figure_id: str) -> Notebook

Parameters

Name	Type	Required	Default
figure_id	str	yes	-

HTTP parameters

Name	In	Type	Required	Default
notebook_id	path	string	yes	-

Fields

Schema: PreferredFigureIn

Field	Type	Required
figure_id	string	yes

Return shape

HTTP 200 — OK

Schema: NotebookSchema

Field	Type	Required
created_at	string	no
description	string	yes
id	string	yes
preferred_figure_id	string	no
primary_dataset_id	string	no
project_id	string	yes
slug	string	no
slug_number	integer	no
tags	array<NotebookTagSchema>	no
title	string	yes
trace_count	integer	no
updated_at	string	no

Permission

Required permission: notebook:update

HTTP

PUT /api/notebooks/{id}/preferred-figure (setNotebookPreferredFigure)

Usage

notebook.set_preferred_figure(figure_id)