Last updated

API / geotoolkit / flowcharts / shapes / connectors / LinkConnection / LinkConnection

Class: LinkConnection

connectors.LinkConnection.LinkConnection

Stores information about connection between a visual and a link ("arrow"). That said, modelPoint defines a point for the link in visual's bounds (which does takes Local Transformation into account). LinkSide defines the side of a link: Begin or End. linkVisual defines a link that is connected to a visual.

Table of contents

Constructors
Methods

Contents

Constructors

new LinkConnection(visual, modelPoint, linkSide, linkVisual)

new LinkConnection(visual, modelPoint, linkSide, linkVisual)

Creates connection

Throws

if visual does not inherit Node

Parameters

Name Type Description
visualComponenta visual that is related to the link
modelPointPointan anchor point in visual's coordinate system.
linkSideLinkSideside of the link (begin=0 or end=1)
linkVisualILinka link visual instance
Methods

getClassName

getClassName(): string

Returns

string


getLinkSide

getLinkSide(): LinkSide

Gets link side that defines link orientation (flow)

Returns

LinkSide


getLinkVisual

getLinkVisual(): ILink

return link visual

Returns

ILink


getModelPoint

getModelPoint(): Point

Gets model point (in visual space)

Returns

Point


getProperty

getProperty(name): string | number

Parameters

Name Type
name"relatedVisualId"

Returns

string | number

getProperty(name): Component

Parameters

Name Type
name"visuals"

Returns

Component


getRelatedVisualId

getRelatedVisualId(): string | number

gets a visual ID related to this connection

Returns

string | number

a visual ID


getVisual

getVisual(): Component

Gets associated visual

Returns

Component


setProperty

setProperty(name, component): LinkConnection

Parameters

Name Type
name"visuals"
componentComponent

Returns

LinkConnection


getClassName

Static getClassName(): string

Returns

string