JSDoc: Class: Geom

Constructor

new Geom(geometry, type)

覆盖物类

Parameters:

Name	Type	Description
`geometry`	object	原生的覆盖物类
`type`	string	覆盖物类型

Source:

ext/geom/index.js, line 12

Methods

addMapEventListener(eventsOn, handler, context) → {function}

事件绑定,别名

Parameters:

Name	Type	Description
`eventsOn`	*	要注册的事件类型
`handler`	function	要调用的处理函数
`context`	*	处理程序的上下文

Source:

ext/geom/index.js, line 352

Returns:

返回处理过的回调,用于移除绑定

Type: function

addTo(map, fitviewopt)

将覆盖物添加到默认图层

Parameters:

Name	Type	Attributes	Default	Description
`map`	object			map\|\|layer 地图或图层对象,必传
`fitview`	boolean	<optional>	false	是否自动将地图设置为合适的中心并缩放覆盖物

Source:

ext/geom/index.js, line 439

animate(styles, options, step)

覆盖物的动画声明(HTML覆盖物不支持)

Parameters:

Name Type Description

styles * 动画样式

options

动画选项

Properties

Name	Type	Description
`duration`	Number	时间
`startTime`	Number	动画开始时间以毫秒为单位
`easing`	string	动画缓动样式 in, out, inAndOut, linear, upAndDown
`repeat`	boolean	动画是否循环

step * 动画步进过程中的回调,参数为当前动画状态

Source:

ext/geom/index.js, line 949

animateCancel()

取消本次动画播放(如果有)并准备再次播放

Source:

ext/geom/index.js, line 986

animateFinish()

完成动画播放(如果有),无法再播放

Source:

ext/geom/index.js, line 997

animatePause()

暂停动画播放(如果有)

Source:

ext/geom/index.js, line 975

animatePlay()

开始动画播放(如果有)

Source:

ext/geom/index.js, line 964

animateShow(options, callback)

线,面类型的展开动画(声明后自动显示展开动画)

Parameters:

Name Type Description

options

动画选项

Properties

Name	Type	Description
`duration`	*	动画时间
`easing`	*	动画缓动样式 in, out, inAndOut, linear, upAndDown

callback * 动画步进过程中的回调,参数为当前动画状态和当前动画步进坐标

Source:

ext/geom/index.js, line 1013

bringToBack() → {Geom}

将覆盖物放在后面(HTML覆盖物不支持)

Source:

ext/geom/index.js, line 701

Returns:

修改后的覆盖物对象

Type: Geom

bringToFront() → {Geom}

将覆盖物放在顶部(HTML覆盖物不支持)

Source:

ext/geom/index.js, line 690

Returns:

修改后的覆盖物对象

Type: Geom

closeInfoWindow()

关闭信息窗体

Source:

ext/geom/index.js, line 543

createArcConnectorLineFeature(src, target, options) → {Geom}

曲线连接线

Parameters:

Name Type Description

src Geom 连接源覆盖物

target Geom 目标覆盖物

options

Object

连接线配置项

Properties

Name	Type	Description
`showOn`	String	何时显示连接线('moving', 'click', 'mouseover', 'always')
`arcDegree`	Number	圆弧度
`arrowStyle`	String \| Array.<Number>	箭头样式,同上
`arrowPlacement`	String	箭头的位置(vertex-first, vertex-last, vertex-firstlast, point)
`smoothness`	Number	对线进行平滑处理，默认情况下为0
`enableSimplify`	Boolean	是否在渲染之前简化路径
`simplifyTolerance`	Number	简化路径的容忍度越高，简化越激烈
`enableClip`	Boolean	是否用地图的当前范围剪切路径
`id`	Boolean	几何体的ID
`visible`	Boolean	几何是否可见
`editable`	Boolean	是否可以编辑几何。
`interactive`	Boolean	几何是否可以交互。
`cursor`	String	鼠标悬停在几何上时的光标样式，与CSS中的定义相同。
`draggable`	Boolean	是否可以拖动几何。
`dragShadow`	Boolean	如果为true，则在拖动几何图形期间，将在移动几何图形之前拖动阴影。
`dragOnAxis`	Boolean	如果设置，则只能沿指定的轴拖动几何，可能的值：x，y
`zIndex`	Number	几何的初始zIndex
`measure`	Number	坐标系，默认EPSG：4326
`symbol`	Object	路径的默认符号

