Adornment

Defined in: parts/Adornment.ts:36

An Adornment is a Part that is attached to another Part. It is used for selection handles, resize handles, rotation handles, tooltips, context menus, and any user-defined visual decoration.

Extends

• Part

Constructors

Constructor

new Adornment(key, name, type, bounds?): Adornment

Defined in: parts/Adornment.ts:43

Parameters

key

NodeKey

name

string

type

AdornmentType

bounds?

Rect

Returns

Adornment

Overrides

Part.constructor

Accessors

actualBounds

Get Signature

get actualBounds(): Rect

Defined in: parts/Part.ts:230

GoJS-compatible: The actual bounds of this part in document coordinates.

Returns

Rect

Set Signature

set actualBounds(value): void

Defined in: parts/Part.ts:234

Parameters

value

Rect

Returns

void

Inherited from

Part.actualBounds

---

adornedPart

Get Signature

get adornedPart(): Part | null

Defined in: parts/Adornment.ts:50

The part this adornment is attached to.

Returns

Part | null

Set Signature

set adornedPart(value): void

Defined in: parts/Adornment.ts:54

Parameters

value

Part | null

Returns

void

---

adornmentName

Get Signature

get adornmentName(): string

Defined in: parts/Adornment.ts:59

The name of this adornment (e.g., ‘Selection’, ‘Resize’).

Returns

string

---

adornments

Get Signature

get adornments(): ReadonlyMap<string, Adornment>

Defined in: parts/Part.ts:572

Get all adornments on this part.

Returns

ReadonlyMap<string, Adornment>

Inherited from

Part.adornments

---

adornmentType

Get Signature

get adornmentType(): AdornmentType

Defined in: parts/Adornment.ts:64

The type of this adornment.

Returns

AdornmentType

---

angle

Get Signature

get angle(): number

Defined in: parts/Part.ts:313

The rotation angle in degrees.

Returns

number

Set Signature

set angle(value): void

Defined in: parts/Part.ts:317

Parameters

value

number

Returns

void

Inherited from

Part.angle

---

background

Get Signature

get background(): string | null

Defined in: parts/Part.ts:185

GoJS-compatible: The background color of this part.

Returns

string | null

Set Signature

set background(value): void

Defined in: parts/Part.ts:189

Parameters

value

string | null

Returns

void

Inherited from

Part.background

---

bindings

Get Signature

get bindings(): readonly Binding[]

Defined in: parts/Part.ts:603

Get all bindings on this part.

Returns

readonly Binding[]

Inherited from

Part.bindings

---

bounds

Get Signature

get bounds(): Rect

Defined in: parts/Part.ts:135

Returns

Rect

Set Signature

set bounds(value): void

Defined in: parts/Part.ts:139

Parameters

value

Rect

Returns

void

Inherited from

Part.bounds

---

category

Get Signature

get category(): string

Defined in: parts/Part.ts:368

GoJS-compatible: The category of this part (used to select a template).

Returns

string

Set Signature

set category(value): void

Defined in: parts/Part.ts:372

Parameters

value

string

Returns

void

Inherited from

Part.category

---

center

Get Signature

get center(): object

Defined in: parts/Part.ts:663

Get the center point.

Returns

object

x

x: number

y

y: number

Inherited from

Part.center

---

childShapes

Get Signature

get childShapes(): readonly AdornmentShape[]

Defined in: parts/Adornment.ts:79

Get all child shapes in this adornment.

Returns

readonly AdornmentShape[]

---

containingGroup

Get Signature

get containingGroup(): Part | null

Defined in: parts/Part.ts:405

Get the containing group, or null if top-level.

Returns

Part | null

Set Signature

set containingGroup(value): void

Defined in: parts/Part.ts:410

Set the containing group.

Parameters

value

Group | null

Returns

void

Inherited from

Part.containingGroup

---

contextMenu

Get Signature

get contextMenu(): Panel | HTMLInfo | null

Defined in: parts/Part.ts:488

