DiagramLink Class Reference


                    
                    
                    init()

Initializes a new instance of the DiagramLink class.

Declaration

Swift

public override init()

Return Value

The newly created DiagramLink instance.


                    
                    
                    getTextToEdit()

Undocumented

Declaration

Swift

open func getTextToEdit() -> String


                    
                    
                    setEditedText(_:)

Undocumented

Declaration

Swift

open func setEditedText(_ text: String)


                    
                    
                    getEditRect(_:pointerPosition:)

Undocumented

Declaration

Swift

open func getEditRect(_ item: DiagramItem?, pointerPosition: Point) -> Rect


                    
                    
                    raiseItemTextEditing(_:newText:)

Undocumented

Declaration

Swift

open func raiseItemTextEditing(_ oldText: String, newText: String)


                    
                    
                    raiseItemTextEdited(_:newText:)

Undocumented

Declaration

Swift

open func raiseItemTextEdited(_ oldText: String, newText: String)


                    
                    
                    getEditedItem()

Undocumented

Declaration

Swift

open func getEditedItem() -> DiagramItem


                    
                    
                    alignPoints()

Aligns all Point-s of this DiagramLink.

Declaration

Swift

open func alignPoints()


                    
                    
                    originConnection

Gets or sets the ConnectionPoint object representing the link connection to its origin node. This allows connecting the link to a constituent part of a node, such as a TreeViewItem.

Declaration

Swift

open lazy var originConnection: ConnectionPoint { get set }


                    
                    
                    destinationConnection

Gets or sets the ConnectionPoint object representing the link connection to its destination node. This allows connecting the link to a constituent part of a node, such as a TreeViewItem.

Declaration

Swift

open lazy var destinationConnection: ConnectionPoint { get set }


                    
                    
                    origin

Gets or sets the DiagramNode that is the origin of this DiagramLink.

Declaration

Swift

open var origin: DiagramNode { get set }


                    
                    
                    destination

Gets or sets the DiagramNode that is the destination of this DiagramLink.

Declaration

Swift

open var destination: DiagramNode { get set }


                    
                    
                    originAnchor

Gets or sets the index of the origin anchor point within the AnchorPattern that contains it.

Declaration

Swift

open var originAnchor: Int { get set }


                    
                    
                    destinationAnchor

Gets or sets the index of the destination anchor point within the AnchorPattern that contains it.

Declaration

Swift

open var destinationAnchor: Int { get set }


                    
                    
                    startPoint

Gets or sets the position of the first control point of this link.

Declaration

Swift

open var startPoint: Point { get set }


                    
                    
                    endPoint

Gets or sets the position of the last control point of this link.

Declaration

Swift

open var endPoint: Point { get set }


                    
                    
                    hitTestHandle(_:)

Overrides DiagramItem.HitTestHandle.

Declaration

Swift

open override func hitTestHandle(_ point: Point) -> AdjustmentHandle?


                    
                    
                    containsPoint(_:)

Overrides DiagramItem.containsPoint.

Declaration

Swift

open override func containsPoint(_ point: Point) -> Bool


                    
                    
                    containsPoint(_:threshold:)

Overrides DiagramItem.containsPoint.

Declaration

Swift

open override func containsPoint(_ point: Point, threshold: Double) -> Bool


                    
                    
                    labelFromPoint(_:)

Undocumented

Declaration

Swift

public func labelFromPoint(_ point: Point) -> LinkLabel?


                    
                    
                    getClassId()

Returns a string with the class Id for this class.

Declaration

Swift

open override func getClassId() -> String

Return Value

The class id.


                    
                    
                    draw(_:)

Draws the link in the specified canvas.

Declaration

Swift

open func draw(_ canvas: inout Canvas)

Parameters


                                canvas

The canvas at which the link is drawn.


                    
                    
                    draw(_:options:)

Draws the link in the specified canvas.

Declaration

Swift

open override func draw(_ canvas: Canvas, options: RenderOptions)

Parameters

`canvas`	The canvas at which the link is drawn.
`options`	The RenderOptions considered when the link is drawn.


                    
                    
                    drawHandles(_:)

Overrides DiagramItem.DrawHandles.

Declaration

Swift

open override func drawHandles(_ canvas: Canvas)


                    
                    
                    createState()

Create state storage for the diagram item.

Declaration

Swift

open override func createState() -> DiagramItemState


                    
                    
                    saveState()

Saves the state of the diagram item.

Declaration

Swift

open override func saveState() -> DiagramItemState


                    
                    
                    restoreState(_:)

Restores the state of the diagram item.

Declaration

Swift

open override func restoreState(_ state: DiagramItemState)


                    
                    
                    loadFromXml(_:context:)

Overrides DiagramItem.loadFromXml.

Declaration

Swift

