| Documentation

AppContext

The global application context. An instance of this class can be accessed via the global app variable. Do not try to create an instance using new keyword.

new AppContext()

Extends EventEmitter

Example

var appName = app.name
console.log(appName)

Instance Members

▸ name

Application name

name

Type: string

▸ version

Application version

version

Type: string

▸ type

All available element classes

type

Type: Object<string, Element>

▸ menu

An instance of MenuManager

menu

Type: MenuManager

▸ contextMenu

An instance of ContextMenuManager

contextMenu

Type: ContextMenuManager

▸ commands

An instance of CommandManager

commands

Type: CommandManager

▸ project

An instance of ProjectManager

project

Type: ProjectManager

▸ repository

An instance of Repository

repository

Type: Repository

▸ preferences

An instance of PreferenceManager

preferences

Type: PreferenceManager

▸ selections

An instance of SelectionManager

selections

Type: SelectionManager

▸ engine

An instance of Engine

engine

Type: Engine

▸ factory

An instance of Factory

factory

Type: Factory

▸ diagrams

An instance of DiagramManager

diagrams

Type: DiagramManager

▸ toolbox

An instance of ToolboxView

toolbox

Type: ToolboxView

▸ editorsHolder

An instance of EditorsHolderView

editorsHolder

Type: EditorsHolderView

▸ toolbar

An instance of ToolbarView

toolbar

Type: ToolbarView

▸ dialogs

An instance of DialogManager

dialogs

Type: DialogManager

▸ toast

An instance of ToastManager

toast

Type: ToastManager

▸ panelManager

An instance of PanelManager

panelManager

Type: PanelManager

▸ commandPalette

An instance of CommandPalette

commandPalette

Type: CommandPalette

▸ elementPickerDialog

An instance of ElementPickerDialog

elementPickerDialog

Type: ElementPickerDialog

▸ elementListPickerDialog

An instance of ElementListPickerDialog

elementListPickerDialog

Type: ElementListPickerDialog

▸ elementListEditorDialog

An instance of ElementListEditorDialog

elementListEditorDialog

Type: ElementListEditorDialog

▸ tagEditorDialog

An instance of TagEditorDialog

tagEditorDialog

Type: TagEditorDialog

▸ tagValueEditorDialog

An instance of TagValueEditorDialog

tagValueEditorDialog

Type: TagValueEditorDialog

▸ getAppPath()

Returns the full path to the application directory.

getAppPath(): !string

Returns

!string: fullPath reference

▸ getUserPath()

Returns the full path to the user data directory.

getUserPath(): !string

Returns

!string: fullPath reference

ProjectManager

Project Manager

new ProjectManager()

Extends EventEmitter

Instance Members

▸ getProject()

Return project

getProject(): Project

Returns

Project:

▸ getFilename()

Return current filename.

getFilename(): string

Returns

string:

▸ newProject()

New project

newProject(): Project

Returns

Project:

▸ closeProject()

Close project

closeProject()

▸ save(fullPath)

Save project to file

save(fullPath: string): Project

Parameters

fullPath (string)

Returns

Project: The saved project

▸ load(fullPath)

Load from a file

load(fullPath: string): Project

Parameters

fullPath (string)

Returns

Project: The loaded project. (null if failed to load)

▸ loadAsTemplate(fullPath)

Load from a file as template

loadAsTemplate(fullPath: string): Project

Parameters

fullPath (string)

Returns

Project: The loaded project. (null if failed to load)

▸ loadFromJson(data)

Load project from JSON

loadFromJson(data: Object): Project

Parameters

data (Object) JSON data.

Returns

Project: The loaded project. (null if failed to load)

▸ importFromFile(parent, fullPath)

Import model fragment from a file.

importFromFile(parent: Element, fullPath: string): Element

Parameters

parent (Element) Element to contain the imported element.

fullPath (string)

Returns

Element: The imported element (null if failed to import)

▸ importFromJson(parent, data)

Import from JSON

importFromJson(parent: Element, data: Object): Element

Parameters

parent (Element) Element to contain the imported element.

data (Object) JSON data

Returns

Element: The imported element (null if failed to import)

▸ exportToFile(elem, fullPath)

Export model fragment to a file.

exportToFile(elem: Element, fullPath: string): Element

Parameters

elem (Element) Element to be exported.

fullPath (string)

Returns

Element: The exported element

Events

▸ projectCreated

Triggered when a project is created

projectCreated

Properties

project (Project) : The created project

▸ beforeProjectClose

Triggered before the project is closed

beforeProjectClose

Properties

filename (string) : File name of the project

project (Project) : The closing project

▸ projectClosed

Triggered after the project is closed

projectClosed

▸ projectSaved

Triggered after the project is saved

projectSaved

Properties

filename (string) : File name of the project

project (Project) : The saved project

▸ projectLoaded

Triggered after a project is loaded

projectLoaded

Properties

filename (string) : File name of the project

project (Project) : The loaded project

▸ imported

Triggered after a model fragment is imported

imported

Properties

filename (string) : File name of the model fragment

elem (Element) : The imported model fragment

▸ exported

Triggered after a model fragment is exported

exported

Properties

filename (string) : File name of the model fragment

elem (Element) : The exported model fragment

CommandManager

Manages global application commands that can be called from menu items, key bindings, or subparts of the application.

new CommandManager()

Extends EventEmitter

Instance Members

▸ commands

Map of all registered global commands

commands

▸ commandNames

Command names

commandNames

▸ register(id, commandFn, name)

Registers a global command.

register(id: string, commandFn: function, name: string)

Parameters

id (string) unique identifier for command. Core commands in app use a simple command title as an id, for example "open.file". Extensions should use the following format: "author.myextension.mycommandname". For example, "lschmitt.csswizard.format.css".

commandFn (function) the function to call when the command is executed. Any arguments passed to execute() (after the id) are passed as arguments to the function. If the function is asynchronous, it must return a jQuery promise that is resolved when the command completes. Otherwise, the CommandManager will assume it is synchronous, and return a promise that is already resolved.

name (string) The name of command.

▸ execute(id, args)

Looks up and runs a global command. Additional arguments are passed to the command.

execute(id: string, args: ...any): object

Parameters

id (string) The ID of the command to run.

args (...any)

Returns

object: Result of the registered command function

Events

▸ commandRegistered

Triggered when a command is registered

commandRegistered

Properties

id (string) : The ID of the command

▸ beforeExecuteCommand

Triggered before a command is executed

beforeExecuteCommand

Properties

id (string) : The ID of the command

Repository

Repository maintains a set of elements.

Reponsibilities:

Applies operations. (Undo/Redo)
Query for retrieve elements.

new Repository()

Extends EventEmitter

Instance Members

▸ doOperation(operation)

Do an Operation If operation.bypass == true, the operation will not be pushed to UndoStack.

doOperation(operation: Object)

Parameters

operation (Object)

▸ undo()

Undo

undo()

▸ redo()

Redo

redo()

▸ clear()

Clear all maps and stacks

clear()

▸ isModified()

Return whether project is modified or not.

isModified(): boolean

Returns

boolean:

▸ isElement(elem)

Return true if the given parameter is an element in this Repository.

