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

指示是否在图例中显示 Basemap 图层。

默认值:filterBasemaps

示例代码:

legend.viewModel.basemapLegendVisible = true;

declaredClass Stringreadonly inherited

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

hideLayersNotInCurrentView Boolean

起始版本: GeoScene API for JavaScript 4.22

当 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 API for JavaScript 4.22

确定是否尊重地图中控制图例可见性的图层属性（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

微件将从中操作的视图。