Diagram API overview

Diagram methods

Name	Description
addShape()	Creates a custom shape
autoPlace()	Automatically arranges connected diagram shapes in the hierarchical structure
collapseItem()	Hides all children of the target shape or collapses the group/swimlane
destructor()	Removes a diagram instance and releases occupied resources
expandItem()	Shows all children of the target shape or expands the group/swimlane
getScrollState()	Returns the position of the diagram inner scroll
locate()	Gets the ID of an item from the specified HTML event or tag
paint()	Repaints the diagram
scrollTo()	Sets the inner scroll of the diagram to the specified position
showItem()	Adjusts scroll to make the target item visible

Diagram events

Name	Description
afterCollapse	Fires after an item has been collapsed
afterExpand	Fires after an item has been expanded
afterSubmenuOpen	Fires after the menu of the subheader is opened
beforeCollapse	Fires before collapsing an item
beforeExpand	Fires before expanding an item
beforeSubmenuOpen	Fires before the menu of the subheader is opened
emptyAreaClick	Fires on clicking an empty space in the current diagram area
emptyAreaDblClick	Fires on double-clicking an empty space in the current diagram area
emptyAreaMouseDown	Fires when a pointing device button is pressed while the pointer is over an empty space in the current diagram area
groupClick	Fires on clicking a group
groupDblClick	Fires on double-clicking a group
groupHeaderClick	Fires on clicking a header of a group
groupHeaderDblClick	Fires on double-clicking a header of a group
groupMouseDown	Fires when a pointing device button is pressed while the pointer is over a group
itemClick	Fires on clicking an item
itemDblClick	Fires on double-clicking an item
itemMouseDown	Fires when a pointing device button is pressed while the pointer is over an item
itemMouseOut	Fires when a pointing device is out of an item
itemMouseOver	Fires when a pointing device is onto an item
lineClick	Fires on clicking a connector line
lineDblClick	Fires on double-clicking a line
lineMouseDown	Fires when a pointing device button is pressed while the pointer is over a connector line
lineTitleClick	Fires on clicking a text element of a line
lineTitleDblClick	Fires on double-clicking a text element of a line
lineTitleMouseDown	Fires when a pointing device button is pressed while the pointer is over a text element of a line
scroll	Fires when a diagram is being scrolled
shapeClick	Fires on clicking a shape
shapeDblClick	Fires on double-clicking a shape
shapeIconClick	Fires on clicking an icon of the shape toolbar
shapeMouseDown	Fires when a pointing device button is pressed while the pointer is over a shape

Diagram properties

Name	Description
autoplacement	Optional. An object with configuration settings for auto-placement of shapes
defaults	Optional. An object which sets the default configuration of a shape or a line
defaultShapeType	Optional. The default type of a shape
exportStyles	Optional. Defines the styles that will be sent to the export service when exporting the diagram
lineConfig	Optional. An object with default configuration for the connector lines
margin	Optional. An object with settings of margins for positioning items in the diagram
scale	Optional. Defines the diagram scale
select	Optional. Enables selection in the diagram
toolbar	Optional. An array of icon objects which sets a toolbar with buttons for items
type	Required. Defines the mode of Diagram initialization
typeConfig	Optional. An object which defines the direction of the shapes in the mindmap mode of Diagram