isElement(elem: Element): boolean

Parameters

elem (Element)

Returns

boolean:

▸ select(selector)

Return an array of elements selected by selector expression. This is a quite heavy operation, so you need to concern about performance.

Selector expression
    - Children selector
      ex) Package1:: -- all children of Package1

    - Type selector: "@<type>"
      ex) Package1::@UMLClass

    - Field selector: ".<field>"
      ex) Class1.attributes, Package1.owendElements

    - Value selector: "[field=value]"
      ex) Class1.operations[isAbstract=false]

    - Name selector: "<name>" (equivalent to "[name=<name>]")
      ex) Class1, Class1::Attribute1

Selector examples:

select(selector: string): Array<Element>

Parameters

selector (string)

Returns

Array<Element>:

▸ get(id)

Return element by id.

get(id: string): Element

Parameters

id (string) Identifier of element.

Returns

Element: Element of id.

▸ getInstancesOf(_typeName)

Return instances of a specified type name(s).

getInstancesOf(_typeName: (string | Array<string>)): Array<Element>

Parameters

_typeName ((string | Array<string>)) Type name(s) of instances to be returned.

Returns

Array<Element>: instances of the type name(s).

▸ find(predicate)

Find the first matched element satisfying the predicate.

find(predicate: function (Element): boolean): Element

Parameters

predicate (function (Element): boolean) A function to filter elements.

Returns

Element: A matched element.

▸ findAll(predicate)

Find all elements satisfying the predicate.

findAll(predicate: function (Element): boolean): Array<Element>

Parameters

predicate (function (Element): boolean) A function to filter elements.

Returns

Array<Element>: All matched elements.

▸ search(keyword, typeFilter)

Search elements by keyword and type

search(keyword: string, typeFilter: constructor): Array<Element>

Parameters

keyword (string)

typeFilter (constructor)

Returns

Array<Element>: elements

▸ lookupAndFind(namespace, name, typeFilter)

Lookup an element and then find. (See Element.prototype.lookup and find).

lookupAndFind(namespace: !Element, name: string, typeFilter: constructor): Element

Parameters

namespace (!Element) Element to start to lookup.

name (string) Name of element to find

typeFilter (constructor) Type filter. (e.g. type.UMLClass )

Returns

Element: A matched element.

▸ getRefsTo(elem, iterator)

Return all elements referencing to the given element.

getRefsTo(elem: Element, iterator: function (Element): boolean?): Array<Element>

Parameters

elem (Element) Element. (model element, view element, or diagram)

iterator (function (Element): boolean?) if given, returns instances only satisfying iterator function.

Returns

Array<Element>: Elements referencing to.

▸ getRelationshipsOf(model, iterator)

Return all instances of Relationship connected to the given model element.

getRelationshipsOf(model: Model, iterator: function (Element): boolean?): Array<Model>

Parameters

model (Model) Model element.

iterator (function (Element): boolean?) if given, returns instances only satisfying iterator function.

Returns

Array<Model>: Instances of Relationship.

▸ getViewsOf(model)

Return all views associated with the given model.

getViewsOf(model: Model): Array<View>

Parameters

model (Model) Model element.

Returns

Array<View>: View elements associated with.

▸ getOperationBuilder()

Return the instance of OperationBuilder

getOperationBuilder(): OperationBuilder

Returns

OperationBuilder:

Events

▸ reordered

Triggered when order of an element is changed

reordered

Properties

elem (Element) : The reordered element

▸ relocated

Triggered when an element is relocated to another parent element

relocated

Properties

elem (Element) : The relocated element

field (Element) : The field name of the parent

oldParent (Element) : Old parent

newParent (Element) : New parent

▸ created

Triggered after elements were created

created

Properties

createdElements (Array<Element>) : An array of created elements

▸ deleted

Triggered after elements were deleted

deleted

Properties

deletedElems (Array<Element>) : An array of deleted elements

▸ updated

Triggered after elements were updated

updated

Properties

updatedElems (Array<Element>) : An array of updated elements

▸ beforeExecuteOperation

Triggered before an operation is executed

beforeExecuteOperation

Properties

operation (Object) : Operation to be executed

▸ operationExecuted

Triggered after an operation is executed

operationExecuted

Properties

operation (Object) : Operation has executed

▸ beforeUndo

Triggered before undo an operation

beforeUndo

Properties

operation (Object) : Operation to be unexecuted

▸ undo

Triggered after undo an operation

undo

Properties

operation (Object) : Operation has unexecuted

▸ beforeRedo

Triggered before redo an operation

beforeRedo

Properties

operation (Object) : Operation to be reexecuted

▸ redo

Triggered after redo an operation

redo

Properties

operation (Object) : Operation has reexecuted

OperationBuilder

OperationBuilder is used to build an operation

new OperationBuilder()

Extends EventEmitter

Instance Members

▸ getTimestamp()

Return timestamp

getTimestamp()

▸ begin(name, bypass, opName)

Begin to make an operation.

begin(name: any, bypass: any, opName: string)

Parameters

name (any)

bypass (any)

opName (string) Operation name

▸ end()

Finish to make an operation.

end()

▸ discard()

Discard currently making operation.

discard()

▸ getOperation()

Return currently made operation.

getOperation(): Object

Returns

Object:

▸ insert(elem)

Insert an element.

insert(elem: Element)

Parameters

elem (Element)

▸ remove(elem)

Remove an element.

remove(elem: Element)

Parameters

elem (Element)

▸ fieldAssign(elem, field, val)

Assign value to field.

fieldAssign(elem: Element, field: string, val: any)

Parameters

elem (Element)

field (string)

val (any)

▸ fieldInsert(elem, field, val)

Insert an element to array field.

fieldInsert(elem: Element, field: string, val: any)

Parameters

elem (Element)

field (string)

val (any)

▸ fieldInsertAt(elem, field, val, pos)

Insert a value to array field at a specific position (index).

fieldInsertAt(elem: Element, field: string, val: any, pos: number)

Parameters

elem (Element)

field (string)

val (any)

pos (number)

▸ fieldRemove(elem, field, val)

Remove a value from array field.

fieldRemove(elem: Element, field: string, val: any)

Parameters

elem (Element)

field (string)

val (any)

▸ fieldRemoveAt(elem, field, val, pos, value)

Remove a value from array field at a specific position.

fieldRemoveAt(elem: Element, field: string, val: any, pos: number, value: any)

Parameters

elem (Element)

field (string)

val (any)

pos (number)

value (any)

▸ fieldReorder(elem, field, val, pos)

Change order of a value in array field.

fieldReorder(elem: Element, field: string, val: any, pos: number)

Parameters

elem (Element)

field (string)

val (any)

pos (number) Position to be placed

▸ fieldRelocate(elem, field, oldParent, newParent)

Relocate an element to another parent.

fieldRelocate(elem: Element, field: string, oldParent: number, newParent: number)

Parameters

elem (Element) Element to be relocated

field (string) Field name of parent

oldParent (number) Current parent

newParent (number) New parent to be located in

Engine

Engine has fundamental operations to manipulate model and view elements.

new Engine()

Instance Members

▸ addModel(parent, field, model)

Add a model element

