• Public
  • Public/Protected
  • All

A schema type that is a minimal subset of the formal JSON Schema along with optional JupyterLab rendering hints.




Optional default

default: PartialJSONValue

The default value, if any.

Optional description

description: string

The schema description.

Optional jupyter.lab.setting-deprecated

jupyter.lab.setting-deprecated: boolean

Whether the schema is deprecated.


This flag can be used by functionality that loads this plugin's settings from the registry. For example, the setting editor does not display a plugin's settings if it is set to true.

Optional jupyter.lab.setting-icon

jupyter.lab.setting-icon: string

The JupyterLab icon hint.

Optional jupyter.lab.setting-icon-class

jupyter.lab.setting-icon-class: string

The JupyterLab icon class hint.

Optional jupyter.lab.setting-icon-label

jupyter.lab.setting-icon-label: string

The JupyterLab icon label hint.

Optional jupyter.lab.shortcuts

jupyter.lab.shortcuts: IShortcut[]

The JupyterLab shortcuts that are created by a plugin's schema.

Optional jupyter.lab.transform

jupyter.lab.transform: boolean

A flag that indicates plugin should be transformed before being used by the setting registry.


If this value is set to true, the setting registry will wait until a transformation has been registered (by calling the transform() method of the registry) for the plugin ID before resolving load() promises. This means that if the attribute is set to true but no transformation is registered in time, calls to load() a plugin will eventually time out and reject.

Optional properties

properties: {}

The schema's child properties.

Type declaration

Optional title

title: string

The title of a property.


type: "object"

The root schema is always an object.

Generated using TypeDoc