ListDirectionsStyleNames (arcpy.na)

Summary

Returns a list of the available styles for generating directions from a route created during network analysis. Each directions style is appropriate for a different application.

Discussion

This function can be used in a custom script tool validation to populate a ValueList of available directions styles for the user to choose from, similar to the Directions Style Name parameter of the Find Closest Facilities tool.

Syntax

ListDirectionsStyleNames (network_dataset_path)
ParameterExplanationData Type
network_dataset_path

A variable that references the catalog path of the network dataset. The catalog path of a network dataset can be obtained from the dataSource property of a network dataset layer or a network analysis layer object. It can also be obtained from the catalogPath property of a network dataset describe object.

String
Return Value
Data TypeExplanation
String

The list of available directions styles containing strings representing the styles installed on your machine. It is a subset of the following styles:

  • NA DesktopThis style generates turn-by-turn directions suitable for printing.
  • NA NavigationThis style generates turn-by-turn directions designed for an in-vehicle navigation device.
  • NA CampusThis style generates turn-by-turn directions suitable for indoor and outdoor pedestrian routing.

Code Sample

Reads a network dataset and lists its supported styles.

# Path to an on-disk network dataset
nds = r'C:Data/SanDiego.gdb/Transportation/Streets_ND'

# Create a list of directions styles available in the network dataset
dir_styles = arcpy.na.ListDirectionsStyleNames(nds)

Related Topics

11/11/2014