ServiceAreaParameters

属性概述

属性详细信息

accumulateAttributes String[]

使用此属性可指定操作是否应累积为 impedanceAttribute 指定的值以外的值。例如，如果您的 impedanceAttribute 设置为 travel-time，则该路径的总行驶时间将由操作计算。但是，如果您还想计算路径的总距离 (以英里为单位)，则可将 Miles 指定为 accumulateAttributes 属性的值。

可能值："kilometers"|"miles"|"minutes"|"travel-time"|"truck-minutes"|"truck-travel-time"|"walk-time"|"string"

apiKey String

起始版本：GeoScene Maps SDK for JavaScript 4.21

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

另请参阅

• API 密钥

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

• token

示例

// Compute the service area for a 2km walking distance.
const url = "https://route-api.geoscene.cn/geoscene/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 AttributeParameterValue[]

使用此属性可指定属性或限制条件所需的其他值，例如指定限制条件是禁止、避免还是偏爱在受限道路上行驶。如果该限制要避免或首选道路，您可以使用此属性进一步指定要避免或首选的程度。例如，您可以选择从不使用收费公路，尽可能的避开它们，或首选它们。

declaredClass Stringreadonly inherited

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

defaultBreaks Number[]

使用此参数可指定为每个设施点生成的服务区的大小和数量。服务会根据该参数的单位生成基于行驶时间或行驶距离的服务区域。如果单位基于时间，则服务区域是基于沿基础街道的出行时间生成的。如果单位基于距离，则服务区域是基于行驶距离生成的。

此参数的单位基于使用 impedanceAttributeName 参数指定的阻抗属性的单位，或者如果指定了出行模式，则使用出行模式的 impedanceAttributeName。如果 impedanceAttributeName 参数为 travel-time，则指定为 defaultBreaks 参数的值将表示为以分钟为单位，且服务生成基于时间的服务区域。否则，基于是否将 impedanceAttributeName 分别设置为 miles 或 kilometers，值将解释为以英里或公里为单位，且服务生成基于距离的服务区域。

excludeSourcesFromPolygons String[]

生成多边形时不使用的网络源名称数组。

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

facilities DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

在其周围生成服务区的输入位置。

geometryPrecision Number

起始版本：GeoScene Maps SDK for JavaScript 4.25

使用此属性可指定求解操作返回的响应几何中的小数位数。这仅适用于 x 和 y 值（不适用于 m 或 z 值）。

geometryPrecisionM Number

起始版本：GeoScene Maps SDK for JavaScript 4.25

使用此属性可指定求解操作返回的响应几何中的小数位数。这仅适用于 m 值（不适用于 x、y 值或 z 值）。

geometryPrecisionZ Number

起始版本：GeoScene Maps SDK for JavaScript 4.25

使用此属性可指定求解操作返回的响应几何中的小数位数。这仅适用于 z 值（不适用于 x、y 值或 m 值）。

ignoreInvalidLocations Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.25

指示在查找最佳解决方案时，是否应忽略无效输入位置。如果输入点不在任何可遍历街道的最大捕捉容差范围内，则该操作将其视为无效。为 true 时，将忽略无效点。为 false 时，则请求中的任何无效点都将导致操作返回失败。

impedanceAttribute String

指定阻抗。

阻抗是一个值，可量化沿交通网络的行程。行程距离是阻抗的一个示例；它量化了人行道和路段的长度。类似地，行驶时间 (沿路段行驶的典型时间) 也是阻抗的一个示例。如果设置了 travelMode，则必须忽略此属性。

可能值："kilometers"|"miles"|"minutes"|"travel-time"|"truck-minutes"|"truck-travel-time"|"walk-time"

另请参阅

• 了解网络属性

• impedanceAttributeName

mergeSimilarPolygonRanges Boolean

使用此参数可指定来自具有相同中断值的不同设施点的服务区是应连接在一起，还是应按中断值拆分。

如果为 true，则具有相同中断值的多个设施点的服务区面将被合并在一起，从而按中断值形成单个面要素。

如果为 false，则具有相同中断值的多个设施点的服务区面将保持为独立的面要素。

outputGeometryPrecision Number

