ClosestFacilityParameters

属性列表

属性详细说明

accumulateAttributes String[]

与分析一起存储的网络属性名称列表，即哪些属性应作为响应的一部分返回。

apiKey String

起始版本: GeoScene API for JavaScript 4.22

用于访问资源或服务的授权字符串。 API 密钥 在 GeoScene Developer 仪表板中生成和管理。API 密钥明确绑定到 GeoScene 帐户；它还用于监视服务使用情况。在特定类上设置细粒度的 API 密钥会覆盖 全局 API 密钥。

示例:

• API 密钥

• 地图教程 - 获取 API 密钥

示例代码:

const start = new Graphic({
  geometry: {
    type: "point",
    x: -13656212.041436872,
    y: 5703897.952531632,
    spatialReference
  }
});

const stores = [
  [-122.67484, 45.52087],
  [-122.68365, 45.52327],
  [-122.66406, 45.52378]
];

const storeGraphics = stores.map(
  (store) =>
    new Graphic({
      geometry: {
        type: "point",
        longitude: store[0],
        latitude: store[1],
        spatialReference
      }
    })
);

const closestFacilityParameters = new ClosestFacilityParameters({
  apiKey: "YOUR_API_KEY",
  incidents: new FeatureSet({
    features: [start]
  }),
  facilities: new FeatureSet({
    features: storeGraphics
  }),
  defaultTargetFacilityCount: 2
});

const results = await solve(url, closestFacilityParameters);

attributeParameterValues Object[]

一组属性参数值，用于确定车辆可以使用哪些网络元素。查看下面的对象规范，了解此数组中各个对象的属性。

属性:

attributeName String 属性的名称。

parameterName String 参数名称。

value String 参数值。

declaredClass Stringreadonly inherited

类名。类的名称声明格式为 geoscene.folder.className。

defaultCutoff Number

用于确定何时停止遍历的截止值。

defaultTargetFacilityCount Number

要查找的设施数量。

directionsLanguage String

生成行车路线时使用的语言。此参数仅在returnDirections 参数设置为true时适用。如果指定了不受支持的语言代码，则服务会使用默认语言返回路线。

directionsLengthUnits String

计算行驶方向时使用的长度单位。此参数仅在returnDirections 参数设置为true 时适用。如果未指定，任务将使用网络道路图层定义的值。

可选值:"centimeters"|"decimal-degrees"|"decimeters"|"feet"|"inches"|"kilometers"|"meters"|"miles"|"millimeters"|"nautical-miles"|"points"|"yards"

directionsOutputType String

定义返回的方向信息数量。默认值为 standard。

可选值:"complete"|"complete-no-events"|"instructions-only"|"standard"|"summary-only"

directionsStyleName String

返回路线时使用的样式。默认值将在网络道路图层中定义。查看网络服务的 REST 图层描述以查看支持的样式列表。

directionsTimeAttribute String

包含行驶时间值的属性字段的名称。如果未指定，任务将使用路由网络道路图层定义的属性字段。

facilities DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

在分析期间作为网络位置加载的设施集。

示例代码:

require([
  "geoscene/layers/GraphicsLayer", "geoscene/rest/support/FeatureSet", "geoscene/rest/support/NetworkUrl", ...
], function(GraphicsLayer, FeatureSet, NetworkUrl, ... ) {
  const facilitiesGraphicsLayer = new GraphicsLayer();

  // Specify facilities using a FeatureSet
  const facilities = new FeatureSet({
    features: facilitiesGraphicsLayer.graphics.toArray()
  });

  params.facilities = new NetworkUrl({
    url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/NetworkAnalysis/SanDiego/MapServer/" +
         "14/query?where=1%3D1&returnGeometry=true&outFields=*&f=json"
  });
});

impedanceAttribute String

在分析中用作阻抗属性的网络属性名称。默认值在您的 道路 中使用的网络道路层中定义 。您可以将服务目录Network Dataset > Network Attributes 中列出的任何属性名称指定为Usage Type: esriNAUTCost。您还可以指定none的值，来指示不应将任何网络属性用于阻抗。如果您指定一个空字符串，它将使用服务的默认值。

例如，设置impedanceAttribute = 'Time'为最快路线和impedanceAttribute = 'Length'最短车程，假设服务具有这两个 esriNAUTCost 属性。

查看 了解网络属性 GeoScene 桌面帮助主题以了解更多详细信息。

incidents DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

分析期间加载为网络位置的事件集。

outputGeometryPrecision Number

输出几何精度。当该值为0时，不执行输出几何的泛化。正值表示generalize 使用的MaximumAllowableOffset参数。

outputGeometryPrecisionUnits String

输出几何精度的单位。

