ListItem

属性概述

属性详细信息

actionsOpen Boolean

操作面板是否在 LayerList 中打开。

默认值：false

actionsSections Collection<Collection<(ActionButton|ActionToggle)>>autocast

自动转换自 Object[][]

可以在项目上触发的嵌套二维操作集合。

children Collection<ListItem>

当图层包含子图层时，此属性是属于给定图层的 ListItem 对象的集合。

childrenSortable Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.16

指示是否可以排序或移动/重新排序列表项目的子项 (或 GroupLayer 中的子图层)。

默认值：true

示例

// disables the children of a parent list item from being sorted
listItem.childrenSortable = false;

connectionStatus Stringreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.24

仅当列表项目表示 StreamLayer 时有效。指示流图层连接的状态。这将覆盖 updating 属性。连接流图层后，列表项目标题旁边将出现一个绿色圆圈。当其为 disconnected 后，列表项目标题旁边将显示一个空心的红色环。

可能值："connected"|"disconnected"

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

error Errorreadonly

如果发生错误，则返回 Error 对象。

hidden Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.24

如果为 true，则从 LayerList 实例中隐藏图层。这是 Layer.listMode 的替代方案，它从包含图层的所有 LayerList 实例中隐藏图层。

默认值：false

示例

let layerList1 = new LayerList({
  view,
  container: layerList1Container,
  listItemCreatedFunction: (event) => {
    // hides the USA - Highway layer from the
    // layerList1 instance of layerlist
    if(event.item.title === "USA - Highways") {
      event.item.hidden = true;
    }
  }
});

layer Layer

与触发操作相关联的图层。

默认值：null

layerView LayerViewreadonly

LayerView，显示关联 layer 的数据。

open Boolean

图层是否在 LayerList 中打开。

默认值：false

panel ListItemPanel

起始版本：GeoScene Maps SDK for JavaScript 4.7

允许您在 LayerList 微件中显示每个 ListItem 的自定义内容。

使用 ListItemPanel 的常见场景是在每个列表项中显示 Legend 微件。legend 关键字可用于面板的 content 属性，以显示 LayerList 中每个图层的图例。

示例

// displays the legend for each layer list item
const layerList = new LayerList({
  view: view,
  listItemCreatedFunction: function(event){
    const item = event.item;
    item.panel = {
      content: "legend"
    };
  }
});

// displays content from the DOM in the LayerList
const layerList = new LayerList({
  view: view,
  listItemCreatedFunction: function(event){
    const item = event.item;
    item.panel = {
      content: document.getElementById("myDiv"),
      className: "geoscene-icon-chart",
      open: item.visible
    };
  }
});

parent ListItem

起始版本：GeoScene Maps SDK for JavaScript 4.5

此项目的父项

默认值：null

publishing Booleanreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.25

发布图层时，值为 true。如果未发布图层或 checkPublishStatusEnabled 为 false，则值将为 false。

默认值：false

sortable Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.16

指示是否可以排序或移动/重新排序列表项目 (或地图中的图层)。

默认值：true

示例

// disables the list item from being sorted
listItem.sortable = false;

title String

图层的标题。

updating Booleanreadonly

更新图层时，值为 true；例如，如果它正在获取数据。

默认值：false

view MapView|SceneView

微件将从中操作的视图。

visibilityMode Stringreadonly

指示如何管理子图层的可见性。

visible Boolean

指示 ListItem 是否可见。

默认值：true

visibleAtCurrentScale Booleanreadonly

图层在当前比例下是否可见。

默认值：true

方法概述

方法详细说明

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

clone(){ListItem}

创建此对象的深度克隆。

返回

类型	描述
ListItem	新 ListItem 实例的克隆。

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