Search
Diagram Methods
 


 Public Methods

  Name Description

addItem

Adds an item to the Diagram.

alignPointToGrid

Returns a point of the alignment grid nearest to the one passed as an argument.

arrange

Arranges the diagram with the given layout.

arrangeAnimated

Arranges the diagram using the given layout, and animates items moving to their new positions.

arrangeLinkLabels

Rearranges link labels whose autoArrange property is enabled.

cancelCompositeOperation

Stops recording undo/redo commands into a CompositeCommand and discards the records created so far.

clearAll

Removes all items from the diagram.

commitCompositeOperation

Stops recording undo/redo commands into a CompositeCommand and saves the composite in the history queue.

executeCommand

Executes the specified command on this diagram.

fromJson

Deserializes the diagram from a JSON string.

fromXmlDocument

Loads diagram contents from specified XML Document.

getContentBounds

Returns the smallest rectangle that bounds all diagram items.

getItemAt

Finds and returns the topmost DiagramItem found at the specified location.

getItemsAt

Finds and returns an array of the diagram items found at the specified location.

getLinkAt

Finds and returns the topmost DiagramLink found at the specified location.

getLinksAt

Finds and returns an array of the diagram DiagramLinks found at the specified location.

getNearestNode

Returns the node nearest to the specified point.

getNodeAt

Finds and returns the topmost DiagramNode found at the specified location.

getNodesAt

Finds and returns an array of the DiagramNodes found at the specified location.

isItemInteractive

Checks if the specified item can be modified interactively.

isItemVisible

Checks if the specified item is currently visible.

loadFromString

Loads diagram contents from specified XML or JSON string.

loadFromXml

Loads the diagram from an XML file.

raiseClicked

Raises an event which notifies that a Diagram item has been clicked.

raiseCreated

Raises an event which notifies that a Diagram item has been created.

raiseDeleted

Raises an event which notifies that a Diagram item has been deleted.

raiseDeselected

Raises an event which notifies that a Diagram item has been deselected.

raiseDoubleClicked

Raises an event which notifies that a Diagram item has been double-clicked.

raiseModified

Raises an event which notifies that a Diagram item has been modified.

RaiseNodeModifying

Raises the NodeModifying event. (Inherited from DiagramBase.)

raisePasted

Raises an event which notifies that a Diagram item has been pasted from clipboard.

raiseSelected

Raises an event which notifies that a Diagram item has been selected.

raiseSelecting

Raises an event which notifies that a Diagram item will be selected.

raiseSelectionChanged

Raises an event which notifies that the selection has changed.

redo

Executes again an action saved in the command history.

registerClass

Registers a diagram item class.

registerComponent

Registers a component class.

registerItemClass

Registers a diagram item class for XML serialization support.

removeItem

Removes the specified item from the Diagram.

resizeToFitItem

Resize the document extents so that the specified item is contained within.

resizeToFitItems

Resizes the document scrollable area so that it fits all diagram items.

routeAllLinks

Routes all links in the diagram in such a way they do not cross nodes.

saveToString

Encodes the diagram contents into an XML or JSON string.

saveToXml

Saves the diagram to an XML file.

startCompositeOperation

Starts recording undo/redo commands into a CompositeCommand.

toJson

Serializes the diagram into a JSON string.

toXmlDocument

Saves the diagram into an XML Document.

TrackMouseHover

Specifies whether the diagram view should track mouse hover events. (Inherited from DiagramBase.)

undo

Undoes an action saved in the command history.

 Protected Methods

  Name Description

OnActionRecorded

Raises the ActionRecorded event. (Inherited from DiagramBase.)

OnActionRecording

Raises the ActionRecording event. (Inherited from DiagramBase.)

OnActionRedone

Raises the ActionRedone event. (Inherited from DiagramBase.)

OnActionUndone

Raises the ActionUndone event. (Inherited from DiagramBase.)

OnBeginLoad

Raises the BeginLoad event. (Inherited from DiagramBase.)

OnBoundsChanged

Raises the BoundsChanged event. (Inherited from DiagramBase.)

OnCellClicked

Raises the CellClicked event. (Inherited from DiagramBase.)

OnCellDoubleClicked

Raises the CellDoubleClicked event. (Inherited from DiagramBase.)

OnCellTextEdited

Raises the CellTextEdited event. (Inherited from DiagramBase.)

OnCellTextEditing

Raises the CellTextEditing event to validate entering inplace edit mode. (Inherited from DiagramBase.)

OnClicked

Raises the Clicked event. (Inherited from DiagramBase.)

OnContainerChildAdded

Raises the ContainerChildAdded event. (Inherited from DiagramBase.)

OnContainerChildRemoved

Raises the ContainerChildRemoved event. (Inherited from DiagramBase.)

OnContainerFolded

