Class StencilEditorSet

Represents a collection of stencil and connector types and respective editors for a specific diagram type creation and editing.

Hierarchy

  • StencilEditorSet

Implements

Constructors

Properties

availableConnectorTypes: typeof ConnectorBase[] = ...

Connector types available in this stencil editor set.

connectorEditorTypes: Map<typeof ConnectorBase, typeof ConnectorBaseEditor>

A mapping collection of connectors and corresponding editors.

defaultConnectorEditor: typeof ConnectorBaseEditor = ConnectorBaseEditor
defaultConnectorType: typeof ConnectorBase = ConnectorBase

The default selected connector type.

defaultStencilEditor: typeof StencilBaseEditor = StencilBaseEditor
defaultStringSet?: StringSet

Localization strings.

displayName?: string

Display name for the editor set.

id: string

Editor set identifier.

newDocumentTemplate?: DiagramState

The default document to load when creating a new diagram for this set.

stencilEditorTypes: Map<typeof StencilBase, typeof StencilBaseEditor>

A mapping collection of stencils and corresponding editors.

stencilSet: IStencilSet

StencilSet covered by the editor set.

Methods

  • Adds an editor type for one or more connector types.

    Parameters

    Returns void

  • Adds an editor type for one or more stencil types.

    Parameters

    • editorType: typeof StencilBaseEditor

      editor type.

    • Rest ...stencilTypes: typeof StencilBase[]

      list of stencil types to be edited by this editor.

    Returns void

  • Returns an editor type for the provided stencil type.

    Parameters

    Returns typeof StencilBaseEditor

    if specified returns a custom editor type for the supplied stencil type, otherwise returns the default editor type for this stencil editor set.

Generated using TypeDoc