Search
DiagramLink Members
Constructors Properties Methods
 


Represents a link between two diagram nodes.

The following tables list the members exposed by the DiagramLink type.

 Public Constructors

  Name Description

DiagramLink

Initializes a new instance of the DiagramLink class between the specified nodes using the specified diagram link as a prototype.

 Public Properties

  Name Description

autoRoute

Gets or sets whether this link should be automatically routed to avoid crossing nodes.

baseBrush

Gets or sets an object that specifies how to fill link's baseShape.

baseShape

Gets or sets the arrowhead shape displayed at the link' start point.

baseShapeSize

Gets or sets the size of the arrowhead displayed at the link's start point.

brush

Gets or sets an object specifying how to fill the interior of this item. (Inherited from DiagramItem.)

container

Gets the parent ContainerNode containing this node. (Inherited from DiagramItem.)

controlPoints

Gets or sets the control points of this link.

destination

Gets or sets the destination node of this link.

destinationAnchor

Gets or sets the anchor point to which the link connects at its destination.

destinationIndex

Gets or sets the index of link's destination row when destination is a TableNode.

dynamic

Gets or sets whether link's end segments are automatically adjustedin order to keep pointing to the centers of the nodes it connects.

effectiveBrush

Gets the effective brush that should be used to paint this item. (Inherited from DiagramItem.)

effectiveCaptionBackBrush

Gets the effective brush that should be used to paint node's caption bar. (Inherited from DiagramItem.)

effectiveFont

Gets the effective font that should be used to render this item's text. (Inherited from DiagramItem.)

effectiveFontName

Gets the name of the effective font that should be used to render this item's text. (Inherited from DiagramItem.)

effectiveFontSize

Gets the size of the effective font that should be used to render this item's text. (Inherited from DiagramItem.)

effectiveFontStyle

Gets the style of the effective font that should be used to render this item's text. (Inherited from DiagramItem.)

effectiveOpacity

Gets the effective opacity that should be used to paint this item. (Inherited from DiagramItem.)

effectiveShadowColor

Gets the effective color that should be used to render this item's shadow. (Inherited from DiagramItem.)

effectiveStroke

Gets the effective color that should be used to stroke this item. (Inherited from DiagramItem.)

effectiveStrokeDashArray

Gets the effective line dash array that should be applied when stroking this item. (Inherited from DiagramItem.)

effectiveStrokeDashOffset

Gets the effective line dash offset that should be applied when stroking this item. (Inherited from DiagramItem.)

effectiveStrokeDashStyle

Gets the effective line dash pattern that should be applied when stroking this item. (Inherited from DiagramItem.)

effectiveStrokeThickness

Gets the effective line thickness that should be applied when stroking this item. (Inherited from DiagramItem.)

effectiveTextColor

Gets the effective text color that should be used to render this item's text. (Inherited from DiagramItem.)

effectiveTextStroke

Gets the effective text color that should be used to render this item's text outline. (Inherited from DiagramItem.)

effectiveTextStrokeThickness

Gets the effective width of the text outline of this item. (Inherited from DiagramItem.)

endPoint

Gets or sets the last control point of this link.

font

Gets or sets the font used to render item's text. (Inherited from DiagramItem.)

graphicsContent

Gets an array of visual elements used to render this item on the canvas. (Inherited from DiagramItem.)

headBrush

Gets or sets an object that specifies how to fill link's headShape.

headShape

Gets or sets the arrowhead shape displayed at the link' end point.

headShapeSize

Gets or sets the size of the arrowhead displayed at the link's end point.

headStroke

Gets or sets the brush used to stroke the outline of link's arrowheads.

headStrokeDashStyle

Gets or sets the dash pattern of arrowhead outlines.

headStrokeThickness

Gets or sets the thickness of arrowhead outlines.

hyperLink

Gets or sets the hyperlink associated with this diagram item. (Inherited from DiagramItem.)

id

Gets or sets a custom identifier associated with this item. (Inherited from DiagramItem.)

ignoreLayout

Gets or sets a value indicating whether the position of this item should not be changed by automatic layout methods. (Inherited from DiagramItem.)

intermediateBrush

Gets or sets an object that specifies how to fill intermediateShape arrowheads.

intermediateShape

Gets or sets the arrowhead shape displayed at the middle of each segment of the link.

intermediateShapeSize

Gets or sets the size of the arrowhead displayed at the middle of each segment of the link.

layoutTraits

Gets an object containing properties specific to individual layout algorithms. (Inherited from DiagramItem.)

lineAlignment

Gets or sets the vertical alignment of item's text. (Inherited from DiagramItem.)

locked

Gets or sets whether users are allowed to interact with this item. (Inherited from DiagramItem.)

opacity

Gets or sets opacity of this item. (Inherited from DiagramItem.)

origin

Gets or sets the origin node of this link.

originAnchor

Gets or sets the anchor point to which the link connects at its origin.

originIndex

Gets or sets the index of link's origin row when origin is a TableNode.

parent

Gets the Diagram to which this item belongs. (Inherited from DiagramItem.)

pen

