Class CustomDmnJsModeler

Hierarchy

  • Modeler
    • CustomDmnJsModeler

Constructors

constructor

Methods

bindKeyboard canRedo canUndo destroy get getActiveView getActiveViewer getSelectionSize getStackIndex getViews import importXML off on open redo registerGlobalEventListener save saveXML unbindKeyboard undo unregisterGlobalEventListener

Constructors

constructor

Methods

bindKeyboard

  • bindKeyboard(): void

  • Binds the keyboard to the curretn document. Keyboard shortcuts will trigger actions in the editor after this has been called.

    Returns void

canRedo

  • canRedo(): boolean

  • Returns whether the command stack contains any actions that can be repeated. Can be used to determine if the redo button should be enabled or not.

    Returns boolean

canUndo

  • canUndo(): boolean

  • Returns whether the command stack contains any actions that can be undone. Can be used to determine if the undo button should be enabled or not.

    Returns boolean

destroy

  • destroy(): any

  • Destroys the modeler instance.

    Returns any

get

  • get(param): any

  • Parameters

    • param: any

    Returns any

getActiveView

  • getActiveView(): any

  • Returns the active view.

    Returns any

getActiveViewer

  • getActiveViewer(): any

  • Returns the active viewer.

    Returns any

getSelectionSize

  • getSelectionSize(): number

  • Returns the size of the current selection.

    Returns number

getStackIndex

  • getStackIndex(): number

  • Returns the current stack index.

    Returns number

getViews

  • getViews(): DmnView[]

  • Returns all available views.

    Returns DmnView[]

import

  • import(xml, open?): Promise<{
        warnings: ImportWarning[];
    }>

  • Imports the specified XML.

    Parameters

    • xml: string

      The XML to import

    • open: boolean = true

      Whether to open the view after importing

    Returns Promise<{
        warnings: ImportWarning[];
    }>

importXML

  • importXML(xml, options?, done): any

  • Imports the passed XML into the editor.

    Parameters

    • xml: string

      The XML to import

    • Optional options: {
          open: boolean;
      }

      Options for customization open: Whether to open the diagram after importing

      • open: boolean
    • done: ((error, warnings) => void)

      Callback that is executed after the import is done

        • (error, warnings): void

        • Parameters

          • error: undefined | Error
          • warnings: ImportWarning[]

          Returns void

    Returns any

off

  • off(event, handler): any

  • Unregisters a previously registered listener for bpmn-js.

    Parameters

    • event: string

      The name of the event

    • handler: ((event, data) => void)

      The previously registered listener to unregister

        • (event, data): void

        • Parameters

          • event: any
          • data: any

          Returns void

    Returns any

on

  • on(event, handler): any

  • Registers an event listener for bpmn-js.

    Parameters

    • event: string

      The name of the event

    • handler: ((event, data) => void)

      The listener to register

        • (event, data): void

        • Parameters

          • event: any
          • data: any

          Returns void

    Returns any

open

  • open(view): any

  • Opens the specified view.

    Parameters

    • view: DmnView

      The view to open

    Returns any

redo

  • redo(): void

  • Instructs the command stack to repeat the last undone action.

    Returns void

registerGlobalEventListener

  • registerGlobalEventListener(listener): void

  • Registers a global event listener that will receive all bpmn-js events.

    Parameters

    • listener: EventCallback

      The listener to register

    Returns void

save

  • save(params): Promise<{
        xml: string;
    }>

  • Saves the editor content as XML.

    Parameters

    • params: {
          format: boolean;
      }
      • format: boolean

    Returns Promise<{
        xml: string;
    }>

saveXML

  • saveXML(__namedParameters, callback): void

  • Parameters

    • __namedParameters: {
          format: any;
      }
      • format: any
    • callback: ((err, xml) => void)
        • (err, xml): void

        • Parameters

          • err: Error
          • xml: string

          Returns void

    Returns void

unbindKeyboard

  • unbindKeyboard(): void

  • Unbinds the keyboard from the current document. Keyboard shortcuts won't work anymore after this has been called.

    Returns void

undo

  • undo(): void

  • Instructs the command stack to undo the last action.

    Returns void

unregisterGlobalEventListener

  • unregisterGlobalEventListener(listener): void

  • Unregisters a previously registered global event listener.

    Parameters

    • listener: EventCallback

      The listener to unregister

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc