Interface IMetadataOptions

Options to customize the widget, the field and the relevant metadata.

interface IMetadataOptions {
    cellTypes?: string[];
    customField?: string;
    customWidget?: string;
    metadataLevel?: "cell" | "notebook";
    writeDefault?: boolean;
    [key: string]: undefined | PartialJSONValue;
}

Hierarchy

  • PartialJSONObject
    • IMetadataOptions

Indexable

Properties

cellTypes? customField? customWidget? metadataLevel? writeDefault?

Properties

OptionalcellTypes

cellTypes?: string[]

Cells which should have this metadata.

OptionalcustomField

customField?: string

Name of a custom react field registered.

OptionalcustomWidget

customWidget?: string

Name of a custom react widget registered.

OptionalmetadataLevel

metadataLevel?: "cell" | "notebook"

Metadata applied to notebook or cell.

OptionalwriteDefault

writeDefault?: boolean

Whether to avoid writing default value in metadata.

Settings

Member Visibility

On This Page

Properties