Fengmap JavaScript SDK v3.1.7

Class: FMMapMask

FMMapMask

FMMapMask 地图掩膜类，即根据掩膜范围对地图要素增加空间遮罩，对掩膜空间内/外要素进行遮挡。属于fengmap.map.min.js

new fengmap.FMMapMask(options)

Name Type Description
options object

配置项

Name Type Description
polygons array

多边形掩膜数组
polygons[].points[].x number

多边形掩膜的x坐标
polygons[].points[].y number

多边形掩膜的y坐标
polygons[].holes array

多边形内部孔洞二维数组
polygons[].holes[][].x number

多边形内部孔洞的y坐标
polygons[].holes[][].y number

多边形内部孔洞的y坐标
height number

离地高度, 默认为-∞，表示掩膜垂直方向上距离地面的起始高度
extrudeHeight number

拉伸高度，默认为+∞，表示掩膜垂直方向上的厚度；查看图片说明
types array

需要参与掩膜的地图元素Layer，默认所有地图元素Layer，如[FMType.EXTENT_LAYER, FMType.FACILITY_LAYER, FMType.LABEL_LAYER, FMType.MODEL_LAYER, FMType.EXTERNAL_MODEL_LAYER]
showRegion string

掩膜区域内部还是外部，取值'inside'或'outside'，默认为'inside'

Members

polygons

Properties:
Name Type Description
polygons Array

多边形掩膜集合
polygons[].points[].x number

多边形掩膜的x坐标
polygons[].points[].x number

多边形掩膜的y坐标
polygons[].holes array

多边形内部孔洞二维数组
polygons[].holes[][].x number

多边形内部孔洞的y坐标
polygons[].holes[][].y number

多边形内部孔洞的y坐标

showRegion

Properties:
Name Type Description
showRegion string

展示区域内部还是外部，取值'inside'或'outside'

readonlytypes

Properties:
Name Type Description
types Array

需要参与掩膜的元素类型数组，默认所有地图元素类型参与掩膜

Methods

addTo(floor)

添加到楼层，一个楼层仅允许添加一个FMMapMask实例

Name Type Description
floor Object

楼层

remove()

从楼层中移除