描述 (Network Analyst)

描述

根据包含路径的网络分析图层生成转弯方向。可以将这些方向信息写入到文本、XML 或 HTML 格式的文件中。如果提供了适合的样式表，也可以将这些方向写入其他任何文件格式。

使用方法

• 使用工具时如果未得到有效结果，那么该工具会自动求解网络分析图层，因此在生成方向之前，您不需要先求解网络分析图层。

语法

arcpy.na.Directions(in_network_analysis_layer, file_type, out_directions_file, report_units, {report_time}, {time_attribute}, {language}, {style_name}, {stylesheet})

参数	说明	数据类型
in_network_analysis_layer	将生成方向信息的网络分析图层。只能为路径、最近设施点和车辆配送网络分析图层生成方向信息。	Network Analyst Layer
file_type	输出方向文件的格式。如果样式表参数中具有值，则会忽略此参数。 XML —将以 XML 文件的形式生成输出方向文件。除了路径的方向字符串和长度及时间信息外，该文件还包含有关每个方向的行进策略类型和转弯角度的信息。 TEXT —将以简单 TXT 文件的形式生成输出方向文件，其中包含路径的方向字符串和长度信息，另外还可包含路径的时间信息。 HTML —将以 HTML 文件的形式生成输出方向文件，其中包含路径的方向字符串和长度信息，另外还可包含路径的时间信息。	String
out_directions_file	如果在 stylesheet 参数中提供样式表，应确保 out_directions_file 的文件后缀与样式表生成的文件类型匹配。	File
report_units	指定在方向文件中报告长度信息时所使用的线性单位。例如，即使阻抗的单位是米，您也可以选择使用英里显示方向。 Feet —英尺 Yards —码 Miles —英里 Meters —米 Kilometers —千米 NauticalMiles —海里	String
report_time （可选）	NO_REPORT_TIME —在方向文件中不报告行驶时间。 REPORT_TIME —在方向文件中报告行驶时间。这是默认设置。	Boolean
time_attribute （可选）	用于提供方向中各行驶时间的基于时间的成本属性。输入网络分析图层所使用的网络数据集中必须存在成本属性。	String
language （可选）	选择生成驾车方向时所使用的语言。 此参数的输入应为两位或五位字符语言代码，表示用于方向生成的可用语言之一。在 Python 中，可使用 ListDirectionsLanguages 函数检索可用语言代码列表。	String
style_name （可选）	选择方向的格式化样式名称。 NA Desktop —可打印转弯方向 NA Navigation —针对车辆内导航设备设计的转弯方向 NA Campus —转弯行走方向，用于人行道	String
stylesheet （可选）	生成格式化输出文件类型（如 PDF、Word 或 HTML 文件）的样式表。输出方向文件参数中的文件后缀应与样式表所生成的文件类型相匹配。如果此参数中包含了参数值，则方向工具会重写输出文件类型参数。 提示： 如果想要领先创建自有文本和 HTML 样式表，请复制和编辑 Network Analyst 使用的样式表。它们位于以下目录中：<ArcGIS installation directory>\ArcGIS\ArcGIS Pro\Resources\NetworkAnalyst\Directions\Styles。样式表为 Dir2PHTML.xsl，文本样式表为 Dir2PlainText.xsl。	File

派生输出

名称	说明	数据类型
output_layer	具有路径的更新网络分析图层。	网络分析图层

代码示例

Directions 示例 1（Python 窗口）

使用所有参数执行“方向”工具。

arcpy.na.Directions("Route", "TEXT", "C:/Data/Route_Directions.txt", "Miles",
                    "REPORT_TIME", "Minutes")

Directions 示例 2（工作流）

以下独立 Python 脚本演示了如何使用 Directions 工具中为某条路径生成一个 HTML 文件格式的驾车方向。

# Name: Directions_Workflow.py
# Description: Generate driving directions in an html file for a route that
#              visits the store locations in the best sequence in order to
#              minimize the total travel time
# Requirements: Network Analyst Extension

#Import system modules
import arcpy
from arcpy import env
import os

try:
    #Check out Network Analyst license if available. Fail if the Network Analyst license is not available.
    if arcpy.CheckExtension("network") == "Available":
        arcpy.CheckOutExtension("network")
    else:
        raise arcpy.ExecuteError("Network Analyst Extension license is not available.")
    
    #Set environment settings
    output_dir = "C:/Data"
    #The NA layer's data will be saved to the workspace specified here
    env.workspace = os.path.join(output_dir, "Output.gdb")
    env.overwriteOutput = True

    #Set inputs and outputs
    input_gdb = "C:/Data/SanFrancisco.gdb"
    network = os.path.join(input_gdb, "Transportation", "Streets_ND")
    layer_name = "StoreRoute"
    travel_mode = "Driving Time"
    start_location = os.path.join(input_gdb, "Analysis", "DistributionCenter")
    store_locations = os.path.join(input_gdb, "Analysis", "Stores")
    output_directions = os.path.join(output_dir,
                                                layer_name + "_Directions.html")
    output_layer_file = os.path.join(output_dir, layer_name + ".lyrx")

    #Create a new route layer. The route starts at the distribution center and
    #visits the stores in the best order to yield the shortest travel time.
    result_object = arcpy.na.MakeRouteAnalysisLayer(network, layer_name,
                                        travel_mode, "PRESERVE_FIRST",
                                        time_of_day="8:00 AM")

    #Get the layer object from the result object. The route layer can
    #now be referenced using the layer object.
    layer_object = result_object.getOutput(0)

    #Get the names of all the sublayers within the route layer.
    sublayer_names = arcpy.na.GetNAClassNames(layer_object)
    #Stores the layer names that we will use later
    stops_layer_name = sublayer_names["Stops"]

    #Load the distribution center as the start location using default field
    #mappings and search tolerance
    arcpy.na.AddLocations(layer_object, stops_layer_name, start_location, "",
                                                                            "")

    #Load the store locations as stops. Make sure the store locations are
    #appended to the Stops sublayer so the distribution center you just loaded
    #isn't overwritten. Map the ServiceTime field from the input data to the
    #Attr_[impedance] property in the Stops sublayer so that the time it takes to
    #service each store is included in the total travel time for the route.
    #Figure out what the impedance attrbute is
    solver_props = arcpy.na.GetSolverProperties(layer_object)
    impedance = solver_props.impedance
    #Handle field mappings
    field_mappings = arcpy.na.NAClassFieldMappings(layer_object,
                                                            stops_layer_name)
    field_mappings["Name"].mappedFieldName = "Name"
    field_mappings["Attr_" + impedance].mappedFieldName = "ServiceTime"
    arcpy.na.AddLocations(layer_object, stops_layer_name, store_locations,
                          field_mappings, "", append="APPEND",
                          exclude_restricted_elements = "EXCLUDE")

    #Generate driving directions in an HTML file
    arcpy.na.Directions(layer_object, "HTML", output_directions, "Miles",
                        "REPORT_TIME", impedance)

    #Save the solved na layer as a layer file on disk
    layer_object.saveACopy(output_layer_file)

    print("Script completed successfully")

except Exception as e:
    # If an error occurred, print line number and error message
    import traceback, sys
    tb = sys.exc_info()[2]
    print("An error occurred on line %i" % tb.tb_lineno)
    print(str(e))

环境

当前工作空间

许可信息

• Basic: 需要 Network Analyst
• Standard: 需要 Network Analyst
• Advanced: 需要 Network Analyst