FenceGeotrigger

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

该条件用于监控地理触发器源的动态元素,以根据 Fence 参数所定义的围栏进入/退出。

示例
let fenceGeotrigger = new FenceGeotrigger({
  name: "Example Geotrigger - Notify when I am within 50m of my target areas.",
  enterExitRule: "enter-intersects-and-exit-does-not-intersect",
  feed: {
    filterExpression: {
      title: "Location filter",
      expression: "return $locationupdate.horizontalaccuracy <= 20"
    }
  },
  fenceNotificationRule: "enter",
  feedAccuracyMode: "use-geometry-with-accuracy",
  fenceParameters: {
    bufferDistance: 50,
    fenceSource: {
      layerUrl: "http://sampleserver6.arcgisonline.com/geoscene/rest/services/Recreation/MapServer/0"
    },
  },
  notificationOptions: {
    expressionInfo: {
      "title": "Expression",
      "expression": "'You have entered' + $fencefeature.AREA_NAME"
    }
  }
})

构造函数

new FenceGeotrigger(properties)
参数
properties Object
optional

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

属性概述

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

类的名称。

更多详情
Accessor
String

确定几何是否已从源中进入或退出围栏多边形的规则。

更多详情
FenceGeotrigger
DeviceLocationFeed

此地理触发器的源。

更多详情
FenceGeotrigger
String

指示地理触发器将如何使用源中的精度信息。

更多详情
FenceGeotrigger
String

指示将触发围栏地理触发器通知的事件类型。

更多详情
FenceGeotrigger
FeatureFenceParameters

定义用于此地理触发器的围栏的对象。

更多详情
FenceGeotrigger
String

此地理触发器的名称。

更多详情
FenceGeotrigger
GeotriggerNotificationOptions

当满足 Geotrigger 条件时,用于控制发送给客户端应用程序的通知信息的选项。

更多详情
FenceGeotrigger
String

指示 Geotrigger 条件类型的字符串。

更多详情
FenceGeotrigger

属性详细信息

declaredClass Stringreadonly inherited

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

enterExitRule String

确定几何是否已从源中进入或退出围栏多边形的规则。必须将 feedAccuracyMode 设置为 use-geometry-with-accuracy,此属性才能产生效果。

进入退出规则 描述
enter-intersects-and-exit-does-not-intersect 当围栏多边形与源几何相交时,则进入围栏;不再相交时则退出。
enter-contains-and-exit-does-not-contain 当围栏多边形包含源几何时,则进入围栏;不再包含时则退出。
enter-contains-and-exit-does-not-intersect 当围栏多边形包含源几何时,则进入围栏;不再相交时则退出。

可能值"enter-contains-and-exit-does-not-contain"|"enter-contains-and-exit-does-not-intersect"|"enter-intersects-and-exit-does-not-intersect"

默认值:enter-contains-and-exit-does-not-intersect

此地理触发器的源。

默认值:null
feedAccuracyMode String

指示地理触发器将如何使用源中的精度信息。

源精度模式 描述
use-geometry 将使用源中报告的几何。
use-geometry-with-accuracy 源几何将与精度信息一起使用。

可能值"use-geometry"|"use-geometry-with-accuracy"

默认值:use-geometry
fenceNotificationRule String

指示将触发围栏地理触发器通知的事件类型。例如,当源的几何进入围栏多边形时,enter 的值将导致通知。

可能值"enter"|"enter-or-exit"|"exit"

默认值:null
fenceParameters FeatureFenceParameters

定义用于此地理触发器的围栏的对象。

默认值:null
name String

此地理触发器的名称。

默认值:null
notificationOptions GeotriggerNotificationOptions

当满足 Geotrigger 条件时,用于控制发送给客户端应用程序的通知信息的选项。

默认值:null
type Stringreadonly

指示 Geotrigger 条件类型的字符串。

对于 FenceGeotrigger,类型总是 "fence"

方法概述

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

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

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

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

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