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;
    };
}

Hierarchy

  • PartialJSONObject
    • IMetadataForm

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.

Optional label

label?: string

The section label.

Optional metadataOptions

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

The jupyter properties.

Type declaration

metadataSchema

metadataSchema: IMetadataSchema

The metadata schema.

Optional rank

rank?: number

The section rank in notebooktools panel.

Optional showModified

showModified?: boolean

Whether to show the modified field from default value.

Optional uiSchema

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

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

Type declaration

  • [metadataKey: string]: UiSchema

Settings

Member Visibility

Theme

On This Page

_originidlabelmetadataOptionsmetadataSchemarankshowModifieduiSchema