使用此属性可指定要对操作返回的路径几何进行简化的程度。简化将保留路径上定义路径基本形状所需的关键点（例如交点处的转弯）而移除其他点。当您传入 travelMode 时，无论您是依赖默认值还是显式设置值，此属性的值都会被覆盖。

单位由 outputGeometryPrecisionUnits 参数指定。

outputGeometryPrecisionUnits String

使用此属性为 outputGeometryPrecision 参数指定的值指定单位。当您传入 travelMode 时，无论您是依赖默认值还是显式设置值，此参数的值都会被覆盖。

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

outputLines String

使用此属性可指定操作输出的路径要素的类型。仅当 returnRoutes 参数设置为 true 时，此参数才适用。

可能值	描述
none	不返回任何路径形状。
straight	在停靠点之间返回一条直线。
true-shape	返回基于基础街道的生成路径的精确形状。
true-shape-with-measure	返回基于基础街道的生成路径的精确形状，并包括路线测量值，以跟踪路径相对于第一个停靠点的累计行驶时间或行驶距离。

可能值："none"|"straight"|"true-shape"|"true-shape-with-measure"

outputPolygons String

此参数可设置是否应返回服务区多边形及其细节级别。

可能值	描述
none	不生成服务区。在您不想围绕设施点生成区域，而只想生成服务区线的情况下，这很有用。
detailed	生成详细服务区。
simplified	生成概化的服务区。

可能值："none"|"simplified"|"detailed"

outSpatialReference SpatialReference

使用此属性可指定求解操作返回的几何的空间参考，例如线或点要素。

overlapLines Boolean

指定不同设施点的服务区线是否可以相互重叠。

如果为 true，则服务区线可以彼此重叠。如果为 false，则来自一个设施点的服务区线不能与来自另一设施点的服务区线重叠。

overlapPolygons Boolean

指定不同设施点的服务区是否可以相互重叠。

如果为 true，则服务区可以彼此重叠。如果为 false，则来自一个设施点的服务区不能与来自另一设施点的服务区重叠。

overrides Object

起始版本：GeoScene Maps SDK for JavaScript 4.25

指定其他设置，这些设置在求解网络分析问题时可能会影响求解程序的行为。

pointBarriers Collection<PointBarrier>|DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

使用此属性可指定一个或多个点，以作为临时限制或表示在基础街道上行驶可能需要的额外时间或距离。例如，点障碍可以用来表示沿街道倒下的树或在铁路交叉口花费的时间延迟。

polygonBarriers Collection<PolygonBarrier>|DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

使用此属性指定面，用于完全限制通行或按比例调整行驶在与面相交的街道上所需的行驶时间或距离。

polylineBarriers Collection<PolylineBarrier>|DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

使用此属性可指定一个或多个禁止沿线与街道相交的任何地方行驶的线。例如，可以使用线障碍来模拟阻塞多个街道段的交通的游行或抗议。

preserveObjectID Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.25

使用此属性指定当输入位置作为输出返回时，是否应保留为输入位置 (如停靠点或障碍点) 指定的对象 ID。

restrictionAttributes String[]

使用此属性可指定操作应遵循的限制。限制表示驾驶偏好或要求。如果指定了 travelMode，则忽略此值。

可能值："any-hazmat-prohibited"|"avoid-carpool-roads"|"avoid-express-lanes"|"avoid-ferries"|"avoid-gates"|"avoid-limited-access-roads"|"avoid-private-roads"|"avoid-roads-unsuitable-for-pedestrians"|"avoid-stairways"|"avoid-toll-roads"|"avoid-toll-roads-for-trucks"|"avoid-truck-restricted-roads"|"avoid-unpaved-roads"|"axle-count-restriction"|"driving-a-bus"|"driving-a-taxi"|"driving-a-truck"|"driving-an-automobile"|"driving-an-emergency-vehicle"|"height-restriction"|"kingpin-to-rear-axle-length-restriction"|"length-restriction"|"preferred-for-pedestrians"|"riding-a-motorcycle"|"roads-under-construction-prohibited"|"semi-or-tractor-with-one-or-more-trailers-prohibited"|"single-axle-vehicles-prohibited"|"tandem-axle-vehicles-prohibited"|"through-traffic-prohibited"|"truck-with-trailers-restriction"|"use-preferred-hazmat-routes"|"use-preferred-truck-routes"|"walking"|"weight-restriction"|"string"

