Skip to main content

Add Spatial Dispatch Layout (Network Diagram Tools)

Summary

Adds the Spatial Dispatch Layout algorithm to the list of layouts to be automatically chained at the end of the building of diagrams based on a given template. This tool also presets the Spatial Dispatch Layout algorithm parameters for any diagram based on that template.

This layout algorithm progressively separates diagram junctions that are visibly close to overlapping according to their current positions and to the shift factor specified.

Learn more about the Spatial Dispatch layout algorithm

Caution:

This tool is a configuration and administration tool.

Note:

This tool impacts the consistency of any existing diagrams based on the input diagram template. All of the existing diagrams become inconsistent and open with a consistency warning icon until they are updated.

Usage

  • This tool is not supported when working with a utility network or trace network service. You must use either a utility network or trace network in a file or mobile geodatabase, or a database connection to a utility network or trace network in an enterprise geodatabase. When working with an enterprise geodatabase, the following are requirements:

  • To preset the layout algorithm parameters for a diagram based on the diagram template, uncheck the Active parameter (is_active = "INACTIVE" in Python).

  • Run the tool with Active checked (is_active = "ACTIVE" in Python) if you want the layout algorithm to be added to the list of layouts that will be automatically chained at the end of diagram generation based on the input diagram template.

Parameters

Label Explanation Data type

Input Network

The utility network or trace network containing the diagram template that will be modified.

Utility Network; Trace Network

Input Diagram Template

The name of the diagram template that will be modified.

String

Active

Specifies whether the layout algorithm will automatically run when generating diagrams based on the specified template.

  • Checked—The added layout algorithm will automatically run during the generation of any diagram based on the input template. This is the default. The parameter values specified for the layout algorithm are used to run the layout during diagram generation. They are also loaded by default when the algorithm is to be run on any diagram based on the input template.

  • Unchecked—All the parameter values currently specified for the added layout algorithm will be loaded by default when the algorithm is to be run on any diagram based on the input template.

Boolean

Preserve container layout

(Optional)

Specifies how the layout algorithm will process containers.

  • Checked—The layout algorithm will apply to the top graph of the diagram so container layouts are preserved.

  • Unchecked—The layout algorithm will apply to both content and noncontent features in the diagram. This is the default.

Boolean

Number of Iterations

(Optional)

The number of iterations to process. The default is 5.

Long

Maximum Shift Factor

(Optional)

The maximum value used to increase the diagram junctions' displacement for junctions that are very close together. The greater the shift factor, the larger the separation between the diagram junctions that almost overlap. The default is 2.

Double

Derived output

Label Explanation Data type

Output Network

The updated utility network or trace network.

Utility Network; Trace Network

Output Diagram Template

The name of the diagram template.

String

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: No
  • Standard: Yes
  • Advanced: Yes