Raises the ContainerFolded event. (Inherited from DiagramBase.)

OnContainerUnfolded

Raises the ContainerUnfolded event. (Inherited from DiagramBase.)

OnContentVisibilityChanged

Raises the ContentVisibilityChanged event. (Inherited from DiagramBase.)

OnDefaultShapeChanged

Raises the DefaultShapeChanged event. (Inherited from DiagramBase.)

OnDeserializeTag

Raises the DeserializeTag event. (Inherited from DiagramBase.)

OnDestinationAnchorChanged

Raises the DestinationAnchorChanged event. (Inherited from DiagramBase.)

OnDirtyChanged

Raises the DirtyChanged event. (Inherited from DiagramBase.)

OnDoubleClicked

Raises the DoubleClicked event. (Inherited from DiagramBase.)

OnDrawAdjustmentHandles

Raises the DrawAdjustmentHandles event. (Inherited from DiagramBase.)

OnDrawAnchorPoint

Raises the DrawAnchorPoint event. (Inherited from DiagramBase.)

OnDrawBackground

Raises the DrawBackground event. (Inherited from DiagramBase.)

OnDrawBranchIndicator

Raises the DrawBranchIndicator event. (Inherited from DiagramBase.)

OnDrawCell

Raises the DrawCell event. (Inherited from DiagramBase.)

OnDrawForeground

Raises the DrawForeground event. (Inherited from DiagramBase.)

OnDrawLink

Raises the DrawLink event. (Inherited from DiagramBase.)

OnDrawNode

Raises the DrawNode event. (Inherited from DiagramBase.)

OnEndLoad

Raises the EndLoad event. (Inherited from DiagramBase.)

OnExpandButtonClicked

Raises the ExpandButtonClicked event. (Inherited from DiagramBase.)

OnGroupDestroyed

Raises the GroupDestroyed event. (Inherited from DiagramBase.)

OnHitTestAdjustmentHandles

Raises the HitTestAdjustmentHandles event. (Inherited from DiagramBase.)

OnInitializeLasso

Raises the InitializeLasso event. (Inherited from DiagramBase.)

OnInitializeLink

Raises the InitializeLink event. (Inherited from DiagramBase.)

OnInitializeNode

Raises the InitializeNode event. (Inherited from DiagramBase.)

OnItemAdded

Raises the ItemAdded event. (Inherited from DiagramBase.)

OnItemRemoved

Raises the ItemRemoved event. (Inherited from DiagramBase.)

OnJsonDeserializeTag

Raises the JsonDeserializeTag event. (Inherited from DiagramBase.)

OnJsonSerializeTag

Raises the JsonSerializeTag event. (Inherited from DiagramBase.)

OnLayerVisibilityChanged

Raises the LayerVisibilityChanged event. (Inherited from DiagramBase.)

OnLinkActivated

Raises the LinkActivated event. (Inherited from DiagramBase.)

OnLinkClicked

Raises the LinkClicked event. (Inherited from DiagramBase.)

OnLinkCreateCancelled

Raises the LinkCreateCancelled event. (Inherited from DiagramBase.)

OnLinkCreated

Raises the LinkCreated event. (Inherited from DiagramBase.)

OnLinkCreating

Raises the LinkCreating event. (Inherited from DiagramBase.)

OnLinkDeactivated

Raises the LinkDeactivated event. (Inherited from DiagramBase.)

OnLinkDeleted

Raises the LinkDeleted event. (Inherited from DiagramBase.)

OnLinkDeleting

Raises the LinkDeleting event. (Inherited from DiagramBase.)

OnLinkDeselected

Raises the LinkDeselected event. (Inherited from DiagramBase.)

OnLinkDoubleClicked

Raises the LinkDoubleClicked event. (Inherited from DiagramBase.)

OnLinkHovered

Raises the LinkHovered event. (Inherited from DiagramBase.)

OnLinkModified

Raises the LinkModified event. (Inherited from DiagramBase.)

OnLinkModifyCancelled

Raises the LinkModifyCancelled event. (Inherited from DiagramBase.)

OnLinkModifying

Raises the LinkModifying event. (Inherited from DiagramBase.)

OnLinkPasted

Raises the LinkPasted event. (Inherited from DiagramBase.)

OnLinkRouted

Raises the LinkRouted event. (Inherited from DiagramBase.)

OnLinkSelected

Raises the LinkSelected event. (Inherited from DiagramBase.)

OnLinkSelecting

Raises the LinkSelecting event. (Inherited from DiagramBase.)

OnLinkSplit

Raises the LinkSplit event. (Inherited from DiagramBase.)

OnLinkStartModifying

Raises the LinkStartModifying event. (Inherited from DiagramBase.)

OnLinkTextEdited

Raises the LinkTextEdited event. (Inherited from DiagramBase.)

