All docs
V20.2
24.2
The page you are viewing does not exist in version 24.2.
24.1
The page you are viewing does not exist in version 24.1.
23.2
The page you are viewing does not exist in version 23.2.
23.1
The page you are viewing does not exist in version 23.1.
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
20.2
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1.
18.2
The page you are viewing does not exist in version 18.2.
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.
A newer version of this page is available. Switch to the current version.

jQuery/JS Common - Object Structures - DiagramConnector

An object that provides information about a connector in the Diagram UI component.

dataItem

Returns the data item that is bound to the diagram item.

Type:

Object

fromId

Gets the connector's start node identifier.

Type:

String

fromKey

Specifies the connector's start node key.

Type:

Object

fromPointIndex

The index of a shape connection point where the connector starts.

Type:

Number

id

Specifies the item's internal identifier.

Type:

String

itemType

Returns the type of the item.

Type:

String

Accepted Values: 'shape' | 'connector'

key

Gets the item's key from a data source.

Type:

Object

If a user removes an item and then undoes the action, the Diagram inserts the item back and generates a new GUID for its key value. A new GUID is also generated for pasted and cloned items. If you specify key values (IDs in a data source) manually, subscribe to the onInserting data source event to assign the values.

points

Gets the connector's key points.

Type:

Array<Object>

The points property contains an array of connector points. Each point is specified by its x- and y-coordinates in units.

The points property value has the following format: [{"x":264,"y":384},{"x":288,"y":420},{"x":480,"y":420}].

texts

Specifies the connector's text.

Type:

Array<String>

toId

Gets the connector's end node identifier.

Type:

String

toKey

Specifies the connector's end node key.

Type:

Object

toPointIndex

The index of the shape connection point where the connector ends.

Type:

Number