SimplePort

Show usages

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

Inheritance Hierarchy

SimplePort

Implemented Interfaces

Remarks

Note that this class is not the one used as the default implementation of a Graph's IPorts and casting them to SimplePort 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 a port into a graphics context: Simply create a SimplePort, associate a style with it and use the style's renderer instance to obtain a rendering for the port.

Type Details

yFiles module: view

Constructors

SimplePort

(owner?: IPortOwner, locationParameter?: IPortLocationModelParameter)

Creates a port with a default lookup using the given location and owner.

Remarks

While technically the owner can be null here, this can cause issues, e.g. with port location models that position the port relative to its owner.

ParametersOptions Overload

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

owner - IPortOwner: The port's owner.
locationParameter - IPortLocationModelParameter: The port's location model parameter. By default, the port is placed at ORIGIN.
style - IPortStyle: The style that is responsible for the visual representation of this port in a CanvasComponent. This option sets the style property on the created object.
tag - IPort['tag']
labels - IListEnumerable<ILabel>: The collection of labels that are owned by this instance. This option sets the labels property on the created object.

Properties

dynamicLocation

: IPoint

Gets a live view of the location of the port in world coordinates.

Remarks

The location is the anchor for the edges that connect to this port. However, it is up to the visualization logic where exactly the visual part of an edge will end. As this will yield a live view, it is up to the client to copy the values if a snapshot of the state is needed. In order to modify the location of a port, use the setPortLocationParameter in IGraph.

Defined in

IPort

labels

: IListEnumerable<ILabel>

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

Implements

ILabelOwner

location

: Point

Gets a snapshot of the current location of the port.

Remarks

Unlike dynamicLocation this does not return a dynamic point that always refers to the current location.

Defined in

IPort

locationParameter

: IPortLocationModelParameter

Gets or sets the IPortLocationModelParameter that is used to determine the location of this port.

Remarks

The port location can be calculated using the model's getLocation method or methods location and dynamicLocation.

Note that parameters may be shared across port instances.

Implements

IPort

owner

: IPortOwner

Gets or sets the owner of this port.

Throws

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

Implements

IPort

style

: IPortStyle

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

Remarks

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

Implements

IPort

Methods

getDecorator

() : PortDecorator

Gets a PortDecorator to modify the ports ILookup.

Returns

↪PortDecorator: A PortDecorator 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

setLocation

(location: Point)

Sets the location of this port.

Remarks

Changes the IMutablePoint if one is found in this port's ILookup. Creates an appropriate locationParameter, otherwise.

Parameters

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

location - Point: The location to set the port to.

SimplePort

Remarks

Type Details

Constructors

SimplePort

Remarks

ParametersOptions Overload

Properties

dynamicLocation

Remarks

See Also

Defined in

labels

See Also

Implements

location

Remarks

See Also

Defined in

locationParameter

Remarks

See Also

Implements

owner

Throws

See Also

Implements

style

Remarks

See Also

Implements

tag

Remarks

Implements

Methods

getDecorator

Returns

lookup

Remarks

Type Parameters

Parameters

Returns

Implements

setLocation

Remarks

Parameters