Group class

A Group is a Node that can contain a subgraph of Nodes and Links, which are members of the group.

For more discussion, see Introduction to Groups. See samples that make use of Groups in the samples index.

Although you can create a Group and Diagram#add it to a Diagram, this does not update the Model. It is more common to create a group by adding a node data object to the model by calling Model#addNodeData. For example:

  myDiagram.startTransaction("make new group");
  myDiagram.model.addNodeData({ key: "Omega", isGroup: true });
  myDiagram.commitTransaction("make new group");

This will cause a Group to be created (copying the template found in Diagram#groupTemplateMap), added to the Diagram in some Layer (based on Part#layerName), and bound to the group data (resulting in Panel#data referring to that group data object). Note that the JavaScript object includes setting isGroup to true, to indicate that the object represents a Group rather than a regular Node or simple Part.

The member Parts of a Group, which you can access as the #memberParts collection, belong to the group but are not in the visual tree of the group. All Parts are directly in Layers -- they cannot be inside a Panel. This allows group member parts to be in layers different from the group's layer.

You can change the membership of a Node or a simple Part in a Group by setting its Part#containingGroup property. This is done automatically for you by the diagram if you initialize the group property on the node data in the model to be the key of the containing group node data. Thus you should do something like:

  myDiagram.startTransaction("add new member");
  myDiagram.model.addNodeData({ group: someExistingGroupKey, ... });
  myDiagram.commitTransaction("add new member");

where you would make sure the node data object included all of the properties you need. You can also change the relationship dynamically by calling GraphLinksModel#setGroupKeyForNodeData.

The membership of Links is computed automatically for you by the diagram based on the membership of the connected Nodes. For example, if the Link#fromNode is a top-level node but the Link#toNode is a member of a group, the link is a top-level link. If the two connected nodes both belong to the same group, the link is a member of that group. If the two connected nodes belong to different groups, the link belongs to the common container group, if there is any. Note that if a link connects a member of a group with the group itself, the link is a member of that group.

All of the group-member relationships effectively form a tree structure. These properties and methods are useful in navigating these relationships:

Part#containingGroup
Part#isTopLevel
Part#findTopLevelPart
Part#findSubGraphLevel
Part#findCommonContainingGroup
#memberParts
#findSubGraphParts
#findExternalLinksConnected
#findExternalNodesConnected

As the membership of a group changes, you may want to update the appearance of the group. You can set the #memberAdded and #memberRemoved properties to be functions that are called. These functions must not modify any membership relationships -- these function properties just exist to update the appearance of the Group.

You can control whether certain Nodes are added to a Group by CommandHandler#groupSelection or #addMembers or CommandHandler#addTopLevelParts by affecting the result of CommandHandler#isValidMember, which is responsible for deciding whether it is OK to add a Node to a Group or to remove a Node from a Group to be a top-level node. You can override that predicate on CommandHandler, but it is easier to set the #memberValidation or CommandHandler#memberValidation functional property.

For a more general discussion of validation, see Introduction to Validation.

The area occupied by the subgraph is represented in the group's visual tree by a Placeholder. As the group #placeholder grows and shrinks based on the sizes and positions of the member nodes and links, the group will grow and shrink accordingly. The placeholder is always the Part#locationObject, although you may specify any Spot as the Part#locationSpot. A Group need not have a placeholder, but it may have at most one.

A group has its own #layout property that is used to position the member nodes and route the member links.

The Group class also supports the notion of expanding and collapsing the subgraph, causing the member nodes and links to be shown or hidden. Principally this is a matter of setting #isSubGraphExpanded. Changes to this property will result in calls to #collapseSubGraph or #expandSubGraph, as appropriate.

If you want to change the appearance of the group you can do so in a function that you assign to the #subGraphExpandedChanged property. This function must not modify any member relationships or expand or collapse any groups -- the functional property just exists to update the appearance of the Group.

For more discussion and examples, see SubGraphs.

If you want the user to be able to create a Group out of the currently selected Parts using the CommandHandler#groupSelection command, you need to first set the CommandHandler#archetypeGroupData property to a data object with isGroup set to true. If you want the user to be able to ungroup a Group, using the CommandHandler#ungroupSelection command, you need to set #ungroupable to true.

For more discussion and examples, see Groups, SubGraphs, and Sized Groups.

Only Groups that are in Diagrams can have member Parts or connections via Links. Templates should not be connected with Links, be labels of Links, be members of Groups, have any member Parts, or have any Adornments.

Implemented types

Node

Available extensions

Annotations

@JS()
@staticInterop

Constructors

Group.$1(): factory
Group.$2([dynamic init]): factory
Group.$3([Object? type, dynamic init]): factory

Properties

actionCancel ↔ void Function(InputEvent, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when the ActionTool is cancelled and this GraphObject's #isActionable is set to true. This property is infrequently set. By default this property is null.
getter/setter pair
actionDown ↔ void Function(InputEvent, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute on a mouse-down event when this GraphObject's #isActionable is set to true. This property is infrequently set. By default this property is null.
getter/setter pair
actionMove ↔ void Function(InputEvent, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute on a mouse-move event when this GraphObject's #isActionable is set to true. This property is infrequently set. By default this property is null.
getter/setter pair
actionUp ↔ void Function(InputEvent, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute on a mouse-up event when this GraphObject's #isActionable is set to true. This property is infrequently set. By default this property is null.
getter/setter pair
actualBounds ↔ Rect: Available on GraphObject, provided by the GraphObject$Typings extension
This read-only property returns the bounds of this GraphObject in container coordinates. This means that the actualBounds are in the coordinate space of the GraphObject's Panel, unless this is a Part, in which case they are in the Diagram's coordinate system.
getter/setter pair
adornments ↔ Iterator<Adornment>: Available on Part, provided by the Part$Typings extension
This read-only property returns an iterator over all of the Adornments associated with this part. After each call to the iterator's next() method that returns true, the iterator's key will be the category and the iterator's value will be an Adornment.
getter/setter pair
alignment ↔ Spot: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the alignment Spot of this GraphObject used in Panel layouts, to determine where in the area allocated by the panel this object should be placed.
getter/setter pair
alignmentFocus ↔ Spot: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the spot on this GraphObject to be used as the alignment point in Spot and Fixed Panels. Value must be of the Spot.
getter/setter pair
alignmentFocusName ↔ String: Available on Panel, provided by the Panel$Typings extension
For Panels which are elements of Spot Panels: Gets or sets the name of this Panel's element that should be used as the alignment object instead of this Panel.
getter/setter pair
angle ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the angle transform, in degrees, of this GraphObject. Value must be a number. If the value is not between (0 <= value < 360), it will be normalized to be in that range. Zero is along the positive X-axis (rightwards); 90 is along the positive Y-axis (downwards). Default is 0.
getter/setter pair
areaBackground ↔ dynamic: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the areaBackground Brush of this GraphObject. The areaBackground fills the rectangle described by this GraphObject's containing panel's coordinates. If the object is rotated, the area background will expand to fill the entire measured bounds of the object, without rotating the brush.
getter/setter pair
avoidable ↔ bool: Available on Node, provided by the Node$Typings extension
Gets or sets whether this Node is to be avoided by Links whose Link#routing is Link.AvoidsNodes.
getter/setter pair
avoidableMargin ↔ Object: Available on Node, provided by the Node$Typings extension
Gets or sets the margin around this Node in which avoidable links will not be routed.
getter/setter pair
background ↔ dynamic: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the background Brush of this GraphObject, filling the rectangle of this object's local coordinate space. If the object is rotated, the background will rotate with it.
getter/setter pair
bind → ({GraphObject Function(Binding binding) $1, GraphObject Function([String? targetprop, String? sourceprop, TargetConversion? conv, BackConversion? backconv]) $2}): Available on GraphObject, provided by the GraphObject$Typings extension
Overload accessor: $1, $2
no setter
category ↔ String: Available on Part, provided by the Part$Typings extension
Gets or sets the category of this part, typically used to distinguish different kinds of nodes or links.
getter/setter pair
click ↔ void Function(InputEvent, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when the user single-primary-clicks on this object. This typically involves a mouse-down followed by a prompt mouse-up at approximately the same position using the left (primary) mouse button. This property is used by the ClickSelectingTool when the user clicks on a GraphObject. The function is called in addition to the DiagramEvent that is raised with the name "ObjectSingleClicked".
getter/setter pair
column ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the column of this GraphObject if it is in a Table Panel. The value must be a small non-negative integer. The default is 0.
getter/setter pair
columnCount ↔ num: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: This read-only property returns the number of columns. This value is only valid after the Panel has been measured.
getter/setter pair
columnSizing ↔ EnumValue: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets or sets how this Panel's columns deal with extra space. Valid values are RowColumnDefinition.ProportionalExtra and RowColumnDefinition.None. The default is RowColumnDefinition.ProportionalExtra.
getter/setter pair
columnSpan ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the number of columns spanned by this GraphObject if it is in a Table Panel. The value must be a small positive integer. The default is 1.
getter/setter pair
computesBoundsAfterDrag ↔ bool: Available on Group, provided by the Group$Typings extension
Gets or sets whether the size of the area of the Group's #placeholder should remain the same during a DraggingTool move until a drop occurs. Groups within temporary layers (such as new Groups during a drag-copy) are unaffected by this property.
getter/setter pair
computesBoundsIncludingLinks ↔ bool: Available on Group, provided by the Group$Typings extension
Gets or sets whether a #placeholder's bounds includes the bounds of member Links. The default value is true. If this is false, only non-Link member Parts are used to compute the Placeholder's bounds in document coordinates.
getter/setter pair
computesBoundsIncludingLocation ↔ bool: Available on Group, provided by the Group$Typings extension
Gets or sets whether a #placeholder's bounds includes the previous Group.location. The default value is false.
getter/setter pair
containingGroup ↔ Group?: Available on Part, provided by the Part$Typings extension
Gets or sets the Group of which this Part or Node is a member. This will be null if this is a top-level part.
getter/setter pair
containingGroupChanged ↔ void Function(Part, [Group?, Group?])?: Available on Part, provided by the Part$Typings extension
Gets or sets the function that is called after this Part has changed which Group it belongs to, if any. It is typically used to modify the appearance of the part. The first argument will be this Part. The second argument will be the old Group, or null if it had been a top-level part. The third argument will be the new Group, or null if it is now a top-level part.
getter/setter pair
contextClick ↔ void Function(InputEvent, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when the user single-secondary-clicks on this object. This typically involves a mouse-down followed by a prompt mouse-up at approximately the same position using the right (secondary) mouse button. This property is used by the ClickSelectingTool when the user clicks on a GraphObject. The function is called in addition to the DiagramEvent that is raised with the name "ObjectContextClicked".
getter/setter pair
contextMenu ↔ dynamic: Available on GraphObject, provided by the GraphObject$Typings extension
This Adornment or HTMLInfo is shown upon a context click on this object. The default value is null, which means no context menu is shown.
getter/setter pair
copyable ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether the user may copy this part. The initial value is true.
getter/setter pair
cursor ↔ String: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the mouse cursor to use when the mouse is over this object with no mouse buttons pressed. The value is null when no particular cursor is specified for this object; the actual cursor is determined by any containing Panel.
getter/setter pair
data ↔ dynamic: Available on Panel, provided by the Panel$Typings extension
Gets or sets the optional model data to which this panel is data-bound. The data must be a JavaScript Object if this is a Part. The data can be any JavaScript value if this is a Panel created for an item in an Array that was data-bound by the #itemArray property. The default value is null.
getter/setter pair
defaultAlignment ↔ Spot: Available on Panel, provided by the Panel$Typings extension
Gets or sets the default alignment spot of this Panel, used as the alignment for an element when its GraphObject#alignment value is Spot.Default. The default value is Spot.Default, which is interpreted by the Panel in whatever manner seems reasonable, depending on the Panel type.
getter/setter pair
defaultColumnSeparatorDashArray ↔ Array<num>?: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets or sets the default dash array for a column's separator. RowColumnDefinition#separatorStrokeWidth can override this default value.
getter/setter pair
defaultColumnSeparatorStroke ↔ dynamic: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets or sets the default stroke (color) for columns provided a given column has a nonzero RowColumnDefinition#separatorStrokeWidth. RowColumnDefinition#separatorDashArray can override this default value. The default value is null -- no line is drawn.
getter/setter pair
defaultColumnSeparatorStrokeWidth ↔ num: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets or sets the default stroke width for a column's separator. RowColumnDefinition#separatorStrokeWidth can override this default value. The default value is 1. Any new value must be a real, non-negative number.
getter/setter pair
defaultRowSeparatorDashArray ↔ Array<num>?: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets or sets the default dash array for a row's separator. RowColumnDefinition#separatorDashArray can override this default value.
getter/setter pair
defaultRowSeparatorStroke ↔ dynamic: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets or sets the default stroke (color) for rows provided a given row has a nonzero RowColumnDefinition#separatorStrokeWidth. RowColumnDefinition#separatorStroke can override this default value. The default value is null -- no line is drawn.
getter/setter pair
defaultRowSeparatorStrokeWidth ↔ num: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets or sets the default stroke width for a row's separator. RowColumnDefinition#separatorStrokeWidth can override this default value. The default value is 1. Any new value must be a real, non-negative number.
getter/setter pair
defaultSeparatorPadding ↔ Object: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets or sets the additional padding for rows and columns. Padding is applied both before and after a row or column's contents.
getter/setter pair
defaultStretch ↔ EnumValue: Available on Panel, provided by the Panel$Typings extension
Gets or sets the default stretch of this Panel, used as the stretch for an element when its GraphObject#stretch value is GraphObject.Default. The default value is GraphObject.Default, which typically resolves to GraphObject.None.
getter/setter pair
deletable ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether the user may delete this part. The initial value is true.
getter/setter pair
desiredSize ↔ Size: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the desired size of this GraphObject in local coordinates. Value must be of type Size. Default is Size(NaN, NaN). You cannot modify the width or height of the value of this property -- if you want to change the desiredSize you must set this property to a different Size.
getter/setter pair
diagram ↔ Diagram?: Available on Part, provided by the Part$Typings extension
This read-only property returns the Diagram that this Part is in.
getter/setter pair
diagram ↔ Diagram?: Available on GraphObject, provided by the GraphObject$Typings extension
This read-only property returns the Diagram that this GraphObject is in, if it is.
getter/setter pair
doubleClick ↔ void Function(InputEvent, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when the user double-primary-clicks on this object. This typically involves a mouse-down/up/down/up in rapid succession at approximately the same position using the left (primary) mouse button. This property is used by the ClickSelectingTool when the user clicks on a GraphObject. The function is called in addition to the DiagramEvent that is raised with the name "ObjectDoubleClicked".
getter/setter pair
dragComputation ↔ Point Function(Part, Point, Point)?: Available on Part, provided by the Part$Typings extension
Gets or sets the function used to determine the location that this Part can be dragged to. The first argument is a reference to the Part being dragged, the second argument is a Point describing the proposed location, and the third argument is a snapped location, if one was determined during dragging. It should return a Point that is the proposed new location.
getter/setter pair
elements ↔ Iterator<GraphObject>: Available on Panel, provided by the Panel$Typings extension
This read-only property returns an iterator over the collection of the GraphObjects that this panel manages.
getter/setter pair
enabledChanged ↔ void Function(GraphObject, bool)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when some containing Panel changes the value of Panel#isEnabled. It is typically used to modify the appearance of the object. This function must not change the value of any panel Panel#isEnabled.
getter/setter pair
filter ↔ String: Available on GraphObject, provided by the GraphObject$Typings extension
Undocumented. May not work in Safari.
getter/setter pair
fromEndSegmentLength ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the length of the first segment of a link coming from this port. This value is used when the computed "from spot" is not Spot.None. The default value is 10. This value also limits how short the Link#fromShortLength may be drawn.
getter/setter pair
fromLinkable ↔ bool?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets whether the user may draw Links from this port. This property is used by LinkingBaseTool#isValidFrom.
getter/setter pair
fromLinkableDuplicates ↔ bool: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets whether the user may draw duplicate Links from this port. This property is used by LinkingBaseTool#isValidLink. The default value is false.
getter/setter pair
fromLinkableSelfNode ↔ bool: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets whether the user may draw Links that connect from this port's Node. This property is used by LinkingBaseTool#isValidLink. The default value is false.
getter/setter pair
fromMaxLinks ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the maximum number of links that may come out of this port. This property is used by LinkingBaseTool#isValidFrom.
getter/setter pair
fromShortLength ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets how far the end segment of a link coming from this port stops short of the actual port. Positive values are limited by the #fromEndSegmentLength or Link#fromEndSegmentLength. Negative values cause the link to extend into the port. The default value is zero.
getter/setter pair
fromSpot ↔ Spot: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets where a link should connect from this port. The default value is Spot.None, meaning that the link routing must consider the shape of the port and connect at the closest point.
getter/setter pair
graduatedMax ↔ num: Available on Panel, provided by the Panel$Typings extension
For Panel.Graduated|Graduated Panels: Gets or sets the maximum value represented. Must be greater than #graduatedMin. The default is 100.
getter/setter pair
graduatedMin ↔ num: Available on Panel, provided by the Panel$Typings extension
For Panel.Graduated|Graduated Panels: Gets or sets the minimum value represented. Must be less than #graduatedMax. The default is 0.
getter/setter pair
graduatedRange ↔ num: Available on Panel, provided by the Panel$Typings extension
For Panel.Graduated|Graduated Panels: This read-only property returns the range of values represented by the Panel.
getter/setter pair
graduatedTickBase ↔ num: Available on Panel, provided by the Panel$Typings extension
For Panel.Graduated|Graduated Panels: Gets or sets the base value which is marked with a tick. The default is 0.
getter/setter pair
graduatedTickUnit ↔ num: Available on Panel, provided by the Panel$Typings extension
For Panel.Graduated|Graduated Panels: Gets or sets the difference between two consecutive values marked by ticks. Must be positive. The default is 10.
getter/setter pair
gridCellSize ↔ Size: Available on Panel, provided by the Panel$Typings extension
For Panel.Grid|Grid Panels: Gets or sets the distance between lines. The units are in local coordinates. The default is 10x10. Any new width or height must be a positive real number.
getter/setter pair
gridOrigin ↔ Point: Available on Panel, provided by the Panel$Typings extension
For Panel.Grid|Grid Panels: Gets or sets an origin point for the grid cells. The units are in local coordinates. The default is (0,0). Any new value must use real numbers.
getter/setter pair
groupable ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether the user may group this part to be a member of a new Group. The initial value is true.
getter/setter pair
handlesDragDropForMembers ↔ bool: Available on Group, provided by the Group$Typings extension
Gets or sets whether drag-and-drop events may be bubbled up to this Group if not handled by member Parts. The default value is false -- each Node or Link that is a member of the Group needs to define its own GraphObject#mouseDragEnter, GraphObject#mouseDragLeave, and GraphObject#mouseDrop event handlers if you want dragging/dropping on a member part to act as if the user were acting on the group.
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
height ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the desired height of this GraphObject in local coordinates. This just gets or sets the height component of the #desiredSize. Default is NaN.
getter/setter pair
highlightedChanged ↔ void Function(Part)?: Available on Part, provided by the Part$Typings extension
Gets or sets the function to execute when this #isHighlighted changes. It is typically used to modify the appearance of the part. This function must not highlight or unhighlight any parts.
getter/setter pair
isActionable ↔ bool: Available on GraphObject, provided by the GraphObject$Typings extension
This property determines whether or not this GraphObject's events occur before all other events, including selection. This enables the #actionDown, #actionMove, #actionUp, and #actionCancel events, which are all handled by the ActionTool.
getter/setter pair
isAnimated ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether this part may be animated. The initial value is true.
getter/setter pair
isClipping ↔ bool: Available on Panel, provided by the Panel$Typings extension
For Spot Panels: Gets or sets whether this Panel's main element clips instead of fills. The main element will not paint its stroke, if it has any. This assumes that the main element is a Shape.
getter/setter pair
isEnabled ↔ bool: Available on Panel, provided by the Panel$Typings extension
Gets or sets whether this Panel or any GraphObject inside the panel actually responds to user click events. It may be used as a Binding target. See how this property is used in Buttons.js.
getter/setter pair
isHighlighted ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether this Part is highlighted. The initial value is false.
getter/setter pair
isInDocumentBounds ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether this Part is part of the document bounds.
getter/setter pair
isLayoutPositioned ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether a Layout positions this Node or routes this Link. This property affects the value of #canLayout.
getter/setter pair
isLinkLabel ↔ bool: Available on Node, provided by the Node$Typings extension
This read-only property is true when this Node is a label node for a Link.
getter/setter pair
isOpposite ↔ bool: Available on Panel, provided by the Panel$Typings extension
For Panel.Horizontal|Horizontal and Panel.Vertical|Vertical Panels: gets or sets whether this Panel arranges its contents from the typical side (left and top, respectively), or the opposite side (right and bottom, respectively).
getter/setter pair
isPanelMain ↔ bool: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets whether a GraphObject is the "main" object for some types of Panel. Panels that use a "main" object include Panel.Auto, Panel.Spot, and Panel.Link.
getter/setter pair
isSelected ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether this Part is selected. The initial value is false.
getter/setter pair
isShadowed ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether this part will draw shadows. The initial value is false.
getter/setter pair
isSubGraphExpanded ↔ bool: Available on Group, provided by the Group$Typings extension
Gets or sets whether the subgraph contained by this group is expanded. Changing this property's value will call #collapseSubGraph or #expandSubGraph, and also will call the value of #subGraphExpandedChanged if it is a function.
getter/setter pair
isTopLevel ↔ bool: Available on Part, provided by the Part$Typings extension
This read-only property is true when this part is not member of any Group node nor is it a label node for a Link.
getter/setter pair
isTreeExpanded ↔ bool: Available on Node, provided by the Node$Typings extension
Gets or sets whether the subtree graph starting at this node is expanded. Changing this property's value will call #collapseTree or #expandTree, and also will call the value of #treeExpandedChanged if it is a function.
getter/setter pair
isTreeLeaf ↔ bool: Available on Node, provided by the Node$Typings extension
Gets whether this node has no tree children.
getter/setter pair
itemArray ↔ Array?: Available on Panel, provided by the Panel$Typings extension
Gets or sets a JavaScript Array of values or objects, each of which will be represented by a Panel as elements in this Panel. Replacing this array results all of this panel's child objects being replaced with a copy of the Panel found in #itemTemplateMap for each particular item in the Array.
getter/setter pair
itemCategoryProperty ↔ Object: Available on Panel, provided by the Panel$Typings extension
Gets or sets the name of the item data property that returns a string describing that data's category, or a function that takes an item data object and returns that string; the default value is the name 'category'. This is used to distinguish between different kinds of items in the #itemArray.
getter/setter pair
itemIndex ↔ num: Available on Panel, provided by the Panel$Typings extension
Gets the index of this Panel's data if it was created to represent an item in its containing Panel's Panel#itemArray. The default value is NaN.
getter/setter pair
itemTemplate ↔ Panel: Available on Panel, provided by the Panel$Typings extension
Gets or sets the default Panel template used as the archetype for item data that are in #itemArray.
getter/setter pair
itemTemplateMap ↔ Map<String, Panel>?: Available on Panel, provided by the Panel$Typings extension
Gets or sets a Map mapping template names to Panels. One of these Panels is copied for each item data that is in the #itemArray. Replacing this map will automatically rebuild all of the elements in this Panel.
getter/setter pair
key ↔ dynamic: Available on Part, provided by the Part$Typings extension
This read-only property returns the Part's Model data key if it is in a Diagram and is backed by Model data. Otherwise this returns undefined.
getter/setter pair
labeledLink ↔ Link?: Available on Node, provided by the Node$Typings extension
Gets or sets the Link for which this Node is acting as a smart label. Most nodes do not act as link labels, so this property will be null.
getter/setter pair
layer ↔ Layer?: Available on Part, provided by the Part$Typings extension
This read-only property returns the Layer that this Part is in. The value is the Layer that is named with the value of #layerName. If you want to change what Layer this Part is in, change the value of #layerName to refer to a different Layer.
getter/setter pair
layer ↔ Layer?: Available on GraphObject, provided by the GraphObject$Typings extension
This read-only property returns the GraphObject's containing Layer, if there is any. A plain GraphObject cannot belong directly to a Layer -- only a Part can belong directly to a Layer.
getter/setter pair
layerChanged ↔ void Function(Part, [Layer?, Layer?])?: Available on Part, provided by the Part$Typings extension
Gets or sets the function to execute when this part changes layers. It is typically used to modify the appearance of the part. This function must not change the layer of this part by setting #layerName.
getter/setter pair
layerName ↔ String: Available on Part, provided by the Part$Typings extension
Gets or sets the layer name for this part. The initial value is an empty string, which is the name of the default layer. The value of this property determines the value of #layer.
getter/setter pair
layout ↔ Layout?: Available on Group, provided by the Group$Typings extension
Gets or sets the Layout used to position all of the immediate member nodes and links in this group. By default this property is an instance of Layout -- no special layout is used, which just makes sure each member node has a valid location.
getter/setter pair
layoutConditions ↔ num: Available on Part, provided by the Part$Typings extension
Gets or sets flags that control when the Layout that is responsible for this Part is invalidated. The initial value is Part.LayoutStandard, which causes the layout for this part to be invalidated when the part is added or removed or changes visibility or size.
getter/setter pair
leftIndex ↔ num: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets or sets the first column that this Panel displays. The default value is 0.
getter/setter pair
linkConnected ↔ void Function(Node, Link, GraphObject)?: Available on Node, provided by the Node$Typings extension
Gets or sets the function that is called after a Link has been connected with this Node. It is typically used to modify the appearance of the node. The first argument will be this Node. The second argument will be a Link that is now connected with this node. The third argument will be a GraphObject port indicating which port the link was connected with.
getter/setter pair
linkDisconnected ↔ void Function(Node, Link, GraphObject)?: Available on Node, provided by the Node$Typings extension
Gets or sets the function that is called after a Link has been disconnected from this Node. It is typically used to modify the appearance of the node. The first argument will be this Node. The second argument will be a Link that had been connected with this node. The third argument will be a GraphObject port indicating which port the link had been connected with.
getter/setter pair
linksConnected ↔ Iterator<Link>: Available on Node, provided by the Node$Typings extension
This read-only property returns an iterator over all of the Links that are connected with this node. This includes both links that are coming out of this node as well as links that are going into this node. Setting Link#fromNode or Link#toNode to refer to this Node will add that Link to this collection.
getter/setter pair
linkValidation ↔ bool Function(Node, GraphObject, Node, GraphObject, Link)?: Available on Node, provided by the Node$Typings extension
Gets or sets a predicate that determines whether or not a Link may be connected with this node. If this is non-null, the predicate is called in addition to the predicate that is LinkingBaseTool#linkValidation on the LinkingTool and RelinkingTool. See LinkingBaseTool#isValidLink for more details.
getter/setter pair
location ↔ Point: Available on Part, provided by the Part$Typings extension
Gets or sets the position of this part in document coordinates, based on the #locationSpot in this part's #locationObject.
getter/setter pair
locationObject ↔ GraphObject: Available on Part, provided by the Part$Typings extension
This read-only property returns the GraphObject that determines the location of this Part. The value will be in the visual tree of this Part and is usually named with the value of #locationObjectName.
getter/setter pair
locationObjectName ↔ String: Available on Part, provided by the Part$Typings extension
Gets or sets the name of the GraphObject that provides the location of this Part. This name determines the value of #locationObject. The actual #location also depends on the #locationSpot.
getter/setter pair
locationSpot ↔ Spot: Available on Part, provided by the Part$Typings extension
Gets or sets the location Spot of this Node, the spot on the #locationObject that is used in positioning this part in the diagram.
getter/setter pair
margin ↔ Object: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the size of empty area around this GraphObject, as a Margin, in the containing Panel coordinates.
getter/setter pair
maxLocation ↔ Point: Available on Part, provided by the Part$Typings extension
Gets or sets the maximum location of this Part to which the user may drag using the DraggingTool.
getter/setter pair
maxSize ↔ Size: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the maximum size of this GraphObject in container coordinates (either a Panel or the document). Any new value must be of type Size; NaN values are treated as Infinity. If you want no maximum width or height, use NaN or Infinity.
getter/setter pair
measuredBounds ↔ Rect: Available on GraphObject, provided by the GraphObject$Typings extension
This read-only property returns the measuredBounds of the GraphObject in container coordinates (either a Panel or the document). This describes the transformed bounds with margins excluded.
getter/setter pair
memberAdded ↔ void Function(Group, Part)?: Available on Group, provided by the Group$Typings extension
Gets or sets the function that is called after a member Part has been added to this Group. It is typically used to modify the appearance of the group. The first argument will be this Group. The second argument will be a Part, typically a Node, but may be a simple Part or a Link.
getter/setter pair
memberParts ↔ Iterator<Part>: Available on Group, provided by the Group$Typings extension
This read-only property returns an iterator over the member Parts of this Group. Setting Part#containingGroup to refer to this Group will add that part to this collection. The Parts can be Nodes, Links, Groups, or simple Parts.
getter/setter pair
memberRemoved ↔ void Function(Group, Part)?: Available on Group, provided by the Group$Typings extension
Gets or sets the function that is called after a member Part has been removed from this Group. It is typically used to modify the appearance of the group. The first argument will be this Group. The second argument will be a Part, typically a Node, but may be a simple Part or a Link.
getter/setter pair
memberValidation ↔ bool Function(Group, Part)?: Available on Group, provided by the Group$Typings extension
Gets or sets the predicate that determines whether or not a Part may become a member of this group. If this is non-null, the predicate is called in addition to any CommandHandler#memberValidation predicate.
getter/setter pair
minLocation ↔ Point: Available on Part, provided by the Part$Typings extension
Gets or sets the minimum location of this Part to which the user may drag using the DraggingTool.
getter/setter pair
minSize ↔ Size: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the minimum size of this GraphObject in container coordinates (either a Panel or the document). Any new value must be of type Size; NaN values are treated as 0.
getter/setter pair
mouseDragEnter ↔ void Function(InputEvent, GraphObject, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when the user moves the mouse into this stationary object during a DraggingTool drag; this allows you to provide feedback during a drag based on where it might drop.
getter/setter pair
mouseDragLeave ↔ void Function(InputEvent, GraphObject, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when the user moves the mouse out of this stationary object during a DraggingTool drag; this allows you to provide feedback during a drag based on where it might drop.
getter/setter pair
mouseDrop ↔ void Function(InputEvent, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when a user drops the selection on this object at the end of a DraggingTool drag; this allows you to customize the behavior when a drop occurs on an object.
getter/setter pair
mouseEnter ↔ void Function(InputEvent, GraphObject, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when the user moves the mouse into this object without holding down any buttons. This property is used by the ToolManager.
getter/setter pair
mouseHold ↔ void Function(InputEvent, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when the user holds the mouse still for a while over this object while holding down a button. This property is used by the ToolManager.
getter/setter pair
mouseHover ↔ void Function(InputEvent, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when the user holds the mouse still for a while over this object without holding down any buttons. This property is used by the ToolManager.
getter/setter pair
mouseLeave ↔ void Function(InputEvent, GraphObject, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when the user moves the mouse out of this object without holding down any buttons. This property is used by the ToolManager.
getter/setter pair
mouseOver ↔ void Function(InputEvent, GraphObject)?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the function to execute when the user moves the mouse over this object without holding down any buttons. This property is used by the ToolManager. This property is infrequently used -- it is more common to implement #mouseEnter and #mouseLeave functions.
getter/setter pair
movable ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether the user may move this part. The initial value is true.
getter/setter pair
name ↔ String: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the name for this object. The default value is the empty string. The name should be unique within a Panel, although if it isn't, it reduces the usefulness of methods such as Panel#findObject.
getter/setter pair
naturalBounds ↔ Rect: Available on GraphObject, provided by the GraphObject$Typings extension
This read-only property returns the natural bounding rectangle of this GraphObject in local coordinates, before any transformation by #scale or #angle. Defaults to unknown (NaN,NaN).
getter/setter pair
opacity ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the multiplicative opacity for this GraphObject and (if a Panel) all elements. The value must be between 0.0 (fully transparent) and 1.0 (no additional transparency).
getter/setter pair
padding ↔ Object: Available on Panel, provided by the Panel$Typings extension
Gets or sets the space between this Panel's border and its content. Unlike GraphObject#margin, padding expands the area inside of the Panel's border. If this Panel's size is unconstrained, this will increase the size of the panel. If this Panel's size is constrained, this will decrease the total area for the Panel elements to arrange themselves.
getter/setter pair
panel ↔ Panel?: Available on GraphObject, provided by the GraphObject$Typings extension
This read-only property returns the GraphObject's containing Panel, or null if this object is not in a Panel.
getter/setter pair
panelLayoutState ↔ dynamic: Available on Panel, provided by the Panel$Typings extension
Undocumented state for PanelLayouts
getter/setter pair
part ↔ Part?: Available on GraphObject, provided by the GraphObject$Typings extension
This read-only property returns the Part containing this object, if any. The Part will be the root GraphObject in this GraphObject's visual tree.
getter/setter pair
pickable ↔ bool: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets whether or not this GraphObject can be chosen by visual "find" or "hit-test" methods such as Diagram#findObjectAt.
getter/setter pair
placeholder ↔ Placeholder?: Available on Group, provided by the Group$Typings extension
This read-only property returns a Placeholder that this group may contain in its visual tree.
getter/setter pair
port ↔ GraphObject: Available on Node, provided by the Node$Typings extension
This read-only property returns the primary GraphObject representing a port in this node. If there is a GraphObject whose GraphObject#portId is the empty string, return it. If there is no such element, just return this whole Node.
getter/setter pair
portId ↔ String: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets an identifier for an object acting as a port on a Node. The default value is null -- this object is not a port.
getter/setter pair
ports ↔ Iterator<GraphObject>: Available on Node, provided by the Node$Typings extension
This read-only property returns an iterator over all of the GraphObjects in this node that act as ports.
getter/setter pair
portSpreading ↔ EnumValue: Available on Node, provided by the Node$Typings extension
Gets or sets how link points are computed when the port spot is a "side" spot. The value must be one of Node.SpreadingNone|SpreadingNone, Node.SpreadingEvenly|SpreadingEvenly, Node.SpreadingPacked|SpreadingPacked. The default value is Node.SpreadingEvenly.
getter/setter pair
position ↔ Point: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the position of this GraphObject in container coordinates (either a Panel or the document). Value must be of type Point. You cannot modify the x or y of the value of this property -- if you want to change the position you must set this property to a different Point. Default is Point(NaN, NaN).
getter/setter pair
reshapable ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether the user may reshape this part. The initial value is false.
getter/setter pair
resizable ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether the user may resize this part. The initial value is false.
getter/setter pair
resizeAdornmentTemplate ↔ Adornment?: Available on Part, provided by the Part$Typings extension
Gets or sets the adornment template used to create a resize handle Adornment for this part. This is used by the ResizingTool, ToolManager#resizingTool.
getter/setter pair
resizeCellSize ↔ Size: Available on Part, provided by the Part$Typings extension
Gets or sets the width and height multiples used when resizing. By default this property is the Size(NaN, NaN).
getter/setter pair
resizeObject ↔ GraphObject: Available on Part, provided by the Part$Typings extension
This read-only property returns the GraphObject that should get resize handles when this part is selected. The value will be in the visual tree of this Part and is usually named with the value of #resizeObjectName.
getter/setter pair
resizeObjectName ↔ String: Available on Part, provided by the Part$Typings extension
Gets or sets the name of the GraphObject that should get a resize handle when this part is selected. The value of this property affects the value of #resizeObject. The initial value is an empty string, meaning the whole Part itself gets any resize handle.
getter/setter pair
rotatable ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether the user may rotate this part. The initial value is false.
getter/setter pair
rotateAdornmentTemplate ↔ Adornment?: Available on Part, provided by the Part$Typings extension
Gets or sets the adornment template used to create a rotation handle Adornment for this part. This is used by the RotatingTool, ToolManager#rotatingTool.
getter/setter pair
rotateObject ↔ GraphObject: Available on Part, provided by the Part$Typings extension
This read-only property returns the GraphObject that should get rotate handles when this part is selected. The value will be in the visual tree of this Part and is usually named with the value of #rotateObjectName.
getter/setter pair
rotateObjectName ↔ String: Available on Part, provided by the Part$Typings extension
Gets or sets the name of the GraphObject that should get a rotate handle when this part is selected. The value of this property affects the value of #rotateObject. The initial value is an empty string, meaning the whole Part itself gets any rotate handle.
getter/setter pair
rotationSpot ↔ Spot: Available on Part, provided by the Part$Typings extension
Gets or sets the spot on the #rotateObject that is used in rotating this part with the RotatingTool.
getter/setter pair
row ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the row of this GraphObject if it is in a Table Panel. The value must be a small non-negative integer. The default is 0.
getter/setter pair
rowCount ↔ num: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: This read-only property returns the number of rows. This value is only valid after the Panel has been measured.
getter/setter pair
rowSizing ↔ EnumValue: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets or sets how this Panel's rows deal with extra space. Valid values are RowColumnDefinition.ProportionalExtra and RowColumnDefinition.None. The default is RowColumnDefinition.ProportionalExtra.
getter/setter pair
rowSpan ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the number of rows spanned by this GraphObject if it is in a Table Panel. The value must be a small positive integer. The default is 1.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
scale ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the scale transform of this GraphObject. Value must be a number; larger values will make this object appear bigger. Default is 1.
getter/setter pair
segmentFraction ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the fractional distance along a segment of a GraphObject that is in a Link. The value should be between zero and one, where zero is at the point at the start of the segment, and where one is at the point at the end of the segment. The default value is zero.
getter/setter pair
segmentIndex ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the segment index of a GraphObject that is in a Link. Non-negative numbers count up from zero, which is the first segment, at the "from" end of the Link. Negative numbers count segments from the "to" end of the Link, where -1 means the last segment and -2 means the next-to-last segment. The default value is -Infinity. The value should be an integer or NaN.
getter/setter pair
segmentOffset ↔ Point: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the offset of a GraphObject that is in a Link from a point on a segment or in a Panel.Graduated from a point along the main element. The X component of the Point indicates the distance along the route, with positive values going further toward the "to" end of the link or panel. The Y component of the Point indicates the distance away from the route, with positive values towards the right as seen when facing further towards the "to" end of the link or panel. The value defaults to the Point (0, 0). You cannot modify the x or y of the value of this property -- if you want to change the segmentOffset you must set this property to a different Point.
getter/setter pair
segmentOrientation ↔ EnumValue: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the orientation of a GraphObject that is in a Link or Panel.Graduated. This controls the automatic rotation of the object by the Link Panel or Graduated Panel. The only accepted values are the Link "Orient..." values of Link and the default value: Link.None.
getter/setter pair
selectable ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether the user may select this part. The initial value is true.
getter/setter pair
selectionAdorned ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether a selection adornment is shown for this part when it is selected. The initial value is true.
getter/setter pair
selectionAdornmentTemplate ↔ Adornment?: Available on Part, provided by the Part$Typings extension
Gets or sets the Adornment template used to create a selection handle for this Part.
getter/setter pair
selectionChanged ↔ void Function(Part)?: Available on Part, provided by the Part$Typings extension
Gets or sets the function to execute when this part is selected or deselected. It is typically used to modify the appearance of the part. This function must not select or deselect any parts.
getter/setter pair
selectionObject ↔ GraphObject: Available on Part, provided by the Part$Typings extension
This read-only property returns the GraphObject that should get a selection handle when this part is selected. The value will be in the visual tree of this Part and is usually named with the value of #selectionObjectName. When the #selectionObjectName is unspecified, this whole Part is used as the "selection object".
getter/setter pair
selectionObjectName ↔ String: Available on Part, provided by the Part$Typings extension
Gets or sets the name of the GraphObject that should get a selection handle when this part is selected. The value of this property affects the value of #selectionObject. The initial value is an empty string, meaning the whole Part itself gets any selection handle.
getter/setter pair
shadowBlur ↔ num: Available on Part, provided by the Part$Typings extension
Gets or sets the numerical value that describes the shadow's blur. Number must be non-negative and non-infinity. A value of 0 would mean the shadow does not blur and larger numbers represent increasingly more blur. The total blur area is independent of the Part's area and can become quite large as this number is increased.
getter/setter pair
shadowColor ↔ String: Available on Part, provided by the Part$Typings extension
Gets or sets the CSS string that describes a shadow color. Default is 'gray'. Brushes cannot be used for this property -- only strings.
getter/setter pair
shadowOffset ↔ Point: Available on Part, provided by the Part$Typings extension
Gets or sets the X and Y offset of this part's shadow. This is only relevant if #isShadowed is true. The initial value is (6, 6).
getter/setter pair
shadowVisible ↔ bool?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets whether or not this GraphObject will be shadowed inside a Part that has Part#isShadowed set to true.
getter/setter pair
spanAllocation ↔ num Function(GraphObject, RowColumnDefinition, num)?: Available on GraphObject, provided by the GraphObject$Typings extension
(undocumented)
getter/setter pair
stretch ↔ EnumValue: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the stretch of the GraphObject. This controls whether the width and/or height of this object automatically adjusts to fill the area allotted by the containing Panel.
getter/setter pair
subGraphExpandedChanged ↔ void Function(Group)?: Available on Group, provided by the Group$Typings extension
Gets or sets the function that is called when #isSubGraphExpanded has changed value. The argument to that function will be this Group.
getter/setter pair
text ↔ String: Available on Part, provided by the Part$Typings extension
Gets or sets a text string that is associated with this part.
getter/setter pair
textEditable ↔ bool: Available on Part, provided by the Part$Typings extension
Gets or sets whether the user may do in-place text editing on TextBlocks in this part that have TextBlock#editable set to true. The initial value is true.
getter/setter pair
toEndSegmentLength ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the length of the last segment of a link going to this port. This value is used when the computed "to spot" is not Spot.None. The default value is 10.
getter/setter pair
toLinkable ↔ bool?: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets whether the user may draw Links to this port. This property is used by LinkingBaseTool#isValidTo.
getter/setter pair
toLinkableDuplicates ↔ bool: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets whether the user may draw duplicate Links to this port. This property is used by LinkingBaseTool#isValidLink. The default value is false.
getter/setter pair
toLinkableSelfNode ↔ bool: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets whether the user may draw Links that connect to this port's Node. This property is used by LinkingBaseTool#isValidLink. The default value is false.
getter/setter pair
toMaxLinks ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the maximum number of links that may go into this port. This property is used by LinkingBaseTool#isValidTo.
getter/setter pair
toolTip ↔ dynamic: Available on GraphObject, provided by the GraphObject$Typings extension
This Adornment or HTMLInfo is shown when the mouse hovers over this object. The default value is null, which means no tooltip is shown.
getter/setter pair
topIndex ↔ num: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets or sets the first row that this Panel displays. The default value is 0.
getter/setter pair
toShortLength ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets how far the end segment of a link going to this port stops short of the actual port. Positive values are limited by the #toEndSegmentLength or Link#toEndSegmentLength. Negative values cause the link to extend into the port. The default value is zero.
getter/setter pair
toSpot ↔ Spot: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets where a link should connect to this port. The default value is Spot.None, meaning that the link routing must consider the shape of the port and connect to the closest point.
getter/setter pair
treeExpandedChanged ↔ void Function(Node)?: Available on Node, provided by the Node$Typings extension
Gets or sets the function that is called when #isTreeExpanded has changed value. The argument to that function will be this Node.
getter/setter pair
type ↔ PanelLayout: Available on Panel, provided by the Panel$Typings extension
Gets or sets the type of the Panel, which controls how the Panel's elements are measured and arranged. The value must be an instance of PanelLayout. The only predefined values are listed as constant properties of Panel, including:
getter/setter pair
ungroupable ↔ bool: Available on Group, provided by the Group$Typings extension
Gets or sets whether the user may ungroup this group. The initial value is false.
getter/setter pair
viewboxStretch ↔ EnumValue: Available on Panel, provided by the Panel$Typings extension
For Panel.Viewbox|Viewbox Panels: Gets or sets how the panel will resize its content.
getter/setter pair
visible ↔ bool: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets whether a GraphObject is visible. The default value is true. A not visible object takes no space in the Panel that it is in. Toggling visibility may cause elements in the visual tree to re-measure and re-arrange. Making a Panel not visible causes all of its elements not to be seen or receive input events. Changing a Panel to become visible causes all of its elements to be seen and be active, unless those elements are themselves not visible.
getter/setter pair
wasSubGraphExpanded ↔ bool: Available on Group, provided by the Group$Typings extension
Gets or sets whether the subgraph starting at this group had been collapsed by a call to #expandSubGraph on the containing Group. The initial value is false.
getter/setter pair
wasTreeExpanded ↔ bool: Available on Node, provided by the Node$Typings extension
Gets or sets whether the subtree graph starting at this node had been collapsed by a call to #expandTree on the parent node. The initial value is false.
getter/setter pair
width ↔ num: Available on GraphObject, provided by the GraphObject$Typings extension
Gets or sets the desired width of this GraphObject in local coordinates. This just gets or sets the width component of the #desiredSize. Default is NaN.
getter/setter pair
zOrder ↔ num: Available on Part, provided by the Part$Typings extension
Gets or sets the Z-ordering position of this Part within its Layer.
getter/setter pair

Methods

add([Iterable? elements]) → Panel: Available on Panel, provided by the Panel$Typings extension
Adds a number of GraphObjects to the end of this Panel's list of elements, visually in front of all of the other elements.
addAdornment(String category, Adornment ad) → void: Available on Part, provided by the Part$Typings extension
Associate an Adornment with this Part, perhaps replacing any existing adornment of the same category. Don't forget to set Adornment#adornedObject before calling this method. This adds the Adornment to the Layer named by #layerName, normally "Adornment".
addColumnDefinition(num colIndex, dynamic options) → Panel: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Sets the column RowColumnDefinition given by the index. If the column definition does not exist on the Panel, this will create it. If it already exists on the Panel, this will copy the properties of the given RowColumnDefinition options onto that definition.
addMembers(Iterable<Part> coll, [bool? check]) → bool: Available on Group, provided by the Group$Typings extension
Add the Parts in the given collection as members of this Group for those Parts for which CommandHandler#isValidMember returns true. If the check argument to this method is not supplied or false, this will set Part#containingGroup on each part unconditionally, not calling CommandHandler#isValidMember.
addRowColumnDefinition(RowColumnDefinition rowOrColumnDef) → Panel: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Sets the given RowColumnDefinition. If the row or column definition does not exist on the Panel, this will create it. If it already exists on the Panel, this will copy the properties of the given RowColumnDefinition onto that RowColumnDefinition. @since 2.3 @param {RowColumnDefinition} rowOrColumnDef the non-negative zero-based integer column index. @return {Panel} this Panel @see #addRowDefinition @see #addColumnDefinition
addRowDefinition(num rowIndex, dynamic options) → Panel: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Sets the row RowColumnDefinition given by the index. If the row definition does not exist on the Panel, this will create it. If it already exists on the Panel, this will copy the properties of the given RowColumnDefinition options onto that definition.
apply(void func(GraphObject)) → GraphObject: Available on GraphObject, provided by the GraphObject$Typings extension
This method takes a function that can be used to apply multiple settings, bindings, or Panel#add calls, to different GraphObjects. This is common in initialization. If you are just adding settings, bindings, or GraphObjects to a single GraphObject, you do not need to use this, you can just chain calls to #set, #bind, and Panel#add instead. This method is mostly useful when setting the same values across multiple GraphObjects.
attach([dynamic config]) → GraphObject: Available on GraphObject, provided by the GraphObject$Typings extension
This method sets a collection of properties according to the property/value pairs on the given Object, or array of Objects, in the same manner as GraphObject.make does when constructing a GraphObject.
canAddMembers(Iterable<Part> coll) → bool: Available on Group, provided by the Group$Typings extension
See if the given collection of Parts contains non-Links all for which CommandHandler#isValidMember returns true.
canCopy() → bool: Available on Part, provided by the Part$Typings extension
This predicate returns true if #copyable is true, if the layer's Layer#allowCopy is true, and if the diagram's Diagram#allowCopy is true.
canDelete() → bool: Available on Part, provided by the Part$Typings extension
This predicate returns true if #deletable is true, if the layer's Layer#allowDelete is true, and if the diagram's Diagram#allowDelete is true.
canEdit() → bool: Available on Part, provided by the Part$Typings extension
This predicate returns true if #textEditable is true, if the layer's Layer#allowTextEdit is true, and if the diagram's Diagram#allowTextEdit is true.
canGroup() → bool: Available on Part, provided by the Part$Typings extension
This predicate returns true if #groupable is true, if the layer's Layer#allowGroup is true, and if the diagram's Diagram#allowGroup is true.
canLayout() → bool: Available on Part, provided by the Part$Typings extension
This predicate is called by Layout implementations to decide whether this Part should be positioned and might affect the positioning of other Parts.
canMove() → bool: Available on Part, provided by the Part$Typings extension
This predicate returns true if #movable is true, if the layer's Layer#allowMove is true, and if the diagram's Diagram#allowMove is true.
canReshape() → bool: Available on Part, provided by the Part$Typings extension
This predicate returns true if #reshapable is true, if the layer's Layer#allowReshape is true, and if the diagram's Diagram#allowReshape is true.
canResize() → bool: Available on Part, provided by the Part$Typings extension
This predicate returns true if #resizable is true, if the layer's Layer#allowResize is true, and if the diagram's Diagram#allowResize is true.
canRotate() → bool: Available on Part, provided by the Part$Typings extension
This predicate returns true if #rotatable is true, if the layer's Layer#allowRotate is true, and if the diagram's Diagram#allowRotate is true.
canSelect() → bool: Available on Part, provided by the Part$Typings extension
This predicate returns true if #selectable is true, if the layer's Layer#allowSelect is true, and if the diagram's Diagram#allowSelect is true.
canUngroup() → bool: Available on Group, provided by the Group$Typings extension
This predicate returns true if #ungroupable is true, if the layer's Layer#allowUngroup is true, and if the diagram's Diagram#allowUngroup is true.
clearAdornments() → void: Available on Part, provided by the Part$Typings extension
Remove all adornments associated with this part.
cloneProtected(GraphObject copy) → void: Available on GraphObject, provided by the GraphObject$Typings extension
Copies properties from this object to the given object, which must be of the same class. This is called by #copy. This method may be overridden.
collapseSubGraph() → void: Available on Group, provided by the Group$Typings extension
Hide each of the member nodes and links of this group, and recursively collapse any member groups. This changes the value of Part#isVisible of the whole subgraph and the parts owned by those member nodes and links. However, this group's visibility is unchanged.
collapseTree([num? level]) → void: Available on Node, provided by the Node$Typings extension
Hide each child node and the connecting link, and recursively collapse each child node. This changes the value of Part#isVisible of the whole subtree and the parts owned by those nodes and links. However, this root node's visibility is unchanged.
copy() → GraphObject: Available on GraphObject, provided by the GraphObject$Typings extension
Creates a deep copy of this GraphObject and returns it. This method is the same as a clone for simple GraphObjects such as Shape, TextBlock, and Picture. For Panel this method copies the visual tree of GraphObjects that it contains. @expose @return {GraphObject}
copy() → Panel: Available on Panel, provided by the Panel$Typings extension
Creates a deep copy of this Panel and returns it. @return {Panel}
copyTemplate([bool? freeze]) → Panel: Available on Panel, provided by the Panel$Typings extension
Make a deep copy of this Panel and allow it to be used as a template. This makes copies of Bindings, unlike the regular copy() method. Pass true as the argument in order to freeze the Bindings, allowing it to operate efficiently as a template. A false value (which is the default) allows further additions/modifications of the bindings in the copied Panel. @since 2.2 @param {boolean=} freeze whether to freeze the Bindings in the copy; default is false @return {Panel}
elt(num idx) → GraphObject: Available on Panel, provided by the Panel$Typings extension
Returns the GraphObject in this Panel's list of elements at the specified index. @param {number} idx @return {GraphObject}
ensureBounds() → void: Available on Part, provided by the Part$Typings extension
Measures if needed to make sure the GraphObject#measuredBounds and GraphObject#naturalBounds are all real numbers, primarily to get the actual width and height. GraphObject#actualBounds will get a real width and height, but the x and y values may continue to be NaN if they were that way beforehand.
expandSubGraph() → void: Available on Group, provided by the Group$Typings extension
Show each member node and link, and perhaps recursively expand nested subgraphs. This may change the value of Part#isVisible of the whole subgraph and the parts owned by those member nodes and links. However, this group's visibility is unchanged.
expandTree([num? level]) → void: Available on Node, provided by the Node$Typings extension
Show each child node and the connecting link, and perhaps recursively expand their child nodes. This may change the value of Part#isVisible of the whole subtree and the parts owned by those nodes and links. However, this root node's visibility is unchanged.
findAdornment(String category) → Adornment?: Available on Part, provided by the Part$Typings extension
Find an Adornment of a given category associated with this Part.
findBindingPanel() → Panel?: Available on GraphObject, provided by the GraphObject$Typings extension
Walks up the visual tree and returns the first Panel whose Panel.data is bound to data. This can be useful when you need to inspect Panel#data objects. @since 2.2 @return {Panel}
findColumnForLocalX(num x) → num: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Returns the cell at a given x-coordinate in local coordinates, or -1 if there are no RowColumnDefinitions for this Table Panel or if the argument is negative. Call GraphObject#getLocalPoint to convert a Point in document coordinates into a Point in local coordinates.
findCommonContainingGroup(Part other) → Group?: Available on Part, provided by the Part$Typings extension
Find the Group that perhaps indirectly contains both this part and another one. If this is a Group and it contains the OTHER Part, return this. If the OTHER Part is a Group and it contains this Part, return that OTHER Part.
findCommonTreeParent(Node other) → Node?: Available on Node, provided by the Node$Typings extension
Find the Node that is the perhaps indirect tree parent of both this node and another one, or this node if it is an ancestor of the other node, or vice-versa.
findExternalLinksConnected() → Iterator<Link>: Available on Group, provided by the Group$Typings extension
Returns an iterator over all of the Links that connect with this group or any node contained by this group, in either direction, but that are not internal to this group.
findExternalNodesConnected() → Iterator<Node>: Available on Group, provided by the Group$Typings extension
Returns an iterator over all of the Nodes that are connected with this group or any node contained by this group, by a link in either direction, but that are not internal to this group.
findExternalTreeLinksConnected() → Iterator<Link>: Available on Node, provided by the Node$Typings extension
Return a collection of Links that connect with this Node or any in its subtree, excluding any isTreeLink Links. For trees this is the analog of Group#findExternalLinksConnected for Groups. @return {Iterator.} @since 2.2
findItemPanelForData(Object data) → Panel?: Available on Panel, provided by the Panel$Typings extension
Return the Panel that was made for a particular data object in this panel's #itemArray. If this returns a Panel, its #data property will be the argument data object, and its containing GraphObject#panel will be this panel. @param {Object} data must be an Object, not a string or a number or a boolean or a function @return {Panel} or null if not found @since 1.6
findLinksBetween(Node othernode, [String? pid, String? otherpid]) → Iterator<Link>: Available on Node, provided by the Node$Typings extension
Returns an iterator over all of the Links that go from this node to another node or vice-versa, perhaps limited to a given port id on this node and a port id on the other node.
findLinksConnected([String? pid]) → Iterator<Link>: Available on Node, provided by the Node$Typings extension
Returns an iterator over all of the Links that connect with this node in either direction, perhaps limited to the given port id on this node. @expose @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. @return {Iterator.}
findLinksInto([String? pid]) → Iterator<Link>: Available on Node, provided by the Node$Typings extension
Returns an iterator over all of the Links that go into this node, perhaps limited to the given port id on this node. @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. @return {Iterator.}
findLinksOutOf([String? pid]) → Iterator<Link>: Available on Node, provided by the Node$Typings extension
Returns an iterator over all of the Links that come out of this node, perhaps limited to the given port id on this node. @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. @return {Iterator.}
findLinksTo(Node othernode, [String? pid, String? otherpid]) → Iterator<Link>: Available on Node, provided by the Node$Typings extension
Returns an iterator over all of the Links that go from this node to another node, perhaps limited to a given port id on this node and a port id on the other node.
findMainElement() → GraphObject?: Available on Panel, provided by the Panel$Typings extension
Return an immediate child element whose GraphObject#isPanelMain is true, or else just return the first child element. @return {GraphObject} this may return null if there are no child elements @since 1.5
findNodesConnected([String? pid]) → Iterator<Node>: Available on Node, provided by the Node$Typings extension
Returns an iterator over the Nodes that are connected with this node in either direction, perhaps limited to the given port id on this node.
findNodesInto([String? pid]) → Iterator<Node>: Available on Node, provided by the Node$Typings extension
Returns an iterator over the Nodes that are connected with this node by links going into this node, perhaps limited to the given port id on this node. @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. @return {Iterator.
findNodesOutOf([String? pid]) → Iterator<Node>: Available on Node, provided by the Node$Typings extension
Returns an iterator over the Nodes that are connected with this node by links coming out of this node, perhaps limited to the given port id on this node. @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. @return {Iterator.
findObject(String name) → GraphObject?: Available on Panel, provided by the Panel$Typings extension
Search the visual tree starting at this Panel for a GraphObject whose GraphObject#name is the given name.
findPort(String pid) → GraphObject: Available on Node, provided by the Node$Typings extension
Find a GraphObject with a given GraphObject#portId. If no such GraphObject is found, search for one with the empty string as its port identifier. Finally, when failing to find a port with either the given name or the empty string, this method returns this whole node itself. @param {string} pid @return {GraphObject}
findRowForLocalY(num y) → num: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Returns the row at a given y-coordinate in local coordinates, or -1 if there are no RowColumnDefinitions for this Table Panel or if the argument is negative. Call GraphObject#getLocalPoint to convert a Point in document coordinates into a Point in local coordinates.
findSubGraphLevel() → num: Available on Part, provided by the Part$Typings extension
Return how deep this part is in the hierarchy of nested Groups. For parts that have no #containingGroup this returns zero.
findSubGraphParts() → Set<Part>: Available on Group, provided by the Group$Typings extension
Return a collection of Parts that are all of the nodes and links that are members of this group, including inside nested groups and label nodes, but excluding this group itself.
findTemplateBinder() → Panel?: Available on GraphObject, provided by the GraphObject$Typings extension
(undocumented) This never-documented method has been renamed #findBindingPanel for v2.2 and will be removed in v3.0. @return {Panel}
findTopLevelPart() → Part: Available on Part, provided by the Part$Typings extension
Gets the top-level Part for this part, which is itself when #isTopLevel is true. If this Part is a member of a Group, this returns the top-level Part for that Group. If this is a Node that is a label node for a labeled Link, this returns the top-level Part for that Link.
findTreeChildrenLinks() → Iterator<Link>: Available on Node, provided by the Node$Typings extension
Returns an Iterator for the collection of Links that connect with the immediate tree children of this node. Links for which Link#isTreeLink is false are ignored.
findTreeChildrenNodes() → Iterator<Node>: Available on Node, provided by the Node$Typings extension
Returns an Iterator for the collection of Nodes that are the immediate tree children of this node. Nodes only connected by links for which Link#isTreeLink is false are ignored.
findTreeLevel() → num: Available on Node, provided by the Node$Typings extension
Return how deep this node is in a tree structure. For tree root nodes, this returns zero. This calls #findTreeParentNode to find any tree parent node, so this respects Diagram#isTreePathToChildren and Link#isTreeLink to know which way to traverse links and to know to ignore non-tree links.
findTreeParentChain() → Set<Part>: Available on Node, provided by the Node$Typings extension
Return a collection of Parts including this Node, its tree parent link and node, and so on up the chain to the root node.
findTreeParentLink() → Link?: Available on Node, provided by the Node$Typings extension
Returns the Link that connects with the tree parent Node of this node if the graph is tree-structured, if there is such a link and Link#isTreeLink is true. @return {Link} The Link to the parent Node, or null if there is no parent node. @see #findTreeParentNode @see #findTreeChildrenLinks @see Diagram#isTreePathToChildren @see #findTreeRoot @see #findTreeParentChain @since 1.1
findTreeParentNode() → Node?: Available on Node, provided by the Node$Typings extension
Returns the Node that is the tree parent of this node if the graph is tree-structured, if there is a parent. Links for which Link#isTreeLink is false are ignored. @return {Node} The parent Node, or null if there is no parent node. @see #findTreeParentLink @see #findTreeChildrenNodes @see Diagram#isTreePathToChildren @see #findTreeRoot @see #findTreeParentChain @since 1.1
findTreeParts([num? level]) → Set<Part>: Available on Node, provided by the Node$Typings extension
Return a collection of Parts including this Node, all of the Links going to child Nodes, and all of their tree child nodes and links. Links for which Link#isTreeLink is false are ignored.
findTreeRoot() → Node: Available on Node, provided by the Node$Typings extension
Return the Node that is at the root of the tree that this node is in, perhaps this node itself.
findVisibleNode() → Node?: Available on Node, provided by the Node$Typings extension
Starting with this node, walk up the chain of containingGroups to find a node that is visible. This can be overridden to find a tree-parent/ancestor if the reason that this node is not visible is because of a collapsed tree rather than a collapsed group. @expose @since 2.2 @return {Node}
getAvoidableRect(Rect result) → Rect: Available on Node, provided by the Node$Typings extension
Return the area to be avoided for this node -- the node's GraphObject#actualBounds plus the Node#avoidableMargin. @expose @param {Rect} result a Rect to be modified and returned. @return {Rect} the area in document coordinates. @since 2.2
getColumnDefinition(num idx) → RowColumnDefinition: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets the RowColumnDefinition for a particular column. If you ask for the definition of a column at or beyond the #columnCount, it will automatically create one and return it.
getDocumentAngle() → num: Available on GraphObject, provided by the GraphObject$Typings extension
Returns the effective angle that the object is drawn at, in document coordinates, normalized to between 0 and 360.
getDocumentBounds([Rect? result]) → Rect: Available on GraphObject, provided by the GraphObject$Typings extension
Returns the Rect in document coordinates for this object's bounds. If this GraphObject is a Part, the rect will be identical to its #actualBounds. @param {Rect=} result an optional Rect that is modified and returned. @return {Rect} in document coordinates. @see #getDocumentPoint @since 2.0
getDocumentBounds([Rect? result]) → Rect: Available on Part, provided by the Part$Typings extension
Returns the Rect in document coordinates for this object's bounds. If this GraphObject is a Part, the rect will be identical to its #actualBounds. @param {Rect=} result an optional Rect that is modified and returned. @return {Rect} in document coordinates. @see #getDocumentPoint @since 2.0
getDocumentPoint(Object local, [Point? result]) → Point: Available on GraphObject, provided by the GraphObject$Typings extension
Returns the Point in document coordinates for a given Spot in this object's bounds or for a Point in local coordinates.
getDocumentScale() → num: Available on GraphObject, provided by the GraphObject$Typings extension
Returns the total scale that the object is drawn at, in document coordinates.
getLocalPoint(Point p, [Point? result]) → Point: Available on GraphObject, provided by the GraphObject$Typings extension
Given a Point in document coordinates, returns a new Point in local coordinates.
getRowDefinition(num idx) → RowColumnDefinition: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Gets the RowColumnDefinition for a particular row. If you ask for the definition of a row at or beyond the #rowCount, it will automatically create one and return it.
graduatedPointForValue(num val, [Point? result]) → Point: Available on Panel, provided by the Panel$Typings extension
For Panel.Graduated|Graduated Panels: Returns the point that corresponds with a value, in the panel's coordinates.
graduatedValueForPoint(Point pt) → num: Available on Panel, provided by the Panel$Typings extension
For Panel.Graduated|Graduated Panels: Returns the value that corresponds with the given Point. The Point must be in the panel's coordinates. The value returned will be in the Graduated Panel's range.
insertAt(num index, GraphObject element) → void: Available on Panel, provided by the Panel$Typings extension
Adds a GraphObject to the Panel's list of elements at the specified index.
invalidateAdornments() → void: Available on Part, provided by the Part$Typings extension
(undocumented)
invalidateConnectedLinks([Set<Part>? ignore]) → void: Available on Node, provided by the Node$Typings extension
(undocumented) This invalidates the routes of all links connected to this node. Basically this calls Link#invalidateRoute on all connected links and invalidates any cached side-connection information. @param {Set.
invalidateLayout([num? condition]) → void: Available on Part, provided by the Part$Typings extension
Invalidate the Layout that is responsible for positioning this Part. If this part is in a Group, invalidate its Group#layout, if it has one. Otherwise invalidate the Diagram#layout.
invalidateLinkBundle(Node other, [String? thisportid, String? otherportid]) → void: Available on Node, provided by the Node$Typings extension
(undocumented) @param {Node} other @param {string=} thisportid @param {string=} otherportid
isContainedBy(GraphObject panel) → bool: Available on GraphObject, provided by the GraphObject$Typings extension
This predicate is true if this object is an element, perhaps indirectly, of the given panel.
isEnabledObject() → bool: Available on GraphObject, provided by the GraphObject$Typings extension
This predicate is false if this object is inside any Panel that is not Panel#isEnabled, or if this is itself a disabled panel. This ignores the #visible and #pickable properties. @return {boolean} @see #enabledChanged @see Panel#isEnabled @since 1.7
isInTreeOf(Node node) → bool: Available on Node, provided by the Node$Typings extension
This predicate is true if this node is a child of the given Node, perhaps indirectly as a descendant.
isMemberOf(Part part) → bool: Available on Part, provided by the Part$Typings extension
This predicate is true if this part is a member of the given Part, perhaps indirectly.
isVisible() → bool: Available on Part, provided by the Part$Typings extension
This predicate is true if this Part can be seen. Parts that can be seen can be manipulated by the user, can take space in the document, or can take part in a layout, among many possibilities. Note that the value of this predicate can often be false even while GraphObject#visible is true.
isVisibleObject() → bool: Available on GraphObject, provided by the GraphObject$Typings extension
This predicate is true if this object is #visible and each of its visual containing panels is also visible. This ignores the actual location or appearance (except visibility) of the panel that this object is part of, as well as ignoring all properties of the Layer or Diagram.
move(Point newpos, [bool? useLocation]) → void: Available on Group, provided by the Group$Typings extension
Move this Group and all of its member parts, recursively.
move(Point newpos, [bool? useLocation]) → void: Available on Part, provided by the Part$Typings extension
Move this part and any parts that are owned by this part to a new position.
moveTo(num newx, num newy, [bool? useLocation]) → void: Available on Part, provided by the Part$Typings extension
Move this part and any parts that are owned by this part to a new position. This just calls #move without the caller having to allocate a new Point. @param {number} newx a new X value in document coordinates. @param {number} newy a new Y value in document coordinates. @param {boolean=} useLocation true if you want to set the #location instead of the position. False by default. @since 1.4
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
rebuildItemElements() → void: Available on Panel, provided by the Panel$Typings extension
Create and add new GraphObjects corresponding to and bound to the data in the #itemArray, after removing all existing elements from this Panel. This method is automatically called when replacing the #itemArray value, or when changing the value of #itemTemplate or #itemTemplateMap.
remove(GraphObject element) → void: Available on Panel, provided by the Panel$Typings extension
Removes a GraphObject from this Panel's list of elements. @param {GraphObject} element A GraphObject.
removeAdornment(String category) → void: Available on Part, provided by the Part$Typings extension
Remove any Adornment of the given category that may be associated with this Part. @param {string} category a string identifying the kind or role of the given adornment for this Part.
removeAt(num idx) → void: Available on Panel, provided by the Panel$Typings extension
Removes an GraphObject from this Panel's list of elements at the specified index. @param {number} idx
removeColumnDefinition(num idx) → void: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Removes the RowColumnDefinition for a particular row.
removeRowDefinition(num idx) → void: Available on Panel, provided by the Panel$Typings extension
For Panel.Table|Table Panels: Removes the RowColumnDefinition for a particular row.
set(dynamic config) → GraphObject: Available on GraphObject, provided by the GraphObject$Typings extension
Set any number of properties on this GraphObject. This is common in initialization. This method can only be used to set existing properties on this object. To attach new properties, or to set properties of elements, use GraphObject#setProperties.
setProperties(Object props) → GraphObject: Available on GraphObject, provided by the GraphObject$Typings extension
This method sets a collection of properties according to the property/value pairs on the given Object, in the same manner as GraphObject.make does when constructing a GraphObject with an argument that is a simple JavaScript Object.
toString() → String: A string representation of this object.
inherited
trigger(AnimationTrigger trigger) → GraphObject: Available on GraphObject, provided by the GraphObject$Typings extension
Adds an AnimationTrigger to this GraphObject. @since 2.2 @param {AnimationTrigger} trigger an AnimationTrigger @return {Panel}
updateAdornments() → void: Available on Part, provided by the Part$Typings extension
This is responsible for creating any selection Adornment (if this Part #isSelected) and any tool adornments for this part. @expose
updateRelationshipsFromData() → void: Available on Part, provided by the Part$Typings extension
Update all of the references to nodes in case they had been modified in the model without properly notifying the model by calling GraphLinksModel#setGroupKeyForNodeData or GraphLinksModel#setToKeyForLinkData or other similar methods. This method does not conduct a transaction, so you need to start and commit one yourself.
updateTargetBindings([String? srcprop]) → void: Available on Part, provided by the Part$Typings extension
Re-evaluate all data bindings in this Part, in order to assign new property values to the GraphObjects in this visual tree based on this this object's #data property values. This method does nothing if #data is null.
updateTargetBindings([String? srcprop]) → void: Available on Panel, provided by the Panel$Typings extension
Re-evaluate all data bindings on this panel, in order to assign new property values to the GraphObjects in this visual tree based on this object's #data property values.

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Group class

Constructors

Properties

Methods

Operators

typings.gojs library