workspaceGraphLayout

This reference describes the full structure of workspaceGraphLayout. Paths include nested objects, list items and conditional branches. A branch selected by kind, contract or mode only admits its own properties.

Structure and values

Field	Options / expected values	Description
[algorithm=box].algorithm	"box"	Required. Graph layout algorithm; its parameters depend on this value.
[algorithm=box].nodeSpacing	number; ≥ 1; ≤ 1000	Required. Defines node Spacing for this object. Observe the type, variants and bounds in the Options column.
[algorithm=box].aspectRatio	number; ≥ 0.1; ≤ 10	Required. Defines aspect Ratio for this object. Observe the type, variants and bounds in the Options column.
[algorithm=disco].algorithm	"disco"	Required. Graph layout algorithm; its parameters depend on this value.
[algorithm=disco].componentSpacing	number; ≥ 1; ≤ 1000	Required. Defines component Spacing for this object. Observe the type, variants and bounds in the Options column.
[algorithm=disco].aspectRatio	number; ≥ 0.1; ≤ 10	Required. Defines aspect Ratio for this object. Observe the type, variants and bounds in the Options column.
[algorithm=disco].componentLayout	"force" | "stress" | "layered"	Required. Defines component Layout for this object. Observe the type, variants and bounds in the Options column.
[algorithm=force].algorithm	"force"	Required. Graph layout algorithm; its parameters depend on this value.
[algorithm=force].nodeSpacing	number; ≥ 1; ≤ 1000	Required. Defines node Spacing for this object. Observe the type, variants and bounds in the Options column.
[algorithm=force].aspectRatio	number; ≥ 0.1; ≤ 10	Required. Defines aspect Ratio for this object. Observe the type, variants and bounds in the Options column.
[algorithm=force].seed	integer; ≥ 1; ≤ 2147483647	Required. Provisions initial content rather than only declaring an instance type.
[algorithm=layered].algorithm	"layered"	Required. Graph layout algorithm; its parameters depend on this value.
[algorithm=layered].nodeSpacing	number; ≥ 1; ≤ 1000	Required. Defines node Spacing for this object. Observe the type, variants and bounds in the Options column.
[algorithm=layered].componentSpacing	number; ≥ 1; ≤ 1000	Required. Defines component Spacing for this object. Observe the type, variants and bounds in the Options column.
[algorithm=layered].layerSpacing	number; ≥ 1; ≤ 1000	Required. Defines layer Spacing for this object. Observe the type, variants and bounds in the Options column.
[algorithm=layered].direction	"UP" | "DOWN" | "LEFT" | "RIGHT"	Required. Traversal or presentation direction using this contract’s closed values.
[algorithm=layered].seed	integer; ≥ 1; ≤ 2147483647	Required. Provisions initial content rather than only declaring an instance type.
[algorithm=mrtree].algorithm	"mrtree"	Required. Graph layout algorithm; its parameters depend on this value.
[algorithm=mrtree].nodeSpacing	number; ≥ 1; ≤ 1000	Required. Defines node Spacing for this object. Observe the type, variants and bounds in the Options column.
[algorithm=mrtree].direction	"UP" | "DOWN" | "LEFT" | "RIGHT"	Required. Traversal or presentation direction using this contract’s closed values.
[algorithm=mrtree].aspectRatio	number; ≥ 0.1; ≤ 10	Required. Defines aspect Ratio for this object. Observe the type, variants and bounds in the Options column.
[algorithm=random].algorithm	"random"	Required. Graph layout algorithm; its parameters depend on this value.
[algorithm=random].nodeSpacing	number; ≥ 1; ≤ 1000	Required. Defines node Spacing for this object. Observe the type, variants and bounds in the Options column.
[algorithm=random].aspectRatio	number; ≥ 0.1; ≤ 10	Required. Defines aspect Ratio for this object. Observe the type, variants and bounds in the Options column.
[algorithm=random].seed	integer; ≥ 1; ≤ 2147483647	Required. Provisions initial content rather than only declaring an instance type.
[algorithm=stress].algorithm	"stress"	Required. Graph layout algorithm; its parameters depend on this value.
[algorithm=stress].desiredEdgeLength	number; ≥ 1; ≤ 1000	Required. Defines desired Edge Length for this object. Observe the type, variants and bounds in the Options column.
[algorithm=stress].iterationLimit	integer; ≥ 1; ≤ 1000	Required. Defines iteration Limit for this object. Observe the type, variants and bounds in the Options column.

Reading the contract

A path ending in [] describes each list item; {key} describes each dictionary value. The ↻ marker refers to the same recursive expression. Closed objects reject additional properties. Semantic validation denotes an additional check: matching a type does not make a reference, permission or transition valid. References must resolve in the Model and the current user context.

An older variant cannot accept properties belonging to a newer variant. The compiler checks the version and consistency of the complete Model.

Structural example

This fragment passes the schema for this section. Its business references must be defined in the enclosing Model.

{
  "algorithm": "layered",
  "nodeSpacing": 40,
  "componentSpacing": 80,
  "layerSpacing": 90,
  "direction": "RIGHT",
  "seed": 1
}

Related references

Complete Model index · Build a Model

Applied examples : Explore the client and its relations

Two visual arrangements present the same linked objects without changing their data.

Configuration

Contract object workspaceGraphLayout. Properties and accepted values.

{
  "algorithm": "layered",
  "nodeSpacing": 48,
  "componentSpacing": 64,
  "layerSpacing": 80,
  "direction": "RIGHT",
  "seed": 1
}

Variation and connection

Fragment placed in graphPresentations[].profiles[].layout. Properties and accepted values.

{
  "algorithm": "mrtree",
  "nodeSpacing": 56,
  "direction": "DOWN",
  "aspectRatio": 1.5
}

UI layout example

The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.

1. North Studio
2. Quote S-1042
3. Preparation
4. Sources

SurfaceClients / North StudioExample

workspaceGraphLayoutworkspaceGraphLayout

Clients

MODEL CONTEXTNorth StudioDeclarative configuration

algorithm

layered

nodeSpacing

48

componentSpacing

64

layerSpacing

80

direction

RIGHT

Values above follow the configuration fragment; references resolve in the complete Model.