Gets or sets the color used to stroke item's borders. (Inherited from DiagramItem.)

segmentCount

Gets or sets the number of segments that form the link's geometry.

selected

Gets or sets a value indicating whether a diagram item is selected. (Inherited from DiagramItem.)

shadowColor

Gets or sets the color used to draw item's shadow. (Inherited from DiagramItem.)

shadowOffsetX

Gets or sets the horizontal offset of item's shadow. (Inherited from DiagramItem.)

shadowOffsetY

Gets or sets the vertical offset of item's shadow. (Inherited from DiagramItem.)

shape

Gets or sets the type of link segments and how they are oriented relatively to each other.

startPoint

Gets or sets the first control point of this link.

stroke

Gets or sets the color used to stroke item's frame. (Inherited from DiagramItem.)

strokeDashArray

Gets or sets an array of values specifying the dash pattern. (Inherited from DiagramItem.)

strokeDashOffset

Gets or sets the the distance between the line start and the beginning of the dash pattern. (Inherited from DiagramItem.)

strokeDashStyle

Gets or sets the line dash pattern applied when stroking item's frame. (Inherited from DiagramItem.)

strokeThickness

Gets or sets the line width applied when stroking item's frame. (Inherited from DiagramItem.)

style

Gets or sets the style associated with this item. (Inherited from DiagramItem.)

tag

Gets or sets custom data tag associated with this item. (Inherited from DiagramItem.)

text

Gets or sets the text displayed by this link.

textAlignment

Gets or sets the alignment of link's text.

textColor

Gets or sets the color used to fill item's text. (Inherited from DiagramItem.)

textComponent

Gets the Text object instance used to render item's text. (Inherited from DiagramItem.)

textPadding

Gets or sets the padding distance between item's boundaries and text label. (Inherited from DiagramItem.)

textStroke

Gets or sets the color used to stroke item's text. (Inherited from DiagramItem.)

textStrokeThickness

Gets or sets the outline width of item's text. (Inherited from DiagramItem.)

textStyle

Gets or sets the placement and orientation of link's text.

tooltip

Gets or sets tooltip text that should be displayed when the mouse hovers over this item. (Inherited from DiagramItem.)

topLevel

Gets if this is a top-level item in the diagram. (Inherited from DiagramItem.)

visible

Gets or sets a value indicating whether this item is visible. (Inherited from DiagramItem.)

weight

Gets or sets a weight value used by layout and path-finding algorithms. (Inherited from DiagramItem.)

zIndex

Gets the z-order position of this item. (Inherited from DiagramItem.)

 Public Methods

  Name Description

addCanvasElements

Derived classes must implement this method by adding their graphics primitives to the canvas.elements collection. (Inherited from DiagramItem.)

addLabel

Adds a new label to this link.

allowDrag

DiagramItem.allowDrag override.

animate

Animates the item. (Inherited from DiagramItem.)

clone

DiagramItem.clone override.

containsPoint

DiagramItem.containsPoint override.

endDrag

DiagramItem.endDrag override.

fromJson

Deserializes this item from a JSON object. (Inherited from DiagramItem.)

fromJson

DiagramItem.fromJson override.

getLength

Gets the length of the links

getRepaintBounds

Gets the repaint region for this item, taking into account factors such as pen width, selection handles and shadow. (Inherited from DiagramItem.)

hitTest

Returns the diagram item that contains the specified point. (Inherited from DiagramItem.)

intersects

Checks whether the link contour intersects with the outline of the specified node.

invalidate

Invalidates the region of the canvas, that matches the item's repaint bounds. (Inherited from DiagramItem.)

loadFromXml

DiagramItem.LoadFromXml override. Loads the link's content from an XML element.

onRemove

Called when an item is removed from a Diagram, either by the user, programmatically or via undo / redo. (Inherited from DiagramItem.)

pointAlongLength

Returns a point lying on a polyline that is positioned at a relative position along the polyline's length.

putEndPointsAtNodeBorders

Places the link's end points on the outline of its origin and destination nodes.

removeCanvasElements

Derived classes must implement this method by removing their graphics primitives from the canvas.elements collection. (Inherited from DiagramItem.)

removeLabel

Removes the specified label from this item. (Inherited from DiagramItem.)

removeLabel

Removes the specified label from this link.

restoreLocationState

DiagramItem.restoreLocationState override.

restoreState

DiagramItem.restoreState override.

restoreState

Loads the properties of this diagram item. (Inherited from DiagramItem.)

route

Routes this link, regardless of whether the link's autoRoute property is enabled.

saveLocationState

DiagramItem.saveLocationState override.

saveState

DiagramItem.saveState override.

saveToXml

Saves the item's content into an XML element.

setDestination

Sets the destination node of this link.

splitSegment

Splits the link segment with the specified index at the specified point.

startDrag

DiagramItem.startDrag override.

toJson

DiagramItem.toJson override.

updateCanvasElements

Updates the elements on the HTML Canvas.

updateDrag

DiagramItem.updateDrag override.

updateFromPoints

Updates the link's internal state after the link's control points have been changed.

 See Also