PortalBasemapsSource

AMD: require(["geoscene/widgets/BasemapGallery/support/PortalBasemapsSource"], (PortalBasemapsSource) => { /* 代码 */ });
ESM: import PortalBasemapsSource from "@geoscene/core/widgets/BasemapGallery/support/PortalBasemapsSource";
类: geoscene/widgets/BasemapGallery/support/PortalBasemapsSource
继承于: PortalBasemapsSource LocalBasemapsSource Accessor
起始版本: GeoScene API for JavaScript 4.22

PortalBasemapsSource 类是 BasemapGalleryViewModelBasemapGallery 微件中的门户驱动的 Basemap

示例:

构造函数

new PortalBasemapsSource(properties)
参数:
properties Object
optional

所有可传入构造函数的属性,请参见属性列表

属性列表

可以设置、检索或监听的属性。参见 使用属性
展示继承属性 隐藏继承属性
属性 类型 描述
Collection<Basemap>更多信息

从源门户获取的 Basemaps 集合。

更多信息PortalBasemapsSource
String更多信息

类名。

更多信息Accessor
BasemapFilter更多信息

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

更多信息PortalBasemapsSource
Portal更多信息

从中获取底图的门户。

更多信息PortalBasemapsSource
Object|String更多信息

具有用于创建自定义底图库组查询的键值对的对象。

更多信息PortalBasemapsSource
String更多信息

源的状态。

更多信息PortalBasemapsSource
UpdateBasemapsCallback更多信息

获取和过滤后用于更新底图的回调。

更多信息PortalBasemapsSource

属性详细说明

basemaps Collection<Basemap>

从源门户获取的 Basemaps 集合。

declaredClass Stringreadonly inherited
起始版本: GeoScene API for JavaScript 4.22

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

filterFunction BasemapFilter

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

portal Portal

从中获取底图的门户。

query Object|String
起始版本: GeoScene API for JavaScript 4.22

具有用于创建自定义底图库组查询的键值对的对象。请注意,所有参数都将使用 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 API for JavaScript 4.22

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

方法列表

属性 返回值类型 描述
更多信息

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

更多信息PortalBasemapsSource

方法详细说明

refresh()

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

类型定义

BasemapFilter(item, index, array){Boolean}

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

参数:
item Basemap

阵列中正在评估的当前底图项目。

index Number

正在评估的底图的索引。

array Basemap[]

被过滤的底图数组。

返回值:
类型 描述
Boolean
  • 如果测试通过则返回真,否则返回假。
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: "f80a41db443145159388dc8db080e89e"  // WGS84 Streets Vector webmap
         }
       });
       // add basemap to the array
       items.push(bm);
       // return the array of basemaps
       return items;
     }
   }
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.