退后点
这个软件包提供了核心功能来检索World Imagery Wayback存档的所有版本,或者找到包含本地变化的版本. 它是该图书馆使用的基础库 Esri 世界影像回路应用。 。 。 .
目录
安装
使用软件包安装 npm 命令如下:
npm install @esri/wayback-core
API 文档
getWaybackItems
返回一个列表 WaybackItem 用于 World Imagery Wayback 从Wayback 存档中释放/版本。 出品列表按出出品日期顺序排序(最新出品为第一品).
参数数字 :
无
回返数字 :
| 类型 | 说明 |
|---|---|
| 承诺 <返回项目[ >] | 解决后,返回一个列表 WaybackItem 按发布日期顺序排序. |
示例数字 :
import {
getWaybackItems,
} from '@esri/wayback-core';
const waybackItems = await getWaybackItems();
以下是回复的例子: getWaybackItems()数字 :
[
{
"itemID":"f5f90c7419f24ceda396088f4e39ae83",
"itemTitle":"World Imagery (Wayback 2023-12-07)",
"itemURL":"https://wayback.maptiles.arcgis.com/arcgis/rest/services/World_Imagery/WMTS/1.0.0/default028mm/MapServer/tile/56102/{level}/{row}/{col}",
"metadataLayerUrl":"https://metadata.maptiles.arcgis.com/arcgis/rest/services/World_Imagery_Metadata_2023_r11/MapServer",
"metadataLayerItemID":"be19e857134046638a10dc2886a5398b",
"layerIdentifier":"WB_2023_R11",
"releaseNum":56102,
"releaseDateLabel":"2023-12-07",
"releaseDatetime": 1701936000000,
},
//...
]
getWaybackItemsWithLocalChanges
返回一个列表 WaybackItem 带有特定地理点在特定缩放级的局部变化.
参数数字 :
| 参数 | 类型 | 需求 | 默认 | 说明 |
|---|---|---|---|---|
point | { latitude: number; longitude: number; } | 对 | —— 说 | 有关地点的地理坐标(经度和纬度)(例如, {longitude: -100.05, latitude: 35.10}(中文(简体) ) |
zoom | number | 对 | —— 说 | 用于确定地理点详细程度的缩放级 |
options.signal | AbortSignal | 没有 | —— 说 | 一个 AbortSignal 以取消操作。 如果中止,函数会丢出错误. |
options.onlyUseSizeToFilterDuplicates | boolean | 没有 | false | 何时 true,重复的释放单由瓦片大小过滤,而不获取图像数据。 这可以显著地改善性能,但可能导致一些独特的发布被错误地排除在外. |
回返数字 :
| 类型 | 说明 |
|---|---|
Promise<WaybackItem[]> | 解决后,返回一个列表 WaybackItem 带有本地变化. |
示例数字 :
import {
getWaybackItemsWithLocalChanges
} from '@esri/wayback-core';
const waybackItems = await getWaybackItemsWithLocalChanges(
{
longitude: 117.1825,
latitude: 34.0556,
},
15
);
有选项的示例数字 :
const controller = new AbortController();
const waybackItems = await getWaybackItemsWithLocalChanges(
{
longitude: 117.1825,
latitude: 34.0556,
},
15,
{
signal: controller.signal,
onlyUseSizeToFilterDuplicates: true,
}
);
以下是回复的例子: getWaybackItemsWithLocalChanges()数字 :
[
{
"itemID":"f5f90c7419f24ceda396088f4e39ae83",
"itemTitle":"World Imagery (Wayback 2023-12-07)",
"itemURL":"https://waybackdev.maptiles.arcgis.com/arcgis/rest/services/World_Imagery/WMTS/1.0.0/default028mm/MapServer/tile/56102/{level}/{row}/{col}",
"metadataLayerUrl":"https://metadatadev.maptiles.arcgis.com/arcgis/rest/services/World_Imagery_Metadata_2023_r11/MapServer",
"metadataLayerItemID":"be19e857134046638a10dc2886a5398b",
"layerIdentifier":"WB_2023_R11",
"releaseNum":56102,
"releaseDateLabel":"2023-12-07",
"releaseDatetime": 1701936000000,
},
//...
]
getMetadata
查询与给定的回路发布/版本相关的回路元数据功能服务,以获取世界图像回路元数据在指定位置和缩放级别的信息(获取日期,提供者,分辨率等).
参数数字 :
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
point | { latitude: number; longitude: number; } | 对 | 有关地点的地理坐标(经度和纬度)(例如, {longitude: -100.05, latitude: 35.10}(中文(简体) ) |
zoom | number | 对 | 缩放级别 |
releaseNumber | number | 对 | 给定回路的发布/版本的发布编号 。 (您可以从 WaybackItem(中文(简体) ) |
options.signal | AbortSignal | 没有 | 一个 AbortSignal 取消请求。 如果中止,函数会丢出错误. |
回返数字 :
| 类型 | 说明 |
|---|---|
承诺 <WaybackMetadata> 翻译: | 解析后,返回 WaybackMetadata |
示例数字 :
import { getMetadata } from '@esri/wayback-core';
const metadata = await getMetadata(
{
longitude: 117.1825,
latitude: 34.0556,
},
15,
56102,
);
有选项的示例数字 :
const controller = new AbortController();
const metadata = await getMetadata(
{
longitude: 117.1825,
latitude: 34.0556,
},
15,
56102,
{
signal: controller.signal,
}
);
以下是回复的例子: getMetadata()数字 :
{
"date": 1680307200000,
"provider": 'Maxar',
"source": 'WV03',
"resolution": 0.3,
"accuracy": 5
}
getWaybackServiceBaseURL
返回Wayback服务的基础 URL,并附带随机选择的子域.
参数数字 : 无
回返数字 :
| 类型 | 说明 |
|---|---|
| 字符串 | 随机选择的子域的Wayback服务的基础 URL . |
示例数字 :
import { getWaybackServiceBaseURL } from '@esri/wayback-core';
const baseURL = getWaybackServiceBaseURL();
console.log(baseURL);
// Example output: "https://wayback.maptiles.arcgis.com/arcgis/rest/services/World_Imagery/MapServer"
setCustomWaybackConfig
为测试或开发目的配置自定义回路设置 。 这使得您可以使用自定义的子域、配置文件 URL 或配置数据来覆盖默认的Wayback配置 .
参数数字 :
| 参数 | 类型 | 说明 |
|---|---|---|
| parms.subDomains (英语) | 字符串 [] | (备选) 要使用一系列自定义的子域名, 而不是默认的生产子域名 : ['wayback', 'wayback-a', 'wayback-b'] |
| params.wayback ConfigFileURL (英语) | 字符串 | (可选)自定义用于回路配置文件而不是默认生产 URL 的 URL : https://s3-us-west-2.amazonaws.com/config.maptiles.arcgis.com/waybackconfig.json |
| params.wayback ConfigData 数据 | 退后配置 | (可选) 自定义可直接使用的回路配置数据, 绕过从配置文件 URL 获取它的必要性 |
回返数字 :
| 类型 | 说明 |
|---|---|
| 无效 | 此函数不返回一个值 |
示例数字 :
import { setCustomWaybackConfig } from '@esri/wayback-core';
// Example 1: Set custom subdomains and configuration file URL
setCustomWaybackConfig({
subDomains: ['custom-wayback-1', 'custom-wayback-2'],
waybackConfigFileURL: 'https://example.com/custom-wayback-config.json'
});
// Example 2: Set custom configuration data directly
setCustomWaybackConfig({
waybackConfigData: {
'12345': {
itemID: 'custom-item-id',
itemTitle: 'World Imagery (Wayback 2024-01-15)',
itemURL: 'https://custom.url/tile/12345/{level}/{row}/{col}',
metadataLayerUrl: 'https://custom.metadata.url/MapServer',
metadataLayerItemID: 'custom-metadata-id',
layerIdentifier: 'WB_2024_R01',
}
}
});
类型定义
WaybackItem
代表 World Imagery Wayback 存档的特定发布/版本对象.
使用量数字 :
import { WaybackItem } from '@esri/wayback-core';
属性数字 :
| 名称 | 类型 | 说明 |
|---|---|---|
| 项ID | 字符串 | 用于此世界影像回路发布(例如, 903f0abe9c3b452dafe1ca5b8dd858b9(中文(简体) ) |
| 项目标题 | 字符串 | 本次世界影像回放的标题(例如, World Imagery (Wayback 2014-02-20)(中文(简体) ) |
| 项目URL | 字符串 | WMTS 层的 URL 模板,用于此Wayback 发布(例如, https://wayback.maptiles.arcgis.com/arcgis/rest/services/World_Imagery/WMTS/1.0.0/default028mm/MapServer/tile/10/{level}/{row}/{col}(中文(简体) ) |
| 元数据Layer 项目ID | 字符串 | AcGIS在线项目(Feature Layer)的ID,用于本"世界影像回路"发行的元数据(例如, 73b47bbc112b498daf85d40fb972738a(中文(简体) ) |
| 元数据LayerUrl | 字符串 | 元数据地物层的 URL( 例如, ), https://metadata.maptiles.arcgis.com/arcgis/rest/services/World_Imagery_Metadata_2014_r01/MapServer(中文(简体) ) |
| 层标识符 | 字符串 | 这个世界影像回放(例如, WB_2014_R01(中文(简体) ) |
| 释放Num | 编号 | 此 Wayback 发布的数量, 正在用作项目URL 的时间参数 : /MapServer/tile/{releaseNum}/{level}/{row}/{col}。 。 。 . |
| 释放 Date 标签 | 字符串 | 此 Wayback 项的格式发布日期( 例如 ), "2014-02-20"(中文(简体) ) |
| 释放 日期 | 编号 | 这个Wayback项目作为Unix时代时间戳(例如, 1392883200000(中文(简体) ) |
WaybackMetadata
此对象代表 Wayback 平板图像的元数据 .
使用量数字 :
import { WaybackMetadata } from '@esri/wayback-core';
属性数字 :
| 名称 | 类型 | 说明 |
|---|---|---|
| 日期 | 编号 | 图像的获取日期 |
| 提供者 | 字符串 | 图像提供者 |
| 来源 | 字符串 | 图像来源 |
| 决议 | 编号 | 像素所代表的地面距离 |
| 准确性 | 编号 | 内有多米物体 |
问题
找到错误还是想要请求新特性 ? 请让我们知道一个问题.
捐款
Esri欢迎所有人的贡献。 请看我们的 提交文件的准则。 。 。 .
许可证发放
图像学
在Wayback Archive中展示的图像须遵守《埃斯里总协定》或《使用条件》中规定的条款和条件。 见 世界影像学 关于图像内容和适用使用条件的更多细节.
软件
版权2023 Esri
根据Apache许可证第2.0版("License"); 您不得使用此文件,除非符合许可证. 您可在下列地点获得许可证副本:
http://www.apache.org/licenses/LICENSE-2.0 (中文(简体) )
除非适用的法律要求或书面同意,否则软件 根据许可证发放的是在“AS IS”BASIS上发放的, 没有任何明示或暗示的警告或条件. 有关许可的特定语言的许可证 许可证的限制.
许可证副本可到存放处索取 自由主义 文档.