addModel(parent: Model, field: string, model: Model): Model

Parameters

parent (Model)

field (string)

model (Model) model element to be added

Returns

Model:

▸ addViews(diagram, views)

Add view elements.

addViews(diagram: diagram, views: Array<Core.View>)

Parameters

diagram (diagram) Diagram where added views to be placed.

views (Array<Core.View>) Views to be added.

▸ addModelAndView(diagram, model, view, parent, parentField, containerView)

Add a model element and a view element.

addModelAndView(diagram: Diagram, model: Model, view: View, parent: Model, parentField: string?, containerView: View?)

Parameters

diagram (Diagram) Diagram where added views to be placed.

model (Model) Model element to be added.

view (View) View element to be added.

parent (Model) Parent element to contain the model element

parentField (string?) Array field name of the parent (default = 'ownedElements')

containerView (View?) Container view where the view element to be contained (optional)

▸ setProperty(elem, field, value)

Set value to a property of an element.

setProperty(elem: Element, field: string, value: Object)

Parameters

elem (Element)

field (string)

value (Object)

▸ setProperties(elem, fieldValueMap)

Set values to multiple properties of an elements.

setProperties(elem: Element, fieldValueMap: any)

Parameters

elem (Element)

fieldValueMap (any)

▸ setElemsProperty(elems, field, value, views)

Set value to a property of multiple elements

setElemsProperty(elems: any, field: string, value: Object, views: Array<View>)

Parameters

elems (any)

field (string)

value (Object)

views (Array<View>)

▸ deleteElements(models, views)

Delete elements.

deleteElements(models: Array<Model>, views: Array<View>)

Parameters

models (Array<Model>) Model elements to be deleted.

views (Array<View>) View elements to be deleted.

▸ addItem(elem, field, val)

Add an item to a particular array field of an element.

addItem(elem: Element, field: string, val: Element)

Parameters

elem (Element)

field (string)

val (Element)

▸ removeItem(elem, field, val)

Remove an item from a particular array field of an element.

removeItem(elem: Element, field: string, val: Element)

Parameters

elem (Element)

field (string)

val (Element)

▸ moveUp(parent, field, elem)

Reorder an item of array field of an element to index - 1.

moveUp(parent: Element, field: string, elem: Element)

Parameters

parent (Element)

field (string)

elem (Element)

▸ moveDown(parent, field, elem)

Reorder an item of array field of an element to index + 1.

moveDown(parent: Element, field: string, elem: Element)

Parameters

parent (Element)

field (string)

elem (Element)

▸ relocate(elem, newOwner, field)

Relocate an element to a new owner (parent).

relocate(elem: Element, newOwner: Element, field: string)

Parameters

elem (Element)

newOwner (Element)

field (string)

▸ moveViews(editor, views, dx, dy)

Move views.

moveViews(editor: Editor, views: Array<View>, dx: number, dy: number)

Parameters

editor (Editor)

views (Array<View>)

dx (number)

dy (number)

▸ moveParasiticView(editor, view, alpha, distance)

Move a parasitic view.

moveParasiticView(editor: Editor, view: ParasiticView, alpha: number, distance: number)

Parameters

editor (Editor)

view (ParasiticView)

alpha (number)

distance (number)

▸ resizeNode(editor, node, left, top, right, bottom)

Resize a node view.

resizeNode(editor: Editor, node: NodeView, left: number, top: number, right: number, bottom: number)

Parameters

editor (Editor)

node (NodeView)

left (number)

top (number)

right (number)

bottom (number)

▸ modifyEdge(editor, edge, points)

Modify points of an edge view.

modifyEdge(editor: Editor, edge: EdgeView, points: Points)

Parameters

editor (Editor)

edge (EdgeView)

points (Points)

▸ reconnectEdge(editor, edge, points, newParticipant, newParticipantModel, isTailSide)

Reconnect an end (head-side or tail-side) of edge view to new element.

reconnectEdge(editor: Editor, edge: EdgeView, points: Points, newParticipant: NodeView, newParticipantModel: any, isTailSide: boolean)

Parameters

editor (Editor)

edge (EdgeView)

points (Points)

newParticipant (NodeView)

newParticipantModel (any)

isTailSide (boolean)

▸ moveViewsChangingContainer(editor, views, dx, dy, containerView, containerModel)

Move views by changing their container view.

moveViewsChangingContainer(editor: Editor, views: Array<View>, dx: number, dy: number, containerView: View, containerModel: any)

Parameters

editor (Editor)

views (Array<View>)

dx (number)

dy (number)

containerView (View)

containerModel (any)

▸ setFillColor(editor, views, color)

Change fill color of views.

setFillColor(editor: Editor, views: Array<View>, color: string)

Parameters

editor (Editor)

views (Array<View>)

color (string) (color string in CSS style: e.g. "#ffffff")

▸ setLineColor(editor, views, color)

Change line color of views.

setLineColor(editor: Editor, views: Array<View>, color: string)

Parameters

editor (Editor)

views (Array<View>)

color (string) (color string in CSS style: e.g. "#ffffff")

▸ setFont(editor, views, face, size, color)

Change font of views.

setFont(editor: Editor, views: Array<View>, face: string, size: number, color: string)

Parameters

editor (Editor)

views (Array<View>)

face (string) Font face (family)

size (number) Font size (in pixel)

color (string) Font color

▸ setFontColor(editor, views, color)

Change font color of views.

setFontColor(editor: Editor, views: Array<View>, color: string)

Parameters

editor (Editor)

views (Array<View>)

color (string) Font color (color string in CSS style: e.g. "#ffffff")

▸ setFontFace(editor, views, fontFace)

Change font face of views.

setFontFace(editor: Editor, views: Array<View>, fontFace: string)

Parameters

editor (Editor)

views (Array<View>)

fontFace (string)

▸ setFontSize(editor, views, fontSize)

Change font size of views.

setFontSize(editor: Editor, views: Array<View>, fontSize: number)

Parameters

editor (Editor)

views (Array<View>)

fontSize (number)

▸ setStereotypeDisplay(editor, views, stereotypeDisplay)

Change stereotypeDisplay of views.

setStereotypeDisplay(editor: Editor, views: Array<View>, stereotypeDisplay: string)

Parameters

editor (Editor)

views (Array<View>)

stereotypeDisplay (string)

▸ setLineStyle(editor, views, lineStyle)

Change lineStyle of edge views.

setLineStyle(editor: Editor, views: Array<View>, lineStyle: string)

Parameters

editor (Editor)

views (Array<View>)

lineStyle (string)

▸ setAutoResize(editor, views, autoResize)

Change autoResize of node views.

setAutoResize(editor: Editor, views: Array<View>, autoResize: boolean)

Parameters

editor (Editor)

views (Array<View>)

autoResize (boolean)

▸ layoutDiagram(editor, diagram, direction, separations, edgeLineStyle)

Layout diagram

layoutDiagram(editor: Editor, diagram: Diagram, direction: string, separations: {node: number, edge: number, rank: number}, edgeLineStyle: number)

Parameters

editor (Editor)

diagram (Diagram)

direction (string)

separations ({node: number, edge: number, rank: number})

edgeLineStyle (number)

SelectionManager

