Interface IWidgetOptions

The options for a connected model.

This gives all of the information needed to instantiate a comm to a new widget on the kernel side (so view information is mandatory).

Notes

Either a comm or a model_id must be provided.

Hierarchy

Properties

comm? model_id? model_module model_module_version model_name view_module view_module_version view_name

Properties

Optional comm

comm?: IClassicComm

Comm object associated with the widget.

Optional model_id

model_id?: string

The model id to use. If not provided, the comm id of the comm is used.

model_module

model_module: string

Module name of the widget model to create.

model_module_version

model_module_version: string

Semver version requirement for the model module.

model_name

model_name: string

Target name of the widget model to create.

view_module

view_module: null | string

Module name of the widget view to create.

view_module_version

view_module_version: string

Semver version requirement for the view module.

view_name

view_name: null | string

Target name of the widget view to create.

Settings

Member Visibility

Theme

Generated using TypeDoc