DiagramGroupMapping

A group mapping in a Diagram. Intended for advanced use cases where you need fine-grained controls over groups, and the config options available in cells are not granular enough.

Name	Type	Description
allowLoopback?	boolean	Whether or not to allow edges from this vertex back to itself. Defaults to true. This flag will not prevent an edge from a port back to the node/group to which it belongs - for that, see allowVertexLoopback.
allowVertexLoopback?	boolean	Whether or not to allow edges from a port back to the vertex it belongs to. Defaults to true.
anchor?	AnchorSpec	Spec for the anchor to use for connections to children of the group when they are transferred to the group in its collapsed state.
anchorPositionFinder?	AnchorPositionFinder<any>	Optional function to call on connection drop, to determine the location for the target anchor for the new connection. Returning null from this indicates no preference, and VisuallyJs will use its own computed value.
anchorPositions?	Array<ObjectAnchorSpec>	Optional array of anchor positions to use.
autoGrow?	boolean	Defaults to false, meaning that the group will not be resized if an item addition/removal or drag causes the bounds of the child members to change and the new size is greater than the previous size.
autoShrink?	boolean	False by default. If true indicates that if a child member is dragged/added/removed and the group's size is recalculated to be smaller than the previous size, the new size should be applied. This also works if the group needs to shrink from its left and/or top edge. If you don't want that behaviour, set allowShrinkFromOrigin to false.
autoSize?	boolean	False by default. This flag switches on both autoShrink and autoGrow and also enables support for shrinking a group from its left or top edge
canDrop?	(v:Node | Group) => boolean	Optional interceptor that will be invoked to test whether a given node/group may be dropped onto this group.
collapsedSize?	Size	The size to use for this group type when it is collapsed.
constrain?	boolean	False by default - nodes/groups may be dragged outside of the bounds of the group.
defaultSize?	Size	Optional default size to use for the vertex. This is not used to set the size in the DOM for a vertex - it is used to insert width and height values into the backing data for any vertex of this type that does not have them set.
edgeType?	string	Type to assign to edges connected to this vertex as a source.
elastic?	boolean	Similar to autoGrow, but the UI shows a visual prompt when a group will be resized as a result of dragging a child.
elementsDraggable?	boolean	True by default - indicates that child members may be dragged around inside the group.
events?	GroupEventOptions<EL>	Optional map of event bindings.
fitToGrid?	boolean	When sizing the group, ensure it fits the underlying grid, if there is one.
layout?	{   options:LayoutParameters,   type:string }	Options for the group's layout.
locked?	boolean	Whether or not the group is locked.
maxConnections?	number	Maximum number of connections this vertex supports. Default is 1. A value of -1 means no limit.
maxSize?	Size	Maximum size the group can grow to. If not specified the group can grow to an arbitrary size. Note that this behaviour can also be enforced via CSS.
mergeStrategy?	string	When merging a type description into its parent(s), values in the child for connector, anchor and anchors will always overwrite any such values in the parent. But other values, such as overlays, will be merged with their parent's entry for that key. You can force a child's type to override every corresponding value in its parent by setting mergeStrategy:'override'.
minSize?	Size	Minimum size the group can be.
padding?	number	Optional padding to set inside a group when computing an auto size.
parameters?	Record<string,any>	A map of parameters that the template engine will merge with the backing data when rendering the vertex.
parent?	string | Array<string>	Optional ID of one or more edge definitions to include in this definition. The child definition is merged on top of the parent definition(s). Circular references are not allowed and will throw an error.
templateIdResolver?	(data:ObjectData, ui:UICore<BrowserElement>, model:VisuallyJsModel, object:Vertex) => string	A function that can resolve the ID of the template to use for the given vertex. This is an advanced configuration that is not often needed, and is only for 'vanilla' VisuallyJs. This function will take precedence over both template and templateId.