Selection Manager

new SelectionManager()

Extends EventEmitter

Instance Members

▸ getSelectedModels()

Return selected model elements.

getSelectedModels(): Array<Model>

Returns

Array<Model>: Array of selected model elements.

▸ getSelectedViews()

Return selected view elements.

getSelectedViews(): Array<View>

Returns

Array<View>: Array of selected view elements.

▸ deselectAll()

Deselect all elements.

deselectAll()

▸ select(models, views)

Select elements (models and views)

select(models: Array<Model>, views: Array<View>)

Parameters

models (Array<Model>) Model elements to be selected.

views (Array<View>) View elements to be selected.

▸ selectModel(model)

Select a model element

selectModel(model: Model)

Parameters

model (Model) Model element to be selected.

▸ selectViews(views)

Select view elements

selectViews(views: Array<View>)

Parameters

views (Array<View>) Array of view elements to be selected.

▸ getSelected()

Return the first selected model element.

getSelected()

Events

▸ selectionChanged

Triggered when selection is changed

selectionChanged

Properties

selectedModels (Array<Model>) : An array of selected model elements

selectedViews (Array<View>) : An array of selected view elements

PreferenceManager

PreferenceManager only works in browser (it uses global localStorage object).

new PreferenceManager()

Extends EventEmitter

Instance Members

▸ get(key, defaultValue)

Return value of key

get(key: string, defaultValue: Object): Object

Parameters

key (string)

defaultValue (Object)

Returns

Object:

▸ set(key, value)

Change value of key

set(key: string, value: Object)

Parameters

key (string)

value (Object)

Factory

Factory creates model, view and diagram elements

new Factory()

Extends EventEmitter

Instance Members

▸ createDiagram(options)

Create a diagram

createDiagram(options: {id: string, parent: Model, diagramType: string}): Diagram

Parameters

options ({id: string, parent: Model, diagramType: string})

Returns

Diagram:

▸ createModel(options)

Create a model element

createModel(options: Object): Model

Parameters

options (Object)

Returns

Model:

▸ createModelAndView(options)

Create model and view elements

createModelAndView(options: Object): View

Parameters

options (Object)

Returns

View:

▸ createViewOf(options)

Create a view element of a given model based on diagram type

createViewOf(options: Object)

Parameters

options (Object)

▸ createViewAndRelationships(editor, x, y, model, containerView, viewType)

Create a view of a given model with relationship views

createViewAndRelationships(editor: Editor, x: number, y: number, model: Model, containerView: View, viewType: constructor)

Parameters

editor (Editor)

x (number)

y (number)

model (Model)

containerView (View)

viewType (constructor)

Events

▸ diagramCreated

Triggered when a diagram is created

diagramCreated

Properties

diagram (Diagram) : The created diagram

▸ elementCreated

Triggered when model and/or view elements are created

elementCreated

Properties

model (Model) : The created model element

view (View) : The created view element

MenuManager

Menu Manager

new MenuManager()

Instance Members

▸ updateStates(visibleStates, enabledStates, checkedStates)

Update states of menu items including main menu and context menus.

updateStates(visibleStates: Object<string, boolean>, enabledStates: Object<string, boolean>, checkedStates: Object<string, boolean>)

Parameters

visibleStates (Object<string, boolean>)

enabledStates (Object<string, boolean>)

checkedStates (Object<string, boolean>)

Example

// Hide `About StarUML` menu item
var visibleStates = {
  'app.about': false // id of the menu item
}
app.menu.updateStates(visibleStates, null, null)

ContextMenuManager

Context Menu Manager

new ContextMenuManager()

Instance Members

▸ popup(selector)

Popup a particular context menu

popup(selector: string)

Parameters

selector (string)

DiagramManager

Diagram Manager manages working diagrams

new DiagramManager()

Extends EventEmitter

Instance Members

▸ openDiagram(diagram)

Open diagram and add to working set

openDiagram(diagram: Diagram)

Parameters

diagram (Diagram)

▸ updateDiagram(diagram)

Update the diagram.

updateDiagram(diagram: Diagram)

Parameters

diagram (Diagram)

▸ closeDiagram(diagram)

Close the diagram.

closeDiagram(diagram: Diagram)

Parameters

diagram (Diagram)

▸ getWorkingDiagrams()

Return all working diagrams.

getWorkingDiagrams(): Array<Diagram>

Returns

Array<Diagram>:

▸ saveWorkingDiagrams()

Save a list of working diagrams of current project.

saveWorkingDiagrams()

▸ restoreWorkingDiagrams()

Restore a list of working diagrams and current diagram of current project.

restoreWorkingDiagrams()

▸ closeOthers()

Close all diagrams except active diagram.

closeOthers()

▸ closeAll()

Close all diagrams

closeAll()

▸ setCurrentDiagram(diagram, skipEvent)

Set current diagram.

setCurrentDiagram(diagram: Diagram, skipEvent: boolean)

Parameters

diagram (Diagram)

skipEvent (boolean)

▸ getCurrentDiagram()

Return current diagram

getCurrentDiagram(): Diagram

Returns

Diagram:

▸ nextDiagram()

Set next diagram as current diagram

nextDiagram()

▸ previousDiagram()

Set previous diagram as current diagram

previousDiagram()

▸ selectAll()

Select all view elements.

selectAll()

▸ deselectAll()

Deselect all.

deselectAll()

▸ selectInDiagram(view)

Select view in diagram. Open diagram if diagram is not opened and then scroll to the view.

selectInDiagram(view: View)

Parameters

view (View)

▸ repaint()

Repaint.

repaint()

▸ setZoomLevel(value)

Set zoom level

setZoomLevel(value: number)

Parameters

value (number) Zoom level between 0 and 1.

▸ getZoomLevel()

Return zoom level

getZoomLevel(): number

Returns

number: Zoom level between 0 and 1.

▸ toggleGrid()

Toggle grid

toggleGrid()

▸ showGrid()

Show grid

showGrid()

▸ hideGrid()

Hide grid

hideGrid()

▸ isGridVisible()

Return whether grid is visible.

isGridVisible(): boolean

Returns

boolean:

▸ getViewportSize(x)

Return view size.

getViewportSize(x: Point)

Parameters

x (Point) is width, y is height.

▸ scrollTo(x, y, animation)

Scroll diagram area to the given position

scrollTo(x: number, y: number, animation: boolean)

Parameters

x (number)

y (number)

animation (boolean)

▸ getScrollPosition()

Get postion of the scroll bar

getScrollPosition(): Point

Returns

Point:

▸ getDiagramArea()

Return left, top, right, bottom of diagram area with zoom level

getDiagramArea(): Rect

Returns

Rect:

Events

▸ workingDiagramAdd

Triggered when an diagram is open (added to working diagrams)

workingDiagramAdd

Properties

diagram (Diagram) : The diagram opened

▸ workingDiagramUpdate

Triggered when an working diagram is updated

workingDiagramUpdate

Properties

diagram (Diagram) : The diagram updated

▸ workingDiagramRemove

Triggered when an working diagram is closed

workingDiagramRemove

Properties

diagram (Diagram) : The diagram closed

▸ repaint

Triggered when current diagram has repainted

repaint

