Class Ground

Ground覆盖物

Abstract

提供Ground覆盖物创建、操作方法

Since

1.0.0

Package

@bdmap/map

Hierarchy (view full)

Overlay
- Ground

Constructors

constructor

new Ground(opts): Ground

构造函数，默认参数如下

{
   bounds: [new LatLng(30.5,110.5),new LatLng(40,120)],
   anchorX: 0.5,
   anchorY: 0.5,
   transparency: 1
}

Parameters

opts: IGroundOption

Returns Ground

Properties

uuid

uuid: string

type

type: default

eventListener

eventListener: TOverlayListener = {}

isDestroyed

isDestroyed: boolean = false

Accessors

typeName

get typeName(): string
Returns string
Overrides Overlay.typeName

visible

get visible(): boolean
获取显示状态

Returns boolean
Since
1.0.0

Inherited from Overlay.visible
set visible(val): void
设置显示状态
Parameters
- val: boolean
Returns void
Since
1.0.0

Inherited from Overlay.visible

zIndex

get zIndex(): number
获取覆盖物显示层级

Returns number
Since
1.0.0

Inherited from Overlay.zIndex
set zIndex(val): void
设置覆盖物显示层级
Parameters
- val: number
Returns void
Since
1.0.0

Inherited from Overlay.zIndex

Methods

getImage

getImage(): Maybe<ImageEntity>
获取填充图像

Returns Maybe<ImageEntity>
Since
1.0.0

Overrides Overlay.getImage

image

image(image): Ground
设置填充图像
Parameters
- image: ImageEntity
Returns Ground
Since
1.0.0

setImage

setImage(image): void
设置填充图像
Parameters
- image: ImageEntity
Returns void
Since
1.0.0

getDimensions

getDimensions(): IDimension
获取填充区域宽高，单位米

Returns IDimension
Since
1.0.0

getAnchor

getAnchor(): IAnchor
获取锚点

Returns IAnchor
Since
1.0.0

anchor

anchor(anchorx, anchory): Ground
设置锚点比例，取值[0,1]
Parameters
- anchorx: number
- anchory: number
Returns Ground
Abstract
默认0.5，水平/垂直方向都居中

Since
1.0.0

setAnchor

setAnchor(anchorx, anchory): void
设置锚点比例，取值[0,1]
Parameters
- anchorx: number
- anchory: number
Returns void
Abstract
默认0.5，水平/垂直方向都居中

Since
1.0.0

bounds

bounds(southwest, northeast): Ground
设置显示区域
Parameters
- southwest: LatLng
  左下角坐标
- northeast: LatLng
  右上角坐标
Returns Ground
Since
1.0.0

getBound

getBound(): [LatLng, LatLng]
获取显示区域坐标

Returns [LatLng, LatLng]
Since
1.0.0

setBound

setBound(southwest, northeast): void
设置显示区域
Parameters
- southwest: LatLng
  左下角坐标
- northeast: LatLng
  右上角坐标
Returns void
Since
1.0.0

transparency

transparency(num): Ground
设置图片透明度
Parameters
- num: number
Returns Ground
Since
1.0.0

setTransparency

setTransparency(num): void
设置图片透明度
Parameters
- num: number
Returns void
Since
1.0.0

getTransparency

getTransparency(): number
获取图片透明度

Returns number
Since
1.0.0

toString

toString(): string
Returns string
Since
1.0.1

Overrides Overlay.toString

`Static` putPointsInfoIntoBundle

putPointsInfoIntoBundle(points, b): void
Parameters
- points: LatLng[]
- b: undefined
Returns void
Inherited from Overlay.putPointsInfoIntoBundle

addEventListener

addEventListener(model, fun): void
Parameters
- model: OverlayEvent
- fun: Function
Returns void
Since
1.0.1

History
包1.0.0 版本中 model:string , 取值范围 'CLICK'、'TOUCH'

Inherited from Overlay.addEventListener

removeEventListener

removeEventListener(model, fun): void
Parameters
- model: OverlayEvent
- fun: Function
Returns void
Since
1.0.1

History
包1.0.0 版本中 model:string , 取值范围 'CLICK'、'TOUCH'

Inherited from Overlay.removeEventListener

addDragListener

addDragListener(listener): void
添加拖拽监听器，当前仅支持Marker、Label
Parameters
- listener: OverlayDragListener
Returns void
Since
2.0.3

Inherited from Overlay.addDragListener

removeDragListener

removeDragListener(): void
移除拖拽监听器

Returns void
Since
2.0.3

Inherited from Overlay.removeDragListener

getDragListener

getDragListener(): Maybe<OverlayDragListener>
获取拖拽监听器

Returns Maybe<OverlayDragListener>
Since
2.0.3

Inherited from Overlay.getDragListener

fireEvent

fireEvent(model, content): void
Parameters
- model: OverlayEvent
- content: EventOverlayBundle
Returns void
Inherited from Overlay.fireEvent

getType

getType(): default
Returns default
Inherited from Overlay.getType

setAnimation

setAnimation(animation): void
Parameters
- animation: Animation
Returns void
Inherited from Overlay.setAnimation