OnLinkTextEditing

Raises the LinkTextEditing event to validate entering inplace edit mode. (Inherited from DiagramBase.)

OnMeasureUnitChanged

Raises the MeasureUnitChanged event. (Inherited from DiagramBase.)

OnNodeActivated

Raises the NodeActivated event. (Inherited from DiagramBase.)

OnNodeClicked

Raises the NodeClicked event. (Inherited from DiagramBase.)

OnNodeCreateCancelled

Raises the NodeCreateCancelled event. (Inherited from DiagramBase.)

OnNodeCreated

Raises the NodeCreated event. (Inherited from DiagramBase.)

OnNodeCreating

Raises the NodeCreating event. (Inherited from DiagramBase.)

OnNodeDeactivated

Raises the NodeDeactivated event. (Inherited from DiagramBase.)

OnNodeDeleted

Raises the NodeDeleted event. (Inherited from DiagramBase.)

OnNodeDeleting

Raises the NodeDeleting event. (Inherited from DiagramBase.)

OnNodeDeselected

Raises the NodeDeselected event. (Inherited from DiagramBase.)

OnNodeDoubleClicked

Raises the NodeDoubleClicked event. (Inherited from DiagramBase.)

OnNodeHovered

Raises the NodeHovered event. (Inherited from DiagramBase.)

OnNodeModified

Raises the NodeModified event. (Inherited from DiagramBase.)

OnNodeModifyCancelled

Raises the NodeModifyCancelled event. (Inherited from DiagramBase.)

OnNodeModifying

Raises the NodeModifying event. (Inherited from DiagramBase.)

OnNodePasted

Raises the NodePasted event. (Inherited from DiagramBase.)

OnNodeSelected

Raises the NodeSelected event. (Inherited from DiagramBase.)

OnNodeSelecting

Raises the NodeSelecting event. (Inherited from DiagramBase.)

OnNodeStartModifying

Raises the NodeStartModifying event. (Inherited from DiagramBase.)

OnNodeTextEdited

Raises the NodeTextEdited event. (Inherited from DiagramBase.)

OnNodeTextEditing

Raises the NodeTextEditing event to validate entering inplace edit mode. (Inherited from DiagramBase.)

OnOriginAnchorChanged

Raises the OriginAnchorChanged event. (Inherited from DiagramBase.)

OnPropertyChanged

Raises the PropertyChanged event. (Inherited from DiagramBase.)

OnQueryAlignTarget

Raises the QueryAlignTarget event. (Inherited from DiagramBase.)

OnRepaint

Raises the Repaint event. (Inherited from DiagramBase.)

OnRequestClipboard

Raises the RequestClipboard event. (Inherited from DiagramBase.)

OnRequestDrawInteractions

Raises the RequestDrawInteractions event. (Inherited from DiagramBase.)

OnRequestTimer

Raises the RequestTimer event. (Inherited from DiagramBase.)

OnSelectionChanged

Raises the SelectionChanged event. (Inherited from DiagramBase.)

OnSelectionModified

Raises the SelectionModified event. (Inherited from DiagramBase.)

OnSelectionModifying

Raises the SelectionModifying event. (Inherited from DiagramBase.)

OnSerializeTag

Raises the SerializeTag event. (Inherited from DiagramBase.)

OnSetSelfLoopShape

Raises the SetSelfLoopShape event. (Inherited from DiagramBase.)

OnShapeModified

Raises the ShapeModified event. (Inherited from DiagramBase.)

OnShapeNotDefined

Raises the ShapeNotDefined event. (Inherited from DiagramBase.)

OnTableColumnResized

Raises the TableColumnResized event. (Inherited from DiagramBase.)

OnTableColumnResizing

Raises the TableColumnResizing event. (Inherited from DiagramBase.)

OnTableRowResized

Raises the TableRowResized event. (Inherited from DiagramBase.)

OnTableRowResizing

Raises the TableRowResizing event. (Inherited from DiagramBase.)

OnTableSectionCollapsed

Raises the TableSectionCollapsed event. (Inherited from DiagramBase.)

OnTableSectionExpanded

Raises the TableSectionExpanded event. (Inherited from DiagramBase.)

OnTreeCollapsed

Raises the TreeCollapsed event. (Inherited from DiagramBase.)

OnTreeExpanded

Raises the TreeExpanded event. (Inherited from DiagramBase.)

OnTreeItemTextEditing

Raises the TreeItemTextEditing event. (Inherited from DiagramBase.)

OnValidateAnchorPoint

Raises the ValidateAnchorPoint event. (Inherited from DiagramBase.)

OnValidateLinkCrossing

Raises the ValidateLinkCrossing event. (Inherited from DiagramBase.)

OnViewRemoved

Raises the ViewRemoved event. (Inherited from DiagramBase.)

 See Also