@ibm/bamoe-standalone-bpmn-and-dmn-editors-classic

BPMN and DMN Standalone Editors (classic)

Description

This library provides standalone DMN and BPMN Editors (one all-in-one JavaScript file each) that can be embedded into any web application.

A comprehensive API is also provided for setup and interaction with the Editor.

For the new DMN Editor, check the @ibm/bamoe-standalone-dmn-editor package.

Installation

• To add it to your package.json file:

  • npm install @ibm/bamoe-standalone-bpmn-and-dmn-editors-classic

• To import each Editor library:

  • import * as DmnEditor from "@ibm/bamoe-standalone-bpmn-and-dmn-editors-classic/dist/dmn"

  • import * as BpmnEditor from "@ibm/bamoe-standalone-bpmn-and-dmn-editors-classic/dist/bpmn"

Usage

The API is the same for both editors. Here is an example on how to open the DMN Editor:

const editor = DmnEditor.open({
  container: document.getElementById("dmn-editor-container"),
  initialContent: Promise.resolve(""),
  readOnly: false,
  resources: new Map([
    [
      "MyIncludedModel.dmn",
      {
        contentType: "text",
        content: Promise.resolve(""),
      },
    ],
  ]),
});

Available parameters:

• container: HTML element in which the Editor will be appended to.
• initialContent: Promise to a DMN model content. Can be empty. Examples:
  • Promise.resolve("")
  • Promise.resolve("<DIAGRAM_CONTENT_DIRECTLY_HERE>")
  • fetch("MyDmnModel.dmn").then(content => content.text())
• readOnly (optional, defaults to true): Use false to allow content edition, and true for read-only mode, in which the Editor will not allow changes.
• origin (optional, defaults to * when accessing the application with the file protocol, window.location.origin otherwise): If for some reason your application needs to change this parameter, you can use it.
• onError (optional, defaults to () => {}): If there's an error opening the Editor, this function will be called.

• resources (optional, defaults to []): Map of resources that will be provided for the Editor. This can be used, for instance, to provide included models for the DMN Editor or Work Item Definitions for the BPMN Editor. Each entry in the map has the resource name as its key and an object containing the content-type (text or binary) and the resource content (Promise similar to the initialContent parameter) as its value.

The returned object will contain the methods needed to manipulate the Editor:

• getContent(): Promise<string>: Returns a Promise containing the Editor content.
• setContent(normalizedPosixPathRelativeToTheWorkspaceRoot: string, content: string): Promise<void>: Sets the content of the Editor. The returning Promise will be rejected if setting the content fails.
• getPreview(): Promise<string>: Returns a Promise containing the SVG string of the current diagram.
• subscribeToContentChanges(callback: (isDirty: boolean) => void): (isDirty: boolean) => void: Setup a callback to be called on every content change in the Editor. Returns the same callback to be used for unsubscription.
• unsubscribeToContentChanges(callback: (isDirty: boolean) => void): void: Unsubscribes the passed callback from content changes.
• markAsSaved(): void: Resets the Editor state, signalizing that its content is saved. This will also fire the subscribed callbacks of content changes.
• undo(): void: Undo the last change in the Editor. This will also fire the subscribed callbacks of content changes.
• redo(): void: Redo the last undone change in the Editor. This will also fire the subscribed callbacks of content changes.
• close(): void: Closes the Editor.
• envelopeApi: MessageBusClientApi<KogitoEditorEnvelopeApi>: Advanced Editor API. See more details in MessageBusClientApi and KogitoEditorEnvelopeApi.
• canvas: Canvas API that exposes methods to manipulate the canvas.
  • getNodeIds(): Promise<string[]>: Returns a Promise containing the ID attributes of all nodes displayed in editors canvas.
  • getBackgroundColor(uuid: string): Promise<string>: Returns a Promise containing the background color of a node with provided UUID.
  • setBackgroundColor(uuid: string, backgroundColor: string): Promise<void>: Sets the background color of a node with provided UUID.
  • getBorderColor(uuid: string): Promise<string>: Returns a Promise containing the border color of a node with provided UUID.
  • setBorderColor(uuid: string, borderColor: string): Promise<void>: Sets the border color of a node with provided UUID.
  • getLocation(uuid: string): Promise<number[]>: Returns a Promise containing the canvas location of a node with provided UUID.
  • getAbsoluteLocation(uuid: string): Promise<number[]>: Returns a Promise containing the window location for a node with provided UUID.
  • getDimensions(uuid: string): Promise<number[]>: Returns a Promise containing the dimensions of a node with provided UUID.
  • applyState(uuid: string, state: string): Promise<void>: Applies state to a node given the UUID [None, Selected, Highlight, Invalid].
  • centerNode(uuid: string): Promise<void>: Centers node on viewable Canvas.