Add Linear Dispatch Layout (Network Diagram Tools)

Summary

Adds the Linear 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 Linear Dispatch Layout algorithm parameters for any diagram based on that template.

This layout algorithm adds space between diagram junctions that are visually too close, overlapping, or coincident. It moves junctions along their connected edges. The movement along the edges depends on the current and relative position of junctions and on the layout parameters.

Learn more about the Linear 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:
- The Input Network parameter value must be from a database connection established as the database utility network owner or database trace network owner.
- The connected ArcGIS Enterprise portal account must be the portal utility network owner or portal trace network owner.
- This tool must be connected to the default version, which is expected to be public and not protected.
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.

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
Junctions Placement (Optional)	Specifies how the junctions will be moved. Equal distance—All junctions with two connected edges will be moved so the distances between them and their two connected junctions are equal. This is the default. User defined distance—All junctions with two connected edges will be moved so there is a minimum distance (the Minimum Shift parameter value) between them and the other end of the edges to which they connect. This occurs at the end of the layout algorithm process. Iterative distance—All junctions with two connected edges will be moved slightly according to the Number of Iterations and Maximum Shift parameter values.	String
Spacing values interpreted as absolute units in the diagram coordinate system (Optional)	Specifies how parameters representing distances will be interpreted. Checked—The layout algorithm will interpret distance values as linear units. Unchecked—The layout algorithm will interpret distance values as relative units to an estimation of the average of the junction sizes in the current diagram extent. This is the default.	Boolean
Maximum Shift (Optional)	The maximum distance the junctions with two connections will be spaced from the junctions to which they connect. The default is 2 in the units of the diagram's coordinate system. At the time this distance is reached, junctions will not be moved during additional iterations. This parameter can only be used with the Iterative distance junction placement type and absolute units.	Linear Unit
Maximum Shift (Optional)	The maximum distance the junctions with two connections will be spaced from the junctions to which they connect. The default is 2. At the time this distance is reached, junctions will not be moved during additional iterations. This parameter can only be used with the Iterative distance junction placement type and proportional units.	Double
Minimum Shift (Optional)	The minimum distance that will separate each junction with two connected edges from its two edge extremities after the layout algorithm runs. The default is 2 in the units of the diagram's coordinate system. When this parameter value is too large, the junctions with two connections are moved so the distances between each moved junction and its edge extremities are equal along the path defined by its two connected edges. This parameter can only be used with the User define distance junction placement type and absolute units.	Linear Unit
Minimum Shift (Optional)	The minimum distance that will separate each junction with two connected edges from its two edge extremities after the layout algorithm runs. The default is 2. When this parameter value is too large, the junctions with two connections are moved so the distances between each moved junction and its edge extremities are equal along the path defined by its two connected edges. This parameter is used with the User defined distance junction placement type and proportional units.	Double
Number of Iterations (Optional)	The number of iterations that will be processed. The default is 5. This parameter can only be used with the Iterative distance junction placement type.	Long
Preserve path (Optional)	Specifies how vertices along edges will be processed. Checked—All vertices along the connected edges will be preserved, and new vertices will be added at the moved junctions' original locations. This is the default. Unchecked—Vertices along edges will not be preserved.	Boolean
Move leaves (Optional)	Specifies whether leaf junctions—junctions with one connection—will be moved during the layout algorithm process. Checked—Leaf junctions will be moved. Unchecked—Leaf junctions will not be moved. This is the default unless the specified input network diagram is based on a template for which the Linear Dispatch Layout algorithm has been configured with another parameter value.	Boolean
Expand leaves (Optional)	Specifies whether leaf junctions will be expanded: Checked—Leaf junctions will be expanded. The Maximum Expand Shift parameter value specifies the maximum distance the leaf junctions can be expanded from the junctions to which they connect. Unchecked—Leaf junctions will not be expanded. This is the default unless the specified input network diagram is based on a template for which the Linear Dispatch Layout algorithm has been configured with another parameter value.	Boolean
Maximum Expand Shift (Optional)	The maximum distance leaf junctions will be expanded from the junctions to which they connect. The default is 2 in the units of the diagram's coordinate system unless the specified input network diagram is based on a template for which the Linear Dispatch Layout algorithm has been configured with another parameter value. At the time this distance is reached, leaf junctions will not be moved during additional iterations. This parameter can only be used with the Expand leaves parameter and absolute units.	Linear Unit
Maximum Expand Shift (Optional)	The maximum distance the leaf junctions will be expanded from the junctions to which they connect. The default is 2 unless the specified input network diagram is based on a template for which the Linear Dispatch Layout algorithm has been configured with another parameter value. At the time this distance is reached, leaf junctions will not be moved during additional iterations. This parameter can only be used with the Expand leaves parameter and proportional units.	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

arcpy.nd.AddLinearDispatchLayout(in_utility_network, template_name, is_active, {junction_placement_type}, {is_unit_absolute}, {maximum_shift_absolute}, {maximum_shift_proportional}, {minimum_shift_absolute}, {minimum_shift_proportional}, {iterations_number}, {is_path_preserved}, {are_leaves_moved}, {are_leaves_expanded}, {expand_shift_absolute}, {expand_shift_proportional})

