BuildingFilter

// define a floor filter
const buildingFilter = new BuildingFilter({
  filterBlocks: [{
    // an SQL expression that filters using the BldgLevel field
    filterExpression: "BldgLevel = 3",
    filterMode: {
      type: "wire-frame",
      edges: {
         type: "solid",
         color: [0, 0, 0, 0.8]
      }
    }
  }]
});
// set the filter in the filters array on the layer
buildingLayer.filters = [buildingFilter];
// specify which filter is the one that should be applied
buildingLayer.activeFilterId = buildingFilter.id;

属性概述

属性详细信息

declaredClass Stringreadonly inherited

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

description String

在 UI 中显示的过滤器的描述，例如在 GeoScene Pro 中编辑过滤器时。

filterBlocks Collection<BuildingFilterBlock>

过滤块定义了哪些要素应在受影响的 BuildingSceneLayer 中可见，以及如何绘制过滤的要素。过滤器应至少包含一个过滤块。

过滤块的顺序影响过滤块的应用顺序。例如，如果使用 wire-frame 模式的过滤块在集合中的 solid 过滤块之前，则匹配任一过滤块的元素将被绘制为线框。

id Stringreadonly

唯一的过滤器 Id。将此 id 分配给 BuildingSceneLayer.activeFilterId 以激活过滤器。

name String

在 UI 中显示的过滤器的名称，例如在 GeoScene Pro 中编辑过滤器时。

方法概述

方法详细说明

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

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例，请参阅指南中的使用 fromJSON() 主题。

参数

json Object GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例，请参阅 GeoScene REST API 文档。

返回

类型	描述
*	返回该类的新实例。

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

toJSON(){Object}

将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息，请参阅使用 fromJSON() 指南主题。

返回

类型	描述
Object	此类实例的 GeoScene Portal JSON 表示。

类型定义

BuildingFilterBlock Object

filterBlocks 集合中包含的类：

属性

filterExpression String 用于将要素与此过滤块进行匹配的 SQL where 子句。仅满足过滤表达式的要素才会显示在 SceneView 中。此属性使用缓存的属性在客户端上计算，并且仅支持标准化 SQL。

filterMode Object optional 此对象包含有关过滤块的筛选模式的信息。 规范 type String optional 默认值：solid 定义过滤器处于活动状态时如何绘制要素。solid 模式使用原始纹理来渲染要素。使用 wire-frame 模式，仅显示要素的边缘。x-ray 使用白色渲染半透明的元素。为确保客户端应用程序的性能，不建议声明多个具有相同过滤模式的过滤块。 可能值："solid"|"wire-frame"|"x-ray" edges SolidEdges3D|SketchEdges3D optional 定义用于显示以 wire-frame 模式过滤的 BuildingSceneLayer 的边类型。此属性只能与 wire-frame 类型的 filterMode 模式一起使用。

title String optional 在 UI 中显示的过滤器的标题，例如在 GeoScene Pro 中编辑过滤器时。