GoJS-compatible: a context menu shown on right-click — a Panel template drawn to canvas, or an HTMLInfo for full control over an HTML element.

Returns

Panel | HTMLInfo | null

Set Signature

set contextMenu(value): void

Defined in: parts/Part.ts:492

Parameters

value

Panel | HTMLInfo | null

Returns

void

Inherited from

Part.contextMenu

---

copyable

Get Signature

get copyable(): boolean

Defined in: parts/Part.ts:118

GoJS-compatible: Whether this part can be copied.

Returns

boolean

Set Signature

set copyable(value): void

Defined in: parts/Part.ts:122

Parameters

value

boolean

Returns

void

Inherited from

Part.copyable

---

cursor

Get Signature

get cursor(): string

Defined in: parts/Part.ts:203

GoJS-compatible: The cursor shown when hovering this part.

Returns

string

Set Signature

set cursor(value): void

Defined in: parts/Part.ts:207

Parameters

value

string

Returns

void

Inherited from

Part.cursor

---

data

Get Signature

get data(): NodeData | null

Defined in: parts/Part.ts:359

GoJS-compatible: Reference to the model data object for this part.

Returns

NodeData | null

Set Signature

set data(value): void

Defined in: parts/Part.ts:363

Parameters

value

NodeData | null

Returns

void

Inherited from

Part.data

---

deletable

Get Signature

get deletable(): boolean

Defined in: parts/Part.ts:96

GoJS-compatible: Whether this part can be deleted.

Returns

boolean

Set Signature

set deletable(value): void

Defined in: parts/Part.ts:100

Parameters

value

boolean

Returns

void

Inherited from

Part.deletable

---

desiredSize

Get Signature

get desiredSize(): Size | null

Defined in: parts/Part.ts:162

GoJS-compatible: The desired size of this part.

Returns

Size | null

Set Signature

set desiredSize(value): void

Defined in: parts/Part.ts:167

Parameters

value

Size | { height: number; width: number; } | null

Returns

void

Inherited from

Part.desiredSize

---

diagram

Get Signature

get diagram(): Diagram | null

Defined in: parts/Part.ts:443

GoJS-compatible: The diagram that this part is in (or null).

Returns

Diagram | null

Set Signature

set diagram(value): void

Defined in: parts/Part.ts:448

Set the diagram this part belongs to.

Parameters

value

Diagram | null

Returns

void

Inherited from

Part.diagram

---

dragAlpha

Get Signature

get dragAlpha(): number

Defined in: parts/Part.ts:377

GoJS-compatible: The opacity used when this part is being dragged.

Returns

number

Set Signature

set dragAlpha(value): void

Defined in: parts/Part.ts:381

Parameters

value

number

Returns

void

Inherited from

Part.dragAlpha

---

draggable

Get Signature

get draggable(): boolean

Defined in: parts/Part.ts:506

Whether this part can be dragged.

Returns

boolean

Set Signature

set draggable(value): void

Defined in: parts/Part.ts:510

Parameters

value

boolean

Returns

void

Inherited from

Part.draggable

---

elements

Get Signature

get elements(): readonly GraphObject[]

Defined in: parts/Part.ts:546

GoJS-compatible: Get the child elements in this part’s visual tree.

Returns

readonly GraphObject[]

Inherited from

Part.elements

---

fill

Get Signature

get fill(): string

Defined in: parts/Part.ts:280

Returns

string

Set Signature

set fill(value): void

Defined in: parts/Part.ts:284

Parameters

value

string

Returns

void

Inherited from

Part.fill

---

height

Get Signature

get height(): number

Defined in: parts/Part.ts:153

GoJS-compatible: The height of this part (delegates to its bounds).

Returns

number

Set Signature

set height(value): void

Defined in: parts/Part.ts:157

Parameters

value

number

Returns

void

Inherited from

Part.height

---

isHighlighted

Get Signature

get isHighlighted(): boolean

Defined in: parts/Part.ts:127

GoJS-compatible: Whether this part is currently highlighted.

Returns

