Skip To Content

Apply Mainline Tree Layout

Summary

Arranges diagram junctions and edges hierarchically along a main line.

Caution:

If you have an open edit session, you must save your edits prior to running this tool. This ensures 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 layout algorithm arranges the junctions and edges in the input network diagram hierarchically along a main line and places its related branches on the left side, the right side, or both sides of the main line.

  • Root and end junctions can be specified in the diagram so the Mainline Tree layout algorithm builds a main line starting at a specified root junction and ending at a specified end junction.

    • By default, when no root and end junctions are set, the algorithm selects the diagram junction associated with the smallest utility network topology index. Starting from this junction representing the root, the algorithm searches for a line composed of the greatest number of edges: the main line.
    • When a root junction is set, the main line is one of the branches composed of the greatest number of edges starting from this root junction.
    • When both root and end junctions are set and there is a path between them, the main line is the branch composed of the greatest number of diagram edges starting from this root junction and ending at this end junction.

    If your network diagram is composed of several disconnected diagram parts, you can define several root and end junctions, for example, one for each part of the diagram.

    Several junctions that belong to the same connected diagram part can also be specified as roots. They are all aligned along the same axis perpendicularly to the tree direction and appear as different start points for a tree branch of the diagram. For end junctions, although nothing prevents users from specifying several ends on the same connected diagram part, the system considers only one of them the end junction.

    If an end junction is specified but no root junction is specified, the end junction is ignored.

Syntax

ApplyMainlineTreeLayout_un (in_network_diagram_layer, {are_containers_preserved}, {tree_direction}, {branches_placement}, {is_unit_absolute}, {perpendicular_absolute}, {perpendicular_proportional}, {along_absolute}, {along_proportional}, {disjoined_graph_absolute}, {disjoined_graph_proportional}, {are_edges_orthogonal}, {breakpoint_position}, {edge_display_type})
ParameterExplanationData Type
in_network_diagram_layer

The network diagram where the layout will be applied.

Diagram Layer
are_containers_preserved
(Optional)

Specifies how containers will be processed by the algorithm.

  • PRESERVE_CONTAINERS The layout algorithm executes on the top graph of the diagram so containers are preserved.
  • IGNORE_CONTAINERSThe layout algorithm executes on both content and noncontent features in the diagram. This is the default.
Boolean
tree_direction
(Optional)

The direction of the main line.

  • FROM_LEFT_TO_RIGHTThe main line will be drawn as a horizontal line starting from the left and ending on the right. This is the default.
  • FROM_RIGHT_TO_LEFTThe main line will be drawn as a horizontal line starting from the right and ending on the left.
  • FROM_BOTTOM_TO_TOPThe main line will be drawn as a vertical line starting from the bottom and ending at the top.
  • FROM_TOP_TO_BOTTOMThe main line will be drawn as a vertical line starting from the top and ending at the bottom.
String
branches_placement
(Optional)

Specifies how branches from the main line are relatively placed with regard to its direction.

  • BOTH_SIDESBranches will be placed on both the left and right sides of the main line. This is the default.
  • LEFT_SIDEBranches will only be placed on the left side of the main line.
  • RIGHT_SIDEBranches will only be placed on the right side of the main line.
String
is_unit_absolute
(Optional)

Specifies how parameters representing distances will be interpreted.

  • ABSOLUTE_UNITThe layout algorithm will interpret any distance values as linear units.
  • PROPORTIONAL_UNITThe layout algorithm will interpret any distance values as relative units to an estimation of the average of the junction sizes in the diagram when it is generated. This is the default.
Boolean
perpendicular_absolute
(Optional)

The spacing between diagram junctions that are displayed along the axis perpendicular to the main line. The default is 2 in the diagram's coordinate system. This parameter is required when using absolute units.

Linear Unit
perpendicular_proportional
(Optional)

The spacing between diagram junctions that are displayed along the axis perpendicular to the main line. The default is 2. This parameter is required when using proportional units.

Double
along_absolute
(Optional)

The spacing between diagram junctions that are displayed along the main line. It also dictates the spacing between diagram junctions that are displayed along the axis parallel to this main line. This parameter is required when using absolute units. The default is 2 in the units of the diagram's coordinate system.

Linear Unit
along_proportional
(Optional)

The spacing between diagram junctions that are displayed along the main line and diagram junctions that are displayed along the axis parallel to this main line. This parameter is expected when using proportional units. The default is 2.

Double
disjoined_graph_absolute
(Optional)

The minimum spacing that must separate features belonging to disjoined graphs when the diagram contains such graphs. This parameter is required when using 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 must separate features belonging to disjoined graphs when the diagram contains such graphs. This parameter is required when using proportional units. The default is 4.

Double
are_edges_orthogonal
(Optional)

Specifies how diagram edges that are related to the tree branches display.

Legacy:

This parameter is deprecated at ArcGIS Pro 2.2. It is systematically ignored regardless of its value when the edge_display_type is specified. However, to maintain compatibility with ArcGIS Pro 2.1, it remains enabled when the edge_display_type parameter is not specified.

  • ORTHOGONAL_EDGESAll diagram edges related to the tree branches will display with right angles.
  • SLANTED_EDGESAll diagram edges related to the tree branches do 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 = REGULAR_EDGES or edge_display_type = ORTHOGONAL_EDGES. 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 inflexion points that will be inserted along the diagram edges to compute the curved edges geometry when edge_display_type = CURVED_EDGES. 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 inflexion point will be positioned at N% of the length of the [XY] segment.
    • The second inflexion 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 inflexion point will be positioned at N% of the length of the [YX] segment.
    • The second inflexion point will be positioned at (100 - N)% of the length of the [XY] segment.

Note:

The notion of the from and to junctions above is relative to the tree direction; it has nothing to do with the real topology of the network feature edge.

Double
edge_display_type
(Optional)

The type of display for the diagram edges related to the tree branches.

  • REGULAR_EDGESAll diagram edges related to the tree branches do not display with right angles. This is the default.
  • ORTHOGONAL_EDGESAll diagram edges related to the tree branches will display with right angles.
  • CURVED_EDGESAll diagram edges related to the tree branches will be curved.
String

Code sample

ApplyMainlineTreeLayout example (Python window)

Apply the Mainline Tree Layout algorithm to the Temporary Diagram diagram.

import arcpy

arcpy.ApplyMainlineTreeLayout_un("Temporary Diagram", "PRESERVE_CONTAINERS", 
                                 "FROM_LEFT_TO_RIGHT", "BOTH_SIDES", 
                                 "PROPORTIONAL_UNIT", "", 5, "", 8, "", 15,
                                 "", 70, "ORTHOGONAL_EDGES" )

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • ArcGIS Desktop Basic: No
  • ArcGIS Desktop Standard: Yes
  • ArcGIS Desktop Advanced: Yes

Related topics