Interface IMetadataForm

An interface describing the metadata form.

interface IMetadataForm {
    _origin?: string;
    id: string;
    label?: string;
    metadataOptions?: { [metadataKey: string]: IMetadataOptions };
    metadataSchema: IMetadataSchema;
    rank?: number;
    showModified?: boolean;
    uiSchema?: { [metadataKey: string]: UiSchema };
    [key: string]: undefined | PartialJSONValue;
}

Hierarchy

  • PartialJSONObject
    • IMetadataForm

Indexable

Properties

_origin? id label? metadataOptions? metadataSchema rank? showModified? uiSchema?

Properties

Optional_origin

_origin?: string

Keep the plugin at origin of the metadata form.

id

id: string

The section unique ID.

Optionallabel

label?: string

The section label.

OptionalmetadataOptions

metadataOptions?: { [metadataKey: string]: IMetadataOptions }

The jupyter properties.

metadataSchema

metadataSchema: IMetadataSchema

The metadata schema.

Optionalrank

rank?: number

The section rank in notebooktools panel.

OptionalshowModified

showModified?: boolean

Whether to show the modified field from default value.

OptionaluiSchema

uiSchema?: { [metadataKey: string]: UiSchema }

The ui schema as used by react-JSON-schema-form.

Settings

Member Visibility

On This Page

Properties