▸ currentDiagramChanged

currentDiagramChanged

Properties

diagram (Diagram)

Font

new Font(face: any, size: any, style: any)

Parameters

face (any)

size (any)

style (any)

Static Members

▸ FS_NORMAL

Font Style: Normal (0)

FS_NORMAL

Type: number

▸ FS_BOLD

Font Style: Bold (1)

FS_BOLD

Type: number

▸ FS_ITALIC

Font Style: Italic (2)

FS_ITALIC

Type: number

▸ FS_BOLD_ITALIC

Font Style: Bold Italic (3)

FS_BOLD_ITALIC

Type: number

Instance Members

▸ face

Font face

face

Type: string

▸ size

Font size

size

Type: string

▸ style

Font style

style

Type: string

DialogManager

new DialogManager()

Instance Members

▸ showInputDialog(message, initialValue)

Show Input Dialog

showInputDialog(message: string, initialValue: string): Dialog

Parameters

message (string)

initialValue (string)

Returns

Dialog:

▸ showTextDialog(message, text)

Show Text Dialog (Multiline Text)

showTextDialog(message: string, text: string): Dialog

Parameters

message (string)

text (string) initial text

Returns

Dialog:

▸ showSelectRadioDialog(message, options, items)

Show Select Dialog (Radio-type)

showSelectRadioDialog(message: string, options: any, items: Array<{text: string, value: string}>): Dialog

Parameters

message (string)

options (any)

items (Array<{text: string, value: string}>)

Returns

Dialog:

▸ showSelectDropdownDialog(message, options, items)

Show Select Dialog (Dropdown-type)

showSelectDropdownDialog(message: string, options: any, items: Array<{text: string, value: string}>): Dialog

Parameters

message (string)

options (any)

items (Array<{text: string, value: string}>)

Returns

Dialog:

▸ showColorDialog(color)

Show Color Dialog

showColorDialog(color: string): Dialog

Parameters

color (string) initial color

Returns

Dialog:

▸ showFontDialog(font)

Show Font Dialog

showFontDialog(font: Graphics.Font): Dialog

Parameters

font (Graphics.Font) Initial font

Returns

Dialog:

▸ showSimpleDialog(message)

Show Simple Dialog. This is a synchronous system dialog.

showSimpleDialog(message: string): string

Parameters

message (string)

Returns

string: button id

▸ showConfirmDialog(message)

Show Confirm Dialog. This is a synchronous system dialog.

showConfirmDialog(message: string): string

Parameters

message (string)

Returns

string: button id

▸ showAlertDialog(message)

Show Alert Dialog. This is a synchronous system dialog.

showAlertDialog(message: string): string

Parameters

message (string)

Returns

string: button id

▸ showInfoDialog(message)

Show Information Dialog. This is a synchronous system dialog.

showInfoDialog(message: string): string

Parameters

message (string)

Returns

string: button id

▸ showOpenDialog(title, defaultPath, filters, options)

Show Open Dialog. This is a synchronous system dialog.

showOpenDialog(title: string, defaultPath: string, filters: Array<{name: string, extensions: Array<string>}>, options: Object): Array<string>

Parameters

title (string)

defaultPath (string)

filters

(Array<{name: string, extensions: Array<string>}>
            = DEFAULT_FILE_FILTERS)

options (Object)

Returns

Array<string>: filenames or null

▸ showSaveDialog(title, defaultPath, filters)

Show SaveDialog. This is a synchronous system dialog.

showSaveDialog(title: string, defaultPath: string, filters: Array<{name: string, extensions: Array<string>}>): string

Parameters

title (string)

defaultPath (string)

filters

(Array<{name: string, extensions: Array<string>}>
            = DEFAULT_FILE_FILTERS)

Returns

string: filename or null

▸ showSaveConfirmDialog(filename)

Show Save Confirmation Dialog. This is a synchronous system dialog.

showSaveConfirmDialog(filename: string): number

Parameters

filename (string)

Returns

number: dialog modal result

▸ showErrorDialog(message)

Show Error Dialog. This is a synchronous system dialog.

showErrorDialog(message: string)

Parameters

message (string)

Dialog

new Dialog($dlg: $.Element, promise: Promise)

Parameters

$dlg ($.Element) The dialog jQuery element

promise (Promise) A promise that will be resolved with the ID of the clicked button when the dialog is dismissed. Never rejected.

Instance Members

▸ getElement()

getElement()

▸ getPromise()

getPromise()

▸ close()

Closes the dialog if is visible

close()

▸ then(callback)

Adds a 'then' callback to the dialog promise

then(callback: function (result: any))

Parameters

callback (function (result: any))

EditorsHolderView

EditorsHolder contains StyleEditorView, PropertyEditorView, and DocumentationEditorView

new EditorsHolderView()

Instance Members

▸ toggle()

Toggle EditorsHolder

toggle()

▸ show()

Show EditorsHolder

show()

▸ hide()

Hide EditorsHolder

hide()

▸ isVisible()

Return whether EditorsHolder is visible or not

isVisible(): boolean

Returns

boolean:

ElementPickerDialog

Element Picker Dialog

new ElementPickerDialog()

Instance Members

▸ expand(elem, expandAllParents)

Expand a tree node

expand(elem: Core.Model, expandAllParents: boolean?)

Parameters

elem (Core.Model) Element to be expanded

expandAllParents (boolean?) Whether expand all parents or not

▸ select(elem, scrollTo)

Select an element

select(elem: Core.Model, scrollTo: boolean?)

Parameters

elem (Core.Model) Element to be selected

scrollTo (boolean?) Whether scroll to the element or not

▸ showDialog(title, selected, type)

Show Element Picker Dialog

showDialog(title: string, selected: Element?, type: constructor?): Dialog

Parameters

title (string) Title of the dialog

selected (Element?) Initial selected element when the dialog is shown

type (constructor?) Type of selectable element

Returns

Dialog:

ElementListEditorDialog

Element List Editor Dialog

new ElementListEditorDialog()

Instance Members

▸ showDialog(elem, field)

Show Element List Editor Dialog.

showDialog(elem: Core.Model, field: string): Dialog

Parameters

elem (Core.Model)

field (string) Array field name to be listed

Returns

Dialog:

ElementListPickerDialog

Element List Picker Dialog

new ElementListPickerDialog()

Instance Members

▸ showDialog(title, elems)

Show Element List Picker Dialog.

showDialog(title: string, elems: Array<Core.Model>): Dialog

Parameters

title (string)

elems (Array<Core.Model>)

Returns

Dialog:

Panel

Represents a panel below the editor area (a child of ".content"). Don'y try to instantiate, use PanelManager.createBottomPanel().

new Panel($panel: jQueryObject, minSize: number)

Parameters

$panel (jQueryObject) The entire panel, including any chrome, already in the DOM.

minSize (number) Minimum height of panel in px.

Instance Members

▸ isVisible()

Return whether this panel is visible or not.

isVisible(): boolean

Returns

boolean:

▸ setVisible(visible)

Set the visibility of the panel

setVisible(visible: boolean)

Parameters

visible (boolean)

PanelManager

new PanelManager()

Instance Members

▸ createBottomPanel(id, $panel, minSize)

