Add Diagram Feature Selection To Layout (Network Diagram)

Summary

Adds the diagram feature selection to which the next active layout configured on the diagram template will apply.

Learn more about presetting a diagram feature selection to lay out during diagram creation

Usage

• Add this task before any active layout to filter out the diagram features to which you want this layout to apply during the diagram building.

• Chain this tool multiple times in a model to build the set of diagram features to which the next active layout will apply.

• The diagram feature selection specified before a layout sequence is only used by the first active layout. Any subsequent active layout in the sequence applies to all diagram features unless another Diagram Feature Selection To Layout task is configured immediately before that layout.

Parameters

Dialog

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 diagram feature selection will be active (processed) during the generation of diagrams based on the input template. Checked—The diagram feature selection will be active during the generation of any diagrams based on the input template. This is the default. Unchecked—The diagram feature selection will not be active during the generation of any diagrams based on the input template.	Boolean
Selection Type	Specifies the type of selection that will be processed to select the diagram features for the layout: Select by attributes—The selection will apply to diagram features related to a specific network source class or network object table filtered using an SQL expression. This is the default. Select by category—The selection will apply to diagram features that are tagged with specific network categories. Select by source—The selection will apply to diagram features based on network source classes and network object tables.	String
Network Sources (Optional)	All diagram features related to specified network source classes or object tables will be processed by the next active layout.	Table; Feature Class
Network Categories (Optional)	All diagram features tagged with the specified network categories will be processed by the next active layout.	String
Network Source (Optional)	The network source class or object table associated with the diagram features that will be processed by the next active layout.	Table; Feature Class
Expression (Optional)	An SQL expression that will be used to filter the subset of diagram features in the source class or object table to which the next active layout configured on the diagram template will apply. For more information about SQL syntax, see SQL reference for query expressions used in ArcGIS.	SQL Expression
Invert selection (Optional)	Specifies whether the current selection of diagram features will be inverted. Checked—All of the selected diagram features, except those using the previous setting combinations, will be inverted. Unchecked—The current selection of diagram features will not be inverted. This is the default.	Boolean
Apply only to features contained (Optional)	Specifies whether the final set of selected diagram features resulting from all the previous settings will be filtered to only apply to diagram features that are contained. Checked—The final set of selected diagram features will be filtered to only apply to diagram features that are contained. Unchecked—The final set of selected diagram features will not be filtered based on their contained status. This is the default.	Boolean
Description (Optional)	The description of the diagram feature selection.	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

Python

arcpy.nd.AddDiagramFeatureSelectionToLayout(in_network, template_name, is_active, selection_type, {network_source}, {category}, {source_by_attribute}, {where_clause}, {invert_selection}, {only_features_contained}, {description})

Name	Explanation	Data Type
in_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 diagram feature selection will be active (processed) during the generation of diagrams based on the input template. ACTIVE—The diagram feature selection will be active during the generation of any diagrams based on the input template. This is the default. INACTIVE—The diagram feature selection will not be active during the generation of any diagrams based on the input template.	Boolean
selection_type	Specifies the type of selection that will be processed to select the diagram features for the layout: SELECT_BY_ATTRIBUTES—The selection will apply to diagram features related to a specific network source class or network object table filtered using an SQL expression. This is the default. SELECT_BY_CATEGORY—The selection will apply to diagram features that are tagged with specific network categories. SELECT_BY_SOURCE—The selection will apply to diagram features based on network source classes and network object tables.	String
network_source [network_source,...] (Optional)	All diagram features related to specified network source classes or object tables will be processed by the next active layout.	Table; Feature Class
category [category,...] (Optional)	All diagram features tagged with the specified network categories will be processed by the next active layout.	String
source_by_attribute (Optional)	The network source class or object table associated with the diagram features that will be processed by the next active layout.	Table; Feature Class
where_clause (Optional)	An SQL expression that will be used to filter the subset of diagram features in the source class or object table to which the next active layout configured on the diagram template will apply. For more information about SQL syntax, see SQL reference for query expressions used in ArcGIS.	SQL Expression
invert_selection (Optional)	Specifies whether the diagram feature selection must be inverse. INVERT_SELECTION—All of the selected diagram features will be inverted. DO_NOT_INVERT_SELECTION—The current selection of diagram features will not be inverted. This is the default.	Boolean
only_features_contained (Optional)	Specifies whether the final set of selected diagram features resulting from all the previous settings will be filtered to only apply to diagram features that are contained. APPLY_ONLY_TO_FEATURES_CONTAINED—The final set of selected diagram features will be filtered to only apply to diagram features that are contained. APPLY_TO_ALL_FEATURES—The final set of selected diagram features will not be filtered based on their contained status. This is the default.	Boolean
description (Optional)	The description of the diagram feature selection.	String

Derived Output

Name	Explanation	Data Type
out_network	The updated utility network or trace network.	Utility Network; Trace Network
out_template_name	The name of the diagram template.	String

Environments

This tool does not use any geoprocessing environments.

Licensing information

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