boolean

Set Signature

set isHighlighted(value): void

Defined in: parts/Part.ts:131

Parameters

value

boolean

Returns

void

Inherited from

Part.isHighlighted

---

isInDocumentBounds

Get Signature

get isInDocumentBounds(): boolean

Defined in: parts/Part.ts:386

GoJS-compatible: Whether this part is within the document bounds.

Returns

boolean

Set Signature

set isInDocumentBounds(value): void

Defined in: parts/Part.ts:390

Parameters

value

boolean

Returns

void

Inherited from

Part.isInDocumentBounds

---

isMemberOfGroup

Get Signature

get isMemberOfGroup(): boolean

Defined in: parts/Part.ts:415

GoJS-compatible: Whether this part is a member of a group.

Returns

boolean

Inherited from

Part.isMemberOfGroup

---

isPositioned

Get Signature

get isPositioned(): boolean

Defined in: parts/Part.ts:420

GoJS-compatible: Whether this part has been given a position/bounds.

Returns

boolean

Inherited from

Part.isPositioned

---

isSelected

Get Signature

get isSelected(): boolean

Defined in: parts/Part.ts:264

Returns

boolean

Set Signature

set isSelected(value): void

Defined in: parts/Part.ts:268

Parameters

value

boolean

Returns

void

Inherited from

Part.isSelected

---

isTreeExpanded

Get Signature

get isTreeExpanded(): boolean

Defined in: parts/Part.ts:109

GoJS-compatible: Whether this part’s tree-children (per findTreeChildrenNodes) are shown. Distinct from Group.isSubGraphExpanded — this applies to any Part and is what TreeExpanderButton toggles via Diagram.collapseTree/expandTree.

Returns

boolean

Set Signature

set isTreeExpanded(value): void

Defined in: parts/Part.ts:113

Parameters

value

boolean

Returns

void

Inherited from

Part.isTreeExpanded

---

isVisible

Get Signature

get isVisible(): boolean

Defined in: parts/Adornment.ts:69

Whether this adornment is visible.

Returns

boolean

Set Signature

set isVisible(value): void

Defined in: parts/Adornment.ts:73

Parameters

value

boolean

Returns

void

---

isVisibleObject

Get Signature

get isVisibleObject(): boolean

Defined in: parts/Part.ts:239

GoJS-compatible: Whether this part and its ancestors are visible.

Returns

boolean

Inherited from

Part.isVisibleObject

---

key

Get Signature

get key(): NodeKey

Defined in: parts/Part.ts:72

Returns

NodeKey

Inherited from

Part.key

---

layer

Get Signature

get layer(): Layer | null

Defined in: parts/Part.ts:425

Get the layer this part belongs to.

Returns

Layer | null

Set Signature

set layer(value): void

Defined in: parts/Part.ts:430

Set the layer this part belongs to.

Parameters

value

Layer | null

Returns

void

Inherited from

Part.layer

---

layerName

Get Signature

get layerName(): string

Defined in: parts/Part.ts:395

GoJS-compatible: The name of the layer this part belongs to.

Returns

string

Set Signature

set layerName(_value): void

Defined in: parts/Part.ts:399

Parameters

_value

string

Returns

void

Inherited from

Part.layerName

---

location

Get Signature

get location(): Point

Defined in: parts/Part.ts:326

GoJS-compatible: The location point of this part — the point within the bounds at locationSpot. With the default locationSpot (0.5, 0.5) this is the center; changing locationSpot moves the part so the spot stays put.

Returns

Point

Set Signature

set location(value): void

Defined in: parts/Part.ts:334

Parameters

value

Point

Returns

void

Inherited from

Part.location

---

locationSpot

Get Signature

get locationSpot(): object

Defined in: parts/Part.ts:341

GoJS-compatible: The spot in the part that corresponds to the location point.

Returns

object

x

x: number

y

y: number

Set Signature

set locationSpot(value): void

Defined in: parts/Part.ts:345

Parameters

value

x

number

y

number

Returns