Creates a new panel beneath the editor area and above the status bar footer. Panel is initially invisible.

createBottomPanel(id: string, $panel: jQueryObject, minSize: number): Panel

Parameters

id (string) Unique id for this panel. Use package-style naming, e.g. "myextension.feature.panelname"

$panel (jQueryObject) DOM content to use as the panel. Need not be in the document yet.

minSize (number) Minimum height of panel in px.

Returns

Panel:

TagEditorDialog

Tag Editor Dialog

new TagEditorDialog()

Instance Members

▸ showDialog(elem)

Show Tag Editor Dialog.

showDialog(elem: Core.Model): Dialog

Parameters

elem (Core.Model) An element

Returns

Dialog:

TagValueEditorDialog

Tag Value Editor Dialog

new TagValueEditorDialog()

Instance Members

▸ showDialog(tag, attr)

Show Tag Value Editor Dialog.

showDialog(tag: Core.Tag, attr: UMLAttribute): Dialog

Parameters

tag (Core.Tag) A tag element

attr (UMLAttribute) A corresponding Attribute of Stereotype

Returns

Dialog:

ToastManager

new ToastManager()

Instance Members

▸ info(message)

Show information toast.

info(message: string)

Parameters

message (string)

▸ warning(message)

Show warning toast.

warning(message: string)

Parameters

message (string)

▸ error(message)

Show error toast.

error(message: string)

Parameters

message (string)

ToolbarView

Toolbar

new ToolbarView()

Instance Members

▸ toggle()

Toggle Toolbar

toggle()

▸ show()

Show Toolbar

show()

▸ hide()

Hide Toolbar

hide()

▸ isVisible()

Return whether Toolbar is visible or not

isVisible(): boolean

Returns

boolean: Visibility of Toolbar

ToolboxView

Toolbox View

new ToolboxView()

Extends EventEmitter

Instance Members

▸ groups

Groups

groups

Type: Object<string, {id: string, title: string}>

▸ items

Items

items

Type: Object<string, {id: string, groupId: string, title: string}>

▸ activeItem

Active Item

activeItem

Type: string

▸ activeItemLocked

Active Item Locked

activeItemLocked

Type: boolean

▸ setActiveItemLock(locked)

Lock the active item

setActiveItemLock(locked: boolean)

Parameters

locked (boolean)

▸ selectItem(itemId)

Select an item.

selectItem(itemId: string)

Parameters

itemId (string)

▸ expandGroup(groupId)

Expand a group.

expandGroup(groupId: string)

Parameters

groupId (string)

▸ collapseGroup(groupId)

Collapse a group.

collapseGroup(groupId: string)

Parameters

groupId (string)

▸ toggle()

Toggle ToolboxView

toggle()

▸ show()

Show ToolboxView

show()

▸ hide()

Hide ToolboxView

hide()

▸ isVisible()

Return whether ToolboxView is visible or not

isVisible(): boolean

Returns

boolean:

Element

new Element()

Static Members

▸ AK_PRIM

Constant for Attribute Kind ('prim')

AK_PRIM

Type: string

▸ AK_ENUM

Constant for Attribute Kind ('enum')

AK_ENUM

Type: string

▸ AK_REF

Constant for Attribute Kind ('ref')

AK_REF

Type: string

▸ AK_REFS

Constant for Attribute Kind ('refs')

AK_REFS

Type: string

▸ AK_OBJ

Constant for Attribute Kind ('obj')

AK_OBJ

Type: string

▸ AK_OBJS

Constant for Attribute Kind ('objs')

AK_OBJS

Type: string

▸ AK_VAR

Constant for Attribute Kind ('var')

AK_VAR

Type: string

▸ AK_CUSTOM

Constant for Attribute Kind ('custom')

AK_CUSTOM

Type: string

▸ getSuperType(subType)

Return a super type of a given type.

getSuperType(subType: constructor): constructor

Parameters

subType (constructor)

Returns

constructor: superType of subType

▸ getCommonType(elems)

Return a generalized type of given elements.

getCommonType(elems: Array<Element>): constructor

Parameters

elems (Array<Element>)

Returns

constructor:

▸ getNewName(array, prefix)

Find an available name in a given array. (e.g. Class1, Class2, ... )

getNewName(array: Array<Element>, prefix: string): string

Parameters

array (Array<Element>)

prefix (string) Prefix for name

Returns

string: Return a new name

▸ mergeProps(elems, prop)

Merge values of a particular property of an array of elements If all values are same, then return the value. Otherwise, return null.

mergeProps(elems: Array<Element>, prop: string)

Parameters

elems (Array<Element>)

prop (string)

Instance Members

▸ _id

globaly unique identifier

_id

Type: string

▸ _parent

reference to its parent

_parent

Type: object

▸ getDisplayClassName()

Return class name for display (e.g. "Class" rather than "UMLClass").

getDisplayClassName(): string

Returns

string:

▸ getClass()

Return Class. (equivalent to type[element.getClassName()])

getClass(): constructor

Returns

constructor:

▸ getClassName()

Return Class name.

getClassName(): string

Returns

string:

▸ getMetaClass()

Return Meta Class.

getMetaClass(): Object

Returns

Object:

▸ getMetaAttributes()

Return Meta Attributes.

getMetaAttributes(): Array<{name: string, kind: string, type: string}>

Returns

Array<{name: string, kind: string, type: string}>:

▸ getParentField()

Return name of parent's field containing this object.

getParentField(): string

Returns

string: Field name (e.g. 'ownedElements')

▸ getNodeIcon()

Return CSS class name of icon for this object. (Shown in Explorer)

getNodeIcon(): string

Returns

string: iconClass명 (e.g. 'icon-UMLClass')

▸ getNodeText(options)

Return textual string for this object. (Shown in Explorer)

getNodeText(options: object): string

Parameters

options (object)

Returns

string: Text (e.g. '< >Class1')

▸ getOrdering(index)

Return ordering priority number. (Lower value comes first in Explorer)

getOrdering(index: number): Number

Parameters

index (number)

Returns

Number:

▸ getChildNodes(sort)

Return all child nodes to be shown in Explorer.

getChildNodes(sort: boolean): Array<Element>

Parameters

sort (boolean)

Returns

Array<Element>:

▸ getChildren()

Return all children.

getChildren(): Array<Element>

Returns

Array<Element>:

▸ traverse(fun)

Traverse all nodes in the tree structure. (Breadth-First Traversal)

traverse(fun: function (elem: Element))

Parameters

fun (function (elem: Element))

▸ traverseDepthFirst(fun)

Traverse all nodes in the tree structure. (Depth-First Traversal)

traverseDepthFirst(fun: function (elem: Element))

Parameters

fun (function (elem: Element))

▸ traverseField(field, fun)

Traverse a specific field chains. (Breadth-First Traversal)

traverseField(field: string, fun: function)

Parameters

field (string) Field name to traverse (e.g. 'ownedElements')

fun (function)

▸ traverseFieldDepthFirst(field, fun)

Traverse a specific field chains. (Depth-First Traversal)

traverseFieldDepthFirst(field: string, fun: function)

Parameters

field (string) Field name to traverse (e.g. 'ownedElements')

