Apply Linear Dispatch Layout (Network Diagram Tools)

Summary

Adds space between diagram junctions that are visually too close, overlapping, or coincident.

Learn more about the Linear Dispatch layout algorithm

Caution:

If you have an open edit session, you must save your edits prior to running this tool. This ensures that the diagram reflects the latest changes made to the network topology in the database. If you fail to save your edits, the edits will not be reflected in the diagram.

License:

The active portal account must be assigned a license with the ArcGIS Advanced Editing user type extension to use this tool in an enterprise deployment.

Note:

Each layout algorithm includes default parameter values. The default parameter values will be used unless otherwise specified. If the input network diagram is based on a template for which this layout has been configured with a different parameter value, that value will be used instead.

Usage

This tool is not supported when working with a database connection to a utility network or trace network in an enterprise geodatabase. You must use either the related published utility network or trace network service, or a utility network or trace network in a file or mobile geodatabase.
The input network diagram layer must be from either a utility network or a trace network in a file or mobile geodatabase. or a network diagram service.
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.
This layout algorithm also separates diagram edges connected to the target junctions. The valence for these junctions is taken into account—that is, the number of their adjacent edges as well as the edge paths can be preserved.
This layout algorithm is especially useful for water, wastewater, and gas, but can be deployed for other industries as well.
Consider applying the layout in asynchronous mode on the server when working on very large diagrams.

Label	Explanation	Data type
Input Network Diagram Layer	The network diagram to which the layout will be applied.	Diagram Layer
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 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 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 define 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
Run in asynchronous mode on the server (Optional)	Specifies whether the layout algorithm will run asynchronously or synchronously on the server. Checked—The layout algorithm will run asynchronously on the server. This option dedicates server resources to run the layout algorithm with a longer time-out. Running asynchronously is recommended for layouts that are time consuming and may exceed the server time-out (for example, Partial Overlapping Edges) and applying to large diagrams (more than 25,000 features). Unchecked—The layout algorithm will run synchronously on the server. It can fail without completion if it exceeds the service default time-out value of 600 seconds. This is the default.	Boolean

Derived output

Label	Explanation	Data type
Output Network Diagram	The updated network diagram layer.	Diagram Layer

arcpy.nd.ApplyLinearDispatchLayout(in_network_diagram_layer, {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}, {run_async})

Name	Explanation	Data type
in_network_diagram_layer	The network diagram to which the layout will be applied.	Diagram Layer
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
run_async (Optional)	Specifies whether the layout algorithm will run asynchronously or synchronously on the server. `RUN_ASYNCHRONOUSLY`—The layout algorithm will run asynchronously on the server. This option dedicates server resources to run the layout algorithm with a longer time-out. Running asynchronously is recommended for layouts that are time consuming and may exceed the server time-out (for example, Partial Overlapping Edges) and applying to large diagrams (more than 25,000 features). `RUN_SYNCHRONOUSLY`—The layout algorithm will run synchronously on the server. It can fail without completion if it exceeds the service default time-out value of 600 seconds. This is the default.	Boolean

Derived output

Name	Explanation	Data type
out_network_diagram_layer	The updated network diagram layer.	Diagram Layer

Code sample

ApplyLinearDispatchLayout example (Python window)

Apply the Linear Dispatch layout algorithm to the diagram called Temporary Diagram.

import arcpy
arcpy.nd.ApplyLinearDispatchLayout("Temporary Diagram", "ITERATIVE_DISTANCE",
                                   "ABSOLUTE_UNIT", "15 Feet", "", "2 Feet",
                                   "", 10, "PRESERVE_PATH", "DO_NOT_MOVE_LEAVES",
                                   "DO_NOT_EXPAND_LEAVES", "2 Feet", 2,
                                   "RUN_SYNCHRONOUSLY")

Environments

This tool does not use any geoprocessing environments.

Licensing information

Basic: No
Standard: Yes
Advanced: Yes

Apply Linear Dispatch Layout (Network Diagram Tools)

Summary

Caution:

License:

Note:

Usage

Parameters

Derived output

Environments

Licensing information

Related topics