BasemapToggle

BasemapToggle 提供了一个允许最终用户在两个底图之间切换的微件。切换的底图设置在视图的 map 对象内。

basemap-toggle

从版本 4.23 开始，BasemapToggle 微件可以有两个具有不同空间参考的底图。将 MapView.spatialReferenceLocked 属性设置为 true 以禁用不同空间参考中的底图并防止用户在运行时更改视图的空间参考。

另请参阅：

示例：

// Create a map with an initial basemap
let map = new Map({
  basemap: "tianditu-vector",  // The initial basemap to toggle from
  ground: "world-elevation"
});

// Reference the map in the view instance
let view = new SceneView({
  container: "viewDiv",
  map: map
});

let basemapToggle = new BasemapToggle({
  view: view,  // The view that provides access to the map's "tianditu-vector" basemap
  nextBasemap: "geoscene-blue"  // Allows for toggling to the "geoscene-blue" basemap
});

构造函数

new BasemapToggle(properties)

参数：

properties Object

optional

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

示例：

// typical usage
let basemapToggle = new BasemapToggle({
  view: view,
  nextBasemap: "tianditu-image"
});

属性概览

可以设置、检索或收听任何属性。请参阅使用属性主题。

显示继承的属性

隐藏继承的属性

类型	描述	类
Basemap	更多信息地图的底图。	更多信息	BasemapToggle
String\|HTMLElement	更多信息表示包含微件的 DOM 元素的 ID 或节点。	更多信息	Widget
String	更多信息类的名称。	更多信息	Accessor
String	更多信息创建微件时分配给微件的唯一 ID。	更多信息	Widget
String	更多信息微件的默认标签。	更多信息	BasemapToggle
Basemap	更多信息下一个用于切换的底图。	更多信息	BasemapToggle
MapView\|SceneView	更多信息对 MapView 或 SceneView 的引用。	更多信息	BasemapToggle
BasemapToggleViewModel	更多信息此微件的视图模型。	更多信息	BasemapToggle
Boolean	更多信息指示微件是否可见。	更多信息	Widget
VisibleElements	更多信息微件中显示的可见元素。	更多信息	BasemapToggle

属性详情

activeBasemap Basemapreadonly

地图的底图。

container String|HTMLElement inherited

表示包含微件的 DOM 元素的 ID 或节点。该属性只能设置一次。以下示例都是使用微件时的有效用例。

示例：

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass Stringreadonly inherited 起始版本：GeoScene API for JavaScript 4.7

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

id String inherited

创建微件时分配给微件的唯一 ID。如果开发人员未设置，则默认为容器 ID，如果不存在，则会自动生成。

label String

微件的默认标签。

nextBasemap Basemapautocast Autocasts from String|Object

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

任何 Esri 底图的字符串 ID。
自定义 Basemap 对象。

view MapView|SceneView

对 MapView 或 SceneView 的引用。此视图为 BasemapToggle 小部件提供对初始 basemap 的访问权限，以通过视图的 map 属性进行切换。

viewModel BasemapToggleViewModelautocast

此微件的视图模型。这是一个包含控制此微件行为的所有逻辑（属性和方法）的类。请参阅 BasemapToggleViewModel 类以访问微件上的所有属性和方法。

visible Boolean inherited

指示微件是否可见。

如果为 false，则该微件将不再呈现在 Web 文档中。这可能会影响文档中其他元素或微件的布局。例如，如果此微件是与视图 UI 右上角关联的三个微件中的第一个，则当此微件不可见时，其他微件将重新定位。有关详细信息，请参阅 "none" 的 CSS display 值。

默认值:true

示例：

// Hides the widget in the view
widget.visible = false;

visibleElements VisibleElementsautocast 起始版本：GeoScene API for JavaScript 4.15

微件中显示的可见元素。此属性提供了打开/关闭微件显示的各个元素的能力。

示例：

basemapToggle.visibleElements = {
  title: false
};

方法概览

显示继承的方法

隐藏继承的方法

返回类型	描述	类
String	更多信息用于构建微件 `class` 属性值的实用方法。	更多信息	Widget
	更多信息注销微件实例。	更多信息	Widget
Boolean	更多信息在实例上发出事件。	更多信息	Widget
Boolean	更多信息指示实例上是否存在与提供的事件名称匹配的事件侦听器。	更多信息	Widget
Boolean	更多信息 `isFulfilled()` 可用于验证创建类的实例是否已完成（已解决或已拒绝）。	更多信息	Widget
Boolean	更多信息 `isRejected()` 可用于验证创建类的实例是否被拒绝。	更多信息	Widget
Boolean	更多信息 `isResolved()` 可用于验证创建类的实例是否已解决。	更多信息	Widget
Object	更多信息在实例上注册事件处理程序。	更多信息	Widget
	更多信息微件拆卸助手。	更多信息	Widget
	更多信息此方法主要由开发人员在实现自定义微件时使用。	更多信息	Widget
