Class ManagerBase`Abstract`

Manager abstract base class

Hierarchy

ManagerBase

Implements

IWidgetManager

Constructors

constructor

new ManagerBase(): ManagerBase
Returns ManagerBase

Properties

`Private` _models

_models: {
[key: string]: Promise<WidgetModel>;
} = ...

Dictionary of model ids and model instance promises

Type declaration

[key: string]: Promise<WidgetModel>

`Readonly` comm_target_name

comm_target_name: "jupyter.widget" = 'jupyter.widget'

The comm target name to register

Methods

`Protected` `Abstract` _create_comm

_create_comm(comm_target_name: string, model_id?: string, data?: JSONObject, metadata?: JSONObject, buffers?: ArrayBuffer[] | ArrayBufferView[]): Promise<IClassicComm>
Create a comm which can be used for communication for a widget.

If the data/metadata is passed in, open the comm before returning (i.e., send the comm_open message). If the data and metadata is undefined, we want to reconstruct a comm that already exists in the kernel, so do not open the comm by sending the comm_open message.
Parameters
- comm_target_name: string
  
  Comm target name
- Optional model_id: string
  
  The comm id
- Optional data: JSONObject
  
  The initial data for the comm
- Optional metadata: JSONObject
  
  The metadata in the open message
- Optional buffers: ArrayBuffer[] | ArrayBufferView[]
Returns Promise<IClassicComm>
- Defined in packages/base-manager/src/manager-base.ts:838

`Protected` `Abstract` _get_comm_info

_get_comm_info(): Promise<{}>
Returns Promise<{}>
- Defined in packages/base-manager/src/manager-base.ts:845

`Protected` _loadFromKernel

_loadFromKernel(): Promise<void>
Fetch all widgets states from the kernel using the control comm channel If this fails (control comm handler not implemented kernel side), it will fall back to _loadFromKernelModels.

This is a utility function that can be used in subclasses.

Returns Promise<void>
- Defined in packages/base-manager/src/manager-base.ts:382

`Protected` _loadFromKernelModels

_loadFromKernelModels(): Promise<void>
Old implementation of fetching widget models one by one using the request_state message on each comm.

This is a utility function that can be used in subclasses.

Returns Promise<void>
- Defined in packages/base-manager/src/manager-base.ts:510

_make_model

_make_model(options: RequiredSome<IModelOptions, "model_id">, serialized_state?: any): Promise<WidgetModel>
Parameters
- options: RequiredSome<IModelOptions, "model_id">
- serialized_state: any = {}
Returns Promise<WidgetModel>
- Defined in packages/base-manager/src/manager-base.ts:572

callbacks

callbacks(view?: WidgetView): ICallbacks
callback handlers specific to a view
Parameters
- Optional view: WidgetView
Returns ICallbacks
Implementation of IWidgetManager.callbacks
- Defined in packages/base-manager/src/manager-base.ts:205

clear_state

clear_state(): Promise<void>
Close all widgets and empty the widget state.

Returns
Promise that resolves when the widget state is cleared.

Returns Promise<void>
- Defined in packages/base-manager/src/manager-base.ts:633

create_view

create_view<VT>(model: DOMWidgetModel, options?: any): Promise<VT>
Creates a promise for a view of a given model

Notes

The implementation must trigger the Lumino 'after-attach' and 'after-show' events when appropriate, which in turn will trigger the view's 'displayed' events.

Make sure the view creation is not out of order with any state updates.
Type Parameters
- VT extends DOMWidgetView<VT> = DOMWidgetView
Parameters
- model: DOMWidgetModel
- Optional options: any
Returns Promise<VT>
Implementation of IWidgetManager.create_view
- Defined in packages/base-manager/src/manager-base.ts:141
create_view<VT>(model: WidgetModel, options?: any): Promise<VT>
Type Parameters
- VT extends WidgetView<VT> = WidgetView
Parameters
- model: WidgetModel
- Optional options: any
Returns Promise<VT>
Implementation of IWidgetManager.create_view
- Defined in packages/base-manager/src/manager-base.ts:145

