Add Partial Overlapping Edges Layout (Network Diagram)

Summary

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

This layout algorithm detects sets of collinear edges or collinear portions of edges (edge segments) that can be considered as being inside a buffer zone of a given size.

Learn more about the Partial Overlapping Edges 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 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 any diagram based on the diagram template, uncheck the Active parameter (is_active = "INACTIVE" in Python).

• Run the tool with Active checked (the default) (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

Dialog

Label	Explanation	Data Type
Input Network	The utility network or trace network containing the diagram template to modify.	Utility Network; Trace Network
Input Diagram Template	The name of the diagram template to modify.	String
Active	Specifies whether the layout algorithm will automatically execute when generating diagrams based on the specified template. Checked—The added layout algorithm will automatically run during the generation of any diagram that is based on the Input Diagram Template parameter. 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
Buffer Width	The width of the buffer zone in which to search for collinear edge segments.	Linear Unit
Offset	The distance that will separate the detected edge segments.	Linear Unit
Optimize edges (Optional)	Specifies how segments will be placed along edges: Checked—The placement of segments will be optimized in each set of collinear segments. This is done by focusing on their connections instead of their positions. Segments that cross each other can be repositioned so they do not cross. Unchecked—The initial position of each segment will be maintained in the collinear segment set and crossings will be preserved. This is the default.	Boolean

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

Python

arcpy.nd.AddPartialOverlappingEdgesLayout(in_utility_network, template_name, is_active, buffer_width_absolute, offset_absolute, {optimize_edges})

Name	Explanation	Data Type
in_utility_network	The utility network or trace network containing the diagram template to modify.	Utility Network; Trace Network
template_name	The name of the diagram template to modify.	String
is_active	Specifies whether the layout algorithm will automatically execute when generating diagrams based on the specified template. ACTIVE —The added layout algorithm will automatically run during the generation of any diagram that is based on the template_name parameter. 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
buffer_width_absolute	The width of the buffer zone in which to search for collinear edge segments.	Linear Unit
offset_absolute	The distance that will separate the detected edge segments.	Linear Unit
optimize_edges (Optional)	Specifies how segments will be placed along edges: OPTIMIZE_EDGES —The placement of segments will be optimized in each set of collinear segments. This is done by focusing on their connections instead of their positions. Segments that cross each other can be repositioned so they do not cross. DO_NOT_OPTIMIZE_EDGES —The initial position of each segment will be maintained in the collinear segment set and crossings will be preserved. This is the default.	Boolean

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

AddPartialOverlappingEdgesLayout example (Python window)

Add the Partial Overlapping Edges layout algorithm as an automatic layout to the MyTemplate1 template existing in a given network.

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

arcpy.AddPartialOverlappingEdgesLayout_nd(input_Network, 
                                          input_DiagramTemplate, "ACTIVE", 
                                          "15 Feet", "25 Feet", 
                                          "DO_NOT_OPTIMIZE_EDGES")

Environments

This tool does not use any geoprocessing environments.

Licensing information

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