Source:

ext/geom/index.js, line 164

Returns:

Type: Geom

createCircleFeature(coordinates, radius, options) → {Geom}

创建圆形实例

Parameters:

Name Type Description

coordinates Array 圆心;例如[-0.157049, 52.498568]

radius number 圆的半径，以米为单位

options

object

圆形配置项,同上

Properties

Name	Type	Description
`numberOfShellPoints`	number	将圆转换为多边形时的点数

Source:

ext/geom/index.js, line 242

Returns:

返回Geom实例

Type: Geom

createConnectorLineFeature(src, target, options) → {Geom}

直线连接线

Parameters:

Name Type Description

src Geom 连接源覆盖物

target Geom 目标覆盖物

options

Object

连接线配置项

Properties

Name	Type	Description
`showOn`	String	何时显示连接线('moving', 'click', 'mouseover', 'always')
`arrowStyle`	String \| Array.<Number>	箭头样式,同上
`arrowPlacement`	String	箭头的位置(vertex-first, vertex-last, vertex-firstlast, point)
`smoothness`	Number	对线进行平滑处理，默认情况下为0
`enableSimplify`	Boolean	是否在渲染之前简化路径
`simplifyTolerance`	Number	简化路径的容忍度越高，简化越激烈
`enableClip`	Boolean	是否用地图的当前范围剪切路径
`id`	Boolean	几何体的ID
`visible`	Boolean	几何是否可见
`editable`	Boolean	是否可以编辑几何。
`interactive`	Boolean	几何是否可以交互。
`cursor`	String	鼠标悬停在几何上时的光标样式，与CSS中的定义相同。
`draggable`	Boolean	是否可以拖动几何。
`dragShadow`	Boolean	如果为true，则在拖动几何图形期间，将在移动几何图形之前拖动阴影。
`dragOnAxis`	Boolean	如果设置，则只能沿指定的轴拖动几何，可能的值：x，y
`zIndex`	Number	几何的初始zIndex
`measure`	Number	坐标系，默认EPSG：4326
`symbol`	Object	路径的默认符号

Source:

ext/geom/index.js, line 123

Returns:

Type: Geom

createHtmlOverlay(coordinates, options) → {Geom}

创建HTMLElement实例

Parameters:

Name Type Description

coordinates Array 坐标

options

Object

配置项

Properties

Name	Type	Description
`draggable`	Boolean	是否可以拖动标记
`single`	Number	标记是全局单个标记
`content`	String \| HTMLElement	标记的内容可以是字符串类型的HTML代码或HTMLElement。
`eventsPropagation`	Boolean	是否阻止冒泡
`eventsToStop`	Boolean
`dx`	Number	x轴上的像素偏移
`dy`	Number	y轴上的像素偏移
`autoPan`	Boolean	是否地图进行平移动画打开
`autoPanDuration`	Boolean	自动平移动画的持续时间
`animation`	Boolean	fade \| scale 在显示和隐藏时淡入，缩放，添加动画效果
`animationDuration`	Number	动画持续时间（以毫秒为单位）
`pitchWithMap`	Boolean	是否与地图倾斜
`rotateWithMap`	Boolean	是否随地图旋转

Source:

ext/geom/index.js, line 315

Returns:

返回Geom实例

Type: Geom

createIconFeature(position, options) → {Geom}

创建图标实例

Parameters:

Name	Type	Description
`position`	Array	点标记坐标
`options`	object	点标记配置项,同上

Source:

ext/geom/index.js, line 53

Returns:

返回Geom实例

Type: Geom

createLableFeature(content, coordinates, width, height, options) → {Geom}

创建文本框实例

Parameters:

Name Type Description

content String 文字内容

coordinates Array 中心点坐标

width Number 像素宽度

height Number 像素高度

options

Object

配置项

Properties

Name Type Description

textStyle

Object

文字样式

Properties

Name	Type	Description
`wrap`	Boolean	是否自动换行文本框中的文本
`padding`	Boolean	框中的文本padding
`verticalAlignment`	Boolean	文字的垂直对齐
`horizontalAlignment`	Boolean	文字的水平对齐
`symbol`	Boolean	文字内容的符号

boxSymbol Object 文本框的框符号

id Boolean

visible Boolean 是否可见

editable Boolean 是否可以编辑

interactive Boolean 是否可以交互