void

Inherited from

Part.locationSpot

---

maxSize

Get Signature

get maxSize(): object

Defined in: parts/Part.ts:221

GoJS-compatible: The maximum size of this part.

Returns

object

height

height: number

width

width: number

Set Signature

set maxSize(value): void

Defined in: parts/Part.ts:225

Parameters

value

height

number

width

number

Returns

void

Inherited from

Part.maxSize

---

minSize

Get Signature

get minSize(): object

Defined in: parts/Part.ts:212

GoJS-compatible: The minimum size of this part.

Returns

object

height

height: number

width

width: number

Set Signature

set minSize(value): void

Defined in: parts/Part.ts:216

Parameters

value

height

number

width

number

Returns

void

Inherited from

Part.minSize

---

name

Get Signature

get name(): string

Defined in: parts/Part.ts:87

GoJS-compatible: an arbitrary name for this part. Real GoJS has this because Part extends GraphObject, which has its own .name (used for findObject-style lookups); graphojs’s Part is a separate class, so it needs its own copy of the same property rather than inheriting it — most relevant for a bare decorative Part (see Diagram.add), which ported GoJS code may still identify by .name the way it would identify any other GraphObject.

Returns

string

Set Signature

set name(value): void

Defined in: parts/Part.ts:91

Parameters

value

string

Returns

void

Inherited from

Part.name

---

opacity

Get Signature

get opacity(): number

Defined in: parts/Part.ts:272

Returns

number

Set Signature

set opacity(value): void

Defined in: parts/Part.ts:276

Parameters

value

number

Returns

void

Inherited from

Part.opacity

---

panel

Get Signature

get panel(): Panel | null

Defined in: parts/Part.ts:533

GoJS-compatible: Get the panel used to render this part’s visual tree.

Returns

Panel | null

Set Signature

set panel(value): void

Defined in: parts/Part.ts:538

GoJS-compatible: Set the panel used to render this part’s visual tree.

Parameters

value

Panel | null

Returns

void

Inherited from

Part.panel

---

pickable

Get Signature

get pickable(): boolean

Defined in: parts/Part.ts:194

GoJS-compatible: Whether this part is pickable (hit-testable).

Returns

boolean

Set Signature

set pickable(value): void

Defined in: parts/Part.ts:198

Parameters

value

boolean

Returns

void

Inherited from

Part.pickable

---

position

Get Signature

get position(): object

Defined in: parts/Part.ts:668

Get the position (top-left).

Returns

object

x

x: number

y

y: number

Set Signature

set position(value): void

Defined in: parts/Part.ts:673

Set the position (top-left), preserving size.

Parameters

value

x

number

y

number

Returns

void

Inherited from

Part.position

---

resizable

Get Signature

get resizable(): boolean

Defined in: parts/Part.ts:515

Whether this part can be resized.

Returns

boolean

Set Signature

set resizable(value): void

Defined in: parts/Part.ts:519

Parameters

value

boolean

Returns

void

Inherited from

Part.resizable

---

rotatable

Get Signature

get rotatable(): boolean

Defined in: parts/Part.ts:524

Whether this part can be rotated.

Returns

boolean

Set Signature

set rotatable(value): void

Defined in: parts/Part.ts:528

Parameters

value

boolean

Returns

void

Inherited from

Part.rotatable

---

scale

Get Signature

get scale(): number

Defined in: parts/Part.ts:176

GoJS-compatible: The scale of this part.

Returns

number

Set Signature

set scale(value): void

Defined in: parts/Part.ts:180

Parameters

value

number

Returns

void

Inherited from

Part.scale

---

selectable

Get Signature

get selectable(): boolean

Defined in: parts/Part.ts:256

Returns

boolean

Set Signature

set selectable(value): void

Defined in: parts/Part.ts:260

Parameters

value

boolean

Returns

void

Inherited from

Part.selectable

---

selectionObject

Get Signature

get selectionObject(): GraphObject | null

Defined in: parts/Part.ts:350