Object	更多信息此方法主要由开发人员在实现自定义微件时使用。	更多信息	Widget
	更多信息立即将微件呈现给 DOM。	更多信息	Widget
	更多信息此方法主要由开发人员在实现自定义微件时使用。	更多信息	Widget
	更多信息 Toggles to the next basemap.	更多信息	BasemapToggle
Promise	更多信息 `when()` 一旦创建了类的实例，就可以利用它。	更多信息	Widget

方法详情

classes(classNames){String}inherited 起始版本：GeoScene API for JavaScript 4.7

用于构建微件 class 属性值的实用方法。这有助于简化 CSS 类设置。

参数：

classNames String|String []|Object

repeatable

类名称。

类型	说明
String	计算出来的类名。

另请参阅：

指南 - 微件开发（rendering）

示例：

// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}

destroy()inherited

注销微件实例。

emit(type, event){Boolean}inherited 起始版本：GeoScene API for JavaScript 4.5

在实例上发出事件。此方法仅应在创建此类的子类时使用。

参数：

type String

事件的名称。

event Object

optional

事件有效负载。

类型	说明
Boolean	如果监听器收到通知，则为 `true`

hasEventListener(type){Boolean}inherited

指示实例上是否存在与提供的事件名称匹配的事件侦听器。

参数：

type String

事件的名称。

类型	说明
Boolean	如果类支持输入事件，则返回 true。

isFulfilled(){Boolean}inherited 起始版本：GeoScene API for JavaScript 4.19

isFulfilled() 可用于验证创建类的实例是否已完成（已解决或已拒绝）。如果满足，则返回 true。

类型	说明
Boolean	指示创建类的实例是否已完成（已解决或已拒绝）。

isRejected(){Boolean}inherited 起始版本：GeoScene API for JavaScript 4.19

isRejected() 可用于验证创建类的实例是否被拒绝。如果被拒绝，则返回 true。

类型	说明
Boolean	指示创建类的实例是否已被拒绝。

isResolved(){Boolean}inherited 起始版本：GeoScene API for JavaScript 4.19

isResolved() 可用于验证创建类的实例是否已解决。如果已解决，将返回 true。

类型	说明
Boolean	指示创建类的实例是否已解决。

on(type, listener){Object}inherited

在实例上注册事件处理程序。调用此方法以将事件与侦听器挂钩。

参数：

type String|String []

要侦听的事件或事件数组。

listener Function

事件触发时调用的函数。

类型说明

Object

返回带有 remove() 方法的事件处理程序，应调用该方法以停止侦听事件。

属性	类型	说明
remove	函数	调用时，从事件中删除侦听器。

示例：

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own(handles)inherited

微件拆卸助手。当微件被销毁时，添加到它的任何句柄都将被自动删除。

参数：

handles WatchHandle|WatchHandle []

微件销毁后标记为删除的句柄。

postInitialize()inherited

此方法主要由开发人员在实现自定义微件时使用。在微件准备好渲染后执行。

render(){Object}inherited

此方法主要由开发人员在实现自定义微件时使用。它必须由子类实现以进行渲染。

类型	说明
Object	渲染的虚拟节点。

renderNow()inherited

立即将微件呈现给 DOM。

scheduleRender()inherited

此方法主要由开发人员在实现自定义微件时使用。安排微件渲染。此方法对于影响 UI 的更改很有用。

toggle()

切换到下一个底图。

when(callback, errback){Promise}inherited 起始版本：GeoScene API for JavaScript 4.19

when() 一旦创建了类的实例，就可以利用它。这个方法有两个输入参数：一个 callback 函数和一个 errback 函数。callback 在类的实例加载时执行。如果类的实例无法加载，则执行 errback。

参数：

callback Function

可选

当 promise 解决时调用的函数。

errback Function

可选

当 promise 失败时执行的函数。

类型	说明
Promise	返回 `callback` 结果的新promise，可用于链接其他函数。

示例：

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

类型说明

VisibleElements

微件中显示的可见元素。这提供了打开/关闭微件显示的各个元素的能力。

属性：

title Boolean

optional

指示是否要显示标题。默认为 false。

事件概览

名称	类型	描述	类
	{current: Basemap,previous: Basemap}	更多信息在调用 toggle() 方法后触发。	更多信息	BasemapToggle

事件详情

toggle 已弃用从 4.22 版开始。另请注意 activeBasemap 属性。

在调用 toggle() 方法后触发。

属性：

current Basemap

地图的当前底图。

previous Basemap

地图的先前底图。

另请参阅：

toggle()

示例：

basemapToggle.on('toggle', function(event){
  console.log("current basemap title: ", event.current.title);
  console.log("previous basemap title: ", event.previous.title);
});

GeoScene API for JavaScript参考手册

构造函数

属性概览

属性详情

方法概览

方法详情

类型说明

事件概览

事件详情