cursor String 鼠标悬停在几何上时的光标样式，与CSS中的定义相同

measure String 坐标系,默认EPSG：4326

draggable Boolean 是否可以拖动

dragShadow Boolean 如果为true，则在拖动几何图形期间，将在移动几何图形之前拖动阴影

dragOnAxis Boolean 如果设置，则只能沿指定的轴拖动几何，可能的值：x，y

zIndex Number 初始zIndex

Source:

ext/geom/index.js, line 279

Returns:

返回Geom实例

Type: Geom

createLineStringFeature(positions, options) → {Geom}

创建线类型实例

Parameters:

Name Type Description

positions Array 线覆盖物坐标集合,坐标要两个或两个以上；例如[[-0.131049, 51.498568],[-0.107049, 51.498568]]

options

object

线覆盖物配置项

Properties

Name	Type	Description
`id`	Boolean
`visible`	Boolean	是否可见
`editable`	Boolean	是否可以编辑
`interactive`	Boolean	是否可以交互
`cursor`	String	鼠标悬停在几何上时的光标样式，与CSS中的定义相同
`measure`	String	坐标系,默认EPSG：4326
`draggable`	Boolean	是否可以拖动
`dragShadow`	Boolean	如果为true，则在拖动几何图形期间，将在移动几何图形之前拖动阴影
`dragOnAxis`	Boolean	如果设置，则只能沿指定的轴拖动几何，可能的值：x，y
`zIndex`	Number	初始zIndex
`arrowStyle`	String \| Array.<Number>	箭头样式，可以是预定义值或数组[arrow-width，arrow-height]（数组中的值是线宽的倍数）例如:classic ([3, 4])
`arrowPlacement`	String	箭头的位置:vertex-first, vertex-last, vertex-firstlast, point
`smoothness`	Number	对线进行平滑处理，默认情况下为0
`enableSimplify`	Boolean	是否在渲染之前简化线条
`simplifyTolerance`	Number	该值越高，线条简化越激烈
`enableClip`	Boolean	是否用地图的当前范围剪切线条
`symbol`	Object	线条的默认符号

Source:

ext/geom/index.js, line 87

Returns:

返回Geom实例

Type: Geom

createPointFeature(position) → {Geom}

创建点实例

Parameters:

Name	Type	Description
`position`	Array	点标记坐标
`options.id`	Boolean
`options.visible`	Boolean	是否可见
`options.editable`	Boolean	是否可以编辑
`options.interactive`	Boolean	是否可以交互
`options.cursor`	String	鼠标悬停在几何上时的光标样式，与CSS中的定义相同
`options.measure`	String	坐标系,默认EPSG：4326
`options.draggable`	Boolean	是否可以拖动
`options.dragShadow`	Boolean	如果为true，则在拖动几何图形期间，将在移动几何图形之前拖动阴影
`options.dragOnAxis`	Boolean	如果设置，则只能沿指定的轴拖动几何，可能的值：x，y
`options.zIndex`	Number	初始zIndex
`options.symbol`	Object	点标记的默认符号

Source:

ext/geom/index.js, line 37

Returns:

返回Geom实例

Type: Geom

createPolygonFeature(positions, options) → {Geom}

创建多边形实例

Parameters:

Name Type Description

positions Array 多边形坐标集合,坐标要三个或三个以上；例如[[-0.131049, 51.498568],[-0.107049, 51.498568],[-0.157049, 52.498568]]

options

object

多边形配置项

Properties

Name	Type	Description
`id`	Boolean
`visible`	Boolean	是否可见
`editable`	Boolean	是否可以编辑
`interactive`	Boolean	是否可以交互
`cursor`	String	鼠标悬停在几何上时的光标样式，与CSS中的定义相同
`measure`	String	坐标系,默认EPSG：4326
`draggable`	Boolean	是否可以拖动
`dragShadow`	Boolean	如果为true，则在拖动几何图形期间，将在移动几何图形之前拖动阴影
`dragOnAxis`	Boolean	如果设置，则只能沿指定的轴拖动几何，可能的值：x，y
`zIndex`	Number	初始zIndex
`smoothness`	Number	对多边形进行平滑处理，默认情况下为0
`enableSimplify`	Boolean	是否在渲染之前简化多边形
`simplifyTolerance`	Number	该值越高，多边形简化越激烈
`enableClip`	Boolean	是否用地图的当前范围剪切多边形
`symbol`	Object	多边形的默认符号

