@jupyterlab/docregistry

constructor

constructor(options: DocumentRegistry.IWidgetFactoryOptions<T>);

• Construct a new ABCWidgetFactory.

property autoStartDefault

autoStartDefault: boolean;

• Whether to automatically select the preferred kernel during a kernel start

property canStartKernel

readonly canStartKernel: boolean;

• Whether the widgets can start a kernel when opened.

property contentProviderId

contentProviderId: string;

• Identifier of the content provider required for the widget (if any).

  Throws Error if the content provider was already set.

  Modifiers

  • @experimental

property defaultFor

readonly defaultFor: string[];

• The file types for which the factory should be the default.

property defaultRendered

readonly defaultRendered: string[];

• The file types for which the factory should be the default for rendering a document model, if different from editing.

property fileTypes

readonly fileTypes: string[];

• The file types the widget can view.

property isDisposed

readonly isDisposed: boolean;

• Get whether the model factory has been disposed.

property label

readonly label: string;

• The label of the widget to display in dialogs. If not given, name is used instead.

property modelName

readonly modelName: string;

• The registered name of the model type used to create the widgets.

property name

readonly name: string;

• A unique name identifying of the widget.

property preferKernel

readonly preferKernel: boolean;

• Whether the widgets prefer having a kernel started.

property readOnly

readonly readOnly: boolean;

• Whether the widget factory is read only.

property shutdownOnClose

shutdownOnClose: boolean;

• Whether the kernel should be shutdown when the widget is closed.

property translator

readonly translator: ITranslator;

• The application language translator.

property widgetCreated

readonly widgetCreated: ISignal<DocumentRegistry.IWidgetFactory<T, U>, T>;

• A signal emitted when a widget is created.

method createNew

createNew: (context: DocumentRegistry.IContext<U>, source?: T) => T;

• Create a new widget given a document model and a context.

  #### Notes It should emit the [widgetCreated] signal with the new widget.

method createNewWidget

protected abstract createNewWidget: (
    context: DocumentRegistry.IContext<U>,
    source?: T
) => T;

• Create a widget for a context.

method defaultToolbarFactory

protected defaultToolbarFactory: (widget: T) => DocumentRegistry.IToolbarItem[];

• Default factory for toolbar items to be added after the widget is created.

method dispose

dispose: () => void;

• Dispose of the resources used by the document manager.

property contentType

readonly contentType: Contents.ContentType;

• The type of the file.

  #### Notes This is a read-only property.

property fileFormat

readonly fileFormat: Contents.FileFormat;

• The format of the file.

  This is a read-only property.

property name

readonly name: string;

• The name of the model type.

  #### Notes This is a read-only property.

constructor

constructor(options: Context.IOptions<T>);

• Construct a new document context.

property canSave

readonly canSave: boolean;

• Whether the document can be saved via the Contents API.

property contentsModel

readonly contentsModel: Omit<Contents.IModel, 'content'>;

• The document metadata, stored as a services contents model.

  #### Notes The contents model will be null until the context is populated. It will not have a content field.

property disposed

readonly disposed: ISignal<this, void>;

• A signal emitted when the context is disposed.

property factoryName

readonly factoryName: string;

• Get the model factory name.

  #### Notes This is not part of the IContext API.

property fileChanged

readonly fileChanged: ISignal<this, Omit<Contents.IModel, 'content'>>;

• A signal emitted when the model is saved or reverted.

property isDisposed

readonly isDisposed: boolean;

• Test whether the context is disposed.

property isReady

readonly isReady: boolean;

• Whether the context is ready.

property lastModifiedCheckMargin

lastModifiedCheckMargin: number;

• Configurable margin used to detect document modification conflicts, in milliseconds

property localPath

readonly localPath: string;

• The current local path associated with the document. If the document is in the default notebook file browser, this is the same as the path.

property model

readonly model: DocumentRegistry.IModel;

• Get the model associated with the document.

property path

readonly path: string;

• The current path associated with the document.

property pathChanged

readonly pathChanged: ISignal<this, string>;

• A signal emitted when the path changes.

property ready

readonly ready: Promise<void>;

• A promise that is fulfilled when the context is ready.

property saveState

readonly saveState: ISignal<this, DocumentRegistry.SaveState>;

• A signal emitted on the start and end of a saving operation.

property sessionContext

readonly sessionContext: SessionContext;

• The client session object associated with the context.

property translator

protected translator: ITranslator;

property urlResolver

readonly urlResolver: IRenderMime.IResolver;

• The url resolver for the context.

method addSibling

addSibling: (
    widget: Widget,
    options?: DocumentRegistry.IOpenOptions
) => IDisposable;

• Add a sibling widget to the document manager.

  Parameter widget

  The widget to add to the document manager.

  Parameter options

  The desired options for adding the sibling.

  Returns

  A disposable used to remove the sibling if desired.

  #### Notes It is assumed that the widget has the same model and context as the original widget.

