C

FreeNodePortLocationModel

Show Usages
A straightforward implementation of an IPortLocationModel for IPorts at INodes that determine the location dynamically using the layout.
ImplementsInheritance Hierarchy

Remarks

Internally, the location is stored as the ratios by which the width and height of the layout need to be scaled and additional offsets to obtain the offset to the top-left corner of the node layout.

See Also

Developer's Guide

Members

No filters for this type

Methods

createParameter

(owner: IPortOwner, location: Point): IPortLocationModelParameter
Factory method that creates a parameter for the given owner that tries to match the provided location in absolute world coordinates.
final

Parameters

owner: IPortOwner
The port owner that will own the port for which the parameter shall be created.
location: Point
The location in the world coordinate system that should be matched as best as possible.

Return Value

IPortLocationModelParameter
A new instance that can be used to describe the location of an IPort at the given owner.

createParameterForRatios

(ratios: Point, offset?: Point): FreeNodePortLocationModelParameter
Creates a parameter that uses the given ratios and offsets.
The ratios will be scaled by the node layout's size and added to the node's top left corner and the offset to determine the port location.
final

Parameters

ratios: Point
The ratios of the node layout's size.
offset?: Point
The offset that is added after the ratios are applied.

Return Value

FreeNodePortLocationModelParameter
A new parameter that matches the specification.

Throws

Exception ({ name: 'ArgumentError' })
ratios or offset contains one or more NaN values.

getContext

(port: IPort): ILookup
Provides a lookup context for the given port.
final

Parameters

port: IPort
The port to use in the context.

Return Value

ILookup
An implementation of the ILookup interface that can be used to query additional aspects of the port.

getLocation

(port: IPort, locationParameter: IPortLocationModelParameter): Point
Determines the location of the port for the given parameter.
final

Parameters

port: IPort
The port to determine the location for.
locationParameter: IPortLocationModelParameter
The parameter to use. The parameter can be expected to be created by this instance having the model property set to this instance.

Return Value

Point
The calculated location of the port.

Constants

BOTTOM

: FreeNodePortLocationModelParameter
static
A read only immutable singleton instance of a parameter that locates the port at the center of the bottom border of the node layout.
This is the same as creating a parameter using (0.5,1) as ratios and (0,0) as offsets.
static

BOTTOM_LEFT

: FreeNodePortLocationModelParameter
static
A read only immutable singleton instance of a parameter that locates the port at the bottom left corner of the node layout.
This is the same as creating a parameter using (0,1) as ratios and (0,0) as offsets.
static

BOTTOM_RIGHT

: FreeNodePortLocationModelParameter
static
A read only immutable singleton instance of a parameter that locates the port at the bottom right corner of the node layout.
This is the same as creating a parameter using (1,1) as ratios and (0,0) as offsets.
static

CENTER

: FreeNodePortLocationModelParameter
static
A read only immutable singleton instance of a parameter that locates the port at the center of the node layout.
This is the same as creating a parameter using (0.5,0.5) as ratios and (0,0) as offsets.
static

INSTANCE

: FreeNodePortLocationModel
static
A read only immutable instance of the FreeNodePortLocationModel.

LEFT

: FreeNodePortLocationModelParameter
static
A read only immutable singleton instance of a parameter that locates the port at the center of the left border of the node layout.
This is the same as creating a parameter using (0,0.5) as ratios and (0,0) as offsets.
static

RIGHT

: FreeNodePortLocationModelParameter
static
A read only immutable singleton instance of a parameter that locates the port at the center of the right border of the node layout.
This is the same as creating a parameter using (1,0.5) as ratios and (0,0) as offsets.
static

TOP

: FreeNodePortLocationModelParameter
static
A read only immutable singleton instance of a parameter that locates the port at the center of the top border of the node layout.
This is the same as creating a parameter using (0.5,0) as ratios and (0,0) as offsets.
static

TOP_LEFT

: FreeNodePortLocationModelParameter
static
A read only immutable singleton instance of a parameter that locates the port at the top left corner of the node layout.
This is the same as creating a parameter using (0,0) as ratios and (0,0) as offsets.
static

TOP_RIGHT

: FreeNodePortLocationModelParameter
static
A read only immutable singleton instance of a parameter that locates the port at the top right corner of the node layout.
This is the same as creating a parameter using (1,0) as ratios and (0,0) as offsets.
static