Source:

ext/geom/index.js, line 199

Returns:

返回Geom实例

Type: Geom

createRectangleFeature(coordinates, width, height, options) → {Geom}

创建矩形实例

Parameters:

Name	Type	Description
`coordinates`	Array	矩形左上角坐标;例如[-0.157049, 52.498568]
`width`	number	矩形宽度,以米为单位
`height`	number	矩形高度,以米为单位
`options`	object	矩形配置项,同上

Source:

ext/geom/index.js, line 218

Returns:

返回Geom实例

Type: Geom

flash(intervalopt, countopt, cbopt, contextopt) → {Geom}

闪烁覆盖物图形

Parameters:

Name	Type	Description
`intervalopt`	Number	闪烁间隔，以毫秒为单位（毫秒）
`countopt`	Number	闪烁次数
`cbopt`	function	Flash结束时的回调函数
`contextopt`	*	上下文信息

Source:

ext/geom/index.js, line 729

Returns:

覆盖物对象

Type: Geom

getCenter() → {Array}

获取对象地理中心坐标

Source:

ext/geom/index.js, line 514

Returns:

返回坐标数组[x,y]

Type: Array

getContent() → {String}

获取html元素的内容

Source:

ext/geom/index.js, line 917

Returns:

内容

Type: String

getCoordinates() → {Array}

获取覆盖物坐标

Source:

ext/geom/index.js, line 804

Returns:

覆盖物的坐标

Type: Array

getHeight() → {*}

获取矩形高度(仅限矩形)

Source:

ext/geom/index.js, line 860

Returns:

Type: *

getId() → {*}

获取覆盖物的ID。ID由setId或构造函数选项设置。

Source:

ext/geom/index.js, line 464

Returns:

返回覆盖物ID

Type: *

getInfoWindow() → {*}

获取信息窗体实例

Source:

ext/geom/index.js, line 570

Returns:

Type: *

getLayer() → {*}

返回该覆盖物所在图层

Source:

ext/geom/index.js, line 504

Returns:

Type: *

getProperties() → {Object}

获取覆盖物属性(HTML覆盖物不支持)

Source:

ext/geom/index.js, line 668

Returns:

覆盖物的属性

Type: Object

getRadius() → {Number}

获取圆的半径

Source:

ext/geom/index.js, line 881

Returns:

圆形的半径

Type: Number

getSymbol()

获取覆盖物符号(HTML覆盖物不支持)

Source:

ext/geom/index.js, line 635

getWidth() → {*}

获取矩形宽度(仅限矩形)

Source:

ext/geom/index.js, line 838

Returns:

Type: *

getZIndex() → {Number}

获取覆盖物层级,默认是0(HTML覆盖物不支持)

Source:

ext/geom/index.js, line 782

Returns:

Type: Number

hide() → {Geom}

隐藏覆盖物

Source:

ext/geom/index.js, line 751

Returns:

覆盖物对象

Type: Geom

isVisible() → {boolean}

覆盖物是否可见

Source:

ext/geom/index.js, line 762

Returns:

是否可见

Type: boolean

isVisible() → {Boolean}

覆盖物是否可见

Source:

ext/geom/index.js, line 772

Returns:

Type: Boolean

on(eventsOn, handler, context) → {function}

事件绑定

Parameters:

Name	Type	Description
`eventsOn`	*	要注册的事件类型
`handler`	function	要调用的处理函数
`context`	*	处理程序的上下文

Source:

ext/geom/index.js, line 333

Returns:

返回处理过的回调,用于移除绑定

Type: function

once(eventsOn, handler, context)

单次事件绑定,调用一次后移除

Parameters:

Name	Type	Description
`eventsOn`	*	要注册的事件类型
`handler`	function	要调用的处理函数
`context`	*	处理程序的上下文

Source:

ext/geom/index.js, line 370

openInfoWindow(coordinate)

打开信息窗体

Parameters:

Name	Type	Description
`coordinate`	Array	可选,信息窗体打开的位置,例如[0,0],默认为覆盖物中心

Source:

ext/geom/index.js, line 528

RemoveFeature()

从图层中删除自身（如果存在）

Source:

ext/geom/index.js, line 488

removeInfoWindow()

移除信息窗体

Source:

ext/geom/index.js, line 556

