提供 BasemapToggle 微件的逻辑。 使用 nextBasemap 属性以确定要切换到的辅助底图。
示例代码:
let basemapToggle = new BasemapToggle({
viewModel: { // 转换成新 BasemapToggleViewModel()
view: view, // 具有使用 “streets-vector” 底图的地图的视图
nextBasemap: "tianditu-image" // 允许切换到 “tianditu-image” 底图
}
});
构造函数
属性列表
可以设置、检索或监听的任何属性。参见使用属性主题。
名称 | 类型 | 描述 | 类 | |
---|---|---|---|---|
Basemap | 更多信息 地图的底图。 | 更多信息 | BasemapToggleViewModel | |
String | 更多信息 类名。 | 更多信息 | Accessor | |
Basemap | 更多信息 用于切换的下一个底图。 | 更多信息 | BasemapToggleViewModel | |
String | 更多信息 视图模型的状态。 | 更多信息 | BasemapToggleViewModel | |
MapView|SceneView | 更多信息 微件将从中运行的视图。 | 更多信息 | BasemapToggleViewModel |
属性详细说明
-
起始版本: GeoScene API for JavaScript 4.22
-
类名。类的名称声明格式为
geoscene.folder.className
。
-
state Stringreadonly
-
视图模型的状态。
可选值:"ready"|"disabled"
- 默认值:disabled
方法列表
名称 | 返回值类型 | 描述 | 类 | |
---|---|---|---|---|
Boolean | 更多信息 在实例上触发事件。 | 更多信息 | BasemapToggleViewModel | |
String | 更多信息 用于查找底图缩略图 URL 的 Helper 方法。 | 更多信息 | BasemapToggleViewModel | |
Boolean | 更多信息 指示实例上是否存在与提供的事件名称匹配的事件侦听器。 | 更多信息 | BasemapToggleViewModel | |
Object | 更多信息 在实例上注册事件处理程序。 | 更多信息 | BasemapToggleViewModel | |
更多信息 切换到下一个底图。 | 更多信息 | BasemapToggleViewModel |
方法详细说明
-
emit(type, event){Boolean}起始版本: GeoScene API for JavaScript 4.22
-
在实例上触发事件。仅当创建此类的子类时才应使用此方法。
参数:type String事件名称。
event Objectoptional事件负载。
返回值:类型 描述 Boolean 如果侦听器收到通知,则为 true
。
-
起始版本: GeoScene API for JavaScript 4.22
-
用于查找底图缩略图 URL 的 Helper 方法。
如果底图没有定义缩略图 URL,此实用程序将尝试从最匹配的已知底图中查找缩略图 URL。如果找不到匹配项,将使用来自底图基层的缩略图 URL。
参数:basemap Basemap用于检索缩略图 URL 的底图。
返回值:类型 描述 String 底图的缩略图 URL。
-
hasEventListener(type){Boolean}
-
指示实例上是否存在与提供的事件名称匹配的事件侦听器。
参数:type String事件名称。
返回值:类型 描述 Boolean 如果类支持输入事件,则返回 true。
-
on(type, listener){Object}
-
在实例上注册事件处理程序。调用此方法将事件与侦听器挂钩。
参数:要监听的事件或者事件数组。
listener Function事件触发时要调用的函数。
返回值:类型 描述 Object 返回一个 remove()
方法的事件处理程序,该方法用以停止侦听事件。名称 类型 描述 remove Function 当被调用时,从事件中移除监听器。 示例代码:view.on("click", function(event){ // event是事件触发后返回的事件句柄。 console.log(event.mapPoint); });
-
toggle()
-
切换到下一底图。