Node
Defined in: parts/Node.ts:16
A visual node in a diagram.
Extends
Sección titulada «Extends»Constructors
Sección titulada «Constructors»Constructor
Sección titulada «Constructor»new Node(
key?,bounds?):Node
Defined in: parts/Part.ts:67
Parameters
Sección titulada «Parameters»bounds?
Sección titulada «bounds?»Returns
Sección titulada «Returns»Node
Inherited from
Sección titulada «Inherited from»Accessors
Sección titulada «Accessors»actualBounds
Sección titulada «actualBounds»Get Signature
Sección titulada «Get Signature»get actualBounds():
Rect
Defined in: parts/Part.ts:230
GoJS-compatible: The actual bounds of this part in document coordinates.
Returns
Sección titulada «Returns»Set Signature
Sección titulada «Set Signature»set actualBounds(
value):void
Defined in: parts/Part.ts:234
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»adornments
Sección titulada «adornments»Get Signature
Sección titulada «Get Signature»get adornments():
ReadonlyMap<string,Adornment>
Defined in: parts/Part.ts:572
Get all adornments on this part.
Returns
Sección titulada «Returns»ReadonlyMap<string, Adornment>
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get angle():
number
Defined in: parts/Part.ts:313
The rotation angle in degrees.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set angle(
value):void
Defined in: parts/Part.ts:317
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»background
Sección titulada «background»Get Signature
Sección titulada «Get Signature»get background():
string|null
Defined in: parts/Part.ts:185
GoJS-compatible: The background color of this part.
Returns
Sección titulada «Returns»string | null
Set Signature
Sección titulada «Set Signature»set background(
value):void
Defined in: parts/Part.ts:189
Parameters
Sección titulada «Parameters»string | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»bindings
Sección titulada «bindings»Get Signature
Sección titulada «Get Signature»get bindings(): readonly
Binding[]
Defined in: parts/Part.ts:603
Get all bindings on this part.
Returns
Sección titulada «Returns»readonly Binding[]
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get bounds():
Rect
Defined in: parts/Part.ts:135
Returns
Sección titulada «Returns»Set Signature
Sección titulada «Set Signature»set bounds(
value):void
Defined in: parts/Part.ts:139
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»category
Sección titulada «category»Get Signature
Sección titulada «Get Signature»get category():
string
Defined in: parts/Part.ts:368
GoJS-compatible: The category of this part (used to select a template).
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set category(
value):void
Defined in: parts/Part.ts:372
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get center():
object
Defined in: parts/Part.ts:663
Get the center point.
Returns
Sección titulada «Returns»object
x:
number
y:
number
Inherited from
Sección titulada «Inherited from»containingGroup
Sección titulada «containingGroup»Get Signature
Sección titulada «Get Signature»get containingGroup():
Part|null
Defined in: parts/Part.ts:405
Get the containing group, or null if top-level.
Returns
Sección titulada «Returns»Part | null
Set Signature
Sección titulada «Set Signature»set containingGroup(
value):void
Defined in: parts/Part.ts:410
Set the containing group.
Parameters
Sección titulada «Parameters»Group | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»contextMenu
Sección titulada «contextMenu»Get Signature
Sección titulada «Get Signature»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
Sección titulada «Returns»Set Signature
Sección titulada «Set Signature»set contextMenu(
value):void
Defined in: parts/Part.ts:492
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»copyable
Sección titulada «copyable»Get Signature
Sección titulada «Get Signature»get copyable():
boolean
Defined in: parts/Part.ts:118
GoJS-compatible: Whether this part can be copied.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set copyable(
value):void
Defined in: parts/Part.ts:122
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»cornerRadius
Sección titulada «cornerRadius»Get Signature
Sección titulada «Get Signature»get cornerRadius():
number
Defined in: parts/Node.ts:61
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set cornerRadius(
value):void
Defined in: parts/Node.ts:65
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Get Signature
Sección titulada «Get Signature»get cursor():
string
Defined in: parts/Part.ts:203
GoJS-compatible: The cursor shown when hovering this part.
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set cursor(
value):void
Defined in: parts/Part.ts:207
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get data():
NodeData|null
Defined in: parts/Part.ts:359
GoJS-compatible: Reference to the model data object for this part.
Returns
Sección titulada «Returns»NodeData | null
Set Signature
Sección titulada «Set Signature»set data(
value):void
Defined in: parts/Part.ts:363
Parameters
Sección titulada «Parameters»NodeData | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»deletable
Sección titulada «deletable»Get Signature
Sección titulada «Get Signature»get deletable():
boolean
Defined in: parts/Part.ts:96
GoJS-compatible: Whether this part can be deleted.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set deletable(
value):void
Defined in: parts/Part.ts:100
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»desiredSize
Sección titulada «desiredSize»Get Signature
Sección titulada «Get Signature»get desiredSize():
Size|null
Defined in: parts/Part.ts:162
GoJS-compatible: The desired size of this part.
Returns
Sección titulada «Returns»Size | null
Set Signature
Sección titulada «Set Signature»set desiredSize(
value):void
Defined in: parts/Part.ts:167
Parameters
Sección titulada «Parameters»Size | { height: number; width: number; } | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»diagram
Sección titulada «diagram»Get Signature
Sección titulada «Get Signature»get diagram():
Diagram|null
Defined in: parts/Part.ts:443
GoJS-compatible: The diagram that this part is in (or null).
Returns
Sección titulada «Returns»Diagram | null
Set Signature
Sección titulada «Set Signature»set diagram(
value):void
Defined in: parts/Part.ts:448
Set the diagram this part belongs to.
Parameters
Sección titulada «Parameters»Diagram | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»dragAlpha
Sección titulada «dragAlpha»Get Signature
Sección titulada «Get Signature»get dragAlpha():
number
Defined in: parts/Part.ts:377
GoJS-compatible: The opacity used when this part is being dragged.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set dragAlpha(
value):void
Defined in: parts/Part.ts:381
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»draggable
Sección titulada «draggable»Get Signature
Sección titulada «Get Signature»get draggable():
boolean
Defined in: parts/Part.ts:506
Whether this part can be dragged.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set draggable(
value):void
Defined in: parts/Part.ts:510
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»elements
Sección titulada «elements»Get Signature
Sección titulada «Get Signature»get elements(): readonly
GraphObject[]
Defined in: parts/Node.ts:84
GoJS-compatible: Get the elements in this node’s visual tree.
Returns
Sección titulada «Returns»readonly GraphObject[]
Overrides
Sección titulada «Overrides»Get Signature
Sección titulada «Get Signature»get fill():
string
Defined in: parts/Part.ts:280
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set fill(
value):void
Defined in: parts/Part.ts:284
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»hasPanel
Sección titulada «hasPanel»Get Signature
Sección titulada «Get Signature»get hasPanel():
boolean
Defined in: parts/Node.ts:70
Check whether this node uses a panel for rendering.
Returns
Sección titulada «Returns»boolean
Get Signature
Sección titulada «Get Signature»get height():
number
Defined in: parts/Part.ts:153
GoJS-compatible: The height of this part (delegates to its bounds).
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set height(
value):void
Defined in: parts/Part.ts:157
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»isHighlighted
Sección titulada «isHighlighted»Get Signature
Sección titulada «Get Signature»get isHighlighted():
boolean
Defined in: parts/Part.ts:127
GoJS-compatible: Whether this part is currently highlighted.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set isHighlighted(
value):void
Defined in: parts/Part.ts:131
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»isInDocumentBounds
Sección titulada «isInDocumentBounds»Get Signature
Sección titulada «Get Signature»get isInDocumentBounds():
boolean
Defined in: parts/Part.ts:386
GoJS-compatible: Whether this part is within the document bounds.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set isInDocumentBounds(
value):void
Defined in: parts/Part.ts:390
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»isMemberOfGroup
Sección titulada «isMemberOfGroup»Get Signature
Sección titulada «Get Signature»get isMemberOfGroup():
boolean
Defined in: parts/Part.ts:415
GoJS-compatible: Whether this part is a member of a group.
Returns
Sección titulada «Returns»boolean
Inherited from
Sección titulada «Inherited from»isPositioned
Sección titulada «isPositioned»Get Signature
Sección titulada «Get Signature»get isPositioned():
boolean
Defined in: parts/Part.ts:420
GoJS-compatible: Whether this part has been given a position/bounds.
Returns
Sección titulada «Returns»boolean
Inherited from
Sección titulada «Inherited from»isSelected
Sección titulada «isSelected»Get Signature
Sección titulada «Get Signature»get isSelected():
boolean
Defined in: parts/Part.ts:264
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set isSelected(
value):void
Defined in: parts/Part.ts:268
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»isTreeExpanded
Sección titulada «isTreeExpanded»Get Signature
Sección titulada «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
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set isTreeExpanded(
value):void
Defined in: parts/Part.ts:113
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»isVisibleObject
Sección titulada «isVisibleObject»Get Signature
Sección titulada «Get Signature»get isVisibleObject():
boolean
Defined in: parts/Part.ts:239
GoJS-compatible: Whether this part and its ancestors are visible.
Returns
Sección titulada «Returns»boolean
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get key():
NodeKey
Defined in: parts/Part.ts:72
Returns
Sección titulada «Returns»Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get label():
string
Defined in: parts/Node.ts:37
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set label(
value):void
Defined in: parts/Node.ts:41
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
labelColor
Sección titulada «labelColor»Get Signature
Sección titulada «Get Signature»get labelColor():
string
Defined in: parts/Node.ts:45
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set labelColor(
value):void
Defined in: parts/Node.ts:49
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
labelFont
Sección titulada «labelFont»Get Signature
Sección titulada «Get Signature»get labelFont():
string
Defined in: parts/Node.ts:53
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set labelFont(
value):void
Defined in: parts/Node.ts:57
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
Get Signature
Sección titulada «Get Signature»get layer():
Layer|null
Defined in: parts/Part.ts:425
Get the layer this part belongs to.
Returns
Sección titulada «Returns»Layer | null
Set Signature
Sección titulada «Set Signature»set layer(
value):void
Defined in: parts/Part.ts:430
Set the layer this part belongs to.
Parameters
Sección titulada «Parameters»Layer | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»layerName
Sección titulada «layerName»Get Signature
Sección titulada «Get Signature»get layerName():
string
Defined in: parts/Part.ts:395
GoJS-compatible: The name of the layer this part belongs to.
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set layerName(
_value):void
Defined in: parts/Part.ts:399
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»location
Sección titulada «location»Get Signature
Sección titulada «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
Sección titulada «Returns»Set Signature
Sección titulada «Set Signature»set location(
value):void
Defined in: parts/Part.ts:334
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»locationSpot
Sección titulada «locationSpot»Get Signature
Sección titulada «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
Sección titulada «Returns»object
x:
number
y:
number
Set Signature
Sección titulada «Set Signature»set locationSpot(
value):void
Defined in: parts/Part.ts:345
Parameters
Sección titulada «Parameters»number
number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»maxSize
Sección titulada «maxSize»Get Signature
Sección titulada «Get Signature»get maxSize():
object
Defined in: parts/Part.ts:221
GoJS-compatible: The maximum size of this part.
Returns
Sección titulada «Returns»object
height:
number
width:
number
Set Signature
Sección titulada «Set Signature»set maxSize(
value):void
Defined in: parts/Part.ts:225
Parameters
Sección titulada «Parameters»number
number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»minSize
Sección titulada «minSize»Get Signature
Sección titulada «Get Signature»get minSize():
object
Defined in: parts/Part.ts:212
GoJS-compatible: The minimum size of this part.
Returns
Sección titulada «Returns»object
height:
number
width:
number
Set Signature
Sección titulada «Set Signature»set minSize(
value):void
Defined in: parts/Part.ts:216
Parameters
Sección titulada «Parameters»number
number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «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
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set name(
value):void
Defined in: parts/Part.ts:91
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»opacity
Sección titulada «opacity»Get Signature
Sección titulada «Get Signature»get opacity():
number
Defined in: parts/Part.ts:272
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set opacity(
value):void
Defined in: parts/Part.ts:276
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «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
Sección titulada «Returns»Panel | null
Set Signature
Sección titulada «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
Sección titulada «Parameters»Panel | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»pickable
Sección titulada «pickable»Get Signature
Sección titulada «Get Signature»get pickable():
boolean
Defined in: parts/Part.ts:194
GoJS-compatible: Whether this part is pickable (hit-testable).
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set pickable(
value):void
Defined in: parts/Part.ts:198
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»portCount
Sección titulada «portCount»Get Signature
Sección titulada «Get Signature»get portCount():
number
Defined in: parts/Node.ts:110
Get the number of ports.
Returns
Sección titulada «Returns»number
Get Signature
Sección titulada «Get Signature»get ports(): readonly
Port[]
Defined in: parts/Node.ts:105
Get all ports on this node.
Returns
Sección titulada «Returns»readonly Port[]
position
Sección titulada «position»Get Signature
Sección titulada «Get Signature»get position():
object
Defined in: parts/Part.ts:668
Get the position (top-left).
Returns
Sección titulada «Returns»object
x:
number
y:
number
Set Signature
Sección titulada «Set Signature»set position(
value):void
Defined in: parts/Part.ts:673
Set the position (top-left), preserving size.
Parameters
Sección titulada «Parameters»number
number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»resizable
Sección titulada «resizable»Get Signature
Sección titulada «Get Signature»get resizable():
boolean
Defined in: parts/Part.ts:515
Whether this part can be resized.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set resizable(
value):void
Defined in: parts/Part.ts:519
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»rotatable
Sección titulada «rotatable»Get Signature
Sección titulada «Get Signature»get rotatable():
boolean
Defined in: parts/Part.ts:524
Whether this part can be rotated.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set rotatable(
value):void
Defined in: parts/Part.ts:528
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get scale():
number
Defined in: parts/Part.ts:176
GoJS-compatible: The scale of this part.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set scale(
value):void
Defined in: parts/Part.ts:180
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»selectable
Sección titulada «selectable»Get Signature
Sección titulada «Get Signature»get selectable():
boolean
Defined in: parts/Part.ts:256
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set selectable(
value):void
Defined in: parts/Part.ts:260
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»selectionObject
Sección titulada «selectionObject»Get Signature
Sección titulada «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
Sección titulada «Returns»GraphObject | null
Set Signature
Sección titulada «Set Signature»set selectionObject(
_value):void
Defined in: parts/Part.ts:354
Parameters
Sección titulada «Parameters»GraphObject | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get shape():
NodeShape
Defined in: parts/Node.ts:29
Returns
Sección titulada «Returns»Set Signature
Sección titulada «Set Signature»set shape(
value):void
Defined in: parts/Node.ts:33
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Get Signature
Sección titulada «Get Signature»get size():
object
Defined in: parts/Part.ts:679
Get the size.
Returns
Sección titulada «Returns»object
height:
number
width:
number
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get stroke():
string
Defined in: parts/Part.ts:288
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set stroke(
value):void
Defined in: parts/Part.ts:292
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»strokeWidth
Sección titulada «strokeWidth»Get Signature
Sección titulada «Get Signature»get strokeWidth():
number
Defined in: parts/Part.ts:296
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set strokeWidth(
value):void
Defined in: parts/Part.ts:300
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»tooltip
Sección titulada «tooltip»Get Signature
Sección titulada «Get Signature»get tooltip():
string
Defined in: parts/Part.ts:463
The tooltip text shown when hovering over this part.
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set tooltip(
value):void
Defined in: parts/Part.ts:467
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»toolTip
Sección titulada «toolTip»Get Signature
Sección titulada «Get Signature»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
Sección titulada «Returns»Set Signature
Sección titulada «Set Signature»set toolTip(
value):void
Defined in: parts/Part.ts:479
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»tooltipVisible
Sección titulada «tooltipVisible»Get Signature
Sección titulada «Get Signature»get tooltipVisible():
boolean
Defined in: parts/Part.ts:497
Whether the tooltip is currently visible.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set tooltipVisible(
value):void
Defined in: parts/Part.ts:501
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»visible
Sección titulada «visible»Get Signature
Sección titulada «Get Signature»get visible():
boolean
Defined in: parts/Part.ts:248
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set visible(
value):void
Defined in: parts/Part.ts:252
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get width():
number
Defined in: parts/Part.ts:144
GoJS-compatible: The width of this part (delegates to its bounds).
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set width(
value):void
Defined in: parts/Part.ts:148
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get zOrder():
number
Defined in: parts/Part.ts:304
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set zOrder(
value):void
Defined in: parts/Part.ts:308
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»Methods
Sección titulada «Methods»add(
element):this
Defined in: parts/Node.ts:89
GoJS-compatible: Add a child element to this node’s visual tree.
Parameters
Sección titulada «Parameters»element
Sección titulada «element»Returns
Sección titulada «Returns»this
addAdornment()
Sección titulada «addAdornment()»addAdornment(
name,adornment):void
Defined in: parts/Part.ts:582
Add an adornment to this part.
Parameters
Sección titulada «Parameters»string
adornment
Sección titulada «adornment»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»addBinding()
Sección titulada «addBinding()»addBinding(
binding):this
Defined in: parts/Part.ts:608
Add a binding to this part.
Parameters
Sección titulada «Parameters»binding
Sección titulada «binding»Returns
Sección titulada «Returns»this
Inherited from
Sección titulada «Inherited from»addPort()
Sección titulada «addPort()»addPort(
port):this
Defined in: parts/Node.ts:131
Add a port to this node.
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»this
addVisual()
Sección titulada «addVisual()»addVisual(
element):this
Defined in: parts/Part.ts:551
GoJS-compatible: Add a child element to this part’s visual tree.
Parameters
Sección titulada «Parameters»element
Sección titulada «element»Returns
Sección titulada «Returns»this
Inherited from
Sección titulada «Inherited from»applyBindings()
Sección titulada «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
Sección titulada «Parameters»nodeData
Sección titulada «nodeData»Returns
Sección titulada «Returns»number
Inherited from
Sección titulada «Inherited from»applyTwoWayBindings()
Sección titulada «applyTwoWayBindings()»applyTwoWayBindings(
nodeData):number
Defined in: parts/Part.ts:647
Apply TwoWay bindings: write Part properties back to model data.
Parameters
Sección titulada «Parameters»nodeData
Sección titulada «nodeData»Returns
Sección titulada «Returns»number
Inherited from
Sección titulada «Inherited from»clearAdornments()
Sección titulada «clearAdornments()»clearAdornments():
void
Defined in: parts/Part.ts:598
Remove all adornments from this part.
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»clearBindings()
Sección titulada «clearBindings()»clearBindings():
void
Defined in: parts/Part.ts:622
Remove all bindings from this part.
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»clearPorts()
Sección titulada «clearPorts()»clearPorts():
void
Defined in: parts/Node.ts:145
Remove all ports.
Returns
Sección titulada «Returns»void
collectPortsFromPanel()
Sección titulada «collectPortsFromPanel()»collectPortsFromPanel():
void
Defined in: parts/Node.ts:159
GoJS-compatible: Collect ports declared declaratively in the visual tree
(GraphObjects with a non-empty portId), creating Port entries.
Uses the object’s relative position within the node bounds as the port spot.
Returns
Sección titulada «Returns»void
containsPoint()
Sección titulada «containsPoint()»containsPoint(
point):boolean
Defined in: parts/Part.ts:658
Check if a point is inside this part.
Parameters
Sección titulada «Parameters»number
number
Returns
Sección titulada «Returns»boolean
Inherited from
Sección titulada «Inherited from»copy():
this
Defined in: parts/Part.ts:684
Create a deep copy of this part.
Returns
Sección titulada «Returns»this
Inherited from
Sección titulada «Inherited from»findAdornment()
Sección titulada «findAdornment()»findAdornment(
name):Adornment|undefined
Defined in: parts/Part.ts:577
Get a specific adornment by name.
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»Adornment | undefined
Inherited from
Sección titulada «Inherited from»findAdornmentNamed()
Sección titulada «findAdornmentNamed()»findAdornmentNamed(
name):Adornment|null
Defined in: parts/Part.ts:588
GoJS-compatible: Find an adornment by name, or null if not present.
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»Adornment | null
Inherited from
Sección titulada «Inherited from»findBinding()
Sección titulada «findBinding()»findBinding(
targetProperty):Binding|undefined
Defined in: parts/Part.ts:627
Find a binding targeting a specific property.
Parameters
Sección titulada «Parameters»targetProperty
Sección titulada «targetProperty»string
Returns
Sección titulada «Returns»Binding | undefined
Inherited from
Sección titulada «Inherited from»findDiagram()
Sección titulada «findDiagram()»findDiagram():
Diagram|null
Defined in: parts/Part.ts:453
GoJS-compatible: Find the diagram that contains this part.
Returns
Sección titulada «Returns»Diagram | null
Inherited from
Sección titulada «Inherited from»findLayer()
Sección titulada «findLayer()»findLayer():
Layer|null
Defined in: parts/Part.ts:458
GoJS-compatible: Find the layer that contains this part.
Returns
Sección titulada «Returns»Layer | null
Inherited from
Sección titulada «Inherited from»findLinksConnected()
Sección titulada «findLinksConnected()»findLinksConnected():
Link[]
Defined in: parts/Node.ts:323
GoJS-compatible: All links connected to this node (in or out).
Returns
Sección titulada «Returns»Link[]
findLinksInto()
Sección titulada «findLinksInto()»findLinksInto():
Link[]
Defined in: parts/Node.ts:309
GoJS-compatible: All links that point into this node.
Returns
Sección titulada «Returns»Link[]
findLinksOutOf()
Sección titulada «findLinksOutOf()»findLinksOutOf():
Link[]
Defined in: parts/Node.ts:316
GoJS-compatible: All links that point out of this node.
Returns
Sección titulada «Returns»Link[]
findNodesConnected()
Sección titulada «findNodesConnected()»findNodesConnected():
Node[]
Defined in: parts/Node.ts:354
GoJS-compatible: All nodes connected to this node by a link.
Returns
Sección titulada «Returns»Node[]
findNodesInto()
Sección titulada «findNodesInto()»findNodesInto():
Node[]
Defined in: parts/Node.ts:330
GoJS-compatible: The source nodes of the links pointing into this node.
Returns
Sección titulada «Returns»Node[]
findNodesOutOf()
Sección titulada «findNodesOutOf()»findNodesOutOf():
Node[]
Defined in: parts/Node.ts:342
GoJS-compatible: The destination nodes of the links pointing out of this node.
Returns
Sección titulada «Returns»Node[]
findObject()
Sección titulada «findObject()»findObject(
name):GraphObject|null
Defined in: parts/Node.ts:78
GoJS-compatible: Find a GraphObject by name in this node’s visual tree. Searches the panel’s elements recursively.
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»GraphObject | null
Overrides
Sección titulada «Overrides»findPort()
Sección titulada «findPort()»findPort(
name):Port|undefined
Defined in: parts/Node.ts:150
Find a port by name.
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»Port | undefined
findTreeChildrenNodes()
Sección titulada «findTreeChildrenNodes()»findTreeChildrenNodes():
Node[]
Defined in: parts/Node.ts:381
GoJS-compatible: The child nodes in the tree structure.
Returns
Sección titulada «Returns»Node[]
findTreeParentNode()
Sección titulada «findTreeParentNode()»findTreeParentNode():
Node|null
Defined in: parts/Node.ts:374
GoJS-compatible: The parent node in the tree structure (or null).
Returns
Sección titulada «Returns»Node | null
getConnectionPoint()
Sección titulada «getConnectionPoint()»getConnectionPoint(
target,portName?):object
Defined in: parts/Node.ts:238
Get the point where a link from this node should connect, given a target direction. Uses the port if specified, otherwise computes the edge point toward the target.
Parameters
Sección titulada «Parameters»number
number
portName?
Sección titulada «portName?»string
Returns
Sección titulada «Returns»object
x:
number
y:
number
getPortPoint()
Sección titulada «getPortPoint()»getPortPoint(
name?):object
Defined in: parts/Node.ts:218
Compute the point of a port in diagram coordinates. If no port name is given, returns the node center.
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»object
x:
number
y:
number
isPointOnPort()
Sección titulada «isPointOnPort()»isPointOnPort(
point,threshold?):boolean
Defined in: parts/Node.ts:115
Whether a diagram point is near any of this node’s ports (within a threshold).
Parameters
Sección titulada «Parameters»number
number
threshold?
Sección titulada «threshold?»number = 10
Returns
Sección titulada «Returns»boolean
isTreeLeaf()
Sección titulada «isTreeLeaf()»isTreeLeaf():
boolean
Defined in: parts/Node.ts:369
GoJS-compatible: Whether this node is a tree leaf (no tree children).
Returns
Sección titulada «Returns»boolean
remove()
Sección titulada «remove()»remove(
element):boolean
Defined in: parts/Node.ts:99
GoJS-compatible: Remove a child element from this node’s visual tree.
Parameters
Sección titulada «Parameters»element
Sección titulada «element»Returns
Sección titulada «Returns»boolean
removeAdornment()
Sección titulada «removeAdornment()»removeAdornment(
name):boolean
Defined in: parts/Part.ts:593
Remove an adornment from this part.
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»boolean
Inherited from
Sección titulada «Inherited from»removeBinding()
Sección titulada «removeBinding()»removeBinding(
binding):boolean
Defined in: parts/Part.ts:614
Remove a binding from this part.
Parameters
Sección titulada «Parameters»binding
Sección titulada «binding»Returns
Sección titulada «Returns»boolean
Inherited from
Sección titulada «Inherited from»removePort()
Sección titulada «removePort()»removePort(
port):boolean
Defined in: parts/Node.ts:137
Remove a port by reference.
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»boolean
removeVisual()
Sección titulada «removeVisual()»removeVisual(
element):boolean
Defined in: parts/Part.ts:560
GoJS-compatible: Remove a child element from this part’s visual tree.
Parameters
Sección titulada «Parameters»element
Sección titulada «element»Returns
Sección titulada «Returns»boolean
Inherited from
Sección titulada «Inherited from»shapeContainsPoint()
Sección titulada «shapeContainsPoint()»shapeContainsPoint(
point):boolean
Defined in: parts/Node.ts:280
Shape-aware hit testing: check whether a point is inside the node’s actual shape geometry, not just its bounding box. Falls back to the bounding box for rect/roundedRect and when the point is clearly outside.
Parameters
Sección titulada «Parameters»number
number
Returns
Sección titulada «Returns»boolean
updatePortSpots()
Sección titulada «updatePortSpots()»updatePortSpots():
void
Defined in: parts/Node.ts:191
Recompute the fractional spot for each existing port from the current element positions (layout happens during draw). Called after rendering so declarative ports resolve to their real edge positions.
Returns
Sección titulada «Returns»void
fromPosAndSize()
Sección titulada «fromPosAndSize()»
staticfromPosAndSize(key,x,y,width,height):Node
Defined in: parts/Node.ts:25
Create a Node from position and size.
Parameters
Sección titulada «Parameters»number
number
number
number
Returns
Sección titulada «Returns»Node