method createCheckpoint

createCheckpoint: () => Promise<Contents.ICheckpointModel>;

• Create a checkpoint for the file.

method deleteCheckpoint

deleteCheckpoint: (checkpointId: string) => Promise<void>;

• Delete a checkpoint for the file.

method dispose

dispose: () => void;

• Dispose of the resources held by the context.

method download

download: () => Promise<void>;

• Download a file.

  Returns

  A promise which resolves when the file has begun downloading.

method initialize

initialize: (isNew: boolean) => Promise<void>;

• Initialize the context.

  Parameter isNew

  Whether it is a new file.

  Returns

  a promise that resolves upon initialization.

method listCheckpoints

listCheckpoints: () => Promise<Contents.ICheckpointModel[]>;

• List available checkpoints for a file.

method rename

rename: (newName: string) => Promise<void>;

• Rename the document.

  Parameter newName

  the new name for the document.

method restoreCheckpoint

restoreCheckpoint: (checkpointId?: string) => Promise<void>;

• Restore the file to a known checkpoint state.

method revert

revert: () => Promise<void>;

• Revert the document contents to disk contents.

method save

save: () => Promise<void>;

• Save the document contents to disk.

method saveAs

saveAs: () => Promise<void>;

• Save the document to a different path chosen by the user.

  It will be rejected if the user abort providing a new path.

constructor

constructor(options?: DocumentRegistry.IModelOptions<ISharedFile>);

• Construct a new document model.

property collaborative

readonly collaborative: boolean;

• Whether the model is collaborative or not.

property contentChanged

readonly contentChanged: ISignal<this, void>;

• A signal emitted when the document content changes.

property defaultKernelLanguage

readonly defaultKernelLanguage: string;

• The default kernel language of the document.

  #### Notes This is a read-only property.

property defaultKernelName

readonly defaultKernelName: string;

• The default kernel name of the document.

  #### Notes This is a read-only property.

property dirty

dirty: boolean;

• The dirty state of the document.

property readOnly

readOnly: boolean;

• The read only state of the document.

property sharedModel

readonly sharedModel: ISharedFile;

• The shared notebook model.

property stateChanged

readonly stateChanged: ISignal<this, IChangedArgs<any>>;

• A signal emitted when the document state changes.

method fromJSON

fromJSON: (value: PartialJSONValue) => void;

• Deserialize the model from JSON.

  #### Notes Should emit a [contentChanged] signal.

method fromString

fromString: (value: string) => void;

• Deserialize the model from a string.

  #### Notes Should emit a [contentChanged] signal.

method initialize

initialize: () => void;

• Initialize the model with its current state.

method toJSON

toJSON: () => PartialJSONValue;

• Serialize the model to JSON.

method toString

toString: () => string;

• Serialize the model to a string.

method triggerContentChange

protected triggerContentChange: () => void;

• Trigger a content changed signal.

method triggerStateChange

protected triggerStateChange: (args: IChangedArgs<any>) => void;

• Trigger a state change signal.

constructor

constructor(options?: DocumentRegistry.IOptions);

• Construct a new document registry.

property changed

readonly changed: ISignal<this, DocumentRegistry.IChangedArgs>;

• A signal emitted when the registry has changed.

property isDisposed

readonly isDisposed: boolean;

• Get whether the document registry has been disposed.

property translator

protected translator: ITranslator;

method addFileType

addFileType: (
    fileType: Partial<DocumentRegistry.IFileType>,
    factories?: string[]
) => IDisposable;

• Add a file type to the document registry.

  Parameter fileType

  The file type object to register.

  Parameter factories

  Optional factories to use for the file type.

  Returns

  A disposable which will unregister the command.

  #### Notes These are used to populate the "Create New" dialog.

  If no default factory exists for the file type, the first factory will be defined as default factory.

method addModelFactory

addModelFactory: (factory: DocumentRegistry.ModelFactory) => IDisposable;

• Add a model factory to the registry.

  Parameter factory

  The factory instance.

  Returns

  A disposable which will unregister the factory.

  #### Notes If a factory with the given name is already registered, or the given factory is already registered, a warning will be logged and this will be a no-op.

method addWidgetExtension

addWidgetExtension: (
    widgetName: string,
    extension: DocumentRegistry.WidgetExtension
) => IDisposable;

• Add a widget extension to the registry.

  Parameter widgetName

  The name of the widget factory.

  Parameter extension

  A widget extension.

  Returns

  A disposable which will unregister the extension.

  #### Notes If the extension is already registered for the given widget name, a warning will be logged and this will be a no-op.

method addWidgetFactory

addWidgetFactory: (factory: DocumentRegistry.WidgetFactory) => IDisposable;

