RouteInfo

AMD: require(["geoscene/rest/support/RouteInfo"], (RouteInfo) => { /* code goes here */ });
ESM: import RouteInfo from "@geoscene/core/rest/support/RouteInfo";
类: geoscene/rest/support/RouteInfo
继承于:RouteInfo Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.23

RouteInfo 包含有关已求解路径的信息,包括路径几何以及总距离和时间。

另请参阅
示例
// Display the route name and overall distance and duration.
const routeLayer = new RouteLayer({
  portalItem: {
    id: "69569b47b1e445b8a42ec12feab41ce9"
  }
});
await routeLayer.load();

const locale = "en-US";
const formatMinutes = new Intl.NumberFormat(locale, {
  minimumFractionDigits: 1,
  maximumFractionDigits: 1
});
const formatDistance = new Intl.NumberFormat(locale, {
  minimumFractionDigits: 0,
  maximumFractionDigits: 0
});
const formatDate = new Intl.DateTimeFormat(locale, {
  year: 'numeric',
  month: 'numeric',
  day: 'numeric',
  hour: 'numeric',
  minute: 'numeric',
  second: 'numeric',
  timeZone: "America/Los_Angeles"
});

const { name, startTime, endTime, totalDistance, totalDuration } = routeLayer.routeInfo;
console.log(`Route name:      ${name}`);
console.log(`Start Time:      ${formatDate.format(startTime)}`);
console.log(`End Time:        ${formatDate.format(endTime)}`);
console.log(`Travel Time:     ${formatMinutes.format(totalDuration)} minutes`);
console.log(`Travel Distance: ${formatDistance.format(totalDistance)} meters`);

// Route name:      Kenoak Pl, Pomona, California, 91768 — 16561 Valley Blvd, Fontana, California, 92335
// Start Time:      12/7/2020, 3:58:50 PM
// End Time:        12/7/2020, 6:12:20 PM
// Travel Time:     133.5 minutes
// Travel Distance: 173,148 meters

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

类的名称。

更多详情
Accessor
Date

路径的结束时间。

更多详情
RouteInfo
Number

结束时间的本地时间偏移量 (以分钟为单位)。

更多详情
RouteInfo
Polyline

表示路径几何的折线。

更多详情
RouteInfo
String

用户指定的路径名称。

更多详情
RouteInfo
Date

路径的开始时间。

更多详情
RouteInfo
Number

开始时间的本地时间偏移量 (以分钟为单位)。

更多详情
RouteInfo
Number

以米为单位的总行驶距离。

更多详情
RouteInfo
Number

总时间 (以分钟为单位)。

更多详情
RouteInfo
String对于 RouteInfo,类型总是 "route-info"更多详情RouteInfo

属性详细信息

declaredClass Stringreadonly inherited

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

endTime Date

路径的结束时间。

endTimeOffset Number

结束时间的本地时间偏移量 (以分钟为单位)。

geometry Polyline

表示路径几何的折线。

name String

用户指定的路径名称。

startTime Date

路径的开始时间。

startTimeOffset Number

开始时间的本地时间偏移量 (以分钟为单位)。

totalDistance Number

以米为单位的总行驶距离。

totalDuration Number

总时间 (以分钟为单位)。

type Stringreadonly

对于 RouteInfo,类型总是 "route-info"

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象的生命周期相关联的句柄。

更多详情
Accessor
RouteInfo

从已解析的 Graphic 创建 RouteInfo

更多详情
RouteInfo
*

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。

更多详情
RouteInfo
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Graphic

基于 RouteInfo 实例创建 Graphic

更多详情
RouteInfo
Object

将此类的实例转换为 GeoScene Portal JSON 表示。

更多详情
RouteInfo

方法详细说明

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() 进行删除。如果未提供键,则句柄将被添加到默认组。

fromGraphic(graphic){RouteInfo}static
起始版本:GeoScene Maps SDK for JavaScript 4.24

从已解析的 Graphic 创建 RouteInfo。此方法假设图形的属性符合路径图层项目模式。

参数
graphic Graphic
optional

Graphic 实例。

返回
类型 描述
RouteInfo RouteInfo 实例。
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");
toGraphic(){Graphic}
起始版本:GeoScene Maps SDK for JavaScript 4.24

基于 RouteInfo 实例创建 Graphic。结果图形将具有符合路径图层项目模式的属性。

返回
类型 描述
Graphic Graphic 实例。
toJSON(){Object}

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

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

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息