Summary
Adds the Grid 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 Grid Layout algorithm parameters for any diagram based on that template.
This algorithm positions diagram junctions relative to a magnetic grid that has cell sizes fixed by the Cell Width and Cell Height parameter values.
Learn more about the Grid 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.
Syntax
arcpy.nd.AddGridLayout(in_utility_network, template_name, is_active, {are_containers_preserved}, {cell_width_absolute}, {cell_height_absolute})| Parameter | 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.
| Boolean |
are_containers_preserved (Optional) | Specifies how the algorithm will process containers.
| Boolean |
cell_width_absolute (Optional) | The width of each grid cell. The default is 2 in the units of the diagram's coordinate system. | Linear Unit |
cell_height_absolute (Optional) | The height of each grid cell. The default is 2 in the units of the diagram's coordinate system. | Linear Unit |
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
Add the Grid layout algorithm as an automatic layout to the MyTemplate1 template related to the input network.
import arcpy
input_Network = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.Electric"
input_DiagramTemplate = "MyTemplate1"
arcpy.AddGridLayout_nd(input_Network, input_DiagramTemplate, "ACTIVE",
"PRESERVE_CONTAINERS", "2 Meter", "5 Meter")Environments
Licensing information
- Basic: No
- Standard: Yes
- Advanced: Yes