• Add a widget factory to the registry.

  Parameter factory

  The factory instance to register.

  Returns

  A disposable which will unregister the factory.

  #### Notes If a factory with the given 'name' is already registered, a warning will be logged, and this will be a no-op. If '*' is given as a default extension, the factory will be registered as the global default. If an extension or global default is already registered, this factory will override the existing default. The factory cannot be named an empty string or the string 'default'.

method defaultRenderedWidgetFactory

defaultRenderedWidgetFactory: (path: string) => DocumentRegistry.WidgetFactory;

• Get the default rendered widget factory for a path.

  Parameter path

  The path to for which to find a widget factory.

  Returns

  The default rendered widget factory for the path.

  ### Notes If the widget factory has registered a separate set of defaultRendered file types and there is a match in that set, this returns that. Otherwise, this returns the same widget factory as [[defaultWidgetFactory]].

  The user setting defaultViewers took precedence on this one too.

method defaultWidgetFactory

defaultWidgetFactory: (path?: string) => DocumentRegistry.WidgetFactory;

• Get the default widget factory for a path.

  Parameter path

  An optional file path to filter the results.

  Returns

  The default widget factory for an path.

  #### Notes This is equivalent to the first value in [[preferredWidgetFactories]].

method dispose

dispose: () => void;

• Dispose of the resources held by the document registry.

method fileTypes

fileTypes: () => IterableIterator<DocumentRegistry.IFileType>;

• Create an iterator over the file types that have been registered.

  Returns

  A new iterator of file types.

method getFileType

getFileType: (name: string) => DocumentRegistry.IFileType | undefined;

• Get a file type by name.

method getFileTypeForModel

getFileTypeForModel: (model: Contents.IModel) => DocumentRegistry.IFileType;

• Get the best file type given a contents model.

  Parameter model

  The contents model of interest.

  Returns

  The best matching file type.

method getFileTypesForPath

getFileTypesForPath: (path: string) => DocumentRegistry.IFileType[];

• Get the file types that match a file name.

  Parameter path

  The path of the file.

  Returns

  An ordered list of matching file types.

method getKernelPreference

getKernelPreference: (
    path: string,
    widgetName: string,
    kernel?: Kernel.IModel
) => ISessionContext.IKernelPreference | undefined;

• Get a kernel preference.

  Parameter path

  The file path.

  Parameter widgetName

  The name of the widget factory.

  Parameter kernel

  An optional existing kernel model.

  Returns

  A kernel preference.

method getModelFactory

getModelFactory: (name: string) => DocumentRegistry.ModelFactory | undefined;

• Get a model factory by name.

  Parameter name

  The name of the model factory.

  Returns

  A model factory instance.

method getWidgetFactory

getWidgetFactory: (
    widgetName: string
) => DocumentRegistry.WidgetFactory | undefined;

• Get a widget factory by name.

  Parameter widgetName

  The name of the widget factory.

  Returns

  A widget factory instance.

method modelFactories

modelFactories: () => IterableIterator<DocumentRegistry.ModelFactory>;

• Create an iterator over the model factories that have been registered.

  Returns

  A new iterator of model factories.

method preferredWidgetFactories

preferredWidgetFactories: (path: string) => DocumentRegistry.WidgetFactory[];

• Get a list of the preferred widget factories.

  Parameter path

  The file path to filter the results.

  Returns

  A new array of widget factories.

  #### Notes Only the widget factories whose associated model factory have been registered will be returned. The first item is considered the default. The returned array has widget factories in the following order: - path-specific default factory - path-specific default rendered factory - global default factory - all other path-specific factories - all other global factories

method setDefaultWidgetFactory

setDefaultWidgetFactory: (fileType: string, factory: string | undefined) => void;

• Set overrides for the default widget factory for a file type.

  Normally, a widget factory informs the document registry which file types it should be the default for using the defaultFor option in the IWidgetFactoryOptions. This function can be used to override that after the fact.

  Parameter fileType

  The name of the file type.

  Parameter factory

  The name of the factory.

  #### Notes If factory is undefined, then any override will be unset, and the default factory will revert to the original value.

  If factory or fileType are not known to the docregistry, or if factory cannot open files of type fileType, this will throw an error.

method widgetExtensions

widgetExtensions: (
    widgetName: string
) => IterableIterator<DocumentRegistry.WidgetExtension>;

• Create an iterator over the registered extensions for a given widget.

  Parameter widgetName

  The name of the widget factory.

  Returns

  A new iterator over the widget extensions.

method widgetFactories

widgetFactories: () => IterableIterator<DocumentRegistry.WidgetFactory>;

• Create an iterator over the widget factories that have been registered.

  Returns

  A new iterator of widget factories.

constructor

constructor(options: DocumentWidget.IOptions<T, U>);

property context

readonly context: DocumentRegistry.IContext<U>;

property isUntitled

isUntitled?: boolean;