getAnimation

getAnimation(): Maybe<Animation>
Returns Maybe<Animation>
Inherited from Overlay.getAnimation

setVisible

setVisible(val): void
设置显示状态
Parameters
- val: boolean
Returns void
Since
1.0.0

Inherited from Overlay.setVisible

getVisible

getVisible(): boolean
获取显示状态

Returns boolean
Since
1.0.0

Inherited from Overlay.getVisible

alpha

alpha(alpha): Ground
设置透明度
Parameters
- alpha: number
  取值范围[0,1]
Returns Ground
Since
1.0.0

Inherited from Overlay.alpha

getAlpha

getAlpha(): number
获取透明度

Returns number
Since
1.0.0

Inherited from Overlay.getAlpha

setAlpha

setAlpha(alpha): void
设置透明度
Parameters
- alpha: number
  取值范围[0,1]
Returns void
Since
1.0.0

Inherited from Overlay.setAlpha

startLevel

startLevel(startLevel): Ground
设置覆盖物开始显示的地图缩放层级
Parameters
- startLevel: number
Returns Ground
Since
1.0.0

Inherited from Overlay.startLevel

getStartLevel

getStartLevel(): number
获取覆盖物开始显示的地图缩放层级

Returns number
Since
1.0.0

Inherited from Overlay.getStartLevel

setStartLevel

setStartLevel(startLevel): void
设置覆盖物开始显示的地图缩放层级
Parameters
- startLevel: number
Returns void
Since
1.0.0

Inherited from Overlay.setStartLevel

endLevel

endLevel(endLevel): Ground
设置覆盖物结束显示的地图缩放层级
Parameters
- endLevel: number
Returns Ground
Since
1.0.0

Inherited from Overlay.endLevel

showLevel

showLevel(from, to): void
Parameters
- from: number
- to: number
Returns void
Inherited from Overlay.showLevel

getEndLevel

getEndLevel(): number
获取marker结束显示的地图缩放层级

Returns number
Since
1.0.0

Inherited from Overlay.getEndLevel

setShowLevel

setShowLevel(from, to): void
Parameters
- from: number
- to: number
Returns void
Inherited from Overlay.setShowLevel

setEndLevel

setEndLevel(endLevel): void
设置覆盖物结束显示的地图缩放层级
Parameters
- endLevel: number
Returns void
Since
1.0.0

Inherited from Overlay.setEndLevel

clickable

clickable(isClickable): Ground
设置是否可点击
Parameters
- isClickable: boolean
Returns Ground
Since
1.0.0

Inherited from Overlay.clickable

getClickable

getClickable(): boolean
获取是否可点击状态

Returns boolean
Since
1.0.0

Inherited from Overlay.getClickable

setClickable

setClickable(isClickable): void
设置是否可点击
Parameters
- isClickable: boolean
Returns void
Since
1.0.0

Inherited from Overlay.setClickable

setZIndex

setZIndex(val): void
设置覆盖物显示层级
Parameters
- val: number
Returns void
Since
1.0.0

Inherited from Overlay.setZIndex

getZIndex

getZIndex(): number
获取覆盖物显示层级

Returns number
Since
1.0.0

Inherited from Overlay.getZIndex

setExtraInfo

setExtraInfo(extraInfo): void
设置覆盖物属性数据
Parameters
- extraInfo: AnyObject
Returns void
Since
1.0.0

Inherited from Overlay.setExtraInfo

getExtraInfo

getExtraInfo(): AnyObject
获取覆盖物属性数据

Returns AnyObject
Since
1.0.0

Inherited from Overlay.getExtraInfo

getBmDrawItem

getBmDrawItem(): undefined | default
Returns undefined | default
Inherited from Overlay.getBmDrawItem

update

update(): void
Returns void
Inherited from Overlay.update

remove

remove(noUpdate?): void
移除覆盖物
Parameters
- Optional noUpdate: boolean
Returns void
Since
1.0.0

Inherited from Overlay.remove

isRemoved

isRemoved(): undefined | boolean
获取是否移除状态

Returns undefined | boolean
Since
1.0.0

Inherited from Overlay.isRemoved

destroy

destroy(): void
仅适用用户主动触发的销毁

Returns void
Inherited from Overlay.destroy

Class Ground

Abstract

Since

Package

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Ground

Properties

uuid

type

eventListener

isDestroyed

Accessors

typeName

Returns string

visible

Returns boolean

Since

Parameters

Returns void

Since

zIndex

Returns number

Since

Parameters

Returns void

Since

Methods

getImage

Returns Maybe<ImageEntity>

Since

image

Parameters

Returns Ground

Since

setImage

Parameters

Returns void

Since

getDimensions

Returns IDimension

Since

getAnchor

Returns IAnchor

Since

anchor

Parameters

Returns Ground

Abstract

Since

setAnchor

Parameters

Returns void

Abstract

Since

bounds

Parameters

Returns Ground

Since

getBound

Returns [LatLng, LatLng]

Since

setBound

Parameters

Returns void

Since

transparency

Parameters

Returns Ground

Since

setTransparency

Parameters

Returns void

`Static` putPointsInfoIntoBundle