StarUML API

Modules (50)

Engine

Description

Engine

Functions Summary

Functions

Public API

addItem

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

elem Element
field string
val Element
Public API

addModel

Add a model element

parent Model
field string
model Model
- model element to be added
Returns: Model
Public API

addModelAndView

Add a model element and a view element.

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 nullable string
Array field name of the parent (default = 'ownedElements')
containerView nullable View
Container view where the view element to be contained (optional)
Public API

addViews

Add view elements.

diagram diagram
Diagram where added views to be placed.
views Array.<Core.View>
Views to be added.
Public API

deleteElements

Delete elements.

models Array.<Model>
Model elements to be deleted.
views Array.<View>
View elements to be deleted.
Public API

layoutDiagram

Layout diagram

editor Editor
diagram Diagram
direction string
separations {node:number,edge:number,rank:number}
Public API

modifyEdge

Modify points of an edge view.

editor Editor
edge EdgeView
points Points
Public API

moveDown

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

parent Element
field string
elem Element
Public API

moveParasiticView

Move a parasitic view.

editor Editor
view ParasiticView
alpha number
distance number
Public API

moveUp

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

parent Element
field string
elem Element
Public API

moveViews

Move views.

editor Editor
views Array.<View>
dx number
dy number
Public API

moveViewsChangingContainer

Move views by changing their container view.

editor Editor
views Array.<View>
dx number
dy number
containerView View
Public API

reconnectEdge

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

editor Editor
edge EdgeView
points Points
newParticipant NodeView
isTailSide boolean
Public API

relocate

Relocate an element to a new owner (parent).

elem Element
newOwner Element
field string
Public API

removeItem

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

elem Element
field string
val Element
Public API

resizeNode

Resize a node view.

editor Editor
node NodeView
left number
top number
right number
bottom number
Public API

setAutoResize

Change autoResize of node views.

editor Editor
views Array.<View>
autoResize boolean
Public API

setElemsProperty

Set value to a property of multiple elements

views Array.<View>
field string
value nullable
Public API

setFillColor

Change fill color of views.

editor Editor
views Array.<View>
color string
(color string in CSS style: e.g. "#ffffff")
Public API

setFont

Change font of views.

editor Editor
views Array.<View>
face string
Font face (family)
size number
Font size (in pixel)
color string
Font color
Public API

setFontColor

Change font color of views.

editor Editor
views Array.<View>
color string
Font color (color string in CSS style: e.g. "#ffffff")
Public API

setFontFace

Change font face of views.

editor Editor
views Array.<View>
fontFace string
Public API

setFontSize

Change font size of views.

editor Editor
views Array.<View>
fontSize number
Public API

setLineColor

Change line color of views.

editor Editor
views Array.<View>
color string
(color string in CSS style: e.g. "#ffffff")
Public API

setLineStyle

Change lineStyle of edge views.

editor Editor
views Array.<View>
lineStyle string
Public API

setProperties

Set values to multiple properties of an elements.

elem Element
fieldValueMap Object.<{string,?}>
Public API

setProperty

Set value to a property of an element.

elem Element
field string
value nullable
Public API

setStereotypeDisplay

Change stereotypeDisplay of views.

editor Editor
views Array.<View>
stereotypeDisplay string