BasemapLayerList

BasemapLayerList 微件提供了一种显示底图图层列表以及打开/关闭其可见性的方法。基础图层和参考图层分为两个单独的部分。启用编辑后，可以通过在列表之间拖放来重新排序图层，并且可以编辑标题。‎

BasemapLayerList 与 LayerList 微件非常相似。有关代码灵感，请参见以下示例：
示例 - LayerList 微件
 示例 - 具有操作的 LayerList 微件

另请参阅

示例

let basemapLayerList = new BasemapLayerList({
  view: view
});
// Adds the widget below other elements in the top left corner of the view
view.ui.add(basemapLayerList, {
  position: "top-left"
});

构造函数

new BasemapLayerList(properties)

参数

properties Object

optional

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

示例

// typical usage
let BasemapLayerList = new BasemapLayerList({
  view: view
});

属性概述

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

显示继承属性

隐藏继承属性

类型	描述	类
Collection<ListItem>	表示 baseLayers 的 ListItem 集合。更多详情	BasemapLayerList
ListItemCreatedHandler	指定一个函数，用于访问表示基础图层的每个 ListItem。更多详情	BasemapLayerList
String	当前底图的标题。更多详情	BasemapLayerList
String\|HTMLElement	包含微件的 DOM 元素的 ID 或节点。更多详情	Widget
String	类的名称。更多详情	Accessor
Boolean	指示用户是否可以编辑底图的标题、图层顺序和图层分组。更多详情	BasemapLayerList
Number	指示用于微件标题的标题级别更多详情	BasemapLayerList
String	微件的默认 CSS 图标类。更多详情	BasemapLayerList
String	创建微件时分配给微件的唯一 ID。更多详情	Widget
String	微件的默认的标注。更多详情	BasemapLayerList
Boolean	指示用户一次是否可以选择多个列表项。更多详情	BasemapLayerList
Collection<ListItem>	表示 referenceLayers 的 ListItem 集合。更多详情	BasemapLayerList
ListItemCreatedHandler	指定一个函数，用于访问表示参考图层的每个 ListItem。更多详情	BasemapLayerList
Collection<ListItem>	所选 ListItem 的集合，表示用户选择的底图图层。更多详情	BasemapLayerList
MapView\|SceneView	对 MapView 或 SceneView 的引用。更多详情	BasemapLayerList
BasemapLayerListViewModel	此微件的视图模型。更多详情	BasemapLayerList
Boolean	指示微件是否可见。更多详情	Widget
VisibleElements	微件中显示的可见元素。更多详情	BasemapLayerList

属性详细信息

baseItems Collection<ListItem>readonly

表示 baseLayers 的 ListItem 集合。

baseListItemCreatedFunction ListItemCreatedHandler

指定一个函数，用于访问表示基础图层的每个 ListItem。每个列表项的可修改属性都可以在其中更新。可以使用 ListItem 的 actionsSections 属性将操作添加到列表项。

示例

let bmLayerList = new BasemapLayerList({
  view: view,
  editingEnabled: true,
  baseListItemCreatedFunction: function(event){
    baseListItem = event.item;
    if(baseListItem.title === "World Imagery_01"){
      // clean up title
      baseListItem.title = "World Imagery";
      // open the baseList item
      baseListItem.open = true;
    }
  }
})

basemapTitle String

当前底图的标题。

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.folder.className。

editingEnabled Boolean

指示用户是否可以编辑底图的标题、图层顺序和图层分组。所做的任何编辑将仅显示在本地，不会进行保存。

默认值：false

示例

// to enable editing
basemapLayerList.editingEnabled = true;

headingLevel Number 起始版本：GeoScene Maps SDK for JavaScript 4.20

指示用于微件标题的标题级别 (即 "Basemap")。默认情况下，此呈现为 2 级标题 (例如，<h2>Basemap</h2>)。根据微件在应用程序中的位置，您可能需要调整此标题以获得正确的语义。这对于满足可访问性标准很重要。

默认值：2

另请参阅

标题元素

示例

// the widget title will render as an <h3>
basemapLayerList.headingLevel = 3;

iconClass String

微件的默认 CSS 图标类。

id String inherited

创建微件时分配给微件的唯一 ID。如果不是由开发人员设置的，它将默认为容器 Id，或者如果没有容器 ID，则将自动生成。

label String

微件的默认的标注。

multipleSelectionEnabled Boolean

指示用户一次是否可以选择多个列表项。所选项目在 selectedItems 属性中可用。

默认值：false

另请参阅

selectedItems

示例

basemapLayerList.multipleSelectionEnabled = true;

referenceItems Collection<ListItem>readonly

表示 referenceLayers 的 ListItem 集合。

referenceListItemCreatedFunction ListItemCreatedHandler

指定一个函数，用于访问表示参考图层的每个 ListItem。每个列表项的可修改属性都可以在其中更新。可以使用 ListItem 的 actionsSections 属性将操作添加到列表项。

示例

let bmLayerList = new BasemapLayerList({
  view: view,
  editingEnabled: true,
  referenceListItemCreatedFunction: function(event){
    referenceListItem = event.item;
    if(referenceListItem.title === "World Imagery_01_reference_layer"){
      // clean up title
      referenceListItem.title = "Reference layer";
      // open the baseList item
      referenceListItem.open = true;
    }
  }
})

selectedItems Collection<ListItem>

所选 ListItem 的集合，表示用户选择的底图图层。

