Port

Defined in: parts/Port.ts:10

A connection point on a Node where Links can attach. Ports can be positioned by an alignment or a Spot.

Constructors

Constructor

new Port(name): Port

Defined in: parts/Port.ts:17

Parameters

name

string

Returns

Port

Accessors

alignment

Get Signature

get alignment(): PortAlignment

Defined in: parts/Port.ts:27

The alignment of this port on its node.

Returns

PortAlignment

Set Signature

set alignment(value): void

Defined in: parts/Port.ts:31

Parameters

value

PortAlignment

Returns

void

---

name

Get Signature

get name(): string

Defined in: parts/Port.ts:22

The port name (used to reference it from link data).

Returns

string

---

size

Get Signature

get size(): Size | null

Defined in: parts/Port.ts:46

The size of this port (for rendering).

Returns

Size | null

Set Signature

set size(value): void

Defined in: parts/Port.ts:50

Parameters

value

Size | null

Returns

void

---

spot

Get Signature

get spot(): Spot | null

Defined in: parts/Port.ts:36

A custom Spot for precise positioning. Overrides alignment.

Returns

Spot | null

Set Signature

set spot(value): void

Defined in: parts/Port.ts:40

Parameters

value

Spot | null

Returns

void

---

visible

Get Signature

get visible(): boolean

Defined in: parts/Port.ts:55

Whether this port is visible.

Returns

boolean

Set Signature

set visible(value): void

Defined in: parts/Port.ts:59

Parameters

value

boolean

Returns

void

Methods

computePoint()

computePoint(x, y, width, height): object

Defined in: parts/Port.ts:66

Compute the point of this port on a node bounds.

Parameters

x

number

y

number

width

number

height

number

Returns

object

x

x: number

y

y: number