GoJS-compatible: The GraphObject that is used as the selection object (for adornment placement).

Returns

GraphObject | null

Set Signature

set selectionObject(_value): void

Defined in: parts/Part.ts:354

Parameters

_value

GraphObject | null

Returns

void

Inherited from

Part.selectionObject

---

size

Get Signature

get size(): object

Defined in: parts/Part.ts:679

Get the size.

Returns

object

height

height: number

width

width: number

Inherited from

Part.size

---

stroke

Get Signature

get stroke(): string

Defined in: parts/Part.ts:288

Returns

string

Set Signature

set stroke(value): void

Defined in: parts/Part.ts:292

Parameters

value

string

Returns

void

Inherited from

Part.stroke

---

strokeWidth

Get Signature

get strokeWidth(): number

Defined in: parts/Part.ts:296

Returns

number

Set Signature

set strokeWidth(value): void

Defined in: parts/Part.ts:300

Parameters

value

number

Returns

void

Inherited from

Part.strokeWidth

---

tooltip

Get Signature

get tooltip(): string

Defined in: parts/Part.ts:463

The tooltip text shown when hovering over this part.

Returns

string

Set Signature

set tooltip(value): void

Defined in: parts/Part.ts:467

Parameters

value

string

Returns

void

Inherited from

Part.tooltip

---

toolTip

Get Signature

get toolTip(): Panel | HTMLInfo | null

Defined in: parts/Part.ts:475

GoJS-compatible: a tooltip shown on hover — a Panel template drawn to canvas, or an HTMLInfo for full control over an HTML element.

Returns

Panel | HTMLInfo | null

Set Signature

set toolTip(value): void

Defined in: parts/Part.ts:479

Parameters

value

Panel | HTMLInfo | null

Returns

void

Inherited from

Part.toolTip

---

tooltipVisible

Get Signature

get tooltipVisible(): boolean

Defined in: parts/Part.ts:497

Whether the tooltip is currently visible.

Returns

boolean

Set Signature

set tooltipVisible(value): void

Defined in: parts/Part.ts:501

Parameters

value

boolean

Returns

void

Inherited from

Part.tooltipVisible

---

visible

Get Signature

get visible(): boolean

Defined in: parts/Part.ts:248

Returns

boolean

Set Signature

set visible(value): void

Defined in: parts/Part.ts:252

Parameters

value

boolean

Returns

void

Inherited from

Part.visible

---

width

Get Signature

get width(): number

Defined in: parts/Part.ts:144

GoJS-compatible: The width of this part (delegates to its bounds).

Returns

number

Set Signature

set width(value): void

Defined in: parts/Part.ts:148

Parameters

value

number

Returns

void

Inherited from

Part.width

---

zOrder

Get Signature

get zOrder(): number

Defined in: parts/Part.ts:304

Returns

number

Set Signature

set zOrder(value): void

Defined in: parts/Part.ts:308

Parameters

value

number

Returns

void

Inherited from

Part.zOrder

Methods

addAdornment()

addAdornment(name, adornment): void

Defined in: parts/Part.ts:582

Add an adornment to this part.

Parameters

name

string

adornment

Adornment

Returns

void

Inherited from

Part.addAdornment

---

addBinding()

addBinding(binding): this

Defined in: parts/Part.ts:608

Add a binding to this part.

Parameters

binding

Binding

Returns

this

Inherited from

Part.addBinding

---

addShape()

addShape(shape): this

Defined in: parts/Adornment.ts:84

Add a child shape to this adornment.

Parameters

shape

AdornmentShape

Returns

this

---

addVisual()

addVisual(element): this

Defined in: parts/Part.ts:551

GoJS-compatible: Add a child element to this part’s visual tree.

Parameters

element

GraphObject

Returns

this

Inherited from

Part.addVisual

---

applyBindings()

applyBindings(nodeData): number

Defined in: parts/Part.ts:632

Apply all bindings from model data to this part. Returns the number of properties set.

Parameters

nodeData

NodeData

Returns

number

