-
Name Type 描述 attributionsAttributionLike | undefined 版权信息。
distancenumber (defaults to 20) 要素聚集的像素距离。
minDistancenumber (defaults to 0) 聚类之间的最小像素距离。该距离将被限制在配置的范围内。默认不保证最小距离。此配置可用于避免图标重叠。作为权衡,聚类要素的位置将不再位于其所有要素的中心。
geometryFunctionGeometryFunction<FeatureType> | undefined 接收一个参数的函数
Feature作为参数并返回一个Point作为要素的聚类计算点。当某个要素不应被纳入聚类时,该函数应返回null默认值在底层数据源仅包含点要素时有效。function(feature) { return feature.getGeometry(); }参见
getInteriorPoint获取多边形聚类计算点的方法createClusterfunction | undefined 接受聚类中心的函数
Point以及一个数组Feature包含于该聚类中。必须返回一个Feature将用于渲染。默认实现为:function(point, features) { return new Feature({ geometry: point, features: features }); }sourceVectorSource<FeatureType> (defaults to null) 数据源.
wrapXboolean (defaults to true) 是否水平循环世界。
触发事件:
addfeature(VectorSourceEvent) - 当要素被添加到矢量源时触发。change(BaseEvent基础事件) - 通用变更事件。当修订计数器增加时触发。changefeatureVectorSourceEvent - 当要素更新时触发。clearVectorSourceEvent向量源事件 - 当调用数据源的清除方法时触发。errorBaseEvent基础事件 - 通用错误事件。在错误发生时触发。featuresloadend(矢量源事件(VectorSourceEvent)) - 在要素加载完成后触发。featuresloaderror(VectorSourceEvent) - 当要素加载失败时触发。featuresloadstart(矢量源事件(VectorSourceEvent)) - 当要素开始加载时触发。propertychange(ObjectEvent对象事件) - 当属性更改时触发。removefeature(矢量源事件(VectorSourceEvent)) - 当要素从矢量源中移除时触发。 有关例外情况,请参阅source.clear()。
继承
方法
-
向源中添加单个要素。若需一次性添加一批要素,请改为调用
#addFeatures()。如果具有相同 ID 的要素已存在,则该要素不会被添加到源中。此举旨在避免在使用边界框或图块加载策略时出现要素重复。注意:若Collection用于要素,此规则同样适用,即如果在集合中添加了具有重复 ID 的要素,它将立即从集合中移除。Name Type 描述 featureFeatureType 要添加的要素。
-
向数据源添加一批要素。
Name Type 描述 featuresArray.<FeatureType> 要添加的要素。
-
递增修订计数器并触发变更事件。
-
从数据源中移除所有要素。
Name Type 描述 fastboolean | undefined 跳过事件分发
removefeature事件. -
触发一个事件,并调用所有侦听此类型事件的侦听器。事件参数可以是字符串,也可以是具有
type属性的对象。Name Type 描述 eventBaseEvent | string 事件对象。
返回:
false如果事件对象上被调用了 preventDefault 方法,或者任何监听器返回了 false。
-
遍历数据源中的所有要素,对每个要素调用提供的回调函数。如果回调返回任何真值,迭代将停止,并且函数将返回该值。注意:此函数仅遍历几何已定义的要素。
Name Type 描述 callbackfunction 对源中的每个要素进行调用。返回真值以停止迭代。
返回:
回调函数最后一次调用的返回值。
-
遍历所有边界框与指定范围相交的要素(请注意,要素的几何图形可能与范围不相交),并为每个要素调用回调函数。如果回调函数返回真值,则迭代将停止,且函数将返回该值。
若您关注几何与范围相交的要素,请改用
#forEachFeatureIntersectingExtent()方法。当
useSpatialIndex设置为 false 时,该方法将遍历所有要素,等效于#forEachFeature()。Name Type 描述 extentExtent 范围.
callbackfunction 对每个边界框与指定范围相交的要素进行调用。
返回:
最后一次回调调用的返回值。
-
forEachFeatureIntersectingExtent(extent, callback){T | undefined} inherited
-
遍历所有几何与指定范围相交的要素,并对每个要素调用回调函数。若回调函数返回真值,则迭代终止,函数返回该真值。
若仅需测试边界框相交,请调用
#forEachFeatureInExtent()方法。Name Type 描述 extentExtent 范围.
callbackfunction 对几何与提供范围相交的每个要素进行调用。
返回:
回调函数最后一次调用的返回值。
-
获取值。
Name Type 描述 keystring 键名。
返回:
值。
-
获取数据源的归属函数
返回:
归属功能。
-
返回:
版权信息可折叠。
-
getClosestFeatureToCoordinate(coordinate, filter){FeatureType | null} inherited
-
获取距离给定坐标最近的要素。
当数据源中
useSpatialIndex设置为false,且要素类型为Feature时,此方法不可用。Name Type 描述 coordinateCoordinate 坐标
filterfunction | undefined 要素过滤函数。 过滤函数将接收一个参数,即
feature应返回布尔值。默认不进行过滤。返回:
最近的要素(若未找到,则返回null)。
-
计算聚类之间的像素距离。
返回:
距离.
-
获取当前源中要素的范围。
当数据源将
useSpatialIndex设置为false时,此方法不可用。Name Type 描述 extentExtent | undefined 目标范围。如果已指定,则不会创建新范围,而是直接覆盖其坐标。
返回:
范围.
-
getFeatureById(id){FeatureClassOrArrayOfRenderFeatures<FeatureType> | null} inherited
-
通过其标识符(即 feature.getId() 返回的值)获取要素。当使用
RenderFeatures 时,getFeatureById()可以返回一个RenderFeatures 数组。这允许处理GeometryCollection几何图形,其中格式读取器为每个GeometryCollection成员创建一个RenderFeature。请注意,索引将字符串和数字标识符视为相同。因此source.getFeatureById(2)将返回 id 为'2'或2的要素。Name Type 描述 idstring | number 要素标识符。
返回:
要素(若未找到,则为null)。
-
以随机顺序获取数据源上当前要素的快照。返回的数组是一个副本,要素是对数据源中要素的引用。
返回:
要素。
-
获取几何图形与给定坐标相交的所有要素。
Name Type 描述 coordinateCoordinate 坐标。
返回:
要素。
-
获取与此数据源关联的要素集合。将为
null,除非数据源在配置时设置了useSpatialIndex为false,或者配置了Collection为features。返回:
要素集
-
获取边界框与提供的范围相交的所有要素。请注意,此方法会以随机顺序返回与给定范围相交的所有要素的数组(因此可能包含几何不与范围相交的要素)。
当
useSpatialIndex设置为 false 时,该方法将返回所有要素。Name Type 描述 extentExtent 范围.
projectionProjection | undefined 包含要素,其中
extent超出x轴范围projection并环绕世界。返回:
要素。
-
获取该数据源的格式。
返回:
} 要素格式。
-
获取对象属性名称列表
返回:
属性列表
-
配置的聚类间最小距离。
返回:
最小像素距离。
-
获取源的投影。
返回:
投影.
-
获取所有属性名及其对应值的对象。
返回:
对象。
-
获取该对象的版本号。每次修改对象时,其版本号都会递增。
返回:
修订。
-
获取包装源的引用。
返回:
数据源.
-
获取源的状态,请参阅
State了解可能的状态。返回:
状态。
-
获取与此数据源关联的 URL。
返回:
网址。
-
若要素被包含在源中,则返回 True。
Name Type 描述 featureFeatureType 要素.
返回:
有要素。
-
监听特定类型的事件。
Name Type 描述 typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听器函数。
返回:
监听器的唯一键。如果以事件类型数组作为第一个参数调用,则返回将是键的数组。
-
仅监听一次特定类型的事件。
Name Type 描述 typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听器函数。
返回:
监听器的唯一键。如果以事件类型数组作为第一个参数调用,则返回将是键的数组。
-
从源中移除单个要素。若要批量移除要素,请改用
#removeFeatures()方法。Name Type 描述 featureFeatureType 要删除的要素。
-
从数据源中批量删除要素。若要一次性删除所有要素,请改用
#clear()方法。Name Type 描述 featuresArray.<FeatureType> 要删除的要素。
-
从已加载范围列表中移除一个范围。
Name Type 描述 extentExtent 范围.
-
设置值。
Name Type 描述 keystring 键名。
value* 值。
silentboolean | undefined 更新而不触发事件。
-
设置数据源的归属信息。
Name Type 描述 attributionsAttributionLike | undefined 归属。可以传递为
string,Array<string>,Attribution,或者undefined. -
设置要素聚类的距离。
Name Type 描述 distancenumber 像素距离
-
设置数据源的新加载器。下一个渲染周期将使用新的加载器。
Name Type 描述 loaderFeatureLoader 要设置的加载器。
-
设置簇之间的最小距离,上限为配置的距离。
Name Type 描述 minDistancenumber 最小像素距离。
-
设置一组键值对。请注意,此操作将修改现有属性并添加新属性,但不会删除任何现有属性。
Name Type 描述 valuesObject.<string, *> 值。
silentboolean | undefined 更新而不触发事件。
-
替换已封装的源。
Name Type 描述 sourceVectorSource<FeatureType> | null 该实例的新源
-
将源指向新的URL。下一个渲染周期将使用新的URL。
Name Type 描述 urlstring | FeatureUrlFunction 网址。
-
取消监听特定类型的事件。
Name Type 描述 typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听函数。
-
清除属性。
Name Type 描述 keystring 键名。
silentboolean | undefined 在不触发事件的情况下取消设置。