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

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


  • PartialJSONObject
    • IMetadataOptions


cellTypes?: string[]

Cells which should have this metadata.

customField?: string

Name of a custom react field registered.

customWidget?: string

Name of a custom react widget registered.

metadataLevel?: "cell" | "notebook"

Metadata applied to notebook or cell.

writeDefault?: boolean

Whether to avoid writing default value in metadata.