Interface IWidgetManager

packages/base/src/manager.ts:117–203

 * The widget manager interface exposed on the Widget instances
 */
export interface IWidgetManager {
  /**
   * Get a promise for a model by model id.
   *
   * #### Notes
   * If a model is not found, undefined is returned (NOT a promise). However,
   * the calling code should also deal with the case where a rejected promise
   * is returned, and should treat that also as a model not found.
   */
  get_model(model_id: string): Promise<WidgetModel>;

  /**
   * Returns true if the given model is registered, otherwise false.
   *
   * #### Notes
   * This is a synchronous way to check if a model is registered.
   */
  has_model(model_id: string): boolean;

  /**
   * Register a model instance promise with the manager.
   *
   * By registering the model, it can later be retrieved with `get_model`.
   */
  register_model(model_id: string, modelPromise: Promise<WidgetModel>): void;

  /**
   * Create a comm and new widget model.
   * @param  options - same options as new_model but comm is not
   *                          required and additional options are available.
   * @param  serialized_state - serialized model attributes.
   */
  new_widget(
    options: IWidgetOptions,
    serialized_state?: JSONObject
  ): Promise<WidgetModel>;

  /**
   * Create and return a promise for a new widget model
   *
   * @param options - the options for creating the model.
   * @param serialized_state - attribute values for the 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)});
   *
   */
  new_model(
    options: IModelOptions,
    serialized_state?: JSONObject
  ): Promise<WidgetModel>;