PortalBasemapsSource

属性概述

属性详细信息

basemaps Collection<Basemap>readonly

从源门户获取的 Basemap 的集合。

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

filterFunction BasemapFilter

从门户获取后，用于过滤底图的函数。

portal Portal

从中获取底图的门户。

query Object|String

起始版本：GeoScene Maps SDK for JavaScript 4.5

具有键值对的对象，用于创建自定义底图库组查询。请注意，所有参数都将使用 AND 运算符连接。它还可以为更高级的用例提供查询字符串。

示例

// query portal basemaps with an object
let source = new PortalBasemapsSource({
  query: {
    title: "United States Basemaps",
    owner: "Esri_cy_US"
  }
});

// query portal basemaps with a string
let source = new PortalBasemapsSource({
  query: "title:\"United States Basemaps\" AND owner:Esri_cy_US"
});

state Stringreadonly

源的状态。

可能值："not-loaded"|"loading"|"ready"

默认值：not-loaded

updateBasemapsCallback UpdateBasemapsCallback

起始版本：GeoScene Maps SDK for JavaScript 4.8

获取和过滤后用于更新底图的回调。如果您想在获取门户底图后添加自定义底图，这会很有用。

方法概述

方法详细说明

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

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");
}

refresh(){Promise}

通过从门户获取底图来刷新底图。

返回

类型	描述
Promise	获取底图时进行解析的 promise。

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");

类型定义

BasemapFilter(item, index, array){Boolean}

filterFunction 属性使用此函数在从门户获取底图后过滤底图。

参数

item Basemap 数组中正在评估的当前底图项目。

index Number 正在评估的底图的索引。

array Basemap[] 要进行过滤的底图数组。

返回

类型	描述
Boolean	如果测试通过，则返回 true，否则返回 false。

UpdateBasemapsCallback(items){Basemap[]}

updateBasemapsCallback 属性使用此函数在获取和过滤后更新底图。

参数

items Basemap[] 已从门户中获取和过滤的底图数组。

返回

类型	描述
Basemap[]	要在 BasemapGallery 微件中显示的底图数组。

示例

let basemapGallery = new BasemapGallery({
   view: view,
   source: {
     query: {
       title: "United States Basemaps",
       owner: "Esri_cy_US"
     },
     updateBasemapsCallback: function(items) {
       // create custom basemap to be added to the array of portal basemaps
       let bm = new Basemap({
         portalItem: {
           id: "8dda0e7b5e2d4fafa80132d59122268c"  // WGS84 Streets Vector webmap
         }
       });
       // add basemap to the array
       items.push(bm);
       // return the array of basemaps
       return items;
     }
   }
});