BasemapLayerList

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

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

有关获得对widget样式的完全控制的信息，请参阅样式主题。

示例:

示例代码:

let basemapLayerList = new BasemapLayerList({
  view: 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	更多信息微件默认样式图标类	更多信息	BasemapLayerList
String	更多信息创建微件时分配给微件的唯一ID。	更多信息	Widget
String	更多信息微件默认标签。	更多信息	BasemapLayerList
Boolean	更多信息用户一次是否可以选择多个列表项。	更多信息	BasemapLayerList
Collection<ListItem>	更多信息显示 referenceLayers 的 ListItems 的集合	更多信息	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 或者节点。此属性只能设置一次。以下示例都是使用微件时的有效示例。

示例代码:

// 在运行时创建HTML div元素，并将其设置为小部件的容器
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

// 创建 HTML div 元素 并且设置为widget的容器

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

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML 标签
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// 在添加到视图的UI时指定widget
const basemapGallery = new BasemapGallery({
  view: view
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass Stringreadonly inherited

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

editingEnabled Boolean

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

默认值:false

示例代码:

// 开启编辑
basemapLayerList.editingEnabled = true;

headingLevel Number 起始版本: GeoScene API for JavaScript 4.22

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

默认值:2

示例:

标题元素

示例代码:

// 这个widget标题将被渲染成<h3>
basemapLayerList.headingLevel = 3;

iconClass String

微件默认样式图标类。

id String inherited

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

label String

微件默认标签。

multipleSelectionEnabled Boolean

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

默认值:false

示例:

selectedItems

示例代码:

basemapLayerList.multipleSelectionEnabled = true;

referenceItems Collection<ListItem>readonly

表示 referenceLayers 的 ListItems 的集合。

referenceListItemCreatedFunction ListItemCreatedHandler

示例代码:

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 文档中。这可能会影响文档中其他元素或构件的布局。例如，如果此微件是与 view UI,右上角关联的三个微件中的第一个，则当此微件不可见时，其他微件将重新定位。有关详细信息，请参阅 CSS display 值为 "none".

默认值:true

示例代码:

// 在view中隐藏widget
widget.visible = false;

visibleElements VisibleElementsautocast 起始版本: GeoScene API for JavaScript 4.22

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

示例代码:

basemapLayerList.visibleElements = {
  statusIndicators: 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
	更多信息触发 trigger-action 事件并执行给定的 action 或 action toggle.	更多信息	BasemapLayerList
Promise	更多信息 `when()` 创建类的实例后，会被执行一次。	更多信息	Widget

方法详细说明

classes(classNames){String}inherited

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

参数:

classNames String|String []|Object

repeatable

class 类名称

返回值:

类型	描述
String	计算的类名。

示例:

指南 - 微件开发 (rendering)

示例代码:

// .tsx语法显示在渲染widget时如何设置CSS classs .

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。

isFulfilled(){Boolean}inherited 起始版本: GeoScene API for JavaScript 4.22

isFulfilled() 可用于验证创建类的实例是否已完成(无论成功或失败)。如果已完成，将会返回true。

返回值:

类型	描述
Boolean	指示创建类的实例是否已完成（无论成功或失败）。

isRejected(){Boolean}inherited 起始版本: GeoScene API for JavaScript 4.22

isRejected() 可用于验证创建类的实例是否失败。如果失败, 将会返回 true 。

返回值:

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

isResolved(){Boolean}inherited 起始版本: GeoScene API for JavaScript 4.22

isResolved() 可用于验证创建类的实例是否成功。如果成功, 将会返回 true 。

返回值:

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

on(type, listener){Object}inherited

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

参数:

type String|String []

要监听的 event 或者事件数组

listener Function

事件触发时要调用的函数

返回值:

类型描述

Object

返回一个remove() 方法的事件处理程序，该方法用以停止侦听事件。

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

示例代码:

view.on("click", function(event){
  // event是事件触发后返回的事件句柄。
  console.log(event.mapPoint);
});

own(handles)inherited

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

参数:

handles WatchHandle|WatchHandle []

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

postInitialize()inherited

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

render(){Object}inherited

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

返回值:

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

renderNow()inherited

立即将微件渲染到 DOM。

scheduleRender()inherited

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

triggerAction(action, item)

触发 trigger-action 事件并执行给定的 action 或 action toggle.

参数:

action ActionButton|ActionToggle

要执行的操作。

item ListItem

与操作关联的项。

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

when() 创建类的实例后，会被执行一次。该方法接受两个参数： callback 函数和 errback 函数。 callback 在类的实例加载时执行。如果类的实例无法加载，则执行 errback。

参数:

callback Function

optional

当 Promise 成功时，该函数将被调用。

errback Function

optional

当 Promise 失败时，该函数将被调用。

返回值:

类型	描述
Promise	返回回调结果的新 promise，可用于链接附加功能。

示例代码:

// 尽管此示例使用 BasemapGallery widget，但任何作为 Promise 的类实例都可以以相同的方式使用 when()
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // 当 Promise resolved 时，函数将被执行
}, function(error){
  // 当 Promise 通过 rejected 抛错时，这个函数将被执行
});

类型定义

ListItemCreatedHandler(event)

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

参数:

event Object

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

规范:

item ListItem

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

VisibleElements

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

属性:

statusIndicators Boolean

optional

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

baseLayers Boolean

optional

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

referenceLayers Boolean

optional

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

Event Overview

属性	类型	描述	类
	{action: ActionButton,ActionToggle,item: ListItem}	更多信息在用户单击底图图层列表微件中的 action 或 action toggle 后触发	更多信息	BasemapLayerList

Event Details

trigger-action

在用户单击底图图层列表微件中的 action 或 action toggle 后触发。此事件可用于定义在单击特定操作时要执行的自定义函数。

属性:

action ActionButton|ActionToggle

用户单击的操作。

item ListItem

与操作关联的列表项。

GeoScene API for JavaScript参考手册

构造函数

属性列表

属性详细说明

方法列表

方法详细说明

类型定义

Event Overview

Event Details