restrictUTurns String

指定应如何处理 U 形转弯。

可能值	描述
allow-backtrack	可在任何地方进行 U 形转弯。允许 U 形转弯表示车辆可以在交汇点处转向并沿同一街道原路返回。
at-dead-ends-only	在所有交汇点和十字路口禁止 U 形转弯，仅在死胡同时才被允许。
no-backtrack	在所有交汇点、交叉点和死胡同处禁止 U 行转弯。
at-dead-ends-and-intersections	在恰好两条相邻街道的交汇点处禁止 U 形转弯。

可能值："allow-backtrack"|"at-dead-ends-only"|"no-backtrack"|"at-dead-ends-and-intersections"

returnFacilities Boolean

确定服务是否返回设施点。

returnPointBarriers Boolean

指定路径操作是否返回点障碍。

returnPolygonBarriers Boolean

指定路径操作是否返回面障碍。

returnPolylineBarriers Boolean

指定路径操作是否返回折线障碍。

splitLinesAtBreaks Boolean

指定服务区线是否应在中断值处分割。

如果为 true，则与中断相交的服务区线将拆分为两条线。如果希望按中断值可视化服务区线，这将非常有用。

splitPolygonsAtBreaks Boolean

指定是将围绕设施点的多个服务区作为圆盘创建还是作为圆环创建。

如果为 true，则较大服务区不包括较小的服务区。如果为 false，则服务区是独立的，并且可能相互重叠。

timeOfDay Date|String

指定离开或到达事件点或设施点的时间和日期。您还可以指定一个 "now” 值，以将离开或到达时间设置为当前时间。

对于 ServiceAreaParameters，timeOfDay 总是 "now"。

timeOfDayIsUTC Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.25

指定 timeOfDay 属性的一个或多个时区。

travelDirection String

指定用于生成服务区面的行驶方向是朝向还是远离设施点。行程方向可以改变面的形状，因为街道两侧的阻抗可能不同，或者可能存在单向约束，例如单行道。

可能值	描述
from-facility	在远离设施点的方向上生成服务区。
to-facility	在朝向设施点的方向上创建服务区。

可能值："from-facility"|"to-facility"

travelMode TravelMode

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

使用 networkService.fetchServiceDescription 可获取预定义的出行模式列表，在路径请求中未指定出行模式的情况下，使用默认出行模式。

trimOuterPolygon Boolean

指定是否修剪服务。

如果为 true，则将修剪服务区域。当您在街道网络非常稀疏的地点查找服务区且不需要服务区覆盖大片没有街道要素的区域时，此选项很有用。

当 useHierarchy 参数设置为 true 时，将忽略此参数值。

trimPolygonDistance Number

该属性定义可从网络到达的距离。

如果 trimOuterPolygon 为 false 或 useHierarchy 为 true，则忽略此属性。

trimPolygonDistanceUnits String

为指定 trimPolygonDistance 的值指定单位。

如果 trimOuterPolygon 为 false 或 useHierarchy 为 true，则忽略此属性。

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

useHierarchy Boolean

指定在查找最短路径时是否使用等级。如果指定了 travelMode，则忽略此值。

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

groupKey * optional 标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

clone(){this}

创建此对象的深度克隆。任何通过引用存储值的属性都将被分配克隆实例上引用值的副本。

返回

类型	描述
this	调用此方法的类实例的深度克隆。

fromJSON(json){*}static

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

参数

json Object GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例，请参阅 GeoScene REST API 文档。

返回

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

hasHandles(groupKey){Boolean}inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组，则返回 true。

参数

groupKey * optional 组键。

返回

类型	描述
Boolean	如果存在指定的句柄组，则返回 true。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

groupKey * optional 要移除的组键或组键的数组或集合。

示例

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON(){Object}

将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息，请参阅使用 fromJSON() 指南主题。

返回

类型	描述
Object	此类实例的 GeoScene Portal JSON 表示。

类型定义

AttributeParameterValue

一个对象，用于描述 ServiceAreaParameters 的 attributeParameterValues 属性的参数值。

属性

attributeName String 限制的名称。

parameterName String 与限制相关的参数名称。限制可具有一个或多个 parameterName 属性。

value String|Number parameterName 的值。