Skip To Content

Apply Radial Tree Layout

Summary

Arranges diagram features hierarchically and places them in a radial tree.

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 diagram features hierarchically and places them in a radial tree according to the specified radius parameters. It works from a root junction that it uses as the circle center to arrange the subtrees starting from this root in concentric circles, each circle corresponding to one hierarchical level.

  • If no root junction is specified, the algorithm selects the diagram junction associated with the smallest utility network topology index and considers this junction to be the root junction.

    If a diagram junction is set as a root junction, the radial tree considers this root junction the center of the concentric circles.

    When several root junctions are specified in the diagram, those root junctions are all placed around a first concentric circle with a fictive center.

Syntax

ApplyRadialTreeLayout_un (in_network_diagram_layer, {are_containers_preserved}, {is_unit_absolute}, {initial_radius_absolute}, {initial_radius_proportional}, {disjoined_graph_absolute}, {disjoined_graph_proportional}, {radius_factor})
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
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
initial_radius_absolute
(Optional)

The radius of the first concentric circle whose center is the radial tree root junction; that is, the radius of the circle around which the diagram junctions belonging to the first hierarchical level are placed. The default is 5 in the units of the diagram's coordinate system. This parameter is required when using absolute units.

Linear Unit
initial_radius_proportional
(Optional)

The radius of the first concentric circle whose center is the radial tree root junction; that is, the radius of the circle around which the diagram junctions belonging to the first hierarchical level are placed. The default is 5. This parameter is required when using proportional units.

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
radius_factor
(Optional)

Represents the multiplicative factor used to increase or decrease the radius of each concentric circle. It also represents the distance that separates each concentric circle related to a hierarchical level. When using a radius factor less than 1, the distance that separates the diagram junctions belonging to the (n) hierarchical level and the (n+1) hierarchical level progressively decreases. With a factor greater than 1, the distance between the hierarchical levels increases progressively. The default is 1.

Double

Derived Output

NameExplanationData Type
out_network_diagram_layer

The updated network diagram layer.

Diagram Layer

Code sample

ApplyRadialTreeLayout example (Python window)

This sample script applies the Radial Tree Layout algorithm to the Temporary Diagram diagram.

import arcpy
arcpy.ApplyRadialTreeLayout_un("Temporary diagram", "PRESERVE_CONTAINERS", 
                               "ABSOLUTE_UNIT", 5, "", 15, "", 1)

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics