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 implements \JsonSerializable
{
    public string $title;

    public ?string $description;

    /**
     * @var array<string>
     */
    public array $tags;

    public \Grafana\Foundation\Dashboardv2beta1\TimeSettingsSpec $timeSettings;

    /**
     * @var array<string, \Grafana\Foundation\Dashboardv2beta1\CellKind|\Grafana\Foundation\Dashboardv2beta1\V2PanelKind|\Grafana\Foundation\Dashboardv2beta1\LibraryPanelKind>
     */
    public array $elements;

    public \Grafana\Foundation\Dashboardv2beta1\NotebookLayoutKind $layout;

}

Methods🔗

fromArray🔗

Builds this object from an array.

This function is meant to be used with the return value of json_decode($json, true).

static fromArray(array $inputData)

jsonSerialize🔗

Returns the data representing this object, preparing it for JSON serialization with json_encode().

jsonSerialize()

See also🔗

NotebookSpecBuilder