BasemapToggleViewModel

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

提供 BasemapToggle 微件的逻辑。使用 nextBasemap 属性以确定要切换到的辅助底图。

另请参阅
示例
let basemapToggle = new BasemapToggle({
  viewModel: {  // autocasts as new BasemapToggleViewModel()
    view: view,  // view with map that uses "tianditu-vector" basemap
    nextBasemap: "hybrid"  // Allows for toggling to "hybrid" basemap
  }
});

构造函数

new BasemapToggleViewModel(properties)
参数
properties Object
optional

有关可能传递给构造函数的所有属性的列表,请参见属性

属性概述

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

地图的底图

更多详情
BasemapToggleViewModel
String

类的名称。

更多详情
Accessor
Basemap

用于切换的下一个底图。

更多详情
BasemapToggleViewModel
String

视图模型的状态。

更多详情
BasemapToggleViewModel
MapView|SceneView

微件将从中操作的视图。

更多详情
BasemapToggleViewModel

属性详细信息

activeBasemap Basemapreadonly

地图的底图

declaredClass Stringreadonly inherited
起始版本:GeoScene Maps SDK for JavaScript 4.7

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

nextBasemap Basemapautocast
自动转换自 String|Object

用于切换的下一个底图。可将下列值之一设置为此属性:

state Stringreadonly

视图模型的状态。

可能的值"ready"|"disabled"

默认值:disabled

微件将从中操作的视图。此视图提供对初始底图的访问,以通过视图的 map 属性进行切换。

方法概述

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

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

更多详情
Accessor
String

用于查找底图缩略图 URL 的 Helper 方法。

更多详情
BasemapToggleViewModel
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Promise

切换到下一个底图

更多详情
BasemapToggleViewModel

方法详细说明

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

getThumbnailUrl(basemap){String}
起始版本:GeoScene Maps SDK for JavaScript 4.4

用于查找底图缩略图 URL 的 Helper 方法。

如果底图没有定义的缩略图 URL,则此实用程序将尝试从最匹配的已知底图中查找缩略图 URL。如果找不到匹配项,将使用来自底图基础图层的缩略图 URL。

参数
basemap Basemap

用于检索缩略图 URL 的底图。

返回
类型 描述
String 底图的缩略图 URL。
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");
toggle(){Promise}

切换到下一个底图

返回
类型 描述
Promise 微件切换到下一个底图后解决。

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