Add Smart Tree Layout (Network Diagram Tools)

Summary

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

This layout algorithm arranges the diagram features hierarchically and places them in a smart tree according to the direction and spacing distances specified. By default, the tree branches are ordered according to their relative positions to each other that they have before the layout applies. Starting with ArcGIS Pro 3.6 and ArcGIS Enterprise 12.0, the tree branches can also be ordered according to attribute values on the branches; that is, according to an attribute existing on the lines or on the extremity junctions of the branches.

Learn more about the Smart Tree 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 that is 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
Preserve container layout (Optional)	Specifies how the algorithm will process containers. Checked—The layout algorithm will apply to the top graph of the diagram so container layouts are preserved. Unchecked—The layout algorithm will apply to both content and noncontent features in the diagram. This is the default.	Boolean
Tree Direction (Optional)	Specifies the direction the tree will be drawn. From left to right—The tree will be drawn from left to right. This is the default. From right to left—The tree will be drawn from right to left. From bottom to top—The tree will be drawn from bottom to top. From top to bottom—The tree will be drawn from top to bottom.	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
Between Subtrees (Optional)	The spacing that will be used between two neighboring subtrees—that is, the spacing between diagram junctions that are displayed perpendicular to the smart tree direction and belong to a different subtree. The default is in the units of the diagram's coordinate system. This parameter can only be used with absolute units.	Linear Unit
Between Subtrees (Optional)	The spacing that will be used between two neighboring subtrees—that is, the spacing between diagram junctions that are displayed perpendicular to the smart tree direction and belong to a different subtree. The default is 2. This parameter can only be used with proportional units.	Double
Between Junctions Perpendicular to the Direction (Optional)	The spacing that will be used between diagram junctions that are displayed perpendicular to the smart tree direction and belong to the same subtree level. The default is 2 in the units of the diagram's coordinate system. This parameter can only be used with absolute units.	Linear Unit
Between Junctions Perpendicular to the Direction (Optional)	The spacing that will be used between diagram junctions that are displayed perpendicular to the smart tree direction and belong to the same subtree level. The default is 2. This parameter can only be used with proportional units.	Double
Between Junctions Along the Direction (Optional)	The spacing that will be used between diagram junctions that are displayed along the smart tree direction. The default is 2 in the units of the diagram's coordinate system. This parameter can only be used with absolute units.	Linear Unit
Between Junctions Along the Direction (Optional)	The spacing that will be used between diagram junctions that are displayed along the smart tree direction. The default is 2. This parameter can only be used with proportional units.	Double
Between Disjoined Graphs (Optional)	The minimum spacing that will separate features belonging to disjoined graphs when the diagram contains such graphs. This parameter is used with absolute units. The default is 4 in the units of the diagram's coordinate system.	Linear Unit
Between Disjoined Graphs (Optional)	The minimum spacing that will separate features belonging to disjoined graphs when the diagram contains such graphs. This parameter is used with proportional units. The default is 4.	Double
Orthogonally display edges (Optional)	Specifies how diagram edges that are related to the tree branches will display. Legacy: This parameter is deprecated at ArcGIS Pro 3.6. The display of tree branches is now controlled using the Edge Display Type parameter. Checked—All diagram edges related to the tree branches will display with right angles. Unchecked—All diagram edges related to the tree branches will not display with right angles. This is the default.	Boolean
Break Point Relative Position (%) (Optional)	The relative position of the break point that will be inserted along the diagram edges when Edge Display Type is set to Regular edges (`edge_display_type = "REGULAR_EDGES"` in Python) or Edge Display Type is set to Orthogonal edges (`edge_display_type = "ORTHOGONAL_EDGES"` in Python). It is a percentage between 0 and 100. With a Break Point Relative Position (%) value of 0, the break point is positioned at the x-coordinate of the edge's from junction and at the y-coordinate of the edge's to junction for a horizontal tree. It is positioned at the y-coordinate of the edge's from junction and at the x-coordinate of the edge's to junction for a vertical tree. With a Break Point Relative Position (%) value of 100, there is no break point inserted on the diagram edges; each diagram edge directly connects its from and to junctions. With a Break Point Relative Position (%) value of N between 0 and 100, the break point is positioned at N% of the length of the [XY] segment, X being the x-coordinate of the edge's from junction and Y being the y-coordinate of the edge's to junction for a horizontal tree. It is positioned at N% of the length of the [YX] segment, Y being the y-coordinate of the edge's from junction and X being the x-coordinate of the edge's to junction for a vertical tree. The relative position of the two inflection points that will be inserted along the diagram edges to compute the curved edges geometry when Edge Display Type is set to Curved edges (`edge_display_type = "CURVED_EDGES"` in Python). It is a percentage between 15 and 40. With a Break Point Relative Position (%) value of N between 15 and 40: X being the x-coordinate of the edge's from junction and Y being the y-coordinate of the edge's to junction for a horizontal tree: The first inflection point will be positioned at N% of the length of the [XY] segment. The second inflection point will be positioned at (100 - N)% of the length of the [XY] segment. Y being the y-coordinate of the edge's from junction and X being the x-coordinate of the edge's to junction for a vertical tree: The first inflection point will be positioned at N% of the length of the [YX] segment. The second inflection point will be positioned at (100 - N)% of the length of the [XY] segment. Note: The concept of the from and to junctions above is relative to the tree direction; it has nothing to do with the real topology of the edge feature or edge object in the network.	Double
Edge Display Type (Optional)	Specifies the type of display for the diagram edges related to the tree branches. Regular edges—All diagram edges related to the tree branches will not display with right angles. This is the default. Orthogonal edges—All diagram edges related to the tree branches will display with right angles. Curved edges—All diagram edges related to the tree branches will be curved.	String
Absolute Offset (Optional)	The offset that will be used to separate overlapping segments when using absolute units and Edge Display Type is set to Orthogonal edges. The value cannot exceed 10 percent of the smallest value specified for the other spacing parameters. The default is 0.	Linear Unit
Proportional Offset (Optional)	The offset that will be used to separate overlapping segments when using proportional units and Edge Display Type is set to Orthogonal edges. It is a double value that cannot exceed 10 percent of the smallest value specified for the other spacing parameters. The default is 0.	Double
Order tree branches according to an attribute (Optional)	Specifies whether the tree branches will be ordered according to an attribute. Checked—The tree branches will be ordered according to the current positions of the branch extremity junctions at the moment the layout applies. This is the default. For example, considering the tree direction, any branch ending with junction A is placed above the branch ending with junction B when branch A already showed above branch B in the diagram before applying the layout. Unchecked—The tree branches will be ordered according to an attribute.	Boolean
Attribute Availability (Optional)	Specifies whether the attribute to consider is available on diagram junctions or diagram edges. Search the attribute on junctions—The attribute to consider is available on diagram junctions. This is the default. Search the attribute on edges—The attribute to consider is available on diagram edges.	String
Attribute Name (Optional)	The name or alias of the attribute field that will be used to order the tree branches when this field exists. When the Attribute Availability parameter value is Search the attribute on junctions, this order attribute will be queried on the branch extremity junctions. When the Attribute Availability parameter value is Search the attribute on edges, this order attribute will be queried on the branch extremity edges.	String
Attribute Sort Order (Optional)	The sort order that will be used for positioning the branches of the tree layout. Sorting always applies from the first branch on the left to the last branch on the right for vertical tree layouts, that is, when the Tree Direction parameter value is From top to bottom or From bottom to top. For horizontal tree layouts, sorting applies from the first branch at the top to the last branch at the bottom, that is, when the Tree Direction parameter value is From left to right or From right to left. Ascending—The tree branches will be sorted based on the attribute field values in ascending order. This is the default. Descending—The tree branches will be sorted based on the attribute field values in descending order.	String

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.AddSmartTreeLayout(in_utility_network, template_name, is_active, {are_containers_preserved}, {tree_direction}, {is_unit_absolute}, {subtree_absolute}, {subtree_proportional}, {perpendicular_absolute}, {perpendicular_proportional}, {along_absolute}, {along_proportional}, {disjoined_graph_absolute}, {disjoined_graph_proportional}, {are_edges_orthogonal}, {breakpoint_position}, {edge_display_type}, {offset_absolute}, {offset_proportional}, {order_tree_branches}, {attribute_availability}, {attribute_name}, {attribute_sort_order})

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 that is 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
are_containers_preserved (Optional)	Specifies how the algorithm will process containers. `PRESERVE_CONTAINERS`—The layout algorithm will apply to the top graph of the diagram so container layouts are preserved. `IGNORE_CONTAINERS`—The layout algorithm will apply to both content and noncontent features in the diagram. This is the default.	Boolean
tree_direction (Optional)	Specifies the direction the tree will be drawn. `FROM_LEFT_TO_RIGHT`—The tree will be drawn from left to right. This is the default. `FROM_RIGHT_TO_LEFT`—The tree will be drawn from right to left. `FROM_BOTTOM_TO_TOP`—The tree will be drawn from bottom to top. `FROM_TOP_TO_BOTTOM`—The tree will be drawn from top to bottom.	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
subtree_absolute (Optional)	The spacing that will be used between two neighboring subtrees—that is, the spacing between diagram junctions that are displayed perpendicular to the smart tree direction and belong to a different subtree. The default is in the units of the diagram's coordinate system. This parameter can only be used with absolute units.	Linear Unit
subtree_proportional (Optional)	The spacing that will be used between two neighboring subtrees—that is, the spacing between diagram junctions that are displayed perpendicular to the smart tree direction and belong to a different subtree. The default is 2. This parameter can only be used with proportional units.	Double
perpendicular_absolute (Optional)	The spacing that will be used between diagram junctions that are displayed perpendicular to the smart tree direction and belong to the same subtree level. The default is 2 in the units of the diagram's coordinate system. This parameter can only be used with absolute units.	Linear Unit
perpendicular_proportional (Optional)	The spacing that will be used between diagram junctions that are displayed perpendicular to the smart tree direction and belong to the same subtree level. The default is 2. This parameter can only be used with proportional units.	Double
along_absolute (Optional)	The spacing that will be used between diagram junctions that are displayed along the smart tree direction. The default is 2 in the units of the diagram's coordinate system. This parameter can only be used with absolute units.	Linear Unit
along_proportional (Optional)	The spacing that will be used between diagram junctions that are displayed along the smart tree direction. The default is 2. This parameter can only be used with proportional units.	Double
disjoined_graph_absolute (Optional)	The minimum spacing that will separate features belonging to disjoined graphs when the diagram contains such graphs. This parameter is used with absolute units. The default is 4 in the units of the diagram's coordinate system.	Linear Unit
disjoined_graph_proportional (Optional)	The minimum spacing that will separate features belonging to disjoined graphs when the diagram contains such graphs. This parameter is used with proportional units. The default is 4.	Double
are_edges_orthogonal (Optional)	Specifies how diagram edges that are related to the tree branches will display. Legacy: This parameter is deprecated at ArcGIS Pro 3.6. It is systematically ignored regardless of its value when the `edge_display_type` parameter is specified. `ORTHOGONAL_EDGES`—All diagram edges related to the tree branches will display with right angles. `SLANTED_EDGES`—All diagram edges related to the tree branches will not display with right angles. This is the default.	Boolean
breakpoint_position (Optional)	The relative position of the break point that will be inserted along the diagram edges when Edge Display Type is set to Regular edges (`edge_display_type = "REGULAR_EDGES"` in Python) or Edge Display Type is set to Orthogonal edges (`edge_display_type = "ORTHOGONAL_EDGES"` in Python). It is a percentage between 0 and 100. With a Break Point Relative Position (%) value of 0, the break point is positioned at the x-coordinate of the edge's from junction and at the y-coordinate of the edge's to junction for a horizontal tree. It is positioned at the y-coordinate of the edge's from junction and at the x-coordinate of the edge's to junction for a vertical tree. With a Break Point Relative Position (%) value of 100, there is no break point inserted on the diagram edges; each diagram edge directly connects its from and to junctions. With a Break Point Relative Position (%) value of N between 0 and 100, the break point is positioned at N% of the length of the [XY] segment, X being the x-coordinate of the edge's from junction and Y being the y-coordinate of the edge's to junction for a horizontal tree. It is positioned at N% of the length of the [YX] segment, Y being the y-coordinate of the edge's from junction and X being the x-coordinate of the edge's to junction for a vertical tree. The relative position of the two inflection points that will be inserted along the diagram edges to compute the curved edges geometry when Edge Display Type is set to Curved edges (`edge_display_type = "CURVED_EDGES"` in Python). It is a percentage between 15 and 40. With a Break Point Relative Position (%) value of N between 15 and 40: X being the x-coordinate of the edge's from junction and Y being the y-coordinate of the edge's to junction for a horizontal tree: The first inflection point will be positioned at N% of the length of the [XY] segment. The second inflection point will be positioned at (100 - N)% of the length of the [XY] segment. Y being the y-coordinate of the edge's from junction and X being the x-coordinate of the edge's to junction for a vertical tree: The first inflection point will be positioned at N% of the length of the [YX] segment. The second inflection point will be positioned at (100 - N)% of the length of the [XY] segment. Note: The concept of the from and to junctions above is relative to the tree direction; it has nothing to do with the real topology of the edge feature or edge object in the network.	Double
edge_display_type (Optional)	Specifies the type of display for the diagram edges related to the tree branches. `REGULAR_EDGES`—All diagram edges related to the tree branches will not display with right angles. This is the default. `ORTHOGONAL_EDGES`—All diagram edges related to the tree branches will display with right angles. `CURVED_EDGES`—All diagram edges related to the tree branches will be curved.	String
offset_absolute (Optional)	The offset that will be used to separate overlapping segments when `is_unit_absolute = "ABSOLUTE_UNIT"` and `edge_display_type = "ORTHOGONAL_EDGES"`. The value cannot exceed 10 percent of the smallest value specified for the other spacing parameters. The default is 0.	Linear Unit
offset_proportional (Optional)	The offset that will be used to separate overlapping segments when `is_unit_absolute = "PROPORTIONAL_UNIT"` and `edge_display_type = "ORTHOGONAL_EDGES"`. It is a double value that cannot exceed 10 percent of the smallest value specified for the other spacing parameters. The default is 0.	Double
order_tree_branches (Optional)	Specifies whether the tree branches will be ordered according to an attribute. `USE_CURRENT_GEOMETRY`—The tree branches will be ordered according to the current positions of the branch extremity junctions at the moment the layout applies. This is the default. For example, considering the tree direction, any branch ending with junction A is placed above the branch ending with junction B when branch A already showed above branch B in the diagram before applying the layout. `USE_ORDER_ATTRIBUTE`—The tree branches will be ordered according to an attribute.	Boolean
attribute_availability (Optional)	Specifies whether the attribute to consider is available on diagram junctions or diagram edges. `JUNCTION`—The attribute to consider is available on diagram junctions. This is the default. `EDGE`—The attribute to consider is available on diagram edges.	String
attribute_name (Optional)	The name or alias of the attribute field that will be used to order the tree branches when this field exists. When the `attribute_availability` parameter value is `JUNCTION`, this order attribute will be queried on the branch extremity junctions. When the `attribute_availability` parameter value is `EDGE`, this order attribute will be queried on the branch extremity edges.	String
attribute_sort_order (Optional)	The sort order that will be used for positioning the branches of the tree layout. Sorting always applies from the first branch on the left to the last branch on the right for vertical tree layouts, that is, when the `tree_direction` parameter value is `FROM_TOP_TO_BOTTOM` or `FROM_BOTTOM_TO_TOP`. For horizontal tree layouts, sorting applies from the first branch at the top to the last branch at the bottom, that is, when the `tree_direction` parameter value is `FROM_LEFT_TO_RIGHT` or `FROM_RIGHT_TO_LEFT`. `ASCENDING`—The tree branches will be sorted based on the attribute field values in ascending order. This is the default. `DESCENDING`—The tree branches will be sorted based on the attribute field values in descending order.	String

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

AddSmartTreeLayout example (Python window)

This sample script adds the Smart Tree Layout algorithm as an automatic layout to the MyTemplate1 template for a given network.

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

arcpy.nd.AddSmartTreeLayout(input_Network, input_DiagramTemplate,
                            "ACTIVE", "PRESERVE_CONTAINERS",
                            "FROM_LEFT_TO_RIGHT", "PROPORTIONAL_UNIT", "", 8,
                            "", 5, "", 5, "", 15, "", 25, "CURVED_EDGES")

Environments

This tool does not use any geoprocessing environments.

Licensing information

Basic: No
Standard: Yes
Advanced: Yes

Add Smart Tree Layout (Network Diagram Tools)

Summary

Caution:

Note:

Usage

Parameters

Legacy:

Note:

Derived output

Environments

Licensing information

Related topics