Name	Explanation	Data type
in_utility_network	The utility network or trace network containing the diagram template that will be modified.	Utility Network; Trace Network
template_name	The name of the diagram template that will be modified.	String
is_active	Specifies whether the layout algorithm will automatically run when generating diagrams based on the specified template. `ACTIVE`—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. `INACTIVE`—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
junction_placement_type (Optional)	Specifies how the junctions will be moved. `EQUAL_DISTANCE`—All junctions with two connected edges will be moved so the distances between them and their two connected junctions are equal. This is the default. `USER_DEFINE_DISTANCE`—All junctions with two connected edges will be moved so there is a minimum distance (the `minimum_shift_` parameter value) between them and the other end of the edges to which they connect. This occurs at the end of the layout algorithm process. `ITERATIVE_DISTANCE`—All junctions with two connected edges will be moved slightly according to the `iterations_number` and `maximum_shift_` parameter values.	String
is_unit_absolute (Optional)	Specifies how parameters representing distances will be interpreted. `ABSOLUTE_UNIT`—The layout algorithm will interpret distance values as linear units. `PROPORTIONAL_UNIT`—The layout algorithm will interpret distance values as relative units to an estimation of the average of the junction sizes in the current diagram extent. This is the default.	Boolean
maximum_shift_absolute (Optional)	The maximum distance the junctions with two connections will be spaced from the junctions to which they connect. The default is 2 in the units of the diagram's coordinate system. At the time this distance is reached, junctions will not be moved during additional iterations. This parameter can only be used with the `ITERATIVE_DISTANCE` junction placement type and absolute units.	Linear Unit
maximum_shift_proportional (Optional)	The maximum distance the junctions with two connections will be spaced from the junctions to which they connect. The default is 2. At the time this distance is reached, junctions will not be moved during additional iterations. This parameter can only be used with the `ITERATIVE_DISTANCE` junction placement type and proportional units.	Double
minimum_shift_absolute (Optional)	The minimum distance that will separate each junction with two connected edges from its two edge extremities after the layout algorithm runs. The default is 2 in the units of the diagram's coordinate system. When this parameter value is too large, the junctions with two connections are moved so the distances between each moved junction and its edge extremities are equal along the path defined by its two connected edges. This parameter can only be used with the `USER_DEFINE_DISTANCE` junction placement type and absolute units.	Linear Unit
minimum_shift_proportional (Optional)	The minimum distance that will separate each junction with two connected edges from its two edge extremities after the layout algorithm runs. The default is 2. When this parameter value is too large, the junctions with two connections are moved so the distances between each moved junction and its edge extremities are equal along the path defined by its two connected edges. This parameter is used with the `USER_DEFINE_DISTANCE` junction placement type and proportional units.	Double
iterations_number (Optional)	The number of iterations that will be processed. The default is 5. This parameter can only be used with the `ITERATIVE_DISTANCE` junction placement type.	Long
is_path_preserved (Optional)	Specifies how vertices along edges will be processed. `PRESERVE_PATH`—All vertices along the connected edges will be preserved, and new vertices will be added at the moved junctions' original locations. This is the default. `IGNORE_PATH`—Vertices along edges will not be preserved.	Boolean
are_leaves_moved (Optional)	Specifies whether leaf junctions—junctions with one connection—will be moved during the layout algorithm process. `MOVE_LEAVES`—Leaf junctions will be moved. `DO_NOT_MOVE_LEAVES`—Leaf junctions will not be moved. This is the default unless the specified input network diagram is based on a template for which the Linear Dispatch Layout algorithm has been configured with another parameter value.	Boolean
are_leaves_expanded (Optional)	Specifies whether leaf junctions will be expanded: `EXPAND_LEAVES`—Leaf junctions will be expanded. The `expand_shift_absolute` parameter value specifies the maximum distance the leaf junctions can be expanded from the junctions to which they connect. `DO_NOT_EXPAND_LEAVES`—Leaf junctions will not be expanded. This is the default unless the specified input network diagram is based on a template for which the Linear Dispatch Layout algorithm has been configured with another parameter value.	Boolean
expand_shift_absolute (Optional)	The maximum distance leaf junctions will be expanded from the junctions to which they connect. The default is 2 in the units of the diagram's coordinate system unless the specified input network diagram is based on a template for which the Linear Dispatch Layout algorithm has been configured with another parameter value. At the time this distance is reached, leaf junctions will not be moved during additional iterations. This parameter can only be used with the Expand leaves parameter and absolute units.	Linear Unit
expand_shift_proportional (Optional)	The maximum distance the leaf junctions will be expanded from the junctions to which they connect. The default is 2 unless the specified input network diagram is based on a template for which the Linear Dispatch Layout algorithm has been configured with another parameter value. At the time this distance is reached, leaf junctions will not be moved during additional iterations. This parameter can only be used with the Expand leaves parameter and proportional units.	Double

Derived output

Name	Explanation	Data type
out_utility_network	The updated utility network or trace network.	Utility Network; Trace Network
out_template_name	The name of the diagram template.	String

Code sample

AddLinearDispatchLayout example (Python window)

This sample adds the Linear Dispatch Layout algorithm as an automatic layout to the MyTemplate1 template existing for the input network.

import arcpy
input_Network = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.Electric"
input_DiagramTemplate = "MyTemplate1"

arcpy.nd.AddLinearDispatchLayout(input_Network, input_DiagramTemplate,
                                 "ACTIVE", "ITERATIVE_DISTANCE", "ABSOLUTE_UNIT",
                                 "15 Feet", "", "2 Feet", "", 10, "PRESERVE_PATH",
                                 "DO_NOT_MOVE_LEAVES", "DO_NOT_EXPAND_LEAVES",
                                 "2 Feet", 2)

Environments

This tool does not use any geoprocessing environments.

Licensing information

Basic: No
Standard: Yes
Advanced: Yes

Add Linear Dispatch Layout (Network Diagram Tools)

Summary

Caution:

Note:

Usage

Parameters

Derived output

Environments

Licensing information

Related topics