Contents
Migration from Essential® JS 1
9 Dec 202424 minutes to read
This article describes the API migration process of Diagram component from Essential® JS 1 to Essential® JS 2.
Background
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Defines the background color of diagram elements |
Property:`BackgroundColor`
|
Property:`BackgroundColor`
|
Defines how to align the background image over the diagram area |
Property:`BackgroundImage.Alignment`
|
Property:`Background.Align`
|
Defines how the background image should be scaled/stretched |
Property:`BackgroundImage.Scale`
|
Property:`Background.Scale`
|
Sets the source path of the background image |
Property:`BackgroundImage.Source`
|
Property:`Background.Source`
|
Bridging
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Sets the direction of line bridges |
Property:`BridgeDirection`
|
Property:`BridgeDirection`
|
CommandManager
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Stores the multiple command names with the corresponding command objects |
Property:`CommandManager.Commands`
[View]
|
Property:`CommandManager.Commands`
[View]
|
Defines any additional parameters that are required at runtime |
Property:`CommandManager.Commands.Parameter`
[View]
|
Property:`CommandManager.Commands.Parameter`
[View]
|
Connectors
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Allows the user to save custom information/data about a connector |
Property:`Connector.AddInfo`
|
Property:`Connectors.AddInfo`
[View]
|
Defines the bridgeSpace of connector |
Property:`Connector.BridgeSpace`
|
Property:`Connectors.BridgeSpace`
[View]
|
Enables or disables the behaviors of connectors |
Property:`Connector.Constraints`
|
Property:`Connector.Constraints`
[View]
|
Defines the radius of the rounded corner |
Property:`Connector.CornerRadius`
|
Property:`Connector.CornerRadius`
[View]
|
Customize connectors appearance using user-defined CSS |
Property:`Connector.CssClass`
|
Not applicable |
Sets the horizontal alignment of the connector |
Property:`Connector.HorizontalAlign`
|
Not applicable |
A collection of JSON objects where each object represents a label |
Property:`Connector.Labels`
|
Property:`Connector.Annotations`
[View]
|
Stroke color of the connector |
Property:`Connector.LineColor`
|
Property:`Connector.Style.StrokeColor`
[View]
|
Sets the pattern of dashes and gaps used to stroke the path of the connector |
Property:`Connector.LineDashArray`
|
Property:`Connector.Style.StrokeDashArray`
[View]
|
Sets the width of the line |
Property:`Connector.LineWidth`
|
Property:`Connector.Style.StrokeWidth`
[View]
|
Defines the padding value to ease the interaction with connectors |
Property:`Connector.LineHitPadding`
|
Property:`Connectors.HitPadding`
[View]
|
Sets a unique name for the connector |
Property:`Connector.Name`
|
Property:`Connectors.Id`
[View]
|
Defines the transparency of the connector |
Property:`Connector.Opacity`
|
Property:`Connectors.Style.Opacity`
[View]
|
Sets the parent name of the connector. |
Property:`Connector.Parent`
|
Not applicable |
An array of JSON objects where each object represents a segment |
Property:`Connector.Segments`
|
Property:`Connector.Segments`
[View]
|
Sets the direction of orthogonal segment |
Property:`Connector.Segments.Direction`
|
Property:`Connectors.Segments.Direction`
[View]
|
Describes the length of orthogonal segment |
Property:`Connector.Segments.Length`
|
Property:`Connectors.Segments.Length`
[View]
|
Describes the end point of bezier/straight segment |
Property:`Connector.Segments.Point`
|
Property:`Connectors.Segments.Point`
|
Defines the first control point of the bezier segment |
Property:`Connector.Segments.Point1`
|
Property:`Connectors.Segments.Point1`
|
Defines the second control point of bezier segment |
Property:`Connector.Segments.Point2`
|
Property:`Connectors.Segments.Point2`
|
Sets the type of the segment |
|
Property:`Connectors.Segments.Type`
[View]
|
Describes the length and angle between the first control point and the start point of bezier segment |
Property:`Connector.Segments.Vector1`
|
Property:`Connectors.Segments.Vector1`
|
Describes the length and angle between the second control point and end point of bezier segment |
Property:`Connector.Segments.Vector2`
|
Property:`Connectors.Segments.Vector2`
|
Sets the type of the connector |
Property:`Connector.Shape.Type`
|
Property:`Connectors.Shape.Type`
[View]
|
Defines the source decorator of the connector |
Property:`Connector.SourceDecorator`
|
Property:`Connectors.SourceDecorator`
[View]
|
Sets the border color of the source decorator |
Property:`Connector.SourceDecorator.BorderColor`
|
Property:`Connectors.SourceDecorator.Style.StrokeColor`
[View]
|
Sets the border width of the decorator |
Property:`Connector.SourceDecorator.BorderWidth`
|
Property:`Connectors.SourceDecorator.Style.StrokeWidth`
[View]
|
Defines to customize sourceDecorator appearance using user-defined CSS |
Property:`Connector.SourceDecorator.CssClass`
|
Not applicable |
Sets the fill color of the source decorator |
Property:`Connector.SourceDecorator.FillColor`
|
Property:`Connectors.SourceDecorator.Style.Fill`
[View]
|
Sets the height of the source decorator |
Property:`Connector.SourceDecorator.Height`
|
Property:`Connectors.SourceDecorator.Height`
[View]
|
Defines the custom shape of the source decorator |
Property:`Connector.SourceDecorator.PathData`
|
Property:`Connectors.SourceDecorator.PathData`
[View]
|
Defines the shape of the source decorator. |
Property:`Connector.SourceDecorator.Shape`
|
Property:`Connectors.SourceDecorator.Shape`
[View]
|
Defines the width of the source decorator |
Property:`Connector.SourceDecorator.Width`
|
Property:`Connectors.SourceDecorator.Width`
[View]
|
Sets the source node of the connector |
Property:`Connector.SourceNode`
|
Property:`Connectors.SourceID`
[View]
|
Defines the space to be left between the source node and the source point of a connector |
Property:`Connector.SourcePadding`
|
Property:`Connectors.HitPadding`
[View]
|
Describes the start point of the connector |
Property:`Connector.SourcePoint`
|
Property:`Connectors.SourcePoint`
[View]
|
Sets the source port of the connector |
Property:`Connector.SourcePort`
|
Property:`Connectors.SourcePortID`
[View]
|
Defines the target decorator of the connector |
Property:`Connector.TargetDecorator`
|
Property:`Connectors.TargetDecorator`
[View]
|
Sets the border color of the target decorator |
Property:`Connector.TargetDecorator.BorderColor`
|
Property:`Connectors.TargetDecorator.Style.StrokeColor`
|
Sets the border width of the decorator |
Property:`Connector.TargetDecorator.BorderWidth`
|
Property:`Connectors.TargetDecorator.Style.StrokeWidth`
[View]
|
Defines to customize target Decorator appearance using user-defined CSS |
Property:`Connector.TargetDecorator.CssClass`
|
Not applicable |
Sets the fill color of the target decorator |
Property:`Connector.TargetDecorator.FillColor`
|
Property:`Connectors.TargetDecorator.Style.Fill`
[View]
|
Sets the height of the target decorator |
Property:`Connector.TargetDecorator.Height`
|
Property:`Connectors.TargetDecorator.Height`
[View]
|
Defines the custom shape of the target decorator |
Property:`Connector.TargetDecorator.PathData`
|
Property:`Connectors.TargetDecorator.PathData`
[View]
|
Defines the shape of the target decorator. |
Property:`Connector.TargetDecorator.Shape`
|
Property:`Connectors.TargetDecorator.Shape`
[View]
|
Defines the width of the target decorator |
Property:`Connector.TargetDecorator.Width`
|
Property:`Connectors.TargetDecorator.Width`
[View]
|
Sets the target node of the connector |
Property:`Connector.TargetNode`
|
Property:`Connectors.TargetID`
[View]
|
Defines the space to be left between the target node and the target point of a connector |
Property:`Connector.TargetPadding`
|
Property:`Connectors.HitPadding`
[View]
|
Describes the start point of the connector |
Property:`Connector.TargetPoint`
|
Property:`Connectors.TargetPoint`
[View]
|
Sets the target port of the connector |
Property:`Connector.TargetPort`
|
Property:`Connectors.TargetPortID`
[View]
|
Defines the tooltip that should be shown when the mouse hovers over connector |
Property:`Connector.Tooltip`
|
Property:`Connectors.Tooltip`
[View]
|
Sets the vertical alignment of connector |
Property:`Connector.VerticalAlign`
|
Not applicable |
Enables or disables the visibility of connector |
Property:`Connector.Visible`
|
Property:`Connectors.Visible`
[View]
|
Sets the z-index of the connector |
Property:`Connector.ZOrder`
|
Property:`Connectors.ZIndex`
[View]
|
Enables/Disables the default behaviors of the diagram |
Property:`Constraints`
|
Property:`Constraints`
|
ContextMenu
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Defines the collection of context menu items |
Property:`ContextMenu.Items`
[View]
|
Property:`ContextMenuSettings.Items`
[View]
|
Defines the text for the collection of context menu item |
Property:`ContextMenu.Items.Text`
[View]
|
Property:`ContextMenuSettings.Items.Text`
[View]
|
Defines the name for the collection of context menu items |
Property:`ContextMenu.Items.Name`
[View]
|
Property:`ContextMenuSettings.Items.Id`
[View]
|
Defines the image url for the collection of context menu items |
Property:`ContextMenu.Items.ImageUrl`
[View]
|
Property:`ContextMenuSettings.Items.Url`
[View]
|
Defines the cssClass for the collection of context menu items |
Property:`ContextMenu.Items.CssClass`
[View]
|
Property:`ContextMenuSettings.Items.IconCss`
[View]
|
Defines the collection of sub items for the context menu items |
Property:`ContextMenu.Items.SubItems`
[View]
|
Property:`ContextMenuSettings.Items.Items`
[View]
|
Set whether to display the default context menu items or not |
Property:`ContextMenu.ShowCustomMenuItemsOnly`
[View]
|
Property:`ContextMenuSettings.ShowCustomMenuOnly`
[View]
|
Specifies separator between the menu items | Not applicable |
Property:`ContextMenuSettings.Items.Separator`
[View]
|
Define the target to show the menu item. | Not applicable |
Property:`ContextMenuSettings.Items.Target`
[View]
|
Enables/Disables the context menu items | Not applicable |
Property:`ContextMenuSettings.Show`
[View]
|
DataSourceSettings
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Defines the data source either as a collection of objects or as an instance of ej.DataManager |
Property:`DataSourceSettings.DataSource`
[View]
|
Property:`DataSourceSettings.DataManager`
[View]
|
Sets the unique id of the data source items |
Property:`DataSourceSettings.Id`
[View]
|
Property:`DataSourceSettings.Id`
[View]
|
Defines the parent id of the data source item |
Property:`DataSourceSettings.Parent`
[View]
|
Property:`DataSourceSettings.ParentId`
[View]
|
Describes query to retrieve a set of data from the specified datasource |
Property:`DataSourceSettings.Query`
[View]
|
Not applicable |
Sets the unique id of the root data source item |
Property:`DataSourceSettings.Root`
[View]
|
Property:`DataSourceSettings.Root`
[View]
|
Describes the name of the table on which the specified query has to be executed |
Property:`DataSourceSettings.TableName`
[View]
|
Not applicable |
Specifies the method name which is used to get the updated data from client side to the server side |
Property:`DataSourceSettings.CrudAction`
[View]
|
Not applicable |
Specifies the create method which is used to get the nodes to be added from client side to the server side |
Property:`DataSourceSettings.CrudAction.Create`
|
Not applicable |
Specifies the update method which is used to get the updated data from client side to the server side |
Property:`DataSourceSettings.CrudAction.Update`
[View]
|
Not applicable |
Specifies the destroy method which is used to get the deleted items data from client side to the server side |
Property:`DataSourceSettings.CrudAction.Destroy`
[View]
|
Not applicable |
Specifies the read method to get the created nodes from client side to the server side |
Property:`DataSourceSettings.CrudAction.Read`
[View]
|
Not applicable |
Defines the data source either as a collection of objects or as an instance of ej.DataManager |
Property:`DataSourceSettings.CustomFields`
[View]
|
Property:`DataSourceSettings.Data`
[View]
|
Defines the data source either as a collection of objects or as an instance of ej.DataManager |
Property:`DataSourceSettings.ConnectionDataSource`
[View]
|
Not applicable |
Sets the datasource for the connection datasource settings items |
Property:`DataSourceSettings.ConnectionDataSource.DataSource`
[View]
|
Not applicable |
Sets the unique id of the connection data source item |
Property:`DataSourceSettings.ConnectionDataSource.Id`
[View]
|
Not applicable |
Sets the source node of the connection data source item |
Property:`DataSourceSettings.ConnectionDataSource.SourceNode`
[View]
|
Not applicable |
Sets the target node of the connection data source item |
Property:`DataSourceSettings.ConnectionDataSource.TargetNode`
[View]
|
Not applicable |
Sets the sourcePointX value of the connection data source item |
Property:`DataSourceSettings.ConnectionDataSource.SourcePointX`
[View]
|
Not applicable |
Sets the sourcePointY value of the connection data source item |
Property:`DataSourceSettings.ConnectionDataSource.SourcePointY`
[View]
|
Not applicable |
Sets the targetPoint-x value of the connection data source item |
Property:`DataSourceSettings.ConnectionDataSource.TargetPointX`
[View]
|
Not applicable |
Sets the targetPoint-y value of the connection data source item |
Property:`DataSourceSettings.ConnectionDataSource.TargetPointY`
[View]
|
Not applicable |
Specifies the method name which is used to get updated connectors from client side to the server side |
Property:`DataSourceSettings.ConnectionDataSource.CrudAction`
[View]
|
Not applicable |
Specifies the create method which is used to get the connectors to be added from client side to the server side |
Property:`DataSourceSettings.ConnectionDataSource.CrudAction.Create`
[View]
|
Not applicable |
Specifies the update method which is used to get the updated connectors from client side to the server side |
Property:`DataSourceSettings.ConnectionDataSource.CrudAction.Update`
[View]
|
Not applicable |
Specifies the destroy method which is used to get the deleted items data from client side to the server side |
Property:`DataSourceSettings.ConnectionDataSource.CrudAction.Destroy`
[View]
|
Not applicable |
Specifies the read method which is used to get the data from client side to the server side |
Property:`DataSourceSettings.ConnectionDataSource.CrudAction.Read`
[View]
|
Not applicable |
Specifies the custom fields to get the updated data from client side to the server side |
Property:`DataSourceSettings.ConnectionDataSource.CustomFields`
[View]
|
Not applicable |
DefaultSettings
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Initializes the default values for nodes and connectors |
Property:`DefaultSettings.Node`
|
Property:`GetNodeDefaults`
|
Initializes the default connector properties |
Property:`DefaultSettings.Connector`
|
Property:`GetConnectorDefaults`
|
Initializes the default properties of groups |
Property:`DefaultSettings.Group`
[View]
|
Not applicable |
DrawType
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Sets the type of JSON object to be drawn through drawing tool |
Property:`DrawType`
[View]
|
Property:`DrawingObject`
|
EnableAutoScroll
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Enables or disables auto scroll in diagram |
Property:`EnableAutoScroll`
|
Property:`CanAutoScroll`
|
EnableContextMenu
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Enables or disables diagram context menu |
Property:`EnableContextMenu`
|
Property:`ContextMenuSettings.Show`
|
GetCustomCursor
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Enable or disable rendering component with custom cursor | Not applicable |
Property:`GetCustomCursor`
|
GetCustomProperty
</tr> </table> ## GetDescriptionbehavior | API in Essential® JS 1 | API in Essential® JS 2 |
Allows to get the custom properties that have to be serialized</td> | Not applicable |
Property:`GetCustomProperty`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Allows to get the custom description</td> | Not applicable |
Property:`GetDescription`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Allows to get the custom tool</td> | Not applicable |
Property:`GetCustomTool`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Specifies the height of the diagram |
Property:`Height`
|
Property:`Height`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
A method that takes a history entry as argument and returns whether the specific entry can be popped or not |
Property:`HistoryManager.CanPop`
|
Not applicable |
A method that ends grouping the changes |
Property:`HistoryManager.CloseGroupAction`
|
Property:`HistoryList.EndGroupAction`
|
A method that removes the history of a recent change made in diagram |
Property:`HistoryManager.Pop`
|
Not applicable |
A method that allows to track the custom changes made in diagram |
Property:`HistoryManager.Push`
|
Property:`HistoryList.Push`
|
Defines what should be happened while trying to restore a custom change |
Property:`HistoryManager.Redo`
[View]
|
Property:`HistoryList.Redo`
|
Gets the number of redo actions to be stored on the history manager. Its an read-only property and the collection should not be modified |
Property:`HistoryManager.RedoStack`
|
Property:`HistoryList.RedoStack`
|
Restricts the undo and redo actions to a certain limit |
Property:`HistoryManager.StackLimit`
|
Not applicable |
A method that starts to group the changes to revert/restore them in a single undo or redo |
Property:`HistoryManager.StartGroupAction`
|
Property:`HistoryList.StartGroupAction`
|
Defines what should be happened while trying to revert a custom change |
Property:`HistoryManager.Undo`
|
Property:`HistoryList.Undo`
|
Gets the number of undo actions to be stored on the history manager. Its an read-only property and the collection should not be modified |
Property:`HistoryManager.UndoStack`
|
Property:`HistoryList.UndoStack`
|
Set the current entry object | Not applicable |
Property:`HistoryList.CurrentEntry`
|
Set the history entry can be undo | Not applicable |
Property:`HistoryList.CanUndo`
|
Set the history entry can be redo | Not applicable |
Property:`HistoryList.CanRedo`
|
Used to decide to stored the changes to history |
Property:`HistoryManager.CanLog`
|
Property:`HistoryList.CanLog`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Specifies the custom bounds to arrange/align the layout |
Property:`Layout.Bounds`
|
Property:`Layout.Bounds`
|
Defines the fixed node with reference to which, the layout will be arranged and fixed node will not be repositioned |
Property:`Layout.FixedNode`
|
Property:`Layout.FixedNode`
|
Customizes the orientation of trees/sub trees |
Property:`Layout.GetLayoutInfo`
|
Property:`Layout.GetLayoutInfo`
|
Defines a method to customize the segments based on source and target nodes |
Property:`Layout.GetConnectorSegments`
|
Property:`Layout.ConnectorSegments`
|
Sets the space to be horizontally left between nodes |
Property:`Layout.HorizontalSpacing`
|
Property:`Layout.HorizontalSpacing`
|
Defines the space to be left between layout bounds and layout |
Property:`Layout.Margin`
|
Property:`Layout.Margin`
|
Defines how to horizontally align the layout within the layout bounds |
Property:`Layout.HorizontalAlignment`
|
Property:`Layout.HorizontalAlignment`
|
Defines how to vertically align the layout within the layout bounds |
Property:`Layout.VerticalAlignment`
|
Property:`Layout.VerticalAlignment`
|
Sets the orientation/direction to arrange the diagram elements |
Property:`Layout.Orientation`
|
Property:`Layout.Orientation`
|
Sets the type of the layout based on which the elements will be arranged |
Property:`Layout.Type`
|
Property:`Layout.Type`
|
Sets the space to be vertically left between nodes |
Property:`Layout.VerticalSpacing`
|
Property:`Layout.VerticalSpacing`
|
Sets the value is used to define the root node of the layout |
Property:`Layout.Root`
[View]
|
Property:`Layout.Root`
|
Defines how long edges should be, ideally. This will be the resting length for the springs |
Property:`Layout.SpringFactor`
[View]
|
Property:`Layout.SpringFactor`
|
Defines how long edges should be, ideally. This will be the resting length for the springs |
Property:`Layout.MaxIteration`
[View]
|
Property:`Layout.MaxIteration`
|
Defines how long edges should be, ideally. This will be the resting length for the springs |
Property:`Layout.SpringLength`
[View]
|
Property:`Layout.SpringLength`
|
Sets how to define the connection direction (first segment direction & last segment direction) | Not applicable |
Property:`Layout.ConnectionDirection`
|
Enables/Disables animation option when a node is expanded/collapsed | Not applicable |
Property:`Layout.EnableAnimation`
|
Defines whether an object should be at the left/right of the mind map. Applicable only for the direct children of the root node | Not applicable |
Property:`Layout.GetBranch`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Array of JSON objects where each object represents a node |
Property:`Nodes`
|
Property:`Nodes`
[View]
|
Defines the type of BPMN Activity. Applicable, if the node is a BPMN activity |
Property:`Nodes.Activity`
|
Property:`Nodes.Shape.Activity`
[View]
|
To maintain additional information about nodes |
Property:`Nodes.AddInfo`
|
Property:`Nodes.AddInfo`
[View]
|
Defines the additional information of a process. It is not directly related to the message flows or sequence flows of the process |
Property:`Nodes.Annotation`
|
Property:`Nodes.Shape.Annotations`
[View]
|
Sets the angle between the BPMN shape and the annotation |
Property:`Nodes.Annotation.Angle`
|
Property:`Nodes.Shape.Annotations.Angle`
[View]
|
Sets the direction of the text annotation |
Property:`Nodes.Annotation.Direction`
|
Not applicable |
Sets the height of the text annotation |
Property:`Nodes.Annotation.Height`
|
[View]
|
Sets the distance between the BPMN shape and the annotation |
Property:`Nodes.Annotation.Length`
|
Property:`Nodes.Shape.Annotations.Length`
[View]
|
Defines the additional information about the flow object in a BPMN Process |
Property:`Nodes.Annotation.Text`
|
Property:`Nodes.Shape.Annotations.Text`
[View]
|
Sets the width of the text annotation |
Property:`Nodes.Annotation.Width`
|
Property:`Nodes.Shape.Annotations.Width`
[View]
|
Sets the id for the annotation | Not applicable |
Property:`Nodes.Shape.Annotations.Id`
[View]
|
Defines whether the group can be ungrouped or not |
Property:`Nodes.CanUngroup`
[View]
|
Not applicable |
Array of JSON objects where each object represents a child node/connector |
Property:`Nodes.Children`
[View]
|
|
Sets the type of UML classifier |
Property:`Nodes.Classifier`
|
Not applicable |
Defines the name, attributes and methods of a Class. Applicable, if the node is a Class |
Property:`Nodes.Class`
|
Not applicable |
Sets the name of class |
Property:`Nodes.Class.Name`
|
Not applicable |
Defines the collection of attributes |
Property:`Nodes.Class.Attributes`
|
Not applicable |
Sets the name of the attribute |
Property:`Nodes.Class.Attributes.Name`
|
Not applicable |
Sets the data type of attribute |
Property:`Nodes.Class.Attributes.Type`
|
Not applicable |
Defines the visibility of the attribute |
Property:`Nodes.Class.Attributes.Scope`
|
Not applicable |
Defines the collection of methods of a Class |
Property:`Nodes.Class.Methods`
|
Not applicable |
Sets the name of the method |
Property:`Nodes.Class.Methods.Name`
|
Not applicable |
Defines the arguments of the method |
Property:`Nodes.Class.Methods.Arguments`
|
Not applicable |
Defines the name, attributes and methods of a Class. Applicable, if the node is a Class |
Property:`Nodes.Class.Methods.Arguments.Name`
|
Not applicable |
Sets the type of the argument |
Property:`Nodes.Class.Methods.Arguments.Type`
|
Not applicable |
Sets the return type of the method |
Property:`Nodes.Class.Methods.Type`
|
Not applicable |
Sets the visibility of the method |
Property:`Nodes.Class.Methods.Scope`
|
Not applicable |
Defines the state of the node is collapsed/expanded |
Property:`Nodes.CollapseIcon`
|
Property:`Nodes.CollapseIcon`
[View]
|
Sets the border color for collapse icon of node |
Property:`Nodes.CollapseIcon.BorderColor`
|
Property:`Nodes.CollapseIcon.BorderColor`
[View]
|
Sets the border width for collapse icon of node |
Property:`Nodes.CollapseIcon.BorderWidth`
|
Property:`Nodes.CollapseIcon.BorderWidth`
[View]
|
Sets the fill color for collapse icon of node |
Property:`Nodes.CollapseIcon.FillColor`
|
Property:`Nodes.CollapseIcon.Fill`
[View]
|
Defines the height for collapse icon of node |
Property:`Nodes.CollapseIcon.Height`
|
Property:`Nodes.CollapseIcon.Height`
[View]
|
Sets the horizontal alignment of the icon |
Property:`Nodes.CollapseIcon.HorizontalAlignment`
|
Property:`Nodes.CollapseIcon.HorizontalAlignment`
[View]
|
To set the margin for the collapse icon of node |
Property:`Nodes.CollapseIcon.Margin`
|
Property:`Nodes.CollapseIcon.Margin`
[View]
|
Sets the fraction/ratio(relative to node) that defines the position of the icon |
Property:`Nodes.CollapseIcon.Offset`
|
Property:`Nodes.CollapseIcon.Offset`
[View]
|
Defines the shape of the collapsed state of the node |
Property:`Nodes.CollapseIcon.Shape`
|
Property:`Nodes.CollapseIcon.Shape`
[View]
|
Sets the vertical alignment of the icon |
Property:`Nodes.CollapseIcon.VerticalAlignment `
|
Property:`Nodes.CollapseIcon.VerticalAlignment `
[View]
|
Defines the custom content of the icon | Not applicable |
Property:`Nodes.CollapseIcon.Content`
[View]
|
Defines the geometry of a path | Not applicable |
Property:`Nodes.CollapseIcon.PathData`
[View]
|
Defines the corner radius of the icon border | Not applicable |
Property:`Nodes.CollapseIcon.CornerRadius`
[View]
|
Defines the space that the icon has to be moved from the icon border | Not applicable |
Property:`Nodes.CollapseIcon.Padding`
[View]
|
Defines the distance to be left between a node and its connections(In coming and out going connections) |
Property:`Nodes.ConnectorPadding`
|
Not applicable |
Enables or disables the default behaviors of the node |
Property:`Nodes.Constraints`
|
Property:`Nodes.Constraints`
[View]
|
Defines the orientation of the container. Applicable, if the group is a container |
Property:`Nodes.Container.Orientation`
[View]
| Not applicable |
Sets the type of the container. Applicable if the group is a container. |
Property:`Nodes.Container.Type`
[View]
| Not applicable |
Defines the corner radius of rectangular shapes |
Property:`Nodes.CornerRadius`
|
Not applicable |
This property allows you to customize nodes appearance using user-defined CSS |
Property:`Nodes.CssClass`
|
Not applicable |
Defines the BPMN data object |
Property:`Nodes.Data.Type`
|
Property:`Nodes.Shape.DataObject.Type`
[View]
|
Defines whether the BPMN data object is a collection or not |
Property:`Nodes.Data.Collection`
|
Property:`Nodes.Shape.DataObject.Collection`
[View]
|
Defines an Enumeration in a UML Class Diagram |
Property:`Nodes.Enumeration`
|
Not applicable |
Sets the name of the Enumeration |
Property:`Nodes.Enumeration.Name`
|
Not applicable |
Defines the collection of enumeration members |
Property:`Nodes.Enumeration.Members`
|
Not applicable |
Sets the name of the enumeration member |
Property:`Nodes.Enumeration.Members.Name`
|
Not applicable |
Sets the type of the BPMN Events. Applicable, if the node is a BPMN event |
Property:`Nodes.Event`
|
Property:`Nodes.Shape.Event`
[View]
|
Defines the type of the trigger |
Property:`Nodes.Event.Trigger`
|
Property:`Nodes.Shape.Event.Trigger`
[View]
|
Defines whether the node can be automatically arranged using layout or not |
Property:`Nodes.ExcludeFromLayout`
|
Property:`Nodes.ExcludeFromLayout`
[View]
|
Defines the fill color of the node |
Property:`Nodes.FillColor`
|
Property:`Nodes.Style.Fill`
[View]
|
Sets the type of the BPMN Gateway. Applicable, if the node is a BPMN gateway |
Property:`Nodes.Gateway`
|
Property:`Nodes.Shape.Gateway`
[View]
|
Paints the node with linear color transitions |
Property:`Nodes.Gradient.Type`
|
Property:`Nodes.Style.Gradient.Type`
[View]
|
Defines the x1 value of linear gradient |
Property:`Nodes.Gradient.LinearGradient.X1`
|
Property:`Nodes.Style.Gradient.LinearGradient.X1`
|
Defines the x2 value of linear gradient |
Property:`Nodes.Gradient.LinearGradient.X2`
|
Property:`Nodes.Style.Gradient.LinearGradient.X2`
|
Defines the y1 value of linear gradient |
Property:`Nodes.Gradient.LinearGradient.Y1`
|
Property:`Nodes.Style.Gradient.LinearGradient.Y1`
|
Defines the y2 value of linear gradient |
Property:`Nodes.Gradient.LinearGradient.Y2`
|
Property:`Nodes.Style.Gradient.LinearGradient.Y2`
|
Defines the type of gradient |
Property:`Nodes.Gradient.RadialGradient.Type`
|
Property:`Nodes.Style.Gradient.Type`
[View]
|
Defines the position of the outermost circle |
Property:`Nodes.Gradient.RadialGradient.Cx`
|
Property:`Nodes.Style.RadialGradient.Cx`
|
Defines the outer most circle of the radial gradient |
Property:`Nodes.Gradient.RadialGradient.Cy`
|
Property:`Nodes.Style.RadialGradient.Cy`
|
Defines the innermost circle of the radial gradient |
Property:`Nodes.Gradient.RadialGradient.Fx`
|
Property:`Nodes.Style.RadialGradient.Fx`
|
Defines the innermost circle of the radial gradient |
Property:`Nodes.Gradient.RadialGradient.Fy`
|
Property:`Nodes.Style.RadialGradient.Fy`
|
Defines the different colors and the region of color transitions |
Property:`Nodes.Gradient.RadialGradient.Stops`
|
Property:`Nodes.Style.RadialGradient.Stops`
[View]
|
Sets the color to be filled over the specified region |
Property:`Nodes.Gradient.Stops.Color`
|
Property:`Nodes.Style.Gradient.Stops.Color`
[View]
|
Sets the position where the previous color transition ends and a new color transition starts |
Property:`Nodes.Gradient.Stops.Offset`
|
Property:`Nodes.Style.Gradient.Stops.Offset`
[View]
|
Describes the transparency level of the region |
Property:`Nodes.Gradient.Stops.Opacity`
|
Property:`Nodes.Style.Gradient.Stops.Opacity`
[View]
|
Defines the header of a swimlane/lane |
Property:`Nodes.Header`
[View]
|
Not applicable |
Defines the height of the node |
Property:`Nodes.Height`
|
Property:`Nodes.Height`
[View]
|
Sets the horizontal alignment of the node. Applicable, if the parent of the node is a container |
Property:`Nodes.HorizontalAlign`
|
Not applicable |
Defines an interface in a UML interface Diagram |
Property:`Nodes.Interface`
|
Not applicable |
Defines the name, attributes and methods of a Interface. Applicable, if the node is a Interface |
Property:`Nodes.Interface.Name`
|
Not applicable |
Defines the collection of attributes |
Property:`Nodes.Interface.Attributes`
|
Not applicable |
Sets the name of the attribute |
Property:`Nodes.Interface.Attributes.Name`
|
Not applicable |
Sets the data type of attribute |
Property:`Nodes.Interface.Attributes.Type`
|
Not applicable |
Defines the visibility of the attribute |
Property:`Nodes.Interface.Attributes.Scope`
|
Not applicable |
Defines the collection of methods of a interface |
Property:`Nodes.Interface.Methods`
|
Not applicable |
Sets the name of the method |
Property:`Nodes.Interface.Methods.Name`
|
Not applicable |
Defines the arguments of the method |
Property:`Nodes.Interface.Methods.Arguments`
|
Not applicable |
Defines the name, attributes and methods of a interface. Applicable, if the node is a interface |
Property:`Nodes.Interface.Methods.Arguments.Name`
|
Not applicable |
Sets the type of the argument |
Property:`Nodes.Interface.Methods.Arguments.Type`
|
Not applicable |
Sets the return type of the method |
Property:`Nodes.Interface.Methods.Type`
|
Not applicable |
Sets the visibility of the method |
Property:`Nodes.Interface.Methods.Scope`
|
Not applicable |
Defines whether the sub tree of the node is expanded or collapsed |
Property:`Nodes.IsExpanded`
|
Property:`Nodes.IsExpanded`
[View]
|
Sets the node as a swimlane |
Property:`Nodes.IsSwimlane`
[View]
|
Not applicable |
A collection of objects where each object represents a label |
Property:`Nodes.Labels`
|
Property:`Nodes.Annotations`
[View]
|
An array of objects where each object represents a lane. Applicable, if the node is a swimlane |
Property:`Nodes.Lanes`
[View]
|
Not applicable |
This property allows you to customize lanes appearance using user-defined CSS |
Property:`Nodes.Lanes.CssClass`
[View]
|
Not applicable |
Defines the header of the lane |
Property:`Nodes.Lanes.Header`
[View]
|
Not applicable |
Defines the width of lane |
Property:`Nodes.Lanes.Width`
[View]
|
Not applicable |
An array of objects where each object represents a child node of the lane |
Property:`Nodes.Lanes.Children`
[View]
|
Not applicable |
Defines the object as a lane |
Property:`Nodes.Lanes.IsLane`
[View]
|
Not applicable |
Defines the minimum space to be left between the bottom of parent bounds and the node |
Property:`Nodes.Margin`
|
Property:`Nodes.Margin`
[View]
|
Defines the maximum height limit of the node |
Property:`Nodes.MaxHeight`
|
Property:`Nodes.MaxHeight`
[View]
|
Sets the unique identifier of the node |
Property:`Nodes.Name`
|
Property:`Nodes.Id`
[View]
|
Sets the path geometry that defines the shape of a path node |
Property:`Nodes.PathData`
|
Property:`Nodes.Shape.Data`
[View]
|
An array of objects, where each object represents a smaller region(phase) of a swimlane |
Property:`Nodes.Phases`
[View]
|
Not applicable |
Defines the header of the smaller regions |
Property:`Nodes.Phases.Label`
[View]
|
Not applicable |
Defines the line color of the splitter that splits adjacent phases |
Property:`Nodes.Phases.LineColor`
[View]
|
Not applicable |
Sets the length of the smaller region(phase) of a swimlane |
Property:`Nodes.Phases.Offset`
[View]
|
Not applicable |
Sets the orientation of the phase |
Property:`Nodes.Phases.Orientation`
[View]
|
Not applicable |
Sets the height of the phase headers |
Property:`Nodes.PhaseSize`
[View]
|
Not applicable |
Sets the ratio/ fractional value relative to node, based on which the node will be transformed(positioning, scaling and rotation) |
Property:`Nodes.Pivot`
|
Property:`Nodes.Pivot`
[View]
|
Defines a collection of points to draw a polygon. Applicable, if the shape is a polygon |
Property:`Nodes.Points`
|
Property:`Nodes.Shape.Points`
[View]
|
An array of objects where each object represents a port |
Property:`Nodes.Ports`
|
Property:`Nodes.Ports`
[View]
|
Sets the border color of the port |
Property:`Nodes.Ports.BorderColor`
|
Property:`Nodes.Ports.Style.StrokeColor`
[View]
|
Defines whether connections can be created with the port |
Property:`Nodes.Ports.Constraints`
|
Property:`Nodes.Ports.Constraints`
[View]
|
An array of objects where each object represents a port |
Property:`Nodes.Ports.Shape`
|
Property:`Nodes.Ports.Shape`
[View]
|
Sets the vertical alignment of the port with respect to its immediate parent | Not applicable |
Property:`Nodes.Ports.VerticalAlignment`
[View]
|
Defines the opacity and the position of shadow |
Property:`Nodes.Shadow`
|
Property:`Nodes.Shadow`
[View]
|
Defines the sub process of a BPMN Activity. Applicable, if the type of the BPMN activity is sub process |
Property:`Nodes.SubProcess`
|
Property:`Nodes.Shape.Activity.SubProcess`
[View]
|
Defines the collection of events that need to be appended with BPMN Sub-Process |
Property:`Nodes.SubProcess.Events`
|
Property:`Nodes.Shape.Activity.SubProcess.Events`
[View]
|
An array of objects where each object represents a port |
Property:`Nodes.SubProcess.Events.Ports`
|
Property:`Nodes.Shape.Activity.SubProcess.Events.Ports`
[View]
|
A collection of objects where each object represents a label |
Property:`Nodes.SubProcess.Events.Labels`
|
Property:`Nodes.Shape.Activity.SubProcess.Events.Annotations`
[View]
|
Defines the task of the BPMN activity. Applicable, if the type of activity is set as task |
Property:`Nodes.Task`
|
Property:`Nodes.Shape.Activity.Task`
[View]
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Binds the custom JSON data with node properties |
Property:`NodeTemplate`
|
Property:`SetNodeTemplate`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
A collection of JSON objects where each object represents a layer. Layer is a named category of diagram shapes |
Property:`Layers`
[View]
|
Property:`Layers`
[View]
|
A collection of JSON objects where each object represents a layer. Layer is a named category of diagram shapes |
Property:`Layers.Print`
[View]
|
Not applicable |
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
A collection of objects where each object represents a label |
Property:`Labels.Text`
|
Property:`Annotations.Content`
[View]
|
Offset for annotation content |
Property:`Labels.Offset`
|
Property:`Annotations.Offset`
[View]
|
Sets the hyperlink for the labels |
Property:`Labels.HyperLink`
|
Property:`Annotations.Hyperlink`
[View]
|
Enables/disables the bold style |
Property:`Labels.Bold`
|
Property:`Annotations.Style.Bold`
[View]
|
Sets the border color of the label |
Property:`Labels.BorderColor`
|
Property:`Annotations.Style.StrokeColor`
[View]
|
Sets the border width of the label |
Property:`Labels.BorderWidth`
|
Property:`Annotations.Style.StrokeWidth`
[View]
|
This property allows you to customize labels appearance using user-defined CSS |
Property:`Labels.CssClass`
|
Not applicable |
Enables or disables the default behaviors of the label |
Property:`Labels.Constraints`
|
Property:`Annotations.Constraints`
[View]
|
Sets the fill color of the text area |
Property:`Labels.FillColor`
|
Property:`Annotations.Style.Fill`
[View]
|
Sets the font color of the text |
Property:`Labels.FontColor`
|
Property:`Annotations.Style.Color`
[View]
|
Sets the font family of the text |
Property:`Labels.FontFamily`
|
Property:`Annotations.Style.FontFamily`
[View]
|
Sets the height of the label |
Property:`Labels.Height`
|
Property:`Annotations.Height`
[View]
|
Sets the horizontal alignment of the label |
Property:`Labels.HorizontalAlignment`
|
Property:`Annotations.HorizontalAlignment`
[View]
|
To set the margin of the label |
Property:`Labels.Margin`
|
Property:`Annotations.Margin`
[View]
|
Defines whether the label is editable or not |
Property:`Labels.ReadOnly`
|
Property:`Annotations.Constraints`
[View]
|
Sets the id of svg/html templates. Applicable, if the node’s label is HTML or native |
Property:`Labels.TemplateId`
|
Not applicable |
Defines how to align the text inside the label |
Property:`Labels.TextAlign`
|
Property:`Annotations.Style.TextAlign`
[View]
|
Enables or disables the visibility of the label |
Property:`Labels.Visible`
|
Property:`Annotations.Visibility`
[View]
|
Gets whether the label is currently being edited or not |
Property:`Labels.Mode`
|
Not applicable |
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Defines the size and appearance of diagram page |
Property:`PageSettings.AutoScrollBorder`
|
Not applicable |
Sets whether multiple pages can be created to fit all nodes and connectors |
Property:`PageSettings.MultiplePage`
|
Property:`PageSettings.MultiplePage`
|
Defines the background color of diagram pages |
Property:`PageSettings.PageBackgroundColor`
|
Property:`PageSettings.Background.Color`
|
Defines the scrollable area of diagram. Applicable, if the scroll limit is “limited” |
Property:`PageSettings.ScrollableArea`
|
Property:`ScrollSettings.ScrollableArea`
|
Defines the draggable region of diagram elements |
Property:`PageSettings.BoundaryConstraints`
[View]
|
Property:`PageSettings.BoundaryConstraints`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Defines the zoom value, zoom factor, scroll status and view port size of the diagram |
Property:`ScrollSettings.HorizontalOffset`
[View]
|
Property:`ScrollSettings.HorizontalOffset`
|
Allows to extend the scrollable region that is based on the scroll limit |
Property:`ScrollSettings.Padding`
[View]
|
Not applicable |
Allows to read the maximum zoom value of scroller | Not applicable |
Property:`ScrollSettings.MaxZoom`
|
Allows to read the maximum zoom value of scroller | Not applicable |
Property:`ScrollSettings.AutoScrollBorder`
|
Enables/Disables the autoscroll option | Not applicable |
Property:`ScrollSettings.CanAutoScroll`
|
Defines the scrollable area of diagram | Not applicable |
Property:`ScrollSettings.ScrollableArea`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Enables or disables snapping nodes/connectors to objects |
Property:`SnapSettings.EnableSnapToObject`
|
Not applicable |
Defines the appearance of horizontal gridlines |
Property:`SnapSettings.HorizontalGridLines`
|
Property:`SnapSettings.HorizontalGridlines`
[View]
|
Defines the appearance of vertical gridlines |
Property:`SnapSettings.VerticalGridLines`
|
Property:`SnapSettings.VerticalGridLines`
[View]
|
Defines the angle by which the object needs to be snapped |
Property:`SnapSettings.SnapAngle`
|
Property:`SnapSettings.SnapAngle`
[View]
|
Sets the minimum distance between the selected object and the nearest object |
Property:`SnapSettings.SnapObjectDistance`
|
Property:`SnapSettings.SnapObjectDistance`
[View]
|
Defines and sets the snapConstraints |
Property:`SnapSettings.SnapConstraints`
|
Property:`SnapSettings.Constraints`
[View]
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Sets the factor by which we can zoom in or zoom out |
Property:`ZoomFactor`
|
Property:`ZoomFactor`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Enables/Disables the interactive behaviors of diagram |
Property:`Tool`
|
Property:`Tool`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Enables or disables tooltip of diagram |
Property:`ShowTooltip`
|
Property:`Constraints`
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
A read only collection of the selected items |
Property:`SelectedItems.Children`
|
Not applicable |
Controls the visibility of selector |
Property:`SelectedItems.Constraints`
|
Property:`SelectedItems.Constraints`
|
Sets the angle to rotate the selected items |
Property:`SelectedItems.Tooltip`
|
Not applicable |
A collection of frequently used commands that will be added around the selector |
Property:`SelectedItems.UserHandles`
|
Property:`SelectedItems.UserHandles`
[View]
|
Sets the horizontal alignment of the user handle |
Property:`SelectedItems.UserHandles.HorizontalAlignment`
|
Property:`SelectedItems.UserHandles.HorizontalAlignment`
[View]
|
Defines the interactive behaviors of the user handle |
Property:`SelectedItems.UserHandles.Tool`
|
Not applicable |
Defines whether the user handle should be added, when more than one element is selected |
Property:`SelectedItems.UserHandles.EnableMultiSelection`
|
Not applicable |
Sets the horizontal alignment of the user handle | Not applicable |
Property:`SelectedItems.UserHandles.Displacement`
[View]
|
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
Defines whether the default diagram properties can be serialized or not |
Property:`SerializationSettings.PreventDefaultValues`
[View]
|
Not applicable |
@{
Html.EJ().Diagram("diagram").Height("500px").Width("500px").Created("diagramCreated").GetNodeDefaults("getNodeDefaults").GetConnectorDefaults("getConnectorDefaults").DataSourceSettings(ss => ss.Id("Id").ParentId("ParentId").DataSource(new DataManager() { Data = (List<MindMapDetails>)ViewBag.Nodes }))
.Layout(l => l.Type(Syncfusion.EJ2.Diagrams.LayoutType.MindMap).GetBranch("getBranch")).Render();
}
function diagramCreated(){
var diagram = document.getElementById("diagram").ej2_instances[0];
var ej1Data = {"JSONData"}; // Replace JSONData with your EJ1 JSON data
//Load the EJ1 JSON and pass a boolean value as true.
diagram.loadDiagram(ej1Data, true);
}
behavior | API in Essential® JS 1 | API in Essential® JS 2 |
An object that defines the description, appearance and alignments of tooltip |
Property:`Tooltip`
|
Property:`Tooltip`
|
Defines the alignment of tooltip |
Property:`Tooltip.Alignment`
|
Not applicable |
Sets the margin of the tooltip |
Property:`Tooltip.Margin`
|
Not applicable |
Sets the svg/html template to be bound with tooltip |
Property:`Tooltip.TemplateId`
|
Property:`Tooltip.Content`
|
Defines if the Tooltip has tip pointer or not | Not applicable |
Property:`Tooltip.ShowTipPointer`
|
Defines the position of the Tooltip | Not applicable |
Property:`Tooltip.Position`
|