LegendViewModel

const legend = new Legend({
  view: view,
  viewModel: new LegendViewModel({
    view: view
  })
});
view.ui.add(legend, "bottom-left");

属性概述

属性详细信息

activeLayerInfos Collection<ActiveLayerInfo>autocast

自动转换自 Object[]

图例视图用于在图例中显示数据的 ActiveLayerInfo 对象的集合。在从此集合中移除或添加 ActiveLayerInfo 时，可使用此属性隐藏或显示图例中的图层符号。

basemapLegendVisible Boolean

指示是否在 Legend 中显示底图图层。

默认值：filterBasemaps

示例

legend.viewModel.basemapLegendVisible = true;

declaredClass Stringreadonly inherited

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

hideLayersNotInCurrentView Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.21

当为 true 时，仅当图层在视图范围内可见，这些图层才会显示在图例中。当图层中的数据在视图中不可见时，图层的图例信息将被隐藏。

要从图例中完全隐藏图层，应将图层的 legendEnabled 属性设置为 false。

默认值：false

另请参阅

• respectLayerVisibility

示例

// layers not displayed in the view
// will not be shown in the legend
legend.viewModel.hideLayersNotInCurrentView = true;

layerInfos Object[]

指定地图中要显示在图例中的图层子集。如果未设置此属性，则地图中的所有业务图层都将显示在图例中。此属性可用于控制图例中的图层显示顺序。此数组中的对象是使用下面列出的属性定义的。

属性

title String optional 指定图层的标题。如果未指定标题，则使用服务名称。

layer Layer optional 添加到图例的图层。

respectLayerVisibility Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.13

确定是否遵循地图中控制图例可见性的图层属性 (minScale、maxScale、legendEnabled)。默认情况下，如果满足以下条件，则图层的图例元素将不会渲染在图例中：

• 图层的 legendEnabled 属性设置为 false。
• 如果视图的比例超出图层的 minScale 和 maxScale 属性定义的可见性范围。

当图例的 respectLayerVisibility 属性设置为 false 时，地图中每个图层的图例元素将始终显示，因此忽略地图中每个图层的 minScale、maxScale 和 legendEnabled 属性。

默认值：true

另请参阅

• hideLayersNotInCurrentView

示例

// Always displays legend elements for the map's layers
// regardless of their minScale, maxScale, and legendEnabled properties
legend.respectLayerVisibility = false;

state Stringreadonly

视图模型的状态。

可能的值："ready"|"disabled"

默认值：disabled

view MapView|SceneView

微件将从中操作的视图。

方法概述

方法详细说明

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

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