Inherited from

Part.applyBindings

---

applyTwoWayBindings()

applyTwoWayBindings(nodeData): number

Defined in: parts/Part.ts:647

Apply TwoWay bindings: write Part properties back to model data.

Parameters

nodeData

NodeData

Returns

number

Inherited from

Part.applyTwoWayBindings

---

clearAdornments()

clearAdornments(): void

Defined in: parts/Part.ts:598

Remove all adornments from this part.

Returns

void

Inherited from

Part.clearAdornments

---

clearBindings()

clearBindings(): void

Defined in: parts/Part.ts:622

Remove all bindings from this part.

Returns

void

Inherited from

Part.clearBindings

---

clearShapes()

clearShapes(): void

Defined in: parts/Adornment.ts:98

Remove all child shapes.

Returns

void

---

containsPoint()

containsPoint(point): boolean

Defined in: parts/Adornment.ts:123

Check if a point is inside any child shape.

Parameters

point

x

number

y

number

Returns

boolean

Overrides

Part.containsPoint

---

copy()

copy(): this

Defined in: parts/Part.ts:684

Create a deep copy of this part.

Returns

this

Inherited from

Part.copy

---

findAdornment()

findAdornment(name): Adornment | undefined

Defined in: parts/Part.ts:577

Get a specific adornment by name.

Parameters

name

string

Returns

Adornment | undefined

Inherited from

Part.findAdornment

---

findAdornmentNamed()

findAdornmentNamed(name): Adornment | null

Defined in: parts/Part.ts:588

GoJS-compatible: Find an adornment by name, or null if not present.

Parameters

name

string

Returns

Adornment | null

Inherited from

Part.findAdornmentNamed

---

findBinding()

findBinding(targetProperty): Binding | undefined

Defined in: parts/Part.ts:627

Find a binding targeting a specific property.

Parameters

targetProperty

string

Returns

Binding | undefined

Inherited from

Part.findBinding

---

findDiagram()

findDiagram(): Diagram | null

Defined in: parts/Part.ts:453

GoJS-compatible: Find the diagram that contains this part.

Returns

Diagram | null

Inherited from

Part.findDiagram

---

findLayer()

findLayer(): Layer | null

Defined in: parts/Part.ts:458

GoJS-compatible: Find the layer that contains this part.

Returns

Layer | null

Inherited from

Part.findLayer

---

findObject()

findObject(name): GraphObject | null

Defined in: parts/Part.ts:566

GoJS-compatible: Find a GraphObject by name in this part’s visual tree.

Parameters

name

string

Returns

GraphObject | null

Inherited from

Part.findObject

---

findShape()

findShape(name): AdornmentShape | undefined

Defined in: parts/Adornment.ts:103

Find a child shape by name.

Parameters

name

string

Returns

AdornmentShape | undefined

---

removeAdornment()

removeAdornment(name): boolean

Defined in: parts/Part.ts:593

Remove an adornment from this part.

Parameters

name

string

Returns

boolean

Inherited from

Part.removeAdornment

---

removeBinding()

removeBinding(binding): boolean

Defined in: parts/Part.ts:614

Remove a binding from this part.

Parameters

binding

Binding

Returns

boolean

Inherited from

Part.removeBinding

---

removeShape()

removeShape(shape): boolean

Defined in: parts/Adornment.ts:90

Remove a child shape from this adornment.

Parameters

shape

AdornmentShape

Returns

boolean

---

removeVisual()

removeVisual(element): boolean

Defined in: parts/Part.ts:560

GoJS-compatible: Remove a child element from this part’s visual tree.

Parameters

element

GraphObject

Returns

boolean

Inherited from

Part.removeVisual

---

updatePosition()

updatePosition(): void

Defined in: parts/Adornment.ts:113

Update the adornment’s position (and any child shapes created with a relative spot, e.g. resize/rotation handles) based on the adorned part’s current bounds. Call this whenever the adorned part moves, resizes, or rotates, to keep the adornment from going stale.

Returns

void