Summary
An ArcPy class for performing a route analysis.
Discussion
A route analysis allows you to calculate the shortest path along a network between a sequence of stops.
Syntax
Route (in_network)
| Parameter | Explanation | Data Type |
in_network | The network dataset or service that will be used for the network analysis. The argument can be specified using the catalog path to the network dataset, a network dataset layer object, the string name of the network dataset layer, or a portal URL for a network analysis service. The network must have at least one travel mode. To use a portal URL, you must be signed in to the portal with an account that has routing privileges. Solving an analysis will consume credits when the object uses ArcGIS Online as the in_network. For more information, see Service Credits Overview | String |
Properties
| Property | Explanation | Data Type |
| accumulateAttributeNames (Read and Write) | A list of cost attributes to be accumulated during analysis. These accumulated attributes are for reference only; the solver only uses the cost attribute used by your designated travel mode when solving the analysis. The default is an empty list. | String |
| allowAutoRelocate (Read and Write) | Specifies whether inputs with existing network location fields can be automatically relocated at solve time to ensure valid, routable location fields for the analysis. If the value is True, points located on restricted network elements and points affected by barriers will be relocated to the closest routable location. If the value is False, network location fields will be used as is, even if the points are unreachable, and this may cause the solve to fail. Even if the value is False, inputs with no location fields or incomplete location fields will be located at solve time. The default is True. This property affects locating for all input types. To change this property for individual input types, use the setLocateSettingsOverrides method. Learn more about network location fields and how inputs are located on the network Setting this property returns an error if the network data source is ArcGIS Online, an ArcGIS Enterprise portal that does not support using network location fields, or a portal running a version of ArcGIS Enterprise older than 11.0. | Boolean |
| allowSaveLayerFile (Read and Write) | Specifies whether to permit saving the analysis result as a layer file using the saveAsLayerFile method on the result object. A value of True indicates that you can save a layer file. A value of False indicates that you cannot save a layer file. The default is True if the analysis references a network dataset and False if it references a portal service. Saving a layer file may slow down the analysis when the analysis references a portal service. | Boolean |
| allowSaveRouteData (Read and Write) | Specifies whether to permit saving the analysis result to a .zip file using the saveRouteData method on the result object. A value of True indicates that you can save the route data. A value of False indicates that you cannot save the route data. The default is True if the analysis references a network dataset and False if it references a portal service. Saving the route data may slow down the analysis when the analysis references a portal service. | Boolean |
| directionsDistanceUnits (Read and Write) | The units to use when reporting travel distance in the output turn-by-turn directions. The property is returned and set as a member of the DistanceUnits enumeration and is applicable only when the returnDirections property is True. The default is the units of the distance attribute in the travel mode used for the analysis. | Object |
| directionsLanguage (Read and Write) | The language in which the output turn-by-turn directions text will appear. The property is returned and set as a string using one of the two- or five-character language codes representing supported directions languages. The list of available directions languages can be obtained from the arcpy.nax.ListDirectionsLanguages function. The default value is either en (English) or the language of the currently activated language pack. The property is applicable only when the returnDirections property is True. | String |
| directionsStyle (Read and Write) | The style to be used for the output turn-by-turn directions text. The property is returned and set as a member of the DirectionsStyle enumeration and is applicable only when the returnDirections property is True. The default value is Desktop. | Object |
| distanceUnits (Read and Write) | The units to use when reporting the travel distance in the analysis output. Regardless of the units of the cost attributes in the network dataset, the output will be transformed to and reported in the units set in this property. The property is returned and set as a member of the DistanceUnits enumeration. The default is DistanceUnits.Kilometers. | Object |
| findBestSequence (Read and Write) | A value of False indicates that the stops should be visited in the order specified in the input. A value of True indicates that the input stops should be reordered to minimize the overall travel cost. This option changes the route analysis from a shortest-path problem to a traveling salesperson problem (TSP). The default is False. | Boolean |
| ignoreInvalidLocations (Read and Write) | Specifies whether invalid input locations will be ignored. A value of True indicates that invalid input locations will be ignored so that the analysis will succeed using only valid locations. A value of False indicates that invalid locations will not be ignored and will cause the analysis to fail. Legacy:Routing services based on portals running versions of ArcGIS Enterprise older than 10.9 always ignore invalid input locations. The method returns a ValueError exception if you set ignoreInvalidLocations to False and the service does not support this option. | Boolean |
| networkDataSource (Read Only) | The full catalog path to the network dataset used for the analysis. | String |
| overrides (Read and Write) | Note:This property is for internal use only. | String |
| preserveFirstStop (Read and Write) | When stops are reordered because the findBestSequence property is set to True, a value of True for this property preserves the order of the first stop. The rest of the stops will be reordered to find the optimal route. This is useful if the route begins at a garage or depot. The default is False. | Boolean |
| preserveLastStop (Read and Write) | When stops are reordered because the findBestSequence property is set to True, a value of True for this property preserves the order of the last stop. The rest of the stops will be reordered to find the optimal route. This is useful if the route must end at a garage or depot. The default is False. | Boolean |
| returnDirections (Read and Write) | Specifies whether turn-by-turn directions will be generated. A value of True indicates that turn-by-turn directions will be generated when solving the analysis. A value of False indicates that directions will not be generated. Generating directions may slow down the analysis. The default is False. | Boolean |
| returnRouteEdges (Read and Write) | Specifies whether route edges will be returned. Route edges are the individual segments of a route indicating which network edges were traversed. A value of True means that route edges will be saved and returned when solving the analysis. A value of False means that route edges will not be preserved. The default is True if the Route object references a network dataset and False if it references a portal service. Returning route edges may slow down the analysis when the analysis references a portal service. | Boolean |
| returnRouteJunctions (Read and Write) | Specifies whether network junctions traversed by the route will be returned. A value of True means that junctions will be saved and returned when solving the analysis. A value of False means that junctions will not be preserved. The default is True if the Route object references a network dataset and False if it references a portal service. Portal services do not support returning junctions. | Boolean |
| returnRouteTurns (Read and Write) | Specifies whether network turns traversed by the route will be returned. A value of True means that turns will be saved and returned when solving the analysis. A value of False means that turns will not be preserved. The default is True if the Route object references a network dataset and False if it references a portal service. Portal services do not support returning turns. | Boolean |
| returnToStart (Read and Write) | A value of True indicates that the route should return to the starting location at the end of the route. A value of False means that the route will end with the final stop. The default is False. | Boolean |
| routeShapeType (Read and Write) | The type of shape to be generated to represent output routes. The routes are always calculated along the network; however, you can choose to represent them by shapes that do not reflect the network paths. The property is returned and set as a member of the RouteShapeType enumeration. The default is RouteShapeType.TrueShapeWithMeasures. | Object |
| searchQuery (Read and Write) | Legacy:This property has been superseded by the searchSources property, which was introduced at ArcGIS Pro 3.0. The searchQuery property continues to work to maintain backward compatibility with existing scripts, but it is recommended that new scripts use the searchSources property instead.When locating inputs on the network, specifies a query to restrict the search to a subset of the features within a source feature class. This is useful if you don't want to find features that may be unsuited for a network location. For example, if you don't want to locate on highway ramps, you can define a query to exclude them. The parameter value is specified as a list with nested lists, with one entry per network source. Each inner list is composed of two values indicating the name of the network source and the SQL expression used as the query for that source. An empty string, "", indicates no query for a particular source. For example, the value [["Streets", "ROAD_CLASS <> 3"], ["Streets_ND_Junctions", ""]] specifies an SQL expression for the Streets source feature class and no expression for the Streets_ND_Junctions source feature class. If a network source is not included in the list, it is interpreted to have no query. The value [["Streets", "ROAD_CLASS <> 3"]] is equivalent to [["Streets", "ROAD_CLASS <> 3"], ["Streets_ND_Junctions", ""]]. By default, no query is used for any source. Learn more about locating inputs on the network For more information on SQL syntax, see SQL reference for query expressions used in ArcGIS. Setting this property returns an error if the network data source is ArcGIS Online or a portal running a version of ArcGIS Enterprise older than 11.0. | List |
| searchSources (Read and Write) | When locating inputs on the network, specifies the list of network sources to be used, and, optionally, a query to restrict the search to a subset of the features within a source feature class. The default value is to locate on all network sources except system junctions and override junctions created by running the Dissolve Network tool. By default, no query is used for any source. The parameter value is specified as a list with nested lists, with at most one entry per network source. Each inner list is composed of two values indicating the name of the network source and the SQL expression used as the query for that source. Possible values for the network source component are the string feature class names of edge and junction sources that participate in the network. Sources in the list will be used for locating, and sources not in the list will not. Queries are useful if you don't want to find features that may be unsuited for a network location. For example, if you don't want to locate on highway ramps, you can define a query to exclude them. For the query component, see SQL reference for query expressions used in ArcGIS for correct syntax. An empty string, "", indicates no query for a particular source. For example, the value [["Streets", "ROAD_CLASS <> 3"], ["Streets_ND_Junctions", ""]] specifies that inputs can be located on both the Streets and Streets_ND_Junctions sources. A SQL expression for the Streets source feature class forbids inputs from locating on streets where the ROAD_CLASS field has a value of 3. No query is used for the Streets_ND_Junctions source feature class. A value of [["Streets", "ROAD_CLASS <> 3"]] indicates that only the Streets source feature class should be used for locating, and Streets_ND_Junctions should not. Additionally, a query is applied to Streets. This property affects locating for all input types. To change this property for individual input types, use the setLocateSettingsOverrides method. Learn more about locating inputs on the network Setting this property returns an error if the network data source is ArcGIS Online or a portal running a version of ArcGIS Enterprise older than 11.0. | String |
| searchTolerance (Read and Write) | The maximum search distance to use when locating the input features on the network. The property is returned and set as a double, and the units of this value are accessed through the searchToleranceUnits property. The default is 5000. This property affects locating for all input types. To change this property for individual input types, use the setLocateSettingsOverrides method. Learn more about locating inputs on the network Legacy:Setting this property returns an error if the network data source is a portal running a version of ArcGIS Enterprise older than 11.0. | Double |
| searchToleranceUnits (Read and Write) | The units of the searchTolerance property. The property is returned and set as a member of the DistanceUnits enumeration. The default is DistanceUnits.Meters. This property affects locating for all input types. To change this property for individual input types, use the setLocateSettingsOverrides method. Legacy:Setting this property returns an error if the network data source is a portal running a version of ArcGIS Enterprise older than 11.0. | Object |
| timeOfDay (Read and Write) | The date and time of day to use for the analysis. The property is specified using a datetime object. For example, to specify that travel should begin at 5:00 p.m. on March 29, 2022, specify the parameter value as datetime.datetime(2022, 3, 29, 17, 0, 0). Instead of using a particular date, a day of the week can be specified using the following dates:
For example, to specify that travel should begin at 5:00 p.m. on Tuesday, specify the parameter value as datetime.datetime(1900, 1, 2, 17, 0, 0). The default is None, which indicates that the analysis will be time neutral. The property will have no impact if the analysis' travel mode's impedance attribute has no time-dependent properties, such as traffic or public transit. | DateTime |
| timeUnits (Read and Write) | The units to use when reporting the travel time in the analysis output. Regardless of the units of the cost attributes in the network dataset, the outputs will be transformed to and reported in the units set in this property. The property is returned and set as a member of the TimeUnits enumeration. The default is TimeUnits.Minutes. | Object |
| timeZone (Read and Write) | Indicates whether the time specified in the timeOfDay property will be interpreted as the local time at the input locations or as coordinated universal time (UTC). The property is returned and set as a member of the TimeZoneUsage enumeration and is applicable only when the timeOfDay property is not None. The default is TimeZoneUsage.LocalTimeAtLocations. | Object |
| timeZoneForTimeWindows (Read and Write) | Indicates whether the times specified in the time windows of the input stops should be interpreted as the local time at the input locations or as Coordinated Universal Time (UTC). The property is returned and set as a member of the TimeZoneUsage enumeration. The default is TimeZoneUsage.LocalTimeAtLocations. | Object |
| travelMode (Read and Write) | The travel mode to use for the analysis. The value is returned and set as an arcpy.nax.TravelMode object, but it can also be set using the string name of the travel mode or a string containing the valid JSON representation of a travel mode. The default is the default travel mode defined on the network dataset used for the analysis. | Object |
Method Overview
| Method | Explanation |
| addFields (input_type, field_description) | Adds custom fields to the designated input class. These fields will be included in the field mapping dictionary created by the fieldMappings method and will also be available for use with the insertCursor method. |
| count (input_type) |
Returns the number of rows added for an input type. |
| fieldMappings (input_type, {use_location_fields}, {list_candidate_fields}) | Generates an NAClassFieldMappings dictionary that maps the field names of the input type to arcpy.nax.NAClassFieldMap objects that allow you to map fields from your input data to the properties of the solver. The dictionary can be used as input to the load method's field_mappings argument. |
| fieldNames (input_type, {use_location_fields}) | Get a list of field names supported by the specified input type. |
| insertCursor (input_type, field_names, {append}) | Establishes a write cursor on the specified input type. This cursor can be used to add rows directly to the input. |
| load (input_type, features, {field_mappings}, {append}, {max_features}) | Set input features to use for the analysis. |
| setLocateSettingsOverrides (input_type, {search_sources}, {allow_auto_relocate}, {search_tolerance}, {search_tolerance_units}) | Set locate settings for a designated input class, overriding the default locate settings specified for the analysis. This is useful if you want to use different rules to locate different inputs. For example, in an OD cost matrix analysis, you can use a search query that applies to the input origins only, if that query should not apply to the input destinations and barriers. Using this method, you can override the values of the searchSources, allowAutoRelocate, searchTolerance, and searchToleranceUnits properties for the designated input class. |
| solve () | Perform the route analysis using the properties set on the Route object and the loaded inputs. |
Methods
addFields (input_type, field_description)
| Parameter | Explanation | Data Type |
input_type |
The type of input to which the fields should be added. The parameter should be set using the RouteInputDataType enumeration. | Object |
field_description [field_description,...] |
The fields and their properties that will be added to the input class. The value should be constructed as a list of lists with each row containing the following items:
Available field types are as follows:
The method will return an error if the field already exists in the table or if any of the field properties are invalid. | List |
count (input_type)
| Parameter | Explanation | Data Type |
input_type | The type of input features to count. The parameter should be set using the RouteInputDataType enumeration. | Object |
| Data Type | Explanation |
| Integer | The number of rows. |
fieldMappings (input_type, {use_location_fields}, {list_candidate_fields})| Parameter | Explanation | Data Type |
input_type | The type of input for which the field mappings are returned. The parameter should be set using the RouteInputDataType enumeration. See descriptions of the fields available for each input type | Object |
use_location_fields | Indicates whether network location fields should be included in the returned field mappings dictionary. Network location fields describe the point on the network where an object is located. You can use network location fields to more precisely control how your analysis inputs locate on the network and to save time when calling the solve method because the solver will not have to calculate the location fields from the geometry of the inputs. You can calculate location fields for a feature class using the Calculate Locations tool. Learn more about network location fields and how inputs are located on the network When this argument is set to True, the returned field mappings dictionary will contain network location fields. The default is False; the field mapping dictionary will not include network location fields. (The default value is False) | Boolean |
list_candidate_fields [list_candidate_fields,...] | Use this parameter to map additional, non-default fields from your input data into your analysis inputs. For example, if your input feature class contains a field named MyField, and you want this field to be included in your analysis inputs, pass the MyField field object to the list_candidate_fields parameter. MyField will be included in the returned field mapping dictionary and automatically mapped. When you call the load method using these field mappings, MyField will be included in the analysis inputs along with all the default fields. In many cases, these extra fields will be passed to the analysis output as well. The parameter should be specified as a list of arcpy.Field objects, which can be obtained from a given feature class or table using the arcpy.ListFields function. Learn more about best practices for setting up analysis inputs (The default value is None) | Field |
| Data Type | Explanation |
| Dictionary | An NAClassFieldMappings dictionary in which the keys are the field names and values are arcpy.nax.NAClassFieldMap objects. |
fieldNames (input_type, {use_location_fields})| Parameter | Explanation | Data Type |
input_type | The type of input for which the supported field names are returned. The parameter should be set using the RouteInputDataType enumeration. See descriptions of the fields available for each input type | Object |
use_location_fields | Indicates whether network location fields will be included in the returned list of field names. Network location fields describe the point on the network where an object is located. You can use network location fields to more precisely control how your analysis inputs locate on the network and to save time when calling the solve method because the solver will not have to calculate the location fields from the geometry of the inputs. You can calculate location fields for a feature class using the Calculate Locations tool. Learn more about network location fields and how inputs are located on the network When this argument is set to True, the returned list of field names will contain network location fields. The default is False; the list of field names will not include network location fields. (The default value is False) | Boolean |
| Data Type | Explanation |
| String | A list of field names supported by the specified input type. |
insertCursor (input_type, field_names, {append})| Parameter | Explanation | Data Type |
input_type | The type of input into which the cursor can be used to insert rows. The parameter should be set using the RouteInputDataType enumeration. | Object |
field_names [field_names,...] | A list of field names of the input type whose values you want to set when inserting rows using the cursor. You can get the names of the fields supported by an input type by using the fieldNames method. See descriptions of the fields available for each input type In addition to regular fields, you can also set the geometry of the input using one of the following geometry tokens:
The SHAPE@XY and SHAPE@XYZ tokens are only supported for point-based input types. When using the SHAPE@XY and SHAPE@XYZ tokens, the x-, y-, and z-values should be specified in the spatial reference of the network data source being used in the analysis. | String |
append | Specifies whether the features being inserted should be appended to the existing set of features for the input type. A value of True indicates that the new features should be appended; the existing features will be preserved. This is the default. A value of False indicates that any existing features for the input type should be deleted and replaced with the features currently being inserted. (The default value is True) | Boolean |
| Data Type | Explanation |
| Object | A SolverInsertCursor object that can be used to write features. |
load (input_type, features, {field_mappings}, {append}, {max_features})| Parameter | Explanation | Data Type |
input_type | The type of input feature to load. The parameter should be set using the RouteInputDataType enumeration. | Object |
features | The input features to load. This parameter accepts the following input types:
For layer inputs, only selected features will be loaded. If a layer has a definition query, only the subset of features visible with the definition query will be loaded. The method also honors the Extent geoprocessing environment; only features in the specified extent will be loaded. | String |
field_mappings | An NAClassFieldMappings dictionary that maps the field names of the input type to arcpy.nax.NAClassFieldMap objects representing the mapping of fields from the input features. Valid input for this parameter can be constructed using the fieldMappings method. If field mappings are not specified, all fields from the input features that have the same name as the supported fields for the input type will be mapped. (The default value is None) | Dictionary |
append | Indicates whether the features being loaded should be appended to the existing set of features for the input type. A value of True indicates that the new features should be appended; the existing features will be preserved. This is useful if you want to load inputs from multiple feature classes or tables to use in a single analysis. This is the default. A value of False indicates that any existing features for the input type should be deleted and replaced with the features currently being loaded. (The default value is True) | Boolean |
max_features | The maximum number of features that can be loaded into the input type. This is useful if you are creating a tool or service and want an error returned if the size of the input exceeds the available resources. The load method will return an arcpy.nax.LimitError if the number of input features exceeds the max_features limit. If a value is not specified, no limit is enforced for the count of the input features. (The default value is None) | Integer |
setLocateSettingsOverrides (input_type, {search_sources}, {allow_auto_relocate}, {search_tolerance}, {search_tolerance_units})| Parameter | Explanation | Data Type |
input_type | The type of input for which to override default locate settings. The parameter should be set using the RouteInputDataType enumeration. | Object |
search_sources [[Source, Expression],...] | The list of network sources to be used when locating inputs of the designated type on the network, and, optionally, a query to restrict the search to a subset of the features within a source feature class. See the documentation for the searchSources property for examples of proper syntax for this parameter. Specifying a value for this parameter overrides the default searchSources property value for the designated input type. If this parameter is not specified or is set to None, the searchSources value will be used for this input type. The method returns an error if this parameter is used and the network data source is ArcGIS Online. | String |
allow_auto_relocate | Specifies whether inputs of the designated type with existing network location fields can be automatically relocated at solve time to ensure valid, routable location fields for the analysis. If the value is True, points located on restricted network elements and points affected by barriers will be relocated to the closest routable location. If the value is False, network location fields will be used as is, even if the points are unreachable, and this may cause the solve to fail. Even if the value is False, inputs with no location fields or incomplete location fields will be located at solve time. Specifying a value for this parameter overrides the default allowAutoRelocate property value for the designated input type. If this parameter is not specified or is set to None, the allowAutoRelocate value will be used for this input type. The method returns an error if the network data source is ArcGIS Online. The method returns an error if the network data source is an ArcGIS Enterprise portal that does not support using network location fields. | Boolean |
search_tolerance | The maximum search distance to use when locating inputs of the designated type on the network. Specifying a value for this parameter overrides the default searchTolerance property value for the designated input type. If this parameter is not specified or is set to None, the searchTolerance value will be used for this input type. The units of this parameter value are set using the search_tolerance_units parameter; however, if no value is set for that parameter, the search_tolerance value will be interpreted in the units specified in the searchToleranceUnits property. This parameter does not apply to line and polygon barriers; the method will return an error if this parameter is specified when the input_type value is one of these barrier types. | Double |
search_tolerance_units | The units of the maximum search distance when locating inputs of the designated type of the network. The parameter is specified using a member of the DistanceUnits enumeration. Specifying a value for this parameter overrides the default searchToleranceUnits property value for the designated input type. If this parameter is not specified or is set to None, the searchToleranceUnits will be used for this input type. The value specified using the search_tolerance parameter is interpreted using these units. If that parameter is not specified, the value of the searchTolerance property will be interpreted using these units for the designated input type only. This parameter does not apply to line and polygon barriers; the method will return an error if this parameter is specified when the input_type value is one of these barrier types. | Double |
solve ()
| Data Type | Explanation |
| Object | An arcpy.nax.RouteResult object that can be used to access outputs and solver messages. |
Code sample
Perform route analysis using a feature class for input stops.
# An example showing how to perform route analysis using a feature class for input stops.
import arcpy
arcpy.CheckOutExtension("network")
nds = "C:/data/NorthAmerica.gdb/Routing/Routing_ND"
nd_layer_name = "Routing_ND"
input_stops = "C:/data/io.gdb/Stops"
output_routes = "C:/data/io.gdb/Routes"
# Create a network dataset layer and get the desired travel mode for analysis
arcpy.nax.MakeNetworkDatasetLayer(nds, nd_layer_name)
nd_travel_modes = arcpy.nax.GetTravelModes(nd_layer_name)
travel_mode = nd_travel_modes["Driving Time"]
# Instantiate a Route solver object
route = arcpy.nax.Route(nd_layer_name)
# Set properties
route.timeUnits = arcpy.nax.TimeUnits.Minutes
route.travelMode = travel_mode
route.routeShapeType = arcpy.nax.RouteShapeType.TrueShapeWithMeasures
# Load inputs
route.load(arcpy.nax.RouteInputDataType.Stops, input_stops)
# Solve the analysis
result = route.solve()
# Export the results to a feature class
if result.solveSucceeded:
result.export(arcpy.nax.RouteOutputDataType.Routes, output_routes)
else:
print("Solved failed")
print(result.solverMessages(arcpy.nax.MessageSeverity.All))