view MapView|SceneView

对 MapView 或 SceneView 的引用。设置此选项可将微件链接到特定视图。

viewModel BasemapLayerListViewModel

此微件的视图模型。此类包含控制此微件行为的所有逻辑。请参阅 BasemapLayerListViewModel 类来访问微件上的所有属性和方法。

visible Boolean inherited

指示微件是否可见。

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

默认值：true

示例

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

visibleElements VisibleElements 起始版本：GeoScene Maps SDK for JavaScript 4.15

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

示例

basemapLayerList.visibleElements = {
  statusIndicators: false,
  baseLayers: false,
  referenceLayers: false,
  errors: true
};

方法概述

显示继承的方法

隐藏继承的方法

返回值类值	描述	类
	添加一个或多个与对象的生命周期相关联的句柄。更多详情	Accessor
String	用于为微件的 `class` 属性构建值的实用方法。更多详情	Widget
	销毁微件实例。更多详情	Widget
Boolean	在实例上触发事件。更多详情	Widget
Boolean	指示实例上是否存在与提供的事件名称相匹配的事件监听器。更多详情	Widget
Boolean	如果存在指定的句柄组，则返回 true。更多详情	Accessor
Boolean	`isFulfilled()` 可用于验证创建类的实例是否已完成 (已解决或已拒绝)。更多详情	Widget
Boolean	`isRejected()` 可用于验证创建类的实例是否被拒绝。更多详情	Widget
Boolean	`isResolved()` 可用于验证创建类的实例是否已解决。更多详情	Widget
Object	在实例上注册事件处理程序。更多详情	Widget
	添加一个或多个与微件的生命周期相关联的句柄。更多详情	Widget
	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
	移除对象拥有的句柄组。更多详情	Accessor
Object	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
	立即将微件渲染到 DOM。更多详情	Widget
	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
	触发 trigger-action 事件并执行给定的操作或操作切换。更多详情	BasemapLayerList
Promise	一旦创建了类的实例，就可以使用`when()` 。更多详情	Widget

方法详细说明

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

classes(classNames){String}inherited

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

参数

classNames String|String []|Object

repeatable

类名称。

类型	描述
String	计算的类名。

另请参阅

指南 - 微件开发 (渲染器)

示例

// .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

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

参数

type String

事件的名称。

event Object

optional

事件有效负载。

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

hasEventListener(type){Boolean}inherited

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

参数

type String

事件的名称。

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

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

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

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

类型	描述
Boolean	指示创建类的实例是否已完成 (已解决或已拒绝)。

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

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

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

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

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

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

on(type, listener){Object}inherited

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

参数

type String|String []

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

listener Function

事件触发时要调用的函数。

类型描述

Object

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

属性	类型	描述
remove	Function	调用时，从事件中移除侦听器。

示例

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

own(handleOrHandles)inherited 起始版本：GeoScene Maps SDK for JavaScript 4.24

添加一个或多个与微件的生命周期相关联的句柄。当微件被销毁时，将移除句柄。

const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true}
);

this.own(handle); // Handle gets removed when the widget is destroyed.

参数

handleOrHandles WatchHandle|WatchHandle []

微件销毁后，标记为要移除的句柄。

postInitialize()inherited

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

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

render(){Object}inherited

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

类型	描述
Object	渲染的虚拟节点。

renderNow()inherited

立即将微件渲染到 DOM。

scheduleRender()inherited

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

triggerAction(action, item)

触发 trigger-action 事件并执行给定的操作或操作切换。

参数

action ActionButton|ActionToggle

要执行的操作。

item ListItem

与操作关联的项目。

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

一旦创建了类的实例，就可以使用when() 。此方法接受两个输入参数：callback 函数和 errback 函数。callback 在类的实例加载时执行。errback 在类的实例无法加载时执行。

参数

callback Function

optional

当 promise 解决时调用的函数。

errback Function

optional

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

类型定义

ListItemCreatedHandler(event)

baseListItemCreatedFunction 和 referenceListItemCreatedFunction 属性的函数定义。有关这些属性的更多详细信息，请参阅文档中的示例代码段。

参数

event Object

包含由 LayerList 创建的列表项的对象。

规范

item ListItem

由 LayerList 创建的列表项。您可以修改此项目的属性以自定义列表项目的文本、操作、面板内容和可见性。有关详细信息，请参阅 listItemCreatedFunction 的文档。

VisibleElements

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

属性

statusIndicators Boolean

optional

指示是否显示状态指示器。默认为 true。

baseLayers Boolean

optional

指示是否将显示基础图层。默认为 true。

referenceLayers Boolean

optional

指示是否将显示参考图层。默认为 true。

errors Boolean

optional

自 4.25 指示是否显示图层加载错误。默认为 false。

事件概述

名称	类型	描述	类
	{action: ActionButton,ActionToggle,item: ListItem}	用户在 BasemapLayerList 微件内单击操作或操作切换后触发。更多详情	BasemapLayerList

事件详细说明

trigger-action

用户在 BasemapLayerList 微件内单击操作或操作切换后触发。此事件可用于定义单击特定操作时要执行的自定义函数。

属性

action ActionButton|ActionToggle

用户单击的操作。

item ListItem

与操作相关联的 ListItem。

GeoScene Maps SDK for JavaScript参考手册

构造函数

属性概述

属性详细信息

方法概述

方法详细说明

类型定义

事件概述

事件详细说明