• Whether the document has an auto-generated name or not.

  #### Notes A document has auto-generated name if its name is untitled and up to the instant the user saves it manually for the first time.

method setFragment

setFragment: (fragment: string) => void;

• Set URI fragment identifier.

constructor

constructor(options: MimeContent.IOptions);

• Construct a new widget.

property mimeType

readonly mimeType: string;

• The mimetype for this rendered content.

property ready

readonly ready: Promise<void>;

• A promise that resolves when the widget is ready.

property renderer

readonly renderer: IRenderMime.IRenderer;

property translator

protected translator: ITranslator;

method [Printing.symbol]

[Printing.symbol]: () => Printing.OptionalAsyncThunk;

• Print method. Deferred to the renderer.

method dispose

dispose: () => void;

• Dispose of the resources held by the widget.

method onUpdateRequest

protected onUpdateRequest: (msg: Message) => void;

• Handle an update-request message to the widget.

method setFragment

setFragment: (fragment: string) => void;

• Set URI fragment identifier.

method setFragment

setFragment: (fragment: string) => void;

constructor

constructor(options: MimeDocumentFactory.IOptions<MimeDocument>);

• Construct a new mimetype widget factory.

method createNewWidget

protected createNewWidget: (context: DocumentRegistry.Context) => MimeDocument;

• Create a new widget given a context.

constructor

constructor(collaborative?: boolean);

• Instantiates a TextModelFactory.

property collaborative

readonly collaborative: boolean;

• Whether the model is collaborative or not.

property contentType

readonly contentType: Contents.ContentType;

• The type of the file.

  #### Notes This is a read-only property.

property fileFormat

readonly fileFormat: Contents.FileFormat;

• The format of the file.

  This is a read-only property.

property isDisposed

readonly isDisposed: boolean;

• Get whether the model factory has been disposed.

property name

readonly name: string;

• The name of the model type.

  #### Notes This is a read-only property.

method createNew

createNew: (
    options?: DocumentRegistry.IModelOptions<ISharedFile>
) => DocumentRegistry.ICodeModel;

• Create a new model.

  Parameter options

  Model options.

  Returns

  A new document model.

method dispose

dispose: () => void;

• Dispose of the resources held by the model factory.

method preferredLanguage

preferredLanguage: (path: string) => string;

• Get the preferred kernel language given a file path.

property content

readonly content: T;

• The content widget.

property context

readonly context: DocumentRegistry.IContext<U>;

• The context associated with the document.

property isUntitled

isUntitled?: boolean;

• Whether the document has an auto-generated name or not.

  #### Notes A document has auto-generated name if its name is untitled and up to the instant the user saves it manually for the first time.

property revealed

readonly revealed: Promise<void>;

• A promise resolving after the content widget is revealed.

property toolbar

readonly toolbar: Toolbar<Widget>;

• The toolbar for the widget.

method setFragment

setFragment: (fragment: string) => void;

• Set URI fragment identifier.

function getDefaultDirectoryFileType

getDefaultDirectoryFileType: (translator?: ITranslator) => IFileType;

• The default directory file type used by the document registry.

  Parameter translator

  The application language translator.

  Returns

  The default directory file type.

function getDefaultFileTypes

getDefaultFileTypes: (
    translator?: ITranslator
) => ReadonlyArray<Partial<IFileType>>;

• The default file types used by the document registry.

  Parameter translator

  The application language translator.

  Returns

  The default directory file types.

function getDefaultNotebookFileType

getDefaultNotebookFileType: (translator?: ITranslator) => IFileType;

• The default notebook file type used by the document registry.

  Parameter translator

  The application language translator.

  Returns

  The default notebook file type.

function getDefaultTextFileType

getDefaultTextFileType: (translator?: ITranslator) => IFileType;

• The default text file type used by the document registry.

  Parameter translator

  The application language translator.

  Returns

  The default text file type.

function getFileTypeDefaults

getFileTypeDefaults: (translator?: ITranslator) => IFileType;

• The defaults used for a file type.

  Parameter translator

  The application language translator.

  Returns

  The default file type.

type CodeContext

type CodeContext = IContext<ICodeModel>;

• A type alias for a code context.

type CodeModelFactory

type CodeModelFactory = IModelFactory<ICodeModel>;

• A type alias for a code model factory.

type Context

type Context = IContext<IModel>;

• A type alias for a context.

type ModelFactory

type ModelFactory = IModelFactory<IModel>;

• A type alias for a standard model factory.

type SaveState

type SaveState = 'started' | 'failed' | 'completed';

• Document save state

type WidgetExtension

type WidgetExtension = IWidgetExtension<Widget, IModel>;

• A type alias for a standard widget extension.

type WidgetFactory

type WidgetFactory = IWidgetFactory<IDocumentWidget, IModel>;

• A type alias for a standard widget factory.