fun (function)

▸ traverseUp(fun)

Traverse up along with the _parent chain.

traverseUp(fun: function)

Parameters

fun (function)

▸ lookup(name, typeFilter, namespace)

Find an element by name. Find through ownedElements chain, and then lookup through _parent chain.

lookup(name: string, typeFilter: constructor, namespace: Element): Element

Parameters

name (string)

typeFilter (constructor)

namespace (Element) Lookup only inside of namespace

Returns

Element: Return the first matched element.

▸ findByName(name)

Find by name in child elements

findByName(name: (string | Array<string>)): Element

Parameters

name ((string | Array<string>))

Returns

Element:

▸ lookdown(pathName)

Look down an element along parent-children chains.

lookdown(pathName: Array<string>): Element

Parameters

pathName (Array<string>)

Returns

Element:

▸ isOneOfTheContainers(elem)

Return true only if a given elem is one of the container.

isOneOfTheContainers(elem: Element): boolean

Parameters

elem (Element)

Returns

boolean:

▸ canContainKind(kind)

Return true only if it can contain the kind of elements

canContainKind(kind: string): Boolean

Parameters

kind (string)

Returns

Boolean:

▸ canContain(elem)

Return true only if it can contain a given element.

canContain(elem: Element): Boolean

Parameters

elem (Element)

Returns

Boolean:

▸ canCopy()

Return true only if it could be copied.

canCopy(): Boolean

Returns

Boolean:

▸ canDelete()

Return true only if it could be deleted alone.

canDelete(): Boolean

Returns

Boolean:

▸ canHide()

Return true only if it could be hidden without deletion.

canHide(): Boolean

Returns

Boolean:

▸ canPaste(kind, copyContext)

Return true only if it can accomodate elements in clipboard based on a given kind and copyContext.

canPaste(kind: string, copyContext: {field: string}): Boolean

Parameters

kind (string)

copyContext ({field: string})

Returns

Boolean:

Model

new Model()

Extends Element

Instance Members

▸ name

name

Type: string

▸ ownedElements

ownedElements

Type: Array<Model>

▸ getViewType()

Get a corresponding view type

getViewType(): constructor

Returns

constructor:

▸ getPath(base)

Get path to from a given base

getPath(base: Model): Array<string>

Parameters

base (Model)

Returns

Array<string>:

▸ getPathname()

Return full pathname

getPathname(): string

Returns

string:

▸ canContain(elem)

Return true only if it can contain a given element.

canContain(elem: Element): Boolean

Parameters

elem (Element)

Returns

Boolean:

▸ canContainDiagramKind(kind)

Determines whether a given diagram type name can be contained or not.

canContainDiagramKind(kind: string): Boolean

Parameters

kind (string)

Returns

Boolean:

▸ canContainDiagram(diagram)

Determines whether a given diagram can be contained or not.

canContainDiagram(diagram: Diagram): Boolean

Parameters

diagram (Diagram)

Returns

Boolean:

▸ canRelocateTo(model)

Determines whether this object can be relocated to a given element.

canRelocateTo(model: Model): Boolean

Parameters

model (Model)

Returns

Boolean:

Tag

new Tag()

Extends Model

Static Members

▸ TK_STRING

TagKind: String ('string')

TK_STRING

Type: string

▸ TK_REFERENCE

TagKind: Reference ('reference')

TK_REFERENCE

Type: string

▸ TK_BOOLEAN

TagKind: Boolean ('boolean')

TK_BOOLEAN

Type: string

▸ TK_NUMBER

TagKind: Number ('number')

TK_NUMBER

Type: string

Instance Members

▸ kind

kind

Type: TagKind

▸ value

value

Type: any

▸ reference

reference

Type: Model

▸ checked

checked

Type: boolean

▸ number

number

Type: number

▸ hidden

hidden

Type: boolean

Hyperlink

new Hyperlink()

Extends Model

Instance Members

▸ reference

reference

Type: Model

▸ url

url

Type: any

ExtensibleModel

new ExtensibleModel()

Extends Model

Instance Members

▸ documentation

documentation

Type: string

▸ tags

Relationship

new Relationship()

Extends ExtensibleModel

DirectedRelationship

new DirectedRelationship()

Extends Relationship

Instance Members

▸ target

target

Type: Model

▸ source

source

Type: Model

RelationshipEnd

new RelationshipEnd()

Extends ExtensibleModel

Instance Members

▸ reference

reference

Type: Model

UndirectedRelationship

new UndirectedRelationship()

Extends Relationship

Instance Members

▸ end1

end1

Type: RelationshipEnd

▸ end2

end2

Type: RelationshipEnd

View

new View()

Extends Element

Static Members

▸ SK_NO

Constant for Selectable Kind

SK_NO

Type: number

▸ SK_YES

Constant for Selectable Kind

SK_YES

Type: number

▸ SK_PROPAGATE

Constant for Selectable Kind

SK_PROPAGATE

Type: number

Instance Members

▸ model

model

Type: Model

▸ subViews

subViews

Type: Array<View>

▸ containerView

containerView

Type: View

▸ containedViews

containedViews

Type: Array<View>

▸ visible

visible

Type: boolean

▸ enabled

enabled

Type: boolean

▸ selected

selected

Type: boolean

▸ selectable

selectable

Type: number

▸ lineColor

lineColor

Type: string

▸ fillColor

fillColor

Type: string

▸ fontColor

fontColor

Type: string

▸ font

font

Type: Font

▸ showShadow

showShadow

Type: boolean

▸ traverse(fun)

Traverse all sub views recursively (Breadth-First Traversal)

traverse(fun: function)

Parameters

fun (function)

▸ traverseDepthFirst(fun)

Traverse all sub views recursively (Depth-First Traversal)

traverseDepthFirst(fun: function)

Parameters

fun (function)

▸ getDiagram()

Return a diagram containg this view object.

getDiagram(): View

Returns

View:

NodeView

new NodeView()

Extends View

Static Members

▸ SZ_NONE

Sizing Mode: None (0)

SZ_NONE

Type: number

▸ SZ_HORZ

Sizing Mode: Horizontal (1)

SZ_HORZ

Type: number

▸ SZ_VERT

Sizing Mode: Vertical (2)

SZ_VERT

Type: number

▸ SZ_RATIO

Sizing Mode: Ratio (3)

SZ_RATIO

Type: number

▸ SZ_FREE

Sizing Mode: Free (4)

SZ_FREE

Type: number

▸ MM_NONE

Move Mode: None (0)

MM_NONE

Type: number

▸ MM_HORZ

Move Mode: Horizontal (1)

MM_HORZ

Type: number

▸ MM_VERT

Move Mode: Vertical (2)

MM_VERT

Type: number

▸ MM_FREE

Move Mode: Free (3)

MM_FREE

Type: number

Instance Members

▸ left

left

Type: number

▸ top

top

Type: number

▸ width

width

Type: number

▸ height

height

Type: number

▸ minWidth

minWidth

Type: number

▸ minHeight

minHeight

Type: number

▸ sizable

sizable

Type: number

▸ movable

movable

Type: number

▸ autoResize

autoResize

Type: Boolean

▸ getRight()

getRight()