可选值:"centimeters"|"decimal-degrees"|"decimeters"|"feet"|"inches"|"kilometers"|"meters"|"miles"|"millimeters"|"nautical-miles"|"points"|"yards"

outputLines String

要在结果中生成的输出行的类型。默认值在 RouteTask 中使用的特定网络道路图层中定义。

可选值	描述
none	不返回任何行
straight	只返回直线
true-shape	返回线条的真实形状
true-shape-with-measure	返回线条的真实形状及其测量值

可选值:"none"|"straight"|"true-shape"|"true-shape-with-measure"

outSpatialReference SpatialReference|String

与分析结果一起返回的几何图形的空间参考或空间参考对象的 id。如果outSpatialReference未指定，几何图形将在地图的空间参考中返回。

pointBarriers DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

在分析期间加载为网络位置的点障碍集。

polygonBarriers DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

在分析期间加载为网络位置的多边形障碍集。

polylineBarriers DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

在分析期间加载为网络位置的线障碍集。

restrictionAttributes String[]

用作分析限制的网络道路属性名称列表。默认值在 RouteTask 中使用的特定网络道路图层中定义。可能的值列在网络数据集 > 网络属性下的服务目录中。您还可以指定值 none 以指示不应将网络属性用作限制。如果您指定一个空数组，它将默认为服务的默认值。用于["none"]覆盖服务默认值并指定不应使用任何限制。

restrictUTurns String

指定应如何处理 U 形转弯。默认值在模块中使用的特定路由网络层中定义：“esri/rest/closestFacility”。

可选值:"allow-backtrack"|"at-dead-ends-only"|"no-backtrack"|"at-dead-ends-and-intersections"

returnDirections Boolean

指示服务是否应为每条路线生成行车路线。

默认值:false

returnFacilities Boolean

如果为true，设施将与分析结果一起返回。

默认值:false

returnIncidents Boolean

如果为true，事件将与分析结果一起返回。

默认值:false

returnPointBarriers Boolean

如果为true，点障碍将在 ClosestFacilitySolveResult的障碍属性中返回。

默认值:false

returnPolygonBarriers Boolean

如果为true，多边形障碍将在 ClosestFacilitySolveResult的障碍属性中返回。

默认值:false

returnPolylineBarriers Boolean

如果为true，折线障碍将在 ClosestFacilitySolveResult的障碍属性中返回。

默认值:false

returnRoutes Boolean

当为 true 时，将在每个ClosestFacilitySolveResult的 route 属性中生成并返回最近设施点路线 。

默认值:true

timeOfDay Date

到达或离开的日期和时间。例如，如果 travelDirection 设置 to-facility 和timeOfDayUsage 为 end ，并且 timeOfDay 被设置为上午 8:00 , 则返回的路线将设置为在当地时间上午 8:00 到达设施点。

timeOfDayUsage String

定义timeOfDay值的使用方式。默认值在网络道路图层中定义。

可选值:"start"|"end"

travelDirection String

往返设施的选项。默认值由网络道路图层定义。

可选值	描述
from-facility	设置方向为从设施出发
to-facility	设置方向为前往设施

可选值:"from-facility"|"to-facility"

travelMode TravelMode

出行方式代表一种交通工具，例如驾车或步行。出行模式定义了车辆或行人的物理特征。

该travelMode参数的值是 JSON 对象，其中包含您的服务支持的出行模式的设置。要获取支持的出行模式，请执行retrieveTravelModes操作。您可以使用以下表单请求检索出行模式： https://route.geosceneonline.cn/arcgis/rest/services/World/Route/NAServer/Route_World/retrieveTravelModes?f=json

示例:

• 出行方式简介
  

• 默认出行方式
  

• networkService.fetchServiceDescription

useHierarchy Boolean

如果true，则网络的层次属性将用于分析。默认值在最接近设施使用的网络道路图层中被定义。

默认值:false

方法列表

方法详细说明

fromJSON(json){*}static

创建此类的新实例，并使用从 GeoScene 产品生成的 JSON 对象的值对其进行初始化。传递给输入 json 参数的对象通常来自对 REST API 中的查询操作的响应，或者来自另一个 GeoScene产品的 toJSON() 方法。有关何时以及如何使用此函数的详细信息和示例，请参阅指南中的 使用 fromJSON() 主题。

参数:

json Object 实例的 json 表达式，以geoscene 格式显示。

返回值:

类型	描述
*	返回一个该类的新实例。

toJSON(){Object}

将此类的实例转换为 GeoScene portal JSON 格式。 有关更多信息，请参阅 使用 fromJSON() 指南。

返回值:

类型	描述
Object	此类实例的 GeoScene portal JSON 格式。