# Class: Annotation

## Annotation()

#### new Annotation()

Source:
  - Annotation.js, line 10

### Methods

#### (async, static) createObj(title, description, point, image) → {Promise.<Annotation>}

构造一个新的 Annotation标记对象

##### Parameters:

Name | Type | Description
--- | --- | ---
`title` |  | 标题
`description` |  | 描述
`point` |  | 地图坐标点
`image` |  | 图标 可以为null

Source:
  - Annotation.js, line 23

##### Returns:

Type
  Promise.<Annotation>

#### (async, static) createObjByUID(uid, title, description, point, image) → {Promise.<Annotation>}

构造一个新的 Annotation标记对象

##### Parameters:

Name | Type | Description
--- | --- | ---
`uid` |  | 唯一标识
`title` |  | 标题
`description` |  | 描述
`point` |  | 地图坐标点
`image` |  | 图标 可以为null

Source:
  - Annotation.js, line 44

##### Returns:

Type
  Promise.<Annotation>

#### (async, static) getCenterOffset() → {Promise.<PointF>}

获取标记点与图标底边中心的偏移 ,x方向和y方向 (默认偏移为(0,0))

Source:
  - Annotation.js, line 239

##### Returns:

偏移值

Type
  Promise.<PointF>

#### (async, static) getDescription() → {Promise}

获取描述

Source:
  - Annotation.js, line 114

##### Returns:

描述

Type
  Promise

#### (async, static) getImageHeight() → {Promise}

返回图标高度

Source:
  - Annotation.js, line 198

##### Returns:

图标高度

Type
  Promise

#### (async, static) getImageWidth() → {Promise}

返回图标宽度

Source:
  - Annotation.js, line 185

##### Returns:

图标宽度

Type
  Promise

#### (async, static) getPoint() → {Promise.<Dot>}

获取地图坐标点

Source:
  - Annotation.js, line 141

##### Returns:

地图坐标点

Type
  Promise.<Dot>

#### (async, static) getTitle() → {Promise}

获取标题

Source:
  - Annotation.js, line 87

##### Returns:

标题

Type
  Promise

#### (async, static) getUid() → {Promise}

获取唯一标识

Source:
  - Annotation.js, line 60

##### Returns:

唯一标识

Type
  Promise

#### (async, static) hideAnnotationView() → {Promise.<void>}

隐藏标记视图

Source:
  - Annotation.js, line 322

##### Returns:

Type
  Promise.<void>

#### (async, static) isAnnotationViewShown() → {Promise.<boolean>}

获取对应的标记视图是否正在显示的标志

Source:
  - Annotation.js, line 335

##### Returns:

对应的标记视图显示状态 值为true时正在显示 ,反之,不能显示

Type
  Promise.<boolean>

#### (async, static) isCanShowAnnotationView() → {Promise.<boolean>}

获取能否弹出标记视图的标志

Source:
  - Annotation.js, line 296

##### Returns:

标记视图弹出标志

Type
  Promise.<boolean>

#### (async, static) isPointByPixel() → {Promise.<boolean>}

获取点是否为像素单位

Source:
  - Annotation.js, line 269

##### Returns:

点是否为像素单位

Type
  Promise.<boolean>

#### (async, static) setCanShowAnnotationView(show) → {Promise.<void>}

设置能否弹出标记视图

##### Parameters:

Name | Type | Description
--- | --- | ---
`show` |  | 值为true时能弹出 ,反之,不能弹出

Source:
  - Annotation.js, line 283

##### Returns:

Type
  Promise.<void>

#### (async, static) setCenterOffset(offset) → {Promise.<void>}

设置标记点与图标底边中心的偏移 offset.x 取正值 图标相对于底边中心向右偏移 取负值 图标相对于底边中心向左偏移 offset.y 取正值 图标相对于底边中心向上移动 取负值 图标相对于底边中心向下移动

##### Parameters:

Name | Type | Description
--- | --- | ---
`offset` |  |

Source:
  - Annotation.js, line 226

##### Returns:

Type
  Promise.<void>

#### (async, static) setDescription(description) → {Promise.<void>}

设置描述

##### Parameters:

Name | Type | Description
--- | --- | ---
`description` |  | 描述

Source:
  - Annotation.js, line 101

##### Returns:

Type
  Promise.<void>

#### (async, static) setImage(bitmap) → {Promise.<void>}

设置标记图标

##### Parameters:

Name | Type | Description
--- | --- | ---
`bitmap` |  | 图标

Source:
  - Annotation.js, line 158

##### Returns:

Type
  Promise.<void>

#### (async, static) setImageByPath(filePath) → {Promise.<void>}

设置标记图标

##### Parameters:

Name | Type | Description
--- | --- | ---
`filePath` |  | 图标路径

Source:
  - Annotation.js, line 172

##### Returns:

Type
  Promise.<void>

#### (async, static) setPoint(point) → {Promise.<void>}

设置地图坐标点

##### Parameters:

Name | Type | Description
--- | --- | ---
`point` |  | 地图坐标点

Source:
  - Annotation.js, line 128

##### Returns:

Type
  Promise.<void>

#### (async, static) setPointByPixel(点是否为像素单位) → {Promise.<void>}

设置点是否为像素单位(默认情况下为地图单位)

##### Parameters:

Name | Type | Description
--- | --- | ---
`点是否为像素单位` |  |

Source:
  - Annotation.js, line 256

##### Returns:

Type
  Promise.<void>

#### (async, static) setTitle(title) → {Promise.<void>}

设置标题

##### Parameters:

Name | Type | Description
--- | --- | ---
`title` |  | 标题

Source:
  - Annotation.js, line 74

##### Returns:

Type
  Promise.<void>

#### (async, static) showAnnotationView() → {Promise.<void>}

显示标记视图

Source:
  - Annotation.js, line 309

##### Returns:

Type
  Promise.<void>