Summary

Constructor

Methods

get(key) → {Object}

获取构造叠加物时，属性options中key对应的value值。

Parameters:

Name	Type	Description
key	String	属性options中的键。

Returns:

Object -

键对应的value值

getDomId() → {String}

获取叠加物的div元素的id值。

Returns:

String -

id值。

getElement() → {HTMLElement}

获取当前叠加物内容中的DOM元素。

Returns:

HTMLElement -

返回叠加物的DOM内容。

getLayer() → {module:layer~OverlayLayer}

获取叠加物所在图层对象。

Returns:

module:layer~OverlayLayer -

图层对象；若叠加物对象没有加到图层上，则返回null。

getLocation() → {module:basetype~Coordinate}

获取叠加物的锚点的地理坐标。

Returns:

module:basetype~Coordinate -

地理坐标。

getOffset() → {module:basetype~Offset}

获取在叠加物地理坐标上增加的偏移量。

Returns:

module:basetype~Offset -

偏移量对象。

setDomId(domId) → {module:overlay~Overlay}

设置叠加物的div元素的id值。

Parameters:

Name	Type	Description
domId	String	id值。

Returns:

module:overlay~Overlay -

返回设置后的叠加物对象。

setElement(element) → {module:overlay~Overlay}

重新设置叠加物中的DOM内容。

Parameters:

Name	Type	Description
element	HTMLElement	DOM对象。

Returns:

module:overlay~Overlay -

返回设置后的叠加物对象。

setLocation(location) → {module:overlay~Overlay}

重新设置叠加物的锚点的地理坐标。

Parameters:

Name	Type	Description
location	module:basetype~Coordinate	地理坐标。

Throws:

Error -

当传入的location参数不是module:basetype~Coordinate的时候，抛出异常“the parameter must be Coordinate!”

Returns:

module:overlay~Overlay -

返回设置后的叠加物对象。

setOffset(offset) → {module:overlay~Overlay}

基于叠加物的地理坐标，设置偏移量。

Parameters:

Name	Type	Description
offset	module:basetype~Offset	偏移量对象。

Returns:

module:overlay~Overlay -

返回设置后的叠加物对象。

setVisibility(visible)

设置叠加物对象的DOM元素的显示隐藏。

Parameters:

Name	Type	Default	Description
visible	Boolean	true	显示设置true，隐藏设置false。