All docs
V19.1
19.2 (CTP)
19.1
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
17.1
The page you are viewing does not exist in version 17.1. This link will take you to the root page.
16.2
The page you are viewing does not exist in version 16.2. This link will take you to the root page.

DiagramCTP

The Diagram widget provides a visual interface to help you design new and modify existing diagrams.

NOTE
At this time, the Diagram is available as a community technology preview (CTP) version. You can test the component and share your feedback to influence our R&D process. We do not recommend that you use the Diagram in production environments because of possible implementation issues and a high chance of breaking changes in subsequent versions.
Module: ui/diagram
Export: default
Type:

Object

Configuration

An object that defines the Diagram widget's configuration options.

Name Description
accessKey

Specifies the shortcut key that sets focus on the widget.

activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.

customShapes

An array of custom shapes.

disabled

Specifies whether the widget responds to user interaction.

edges

An array of diagram edges.

elementAttr

Specifies the attributes to be attached to the widget's root element.

export

Configures export features.

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

height

Specifies the widget's height.

hint

Specifies text for a hint that appears when a user pauses on the widget.

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

layout

Specifies an auto-layout algorithm that the widget uses to build a diagram.

nodes

An array of diagram nodes.

onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.

onDataChanged

A function that is executed when the diagram's data changes.

onDisposing

A function that is executed before the widget is disposed of.

onInitialized

A function used in JavaScript frameworks to save the widget instance.

onOptionChanged

A function that is executed after a widget option is changed.

rtlEnabled

Switches the widget to a right-to-left representation.

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

visible

Specifies whether the widget is visible.

width

Specifies the widget's width.

See Also

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

createDataSource(parameters)

Populates the toolbox with items from a data source.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

deleteDataSource(key)

Removes data source items from the toolbox.

dispose()

Disposes of all the resources allocated to the Diagram instance.

element()

Gets the root widget element.

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

focus()

Sets focus on the widget.

getData()

Gets the diagram data.

getInstance(element)

Gets the instance of a widget found using its DOM node.

instance()

Gets the widget's instance. Use it to access other methods of the widget.

off(eventName)

Detaches all event handlers from a single event.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

on(eventName, eventHandler)

Subscribes to an event.

on(events)

Subscribes to events.

option()

Gets all widget options.

option(optionName)

Gets the value of a single option.

option(optionName, optionValue)

Updates the value of a single option.

option(options)

Updates the values of several options.

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

repaint()

Repaints the widget without reloading data. Call it to update the widget's markup.

setData(data, updateExistingItemsOnly)

Sets the diagram data.

See Also

Events

This section describes events this widget fires.

Name Description
contentReady

Raised when the widget's content is ready.

dataChanged

Raised when the widget's data changes.

disposing

Raised before the widget is disposed of.

initialized

Raised only once, after the widget is initialized.

optionChanged

Raised after a widget option is changed.

See Also