SceneFilter

AMD: require(["geoscene/layers/support/SceneFilter"], (SceneFilter) => { /* code goes here */ });
ESM: import SceneFilter from "@geoscene/core/layers/support/SceneFilter";
类: geoscene/layers/support/SceneFilter
继承于:SceneFilter Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.24
beta

SceneFilter 可定义用于在 SceneLayer 上设置客户端空间过滤器的参数。

可以定义一组多边形几何,以掩膜图层的不同部分。spatialRelationship 属性可定义是否应掩膜多边形内部或外部的内容。

在保存 SceneLayer 时,也会在 WebScenes 中保留此过滤器。

已知限制

  • 具有多个掩膜的次优性能。
  • 在下一版本中,行为可能会略有改变。

构造函数

new SceneFilter(properties)
参数
properties Object
optional

有关可能传递给构造函数的所有属性的列表,请参见属性

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

类的名称。

更多详情
Accessor
Collection<Polygon>

应用于空间过滤器的几何。

更多详情
SceneFilter
String

要执行的掩膜类型。

更多详情
SceneFilter

属性详细信息

declaredClass Stringreadonly inherited

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

geometries Collection<Polygon>autocast

应用于空间过滤器的几何。

spatialRelationship 指定的空间关系将指示应如何使用几何图形来过滤要素。多个重叠的几何应用为其 spatialRelationship 操作的并集。对于多边形内的多个环,可使用奇偶规则来确定点是否在内部。

已知限制

多边形是唯一支持的几何类型。

spatialRelationship String

要执行的掩膜类型。

图示 修改 描述
filter-type-disjoint disjoint - 移除所选区域 移除场景图层的部分。使用多边形,请勿在多边形内绘制部件。例如,添加另一图层,显示城市中该地区的新发展。
filter-type-contains contains - 仅显示所选区域 定义感兴趣区域。使用多边形并仅在该多边形内绘制场景图层的一部分。例如,仅显示城市边界内场景图层的一部分。

可能值"disjoint"|"contains"

默认值:"disjoint"
另请参阅

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象的生命周期相关联的句柄。

更多详情
Accessor
SceneFilter

创建 SceneFilter 对象的深度克隆。

更多详情
SceneFilter
Boolean

如果存在指定的句柄组,则返回 true。

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor

方法详细说明

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(){SceneFilter}

创建 SceneFilter 对象的深度克隆。

返回
类型 描述
SceneFilter SceneFilter 对象的新实例,其等于用于调用 .clone() 的对象。
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");

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息