open override func loadFromXml(_ element: XmlElement, context: XmlContext)


                    
                    
                    saveToXml(_:context:)

Overrides DiagramItem.saveToXml.

Declaration

Swift

open override func saveToXml(_ element: XmlElement, context: XmlContext)


                    
                    
                    drawArrowhead(_:shape:pivot:position:segmentStart:size:)

Draws an arrowhead shape.

Declaration

Swift

open class func drawArrowhead(
    _ canvas: Canvas,
    shape: Shape?,
    pivot: Point,
    position: Point,
    segmentStart: Point,
    size: Double)

Parameters

`canvas`	The canvas to draw the shape on.
`shape`	A Shape instance that defines the arrowhead geometry.
`pivot`	A Point specified in percents that corresponds to the arrowhead tip position within the Shape geometry.
`position`	A point on the drawing surface where the arrowhead tip should be located.
`segmentStart`	A point specifying the arrowhead direction.
`size`	A double value that specifies the arrowhead size.


                    
                    
                    getBounds()

Overrides DiagramItem.getBounds().

Declaration

Swift

open override func getBounds() -> Rect


                    
                    
                    resolveInheritedStyle(_:theme:)

Looks for a Style that defines an appearance property’s value in specified Theme. Overrides DiagramItem.resolveInheritedStyle(...).

Declaration

Swift

open override func resolveInheritedStyle(_ check: StyleCheck, theme: Theme?) -> Style?

Parameters


                                check

A StyleCheck predicate that verifies if property is set.

Return Value

The Style if resolved, or nil otherwise.


                    
                    
                    controlPoints

Represents a collection of the control points of this link.

Declaration

Swift

open var controlPoints: [Point]


                    
                    
                    updateFromPoints()

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

Declaration

Swift

open func updateFromPoints()


                    
                    
                    shape

Gets or sets the type of this DiagramLink.

Declaration

Swift

open var shape: LinkShape { get set }


                    
                    
                    headStroke

Gets or sets the color that specifies how the arrowhead stroke outline is painted.

Declaration

Swift

open var headStroke: Color { get set }


                    
                    
                    headStrokeThickness

Gets or sets the width of the arrowhead stroke outline.

Declaration

Swift

open var headStrokeThickness: Double { get set }


                    
                    
                    headShape

Gets or sets the shape of this link’s arrowhead.

Declaration

Swift

open var headShape: Shape? { get set }


                    
                    
                    headShapeSize

Gets or sets the size of the arrowhead shape.

Declaration

Swift

open var headShapeSize: Double { get set }


                    
                    
                    headBrush

Gets or sets the brush to use when painting arrowheads lines.

Declaration

Swift

open var headBrush: Brush? { get set }


                    
                    
                    baseShape

Gets or sets what shape to display at the beginning of a link.

Declaration

Swift

open var baseShape: Shape? { get set }


                    
                    
                    baseShapeSize

Gets or sets the size of the shape at the beginning of the link.

Declaration

Swift

open var baseShapeSize: Double { get set }


                    
                    
                    baseBrush

Gets or sets the brush to use when painting the beginning of a link.

Declaration

Swift

open var baseBrush: Brush? { get set }


                    
                    
                    intermediateShape

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

Declaration

Swift

open var intermediateShape: Shape? { get set }


                    
                    
                    intermediateShapeSize

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

Declaration

Swift

open var intermediateShapeSize: Double { get set }


                    
                    
                    intermediateBrush

Gets or sets the brush to use when painting the shape at the middle of each segment of the link.

Declaration

Swift

open var intermediateBrush: Brush? { get set }


                    
                    
                    pivot

Specifies the pivot point.

Declaration

Swift

public let pivot: Point


                    
                    
                    cascadeStartHorizontal

Gets or sets whether cascading links start in horizontal direction.

Declaration

Swift

open var cascadeStartHorizontal: Bool


                    
                    
                    drawCrossings

Gets or sets whether link crossings are drawn.

Declaration

Swift

open var drawCrossings: Bool { get set }


                    
                    
                    crossingRadius

Gets or sets the radius of the link crossing.

Declaration

Swift

open var crossingRadius: Double { get set }


                    
                    
                    labels

Returns the list of all labels displayed by this link.

Declaration

Swift

open var labels: [LinkLabel]


                    
                    
                    center

Specifies the center Point.

Declaration

Swift

open var center: Point { get }


                    
                    
                    segmentCount

Gets or sets the number of segments of this link.

Declaration

Swift

open var segmentCount: Int { get set }


                    
                    
                    isTopLevel()

Overrides DiagramItem.isTopLavel.

Declaration

Swift

open override func isTopLevel() -> Bool


                    
                    
                    autoRoute

Turns on or off auto routing for this DiagramLink.

Declaration

Swift

open var autoRoute: Bool