▸ setRight(value)

setRight(value: any)

Parameters

value (any)

▸ getBottom()

getBottom()

▸ setBottom(value)

setBottom(value: any)

Parameters

value (any)

▸ getCenter()

getCenter()

EdgeView

new EdgeView()

Extends View

Static Members

▸ LM_SOLID

Line Mode: Solid (0)

LM_SOLID

Type: number

▸ LM_DOT

Line Mode: Dot (1)

LM_DOT

Type: number

▸ LM_DASH

Line Mode: Dash (2)

LM_DASH

Type: number

▸ LS_RECTILINEAR

Line Style: Rectilinear (0)

LS_RECTILINEAR

Type: number

▸ LS_OBLIQUE

Line Style: Oblique (1)

LS_OBLIQUE

Type: number

▸ LS_ROUNDRECT

Line Style: RoundRect (2)

LS_ROUNDRECT

Type: number

▸ LS_CURVE

Line Style: Curve (3)

LS_CURVE

Type: number

▸ LS_DIRECT

Line Style: Direct (4)

LS_DIRECT

Type: number

▸ ES_FLAT

Line End Style: Flat (0)

ES_FLAT

Type: number

▸ ES_STICK_ARROW

Line End Style: Stick Arrow (1)

ES_STICK_ARROW

Type: number

▸ ES_SOLID_ARROW

Line End Style: Solid Arrow (2)

ES_SOLID_ARROW

Type: number

▸ ES_TRIANGLE

Line End Style: Triangle (3)

ES_TRIANGLE

Type: number

▸ ES_FILLED_TRIANGLE

Line End Style: Filled Triangle (4)

ES_FILLED_TRIANGLE

Type: number

▸ ES_DIAMOND

Line End Style: Diamond (5)

ES_DIAMOND

Type: number

▸ ES_FILLED_DIAMOND

Line End Style: Filled Diamond (6)

ES_FILLED_DIAMOND

Type: number

▸ ES_ARROW_DIAMOND

Line End Style: Arrow Diamond (7)

ES_ARROW_DIAMOND

Type: number

▸ ES_ARROW_FILLED_DIAMOND

Line End Style: Arrow Filled Diamond (8)

ES_ARROW_FILLED_DIAMOND

Type: number

▸ ES_PLUS

Line End Style: Plus (9)

ES_PLUS

Type: number

▸ ES_CIRCLE

Line End Style: Circle (10)

ES_CIRCLE

Type: number

▸ ES_CIRCLE_PLUS

Line End Style: Circle Plus (11)

ES_CIRCLE_PLUS

Type: number

▸ ES_CROWFOOT_ONE

Line End Style: Crow Foot One (12)

ES_CROWFOOT_ONE

Type: number

▸ ES_CROWFOOT_MANY

Line End Style: Crow Foot Many (13)

ES_CROWFOOT_MANY

Type: number

▸ ES_CROWFOOT_ZERO_ONE

Line End Style: Crow Foot Zero-to-One (14)

ES_CROWFOOT_ZERO_ONE

Type: number

▸ ES_CROWFOOT_ZERO_MANY

Line End Style: Crow Foot Zero-to-Many (15)

ES_CROWFOOT_ZERO_MANY

Type: number

Instance Members

▸ head

head

Type: View

▸ tail

tail

Type: View

▸ lineStyle

lineStyle

Type: number

LabelView

new LabelView()

Extends NodeView

Static Members

▸ DK_HORZ

Direction Kind: Horizontal (0)

DK_HORZ

Type: number

▸ DK_VERT

Direction Kind: Vertical (1)

DK_VERT

Type: number

Instance Members

▸ underline

underline

Type: string

▸ text

text

Type: string

▸ horizontalAlignment

horizontalAlignment

Type: number

▸ verticalAlignment

verticalAlignment

Type: number

▸ direction

direction

Type: number

▸ wordWrap

wordWrap

Type: boolean

ParasiticView

new ParasiticView()

Extends NodeView

Instance Members

▸ alpha

alpha

Type: number

▸ distance

distance

Type: number

NodeParasiticView

new NodeParasiticView()

Extends ParasiticView

Instance Members

▸ hostNode

hostNode

Type: NodeView

EdgeParasiticView

new EdgeParasiticView()

Extends ParasiticView

Static Members

▸ EP_HEAD

Edge Position: Head (0)

EP_HEAD

Type: number

▸ EP_MIDDLE

Edge Position: Middle (1)

EP_MIDDLE

Type: number

▸ EP_TAIL

Edge Position: Tail (2)

EP_TAIL

Type: number

Instance Members

▸ hostEdge

hostEdge

Type: EdgeView

▸ edgePosition

edgePosition

Type: number

NodeLabelView

new NodeLabelView()

Extends NodeParasiticView

Instance Members

▸ underline

underline

Type: string

▸ wordWrap

wordWrap

Type: boolean

EdgeLabelView

new EdgeLabelView()

Extends EdgeParasiticView

Instance Members

▸ underline

underline

Type: string

▸ wordWrap

wordWrap

Type: boolean

NodeNodeView

new NodeNodeView()

Extends NodeParasiticView

EdgeNodeView

new EdgeNodeView()

Extends EdgeParasiticView

Diagram

new Diagram()

Extends ExtensibleModel

Static Members

▸ LD_TB

Diagram Layout Direction: Top to Bottom ('TB')

LD_TB

Type: string

▸ LD_BT

Diagram Layout Direction: Bottom to Top ('BT')

LD_BT

Type: string

▸ LD_LR

Diagram Layout Direction: Left to Right ('LR')

LD_LR

Type: string

▸ LD_RL

Diagram Layout Direction: Right to Left ('RL')

LD_RL

Type: string

Instance Members

▸ visible

visible

Type: boolean

▸ defaultDiagram

defaultDiagram

Type: boolean

▸ ownedViews

ownedViews

Type: Array<View>

▸ selectedViews

selectedViews

Type: Array<View>

▸ getViewOf(model, viewType)

Get a view of a specific model

getViewOf(model: Model, viewType: constructor?): View

Parameters

model (Model)

viewType (constructor?)

Returns

View:

Project

new Project()

Extends ExtensibleModel

FreelineEdgeView

new FreelineEdgeView()

Extends EdgeView

Unique token used to indicate user-driven cancellation of Save As (as opposed to file IO error)

Components

AppContext

ProjectManager

CommandManager

Repository

OperationBuilder

Engine

SelectionManager

PreferenceManager

Factory

MenuManager

ContextMenuManager

DiagramManager

Font

UI Components

DialogManager

Dialog

EditorsHolderView

ElementPickerDialog

ElementListEditorDialog

ElementListPickerDialog

Panel

PanelManager

TagEditorDialog

TagValueEditorDialog

ToastManager

ToolbarView

ToolboxView

Elements

Element

Model

Tag

Hyperlink

ExtensibleModel

Relationship

DirectedRelationship

RelationshipEnd

UndirectedRelationship

View

NodeView

EdgeView

LabelView

ParasiticView

NodeParasiticView

EdgeParasiticView

NodeLabelView

EdgeLabelView

NodeNodeView

EdgeNodeView

Diagram

Project

FreelineEdgeView