SuperMap.REST.PathGuideItem

行驶导引子类。 行驶导引由多个行驶导引子项构成,记录了如何一步步从起点行驶到终点,其中每一步就是一个行驶导引子项。 每个分析结果路径 Path 中包含该路径的行驶引导,每个行驶引导子项可以表示一个弧段,一个结点或一个站点,记录了在当前地点转弯情况、行驶方向、耗费等信息。

Summary
SuperMap.REST.PathGuideItem 行驶导引子类。 行驶导引由多个行驶导引子项构成,记录了如何一步步从起点行驶到终点,其中每一步就是一个行驶导引子项。 每个分析结果路径 Path 中包含该路径的行驶引导,每个行驶引导子项可以表示一个弧段,一个结点或一个站点,记录了在当前地点转弯情况、行驶方向、耗费等信息。
Properties
bounds {SuperMap.Bounds} 子对象(弧段或结点或站点)的范围。对弧段而言,为弧段的外接矩形;对点而言,为点本身。
description {String} 行驶引导描述。
directionType {SuperMap.REST.DirectionType} 行驶的方向。共有五个方向,即东、南、西、北、无方向。 当该类中字段 isEdge 为 false 时,即为结点无行驶方向,行驶方向的类型为无方向。
distance {Number} 站点到弧段的距离。该距离是指站点到最近一条弧段的距离。
geometry {SuperMap.Geometry}行驶引导项所对应的地物对象。
id {Number} 行驶导引子项的 ID 号,即 edgeID 或 nodeID。当子项为不在网络上的站点时,此值为-1。
index {Number} 行驶导引子项的序号。
isEdge {Boolean} 判断本行驶导引子项是否是弧段。true 表示行驶导引子项是弧段,false 表示行驶导引子项不是弧段。
isStop {Boolean} 该子项是否为站点。站点为用户指定的用于做路径分析的点,站点可能与网络结点重合,也可能不在网络上。true 表示是站点,false 表示不是站点。
length {Number} 当行驶导引子项为弧段时表示弧段的长度。
name {String} 行驶导引子项的名称。
sideType {SuperMap.REST.SideType} 站点是在路的左侧、右侧还是在路上的常量。 当该类的字段 isEdge 为 true 时将返回 SideType.None,表示无效值。
turnAngle {Number} 转弯角度。单位为度,精确到0.1度。
turnType {SuperMap.REST.TurnType} 转弯方向常量。当该类的字段 isEdge 为 true 时将返回 TurnType.None,表示无效值。
weight {Number} 行驶导引子项的权值,即行使导引对象子项的花费。
Constructor
SuperMap.REST.PathGuideItem 最佳路径分析参数类构造函数。
Functions
destroy 释放资源,将引用资源的属性置空。

Properties

bounds

{SuperMap.Bounds} 子对象(弧段或结点或站点)的范围。对弧段而言,为弧段的外接矩形;对点而言,为点本身。

directionType

{SuperMap.REST.DirectionType} 行驶的方向。共有五个方向,即东、南、西、北、无方向。 当该类中字段 isEdge 为 false 时,即为结点无行驶方向,行驶方向的类型为无方向。

distance

{Number} 站点到弧段的距离。该距离是指站点到最近一条弧段的距离。

id

{Number} 行驶导引子项的 ID 号,即 edgeID 或 nodeID。当子项为不在网络上的站点时,此值为-1。

index

{Number} 行驶导引子项的序号。

isEdge

{Boolean} 判断本行驶导引子项是否是弧段。true 表示行驶导引子项是弧段,false 表示行驶导引子项不是弧段。

isStop

{Boolean} 该子项是否为站点。站点为用户指定的用于做路径分析的点,站点可能与网络结点重合,也可能不在网络上。true 表示是站点,false 表示不是站点。

length

{Number} 当行驶导引子项为弧段时表示弧段的长度。

name

{String} 行驶导引子项的名称。

sideType

{SuperMap.REST.SideType} 站点是在路的左侧、右侧还是在路上的常量。 当该类的字段 isEdge 为 true 时将返回 SideType.None,表示无效值。

turnAngle

{Number} 转弯角度。单位为度,精确到0.1度。

turnType

{SuperMap.REST.TurnType} 转弯方向常量。当该类的字段 isEdge 为 true 时将返回 TurnType.None,表示无效值。

weight

{Number} 行驶导引子项的权值,即行使导引对象子项的花费。

description

{String} 行驶引导描述。

geometry

{SuperMap.Geometry}行驶引导项所对应的地物对象。

Constructor

SuperMap.REST.PathGuideItem

最佳路径分析参数类构造函数。

Parameters

options {Object} 参数。

Allowed options properties

bounds {SuperMap.Bounds} 子对象(弧段或结点或站点)的范围。
description {String} 行驶引导描述。
geometry {SuperMap.Geometry} 行驶引导项所对应的地物对象。
directionType {SuperMap.REST.DirectionType} 行驶的方向。
distance {Number} 站点到弧段的距离。
id {Number} 行驶导引子项的 ID 号,即 edgeID 或 nodeID。
index {Number} 行驶导引子项的序号。
isEdge {Boolean} 判断本行驶导引子项是否是弧段。
isStop {Boolean} 该子项是否为站点。
length {Number} 当行驶导引子项为弧段时表示弧段的长度。
name {String} 行驶导引子项的名称。
sideType {SuperMap.REST.SideType} 站点是在路的左侧、右侧还是在路上的常量。
turnAngle {Number} 转弯角度。单位为度,精确到0.1度。
turnType {SuperMap.REST.TurnType} 转弯方向常量。
weight {Number} 行驶导引子项的权值,即行使导引对象子项的花费。

Functions

destroy

destroy: function()

释放资源,将引用资源的属性置空。

表示边界类实例。使用bounds之前需要设置left,bottom, right, top四个属性,这些属性的初始值为null。
{Object} 网络分析中方向枚举类。 在行驶引导子项中使用。
{Object} 行驶位置枚举类。 表示在行驶在路的左边、右边或者路上的枚举,该类用在行驶导引子项类中。
{Object} 转弯方向枚举类。 用在行驶引导子项类中,表示转弯的方向。
几何对象类,描述地理对象的几何图形。
destroy: function()
释放资源,将引用资源的属性置空。
Close