Skip to content

NotebookSpec🔗

A notebook spec is a dashboard spec with narrative content. It has a title, optional description, tags, time

settings, and a map of elements (panels and cells) referenced by the layout.

Definition🔗

class NotebookSpec:
    """
    A notebook spec is a dashboard spec with narrative content. It has a title, optional description, tags, time
    settings, and a map of elements (panels and cells) referenced by the layout.
    """

    title: str
    description: typing.Optional[str]
    tags: list[str]
    time_settings: dashboardv2beta1.TimeSettingsSpec
    elements: dict[str, dashboardv2beta1.NotebookElement]
    layout: dashboardv2beta1.NotebookLayoutKind

Methods🔗

to_json🔗

Converts this object into a representation that can easily be encoded to JSON.

def to_json() -> dict[str, object]

from_json🔗

Builds this object from a JSON-decoded dict.

@classmethod
def from_json(data: dict[str, typing.Any]) -> typing.Self

See also🔗

NotebookSpec