类:多重多边形

ol/geom/MultiPolygon~多边形


import MultiPolygon from 'ol/geom/MultiPolygon.js';

多重多边形几何

new MultiPolygon(coordinates, layout, endss)

Name Type 描述
coordinates Array.<(Array.<Array.<module:ol/coordinate~Coordinate>>|module:ol/geom/Polygon~Polygon)> | Array.<number>

坐标。对于内部使用,平面坐标与layoutendss同样被接受。

layout GeometryLayout | undefined

布局。

endss Array.<Array.<number>> | undefined

内部使用的平面坐标端点数组。

触发事件:

继承

方法

appendPolygon(polygon)

将传递的多边形追加到该多重多边形。

Name Type 描述
polygon Polygon

面.

applyTransform(transformFn) inherited

对几何体的坐标应用变换函数。几何体将被就地修改。若不想就地修改几何体,请首先 clone() 它,然后在克隆上使用此函数。

Name Type 描述
transformFn TransformFunction

变换函数接收一个几何坐标的扁平数组。

递增修订计数器并触发change事件。

创建几何的完整副本。

返回:
克隆。

dispatchEvent(event){boolean | undefined} inherited

分发事件并调用所有监听该类型事件的侦听器。事件参数可以是字符串,也可以是具有 type 属性的对象。

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 如果任何监听器调用了事件对象的 preventDefault 或返回了 false。

获取值。

Name Type 描述
key string

键名。

返回:
值。

getArea(){number}

返回投影平面上多重多边形的面积。

返回:
投影平面上的面积。

getClosestPoint(point, closestPoint){Coordinate} inherited

返回几何体到传入点的最近点作为 coordinate

Name Type 描述
point Coordinate

点.

closestPoint Coordinate | undefined

最近点。

返回:
最近点。

getCoordinates(right){Array<Array<Array<Coordinate>>>}

获取此几何体的坐标数组,其结构遵循多多边形GeoJSON坐标数组的格式。

Name Type 描述
right boolean | undefined

按照右手定则定向坐标(外环逆时针,内环顺时针)。如果false,坐标将遵循左手规则进行定向(外环为顺时针方向,内环为逆时针方向)。默认情况下,坐标定向将取决于几何体的构建方式。

返回:
坐标。

获取几何的范围。

Name Type 描述
extent Extent | undefined

范围.

返回:
范围 范围.

返回几何图形的首个坐标。

返回:
第一个坐标。

getInteriorPoints(){MultiPoint}

将内部点作为 multipoint 返回。

返回:
内部点为 XYM 坐标,其中 M 是该点所属的水平交点的长度。

getKeys(){Array.<string>} inherited

获取对象属性名列表。

返回:
属性名称列表。

返回几何的最后一个坐标。

返回:
最后一点。

返回几何的 layout

返回:
布局。

getPolygon(index){Polygon}

返回指定索引处的多边形。

Name Type 描述
index number

索引。

返回:
面.

getPolygons(){Array<Polygon>}

返回此多重多边形的各个多边形。

返回:
多边形。

getProperties(){Object.<string, *>} inherited

获取包含所有属性名称及其对应值的对象。

返回:
对象。

getRevision(){number} inherited

获取该对象的版本号。每当对象发生修改时,其版本号将自动递增。

返回:
修订。

获取该几何的类型。

返回:
几何 类型.

intersectsCoordinate(coordinate){boolean} inherited

如果此几何包含指定坐标,返回true;如果坐标在几何边界上,返回false。

Name Type 描述
coordinate Coordinate

坐标。

返回:
包含坐标。

intersectsExtent(extent){boolean}

测试几何对象与传入范围是否相交。

Name Type 描述
extent Extent

范围.

返回:
如果几何与范围相交,则为 true

on(type, listener){EventsKey | Array<EventsKey>} inherited

监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数

返回:
监听器的唯一键。若以事件类型数组作为首个参数调用,则返回键数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited

一次性监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听函数。

返回:
监听器的唯一键。若以事件类型数组作为第一个参数调用,则返回值将是键的数组。

rotate(angle, anchor) inherited

围绕给定坐标旋转几何体。这会原地修改几何坐标。

Name Type 描述
angle number

逆时针旋转角度(弧度)

anchor Coordinate

旋转中心。

scale(sx, sy, anchor) inherited

缩放几何体(可选原点)。这将原地修改几何坐标。

Name Type 描述
sx number

x方向的缩放因子。

sy number | undefined

y方向的缩放因子(默认为sx)。

anchor Coordinate | undefined

缩放原点(默认为几何范围的中心)。

set(key, value, silent) inherited

设置值。

Name Type 描述
key string

键名。

value *

值。

silent boolean | undefined

更新而不触发事件。

setCoordinates(coordinates, layout)

设置多边形的坐标。

Name Type 描述
coordinates Array<Array<Array<Coordinate>>>

坐标。

layout GeometryLayout | undefined

布局。

setProperties(values, silent) inherited

设置键值对集合。注意:此操作将修改现有属性并添加新属性,但不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。

silent boolean | undefined

更新时不触发事件。

生成该几何的简化版本。对于线串,应用 Douglas Peucker 算法。对于多边形,采用基于量化的简化来保持拓扑。

Name Type 描述
tolerance number

简化容差距离

返回:
原始几何的新简化版本。

transform(source, destination){this} inherited

将几何的每个坐标从一种坐标参考系统转换到另一种坐标参考系统。几何会被就地修改。例如,线变换后仍为线,圆变换后仍为圆。如果您不想就地修改几何,请首先对几何执行 clone(),然后在克隆上使用此函数。

Name Type 描述
source ProjectionLike

当前投影可以是字符串标识符或Projection对象。

destination ProjectionLike

所需的投影可以是字符串标识符或Projection对象。

返回:
该几何。请注意,原始几何已就地修改。

translate(deltaX, deltaY) inherited

平移几何。这会原地修改几何坐标。若想创建新几何,请先 clone() 此几何。

Name Type 描述
deltaX number

X方向增量

deltaY number

Y轴增量

un(type, listener) inherited

取消监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

unset(key, silent) inherited

移除属性。

Name Type 描述
key string

键名。

silent boolean | undefined

取消设置而不触发事件。