ServiceAreaParameters

属性列表

属性详细说明

accumulateAttributes String[]

与分析一起累积的网络属性名称列表（即哪些属性应作为响应的一部分返回）。默认值在您的路线中使用的特定路由网络层中定义。您可以将服务目录中列出的任何属性名称指定 Network Dataset > Network Attributes为Usage Type: esriNAUTCost。

apiKey String

起始版本: GeoScene API for JavaScript 4.22

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

示例:

• API 密钥

• 显示地图教程 - 获取 API 密钥

示例代码:

// Compute the service area for a 2km walking distance.
const url = "https://route-api.geoscene.cn/arcgis/rest/services/World/ServiceAreas/NAServer/ServiceArea_World";
const apiKey = "abcdefghijklmnopqrstuvwxyz";
const spatialReference = SpatialReference.WebMercator;

const start = new Graphic({
  geometry: {
    type: "point",
    x: -13039204.060165292,
    y: 4031816.239573444,
    spatialReference
  },
  symbol: {
    type: "simple-marker",
    color: "white",
    size: 8
  }
});

const networkDescription = await fetchServiceDescription(url, apiKey);
const travelMode = networkDescription.supportedTravelModes.find(
  (travelMode) => travelMode.name === "Walking Distance"
);

const serviceAreaParameters = new ServiceAreaParameters({
  apiKey,
  facilities: new FeatureSet({
    features: [start]
  }),
  defaultBreaks: [2.5],
  travelMode,
  travelDirection: "to-facility",
  outSpatialReference: spatialReference,
  trimOuterPolygon: true
});

const results = await solve(url, serviceAreaParameters);

attributeParameterValues Object[]

一组属性参数值，可以参数化以确定车辆可以使用哪些网络元素。将保存车辆特性的参数与来自描述符属性的值进行比较，以确定网络元素是否可遍历。例如，参数化限制属性可以将您的车辆高度与一个描述符属性进行比较，该描述符属性在通过隧道的立交桥下保持间隙。如果车辆的高度大于净空，则边缘受到限制。

也可以使用引用其他成本属性并对其进行缩放的参数化成本属性。当冰、雾或大雨等恶劣天气降临研究区域并阻碍正常交通时，这很有用。通过在成本属性上配备参数，可以根据交通速度的变化调整旅行时间预期和可穿越的网络路径。

declaredClass Stringreadonly inherited

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

defaultBreaks Number[]

定义中断的数字数组。默认值在网络分析图层中定义。

excludeSourcesFromPolygons String[]

生成多边形时不使用的网络源名称数组。此属性指定是否应从服务区多边形生成中排除某些网络源。如果从多边形中排除其他模式，则仅使用一种模式来计算服务区的多模式网络上的服务区将获得更合适的形状。

facilities DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

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

impedanceAttribute String

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

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

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

mergeSimilarPolygonRanges Boolean

如果为true，相似的范围将被合并到生成的多边形中。

默认值:false

outputGeometryPrecision Number

标准化后输出几何的精度。如果为0，则不执行输出几何的标准化。如果存在且为正，则表示MaximumAllowableOffset参数，并且根据 IPolycurve.Generalize 进行标准化。

outputGeometryPrecisionUnits String

输出几何精度的单位。

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

outputLines String

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

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

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

示例:

• outputLines

outputPolygons String

要在结果中生成的输出多边形的类型。默认值在您的 serviceArea中使用的特定路线网络道路图层中定义。

可选值:"none"|"simplified"|"detailed"

outSpatialReference SpatialReference

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

overlapLines Boolean

指示线条是否应与多个设施重叠。默认值由 serviceArea中的网络道路分析图层定义。

默认值:false

overlapPolygons Boolean

指示多边形是否应与多个设施重叠。默认值由 serviceArea中的网络道路分析图层定义。

默认值:false

pointBarriers DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

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

polygonBarriers DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

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

polylineBarriers DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

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

restrictionAttributes String[]

用作分析限制的网络属性名称列表。默认值在您的 路线 中使用的特定路由网络层中定义 。您可以将服务目录中列出的任何属性名称指定Network Dataset > Network Attributes为Usage Type: esriNAUTCost。

restrictUTurns String

指定应如何处理 U 形转弯。默认值在 RouteTask 中使用的路由网络层中定义。

可选值	描述
allow-backtrack	允许在任何地方 U 形转弯
at-dead-ends-only	只允许在死角掉头
no-backtrack	限制掉头
at-dead-ends-and-intersections	只允许在死角和路口掉头

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

returnFacilities Boolean

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

默认值:false

returnPointBarriers Boolean

如果为 true，点障碍将在分析结果的pointBarriers 属性中被返回。

默认值:false

returnPolygonBarriers Boolean

如果为 true，多边形障碍将在分析结果的 polygonBarriers 属性中被返回。

默认值:false

returnPolylineBarriers Boolean

如果为 true，线障碍将在分析结果的 polylineBarriers 属性中被返回。

默认值:false

splitLinesAtBreaks Boolean

如果为true，行将在中断处拆分。

默认值:false

splitPolygonsAtBreaks Boolean

如果为true，多边形将在中断处被拆分。

默认值:false

timeOfDay Date

设施的当地日期和时间。如果travelDirection = "to-facility"，则该timeOfDay值指定到达设施的时间。如果travelDirection = "from-facility"， timeOfDay则指定从设施出发的时间。

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

示例:

• Introduction to travel modes

• Default travel modes

• networkService.fetchServiceDescription

trimOuterPolygon Boolean

如果为true，将修剪最外面的多边形（在最大中断值处）。默认值在您的 serviceArea的网络分析层中定义。

默认值:false

trimPolygonDistance Number

如果正在修剪多边形，则提供要修剪的距离。默认值在网络分析图层中定义。

trimPolygonDistanceUnits String

如果正在修剪多边形，请指定 trimPolygonDistance的单位。默认值在网络分析图层中定义。

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

useHierarchy Boolean

如果为true，将在分析中使用网络的层次属性。默认值在网络层中定义。 useHierarchy不能与outputLines结合使用。

方法列表

方法详细说明

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 格式。