removeMapEventListener(eventsOn, handler, context)

事件移除,别名

Parameters:

Name	Type	Description
`eventsOn`	*	要移除的事件类型
`handler`	function	要移除的处理函数,该函数为绑定事件时返回的函数,如不传既移除该事件所有绑定(可选)
`context`	*	处理程序的上下文

Source:

ext/geom/index.js, line 414

setContent(content) → {Geom}

设置html元素的内容

Parameters:

Name	Type	Description
`content`	String	HTMLElement

Source:

ext/geom/index.js, line 930

Returns:

覆盖物对象

Type: Geom

setCoordinates(array) → {Geom}

修改覆盖物坐标

Parameters:

Name	Type	Description
`array`	Array	覆盖物坐标

Source:

ext/geom/index.js, line 828

Returns:

覆盖物对象

Type: Geom

setHeight(num) → {*}

设置矩形高度(仅限矩形)

Parameters:

Name	Type	Description
`num`	*

Source:

ext/geom/index.js, line 871

Returns:

Type: *

setId(id)

设置覆盖物的ID

Parameters:

Name	Type	Description
`id`	*

Source:

ext/geom/index.js, line 474

setInfoWindow(options)

设置信息窗体

Parameters:

Name	Type	Description
`options`	*

Source:

ext/geom/index.js, line 585

setOptions(options) → {Geom}

设置覆盖物的options与默认options合并

Parameters:

Name	Type	Description
`options`	Object	覆盖物options

Source:

ext/geom/index.js, line 904

Returns:

覆盖物对象

Type: Geom

setProperties(properties) → {Geom}

为覆盖物设置新属性(HTML覆盖物不支持)

Parameters:

Name	Type	Description
`properties`	Object	覆盖物的新属性

Source:

ext/geom/index.js, line 679

Returns:

修改后的覆盖物对象

Type: Geom

setRadius(num) → {Geom}

设置圆的半径

Parameters:

Name	Type	Description
`num`	Number	半径

Source:

ext/geom/index.js, line 892

Returns:

圆形覆盖物对象

Type: Geom

setSymbol(symbol) → {Geom}

设置一个新符号以设置覆盖物样式(HTML覆盖物不支持)

Parameters:

Name	Type	Description
`symbol`	Object	新符号样式

Source:

ext/geom/index.js, line 645

Returns:

返回修改后的覆盖物对象

Type: Geom

setWidth(num) → {*}

设置矩形宽度(仅限矩形)

Parameters:

Name	Type	Description
`num`	*

Source:

ext/geom/index.js, line 849

Returns:

Type: *

setZIndex(num) → {Geom}

设置覆盖物层级(HTML覆盖物不支持)

Parameters:

Name	Type	Description
`num`	Number

Source:

ext/geom/index.js, line 793

Returns:

覆盖物对象

Type: Geom

show() → {Geom}

显示覆盖物

Source:

ext/geom/index.js, line 740

Returns:

覆盖物对象

Type: Geom

startDragFeatures()

开启拖拽

Source:

ext/geom/index.js, line 617

startEditFeature()

开始编辑(HTML覆盖物不支持)

Source:

ext/geom/index.js, line 599

stopDragFeatures()

结束拖拽

Source:

ext/geom/index.js, line 626

stopEditFeature()

结束编辑(HTML覆盖物不支持)

Source:

ext/geom/index.js, line 608

translate(x, y) → {Geom}

按给定的偏移量移动覆盖物(HTML覆盖物不支持)

Parameters:

Name	Type	Description
`x`	Number	x偏移
`y`	Number	y偏移

Source:

ext/geom/index.js, line 714

Returns:

修改后的覆盖物对象

Type: Geom

un(eventsOn, handler, context)

事件移除

Parameters:

Name	Type	Description
`eventsOn`	*	要移除的事件类型
`handler`	function	要移除的处理函数,该函数为绑定事件时返回的函数,如不传既移除该事件所有绑定(可选)
`context`	*	处理程序的上下文

Source:

ext/geom/index.js, line 388

updateSymbol(symbol) → {Geom}

更新覆盖物图形的当前符号(HTML覆盖物不支持)

Parameters:

Name	Type	Description
`symbol`	Object	当前覆盖物图形已有的符号

Source:

ext/geom/index.js, line 657

Returns:

返回修改后的覆盖物对象

Type: Geom