Summary
Separates diagram junctions that are visibly close to overlapping.
Learn more about the Spatial 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.
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 is used instead.
Usage
This tool is not supported when working with a database connection to a utility network in an enterprise geodatabase. You must use either the related published utility network service or a utility network or trace network in a file geodatabase.
The input network diagram layer must be from either a utility network or trace network in a file geodatabase or a network diagram service.
-
This layout algorithm progressively separates diagram junctions that are visibly close to overlapping according to their current positions and to the shift factor specified.
Consider applying the layout in asynchronous mode on the server when working on very large diagrams.
Syntax
ApplySpatialDispatchLayout(in_network_diagram_layer, {are_containers_preserved}, {iterations_number}, {maximum_shift_factor}, {run_async})
Parameter | Explanation | Data Type |
in_network_diagram_layer | The network diagram to which the layout will be applied. | Diagram Layer |
are_containers_preserved (Optional) | Specifies how the algorithm will process containers.
| Boolean |
iterations_number (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 |
run_async (Optional) | Specifies whether the layout algorithm will run asynchronously or synchronously on the server.
| Boolean |
Derived Output
Name | Explanation | Data Type |
out_network_diagram_layer | The updated network diagram layer. | Diagram Layer |
Code sample
Apply the Spatial Dispatch Layout algorithm to the diagram called Temporary Diagram.
import arcpy
arcpy.ApplySpatialDispatchLayout_nd("Temporary Diagram", "PRESERVE_CONTAINERS",
5, 2, "RUN_SYNCHRONOUSLY")
Environments
Licensing information
- Basic: No
- Standard: Yes
- Advanced: Yes