Interface Shell

Shells extend Views with rich editing controls. A Shell instance is obtained by calling create.

Hierarchy

  • Shell

Index

Properties

Readonly editor

editor: Editor

The editor which this shell provides an interface for.

Readonly rootElement

rootElement: HTMLElement

Gets the DOM element that contains the shell. Not to be confused with the View.rootElement of the view wrapped by the shell, which will be a descendant of this element.

Readonly view

view: View

The view which this shell wraps.

Methods

dispose

  • dispose(): void
  • Removes the shell from the page, destroys the editor, and frees associated resources.

    Returns void

focus

  • focus(): void
  • Requests that the view within the shell be given input focus. This is just a convenient shorthand for the equivalent to shell.view.focus().

    Returns void

getPanel

  • Returns the side panel with the specified index: 0 for the first (usually "left") panel, 1 for the second panel. Returns null if the requested panel does not exist. This occurs if the shell options explicitly pass null as the template for the corresponding panel.

    Parameters

    • index: number

      Returns the requested panel, or null if it does not exist.

    Returns SidePanel

This API is still under development and is subject to change. Copyright © Math I Can Do Solutions Incorporated and/or its licensors.