Panel
Defined in: panel/Panel.ts:25
A Panel is a GraphObject that contains and lays out other GraphObjects.
Extends
Sección titulada «Extends»Constructors
Sección titulada «Constructors»Constructor
Sección titulada «Constructor»new Panel(
type?):Panel
Defined in: panel/Panel.ts:72
Parameters
Sección titulada «Parameters»PanelType = 'Auto'
Returns
Sección titulada «Returns»Panel
Overrides
Sección titulada «Overrides»Properties
Sección titulada «Properties»actionCancel?
Sección titulada «actionCancel?»
optionalactionCancel?: (e,obj) =>void
Defined in: panel/GraphObject.ts:86
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»actionDown?
Sección titulada «actionDown?»
optionalactionDown?: (e,obj) =>void
Defined in: panel/GraphObject.ts:83
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»actionMove?
Sección titulada «actionMove?»
optionalactionMove?: (e,obj) =>void
Defined in: panel/GraphObject.ts:84
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»actionUp?
Sección titulada «actionUp?»
optionalactionUp?: (e,obj) =>void
Defined in: panel/GraphObject.ts:85
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»
optionalclick?: (e,obj) =>void
Defined in: panel/GraphObject.ts:68
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»columnDefinitions
Sección titulada «columnDefinitions»columnDefinitions:
object[] =[]
Defined in: panel/Panel.ts:56
GoJS-compatible: Explicit column widths for Table panels.
separatorStrokeWidth?
Sección titulada «separatorStrokeWidth?»
optionalseparatorStrokeWidth?:number
optionalwidth?:number
contextClick?
Sección titulada «contextClick?»
optionalcontextClick?: (e,obj) =>void
Defined in: panel/GraphObject.ts:70
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»data:
NodeData|null=null
Defined in: panel/Panel.ts:70
The data object most recently applied to this panel (for ofObject(“parent”)).
doubleClick?
Sección titulada «doubleClick?»
optionaldoubleClick?: (e,obj) =>void
Defined in: panel/GraphObject.ts:69
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»gridCellSize
Sección titulada «gridCellSize»gridCellSize:
Size|null=null
Defined in: panel/Panel.ts:46
GoJS-compatible: the tile size for a 'Grid'-type panel — how often
its children repeat, whether used standalone (nested in a template,
needs an explicit width/height to know how large an area to tile)
or as diagram.grid (read by Diagram.getGridPatternStyle instead of
tiled directly). Defaults to 10x10 when unset.
isActionable
Sección titulada «isActionable»isActionable:
boolean=false
Defined in: panel/GraphObject.ts:82
GoJS-compatible: when true, ActionTool dispatches
actionDown/actionMove/actionUp/actionCancel on this object for
mouse-down-move-up gestures starting on it — for building controls
(buttons, sliders) that handle their own gesture without a new Tool.
Inherited from
Sección titulada «Inherited from»mouseEnter?
Sección titulada «mouseEnter?»
optionalmouseEnter?: (e,obj,prev) =>void
Defined in: panel/GraphObject.ts:71
Parameters
Sección titulada «Parameters»GraphObject | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»mouseLeave?
Sección titulada «mouseLeave?»
optionalmouseLeave?: (e,obj,prev) =>void
Defined in: panel/GraphObject.ts:72
Parameters
Sección titulada «Parameters»GraphObject | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»mouseOut?
Sección titulada «mouseOut?»
optionalmouseOut?: (e,obj) =>void
Defined in: panel/GraphObject.ts:74
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»mouseOver?
Sección titulada «mouseOver?»
optionalmouseOver?: (e,obj) =>void
Defined in: panel/GraphObject.ts:73
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»parentPanel
Sección titulada «parentPanel»parentPanel:
GraphObject|null=null
Defined in: panel/GraphObject.ts:89
The panel this object belongs to (set when added). Used for ofObject resolution.
Inherited from
Sección titulada «Inherited from»portId:
string=''
Defined in: panel/GraphObject.ts:92
GoJS-compatible: If non-empty, this object acts as a port on its part.
Inherited from
Sección titulada «Inherited from»rowDefinitions
Sección titulada «rowDefinitions»rowDefinitions:
object[] =[]
Defined in: panel/Panel.ts:54
GoJS-compatible: Explicit row heights for Table panels (in the panel’s coordinate space).
height?
Sección titulada «height?»
optionalheight?:number
separatorStrokeWidth?
Sección titulada «separatorStrokeWidth?»
optionalseparatorStrokeWidth?:number
templateProperties
Sección titulada «templateProperties»templateProperties:
Record<string,unknown> ={}
Defined in: panel/Panel.ts:67
Extra properties to apply to the created part when this panel is used as a node/link/group template (e.g. link routing, corner, arrowhead).
readonlystaticAuto:"Auto"='Auto'
Defined in: panel/Panel.ts:27
readonlystaticGrid:"Grid"='Grid'
Defined in: panel/Panel.ts:34
Horizontal
Sección titulada «Horizontal»
readonlystaticHorizontal:"Horizontal"='Horizontal'
Defined in: panel/Panel.ts:29
Position
Sección titulada «Position»
readonlystaticPosition:"Position"='Position'
Defined in: panel/Panel.ts:33
readonlystaticSpot:"Spot"='Spot'
Defined in: panel/Panel.ts:30
readonlystaticTable:"Table"='Table'
Defined in: panel/Panel.ts:31
Vertical
Sección titulada «Vertical»
readonlystaticVertical:"Vertical"='Vertical'
Defined in: panel/Panel.ts:28
Viewbox
Sección titulada «Viewbox»
readonlystaticViewbox:"Viewbox"='Viewbox'
Defined in: panel/Panel.ts:32
Accessors
Sección titulada «Accessors»actualSize
Sección titulada «actualSize»Get Signature
Sección titulada «Get Signature»get actualSize():
Size
Defined in: panel/GraphObject.ts:481
The actual size computed during layout.
Returns
Sección titulada «Returns»Inherited from
Sección titulada «Inherited from»alignment
Sección titulada «alignment»Get Signature
Sección titulada «Get Signature»get alignment():
Spot|null
Defined in: panel/GraphObject.ts:491
The alignment spot for Spot panels.
Returns
Sección titulada «Returns»Spot | null
Set Signature
Sección titulada «Set Signature»set alignment(
value):void
Defined in: panel/GraphObject.ts:495
Parameters
Sección titulada «Parameters»Spot | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»alignmentFocus
Sección titulada «alignmentFocus»Get Signature
Sección titulada «Get Signature»get alignmentFocus():
Spot|null
Defined in: panel/GraphObject.ts:553
GoJS-compatible: The spot within this object used for alignment/placement.
Returns
Sección titulada «Returns»Spot | null
Set Signature
Sección titulada «Set Signature»set alignmentFocus(
value):void
Defined in: panel/GraphObject.ts:557
Parameters
Sección titulada «Parameters»Spot | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get angle():
number
Defined in: panel/GraphObject.ts:414
The rotation angle in degrees.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set angle(
value):void
Defined in: panel/GraphObject.ts:418
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: panel/Panel.ts:171
The background color of this panel.
Returns
Sección titulada «Returns»string | null
Set Signature
Sección titulada «Set Signature»set background(
value):void
Defined in: panel/Panel.ts:175
Parameters
Sección titulada «Parameters»string | null
Returns
Sección titulada «Returns»void
bindings
Sección titulada «bindings»Get Signature
Sección titulada «Get Signature»get bindings(): readonly
Binding[]
Defined in: panel/GraphObject.ts:104
GoJS-compatible: The bindings attached to this graph object.
Returns
Sección titulada «Returns»readonly Binding[]
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get column():
number
Defined in: panel/GraphObject.ts:524
GoJS-compatible: The column index for table panels.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set column(
value):void
Defined in: panel/GraphObject.ts:528
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»columnCount
Sección titulada «columnCount»Get Signature
Sección titulada «Get Signature»get columnCount():
number
Defined in: panel/Panel.ts:194
The number of columns (for Table panels).
Returns
Sección titulada «Returns»number
columnSpan
Sección titulada «columnSpan»Get Signature
Sección titulada «Get Signature»get columnSpan():
number
Defined in: panel/GraphObject.ts:542
GoJS-compatible: The number of columns this object spans.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set columnSpan(
value):void
Defined in: panel/GraphObject.ts:546
Parameters
Sección titulada «Parameters»number
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: panel/GraphObject.ts:635
GoJS-compatible: Whether this object is included when copying its part.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set copyable(
value):void
Defined in: panel/GraphObject.ts:639
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 cursor():
string
Defined in: panel/GraphObject.ts:423
GoJS-compatible: The cursor displayed when hovering over this object.
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set cursor(
value):void
Defined in: panel/GraphObject.ts:427
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»defaultAlignment
Sección titulada «defaultAlignment»Get Signature
Sección titulada «Get Signature»get defaultAlignment(): {
x:number;y:number; } |null
Defined in: panel/Panel.ts:234
GoJS-compatible: The default alignment for elements in Spot panels.
Returns
Sección titulada «Returns»{ x: number; y: number; } | null
Set Signature
Sección titulada «Set Signature»set defaultAlignment(
value):void
Defined in: panel/Panel.ts:238
Parameters
Sección titulada «Parameters»{ x: number; y: number; } | null
Returns
Sección titulada «Returns»void
desiredSize
Sección titulada «desiredSize»Get Signature
Sección titulada «Get Signature»get desiredSize():
Size|null
Defined in: panel/GraphObject.ts:432
The desired size. If null, natural size is used.
Returns
Sección titulada «Returns»Size | null
Set Signature
Sección titulada «Set Signature»set desiredSize(
value):void
Defined in: panel/GraphObject.ts:436
Parameters
Sección titulada «Parameters»Size | null
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»elementCount
Sección titulada «elementCount»Get Signature
Sección titulada «Get Signature»get elementCount():
number
Defined in: panel/Panel.ts:148
The number of elements in this panel.
Returns
Sección titulada «Returns»number
elements
Sección titulada «elements»Get Signature
Sección titulada «Get Signature»get elements(): readonly
GraphObject[]
Defined in: panel/Panel.ts:143
The elements contained in this panel.
Returns
Sección titulada «Returns»readonly GraphObject[]
gradient
Sección titulada «gradient»Get Signature
Sección titulada «Get Signature»get gradient():
CanvasGradient|null
Defined in: panel/Panel.ts:180
A canvas gradient used as the background.
Returns
Sección titulada «Returns»CanvasGradient | null
Set Signature
Sección titulada «Set Signature»set gradient(
value):void
Defined in: panel/Panel.ts:184
Parameters
Sección titulada «Parameters»CanvasGradient | null
Returns
Sección titulada «Returns»void
Get Signature
Sección titulada «Get Signature»get height():
number
Defined in: panel/GraphObject.ts:462
GoJS-compatible: the last explicitly-set desired height, or NaN if never set.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set height(
value):void
Defined in: panel/GraphObject.ts:466
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»isShadowed
Sección titulada «isShadowed»Get Signature
Sección titulada «Get Signature»get isShadowed():
boolean
Defined in: panel/GraphObject.ts:578
GoJS-compatible: Whether this object casts a drop shadow.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set isShadowed(
value):void
Defined in: panel/GraphObject.ts:582
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: panel/GraphObject.ts:379
GoJS-compatible: Whether this object and all of its ancestors are visible.
Returns
Sección titulada «Returns»boolean
Inherited from
Sección titulada «Inherited from»itemArray
Sección titulada «itemArray»Get Signature
Sección titulada «Get Signature»get itemArray(): readonly
unknown[]
Defined in: panel/Panel.ts:78
GoJS-compatible: The data array used to generate item elements.
Returns
Sección titulada «Returns»readonly unknown[]
Set Signature
Sección titulada «Set Signature»set itemArray(
value):void
Defined in: panel/Panel.ts:82
Parameters
Sección titulada «Parameters»unknown[]
Returns
Sección titulada «Returns»void
itemTemplate
Sección titulada «itemTemplate»Get Signature
Sección titulada «Get Signature»get itemTemplate():
GraphObject|null
Defined in: panel/Panel.ts:88
GoJS-compatible: The template used to create one element per item.
Returns
Sección titulada «Returns»GraphObject | null
Set Signature
Sección titulada «Set Signature»set itemTemplate(
value):void
Defined in: panel/Panel.ts:92
Parameters
Sección titulada «Parameters»GraphObject | null
Returns
Sección titulada «Returns»void
mainElement
Sección titulada «mainElement»Get Signature
Sección titulada «Get Signature»get mainElement():
GraphObject|null
Defined in: panel/Panel.ts:315
Get the first element of this panel (used by Auto panels as background).
Returns
Sección titulada «Returns»GraphObject | null
Get Signature
Sección titulada «Get Signature»get margin():
Margin|null
Defined in: panel/GraphObject.ts:500
The margin around this object.
Returns
Sección titulada «Returns»Margin | null
Set Signature
Sección titulada «Set Signature»set margin(
value):void
Defined in: panel/GraphObject.ts:505
GoJS-compatible: a plain number sets a uniform margin on all four sides.
Parameters
Sección titulada «Parameters»number | Margin | null
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: panel/GraphObject.ts:95
The name of this graph object, used for findObject() lookups.
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set name(
value):void
Defined in: panel/GraphObject.ts:99
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: panel/GraphObject.ts:405
The opacity of this object (0-1).
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set opacity(
value):void
Defined in: panel/GraphObject.ts:409
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»padding
Sección titulada «padding»Get Signature
Sección titulada «Get Signature»get padding():
Margin|null
Defined in: panel/Panel.ts:153
The padding of this panel.
Returns
Sección titulada «Returns»Margin | null
Set Signature
Sección titulada «Set Signature»set padding(
value):void
Defined in: panel/Panel.ts:157
Parameters
Sección titulada «Parameters»Margin | null
Returns
Sección titulada «Returns»void
Get Signature
Sección titulada «Get Signature»get parent():
GraphObject|null
Defined in: panel/GraphObject.ts:389
GoJS-compatible: The parent panel of this object (or null).
Returns
Sección titulada «Returns»GraphObject | null
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get part():
Part|null
Defined in: panel/GraphObject.ts:394
GoJS-compatible: The Part that contains this object (or null).
Returns
Sección titulada «Returns»Part | null
Inherited from
Sección titulada «Inherited from»pickable
Sección titulada «pickable»Get Signature
Sección titulada «Get Signature»get pickable():
boolean
Defined in: panel/GraphObject.ts:626
GoJS-compatible: Whether this object can be hit-tested.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set pickable(
value):void
Defined in: panel/GraphObject.ts:630
Parameters
Sección titulada «Parameters»boolean
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»position
Sección titulada «position»Get Signature
Sección titulada «Get Signature»get position():
object
Defined in: panel/GraphObject.ts:471
The position within the parent panel.
Returns
Sección titulada «Returns»object
x:
number
y:
number
Inherited from
Sección titulada «Inherited from»Get Signature
Sección titulada «Get Signature»get row():
number
Defined in: panel/GraphObject.ts:515
GoJS-compatible: The row index for table panels.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set row(
value):void
Defined in: panel/GraphObject.ts:519
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»rowCount
Sección titulada «rowCount»Get Signature
Sección titulada «Get Signature»get rowCount():
number
Defined in: panel/Panel.ts:189
The number of rows (for Table panels).
Returns
Sección titulada «Returns»number
rowSpan
Sección titulada «rowSpan»Get Signature
Sección titulada «Get Signature»get rowSpan():
number
Defined in: panel/GraphObject.ts:533
GoJS-compatible: The number of rows this object spans.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set rowSpan(
value):void
Defined in: panel/GraphObject.ts:537
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 scale():
number
Defined in: panel/GraphObject.ts:564
GoJS-compatible: The scale of this object relative to its normal size.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set scale(
value):void
Defined in: panel/GraphObject.ts:568
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»separators
Sección titulada «separators»Get Signature
Sección titulada «Get Signature»get separators(): readonly
GraphObject[]
Defined in: panel/Panel.ts:227
GoJS-compatible: The separators added to this panel.
Returns
Sección titulada «Returns»readonly GraphObject[]
Get Signature
Sección titulada «Get Signature»get shadow():
string
Defined in: panel/GraphObject.ts:614
GoJS-compatible: Alias for shadowColor.
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set shadow(
value):void
Defined in: panel/GraphObject.ts:618
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»shadowBlur
Sección titulada «shadowBlur»Get Signature
Sección titulada «Get Signature»get shadowBlur():
number
Defined in: panel/GraphObject.ts:605
GoJS-compatible: The drop shadow blur radius.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set shadowBlur(
value):void
Defined in: panel/GraphObject.ts:609
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»shadowColor
Sección titulada «shadowColor»Get Signature
Sección titulada «Get Signature»get shadowColor():
string
Defined in: panel/GraphObject.ts:587
GoJS-compatible: The drop shadow color.
Returns
Sección titulada «Returns»string
Set Signature
Sección titulada «Set Signature»set shadowColor(
value):void
Defined in: panel/GraphObject.ts:591
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»shadowOffset
Sección titulada «shadowOffset»Get Signature
Sección titulada «Get Signature»get shadowOffset():
object
Defined in: panel/GraphObject.ts:596
GoJS-compatible: The drop shadow offset.
Returns
Sección titulada «Returns»object
x:
number
y:
number
Set Signature
Sección titulada «Set Signature»set shadowOffset(
value):void
Defined in: panel/GraphObject.ts:600
Parameters
Sección titulada «Parameters»number
number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»spacing
Sección titulada «spacing»Get Signature
Sección titulada «Get Signature»get spacing():
number
Defined in: panel/Panel.ts:162
The spacing between elements (for Vertical/Horizontal panels).
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set spacing(
value):void
Defined in: panel/Panel.ts:166
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»void
Get Signature
Sección titulada «Get Signature»get type():
PanelType
Defined in: panel/Panel.ts:134
Returns
Sección titulada «Returns»Set Signature
Sección titulada «Set Signature»set type(
value):void
Defined in: panel/Panel.ts:138
Parameters
Sección titulada «Parameters»Returns
Sección titulada «Returns»void
visible
Sección titulada «visible»Get Signature
Sección titulada «Get Signature»get visible():
boolean
Defined in: panel/GraphObject.ts:370
Whether this object is visible.
Returns
Sección titulada «Returns»boolean
Set Signature
Sección titulada «Set Signature»set visible(
value):void
Defined in: panel/GraphObject.ts:374
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: panel/GraphObject.ts:453
GoJS-compatible: the last explicitly-set desired width, or NaN if
never set — NOT the object’s current rendered size. Falling back to
_actualSize here (as this used to) makes every measure() override
(Shape/TextBlock/Picture/Panel, which all gate their real
measurement behind !Number.isNaN(this.width)) permanently “lock onto”
whatever size an earlier — possibly premature, e.g. before a data
binding applied the real text — layout pass happened to produce, since
that stale actualSize then reads back as “an explicit width was set” on
every later pass and skips remeasuring for good. Those callers must
check for NaN specifically, not > 0 — a Binding that legitimately
resolves to 0 (e.g. a 0%-progress bar) is still an explicit width.
Returns
Sección titulada «Returns»number
Set Signature
Sección titulada «Set Signature»set width(
value):void
Defined in: panel/GraphObject.ts:457
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: panel/Panel.ts:199
Add an element to this panel.
Parameters
Sección titulada «Parameters»element
Sección titulada «element»Returns
Sección titulada «Returns»this
addBinding()
Sección titulada «addBinding()»addBinding(
binding):this
Defined in: panel/GraphObject.ts:119
Add a binding to this graph object (keeps existing bindings).
Parameters
Sección titulada «Parameters»binding
Sección titulada «binding»Returns
Sección titulada «Returns»this
Inherited from
Sección titulada «Inherited from»addSeparator()
Sección titulada «addSeparator()»addSeparator(
separator?):GraphObject
Defined in: panel/Panel.ts:209
GoJS-compatible: Add a visual separator element to this panel.
Parameters
Sección titulada «Parameters»separator?
Sección titulada «separator?»Returns
Sección titulada «Returns»append()
Sección titulada «append()»append(
element):this
Defined in: panel/Panel.ts:272
Fluent add of an element.
Parameters
Sección titulada «Parameters»element
Sección titulada «element»Returns
Sección titulada «Returns»this
applyBindings()
Sección titulada «applyBindings()»applyBindings(
nodeData):number
Defined in: panel/Panel.ts:933
Apply bindings to this panel and recursively to all child elements.
Parameters
Sección titulada «Parameters»nodeData
Sección titulada «nodeData»Returns
Sección titulada «Returns»number
Overrides
Sección titulada «Overrides»clear()
Sección titulada «clear()»clear():
void
Defined in: panel/Panel.ts:260
Remove all elements.
Returns
Sección titulada «Returns»void
clone()
Sección titulada «clone()»clone():
this
Defined in: panel/Panel.ts:896
Deep copy of this panel, including all child elements.
Returns
Sección titulada «Returns»this
Overrides
Sección titulada «Overrides»contains()
Sección titulada «contains()»contains(
element):boolean
Defined in: panel/Panel.ts:267
Check if an element is in this panel.
Parameters
Sección titulada «Parameters»element
Sección titulada «element»Returns
Sección titulada «Returns»boolean
containsPoint()
Sección titulada «containsPoint()»containsPoint(
px,py):boolean
Defined in: panel/GraphObject.ts:675
Check if a point is inside this object’s area (for hit testing).
Parameters
Sección titulada «Parameters»number
number
Returns
Sección titulada «Returns»boolean
Inherited from
Sección titulada «Inherited from»draw(
ctx,x,y,width,height):void
Defined in: panel/Panel.ts:442
Draw this object at its computed position and size.
Parameters
Sección titulada «Parameters»CanvasRenderingContext2D
number
number
number
number
Returns
Sección titulada «Returns»void
Overrides
Sección titulada «Overrides»findElement()
Sección titulada «findElement()»findElement(
name):GraphObject|null
Defined in: panel/Panel.ts:869
GoJS-compatible: Find a GraphObject by name, searching this panel and nested panels.
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»GraphObject | null
findObject()
Sección titulada «findObject()»findObject(
name):GraphObject|null
Defined in: panel/Panel.ts:881
GoJS-compatible alias: real GoJS names this method findObject.
Parameters
Sección titulada «Parameters»string
Returns
Sección titulada «Returns»GraphObject | null
getBounds()
Sección titulada «getBounds()»getBounds():
Rect
Defined in: panel/Panel.ts:886
The bounds of this panel within the parent coordinate space.
Returns
Sección titulada «Returns»Overrides
Sección titulada «Overrides»hitTest()
Sección titulada «hitTest()»hitTest(
px,py):GraphObject|null
Defined in: panel/Panel.ts:851
Find the top-most GraphObject at a point, or null.
Parameters
Sección titulada «Parameters»number
number
Returns
Sección titulada «Returns»GraphObject | null
insertAt()
Sección titulada «insertAt()»insertAt(
index,element):this
Defined in: panel/Panel.ts:243
GoJS-compatible: Insert an element at a specific index.
Parameters
Sección titulada «Parameters»number
element
Sección titulada «element»Returns
Sección titulada «Returns»this
measure()
Sección titulada «measure()»measure():
Size
Defined in: panel/Panel.ts:319
Measure the natural size of this object. Returns the size this object would like to occupy.
Returns
Sección titulada «Returns»Overrides
Sección titulada «Overrides»measureWithMargin()
Sección titulada «measureWithMargin()»measureWithMargin():
Size
Defined in: panel/GraphObject.ts:663
Compute the effective size after applying margin.
Returns
Sección titulada «Returns»Inherited from
Sección titulada «Inherited from»remove()
Sección titulada «remove()»remove(
element):boolean
Defined in: panel/Panel.ts:251
Remove an element from this panel.
Parameters
Sección titulada «Parameters»element
Sección titulada «element»Returns
Sección titulada «Returns»boolean
removeBinding()
Sección titulada «removeBinding()»removeBinding(
targetProperty):boolean
Defined in: panel/GraphObject.ts:125
Remove a binding by target property. Returns true if removed.
Parameters
Sección titulada «Parameters»targetProperty
Sección titulada «targetProperty»string
Returns
Sección titulada «Returns»boolean
Inherited from
Sección titulada «Inherited from»setActualSize()
Sección titulada «setActualSize()»setActualSize(
width,height):void
Defined in: panel/GraphObject.ts:486
Set the actual size during layout.
Parameters
Sección titulada «Parameters»number
number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»setBackground()
Sección titulada «setBackground()»setBackground(
value):this
Defined in: panel/Panel.ts:289
Fluent setter for background.
Parameters
Sección titulada «Parameters»string | null
Returns
Sección titulada «Returns»this
setBinding()
Sección titulada «setBinding()»setBinding(
binding):this
Defined in: panel/GraphObject.ts:112
GoJS-compatible: Set a binding on this graph object, replacing any existing binding with the same target property.
Parameters
Sección titulada «Parameters»binding
Sección titulada «binding»Returns
Sección titulada «Returns»this
Inherited from
Sección titulada «Inherited from»setPadding()
Sección titulada «setPadding()»setPadding(
value):this
Defined in: panel/Panel.ts:277
Fluent setter for padding.
Parameters
Sección titulada «Parameters»Margin | null
Returns
Sección titulada «Returns»this
setPosition()
Sección titulada «setPosition()»setPosition(
x,y):void
Defined in: panel/GraphObject.ts:476
Set the position within the parent panel.
Parameters
Sección titulada «Parameters»number
number
Returns
Sección titulada «Returns»void
Inherited from
Sección titulada «Inherited from»setSpacing()
Sección titulada «setSpacing()»setSpacing(
value):this
Defined in: panel/Panel.ts:283
Fluent setter for spacing.
Parameters
Sección titulada «Parameters»number
Returns
Sección titulada «Returns»this
theme()
Sección titulada «theme()»theme(
targetprop,sourceprop?,themeSource?,conv?,themeconv?):this
Defined in: panel/GraphObject.ts:137
GoJS-compatible: add a ThemeBinding from a literal Theme property
name to targetprop, e.g. .theme("stroke", "text") assigns stroke
to the current theme’s colors.text.
Parameters
Sección titulada «Parameters»targetprop
Sección titulada «targetprop»string
sourceprop?
Sección titulada «sourceprop?»string
themeSource?
Sección titulada «themeSource?»string | null
(value, data) => unknown
themeconv?
Sección titulada «themeconv?»(value, target) => unknown
Returns
Sección titulada «Returns»this
Inherited from
Sección titulada «Inherited from»themeData()
Sección titulada «themeData()»themeData(
targetprop,sourceprop?,themeSource?,conv?,themeconv?):this
Defined in: panel/GraphObject.ts:153
GoJS-compatible: add a ThemeBinding whose theme key comes from a
data property’s value, e.g. .themeData("fill", "state") looks up
data.state and uses that as the colors key.
Parameters
Sección titulada «Parameters»targetprop
Sección titulada «targetprop»string
sourceprop?
Sección titulada «sourceprop?»string
themeSource?
Sección titulada «themeSource?»string | null
(value, data) => unknown
themeconv?
Sección titulada «themeconv?»(value, target) => unknown
Returns
Sección titulada «Returns»this
Inherited from
Sección titulada «Inherited from»themeModel()
Sección titulada «themeModel()»themeModel(
targetprop,sourceprop?,themeSource?,conv?,themeconv?):this
Defined in: panel/GraphObject.ts:171
GoJS-compatible: like themeData, but sourced from model-wide data.
graphojs has no Model.modelData, so this currently behaves exactly
like themeData (resolved against the part’s own data instead).
Parameters
Sección titulada «Parameters»targetprop
Sección titulada «targetprop»string
sourceprop?
Sección titulada «sourceprop?»string
themeSource?
Sección titulada «themeSource?»string | null
(value, data) => unknown
themeconv?
Sección titulada «themeconv?»(value, target) => unknown
Returns
Sección titulada «Returns»this
Inherited from
Sección titulada «Inherited from»Call Signature
Sección titulada «Call Signature»
staticmake(builder, …args):Panel
Defined in: panel/GraphObject.ts:203
GoJS-compatible static factory method.
Usage: const $ = go.GraphObject.make; const shape = $(go.Shape, “RoundedRectangle”, { fill: “white”, stroke: “gray” }); const panel = $(go.Panel, “Auto”, shape, $(go.TextBlock, “Hello”));
Parameters
Sección titulada «Parameters»builder
Sección titulada «builder»string
…unknown[]
Returns
Sección titulada «Returns»Panel
Inherited from
Sección titulada «Inherited from»Call Signature
Sección titulada «Call Signature»
staticmake(ctor, …args):Panel
Defined in: panel/GraphObject.ts:204
GoJS-compatible static factory method.
Usage: const $ = go.GraphObject.make; const shape = $(go.Shape, “RoundedRectangle”, { fill: “white”, stroke: “gray” }); const panel = $(go.Panel, “Auto”, shape, $(go.TextBlock, “Hello”));
Parameters
Sección titulada «Parameters»typeof Node | typeof Link | typeof Group
…unknown[]
Returns
Sección titulada «Returns»Panel
Inherited from
Sección titulada «Inherited from»Call Signature
Sección titulada «Call Signature»
staticmake<T>(ctor, …args):T
Defined in: panel/GraphObject.ts:205
GoJS-compatible static factory method.
Usage: const $ = go.GraphObject.make; const shape = $(go.Shape, “RoundedRectangle”, { fill: “white”, stroke: “gray” }); const panel = $(go.Panel, “Auto”, shape, $(go.TextBlock, “Hello”));
Type Parameters
Sección titulada «Type Parameters»T
Parameters
Sección titulada «Parameters»(…args) => T
…unknown[]
Returns
Sección titulada «Returns»T