disconnect

disconnect(): void
Disconnect the widget manager from the kernel, setting each model's comm as dead.

Returns void
- Defined in packages/base-manager/src/manager-base.ts:747

`Protected` filterExistingModelState

filterExistingModelState(serialized_state: any): any
Filter serialized widget state to remove any ID's already present in manager.

Returns
A copy of the state, with its 'state' attribute filtered
Parameters
- serialized_state: any
Returns any
- Defined in packages/base-manager/src/manager-base.ts:854

get_model

get_model(model_id: string): Promise<WidgetModel>
Get a promise for a model by model id.

Notes

If the model is not found, the returned Promise object is rejected.

If you would like to synchronously test if a model exists, use .has_model().
Parameters
- model_id: string
Returns Promise<WidgetModel>
Implementation of IWidgetManager.get_model
- Defined in packages/base-manager/src/manager-base.ts:217

get_state

get_state(options?: IStateOptions): Promise<IManagerState>
Asynchronously get the state of the widget manager.

This includes all of the widget models, and follows the format given in the @jupyter-widgets/schema package.

Returns
Promise for a state dictionary
Parameters
- options: IStateOptions = {}
  
  The options for what state to return.
Returns Promise<IManagerState>
- Defined in packages/base-manager/src/manager-base.ts:649

handle_comm_open

handle_comm_open(comm: IClassicComm, msg: ICommOpenMsg<"iopub" | "shell">): Promise<WidgetModel>
Handle when a comm is opened.
Parameters
- comm: IClassicComm
- msg: ICommOpenMsg<"iopub" | "shell">
Returns Promise<WidgetModel>
- Defined in packages/base-manager/src/manager-base.ts:238

has_model

has_model(model_id: string): boolean
Returns true if the given model is registered, otherwise false.

Notes

This is a synchronous way to check if a model is registered.
Parameters
- model_id: string
Returns boolean
Implementation of IWidgetManager.has_model
- Defined in packages/base-manager/src/manager-base.ts:231

inline_sanitize

inline_sanitize(source: string): string
Parameters
- source: string
Returns string
Implementation of IWidgetManager.inline_sanitize
- Defined in packages/base-manager/src/manager-base.ts:764

`Protected` `Abstract` loadClass

loadClass(className: string, moduleName: string, moduleVersion: string): Promise<typeof WidgetModel | typeof WidgetView>
Load a class and return a promise to the loaded object.
Parameters
- className: string
- moduleName: string
- moduleVersion: string
Returns Promise<typeof WidgetModel | typeof WidgetView>
- Defined in packages/base-manager/src/manager-base.ts:779

`Protected` loadModelClass

loadModelClass(className: string, moduleName: string, moduleVersion: string): Promise<typeof WidgetModel>
Parameters
- className: string
- moduleName: string
- moduleVersion: string
Returns Promise<typeof WidgetModel>
- Defined in packages/base-manager/src/manager-base.ts:785

`Protected` loadViewClass

loadViewClass(className: string, moduleName: string, moduleVersion: string): Promise<typeof WidgetView>
Parameters
- className: string
- moduleName: string
- moduleVersion: string
Returns Promise<typeof WidgetView>
- Defined in packages/base-manager/src/manager-base.ts:805

new_model

new_model(options: IModelOptions, serialized_state?: any): Promise<WidgetModel>
Create and return a promise for a new widget model

Example
```
widget_manager.new_model({
     model_name: 'IntSlider',
     model_module: '@jupyter-widgets/controls',
     model_module_version: '1.0.0',
     model_id: 'u-u-i-d'
}).then((model) => { console.log('Create success!', model); },
 (err) => {console.error(err)});
```
Parameters
- options: IModelOptions
  
  the options for creating the model.
- serialized_state: any = {}
  
  attribute values for the model.
Returns Promise<WidgetModel>
Implementation of IWidgetManager.new_model
- Defined in packages/base-manager/src/manager-base.ts:355

new_widget

