Apply Layout

gdbVersion

The name of the geodatabase version.

Syntax: gdbVersion=<version>

Example: gdbVersion=ABV1

sessionId

The token (guid) used to lock the version.

Syntax: sessionId=<guid>

Example: sessionId=44G259DE-87B0-407D-8F2E-DCB7665DD0F0

layoutName

(Required)

The name of the algorithm layout to apply (string). The parameter accepts the following values:

• AngleDirectedDiagramLayout: Moves a diagram's edges in specified alignment directions. For more information see the AngleDirectedDiagramLayout property set object documentation or the Apply Angle Directed Layout tool documentation.
• CompressionDiagramLayout: Compresses the diagram features toward the middle of the diagram. For more information see the CompressionDiagramLayout property set object documentation or the Apply Compression Layout tool documentation.
• ForceDirectedDiagramLayout: Emphasizes loops contained in a network diagram. For more information see the ForceDirectedDiagramLayout property set object documentation or the Apply Force Directed Layout tool documentation.
• GeoPositionsDiagramLayout: Moves each diagram junction and edge feature so they match the geographical positions of the associated network features. For more information see the GeoPositionsDiagramLayout property set object documentation or the Apply Geo Positions Layout tool documentation.
• GridDiagramLayout: Positions diagram junctions relative to a predefined magnetic grid. For more information see the GridDiagramLayout property set object documentation or the Apply Grid Layout tool documentation.
• LinearDispatchDiagramLayout: Adds space between diagram junctions that are visually too close, overlapping, or coincident. For more information see the LinearDispatchDiagramLayout property set object documentation or the Apply Linear Dispatch Layout tool documentation.
• MainLineTreeDiagramLayout: Arranges diagram junctions and edges hierarchically along a main line. For more information see the MainLineTreeDiagramLayout property set object documentation or the Apply Mainline Tree Layout tool documentation.
• MainRingDiagramLayout: Arranges the diagram features in a network diagram around a main ring. For more information see the MainRingDiagramLayout property set object documentation or the Apply Main Ring Layout tool documentation.
• PartialOverlappingEdgesDiagramLayout: Spaces out collinear edges or collinear portions of edges (edge segments) inside a given buffer zone. For more information see the PartialOverlappingEdgesDiagramLayout property set object documentation or the Apply Partial Overlapping Edges Layout tool documentation.
• RadialTreeDiagramLayout: Arranges diagram features hierarchically and places them in a radial tree. For more information see the RadialTreeDiagramLayout property set object documentation or the Apply Radial Tree Layout tool documentation.
• RelativeMainlineDiagramLayout: Arranges the network diagram features in the active diagram along parallel straight lines. For more information see the RelativeMainlineDiagramLayout property set object documentation or the Apply Relative Mainline Layout tool documentation.
• ReshapeEdgesDiagramLayout: Processes simple operations on vertices along edges. For more information see the ReshapeEdgesDiagramLayout property set object documentation or the Reshape Diagram Edges Layout tool documentation.
• RotateTreeDiagramLayout: Rotates the tree or trees related to pivot junctions currently set up in a diagram to the specified angle. For more information see the RotateTreeDiagramLayout property set object documentation or the Apply Rotate Tree Layout tool documentation.
• SeparateOverlappingEdgesDiagramLayout: Separates edges that connect the same origin and extremity junctions when they are overlapping. For more information see the SeparateOverlappingEdgesDiagramLayout property set object documentation.
• SmartTreeDiagramLayout: Arranges diagram features hierarchically and places them in a smart tree. For more information see the SmartTreeDiagramLayout property set object documentation or the Apply Smart Tree Layout tool documentation.
• SpatialDispatchDiagramLayout: Separates diagram junctions that are visibly close to overlapping. For more information see the SpatialDispatchDiagramLayout property set object documentation or the Apply Spatial Dispatch Layout tool documentation.

Example: layoutName = ForceDirectedDiagramLayout

layoutParams

The algorithm layout parameters property set.

There is a specific property set JSON object for each diagram layout parameters

Syntax:

1
2
3
4
layoutParams = {
 "type": "PropertySet",
 "propertySetItems": ["algoParamName1", <algoParamValue1>, …, "algoParamNameN",<algoParamValueN>]
}

Example:

Sample of parameter property set when layoutName = ForceDirectedDiagramLayout

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
layoutParams = {
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "iterations_number",
    20,
    "repel_factor",
    1,
    "degree_freedom",
    1
   ]
  }

junctionObjectIDs

For the case you want the layout algorithm to apply to a diagram part, a list of junction ObjectIDs (long) that will be processed:

Syntax: junctionObjectIDs=[<DiagJctOid1>, …, <DiagJctOidN]

Example: junctionObjectIDs=[1,2,3,4,5]

containerObjectIDs

For the case you want the layout algorithm to apply to a diagram part, a list of container ObjectIDs (long) that will be processed:

Syntax: containerObjectIDs=[<DiagConOid1>, …, <DiagConOidN]

Example: containerObjectIDs=[1]

edgeObjectIDs

For the case you want the layout algorithm to apply to a diagram part, a list of edge ObjectIDs (long) that will be processed:

Syntax: edgeObjectIDs=[<DiagEdgOid1>, …, <DiagEdgOidN]

Example: edgeObjectIDs=[1,2,3]

async

A boolean statement that specifies whether the layout algorithm will run synchronously or asynchronously.

• false—The layout algorithm will run synchronously and can fail if the process completion exceeds the service timeout—600 seconds by default. This is the default.
• true—The layout algorithm will run asynchronously. This option dedicates server resources to run the layout algorithm with a longer time-out. Running asynchronously can be interesting when applying layout that are time consuming—for example, Partial Overlapping Edges—and applying to large diagrams—more than 25,000 features.

Syntax: async=<true | false>

Example: async=true

f

The response format. The default response format is html.

Values: <html | json>