---
title: vjmap
source: https://vjmap.com/doc/full.html
---
---
pageClass: markdown-page
sidebar: auto
sidebarDepth: 0
search: false
---
### 目录
## Map
**扩展事件**
该`Map`对象代表您页面上的地图。它公开了使您能够以编程方式更改地图的方法和属性，并在用户与其交互时触发事件。
您可以`Map`通过指定 `container`和其他选项来创建。然后初始化页面上的地图并返回您的`Map` 对象。
### Parameters
- `options` **`Object`**
- `options.container` **( `HTMLElement`| `string`)** 将在其中呈现地图的 HTML 元素，或元素的 string `id`。指定的元素必须没有子元素。
- `options.minZoom` **`number`**地图的最小缩放级别 (0-24)。（可选，默认`0`）
- `options.maxZoom` **`number`**地图的最大缩放级别 (0-24)。（可选，默认`22`）
- `options.minPitch` **`number`**地图的最小倾斜角度 (0-85)。（可选，默认`0`）
- `options.maxPitch` **`number`**地图的最大倾斜角度（0-85）。（可选，默认`85`）
- `options.style` **( `Object`| `string`)？**地图的样式。
- `options.hash` **( `boolean`| `string`)**如果`true`，则地图的位置（缩放、中心纬度、中心经度、方位角和俯仰角）将与页面 URL 的哈希片段同步。例如，`http://path/to/my/page.html#2.59/39.26/53.07/-24.1/60`。可以选择提供附加字符串来指示参数样式的哈希，例如`http://path/to/my/page.html#map=2.59/39.26/53.07/-24.1/60&foo=bar `，其中 foo 是自定义参数， bar 是与地图哈希不同的任意哈希。（可选，默认`false`）
- `options.interactive` **`boolean`**如果`false`，则不会将鼠标、触摸或键盘侦听器附加到地图，因此它不会响应交互。（可选，默认`true`）
- `options.bearingSnap` **`number`**阈值（以度为单位），用于确定地图的方位何时向北对齐。例如，当 `bearingSnap`为 7 时，如果用户在北纬 7 度范围内旋转地图，地图将自动对齐到正北。（可选，默认`7`）
- `options.pitchWithRotate` **`boolean`**如果`false`，地图的俯仰（倾斜）控制与“拖动旋转”交互将被禁用。（可选，默认`true`）
- `options.clickTolerance` **`number`**用户可以在单击期间移动鼠标指针以将其视为有效单击（与鼠标拖动相反）的最大像素数。（可选，默认`3`）
- `options.attributionControl` **`boolean`**如果`true`，一个[AttributionControl][204]将被添加到地图中。（可选，默认`true`）
- `options.customAttribution` **( `string`| `Array`< `string`\>)？**在`AttributionControl 中`显示的一个或多个字符串。仅适用于采用`options.attributionControl`是`true`。
- `options.logoPosition` **`string`**一个字符串，表示文字标记在地图上的位置。有效选项为`top-left`、`top-right`、`bottom-left`、`bottom-right`。（可选，默认`'bottom-left'`）
- `options.failIfMajorPerformanceCaveat` **`boolean`**如果`true`，如果性能比预期的差很多（即使用软件渲染器），地图创建将失败。（可选，默认`false`）
- `options.preserveDrawingBuffer` **`boolean`**如果`true`，则可以使用 将地图的画布导出为 PNG `map.getCanvas().toDataURL()`。这是`false`默认的性能优化。（可选，默认`false`）
- `options.antialias` **`boolean`?** 如果`true`，将使用 MSAA 抗锯齿创建上下文，这对于抗锯齿自定义图层很有用。这是`false`默认的性能优化。
- `options.refreshExpiredTiles` **`boolean`**如果`false`，地图将不会尝试重新请求图块，一旦它们根据其 HTTP `cacheControl`/`expires`标头过期。（可选，默认`true`）
- `options.maxBounds` **[LngLatBoundsLike][299] ?** 如果设置，地图将被限制在给定的范围内。
- `options.scrollZoom` **( `boolean`| `Object`)**如果`true`，则启用“滚动缩放”交互。一个`Object`值作为选项传递给`ScrollZoomHandler#enable`。（可选，默认`true`）
- `options.boxZoom` **`boolean`**如果`true`，则启用“框缩放”交互（请参阅[BoxZoomHandler][178]）。（可选，默认`true`）
- `options.dragRotate` **`boolean`**如果`true`，则启用“拖动旋转”交互（请参阅[DragRotateHandler][192]）。（可选，默认`true`）
- `options.dragPan` **( `boolean`| `Object`)**如果`true`，则启用“拖动平移”交互。一个`Object`值作为选项传递给`DragPanHandler#enable`。（可选，默认`true`）
- `options.keyboard` **`boolean`**如果`true`，则启用键盘快捷键（请参阅[KeyboardHandler][184]）。（可选，默认`true`）
- `options.doubleClickZoom` **`boolean`**如果`true`，则启用“双击缩放”交互（请参阅[DoubleClickZoomHandler][190]）。（可选，默认`true`）
- `options.touchZoomRotate` **( `boolean`| `Object`)**如果`true`，则启用“捏合旋转和缩放”交互。一个`Object`值作为选项传递给`TouchZoomRotateHandler#enable`。（可选，默认`true`）
- `options.touchPitch` **( `boolean`| `Object`)**如果`true`，则启用“拖动到音调”交互。一个`Object`值作为选项传递给`TouchPitchHandler#enable`。（可选，默认`true`）
- `options.trackResize` **`boolean`**如果`true`，则当浏览器窗口调整大小时，地图将自动调整大小。（可选，默认`true`）
- `options.center` **[LngLatLike][284]**地图的初始地理中心点。如果`center`未在构造函数选项中指定， 将在地图的样式对象中查找它。如果样式中也没有指定，则默认为`[0, 0]`注意：地图使用经度、纬度坐标顺序（相对于纬度、经度）来匹配 GeoJSON。（可选，默认`[0,0]`）
- `options.zoom` **`number`**地图的初始缩放级别。如果`zoom`未在构造函数选项中指定，将在地图的样式对象中查找它。如果样式中也没有指定，则默认为`0`. （可选，默认`0`）
- `options.bearing` **`number`**地图的初始方位（旋转），以北为逆时针方向测量的度数。如果`bearing`未在构造函数选项中指定，将在地图的样式对象中查找它。如果样式中也没有指定，则默认为`0`. （可选，默认`0`）
- `options.pitch` **`number`**地图的初始倾斜度（倾斜度），以距屏幕平面 (0-85) 的度数为单位。如果`pitch`未在构造函数选项中指定，将在地图的样式对象中查找它。如果样式中也没有指定，则默认为`0`. （可选，默认`0`）
- `options.bounds` **[LngLatBoundsLike][299] ?** 地图的初始边界。如果`bounds`指定，它将覆盖`center`和`zoom`构造函数选项。
- `options.fitBoundsOptions` **`Object`?** 甲`地图＃fitBounds`选项对象使用_仅_拟合初始时`bounds`的上方。
- `options.optimizeForTerrain` **`boolean`**启用地形时，如果`true`，地图将呈现性能优先级，这可能会导致图层重新排序以最大化性能（将首先绘制覆盖在地形上的图层，包括填充、线条、背景、山体阴影和栅格）。否则，如果设置为`false`，地图将始终按图层顺序优先级绘制。（可选，默认`true`）
- `options.renderWorldCopies` **`boolean`**如果`true`，世界的多个副本将在超过 -180 度和 180 度经度的范围内并排呈现。如果设置为`false`：- 当地图缩小到足以使世界的单个表示无法填满地图的整个容器时，超过 180 度和 -180 度经度将出现空白。
- 在每个缩放级别，跨越 180 度和 -180 度经度的要素将被切成两部分（一部分位于地图的右边缘，另一部分位于地图的左边缘）。（可选，默认`true`）
- `options.maxTileCacheSize` **`number`**存储在给定源的切片缓存中的最大切片数。如果省略，缓存将根据当前视口动态调整大小。（可选，默认`null`）
- `options.localIdeographFontFamily` **`string`**定义一个 CSS 字体系列，用于在“CJK 统一表意文字”、“平假名”、“片假名”和“韩文音节”范围内本地覆盖生成字形。在这些范围内，地图样式的字体设置将被忽略，除了字体粗细关键字（light/regular/medium/bold）。设置为`false`, 以针对这些字形范围启用地图样式的字体设置。此选项的目的是避免带宽密集型字形服务器请求。（请参阅`使用本地生成的表意文字 `.)（可选，默认`'sans-serif'`）
- `options.localFontFamily` **`string`**定义一个 CSS 字体系列，用于本地覆盖所有字形的生成。除了字体粗细关键字（light/regular/medium/bold）之外，地图样式中的字体设置将被忽略。如果设置，此选项将覆盖 localIdeographFontFamily 中的设置（可选，默认`false`）
- `options.transformRequest` **RequestTransformFunction**在 Map 请求外部 URL 之前运行的回调。回调可用于修改 url、设置标头或设置跨域请求的凭据属性。预计返回`requestParameters的`对象与`url`属性和可选`headers`和`credentials`性能。（可选，默认`null`）
- `options.collectResourceTiming` **`boolean`**如果`true`，将为 GeoJSON 和 Vector Tile Web Worker 发出的请求收集资源计时 API 信息（此信息通常无法从主 Javascript 线程访问）。信息将在`resourceTiming`相关`data`事件的属性中返回。（可选，默认`false`）
- `options.fadeDuration` **`number`**控制标签碰撞的淡入/淡出动画的持续时间，以毫秒为单位。此设置会影响所有符号图层。此设置不会影响运行时样式转换或光栅图块淡入淡出的持续时间。（可选，默认`300`）
- `options.crossSourceCollisions` **`boolean`**如果`true`，来自多个源的符号可以在碰撞检测期间相互碰撞。如果`false`，则对每个源中的符号单独运行碰撞检测。（可选，默认`true`）
- `options.locale` **`Object`**应用于 UI 字符串的默认本地化表的补丁，例如控件工具提示。该`locale`对象将命名空间的 UI 字符串 ID 映射到目标语言的翻译字符串；`src/ui/default_locale.js`有关所有支持的字符串 ID 的示例，请参见。该对象可以指定所有 UI 字符串（从而添加对新翻译的支持）或仅字符串的子集（从而修补默认翻译表）。（可选，默认`null`）
- `options.testMode` **`boolean`**静默由于无效的访问令牌而生成的错误和警告，这在使用库编写单元测试时很有用。（可选，默认`false`）
### Examples
```
var map = new vjmap.Map({
container: 'map', // container ID
center: [-122.420679, 37.772537], // starting position [lng, lat]
zoom: 13, // starting zoom
style: 'your style', // style URL or style object
hash: true, // sync `center`, `zoom`, `pitch`, and `bearing` with URL
// Use `transformRequest` to modify requests that begin with `http://myHost`.
transformRequest: (url, resourceType)=> {
if(resourceType === 'Source' && url.startsWith('http://myHost')) {
return {
url: url.replace('http', 'https'),
headers: { 'my-custom-header': true},
credentials: 'include' // Include cookies for cross-origin requests
}
}
}
});
```
### scrollZoom
地图的[ScrollZoomHandler][187]，它使用滚轮或触控板实现放大和缩小。`scrollZoom`在[ScrollZoomHandler][187]部分中查找更多详细信息和示例。
类型：[ScrollZoomHandler][187]
### boxZoom
地图的[BoxZoomHandler][178]，它使用按住 Shift 键的拖动手势实现缩放。`boxZoom`在[BoxZoomHandler][178]部分中查找更多详细信息和示例。
类型：[BoxZoomHandler][178]
### dragRotate
地图的[DragRotateHandler][192]，它实现了在使用鼠标右键或按下 Control 键拖动时旋转地图。`dragRotate` 在[DragRotateHandler][192]部分中查找更多详细信息和示例。
类型：[DragRotateHandler][192]
### dragPan
地图的[DragPanHandler][191]，它实现了使用鼠标或触摸手势拖动地图。`dragPan`在[DragPanHandler][191]部分中查找更多详细信息和示例。
类型：[DragPanHandler][191]
### keyboard
地图的[KeyboardHandler][184]，它允许用户使用键盘快捷键缩放、旋转和平移地图。`keyboard`在[KeyboardHandler][184]部分中查找更多详细信息和示例。
类型：[KeyboardHandler][184]
### doubleClickZoom
地图的[DoubleClickZoomHandler][190]，允许用户通过双击进行缩放。`doubleClickZoom`在[DoubleClickZoomHandler][190]部分中查找更多详细信息和示例。
类型：[DoubleClickZoomHandler][190]
### touchZoomRotate
地图的[TouchZoomRotateHandler][193]，它允许用户使用触摸手势缩放或旋转地图。`touchZoomRotate`在[TouchZoomRotateHandler][193]部分中查找更多详细信息和示例。
类型：[TouchZoomRotateHandler][193]
### touchPitch
地图的[TouchPitchHandler][183]，它允许用户通过触摸手势来调整地图。`touchPitch`在[TouchPitchHandler][183]部分中查找更多详细信息和示例。
类型：[TouchPitchHandler][183]
### addControl
将[IControl][161]添加到地图，调用`control.onAdd(this)`.
#### Parameters
- `control` **[ICONTROL][161]**的[ICONTROL][161]补充。
- `position` **`string`?** 控件将添加到的地图上的位置。有效值是`'top-left'`，`'top-right'`，`'bottom-left'`，和`'bottom-right'`。默认为`'top-right'`.
#### Examples
```
// Add zoom and rotation controls to the map.
map.addControl(new vjmap.NavigationControl());
```
返回**`地图`** `this`
### removeControl
从地图中删除控件。
#### Parameters
- `control` **[ICONTROL][161]**的[ICONTROL][161]删除。
#### Examples
```
// Define a new navigation control.
var navigation = new vjmap.NavigationControl();
// Add zoom and rotation controls to the map.
map.addControl(navigation);
// Remove zoom and rotation controls from the map.
map.removeControl(navigation);
```
返回**`地图`** `this`
### hasControl
检查控件是否在地图上。
#### Parameters
- `control` **[ICONTROL][161]**的[ICONTROL][161]检查。
#### Examples
```
// Define a new navigation control.
var navigation = new vjmap.NavigationControl();
// Add zoom and rotation controls to the map.
map.addControl(navigation);
// Check that the navigation control exists on the map.
const added = map.hasControl(navigation);
// added === true
```
**`boolean`**如果地图包含控件，则返回True。
### resize
根据其`container`元素的尺寸调整地图的大小 。
检查地图容器大小是否改变，如果改变则更新地图。必须在以`container`编程方式调整地图大小后或在最初使用 CSS 隐藏地图后显示地图时调用此方法。
#### Parameters
- `eventData` **`Object`?** 要传递给`movestart`、`move`、`resize`和`moveend` 因调整大小而触发的事件的其他属性。这对于区分事件源（例如，用户启动或以编程方式触发的事件）非常有用。
#### Examples
```
// Resize the map when the map container is shown
// after being initially hidden with CSS.
var mapDiv = document.getElementById('map');
if (mapDiv.style.visibility === true) map.resize();
```
返回**`地图`** `this`
### getBounds
返回地图的地理边界。当方位角或螺距不为零时，可见区域不是轴对齐的矩形，结果是包含可见区域的最小边界。如果在地图上设置了填充，则返回的边界适用于插图。
#### Examples
```
var bounds = map.getBounds();
```
返回**[LngLatBounds][285]**地图的地理边界作为[LngLatBounds][285]。
### getMaxBounds
返回地图被限制到的最大地理边界，或者`null`如果没有设置。
#### Examples
```
var maxBounds = map.getMaxBounds();
```
返回**( [LngLatBounds][285] | null)**地图对象。
### setMaxBounds
设置或清除地图的地理边界。
平移和缩放操作被限制在这些范围内。如果执行平移或缩放会显示这些边界之外的区域，则地图将改为显示尽可能接近操作请求的位置和缩放级别，同时仍保持在边界内。
#### Parameters
- `bounds` **( [LngLatBoundsLike][299] | null | `undefined`)**要设置的最大边界。如果提供`null`或`undefined`，该函数将删除地图的最大边界。
#### Examples
```
// Define bounds that conform to the `LngLatBoundsLike` object.
var bounds = [
[-74.04728, 40.68392], // [west, south]
[-73.91058, 40.87764] // [east, north]
];
// Set the map's max bounds.
map.setMaxBounds(bounds);
```
返回**`地图`** `this`
### setMinZoom
设置或清除地图的最小缩放级别。如果地图的当前缩放级别低于新的最小值，则地图将缩放到新的最小值。
并非总是可以缩小并到达集合`minZoom`。其他因素（例如地图高度）可能会限制缩放。例如，如果地图的高度为 512 像素，则无论`minZoom`设置为什么，都无法在缩放 0 以下进行缩放。
#### Parameters
- `minZoom` **( `number`| null | `undefined`)**要设置的最小缩放级别 (-2 - 24)。如果提供`null`或`undefined`，该函数将删除当前的最小缩放（即将其设置为 -2）。
#### Examples
```
map.setMinZoom(12.25);
```
返回**`地图`** `this`
### getMinZoom
返回地图的最小允许缩放级别。
#### Examples
```
var minZoom = map.getMinZoom();
```
返回**`number`**minZoom
### setMaxZoom
设置或清除地图的最大缩放级别。如果地图的当前缩放级别高于新的最大值，则地图将缩放到新的最大值。
#### Parameters
- `maxZoom` **( `number`| null | `undefined`)**要设置的最大缩放级别。如果提供`null`或`undefined`，该函数将删除当前最大缩放（将其设置为 22）。
#### Examples
```
map.setMaxZoom(18.75);
```
返回**`地图`** `this`
### getMaxZoom
返回地图的最大允许缩放级别。
#### Examples
```
var maxZoom = map.getMaxZoom();
```
返回**`number`**最大缩放
### setMinPitch
设置或清除地图的最小间距。如果地图的当前俯仰低于新的最小值，则地图将俯仰到新的最小值。
#### Parameters
- `minPitch` **( `number`| null | `undefined`)**要设置的最小间距 (0-85)。如果提供`null`或`undefined`，则该函数会删除当前的最小音高（即，将其设置为 0）。
返回**`地图`** `this`
### getMinPitch
返回地图的最小允许间距。
返回**`number`**minPitch
### setMaxPitch
设置或清除地图的最大间距。如果地图的当前俯仰高于新的最大值，则地图将俯仰到新的最大值。
#### Parameters
- `maxPitch` **( `number`| null | `undefined`)**要设置的最大间距。如果提供`null`或`undefined`，则该函数会删除当前的最大音高（将其设置为 85）。
返回**`地图`** `this`
### getMaxPitch
返回地图的最大允许间距。
返回**`number`**最大间距
### getRenderWorldCopies
返回 的状态`renderWorldCopies`。如果`true`，世界的多个副本将在超过 -180 度和 180 度经度的范围内并排呈现。如果设置为`false`：
- 当地图缩小到足以让世界的单一表示无法填满地图的整个容器时，超过 180 度和 -180 度经度将出现空白。
- 在每个缩放级别，跨越 180 度和 -180 度经度的要素将被切成两部分（一部分位于地图的右边缘，另一部分位于地图的左边缘）。
#### Examples
```
var worldCopiesRendered = map.getRenderWorldCopies();
```
返回**`boolean`**renderWorldCopies
### setRenderWorldCopies
设置 的状态`renderWorldCopies`。
#### Parameters
- `renderWorldCopies` **`boolean`**如果`true`，世界的多个副本将在超过 -180 度和 180 度经度的范围内并排呈现。如果设置为`false`：- 当地图缩小到足以使世界的单个表示无法填满地图的整个容器时，超过 180 度和 -180 度经度将出现空白。
- 在每个缩放级别，跨越 180 度和 -180 度经度的要素将被切成两部分（一部分位于地图的右边缘，另一部分位于地图的左边缘）。`undefined`被视为`true`，`null`被视为`false`。
#### Examples
```
map.setRenderWorldCopies(true);
```
返回**`地图`** `this`
### project
返回一个[Point][165]表示像素坐标，相对于地图的`container`，对应于指定的地理位置。
当地图倾斜并`lnglat`完全在相机后面时，没有对应于该位置的像素坐标。在这种情况下，返回的`Point][165]的`x`和`y`组件设置为 Number.MAX\_VALUE。[`
#### Parameters
- `lnglat` **`LngLatLike 要投影`**的地理位置。
#### Examples
```
var coordinate = [-122.420679, 37.772537];
var point = map.project(coordinate);
```
返回**[Point][165]**对应于的`点``lnglat`，相对于地图的`container`。
### unproject
返回表示与指定像素坐标对应的地理坐标的[LngLat][230]。如果地平线可见，并且指定像素高于地平线，则返回与地平线上的点相对应的[LngLat][230]，距离该点最近。
#### Parameters
- `point` **`PointLike 要取消投影`**的像素坐标。
#### Examples
```
map.on('click', function(e) {
// When the map is clicked, get the geographic coordinate.
var coordinate = map.unproject(e.point);
});
```
返回**[LngLat][230]**对应的[LngLat][230]`point`。
### isMoving
如果地图由于相机动画或用户手势而平移、缩放、旋转或俯仰，则返回 true。
#### Examples
```
var isMoving = map.isMoving();
```
**`boolean`**如果地图正在移动，则返回True。
### isZooming
如果地图由于相机动画或用户手势而缩放，则返回 true。
#### Examples
```
var isZooming = map.isZooming();
```
**`boolean`**如果地图正在缩放，则返回True。
### isRotating
如果地图由于相机动画或用户手势而旋转，则返回 true。
#### Examples
```
map.isRotating();
```
**`boolean`**如果地图正在旋转，则返回True。
### on
为指定类型的事件添加侦听器，可选择限制为指定样式层中的功能。
#### Parameters
- `type` **`string`**要侦听的事件类型。`layerId`当光标从该图层外部或地图画布外部进入指定图层的可见部分时，将触发与可选参数兼容的事件。
#### Parameters
- `type` **`string`**要侦听的事件类型。`layerId`当光标从该图层外部或地图画布外部进入指定图层的可见部分时，将触发与可选参数兼容的事件。
|事件 | 兼容`layerId`|
|-|-|-
|``mousedown`` | 是 |
| ``mouseup`` | 是 |
| ``mouseover`` | 是 |
| ``mouseout`` | 是 |
| ``mousemove`` | 是 |
| ``mouseenter`` | 是（必填） |
| ``mouseleave`` | 是（必填） |
| ``click`` | 是 |
| ``dblclick`` | 是 |
| ``contextmenu`` | 是 |
| ``contextMenuPreOpen`` | 是 |
| ``contextMenuOpened`` | 是 |
| ``contextMenuNoContent`` | 是 |
| ``contextMenuCancel`` | 是 |
| ``touchstart`` | 是 |
| ``touchend`` | 是 |
| ``touchcancel`` | 是 |
| ``wheel`` |
| ``resize`` |
| ``remove`` |
| ``touchmove`` |
| ``movestart`` |
| ``move`` |
| ``moveend`` |
| ``dragstart`` |
| ``drag`` |
| ``dragend`` |
| ``zoomstart`` |
| ``zoom`` |
| ``zoomend`` |
| ``rotatestart`` |
| ``rotate`` |
| ``rotateend`` |
| ``pitchstart`` |
| ``pitch`` |
| ``pitchend`` |
| ``boxzoomstart`` |
| ``boxzoomend`` |
| ``boxzoomcancel`` |
| ``webglcontextlost`` |
| ``webglcontextrestored``|
| ``load`` |
| ``render`` |
| ``idle`` |
| ``error`` |
| ``data`` |
| ``styledata`` |
| ``sourcedata`` |
| ``dataloading`` |
| ``styledataloading`` |
| ``sourcedataloading`` |
| ``styleimagemissing`` |
- `layerId` **`string`**（可选）样式层的 ID。如果您提供`layerId`，则仅当侦听器的位置位于该图层中的可见要素内时才会触发侦听器，并且该事件将具有`features`包含匹配要素数组的属性。如果您不提供`layerId`，则侦听器将由地图上任何位置发生的相应事件触发，并且该事件将没有`features`属性。请注意，许多事件类型与可选`layerId`参数不兼容。
- `listener` **Function**触发事件时要调用的函数。
#### Examples
```
// Set an event listener that will fire
// when the map has finished loading.
map.on('load', function() {
// Add a new layer.
map.addLayer({
id: 'points-of-interest',
source: {
type: 'vector',
url: 'your url'
},
'source-layer': 'poi_label',
type: 'circle',
paint: {
// Style Specification paint properties
},
layout: {
// Style Specification layout properties
}
});
});
```
```
// Set an event listener that will fire
// when a feature on the countries layer of the map is clicked.
map.on('click', 'countries', function(e) {
new vjmap.Popup()
.setLngLat(e.lngLat)
.setHTML(`Country name: ${e.features[0].properties.name}`)
.addTo(map);
});
```
返回**`地图`** `this`
### once
添加一个仅对指定事件类型调用一次的侦听器，可选择仅限于在指定样式图层中的要素上发生的事件。
#### Parameters
- `type` **`string`**要侦听的事件类型；之一`'mousedown'`，`'mouseup'`，`'click'`，`'dblclick'`， `'mousemove'`，`'mouseenter'`，`'mouseleave'`，`'mouseover'`，`'mouseout'`，`'contextmenu'`，`'touchstart'`， `'touchend'`，或`'touchcancel'`。`mouseenter`和`mouseover`当光标从外部进入指定的层的可见部分事件被触发该层或地图帆布外。`mouseleave` 和`mouseout`事件被触发时光标离开指定的层，或叶地图画布的可见部分。
- `layerId` **`string`**（可选）样式层的 ID。如果您提供`layerId`，则仅当侦听器的位置位于该图层中的可见要素内时才会触发侦听器，并且该事件将具有`features`包含匹配要素数组的属性。如果您不提供`layerId`，则侦听器将由地图上任何位置发生的相应事件触发，并且该事件将没有`features`属性。请注意，许多事件类型与可选`layerId`参数不兼容。
- `listener` **Function**触发事件时要调用的函数。
#### Examples
```
// Log the coordinates of a user's first map touch.
map.once('touchstart', function (e) {
console.log('The first map touch was at: ' + e.lnglat)
});
```
```
// Log the coordinates of a user's first map touch
// on a specific layer.
map.once('touchstart', 'my-point-layer', function (e) {
console.log('The first map touch on the point layer was at: ' + e.lnglat)
});
```
返回**`地图`** `this`
### off
删除先前使用`Map#on`添加的事件侦听器，可选择限制为特定于图层的事件。
#### Parameters
- `type` **`string`** 以前用于安装侦听器的事件类型。
- `layerId` **`string`** （可选）先前用于安装侦听器的层 ID。
- `listener` **功能**以前安装的监听功能。
#### Examples
```
// Create a function to print coordinates while a mouse is moving.
function onMove(e) {
console.log('The mouse is moving: ' + e.lngLat)
}
// Create a function to unbind the `mousemove` event.
function onUp(e) {
console.log('The final coordinates are: ' + e.lngLat)
map.off('mousemove', onMove);
}
// When a click occurs, bind both functions to mouse events.
map.on('mousedown', function (e) {
map.on('mousemove', onMove);
map.once('mouseup', onUp);
});
```
返回**`地图`** `this`
### queryRenderedFeatures
返回一个`GeoJSON`数组 `` `特征对象` 表示满足查询参数的可见特征。
#### Parameters
- `geometry` **( [PointLike][166] | `Array`< [PointLike][166] >)？**以像素为单位的查询区域的几何形状：描述边界框的单个点或左下角和右上角的点，其中原点位于左上角。省略此参数（即使用零参数或仅使用参数调用`Map#queryRenderedFeatures``options`）等效于传递包含整个地图视口的边界框。仅支持现有视口内的值。
- `options` **`Object`?** 选项对象。
- `options.layers` **`Array`< `string`\>？**一组`样式层 ID `用于要检查的查询。仅返回这些图层内的要素。如果未定义此参数，则将检查所有图层。
- `options.filter` **`Array`?** 一个`过滤器` 限制查询结果。
- `options.validate` **`boolean`**是否检查 \[options.filter\] 是否符合样式规范。禁用验证是一种性能优化，只有在您之前验证过将传递给此函数的值时才应使用。（可选，默认`true`）
#### Examples
```
// Find all features at a point
var features = map.queryRenderedFeatures(
[20, 35],
{ layers: ['my-layer-name'] }
);
```
```
// Find all features within a static bounding box
var features = map.queryRenderedFeatures(
[[10, 20], [30, 50]],
{ layers: ['my-layer-name'] }
);
```
```
// Find all features within a bounding box around a point
var width = 10;
var height = 20;
var features = map.queryRenderedFeatures([
[point.x - width / 2, point.y - height / 2],
[point.x + width / 2, point.y + height / 2]
], { layers: ['my-layer-name'] });
```
```
// Query all rendered features from a single layer
var features = map.queryRenderedFeatures({ layers: ['my-layer-name'] });
```
返回**`Array`< `Object`\>** `GeoJSON`数组 `` `特征对象 `.`properties`每个返回的特征对象的值都包含其源特征的属性。对于以GeoJSON源，只有字符串和数值属性的值被支持（即`null`，`Array`和`Object`值不支持）。每个特征包括顶层`layer`，`source`和`sourceLayer`特性。该`layer`属性是一个对象，表示该要素所属的样式图层。此对象中的布局和绘制属性包含针对给定缩放级别和特征进行全面评估的值。仅包括当前呈现的特征。某些功能将**不**包括在内，例如：-`visibility`属性为 的图层中的功能`"none"`。
- 来自缩放范围不包括当前缩放级别的图层的要素。
- 由于文本或图标碰撞而被隐藏的符号特征。包括所有其他层的特征，包括可能对渲染结果没有可见贡献的特征；例如，因为图层的不透明度或颜色 alpha 分量设置为 0。最上面渲染的特征首先出现在返回的数组中，后续特征按 z-order 降序排序。多次渲染的要素（由于在低缩放级别下环绕反子午线）仅返回一次（但需遵守以下注意事项）。因为要素来自切片矢量数据或在内部转换为切片的 GeoJSON 数据，所以要素几何可能会跨切片边界拆分或复制，因此，要素可能会在查询结果中出现多次。例如，假设有一条高速公路穿过查询的边界矩形。查询的结果将是位于覆盖边界矩形的地图图块内的高速公路部分，即使高速公路延伸到其他图块中，并且每个地图图块内的高速公路部分将作为单独的要素返回。类似地，由于瓦片缓冲，瓦片边界附近的点要素可能出现在多个瓦片中。
### querySourceFeatures
返回一个`GeoJSON`数组 `` `特征对象` 表示满足查询参数的指定矢量切片或 GeoJSON 源中的要素。
#### Parameters
- `sourceId` **`string`** 要查询的矢量切片或 GeoJSON 源的 ID。
- `parameters` **`Object`?** 选项对象。
- `parameters.sourceLayer` **`string`?** `源层`的名称 `` 查询。_对于矢量切片源，此参数是必需的。_对于 GeoJSON 源，它被忽略。
- `parameters.filter` **`Array`?** 一个`过滤器` 限制查询结果。
- `parameters.validate` **`boolean`**是否检查 \[parameters.filter\] 是否符合样式规范。禁用验证是一种性能优化，只有在您之前验证过将传递给此函数的值时才应使用。（可选，默认`true`）
#### Examples
```
// Find all features in one source layer in a vector source
var features = map.querySourceFeatures('your-source-id', {
sourceLayer: 'your-source-layer'
});
```
返回**`Array`< `Object`\>** `GeoJSON](http://geojson.org/)数组 `` `特征对象 `. 与[Map#queryRenderedFeatures 相比`，该函数返回所有匹配查询参数的特征，无论它们是否被当前样式渲染（即可见）。查询的域包括所有当前加载的矢量切片和 GeoJSON 源切片：该函数不检查当前可见视口之外的切片。因为特征来自切片矢量数据或内部转换为切片的 GeoJSON 数据，特征几何可能跨切片边界拆分或复制，因此，要素可能会在查询结果中出现多次。例如，假设有一条高速公路穿过查询的边界矩形。查询的结果将是位于覆盖边界矩形的地图图块内的高速公路部分，即使高速公路延伸到其他图块中，每个地图图块内的高速公路部分将作为单独的要素返回。类似地，由于瓦片缓冲，瓦片边界附近的点要素可能出现在多个瓦片中。
### setStyle
使用新值更新地图的 样式对象。
如果在使用时已经设置了样式并且 options.diff 设置为 true，则地图渲染器将尝试将给定样式与地图的当前状态进行比较，并仅执行使地图样式与所需状态匹配所需的更改。精灵（用于图标和图案的图像）和字形（标签文本的字体）的变化**无法**区分。如果当前样式中使用的精灵或字体与给定样式有任何不同，地图渲染器将强制进行完整更新，删除当前样式并从头开始构建给定样式。
#### Parameters
- `style` **(StyleSpecification | `string`| null)**符合`样式规范中`描述的架构的 JSON 对象 ``，或此类 JSON 的 URL。
- `options` **`Object`?** 选项对象。
- `options.diff` **`boolean`**如果为 false，则强制进行“完整”更新，删除当前样式并构建给定样式，而不是尝试基于差异的更新。（可选，默认`true`）
- `options.localIdeographFontFamily` **`string`**定义一个 CSS 字体系列，用于在“CJK 统一表意文字”、“平假名”、“片假名”和“韩文音节”范围内本地覆盖生成字形。在这些范围内，地图样式的字体设置将被忽略，除了字体粗细关键字（light/regular/medium/bold）。设置为`false`, 以针对这些字形范围启用地图样式的字体设置。强制完整更新。（可选，默认`'sans-serif'`）
#### Examples
```
map.setStyle("your style");
```
返回**`地图`** `this`
### getStyle
返回地图的 `样式` 对象，一个 JSON 对象，可用于重新创建地图的样式。
#### Examples
```
map.on('load', function() {
var styleJson = map.getStyle();
});
```
返回**`Object`**地图的样式 JSON 对象。
### isStyleLoaded
返回一个布尔值，指示地图的样式是否已完全加载。
#### Examples
```
var styleLoadStatus = map.isStyleLoaded();
```
返回**`boolean`**一个布尔值，指示样式是否已完全加载。
### addSource
将源添加到地图的样式。
#### Parameters
- `id` **`string`**要添加的源的 ID。不得与现有来源发生冲突。
- `source` **`Object`**源对象。
#### Examples
```
map.addSource('my-data', {
type: 'vector',
url: 'your url'
});
```
```
map.addSource('my-data', {
"type": "geojson",
"data": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [-77.0323, 38.9131]
},
"properties": {
"title": "DC",
"marker-symbol": "monument"
}
}
});
```
返回**`地图`** `this`
### isSourceLoaded
返回一个布尔值，指示源是否已加载。返回`true`如果在地图的风格给定ID的源没有未完成的的网络请求，否则`false`。
#### Parameters
- `id` **`string`** 要检查的源的 ID。
#### Examples
```
var sourceLoaded = map.isSourceLoaded('bathymetry-data');
```
返回**`boolean`**一个布尔值，指示源是否已加载。
### areTilesLoaded
返回一个布尔值，指示是否加载了来自样式上所有源的视口中的所有图块。
#### Examples
```
var tilesLoaded = map.areTilesLoaded();
```
返回**`boolean`**一个布尔值，指示是否已加载所有图块。
### removeSource
从地图的样式中删除源。
#### Parameters
- `id` **`string`** 要删除的源的 ID。
#### Examples
```
map.removeSource('bathymetry-data');
```
返回**`地图`** `this`
### getSource
返回具有地图样式中指定 ID 的源。
此方法通常用于使用`Sources 中`定义的相关源类型的实例成员更新`源`。例如，`data`为 GeoJSON 源设置或更新 图像源的`url`和`coordinates`。
#### Parameters
- `id` **`string`** 要获取的源的 ID。
#### Examples
```
var sourceObject = map.getSource('points');
```
返回**`Object`?** 具有指定 ID 的样式源，或者`undefined`如果 ID 不对应于现有源。对象的形状因源类型而异。样式规范的`源中`提供了每种源类型的选项列表 `` 页。
### addImage
向样式添加图像。此图像可以像样式``[精灵]`` 使用图像的 ID ``icon-image` `, ``background-pattern` `, ``fill-pattern` `， 或者 ``line-pattern` `. 一个`Map.event`：错误如果没有在精灵足够的空间来添加此图像事件将被解雇。
#### Parameters
- `id` **`string`** 图像的 ID。
- `image` **`HTMLImageElement`| 图像位图 | 图像数据 | {width: `number`, height: `number`, data: ( `Uint8Array `| `Uint8ClampedArray `)} | [StyleImageInterface` )**图像作为`HTMLImageElement`、`ImageData`、`ImageBitmap`或具有、 和 属性的对象`width`，其格式与.`height``data``ImageData`
- `options` **$Shape<StyleImageMetadata>**选项对象。（可选，默认`{}`）
- `options.pixelRatio` 图像中的像素与屏幕上的物理像素的比率（可选，默认`1`）
- `options.sdf` 图像是否应被解释为 SDF 图像（可选，默认`false`）
- `options.stretchX` `[[x1, x2], ...]`如果`icon-text-fit`在具有此图像的图层中使用，则此选项定义可以水平拉伸的图像部分。
- `options.stretchY` `[[y1, y2], ...]`如果`icon-text-fit`在带有此图像的图层中使用，则此选项定义可以垂直拉伸的图像部分。
- `options.content` `[x1, y1, x2, y2]` 如果`icon-text-fit`在带有此图像的图层中使用，则此选项定义图像中可以被 中的内容覆盖的部分`text-field`。
#### Examples
```
// If the style's sprite does not already contain an image with ID 'cat',
// add the image 'cat-icon.png' to the style's sprite with the ID 'cat'.
map.loadImage('https://xxx.png', function(error, image) {
if (error) throw error;
if (!map.hasImage('cat')) map.addImage('cat', image);
});
// Add a stretchable image that can be used with `icon-text-fit`
// In this example, the image is 600px wide by 400px high.
map.loadImage('https:/xxx.png', function(error, image) {
if (error) throw error;
if (!map.hasImage('border-image')) {
map.addImage('border-image', image, {
content: [16, 16, 300, 384], // place text over left half of image, avoiding the 16px border
stretchX: [[16, 584]], // stretch everything horizontally except the 16px border
stretchY: [[16, 384]], // stretch everything vertically except the 16px border
});
}
});
```
### updateImage
更新样式中的现有图像。此图像可以像样式`精灵`中的任何其他图标一样显示在地图上 `` 使用图像的 ID ``icon-image` `, ``background-pattern` `, ``fill-pattern` `， 或者 ``line-pattern` `.
#### Parameters
- `id` **`string`** 图像的 ID。
- `image` **`HTMLImageElement`| 图像位图 | 图像数据 | {width: `number`, height: `number`, data: ( `Uint8Array `| `Uint8ClampedArray `)} | [StyleImageInterface` )**图像作为`HTMLImageElement`、`ImageData`、`ImageBitmap`或具有、 和 属性的对象`width`，其格式与.`height``data``ImageData`
#### Examples
```
// If an image with the ID 'cat' already exists in the style's sprite,
// replace that image with a new image, 'other-cat-icon.png'.
if (map.hasImage('cat')) map.updateImage('cat', './other-cat-icon.png');
```
### hasImage
检查样式中是否存在具有特定 ID 的图像。
#### Parameters
- `id` **`string`** 图像的 ID。
#### Examples
```
// Check if an image with the ID 'cat' exists in
// the style's sprite.
var catIconExists = map.hasImage('cat');
```
返回**`boolean`**一个布尔值，指示图像是否存在。
### removeImage
从样式中删除图像。
#### Parameters
- `id` **`string`** 图像的 ID。
#### Examples
```
// If an image with the ID 'cat' exists in
// the style's sprite, remove it.
if (map.hasImage('cat')) map.removeImage('cat');
```
### loadImage
从外部 URL 加载图像以与`Map#addImage`一起使用。外部域必须支持`CORS `.
#### Parameters
- `url` **`string`**图像文件的 URL。图像文件必须为 png、webp 或 jpg 格式。
- `callback` **功能**期待`callback(error, data)`。在图像加载时调用或在出现错误时使用错误参数调用。
#### Examples
```
// Load an image from an external URL.
map.loadImage('http://xxx', function(error, image) {
if (error) throw error;
// Add the loaded image to the style's sprite with the ID 'kitten'.
map.addImage('kitten', image);
});
```
### listImages
返回一个字符串数组，其中包含地图中当前可用的所有图像的 ID。
#### Examples
```
var allImages = map.listImages();
```
返回**`Array`< `string`\>**包含地图中当前可用的所有精灵/图像名称的字符串数组。
### addLayer
添加`样式图层`到地图的样式。
层定义了来自指定源的数据的样式。在`样式规范中`阅读有关图层类型和可用绘制和布局属性的`更多信息 `.
#### Parameters
- `layer` **( `Object`| `CustomLayerInterface][276] )**要添加的图层，符合 样式规范的`图层定义 `或者，不太常见的是[CustomLayerInterface`规范。样式规范的图层定义适用于大多数图层。
- `layer.id` **`string`** 您定义的唯一标识符。
- `layer.type` **`string`**层的类型（例如`fill`或`symbol`）。`样式规范中`提供了图层类型列表 ``.（这也可以是`custom`。有关更多信息，请参阅[CustomLayerInterface`。）
- `layer.source` **( `string`| `Object`)？** 图层的数据源。引用已使用源的唯一 id_定义_的源。使用源对象引用_新源_（如`样式规范中`所定义） ``） 直接地。这是**需要**所有`layer.type`的选项_，除了_为`custom`和`background`。
- `layer.sourceLayer` **`string`?** （可选）`源层`的名称 ``在指定`layer.source`用于此样式层的范围内。这是仅适用于矢量瓦片源并且**需要**时`layer.source`是该类型`vector`。
- `layer.filter` **`大批 `?** （可选）指定源要素条件的表达式。仅显示与过滤器匹配的特征。样式规范包含有关限制的更多信息``filter` `参数和可用`表达式`的完整列表 ``. 如果未提供过滤器，则将显示源（或矢量切片集的源层）中的所有要素。
- `layer.paint` **`Object`?** （可选）图层的绘制属性。可用的油漆特性因`layer.type`. `样式规范中`提供了每种图层类型的绘制属性的完整列表 ``. 如果未指定绘制属性，则将使用默认值。
- `layer.layout` **`Object`?** （可选）图层的布局属性。可用的布局属性因 而异`layer.type`。`样式规范中`提供了每个图层类型的布局属性的完整列表 ``. 如果未指定布局属性，则将使用默认值。
- `layer.maxzoom` **`number`?** （可选）图层的最大缩放级别。在缩放级别等于或大于 maxzoom 时，图层将被隐藏。该值可以是`0`和`24`（包括）之间的任何数字。如果未提供 maxzoom，则图层将在有可用图块的所有缩放级别上可见。
- `layer.minzoom` **`number`?** （可选）图层的最小缩放级别。当缩放级别小于 minzoom 时，图层将被隐藏。该值可以是`0`和`24`（包括）之间的任何数字。如果未提供 minzoom，则图层将在有可用图块的所有缩放级别上可见。
- `layer.metadata` **`Object`?** （可选）用于跟踪图层的任意属性，但不影响渲染。
- `layer.renderingMode` **`string`?** 这仅适用于类型为 的图层`custom`。有关更多信息，请参阅[CustomLayerInterface][276]。
- `beforeId` **`string`?** 在现有图层之前插入新图层的现有图层的 ID，从而使新图层在视觉上出现在现有图层下方。如果未指定此参数，则图层将附加到图层数组的末尾，并在视觉上显示在所有其他图层之上。
#### Examples
```
// Add a circle layer with a vector source
map.addLayer({
id: 'points-of-interest',
source: {
type: 'vector',
url: 'your url'
},
'source-layer': 'poi_label',
type: 'circle',
paint: {
// Style Specification paint properties
},
layout: {
// Style Specification layout properties
}
});
```
```
// Define a source before using it to create a new layer
map.addSource('state-data', {
type: 'geojson',
data: 'path/to/data.geojson'
});
map.addLayer({
id: 'states',
// References the GeoJSON source defined above
// and does not require a `source-layer`
source: 'state-data',
type: 'symbol',
layout: {
// Set the label content to the
// feature's `name` property
text-field: ['get', 'name']
}
});
```
```
// Add a new symbol layer before an existing layer
map.addLayer({
id: 'states',
// References a source that's already been defined
source: 'state-data',
type: 'symbol',
layout: {
// Set the label content to the
// feature's `name` property
text-field: ['get', 'name']
}
// Add the layer before the existing `cities` layer
}, 'cities');
```
返回**`地图`** `this`
### moveLayer
将图层移动到不同的 z 位置。
#### Parameters
- `id` **`string`** 要移动的图层的 ID。
- `beforeId` **`string`?** 要在之前插入新图层的现有图层的 ID。查看地图时，`id`图层将出现在`beforeId`图层下方。如果`beforeId`省略，图层将被附加到图层数组的末尾并出现在地图上的所有其他图层之上。
#### Examples
```
// Move a layer with ID 'polygon' before the layer with ID 'country-label'. The `polygon` layer will appear beneath the `country-label` layer on the map.
map.moveLayer('polygon', 'country-label');
```
返回**`地图`** `this`
### removeLayer
从地图的样式中删除具有给定 ID 的图层。
如果不存在这样的层，`error`则会触发一个事件。
#### Parameters
- `id` **`string`** 要删除的图层的 id
#### Examples
```
// If a layer with ID 'state-data' exists, remove it.
if (map.getLayer('state-data')) map.removeLayer('state-data');
```
### getLayer
返回地图样式中具有指定 ID 的图层。
#### Parameters
- `id` **`string`** 要获取的图层的 ID。
#### Examples
```
var stateDataLayer = map.getLayer('state-data');
```
返回**`Object`?** 具有指定 ID 的图层，或者`undefined` 如果 ID 对应于不存在的图层。
### setLayerZoomRange
设置指定样式图层的缩放范围。缩放范围包括 `最小缩放级别` 和`最大缩放级别` 图层将被渲染。
注意：对于使用矢量源的样式图层，样式图层无法以低于_源图层_的最小缩放级别的缩放级别进行渲染，因为这些缩放级别不存在数据。如果源图层的最小缩放级别高于样式图层中定义的最小缩放级别，则不会在缩放范围内的所有缩放级别渲染样式图层。
#### Parameters
- `layerId` **`string`** 将应用缩放范围的图层的 ID。
- `minzoom` **`number`** 要设置的最小缩放 (0-24)。
- `maxzoom` **`number`** 要设置的最大缩放 (0-24)。
#### Examples
```
map.setLayerZoomRange('my-layer', 2, 5);
```
返回**`地图`** `this`
### setFilter
为指定的样式层设置过滤器。
过滤器控制样式层从其源呈现的特征。过滤器表达式计算出的任何要素`true`都将在地图上呈现。那些虚假的将被隐藏。
使用`setFilter`显示源数据的子集。
要清除过滤器，请传递`null`或`undefined`作为第二个参数。
#### Parameters
- `layerId` **`string`** 将应用过滤器的图层的 ID。
- `filter` **( `Array`| null | `undefined`)**过滤器，符合 Style Specification 的 `过滤器定义 `. 如果提供`null`或`undefined`，则该函数会从图层中删除任何现有过滤器。
- `options` **`Object`?** 选项对象。（可选，默认`{}`）
- `options.validate` **`boolean`**是否检查过滤器是否符合样式规范。禁用验证是一种性能优化，只有在您之前验证过将传递给此函数的值时才应使用。（可选，默认`true`）
#### Examples
```
// display only features with the 'name' property 'USA'
map.setFilter('my-layer', ['==', ['get', 'name'], 'USA']);
```
```
// display only features with five or more 'available-spots'
map.setFilter('bike-docks', ['>=', ['get', 'available-spots'], 5]);
```
```
// remove the filter for the 'bike-docks' style layer
map.setFilter('bike-docks', null);
```
返回**`地图`** `this`
### getFilter
返回应用于指定样式层的过滤器。
#### Parameters
- `layerId` **`string`** 要获取其过滤器的样式图层的 ID。
返回**`Array`**图层的过滤器。
### setPaintProperty
设置指定样式层中绘制属性的值。
#### Parameters
- `layerId` **`string`** 要在其中设置 Paint 属性的图层的 ID。
- `name` **`string`** 要设置的绘制属性的名称。
- `value` **any**要设置的paint 属性的值。必须是适合该属性的类型，如`样式规范中`所定义 ``.
- `options` **`Object`?** 选项对象。（可选，默认`{}`）
- `options.validate` **`boolean`**是否检查是否`value`符合样式规范。禁用验证是一种性能优化，只有在您之前验证过将传递给此函数的值时才应使用。（可选，默认`true`）
#### Examples
```
map.setPaintProperty('my-layer', 'fill-color', '#faafee');
```
返回**`地图`** `this`
### getPaintProperty
返回指定样式层中绘制属性的值。
#### Parameters
- `layerId` **`string`** 从中获取paint属性的图层的ID。
- `name` **`string`** 要获取的油漆属性的名称。
返回**任何**指定的paint属性的值。
### setLayoutProperty
设置指定样式层中布局属性的值。
#### Parameters
- `layerId` **`string`** 要在其中设置布局属性的图层的 ID。
- `name` **`string`** 要设置的布局属性的名称。
- `value` **any**布局属性的值。必须是适合该属性的类型，如`样式规范中`所定义 ``.
- `options` **`Object`?** 选项对象。（可选，默认`{}`）
- `options.validate` **`boolean`**是否检查是否`value`符合样式规范。禁用验证是一种性能优化，只有在您之前验证过将传递给此函数的值时才应使用。（可选，默认`true`）
#### Examples
```
map.setLayoutProperty('my-layer', 'visibility', 'none');
```
返回**`地图`** `this`
### getLayoutProperty
返回指定样式层中布局属性的值。
#### Parameters
- `layerId` **`string`** 要从中获取布局属性的图层的 ID。
- `name` **`string`** 要获取的布局属性的名称。
返回**任何**指定布局属性的值。
### setLight
设置灯光值的任意组合。
#### Parameters
- `light` **LightSpecification**要设置的光属性。必须符合`样式规范 `.
- `options` **`Object`?** 选项对象。（可选，默认`{}`）
- `options.validate` **`boolean`**是否检查过滤器是否符合样式规范。禁用验证是一种性能优化，只有在您之前验证过将传递给此函数的值时才应使用。（可选，默认`true`）
#### Examples
```
var layerVisibility = map.getLayoutProperty('my-layer', 'visibility');
```
返回**`地图`** `this`
### getLight
返回灯光对象的值。
返回**`Object`**样式的 light Light 属性。
### setTerrain
设置样式的地形属性。
#### Parameters
- `terrain` **TerrainSpecification**要设置的地形属性。如果提供`null`或`undefined`，则函数会移除地形。
#### Examples
```
map.addSource('dem', {
'type': 'raster-dem',
'url': 'your url',
'tileSize': 512,
'maxzoom': 14
});
// add the DEM source as a terrain layer with exaggerated height
map.setTerrain({ 'source': 'dem', 'exaggeration': 1.5 });
```
返回**`地图`** `this`
### getTerrain
返回地形规范或`null`地形未在地图上设置。
返回**`Object`**地形的地形规范属性。
### setFog
设置样式的雾属性。
#### Parameters
- `fog` **FogSpecification**要设置的雾属性。 如果提供`null`或`undefined`，则此函数调用将从地图中移除雾。
#### Examples
```
map.setFog({
"range": [1.0, 12.0],
"color": 'white',
"horizon-blend": 0.1
});
```
返回**`地图`** `this`
### getFog
返回雾规范或`null`地图上是否未设置雾。
返回**`Object`**样式的雾雾规范属性。
### queryTerrainElevation
查询当前加载的某个地理位置的高程数据。`meters`相对于平均海平面返回高程。`null`如果`terrain`已禁用或尚未加载该位置的地形数据，则返回。
为了保证加载地形数据，确保地理位置可见，等待`idle`事件发生。
#### Parameters
- `lnglat` **[LngLatLike][284]**要查询的地理位置。
- `options` **`海拔查询选项`？**选项对象
- `options.exaggerated` **`boolean`**当`true`返回具有`exaggeration`来自已应用样式的值的地形高程时。当`false`，返回未应用样式的基础数据的原始值。（可选，默认`true`）
#### Examples
```
var coordinate = [-122.420679, 37.772537];
var elevation = map.queryTerrainElevation(coordinate);
```
返回**( `number`| null)**以米为单位的海拔高度
### setFeatureState
设置`state`特征的 。功能`state`是在运行时分配给功能的一组用户定义的键值对。使用此方法时，`state`对象将与特征状态中的任何现有键值对合并。要素由其`feature.id`属性标识，该属性可以是任何数字或字符串。
此方法只能用于具有`feature.id`属性的源。该`feature.id`属性可以通过三种方式进行定义：
- 对于矢量或 GeoJSON 源，包括`id`原始数据文件中的属性。
- 对于矢量或 GeoJSON 源，使用 ``promoteId`` 定义源时的选项。
- 对于 GeoJSON 源，使用 ``generateId``选项`id`根据源数据中的特征索引自动分配一个。如果使用 更改要素数据`map.getSource('some id').setData(..)`，则可能需要考虑更新的`id`值重新应用状态。
_注意：您可以使用``feature-state`` 表达式出于样式目的访问功能状态对象中的值。_
#### Parameters
- `feature` **`Object`**特征标识符。从`Map#queryRenderedFeatures`或事件处理程序返回的特征对象 可用作特征标识符。
- `feature.id` **( `number`| `string`) 功能的**唯一 ID。可以是整数或字符串，但仅当``promoteId`` 选项已应用于源或字符串可以转换为整数。
- `feature.source` **`string`** 要素的矢量或 GeoJSON 源的 ID。
- `feature.sourceLayer` **`string`?** （可选）_对于矢量切片源，`sourceLayer`是必需的。_
- `state` **`Object`**一组键值对。这些值应该是有效的 JSON 类型。
#### Examples
```
// When the mouse moves over the `my-layer` layer, update
// the feature state for the feature under the mouse
map.on('mousemove', 'my-layer', function(e) {
if (e.features.length > 0) {
map.setFeatureState({
source: 'my-source',
sourceLayer: 'my-source-layer',
id: e.features[0].id,
}, {
hover: true
});
}
});
```
返回**[Map][1]**地图对象。
### removeFeatureState
删除`state`功能的 ，将其设置回默认行为。如果仅`feature.source`指定了 a ，它将从该源中删除所有功能的状态。如果`feature.id`还指定了，它将删除该功能状态的所有键。如果`key`还指定了，它只会从该功能的状态中删除该键。要素由其`feature.id`属性标识，该属性可以是任何数字或字符串。
#### Parameters
- `feature` **`Object`**在哪里删除状态的标识符。它可以是来源、功能或功能的特定键。从`Map#queryRenderedFeatures`或事件处理程序返回的特征对象可用作特征标识符。
- `feature.id` **( `number`| `string`) 功能的**唯一 ID。可以是整数或字符串，但仅当``promoteId`` 选项已应用于源或字符串可以转换为整数。
- `feature.source` **`string`** 要素的矢量或 GeoJSON 源的 ID。
- `feature.sourceLayer` **`string`?** （可选）_对于矢量切片源，`sourceLayer`是必需的。_
- `key` **`string`** （可选）要重置的功能状态的键。
#### Examples
```
// Reset the entire state object for all features
// in the `my-source` source
map.removeFeatureState({
source: 'my-source'
});
```
```
// When the mouse leaves the `my-layer` layer,
// reset the entire state object for the
// feature under the mouse
map.on('mouseleave', 'my-layer', function(e) {
map.removeFeatureState({
source: 'my-source',
sourceLayer: 'my-source-layer',
id: e.features[0].id
});
});
```
```
// When the mouse leaves the `my-layer` layer,
// reset only the `hover` key-value pair in the
// state for the feature under the mouse
map.on('mouseleave', 'my-layer', function(e) {
map.removeFeatureState({
source: 'my-source',
sourceLayer: 'my-source-layer',
id: e.features[0].id
}, 'hover');
});
```
### getFeatureState
获取`state`功能的 。功能`state`是在运行时分配给功能的一组用户定义的键值对。要素由其`feature.id`属性标识，该属性可以是任何数字或字符串。
_注意：要访问功能状态对象中的值以设置功能样式，请使用``feature-state`表达式 `._
#### Parameters
- `feature` **`Object`**特征标识符。从`Map#queryRenderedFeatures`或事件处理程序返回的特征对象 可用作特征标识符。
- `feature.id` **( `number`| `string`) 功能的**唯一 ID。可以是整数或字符串，但仅当``promoteId`` 选项已应用于源或字符串可以转换为整数。
- `feature.source` **`string`** 要素的矢量或 GeoJSON 源的 ID。
- `feature.sourceLayer` **`string`?** （可选）_对于矢量切片源，`sourceLayer`是必需的。_
#### Examples
```
// When the mouse moves over the `my-layer` layer,
// get the feature state for the feature under the mouse
map.on('mousemove', 'my-layer', function(e) {
if (e.features.length > 0) {
map.getFeatureState({
source: 'my-source',
sourceLayer: 'my-source-layer',
id: e.features[0].id
});
}
});
```
返回**`Object`**功能状态：在运行时分配给功能的一组键值对。
### getContainer
返回地图的包含 HTML 元素。
返回**`HTMLElement`**地图的容器。
### getCanvasContainer
返回包含地图`<canvas>`元素的 HTML元素。
如果要将非叠加层添加到地图，则应将它们附加到此元素。
这是地图交互性（例如平移和缩放）的事件绑定所附加到的元素。它将接收来自子元素（例如 ）的冒泡事件`<canvas>`，但不会接收来自地图控件的冒泡事件。
返回**`HTMLElement`**地图的容器`<canvas>`。
### getCanvas
返回地图的`<canvas>`元素。
返回**`HTMLCanvasElement `**地图的`<canvas>`元素。
### loaded
返回一个布尔值，指示地图是否已完全加载。
返回`false`如果样式还没有完全加载，或者如果已经更改了源或风格还没有完全加载。
返回**`boolean`**一个布尔值，指示地图是否已完全加载。
### remove
清理并释放与此地图关联的所有内部资源。
这包括 DOM 元素、事件绑定、Web Worker 和 WebGL 资源。
当您使用完地图并希望确保它不再消耗浏览器资源时，请使用此方法。之后，您不得在地图上调用任何其他方法。
### triggerRepaint
触发单帧渲染。当图层的属性或与图层源关联的属性发生更改时，将此方法与自定义图层一起使用以重新绘制地图。在渲染下一帧之前多次调用它仍然会导致只渲染一个帧。
#### Examples
```
map.triggerRepaint();
```
### showTileBoundaries
获取和设置一个布尔值，指示地图是否将围绕每个图块和图块 ID 呈现轮廓。这些图块边界对于调试很有用。
第一个矢量源的未压缩文件大小绘制在每个图块的左上角，在图块 ID 旁边。
类型： `boolean`
#### Examples
```
map.showTileBoundaries = true;
```
### showTerrainWireframe
获取并设置一个布尔值，指示地图是否将在显示的地形顶部呈现线框。用于调试。
线框始终为红色，仅在地形处于活动状态时绘制。
类型： `boolean`
#### Examples
```
map.showTerrainWireframe = true;
```
### showPadding
获取并设置一个布尔值，指示地图是否将填充偏移可视化。
类型： `boolean`
### showCollisionBoxes
获取和设置一个布尔值，指示地图是否将围绕数据源中的所有符号呈现框，显示哪些符号已渲染或由于碰撞而隐藏。此信息对调试很有用。
类型： `boolean`
### repaint
获取和设置一个布尔值，指示地图是否会连续重绘。此信息可用于分析性能。
类型： `boolean`
### version
正在使用的版本。
类型： `string`
### getCenter
返回地图的地理中心点。
#### Examples
```
// return a LngLat object such as {lng: 0, lat: 0}
var center = map.getCenter();
// access longitude and latitude values directly
var {longitude, latitude} = map.getCenter();
```
返回**[LngLat][230]**地图的地理中心点。
### setCenter
设置地图的地理中心点。相当于`jumpTo({center: center})`。
#### Parameters
- `center` **[LngLatLike][284]**要设置的中心点。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
map.setCenter([-74, 38]);
```
返回**`地图`** `this`
### panBy
按指定的偏移量平移地图。
#### Parameters
- `offset` **[PointLike][166]** `x`和`y`平移地图所**`依据的`**坐标。
- `options` **`动画选项`？**选项对象。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
返回**`地图`** `this`
### panTo
使用动画过渡将地图平移到指定位置。
#### Parameters
- `lnglat` **`LngLatLike 要将`**地图平**`移到`**的位置。
- `options` **`动画选项`？**描述过渡目标和动画的选项。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
map.panTo([-74, 38]);
```
```
// Specify that the panTo animation should last 5000 milliseconds.
map.panTo([-74, 38], {duration: 5000});
```
返回**`地图`** `this`
### getZoom
返回地图的当前缩放级别。
#### Examples
```
map.getZoom();
```
返回**`number`**地图的当前缩放级别。
### setZoom
设置地图的缩放级别。相当于`jumpTo({zoom: zoom})`。
#### Parameters
- `zoom` **`number`** 要设置的缩放级别 (0-20)。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
// Zoom to the zoom level 5 without an animated transition
map.setZoom(5);
```
返回**`地图`** `this`
### zoomTo
使用动画过渡将地图缩放到指定的缩放级别。
#### Parameters
- `zoom` **`number`** 要过渡到的缩放级别。
- `options` **`动画选项`？**选项对象。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
// Zoom to the zoom level 5 without an animated transition
map.zoomTo(5);
// Zoom to the zoom level 8 with an animated transition
map.zoomTo(8, {
duration: 2000,
offset: [100, 50]
});
```
返回**`地图`** `this`
### zoomIn
将地图的缩放级别增加 1。
#### Parameters
- `options` **`动画选项`？**选项对象。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
// zoom the map in one level with a custom animation duration
map.zoomIn({duration: 1000});
```
返回**`地图`** `this`
### zoomOut
将地图的缩放级别降低 1。
#### Parameters
- `options` **`动画选项`？**选项对象。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
// zoom the map out one level with a custom animation offset
map.zoomOut({offset: [80, 60]});
```
返回**`地图`** `this`
### getBearing
返回地图的当前方位。方位是“向上”的罗盘方向；例如，90° 的方位角使地图定向，使东面朝上。
返回**`number`**地图的当前方位。
### setBearing
设置地图的方位（旋转）。方位是“向上”的罗盘方向；例如，90° 的方位角使地图定向，使东面朝上。
相当于`jumpTo({bearing: bearing})`。
#### Parameters
- `bearing` **`number`** 所需的轴承。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
// rotate the map to 90 degrees
map.setBearing(90);
```
返回**`地图`** `this`
### getPadding
返回在地图视口周围应用的当前填充。
返回**[PaddingOptions][196]**地图视口周围的当前填充。
### setPadding
设置视口周围的填充（以像素为单位）。
相当于`jumpTo({padding: padding})`。
#### Parameters
- `padding` **[PaddingOptions][196]**所需的填充。格式：{左：数字，右：数字，上：数字，下：数字}
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
// Sets a left padding of 300px, and a top padding of 50px
map.setPadding({ left: 300, top: 50 });
```
返回**`地图`** `this`
### rotateTo
使用动画过渡将地图旋转到指定的方位。方位是“向上”的罗盘方向；例如，90° 的方位角使地图定向，使东面朝上。
#### Parameters
- `bearing` **`number`** 所需的轴承。
- `options` **`动画选项`？**选项对象。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
返回**`地图`** `this`
### resetNorth
旋转地图，使北方向上（0° 方位角），并带有动画过渡。
#### Parameters
- `options` **`动画选项`？**选项对象。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
返回**`地图`** `this`
### resetNorthPitch
旋转和倾斜地图，使北朝上（0° 方位角）且俯仰角为 0°，并带有动画过渡。
#### Parameters
- `options` **`动画选项`？**选项对象。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
返回**`地图`** `this`
### snapToNorth
如果当前方位足够接近它（即在`bearingSnap`阈值内），则捕捉地图使北朝上（0° 方位 ）。
#### Parameters
- `options` **`动画选项`？**选项对象。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
返回**`地图`** `this`
### getPitch
返回地图的当前倾斜度（倾斜度）。
返回**`number`**地图的当前间距，以距屏幕平面的度数为单位。
### setPitch
设置地图的倾斜度（倾斜度）。相当于`jumpTo({pitch: pitch})`。
#### Parameters
- `pitch` **`number`** 要设置的间距，以距屏幕平面的度数为单位 (0-60)。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
返回**`地图`** `this`
### cameraForBounds
#### Parameters
- `bounds` **[LngLatBoundsLike][299]**计算视口中这些边界的中心，并使用最高缩放级别，包括`Map#getMaxZoom()`适合视口的缩放级别。LngLatBounds 表示一个始终与轴承 0 轴对齐的框。
- `options` **`相机选项`？**选项对象。
- `options.padding` **( `number`| [PaddingOptions][196] )？**添加到给定边界的填充量（以像素为单位）。
- `options.bearing` **`number`**动画结束时所需的地图方位，以度为单位。（可选，默认`0`）
- `options.offset` **[PointLike][166]**相对于地图中心的给定边界的中心，以像素为单位。（可选，默认`[0,0]`）
- `options.maxZoom` **`number`?** 相机过渡到指定边界时允许的最大缩放级别。
#### Examples
```
var bbox = [[-79, 43], [-73, 45]];
var newCameraTransform = map.cameraForBounds(bbox, {
padding: {top: 10, bottom:25, left: 15, right: 5}
});
```
返回**（[CameraOptions][194] |无效）**如果地图能够适合提供的界限，收益`CameraOptions`有 `center`，`zoom`和`bearing`。如果地图无法适应，方法将发出警告并返回未定义。
### fitBounds
平移和缩放地图以将其可见区域包含在指定的地理边界内。如果方位角非零，此函数还会将地图的方位角重置为 0。如果在地图上设置了填充，则边界适合插图。
#### Parameters
- `bounds` **[LngLatBoundsLike][299]**在视口中居中这些边界，并使用最高缩放级别，包括`Map#getMaxZoom()`适合它们在视口中的缩放级别。
- `options` **`Object`?** 除了以下字段之外，Options 还支持[AnimationOptions][195]和[CameraOptions][194]中的所有属性。
- `options.padding` **( `number`| [PaddingOptions][196] )？**添加到给定边界的填充量（以像素为单位）。
- `options.linear` **`boolean`**如果`true`，则地图使用 `Map#easeTo 进行转换`。如果`false`，则地图使用`Map#flyTo 进行转换`。有关可用选项的信息，请参阅这些函数和[AnimationOptions][195]。（可选，默认`false`）
- `options.easing` **功能？**动画过渡的缓动函数。请参阅`动画选项`。
- `options.offset` **[PointLike][166]**相对于地图中心的给定边界的中心，以像素为单位。（可选，默认`[0,0]`）
- `options.maxZoom` **`number`?** 当地图视图转换到指定边界时允许的最大缩放级别。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
var bbox = [[-79, 43], [-73, 45]];
map.fitBounds(bbox, {
padding: {top: 10, bottom:25, left: 15, right: 5}
});
```
返回**`地图`** `this`
### fitScreenCoordinates
一旦地图旋转到指定的方位，平移、旋转和缩放地图以适应由点 p0 和 p1 构成的框。要缩放而不旋转，请传入当前地图方位。
#### Parameters
- `p0` **[PointLike][166]**屏幕上的第一个点，以像素坐标表示
- `p1` **[PointLike][166]**屏幕上的第二个点，以像素坐标表示
- `bearing` **`number`**动画结束时所需的地图方位，以度为单位。如果贴图具有非零间距，则忽略此值。
- `options` **任何？**选项对象。
- `options.padding` **( `number`| [PaddingOptions][196] )？**添加到给定边界的填充量（以像素为单位）。
- `options.linear` **`boolean`**如果`true`，则地图使用 `Map#easeTo 进行转换`。如果`false`，则地图使用`Map#flyTo 进行转换`。有关可用选项的信息，请参阅这些函数和[AnimationOptions][195]。（可选，默认`false`）
- `options.easing` **功能？**动画过渡的缓动函数。请参阅`动画选项`。
- `options.offset` **[PointLike][166]**相对于地图中心的给定边界的中心，以像素为单位。（可选，默认`[0,0]`）
- `options.maxZoom` **`number`?** 当地图视图转换到指定边界时允许的最大缩放级别。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
var p0 = [220, 400];
var p1 = [500, 900];
map.fitScreenCoordinates(p0, p1, map.getBearing(), {
padding: {top: 10, bottom:25, left: 15, right: 5}
});
```
返回**`地图`** `this`
### jumpTo
更改中心、缩放、方位和俯仰的任意组合，无需动画过渡。对于 中未指定的任何详细信息，地图将保留其当前值`options`。
#### Parameters
- `options` **[CameraOptions][194]**选项对象。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
// jump to coordinates at current zoom
map.jumpTo({center: [0, 0]});
// jump with zoom, pitch, and bearing options
map.jumpTo({
center: [0, 0],
zoom: 8,
pitch: 45,
bearing: 90
});
```
返回**`地图`** `this`
### getFreeCameraOptions
返回相机实体的位置和方向。
返回**[FreeCameraOptions][309]**相机状态
### setFreeCameraOptions
`FreeCameraOptions`提供对底层相机实体的更直接访问。为了向后兼容，使用此 API 的状态集也必须是可表示的 `CameraOptions`。如果向俯仰和方位表示的转换不明确，参数将被限制在有效范围内或作为无效丢弃。例如，如果导致相机颠倒、四元数长度为零或间距超过最大间距限制，则方向可能无效。
#### Parameters
- `options` **[FreeCameraOptions][309]** `FreeCameraOptions`对象
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
返回**`地图`** `this`
### easeTo
更改的任意组合`center`，`zoom`，`bearing`，`pitch`，并`padding`与新老值之间动画转换。对于 中未指定的任何详细信息，地图将保留其当前值`options`。
注意：如果用户`reduced motion`在其操作系统中启用了辅助功能，则转换将立即发生，除非`options`包含`essential: true`.
#### Parameters
- `options` **任何**描述过渡目标和动画的选项。接受[CameraOptions][194]和[AnimationOptions][195]。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
返回**`地图`** `this`
### flyTo
改变中心、缩放、方位和俯仰的任意组合，沿着一条唤起飞行的曲线动画过渡。动画无缝地结合了缩放和平移，以帮助用户即使在穿越很远的距离后也能保持她的方位。
注意：动画将被跳过，这将`jumpTo` 与用户`reduced motion`在其操作系统中启用辅助功能时的行为等效，除非 'options' 包含`essential: true`.
#### Parameters
- `options` **`Object`**描述过渡目标和动画的选项。接受[CameraOptions][194]、[AnimationOptions][195]和以下附加选项。
- `options.curve` **`number`**沿飞行路径发生的缩放“曲线”。高值最大化放大动画的缩放，而低值最小化缩放以获得更接近`Map#easeTo`的效果。1.42 是参与者在`van Wijk (2003) 中`讨论的用户研究中选择的平均值 ``. 的值 `Math.pow(6, 0.25)`将等价于均方根平均速度。值为 1 将产生圆周运动。（可选，默认`1.42`）
- `options.minZoom` **`number`?** 飞行路径峰值处的基于零的缩放级别。如果 `options.curve`指定，则忽略此选项。
- `options.speed` **`number`**相对于 定义的动画的平均速度 `options.curve`。速度为 1.2 意味着地图似乎每秒沿着飞行路径移动 1.2 倍`options.curve`屏幕。一_屏_是地图的可见跨度。它不对应于固定的物理距离，而是因缩放级别而异。（可选，默认`1.2`）
- `options.screenSpeed` **`number`?** 假设线性时间曲线，以每秒屏幕数为单位测量的动画平均速度。如果`options.speed`指定，则忽略此选项。
- `options.maxDuration` **`number`?** 动画的最长持续时间，以毫秒为单位。如果持续时间超过最大持续时间，则重置为 0。
- `eventData` **`Object`?** 要添加到此方法触发的事件的事件对象的附加属性。
#### Examples
```
// fly with default options to null island
map.flyTo({center: [0, 0], zoom: 9});
// using flyTo options
map.flyTo({
center: [0, 0],
zoom: 9,
speed: 0.2,
curve: 1,
easing(t) {
return t;
}
});
```
返回**`地图`** `this`
### stop
停止任何正在进行的动画过渡。
返回**`地图`** `this`
### resize
在调整地图大小后立即触发。
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// immediately after the map has been resized.
map.on('resize', function() {
console.log('A resize event occurred.');
});
```
### remove
在使用`Map.event:remove 删除`地图后立即`触发`。
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just after the map is removed.
map.on('remove', function() {
console.log('A remove event occurred.');
});
```
### mousedown
当在地图内按下定位设备（通常是鼠标）时触发。
**注意：**此事件与可选`layerId`参数兼容。如果`layerId`作为第二个参数包含在`Map#on 中`，则仅当在指定图层的可见部分内按下光标时，事件侦听器才会触发。
#### Properties
- `data` **`地图鼠标事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener
map.on('mousedown', function() {
console.log('A mousedown event has occurred.');
});
```
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener for a specific layer
map.on('mousedown', 'poi-label', function() {
console.log('A mousedown event has occurred on a visible portion of the poi-label layer.');
});
```
### mouseup
当定位设备（通常是鼠标）在地图内释放时触发。
**注意：**此事件与可选`layerId`参数兼容。如果`layerId`在`Map#on 中`作为第二个参数包含在内，则仅当在指定图层的可见部分内释放光标时，事件侦听器才会触发。
#### Properties
- `data` **`地图鼠标事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener
map.on('mouseup', function() {
console.log('A mouseup event has occurred.');
});
```
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener for a specific layer
map.on('mouseup', 'poi-label', function() {
console.log('A mouseup event has occurred on a visible portion of the poi-label layer.');
});
```
### mouseover
当定位设备（通常是鼠标）在地图内移动时触发。当您在包含地图的网页上移动光标时，每次进入地图或任何子元素时都会触发该事件。
**注意：**此事件与可选`layerId`参数兼容。如果`layerId`作为第二个参数包含在`Map#on 中`，则仅当光标移动到指定图层的可见部分内时，事件侦听器才会触发。
#### Properties
- `data` **`地图鼠标事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener
map.on('mouseover', function() {
console.log('A mouseover event has occurred.');
});
```
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener for a specific layer
map.on('mouseover', 'poi-label', function() {
console.log('A mouseover event has occurred on a visible portion of the poi-label layer.');
});
```
### mousemove
当光标在地图内时移动定点设备（通常是鼠标）时触发。当您在地图上移动光标时，每次光标在地图内更改位置时都会触发该事件。
**注意：**此事件与可选`layerId`参数兼容。如果`layerId`作为第二个参数包含在`Map#on 中`，则仅当光标位于指定图层的可见部分内时，事件侦听器才会触发。
#### Properties
- `data` **`地图鼠标事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener
map.on('mousemove', function() {
console.log('A mousemove event has occurred.');
});
```
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener for a specific layer
map.on('mousemove', 'poi-label', function() {
console.log('A mousemove event has occurred on a visible portion of the poi-label layer.');
});
```
### click
当在地图上的同一点按下并释放定位设备（通常是鼠标）时触发。
**注意：**此事件与可选`layerId`参数兼容。如果`layerId`作为第二个参数包含在`Map#on 中`，则仅当按下和释放的点包含指定图层的可见部分时，事件侦听器才会触发。
#### Properties
- `data` **`地图鼠标事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener
map.on('click', function(e) {
console.log('A click event has occurred at ' + e.lngLat);
});
```
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener for a specific layer
map.on('click', 'poi-label', function(e) {
console.log('A click event has occurred on a visible portion of the poi-label layer at ' + e.lngLat);
});
```
### dblclick
当定位设备（通常是鼠标）在地图上的同一点快速连续按下和释放两次时触发。
**注意：**此事件与可选`layerId`参数兼容。如果`layerId`作为第二个参数包含在`Map#on 中`，则仅当单击两次的点包含指定图层的可见部分时，事件侦听器才会触发。
#### Properties
- `data` **`地图鼠标事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener
map.on('dblclick', function(e) {
console.log('A dblclick event has occurred at ' + e.lngLat);
});
```
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener for a specific layer
map.on('dblclick', 'poi-label', function(e) {
console.log('A dblclick event has occurred on a visible portion of the poi-label layer at ' + e.lngLat);
});
```
### mouseenter
当定点设备（通常是鼠标）从该图层外部或地图画布外部进入指定图层的可见部分时触发。
**重要提示：**只有当`Map#on`包含三个参数时才能侦听此事件，其中第二个参数指定所需的层。
#### Properties
- `data` **`地图鼠标事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener
map.on('mouseenter', 'water', function() {
console.log('A mouseenter event occurred on a visible portion of the water layer.');
});
```
### mouseleave
当定点设备（通常是鼠标）离开指定图层的可见部分或从指定图层移动到地图画布外时触发。
**注意：**要检测鼠标何时离开画布，独立于图层，请改用`Map.event:mouseout`。
**重要提示：**只有当`Map#on`包含三个参数时才能侦听此事件，其中第二个参数指定所需的层。
#### Properties
- `data` **`地图鼠标事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when the pointing device leaves
// a visible portion of the specified layer.
map.on('mouseleave', 'water', function() {
console.log('A mouseleave event occurred.');
});
```
### mouseout
当点设备（通常是鼠标）离开地图的画布时触发。
#### Properties
- `data` **`地图鼠标事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when the pointing device leave's
// the map's canvas.
map.on('mouseout', function() {
console.log('A mouseout event occurred.');
});
```
### contextmenu
单击鼠标右键或在地图内按下上下文菜单键时触发。
#### Properties
- `data` **`地图鼠标事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when the right mouse button is
// pressed within the map.
map.on('contextmenu', function() {
console.log('A contextmenu event occurred.');
});
```
### wheel
当一个 ``wheel``事件发生在地图内。
#### Properties
- `data` **`地图轮事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when a wheel event occurs within the map.
map.on('wheel', function() {
console.log('A wheel event occurred.');
});
```
### touchstart
当一个 ``touchstart`` 事件发生在地图内。
#### Properties
- `data` **[MapTouchEvent][232]** // 初始化地图 var map = new vjmap.Map({ // 地图选项 }); // 设置一个事件侦听器，当地图中发生 touchstart 事件时触发该事件。map.on('touchstart', function() { console.log('A touchstart 事件发生。'); });
### touchend
当一个 ``touchend`` 事件发生在地图内。
#### Properties
- `data` **`地图触摸事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when a touchstart event occurs within the map.
map.on('touchstart', function() {
console.log('A touchstart event occurred.');
});
```
### touchmove
当一个 ``touchmove`` 事件发生在地图内。
#### Properties
- `data` **`地图触摸事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when a touchmove event occurs within the map.
map.on('touchmove', function() {
console.log('A touchmove event occurred.');
});
```
### touchcancel
当一个 ``touchcancel`` 事件发生在地图内。
#### Properties
- `data` **`地图触摸事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when a touchcancel event occurs within the map.
map.on('touchcancel', function() {
console.log('A touchcancel event occurred.');
});
```
### movestart
作为用户交互或`Map#jumpTo`等方法的结果，在地图开始从一个视图过渡到另一个视图之前`触发`。
#### Properties
- `data` **{originalEvent: `DragEvent `}**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just before the map begins a transition
// from one view to another.
map.on('movestart', function() {
console.log('A movestart` event occurred.');
});
```
### move
作为用户交互或`Map#flyTo`等方法的结果，在从一个视图到另一个视图的动画过渡期间重复`触发`。
#### Properties
- `data` **( [MapMouseEvent][226] | [MapTouchEvent][232] )**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// repeatedly during an animated transition.
map.on('move', function() {
console.log('A move event occurred.');
});
```
### moveend
作为用户交互或`Map#jumpTo`等方法的结果，在地图完成从一个视图到另一个视图的转换后`立即触发`。
#### Properties
- `data` **{originalEvent: `DragEvent `}**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just after the map completes a transition.
map.on('moveend', function() {
console.log('A moveend event occurred.');
});
```
### dragstart
当“拖动平移”交互开始时触发。请参阅[DragPanHandler][191]。
#### Properties
- `data` **{originalEvent: `DragEvent `}**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when a "drag to pan" interaction starts.
map.on('dragstart', function() {
console.log('A dragstart event occurred.');
});
```
### drag
在“拖动平移”交互期间反复触发。请参阅[DragPanHandler][191]。
#### Properties
- `data` **( [MapMouseEvent][226] | [MapTouchEvent][232] )**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// repeatedly during a "drag to pan" interaction.
map.on('drag', function() {
console.log('A drag event occurred.');
});
```
### dragend
当“拖动平移”交互结束时触发。请参阅[DragPanHandler][191]。
#### Properties
- `data` **{originalEvent: `DragEvent `}**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when a "drag to pan" interaction ends.
map.on('dragend', function() {
console.log('A dragend event occurred.');
});
```
### zoomstart
作为用户交互或`Map#flyTo`等方法的结果，在地图开始从一个缩放级别过渡到另一个缩放级别之前`触发`。
#### Properties
- `data` **( [MapMouseEvent][226] | [MapTouchEvent][232] )**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just before a zoom transition starts.
map.on('zoomstart', function() {
console.log('A zoomstart event occurred.');
});
```
### zoom
作为用户交互或`Map#flyTo`等方法的结果，在从一个缩放级别到另一个缩放级别的动画过渡期间重复`触发`。
#### Properties
- `data` **( [MapMouseEvent][226] | [MapTouchEvent][232] )**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// repeatedly during a zoom transition.
map.on('zoom', function() {
console.log('A zoom event occurred.');
});
```
### zoomend
作为用户交互或`Map#flyTo`等方法的结果，在地图完成从一个缩放级别到另一个缩放级别的转换后`立即触发`。缩放过渡通常会在渲染完成之前结束，因此如果您需要等待渲染完成，请改用`Map#idle`事件。
#### Properties
- `data` **( [MapMouseEvent][226] | [MapTouchEvent][232] )**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just after a zoom transition finishes.
map.on('zoomend', function() {
console.log('A zoomend event occurred.');
});
```
### rotatestart
当“拖动旋转”交互开始时触发。请参阅[DragRotateHandler][192]。
#### Properties
- `data` **( [MapMouseEvent][226] | [MapTouchEvent][232] )**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just before a "drag to rotate" interaction starts.
map.on('rotatestart', function() {
console.log('A rotatestart event occurred.');
});
```
### rotate
在“拖动以旋转”交互期间反复触发。请参阅[DragRotateHandler][192]。
#### Properties
- `data` **( [MapMouseEvent][226] | [MapTouchEvent][232] )**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// repeatedly during "drag to rotate" interaction.
map.on('rotate', function() {
console.log('A rotate event occurred.');
});
```
### rotateend
当“拖动旋转”交互结束时触发。请参阅[DragRotateHandler][192]。
#### Properties
- `data` **( [MapMouseEvent][226] | [MapTouchEvent][232] )**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just after a "drag to rotate" interaction ends.
map.on('rotateend', function() {
console.log('A rotateend event occurred.');
});
```
### pitchstart
每当地图的俯仰（倾斜）由于用户交互或`Map#flyTo`等方法而开始发生变化时`触发`。
#### Properties
- `data` **地图事件数据**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just before a pitch (tilt) transition starts.
map.on('pitchstart', function() {
console.log('A pitchstart event occurred.');
});
```
### pitch
作为用户交互或`Map#flyTo`等方法的结果，在一个状态和另一个状态之间的地图俯仰（倾斜）动画期间重复`触发`。
#### Properties
- `data` **地图事件数据**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// repeatedly during a pitch (tilt) transition.
map.on('pitch', function() {
console.log('A pitch event occurred.');
});
```
### pitchend
由于用户交互或`Map#flyTo 之类的`方法，在地图的俯仰（倾斜）完成更改后立即`触发`。
#### Properties
- `data` **地图事件数据**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just after a pitch (tilt) transition ends.
map.on('pitchend', function() {
console.log('A pitchend event occurred.');
});
```
### boxzoomstart
当“框缩放”交互开始时触发。请参阅[BoxZoomHandler][178]。
#### Properties
- `data` **`地图框缩放事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just before a "box zoom" interaction starts.
map.on('boxzoomstart', function() {
console.log('A boxzoomstart event occurred.');
});
```
### boxzoomend
当“框缩放”交互结束时触发。请参阅[BoxZoomHandler][178]。
类型： `Object`
#### Properties
- `data` **`地图框缩放事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just after a "box zoom" interaction ends.
map.on('boxzoomend', function() {
console.log('A boxzoomend event occurred.');
});
```
### boxzoomcancel
当用户取消“框缩放”交互或边界框不满足最小尺寸阈值时触发。请参阅[BoxZoomHandler][178]。
#### Properties
- `data` **`地图框缩放事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// the user cancels a "box zoom" interaction.
map.on('boxzoomcancel', function() {
console.log('A boxzoomcancel event occurred.');
});
```
### webglcontextlost
当 WebGL 上下文丢失时触发。
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when the WebGL context is lost.
map.on('webglcontextlost', function() {
console.log('A webglcontextlost event occurred.');
});
```
### webglcontextrestored
当 WebGL 上下文恢复时触发。
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when the WebGL context is restored.
map.on('webglcontextrestored', function() {
console.log('A webglcontextrestored event occurred.');
});
```
### load
在下载了所有必要的资源并且地图的第一次视觉完整渲染发生后立即触发。
类型： `Object`
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when the map has finished loading.
map.on('load', function() {
console.log('A load event occurred.');
});
```
### render
每当地图绘制到屏幕时触发，作为结果
- 更改地图的位置、缩放、俯仰或方位
- 地图样式的更改
- 对 GeoJSON 源的更改
- 加载矢量切片、GeoJSON 文件、字形或精灵
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// whenever the map is drawn to the screen.
map.on('render', function() {
console.log('A render event occurred.');
});
```
### idle
在地图进入“空闲”状态之前渲染的最后一帧之后触发：
- 没有正在进行的相机转换
- 当前请求的所有图块都已加载
- 所有淡入淡出/过渡动画已完成
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// just before the map enters an "idle" state.
map.on('idle', function() {
console.log('A idle event occurred.');
});
```
### error
发生错误时触发。这是主要错误报告机制。我们使用事件而不是`throw`更好地适应异步操作。如果没有侦听器绑定到`error`事件，错误将打印到控制台。
#### Properties
- `data` **{错误：{消息：`string`}}**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when an error occurs.
map.on('error', function() {
console.log('A error event occurred.');
});
```
### data
当任何地图数据加载或更改时触发。有关 详细信息，请参阅[MapDataEvent][237]。
#### Properties
- `data` **`地图数据事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when map data loads or changes.
map.on('data', function() {
console.log('A data event occurred.');
});
```
### styledata
当地图的样式加载或更改时触发。有关详细信息，请参阅 [MapDataEvent][237]。
#### Properties
- `data` **`地图数据事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when the map's style loads or changes.
map.on('styledata', function() {
console.log('A styledata event occurred.');
});
```
### sourcedata
当地图源之一加载或更改时触发，包括属于源的图块加载或更改。有关详细信息，请参阅[MapDataEvent][237]。
#### Properties
- `data` **`地图数据事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when one of the map's sources loads or changes.
map.on('sourcedata', function() {
console.log('A sourcedata event occurred.');
});
```
### dataloading
当任何地图数据（样式、源、图块等）开始异步加载或更改时触发。所有`dataloading`事件后跟一个`data` 或`error`事件。有关详细信息，请参阅[MapDataEvent][237]。
#### Properties
- `data` **`地图数据事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// when any map data begins loading
// or changing asynchronously.
map.on('dataloading', function() {
console.log('A dataloading event occurred.');
});
```
### styledataloading
当地图的样式开始异步加载或更改时触发。所有`styledataloading`事件后跟一个`styledata` 或`error`事件。有关详细信息，请参阅[MapDataEvent][237]。
#### Properties
- `data` **`地图数据事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// map's style begins loading or
// changing asyncronously.
map.on('styledataloading', function() {
console.log('A styledataloading event occurred.');
});
```
### sourcedataloading
当地图的源之一开始异步加载或更改时触发。所有`sourcedataloading`事件后跟一个`sourcedata`或`error`事件。有关详细信息，请参阅[MapDataEvent][237]。
#### Properties
- `data` **`地图数据事件`**
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// map's sources begin loading or
// changing asyncronously.
map.on('sourcedataloading', function() {
console.log('A sourcedataloading event occurred.');
});
```
### styleimagemissing
当样式所需的图标或图案丢失时触发。可以在此事件侦听器回调中使用`Map#addImage`添加丢失的图像，以防止跳过图像。此事件可用于动态生成图标和图案。
#### Properties
- `id` **`string`** 缺失图像的 id。
#### Examples
```
// Initialize the map
var map = new vjmap.Map({ // map options });
// Set an event listener that fires
// an icon or pattern is missing.
map.on('styleimagemissing', function() {
console.log('A styleimagemissing event occurred.');
});
```
## IControl
添加到地图的交互式控件界面。这是实现者建模的规范：它不是导出的方法或类。
控件必须实现`onAdd`和`onRemove`，并且必须拥有一个元素，通常是一个`div`元素。要使用默认控件样式，请将`vjmap-ctrl`类添加到控件的节点。
### Examples
```
// Control implemented as ES6 class
class HelloWorldControl {
onAdd(map) {
this._map = map;
this._container = document.createElement('div');
this._container.className = 'vjmap-ctrl';
this._container.textContent = 'Hello, world';
return this._container;
}
onRemove() {
this._container.parentNode.removeChild(this._container);
this._map = undefined;
}
}
// Control implemented as ES5 prototypical class
function HelloWorldControl() { }
HelloWorldControl.prototype.onAdd = function(map) {
this._map = map;
this._container = document.createElement('div');
this._container.className = 'vjmap-ctrl';
this._container.textContent = 'Hello, world';
return this._container;
};
HelloWorldControl.prototype.onRemove = function () {
this._container.parentNode.removeChild(this._container);
this._map = undefined;
};
```
### onAdd
在地图上注册一个控件并让它有机会注册事件侦听器和资源。该方法由`Map#addControl` 内部调用。
#### Parameters
- `map` **`映射`**此控件将添加到的映射
返回**`HTMLElement`**控件的容器元素。这应该由控件创建并由 onAdd 返回而不附加到 DOM：地图将根据需要将控件的元素插入到 DOM 中。
### onRemove
取消注册地图上的控件并让它有机会分离事件侦听器和资源。该方法由`Map#removeControl` 内部调用。
#### Parameters
- `map` **`映射`**此控件将从中删除的映射
返回**`undefined`**此方法不需要返回值
### getDefaultPosition
（可选）为此控件提供默认位置。如果实现了该方法并且`在`没有`position` 参数的情况下调用`Map#addControl`，则 getDefaultPosition 返回的值将用作控件的位置。
返回**`string`**一个控件位置，它是 addControl 中有效值之一。
## point
一个``Point`几何 `对象，它具有 `x`和`y`表示在像素的屏幕坐标特性。
类型： `Object`
### Examples
```
var point = new vjmap.Point(-77, 38);
```
## PointLike
甲`点`或代表两个数字的阵列`x`和`y`以像素为单位的屏幕坐标。
类型：（`点`| `Array`< `number`\>）
### Examples
```
var p1 = new vjmap.Point(-77, 38); // a PointLike which is a Point
var p2 = [-77, 38]; // a PointLike which is an array of two numbers
```
## ProxySourceCache
**扩展 SourceCache**
代理源缓存获得理想的屏幕图块覆盖坐标。所有其他源缓存的坐标被映射到代理坐标的子区域（反之亦然，来自所有源缓存的较大切片的子区域被映射到完整的代理切片）。这发生在 Terrain.updateTileBinding 中的每次绘制调用中。方法在这里用于地形：所有源缓存的所有可见源图块都被渲染到代理源缓存纹理，然后覆盖在地形上。它在未来可重用于处理过度调用，因为桶只能为代理瓦片内容构建，而不是为完全过度调用的矢量瓦片构建。
### Parameters
- `map` **`地图`**
## ProxiedTileID
**扩展 OverscaledTileID**
Canonical、wrap 和 overscaledZ 包含原始源缓存瓦片的信息。此图块被正交渲染到代理图块（由 proxyTileKey 定义）。posMatrix 保存用于将原始图块内容渲染到代理图块的正交、缩放和平移信息。代理图块覆盖原始图块的整个或子矩形。
### Parameters
- `tileID` **超大TileID**
- `proxyTileKey` **`number`**
- `projMatrix` **`Float32Array `**
## ElevationQueryOptions
`Map#queryTerrainElevation`和`Map#unproject3d 的`通用选项，用于控制高程数据的返回方式。
类型： `Object`
### Properties
- `exaggerated` **`boolean`**当设置为`true`返回`exaggeration`已应用样式上的地形的高程值时，当`false`它返回未应用样式的基础数据的原始值时。
## Elevation
提供对来自 raster-dem 源缓存的高程数据的访问。
### getAtPointOrZero
周围的帮助`getAtPoint`程序保证返回一个数值。
#### Parameters
- `point` **`墨卡托坐标`**
- `defaultIfNotLoaded` **`number`** （可选，默认`0`）
返回 **`number`**
### getAtPoint
指定点的海拔高度（以米为单位）。
#### Parameters
- `point` **[MercatorCoordinate][300]**点的**`墨`**卡托坐标。
- `defaultIfNotLoaded` **`number`** 如果未加载提供的点的 dem 磁贴，则返回的值
- `exaggerated` **`boolean`** （可选，默认`true`）
**`number`**以米为单位返回海拔高度。如果没有加载的包含所请求点高程信息的图块，则返回`defaultIfNotLoaded`。不调用网络请求来获取数据。
### getMinMaxForTile
获取由 标识的图块的最低和最高高度`tileID`。
#### Parameters
- `tileID` **OverscaledTileID**是我们从中读取信息的 DEM 切片的子切片（或覆盖相同的空间）。
返回**{min: `number`, max: `number`}?** 最小和最大海拔。
### getMinElevationBelowMSL
获取可见图块低于 MSL 的最低高度。此函数考虑了地形夸大，并且基于最大 DEM 误差是保守的，不要期望此函数提供准确的值。如果没有可见的负高程，则此函数返回 0。
返回**`number`**所有可见图块低于海平面的最小海拔。
### raycast
对屏幕上的可见 DEM 图块执行光线投射并返回沿光线行进的距离。位置的 x 和 y 分量预计在标准化墨卡托坐标 \[0, 1\] 和 z 以米为单位。
#### Parameters
- `position` **vec3**射线原点。
- `dir` **vec3**射线方向。
- `exaggeration` **`number`** 地形夸张。
返回**`number`?**
### pointCoordinate
给定屏幕上的一个点，返回地形上的 3D MercatorCoordinate。包装`raycast`.
#### Parameters
- `screenPoint` **[Point][165]**左上角原点坐标系中以像素为单位的屏幕点。
返回**vec3**如果与地形有交点，则返回 3D 墨卡托坐标的交点，如 vec3(x, y, z)，否则为 null。
## DEMSampler
Helper 类计算并缓存在切片级别查找高程偏移所需的数据。
### Parameters
- `demTile` **Tile**
- `scale` **`number`**
- `offset` **\[ `number`, `number`\]**
## BoxZoomHandler
将`BoxZoomHandler`允许用户放大地图，以适应边框内。通过`shift`在拖动光标的同时单击并按住来定义边界框。
### Parameters
- `map` **`地图`**
- `options` **{clickTolerance：`number`}**
### isEnabled
返回一个布尔值，指示是否启用“框缩放”交互。
如果启用了“框缩放”交互，则返回。**`boolean`** `true`
### isActive
返回一个布尔值，指示“框缩放”交互是否处于活动状态，即当前正在使用。
返回如果“框放大”作用是积极的。**`boolean`** `true`
### enable
启用“框缩放”交互。
#### Examples
```
map.boxZoom.enable();
```
### disable
禁用“框缩放”交互。
#### Examples
```
map.boxZoom.disable();
```
## TouchPitchHandler
**扩展 TwoTouchHandler**
在`TouchPitchHandler`由地图拖动向上和向下两个手指，用户可以间距。
### isEnabled
返回一个布尔值，指示是否启用了“拖动到音高”交互。
如果启用了“拖动到音高”交互，则返回。**`boolean`** `true`
### isActive
返回一个布尔值，指示“拖动到音高”交互是否处于活动状态，即当前正在使用。
返回如果“拖动间距”互动是有效的。**`boolean`** `true`
### enable
启用“拖动到音高”交互。
#### Examples
```
map.touchPitch.enable();
```
### disable
禁用“拖动到音高”交互。
#### Examples
```
map.touchPitch.disable();
```
## KeyboardHandler
将`KeyboardHandler`允许用户放大，缩小，旋转，并使用以下键盘快捷键平移地图：
- `=`/ `+`：将缩放级别增加 1。
- `Shift-=`/ `Shift-+`：将缩放级别增加 2。
- `-`：将缩放级别降低 1。
- `Shift--`：将缩放级别降低 2。
- 箭头键：平移 100 像素。
- `Shift+⇢`：将旋转增加 15 度。
- `Shift+⇠`：将旋转减少 15 度。
- `Shift+⇡`：将音高增加 10 度。
- `Shift+⇣`：将音高降低 10 度。
### enable
启用“键盘旋转和缩放”交互。
#### Examples
```
map.keyboard.enable();
```
### disable
禁用“键盘旋转和缩放”交互。
#### Examples
```
map.keyboard.disable();
```
### isEnabled
返回一个布尔值，指示是否启用“键盘旋转和缩放”交互。
返回是否启用了“键盘旋转和缩放”交互。**`boolean`** `true`
### isActive
如果处理程序已启用并检测到缩放/旋转手势的开始，则返回 true。
返回处理程序是否已启用并已检测到缩放/旋转手势的开始。**`boolean`** `true`
### disableRotation
禁用“键盘平移/旋转”交互，启用“键盘缩放”交互。
#### Examples
```
map.keyboard.disableRotation();
```
### enableRotation
启用“键盘平移/旋转”交互。
#### Examples
```
map.keyboard.enable();
map.keyboard.enableRotation();
```
## ScrollZoomHandler
将`ScrollZoomHandler`允许用户通过滚动缩放地图。
### Parameters
- `map` **`地图`**
- `handler` **处理程序管理器**
### setZoomRate
设置触控板的缩放率。
#### Parameters
- `zoomRate` **`number`**用于将触控板移动缩放到缩放值的速率。（可选，默认`1/100`）
#### Examples
```
// Speed up trackpad zoom
map.scrollZoom.setZoomRate(1/25);
```
### setWheelZoomRate
设置鼠标滚轮的缩放率。
#### Parameters
- `wheelZoomRate` **`number`**用于将鼠标滚轮移动缩放到缩放值的速率。（可选，默认`1/450`）
#### Examples
```
// Slow down zoom of mouse wheel
map.scrollZoom.setWheelZoomRate(1/600);
```
### isEnabled
返回一个布尔值，指示是否启用了“滚动缩放”交互。
如果启用了“滚动缩放”交互，则返回。**`boolean`** `true`
### enable
启用“滚动缩放”交互。
#### Parameters
- `options` **`Object`?** 选项对象。
- `options.around` **`string`?** 如果传递“center”，地图将围绕地图中心缩放
#### Examples
```
map.scrollZoom.enable();
```
```
map.scrollZoom.enable({ around: 'center' })
```
### disable
禁用“滚动缩放”交互。
#### Examples
```
map.scrollZoom.disable();
```
## DoubleClickZoomHandler
将`DoubleClickZoomHandler`允许用户在通过双击或双攻一个点缩放地图。
### Parameters
- `clickZoom` **单击缩放处理程序**
- `TapZoom` **TapZoomHandler**
### enable
启用“双击缩放”交互。
#### Examples
```
map.doubleClickZoom.enable();
```
### disable
禁用“双击缩放”交互。
#### Examples
```
map.doubleClickZoom.disable();
```
### isEnabled
返回一个布尔值，指示是否启用“双击缩放”交互。
如果启用了“双击缩放”交互，则返回。**`boolean`** `true`
### isActive
返回一个布尔值，指示“双击缩放”交互是否处于活动状态，即当前正在使用。
返回如果“双击缩放”互动是有效的。**`boolean`** `true`
## DragPanHandler
将`DragPanHandler`允许用户通过点击并拖动光标以平移地图。
### Parameters
- `el` **`HTMLElement`**
- `mousePan` **鼠标平移处理器**
- `touchPan` **触摸屏处理器**
### enable
启用“拖动平移”交互。
#### Parameters
- `options` **`Object`?** 选项对象。
- `options.linearity` **`number`**用于缩放拖动速度的因子（可选，默认`0`）
- `options.easing` `map.panTo`应用拖动时应用的**函数**缓动函数。（可选，默认`bezier(0,0,0.3,1)`）
- `options.maxSpeed` **`number`**阻力速度的最大值。（可选，默认`1400`）
- `options.deceleration` **`number`**平底锅结束后速度降低的速率。（可选，默认`2500`）
#### Examples
```
map.dragPan.enable();
```
```
map.dragPan.enable({
linearity: 0.3,
easing: bezier(0, 0, 0.3, 1),
maxSpeed: 1400,
deceleration: 2500,
});
```
### disable
禁用“拖动平移”交互。
#### Examples
```
map.dragPan.disable();
```
### isEnabled
返回一个布尔值，指示是否启用了“拖动平移”交互。
如果启用了“拖动平移”交互，则返回。**`boolean`** `true`
### isActive
返回一个布尔值，指示“拖动平移”交互是否处于活动状态，即当前正在使用。
返回如果“拖动进行平移”互动是有效的。**`boolean`** `true`
## DragRotateHandler
在`DragRotateHandler`允许用户通过点击并拖动光标按住鼠标右键或向旋转地图`ctrl`键。
### Parameters
- `options` **`Object`?**
- `mouseRotate` **鼠标旋转处理程序**
- `mousePitch` **鼠标音调处理程序**
### enable
启用“拖动旋转”交互。
#### Examples
```
map.dragRotate.enable();
```
### disable
禁用“拖动旋转”交互。
#### Examples
```
map.dragRotate.disable();
```
### isEnabled
返回一个布尔值，指示是否启用“拖动旋转”交互。
如果启用了“拖动旋转”交互，则返回。**`boolean`** `true`
### isActive
返回一个布尔值，指示“拖动旋转”交互是否处于活动状态，即当前正在使用。
返回如果“拖动以旋转”互动是有效的。**`boolean`** `true`
## TouchZoomRotateHandler
将`TouchZoomRotateHandler`允许用户放大和捏在触摸屏上旋转地图。
他们可以通过双击和拖动用一根手指进行缩放。在第二次点击时，按住手指并向上或向下拖动以放大或缩小。
### Parameters
- `el` **`HTMLElement`**
- `touchZoom` **TouchZoomHandler**
- `touchRotate` **TouchRotateHandler**
- `tapDragZoom` **TapDragZoomHandler**
### enable
启用“捏合旋转和缩放”交互。
#### Parameters
- `options` **`Object`?** 选项对象。
- `options.around` **`string`?** 如果传递“center”，地图将围绕中心缩放
#### Examples
```
map.touchZoomRotate.enable();
```
```
map.touchZoomRotate.enable({ around: 'center' });
```
### disable
禁用“捏合旋转和缩放”交互。
#### Examples
```
map.touchZoomRotate.disable();
```
### isEnabled
返回一个布尔值，指示是否启用了“捏合旋转和缩放”交互。
返回如果“掐去旋转和缩放”启用互动。**`boolean`** `true`
### isActive
如果处理程序已启用并检测到缩放/旋转手势的开始，则返回 true。
返回 **`boolean`**
### disableRotation
禁用“捏合旋转”交互，启用“捏合缩放”交互。
#### Examples
```
map.touchZoomRotate.disableRotation();
```
### enableRotation
启用“捏合旋转”交互。
#### Examples
```
map.touchZoomRotate.enable();
map.touchZoomRotate.enableRotation();
```
## CameraOptions
常见的选项`地图＃jumpTo`，`地图＃easeTo`和`地图＃一个FlyTo`，控制摄像机的所需位置，缩放，轴承，和俯仰。所有属性都是可选的，当省略某个属性时，该属性的当前相机值将保持不变。
类型： `Object`
### Properties
- `center` **[LngLatLike][284]**所需的中心。
- `zoom` **`number`** 所需的缩放级别。
- `bearing` **`number`**以度为单位的所需方位。方位是“向上”的罗盘方向。例如，`bearing: 90`调整地图的方向，使东方朝上。
- `pitch` **`number`**所需的度数。俯仰角是与地平线的角度，以度为单位，范围在 0 到 60 度之间。例如，pitch: 0 提供了直视地图的外观，而 pitch: 60 使用户的视角向地平线倾斜。增加间距值通常用于显示 3D 对象。
- `around` **[LngLatLike][284]**如果`zoom`指定，则`around`确定缩放的中心点。
- `padding` **[PaddingOptions][196]**应用在视口每一侧以移动消失点的尺寸（以像素为单位）。
### Examples
```
// set the map's initial perspective with CameraOptions
var map = new vjmap.Map({
container: 'map',
style: 'your style',
center: [-73.5804, 45.53483],
pitch: 60,
bearing: -60,
zoom: 10
});
```
## AnimationOptions
涉及动画的地图移动方法常见的选项，例如`Map#panBy`和 `Map#easeTo`，控制动画的持续时间`和缓动`功能。所有属性都是可选的。
类型： `Object`
### Properties
- `duration` **`number`** 动画的持续时间，以毫秒为单位。
- `easing` **函数**一个函数在 0..1 范围内花费时间并返回一个数字，其中 0 是初始状态，1 是最终状态。
- `offset` 动画结束时目标中心相对于真实地图容器中心的**[PointLike][166]**。
- `animate` **`boolean`**如果`false`，则不会发生动画。
- `essential` **`boolean`**如果`true`，则动画被认为是必不可少的，不会受到 ``prefers-reduced-motion` `.
## PaddingOptions
用于在调用`Map#fitBounds`、`Map#fitScreenCoordinates`和`Map#setPadding`等方法时设置填充的选项。调整这些选项以设置添加到画布边缘的像素填充量。在所有边缘或每个边缘的单个值上设置统一的填充。此对象的所有属性必须是非负整数。
类型： `Object`
### Properties
- `top` **`number`** 从地图画布顶部以像素为单位的填充。
- `bottom` **`number`** 以像素为单位从地图画布底部填充。
- `left` **`number`** 从地图画布左侧以像素为单位的填充。
- `right` **`number`** 从地图画布右侧以像素为单位的填充。
### Examples
```
var bbox = [[-79, 43], [-73, 45]];
map.fitBounds(bbox, {
padding: {top: 10, bottom:25, left: 15, right: 5}
});
```
```
var bbox = [[-79, 43], [-73, 45]];
map.fitBounds(bbox, {
padding: 20
});
```
## NavigationControl
一个`NavigationControl`控件包含缩放按钮和一个指南针。使用`Map#addControl`将此控件添加到地图。
### Parameters
- `options` **`Object`?**
- `options.showCompass` **`布尔值 `**如果`true`包含指南针按钮。（可选，默认`true`）
- `options.showZoom` **`布尔值 `**如果`true`包括放大和缩小按钮。（可选，默认`true`）
- `options.visualizePitch` **`布尔值 `**如果`true`通过旋转罗盘的 X 轴来可视化俯仰。（可选，默认`false`）
### Examples
```
var nav = new vjmap.NavigationControl();
map.addControl(nav, 'top-left');
```
## GeolocateControl
**扩展事件**
一个`GeolocateControl`控件提供了使用浏览器的地理位置API，以在地图上定位用户的按钮。使用`Map#addControl`将此控件添加到地图。
并非所有浏览器都支持地理定位，一些用户可能会禁用该功能。对包括 Chrome 在内的现代浏览器的地理定位支持要求站点通过 HTTPS 提供服务。如果地理定位支持不可用，则 GeolocateControl 将显示为禁用。
应用的缩放级别将取决于设备提供的地理位置的准确性。
GeolocateControl 有两种模式。如果`trackUserLocation`是`false`（默认），则控件充当按钮，按下按钮时会将地图的相机设置为定位用户位置。如果用户移动，地图将不会更新。这最适合桌面。如果`trackUserLocation`是`true`，控制作为一个拨动按钮活性当用户的位置被主动监视更改。在这种模式下 GeolocateControl 具有三种交互状态：
- active - 随着用户位置的变化，地图的相机会自动更新，将位置点保持在中心。初始状态和单击`GeolocateControl`按钮时。
- 被动 - 用户的位置点会自动更新，但地图的相机不会。在用户启动地图移动时发生。
- 禁用 - 如果地理位置不可用、禁用或被拒绝，则会发生。
这些交互状态不能以编程方式控制，而是根据用户交互设置。
### Parameters
- `options` **`Object`?**
- `options.positionOptions` **`Object`**地理定位 API `PositionOptions `目的。（可选，默认`{enableHighAccuracy:false,timeout:6000}`）
- `options.fitBoundsOptions` **`Object`**一个`Map#fitBounds`选项对象，当地图被平移和缩放到用户的位置时使用。默认值是使用`maxZoom`15 来限制地图为非常准确的位置放大的距离。（可选，默认`{maxZoom:15}`）
- `options.trackUserLocation` **`Object`**如果`true`Geolocate Control 变成一个切换按钮，并且当它处于活动状态时，地图将随着用户位置的变化接收更新。（可选，默认`false`）
- `options.showAccuracyCircle` **`Object`**默认情况下，如果 showUserLocation 为`true`，则会在用户位置周围绘制一个透明圆圈，指示用户位置的准确性（95% 置信度）。设置`false`为禁用。当 showUserLocation 为 时始终禁用`false`。（可选，默认`true`）
- `options.showUserLocation` **`Object`**默认情况下，用户所在位置的地图上将显示一个点。设置`false`为禁用。（可选，默认`true`）
### Examples
```
map.addControl(new vjmap.GeolocateControl({
positionOptions: {
enableHighAccuracy: true
},
trackUserLocation: true
}));
```
### trigger
以编程方式请求地图并将其移动到用户的位置。
#### Examples
```
// Initialize the geolocate control.
var geolocate = new vjmap.GeolocateControl({
positionOptions: {
enableHighAccuracy: true
},
trackUserLocation: true
});
// Add the control to the map.
map.addControl(geolocate);
map.on('load', function() {
geolocate.trigger();
});
```
返回**`boolean`**返回`false`如果之前控制被添加到地图叫，否则返回`true`。
### geolocate
在每次成功返回的 Geolocation API 位置更新上触发。
#### Properties
- `data` **`位置 `**返回的`位置 ``Geolocation.getCurrentPosition()`回调中的对象 ``或`Geolocation.watchPosition() `.
#### Examples
```
// Initialize the geolocate control.
var geolocate = new vjmap.GeolocateControl({
positionOptions: {
enableHighAccuracy: true
},
trackUserLocation: true
});
// Add the control to the map.
map.addControl(geolocate);
// Set an event listener that fires
// when a geolocate event occurs.
geolocate.on('geolocate', function() {
console.log('A geolocate event has occurred.')
});
```
### error
在作为错误返回的每个 Geolocation API 位置更新时触发。
#### Properties
- `data` **`位置误差 `**返回的`PositionError ``Geolocation.getCurrentPosition()`回调中的对象 ``或`Geolocation.watchPosition() `.
#### Examples
```
// Initialize the geolocate control.
var geolocate = new vjmap.GeolocateControl({
positionOptions: {
enableHighAccuracy: true
},
trackUserLocation: true
});
// Add the control to the map.
map.addControl(geolocate);
// Set an event listener that fires
// when an error event occurs.
geolocate.on('error', function() {
console.log('An error event has occurred.')
});
```
### outofmaxbounds
在每个 Geolocation API 位置更新时触发，该位置更新返回成功，但用户位置超出地图 maxBounds。
#### Properties
- `data` **`位置 `**返回的`位置 ``Geolocation.getCurrentPosition()`回调中的对象 ``或`Geolocation.watchPosition() `.
#### Examples
```
// Initialize the geolocate control.
var geolocate = new vjmap.GeolocateControl({
positionOptions: {
enableHighAccuracy: true
},
trackUserLocation: true
});
// Add the control to the map.
map.addControl(geolocate);
// Set an event listener that fires
// when an outofmaxbounds event occurs.
geolocate.on('outofmaxbounds', function() {
console.log('An outofmaxbounds event has occurred.')
});
```
### trackuserlocationstart
当 Geolocate Control 更改为活动锁定状态时触发，该状态发生在第一次为用户成功获取 Geolocation API 位置时（随后将发生 geolocate 事件），或者用户在使用最后一个的后台状态时单击 geolocate 按钮已知位置重新定位地图并进入活动锁定状态（除非用户的位置发生变化，否则不会发生地理定位事件）。
#### Examples
```
// Initialize the geolocate control.
var geolocate = new vjmap.GeolocateControl({
positionOptions: {
enableHighAccuracy: true
},
trackUserLocation: true
});
// Add the control to the map.
map.addControl(geolocate);
// Set an event listener that fires
// when a trackuserlocationstart event occurs.
geolocate.on('trackuserlocationstart', function() {
console.log('A trackuserlocationstart event has occurred.')
});
```
### trackuserlocationend
当 Geolocate Control 更改为后台状态时触发，当用户在活动位置锁定期间更改相机时会发生这种情况。这仅在 trackUserLocation 为 true 时适用。在后台状态下，地图上的点会随着位置更新而更新，但相机不会。
#### Examples
```
// Initialize the geolocate control.
var geolocate = new vjmap.GeolocateControl({
positionOptions: {
enableHighAccuracy: true
},
trackUserLocation: true
});
// Add the control to the map.
map.addControl(geolocate);
// Set an event listener that fires
// when a trackuserlocationend event occurs.
geolocate.on('trackuserlocationend', function() {
console.log('A trackuserlocationend event has occurred.')
});
```
## AttributionControl
一个`AttributionControl`控件显示地图的`属性信息`. 使用`Map#addControl`将此控件添加到地图。
### Parameters
- `options` **`Object`?** （可选，默认`{}`）
- `options.compact` **`boolean`?** 如果`true`，则强制使用紧凑属性，在鼠标悬停时显示完整属性。如果`false`，则强制执行完全归因控制。默认为响应式属性，当地图宽度小于 640 像素时会折叠。**如果可以轻松地放置在地图上，则不应折叠归因。`compact`仅当地图大小无法适应`默认属性`时，才应用于修改`默认属性` 当默认设置的自动紧凑调整大小不够时。**
- `options.customAttribution` **( `string`| `Array`< `string`\>)？**除了任何其他属性之外要显示的一个或多个字符串。您还可以在使用`customAttribution 选项`初始化地图时设置自定义属性 ``.
### Examples
```
var map = new vjmap.Map({attributionControl: false})
.addControl(new vjmap.AttributionControl({
customAttribution: 'Map design by me'
}));
```
## ScaleControl
甲`ScaleControl`控制显示的距离的地图可以在地面上对应的距离上的比率。使用`Map#addControl`将此控件添加到地图。
### Parameters
- `options` **`Object`?**
- `options.maxWidth` **`number`**缩放控件的最大长度（以像素为单位）。（可选，默认`'100'`）
- `options.unit` **`string`**距离单位（`'imperial'`、`'metric'`或`'nautical'`）。（可选，默认`'metric'`）
### Examples
```
var scale = new vjmap.ScaleControl({
maxWidth: 80,
unit: 'imperial'
});
map.addControl(scale);
scale.setUnit('metric');
```
### setUnit
设置距离的比例单位
#### Parameters
- `unit` **Unit**距离的单位（`'imperial'`、`'metric'`或`'nautical'`）。
## FullscreenControl
甲`FullscreenControl`控制包含用于进出的全屏模式切换地图的按钮。查看`requestFullScreen` `兼容性表 ](https://developer.mozilla.org/en-US/docs/Web/API/Element/requestFullScreen#browser_compatibility)对于支持的浏览器。使用[Map#addControl`将此控件添加到地图。
### Parameters
- `options` **`Object`?**
- `options.container` **`HTMLElement`?** `container`是`兼容的 DOM 元素 `这应该是全屏的。默认情况下，地图容器元素将全屏显示。
### Examples
```
map.addControl(new vjmap.FullscreenControl({container: document.querySelector('body')}));
```
## Popup
**扩展事件**
一个弹出组件。
### Parameters
- `options` **`Object`?**
- `options.closeButton` **`boolean`**如果`true`，弹出窗口的右上角将出现一个关闭按钮。（可选，默认`true`）
- `options.closeOnClick` **`boolean`**如果`true`，则单击地图时将关闭弹出窗口。（可选，默认`true`）
- `options.closeOnMove` **`boolean`**如果`true`，则当地图移动时弹出窗口将关闭。（可选，默认`false`）
- `options.focusAfterOpen` **`boolean`**如果`true`，则弹出窗口将尝试聚焦弹出窗口内的第一个可聚焦元素。（可选，默认`true`）
- `options.anchor` **`string`?** 一个字符串，指示应该通过`Popup#setLngLat`定位到最接近坐标集的`Popup 部分`。选项包括`'center'`，`'top'`，`'bottom'`，`'left'`，`'right'`，`'top-left'`， `'top-right'`，`'bottom-left'`，和`'bottom-right'`。如果未设置，锚点将被动态设置以确保弹出窗口位于地图容器内，并且优先选择`'bottom'`。
- `options.offset` **( `number`| [PointLike][166] | `Object`)？** 应用于弹出窗口位置的像素偏移指定为：- 指定与弹出窗口位置距离的单个数字
- 指定常量偏移量的[PointLike][166]
- [Point][165] s的对象，指定每个锚点位置的偏移量负偏移表示向左和向上。
- `options.className` **`string`?** 添加到弹出容器的以空格分隔的 CSS 类名
- `options.maxWidth` **`string`** 设置弹出窗口最大宽度的 CSS 属性的字符串，例如`'300px'`. 要确保弹出窗口调整大小以适合其内容，请将此属性设置为`'none'`。可用值可以在这里找到：`https` : `//developer.mozilla.org/en-US/docs/Web/CSS/max-width `（可选，默认`'240px'`）
### Examples
```
var markerHeight = 50, markerRadius = 10, linearOffset = 25;
var popupOffsets = {
'top': [0, 0],
'top-left': [0,0],
'top-right': [0,0],
'bottom': [0, -markerHeight],
'bottom-left': [linearOffset, (markerHeight - markerRadius + linearOffset) * -1],
'bottom-right': [-linearOffset, (markerHeight - markerRadius + linearOffset) * -1],
'left': [markerRadius, (markerHeight - markerRadius) * -1],
'right': [-markerRadius, (markerHeight - markerRadius) * -1]
};
var popup = new vjmap.Popup({offset: popupOffsets, className: 'my-class'})
.setLngLat(e.lngLat)
.setHTML("<h1>Hello World!</h1>")
.setMaxWidth("300px")
.addTo(map);
```
### addTo
将弹出窗口添加到地图。
#### Parameters
- `map` **[Map][1]**要添加弹出窗口的地图。
#### Examples
```
new vjmap.Popup()
.setLngLat([0, 0])
.setHTML("<h1>Null Island</h1>")
.addTo(map);
```
返回**`弹出窗口`** `this`
### isOpen
如果弹出窗口是打开的，如果它是关闭的，则返回。**`boolean`** `true``false`
### remove
从已添加到的地图中删除弹出窗口。
#### Examples
```
var popup = new vjmap.Popup().addTo(map);
popup.remove();
```
返回**`弹出窗口`** `this`
### getLngLat
返回弹出窗口锚点的地理位置。
结果的经度可能与先前设置的经度相差 360 度的倍数，`setLngLat`因为`Popup`将锚定经度包装在世界的副本上以保持弹出窗口在屏幕上。
返回**[LngLat][230]**弹出窗口锚点的地理位置。
### setLngLat
设置弹出窗口锚点的地理位置，并将弹出窗口移动到它。替换 trackPointer() 行为。
#### Parameters
- `lnglat` **[LngLatLike][284]**设置为弹出窗口锚点的地理位置。
返回**`弹出窗口`** `this`
### trackPointer
使用指针设备将弹出锚点跟踪到屏幕上的光标位置（它将在触摸屏上隐藏）。替换`setLngLat`行为。对于大多数用例，将`closeOnClick`和设置`closeButton`为`false`。
#### Examples
```
var popup = new vjmap.Popup({ closeOnClick: false, closeButton: false })
.setHTML("<h1>Hello World!</h1>")
.trackPointer()
.addTo(map);
```
返回**`弹出窗口`** `this`
### getElement
返回`Popup`的 HTML 元素。
#### Examples
```
// Change the `Popup` element's font size
var popup = new vjmap.Popup()
.setLngLat([-96, 37.8])
.setHTML("<p>Hello World!</p>")
.addTo(map);
var popupElem = popup.getElement();
popupElem.style.fontSize = "25px";
```
返回**`HTMLElement`**元素
### setText
将弹出窗口的内容设置为一串文本。
此函数创建一个`文本 `DOM 中的节点，因此它无法插入原始 HTML。如果弹出内容是用户提供的，请使用此方法来防止 XSS。
#### Parameters
- `text` **`string`** 弹出窗口的文本内容。
#### Examples
```
var popup = new vjmap.Popup()
.setLngLat(e.lngLat)
.setText('Hello, world!')
.addTo(map);
```
返回**`弹出窗口`** `this`
### setHTML
将弹出窗口的内容设置为作为字符串提供的 HTML。
此方法不执行 HTML 过滤或清理，并且必须仅用于受信任的内容。如果内容是不受信任的文本字符串，请考虑`Popup#setText`。
#### Parameters
- `html` **`string`** 表示弹出窗口的 HTML 内容的字符串。
#### Examples
```
var popup = new vjmap.Popup()
.setLngLat(e.lngLat)
.setHTML("<h1>Hello World!</h1>")
.addTo(map);
```
返回**`弹出窗口`** `this`
### getMaxWidth
返回弹出窗口的最大宽度。
返回**`string`**弹出窗口的最大宽度。
### setMaxWidth
设置弹出窗口的最大宽度。这是设置 CSS 属性`max-width`。可用值可以在这里找到：`https` : `//developer.mozilla.org/en-US/docs/Web/CSS/max-width `
#### Parameters
- `maxWidth` **`string`** 表示最大宽度值的字符串。
返回**`弹出窗口`** `this`
### setDOMContent
将弹出窗口的内容设置为作为 DOM 节点提供的元素。
#### Parameters
- `htmlNode` **`节点 `** 用作弹出窗口内容的 DOM 节点。
#### Examples
```
// create an element with the popup content
var div = window.document.createElement('div');
div.innerHTML = 'Hello, world!';
var popup = new vjmap.Popup()
.setLngLat(e.lngLat)
.setDOMContent(div)
.addTo(map);
```
返回**`弹出窗口`** `this`
### addClassName
将 CSS 类添加到弹出式容器元素。
#### Parameters
- `className` **`string`** 要添加到弹出式容器的具有 CSS 类名的非空字符串
#### Examples
```
let popup = new vjmap.Popup()
popup.addClassName('some-class')
```
### removeClassName
从弹出式容器元素中删除 CSS 类。
#### Parameters
- `className` **`string`** 要从弹出式容器中删除的具有 CSS 类名的非空字符串
#### Examples
```
let popup = new vjmap.Popup()
popup.removeClassName('some-class')
```
### setOffset
设置弹出窗口的偏移量。
#### Parameters
- `offset` **抵消？**设置弹出窗口的偏移量。
返回**`弹出窗口`** `this`
### toggleClassName
在弹出容器上添加或删除给定的 CSS 类，具体取决于容器当前是否具有该类。
#### Parameters
- `className` **`string`** 要添加/删除的带有 CSS 类名的非空字符串
#### Examples
```
let popup = new vjmap.Popup()
popup.toggleClassName('toggleClass')
```
返回**`boolean`**如果取出假回报类，如果加入的类，然后返回true
### open
当手动或以编程方式打开弹出窗口时触发。
类型： `Object`
#### Properties
- `popup` 已打开的**`弹出`**对象
#### Examples
```
// Create a popup
var popup = new vjmap.Popup();
// Set an event listener that will fire
// any time the popup is opened
popup.on('open', function(){
console.log('popup was opened');
});
```
### close
当手动或以编程方式关闭弹出窗口时触发。
类型： `Object`
#### Properties
- `popup` 已关闭的**`弹出`**对象
#### Examples
```
// Create a popup
var popup = new vjmap.Popup();
// Set an event listener that will fire
// any time the popup is closed
popup.on('close', function(){
console.log('popup was closed');
});
```
## MapMouseEvent
**扩展对象**
`MapMouseEvent`是其他类使用的类，用于生成特定类型的鼠标事件，例如“单击”或“悬停”。有关可用事件的完整列表，请参阅``Map`events`。
### Parameters
- `type` **`string`**
- `map` **`地图`**
- `originalEvent` **`鼠标事件 `**
- `data` **`Object`** （可选，默认`{}`）
### Examples
```
// Example of a MapMouseEvent of type "click"
{
lngLat: {
lng: 40.203,
lat: -74.451
},
originalEvent: {...},
point: {
x: 266,
y: 464
},
target: {...},
type: "click"
}
```
### type
始发事件的类型。有关可用事件的完整列表，请参阅``Map`events`。
类型：（`"mousedown"`| `"mouseup"`| `"click"`| `"dblclick"`| `"mousemove"`| `"mouseover"`| `"mouseenter"`| `"mouseleave"`| `"mouseout"`| `"contextmenu"`）
### target
`Map`触发事件的对象。
类型：`地图`
### originalEvent
引发地图事件的 DOM 事件。
类型：`鼠标事件 `
### point
鼠标光标的像素坐标，相对于地图并从左上角开始测量。
类型：`点`
### LngLat
鼠标光标在地图上的地理位置。
类型：[LngLat][230]
### preventDefault
阻止地图对事件的后续默认处理。
调用此方法将阻止以下默认地图行为：
- 在`mousedown`事件上，`DragPanHandler][191]的行为[`
- 在`mousedown`事件上，`DragRotateHandler][192]的行为[`
- 在`mousedown`事件上，`BoxZoomHandler][178]的行为[`
- 在`dblclick`事件上，`DoubleClickZoomHandler][190]的行为[`
## MapTouchEvent
**扩展对象**
`MapTouchEvent`是其他类用来生成特定类型的鼠标事件的类，例如“touchstart”或“touchend”。有关可用事件的完整列表，请参阅``Map`events`。
### Parameters
- `type` **`string`**
- `map` **`地图`**
- `originalEvent` **`触摸事件 `**
### Examples
```
// Example of a MapTouchEvent of type "touch"
{
lngLat: {
lng: 40.203,
lat: -74.451
},
lngLats: [
{
lng: 40.203,
lat: -74.451
}
],
originalEvent: {...},
point: {
x: 266,
y: 464
},
points: [
{
x: 266,
y: 464
}
]
preventDefault(),
target: {...},
type: "touchstart"
}
```
### type
始发事件的类型。有关可用事件的完整列表，请参阅``Map`events`。
类型：( `"touchstart"`| `"touchend"`| `"touchcancel"`)
### target
`Map`触发事件的对象。
类型：`地图`
### originalEvent
引发地图事件的 DOM 事件。
类型：`触摸事件 `
### LngLat
地图上触摸事件点中心的地理位置。
类型：[LngLat][230]
### point
触摸事件点中心的像素坐标，相对于地图，从左上角开始测量。
类型：`点`
### points
对应于`触摸事件的`像素坐标数组 ``touches`` 财产。
类型：`Array`<`点`\>
### lngLats
地图上对应于`触摸事件的`地理位置 ``touches`` 财产。
类型：`Array`< [LngLat][230] >
### preventDefault
阻止地图对事件的后续默认处理。
调用此方法将阻止以下默认地图行为：
- 在`touchstart`事件上，`DragPanHandler][191]的行为[`
- 在`touchstart`事件上，`TouchZoomRotateHandler][193]的行为[`
## MapWheelEvent
**扩展对象**
`MapWheelEvent`是其他类用来生成特定类型的鼠标事件（例如“轮”）的类。有关可用事件的完整列表，请参阅``Map`events`。
### Parameters
- `type` **`string`**
- `map` **`地图`**
- `originalEvent` **`轮事件 `**
### Examples
```
// Example of a MapWheelEvent of type "wheel"
{
originalEvent: WheelEvent {...},
target: Map {...},
type: "wheel"
}
```
### type
始发事件的类型。有关可用事件的完整列表，请参阅``Map`events`。
类型： `"wheel"`
### target
`Map`触发事件的对象。
类型：`地图`
### originalEvent
引发地图事件的 DOM 事件。
类型：`WheelEvent `
### preventDefault
阻止地图对事件的后续默认处理。
调用此方法将阻止[ScrollZoomHandler][187]的行为。
## ZoomEvent
`ZoomEvent`是其他类用来生成特定类型的鼠标事件的类，例如“boxzoomstart”或“boxzoomend”。有关可用事件的完整列表，请参阅``Map`events`。
类型： `Object`
### Properties
- `originalEvent` **`鼠标事件 `**触发 boxzoom 事件的 DOM 事件。可以是一个`MouseEvent`或`KeyboardEvent`
- `type` **`string`**始发事件的类型。有关可用事件的完整列表，请参阅``Map`events`。
- `target` **[Map][1]**`Map`触发事件的实例
### Examples
```
// Example of a BoxZoomEvent of type "boxzoomstart"
{
originalEvent: {...},
type: "boxzoomstart",
target: {...}
}
```
## MapDataEvent
`MapDataEvent`是其他类用来生成特定类型的鼠标事件的类，例如“sourcedata”或“dataloading”。有关可用事件的完整列表，请参阅``Map`events`。
类型： `Object`
### Properties
- `type` **`string`**始发事件的类型。有关可用事件的完整列表，请参阅``Map`events`。
- `dataType` **`string`**已更改的数据类型。一个`'source'`或`'style'`，其中`'source'`是指与任何源相关联的数据，以及`'style'`指的是整个`的风格` 被地图使用。
- `isSourceLoaded` **`boolean`?** 如果事件有一个`dataType`，`source`并且源没有未完成的网络请求，则为真。
- `source` **`Object`?** `源`的`样式规范表示 `如果事件有一个`dataType`的`source`。
- `sourceDataType` **`string`?** 如果事件具有`dataType`of`source`并且事件表示内部数据已被接收或更改，则包括在内。可能的值为`metadata`、`content`和`visibility`。
- `tile` **`Object`?** 正在加载或更改的图块，如果事件具有`dataType`of`source`并且该事件与图块的加载相关。
- `coord` **协调？**如果事件有瓷砖的坐标`dataType`的`source`，而该事件涉及到瓷砖的负载。
### Examples
```
// Example of a MapDataEvent of type "sourcedata"
{
dataType: "source",
isSourceLoaded: false,
source: {
type: "vector",
url: "your url"
},
sourceDataType: "visibility",
sourceId: "composite",
style: {...},
target: {...},
type: "sourcedata"
}
```
## Marker
**扩展事件**
创建一个标记组件
### Parameters
- `options` **`Object`?**
- `options.element` **`HTMLElement`?** 用作标记的 DOM 元素。默认为浅蓝色、水滴状的 SVG 标记。
- `options.anchor` **`string`**一个字符串，指示应该通过`Marker#setLngLat`定位到最接近坐标集的`Marker 部分`。选项包括`'center'`，`'top'`，`'bottom'`，`'left'`，`'right'`，`'top-left'`，`'top-right'`，`'bottom-left'`，和`'bottom-right'`。（可选，默认`'center'`）
- `options.offset` **`点像`?** 以像素为单位的偏移量，作为要应用的[PointLike][166]对象相对于元素的中心。负数表示向左和向上。
- `options.color` **`string`**如果未提供 options.element，则用于默认标记的颜色。默认为浅蓝色。（可选，默认`'#3FB1CE'`）
- `options.scale` **`number`**如果未提供 options.element，则用于默认标记的比例。默认比例对应于 的高度`41px`和宽度`27px`。（可选，默认`1`）
- `options.draggable` **`boolean`**一个布尔值，指示是否可以将标记拖动到地图上的新位置。（可选，默认`false`）
- `options.clickTolerance` **`number`**用户在点击标记期间可以移动鼠标指针的最大像素数，以便将其视为有效点击（与标记拖动相反）。默认是继承地图的clickTolerance。（可选，默认`0`）
- `options.rotation` **`number`**标记相对于其各自`rotationAlignment`设置的旋转角度（以度为单位）。正值将顺时针旋转标记。（可选，默认`0`）
- `options.pitchAlignment` **`string`** `map`将 与`Marker`地图平面对齐。`viewport`将 与`Marker`视口平面对齐。`auto`自动匹配 的值`rotationAlignment`。（可选，默认`'auto'`）
- `options.rotationAlignment` **`string`** `map`对齐`Marker`相对于地图的旋转，在地图旋转时保持方位角。相对于视口`viewport`对齐`Marker`的旋转，与地图旋转无关。`auto`相当于`viewport`。（可选，默认`'auto'`）
- `legacyOptions` **选项？**
### Examples
```
var marker = new vjmap.Marker()
.setLngLat([30.5, 50.5])
.addTo(map);
```
```
// Set options
var marker = new vjmap.Marker({
color: "#FFFFFF",
draggable: true
}).setLngLat([30.5, 50.5])
.addTo(map);
```
### addTo
将 附加`Marker`到`Map`对象。
#### Parameters
- `map` **[Map][1]**要添加标记的地图。
#### Examples
```
var marker = new vjmap.Marker()
.setLngLat([30.5, 50.5])
.addTo(map); // add the marker to the map
```
返回**`标记`** `this`
### remove
从地图上移除标记
#### Examples
```
var marker = new vjmap.Marker().addTo(map);
marker.remove();
```
返回**`标记`** `this`
### getLngLat
获取标记的地理位置。
结果的经度可能与之前设置的经度相差 360 度的倍数，`setLngLat`因为`Marker`将锚定经度包裹在世界的副本上以将标记保留在屏幕上。
#### Examples
```
// Store the marker's longitude and latitude coordinates in a variable
var lngLat = marker.getLngLat();
// Print the marker's longitude and latitude values in the console
console.log('Longitude: ' + lngLat.lng + ', Latitude: ' + lngLat.lat )
```
返回**[LngLat][230]**一个[LngLat][230]描述标记的位置。
### setLngLat
设置标记的地理位置并移动它。
#### Parameters
- `lnglat` **[LngLat][230]**甲[LngLat][230]描述将标记应位于。
#### Examples
```
// Create a new marker, set the longitude and latitude, and add it to the map
new vjmap.Marker()
.setLngLat([-65.017, -16.457])
.addTo(map);
```
返回**`标记`** `this`
### getElement
返回`Marker`的 HTML 元素。
返回**`HTMLElement`**元素
### setPopup
将[Popup][208]绑定到[Marker][238]。
#### Parameters
- `popup` **`弹出窗口`？**[Popup][208]类的一个实例。如果未定义或为空，则在此[Marker][238]实例上设置的任何弹出窗口都未设置。
#### Examples
```
var marker = new vjmap.Marker()
.setLngLat([0, 0])
.setPopup(new vjmap.Popup().setHTML("<h1>Hello World!</h1>")) // add popup
.addTo(map);
```
返回**`标记`** `this`
### getPopup
返回绑定到`Marker][238]的[Popup][208]实例。[`
#### Examples
```
var marker = new vjmap.Marker()
.setLngLat([0, 0])
.setPopup(new vjmap.Popup().setHTML("<h1>Hello World!</h1>"))
.addTo(map);
console.log(marker.getPopup()); // return the popup instance
```
返回**`弹出`**窗口
### togglePopup
打开或关闭`弹出`绑定到该实例`标记`，这取决于当前的状态`弹出`。
#### Examples
```
var marker = new vjmap.Marker()
.setLngLat([0, 0])
.setPopup(new vjmap.Popup().setHTML("<h1>Hello World!</h1>"))
.addTo(map);
marker.togglePopup(); // toggle popup open or closed
```
返回**`标记`** `this`
### getOffset
获取标记的偏移量。
返回**[Point][165]**标记的屏幕坐标（以像素为单位）。
### setOffset
设置标记的偏移量
#### Parameters
- `offset` **[PointLike][166]**作为要应用的[PointLike][166]对象相对于元素中心的偏移量（以像素为单位）。负数表示向左和向上。
返回**`标记`** `this`
### setDraggable
设置`draggable`标记的属性和功能
#### Parameters
- `shouldBeDraggable` **`boolean`**打开/关闭拖动功能（可选，默认`false`）
返回**`标记`** `this`
### isDraggable
如果可以拖动标记，则返回 true
**`boolean`**如果标记是可拖动的，则返回True。
### setRotation
设置`rotation`标记的属性。
#### Parameters
- `rotation` **`number`**标记的旋转角度（顺时针，以度为单位），相对于其各自的`Marker#setRotationAlignment`设置。（可选，默认`0`）
返回**`标记`** `this`
### getRotation
返回标记的当前旋转角度（以度为单位）。
返回**`number`**标记的当前旋转角度。
### setRotationAlignment
设置`rotationAlignment`标记的属性。
#### Parameters
- `alignment` **`string`**设置`rotationAlignment`标记的属性。（可选，默认`'auto'`）
返回**`标记`** `this`
### getRotationAlignment
返回`rotationAlignment`标记的当前属性。
返回**`string`**标记的当前旋转对齐方式。
### setPitchAlignment
设置`pitchAlignment`标记的属性。
#### Parameters
- `alignment` **`string`?** 设置`pitchAlignment`标记的属性。如果对齐是“自动”，它会自动匹配`rotationAlignment`。
返回**`标记`** `this`
### getPitchAlignment
返回`pitchAlignment`标记的当前属性。
返回**`string`**标记的当前音高对齐（以度为单位）。
### dragstart
拖动开始时触发
类型： `Object`
#### Properties
- `marker` 被拖动的**`标记`**对象
### drag
拖动时触发
类型： `Object`
#### Properties
- `marker` 被拖动的**`标记`**对象
### dragend
当标记完成拖动时触发
类型： `Object`
#### Properties
- `marker` 被拖动的**`标记`**对象
## StyleImageInterface
动态生成样式图像的界面。这是实现者建模的规范：它不是导出的方法或类。
可以为每一帧重新绘制实现此接口的图像。它们可用于动画图标和图案或使它们响应用户输入。样式图像可以实现 `StyleImageInterface#render`方法。该方法每帧调用一次，可用于更新图像。
### Properties
- `width` **`number`**
- `height` **`number`**
- `data` **( `Uint8Array `| `Uint8ClampedArray `)**
### Examples
```
var flashingSquare = {
width: 64,
height: 64,
data: new Uint8Array(64 * 64 * 4),
onAdd: function(map) {
this.map = map;
},
render: function() {
// keep repainting while the icon is on the map
this.map.triggerRepaint();
// alternate between black and white based on the time
var value = Math.round(Date.now() / 1000) % 2 === 0 ? 255 : 0;
// check if image needs to be changed
if (value !== this.previousValue) {
this.previousValue = value;
var bytesPerPixel = 4;
for (var x = 0; x < this.width; x++) {
for (var y = 0; y < this.height; y++) {
var offset = (y * this.width + x) * bytesPerPixel;
this.data[offset + 0] = value;
this.data[offset + 1] = value;
this.data[offset + 2] = value;
this.data[offset + 3] = 255;
}
}
// return true to indicate that the image changed
return true;
}
}
}
map.addImage('flashing_square', flashingSquare);
```
### render
在将使用图标的每一帧之前调用此方法一次。该方法可以选择`data`使用新图像更新图像的成员。
如果该方法更新图像，它必须返回`true`以提交更改。如果该方法返回`false`或什么都不返回，则假定图像未更改。
如果更新不频繁，使用`Map#updateImage`更新图像而不是实现此方法可能更容易。
如果此方法更新了图像，则返回。如果图像没有改变。**`boolean`** `true``false`
### onAdd
使用`Map#addImage`将图层添加到地图时调用的可选方法。
#### Parameters
- `map` **`地图`**此自定义图层刚刚添加到的地图。
### onRemove
使用`Map#removeImage`从地图中删除图标时调用的可选方法。这使图像有机会清理资源和事件侦听器。
## RequestParameters
`RequestParameters`从 Map.options.transformRequest 回调返回的对象。
类型： `Object`
### Properties
- `url` **`string`** 要请求的 URL。
- `headers` **`Object`** 要与请求一起发送的标头。
- `method` **`string`**请求方法`'GET' | 'POST' | 'PUT'`。
- `body` **`string`** 请求体。
- `type` **`string`**要返回的响应正文类型`'string' | 'json' | 'arrayBuffer'`。
- `credentials` **`string`** `'same-origin'|'include'` 使用 'include' 发送带有跨域请求的 cookie。
- `collectResourceTiming` **`boolean`** 如果为 true，将为这些转换后的请求收集 Resource Timing API 信息，并在相关数据事件的 resourceTiming 属性中返回。
### Examples
```
// use transformRequest to modify requests that begin with `http://myHost`
transformRequest: function(url, resourceType) {
if (resourceType === 'Source' && url.indexOf('http://myHost') > -1) {
return {
url: url.replace('http', 'https'),
headers: { 'my-custom-header': true },
credentials: 'include' // Include cookies for cross-origin requests
}
}
}
```
## QueryGeometry
表示来自 的屏幕空间查询的数据类`Map#queryRenderedFeatures`。所有内部几何图形和数据都旨在是不可变的和只读的。它的生命周期仅适用于查询的持续时间和处理查询时地图的固定状态。
### isPointQuery
如果用户的初始查询是单点，则返回 true
**`boolean`**如果初始查询几何是单个点，则返回True
### bufferedScreenGeometry
由于数据驱动的样式特征不统一大小（例如`circle-radius`），并且可以与其原始位置不同地偏移（例如， with `*-translate`）。这意味着我们必须为每个瓦片扩展我们的查询区域以解释这些属性的变化。每个 tile 在解析时计算一个 tile 级别的最大填充值（以屏幕空间像素为单位），这个函数让我们计算每个 tile 的屏幕空间查询几何的缓冲版本。
#### Parameters
- `buffer` **`number`** 以屏幕空间像素为单位的平铺填充。
返回**`Array`< [Point][165] >**缓冲的查询几何。
### bufferedCameraGeometry
当地图倾斜时，与查询相交的一些 3D 要素将不会在地球表面与查询相交。相反，该特征可能更近，并且仅与查询相交，因为它突出到空中。
这将返回一个几何图形，它是一个凸多边形，它包含查询视锥体和相机下方的点。与 类似`bufferedScreenGeometry`，添加了缓冲以解决油漆属性的变化。
案例1：相机下方的点正好在查询量后面+----------+ | | | | | | \+ + XX XX XX XX XX
情况 2：点在右后方 +---------+ | X | X | XX + X XXX XX XXXX X XXX XX XX X XXX
情况 3：点在左后方 +---------+ X | X | XX | X + X XXXX XX XXX X XXXX X XXXX XXX
#### Parameters
- `buffer` **`number`** 以屏幕空间像素为单位的平铺填充。
返回**`Array`< [Point][165] >**缓冲的查询几何。
### containsTile
检查此查询几何图形中是否包含图块。
#### Parameters
- `tile` **平铺**要检查的平铺。
- `transform` **Transform**当前地图变换。
- `use3D` **`boolean`** 指示是否查询 3D 特征的布尔值。
返回**TilespaceQueryGeometry？**如果 tile 不相交，则返回 undefined
### bufferedscreenmercator
这些方法在由`Transform#pointCoordinate3d`. 图块具有不同的填充值，但是很可能多个图块根据样式共享相同的填充值。在这种情况下，我们希望重用先前计算的地形射线投射的结果。
#### Parameters
- `padding` **`number`**
- `transform` **转换**
返回**`Array`<`墨卡托坐标`\>**
### createFromScreenPoints
帮助构建实例同时考虑当前地图状态的工厂方法。
#### Parameters
- `geometry` **( [PointLike][166] | \` [PointLike` , [PointLike][166] \])**查询几何。
- `transform` **Transform**当前地图变换。
返回**[QueryGeometry][253]** QueryGeometry 类的实例。
## VectorTileSource
**扩展事件**
包含`矢量瓦片格式`矢量瓦片的源 ``. （见`样式规范` 有关选项的详细文档。）
### Parameters
- `id` **`string`**
- `options` **任何**
- `dispatcher` **调度员**
- `eventedParent` **`事件发生`**
### Examples
```
map.addSource('some id', {
type: 'vector',
url: 'your url'
});
```
```
map.addSource('some id', {
type: 'vector',
tiles: ['https://xxx/{z}/{x}/{y}.mvt'],
minzoom: 6,
maxzoom: 14
});
```
```
map.getSource('some id').setUrl("your url");
```
```
map.getSource('some id').setTiles(['https://xxx/{z}/{x}/{y}.mvt']);
```
### setTiles
设置源`tiles`属性并重新渲染地图。
#### Parameters
- `tiles` **`Array`< `string`\>**一个或多个图块源 URL 的数组，如 TileJSON 规范中所示。
返回**[VectorTileSource][260]**这个
### setUrl
设置源`url`属性并重新渲染地图。
#### Parameters
- `url` **`string`**TileJSON 资源的 URL。支持的协议是`http:`，`https:`。
返回**[VectorTileSource][260]**这个
## VideoSource
**扩展图像源**
包含视频的数据源。（见`样式规范` 有关选项的详细文档。）
### Parameters
- `id` **`string`**
- `options` **视频源规范**
- `dispatcher` **调度员**
- `eventedParent` **`事件发生`**
### Examples
```
// add to map
map.addSource('some id', {
type: 'video',
url: [
'http://xxx.mp4',
'https://xxx.webm'
],
coordinates: [
[-76.54, 39.18],
[-76.52, 39.18],
[-76.52, 39.17],
[-76.54, 39.17]
]
});
// update
var mySource = map.getSource('some id');
mySource.setCoordinates([
[-76.54335737228394, 39.18579907229748],
[-76.52803659439087, 39.1838364847587],
[-76.5295386314392, 39.17683392507606],
[-76.54520273208618, 39.17876344106642]
]);
map.removeSource('some id'); // remove
```
### pause
暂停视频。
### play
播放视频。
### getVideo
返回 HTML`video`元素。
返回**`HTMLVideoElement `**HTML`video`元素。
### setCoordinates
设置视频的坐标并重新渲染地图。
返回**[VideoSource][263]**这个
## ImageSource
**扩展事件**
包含图像的数据源。（见`样式规范` 有关选项的详细文档。）
### Parameters
- `id` **`string`**
- `options` **(ImageSourceSpecification | VideoSourceSpecification | CanvasSourceSpecification)**
- `dispatcher` **调度员**
- `eventedParent` **`事件发生`**
### Examples
```
// add to map
map.addSource('some id', {
type: 'image',
url: 'https://xxx.png',
coordinates: [
[-76.54, 39.18],
[-76.52, 39.18],
[-76.52, 39.17],
[-76.54, 39.17]
]
});
// update coordinates
var mySource = map.getSource('some id');
mySource.setCoordinates([
[-76.54335737228394, 39.18579907229748],
[-76.52803659439087, 39.1838364847587],
[-76.5295386314392, 39.17683392507606],
[-76.54520273208618, 39.17876344106642]
]);
// update url and coordinates simultaneously
mySource.updateImage({
url: 'https://xxx.png',
coordinates: [
[-76.54335737228394, 39.18579907229748],
[-76.52803659439087, 39.1838364847587],
[-76.5295386314392, 39.17683392507606],
[-76.54520273208618, 39.17876344106642]
]
})
map.removeSource('some id'); // remove
```
### updateImage
更新图像 URL 和（可选）坐标。为避免更改后图像闪烁，请将`raster-fade-duration`光栅图层上的paint属性设置为0。
#### Parameters
- `options` **`Object`** 选项对象。
- `options.url` **`string`?** 必需的图像 URL。
- `options.coordinates` **`Array`< `Array`< `number`\>>？**四个地理坐标，表示为经度和纬度数字数组，用于定义图像的角点。坐标从图像的左上角开始，并按顺时针顺序进行。它们不必表示一个矩形。
返回**[ImageSource][268]**这个
### setCoordinates
设置图像的坐标并重新渲染地图。
#### Parameters
- `coordinates` **`Array`< `Array`< `number`\>>**四地理坐标，表示为经度和纬度的数字阵列，它定义了图像的角上。坐标从图像的左上角开始，并按顺时针顺序进行。它们不必表示一个矩形。
返回**[ImageSource][268]**这个
## CanvasSourceOptions
将画布源类型添加到地图的选项。
类型： `Object`
### Properties
- `type` **`string`**来源类型。必须是`"canvas"`。
- `canvas` **( `string`| `HTMLCanvasElement `)**从中读取像素的画布源。可以是表示画布元素 ID 或`HTMLCanvasElement`本身的字符串。
- `coordinates` **`Array`< `Array`< `number`\>>**四个地理坐标表示在何处放置画布的角部，在指定的`[longitude, latitude]`对。
- `animate` **`boolean`?** 画布源是否是动画的。如果画布是静态的（即不需要在每一帧上重新读取像素），`animate`则应设置为`false`以提高性能。
## CanvasSource
**扩展图像源**
包含 HTML 画布内容的数据源。有关`选项`的详细文档，请参阅[CanvasSourceOptions][269]。
### Parameters
- `id` **`string`**
- `options` **画布来源规范**
- `dispatcher` **调度员**
- `eventedParent` **`事件发生`**
### Examples
```
// add to map
map.addSource('some id', {
type: 'canvas',
canvas: 'idOfMyHTMLCanvas',
animate: true,
coordinates: [
[-76.54, 39.18],
[-76.52, 39.18],
[-76.52, 39.17],
[-76.54, 39.17]
]
});
// update
var mySource = map.getSource('some id');
mySource.setCoordinates([
[-76.54335737228394, 39.18579907229748],
[-76.52803659439087, 39.1838364847587],
[-76.5295386314392, 39.17683392507606],
[-76.54520273208618, 39.17876344106642]
]);
map.removeSource('some id'); // remove
```
### play
启用动画。图像将从画布复制到每一帧的地图。
### pause
禁用动画。地图将显示画布图像的静态副本。
### getCanvas
返回 HTML`canvas`元素。
返回**`HTMLCanvasElement `**HTML`canvas`元素。
### setCoordinates
设置画布的坐标并重新渲染地图。
#### Parameters
- `coordinates` **`Array`< `Array`< `number`\>>**四地理坐标，表示为经度和纬度的数字阵列，它定义了画布的角上。坐标从画布的左上角开始并按顺时针顺序进行。它们不必表示一个矩形。
返回**[CanvasSource][270]**这个
## GeoJSONSource
**扩展事件**
包含 GeoJSON 的源。（见`样式规范`有关选项的详细文档。）
### Parameters
- `id` **`string`**
- `options` **任何**
- `dispatcher` **调度员**
- `eventedParent` **`事件发生`**
### Examples
```
map.addSource('some id', {
type: 'geojson',
data: 'https://xxx.geojson'
});
```
```
map.addSource('some id', {
type: 'geojson',
data: {
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [
-76.53063297271729,
39.18174077994108
]
}
}]
}
});
```
```
map.getSource('some id').setData({
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"properties": { "name": "Null Island" },
"geometry": {
"type": "Point",
"coordinates": [ 0, 0 ]
}
}]
});
```
### setData
设置 GeoJSON 数据并重新渲染地图。
#### Parameters
- `data` **( `Object`| `string`)** GeoJSON 数据对象或指向一个的 URL。在大 GeoJSON 文件的情况下，后者更可取。
返回**[GeoJSONSource][271]**这个
### getClusterExpansionZoom
对于集群源，获取给定集群扩展的缩放比例。
#### Parameters
- `clusterId` **`number`**集群的`cluster_id`属性值。
- `callback` **回调< `number`\>**检索缩放值时要调用的回调 ( `(error, zoom) => { ... }`)。
返回**[GeoJSONSource][271]**这个
### getClusterChildren
对于集群源，在下一个缩放级别（作为 GeoJSON 功能数组）获取给定集群的子项。
#### Parameters
- `clusterId` **`number`**集群的`cluster_id`属性值。
- `callback` **Callback< `Array`<GeoJSONFeature>>**检索要素时要调用的回调 ( `(error, features) => { ... }`)。
返回**[GeoJSONSource][271]**这个
### getClusterLeaves
对于集群源，获取属于集群的原始点（作为 GeoJSON 特征数组）。
#### Parameters
- `clusterId` **`number`**集群的`cluster_id`属性值。
- `limit` **`number`**要返回的最大特征数。（`10`如果给出了假值，则默认为。）
- `offset` **`number`**要跳过的功能数量（例如分页）。（`0`如果给出了假值，则默认为。）
- `callback` **Callback< `Array`<GeoJSONFeature>>**检索要素时要调用的回调 ( `(error, features) => { ... }`)。
#### Examples
```
// Retrieve cluster leaves on click
map.on('click', 'clusters', function(e) {
var features = map.queryRenderedFeatures(e.point, {
layers: ['clusters']
});
var clusterId = features[0].properties.cluster_id;
var pointCount = features[0].properties.point_count;
var clusterSource = map.getSource('clusters');
clusterSource.getClusterLeaves(clusterId, pointCount, 0, function(error, features) {
// Print cluster leaves in the console
console.log('Cluster leaves:', error, features);
})
});
```
返回**[GeoJSONSource][271]**这个
## CustomLayerInterface
自定义样式层的界面。这是实现者建模的规范：它不是导出的方法或类。
自定义图层允许用户使用地图的相机直接渲染到地图的上下文中。可以使用`Map#addLayer`在任何常规图层之间添加这些图层。
自定义层必须具有唯一`id`和必须具备的`type`的`"custom"`。他们必须实施`render`并且可以实施`prerender`,`onAdd`和`onRemove`。他们可以使用`Map#triggerRepaint`触发渲染， 并且他们应该适当地处理`Map.event:webglcontextlost`和 `Map.event:webglcontextrestored`。
该`renderingMode`属性控制是将图层视为地图图层`"2d"`还是`"3d"`地图图层。用：
- `"renderingMode": "3d"` 使用深度缓冲区并与其他层共享
- `"renderingMode": "2d"`添加一个没有深度的图层。如果您需要为`"2d"`图层使用深度缓冲区，则必须使用屏幕外帧缓冲区和`CustomLayerInterface#prerender`
### Properties
- `id` **`string`** 唯一的图层 ID。
- `type` **`string`**图层的类型。必须是`"custom"`。
- `renderingMode` **`string`**无论是`"2d"`或`"3d"`。默认为`"2d"`.
### Examples
```
// Custom layer implemented as ES6 class
class NullIslandLayer {
constructor() {
this.id = 'null-island';
this.type = 'custom';
this.renderingMode = '2d';
}
onAdd(map, gl) {
const vertexSource = `
uniform mat4 u_matrix;
void main() {
gl_Position = u_matrix * vec4(0.5, 0.5, 0.0, 1.0);
gl_PointSize = 20.0;
}`;
const fragmentSource = `
void main() {
gl_FragColor = vec4(1.0, 0.0, 0.0, 1.0);
}`;
const vertexShader = gl.createShader(gl.VERTEX_SHADER);
gl.shaderSource(vertexShader, vertexSource);
gl.compileShader(vertexShader);
const fragmentShader = gl.createShader(gl.FRAGMENT_SHADER);
gl.shaderSource(fragmentShader, fragmentSource);
gl.compileShader(fragmentShader);
this.program = gl.createProgram();
gl.attachShader(this.program, vertexShader);
gl.attachShader(this.program, fragmentShader);
gl.linkProgram(this.program);
}
render(gl, matrix) {
gl.useProgram(this.program);
gl.uniformMatrix4fv(gl.getUniformLocation(this.program, "u_matrix"), false, matrix);
gl.drawArrays(gl.POINTS, 0, 1);
}
}
map.on('load', function() {
map.addLayer(new NullIslandLayer());
});
```
### onAdd
使用`Map#addLayer`将图层添加到地图时调用的可选方法。这使该层有机会初始化 gl 资源并注册事件侦听器。
#### Parameters
- `map` **`地图`**此自定义图层刚刚添加到的地图。
- `gl` **`WebGL 渲染上下文 `** 地图的 gl 上下文。
### onRemove
使用`Map#removeLayer`从地图中删除图层时调用的可选方法。这使该层有机会清理 gl 资源和事件侦听器。
#### Parameters
- `map` **`地图`**此自定义图层刚刚添加到的地图。
- `gl` **`WebGL 渲染上下文 `** 地图的 gl 上下文。
### prerender
在渲染帧期间调用的可选方法，以允许图层准备资源或渲染到纹理中。
该层不能对当前状态做出任何假设，并且必须在渲染之前绑定一个帧缓冲区。
#### Parameters
- `gl` **`WebGL 渲染上下文 `** 地图的 gl 上下文。
- `matrix` **`Array`< `number`\>**地图的相机矩阵。它将球形墨卡托坐标投影到 gl 坐标。墨卡托坐标``0, 0]`代表墨卡托世界的左上角，`[1, 1]`代表右下角。当`renderingMode`是 时`"3d"`，z 坐标是共形的。具有相同 x、y 和 z 长度（以墨卡托为单位）的盒子将被渲染为立方体。[MercatorCoordinate` .fromLngLat 可用于将 a 投影`LngLat`到墨卡托坐标。
### render
在渲染帧期间调用，允许图层绘制到 GL 上下文中。
图层可以假设混合和深度状态设置为允许图层正确混合和剪辑其他图层。该层不能对当前 GL 状态做出任何其他假设。
如果图层需要渲染到纹理，它应该实现`prerender`这样做的方法，并且只使用`render`直接绘制到主帧缓冲区的方法。
混合函数设置为`gl.blendFunc(gl.ONE, gl.ONE_MINUS_SRC_ALPHA)`。这期望以预乘 alpha 形式提供颜色，其中`r`,`g`和`b`值已经乘以该`a`值。如果您无法以预乘形式提供颜色，您可能需要将混合函数更改为 `gl.blendFuncSeparate(gl.SRC_ALPHA, gl.ONE_MINUS_SRC_ALPHA, gl.ONE, gl.ONE_MINUS_SRC_ALPHA)`.
#### Parameters
- `gl` **`WebGL 渲染上下文 `** 地图的 gl 上下文。
- `matrix` **`Array`< `number`\>**地图的相机矩阵。它将球形墨卡托坐标投影到 gl 坐标。球面墨卡托坐标``0, 0]`代表墨卡托世界的左上角，`[1, 1]`代表右下角。当`renderingMode`是 时`"3d"`，z 坐标是共形的。具有相同 x、y 和 z 长度（以墨卡托为单位）的盒子将被渲染为立方体。[MercatorCoordinate` .fromLngLat 可用于将 a 投影`LngLat`到墨卡托坐标。
## LngLat
甲`LngLat`对象表示一个给定的经度和纬度坐标，以度为单位。这些坐标基于`WGS84 (EPSG:4326) 标准 `.
使用经度、纬度坐标顺序（相对于纬度、经度）来匹配 `GeoJSON 规范 `.
请注意，任何接受`LngLat`对象作为参数或选项的方法也可以接受`Array`两个数字中的一个，并将执行隐式转换。这种灵活的类型记录为[LngLatLike][284]。
### Parameters
- `lng` **`number`** 经度，以度为单位。
- `lat` **`number`** 纬度，以度为单位。
### Examples
```
var ll = new vjmap.LngLat(-123.9749, 40.7736);
ll.lng; // = -123.9749
```
### wrap
返回一个新`LngLat`对象，其经度被包裹到范围 (-180, 180)。
#### Examples
```
var ll = new vjmap.LngLat(286.0251, 40.7736);
var wrapped = ll.wrap();
wrapped.lng; // = -73.9749
```
返回**[LngLat][230]**包装的`LngLat`对象。
### toArray
返回表示为两个数字数组的坐标。
#### Examples
```
var ll = new vjmap.LngLat(-73.9749, 40.7736);
ll.toArray(); // = [-73.9749, 40.7736]
```
返回**`Array`< `number`\>**坐标表示为经度和纬度数组。
### toString
返回表示为字符串的坐标。
#### Examples
```
var ll = new vjmap.LngLat(-73.9749, 40.7736);
ll.toString(); // = "LngLat(-73.9749, 40.7736)"
```
返回**`string`**值表示为格式字符串的坐标`'LngLat(lng, lat)'`。
### distanceTo
返回一对坐标之间的近似距离（以米为单位） 使用Haversine 公式（来自 RW Sinnott，“Haversine 的优点”，Sky and Telescope，第 68 卷，第 2 期，1984 年，第 159 页）
#### Parameters
- `lngLat` 计算距离的**[LngLat][230]**坐标
#### Examples
```
var new_york = new vjmap.LngLat(-74.0060, 40.7128);
var los_angeles = new vjmap.LngLat(-118.2437, 34.0522);
new_york.distanceTo(los_angeles); // = 3935751.690893987, "true distance" using a non-spherical approximation is ~3966km
```
返回**`number`**两个坐标之间的距离（以米为单位）。
### toBounds
`LngLatBounds`从给定 扩展的坐标返回 a `radius`。返回的`LngLatBounds`完全包含`radius`.
#### Parameters
- `radius` **`number`**从坐标到扩展边界的距离（以米为单位）。（可选，默认`0`）
#### Examples
```
var ll = new vjmap.LngLat(-73.9749, 40.7736);
ll.toBounds(100).toArray(); // = [[-73.97501862141328, 40.77351016847229], [-73.97478137858673, 40.77368983152771]]
```
返回**[LngLatBounds][285]**一个新`LngLatBounds`对象，表示由 扩展的坐标`radius`。
### convert
将包含两个数字的数组或具有`lng`and`lat`或`lon`and`lat`属性的`LngLat`对象转换为对象。
如果`LngLat`传入一个对象，该函数将原样返回它。
#### Parameters
- `input` **[LngLatLike][284]**要转换的两个数字或对象的数组，或`LngLat`要返回的对象。
#### Examples
```
var arr = [-73.9749, 40.7736];
var ll = vjmap.LngLat.convert(arr);
ll; // = LngLat {lng: -73.9749, lat: 40.7736}
```
返回**[LngLat][230]**一个新`LngLat`对象（如果发生转换）或原始`LngLat`对象。
## LngLatLike
一个[LngLat][230]对象，一个表示经度和纬度的两个数字的数组，或者一个具有`lng`and`lat`或`lon`and`lat`属性的对象。
类型: ( [LngLat][230] | {lng: `number`, lat: `number`} | {lon: `number`, lat: `number`} | \[ `number`, `number`\])
### Examples
```
var v1 = new vjmap.LngLat(-122.420679, 37.772537);
var v2 = [-122.420679, 37.772537];
var v3 = {lon: -122.420679, lat: 37.772537};
```
## LngLatBounds
一个`LngLatBounds`对象代表一个地理边界框，由其西南和东北经纬度点定义。
如果没有为构造函数提供参数，`null`则会创建一个边界框。
请注意，任何接受`LngLatBounds`对象作为参数或选项的方法也可以接受`Array`两个[LngLatLike][284]构造中的一个，并将执行隐式转换。这种灵活的类型记录为[LngLatBoundsLike][299]。
### Parameters
- `sw` **[LngLatLike][284] ?** 边界框的西南角。
- `ne` **[LngLatLike][284] ?** 边界框的东北角。
### Examples
```
var sw = new vjmap.LngLat(-73.9876, 40.7661);
var ne = new vjmap.LngLat(-73.9397, 40.8002);
var llb = new vjmap.LngLatBounds(sw, ne);
```
### setNorthEast
设置边界框的东北角
#### Parameters
- `ne` **[LngLatLike][284]**一个[LngLatLike][284]描述边界框的东北角对象。
返回**[LngLatBounds][285]** `this`
### setSouthWest
设置边界框的西南角
#### Parameters
- `sw` **[LngLatLike][284]**一个[LngLatLike][284]描述边框的西南角对象。
返回**[LngLatBounds][285]** `this`
### extend
扩展边界以包括给定的 LngLatLike 或 LngLatBoundsLike。
#### Parameters
- `obj` **( [LngLatLike][284] | [LngLatBoundsLike][299] )**要扩展到的对象
返回**[LngLatBounds][285]** `this`
### getCenter
返回与边界框角等距的地理坐标。
#### Examples
```
var llb = new vjmap.LngLatBounds([-73.9876, 40.7661], [-73.9397, 40.8002]);
llb.getCenter(); // = LngLat {lng: -73.96365, lat: 40.78315}
```
返回**[LngLat][230]**边界框的中心。
### getSouthWest
返回边界框的西南角。
返回**[LngLat][230]**边界框的西南角。
### getNorthEast
返回边界框的东北角。
返回**[LngLat][230]**边界框的东北角。
### getNorthWest
返回边界框的西北角。
返回**[LngLat][230]**边界框的西北角。
### getSouthEast
返回边界框的东南角。
返回**[LngLat][230]**边界框的东南角。
### getWest
返回边界框的西边。
返回**`number`**边界框的西边。
### getSouth
返回边界框的南边。
返回**`number`**边界框的南边缘。
### getEast
返回边界框的东边。
返回**`number`**边界框的东边。
### getNorth
返回边界框的北边缘。
返回**`number`**边界框的北边缘。
### toArray
返回表示为数组的边界框。
#### Examples
```
var llb = new vjmap.LngLatBounds([-73.9876, 40.7661], [-73.9397, 40.8002]);
llb.toArray(); // = [[-73.9876, 40.7661], [-73.9397, 40.8002]]
```
返回**`Array`< `Array`< `number`\>>**表示为数组的边界框，由表示为数字数组的边界的西南和东北坐标组成。
### toString
返回表示为字符串的边界框。
#### Examples
```
var llb = new vjmap.LngLatBounds([-73.9876, 40.7661], [-73.9397, 40.8002]);
llb.toString(); // = "LngLatBounds(LngLat(-73.9876, 40.7661), LngLat(-73.9397, 40.8002))"
```
返回**`string`**边界框表示为格式字符串 `'LngLatBounds(LngLat(lng, lat), LngLat(lng, lat))'`。
### isEmpty
检查边界框是否为空/ `null`\- 类型框。
**`boolean`**如果边界已定义，则返回True，否则返回false。
### contains
检查点是否在边界框内。
#### Parameters
- `lnglat` 要检查的**[LngLatLike][284]**地理点。
#### Examples
```
var llb = new vjmap.LngLatBounds(
new vjmap.LngLat(-73.9876, 40.7661),
new vjmap.LngLat(-73.9397, 40.8002)
);
var ll = new vjmap.LngLat(-73.9567, 40.7789);
console.log(llb.contains(ll)); // = true
```
**`boolean`**如果点在边界框内，则返回True。
### convert
将数组转换为`LngLatBounds`对象。
如果`LngLatBounds`传入一个对象，该函数将原样返回它。
在内部，该函数调用`LngLat#convert`将数组转换为`LngLat`值。
#### Parameters
- `input` **[LngLatBoundsLike][299]**要转换的两个坐标数组，或`LngLatBounds`要返回的对象。
#### Examples
```
var arr = [[-73.9876, 40.7661], [-73.9397, 40.8002]];
var llb = vjmap.LngLatBounds.convert(arr);
llb; // = LngLatBounds {_sw: LngLat {lng: -73.9876, lat: 40.7661}, _ne: LngLat {lng: -73.9397, lat: 40.8002}}
```
返回**[LngLatBounds][285]**一个新`LngLatBounds`对象（如果发生转换）或原始`LngLatBounds`对象。
## LngLatBoundsLike
甲[LngLatBounds][285]对象，的阵列[LngLatLike][284]在\[SW，NE\]顺序，或数字的在\[西，南，东，北\]为了对象的数组。
类型：( [LngLatBounds][285] | \` [LngLatLike` , [LngLatLike][284] \] | \[ `number`, `number`, `number`, `number`\])
### Examples
```
var v1 = new vjmap.LngLatBounds(
new vjmap.LngLat(-73.9876, 40.7661),
new vjmap.LngLat(-73.9397, 40.8002)
);
var v2 = new vjmap.LngLatBounds([-73.9876, 40.7661], [-73.9397, 40.8002])
var v3 = [[-73.9876, 40.7661], [-73.9397, 40.8002]];
```
## MercatorCoordinate
甲`MercatorCoordinate`对象表示投影三维位置。
`MercatorCoordinate`使用 web 墨卡托投影 ( `EPSG:3857 `) 单位略有不同：
- 1个单位的大小是投影世界的宽度而不是“墨卡托米”
- 坐标空间的原点在西北角而不是中间
例如，`MercatorCoordinate(0, 0, 0)`是墨卡托世界的西北角， `MercatorCoordinate(1, 1, 0)`是东南角。如果您熟悉 `矢量切片 `将坐标空间视为`0/0/0`范围为 的瓦片可能会有所帮助`1`。
的`z`尺寸`MercatorCoordinate`是共形的。墨卡托坐标空间中的立方体将被渲染为立方体。
### Parameters
- `x` **`number`** 位置的 x 分量。
- `y` **`number`** 位置的 y 分量。
- `z` **`number`**位置的 z 分量。（可选，默认`0`）
### Examples
```
var nullIsland = new vjmap.MercatorCoordinate(0.5, 0.5, 0);
```
### toLngLat
返回`LngLat`坐标的 。
#### Examples
```
var coord = new vjmap.MercatorCoordinate(0.5, 0.5, 0);
var lngLat = coord.toLngLat(); // LngLat(0, 0)
```
返回**[LngLat][230]**的`LngLat`对象。
### toAltitude
返回以米为单位的坐标高度。
#### Examples
```
var coord = new vjmap.MercatorCoordinate(0, 0, 0.02);
coord.toAltitude(); // 6914.281956295339
```
返回**`number`**以米为单位的海拔高度。
### meterInMercatorCoordinateUnits
返回`MercatorCoordinate`以该纬度为单位的 1 米的距离。
对于使用米的真实世界单位坐标，这自然提供了转换为`MercatorCoordinate`s的比例。
**`number`**以`MercatorCoordinate`单位返回1 米的距离。
### fromLngLat
`LngLat`将 a投影到 a `MercatorCoordinate`。
#### Parameters
- `lngLatLike` **[LngLatLike][284]**要投影的位置。
- `altitude` **`number`**位置的高度（以米为单位）。（可选，默认`0`）
#### Examples
```
var coord = vjmap.MercatorCoordinate.fromLngLat({ lng: 0, lat: 0}, 0);
coord; // MercatorCoordinate(0.5, 0.5, 0)
```
返回**[MercatorCoordinate][300]**投影的墨卡托坐标。
## Evented
`Evented` 将方法混合到其他类中以获得事件功能。
除非您正在开发插件，否则您很可能会通过`Map`或 之类的类使用这些方法`Popup`。
有关您可以侦听的事件列表，请参阅特定类的 API 文档： ``Map` `, ``Marker` `, ``Popup` `， 和 ``GeolocationControl` `.
### on
将侦听器添加到指定的事件类型。
#### Parameters
- `type` **`string`** 要添加侦听的事件类型。
- `listener` **Function**触发事件时要调用的函数。使用传递给 的数据对象调用侦听器函数`fire`，`target`并使用和`type`属性进行扩展。
返回 **`Object`** `this`
### off
删除以前注册的事件侦听器。
#### Parameters
- `type` **`string`** 要为其删除侦听器的事件类型。
- `listener` **功能**监听器函数删除。
返回 **`Object`** `this`
### once
将仅被调用一次的侦听器添加到指定的事件类型。
注册监听器后，第一次触发事件时将调用监听器。
#### Parameters
- `type` **`string`** 要侦听的事件类型。
- `listener` **函数**（可选）当事件被触发一次时要调用的函数。如果未提供，则返回将在事件触发一次时解决的 Promise。
返回| 承诺**`Object`** `this`
## getAABBPointSquareDist
返回由 min 和 max 定义的 AABB 与一个点之间的 2D 距离的平方。如果 point 为空或未定义，则返回距原点 (0,0) 的 AABB 距离。
### Parameters
- `min` **`点`**AABB 的最小范围。
- `max` **`点`**AABB 的最大范围。
- `point` **`点`？**计算距离的点可能未定义。
返回**`number`**距 AABB 的平方距离，如果 AABB 包含该点，则为 0.0。
## polygonizeBounds
将 AABB 转换为具有顺时针缠绕顺序的多边形。
### Parameters
- `min` **`点`**左上点。
- `max` **`点`**右下点。
- `buffer` **`number`**缓冲区宽度。（可选，默认`0`）
- `close` **`boolean`**是否关闭多边形。（可选，默认`true`）
返回**`Array`<`点`\>**多边形。
## bufferConvexPolygon
取一个凸环并通过在其周围应用缓冲区将其向外扩展。此函数假定环按顺时针缠绕顺序。
### Parameters
- `ring` **`Array`<`点`\>**输入环。
- `buffer` **`number`** 缓冲区宽度。
返回**`Array`< [Point][165] >**扩展环。
## FreeCameraOptions
用于访问底层相机实体的物理属性的选项。直接访问这些属性可以更灵活和精确地控制相机，同时还与 CameraOptions 完全兼容和可互换。所有字段都是可选的。参见`Map#setFreeCameraOptions`和`Map#getFreeCameraOptions`
### Parameters
- `position` **[MercatorCoordinate][300]**稍微修改过的 web 墨卡托坐标中的相机位置 - 1 个单位的大小是投影世界的宽度，而不是“墨卡托米”。坐标 \[0, 0, 0\] 是西北角，\[1, 1, 0\] 是东南角。
- Z 坐标是共形的，必须遵守最小和最大缩放值。
- 缩放是根据高度 (z) 自动计算的
- `orientation` **quat**相机的方向表示为左手坐标空间中的单位四元数 \[x, y, z, w\]。旋转方向是绕各自的轴顺时针旋转。相机的默认姿势是这样的，即前向矢量在 -Z 轴上查找，向上矢量与地图的北方向对齐： forward: \[0, 0, -1\] up: \[0, -1, 0\] right \[1, 0, 0\] 方向可以自由设置，但某些限制仍然适用 - 方向必须只能用俯仰和轴承表示。
- 间距有上限
### lookAtPoint
通过在地图上定义焦点来设置相机方向的辅助功能。
#### Parameters
- `location` **[LngLatLike][284]**焦点在地图上的位置
- `up` **vec3？**在某些无法从观察方向推导出方位的情况下，相机的向上矢量是必要的。
### setPitchBearing
用于将相机的方向设置为俯仰和方位角的辅助函数。
#### Parameters
- `pitch` **`number`** 俯仰角（度）
- `bearing` **`number`** 以度为单位的轴承角
## FreeCamera
在使用免费相机 API 时，isZooming、isMoving 和 isRotating 的结果值不是免费相机 API 的结果。如果用户将 map.interactive 设置为 true，则在使用鼠标或/和键盘通过缩放或移动与地图交互时会出现冲突行为，这将导致 isZooming、isMoving 和 isRotating 在使用免费相机 API 时返回 true。为了防止冲突行为，请将 map.interactive 设置为 false，这将导致以下事件静音：zoom、zoomend、zoomstart、rotate、rotateend、rotatestart、move、moveend、movestart、pitch、pitchend、pitchstart。
### Parameters
- `position` **vec3？**
- `orientation` **quat**
## prewarm
在某些情况下初始化可以跨地图共享的资源，例如 WebWorkers，以减少加载时间。`vjmap.workerUrl`并且`vjmap.workerCount`，如果使用，必须在`prewarm()`调用前才能生效。
默认情况下，这些资源的生命周期是自动管理的，并且在首次创建地图时延迟初始化。通过调用`prewarm()`，这些资源会提前创建，当最后一个地图从页面中移除时不会被清除。这允许它们被稍后创建的新地图实例重重使用。可以通过调用手动清除它们`vjmap.clearPrewarmedResources()`。仅当您的网页保持活动状态但完全停止使用地图时才需要破坏。
### Examples
```
vjmap.prewarm()
```
## clearPrewarmedResources
清除之前创建的资源`vjmap.prewarm()`。请注意，这通常不是必需的。如果您希望您的应用程序的用户在您的应用程序中的任何时候都不会返回到地图视图，您应该只调用此函数。
### Examples
```
vjmap.clearPrewarmedResources()
```
## workerCount
获取和设置在具有地图的页面上实例化的 Web Worker 的数量。默认情况下，它为 2。确保在创建任何地图实例之前设置此属性以使其生效。
类型： `string`
### Examples
```
vjmap.workerCount = 4;
```
返回**`number`**当前配置的`workerCount`。
## maxParallelImageRequests
获取和设置要并行加载的图像（光栅图块、像素、图标）的最大数量，这会影响地图重地图的性能。默认为16。
类型： `string`
### Examples
```
vjmap.maxParallelImageRequests = 10;
```
返回**`number`**当前配置的并行请求数。
## clearStorage
清除此库的浏览器。
此 API 在`API 的 `浏览器上受支持``Cache`（新窗口显示） `支持并启用。这包括通过提供页面时的所有主要浏览器`https://`，但 Internet Explorer 和 Edge Mobile 除外。
在不受支持的浏览器或环境（智能或隐身模式）中，将使用错误参数调用中时。
### Parameters
- `callback` **功能**如果出现错误，则使用错误参数调用。
### Examples
```
vjmap.clearStorage();
```
## workerClass
为Webpack或Rollup等外部模块打包器提供接口，将WebWorker打包成一个单独的类，并与库集成。
优先于`vjmap.workerUrl`。
类型： `Object`
返回**( `Object`| null)**一个类对象，它的一个实例公开了`Worker`接口。
## time
设置在内部为所有动画使用的时间。用于生成视频。
类型： `number`
## version
当前版本。
类型： `string`
## supported
测试浏览器是否支持`webgl`.
### Parameters
- `options` **`Object`?**
- `options.failIfMajorPerformanceCaveat` **`boolean`**如果`true`，如果`true`，`false`如果性能比预期的差很多（例如，将使用软件 WebGL 渲染器），该函数将返回。（任选，默认`false`）
### Examples
```
// Show an alert if the browser does not support webgl
if (!vjmap.supported()) {
alert('Your browser does not support `webgl`');
}
```
返回 **`boolean`**
[1]: #map
[2]: #parameters
[3]: #examples
[4]: #scrollzoom
[5]: #boxzoom
[6]: #dragrotate
[7]: #dragpan
[8]: #keyboard
[9]: #doubleclickzoom
[10]: #touchzoomrotate
[11]: #touchpitch
[12]: #addcontrol
[13]: #removecontrol
[14]: #hascontrol
[15]: #resize
[16]: #getbounds
[17]: #getmaxbounds
[18]: #setmaxbounds
[19]: #setminzoom
[20]: #getminzoom
[21]: #setmaxzoom
[22]: #getmaxzoom
[23]: #setminpitch
[24]: #getminpitch
[25]: #setmaxpitch
[26]: #getmaxpitch
[27]: #getrenderworldcopies
[28]: #setrenderworldcopies
[29]: #project
[30]: #unproject
[31]: #ismoving
[32]: #iszooming
[33]: #isrotating
[34]: #on
[35]: #once
[36]: #off
[37]: #queryrenderedfeatures
[38]: #querysourcefeatures
[39]: #setstyle
[40]: #getstyle
[41]: #isstyleloaded
[42]: #addsource
[43]: #issourceloaded
[44]: #aretilesloaded
[45]: #removesource
[46]: #getsource
[47]: #addimage
[48]: #updateimage
[49]: #hasimage
[50]: #removeimage
[51]: #loadimage
[52]: #listimages
[53]: #addlayer
[54]: #movelayer
[55]: #removelayer
[56]: #getlayer
[57]: #setlayerzoomrange
[58]: #setfilter
[59]: #getfilter
[60]: #setpaintproperty
[61]: #getpaintproperty
[62]: #setlayoutproperty
[63]: #getlayoutproperty
[64]: #setlight
[65]: #getlight
[66]: #setterrain
[67]: #getterrain
[68]: #setfog
[69]: #getfog
[70]: #queryterrainelevation
[71]: #setfeaturestate
[72]: #removefeaturestate
[73]: #getfeaturestate
[74]: #getcontainer
[75]: #getcanvascontainer
[76]: #getcanvas
[77]: #loaded
[78]: #remove
[79]: #triggerrepaint
[80]: #showtileboundaries
[81]: #showterrainwireframe
[82]: #showpadding
[83]: #showcollisionboxes
[84]: #repaint
[85]: #version
[86]: #getcenter
[87]: #setcenter
[88]: #panby
[89]: #panto
[90]: #getzoom
[91]: #setzoom
[92]: #zoomto
[93]: #zoomin
[94]: #zoomout
[95]: #getbearing
[96]: #setbearing
[97]: #getpadding
[98]: #setpadding
[99]: #rotateto
[100]: #resetnorth
[101]: #resetnorthpitch
[102]: #snaptonorth
[103]: #getpitch
[104]: #setpitch
[105]: #cameraforbounds
[106]: #fitbounds
[107]: #fitscreencoordinates
[108]: #jumpto
[109]: #getfreecameraoptions
[110]: #setfreecameraoptions
[111]: #easeto
[112]: #flyto
[113]: #stop
[114]: #mousedown
[115]: #properties
[116]: #mouseup
[117]: #mouseover
[118]: #mousemove
[119]: #click
[120]: #dblclick
[121]: #mouseenter
[122]: #mouseleave
[123]: #mouseout
[124]: #contextmenu
[125]: #wheel
[126]: #touchstart
[127]: #touchend
[128]: #touchmove
[129]: #touchcancel
[130]: #movestart
[131]: #move
[132]: #moveend
[133]: #dragstart
[134]: #drag
[135]: #dragend
[136]: #zoomstart
[137]: #zoom
[138]: #zoomend
[139]: #rotatestart
[140]: #rotate
[141]: #rotateend
[142]: #pitchstart
[143]: #pitch
[144]: #pitchend
[145]: #boxzoomstart
[146]: #boxzoomend
[147]: #boxzoomcancel
[148]: #webglcontextlost
[149]: #webglcontextrestored
[150]: #load
[151]: #render
[152]: #idle
[153]: #error
[154]: #data
[155]: #styledata
[156]: #sourcedata
[157]: #dataloading
[158]: #styledataloading
[159]: #sourcedataloading
[160]: #styleimagemissing
[161]: #icontrol
[162]: #onadd
[163]: #onremove
[164]: #getdefaultposition
[165]: #point
[166]: #pointlike
[167]: #proxysourcecache
[168]: #proxiedtileid
[169]: #elevationqueryoptions
[170]: #elevation
[171]: #getatpointorzero
[172]: #getatpoint
[173]: #getminmaxfortile
[174]: #getminelevationbelowmsl
[175]: #raycast
[176]: #pointcoordinate
[177]: #demsampler
[178]: #boxzoomhandler
[179]: #isenabled
[180]: #isactive
[181]: #enable
[182]: #disable
[183]: #touchpitchhandler
[184]: #keyboardhandler
[185]: #disablerotation
[186]: #enablerotation
[187]: #scrollzoomhandler
[188]: #setzoomrate
[189]: #setwheelzoomrate
[190]: #doubleclickzoomhandler
[191]: #dragpanhandler
[192]: #dragrotatehandler
[193]: #touchzoomrotatehandler
[194]: #cameraoptions
[195]: #animationoptions
[196]: #paddingoptions
[197]: #navigationcontrol
[198]: #geolocatecontrol
[199]: #trigger
[200]: #geolocate
[201]: #outofmaxbounds
[202]: #trackuserlocationstart
[203]: #trackuserlocationend
[204]: #attributioncontrol
[205]: #scalecontrol
[206]: #setunit
[207]: #fullscreencontrol
[208]: #popup
[209]: #addto
[210]: #isopen
[211]: #getlnglat
[212]: #setlnglat
[213]: #trackpointer
[214]: #getelement
[215]: #settext
[216]: #sethtml
[217]: #getmaxwidth
[218]: #setmaxwidth
[219]: #setdomcontent
[220]: #addclassname
[221]: #removeclassname
[222]: #setoffset
[223]: #toggleclassname
[224]: #open
[225]: #close
[226]: #mapmouseevent
[227]: #type
[228]: #target
[229]: #originalevent
[230]: #lnglat
[231]: #preventdefault
[232]: #maptouchevent
[233]: #points
[234]: #lnglats
[235]: #mapwheelevent
[236]: #zoomevent
[237]: #mapdataevent
[238]: #marker
[239]: #setpopup
[240]: #getpopup
[241]: #togglepopup
[242]: #getoffset
[243]: #setdraggable
[244]: #isdraggable
[245]: #setrotation
[246]: #getrotation
[247]: #setrotationalignment
[248]: #getrotationalignment
[249]: #setpitchalignment
[250]: #getpitchalignment
[251]: #styleimageinterface
[252]: #requestparameters
[253]: #querygeometry
[254]: #ispointquery
[255]: #bufferedscreengeometry
[256]: #bufferedcamerageometry
[257]: #containstile
[258]: #bufferedscreenmercator
[259]: #createfromscreenpoints
[260]: #vectortilesource
[261]: #settiles
[262]: #seturl
[263]: #videosource
[264]: #pause
[265]: #play
[266]: #getvideo
[267]: #setcoordinates
[268]: #imagesource
[269]: #canvassourceoptions
[270]: #canvassource
[271]: #geojsonsource
[272]: #setdata
[273]: #getclusterexpansionzoom
[274]: #getclusterchildren
[275]: #getclusterleaves
[276]: #customlayerinterface
[277]: #prerender
[278]: #wrap
[279]: #toarray
[280]: #tostring
[281]: #distanceto
[282]: #tobounds
[283]: #convert
[284]: #lnglatlike
[285]: #lnglatbounds
[286]: #setnortheast
[287]: #setsouthwest
[288]: #extend
[289]: #getsouthwest
[290]: #getnortheast
[291]: #getnorthwest
[292]: #getsoutheast
[293]: #getwest
[294]: #getsouth
[295]: #geteast
[296]: #getnorth
[297]: #isempty
[298]: #contains
[299]: #lnglatboundslike
[300]: #mercatorcoordinate
[301]: #tolnglat
[302]: #toaltitude
[303]: #meterinmercatorcoordinateunits
[304]: #fromlnglat
[305]: #evented
[306]: #getaabbpointsquaredist
[307]: #polygonizebounds
[308]: #bufferconvexpolygon
[309]: #freecameraoptions
[310]: #lookatpoint
[311]: #setpitchbearing
[312]: #freecamera
[313]: #prewarm
[314]: #%e4%be%8b%e5%ad%90
[315]: #clearprewarmedresources
[316]: #workercount
[317]: #maxparallelimagerequests
[318]: #clearstorage
[319]: #workerclass
[320]: #time
[321]: #supported
vjmap / [Exports](#modulesmd)
# vjmap
如需更改mapboxgl的内容，需去
D:\w\vclient\deps\mapbox-gl-js-2.5.1\
yarn build-prod-min
把编译后的 mapbox-gl.js 拷贝至 D:\w\vclient\node_modules\mapbox-gl\dist下面
更新记录
2023-10-13 增加对webgl2的支持
# Classes
[vjmap](#readmemd) / [Exports](#modulesmd) / AnimateMarkerLayer
## Class: AnimateMarkerLayer
动画标记图层.
### Hierarchy
- *Evented*
↳ **AnimateMarkerLayer**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Methods
- [\_getMarkerElement](#_getmarkerelement)
- [addTo](#addto)
- [clearMarkerLayer](#clearmarkerlayer)
- [getMarkers](#getmarkers)
- [remove](#remove)
- [render](#render)
- [setType](#settype)
### Constructors
#### constructor
\+ **new AnimateMarkerLayer**(`features`: *FeatureCollection*, `options?`: [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd)): [*AnimateMarkerLayer*](#classesdefaultanimatemarkerlayermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `features` | *FeatureCollection* |
| `options?` | [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd) |
**Returns:** [*AnimateMarkerLayer*](#classesdefaultanimatemarkerlayermd)
Overrides: Evented.constructor
### Methods
#### \_getMarkerElement
▸ **_getMarkerElement**(): *void*
**Returns:** *void*
___
#### addTo
▸ **addTo**(`map`: *Map*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
**Returns:** *void*
___
#### clearMarkerLayer
▸ **clearMarkerLayer**(): *void*
**Returns:** *void*
___
#### getMarkers
▸ **getMarkers**(): *Marker*[]
**Returns:** *Marker*[]
___
#### remove
▸ **remove**(): *void*
**Returns:** *void*
___
#### render
▸ **render**(): *void*
**Returns:** *void*
___
#### setType
▸ **setType**(`type`: [*AnimateMarkerType*](#animatemarkertype), `options?`: [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd)): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `type` | [*AnimateMarkerType*](#animatemarkertype) |
| `options?` | [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd) |
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / BackgroundLayer
## Class: BackgroundLayer
创建一个背景图层.
### Hierarchy
- [*OverlayLayerBase*](#classesdefaultoverlaylayerbasemd)
↳ **BackgroundLayer**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [\_map](#_map)
- [layerId](#layerid)
- [options](#options)
- [sourceId](#sourceid)
#### Methods
- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getBackgroundColor](#getbackgroundcolor)
- [getBackgroundOpacity](#getbackgroundopacity)
- [getBackgroundPattern](#getbackgroundpattern)
- [getData](#getdata)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getSourceId](#getsourceid)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setBackgroundColor](#setbackgroundcolor)
- [setBackgroundOpacity](#setbackgroundopacity)
- [setBackgroundPattern](#setbackgroundpattern)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setProperty](#setproperty)
- [show](#show)
- [toggle](#toggle)
### Constructors
#### constructor
\+ **new BackgroundLayer**(`options`: [*BackgroundLayerOptions*](#interfacesdefaultbackgroundlayeroptionsmd)): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `options` | [*BackgroundLayerOptions*](#interfacesdefaultbackgroundlayeroptionsmd) |
**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
### Properties
#### \_map
• `Optional` **\_map**: *Map*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[_map](#_map)
___
#### layerId
• `Optional` **layerId**: *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[layerId](#layerid)
___
#### options
• **options**: [*BackgroundLayerOptions*](#interfacesdefaultbackgroundlayeroptionsmd)
___
#### sourceId
• `Optional` **sourceId**: *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[sourceId](#sourceid)
### Methods
#### addTo
▸ **addTo**(`map`: *Map*, `beforeId?`: *string*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
| `beforeId?` | *string* |
**Returns:** *void*
Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### clickLayer
▸ **clickLayer**(`cb`: *any*): *any*
每当单击这些图层中的要素时都会触发回调。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cb` | *any* | Callback that receives event with .features property |
**Returns:** *any*
A function that removes the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### clickPopup
▸ **clickPopup**(`htmlFunc`: (`arg0`: {}) => *void*, `popupOptions?`: PopupOptions): *any*
每当单击这些图层中的要素时都会显示一个弹出窗口。
**`example`** clickPopup(f => `${f.properties.Name}
${f.properties.Description}`, { maxWidth: 500 });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | (`arg0`: {}) => *void* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
A function that removes the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getBackgroundColor
▸ **getBackgroundColor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
___
#### getBackgroundOpacity
▸ **getBackgroundOpacity**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
___
#### getBackgroundPattern
▸ **getBackgroundPattern**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
___
#### getData
▸ **getData**(): *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
获取数据源的数据
**Returns:** *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getLayerId
▸ **getLayerId**(): *undefined* \| *string*
获取图层ID
**Returns:** *undefined* \| *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getLayerStyle
▸ **getLayerStyle**(): [*LayerSpecification*](#layerspecification)
根据样式规范，获取给定图层 ID 的图层定义。
**Returns:** [*LayerSpecification*](#layerspecification)
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getSourceId
▸ **getSourceId**(): *undefined* \| *string*
获取数据源ID
**Returns:** *undefined* \| *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hide
▸ **hide**(): *void*
使给定的图层不可见。
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverFeatureState
▸ **hoverFeatureState**(`enterCb?`: (`arg0`: {}) => *void*, `leaveCb?`: (`arg0`: {}) => *void*): *void*
每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。
##### Parameters
| Name | Type |
| :------ | :------ |
| `enterCb?` | (`arg0`: {}) => *void* |
| `leaveCb?` | (`arg0`: {}) => *void* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverLayer
▸ **hoverLayer**(`cb`: *any*): *any*
当鼠标悬停在这些图层中的要素上时触发回调。
##### Parameters
| Name | Type |
| :------ | :------ |
| `cb` | *any* |
**Returns:** *any*
A function to remove the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverPointer
▸ **hoverPointer**(): *void*
每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。
**Returns:** *void*
A function to remove the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverPopup
▸ **hoverPopup**(`htmlFunc`: *any*, `popupOptions?`: PopupOptions): *any*
将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。
**`example`** hoverPopup(f => `${f.properties.Name}
${f.properties.Description}`, { anchor: 'left' });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | *any* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### remove
▸ **remove**(): *void*
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setBackgroundColor
▸ **setBackgroundColor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex) |
**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
___
#### setBackgroundOpacity
▸ **setBackgroundOpacity**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex) |
**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
___
#### setBackgroundPattern
▸ **setBackgroundPattern**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex) |
**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
___
#### setFilter
▸ **setFilter**(`filter`: [*FilterSpecification*](#filterspecification)): *void*
替换一个图层的过滤器。
**`example`** setFilter(['==','level','0']]);
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `filter` | [*FilterSpecification*](#filterspecification) | New filter to set. |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setLayerStyle
▸ **setLayerStyle**(`style`: *any*): *void*
设置图层样式
##### Parameters
| Name | Type |
| :------ | :------ |
| `style` | *any* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setProperty
▸ **setProperty**(`prop`: *string* \| *object*, `value?`: *any*): *void*
在一个或多个图层上设置绘制或布局属性。
**`example`** setProperty('fillOpacity', 0.5)
##### Parameters
| Name | Type |
| :------ | :------ |
| `prop` | *string* \| *object* |
| `value?` | *any* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### show
▸ **show**(): *void*
使给定的图层可见。
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### toggle
▸ **toggle**(`state`: *boolean*): *boolean*
根据参数使给定的图层隐藏或可见。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `state` | *boolean* | True for visible, false for hidden. |
**Returns:** *boolean*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
[vjmap](#readmemd) / [Exports](#modulesmd) / BreathingApertureMarker
## Class: BreathingApertureMarker
呼吸的光圈.
### Hierarchy
- *MarkerBase*
↳ **BreathingApertureMarker**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [features](#features)
- [markersElement](#markerselement)
- [options](#options)
#### Methods
- [\_createMarker](#_createmarker)
- [\_getColorWithOpacity](#_getcolorwithopacity)
- [\_getTextContainer](#_gettextcontainer)
- [createMarker](#createmarker)
- [getColorWithOpacity](#getcolorwithopacity)
- [getElement](#getelement)
- [getLngLat](#getlnglat)
- [getMarkersElement](#getmarkerselement)
- [set16ToRgb](#set16torgb)
- [setDotSize](#setdotsize)
- [setFeatures](#setfeatures)
- [setMarkersColors](#setmarkerscolors)
- [setMarkersText](#setmarkerstext)
- [setMarkersTextColor](#setmarkerstextcolor)
- [setMarkersTextField](#setmarkerstextfield)
- [setMarkersTextFontSize](#setmarkerstextfontsize)
- [setMarkersWidth](#setmarkerswidth)
### Constructors
#### constructor
\+ **new BreathingApertureMarker**(`features`: *FeatureCollection* \| { `lngLat`: LngLatLike ; `text?`: *string* }, `options?`: [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd)): [*BreathingApertureMarker*](#classesdefaultbreathingaperturemarkermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `features` | *FeatureCollection* \| { `lngLat`: LngLatLike ; `text?`: *string* } |
| `options?` | [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd) |
**Returns:** [*BreathingApertureMarker*](#classesdefaultbreathingaperturemarkermd)
Overrides: MarkerBase.constructor
### Properties
#### features
• `Protected` **features**: *FeatureCollection* \| { `lngLat`: LngLatLike ; `text?`: *string* }
Inherited from: MarkerBase.features
___
#### markersElement
• `Protected` **markersElement**: *any*
Inherited from: MarkerBase.markersElement
___
#### options
• `Protected` **options**: [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd)
Inherited from: MarkerBase.options
### Methods
#### \_createMarker
▸ **_createMarker**(): *void*
**Returns:** *void*
___
#### \_getColorWithOpacity
▸ `Protected` **_getColorWithOpacity**(`color`: *string*, `opacity`: *string* \| *number*): *string*
##### Parameters
| Name | Type |
| :------ | :------ |
| `color` | *string* |
| `opacity` | *string* \| *number* |
**Returns:** *string*
Inherited from: MarkerBase.\_getColorWithOpacity
___
#### \_getTextContainer
▸ `Protected` **_getTextContainer**(`feature`: *any*, `className`: *string*): ``null`` \| HTMLDivElement
##### Parameters
| Name | Type |
| :------ | :------ |
| `feature` | *any* |
| `className` | *string* |
**Returns:** ``null`` \| HTMLDivElement
Inherited from: MarkerBase.\_getTextContainer
___
#### createMarker
▸ **createMarker**(`options?`: [*createMarkerOptions*](#interfacesdefaultcreatemarkeroptionsmd), `index?`: *number*): *Marker*
##### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | [*createMarkerOptions*](#interfacesdefaultcreatemarkeroptionsmd) |
| `index?` | *number* |
**Returns:** *Marker*
Inherited from: MarkerBase.createMarker
___
#### getColorWithOpacity
▸ **getColorWithOpacity**(`color`: *string*, `opacity`: *string* \| *number*): *string*
##### Parameters
| Name | Type |
| :------ | :------ |
| `color` | *string* |
| `opacity` | *string* \| *number* |
**Returns:** *string*
Inherited from: MarkerBase.getColorWithOpacity
___
#### getElement
▸ **getElement**(`index?`: *number*): *any*
##### Parameters
| Name | Type |
| :------ | :------ |
| `index?` | *number* |
**Returns:** *any*
Inherited from: MarkerBase.getElement
___
#### getLngLat
▸ **getLngLat**(`index?`: *number*): *any*
##### Parameters
| Name | Type |
| :------ | :------ |
| `index?` | *number* |
**Returns:** *any*
Inherited from: MarkerBase.getLngLat
___
#### getMarkersElement
▸ **getMarkersElement**(): *any*
**Returns:** *any*
Inherited from: MarkerBase.getMarkersElement
___
#### set16ToRgb
▸ **set16ToRgb**(`str`: *string*): *string*
##### Parameters
| Name | Type |
| :------ | :------ |
| `str` | *string* |
**Returns:** *string*
Inherited from: MarkerBase.set16ToRgb
___
#### setDotSize
▸ **setDotSize**(`size`: *number*, `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `size` | *number* |
| `index?` | *number* |
**Returns:** *void*
___
#### setFeatures
▸ **setFeatures**(`features`: *FeatureCollection*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `features` | *FeatureCollection* |
**Returns:** *void*
Inherited from: MarkerBase.setFeatures
___
#### setMarkersColors
▸ **setMarkersColors**(`colors`: *string*[], `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `colors` | *string*[] |
| `index?` | *number* |
**Returns:** *void*
___
#### setMarkersText
▸ **setMarkersText**(`text`: *string*, `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `text` | *string* |
| `index?` | *number* |
**Returns:** *void*
Inherited from: MarkerBase.setMarkersText
___
#### setMarkersTextColor
▸ **setMarkersTextColor**(`textColor`: *string*, `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `textColor` | *string* |
| `index?` | *number* |
**Returns:** *void*
Inherited from: MarkerBase.setMarkersTextColor
___
#### setMarkersTextField
▸ **setMarkersTextField**(`textField`: *string*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `textField` | *string* |
**Returns:** *void*
Inherited from: MarkerBase.setMarkersTextField
___
#### setMarkersTextFontSize
▸ **setMarkersTextFontSize**(`textFontSize`: *number*, `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `textFontSize` | *number* |
| `index?` | *number* |
**Returns:** *void*
Inherited from: MarkerBase.setMarkersTextFontSize
___
#### setMarkersWidth
▸ **setMarkersWidth**(`width`: *number*, `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `width` | *number* |
| `index?` | *number* |
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / ButtonGroupControl
## Class: ButtonGroupControl
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Methods
- [onAdd](#onadd)
- [onRemove](#onremove)
### Constructors
#### constructor
\+ **new ButtonGroupControl**(`options?`: *Record*): [*ButtonGroupControl*](#classesdefaultbuttongroupcontrolmd)
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `options` | *Record* | {} |
**Returns:** [*ButtonGroupControl*](#classesdefaultbuttongroupcontrolmd)
### Methods
#### onAdd
▸ **onAdd**(`map`: *Map*): HTMLElement
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
**Returns:** HTMLElement
___
#### onRemove
▸ **onRemove**(): *void*
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / Circle
## Class: Circle
创建圆符号图层.
### Hierarchy
- [*OverlayLayerBase*](#classesdefaultoverlaylayerbasemd)
↳ **Circle**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [\_map](#_map)
- [layerId](#layerid)
- [options](#options)
- [sourceId](#sourceid)
#### Methods
- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getCircleBlur](#getcircleblur)
- [getCircleColor](#getcirclecolor)
- [getCircleOpacity](#getcircleopacity)
- [getCirclePitchAlignment](#getcirclepitchalignment)
- [getCirclePitchScale](#getcirclepitchscale)
- [getCircleRadius](#getcircleradius)
- [getCircleSortKey](#getcirclesortkey)
- [getCircleStrokeColor](#getcirclestrokecolor)
- [getCircleStrokeOpacity](#getcirclestrokeopacity)
- [getCircleStrokeWidth](#getcirclestrokewidth)
- [getCircleTranslate](#getcircletranslate)
- [getCircleTranslateAnchor](#getcircletranslateanchor)
- [getData](#getdata)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getSourceId](#getsourceid)
- [getVisibility](#getvisibility)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setCircleBlur](#setcircleblur)
- [setCircleColor](#setcirclecolor)
- [setCircleOpacity](#setcircleopacity)
- [setCirclePitchAlignment](#setcirclepitchalignment)
- [setCirclePitchScale](#setcirclepitchscale)
- [setCircleRadius](#setcircleradius)
- [setCircleSortKey](#setcirclesortkey)
- [setCircleStrokeColor](#setcirclestrokecolor)
- [setCircleStrokeOpacity](#setcirclestrokeopacity)
- [setCircleStrokeWidth](#setcirclestrokewidth)
- [setCircleTranslate](#setcircletranslate)
- [setCircleTranslateAnchor](#setcircletranslateanchor)
- [setData](#setdata)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setProperty](#setproperty)
- [setVisibility](#setvisibility)
- [show](#show)
- [toggle](#toggle)
### Constructors
#### constructor
\+ **new Circle**(`options`: [*CircleOptions*](#interfacesdefaultcircleoptionsmd)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `options` | [*CircleOptions*](#interfacesdefaultcircleoptionsmd) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
### Properties
#### \_map
• `Optional` **\_map**: *Map*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[_map](#_map)
___
#### layerId
• `Optional` **layerId**: *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[layerId](#layerid)
___
#### options
• **options**: [*CircleOptions*](#interfacesdefaultcircleoptionsmd)
___
#### sourceId
• `Optional` **sourceId**: *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[sourceId](#sourceid)
### Methods
#### addTo
▸ **addTo**(`map`: *Map*, `beforeId?`: *string*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
| `beforeId?` | *string* |
**Returns:** *void*
Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### clickLayer
▸ **clickLayer**(`cb`: *any*): *any*
每当单击这些图层中的要素时都会触发回调。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cb` | *any* | Callback that receives event with .features property |
**Returns:** *any*
A function that removes the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### clickPopup
▸ **clickPopup**(`htmlFunc`: (`arg0`: {}) => *void*, `popupOptions?`: PopupOptions): *any*
每当单击这些图层中的要素时都会显示一个弹出窗口。
**`example`** clickPopup(f => `${f.properties.Name}
${f.properties.Description}`, { maxWidth: 500 });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | (`arg0`: {}) => *void* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
A function that removes the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getCircleBlur
▸ **getCircleBlur**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleColor
▸ **getCircleColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleOpacity
▸ **getCircleOpacity**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCirclePitchAlignment
▸ **getCirclePitchAlignment**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
___
#### getCirclePitchScale
▸ **getCirclePitchScale**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
___
#### getCircleRadius
▸ **getCircleRadius**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleSortKey
▸ **getCircleSortKey**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleStrokeColor
▸ **getCircleStrokeColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleStrokeOpacity
▸ **getCircleStrokeOpacity**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleStrokeWidth
▸ **getCircleStrokeWidth**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleTranslate
▸ **getCircleTranslate**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>
___
#### getCircleTranslateAnchor
▸ **getCircleTranslateAnchor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
___
#### getData
▸ **getData**(): *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
获取数据源的数据
**Returns:** *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getLayerId
▸ **getLayerId**(): *undefined* \| *string*
获取图层ID
**Returns:** *undefined* \| *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getLayerStyle
▸ **getLayerStyle**(): [*LayerSpecification*](#layerspecification)
根据样式规范，获取给定图层 ID 的图层定义。
**Returns:** [*LayerSpecification*](#layerspecification)
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getSourceId
▸ **getSourceId**(): *undefined* \| *string*
获取数据源ID
**Returns:** *undefined* \| *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getVisibility
▸ **getVisibility**(): ``"visible"`` \| ``"none"``
**Returns:** ``"visible"`` \| ``"none"``
___
#### hide
▸ **hide**(): *void*
使给定的图层不可见。
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverFeatureState
▸ **hoverFeatureState**(`enterCb?`: (`arg0`: {}) => *void*, `leaveCb?`: (`arg0`: {}) => *void*): *void*
每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。
##### Parameters
| Name | Type |
| :------ | :------ |
| `enterCb?` | (`arg0`: {}) => *void* |
| `leaveCb?` | (`arg0`: {}) => *void* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverLayer
▸ **hoverLayer**(`cb`: *any*): *any*
当鼠标悬停在这些图层中的要素上时触发回调。
##### Parameters
| Name | Type |
| :------ | :------ |
| `cb` | *any* |
**Returns:** *any*
A function to remove the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverPointer
▸ **hoverPointer**(): *void*
每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。
**Returns:** *void*
A function to remove the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverPopup
▸ **hoverPopup**(`htmlFunc`: *any*, `popupOptions?`: PopupOptions): *any*
将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。
**`example`** hoverPopup(f => `${f.properties.Name}
${f.properties.Description}`, { anchor: 'left' });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | *any* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### remove
▸ **remove**(): *void*
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setCircleBlur
▸ **setCircleBlur**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleColor
▸ **setCircleColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleOpacity
▸ **setCircleOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCirclePitchAlignment
▸ **setCirclePitchAlignment**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCirclePitchScale
▸ **setCirclePitchScale**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleRadius
▸ **setCircleRadius**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleSortKey
▸ **setCircleSortKey**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleStrokeColor
▸ **setCircleStrokeColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleStrokeOpacity
▸ **setCircleStrokeOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleStrokeWidth
▸ **setCircleStrokeWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleTranslate
▸ **setCircleTranslate**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\> |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleTranslateAnchor
▸ **setCircleTranslateAnchor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setData
▸ **setData**(`data`: *any*): *void*
替换 GeoJSON 图层的当前数据。
##### Parameters
| Name | Type |
| :------ | :------ |
| `data` | *any* |
**Returns:** *void*
___
#### setFilter
▸ **setFilter**(`filter`: [*FilterSpecification*](#filterspecification)): *void*
替换一个图层的过滤器。
**`example`** setFilter(['==','level','0']]);
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `filter` | [*FilterSpecification*](#filterspecification) | New filter to set. |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setLayerStyle
▸ **setLayerStyle**(`style`: *any*): *void*
设置图层样式
##### Parameters
| Name | Type |
| :------ | :------ |
| `style` | *any* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setProperty
▸ **setProperty**(`prop`: *string* \| *object*, `value?`: *any*): *void*
在一个或多个图层上设置绘制或布局属性。
**`example`** setProperty('fillOpacity', 0.5)
##### Parameters
| Name | Type |
| :------ | :------ |
| `prop` | *string* \| *object* |
| `value?` | *any* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setVisibility
▸ **setVisibility**(`value`: ``"visible"`` \| ``"none"``): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | ``"visible"`` \| ``"none"`` |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### show
▸ **show**(): *void*
使给定的图层可见。
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### toggle
▸ **toggle**(`state`: *boolean*): *boolean*
根据参数使给定的图层隐藏或可见。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `state` | *boolean* | True for visible, false for hidden. |
**Returns:** *boolean*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
[vjmap](#readmemd) / [Exports](#modulesmd) / CircleEdge
## Class: CircleEdge
创建只有边框的圆或圆弧
### Hierarchy
- [*Polyline*](#classesdefaultpolylinemd)
↳ **CircleEdge**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [\_map](#_map)
- [layerId](#layerid)
- [options](#options)
- [sourceId](#sourceid)
#### Methods
- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getCenter](#getcenter)
- [getData](#getdata)
- [getEndAngle](#getendangle)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getLineBlur](#getlineblur)
- [getLineCap](#getlinecap)
- [getLineColor](#getlinecolor)
- [getLineDasharray](#getlinedasharray)
- [getLineGapWidth](#getlinegapwidth)
- [getLineGradient](#getlinegradient)
- [getLineJoin](#getlinejoin)
- [getLineMiterMimit](#getlinemitermimit)
- [getLineOffset](#getlineoffset)
- [getLineOpacity](#getlineopacity)
- [getLinePattern](#getlinepattern)
- [getLineRoundLimit](#getlineroundlimit)
- [getLineSortKey](#getlinesortkey)
- [getLineTranslate](#getlinetranslate)
- [getLineTranslateAnchor](#getlinetranslateanchor)
- [getLineWidth](#getlinewidth)
- [getPoints](#getpoints)
- [getRadius](#getradius)
- [getSourceId](#getsourceid)
- [getStartAngle](#getstartangle)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setCenter](#setcenter)
- [setData](#setdata)
- [setEndAngle](#setendangle)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setLineBlur](#setlineblur)
- [setLineCap](#setlinecap)
- [setLineColor](#setlinecolor)
- [setLineDasharray](#setlinedasharray)
- [setLineGapWidth](#setlinegapwidth)
- [setLineGradient](#setlinegradient)
- [setLineJoin](#setlinejoin)
- [setLineMiterMimit](#setlinemitermimit)
- [setLineOffset](#setlineoffset)
- [setLineOpacity](#setlineopacity)
- [setLinePattern](#setlinepattern)
- [setLineRoundLimit](#setlineroundlimit)
- [setLineSortKey](#setlinesortkey)
- [setLineTranslate](#setlinetranslate)
- [setLineTranslateAnchor](#setlinetranslateanchor)
- [setLineWidth](#setlinewidth)
- [setPoints](#setpoints)
- [setProperty](#setproperty)
- [setRadius](#setradius)
- [setStartAngle](#setstartangle)
- [show](#show)
- [toggle](#toggle)
- [updateData](#updatedata)
### Constructors
#### constructor
\+ **new CircleEdge**(`options`: [*CircleEdgeOptions*](#interfacesdefaultcircleedgeoptionsmd)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `options` | [*CircleEdgeOptions*](#interfacesdefaultcircleedgeoptionsmd) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Overrides: [Polyline](#classesdefaultpolylinemd)
### Properties
#### \_map
• `Optional` **\_map**: *Map*
Inherited from: [Polyline](#classesdefaultpolylinemd).[_map](#_map)
___
#### layerId
• `Optional` **layerId**: *string*
Inherited from: [Polyline](#classesdefaultpolylinemd).[layerId](#layerid)
___
#### options
• **options**: [*PolylineOptions*](#interfacesdefaultpolylineoptionsmd)
Inherited from: [Polyline](#classesdefaultpolylinemd).[options](#options)
___
#### sourceId
• `Optional` **sourceId**: *string*
Inherited from: [Polyline](#classesdefaultpolylinemd).[sourceId](#sourceid)
### Methods
#### addTo
▸ **addTo**(`map`: *Map*, `beforeId?`: *string*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
| `beforeId?` | *string* |
**Returns:** *void*
Overrides: [Polyline](#classesdefaultpolylinemd)
___
#### clickLayer
▸ **clickLayer**(`cb`: *any*): *any*
每当单击这些图层中的要素时都会触发回调。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cb` | *any* | Callback that receives event with .features property |
**Returns:** *any*
A function that removes the handler.
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### clickPopup
▸ **clickPopup**(`htmlFunc`: (`arg0`: {}) => *void*, `popupOptions?`: PopupOptions): *any*
每当单击这些图层中的要素时都会显示一个弹出窗口。
**`example`** clickPopup(f => `${f.properties.Name}
${f.properties.Description}`, { maxWidth: 500 });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | (`arg0`: {}) => *void* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
A function that removes the handler.
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getCenter
▸ **getCenter**(): [*GeoPointLike*](#geopointlike)
得到中心点。
**Returns:** [*GeoPointLike*](#geopointlike)
___
#### getData
▸ **getData**(): *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
获取数据源的数据
**Returns:** *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getEndAngle
▸ **getEndAngle**(): *number*
得到结束角度。
**Returns:** *number*
___
#### getLayerId
▸ **getLayerId**(): *undefined* \| *string*
获取图层ID
**Returns:** *undefined* \| *string*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLayerStyle
▸ **getLayerStyle**(): [*LayerSpecification*](#layerspecification)
根据样式规范，获取给定图层 ID 的图层定义。
**Returns:** [*LayerSpecification*](#layerspecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineBlur
▸ **getLineBlur**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineCap
▸ **getLineCap**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\>
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\>
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineColor
▸ **getLineColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineDasharray
▸ **getLineDasharray**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineGapWidth
▸ **getLineGapWidth**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineGradient
▸ **getLineGradient**(): [*ExpressionSpecificationEx*](#expressionspecificationex)
**Returns:** [*ExpressionSpecificationEx*](#expressionspecificationex)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineJoin
▸ **getLineJoin**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\>
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\>
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineMiterMimit
▸ **getLineMiterMimit**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineOffset
▸ **getLineOffset**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineOpacity
▸ **getLineOpacity**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLinePattern
▸ **getLinePattern**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineRoundLimit
▸ **getLineRoundLimit**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineSortKey
▸ **getLineSortKey**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineTranslate
▸ **getLineTranslate**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineTranslateAnchor
▸ **getLineTranslateAnchor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineWidth
▸ **getLineWidth**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getPoints
▸ **getPoints**(): *number*
得到离散化的点的个数。
**Returns:** *number*
___
#### getRadius
▸ **getRadius**(): *number*
得到半径。
**Returns:** *number*
___
#### getSourceId
▸ **getSourceId**(): *undefined* \| *string*
获取数据源ID
**Returns:** *undefined* \| *string*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getStartAngle
▸ **getStartAngle**(): *number*
得到开始角度。
**Returns:** *number*
___
#### hide
▸ **hide**(): *void*
使给定的图层不可见。
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### hoverFeatureState
▸ **hoverFeatureState**(`enterCb?`: (`arg0`: {}) => *void*, `leaveCb?`: (`arg0`: {}) => *void*): *void*
每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。
##### Parameters
| Name | Type |
| :------ | :------ |
| `enterCb?` | (`arg0`: {}) => *void* |
| `leaveCb?` | (`arg0`: {}) => *void* |
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### hoverLayer
▸ **hoverLayer**(`cb`: *any*): *any*
当鼠标悬停在这些图层中的要素上时触发回调。
##### Parameters
| Name | Type |
| :------ | :------ |
| `cb` | *any* |
**Returns:** *any*
A function to remove the handler.
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### hoverPointer
▸ **hoverPointer**(): *void*
每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。
**Returns:** *void*
A function to remove the handler.
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### hoverPopup
▸ **hoverPopup**(`htmlFunc`: *any*, `popupOptions?`: PopupOptions): *any*
将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。
**`example`** hoverPopup(f => `${f.properties.Name}
${f.properties.Description}`, { anchor: 'left' });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | *any* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### remove
▸ **remove**(): *void*
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setCenter
▸ **setCenter**(`value`: [*GeoPointLike*](#geopointlike), `bFocusUpdateData?`: *boolean*): [*CircleEdge*](#classesdefaultcircleedgemd)
设置中心点。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | [*GeoPointLike*](#geopointlike) | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
___
#### setData
▸ **setData**(`data`: *any*): *void*
替换 GeoJSON 图层的当前数据。
##### Parameters
| Name | Type |
| :------ | :------ |
| `data` | *any* |
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setEndAngle
▸ **setEndAngle**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleEdge*](#classesdefaultcircleedgemd)
设置结束角度。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
___
#### setFilter
▸ **setFilter**(`filter`: [*FilterSpecification*](#filterspecification)): *void*
替换一个图层的过滤器。
**`example`** setFilter(['==','level','0']]);
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `filter` | [*FilterSpecification*](#filterspecification) | New filter to set. |
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLayerStyle
▸ **setLayerStyle**(`style`: *any*): *void*
设置图层样式
##### Parameters
| Name | Type |
| :------ | :------ |
| `style` | *any* |
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineBlur
▸ **setLineBlur**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineCap
▸ **setLineCap**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\>): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\> |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineColor
▸ **setLineColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineDasharray
▸ **setLineDasharray**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineGapWidth
▸ **setLineGapWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineGradient
▸ **setLineGradient**(`value`: [*ExpressionSpecificationEx*](#expressionspecificationex)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*ExpressionSpecificationEx*](#expressionspecificationex) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineJoin
▸ **setLineJoin**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\>): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\> |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineMiterMimit
▸ **setLineMiterMimit**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineOffset
▸ **setLineOffset**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineOpacity
▸ **setLineOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLinePattern
▸ **setLinePattern**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineRoundLimit
▸ **setLineRoundLimit**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineSortKey
▸ **setLineSortKey**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineTranslate
▸ **setLineTranslate**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\> |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineTranslateAnchor
▸ **setLineTranslateAnchor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineWidth
▸ **setLineWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setPoints
▸ **setPoints**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleEdge*](#classesdefaultcircleedgemd)
设置离散化的点的个数。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
___
#### setProperty
▸ **setProperty**(`prop`: *string* \| *object*, `value?`: *any*): *void*
在一个或多个图层上设置绘制或布局属性。
**`example`** setProperty('fillOpacity', 0.5)
##### Parameters
| Name | Type |
| :------ | :------ |
| `prop` | *string* \| *object* |
| `value?` | *any* |
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setRadius
▸ **setRadius**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleEdge*](#classesdefaultcircleedgemd)
设置半径。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
___
#### setStartAngle
▸ **setStartAngle**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleEdge*](#classesdefaultcircleedgemd)
设置开始角度。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
___
#### show
▸ **show**(): *void*
使给定的图层可见。
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### toggle
▸ **toggle**(`state`: *boolean*): *boolean*
根据参数使给定的图层隐藏或可见。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `state` | *boolean* | True for visible, false for hidden. |
**Returns:** *boolean*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### updateData
▸ **updateData**(): *void*
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / CircleFill
## Class: CircleFill
创建填充的圆或圆弧
### Hierarchy
- [*Polygon*](#classesdefaultpolygonmd)
↳ **CircleFill**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [\_map](#_map)
- [layerId](#layerid)
- [options](#options)
- [sourceId](#sourceid)
#### Methods
- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getCenter](#getcenter)
- [getData](#getdata)
- [getEndAngle](#getendangle)
- [getFillAntialias](#getfillantialias)
- [getFillColor](#getfillcolor)
- [getFillOpacity](#getfillopacity)
- [getFillOutlineColor](#getfilloutlinecolor)
- [getFillPattern](#getfillpattern)
- [getFillSortKey](#getfillsortkey)
- [getFillTranslate](#getfilltranslate)
- [getFillTranslateAnchor](#getfilltranslateanchor)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getPoints](#getpoints)
- [getRadius](#getradius)
- [getSourceId](#getsourceid)
- [getStartAngle](#getstartangle)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setCenter](#setcenter)
- [setData](#setdata)
- [setEndAngle](#setendangle)
- [setFillAntialias](#setfillantialias)
- [setFillColor](#setfillcolor)
- [setFillOpacity](#setfillopacity)
- [setFillOutlineColor](#setfilloutlinecolor)
- [setFillPattern](#setfillpattern)
- [setFillSortKey](#setfillsortkey)
- [setFillTranslate](#setfilltranslate)
- [setFillTranslateAnchor](#setfilltranslateanchor)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setPoints](#setpoints)
- [setProperty](#setproperty)
- [setRadius](#setradius)
- [setStartAngle](#setstartangle)
- [show](#show)
- [toggle](#toggle)
- [updateData](#updatedata)
### Constructors
#### constructor
\+ **new CircleFill**(`options`: [*CircleFillOptions*](#interfacesdefaultcirclefilloptionsmd)): [*CircleFill*](#classesdefaultcirclefillmd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `options` | [*CircleFillOptions*](#interfacesdefaultcirclefilloptionsmd) |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
Overrides: [Polygon](#classesdefaultpolygonmd)
### Properties
#### \_map
• `Optional` **\_map**: *Map*
Inherited from: [Polygon](#classesdefaultpolygonmd).[_map](#_map)
___
#### layerId
• `Optional` **layerId**: *string*
Inherited from: [Polygon](#classesdefaultpolygonmd).[layerId](#layerid)
___
#### options
• **options**: [*PolygonOptions*](#interfacesdefaultpolygonoptionsmd)
Inherited from: [Polygon](#classesdefaultpolygonmd).[options](#options)
___
#### sourceId
• `Optional` **sourceId**: *string*
Inherited from: [Polygon](#classesdefaultpolygonmd).[sourceId](#sourceid)
### Methods
#### addTo
▸ **addTo**(`map`: *Map*, `beforeId?`: *string*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
| `beforeId?` | *string* |
**Returns:** *void*
Overrides: [Polygon](#classesdefaultpolygonmd)
___
#### clickLayer
▸ **clickLayer**(`cb`: *any*): *any*
每当单击这些图层中的要素时都会触发回调。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cb` | *any* | Callback that receives event with .features property |
**Returns:** *any*
A function that removes the handler.
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### clickPopup
▸ **clickPopup**(`htmlFunc`: (`arg0`: {}) => *void*, `popupOptions?`: PopupOptions): *any*
每当单击这些图层中的要素时都会显示一个弹出窗口。
**`example`** clickPopup(f => `${f.properties.Name}
${f.properties.Description}`, { maxWidth: 500 });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | (`arg0`: {}) => *void* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
A function that removes the handler.
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getCenter
▸ **getCenter**(): [*GeoPointLike*](#geopointlike)
得到中心点。
**Returns:** [*GeoPointLike*](#geopointlike)
___
#### getData
▸ **getData**(): *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
获取数据源的数据
**Returns:** *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getEndAngle
▸ **getEndAngle**(): *number*
得到结束角度。
**Returns:** *number*
___
#### getFillAntialias
▸ **getFillAntialias**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
获取图层的“填充抗锯齿”绘制属性。
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getFillColor
▸ **getFillColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
获取图层的 `fill-color` 绘制属性。
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getFillOpacity
▸ **getFillOpacity**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
获取图层的 `fill-opacity` 绘制属性。
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getFillOutlineColor
▸ **getFillOutlineColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
获取图层的 `fill-outline-color` 绘制属性。
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getFillPattern
▸ **getFillPattern**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
获取图层的`fill-pattern` 绘制属性。
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getFillSortKey
▸ **getFillSortKey**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
获取图层的`fill-sort-key` 布局属性.
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getFillTranslate
▸ **getFillTranslate**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>
获取图层的 `fill-translate` 绘制属性。
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getFillTranslateAnchor
▸ **getFillTranslateAnchor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
获取图层的 `fill-translate-anchor` 绘制属性。
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getLayerId
▸ **getLayerId**(): *undefined* \| *string*
获取图层ID
**Returns:** *undefined* \| *string*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getLayerStyle
▸ **getLayerStyle**(): [*LayerSpecification*](#layerspecification)
根据样式规范，获取给定图层 ID 的图层定义。
**Returns:** [*LayerSpecification*](#layerspecification)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getPoints
▸ **getPoints**(): *number*
得到离散化的点的个数。
**Returns:** *number*
___
#### getRadius
▸ **getRadius**(): *number*
得到半径。
**Returns:** *number*
___
#### getSourceId
▸ **getSourceId**(): *undefined* \| *string*
获取数据源ID
**Returns:** *undefined* \| *string*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getStartAngle
▸ **getStartAngle**(): *number*
得到开始角度。
**Returns:** *number*
___
#### hide
▸ **hide**(): *void*
使给定的图层不可见。
**Returns:** *void*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### hoverFeatureState
▸ **hoverFeatureState**(`enterCb?`: (`arg0`: {}) => *void*, `leaveCb?`: (`arg0`: {}) => *void*): *void*
每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。
##### Parameters
| Name | Type |
| :------ | :------ |
| `enterCb?` | (`arg0`: {}) => *void* |
| `leaveCb?` | (`arg0`: {}) => *void* |
**Returns:** *void*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### hoverLayer
▸ **hoverLayer**(`cb`: *any*): *any*
当鼠标悬停在这些图层中的要素上时触发回调。
##### Parameters
| Name | Type |
| :------ | :------ |
| `cb` | *any* |
**Returns:** *any*
A function to remove the handler.
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### hoverPointer
▸ **hoverPointer**(): *void*
每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。
**Returns:** *void*
A function to remove the handler.
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### hoverPopup
▸ **hoverPopup**(`htmlFunc`: *any*, `popupOptions?`: PopupOptions): *any*
将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。
**`example`** hoverPopup(f => `${f.properties.Name}
${f.properties.Description}`, { anchor: 'left' });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | *any* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### remove
▸ **remove**(): *void*
**Returns:** *void*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setCenter
▸ **setCenter**(`value`: [*GeoPointLike*](#geopointlike), `bFocusUpdateData?`: *boolean*): [*CircleFill*](#classesdefaultcirclefillmd)
设置中心点。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | [*GeoPointLike*](#geopointlike) | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
___
#### setData
▸ **setData**(`data`: *any*): *void*
替换 GeoJSON 图层的当前数据。
##### Parameters
| Name | Type |
| :------ | :------ |
| `data` | *any* |
**Returns:** *void*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setEndAngle
▸ **setEndAngle**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleFill*](#classesdefaultcirclefillmd)
设置结束角度。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
___
#### setFillAntialias
▸ **setFillAntialias**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)): [*CircleFill*](#classesdefaultcirclefillmd)
为一个或多个图层设置`fill-antialias` 绘制属性。
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex) |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setFillColor
▸ **setFillColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleFill*](#classesdefaultcirclefillmd)
为一个或多个图层设置`fill-color` 绘画属性。
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setFillOpacity
▸ **setFillOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleFill*](#classesdefaultcirclefillmd)
为一个或多个图层设置`fill-opacity` 绘画属性。
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setFillOutlineColor
▸ **setFillOutlineColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleFill*](#classesdefaultcirclefillmd)
为一个或多个图层设置`fill-outline-color` 绘画属性。
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setFillPattern
▸ **setFillPattern**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleFill*](#classesdefaultcirclefillmd)
为一个或多个图层设置`fill-pattern` 绘制属性。
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setFillSortKey
▸ **setFillSortKey**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleFill*](#classesdefaultcirclefillmd)
为一层或多层设置`fill-sort-key`布局属性。
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setFillTranslate
▸ **setFillTranslate**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleFill*](#classesdefaultcirclefillmd)
为一个或多个图层设置`fill-translate` 绘制属性。
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setFillTranslateAnchor
▸ **setFillTranslateAnchor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*CircleFill*](#classesdefaultcirclefillmd)
为一个或多个图层设置`fill-translate-anchor` 绘制属性。
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setFilter
▸ **setFilter**(`filter`: [*FilterSpecification*](#filterspecification)): *void*
替换一个图层的过滤器。
**`example`** setFilter(['==','level','0']]);
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `filter` | [*FilterSpecification*](#filterspecification) | New filter to set. |
**Returns:** *void*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setLayerStyle
▸ **setLayerStyle**(`style`: *any*): *void*
设置图层样式
##### Parameters
| Name | Type |
| :------ | :------ |
| `style` | *any* |
**Returns:** *void*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setPoints
▸ **setPoints**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleFill*](#classesdefaultcirclefillmd)
设置离散化的点的个数。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
___
#### setProperty
▸ **setProperty**(`prop`: *string* \| *object*, `value?`: *any*): *void*
在一个或多个图层上设置绘制或布局属性。
**`example`** setProperty('fillOpacity', 0.5)
##### Parameters
| Name | Type |
| :------ | :------ |
| `prop` | *string* \| *object* |
| `value?` | *any* |
**Returns:** *void*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### setRadius
▸ **setRadius**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleFill*](#classesdefaultcirclefillmd)
设置半径。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
___
#### setStartAngle
▸ **setStartAngle**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleFill*](#classesdefaultcirclefillmd)
设置开始角度。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
___
#### show
▸ **show**(): *void*
使给定的图层可见。
**Returns:** *void*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### toggle
▸ **toggle**(`state`: *boolean*): *boolean*
根据参数使给定的图层隐藏或可见。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `state` | *boolean* | True for visible, false for hidden. |
**Returns:** *boolean*
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### updateData
▸ **updateData**(): *void*
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / CloseEvent
## Class: CloseEvent
### Hierarchy
- [*WebSocketEvent*](#classeswebsocketeventmd)
↳ **CloseEvent**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [code](#code)
- [reason](#reason)
- [target](#target)
- [type](#type)
- [wasClean](#wasclean)
### Constructors
#### constructor
\+ **new CloseEvent**(`code?`: *number*, `reason?`: *string*, `target`: *any*): [*CloseEvent*](#classescloseeventmd)
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `code` | *number* | 1000 |
| `reason` | *string* | "" |
| `target` | *any* | - |
**Returns:** [*CloseEvent*](#classescloseeventmd)
Overrides: [WebSocketEvent](#classeswebsocketeventmd)
### Properties
#### code
• **code**: *number*
___
#### reason
• **reason**: *string*
___
#### target
• **target**: *any*
Inherited from: [WebSocketEvent](#classeswebsocketeventmd).[target](#target)
___
#### type
• **type**: *string*
Inherited from: [WebSocketEvent](#classeswebsocketeventmd).[type](#type)
___
#### wasClean
• **wasClean**: *boolean*= true
[vjmap](#readmemd) / [Exports](#modulesmd) / Compare
## Class: Compare
### Hierarchy
- *Evented*
↳ **Compare**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Methods
- [remove](#remove)
- [setSlider](#setslider)
### Constructors
#### constructor
\+ **new Compare**(`a`: *Map*, `b`: *Map*, `container`: *string* \| Element, `options?`: { `mousemove`: *boolean* ; `orientation`: ``"vertical"`` \| ``"horizontal"`` }): [*Compare*](#classesdefaultcomparemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `a` | *Map* |
| `b` | *Map* |
| `container` | *string* \| Element |
| `options?` | *object* |
| `options.mousemove` | *boolean* |
| `options.orientation` | ``"vertical"`` \| ``"horizontal"`` |
**Returns:** [*Compare*](#classesdefaultcomparemd)
Overrides: Evented.constructor
### Methods
#### remove
▸ **remove**(): *void*
**Returns:** *void*
___
#### setSlider
▸ **setSlider**(`x`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `x` | *number* |
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / ContextMenu
## Class: ContextMenu
上下文菜单.
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Methods
- [add](#add)
- [hide](#hide)
- [show](#show)
- [toggle](#toggle)
### Constructors
#### constructor
\+ **new ContextMenu**(`opts`: [*ContextMenuOptions*](#interfacesdefaultcontextmenuoptionsmd)): [*ContextMenu*](#classesdefaultcontextmenumd)
Creates a new ContextMenu menu
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `opts` | [*ContextMenuOptions*](#interfacesdefaultcontextmenuoptionsmd) | options which build the menu e.g. position and items |
**Returns:** [*ContextMenu*](#classesdefaultcontextmenumd)
### Methods
#### add
▸ **add**(`item`: *any*): *void*
Adds item to this ContextMenu menu instance
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `item` | *any* | item to add to the ContextMenu menu |
**Returns:** *void*
___
#### hide
▸ **hide**(): *void*
Hides this ContextMenu menu
**Returns:** *void*
___
#### show
▸ **show**(): *void*
Makes this ContextMenu menu visible
**Returns:** *void*
___
#### toggle
▸ **toggle**(): *void*
Toggle visibility of menu
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / Db2dPolyline
## Class: Db2dPolyline
`Db2dPolyline` 二维多段线实体.
### Hierarchy
- [*DbCurve*](#classesdefaultdbcurvemd)
↳ **Db2dPolyline**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [closed](#closed)
- [color](#color)
- [colorIndex](#colorindex)
- [elevation](#elevation)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [points](#points)
- [polyType](#polytype)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new Db2dPolyline**(`prop?`: [*IDb2dPolyline*](#interfacesdefaultidb2dpolylinemd)): [*Db2dPolyline*](#classesdefaultdb2dpolylinemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDb2dPolyline*](#interfacesdefaultidb2dpolylinemd) | {} |
**Returns:** [*Db2dPolyline*](#classesdefaultdb2dpolylinemd)
Overrides: [DbCurve](#classesdefaultdbcurvemd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[alpha](#alpha)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneObjectId](#cloneobjectid)
___
#### closed
• `Optional` **closed**: *boolean*
是否闭合.
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[colorIndex](#colorindex)
___
#### elevation
• `Optional` **elevation**: *number*
高程.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[matrix](#matrix)
___
#### points
• `Optional` **points**: [*number*, *number*, *undefined* \| *number*][]
坐标.
___
#### polyType
• `Optional` **polyType**: [*k2dSimplePoly*](#k2dsimplepoly) \| [*k2dFitCurvePoly*](#k2dfitcurvepoly) \| [*k2dQuadSplinePoly*](#k2dquadsplinepoly) \| [*k2dCubicSplinePoly*](#k2dcubicsplinepoly)
2d折线类型
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / Db2LineAngularDimension
## Class: Db2LineAngularDimension
`Db2LineAngularDimension` 角度标注[两条线]实体.
### Hierarchy
- [*DbDimension*](#classesdefaultdbdimensionmd)
↳ **Db2LineAngularDimension**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [arcPoint](#arcpoint)
- [arrowColor](#arrowcolor)
- [arrowSize](#arrowsize)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [dimDec](#dimdec)
- [dimRnd](#dimrnd)
- [dimScale](#dimscale)
- [dimStyle](#dimstyle)
- [layer](#layer)
- [lineColor](#linecolor)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [textColor](#textcolor)
- [textHeight](#textheight)
- [textPosition](#textposition)
- [textRotation](#textrotation)
- [typename](#typename)
- [visibility](#visibility)
- [xLine1End](#xline1end)
- [xLine1Start](#xline1start)
- [xLine2End](#xline2end)
- [xLine2Start](#xline2start)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new Db2LineAngularDimension**(`prop?`: [*IDb2LineAngularDimension*](#interfacesdefaultidb2lineangulardimensionmd)): [*Db2LineAngularDimension*](#classesdefaultdb2lineangulardimensionmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDb2LineAngularDimension*](#interfacesdefaultidb2lineangulardimensionmd) | {} |
**Returns:** [*Db2LineAngularDimension*](#classesdefaultdb2lineangulardimensionmd)
Overrides: [DbDimension](#classesdefaultdbdimensionmd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[alpha](#alpha)
___
#### arcPoint
• `Optional` **arcPoint**: [*number*, *number*, *undefined* \| *number*][]
圆弧点位置.
___
#### arrowColor
• `Optional` **arrowColor**: *number*
箭头颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowColor](#arrowcolor)
___
#### arrowSize
• `Optional` **arrowSize**: *number*
箭头大小.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowSize](#arrowsize)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[colorIndex](#colorindex)
___
#### dimDec
• `Optional` **dimDec**: *number*
设置标注主单位显示的小数位位数.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimDec](#dimdec)
___
#### dimRnd
• `Optional` **dimRnd**: *number*
所有标注距离舍入到指定值.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimRnd](#dimrnd)
___
#### dimScale
• `Optional` **dimScale**: *number*
注记比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimScale](#dimscale)
___
#### dimStyle
• `Optional` **dimStyle**: *string*
标注样式.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimStyle](#dimstyle)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[layer](#layer)
___
#### lineColor
• `Optional` **lineColor**: *number*
引线颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineColor](#linecolor)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[matrix](#matrix)
___
#### textColor
• `Optional` **textColor**: *number*
文本颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textColor](#textcolor)
___
#### textHeight
• `Optional` **textHeight**: *number*
文字高度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textHeight](#textheight)
___
#### textPosition
• `Optional` **textPosition**: [*number*, *number*, *undefined* \| *number*][]
文字位置.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textPosition](#textposition)
___
#### textRotation
• `Optional` **textRotation**: *number*
文字旋转角度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textRotation](#textrotation)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[visibility](#visibility)
___
#### xLine1End
• `Optional` **xLine1End**: [*number*, *number*, *undefined* \| *number*][]
线1终点.
___
#### xLine1Start
• `Optional` **xLine1Start**: [*number*, *number*, *undefined* \| *number*][]
线1起点.
___
#### xLine2End
• `Optional` **xLine2End**: [*number*, *number*, *undefined* \| *number*][]
线2终点.
___
#### xLine2Start
• `Optional` **xLine2Start**: [*number*, *number*, *undefined* \| *number*][]
线2起点.
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / Db3dPolyline
## Class: Db3dPolyline
`Db3dPolyline` 三维多段线实体.
### Hierarchy
- [*DbCurve*](#classesdefaultdbcurvemd)
↳ **Db3dPolyline**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [closed](#closed)
- [color](#color)
- [colorIndex](#colorindex)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [points](#points)
- [polyType](#polytype)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new Db3dPolyline**(`prop?`: [*IDb3dPolyline*](#interfacesdefaultidb3dpolylinemd)): [*Db3dPolyline*](#classesdefaultdb3dpolylinemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDb3dPolyline*](#interfacesdefaultidb3dpolylinemd) | {} |
**Returns:** [*Db3dPolyline*](#classesdefaultdb3dpolylinemd)
Overrides: [DbCurve](#classesdefaultdbcurvemd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[alpha](#alpha)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneObjectId](#cloneobjectid)
___
#### closed
• `Optional` **closed**: *boolean*
是否闭合.
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[colorIndex](#colorindex)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[matrix](#matrix)
___
#### points
• `Optional` **points**: [*number*, *number*, *undefined* \| *number*][]
坐标.
___
#### polyType
• `Optional` **polyType**: [*k3dSimplePoly*](#k3dsimplepoly) \| [*k3dQuadSplinePoly*](#k3dquadsplinepoly) \| [*k3dCubicSplinePoly*](#k3dcubicsplinepoly)
3d折线类型
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / Db3PointAngularDimension
## Class: Db3PointAngularDimension
`Db3PointAngularDimension` 角度标注[三点]实体.
### Hierarchy
- [*DbDimension*](#classesdefaultdbdimensionmd)
↳ **Db3PointAngularDimension**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [arcPoint](#arcpoint)
- [arrowColor](#arrowcolor)
- [arrowSize](#arrowsize)
- [centerPoint](#centerpoint)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [dimDec](#dimdec)
- [dimRnd](#dimrnd)
- [dimScale](#dimscale)
- [dimStyle](#dimstyle)
- [layer](#layer)
- [lineColor](#linecolor)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [textColor](#textcolor)
- [textHeight](#textheight)
- [textPosition](#textposition)
- [textRotation](#textrotation)
- [typename](#typename)
- [visibility](#visibility)
- [xLine1Point](#xline1point)
- [xLine2Point](#xline2point)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new Db3PointAngularDimension**(`prop?`: [*IDb3PointAngularDimension*](#interfacesdefaultidb3pointangulardimensionmd)): [*Db3PointAngularDimension*](#classesdefaultdb3pointangulardimensionmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDb3PointAngularDimension*](#interfacesdefaultidb3pointangulardimensionmd) | {} |
**Returns:** [*Db3PointAngularDimension*](#classesdefaultdb3pointangulardimensionmd)
Overrides: [DbDimension](#classesdefaultdbdimensionmd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[alpha](#alpha)
___
#### arcPoint
• `Optional` **arcPoint**: [*number*, *number*, *undefined* \| *number*][]
圆弧点位置.
___
#### arrowColor
• `Optional` **arrowColor**: *number*
箭头颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowColor](#arrowcolor)
___
#### arrowSize
• `Optional` **arrowSize**: *number*
箭头大小.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowSize](#arrowsize)
___
#### centerPoint
• `Optional` **centerPoint**: [*number*, *number*, *undefined* \| *number*][]
中点.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[colorIndex](#colorindex)
___
#### dimDec
• `Optional` **dimDec**: *number*
设置标注主单位显示的小数位位数.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimDec](#dimdec)
___
#### dimRnd
• `Optional` **dimRnd**: *number*
所有标注距离舍入到指定值.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimRnd](#dimrnd)
___
#### dimScale
• `Optional` **dimScale**: *number*
注记比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimScale](#dimscale)
___
#### dimStyle
• `Optional` **dimStyle**: *string*
标注样式.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimStyle](#dimstyle)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[layer](#layer)
___
#### lineColor
• `Optional` **lineColor**: *number*
引线颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineColor](#linecolor)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[matrix](#matrix)
___
#### textColor
• `Optional` **textColor**: *number*
文本颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textColor](#textcolor)
___
#### textHeight
• `Optional` **textHeight**: *number*
文字高度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textHeight](#textheight)
___
#### textPosition
• `Optional` **textPosition**: [*number*, *number*, *undefined* \| *number*][]
文字位置.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textPosition](#textposition)
___
#### textRotation
• `Optional` **textRotation**: *number*
文字旋转角度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textRotation](#textrotation)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[visibility](#visibility)
___
#### xLine1Point
• `Optional` **xLine1Point**: [*number*, *number*, *undefined* \| *number*][]
点1.
___
#### xLine2Point
• `Optional` **xLine2Point**: [*number*, *number*, *undefined* \| *number*][]
点2.
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbAlignedDimension
## Class: DbAlignedDimension
`DbAlignedDimension` 对齐标注实体.
### Hierarchy
- [*DbDimension*](#classesdefaultdbdimensionmd)
↳ **DbAlignedDimension**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [arrowColor](#arrowcolor)
- [arrowSize](#arrowsize)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [dimDec](#dimdec)
- [dimLinePoint](#dimlinepoint)
- [dimRnd](#dimrnd)
- [dimScale](#dimscale)
- [dimStyle](#dimstyle)
- [jogSymbolHeight](#jogsymbolheight)
- [layer](#layer)
- [lineColor](#linecolor)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [textColor](#textcolor)
- [textHeight](#textheight)
- [textPosition](#textposition)
- [textRotation](#textrotation)
- [typename](#typename)
- [visibility](#visibility)
- [xLine1Point](#xline1point)
- [xLine2Point](#xline2point)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbAlignedDimension**(`prop?`: [*IDbAlignedDimension*](#interfacesdefaultidbaligneddimensionmd)): [*DbAlignedDimension*](#classesdefaultdbaligneddimensionmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbAlignedDimension*](#interfacesdefaultidbaligneddimensionmd) | {} |
**Returns:** [*DbAlignedDimension*](#classesdefaultdbaligneddimensionmd)
Overrides: [DbDimension](#classesdefaultdbdimensionmd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[alpha](#alpha)
___
#### arrowColor
• `Optional` **arrowColor**: *number*
箭头颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowColor](#arrowcolor)
___
#### arrowSize
• `Optional` **arrowSize**: *number*
箭头大小.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowSize](#arrowsize)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[colorIndex](#colorindex)
___
#### dimDec
• `Optional` **dimDec**: *number*
设置标注主单位显示的小数位位数.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimDec](#dimdec)
___
#### dimLinePoint
• `Optional` **dimLinePoint**: [*number*, *number*, *undefined* \| *number*][]
设置定义此dimension实体尺寸线位置的WCS点.
___
#### dimRnd
• `Optional` **dimRnd**: *number*
所有标注距离舍入到指定值.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimRnd](#dimrnd)
___
#### dimScale
• `Optional` **dimScale**: *number*
注记比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimScale](#dimscale)
___
#### dimStyle
• `Optional` **dimStyle**: *string*
标注样式.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimStyle](#dimstyle)
___
#### jogSymbolHeight
• `Optional` **jogSymbolHeight**: *number*
设置此实体的符号高度。.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[layer](#layer)
___
#### lineColor
• `Optional` **lineColor**: *number*
引线颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineColor](#linecolor)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[matrix](#matrix)
___
#### textColor
• `Optional` **textColor**: *number*
文本颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textColor](#textcolor)
___
#### textHeight
• `Optional` **textHeight**: *number*
文字高度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textHeight](#textheight)
___
#### textPosition
• `Optional` **textPosition**: [*number*, *number*, *undefined* \| *number*][]
文字位置.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textPosition](#textposition)
___
#### textRotation
• `Optional` **textRotation**: *number*
文字旋转角度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textRotation](#textrotation)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[visibility](#visibility)
___
#### xLine1Point
• `Optional` **xLine1Point**: [*number*, *number*, *undefined* \| *number*][]
线1点.
___
#### xLine2Point
• `Optional` **xLine2Point**: [*number*, *number*, *undefined* \| *number*][]
线2点.
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbArc
## Class: DbArc
`DbArc` 圆弧实体.
### Hierarchy
- [*DbCurve*](#classesdefaultdbcurvemd)
↳ **DbArc**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [center](#center)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [endAngle](#endangle)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [normal](#normal)
- [radius](#radius)
- [startAngle](#startangle)
- [thickness](#thickness)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbArc**(`prop?`: [*IDbArc*](#interfacesdefaultidbarcmd)): [*DbArc*](#classesdefaultdbarcmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbArc*](#interfacesdefaultidbarcmd) | {} |
**Returns:** [*DbArc*](#classesdefaultdbarcmd)
Overrides: [DbCurve](#classesdefaultdbcurvemd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[alpha](#alpha)
___
#### center
• `Optional` **center**: [*number*, *number*, *undefined* \| *number*]
中心坐标.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[colorIndex](#colorindex)
___
#### endAngle
• `Optional` **endAngle**: *number*
结束弧度.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[matrix](#matrix)
___
#### normal
• `Optional` **normal**: [*number*, *number*, *undefined* \| *number*]
法向量.
___
#### radius
• `Optional` **radius**: *number*
半径.
___
#### startAngle
• `Optional` **startAngle**: *number*
开始弧度.
___
#### thickness
• `Optional` **thickness**: *number*
厚度.
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbArcDimension
## Class: DbArcDimension
`DbArcDimension` 圆弧标注实体.
### Hierarchy
- [*DbDimension*](#classesdefaultdbdimensionmd)
↳ **DbArcDimension**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [arcPoint](#arcpoint)
- [arcSymbolType](#arcsymboltype)
- [arrowColor](#arrowcolor)
- [arrowSize](#arrowsize)
- [centerPoint](#centerpoint)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [dimDec](#dimdec)
- [dimRnd](#dimrnd)
- [dimScale](#dimscale)
- [dimStyle](#dimstyle)
- [layer](#layer)
- [lineColor](#linecolor)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [textColor](#textcolor)
- [textHeight](#textheight)
- [textPosition](#textposition)
- [textRotation](#textrotation)
- [typename](#typename)
- [visibility](#visibility)
- [xLine1Point](#xline1point)
- [xLine2Point](#xline2point)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbArcDimension**(`prop?`: [*IDbArcDimension*](#interfacesdefaultidbarcdimensionmd)): [*DbArcDimension*](#classesdefaultdbarcdimensionmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbArcDimension*](#interfacesdefaultidbarcdimensionmd) | {} |
**Returns:** [*DbArcDimension*](#classesdefaultdbarcdimensionmd)
Overrides: [DbDimension](#classesdefaultdbdimensionmd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[alpha](#alpha)
___
#### arcPoint
• `Optional` **arcPoint**: [*number*, *number*, *undefined* \| *number*][]
圆弧点.
___
#### arcSymbolType
• `Optional` **arcSymbolType**: *number*
文本中使用的弧符号的类型。 0 弧符号在文本前面; 1 弧线符号在文字上方; 2 没有符号.
___
#### arrowColor
• `Optional` **arrowColor**: *number*
箭头颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowColor](#arrowcolor)
___
#### arrowSize
• `Optional` **arrowSize**: *number*
箭头大小.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowSize](#arrowsize)
___
#### centerPoint
• `Optional` **centerPoint**: [*number*, *number*, *undefined* \| *number*][]
中心点.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[colorIndex](#colorindex)
___
#### dimDec
• `Optional` **dimDec**: *number*
设置标注主单位显示的小数位位数.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimDec](#dimdec)
___
#### dimRnd
• `Optional` **dimRnd**: *number*
所有标注距离舍入到指定值.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimRnd](#dimrnd)
___
#### dimScale
• `Optional` **dimScale**: *number*
注记比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimScale](#dimscale)
___
#### dimStyle
• `Optional` **dimStyle**: *string*
标注样式.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimStyle](#dimstyle)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[layer](#layer)
___
#### lineColor
• `Optional` **lineColor**: *number*
引线颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineColor](#linecolor)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[matrix](#matrix)
___
#### textColor
• `Optional` **textColor**: *number*
文本颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textColor](#textcolor)
___
#### textHeight
• `Optional` **textHeight**: *number*
文字高度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textHeight](#textheight)
___
#### textPosition
• `Optional` **textPosition**: [*number*, *number*, *undefined* \| *number*][]
文字位置.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textPosition](#textposition)
___
#### textRotation
• `Optional` **textRotation**: *number*
文字旋转角度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textRotation](#textrotation)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[visibility](#visibility)
___
#### xLine1Point
• `Optional` **xLine1Point**: [*number*, *number*, *undefined* \| *number*][]
线1点.
___
#### xLine2Point
• `Optional` **xLine2Point**: [*number*, *number*, *undefined* \| *number*][]
线2点.
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbAttributeDefinition
## Class: DbAttributeDefinition
`DbText` 属性定义实体.
### Hierarchy
- [*DbText*](#classesdefaultdbtextmd)
↳ **DbAttributeDefinition**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [contents](#contents)
- [height](#height)
- [horizontalMode](#horizontalmode)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [position](#position)
- [prompt](#prompt)
- [rotation](#rotation)
- [tag](#tag)
- [text](#text)
- [textStyle](#textstyle)
- [typename](#typename)
- [verticalMode](#verticalmode)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbAttributeDefinition**(`prop?`: [*IDbText*](#interfacesdefaultidbtextmd)): [*DbAttributeDefinition*](#classesdefaultdbattributedefinitionmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbText*](#interfacesdefaultidbtextmd) | {} |
**Returns:** [*DbAttributeDefinition*](#classesdefaultdbattributedefinitionmd)
Overrides: [DbText](#classesdefaultdbtextmd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbText](#classesdefaultdbtextmd).[alpha](#alpha)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbText](#classesdefaultdbtextmd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbText](#classesdefaultdbtextmd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbText](#classesdefaultdbtextmd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbText](#classesdefaultdbtextmd).[colorIndex](#colorindex)
___
#### contents
• `Optional` **contents**: *string*
文本内容， 同text.
Inherited from: [DbText](#classesdefaultdbtextmd).[contents](#contents)
___
#### height
• `Optional` **height**: *number*
高.
Inherited from: [DbText](#classesdefaultdbtextmd).[height](#height)
___
#### horizontalMode
• `Optional` **horizontalMode**: [*kTextLeft*](#ktextleft) \| [*kTextCenter*](#ktextcenter) \| [*kTextRight*](#ktextright) \| [*kTextAlign*](#ktextalign) \| [*kTextMid*](#ktextmid) \| [*kTextFit*](#ktextfit)
水平模式.
Inherited from: [DbText](#classesdefaultdbtextmd).[horizontalMode](#horizontalmode)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbText](#classesdefaultdbtextmd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbText](#classesdefaultdbtextmd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbText](#classesdefaultdbtextmd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbText](#classesdefaultdbtextmd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbText](#classesdefaultdbtextmd).[matrix](#matrix)
___
#### position
• `Optional` **position**: [*number*, *number*, *undefined* \| *number*]
位置.
Inherited from: [DbText](#classesdefaultdbtextmd).[position](#position)
___
#### prompt
• `Optional` **prompt**: *string*
属性提示.
___
#### rotation
• `Optional` **rotation**: *number*
旋转角度.
Inherited from: [DbText](#classesdefaultdbtextmd).[rotation](#rotation)
___
#### tag
• `Optional` **tag**: *string*
属性名.
___
#### text
• `Optional` **text**: *string*
文本内容， 同contents.
Inherited from: [DbText](#classesdefaultdbtextmd).[text](#text)
___
#### textStyle
• `Optional` **textStyle**: *string*
文本样式.
Inherited from: [DbText](#classesdefaultdbtextmd).[textStyle](#textstyle)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbText](#classesdefaultdbtextmd).[typename](#typename)
___
#### verticalMode
• `Optional` **verticalMode**: [*kTextBase*](#ktextbase) \| [*kTextBottom*](#ktextbottom) \| [*kTextVertMid*](#ktextvertmid) \| [*kTextTop*](#ktexttop)
垂直模式.
Inherited from: [DbText](#classesdefaultdbtextmd).[verticalMode](#verticalmode)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbText](#classesdefaultdbtextmd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbText](#classesdefaultdbtextmd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbBlock
## Class: DbBlock
`DbBlock` 块定义.
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [comments](#comments)
- [entitys](#entitys)
- [explodable](#explodable)
- [insertUnits](#insertunits)
- [name](#name)
- [origin](#origin)
- [scaling](#scaling)
### Constructors
#### constructor
\+ **new DbBlock**(`prop?`: [*IDbBlock*](#interfacesdefaultidbblockmd)): [*DbBlock*](#classesdefaultdbblockmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbBlock*](#interfacesdefaultidbblockmd) | {} |
**Returns:** [*DbBlock*](#classesdefaultdbblockmd)
### Properties
#### comments
• `Optional` **comments**: *string*
备注.
___
#### entitys
• `Optional` **entitys**: [*IDbEntity*](#interfacesdefaultidbentitymd)[]
由哪些实体创建而成.
___
#### explodable
• `Optional` **explodable**: *boolean*
是否可炸开.
___
#### insertUnits
• `Optional` **insertUnits**: *number*
设置此块的块插入单位 .
___
#### name
• `Optional` **name**: *string*
块名称.
___
#### origin
• `Optional` **origin**: [*number*, *number*, *undefined* \| *number*]
原点。 .
___
#### scaling
• `Optional` **scaling**: *number*
设置此块的参照的缩放特征.
[vjmap](#readmemd) / [Exports](#modulesmd) / DbBlockReference
## Class: DbBlockReference
`DbBlockReference` 块参照实体.
### Hierarchy
- [*DbEntity*](#classesdefaultdbentitymd)
↳ **DbBlockReference**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [attribute](#attribute)
- [blockname](#blockname)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [normal](#normal)
- [position](#position)
- [ref](#ref)
- [rotation](#rotation)
- [scaleFactors](#scalefactors)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbBlockReference**(`prop?`: [*IDbBlockReference*](#interfacesdefaultidbblockreferencemd)): [*DbBlockReference*](#classesdefaultdbblockreferencemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbBlockReference*](#interfacesdefaultidbblockreferencemd) | {} |
**Returns:** [*DbBlockReference*](#classesdefaultdbblockreferencemd)
Overrides: [DbEntity](#classesdefaultdbentitymd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbEntity](#classesdefaultdbentitymd).[alpha](#alpha)
___
#### attribute
• `Optional` **attribute**: *Record*
属性字段值
___
#### blockname
• `Optional` **blockname**: *string*
块名称.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbEntity](#classesdefaultdbentitymd).[colorIndex](#colorindex)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[matrix](#matrix)
___
#### normal
• `Optional` **normal**: [*number*, *number*, *undefined* \| *number*]
法向量.
___
#### position
• `Optional` **position**: [*number*, *number*, *undefined* \| *number*]
坐标.
___
#### ref
• `Optional` **ref**: *string*
参考外部图形，形式为 mapid/version,如 exam/v1.
___
#### rotation
• `Optional` **rotation**: *number*
旋转角度.
___
#### scaleFactors
• `Optional` **scaleFactors**: [*number*, *number*, *undefined* \| *number*]
缩放因子. [x方向，y方向,z方向]
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbCircle
## Class: DbCircle
`DbCircle` 圆实体.
### Hierarchy
- [*DbCurve*](#classesdefaultdbcurvemd)
↳ **DbCircle**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [center](#center)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [normal](#normal)
- [radius](#radius)
- [thickness](#thickness)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbCircle**(`prop?`: [*IDbCircle*](#interfacesdefaultidbcirclemd)): [*DbCircle*](#classesdefaultdbcirclemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbCircle*](#interfacesdefaultidbcirclemd) | {} |
**Returns:** [*DbCircle*](#classesdefaultdbcirclemd)
Overrides: [DbCurve](#classesdefaultdbcurvemd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[alpha](#alpha)
___
#### center
• `Optional` **center**: [*number*, *number*, *undefined* \| *number*]
中心坐标.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[colorIndex](#colorindex)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[matrix](#matrix)
___
#### normal
• `Optional` **normal**: [*number*, *number*, *undefined* \| *number*]
法向量.
___
#### radius
• `Optional` **radius**: *number*
半径.
___
#### thickness
• `Optional` **thickness**: *number*
厚度.
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbCurve
## Class: DbCurve
`DbCurve` 曲线实体.
### Hierarchy
- [*DbEntity*](#classesdefaultdbentitymd)
↳ **DbCurve**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbCurve**(`prop?`: [*IDbCurve*](#interfacesdefaultidbcurvemd)): [*DbCurve*](#classesdefaultdbcurvemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbCurve*](#interfacesdefaultidbcurvemd) | {} |
**Returns:** [*DbCurve*](#classesdefaultdbcurvemd)
Overrides: [DbEntity](#classesdefaultdbentitymd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbEntity](#classesdefaultdbentitymd).[alpha](#alpha)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbEntity](#classesdefaultdbentitymd).[colorIndex](#colorindex)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[matrix](#matrix)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbDiametricDimension
## Class: DbDiametricDimension
`DbDiametricDimension` 直径标注实体.
### Hierarchy
- [*DbDimension*](#classesdefaultdbdimensionmd)
↳ **DbDiametricDimension**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [arrowColor](#arrowcolor)
- [arrowSize](#arrowsize)
- [chordPoint](#chordpoint)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [dimDec](#dimdec)
- [dimRnd](#dimrnd)
- [dimScale](#dimscale)
- [dimStyle](#dimstyle)
- [farChordPoint](#farchordpoint)
- [layer](#layer)
- [leaderLength](#leaderlength)
- [lineColor](#linecolor)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [textColor](#textcolor)
- [textHeight](#textheight)
- [textPosition](#textposition)
- [textRotation](#textrotation)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbDiametricDimension**(`prop?`: [*IDbDiametricDimension*](#interfacesdefaultidbdiametricdimensionmd)): [*DbDiametricDimension*](#classesdefaultdbdiametricdimensionmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbDiametricDimension*](#interfacesdefaultidbdiametricdimensionmd) | {} |
**Returns:** [*DbDiametricDimension*](#classesdefaultdbdiametricdimensionmd)
Overrides: [DbDimension](#classesdefaultdbdimensionmd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[alpha](#alpha)
___
#### arrowColor
• `Optional` **arrowColor**: *number*
箭头颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowColor](#arrowcolor)
___
#### arrowSize
• `Optional` **arrowSize**: *number*
箭头大小.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowSize](#arrowsize)
___
#### chordPoint
• `Optional` **chordPoint**: [*number*, *number*, *undefined* \| *number*][]
圆上1点.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[colorIndex](#colorindex)
___
#### dimDec
• `Optional` **dimDec**: *number*
设置标注主单位显示的小数位位数.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimDec](#dimdec)
___
#### dimRnd
• `Optional` **dimRnd**: *number*
所有标注距离舍入到指定值.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimRnd](#dimrnd)
___
#### dimScale
• `Optional` **dimScale**: *number*
注记比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimScale](#dimscale)
___
#### dimStyle
• `Optional` **dimStyle**: *string*
标注样式.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimStyle](#dimstyle)
___
#### farChordPoint
• `Optional` **farChordPoint**: [*number*, *number*, *undefined* \| *number*][]
圆上2点.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[layer](#layer)
___
#### leaderLength
• `Optional` **leaderLength**: *number*
引线长度.
___
#### lineColor
• `Optional` **lineColor**: *number*
引线颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineColor](#linecolor)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[matrix](#matrix)
___
#### textColor
• `Optional` **textColor**: *number*
文本颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textColor](#textcolor)
___
#### textHeight
• `Optional` **textHeight**: *number*
文字高度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textHeight](#textheight)
___
#### textPosition
• `Optional` **textPosition**: [*number*, *number*, *undefined* \| *number*][]
文字位置.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textPosition](#textposition)
___
#### textRotation
• `Optional` **textRotation**: *number*
文字旋转角度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textRotation](#textrotation)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbDimension
## Class: DbDimension
`DbDimension` 标注实体.
### Hierarchy
- [*DbEntity*](#classesdefaultdbentitymd)
↳ **DbDimension**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [arrowColor](#arrowcolor)
- [arrowSize](#arrowsize)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [dimDec](#dimdec)
- [dimRnd](#dimrnd)
- [dimScale](#dimscale)
- [dimStyle](#dimstyle)
- [layer](#layer)
- [lineColor](#linecolor)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [textColor](#textcolor)
- [textHeight](#textheight)
- [textPosition](#textposition)
- [textRotation](#textrotation)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbDimension**(`prop?`: [*IDbDimension*](#interfacesdefaultidbdimensionmd)): [*DbDimension*](#classesdefaultdbdimensionmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbDimension*](#interfacesdefaultidbdimensionmd) | {} |
**Returns:** [*DbDimension*](#classesdefaultdbdimensionmd)
Overrides: [DbEntity](#classesdefaultdbentitymd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbEntity](#classesdefaultdbentitymd).[alpha](#alpha)
___
#### arrowColor
• `Optional` **arrowColor**: *number*
箭头颜色.
___
#### arrowSize
• `Optional` **arrowSize**: *number*
箭头大小.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbEntity](#classesdefaultdbentitymd).[colorIndex](#colorindex)
___
#### dimDec
• `Optional` **dimDec**: *number*
设置标注主单位显示的小数位位数.
___
#### dimRnd
• `Optional` **dimRnd**: *number*
所有标注距离舍入到指定值.
___
#### dimScale
• `Optional` **dimScale**: *number*
注记比例.
___
#### dimStyle
• `Optional` **dimStyle**: *string*
标注样式.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[layer](#layer)
___
#### lineColor
• `Optional` **lineColor**: *number*
引线颜色.
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[matrix](#matrix)
___
#### textColor
• `Optional` **textColor**: *number*
文本颜色.
___
#### textHeight
• `Optional` **textHeight**: *number*
文字高度.
___
#### textPosition
• `Optional` **textPosition**: [*number*, *number*, *undefined* \| *number*][]
文字位置.
___
#### textRotation
• `Optional` **textRotation**: *number*
文字旋转角度.
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbDocument
## Class: DbDocument
`DbDocument` 地图数据库文档.
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [blocks](#blocks)
- [dimStyles](#dimstyles)
- [entitys](#entitys)
- [environment](#environment)
- [from](#from)
- [isClearFromDb](#isclearfromdb)
- [isRenameBlockNameIfExist](#isrenameblocknameifexist)
- [layers](#layers)
- [linetypes](#linetypes)
- [pickEntitys](#pickentitys)
- [pickExpr](#pickexpr)
- [pickLayers](#picklayers)
- [textStyles](#textstyles)
#### Methods
- [appendBlock](#appendblock)
- [appendDimStyle](#appenddimstyle)
- [appendEntity](#appendentity)
- [appendLayer](#appendlayer)
- [appendLinetype](#appendlinetype)
- [appendTextStyle](#appendtextstyle)
- [toDoc](#todoc)
### Constructors
#### constructor
\+ **new DbDocument**(`prop?`: [*IDbDocument*](#interfacesdefaultidbdocumentmd)): [*DbDocument*](#classesdefaultdbdocumentmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbDocument*](#interfacesdefaultidbdocumentmd) | {} |
**Returns:** [*DbDocument*](#classesdefaultdbdocumentmd)
### Properties
#### blocks
• `Optional` **blocks**: [*IDbBlock*](#interfacesdefaultidbblockmd)[]
块定义.
___
#### dimStyles
• `Optional` **dimStyles**: [*IDbDimStyle*](#interfacesdefaultidbdimstylemd)[]
标注样式.
___
#### entitys
• `Optional` **entitys**: [*IDbEntity*](#interfacesdefaultidbentitymd)[]
实体集.
___
#### environment
• `Optional` **environment**: *Record*
文档环境，用于设置是否显示线宽等设置, 设置线宽为 LWDISPLAY ,true显示或 false不显示线宽
___
#### from
• `Optional` **from**: *string*
来源于哪个图，会在此图的上面进行修改或新增删除，格式如 形式为 mapid/version,如 exam/v1 .
___
#### isClearFromDb
• `Optional` **isClearFromDb**: *boolean*
___
#### isRenameBlockNameIfExist
• `Optional` **isRenameBlockNameIfExist**: *boolean*
来源于其他图的实体时，如果块定义重复，则自动重命名 ，默认true
___
#### layers
• `Optional` **layers**: [*IDbLayer*](#interfacesdefaultidblayermd)[]
图层集.
___
#### linetypes
• `Optional` **linetypes**: [*IDbLinetype*](#interfacesdefaultidblinetypemd)[]
线型.
___
#### pickEntitys
• `Optional` **pickEntitys**: *string*[]
来源于哪个图时有效，表示从此图中选择指定的实体ID，不在指定的实体ID将不会显示
___
#### pickExpr
• `Optional` **pickExpr**: *string*
来源于哪个图时有效，使用表达式，表示从此图中选择指定的实体ID，不在指定的实体ID将不会显示 结果与pickEntitys的取并
___
#### pickLayers
• `Optional` **pickLayers**: *string*[]
来源于哪个图时有效，表示从此图中选择指定的图层，不在指定的图层将不会显示
___
#### textStyles
• `Optional` **textStyles**: [*IDbTextStyle*](#interfacesdefaultidbtextstylemd)[]
文字样式.
### Methods
#### appendBlock
▸ **appendBlock**(`block`: [*IDbBlock*](#interfacesdefaultidbblockmd) \| [*IDbBlock*](#interfacesdefaultidbblockmd)[]): *void*
增加块
##### Parameters
| Name | Type |
| :------ | :------ |
| `block` | [*IDbBlock*](#interfacesdefaultidbblockmd) \| [*IDbBlock*](#interfacesdefaultidbblockmd)[] |
**Returns:** *void*
___
#### appendDimStyle
▸ **appendDimStyle**(`dimStyle`: [*IDbDimStyle*](#interfacesdefaultidbdimstylemd) \| [*IDbDimStyle*](#interfacesdefaultidbdimstylemd)[]): *void*
增加标注样式
##### Parameters
| Name | Type |
| :------ | :------ |
| `dimStyle` | [*IDbDimStyle*](#interfacesdefaultidbdimstylemd) \| [*IDbDimStyle*](#interfacesdefaultidbdimstylemd)[] |
**Returns:** *void*
___
#### appendEntity
▸ **appendEntity**(`entity`: [*IDbEntity*](#interfacesdefaultidbentitymd) \| [*IDbEntity*](#interfacesdefaultidbentitymd)[]): *void*
增加实体
##### Parameters
| Name | Type |
| :------ | :------ |
| `entity` | [*IDbEntity*](#interfacesdefaultidbentitymd) \| [*IDbEntity*](#interfacesdefaultidbentitymd)[] |
**Returns:** *void*
___
#### appendLayer
▸ **appendLayer**(`layer`: [*IDbLayer*](#interfacesdefaultidblayermd) \| [*IDbLayer*](#interfacesdefaultidblayermd)[]): *void*
增加图层
##### Parameters
| Name | Type |
| :------ | :------ |
| `layer` | [*IDbLayer*](#interfacesdefaultidblayermd) \| [*IDbLayer*](#interfacesdefaultidblayermd)[] |
**Returns:** *void*
___
#### appendLinetype
▸ **appendLinetype**(`linetype`: [*IDbLinetype*](#interfacesdefaultidblinetypemd) \| [*IDbLinetype*](#interfacesdefaultidblinetypemd)[]): *void*
增加线型
##### Parameters
| Name | Type |
| :------ | :------ |
| `linetype` | [*IDbLinetype*](#interfacesdefaultidblinetypemd) \| [*IDbLinetype*](#interfacesdefaultidblinetypemd)[] |
**Returns:** *void*
___
#### appendTextStyle
▸ **appendTextStyle**(`textStyle`: [*IDbTextStyle*](#interfacesdefaultidbtextstylemd) \| [*IDbTextStyle*](#interfacesdefaultidbtextstylemd)[]): *void*
增加样式样式
##### Parameters
| Name | Type |
| :------ | :------ |
| `textStyle` | [*IDbTextStyle*](#interfacesdefaultidbtextstylemd) \| [*IDbTextStyle*](#interfacesdefaultidbtextstylemd)[] |
**Returns:** *void*
___
#### toDoc
▸ **toDoc**(`content?`: *string*): *string*
转成文档字符串
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `content?` | *string* | 如果传入了内容，则以content为主。json格式 |
**Returns:** *string*
[vjmap](#readmemd) / [Exports](#modulesmd) / DbEllipse
## Class: DbEllipse
`DbEllipse` 椭圆实体.
### Hierarchy
- [*DbCurve*](#classesdefaultdbcurvemd)
↳ **DbEllipse**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [center](#center)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [endAngle](#endangle)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [minorAxis](#minoraxis)
- [radiusRatio](#radiusratio)
- [startAngle](#startangle)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbEllipse**(`prop?`: [*IDbEllipse*](#interfacesdefaultidbellipsemd)): [*DbEllipse*](#classesdefaultdbellipsemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbEllipse*](#interfacesdefaultidbellipsemd) | {} |
**Returns:** [*DbEllipse*](#classesdefaultdbellipsemd)
Overrides: [DbCurve](#classesdefaultdbcurvemd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[alpha](#alpha)
___
#### center
• `Optional` **center**: [*number*, *number*, *undefined* \| *number*]
中心坐标.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[colorIndex](#colorindex)
___
#### endAngle
• `Optional` **endAngle**: *number*
结束弧度.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[matrix](#matrix)
___
#### minorAxis
• `Optional` **minorAxis**: [*number*, *number*, *undefined* \| *number*]
主轴方向.
___
#### radiusRatio
• `Optional` **radiusRatio**: *number*
短轴和长轴的比例.
___
#### startAngle
• `Optional` **startAngle**: *number*
开始弧度.
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbEntity
## Class: DbEntity
`DbEntity` 实体基类.
### Implements
- [*IDbEntity*](#interfacesdefaultidbentitymd)
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ `Protected` **new DbEntity**(`prop?`: [*IDbEntity*](#interfacesdefaultidbentitymd)): [*DbEntity*](#classesdefaultdbentitymd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbEntity*](#interfacesdefaultidbentitymd) | {} |
**Returns:** [*DbEntity*](#classesdefaultdbentitymd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Implementation of: [IDbEntity](#interfacesdefaultidbentitymd).[alpha](#alpha)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
___
#### color
• `Optional` **color**: *number*
颜色.
Implementation of: [IDbEntity](#interfacesdefaultidbentitymd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Implementation of: [IDbEntity](#interfacesdefaultidbentitymd).[colorIndex](#colorindex)
___
#### layer
• `Optional` **layer**: *string*
图层.
Implementation of: [IDbEntity](#interfacesdefaultidbentitymd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Implementation of: [IDbEntity](#interfacesdefaultidbentitymd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Implementation of: [IDbEntity](#interfacesdefaultidbentitymd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Implementation of: [IDbEntity](#interfacesdefaultidbentitymd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Implementation of: [IDbEntity](#interfacesdefaultidbentitymd).[matrix](#matrix)
___
#### typename
• `Optional` **typename**: *string*
类型.
Implementation of: [IDbEntity](#interfacesdefaultidbentitymd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Implementation of: [IDbEntity](#interfacesdefaultidbentitymd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Implementation of: [IDbEntity](#interfacesdefaultidbentitymd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbHatch
## Class: DbHatch
`DbHatch` 图案实体.
### Hierarchy
- [*DbEntity*](#classesdefaultdbentitymd)
↳ **DbHatch**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [elevation](#elevation)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [pattern](#pattern)
- [patternAngle](#patternangle)
- [patternAssociative](#patternassociative)
- [patternBackgroundColor](#patternbackgroundcolor)
- [patternDouble](#patterndouble)
- [patternOrigin](#patternorigin)
- [patternScale](#patternscale)
- [patternSpace](#patternspace)
- [points](#points)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbHatch**(`prop?`: [*IDbHatch*](#interfacesdefaultidbhatchmd)): [*DbHatch*](#classesdefaultdbhatchmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbHatch*](#interfacesdefaultidbhatchmd) | {} |
**Returns:** [*DbHatch*](#classesdefaultdbhatchmd)
Overrides: [DbEntity](#classesdefaultdbentitymd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbEntity](#classesdefaultdbentitymd).[alpha](#alpha)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbEntity](#classesdefaultdbentitymd).[colorIndex](#colorindex)
___
#### elevation
• `Optional` **elevation**: *number*
高程.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[matrix](#matrix)
___
#### pattern
• `Optional` **pattern**: *string*
填充图案, 缺省 SOLID
___
#### patternAngle
• `Optional` **patternAngle**: *number*
填充角度
___
#### patternAssociative
• `Optional` **patternAssociative**: *boolean*
是否关联
___
#### patternBackgroundColor
• `Optional` **patternBackgroundColor**: *number*
填充背景色
___
#### patternDouble
• `Optional` **patternDouble**: *boolean*
指定用户定义的图案填充是否双向填充
___
#### patternOrigin
• `Optional` **patternOrigin**: [*number*, *number*]
填充原点坐标
___
#### patternScale
• `Optional` **patternScale**: *number*
填充比例
___
#### patternSpace
• `Optional` **patternSpace**: *number*
填充间距
___
#### points
• `Optional` **points**: [*number*, *number*, *undefined* \| *number*][] \| [*number*, *number*, *undefined* \| *number*][][]
坐标.
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbLayer
## Class: DbLayer
`DbLayer` 图层.
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [color](#color)
- [isFrozen](#isfrozen)
- [isLocked](#islocked)
- [isOff](#isoff)
- [linetype](#linetype)
- [name](#name)
### Constructors
#### constructor
\+ **new DbLayer**(`prop?`: [*IDbLayer*](#interfacesdefaultidblayermd)): [*DbLayer*](#classesdefaultdblayermd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbLayer*](#interfacesdefaultidblayermd) | {} |
**Returns:** [*DbLayer*](#classesdefaultdblayermd)
### Properties
#### color
• `Optional` **color**: *number*
图层颜色索引.
___
#### isFrozen
• `Optional` **isFrozen**: *boolean*
图层冻结.
___
#### isLocked
• `Optional` **isLocked**: *boolean*
图层锁定.
___
#### isOff
• `Optional` **isOff**: *boolean*
图层开关.
___
#### linetype
• `Optional` **linetype**: *string*
图层线型，缺省 CONTINUOUS .
___
#### name
• `Optional` **name**: *string*
图层名称. 如果要对所有图层进行修改时，请使用 \*all_layers\*
[vjmap](#readmemd) / [Exports](#modulesmd) / DbLine
## Class: DbLine
`DbLine` 线实体.
### Hierarchy
- [*DbEntity*](#classesdefaultdbentitymd)
↳ **DbLine**
### Implements
- [*IDbLine*](#interfacesdefaultidblinemd)
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [end](#end)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [start](#start)
- [thickness](#thickness)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbLine**(`prop?`: [*IDbLine*](#interfacesdefaultidblinemd)): [*DbLine*](#classesdefaultdblinemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbLine*](#interfacesdefaultidblinemd) | {} |
**Returns:** [*DbLine*](#classesdefaultdblinemd)
Overrides: [DbEntity](#classesdefaultdbentitymd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[alpha](#alpha)
Inherited from: [DbEntity](#classesdefaultdbentitymd).[alpha](#alpha)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[color](#color)
Inherited from: [DbEntity](#classesdefaultdbentitymd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[colorIndex](#colorindex)
Inherited from: [DbEntity](#classesdefaultdbentitymd).[colorIndex](#colorindex)
___
#### end
• `Optional` **end**: [*number*, *number*, *undefined* \| *number*]
终点.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[end](#end)
___
#### layer
• `Optional` **layer**: *string*
图层.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[layer](#layer)
Inherited from: [DbEntity](#classesdefaultdbentitymd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[lineWidth](#linewidth)
Inherited from: [DbEntity](#classesdefaultdbentitymd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[linetype](#linetype)
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[linetypeScale](#linetypescale)
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[matrix](#matrix)
Inherited from: [DbEntity](#classesdefaultdbentitymd).[matrix](#matrix)
___
#### start
• `Optional` **start**: [*number*, *number*, *undefined* \| *number*]
起点.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[start](#start)
___
#### thickness
• `Optional` **thickness**: *number*
厚度.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[thickness](#thickness)
___
#### typename
• `Optional` **typename**: *string*
类型.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[typename](#typename)
Inherited from: [DbEntity](#classesdefaultdbentitymd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[visibility](#visibility)
Inherited from: [DbEntity](#classesdefaultdbentitymd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Implementation of: [IDbLine](#interfacesdefaultidblinemd).[xdata](#xdata)
Inherited from: [DbEntity](#classesdefaultdbentitymd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbLineType
## Class: DbLineType
`DbLineType` 线型.
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [comments](#comments)
- [name](#name)
- [style](#style)
### Constructors
#### constructor
\+ **new DbLineType**(`prop?`: [*IDbLinetype*](#interfacesdefaultidblinetypemd)): [*DbLineType*](#classesdefaultdblinetypemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbLinetype*](#interfacesdefaultidblinetypemd) | {} |
**Returns:** [*DbLineType*](#classesdefaultdblinetypemd)
### Properties
#### comments
• `Optional` **comments**: *string*
评论.
___
#### name
• `Optional` **name**: *string*
线型名称.
___
#### style
• `Optional` **style**: [*IDbLinetypeStyle*](#interfacesdefaultidblinetypestylemd)[]
线型样式 .
[vjmap](#readmemd) / [Exports](#modulesmd) / DbMLeader
## Class: DbMLeader
`DbMLeader` 多重引线.
### Hierarchy
- [*DbEntity*](#classesdefaultdbentitymd)
↳ **DbMLeader**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [arrowSize](#arrowsize)
- [blockConnectionType](#blockconnectiontype)
- [blockPosition](#blockposition)
- [blockRotation](#blockrotation)
- [blockScale](#blockscale)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [contents](#contents)
- [doglegLength](#dogleglength)
- [enableDogleg](#enabledogleg)
- [height](#height)
- [landingGap](#landinggap)
- [layer](#layer)
- [leaderLinePoint](#leaderlinepoint)
- [leaderVertexPoints](#leadervertexpoints)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [textAttachment](#textattachment)
- [textAttachmentDirection](#textattachmentdirection)
- [textAttachmentType](#textattachmenttype)
- [textHeight](#textheight)
- [textLocation](#textlocation)
- [textRotation](#textrotation)
- [textStyle](#textstyle)
- [textWidth](#textwidth)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbMLeader**(`prop?`: [*IDbMText*](#interfacesdefaultidbmtextmd)): [*DbMLeader*](#classesdefaultdbmleadermd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbMText*](#interfacesdefaultidbmtextmd) | {} |
**Returns:** [*DbMLeader*](#classesdefaultdbmleadermd)
Overrides: [DbEntity](#classesdefaultdbentitymd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbEntity](#classesdefaultdbentitymd).[alpha](#alpha)
___
#### arrowSize
• `Optional` **arrowSize**: *number*
___
#### blockConnectionType
• `Optional` **blockConnectionType**: ``0`` \| ``1``
___
#### blockPosition
• `Optional` **blockPosition**: [*number*, *number*, *undefined* \| *number*]
___
#### blockRotation
• `Optional` **blockRotation**: *number*
___
#### blockScale
• `Optional` **blockScale**: [*number*, *number*, *number*]
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbEntity](#classesdefaultdbentitymd).[colorIndex](#colorindex)
___
#### contents
• `Optional` **contents**: *string*
文本内容.
___
#### doglegLength
• `Optional` **doglegLength**: *number*
___
#### enableDogleg
• `Optional` **enableDogleg**: *boolean*
___
#### height
• `Optional` **height**: *number*
文本高.
___
#### landingGap
• `Optional` **landingGap**: *number*
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[layer](#layer)
___
#### leaderLinePoint
• `Optional` **leaderLinePoint**: [*number*, *number*, *undefined* \| *number*]
引线位置.
___
#### leaderVertexPoints
• `Optional` **leaderVertexPoints**: [*number*, *number*, *undefined* \| *number*][]
引线顶点位置数组.
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[matrix](#matrix)
___
#### textAttachment
• `Optional` **textAttachment**: [*kTopLeft*](#ktopleft) \| [*kTopCenter*](#ktopcenter) \| [*kTopRight*](#ktopright) \| [*kMiddleLeft*](#kmiddleleft) \| [*kMiddleCenter*](#kmiddlecenter) \| [*kMiddleRight*](#kmiddleright) \| [*kBottomLeft*](#kbottomleft) \| [*kBottomCenter*](#kbottomcenter) \| [*kBottomRight*](#kbottomright) \| [*kBaseLeft*](#kbaseleft) \| [*kBaseCenter*](#kbasecenter) \| [*kBaseRight*](#kbaseright) \| [*kBaseAlign*](#kbasealign) \| [*kBottomAlign*](#kbottomalign) \| [*kMiddleAlign*](#kmiddlealign) \| [*kTopAlign*](#ktopalign) \| [*kBaseFit*](#kbasefit) \| [*kBottomFit*](#kbottomfit) \| [*kMiddleFit*](#kmiddlefit) \| [*kTopFit*](#ktopfit) \| [*kBaseMid*](#kbasemid) \| [*kBottomMid*](#kbottommid) \| [*kMiddleMid*](#kmiddlemid) \| [*kTopMid*](#ktopmid)
文本对齐方式.
___
#### textAttachmentDirection
• `Optional` **textAttachmentDirection**: ``0`` \| ``1``
文本对齐方向. 0 水平 1 垂直
___
#### textAttachmentType
• `Optional` **textAttachmentType**: *number*[]
文本对齐类型. type(0-10) value(0-4) [type1, value1, type2, value2....]
___
#### textHeight
• `Optional` **textHeight**: *number*
文本高.
___
#### textLocation
• `Optional` **textLocation**: [*number*, *number*, *undefined* \| *number*]
文本位置.
___
#### textRotation
• `Optional` **textRotation**: *number*
文本旋转角度.
___
#### textStyle
• `Optional` **textStyle**: *string*
文本样式.
___
#### textWidth
• `Optional` **textWidth**: *number*
文本宽.
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbMText
## Class: DbMText
`DbMText` 多行文本实体.
### Hierarchy
- [*DbEntity*](#classesdefaultdbentitymd)
↳ **DbMText**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [attachment](#attachment)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [contents](#contents)
- [height](#height)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [location](#location)
- [matrix](#matrix)
- [rotation](#rotation)
- [textHeight](#textheight)
- [textStyle](#textstyle)
- [typename](#typename)
- [visibility](#visibility)
- [width](#width)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbMText**(`prop?`: [*IDbMText*](#interfacesdefaultidbmtextmd)): [*DbMText*](#classesdefaultdbmtextmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbMText*](#interfacesdefaultidbmtextmd) | {} |
**Returns:** [*DbMText*](#classesdefaultdbmtextmd)
Overrides: [DbEntity](#classesdefaultdbentitymd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbEntity](#classesdefaultdbentitymd).[alpha](#alpha)
___
#### attachment
• `Optional` **attachment**: [*kTopLeft*](#ktopleft) \| [*kTopCenter*](#ktopcenter) \| [*kTopRight*](#ktopright) \| [*kMiddleLeft*](#kmiddleleft) \| [*kMiddleCenter*](#kmiddlecenter) \| [*kMiddleRight*](#kmiddleright) \| [*kBottomLeft*](#kbottomleft) \| [*kBottomCenter*](#kbottomcenter) \| [*kBottomRight*](#kbottomright) \| [*kBaseLeft*](#kbaseleft) \| [*kBaseCenter*](#kbasecenter) \| [*kBaseRight*](#kbaseright) \| [*kBaseAlign*](#kbasealign) \| [*kBottomAlign*](#kbottomalign) \| [*kMiddleAlign*](#kmiddlealign) \| [*kTopAlign*](#ktopalign) \| [*kBaseFit*](#kbasefit) \| [*kBottomFit*](#kbottomfit) \| [*kMiddleFit*](#kmiddlefit) \| [*kTopFit*](#ktopfit) \| [*kBaseMid*](#kbasemid) \| [*kBottomMid*](#kbottommid) \| [*kMiddleMid*](#kmiddlemid) \| [*kTopMid*](#ktopmid)
对齐方式.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbEntity](#classesdefaultdbentitymd).[colorIndex](#colorindex)
___
#### contents
• `Optional` **contents**: *string*
文本内容.
___
#### height
• `Optional` **height**: *number*
高.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetypeScale](#linetypescale)
___
#### location
• `Optional` **location**: [*number*, *number*, *undefined* \| *number*]
位置.
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[matrix](#matrix)
___
#### rotation
• `Optional` **rotation**: *number*
旋转角度.
___
#### textHeight
• `Optional` **textHeight**: *number*
文本高.
___
#### textStyle
• `Optional` **textStyle**: *string*
文本样式.
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[visibility](#visibility)
___
#### width
• `Optional` **width**: *number*
宽.
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbOrdinateDimension
## Class: DbOrdinateDimension
`DbOrdinateDimension` 坐标标注实体.
### Hierarchy
- [*DbDimension*](#classesdefaultdbdimensionmd)
↳ **DbOrdinateDimension**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [arrowColor](#arrowcolor)
- [arrowSize](#arrowsize)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [definingPoint](#definingpoint)
- [dimDec](#dimdec)
- [dimRnd](#dimrnd)
- [dimScale](#dimscale)
- [dimStyle](#dimstyle)
- [layer](#layer)
- [leaderEndPoint](#leaderendpoint)
- [lineColor](#linecolor)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [origin](#origin)
- [textColor](#textcolor)
- [textHeight](#textheight)
- [textPosition](#textposition)
- [textRotation](#textrotation)
- [typename](#typename)
- [useXAxis](#usexaxis)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbOrdinateDimension**(`prop?`: [*IDbOrdinateDimension*](#interfacesdefaultidbordinatedimensionmd)): [*DbOrdinateDimension*](#classesdefaultdbordinatedimensionmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbOrdinateDimension*](#interfacesdefaultidbordinatedimensionmd) | {} |
**Returns:** [*DbOrdinateDimension*](#classesdefaultdbordinatedimensionmd)
Overrides: [DbDimension](#classesdefaultdbdimensionmd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[alpha](#alpha)
___
#### arrowColor
• `Optional` **arrowColor**: *number*
箭头颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowColor](#arrowcolor)
___
#### arrowSize
• `Optional` **arrowSize**: *number*
箭头大小.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowSize](#arrowsize)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[colorIndex](#colorindex)
___
#### definingPoint
• `Optional` **definingPoint**: [*number*, *number*, *undefined* \| *number*][]
定义点.
___
#### dimDec
• `Optional` **dimDec**: *number*
设置标注主单位显示的小数位位数.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimDec](#dimdec)
___
#### dimRnd
• `Optional` **dimRnd**: *number*
所有标注距离舍入到指定值.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimRnd](#dimrnd)
___
#### dimScale
• `Optional` **dimScale**: *number*
注记比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimScale](#dimscale)
___
#### dimStyle
• `Optional` **dimStyle**: *string*
标注样式.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimStyle](#dimstyle)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[layer](#layer)
___
#### leaderEndPoint
• `Optional` **leaderEndPoint**: [*number*, *number*, *undefined* \| *number*][]
引线点.
___
#### lineColor
• `Optional` **lineColor**: *number*
引线颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineColor](#linecolor)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[matrix](#matrix)
___
#### origin
• `Optional` **origin**: [*number*, *number*, *undefined* \| *number*][]
基点.
___
#### textColor
• `Optional` **textColor**: *number*
文本颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textColor](#textcolor)
___
#### textHeight
• `Optional` **textHeight**: *number*
文字高度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textHeight](#textheight)
___
#### textPosition
• `Optional` **textPosition**: [*number*, *number*, *undefined* \| *number*][]
文字位置.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textPosition](#textposition)
___
#### textRotation
• `Optional` **textRotation**: *number*
文字旋转角度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textRotation](#textrotation)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[typename](#typename)
___
#### useXAxis
• `Optional` **useXAxis**: *boolean*
是否用X轴.
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbPolyline
## Class: DbPolyline
`DbPolyline` 多段线实体.
### Hierarchy
- [*DbCurve*](#classesdefaultdbcurvemd)
↳ **DbPolyline**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [bulge](#bulge)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [closed](#closed)
- [color](#color)
- [colorIndex](#colorindex)
- [elevation](#elevation)
- [endWidth](#endwidth)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [points](#points)
- [startWidth](#startwidth)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbPolyline**(`prop?`: [*IDbPolyline*](#interfacesdefaultidbpolylinemd)): [*DbPolyline*](#classesdefaultdbpolylinemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbPolyline*](#interfacesdefaultidbpolylinemd) | {} |
**Returns:** [*DbPolyline*](#classesdefaultdbpolylinemd)
Overrides: [DbCurve](#classesdefaultdbcurvemd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[alpha](#alpha)
___
#### bulge
• `Optional` **bulge**: *number*[]
凸度.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneObjectId](#cloneobjectid)
___
#### closed
• `Optional` **closed**: *boolean*
是否闭合.
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[colorIndex](#colorindex)
___
#### elevation
• `Optional` **elevation**: *number*
高程.
___
#### endWidth
• `Optional` **endWidth**: *number*[]
终点宽.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[matrix](#matrix)
___
#### points
• `Optional` **points**: [*number*, *number*, *undefined* \| *number*][]
坐标.
___
#### startWidth
• `Optional` **startWidth**: *number*[]
起点宽.
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbRadialDimension
## Class: DbRadialDimension
`DbRadialDimension` 半径标注实体
### Hierarchy
- [*DbDimension*](#classesdefaultdbdimensionmd)
↳ **DbRadialDimension**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [arrowColor](#arrowcolor)
- [arrowSize](#arrowsize)
- [center](#center)
- [chordPoint](#chordpoint)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [dimDec](#dimdec)
- [dimRnd](#dimrnd)
- [dimScale](#dimscale)
- [dimStyle](#dimstyle)
- [layer](#layer)
- [leaderLength](#leaderlength)
- [lineColor](#linecolor)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [textColor](#textcolor)
- [textHeight](#textheight)
- [textPosition](#textposition)
- [textRotation](#textrotation)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbRadialDimension**(`prop?`: [*IDbRadialDimension*](#interfacesdefaultidbradialdimensionmd)): [*DbRadialDimension*](#classesdefaultdbradialdimensionmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbRadialDimension*](#interfacesdefaultidbradialdimensionmd) | {} |
**Returns:** [*DbRadialDimension*](#classesdefaultdbradialdimensionmd)
Overrides: [DbDimension](#classesdefaultdbdimensionmd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[alpha](#alpha)
___
#### arrowColor
• `Optional` **arrowColor**: *number*
箭头颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowColor](#arrowcolor)
___
#### arrowSize
• `Optional` **arrowSize**: *number*
箭头大小.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowSize](#arrowsize)
___
#### center
• `Optional` **center**: [*number*, *number*, *undefined* \| *number*][]
中心点.
___
#### chordPoint
• `Optional` **chordPoint**: [*number*, *number*, *undefined* \| *number*][]
圆上点.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[colorIndex](#colorindex)
___
#### dimDec
• `Optional` **dimDec**: *number*
设置标注主单位显示的小数位位数.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimDec](#dimdec)
___
#### dimRnd
• `Optional` **dimRnd**: *number*
所有标注距离舍入到指定值.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimRnd](#dimrnd)
___
#### dimScale
• `Optional` **dimScale**: *number*
注记比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimScale](#dimscale)
___
#### dimStyle
• `Optional` **dimStyle**: *string*
标注样式.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimStyle](#dimstyle)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[layer](#layer)
___
#### leaderLength
• `Optional` **leaderLength**: *number*
引线长度.
___
#### lineColor
• `Optional` **lineColor**: *number*
引线颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineColor](#linecolor)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[matrix](#matrix)
___
#### textColor
• `Optional` **textColor**: *number*
文本颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textColor](#textcolor)
___
#### textHeight
• `Optional` **textHeight**: *number*
文字高度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textHeight](#textheight)
___
#### textPosition
• `Optional` **textPosition**: [*number*, *number*, *undefined* \| *number*][]
文字位置.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textPosition](#textposition)
___
#### textRotation
• `Optional` **textRotation**: *number*
文字旋转角度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textRotation](#textrotation)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbRadialDimensionLarge
## Class: DbRadialDimensionLarge
`DbRadialDimensionLarge` 半径折线标注实体.
### Hierarchy
- [*DbDimension*](#classesdefaultdbdimensionmd)
↳ **DbRadialDimensionLarge**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [arrowColor](#arrowcolor)
- [arrowSize](#arrowsize)
- [center](#center)
- [chordPoint](#chordpoint)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [dimDec](#dimdec)
- [dimRnd](#dimrnd)
- [dimScale](#dimscale)
- [dimStyle](#dimstyle)
- [jogAngle](#jogangle)
- [jogPoint](#jogpoint)
- [layer](#layer)
- [lineColor](#linecolor)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [overrideCenter](#overridecenter)
- [textColor](#textcolor)
- [textHeight](#textheight)
- [textPosition](#textposition)
- [textRotation](#textrotation)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbRadialDimensionLarge**(`prop?`: [*IDbRadialDimensionLarge*](#interfacesdefaultidbradialdimensionlargemd)): [*DbRadialDimensionLarge*](#classesdefaultdbradialdimensionlargemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbRadialDimensionLarge*](#interfacesdefaultidbradialdimensionlargemd) | {} |
**Returns:** [*DbRadialDimensionLarge*](#classesdefaultdbradialdimensionlargemd)
Overrides: [DbDimension](#classesdefaultdbdimensionmd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[alpha](#alpha)
___
#### arrowColor
• `Optional` **arrowColor**: *number*
箭头颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowColor](#arrowcolor)
___
#### arrowSize
• `Optional` **arrowSize**: *number*
箭头大小.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowSize](#arrowsize)
___
#### center
• `Optional` **center**: [*number*, *number*, *undefined* \| *number*][]
中心点.
___
#### chordPoint
• `Optional` **chordPoint**: [*number*, *number*, *undefined* \| *number*][]
圆上点.
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[colorIndex](#colorindex)
___
#### dimDec
• `Optional` **dimDec**: *number*
设置标注主单位显示的小数位位数.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimDec](#dimdec)
___
#### dimRnd
• `Optional` **dimRnd**: *number*
所有标注距离舍入到指定值.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimRnd](#dimrnd)
___
#### dimScale
• `Optional` **dimScale**: *number*
注记比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimScale](#dimscale)
___
#### dimStyle
• `Optional` **dimStyle**: *string*
标注样式.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimStyle](#dimstyle)
___
#### jogAngle
• `Optional` **jogAngle**: *number*
设置此Dimension实体的折角。.
___
#### jogPoint
• `Optional` **jogPoint**: [*number*, *number*, *undefined* \| *number*][]
设置此Dimension实体的折角点。.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[layer](#layer)
___
#### lineColor
• `Optional` **lineColor**: *number*
引线颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineColor](#linecolor)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[matrix](#matrix)
___
#### overrideCenter
• `Optional` **overrideCenter**: [*number*, *number*, *undefined* \| *number*][]
设置由该Dimension实体确定尺寸的弧的WCS覆盖中心。.
___
#### textColor
• `Optional` **textColor**: *number*
文本颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textColor](#textcolor)
___
#### textHeight
• `Optional` **textHeight**: *number*
文字高度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textHeight](#textheight)
___
#### textPosition
• `Optional` **textPosition**: [*number*, *number*, *undefined* \| *number*][]
文字位置.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textPosition](#textposition)
___
#### textRotation
• `Optional` **textRotation**: *number*
文字旋转角度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textRotation](#textrotation)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbRasterImage
## Class: DbRasterImage
`DbRasterImage` 栅格图像实体.
### Hierarchy
- [*DbEntity*](#classesdefaultdbentitymd)
↳ **DbRasterImage**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [brightness](#brightness)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [heightRatio](#heightratio)
- [imageDisplayOptClip](#imagedisplayoptclip)
- [imageDisplayOptShow](#imagedisplayoptshow)
- [imageDisplayOptShowUnAligned](#imagedisplayoptshowunaligned)
- [imageDisplayOptTransparent](#imagedisplayopttransparent)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [pixelHeight](#pixelheight)
- [pixelWidth](#pixelwidth)
- [position](#position)
- [sourceHttpUrl](#sourcehttpurl)
- [typename](#typename)
- [units](#units)
- [visibility](#visibility)
- [widthRatio](#widthratio)
- [xPelsPerUnit](#xpelsperunit)
- [xdata](#xdata)
- [yPelsPerUnit](#ypelsperunit)
### Constructors
#### constructor
\+ **new DbRasterImage**(`prop?`: [*IDbRasterImage*](#interfacesdefaultidbrasterimagemd)): [*DbRasterImage*](#classesdefaultdbrasterimagemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbRasterImage*](#interfacesdefaultidbrasterimagemd) | {} |
**Returns:** [*DbRasterImage*](#classesdefaultdbrasterimagemd)
Overrides: [DbEntity](#classesdefaultdbentitymd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbEntity](#classesdefaultdbentitymd).[alpha](#alpha)
___
#### brightness
• `Optional` **brightness**: *number*
明亮度 [0.0 .. 100.0]
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbEntity](#classesdefaultdbentitymd).[colorIndex](#colorindex)
___
#### heightRatio
• `Optional` **heightRatio**: *number*
高比例..
___
#### imageDisplayOptClip
• `Optional` **imageDisplayOptClip**: *boolean*
是否裁剪.
___
#### imageDisplayOptShow
• `Optional` **imageDisplayOptShow**: *boolean*
是否显示.
___
#### imageDisplayOptShowUnAligned
• `Optional` **imageDisplayOptShowUnAligned**: *boolean*
是否对齐.
___
#### imageDisplayOptTransparent
• `Optional` **imageDisplayOptTransparent**: *boolean*
是否透明.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[matrix](#matrix)
___
#### pixelHeight
• `Optional` **pixelHeight**: *number*
源图片高.
___
#### pixelWidth
• `Optional` **pixelWidth**: *number*
源图片宽.
___
#### position
• `Optional` **position**: [*number*, *number*, *undefined* \| *number*]
位置.
___
#### sourceHttpUrl
• `Optional` **sourceHttpUrl**: *string*
图片url地址.
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[typename](#typename)
___
#### units
• `Optional` **units**: [*kNone*](#knone) \| [*kMillimeter*](#kmillimeter) \| [*kCentimeter*](#kcentimeter) \| [*kMeter*](#kmeter) \| [*kKilometer*](#kkilometer) \| [*kInch*](#kinch) \| [*kFoot*](#kfoot) \| [*kYard*](#kyard) \| [*kMile*](#kmile) \| [*kMicroinches*](#kmicroinches) \| [*kMils*](#kmils) \| [*kAngstroms*](#kangstroms) \| [*kNanometers*](#knanometers) \| [*kMicrons*](#kmicrons) \| [*kDecimeters*](#kdecimeters) \| [*kDekameters*](#kdekameters) \| [*kHectometers*](#khectometers) \| [*kGigameters*](#kgigameters) \| [*kAstronomical*](#kastronomical) \| [*kLightYears*](#klightyears) \| [*kParsecs*](#kparsecs)
单位.
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[visibility](#visibility)
___
#### widthRatio
• `Optional` **widthRatio**: *number*
宽比例.
___
#### xPelsPerUnit
• `Optional` **xPelsPerUnit**: *number*
x轴每像素代表长度.
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[xdata](#xdata)
___
#### yPelsPerUnit
• `Optional` **yPelsPerUnit**: *number*
y轴每像素代表长度.
[vjmap](#readmemd) / [Exports](#modulesmd) / DbRotatedDimension
## Class: DbRotatedDimension
`DbRotatedDimension` 转角标注实体.
### Hierarchy
- [*DbDimension*](#classesdefaultdbdimensionmd)
↳ **DbRotatedDimension**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [arrowColor](#arrowcolor)
- [arrowSize](#arrowsize)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [dimDec](#dimdec)
- [dimLinePoint](#dimlinepoint)
- [dimRnd](#dimrnd)
- [dimScale](#dimscale)
- [dimStyle](#dimstyle)
- [layer](#layer)
- [lineColor](#linecolor)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [textColor](#textcolor)
- [textHeight](#textheight)
- [textPosition](#textposition)
- [textRotation](#textrotation)
- [typename](#typename)
- [visibility](#visibility)
- [xLine1Point](#xline1point)
- [xLine2Point](#xline2point)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbRotatedDimension**(`prop?`: [*IDbRotatedDimension*](#interfacesdefaultidbrotateddimensionmd)): [*DbRotatedDimension*](#classesdefaultdbrotateddimensionmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbRotatedDimension*](#interfacesdefaultidbrotateddimensionmd) | {} |
**Returns:** [*DbRotatedDimension*](#classesdefaultdbrotateddimensionmd)
Overrides: [DbDimension](#classesdefaultdbdimensionmd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[alpha](#alpha)
___
#### arrowColor
• `Optional` **arrowColor**: *number*
箭头颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowColor](#arrowcolor)
___
#### arrowSize
• `Optional` **arrowSize**: *number*
箭头大小.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[arrowSize](#arrowsize)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[colorIndex](#colorindex)
___
#### dimDec
• `Optional` **dimDec**: *number*
设置标注主单位显示的小数位位数.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimDec](#dimdec)
___
#### dimLinePoint
• `Optional` **dimLinePoint**: [*number*, *number*, *undefined* \| *number*][]
设置定义此dimension实体尺寸线位置的WCS点。.
___
#### dimRnd
• `Optional` **dimRnd**: *number*
所有标注距离舍入到指定值.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimRnd](#dimrnd)
___
#### dimScale
• `Optional` **dimScale**: *number*
注记比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimScale](#dimscale)
___
#### dimStyle
• `Optional` **dimStyle**: *string*
标注样式.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[dimStyle](#dimstyle)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[layer](#layer)
___
#### lineColor
• `Optional` **lineColor**: *number*
引线颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineColor](#linecolor)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[matrix](#matrix)
___
#### textColor
• `Optional` **textColor**: *number*
文本颜色.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textColor](#textcolor)
___
#### textHeight
• `Optional` **textHeight**: *number*
文字高度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textHeight](#textheight)
___
#### textPosition
• `Optional` **textPosition**: [*number*, *number*, *undefined* \| *number*][]
文字位置.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textPosition](#textposition)
___
#### textRotation
• `Optional` **textRotation**: *number*
文字旋转角度.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[textRotation](#textrotation)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[visibility](#visibility)
___
#### xLine1Point
• `Optional` **xLine1Point**: [*number*, *number*, *undefined* \| *number*][]
线上点1.
___
#### xLine2Point
• `Optional` **xLine2Point**: [*number*, *number*, *undefined* \| *number*][]
线上点2.
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbDimension](#classesdefaultdbdimensionmd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbShape
## Class: DbShape
`DbShape` 型实体
### Hierarchy
- [*DbEntity*](#classesdefaultdbentitymd)
↳ **DbShape**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [name](#name)
- [normal](#normal)
- [position](#position)
- [rotation](#rotation)
- [size](#size)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbShape**(`prop?`: [*IDbShape*](#interfacesdefaultidbshapemd)): [*DbShape*](#classesdefaultdbshapemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbShape*](#interfacesdefaultidbshapemd) | {} |
**Returns:** [*DbShape*](#classesdefaultdbshapemd)
Overrides: [DbEntity](#classesdefaultdbentitymd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbEntity](#classesdefaultdbentitymd).[alpha](#alpha)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbEntity](#classesdefaultdbentitymd).[colorIndex](#colorindex)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[matrix](#matrix)
___
#### name
• `Optional` **name**: *string*
型名称.
___
#### normal
• `Optional` **normal**: [*number*, *number*, *undefined* \| *number*]
法向量.
___
#### position
• `Optional` **position**: [*number*, *number*, *undefined* \| *number*]
位置.
___
#### rotation
• `Optional` **rotation**: *number*
旋转角度.
___
#### size
• `Optional` **size**: *number*
大小.
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbSpline
## Class: DbSpline
`DbSpline` 样条曲线实体.
### Hierarchy
- [*DbCurve*](#classesdefaultdbcurvemd)
↳ **DbSpline**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [controlPoints](#controlpoints)
- [degree](#degree)
- [fitPoints](#fitpoints)
- [fitTol](#fittol)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [typename](#typename)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbSpline**(`prop?`: [*IDbSpline*](#interfacesdefaultidbsplinemd)): [*DbSpline*](#classesdefaultdbsplinemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbSpline*](#interfacesdefaultidbsplinemd) | {} |
**Returns:** [*DbSpline*](#classesdefaultdbsplinemd)
Overrides: [DbCurve](#classesdefaultdbcurvemd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[alpha](#alpha)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[colorIndex](#colorindex)
___
#### controlPoints
• `Optional` **controlPoints**: [*number*, *number*, *undefined* \| *number*][]
控制点.
___
#### degree
• `Optional` **degree**: *number*
Increased the degree of this spline to the specified value.
___
#### fitPoints
• `Optional` **fitPoints**: [*number*, *number*, *undefined* \| *number*][]
拟合点.
___
#### fitTol
• `Optional` **fitTol**: *number*
the curve fitting tolerance for this Spline entity.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[matrix](#matrix)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[typename](#typename)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbCurve](#classesdefaultdbcurvemd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbTable
## Class: DbTable
`DbBlockReference` 块参照实体.
### Hierarchy
- [*DbBlockReference*](#classesdefaultdbblockreferencemd)
↳ **DbTable**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alignment](#alignment)
- [alpha](#alpha)
- [attribute](#attribute)
- [backgroundColor](#backgroundcolor)
- [blockname](#blockname)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [columnWidth](#columnwidth)
- [contentColor](#contentcolor)
- [data](#data)
- [directionBottomToTop](#directionbottomtotop)
- [disableTitle](#disabletitle)
- [gridColor](#gridcolor)
- [gridVisibility](#gridvisibility)
- [horzCellMargin](#horzcellmargin)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [mergeCells](#mergecells)
- [normal](#normal)
- [numColumns](#numcolumns)
- [numRows](#numrows)
- [position](#position)
- [ref](#ref)
- [rotation](#rotation)
- [rowHeight](#rowheight)
- [scaleFactors](#scalefactors)
- [tableStyleName](#tablestylename)
- [textHeight](#textheight)
- [typename](#typename)
- [vertCellMargin](#vertcellmargin)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbTable**(`prop?`: [*IDbTable*](#interfacesdefaultidbtablemd)): [*DbTable*](#classesdefaultdbtablemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbTable*](#interfacesdefaultidbtablemd) | {} |
**Returns:** [*DbTable*](#classesdefaultdbtablemd)
Overrides: [DbBlockReference](#classesdefaultdbblockreferencemd)
### Properties
#### alignment
• `Optional` **alignment**: [*kTopLeft*](#ktopleft) \| [*kTopCenter*](#ktopcenter) \| [*kTopRight*](#ktopright) \| [*kMiddleLeft*](#kmiddleleft) \| [*kMiddleCenter*](#kmiddlecenter) \| [*kMiddleRight*](#kmiddleright) \| [*kBottomLeft*](#kbottomleft) \| [*kBottomCenter*](#kbottomcenter) \| [*kBottomRight*](#kbottomright)
单元格对齐方式(所有单元格).
___
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[alpha](#alpha)
___
#### attribute
• `Optional` **attribute**: *Record*
属性字段值
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[attribute](#attribute)
___
#### backgroundColor
• `Optional` **backgroundColor**: *number*
背景颜色(所有单元格).
___
#### blockname
• `Optional` **blockname**: *string*
块名称.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[blockname](#blockname)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[colorIndex](#colorindex)
___
#### columnWidth
• `Optional` **columnWidth**: *number*
列宽.
___
#### contentColor
• `Optional` **contentColor**: *number*
文字颜色(所有单元格).
___
#### data
• `Optional` **data**: (*string* \| { `alignment`: [*TableCellAlignment*](#enumsdefaulttablecellalignmentmd) ; `backgroundColor`: *number* ; `contentColor`: *number* ; `gridColor`: *number* ; `gridVisibility`: *boolean* ; `text`: *string* ; `textHeight`: *number* })[][]
数据.
___
#### directionBottomToTop
• `Optional` **directionBottomToTop**: *boolean*
表格方向是否从上至上.
___
#### disableTitle
• `Optional` **disableTitle**: *boolean*
是否禁用标题.
___
#### gridColor
• `Optional` **gridColor**: *number*
网格线颜色(所有单元格).
___
#### gridVisibility
• `Optional` **gridVisibility**: [*boolean*, *number*, *number*]
显示网格线.第二个参数(kHorzTop(1), kHorzInside(2), kHorzBottom(4), kVertLeft(8), kVertInside(16), kVertRight(32); 第三个参数 kTitleRow(1), kHeaderRow(2), kDataRow(4)
___
#### horzCellMargin
• `Optional` **horzCellMargin**: *number*
水平方向单元格边距.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[matrix](#matrix)
___
#### mergeCells
• `Optional` **mergeCells**: [*number*, *number*, *number*, *number*][]
需要合并的单元格 [[minRow, maxRow,minColumn, maxColumn], ...]
___
#### normal
• `Optional` **normal**: [*number*, *number*, *undefined* \| *number*]
法向量.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[normal](#normal)
___
#### numColumns
• `Optional` **numColumns**: *number*
表格列数.
___
#### numRows
• `Optional` **numRows**: *number*
表格行数.
___
#### position
• `Optional` **position**: [*number*, *number*, *undefined* \| *number*]
坐标.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[position](#position)
___
#### ref
• `Optional` **ref**: *string*
参考外部图形，形式为 mapid/version,如 exam/v1.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[ref](#ref)
___
#### rotation
• `Optional` **rotation**: *number*
旋转角度.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[rotation](#rotation)
___
#### rowHeight
• `Optional` **rowHeight**: *number*
行高.
___
#### scaleFactors
• `Optional` **scaleFactors**: [*number*, *number*, *undefined* \| *number*]
缩放因子. [x方向，y方向,z方向]
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[scaleFactors](#scalefactors)
___
#### tableStyleName
• `Optional` **tableStyleName**: *string*
表样式名称.
___
#### textHeight
• `Optional` **textHeight**: *number*
文字高度(所有单元格).
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[typename](#typename)
___
#### vertCellMargin
• `Optional` **vertCellMargin**: *number*
竖直方向单元格边距.
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbBlockReference](#classesdefaultdbblockreferencemd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbText
## Class: DbText
`DbText` 文本实体.
### Hierarchy
- [*DbEntity*](#classesdefaultdbentitymd)
↳ **DbText**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [contents](#contents)
- [height](#height)
- [horizontalMode](#horizontalmode)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [position](#position)
- [rotation](#rotation)
- [text](#text)
- [textStyle](#textstyle)
- [typename](#typename)
- [verticalMode](#verticalmode)
- [visibility](#visibility)
- [xdata](#xdata)
### Constructors
#### constructor
\+ **new DbText**(`prop?`: [*IDbText*](#interfacesdefaultidbtextmd)): [*DbText*](#classesdefaultdbtextmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbText*](#interfacesdefaultidbtextmd) | {} |
**Returns:** [*DbText*](#classesdefaultdbtextmd)
Overrides: [DbEntity](#classesdefaultdbentitymd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbEntity](#classesdefaultdbentitymd).[alpha](#alpha)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbEntity](#classesdefaultdbentitymd).[colorIndex](#colorindex)
___
#### contents
• `Optional` **contents**: *string*
文本内容， 同text.
___
#### height
• `Optional` **height**: *number*
高.
___
#### horizontalMode
• `Optional` **horizontalMode**: [*kTextLeft*](#ktextleft) \| [*kTextCenter*](#ktextcenter) \| [*kTextRight*](#ktextright) \| [*kTextAlign*](#ktextalign) \| [*kTextMid*](#ktextmid) \| [*kTextFit*](#ktextfit)
水平模式.
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[matrix](#matrix)
___
#### position
• `Optional` **position**: [*number*, *number*, *undefined* \| *number*]
位置.
___
#### rotation
• `Optional` **rotation**: *number*
旋转角度.
___
#### text
• `Optional` **text**: *string*
文本内容， 同contents.
___
#### textStyle
• `Optional` **textStyle**: *string*
文本样式.
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[typename](#typename)
___
#### verticalMode
• `Optional` **verticalMode**: [*kTextBase*](#ktextbase) \| [*kTextBottom*](#ktextbottom) \| [*kTextVertMid*](#ktextvertmid) \| [*kTextTop*](#ktexttop)
垂直模式.
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[visibility](#visibility)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbEntity](#classesdefaultdbentitymd).[xdata](#xdata)
[vjmap](#readmemd) / [Exports](#modulesmd) / DbTextStyle
## Class: DbTextStyle
`DbTextStyle` 文字样式.
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [bold](#bold)
- [charset](#charset)
- [fileName](#filename)
- [isShapeFile](#isshapefile)
- [italic](#italic)
- [name](#name)
- [obliquingAngle](#obliquingangle)
- [pitchAndFamily](#pitchandfamily)
- [priorSize](#priorsize)
- [textSize](#textsize)
- [typeFace](#typeface)
- [xScale](#xscale)
### Constructors
#### constructor
\+ **new DbTextStyle**(`prop?`: [*IDbTextStyle*](#interfacesdefaultidbtextstylemd)): [*DbTextStyle*](#classesdefaultdbtextstylemd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbTextStyle*](#interfacesdefaultidbtextstylemd) | {} |
**Returns:** [*DbTextStyle*](#classesdefaultdbtextstylemd)
### Properties
#### bold
• `Optional` **bold**: *boolean*
是否粗体 .
___
#### charset
• `Optional` **charset**: *number*
字符集标识符，缺省0 .
___
#### fileName
• `Optional` **fileName**: *string*
字体文件名 .
___
#### isShapeFile
• `Optional` **isShapeFile**: *boolean*
是否型文件.
___
#### italic
• `Optional` **italic**: *boolean*
是否斜体 .
___
#### name
• `Optional` **name**: *string*
文字样式名称.
___
#### obliquingAngle
• `Optional` **obliquingAngle**: *number*
设置字母的倾斜角度。正角度顺时针（向右）倾斜字母。负值使字母逆时针倾斜（向左）。通过将值2*PI相加，将负值转换为其正当量。 默认情况下，初始值为0.0.
___
#### pitchAndFamily
• `Optional` **pitchAndFamily**: *number*
字符间距和族，缺省34 .
___
#### priorSize
• `Optional` **priorSize**: *number*
设置最近使用此文本样式创建的文本的先前大小 .
___
#### textSize
• `Optional` **textSize**: *number*
文本大小 .
___
#### typeFace
• `Optional` **typeFace**: *string*
字体 .
___
#### xScale
• `Optional` **xScale**: *number*
x轴缩放 .
[vjmap](#readmemd) / [Exports](#modulesmd) / DbWipeout
## Class: DbWipeout
`DbWipeout` 遮罩实体.
### Hierarchy
- [*DbRasterImage*](#classesdefaultdbrasterimagemd)
↳ **DbWipeout**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [alpha](#alpha)
- [brightness](#brightness)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [heightRatio](#heightratio)
- [imageDisplayOptClip](#imagedisplayoptclip)
- [imageDisplayOptShow](#imagedisplayoptshow)
- [imageDisplayOptShowUnAligned](#imagedisplayoptshowunaligned)
- [imageDisplayOptTransparent](#imagedisplayopttransparent)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [pixelHeight](#pixelheight)
- [pixelWidth](#pixelwidth)
- [points](#points)
- [position](#position)
- [sourceHttpUrl](#sourcehttpurl)
- [typename](#typename)
- [units](#units)
- [visibility](#visibility)
- [widthRatio](#widthratio)
- [xPelsPerUnit](#xpelsperunit)
- [xdata](#xdata)
- [yPelsPerUnit](#ypelsperunit)
### Constructors
#### constructor
\+ **new DbWipeout**(`prop?`: [*IDbWipeout*](#interfacesdefaultidbwipeoutmd)): [*DbWipeout*](#classesdefaultdbwipeoutmd)
构造函数
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbWipeout*](#interfacesdefaultidbwipeoutmd) | {} |
**Returns:** [*DbWipeout*](#classesdefaultdbwipeoutmd)
Overrides: [DbRasterImage](#classesdefaultdbrasterimagemd)
### Properties
#### alpha
• `Optional` **alpha**: *number*
透明度. [0-255][0完全透明,255完全不透明]
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[alpha](#alpha)
___
#### brightness
• `Optional` **brightness**: *number*
明亮度 [0.0 .. 100.0]
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[brightness](#brightness)
___
#### cloneFromDb
• `Optional` **cloneFromDb**: *string*
克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[cloneFromDb](#clonefromdb)
___
#### cloneObjectId
• `Optional` **cloneObjectId**: *string*
克隆的实体ID，DbDocument有from图形来源字段时有效.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[cloneObjectId](#cloneobjectid)
___
#### color
• `Optional` **color**: *number*
颜色.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[color](#color)
___
#### colorIndex
• `Optional` **colorIndex**: *number*
颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[colorIndex](#colorindex)
___
#### heightRatio
• `Optional` **heightRatio**: *number*
高比例..
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[heightRatio](#heightratio)
___
#### imageDisplayOptClip
• `Optional` **imageDisplayOptClip**: *boolean*
是否裁剪.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[imageDisplayOptClip](#imagedisplayoptclip)
___
#### imageDisplayOptShow
• `Optional` **imageDisplayOptShow**: *boolean*
是否显示.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[imageDisplayOptShow](#imagedisplayoptshow)
___
#### imageDisplayOptShowUnAligned
• `Optional` **imageDisplayOptShowUnAligned**: *boolean*
是否对齐.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[imageDisplayOptShowUnAligned](#imagedisplayoptshowunaligned)
___
#### imageDisplayOptTransparent
• `Optional` **imageDisplayOptTransparent**: *boolean*
是否透明.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[imageDisplayOptTransparent](#imagedisplayopttransparent)
___
#### layer
• `Optional` **layer**: *string*
图层.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[layer](#layer)
___
#### lineWidth
• `Optional` **lineWidth**: *number*
线宽.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[lineWidth](#linewidth)
___
#### linetype
• `Optional` **linetype**: *string*
线型.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[linetype](#linetype)
___
#### linetypeScale
• `Optional` **linetypeScale**: *number*
线型比例.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[linetypeScale](#linetypescale)
___
#### matrix
• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]
矩阵.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[matrix](#matrix)
___
#### pixelHeight
• `Optional` **pixelHeight**: *number*
源图片高.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[pixelHeight](#pixelheight)
___
#### pixelWidth
• `Optional` **pixelWidth**: *number*
源图片宽.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[pixelWidth](#pixelwidth)
___
#### points
• `Optional` **points**: [*number*, *number*, *undefined* \| *number*][]
坐标.
___
#### position
• `Optional` **position**: [*number*, *number*, *undefined* \| *number*]
位置.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[position](#position)
___
#### sourceHttpUrl
• `Optional` **sourceHttpUrl**: *string*
图片url地址.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[sourceHttpUrl](#sourcehttpurl)
___
#### typename
• `Optional` **typename**: *string*
类型.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[typename](#typename)
___
#### units
• `Optional` **units**: [*kNone*](#knone) \| [*kMillimeter*](#kmillimeter) \| [*kCentimeter*](#kcentimeter) \| [*kMeter*](#kmeter) \| [*kKilometer*](#kkilometer) \| [*kInch*](#kinch) \| [*kFoot*](#kfoot) \| [*kYard*](#kyard) \| [*kMile*](#kmile) \| [*kMicroinches*](#kmicroinches) \| [*kMils*](#kmils) \| [*kAngstroms*](#kangstroms) \| [*kNanometers*](#knanometers) \| [*kMicrons*](#kmicrons) \| [*kDecimeters*](#kdecimeters) \| [*kDekameters*](#kdekameters) \| [*kHectometers*](#khectometers) \| [*kGigameters*](#kgigameters) \| [*kAstronomical*](#kastronomical) \| [*kLightYears*](#klightyears) \| [*kParsecs*](#kparsecs)
单位.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[units](#units)
___
#### visibility
• `Optional` **visibility**: *boolean*
可见.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[visibility](#visibility)
___
#### widthRatio
• `Optional` **widthRatio**: *number*
宽比例.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[widthRatio](#widthratio)
___
#### xPelsPerUnit
• `Optional` **xPelsPerUnit**: *number*
x轴每像素代表长度.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[xPelsPerUnit](#xpelsperunit)
___
#### xdata
• `Optional` **xdata**: *string*
扩展数据.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[xdata](#xdata)
___
#### yPelsPerUnit
• `Optional` **yPelsPerUnit**: *number*
y轴每像素代表长度.
Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[yPelsPerUnit](#ypelsperunit)
[vjmap](#readmemd) / [Exports](#modulesmd) / DeckLayer
## Class: DeckLayer
deck.gl图层.
### Hierarchy
- *Evented*
↳ **DeckLayer**
### Implements
- *CustomLayerInterface*
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [deckNs](#deckns)
- [id](#id)
- [layer](#layer)
- [renderingMode](#renderingmode)
- [type](#type)
#### Methods
- [onAdd](#onadd)
- [onRemove](#onremove)
- [render](#render)
- [setProps](#setprops)
### Constructors
#### constructor
\+ **new DeckLayer**(`props`: *any*): [*DeckLayer*](#classesdefaultdecklayermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `props` | *any* |
**Returns:** [*DeckLayer*](#classesdefaultdecklayermd)
Overrides: Evented.constructor
### Properties
#### deckNs
• **deckNs**: *object*
___
#### id
• **id**: *string*
Implementation of: CustomLayerInterface.id
___
#### layer
• **layer**: *object*
___
#### renderingMode
• `Optional` **renderingMode**: ``"2d"`` \| ``"3d"``
Implementation of: CustomLayerInterface.renderingMode
___
#### type
• **type**: ``"custom"``
Implementation of: CustomLayerInterface.type
### Methods
#### onAdd
▸ **onAdd**(`map`: *any*, `gl`: *any*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *any* |
| `gl` | *any* |
**Returns:** *void*
Implementation of: CustomLayerInterface.onAdd
___
#### onRemove
▸ **onRemove**(): *void*
**Returns:** *void*
Implementation of: CustomLayerInterface.onRemove
___
#### render
▸ **render**(`gl`: *any*, `matrix`: *any*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `gl` | *any* |
| `matrix` | *any* |
**Returns:** *void*
Implementation of: CustomLayerInterface.render
___
#### setProps
▸ **setProps**(`props`: *any*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `props` | *any* |
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / [default](#modulesdefaultmd) / AnimateMarkerLayer
## Class: AnimateMarkerLayer
[default](#modulesdefaultmd).AnimateMarkerLayer
动画标记图层.
### Hierarchy
- *Evented*
↳ **AnimateMarkerLayer**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Methods
- [\_getMarkerElement](#_getmarkerelement)
- [addTo](#addto)
- [clearMarkerLayer](#clearmarkerlayer)
- [getMarkers](#getmarkers)
- [remove](#remove)
- [render](#render)
- [setType](#settype)
### Constructors
#### constructor
\+ **new AnimateMarkerLayer**(`features`: *FeatureCollection*, `options?`: [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd)): [*AnimateMarkerLayer*](#classesdefaultanimatemarkerlayermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `features` | *FeatureCollection* |
| `options?` | [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd) |
**Returns:** [*AnimateMarkerLayer*](#classesdefaultanimatemarkerlayermd)
Overrides: Evented.constructor
### Methods
#### \_getMarkerElement
▸ **_getMarkerElement**(): *void*
**Returns:** *void*
___
#### addTo
▸ **addTo**(`map`: *Map*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
**Returns:** *void*
___
#### clearMarkerLayer
▸ **clearMarkerLayer**(): *void*
**Returns:** *void*
___
#### getMarkers
▸ **getMarkers**(): *Marker*[]
**Returns:** *Marker*[]
___
#### remove
▸ **remove**(): *void*
**Returns:** *void*
___
#### render
▸ **render**(): *void*
**Returns:** *void*
___
#### setType
▸ **setType**(`type`: [*AnimateMarkerType*](#animatemarkertype), `options?`: [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd)): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `type` | [*AnimateMarkerType*](#animatemarkertype) |
| `options?` | [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd) |
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / [default](#modulesdefaultmd) / BackgroundLayer
## Class: BackgroundLayer
[default](#modulesdefaultmd).BackgroundLayer
创建一个背景图层.
### Hierarchy
- [*OverlayLayerBase*](#classesdefaultoverlaylayerbasemd)
↳ **BackgroundLayer**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [\_map](#_map)
- [layerId](#layerid)
- [options](#options)
- [sourceId](#sourceid)
#### Methods
- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getBackgroundColor](#getbackgroundcolor)
- [getBackgroundOpacity](#getbackgroundopacity)
- [getBackgroundPattern](#getbackgroundpattern)
- [getData](#getdata)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getSourceId](#getsourceid)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setBackgroundColor](#setbackgroundcolor)
- [setBackgroundOpacity](#setbackgroundopacity)
- [setBackgroundPattern](#setbackgroundpattern)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setProperty](#setproperty)
- [show](#show)
- [toggle](#toggle)
### Constructors
#### constructor
\+ **new BackgroundLayer**(`options`: [*BackgroundLayerOptions*](#interfacesdefaultbackgroundlayeroptionsmd)): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `options` | [*BackgroundLayerOptions*](#interfacesdefaultbackgroundlayeroptionsmd) |
**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
### Properties
#### \_map
• `Optional` **\_map**: *Map*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[_map](#_map)
___
#### layerId
• `Optional` **layerId**: *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[layerId](#layerid)
___
#### options
• **options**: [*BackgroundLayerOptions*](#interfacesdefaultbackgroundlayeroptionsmd)
___
#### sourceId
• `Optional` **sourceId**: *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[sourceId](#sourceid)
### Methods
#### addTo
▸ **addTo**(`map`: *Map*, `beforeId?`: *string*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
| `beforeId?` | *string* |
**Returns:** *void*
Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### clickLayer
▸ **clickLayer**(`cb`: *any*): *any*
每当单击这些图层中的要素时都会触发回调。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cb` | *any* | Callback that receives event with .features property |
**Returns:** *any*
A function that removes the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### clickPopup
▸ **clickPopup**(`htmlFunc`: (`arg0`: {}) => *void*, `popupOptions?`: PopupOptions): *any*
每当单击这些图层中的要素时都会显示一个弹出窗口。
**`example`** clickPopup(f => `${f.properties.Name}
${f.properties.Description}`, { maxWidth: 500 });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | (`arg0`: {}) => *void* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
A function that removes the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getBackgroundColor
▸ **getBackgroundColor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
___
#### getBackgroundOpacity
▸ **getBackgroundOpacity**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
___
#### getBackgroundPattern
▸ **getBackgroundPattern**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
___
#### getData
▸ **getData**(): *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
获取数据源的数据
**Returns:** *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getLayerId
▸ **getLayerId**(): *undefined* \| *string*
获取图层ID
**Returns:** *undefined* \| *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getLayerStyle
▸ **getLayerStyle**(): [*LayerSpecification*](#layerspecification)
根据样式规范，获取给定图层 ID 的图层定义。
**Returns:** [*LayerSpecification*](#layerspecification)
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getSourceId
▸ **getSourceId**(): *undefined* \| *string*
获取数据源ID
**Returns:** *undefined* \| *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hide
▸ **hide**(): *void*
使给定的图层不可见。
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverFeatureState
▸ **hoverFeatureState**(`enterCb?`: (`arg0`: {}) => *void*, `leaveCb?`: (`arg0`: {}) => *void*): *void*
每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。
##### Parameters
| Name | Type |
| :------ | :------ |
| `enterCb?` | (`arg0`: {}) => *void* |
| `leaveCb?` | (`arg0`: {}) => *void* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverLayer
▸ **hoverLayer**(`cb`: *any*): *any*
当鼠标悬停在这些图层中的要素上时触发回调。
##### Parameters
| Name | Type |
| :------ | :------ |
| `cb` | *any* |
**Returns:** *any*
A function to remove the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverPointer
▸ **hoverPointer**(): *void*
每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。
**Returns:** *void*
A function to remove the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverPopup
▸ **hoverPopup**(`htmlFunc`: *any*, `popupOptions?`: PopupOptions): *any*
将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。
**`example`** hoverPopup(f => `${f.properties.Name}
${f.properties.Description}`, { anchor: 'left' });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | *any* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### remove
▸ **remove**(): *void*
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setBackgroundColor
▸ **setBackgroundColor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex) |
**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
___
#### setBackgroundOpacity
▸ **setBackgroundOpacity**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex) |
**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
___
#### setBackgroundPattern
▸ **setBackgroundPattern**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex) |
**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)
___
#### setFilter
▸ **setFilter**(`filter`: [*FilterSpecification*](#filterspecification)): *void*
替换一个图层的过滤器。
**`example`** setFilter(['==','level','0']]);
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `filter` | [*FilterSpecification*](#filterspecification) | New filter to set. |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setLayerStyle
▸ **setLayerStyle**(`style`: *any*): *void*
设置图层样式
##### Parameters
| Name | Type |
| :------ | :------ |
| `style` | *any* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setProperty
▸ **setProperty**(`prop`: *string* \| *object*, `value?`: *any*): *void*
在一个或多个图层上设置绘制或布局属性。
**`example`** setProperty('fillOpacity', 0.5)
##### Parameters
| Name | Type |
| :------ | :------ |
| `prop` | *string* \| *object* |
| `value?` | *any* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### show
▸ **show**(): *void*
使给定的图层可见。
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### toggle
▸ **toggle**(`state`: *boolean*): *boolean*
根据参数使给定的图层隐藏或可见。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `state` | *boolean* | True for visible, false for hidden. |
**Returns:** *boolean*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
[vjmap](#readmemd) / [Exports](#modulesmd) / [default](#modulesdefaultmd) / BreathingApertureMarker
## Class: BreathingApertureMarker
[default](#modulesdefaultmd).BreathingApertureMarker
呼吸的光圈.
### Hierarchy
- *MarkerBase*
↳ **BreathingApertureMarker**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [features](#features)
- [markersElement](#markerselement)
- [options](#options)
#### Methods
- [\_createMarker](#_createmarker)
- [\_getColorWithOpacity](#_getcolorwithopacity)
- [\_getTextContainer](#_gettextcontainer)
- [createMarker](#createmarker)
- [getColorWithOpacity](#getcolorwithopacity)
- [getElement](#getelement)
- [getLngLat](#getlnglat)
- [getMarkersElement](#getmarkerselement)
- [set16ToRgb](#set16torgb)
- [setDotSize](#setdotsize)
- [setFeatures](#setfeatures)
- [setMarkersColors](#setmarkerscolors)
- [setMarkersText](#setmarkerstext)
- [setMarkersTextColor](#setmarkerstextcolor)
- [setMarkersTextField](#setmarkerstextfield)
- [setMarkersTextFontSize](#setmarkerstextfontsize)
- [setMarkersWidth](#setmarkerswidth)
### Constructors
#### constructor
\+ **new BreathingApertureMarker**(`features`: *FeatureCollection* \| { `lngLat`: LngLatLike ; `text?`: *string* }, `options?`: [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd)): [*BreathingApertureMarker*](#classesdefaultbreathingaperturemarkermd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `features` | *FeatureCollection* \| { `lngLat`: LngLatLike ; `text?`: *string* } |
| `options?` | [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd) |
**Returns:** [*BreathingApertureMarker*](#classesdefaultbreathingaperturemarkermd)
Overrides: MarkerBase.constructor
### Properties
#### features
• `Protected` **features**: *FeatureCollection* \| { `lngLat`: LngLatLike ; `text?`: *string* }
Inherited from: MarkerBase.features
___
#### markersElement
• `Protected` **markersElement**: *any*
Inherited from: MarkerBase.markersElement
___
#### options
• `Protected` **options**: [*AnimateMarkerLayerOption*](#interfacesdefaultanimatemarkerlayeroptionmd)
Inherited from: MarkerBase.options
### Methods
#### \_createMarker
▸ **_createMarker**(): *void*
**Returns:** *void*
___
#### \_getColorWithOpacity
▸ `Protected` **_getColorWithOpacity**(`color`: *string*, `opacity`: *string* \| *number*): *string*
##### Parameters
| Name | Type |
| :------ | :------ |
| `color` | *string* |
| `opacity` | *string* \| *number* |
**Returns:** *string*
Inherited from: MarkerBase.\_getColorWithOpacity
___
#### \_getTextContainer
▸ `Protected` **_getTextContainer**(`feature`: *any*, `className`: *string*): ``null`` \| HTMLDivElement
##### Parameters
| Name | Type |
| :------ | :------ |
| `feature` | *any* |
| `className` | *string* |
**Returns:** ``null`` \| HTMLDivElement
Inherited from: MarkerBase.\_getTextContainer
___
#### createMarker
▸ **createMarker**(`options?`: [*createMarkerOptions*](#interfacesdefaultcreatemarkeroptionsmd), `index?`: *number*): *Marker*
##### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | [*createMarkerOptions*](#interfacesdefaultcreatemarkeroptionsmd) |
| `index?` | *number* |
**Returns:** *Marker*
Inherited from: MarkerBase.createMarker
___
#### getColorWithOpacity
▸ **getColorWithOpacity**(`color`: *string*, `opacity`: *string* \| *number*): *string*
##### Parameters
| Name | Type |
| :------ | :------ |
| `color` | *string* |
| `opacity` | *string* \| *number* |
**Returns:** *string*
Inherited from: MarkerBase.getColorWithOpacity
___
#### getElement
▸ **getElement**(`index?`: *number*): *any*
##### Parameters
| Name | Type |
| :------ | :------ |
| `index?` | *number* |
**Returns:** *any*
Inherited from: MarkerBase.getElement
___
#### getLngLat
▸ **getLngLat**(`index?`: *number*): *any*
##### Parameters
| Name | Type |
| :------ | :------ |
| `index?` | *number* |
**Returns:** *any*
Inherited from: MarkerBase.getLngLat
___
#### getMarkersElement
▸ **getMarkersElement**(): *any*
**Returns:** *any*
Inherited from: MarkerBase.getMarkersElement
___
#### set16ToRgb
▸ **set16ToRgb**(`str`: *string*): *string*
##### Parameters
| Name | Type |
| :------ | :------ |
| `str` | *string* |
**Returns:** *string*
Inherited from: MarkerBase.set16ToRgb
___
#### setDotSize
▸ **setDotSize**(`size`: *number*, `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `size` | *number* |
| `index?` | *number* |
**Returns:** *void*
___
#### setFeatures
▸ **setFeatures**(`features`: *FeatureCollection*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `features` | *FeatureCollection* |
**Returns:** *void*
Inherited from: MarkerBase.setFeatures
___
#### setMarkersColors
▸ **setMarkersColors**(`colors`: *string*[], `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `colors` | *string*[] |
| `index?` | *number* |
**Returns:** *void*
___
#### setMarkersText
▸ **setMarkersText**(`text`: *string*, `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `text` | *string* |
| `index?` | *number* |
**Returns:** *void*
Inherited from: MarkerBase.setMarkersText
___
#### setMarkersTextColor
▸ **setMarkersTextColor**(`textColor`: *string*, `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `textColor` | *string* |
| `index?` | *number* |
**Returns:** *void*
Inherited from: MarkerBase.setMarkersTextColor
___
#### setMarkersTextField
▸ **setMarkersTextField**(`textField`: *string*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `textField` | *string* |
**Returns:** *void*
Inherited from: MarkerBase.setMarkersTextField
___
#### setMarkersTextFontSize
▸ **setMarkersTextFontSize**(`textFontSize`: *number*, `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `textFontSize` | *number* |
| `index?` | *number* |
**Returns:** *void*
Inherited from: MarkerBase.setMarkersTextFontSize
___
#### setMarkersWidth
▸ **setMarkersWidth**(`width`: *number*, `index?`: *number*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `width` | *number* |
| `index?` | *number* |
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / [default](#modulesdefaultmd) / ButtonGroupControl
## Class: ButtonGroupControl
[default](#modulesdefaultmd).ButtonGroupControl
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Methods
- [onAdd](#onadd)
- [onRemove](#onremove)
### Constructors
#### constructor
\+ **new ButtonGroupControl**(`options?`: *Record*): [*ButtonGroupControl*](#classesdefaultbuttongroupcontrolmd)
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `options` | *Record* | {} |
**Returns:** [*ButtonGroupControl*](#classesdefaultbuttongroupcontrolmd)
### Methods
#### onAdd
▸ **onAdd**(`map`: *Map*): HTMLElement
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
**Returns:** HTMLElement
___
#### onRemove
▸ **onRemove**(): *void*
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / [default](#modulesdefaultmd) / Circle
## Class: Circle
[default](#modulesdefaultmd).Circle
创建圆符号图层.
### Hierarchy
- [*OverlayLayerBase*](#classesdefaultoverlaylayerbasemd)
↳ **Circle**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [\_map](#_map)
- [layerId](#layerid)
- [options](#options)
- [sourceId](#sourceid)
#### Methods
- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getCircleBlur](#getcircleblur)
- [getCircleColor](#getcirclecolor)
- [getCircleOpacity](#getcircleopacity)
- [getCirclePitchAlignment](#getcirclepitchalignment)
- [getCirclePitchScale](#getcirclepitchscale)
- [getCircleRadius](#getcircleradius)
- [getCircleSortKey](#getcirclesortkey)
- [getCircleStrokeColor](#getcirclestrokecolor)
- [getCircleStrokeOpacity](#getcirclestrokeopacity)
- [getCircleStrokeWidth](#getcirclestrokewidth)
- [getCircleTranslate](#getcircletranslate)
- [getCircleTranslateAnchor](#getcircletranslateanchor)
- [getData](#getdata)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getSourceId](#getsourceid)
- [getVisibility](#getvisibility)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setCircleBlur](#setcircleblur)
- [setCircleColor](#setcirclecolor)
- [setCircleOpacity](#setcircleopacity)
- [setCirclePitchAlignment](#setcirclepitchalignment)
- [setCirclePitchScale](#setcirclepitchscale)
- [setCircleRadius](#setcircleradius)
- [setCircleSortKey](#setcirclesortkey)
- [setCircleStrokeColor](#setcirclestrokecolor)
- [setCircleStrokeOpacity](#setcirclestrokeopacity)
- [setCircleStrokeWidth](#setcirclestrokewidth)
- [setCircleTranslate](#setcircletranslate)
- [setCircleTranslateAnchor](#setcircletranslateanchor)
- [setData](#setdata)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setProperty](#setproperty)
- [setVisibility](#setvisibility)
- [show](#show)
- [toggle](#toggle)
### Constructors
#### constructor
\+ **new Circle**(`options`: [*CircleOptions*](#interfacesdefaultcircleoptionsmd)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `options` | [*CircleOptions*](#interfacesdefaultcircleoptionsmd) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
### Properties
#### \_map
• `Optional` **\_map**: *Map*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[_map](#_map)
___
#### layerId
• `Optional` **layerId**: *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[layerId](#layerid)
___
#### options
• **options**: [*CircleOptions*](#interfacesdefaultcircleoptionsmd)
___
#### sourceId
• `Optional` **sourceId**: *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[sourceId](#sourceid)
### Methods
#### addTo
▸ **addTo**(`map`: *Map*, `beforeId?`: *string*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
| `beforeId?` | *string* |
**Returns:** *void*
Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### clickLayer
▸ **clickLayer**(`cb`: *any*): *any*
每当单击这些图层中的要素时都会触发回调。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cb` | *any* | Callback that receives event with .features property |
**Returns:** *any*
A function that removes the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### clickPopup
▸ **clickPopup**(`htmlFunc`: (`arg0`: {}) => *void*, `popupOptions?`: PopupOptions): *any*
每当单击这些图层中的要素时都会显示一个弹出窗口。
**`example`** clickPopup(f => `${f.properties.Name}
${f.properties.Description}`, { maxWidth: 500 });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | (`arg0`: {}) => *void* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
A function that removes the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getCircleBlur
▸ **getCircleBlur**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleColor
▸ **getCircleColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleOpacity
▸ **getCircleOpacity**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCirclePitchAlignment
▸ **getCirclePitchAlignment**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
___
#### getCirclePitchScale
▸ **getCirclePitchScale**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
___
#### getCircleRadius
▸ **getCircleRadius**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleSortKey
▸ **getCircleSortKey**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleStrokeColor
▸ **getCircleStrokeColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleStrokeOpacity
▸ **getCircleStrokeOpacity**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleStrokeWidth
▸ **getCircleStrokeWidth**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
___
#### getCircleTranslate
▸ **getCircleTranslate**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>
___
#### getCircleTranslateAnchor
▸ **getCircleTranslateAnchor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
___
#### getData
▸ **getData**(): *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
获取数据源的数据
**Returns:** *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getLayerId
▸ **getLayerId**(): *undefined* \| *string*
获取图层ID
**Returns:** *undefined* \| *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getLayerStyle
▸ **getLayerStyle**(): [*LayerSpecification*](#layerspecification)
根据样式规范，获取给定图层 ID 的图层定义。
**Returns:** [*LayerSpecification*](#layerspecification)
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getSourceId
▸ **getSourceId**(): *undefined* \| *string*
获取数据源ID
**Returns:** *undefined* \| *string*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### getVisibility
▸ **getVisibility**(): ``"visible"`` \| ``"none"``
**Returns:** ``"visible"`` \| ``"none"``
___
#### hide
▸ **hide**(): *void*
使给定的图层不可见。
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverFeatureState
▸ **hoverFeatureState**(`enterCb?`: (`arg0`: {}) => *void*, `leaveCb?`: (`arg0`: {}) => *void*): *void*
每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。
##### Parameters
| Name | Type |
| :------ | :------ |
| `enterCb?` | (`arg0`: {}) => *void* |
| `leaveCb?` | (`arg0`: {}) => *void* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverLayer
▸ **hoverLayer**(`cb`: *any*): *any*
当鼠标悬停在这些图层中的要素上时触发回调。
##### Parameters
| Name | Type |
| :------ | :------ |
| `cb` | *any* |
**Returns:** *any*
A function to remove the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverPointer
▸ **hoverPointer**(): *void*
每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。
**Returns:** *void*
A function to remove the handler.
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### hoverPopup
▸ **hoverPopup**(`htmlFunc`: *any*, `popupOptions?`: PopupOptions): *any*
将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。
**`example`** hoverPopup(f => `${f.properties.Name}
${f.properties.Description}`, { anchor: 'left' });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | *any* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### remove
▸ **remove**(): *void*
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setCircleBlur
▸ **setCircleBlur**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleColor
▸ **setCircleColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleOpacity
▸ **setCircleOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCirclePitchAlignment
▸ **setCirclePitchAlignment**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCirclePitchScale
▸ **setCirclePitchScale**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleRadius
▸ **setCircleRadius**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleSortKey
▸ **setCircleSortKey**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleStrokeColor
▸ **setCircleStrokeColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleStrokeOpacity
▸ **setCircleStrokeOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleStrokeWidth
▸ **setCircleStrokeWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleTranslate
▸ **setCircleTranslate**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\> |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setCircleTranslateAnchor
▸ **setCircleTranslateAnchor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### setData
▸ **setData**(`data`: *any*): *void*
替换 GeoJSON 图层的当前数据。
##### Parameters
| Name | Type |
| :------ | :------ |
| `data` | *any* |
**Returns:** *void*
___
#### setFilter
▸ **setFilter**(`filter`: [*FilterSpecification*](#filterspecification)): *void*
替换一个图层的过滤器。
**`example`** setFilter(['==','level','0']]);
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `filter` | [*FilterSpecification*](#filterspecification) | New filter to set. |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setLayerStyle
▸ **setLayerStyle**(`style`: *any*): *void*
设置图层样式
##### Parameters
| Name | Type |
| :------ | :------ |
| `style` | *any* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setProperty
▸ **setProperty**(`prop`: *string* \| *object*, `value?`: *any*): *void*
在一个或多个图层上设置绘制或布局属性。
**`example`** setProperty('fillOpacity', 0.5)
##### Parameters
| Name | Type |
| :------ | :------ |
| `prop` | *string* \| *object* |
| `value?` | *any* |
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### setVisibility
▸ **setVisibility**(`value`: ``"visible"`` \| ``"none"``): [*Circle*](#classesdefaultcirclemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | ``"visible"`` \| ``"none"`` |
**Returns:** [*Circle*](#classesdefaultcirclemd)
___
#### show
▸ **show**(): *void*
使给定的图层可见。
**Returns:** *void*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
___
#### toggle
▸ **toggle**(`state`: *boolean*): *boolean*
根据参数使给定的图层隐藏或可见。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `state` | *boolean* | True for visible, false for hidden. |
**Returns:** *boolean*
Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)
[vjmap](#readmemd) / [Exports](#modulesmd) / [default](#modulesdefaultmd) / CircleEdge
## Class: CircleEdge
[default](#modulesdefaultmd).CircleEdge
创建只有边框的圆或圆弧
### Hierarchy
- [*Polyline*](#classesdefaultpolylinemd)
↳ **CircleEdge**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [\_map](#_map)
- [layerId](#layerid)
- [options](#options)
- [sourceId](#sourceid)
#### Methods
- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getCenter](#getcenter)
- [getData](#getdata)
- [getEndAngle](#getendangle)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getLineBlur](#getlineblur)
- [getLineCap](#getlinecap)
- [getLineColor](#getlinecolor)
- [getLineDasharray](#getlinedasharray)
- [getLineGapWidth](#getlinegapwidth)
- [getLineGradient](#getlinegradient)
- [getLineJoin](#getlinejoin)
- [getLineMiterMimit](#getlinemitermimit)
- [getLineOffset](#getlineoffset)
- [getLineOpacity](#getlineopacity)
- [getLinePattern](#getlinepattern)
- [getLineRoundLimit](#getlineroundlimit)
- [getLineSortKey](#getlinesortkey)
- [getLineTranslate](#getlinetranslate)
- [getLineTranslateAnchor](#getlinetranslateanchor)
- [getLineWidth](#getlinewidth)
- [getPoints](#getpoints)
- [getRadius](#getradius)
- [getSourceId](#getsourceid)
- [getStartAngle](#getstartangle)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setCenter](#setcenter)
- [setData](#setdata)
- [setEndAngle](#setendangle)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setLineBlur](#setlineblur)
- [setLineCap](#setlinecap)
- [setLineColor](#setlinecolor)
- [setLineDasharray](#setlinedasharray)
- [setLineGapWidth](#setlinegapwidth)
- [setLineGradient](#setlinegradient)
- [setLineJoin](#setlinejoin)
- [setLineMiterMimit](#setlinemitermimit)
- [setLineOffset](#setlineoffset)
- [setLineOpacity](#setlineopacity)
- [setLinePattern](#setlinepattern)
- [setLineRoundLimit](#setlineroundlimit)
- [setLineSortKey](#setlinesortkey)
- [setLineTranslate](#setlinetranslate)
- [setLineTranslateAnchor](#setlinetranslateanchor)
- [setLineWidth](#setlinewidth)
- [setPoints](#setpoints)
- [setProperty](#setproperty)
- [setRadius](#setradius)
- [setStartAngle](#setstartangle)
- [show](#show)
- [toggle](#toggle)
- [updateData](#updatedata)
### Constructors
#### constructor
\+ **new CircleEdge**(`options`: [*CircleEdgeOptions*](#interfacesdefaultcircleedgeoptionsmd)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `options` | [*CircleEdgeOptions*](#interfacesdefaultcircleedgeoptionsmd) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Overrides: [Polyline](#classesdefaultpolylinemd)
### Properties
#### \_map
• `Optional` **\_map**: *Map*
Inherited from: [Polyline](#classesdefaultpolylinemd).[_map](#_map)
___
#### layerId
• `Optional` **layerId**: *string*
Inherited from: [Polyline](#classesdefaultpolylinemd).[layerId](#layerid)
___
#### options
• **options**: [*PolylineOptions*](#interfacesdefaultpolylineoptionsmd)
Inherited from: [Polyline](#classesdefaultpolylinemd).[options](#options)
___
#### sourceId
• `Optional` **sourceId**: *string*
Inherited from: [Polyline](#classesdefaultpolylinemd).[sourceId](#sourceid)
### Methods
#### addTo
▸ **addTo**(`map`: *Map*, `beforeId?`: *string*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
| `beforeId?` | *string* |
**Returns:** *void*
Overrides: [Polyline](#classesdefaultpolylinemd)
___
#### clickLayer
▸ **clickLayer**(`cb`: *any*): *any*
每当单击这些图层中的要素时都会触发回调。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cb` | *any* | Callback that receives event with .features property |
**Returns:** *any*
A function that removes the handler.
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### clickPopup
▸ **clickPopup**(`htmlFunc`: (`arg0`: {}) => *void*, `popupOptions?`: PopupOptions): *any*
每当单击这些图层中的要素时都会显示一个弹出窗口。
**`example`** clickPopup(f => `${f.properties.Name}
${f.properties.Description}`, { maxWidth: 500 });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | (`arg0`: {}) => *void* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
A function that removes the handler.
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getCenter
▸ **getCenter**(): [*GeoPointLike*](#geopointlike)
得到中心点。
**Returns:** [*GeoPointLike*](#geopointlike)
___
#### getData
▸ **getData**(): *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
获取数据源的数据
**Returns:** *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getEndAngle
▸ **getEndAngle**(): *number*
得到结束角度。
**Returns:** *number*
___
#### getLayerId
▸ **getLayerId**(): *undefined* \| *string*
获取图层ID
**Returns:** *undefined* \| *string*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLayerStyle
▸ **getLayerStyle**(): [*LayerSpecification*](#layerspecification)
根据样式规范，获取给定图层 ID 的图层定义。
**Returns:** [*LayerSpecification*](#layerspecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineBlur
▸ **getLineBlur**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineCap
▸ **getLineCap**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\>
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\>
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineColor
▸ **getLineColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineDasharray
▸ **getLineDasharray**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineGapWidth
▸ **getLineGapWidth**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineGradient
▸ **getLineGradient**(): [*ExpressionSpecificationEx*](#expressionspecificationex)
**Returns:** [*ExpressionSpecificationEx*](#expressionspecificationex)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineJoin
▸ **getLineJoin**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\>
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\>
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineMiterMimit
▸ **getLineMiterMimit**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineOffset
▸ **getLineOffset**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineOpacity
▸ **getLineOpacity**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLinePattern
▸ **getLinePattern**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineRoundLimit
▸ **getLineRoundLimit**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineSortKey
▸ **getLineSortKey**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineTranslate
▸ **getLineTranslate**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineTranslateAnchor
▸ **getLineTranslateAnchor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getLineWidth
▸ **getLineWidth**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getPoints
▸ **getPoints**(): *number*
得到离散化的点的个数。
**Returns:** *number*
___
#### getRadius
▸ **getRadius**(): *number*
得到半径。
**Returns:** *number*
___
#### getSourceId
▸ **getSourceId**(): *undefined* \| *string*
获取数据源ID
**Returns:** *undefined* \| *string*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### getStartAngle
▸ **getStartAngle**(): *number*
得到开始角度。
**Returns:** *number*
___
#### hide
▸ **hide**(): *void*
使给定的图层不可见。
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### hoverFeatureState
▸ **hoverFeatureState**(`enterCb?`: (`arg0`: {}) => *void*, `leaveCb?`: (`arg0`: {}) => *void*): *void*
每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。
##### Parameters
| Name | Type |
| :------ | :------ |
| `enterCb?` | (`arg0`: {}) => *void* |
| `leaveCb?` | (`arg0`: {}) => *void* |
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### hoverLayer
▸ **hoverLayer**(`cb`: *any*): *any*
当鼠标悬停在这些图层中的要素上时触发回调。
##### Parameters
| Name | Type |
| :------ | :------ |
| `cb` | *any* |
**Returns:** *any*
A function to remove the handler.
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### hoverPointer
▸ **hoverPointer**(): *void*
每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。
**Returns:** *void*
A function to remove the handler.
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### hoverPopup
▸ **hoverPopup**(`htmlFunc`: *any*, `popupOptions?`: PopupOptions): *any*
将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。
**`example`** hoverPopup(f => `${f.properties.Name}
${f.properties.Description}`, { anchor: 'left' });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | *any* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### remove
▸ **remove**(): *void*
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setCenter
▸ **setCenter**(`value`: [*GeoPointLike*](#geopointlike), `bFocusUpdateData?`: *boolean*): [*CircleEdge*](#classesdefaultcircleedgemd)
设置中心点。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | [*GeoPointLike*](#geopointlike) | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
___
#### setData
▸ **setData**(`data`: *any*): *void*
替换 GeoJSON 图层的当前数据。
##### Parameters
| Name | Type |
| :------ | :------ |
| `data` | *any* |
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setEndAngle
▸ **setEndAngle**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleEdge*](#classesdefaultcircleedgemd)
设置结束角度。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
___
#### setFilter
▸ **setFilter**(`filter`: [*FilterSpecification*](#filterspecification)): *void*
替换一个图层的过滤器。
**`example`** setFilter(['==','level','0']]);
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `filter` | [*FilterSpecification*](#filterspecification) | New filter to set. |
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLayerStyle
▸ **setLayerStyle**(`style`: *any*): *void*
设置图层样式
##### Parameters
| Name | Type |
| :------ | :------ |
| `style` | *any* |
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineBlur
▸ **setLineBlur**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineCap
▸ **setLineCap**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\>): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\> |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineColor
▸ **setLineColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineDasharray
▸ **setLineDasharray**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineGapWidth
▸ **setLineGapWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineGradient
▸ **setLineGradient**(`value`: [*ExpressionSpecificationEx*](#expressionspecificationex)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*ExpressionSpecificationEx*](#expressionspecificationex) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineJoin
▸ **setLineJoin**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\>): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\> |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineMiterMimit
▸ **setLineMiterMimit**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineOffset
▸ **setLineOffset**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineOpacity
▸ **setLineOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLinePattern
▸ **setLinePattern**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineRoundLimit
▸ **setLineRoundLimit**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineSortKey
▸ **setLineSortKey**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineTranslate
▸ **setLineTranslate**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\> |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineTranslateAnchor
▸ **setLineTranslateAnchor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setLineWidth
▸ **setLineWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)): [*CircleEdge*](#classesdefaultcircleedgemd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification) |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setPoints
▸ **setPoints**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleEdge*](#classesdefaultcircleedgemd)
设置离散化的点的个数。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
___
#### setProperty
▸ **setProperty**(`prop`: *string* \| *object*, `value?`: *any*): *void*
在一个或多个图层上设置绘制或布局属性。
**`example`** setProperty('fillOpacity', 0.5)
##### Parameters
| Name | Type |
| :------ | :------ |
| `prop` | *string* \| *object* |
| `value?` | *any* |
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### setRadius
▸ **setRadius**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleEdge*](#classesdefaultcircleedgemd)
设置半径。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
___
#### setStartAngle
▸ **setStartAngle**(`value`: *number*, `bFocusUpdateData?`: *boolean*): [*CircleEdge*](#classesdefaultcircleedgemd)
设置开始角度。
##### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `value` | *number* | - |
| `bFocusUpdateData` | *boolean* | true |
**Returns:** [*CircleEdge*](#classesdefaultcircleedgemd)
___
#### show
▸ **show**(): *void*
使给定的图层可见。
**Returns:** *void*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### toggle
▸ **toggle**(`state`: *boolean*): *boolean*
根据参数使给定的图层隐藏或可见。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `state` | *boolean* | True for visible, false for hidden. |
**Returns:** *boolean*
Inherited from: [Polyline](#classesdefaultpolylinemd)
___
#### updateData
▸ **updateData**(): *void*
**Returns:** *void*
[vjmap](#readmemd) / [Exports](#modulesmd) / [default](#modulesdefaultmd) / CircleFill
## Class: CircleFill
[default](#modulesdefaultmd).CircleFill
创建填充的圆或圆弧
### Hierarchy
- [*Polygon*](#classesdefaultpolygonmd)
↳ **CircleFill**
### Table of contents
#### Constructors
- [constructor](#constructor)
#### Properties
- [\_map](#_map)
- [layerId](#layerid)
- [options](#options)
- [sourceId](#sourceid)
#### Methods
- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getCenter](#getcenter)
- [getData](#getdata)
- [getEndAngle](#getendangle)
- [getFillAntialias](#getfillantialias)
- [getFillColor](#getfillcolor)
- [getFillOpacity](#getfillopacity)
- [getFillOutlineColor](#getfilloutlinecolor)
- [getFillPattern](#getfillpattern)
- [getFillSortKey](#getfillsortkey)
- [getFillTranslate](#getfilltranslate)
- [getFillTranslateAnchor](#getfilltranslateanchor)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getPoints](#getpoints)
- [getRadius](#getradius)
- [getSourceId](#getsourceid)
- [getStartAngle](#getstartangle)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setCenter](#setcenter)
- [setData](#setdata)
- [setEndAngle](#setendangle)
- [setFillAntialias](#setfillantialias)
- [setFillColor](#setfillcolor)
- [setFillOpacity](#setfillopacity)
- [setFillOutlineColor](#setfilloutlinecolor)
- [setFillPattern](#setfillpattern)
- [setFillSortKey](#setfillsortkey)
- [setFillTranslate](#setfilltranslate)
- [setFillTranslateAnchor](#setfilltranslateanchor)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setPoints](#setpoints)
- [setProperty](#setproperty)
- [setRadius](#setradius)
- [setStartAngle](#setstartangle)
- [show](#show)
- [toggle](#toggle)
- [updateData](#updatedata)
### Constructors
#### constructor
\+ **new CircleFill**(`options`: [*CircleFillOptions*](#interfacesdefaultcirclefilloptionsmd)): [*CircleFill*](#classesdefaultcirclefillmd)
##### Parameters
| Name | Type |
| :------ | :------ |
| `options` | [*CircleFillOptions*](#interfacesdefaultcirclefilloptionsmd) |
**Returns:** [*CircleFill*](#classesdefaultcirclefillmd)
Overrides: [Polygon](#classesdefaultpolygonmd)
### Properties
#### \_map
• `Optional` **\_map**: *Map*
Inherited from: [Polygon](#classesdefaultpolygonmd).[_map](#_map)
___
#### layerId
• `Optional` **layerId**: *string*
Inherited from: [Polygon](#classesdefaultpolygonmd).[layerId](#layerid)
___
#### options
• **options**: [*PolygonOptions*](#interfacesdefaultpolygonoptionsmd)
Inherited from: [Polygon](#classesdefaultpolygonmd).[options](#options)
___
#### sourceId
• `Optional` **sourceId**: *string*
Inherited from: [Polygon](#classesdefaultpolygonmd).[sourceId](#sourceid)
### Methods
#### addTo
▸ **addTo**(`map`: *Map*, `beforeId?`: *string*): *void*
##### Parameters
| Name | Type |
| :------ | :------ |
| `map` | *Map* |
| `beforeId?` | *string* |
**Returns:** *void*
Overrides: [Polygon](#classesdefaultpolygonmd)
___
#### clickLayer
▸ **clickLayer**(`cb`: *any*): *any*
每当单击这些图层中的要素时都会触发回调。
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cb` | *any* | Callback that receives event with .features property |
**Returns:** *any*
A function that removes the handler.
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### clickPopup
▸ **clickPopup**(`htmlFunc`: (`arg0`: {}) => *void*, `popupOptions?`: PopupOptions): *any*
每当单击这些图层中的要素时都会显示一个弹出窗口。
**`example`** clickPopup(f => `${f.properties.Name}
${f.properties.Description}`, { maxWidth: 500 });
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | (`arg0`: {}) => *void* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |
**Returns:** *any*
A function that removes the handler.
Inherited from: [Polygon](#classesdefaultpolygonmd)
___
#### getCenter
▸ **getCenter**(): [*GeoPointLike*](#geopointlike)
得到中心点。
**Returns:** [*GeoPointLike*](#geopointlike)
___
#### getData
▸ **getData**(): *undefined* \| *Feature* \| *FeatureCollection* \| Geometry \| GeometryCollection
获取数据源的数据
**Returns:** *undefined* \| *Feature*