Apply Angle Directed Layout (Network Diagram)

Summary

Moves a diagram's edges in specified alignment directions.

Learn more about the Angle Directed 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 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 geodatabase.

• The input network diagram layer must be from either a utility network or a trace network in a file geodatabase or a network diagram service.

• This layout algorithm progressively moves the diagram's edges in specified alignment directions. For each diagram edge, this layout notes its current direction, searches for the nearest desired direction among those specified, and moves the edge in that direction.

• Consider applying the layout in asynchronous mode on the server when working on very large diagrams.

Syntax

arcpy.nd.ApplyAngleDirectedLayout(in_network_diagram_layer, {are_containers_preserved}, {iterations_number}, {number_of_directions}, {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. PRESERVE_CONTAINERS — The layout algorithm will execute on the top graph of the diagram so containers are preserved. IGNORE_CONTAINERS —The layout algorithm will execute on both content and noncontent features in the diagram. This is the default.	Boolean
iterations_number (Optional)	The number of iterations to process. The default is 1.	Long
number_of_directions (Optional)	The number of directions that will be used to align the diagram edges and their connected junctions. TWELVE_DIRECTIONS —The edges will move so they progressively approach one of the 12 axes, starting with the edge's origin junction and inclined at 30, 60, 90, 120, 150, 180, 210, 240, 270, 300, 330, or 360 degrees. EIGHT_DIRECTIONS —The edges will move so they progressively approach one of the 8 axes, starting with the edge's origin junction and inclined at 45, 90, 135, 180, 225, 270, 315, or 360 degrees. This is the default. FOUR_DIRECTIONS —The edges will move so they progressively approach one of the 4 axes, starting with the edge's origin junction and inclined at 90, 180, 270, or 360 degrees.	String
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 when executing 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 its execution exceeds the service time-out: 600 seconds by default. This is the default.	Boolean

Derived Output

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

Code sample

ApplyAngleDirectedLayout example (Python window)

Apply the Angle Directed Layout algorithm to the diagram called Temporary Diagram.

import arcpy
arcpy.ApplyAngleDirectedLayout_nd("Temporary Diagram", "PRESERVE_CONTAINERS", 
                                  20, "EIGHT_DIRECTIONS", "RUN_SYNCHRONOUSLY")

Environments

This tool does not use any geoprocessing environments.

Licensing information

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