SimpleEdge

Show usages

A mutable implementation of the IEdge interface that can be used without an IGraph.

Inheritance Hierarchy

SimpleEdge

Implemented Interfaces

Remarks

Note that this class is not the one used as the default implementation of a Graph's IEdges and casting them to SimpleEdge will fail. Instances of this class can be used without an accompanying graph instance. All the properties are mutable. An example of a possible use case would be the rendering of an edge into a graphics context: Simply create a SimpleEdge, associate a style with it and use the style's renderer instance to obtain a rendering for the edge.

Type Details

yFiles module: view

Constructors

SimpleEdge

(sourcePort?: IPort, targetPort?: IPort)

Creates an edge with a default lookup, and, optionally, the given source and target ports.

Remarks

While technically the source and target port can be null here, this will cause all kinds of issues, e.g. with styles or label models that require the ports to be non-null to work properly.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

sourcePort - IPort: The source port for the edge.
targetPort - IPort: The target port for the edge.
style - IEdgeStyle: The style that is responsible for the visual representation of this edge in a CanvasComponent. This option sets the style property on the created object.
bends - IListEnumerable<IBend>: The collection of bends that describe the geometry of this edge. This option sets the bends property on the created object.
ports - IListEnumerable<IPort>: The collection of ports that are owned by this instance. This option sets the ports property on the created object.
labels - IListEnumerable<ILabel>: The collection of labels that are owned by this instance. This option sets the labels property on the created object.
tag - IEdge['tag']

Properties

bends

: IListEnumerable<IBend>

Gets or sets the collection of bends that describe the geometry of this edge.

Implements

IEdge

isSelfLoop

: boolean

Determines whether an edge is a self-loop, that is, it starts and ends at the same port owner.

Defined in

IEdge

labels

: IListEnumerable<ILabel>

Gets or sets the collection of labels that are owned by this instance.

Implements

ILabelOwner

ports

: IListEnumerable<IPort>

Gets or sets the collection of ports that are owned by this instance.

Implements

IPortOwner

sourceNode

: INode

Gets the source node for the given edge or null.

Throws

Exception({ name: 'InvalidOperationError' }): If the edge's is not set or its is not an .

Defined in

IEdge

sourcePort

: IPort

Gets or sets the source port instance this edge is connected to.

Remarks

Although the notion of source and target port is used for directed edges, it is still up to the client to decide whether the edge should be treated as such.

Throws

Exception({ name: 'InvalidOperationError' }): if the edge has no source port.

Implements

IEdge

style

: IEdgeStyle

Gets or sets the style that is responsible for the visual representation of this edge in a CanvasComponent.

Remarks

Note that the style instance associated with an edge instance may be shared between multiple edge instances and that the modification of this style will result in a change of the appearance of all edges that are associated with the same style instance.

Implements

IEdge

targetNode

: INode

Gets the target node for the given edge or null.

Throws

Exception({ name: 'InvalidOperationError' }): If the edge's is not set or its is not an .

Defined in

IEdge

targetPort

: IPort

Gets or sets the target port instance this edge is connected to.

Remarks

Although the notion of source and target port is used for directed edges, it is still up to the client to decide whether the edge should be treated as such.

Throws

Exception({ name: 'InvalidOperationError' }): if the edge has no target port.

Implements

IEdge

Methods

getDecorator

() : EdgeDecorator

Gets a EdgeDecorator to modify the ports ILookup.

Returns

↪EdgeDecorator: A EdgeDecorator for this instance.

lookup

<T>(type: Constructor<T>) : T

Returns an instance that implements the given type or null.

Remarks

Typically, this method will be called to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile-time constraints. An instance implementing this method is not required to return non-null implementations for the types, nor does it have to return the same instance any time. Also, it depends on the type and context whether the instance returned stays up to date or needs to be re-obtained for further use.

Type Parameters

T

Parameters

options - Object
A map of options to pass to the method.

type - Constructor<T>: the type for which an instance shall be returned

Returns

↪T?: an instance that is assignable to the type or null

Implements

ILookup

opposite

(owner: IPortOwner) : IPortOwner

Gets the opposite port owner of an IEdge.

Parameters

options - Object
A map of options to pass to the method.

owner - IPortOwner: The owner of the port that the IEdge is connected to.

Returns

↪IPortOwner: The owner of the opposite port.

Throws

Exception({ name: 'ArgumentError' }): If owner is neither the source nor target of the edge.

Defined in

IEdge

opposite

(port: IPort) : IPort

Gets the opposite port of an IEdge.

Parameters

options - Object
A map of options to pass to the method.

port - IPort: The port that the IEdge is connected to.

Returns

↪IPort: The opposite port.

Throws

Exception({ name: 'ArgumentError' }): If port is neither the source nor target of the edge.

Defined in

IEdge

SimpleEdge

Remarks

Type Details

Constructors

SimpleEdge

Remarks

ParametersOptions Overload

Properties

bends

See Also

Implements

isSelfLoop

See Also

Defined in

labels

See Also

Implements

ports

See Also

Implements

sourceNode

Throws

Defined in

sourcePort

Remarks

Throws

See Also

Implements

style

Remarks

See Also

Implements

tag

Remarks

Implements

targetNode

Throws

Defined in

targetPort

Remarks

Throws

See Also

Implements

Methods

getDecorator

Returns

lookup

Remarks

Type Parameters

Parameters

Returns

Implements

opposite

Parameters

Returns

Throws

See Also

Defined in

opposite

Parameters

Returns

Throws

See Also

Defined in