new_widget(options: IWidgetOptions, serialized_state?: JSONObject): Promise<WidgetModel>
Create a comm and new widget model.
Parameters
- options: IWidgetOptions
  
  same options as new_model but comm is not required and additional options are available.
- serialized_state: JSONObject = {}
  
  serialized model attributes.
Returns Promise<WidgetModel>
Implementation of IWidgetManager.new_widget
- Defined in packages/base-manager/src/manager-base.ts:269

register_model

register_model(model_id: string, modelPromise: Promise<WidgetModel>): void
Parameters
- model_id: string
- modelPromise: Promise<WidgetModel>
Returns void
Implementation of IWidgetManager.register_model
- Defined in packages/base-manager/src/manager-base.ts:330

resolveUrl

resolveUrl(url: string): Promise<string>
Resolve a URL relative to the current notebook location.

The default implementation just returns the original url.
Parameters
- url: string
Returns Promise<string>
Implementation of IWidgetManager.resolveUrl
- Defined in packages/base-manager/src/manager-base.ts:760

setViewOptions

setViewOptions(options?: any): any
Modifies view options. Generally overloaded in custom widget manager implementations.
Parameters
- options: any = {}
Returns any
- Defined in packages/base-manager/src/manager-base.ts:127

set_state

set_state(state: IManagerState): Promise<WidgetModel[]>
Set the widget manager state.
Parameters
- state: IManagerState
  
  a Javascript object conforming to the application/vnd.jupyter.widget-state+json spec.
  
  Reconstructs all of the widget models in the state, merges that with the current manager state, and then attempts to redisplay the widgets in the state.
Returns Promise<WidgetModel[]>
- Defined in packages/base-manager/src/manager-base.ts:667

Class ManagerBaseAbstract

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ManagerBase

Properties

Private _models

Type declaration

[key: string]: Promise<WidgetModel>

Readonly comm_target_name

Methods

Protected Abstract _create_comm

Parameters

comm_target_name: string

Optional model_id: string

Optional data: JSONObject

Optional metadata: JSONObject

Optional buffers: ArrayBuffer[] | ArrayBufferView[]

Returns Promise<IClassicComm>

Protected Abstract _get_comm_info

Returns Promise<{}>

Protected _loadFromKernel

Returns Promise<void>

Protected _loadFromKernelModels

Returns Promise<void>

_make_model

Parameters

options: RequiredSome<IModelOptions, "model_id">

serialized_state: any = {}

Returns Promise<WidgetModel>

callbacks

Parameters

Optional view: WidgetView

Returns ICallbacks

clear_state

Returns

Returns Promise<void>

create_view

Notes

Type Parameters

VT extends DOMWidgetView<VT> = DOMWidgetView

Parameters

model: DOMWidgetModel

Optional options: any

Returns Promise<VT>

Type Parameters

VT extends WidgetView<VT> = WidgetView

Parameters

model: WidgetModel

Optional options: any

Returns Promise<VT>

disconnect

Returns void

Protected filterExistingModelState

Returns

Parameters

serialized_state: any

Returns any

get_model

Notes

Parameters

model_id: string

Returns Promise<WidgetModel>

get_state

Returns

Parameters

options: IStateOptions = {}

Returns Promise<IManagerState>

handle_comm_open

Parameters

comm: IClassicComm

msg: ICommOpenMsg<"iopub" | "shell">

Returns Promise<WidgetModel>

has_model

Notes

Class ManagerBase`Abstract`

`Private` _models

`Readonly` comm_target_name

`Protected` `Abstract` _create_comm

`Optional` model_id: string

`Optional` data: JSONObject

`Optional` metadata: JSONObject

`Optional` buffers: ArrayBuffer[] | ArrayBufferView[]

`Protected` `Abstract` _get_comm_info

`Protected` _loadFromKernel

`Protected` _loadFromKernelModels

`Optional` view: WidgetView

`Optional` options: any

`Optional` options: any

`Protected` filterExistingModelState

`Protected` `Abstract` loadClass

`Protected` loadModelClass

`Protected` loadViewClass