唯杰地图-VJMAP

# 目录

# 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将被添加到地图中。（可选，默认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 ? 如果设置，地图将被限制在给定的范围内。
    • options.scrollZoom **( boolean| Object)**如果true，则启用“滚动缩放”交互。一个Object值作为选项传递给ScrollZoomHandler#enable。（可选，默认true）
    • options.boxZoom **boolean**如果true，则启用“框缩放”交互（请参阅BoxZoomHandler）。（可选，默认true）
    • options.dragRotate **boolean**如果true，则启用“拖动旋转”交互（请参阅DragRotateHandler）。（可选，默认true）
    • options.dragPan **( boolean| Object)**如果true，则启用“拖动平移”交互。一个Object值作为选项传递给DragPanHandler#enable。（可选，默认true）
    • options.keyboard **boolean**如果true，则启用键盘快捷键（请参阅KeyboardHandler）。（可选，默认true）
    • options.doubleClickZoom **boolean**如果true，则启用“双击缩放”交互（请参阅DoubleClickZoomHandler）。（可选，默认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**地图的初始地理中心点。如果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 ? 地图的初始边界。如果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
     }
    }
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# scrollZoom

地图的ScrollZoomHandler，它使用滚轮或触控板实现放大和缩小。scrollZoom在ScrollZoomHandler部分中查找更多详细信息和示例。

类型：ScrollZoomHandler

# boxZoom

地图的BoxZoomHandler，它使用按住 Shift 键的拖动手势实现缩放。boxZoom在BoxZoomHandler部分中查找更多详细信息和示例。

类型：BoxZoomHandler

# dragRotate

地图的DragRotateHandler，它实现了在使用鼠标右键或按下 Control 键拖动时旋转地图。dragRotate 在DragRotateHandler部分中查找更多详细信息和示例。

类型：DragRotateHandler

# dragPan

地图的DragPanHandler，它实现了使用鼠标或触摸手势拖动地图。dragPan在DragPanHandler部分中查找更多详细信息和示例。

类型：DragPanHandler

# keyboard

地图的KeyboardHandler，它允许用户使用键盘快捷键缩放、旋转和平移地图。keyboard在KeyboardHandler部分中查找更多详细信息和示例。

类型：KeyboardHandler

# doubleClickZoom

地图的DoubleClickZoomHandler，允许用户通过双击进行缩放。doubleClickZoom在DoubleClickZoomHandler部分中查找更多详细信息和示例。

类型：DoubleClickZoomHandler

# touchZoomRotate

地图的TouchZoomRotateHandler，它允许用户使用触摸手势缩放或旋转地图。touchZoomRotate在TouchZoomRotateHandler部分中查找更多详细信息和示例。

类型：TouchZoomRotateHandler

# touchPitch

地图的TouchPitchHandler，它允许用户通过触摸手势来调整地图。touchPitch在TouchPitchHandler部分中查找更多详细信息和示例。

类型：TouchPitchHandler

# addControl

将IControl添加到地图，调用control.onAdd(this).

# Parameters

  • control **ICONTROL**的ICONTROL补充。
  • 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());
1
2

返回**地图** this

# removeControl

从地图中删除控件。

# Parameters

# 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);
1
2
3
4
5
6

返回**地图** this

# hasControl

检查控件是否在地图上。

# Parameters

# 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
1
2
3
4
5
6
7

**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();
1
2
3
4

返回**地图** this

# getBounds

返回地图的地理边界。当方位角或螺距不为零时，可见区域不是轴对齐的矩形，结果是包含可见区域的最小边界。如果在地图上设置了填充，则返回的边界适用于插图。

# Examples

var bounds = map.getBounds();
1

返回**LngLatBounds**地图的地理边界作为LngLatBounds。

# getMaxBounds

返回地图被限制到的最大地理边界，或者null如果没有设置。

# Examples

var maxBounds = map.getMaxBounds();
1

返回**( LngLatBounds | null)**地图对象。

# setMaxBounds

设置或清除地图的地理边界。

平移和缩放操作被限制在这些范围内。如果执行平移或缩放会显示这些边界之外的区域，则地图将改为显示尽可能接近操作请求的位置和缩放级别，同时仍保持在边界内。

# Parameters

  • bounds **( LngLatBoundsLike | 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);
1
2
3
4
5
6
7

返回**地图** this

# setMinZoom

设置或清除地图的最小缩放级别。如果地图的当前缩放级别低于新的最小值，则地图将缩放到新的最小值。

并非总是可以缩小并到达集合minZoom。其他因素（例如地图高度）可能会限制缩放。例如，如果地图的高度为 512 像素，则无论minZoom设置为什么，都无法在缩放 0 以下进行缩放。

# Parameters

  • minZoom **( number| null | undefined)**要设置的最小缩放级别 (-2 - 24)。如果提供null或undefined，该函数将删除当前的最小缩放（即将其设置为 -2）。

# Examples

map.setMinZoom(12.25);
1

返回**地图** this

# getMinZoom

返回地图的最小允许缩放级别。

# Examples

var minZoom = map.getMinZoom();
1

返回**number**minZoom

# setMaxZoom

设置或清除地图的最大缩放级别。如果地图的当前缩放级别高于新的最大值，则地图将缩放到新的最大值。

# Parameters

  • maxZoom **( number| null | undefined)**要设置的最大缩放级别。如果提供null或undefined，该函数将删除当前最大缩放（将其设置为 22）。

# Examples

map.setMaxZoom(18.75);
1

返回**地图** this

# getMaxZoom

返回地图的最大允许缩放级别。

# Examples

var maxZoom = map.getMaxZoom();
1

返回**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();
1

返回**boolean**renderWorldCopies

# setRenderWorldCopies

设置 的状态renderWorldCopies。

# Parameters

  • renderWorldCopies **boolean**如果true，世界的多个副本将在超过 -180 度和 180 度经度的范围内并排呈现。如果设置为false：- 当地图缩小到足以使世界的单个表示无法填满地图的整个容器时，超过 180 度和 -180 度经度将出现空白。
    • 在每个缩放级别，跨越 180 度和 -180 度经度的要素将被切成两部分（一部分位于地图的右边缘，另一部分位于地图的左边缘）。undefined被视为true，null被视为false。

# Examples

map.setRenderWorldCopies(true);
1

返回**地图** this

# project

返回一个Point表示像素坐标，相对于地图的container，对应于指定的地理位置。

当地图倾斜并lnglat完全在相机后面时，没有对应于该位置的像素坐标。在这种情况下，返回的Point][165]的x和y组件设置为 Number.MAX\_VALUE。[

# Parameters

  • lnglat **LngLatLike 要投影**的地理位置。

# Examples

var coordinate = [-122.420679, 37.772537];
var point = map.project(coordinate);
1
2

返回**Point**对应于的点``lnglat，相对于地图的container。

# unproject

返回表示与指定像素坐标对应的地理坐标的LngLat。如果地平线可见，并且指定像素高于地平线，则返回与地平线上的点相对应的LngLat，距离该点最近。

# Parameters

  • point **PointLike 要取消投影**的像素坐标。

# Examples

map.on('click', function(e) {
  // When the map is clicked, get the geographic coordinate.
  var coordinate = map.unproject(e.point);
});
1
2
3
4

返回**LngLat**对应的LngLatpoint。

# isMoving

如果地图由于相机动画或用户手势而平移、缩放、旋转或俯仰，则返回 true。

# Examples

var isMoving = map.isMoving();
1

**boolean**如果地图正在移动，则返回True。

# isZooming

如果地图由于相机动画或用户手势而缩放，则返回 true。

# Examples

var isZooming = map.isZooming();
1

**boolean**如果地图正在缩放，则返回True。

# isRotating

如果地图由于相机动画或用户手势而旋转，则返回 true。

# Examples

map.isRotating();
1

**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
    }
  });
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// 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);
});
1
2
3
4
5
6
7
8

返回**地图** 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)
});
1
2
3
4
// 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)
});
1
2
3
4
5

返回**地图** 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);
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14

返回**地图** this

# queryRenderedFeatures

返回一个GeoJSON数组 `` 特征对象 表示满足查询参数的可见特征。

# Parameters

  • geometry **( PointLike | Array< PointLike >)？**以像素为单位的查询区域的几何形状：描述边界框的单个点或左下角和右上角的点，其中原点位于左上角。省略此参数（即使用零参数或仅使用参数调用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'] }
);
1
2
3
4
5
// Find all features within a static bounding box
var features = map.queryRenderedFeatures(
  [[10, 20], [30, 50]],
  { layers: ['my-layer-name'] }
);
1
2
3
4
5
// 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'] });
1
2
3
4
5
6
7
// Query all rendered features from a single layer
var features = map.queryRenderedFeatures({ layers: ['my-layer-name'] });
1
2

返回**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'
});
1
2
3
4

返回**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");
1

返回**地图** this

# getStyle

返回地图的 样式 对象，一个 JSON 对象，可用于重新创建地图的样式。

# Examples

map.on('load', function() {
  var styleJson = map.getStyle();
});
1
2
3

返回**Object**地图的样式 JSON 对象。

# isStyleLoaded

返回一个布尔值，指示地图的样式是否已完全加载。

# Examples

var styleLoadStatus = map.isStyleLoaded();
1

返回**boolean**一个布尔值，指示样式是否已完全加载。

# addSource

将源添加到地图的样式。

# Parameters

  • id **string**要添加的源的 ID。不得与现有来源发生冲突。
  • source **Object**源对象。

# Examples

map.addSource('my-data', {
  type: 'vector',
  url: 'your url'
});
1
2
3
4
map.addSource('my-data', {
  "type": "geojson",
  "data": {
    "type": "Feature",
    "geometry": {
      "type": "Point",
      "coordinates": [-77.0323, 38.9131]
    },
    "properties": {
      "title": "DC",
      "marker-symbol": "monument"
    }
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14

返回**地图** this

# isSourceLoaded

返回一个布尔值，指示源是否已加载。返回true如果在地图的风格给定ID的源没有未完成的的网络请求，否则false。

# Parameters

  • id string 要检查的源的 ID。

# Examples

var sourceLoaded = map.isSourceLoaded('bathymetry-data');
1

返回**boolean**一个布尔值，指示源是否已加载。

# areTilesLoaded

返回一个布尔值，指示是否加载了来自样式上所有源的视口中的所有图块。

# Examples

var tilesLoaded = map.areTilesLoaded();
1

返回**boolean**一个布尔值，指示是否已加载所有图块。

# removeSource

从地图的样式中删除源。

# Parameters

  • id string 要删除的源的 ID。

# Examples

map.removeSource('bathymetry-data');
1

返回**地图** this

# getSource

返回具有地图样式中指定 ID 的源。

此方法通常用于使用Sources 中定义的相关源类型的实例成员更新源。例如，data为 GeoJSON 源设置或更新 图像源的url和coordinates。

# Parameters

  • id string 要获取的源的 ID。

# Examples

var sourceObject = map.getSource('points');
1

返回**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，其格式与.heightdataImageData`
  • 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
     });
   }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# updateImage

更新样式中的现有图像。此图像可以像样式精灵中的任何其他图标一样显示在地图上 使用图像的 IDicon-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，其格式与.heightdataImageData`

# 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');
1
2
3

# 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');
1
2
3

返回**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');
1
2
3

# 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);
});
1
2
3
4
5
6

# listImages

返回一个字符串数组，其中包含地图中当前可用的所有图像的 ID。

# Examples

var allImages = map.listImages();
1

返回**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。
  • 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
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// 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']
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 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');
1
2
3
4
5
6
7
8
9
10
11
12
13

返回**地图** 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');
1
2

返回**地图** 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');
1
2

# getLayer

返回地图样式中具有指定 ID 的图层。

# Parameters

  • id string 要获取的图层的 ID。

# Examples

var stateDataLayer = map.getLayer('state-data');
1

返回**Object?** 具有指定 ID 的图层，或者undefined 如果 ID 对应于不存在的图层。

# setLayerZoomRange

设置指定样式图层的缩放范围。缩放范围包括 最小缩放级别 和最大缩放级别 图层将被渲染。

注意：对于使用矢量源的样式图层，样式图层无法以低于_源图层_的最小缩放级别的缩放级别进行渲染，因为这些缩放级别不存在数据。如果源图层的最小缩放级别高于样式图层中定义的最小缩放级别，则不会在缩放范围内的所有缩放级别渲染样式图层。

# Parameters

  • layerId string 将应用缩放范围的图层的 ID。
  • minzoom number 要设置的最小缩放 (0-24)。
  • maxzoom number 要设置的最大缩放 (0-24)。

# Examples

map.setLayerZoomRange('my-layer', 2, 5);
1

返回**地图** 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']);
1
2
// display only features with five or more 'available-spots'
map.setFilter('bike-docks', ['>=', ['get', 'available-spots'], 5]);
1
2
// remove the filter for the 'bike-docks' style layer
map.setFilter('bike-docks', null);
1
2

返回**地图** 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');
1

返回**地图** 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');
1

返回**地图** 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');
1

返回**地图** 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 });
1
2
3
4
5
6
7
8

返回**地图** this

# getTerrain

返回地形规范或null地形未在地图上设置。

返回**Object**地形的地形规范属性。

# setFog

设置样式的雾属性。

# Parameters

  • fog FogSpecification要设置的雾属性。 如果提供null或undefined，则此函数调用将从地图中移除雾。

# Examples

map.setFog({
 "range": [1.0, 12.0],
 "color": 'white',
 "horizon-blend": 0.1
});
1
2
3
4
5

返回**地图** this

# getFog

返回雾规范或null地图上是否未设置雾。

返回**Object**样式的雾雾规范属性。

# queryTerrainElevation

查询当前加载的某个地理位置的高程数据。meters相对于平均海平面返回高程。null如果terrain已禁用或尚未加载该位置的地形数据，则返回。

为了保证加载地形数据，确保地理位置可见，等待idle事件发生。

# Parameters

  • lnglat **LngLatLike**要查询的地理位置。
  • options **海拔查询选项？**选项对象
    • options.exaggerated **boolean**当true返回具有exaggeration来自已应用样式的值的地形高程时。当false，返回未应用样式的基础数据的原始值。（可选，默认true）

# Examples

var coordinate = [-122.420679, 37.772537];
var elevation = map.queryTerrainElevation(coordinate);
1
2

返回**( 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
    });
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13

返回**Map**地图对象。

# 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'
});
1
2
3
4
5
// 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
  });
});
1
2
3
4
5
6
7
8
9
10
// 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');
});
1
2
3
4
5
6
7
8
9
10

# 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
    });
  }
});
1
2
3
4
5
6
7
8
9
10
11

返回**Object**功能状态：在运行时分配给功能的一组键值对。

# getContainer

返回地图的包含 HTML 元素。

返回**HTMLElement**地图的容器。

# getCanvasContainer

返回包含地图&lt;canvas>元素的 HTML元素。

如果要将非叠加层添加到地图，则应将它们附加到此元素。

这是地图交互性（例如平移和缩放）的事件绑定所附加到的元素。它将接收来自子元素（例如 ）的冒泡事件&lt;canvas>，但不会接收来自地图控件的冒泡事件。

返回**HTMLElement**地图的容器&lt;canvas>。

# getCanvas

返回地图的&lt;canvas>元素。

返回**HTMLCanvasElement**地图的&lt;canvas>元素。

# loaded

返回一个布尔值，指示地图是否已完全加载。

返回false如果样式还没有完全加载，或者如果已经更改了源或风格还没有完全加载。

返回**boolean**一个布尔值，指示地图是否已完全加载。

# remove

清理并释放与此地图关联的所有内部资源。

这包括 DOM 元素、事件绑定、Web Worker 和 WebGL 资源。

当您使用完地图并希望确保它不再消耗浏览器资源时，请使用此方法。之后，您不得在地图上调用任何其他方法。

# triggerRepaint

触发单帧渲染。当图层的属性或与图层源关联的属性发生更改时，将此方法与自定义图层一起使用以重新绘制地图。在渲染下一帧之前多次调用它仍然会导致只渲染一个帧。

# Examples

map.triggerRepaint();
1

# showTileBoundaries

获取和设置一个布尔值，指示地图是否将围绕每个图块和图块 ID 呈现轮廓。这些图块边界对于调试很有用。

第一个矢量源的未压缩文件大小绘制在每个图块的左上角，在图块 ID 旁边。

类型： boolean

# Examples

map.showTileBoundaries = true;
1

# showTerrainWireframe

获取并设置一个布尔值，指示地图是否将在显示的地形顶部呈现线框。用于调试。

线框始终为红色，仅在地形处于活动状态时绘制。

类型： boolean

# Examples

map.showTerrainWireframe = true;
1

# 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();
1
2
3
4

返回**LngLat**地图的地理中心点。

# setCenter

设置地图的地理中心点。相当于jumpTo({center: center})。

# Parameters

  • center **LngLatLike**要设置的中心点。
  • eventData Object? 要添加到此方法触发的事件的事件对象的附加属性。

# Examples

map.setCenter([-74, 38]);
1

返回**地图** this

# panBy

按指定的偏移量平移地图。

# Parameters

  • offset PointLike x和y平移地图所**依据的**坐标。
  • options **动画选项？**选项对象。
  • eventData Object? 要添加到此方法触发的事件的事件对象的附加属性。

返回**地图** this

# panTo

使用动画过渡将地图平移到指定位置。

# Parameters

  • lnglat **LngLatLike 要将地图平移到**的位置。
  • options **动画选项？**描述过渡目标和动画的选项。
  • eventData Object? 要添加到此方法触发的事件的事件对象的附加属性。

# Examples

map.panTo([-74, 38]);
1
// Specify that the panTo animation should last 5000 milliseconds.
map.panTo([-74, 38], {duration: 5000});
1
2

返回**地图** this

# getZoom

返回地图的当前缩放级别。

# Examples

map.getZoom();
1

返回**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);
1
2

返回**地图** 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]
});
1
2
3
4
5
6
7

返回**地图** this

# zoomIn

将地图的缩放级别增加 1。

# Parameters

  • options **动画选项？**选项对象。
  • eventData Object? 要添加到此方法触发的事件的事件对象的附加属性。

# Examples

// zoom the map in one level with a custom animation duration
map.zoomIn({duration: 1000});
1
2

返回**地图** this

# zoomOut

将地图的缩放级别降低 1。

# Parameters

  • options **动画选项？**选项对象。
  • eventData Object? 要添加到此方法触发的事件的事件对象的附加属性。

# Examples

// zoom the map out one level with a custom animation offset
map.zoomOut({offset: [80, 60]});
1
2

返回**地图** this

# getBearing

返回地图的当前方位。方位是“向上”的罗盘方向；例如，90° 的方位角使地图定向，使东面朝上。

返回**number**地图的当前方位。

# setBearing

设置地图的方位（旋转）。方位是“向上”的罗盘方向；例如，90° 的方位角使地图定向，使东面朝上。

相当于jumpTo({bearing: bearing})。

# Parameters

  • bearing number 所需的轴承。
  • eventData Object? 要添加到此方法触发的事件的事件对象的附加属性。

# Examples

// rotate the map to 90 degrees
map.setBearing(90);
1
2

返回**地图** this

# getPadding

返回在地图视口周围应用的当前填充。

返回**PaddingOptions**地图视口周围的当前填充。

# setPadding

设置视口周围的填充（以像素为单位）。

相当于jumpTo({padding: padding})。

# Parameters

  • padding **PaddingOptions**所需的填充。格式：{左：数字，右：数字，上：数字，下：数字}
  • eventData Object? 要添加到此方法触发的事件的事件对象的附加属性。

# Examples

// Sets a left padding of 300px, and a top padding of 50px
map.setPadding({ left: 300, top: 50 });
1
2

返回**地图** 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**计算视口中这些边界的中心，并使用最高缩放级别，包括Map#getMaxZoom()适合视口的缩放级别。LngLatBounds 表示一个始终与轴承 0 轴对齐的框。
  • options **相机选项？**选项对象。
    • options.padding **( number| PaddingOptions )？**添加到给定边界的填充量（以像素为单位）。
    • options.bearing **number**动画结束时所需的地图方位，以度为单位。（可选，默认0）
    • options.offset **PointLike**相对于地图中心的给定边界的中心，以像素为单位。（可选，默认[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}
});
1
2
3
4

返回**（CameraOptions |无效）**如果地图能够适合提供的界限，收益CameraOptions有 center，zoom和bearing。如果地图无法适应，方法将发出警告并返回未定义。

# fitBounds

平移和缩放地图以将其可见区域包含在指定的地理边界内。如果方位角非零，此函数还会将地图的方位角重置为 0。如果在地图上设置了填充，则边界适合插图。

# Parameters

  • bounds **LngLatBoundsLike**在视口中居中这些边界，并使用最高缩放级别，包括Map#getMaxZoom()适合它们在视口中的缩放级别。
  • options Object? 除了以下字段之外，Options 还支持AnimationOptions和CameraOptions中的所有属性。
    • options.padding **( number| PaddingOptions )？**添加到给定边界的填充量（以像素为单位）。
    • options.linear **boolean**如果true，则地图使用 Map#easeTo 进行转换。如果false，则地图使用Map#flyTo 进行转换。有关可用选项的信息，请参阅这些函数和AnimationOptions。（可选，默认false）
    • options.easing **功能？**动画过渡的缓动函数。请参阅动画选项。
    • options.offset **PointLike**相对于地图中心的给定边界的中心，以像素为单位。（可选，默认[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}
});
1
2
3
4

返回**地图** this

# fitScreenCoordinates

一旦地图旋转到指定的方位，平移、旋转和缩放地图以适应由点 p0 和 p1 构成的框。要缩放而不旋转，请传入当前地图方位。

# Parameters

  • p0 **PointLike**屏幕上的第一个点，以像素坐标表示
  • p1 **PointLike**屏幕上的第二个点，以像素坐标表示
  • bearing **number**动画结束时所需的地图方位，以度为单位。如果贴图具有非零间距，则忽略此值。
  • options **任何？**选项对象。
    • options.padding **( number| PaddingOptions )？**添加到给定边界的填充量（以像素为单位）。
    • options.linear **boolean**如果true，则地图使用 Map#easeTo 进行转换。如果false，则地图使用Map#flyTo 进行转换。有关可用选项的信息，请参阅这些函数和AnimationOptions。（可选，默认false）
    • options.easing **功能？**动画过渡的缓动函数。请参阅动画选项。
    • options.offset **PointLike**相对于地图中心的给定边界的中心，以像素为单位。（可选，默认[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}
});
1
2
3
4
5

返回**地图** this

# jumpTo

更改中心、缩放、方位和俯仰的任意组合，无需动画过渡。对于 中未指定的任何详细信息，地图将保留其当前值options。

# Parameters

  • options **CameraOptions**选项对象。
  • 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
});
1
2
3
4
5
6
7
8
9

返回**地图** this

# getFreeCameraOptions

返回相机实体的位置和方向。

返回**FreeCameraOptions**相机状态

# setFreeCameraOptions

FreeCameraOptions提供对底层相机实体的更直接访问。为了向后兼容，使用此 API 的状态集也必须是可表示的 CameraOptions。如果向俯仰和方位表示的转换不明确，参数将被限制在有效范围内或作为无效丢弃。例如，如果导致相机颠倒、四元数长度为零或间距超过最大间距限制，则方向可能无效。

# Parameters

  • options FreeCameraOptions FreeCameraOptions对象
  • eventData Object? 要添加到此方法触发的事件的事件对象的附加属性。

返回**地图** this

# easeTo

更改的任意组合center，zoom，bearing，pitch，并padding与新老值之间动画转换。对于 中未指定的任何详细信息，地图将保留其当前值options。

注意：如果用户reduced motion在其操作系统中启用了辅助功能，则转换将立即发生，除非options包含essential: true.

# Parameters

  • options 任何描述过渡目标和动画的选项。接受CameraOptions和AnimationOptions。
  • eventData Object? 要添加到此方法触发的事件的事件对象的附加属性。

返回**地图** this

# flyTo

改变中心、缩放、方位和俯仰的任意组合，沿着一条唤起飞行的曲线动画过渡。动画无缝地结合了缩放和平移，以帮助用户即使在穿越很远的距离后也能保持她的方位。

注意：动画将被跳过，这将jumpTo 与用户reduced motion在其操作系统中启用辅助功能时的行为等效，除非 'options' 包含essential: true.

# Parameters

  • options **Object**描述过渡目标和动画的选项。接受CameraOptions、AnimationOptions和以下附加选项。
    • 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;
  }
});
1
2
3
4
5
6
7
8
9
10
11
12

返回**地图** 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
// 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.');
});
1
2
3
4
5
6

# 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.');
});
1
2
3
4
5
6
// 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.');
});
1
2
3
4
5
6

# 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.');
});
1
2
3
4
5
6
// 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.');
});
1
2
3
4
5
6

# 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.');
});
1
2
3
4
5
6
// 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.');
});
1
2
3
4
5
6

# 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);
});
1
2
3
4
5
6
// 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);
});
1
2
3
4
5
6

# 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);
});
1
2
3
4
5
6
// 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);
});
1
2
3
4
5
6

# 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.');
});
1
2
3
4
5
6

# 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.');
});
1
2
3
4
5
6
7
8

# 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.');
});
1
2
3
4
5
6
7
8

# 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.');
});
1
2
3
4
5
6
7
8

# 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.');
});
1
2
3
4
5
6
7

# touchstart

当一个 touchstart 事件发生在地图内。

# Properties

  • data MapTouchEvent // 初始化地图 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7
8

# move

作为用户交互或Map#flyTo等方法的结果，在从一个视图到另一个视图的动画过渡期间重复触发。

# Properties

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# dragstart

当“拖动平移”交互开始时触发。请参阅DragPanHandler。

# 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.');
});
1
2
3
4
5
6
7

# drag

在“拖动平移”交互期间反复触发。请参阅DragPanHandler。

# Properties

# 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.');
});
1
2
3
4
5
6
7

# dragend

当“拖动平移”交互结束时触发。请参阅DragPanHandler。

# 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.');
});
1
2
3
4
5
6
7

# zoomstart

作为用户交互或Map#flyTo等方法的结果，在地图开始从一个缩放级别过渡到另一个缩放级别之前触发。

# Properties

# 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.');
});
1
2
3
4
5
6
7

# zoom

作为用户交互或Map#flyTo等方法的结果，在从一个缩放级别到另一个缩放级别的动画过渡期间重复触发。

# Properties

# 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.');
});
1
2
3
4
5
6
7

# zoomend

作为用户交互或Map#flyTo等方法的结果，在地图完成从一个缩放级别到另一个缩放级别的转换后立即触发。缩放过渡通常会在渲染完成之前结束，因此如果您需要等待渲染完成，请改用Map#idle事件。

# Properties

# 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.');
});
1
2
3
4
5
6
7

# rotatestart

当“拖动旋转”交互开始时触发。请参阅DragRotateHandler。

# Properties

# 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.');
});
1
2
3
4
5
6
7

# rotate

在“拖动以旋转”交互期间反复触发。请参阅DragRotateHandler。

# Properties

# 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.');
});
1
2
3
4
5
6
7

# rotateend

当“拖动旋转”交互结束时触发。请参阅DragRotateHandler。

# Properties

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# boxzoomstart

当“框缩放”交互开始时触发。请参阅BoxZoomHandler。

# 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.');
});
1
2
3
4
5
6
7

# boxzoomend

当“框缩放”交互结束时触发。请参阅BoxZoomHandler。

类型： 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.');
});
1
2
3
4
5
6
7

# boxzoomcancel

当用户取消“框缩放”交互或边界框不满足最小尺寸阈值时触发。请参阅BoxZoomHandler。

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# 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.');
});
1
2
3
4
5
6
7

# data

当任何地图数据加载或更改时触发。有关 详细信息，请参阅MapDataEvent。

# 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.');
});
1
2
3
4
5
6
7

# styledata

当地图的样式加载或更改时触发。有关详细信息，请参阅 MapDataEvent。

# 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.');
});
1
2
3
4
5
6
7

# sourcedata

当地图源之一加载或更改时触发，包括属于源的图块加载或更改。有关详细信息，请参阅MapDataEvent。

# 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.');
});
1
2
3
4
5
6
7

# dataloading

当任何地图数据（样式、源、图块等）开始异步加载或更改时触发。所有dataloading事件后跟一个data 或error事件。有关详细信息，请参阅MapDataEvent。

# 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.');
});
1
2
3
4
5
6
7
8

# styledataloading

当地图的样式开始异步加载或更改时触发。所有styledataloading事件后跟一个styledata 或error事件。有关详细信息，请参阅MapDataEvent。

# 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.');
});
1
2
3
4
5
6
7
8

# sourcedataloading

当地图的源之一开始异步加载或更改时触发。所有sourcedataloading事件后跟一个sourcedata或error事件。有关详细信息，请参阅MapDataEvent。

# 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.');
});
1
2
3
4
5
6
7
8

# 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.');
});
1
2
3
4
5
6
7

# 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;
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

# 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);
1

# 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
1
2

# 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点的墨**卡托坐标。
  • 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**左上角原点坐标系中以像素为单位的屏幕点。

返回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();
1

# disable

禁用“框缩放”交互。

# Examples

map.boxZoom.disable();
1

# TouchPitchHandler

扩展 TwoTouchHandler

在TouchPitchHandler由地图拖动向上和向下两个手指，用户可以间距。

# isEnabled

返回一个布尔值，指示是否启用了“拖动到音高”交互。

如果启用了“拖动到音高”交互，则返回。boolean true

# isActive

返回一个布尔值，指示“拖动到音高”交互是否处于活动状态，即当前正在使用。

返回如果“拖动间距”互动是有效的。boolean true

# enable

启用“拖动到音高”交互。

# Examples

map.touchPitch.enable();
1

# disable

禁用“拖动到音高”交互。

# Examples

map.touchPitch.disable();
1

# KeyboardHandler

将KeyboardHandler允许用户放大，缩小，旋转，并使用以下键盘快捷键平移地图：

  • =/ +：将缩放级别增加 1。
  • Shift-=/ Shift-+：将缩放级别增加 2。
  • -：将缩放级别降低 1。
  • Shift--：将缩放级别降低 2。
  • 箭头键：平移 100 像素。
  • Shift+⇢：将旋转增加 15 度。
  • Shift+⇠：将旋转减少 15 度。
  • Shift+⇡：将音高增加 10 度。
  • Shift+⇣：将音高降低 10 度。

# enable

启用“键盘旋转和缩放”交互。

# Examples

map.keyboard.enable();
1

# disable

禁用“键盘旋转和缩放”交互。

# Examples

map.keyboard.disable();
1

# isEnabled

返回一个布尔值，指示是否启用“键盘旋转和缩放”交互。

返回是否启用了“键盘旋转和缩放”交互。boolean true

# isActive

如果处理程序已启用并检测到缩放/旋转手势的开始，则返回 true。

返回处理程序是否已启用并已检测到缩放/旋转手势的开始。boolean true

# disableRotation

禁用“键盘平移/旋转”交互，启用“键盘缩放”交互。

# Examples

map.keyboard.disableRotation();
1

# enableRotation

启用“键盘平移/旋转”交互。

# Examples

map.keyboard.enable();
  map.keyboard.enableRotation();
1
2

# ScrollZoomHandler

将ScrollZoomHandler允许用户通过滚动缩放地图。

# Parameters

  • map 地图
  • handler 处理程序管理器

# setZoomRate

设置触控板的缩放率。

# Parameters

  • zoomRate **number**用于将触控板移动缩放到缩放值的速率。（可选，默认1/100）

# Examples

// Speed up trackpad zoom
map.scrollZoom.setZoomRate(1/25);
1
2

# setWheelZoomRate

设置鼠标滚轮的缩放率。

# Parameters

  • wheelZoomRate **number**用于将鼠标滚轮移动缩放到缩放值的速率。（可选，默认1/450）

# Examples

// Slow down zoom of mouse wheel
map.scrollZoom.setWheelZoomRate(1/600);
1
2

# isEnabled

返回一个布尔值，指示是否启用了“滚动缩放”交互。

如果启用了“滚动缩放”交互，则返回。boolean true

# enable

启用“滚动缩放”交互。

# Parameters

  • options Object? 选项对象。
    • options.around string? 如果传递“center”，地图将围绕地图中心缩放

# Examples

map.scrollZoom.enable();
1
map.scrollZoom.enable({ around: 'center' })
1

# disable

禁用“滚动缩放”交互。

# Examples

map.scrollZoom.disable();
1

# DoubleClickZoomHandler

将DoubleClickZoomHandler允许用户在通过双击或双攻一个点缩放地图。

# Parameters

  • clickZoom 单击缩放处理程序
  • TapZoom TapZoomHandler

# enable

启用“双击缩放”交互。

# Examples

map.doubleClickZoom.enable();
1

# disable

禁用“双击缩放”交互。

# Examples

map.doubleClickZoom.disable();
1

# 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();
1
map.dragPan.enable({
     linearity: 0.3,
     easing: bezier(0, 0, 0.3, 1),
     maxSpeed: 1400,
     deceleration: 2500,
  });
1
2
3
4
5
6

# disable

禁用“拖动平移”交互。

# Examples

map.dragPan.disable();
1

# isEnabled

返回一个布尔值，指示是否启用了“拖动平移”交互。

如果启用了“拖动平移”交互，则返回。boolean true

# isActive

返回一个布尔值，指示“拖动平移”交互是否处于活动状态，即当前正在使用。

返回如果“拖动进行平移”互动是有效的。boolean true

# DragRotateHandler

在DragRotateHandler允许用户通过点击并拖动光标按住鼠标右键或向旋转地图ctrl键。

# Parameters

  • options Object?
  • mouseRotate 鼠标旋转处理程序
  • mousePitch 鼠标音调处理程序

# enable

启用“拖动旋转”交互。

# Examples

map.dragRotate.enable();
1

# disable

禁用“拖动旋转”交互。

# Examples

map.dragRotate.disable();
1

# 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();
1
map.touchZoomRotate.enable({ around: 'center' });
1

# disable

禁用“捏合旋转和缩放”交互。

# Examples

map.touchZoomRotate.disable();
1

# isEnabled

返回一个布尔值，指示是否启用了“捏合旋转和缩放”交互。

返回如果“掐去旋转和缩放”启用互动。boolean true

# isActive

如果处理程序已启用并检测到缩放/旋转手势的开始，则返回 true。

返回 boolean

# disableRotation

禁用“捏合旋转”交互，启用“捏合缩放”交互。

# Examples

map.touchZoomRotate.disableRotation();
1

# enableRotation

启用“捏合旋转”交互。

# Examples

map.touchZoomRotate.enable();
  map.touchZoomRotate.enableRotation();
1
2

# CameraOptions

常见的选项地图＃jumpTo，地图＃easeTo和地图＃一个FlyTo，控制摄像机的所需位置，缩放，轴承，和俯仰。所有属性都是可选的，当省略某个属性时，该属性的当前相机值将保持不变。

类型： Object

# Properties

  • center **LngLatLike**所需的中心。
  • zoom number 所需的缩放级别。
  • bearing **number**以度为单位的所需方位。方位是“向上”的罗盘方向。例如，bearing: 90调整地图的方向，使东方朝上。
  • pitch **number**所需的度数。俯仰角是与地平线的角度，以度为单位，范围在 0 到 60 度之间。例如，pitch: 0 提供了直视地图的外观，而 pitch: 60 使用户的视角向地平线倾斜。增加间距值通常用于显示 3D 对象。
  • around **LngLatLike**如果zoom指定，则around确定缩放的中心点。
  • padding **PaddingOptions**应用在视口每一侧以移动消失点的尺寸（以像素为单位）。

# 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
});
1
2
3
4
5
6
7
8
9

# AnimationOptions

涉及动画的地图移动方法常见的选项，例如Map#panBy和 Map#easeTo，控制动画的持续时间和缓动功能。所有属性都是可选的。

类型： Object

# Properties

  • duration number 动画的持续时间，以毫秒为单位。
  • easing 函数一个函数在 0..1 范围内花费时间并返回一个数字，其中 0 是初始状态，1 是最终状态。
  • offset 动画结束时目标中心相对于真实地图容器中心的**PointLike**。
  • 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}
});
1
2
3
4
var bbox = [[-79, 43], [-73, 45]];
map.fitBounds(bbox, {
  padding: 20
});
1
2
3
4

一个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');
1
2

# 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选项对象，当地图被平移和缩放到用户的位置时使用。默认值是使用maxZoom15 来限制地图为非常准确的位置放大的距离。（可选，默认{maxZoom:15}）
    • options.trackUserLocation **Object**如果trueGeolocate 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
}));
1
2
3
4
5
6

# 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();
});
1
2
3
4
5
6
7
8
9
10
11
12

返回**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.')
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 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.')
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 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.')
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 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.')
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 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.')
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 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'
    }));
1
2
3
4

# 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');
1
2
3
4
5
6
7

# 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')}));
1

扩展事件

一个弹出组件。

# 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 | Object)？ 应用于弹出窗口位置的像素偏移指定为：- 指定与弹出窗口位置距离的单个数字
      • 指定常量偏移量的PointLike
      • Point 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("&lt;h1>Hello World!&lt;/h1>")
  .setMaxWidth("300px")
  .addTo(map);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# addTo

将弹出窗口添加到地图。

# Parameters

  • map **Map**要添加弹出窗口的地图。

# Examples

new vjmap.Popup()
  .setLngLat([0, 0])
  .setHTML("&lt;h1>Null Island&lt;/h1>")
  .addTo(map);
1
2
3
4

返回**弹出窗口** this

# isOpen

如果弹出窗口是打开的，如果它是关闭的，则返回。boolean true``false

# remove

从已添加到的地图中删除弹出窗口。

# Examples

var popup = new vjmap.Popup().addTo(map);
popup.remove();
1
2

返回**弹出窗口** this

# getLngLat

返回弹出窗口锚点的地理位置。

结果的经度可能与先前设置的经度相差 360 度的倍数，setLngLat因为Popup将锚定经度包装在世界的副本上以保持弹出窗口在屏幕上。

返回**LngLat**弹出窗口锚点的地理位置。

# setLngLat

设置弹出窗口锚点的地理位置，并将弹出窗口移动到它。替换 trackPointer() 行为。

# Parameters

  • lnglat **LngLatLike**设置为弹出窗口锚点的地理位置。

返回**弹出窗口** this

# trackPointer

使用指针设备将弹出锚点跟踪到屏幕上的光标位置（它将在触摸屏上隐藏）。替换setLngLat行为。对于大多数用例，将closeOnClick和设置closeButton为false。

# Examples

var popup = new vjmap.Popup({ closeOnClick: false, closeButton: false })
  .setHTML("&lt;h1>Hello World!&lt;/h1>")
  .trackPointer()
  .addTo(map);
1
2
3
4

返回**弹出窗口** this

# getElement

返回Popup的 HTML 元素。

# Examples

// Change the `Popup` element's font size
var popup = new vjmap.Popup()
  .setLngLat([-96, 37.8])
  .setHTML("&lt;p>Hello World!&lt;/p>")
  .addTo(map);
var popupElem = popup.getElement();
popupElem.style.fontSize = "25px";
1
2
3
4
5
6
7

返回**HTMLElement**元素

# setText

将弹出窗口的内容设置为一串文本。

此函数创建一个文本DOM 中的节点，因此它无法插入原始 HTML。如果弹出内容是用户提供的，请使用此方法来防止 XSS。

# Parameters

  • text string 弹出窗口的文本内容。

# Examples

var popup = new vjmap.Popup()
  .setLngLat(e.lngLat)
  .setText('Hello, world!')
  .addTo(map);
1
2
3
4

返回**弹出窗口** this

# setHTML

将弹出窗口的内容设置为作为字符串提供的 HTML。

此方法不执行 HTML 过滤或清理，并且必须仅用于受信任的内容。如果内容是不受信任的文本字符串，请考虑Popup#setText。

# Parameters

  • html string 表示弹出窗口的 HTML 内容的字符串。

# Examples

var popup = new vjmap.Popup()
  .setLngLat(e.lngLat)
  .setHTML("&lt;h1>Hello World!&lt;/h1>")
  .addTo(map);
1
2
3
4

返回**弹出窗口** 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);
1
2
3
4
5
6
7

返回**弹出窗口** this

# addClassName

将 CSS 类添加到弹出式容器元素。

# Parameters

  • className string 要添加到弹出式容器的具有 CSS 类名的非空字符串

# Examples

let popup = new vjmap.Popup()
popup.addClassName('some-class')
1
2

# removeClassName

从弹出式容器元素中删除 CSS 类。

# Parameters

  • className string 要从弹出式容器中删除的具有 CSS 类名的非空字符串

# Examples

let popup = new vjmap.Popup()
popup.removeClassName('some-class')
1
2

# setOffset

设置弹出窗口的偏移量。

# Parameters

  • offset **抵消？**设置弹出窗口的偏移量。

返回**弹出窗口** this

# toggleClassName

在弹出容器上添加或删除给定的 CSS 类，具体取决于容器当前是否具有该类。

# Parameters

  • className string 要添加/删除的带有 CSS 类名的非空字符串

# Examples

let popup = new vjmap.Popup()
popup.toggleClassName('toggleClass')
1
2

返回**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');
});
1
2
3
4
5
6
7

# 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');
});
1
2
3
4
5
6
7

# MapMouseEvent

扩展对象

MapMouseEvent是其他类使用的类，用于生成特定类型的鼠标事件，例如“单击”或“悬停”。有关可用事件的完整列表，请参阅``Mapevents。

# 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"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# type

始发事件的类型。有关可用事件的完整列表，请参阅``Mapevents。

类型：（"mousedown"| "mouseup"| "click"| "dblclick"| "mousemove"| "mouseover"| "mouseenter"| "mouseleave"| "mouseout"| "contextmenu"）

# target

Map触发事件的对象。

类型：地图

# originalEvent

引发地图事件的 DOM 事件。

类型：鼠标事件

# point

鼠标光标的像素坐标，相对于地图并从左上角开始测量。

类型：点

# LngLat

鼠标光标在地图上的地理位置。

类型：LngLat

# preventDefault

阻止地图对事件的后续默认处理。

调用此方法将阻止以下默认地图行为：

  • 在mousedown事件上，DragPanHandler][191]的行为[
  • 在mousedown事件上，DragRotateHandler][192]的行为[
  • 在mousedown事件上，BoxZoomHandler][178]的行为[
  • 在dblclick事件上，DoubleClickZoomHandler][190]的行为[

# MapTouchEvent

扩展对象

MapTouchEvent是其他类用来生成特定类型的鼠标事件的类，例如“touchstart”或“touchend”。有关可用事件的完整列表，请参阅``Mapevents。

# 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"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# type

始发事件的类型。有关可用事件的完整列表，请参阅``Mapevents。

类型：( "touchstart"| "touchend"| "touchcancel")

# target

Map触发事件的对象。

类型：地图

# originalEvent

引发地图事件的 DOM 事件。

类型：触摸事件

# LngLat

地图上触摸事件点中心的地理位置。

类型：LngLat

# point

触摸事件点中心的像素坐标，相对于地图，从左上角开始测量。

类型：点

# points

对应于触摸事件的像素坐标数组 touches 财产。

类型：Array<点>

# lngLats

地图上对应于触摸事件的地理位置 touches 财产。

类型：Array< LngLat >

# preventDefault

阻止地图对事件的后续默认处理。

调用此方法将阻止以下默认地图行为：

  • 在touchstart事件上，DragPanHandler][191]的行为[
  • 在touchstart事件上，TouchZoomRotateHandler][193]的行为[

# MapWheelEvent

扩展对象

MapWheelEvent是其他类用来生成特定类型的鼠标事件（例如“轮”）的类。有关可用事件的完整列表，请参阅``Mapevents。

# Parameters

  • type string
  • map 地图
  • originalEvent 轮事件

# Examples

// Example of a MapWheelEvent of type "wheel"
{
  originalEvent: WheelEvent {...},
	 target: Map {...},
	 type: "wheel"
}
1
2
3
4
5
6

# type

始发事件的类型。有关可用事件的完整列表，请参阅``Mapevents。

类型： "wheel"

# target

Map触发事件的对象。

类型：地图

# originalEvent

引发地图事件的 DOM 事件。

类型：WheelEvent

# preventDefault

阻止地图对事件的后续默认处理。

调用此方法将阻止ScrollZoomHandler的行为。

# ZoomEvent

ZoomEvent是其他类用来生成特定类型的鼠标事件的类，例如“boxzoomstart”或“boxzoomend”。有关可用事件的完整列表，请参阅``Mapevents。

类型： Object

# Properties

  • originalEvent **鼠标事件**触发 boxzoom 事件的 DOM 事件。可以是一个MouseEvent或KeyboardEvent
  • type **string**始发事件的类型。有关可用事件的完整列表，请参阅``Mapevents。
  • target MapMap触发事件的实例

# Examples

// Example of a BoxZoomEvent of type "boxzoomstart"
{
  originalEvent: {...},
  type: "boxzoomstart",
  target: {...}
}
1
2
3
4
5
6

# MapDataEvent

MapDataEvent是其他类用来生成特定类型的鼠标事件的类，例如“sourcedata”或“dataloading”。有关可用事件的完整列表，请参阅``Mapevents。

类型： Object

# Properties

  • type **string**始发事件的类型。有关可用事件的完整列表，请参阅``Mapevents。
  • dataType **string**已更改的数据类型。一个'source'或'style'，其中'source'是指与任何源相关联的数据，以及'style'指的是整个的风格 被地图使用。
  • isSourceLoaded boolean? 如果事件有一个dataType，source并且源没有未完成的网络请求，则为真。
  • source Object? 源的样式规范表示如果事件有一个dataType的source。
  • sourceDataType string? 如果事件具有dataTypeofsource并且事件表示内部数据已被接收或更改，则包括在内。可能的值为metadata、content和visibility。
  • tile Object? 正在加载或更改的图块，如果事件具有dataTypeofsource并且该事件与图块的加载相关。
  • 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"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 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对象相对于元素的中心。负数表示向左和向上。
    • 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);
1
2
3
// Set options
var marker = new vjmap.Marker({
    color: "#FFFFFF",
    draggable: true
  }).setLngLat([30.5, 50.5])
  .addTo(map);
1
2
3
4
5
6

# addTo

将 附加Marker到Map对象。

# Parameters

  • map **Map**要添加标记的地图。

# Examples

var marker = new vjmap.Marker()
  .setLngLat([30.5, 50.5])
  .addTo(map); // add the marker to the map
1
2
3

返回**标记** this

# remove

从地图上移除标记

# Examples

var marker = new vjmap.Marker().addTo(map);
marker.remove();
1
2

返回**标记** 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 )
1
2
3
4

返回**LngLat**一个LngLat描述标记的位置。

# setLngLat

设置标记的地理位置并移动它。

# Parameters

# 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);
1
2
3
4

返回**标记** this

# getElement

返回Marker的 HTML 元素。

返回**HTMLElement**元素

# setPopup

将Popup绑定到Marker。

# Parameters

  • popup 弹出窗口？Popup类的一个实例。如果未定义或为空，则在此Marker实例上设置的任何弹出窗口都未设置。

# Examples

var marker = new vjmap.Marker()
 .setLngLat([0, 0])
 .setPopup(new vjmap.Popup().setHTML("&lt;h1>Hello World!&lt;/h1>")) // add popup
 .addTo(map);
1
2
3
4

返回**标记** this

# getPopup

返回绑定到Marker][238]的[Popup][208]实例。[

# Examples

var marker = new vjmap.Marker()
 .setLngLat([0, 0])
 .setPopup(new vjmap.Popup().setHTML("&lt;h1>Hello World!&lt;/h1>"))
 .addTo(map);

console.log(marker.getPopup()); // return the popup instance
1
2
3
4
5
6

返回**弹出**窗口

# togglePopup

打开或关闭弹出绑定到该实例标记，这取决于当前的状态弹出。

# Examples

var marker = new vjmap.Marker()
 .setLngLat([0, 0])
 .setPopup(new vjmap.Popup().setHTML("&lt;h1>Hello World!&lt;/h1>"))
 .addTo(map);

marker.togglePopup(); // toggle popup open or closed
1
2
3
4
5
6

返回**标记** this

# getOffset

获取标记的偏移量。

返回**Point**标记的屏幕坐标（以像素为单位）。

# setOffset

设置标记的偏移量

# Parameters

  • offset **PointLike**作为要应用的PointLike对象相对于元素中心的偏移量（以像素为单位）。负数表示向左和向上。

返回**标记** 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 &lt; this.width; x++) {
                for (var y = 0; y &lt; 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);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# 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
   }
  }
 }
1
2
3
4
5
6
7
8
9
10

# QueryGeometry

表示来自 的屏幕空间查询的数据类Map#queryRenderedFeatures。所有内部几何图形和数据都旨在是不可变的和只读的。它的生命周期仅适用于查询的持续时间和处理查询时地图的固定状态。

# isPointQuery

如果用户的初始查询是单点，则返回 true

**boolean**如果初始查询几何是单个点，则返回True

# bufferedScreenGeometry

由于数据驱动的样式特征不统一大小（例如circle-radius），并且可以与其原始位置不同地偏移（例如， with *-translate）。这意味着我们必须为每个瓦片扩展我们的查询区域以解释这些属性的变化。每个 tile 在解析时计算一个 tile 级别的最大填充值（以屏幕空间像素为单位），这个函数让我们计算每个 tile 的屏幕空间查询几何的缓冲版本。

# Parameters

  • buffer number 以屏幕空间像素为单位的平铺填充。

返回**Array< Point >**缓冲的查询几何。

# 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 >**缓冲的查询几何。

# containsTile

检查此查询几何图形中是否包含图块。

# Parameters

  • tile 平铺要检查的平铺。
  • transform Transform当前地图变换。
  • use3D boolean 指示是否查询 3D 特征的布尔值。

返回**TilespaceQueryGeometry？**如果 tile 不相交，则返回 undefined

# bufferedscreenmercator

这些方法在由Transform#pointCoordinate3d. 图块具有不同的填充值，但是很可能多个图块根据样式共享相同的填充值。在这种情况下，我们希望重用先前计算的地形射线投射的结果。

# Parameters

  • padding number
  • transform 转换

返回**Array<墨卡托坐标>**

# createFromScreenPoints

帮助构建实例同时考虑当前地图状态的工厂方法。

# Parameters

  • geometry **( PointLike | ` [PointLike` , PointLike ])**查询几何。
  • transform Transform当前地图变换。

返回**QueryGeometry** QueryGeometry 类的实例。

# VectorTileSource

扩展事件

包含矢量瓦片格式矢量瓦片的源 ``. （见样式规范 有关选项的详细文档。）

# Parameters

  • id string
  • options 任何
  • dispatcher 调度员
  • eventedParent 事件发生

# Examples

map.addSource('some id', {
    type: 'vector',
    url: 'your url'
});
1
2
3
4
map.addSource('some id', {
    type: 'vector',
    tiles: ['https://xxx/{z}/{x}/{y}.mvt'],
    minzoom: 6,
    maxzoom: 14
});
1
2
3
4
5
6
map.getSource('some id').setUrl("your url");
1
map.getSource('some id').setTiles(['https://xxx/{z}/{x}/{y}.mvt']);
1

# setTiles

设置源tiles属性并重新渲染地图。

# Parameters

  • tiles **Array< string>**一个或多个图块源 URL 的数组，如 TileJSON 规范中所示。

返回**VectorTileSource**这个

# setUrl

设置源url属性并重新渲染地图。

# Parameters

  • url **string**TileJSON 资源的 URL。支持的协议是http:，https:。

返回**VectorTileSource**这个

# 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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# pause

暂停视频。

# play

播放视频。

# getVideo

返回 HTMLvideo元素。

返回**HTMLVideoElement**HTMLvideo元素。

# setCoordinates

设置视频的坐标并重新渲染地图。

返回**VideoSource**这个

# 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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

# updateImage

更新图像 URL 和（可选）坐标。为避免更改后图像闪烁，请将raster-fade-duration光栅图层上的paint属性设置为0。

# Parameters

  • options Object 选项对象。
    • options.url string? 必需的图像 URL。
    • options.coordinates **Array< Array< number>>？**四个地理坐标，表示为经度和纬度数字数组，用于定义图像的角点。坐标从图像的左上角开始，并按顺时针顺序进行。它们不必表示一个矩形。

返回**ImageSource**这个

# setCoordinates

设置图像的坐标并重新渲染地图。

# Parameters

  • coordinates **Array< Array< number>>**四地理坐标，表示为经度和纬度的数字阵列，它定义了图像的角上。坐标从图像的左上角开始，并按顺时针顺序进行。它们不必表示一个矩形。

返回**ImageSource**这个

# CanvasSourceOptions

将画布源类型添加到地图的选项。

类型： Object

# Properties

  • type **string**来源类型。必须是"canvas"。
  • canvas **( string| HTMLCanvasElement)**从中读取像素的画布源。可以是表示画布元素 ID 或HTMLCanvasElement本身的字符串。
  • coordinates **Array< Array< number>>**四个地理坐标表示在何处放置画布的角部，在指定的[longitude, latitude]对。
  • animate boolean? 画布源是否是动画的。如果画布是静态的（即不需要在每一帧上重新读取像素），animate则应设置为false以提高性能。

# CanvasSource

扩展图像源

包含 HTML 画布内容的数据源。有关选项的详细文档，请参阅CanvasSourceOptions。

# 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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# play

启用动画。图像将从画布复制到每一帧的地图。

# pause

禁用动画。地图将显示画布图像的静态副本。

# getCanvas

返回 HTMLcanvas元素。

返回**HTMLCanvasElement**HTMLcanvas元素。

# setCoordinates

设置画布的坐标并重新渲染地图。

# Parameters

  • coordinates **Array< Array< number>>**四地理坐标，表示为经度和纬度的数字阵列，它定义了画布的角上。坐标从画布的左上角开始并按顺时针顺序进行。它们不必表示一个矩形。

返回**CanvasSource**这个

# GeoJSONSource

扩展事件

包含 GeoJSON 的源。（见样式规范有关选项的详细文档。）

# Parameters

  • id string
  • options 任何
  • dispatcher 调度员
  • eventedParent 事件发生

# Examples

map.addSource('some id', {
    type: 'geojson',
    data: 'https://xxx.geojson'
});
1
2
3
4
map.addSource('some id', {
   type: 'geojson',
   data: {
       "type": "FeatureCollection",
       "features": [{
           "type": "Feature",
           "properties": {},
           "geometry": {
               "type": "Point",
               "coordinates": [
                   -76.53063297271729,
                   39.18174077994108
               ]
           }
       }]
   }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
map.getSource('some id').setData({
  "type": "FeatureCollection",
  "features": [{
      "type": "Feature",
      "properties": { "name": "Null Island" },
      "geometry": {
          "type": "Point",
          "coordinates": [ 0, 0 ]
      }
  }]
});
1
2
3
4
5
6
7
8
9
10
11

# setData

设置 GeoJSON 数据并重新渲染地图。

# Parameters

  • data ( Object| string) GeoJSON 数据对象或指向一个的 URL。在大 GeoJSON 文件的情况下，后者更可取。

返回**GeoJSONSource**这个

# getClusterExpansionZoom

对于集群源，获取给定集群扩展的缩放比例。

# Parameters

  • clusterId **number**集群的cluster_id属性值。
  • callback **回调< number>**检索缩放值时要调用的回调 ( (error, zoom) => { ... })。

返回**GeoJSONSource**这个

# getClusterChildren

对于集群源，在下一个缩放级别（作为 GeoJSON 功能数组）获取给定集群的子项。

# Parameters

  • clusterId **number**集群的cluster_id属性值。
  • callback **Callback< Array<GeoJSONFeature>>**检索要素时要调用的回调 ( (error, features) => { ... })。

返回**GeoJSONSource**这个

# 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);
  })
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

返回**GeoJSONSource**这个

# 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());
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

# 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。

# Parameters

  • lng number 经度，以度为单位。
  • lat number 纬度，以度为单位。

# Examples

var ll = new vjmap.LngLat(-123.9749, 40.7736);
ll.lng; // = -123.9749
1
2

# wrap

返回一个新LngLat对象，其经度被包裹到范围 (-180, 180)。

# Examples

var ll = new vjmap.LngLat(286.0251, 40.7736);
var wrapped = ll.wrap();
wrapped.lng; // = -73.9749
1
2
3

返回**LngLat**包装的LngLat对象。

# toArray

返回表示为两个数字数组的坐标。

# Examples

var ll = new vjmap.LngLat(-73.9749, 40.7736);
ll.toArray(); // = [-73.9749, 40.7736]
1
2

返回**Array< number>**坐标表示为经度和纬度数组。

# toString

返回表示为字符串的坐标。

# Examples

var ll = new vjmap.LngLat(-73.9749, 40.7736);
ll.toString(); // = "LngLat(-73.9749, 40.7736)"
1
2

返回**string**值表示为格式字符串的坐标'LngLat(lng, lat)'。

# distanceTo

返回一对坐标之间的近似距离（以米为单位） 使用Haversine 公式（来自 RW Sinnott，“Haversine 的优点”，Sky and Telescope，第 68 卷，第 2 期，1984 年，第 159 页）

# Parameters

  • lngLat 计算距离的**LngLat**坐标

# 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
1
2
3

返回**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]]
1
2

返回**LngLatBounds**一个新LngLatBounds对象，表示由 扩展的坐标radius。

# convert

将包含两个数字的数组或具有lngandlat或lonandlat属性的LngLat对象转换为对象。

如果LngLat传入一个对象，该函数将原样返回它。

# Parameters

  • input **LngLatLike**要转换的两个数字或对象的数组，或LngLat要返回的对象。

# Examples

var arr = [-73.9749, 40.7736];
var ll = vjmap.LngLat.convert(arr);
ll;   // = LngLat {lng: -73.9749, lat: 40.7736}
1
2
3

返回**LngLat**一个新LngLat对象（如果发生转换）或原始LngLat对象。

# LngLatLike

一个LngLat对象，一个表示经度和纬度的两个数字的数组，或者一个具有lngandlat或lonandlat属性的对象。

类型: ( LngLat | {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};
1
2
3

# LngLatBounds

一个LngLatBounds对象代表一个地理边界框，由其西南和东北经纬度点定义。

如果没有为构造函数提供参数，null则会创建一个边界框。

请注意，任何接受LngLatBounds对象作为参数或选项的方法也可以接受Array两个LngLatLike构造中的一个，并将执行隐式转换。这种灵活的类型记录为LngLatBoundsLike。

# Parameters

# 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);
1
2
3

# setNorthEast

设置边界框的东北角

# Parameters

返回**LngLatBounds** this

# setSouthWest

设置边界框的西南角

# Parameters

返回**LngLatBounds** this

# extend

扩展边界以包括给定的 LngLatLike 或 LngLatBoundsLike。

# Parameters

返回**LngLatBounds** 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}
1
2

返回**LngLat**边界框的中心。

# getSouthWest

返回边界框的西南角。

返回**LngLat**边界框的西南角。

# getNorthEast

返回边界框的东北角。

返回**LngLat**边界框的东北角。

# getNorthWest

返回边界框的西北角。

返回**LngLat**边界框的西北角。

# getSouthEast

返回边界框的东南角。

返回**LngLat**边界框的东南角。

# 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]]
1
2

返回**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))"
1
2

返回**string**边界框表示为格式字符串 'LngLatBounds(LngLat(lng, lat), LngLat(lng, lat))'。

# isEmpty

检查边界框是否为空/ null- 类型框。

**boolean**如果边界已定义，则返回True，否则返回false。

# contains

检查点是否在边界框内。

# Parameters

# 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
1
2
3
4
5
6
7
8

**boolean**如果点在边界框内，则返回True。

# convert

将数组转换为LngLatBounds对象。

如果LngLatBounds传入一个对象，该函数将原样返回它。

在内部，该函数调用LngLat#convert将数组转换为LngLat值。

# Parameters

  • input **LngLatBoundsLike**要转换的两个坐标数组，或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}}
1
2
3

返回**LngLatBounds**一个新LngLatBounds对象（如果发生转换）或原始LngLatBounds对象。

# LngLatBoundsLike

甲LngLatBounds对象，的阵列LngLatLike在[SW，NE]顺序，或数字的在[西，南，东，北]为了对象的数组。

类型：( LngLatBounds | ` [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]];
1
2
3
4
5
6

# 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);
1

# toLngLat

返回LngLat坐标的 。

# Examples

var coord = new vjmap.MercatorCoordinate(0.5, 0.5, 0);
var lngLat = coord.toLngLat(); // LngLat(0, 0)
1
2

返回**LngLat**的LngLat对象。

# toAltitude

返回以米为单位的坐标高度。

# Examples

var coord = new vjmap.MercatorCoordinate(0, 0, 0.02);
coord.toAltitude(); // 6914.281956295339
1
2

返回**number**以米为单位的海拔高度。

# meterInMercatorCoordinateUnits

返回MercatorCoordinate以该纬度为单位的 1 米的距离。

对于使用米的真实世界单位坐标，这自然提供了转换为MercatorCoordinates的比例。

**number**以MercatorCoordinate单位返回1 米的距离。

# fromLngLat

LngLat将 a投影到 a MercatorCoordinate。

# Parameters

  • lngLatLike **LngLatLike**要投影的位置。
  • altitude **number**位置的高度（以米为单位）。（可选，默认0）

# Examples

var coord = vjmap.MercatorCoordinate.fromLngLat({ lng: 0, lat: 0}, 0);
coord; // MercatorCoordinate(0.5, 0.5, 0)
1
2

返回**MercatorCoordinate**投影的墨卡托坐标。

# 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 >**扩展环。

# FreeCameraOptions

用于访问底层相机实体的物理属性的选项。直接访问这些属性可以更灵活和精确地控制相机，同时还与 CameraOptions 完全兼容和可互换。所有字段都是可选的。参见Map#setFreeCameraOptions和Map#getFreeCameraOptions

# Parameters

  • position **MercatorCoordinate**稍微修改过的 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**焦点在地图上的位置
  • 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()
1

# clearPrewarmedResources

清除之前创建的资源vjmap.prewarm()。请注意，这通常不是必需的。如果您希望您的应用程序的用户在您的应用程序中的任何时候都不会返回到地图视图，您应该只调用此函数。

# Examples

vjmap.clearPrewarmedResources()
1

# workerCount

获取和设置在具有地图的页面上实例化的 Web Worker 的数量。默认情况下，它为 2。确保在创建任何地图实例之前设置此属性以使其生效。

类型： string

# Examples

vjmap.workerCount = 4;
1

返回**number**当前配置的workerCount。

# maxParallelImageRequests

获取和设置要并行加载的图像（光栅图块、像素、图标）的最大数量，这会影响地图重地图的性能。默认为16。

类型： string

# Examples

vjmap.maxParallelImageRequests = 10;
1

返回**number**当前配置的并行请求数。

# clearStorage

清除此库的浏览器。

此 API 在API 的浏览器上受支持``Cache（新窗口显示）支持并启用。这包括通过提供页面时的所有主要浏览器https://，但 Internet Explorer 和 Edge Mobile 除外。

在不受支持的浏览器或环境（智能或隐身模式）中，将使用错误参数调用中时。

# Parameters

  • callback 功能如果出现错误，则使用错误参数调用。

# Examples

vjmap.clearStorage();
1

# 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`');
}
1
2
3
4

返回 boolean

vjmap / Exports

# 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 / Exports / AnimateMarkerLayer

# Class: AnimateMarkerLayer

动画标记图层.

# Hierarchy

  • Evented

    ↳ AnimateMarkerLayer

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new AnimateMarkerLayer(features: FeatureCollection<Geometry | GeometryCollection, Properties>, options?: AnimateMarkerLayerOption): AnimateMarkerLayer

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>
options? AnimateMarkerLayerOption

Returns: AnimateMarkerLayer

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, options?: AnimateMarkerLayerOption): void

# Parameters
Name Type
type AnimateMarkerType
options? AnimateMarkerLayerOption

Returns: void

vjmap / Exports / BackgroundLayer

# Class: BackgroundLayer

创建一个背景图层.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new BackgroundLayer(options: BackgroundLayerOptions): BackgroundLayer

# Parameters
Name Type
options BackgroundLayerOptions

Returns: BackgroundLayer

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: BackgroundLayerOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getBackgroundColor

▸ getBackgroundColor(): PropertyValueSpecificationEx<string>

Returns: PropertyValueSpecificationEx<string>

# getBackgroundOpacity

▸ getBackgroundOpacity(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getBackgroundPattern

▸ getBackgroundPattern(): PropertyValueSpecificationEx<string>

Returns: PropertyValueSpecificationEx<string>

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setBackgroundColor

▸ setBackgroundColor(value: PropertyValueSpecificationEx<string>): BackgroundLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<string>

Returns: BackgroundLayer

# setBackgroundOpacity

▸ setBackgroundOpacity(value: PropertyValueSpecificationEx<number>): BackgroundLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: BackgroundLayer

# setBackgroundPattern

▸ setBackgroundPattern(value: PropertyValueSpecificationEx<string>): BackgroundLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<string>

Returns: BackgroundLayer

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / BreathingApertureMarker

# Class: BreathingApertureMarker

呼吸的光圈.

# Hierarchy

  • MarkerBase

    ↳ BreathingApertureMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new BreathingApertureMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): BreathingApertureMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: BreathingApertureMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

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 / Exports / ButtonGroupControl

# Class: ButtonGroupControl

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new ButtonGroupControl(options?: Record<string, any>): ButtonGroupControl

# Parameters
Name Type Default value
options Record<string, any> {}

Returns: ButtonGroupControl

# Methods

# onAdd

▸ onAdd(map: Map): HTMLElement

# Parameters
Name Type
map Map

Returns: HTMLElement

# onRemove

▸ onRemove(): void

Returns: void

vjmap / Exports / Circle

# Class: Circle

创建圆符号图层.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Circle(options: CircleOptions): Circle

# Parameters
Name Type
options CircleOptions

Returns: Circle

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: CircleOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getCircleBlur

▸ getCircleBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCircleColor

▸ getCircleColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getCircleOpacity

▸ getCircleOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCirclePitchAlignment

▸ getCirclePitchAlignment(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getCirclePitchScale

▸ getCirclePitchScale(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getCircleRadius

▸ getCircleRadius(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCircleSortKey

▸ getCircleSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCircleStrokeColor

▸ getCircleStrokeColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getCircleStrokeOpacity

▸ getCircleStrokeOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCircleStrokeWidth

▸ getCircleStrokeWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCircleTranslate

▸ getCircleTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getCircleTranslateAnchor

▸ getCircleTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getVisibility

▸ getVisibility(): "visible" | "none"

Returns: "visible" | "none"

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setCircleBlur

▸ setCircleBlur(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCircleColor

▸ setCircleColor(value: DataDrivenPropertyValueSpecification<string>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Circle

# setCircleOpacity

▸ setCircleOpacity(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCirclePitchAlignment

▸ setCirclePitchAlignment(value: PropertyValueSpecificationEx<"map" | "viewport">): Circle

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Circle

# setCirclePitchScale

▸ setCirclePitchScale(value: PropertyValueSpecificationEx<"map" | "viewport">): Circle

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Circle

# setCircleRadius

▸ setCircleRadius(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCircleSortKey

▸ setCircleSortKey(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCircleStrokeColor

▸ setCircleStrokeColor(value: DataDrivenPropertyValueSpecification<string>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Circle

# setCircleStrokeOpacity

▸ setCircleStrokeOpacity(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCircleStrokeWidth

▸ setCircleStrokeWidth(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCircleTranslate

▸ setCircleTranslate(value: PropertyValueSpecificationEx<[number, number]>): Circle

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: Circle

# setCircleTranslateAnchor

▸ setCircleTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Circle

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Circle

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# setVisibility

▸ setVisibility(value: "visible" | "none"): Circle

# Parameters
Name Type
value "visible" | "none"

Returns: Circle

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / CircleEdge

# Class: CircleEdge

创建只有边框的圆或圆弧

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new CircleEdge(options: CircleEdgeOptions): CircleEdge

# Parameters
Name Type
options CircleEdgeOptions

Returns: CircleEdge

Overrides: Polyline

# Properties

# _map

• Optional _map: Map

Inherited from: Polyline._map

# layerId

• Optional layerId: string

Inherited from: Polyline.layerId

# options

• options: PolylineOptions

Inherited from: Polyline.options

# sourceId

• Optional sourceId: string

Inherited from: Polyline.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: Polyline

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getCenter

▸ getCenter(): GeoPointLike

得到中心点。

Returns: GeoPointLike

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: Polyline

# getEndAngle

▸ getEndAngle(): number

得到结束角度。

Returns: number

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: Polyline

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: Polyline

# getLineBlur

▸ getLineBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineCap

▸ getLineCap(): DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Inherited from: Polyline

# getLineColor

▸ getLineColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polyline

# getLineDasharray

▸ getLineDasharray(): DataDrivenPropertyValueSpecification<number[]>

Returns: DataDrivenPropertyValueSpecification<number[]>

Inherited from: Polyline

# getLineGapWidth

▸ getLineGapWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineGradient

▸ getLineGradient(): ExpressionSpecificationEx

Returns: ExpressionSpecificationEx

Inherited from: Polyline

# getLineJoin

▸ getLineJoin(): DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Inherited from: Polyline

# getLineMiterMimit

▸ getLineMiterMimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

Inherited from: Polyline

# getLineOffset

▸ getLineOffset(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineOpacity

▸ getLineOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLinePattern

▸ getLinePattern(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polyline

# getLineRoundLimit

▸ getLineRoundLimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

Inherited from: Polyline

# getLineSortKey

▸ getLineSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineTranslate

▸ getLineTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

Inherited from: Polyline

# getLineTranslateAnchor

▸ getLineTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

Inherited from: Polyline

# getLineWidth

▸ getLineWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getPoints

▸ getPoints(): number

得到离散化的点的个数。

Returns: number

# getRadius

▸ getRadius(): number

得到半径。

Returns: number

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: Polyline

# getStartAngle

▸ getStartAngle(): number

得到开始角度。

Returns: number

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: Polyline

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: Polyline

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: Polyline

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: Polyline

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: Polyline

# setCenter

▸ setCenter(value: GeoPointLike, bFocusUpdateData?: boolean): CircleEdge

设置中心点。

# Parameters
Name Type Default value
value GeoPointLike -
bFocusUpdateData boolean true

Returns: CircleEdge

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

Inherited from: Polyline

# setEndAngle

▸ setEndAngle(value: number, bFocusUpdateData?: boolean): CircleEdge

设置结束角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleEdge

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: Polyline

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: Polyline

# setLineBlur

▸ setLineBlur(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineCap

▸ setLineCap(value: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: CircleEdge

Inherited from: Polyline

# setLineColor

▸ setLineColor(value: DataDrivenPropertyValueSpecification<string>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleEdge

Inherited from: Polyline

# setLineDasharray

▸ setLineDasharray(value: DataDrivenPropertyValueSpecification<number[]>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number[]>

Returns: CircleEdge

Inherited from: Polyline

# setLineGapWidth

▸ setLineGapWidth(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineGradient

▸ setLineGradient(value: ExpressionSpecificationEx): CircleEdge

# Parameters
Name Type
value ExpressionSpecificationEx

Returns: CircleEdge

Inherited from: Polyline

# setLineJoin

▸ setLineJoin(value: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: CircleEdge

Inherited from: Polyline

# setLineMiterMimit

▸ setLineMiterMimit(value: PropertyValueSpecificationEx<number>): CircleEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineOffset

▸ setLineOffset(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineOpacity

▸ setLineOpacity(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setLinePattern

▸ setLinePattern(value: DataDrivenPropertyValueSpecification<string>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleEdge

Inherited from: Polyline

# setLineRoundLimit

▸ setLineRoundLimit(value: PropertyValueSpecificationEx<number>): CircleEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineSortKey

▸ setLineSortKey(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineTranslate

▸ setLineTranslate(value: PropertyValueSpecificationEx<[number, number]>): CircleEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: CircleEdge

Inherited from: Polyline

# setLineTranslateAnchor

▸ setLineTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): CircleEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: CircleEdge

Inherited from: Polyline

# setLineWidth

▸ setLineWidth(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setPoints

▸ setPoints(value: number, bFocusUpdateData?: boolean): CircleEdge

设置离散化的点的个数。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleEdge

# 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

# setRadius

▸ setRadius(value: number, bFocusUpdateData?: boolean): CircleEdge

设置半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleEdge

# setStartAngle

▸ setStartAngle(value: number, bFocusUpdateData?: boolean): CircleEdge

设置开始角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleEdge

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: Polyline

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: Polyline

# updateData

▸ updateData(): void

Returns: void

vjmap / Exports / CircleFill

# Class: CircleFill

创建填充的圆或圆弧

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new CircleFill(options: CircleFillOptions): CircleFill

# Parameters
Name Type
options CircleFillOptions

Returns: CircleFill

Overrides: Polygon

# Properties

# _map

• Optional _map: Map

Inherited from: Polygon._map

# layerId

• Optional layerId: string

Inherited from: Polygon.layerId

# options

• options: PolygonOptions

Inherited from: Polygon.options

# sourceId

• Optional sourceId: string

Inherited from: Polygon.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: Polygon

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getCenter

▸ getCenter(): GeoPointLike

得到中心点。

Returns: GeoPointLike

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: Polygon

# getEndAngle

▸ getEndAngle(): number

得到结束角度。

Returns: number

# getFillAntialias

▸ getFillAntialias(): PropertyValueSpecificationEx<boolean>

获取图层的“填充抗锯齿”绘制属性。

Returns: PropertyValueSpecificationEx<boolean>

Inherited from: Polygon

# getFillColor

▸ getFillColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillOpacity

▸ getFillOpacity(): DataDrivenPropertyValueSpecification<number>

获取图层的 fill-opacity 绘制属性。

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polygon

# getFillOutlineColor

▸ getFillOutlineColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-outline-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillPattern

▸ getFillPattern(): DataDrivenPropertyValueSpecification<string>

获取图层的fill-pattern 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillSortKey

▸ getFillSortKey(): DataDrivenPropertyValueSpecification<number>

获取图层的fill-sort-key 布局属性.

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polygon

# getFillTranslate

▸ getFillTranslate(): PropertyValueSpecificationEx<[number, number]>

获取图层的 fill-translate 绘制属性。

Returns: PropertyValueSpecificationEx<[number, number]>

Inherited from: Polygon

# getFillTranslateAnchor

▸ getFillTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

获取图层的 fill-translate-anchor 绘制属性。

Returns: PropertyValueSpecificationEx<"map" | "viewport">

Inherited from: Polygon

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: Polygon

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: Polygon

# getPoints

▸ getPoints(): number

得到离散化的点的个数。

Returns: number

# getRadius

▸ getRadius(): number

得到半径。

Returns: number

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: Polygon

# getStartAngle

▸ getStartAngle(): number

得到开始角度。

Returns: number

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: Polygon

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: Polygon

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: Polygon

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: Polygon

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: Polygon

# setCenter

▸ setCenter(value: GeoPointLike, bFocusUpdateData?: boolean): CircleFill

设置中心点。

# Parameters
Name Type Default value
value GeoPointLike -
bFocusUpdateData boolean true

Returns: CircleFill

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

Inherited from: Polygon

# setEndAngle

▸ setEndAngle(value: number, bFocusUpdateData?: boolean): CircleFill

设置结束角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleFill

# setFillAntialias

▸ setFillAntialias(value: PropertyValueSpecificationEx<boolean>): CircleFill

为一个或多个图层设置fill-antialias 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: CircleFill

Inherited from: Polygon

# setFillColor

▸ setFillColor(value: DataDrivenPropertyValueSpecification<string>): CircleFill

为一个或多个图层设置fill-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleFill

Inherited from: Polygon

# setFillOpacity

▸ setFillOpacity(value: DataDrivenPropertyValueSpecification<number>): CircleFill

为一个或多个图层设置fill-opacity 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleFill

Inherited from: Polygon

# setFillOutlineColor

▸ setFillOutlineColor(value: DataDrivenPropertyValueSpecification<string>): CircleFill

为一个或多个图层设置fill-outline-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleFill

Inherited from: Polygon

# setFillPattern

▸ setFillPattern(value: DataDrivenPropertyValueSpecification<string>): CircleFill

为一个或多个图层设置fill-pattern 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleFill

Inherited from: Polygon

# setFillSortKey

▸ setFillSortKey(value: DataDrivenPropertyValueSpecification<number>): CircleFill

为一层或多层设置fill-sort-key布局属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleFill

Inherited from: Polygon

# setFillTranslate

▸ setFillTranslate(value: DataDrivenPropertyValueSpecification<string>): CircleFill

为一个或多个图层设置fill-translate 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleFill

Inherited from: Polygon

# setFillTranslateAnchor

▸ setFillTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): CircleFill

为一个或多个图层设置fill-translate-anchor 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: CircleFill

Inherited from: Polygon

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: Polygon

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: Polygon

# setPoints

▸ setPoints(value: number, bFocusUpdateData?: boolean): CircleFill

设置离散化的点的个数。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleFill

# 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

# setRadius

▸ setRadius(value: number, bFocusUpdateData?: boolean): CircleFill

设置半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleFill

# setStartAngle

▸ setStartAngle(value: number, bFocusUpdateData?: boolean): CircleFill

设置开始角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleFill

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: Polygon

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: Polygon

# updateData

▸ updateData(): void

Returns: void

vjmap / Exports / CloseEvent

# Class: CloseEvent

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new CloseEvent(code?: number, reason?: string, target: any): CloseEvent

# Parameters
Name Type Default value
code number 1000
reason string ""
target any -

Returns: CloseEvent

Overrides: WebSocketEvent

# Properties

# code

• code: number

# reason

• reason: string

# target

• target: any

Inherited from: WebSocketEvent.target

# type

• type: string

Inherited from: WebSocketEvent.type

# wasClean

• wasClean: boolean= true

vjmap / Exports / Compare

# Class: Compare

# Hierarchy

  • Evented

    ↳ Compare

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new Compare(a: Map, b: Map, container: string | Element, options?: { mousemove: boolean ; orientation: "vertical" | "horizontal" }): Compare

# Parameters
Name Type
a Map
b Map
container string | Element
options? object
options.mousemove boolean
options.orientation "vertical" | "horizontal"

Returns: Compare

Overrides: Evented.constructor

# Methods

# remove

▸ remove(): void

Returns: void

# setSlider

▸ setSlider(x: number): void

# Parameters
Name Type
x number

Returns: void

vjmap / Exports / ContextMenu

# Class: ContextMenu

上下文菜单.

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new ContextMenu(opts: ContextMenuOptions): ContextMenu

Creates a new ContextMenu menu

# Parameters
Name Type Description
opts ContextMenuOptions options which build the menu e.g. position and items

Returns: ContextMenu

# 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 / Exports / Db2dPolyline

# Class: Db2dPolyline

Db2dPolyline 二维多段线实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new Db2dPolyline(prop?: IDb2dPolyline): Db2dPolyline

构造函数

# Parameters
Name Type Default value
prop IDb2dPolyline {}

Returns: Db2dPolyline

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# elevation

• Optional elevation: number

高程.

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# points

• Optional points: [number, number, undefined | number][]

坐标.

# polyType

• Optional polyType: k2dSimplePoly | k2dFitCurvePoly | k2dQuadSplinePoly | k2dCubicSplinePoly

2d折线类型

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / Db2LineAngularDimension

# Class: Db2LineAngularDimension

Db2LineAngularDimension 角度标注[两条线]实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new Db2LineAngularDimension(prop?: IDb2LineAngularDimension): Db2LineAngularDimension

构造函数

# Parameters
Name Type Default value
prop IDb2LineAngularDimension {}

Returns: Db2LineAngularDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点位置.

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.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.xdata

vjmap / Exports / Db3dPolyline

# Class: Db3dPolyline

Db3dPolyline 三维多段线实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new Db3dPolyline(prop?: IDb3dPolyline): Db3dPolyline

构造函数

# Parameters
Name Type Default value
prop IDb3dPolyline {}

Returns: Db3dPolyline

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# points

• Optional points: [number, number, undefined | number][]

坐标.

# polyType

• Optional polyType: k3dSimplePoly | k3dQuadSplinePoly | k3dCubicSplinePoly

3d折线类型

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / Db3PointAngularDimension

# Class: Db3PointAngularDimension

Db3PointAngularDimension 角度标注[三点]实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new Db3PointAngularDimension(prop?: IDb3PointAngularDimension): Db3PointAngularDimension

构造函数

# Parameters
Name Type Default value
prop IDb3PointAngularDimension {}

Returns: Db3PointAngularDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点位置.

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# centerPoint

• Optional centerPoint: [number, number, undefined | number][]

中点.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

点1.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

点2.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / DbAlignedDimension

# Class: DbAlignedDimension

DbAlignedDimension 对齐标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbAlignedDimension(prop?: IDbAlignedDimension): DbAlignedDimension

构造函数

# Parameters
Name Type Default value
prop IDbAlignedDimension {}

Returns: DbAlignedDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimLinePoint

• Optional dimLinePoint: [number, number, undefined | number][]

设置定义此dimension实体尺寸线位置的WCS点.

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# jogSymbolHeight

• Optional jogSymbolHeight: number

设置此实体的符号高度。.

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线1点.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线2点.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / DbArc

# Class: DbArc

DbArc 圆弧实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbArc(prop?: IDbArc): DbArc

构造函数

# Parameters
Name Type Default value
prop IDbArc {}

Returns: DbArc

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# endAngle

• Optional endAngle: number

结束弧度.

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / DbArcDimension

# Class: DbArcDimension

DbArcDimension 圆弧标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbArcDimension(prop?: IDbArcDimension): DbArcDimension

构造函数

# Parameters
Name Type Default value
prop IDbArcDimension {}

Returns: DbArcDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点.

# arcSymbolType

• Optional arcSymbolType: number

文本中使用的弧符号的类型。 0 弧符号在文本前面; 1 弧线符号在文字上方; 2 没有符号.

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# centerPoint

• Optional centerPoint: [number, number, undefined | number][]

中心点.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线1点.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线2点.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / DbAttributeDefinition

# Class: DbAttributeDefinition

DbText 属性定义实体.

# Hierarchy

  • DbText

    ↳ DbAttributeDefinition

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbAttributeDefinition(prop?: IDbText): DbAttributeDefinition

构造函数

# Parameters
Name Type Default value
prop IDbText {}

Returns: DbAttributeDefinition

Overrides: DbText

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbText.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbText.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbText.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbText.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbText.colorIndex

# contents

• Optional contents: string

文本内容， 同text.

Inherited from: DbText.contents

# height

• Optional height: number

高.

Inherited from: DbText.height

# horizontalMode

• Optional horizontalMode: kTextLeft | kTextCenter | kTextRight | kTextAlign | kTextMid | kTextFit

水平模式.

Inherited from: DbText.horizontalMode

# layer

• Optional layer: string

图层.

Inherited from: DbText.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbText.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbText.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbText.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbText.matrix

# position

• Optional position: [number, number, undefined | number]

位置.

Inherited from: DbText.position

# prompt

• Optional prompt: string

属性提示.

# rotation

• Optional rotation: number

旋转角度.

Inherited from: DbText.rotation

# tag

• Optional tag: string

属性名.

# text

• Optional text: string

文本内容， 同contents.

Inherited from: DbText.text

# textStyle

• Optional textStyle: string

文本样式.

Inherited from: DbText.textStyle

# typename

• Optional typename: string

类型.

Inherited from: DbText.typename

# verticalMode

• Optional verticalMode: kTextBase | kTextBottom | kTextVertMid | kTextTop

垂直模式.

Inherited from: DbText.verticalMode

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbText.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbText.xdata

vjmap / Exports / DbBlock

# Class: DbBlock

DbBlock 块定义.

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbBlock(prop?: IDbBlock): DbBlock

构造函数

# Parameters
Name Type Default value
prop IDbBlock {}

Returns: DbBlock

# Properties

# comments

• Optional comments: string

备注.

# entitys

• Optional entitys: IDbEntity[]

由哪些实体创建而成.

# explodable

• Optional explodable: boolean

是否可炸开.

# insertUnits

• Optional insertUnits: number

设置此块的块插入单位 .

# name

• Optional name: string

块名称.

# origin

• Optional origin: [number, number, undefined | number]

原点。 .

# scaling

• Optional scaling: number

设置此块的参照的缩放特征.

vjmap / Exports / DbBlockReference

# Class: DbBlockReference

DbBlockReference 块参照实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbBlockReference(prop?: IDbBlockReference): DbBlockReference

构造函数

# Parameters
Name Type Default value
prop IDbBlockReference {}

Returns: DbBlockReference

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# attribute

• Optional attribute: Record<string, string | number | DbText>

属性字段值

# blockname

• Optional blockname: string

块名称.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / DbCircle

# Class: DbCircle

DbCircle 圆实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbCircle(prop?: IDbCircle): DbCircle

构造函数

# Parameters
Name Type Default value
prop IDbCircle {}

Returns: DbCircle

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# normal

• Optional normal: [number, number, undefined | number]

法向量.

# radius

• Optional radius: number

半径.

# thickness

• Optional thickness: number

厚度.

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / DbCurve

# Class: DbCurve

DbCurve 曲线实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbCurve(prop?: IDbCurve): DbCurve

构造函数

# Parameters
Name Type Default value
prop IDbCurve {}

Returns: DbCurve

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.matrix

# typename

• Optional typename: string

类型.

Inherited from: DbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / DbDiametricDimension

# Class: DbDiametricDimension

DbDiametricDimension 直径标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbDiametricDimension(prop?: IDbDiametricDimension): DbDiametricDimension

构造函数

# Parameters
Name Type Default value
prop IDbDiametricDimension {}

Returns: DbDiametricDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# chordPoint

• Optional chordPoint: [number, number, undefined | number][]

圆上1点.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# farChordPoint

• Optional farChordPoint: [number, number, undefined | number][]

圆上2点.

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# leaderLength

• Optional leaderLength: number

引线长度.

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / DbDimension

# Class: DbDimension

DbDimension 标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbDimension(prop?: IDbDimension): DbDimension

构造函数

# Parameters
Name Type Default value
prop IDbDimension {}

Returns: DbDimension

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

# arrowSize

• Optional arrowSize: number

箭头大小.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

# dimScale

• Optional dimScale: number

注记比例.

# dimStyle

• Optional dimStyle: string

标注样式.

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineColor

• Optional lineColor: number

引线颜色.

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / DbDocument

# Class: DbDocument

DbDocument 地图数据库文档.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new DbDocument(prop?: IDbDocument): DbDocument

构造函数

# Parameters
Name Type Default value
prop IDbDocument {}

Returns: DbDocument

# Properties

# blocks

• Optional blocks: IDbBlock[]

块定义.

# dimStyles

• Optional dimStyles: IDbDimStyle[]

标注样式.

# entitys

• Optional entitys: IDbEntity[]

实体集.

# environment

• Optional environment: Record<string, any>

文档环境，用于设置是否显示线宽等设置, 设置线宽为 LWDISPLAY ,true显示或 false不显示线宽

# from

• Optional from: string

来源于哪个图，会在此图的上面进行修改或新增删除，格式如 形式为 mapid/version,如 exam/v1 .

# isClearFromDb

• Optional isClearFromDb: boolean

# isRenameBlockNameIfExist

• Optional isRenameBlockNameIfExist: boolean

来源于其他图的实体时，如果块定义重复，则自动重命名 ，默认true

# layers

• Optional layers: IDbLayer[]

图层集.

# linetypes

• Optional linetypes: IDbLinetype[]

线型.

# pickEntitys

• Optional pickEntitys: string[]

来源于哪个图时有效，表示从此图中选择指定的实体ID，不在指定的实体ID将不会显示

# pickExpr

• Optional pickExpr: string

来源于哪个图时有效，使用表达式，表示从此图中选择指定的实体ID，不在指定的实体ID将不会显示 结果与pickEntitys的取并

# pickLayers

• Optional pickLayers: string[]

来源于哪个图时有效，表示从此图中选择指定的图层，不在指定的图层将不会显示

# textStyles

• Optional textStyles: IDbTextStyle[]

文字样式.

# Methods

# appendBlock

▸ appendBlock(block: IDbBlock | IDbBlock[]): void

增加块

# Parameters
Name Type
block IDbBlock | IDbBlock[]

Returns: void

# appendDimStyle

▸ appendDimStyle(dimStyle: IDbDimStyle | IDbDimStyle[]): void

增加标注样式

# Parameters
Name Type
dimStyle IDbDimStyle | IDbDimStyle[]

Returns: void

# appendEntity

▸ appendEntity(entity: IDbEntity | IDbEntity[]): void

增加实体

# Parameters
Name Type
entity IDbEntity | IDbEntity[]

Returns: void

# appendLayer

▸ appendLayer(layer: IDbLayer | IDbLayer[]): void

增加图层

# Parameters
Name Type
layer IDbLayer | IDbLayer[]

Returns: void

# appendLinetype

▸ appendLinetype(linetype: IDbLinetype | IDbLinetype[]): void

增加线型

# Parameters
Name Type
linetype IDbLinetype | IDbLinetype[]

Returns: void

# appendTextStyle

▸ appendTextStyle(textStyle: IDbTextStyle | IDbTextStyle[]): void

增加样式样式

# Parameters
Name Type
textStyle IDbTextStyle | IDbTextStyle[]

Returns: void

# toDoc

▸ toDoc(content?: string): string

转成文档字符串

# Parameters
Name Type Description
content? string 如果传入了内容，则以content为主。json格式

Returns: string

vjmap / Exports / DbEllipse

# Class: DbEllipse

DbEllipse 椭圆实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbEllipse(prop?: IDbEllipse): DbEllipse

构造函数

# Parameters
Name Type Default value
prop IDbEllipse {}

Returns: DbEllipse

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# endAngle

• Optional endAngle: number

结束弧度.

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# minorAxis

• Optional minorAxis: [number, number, undefined | number]

主轴方向.

# radiusRatio

• Optional radiusRatio: number

短轴和长轴的比例.

# startAngle

• Optional startAngle: number

开始弧度.

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / DbEntity

# Class: DbEntity

DbEntity 实体基类.

# Implements

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ Protected new DbEntity(prop?: IDbEntity): DbEntity

构造函数

# Parameters
Name Type Default value
prop IDbEntity {}

Returns: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Implementation of: IDbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

# color

• Optional color: number

颜色.

Implementation of: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Implementation of: IDbEntity.colorIndex

# layer

• Optional layer: string

图层.

Implementation of: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Implementation of: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Implementation of: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Implementation of: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Implementation of: IDbEntity.matrix

# typename

• Optional typename: string

类型.

Implementation of: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Implementation of: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Implementation of: IDbEntity.xdata

vjmap / Exports / DbHatch

# Class: DbHatch

DbHatch 图案实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbHatch(prop?: IDbHatch): DbHatch

构造函数

# Parameters
Name Type Default value
prop IDbHatch {}

Returns: DbHatch

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# elevation

• Optional elevation: number

高程.

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / DbLayer

# Class: DbLayer

DbLayer 图层.

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbLayer(prop?: IDbLayer): DbLayer

构造函数

# Parameters
Name Type Default value
prop IDbLayer {}

Returns: DbLayer

# 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 / Exports / DbLine

# Class: DbLine

DbLine 线实体.

# Hierarchy

# Implements

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbLine(prop?: IDbLine): DbLine

构造函数

# Parameters
Name Type Default value
prop IDbLine {}

Returns: DbLine

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Implementation of: IDbLine.alpha

Inherited from: DbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Implementation of: IDbLine.color

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Implementation of: IDbLine.colorIndex

Inherited from: DbEntity.colorIndex

# end

• Optional end: [number, number, undefined | number]

终点.

Implementation of: IDbLine.end

# layer

• Optional layer: string

图层.

Implementation of: IDbLine.layer

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Implementation of: IDbLine.lineWidth

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Implementation of: IDbLine.linetype

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Implementation of: IDbLine.linetypeScale

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Implementation of: IDbLine.matrix

Inherited from: DbEntity.matrix

# start

• Optional start: [number, number, undefined | number]

起点.

Implementation of: IDbLine.start

# thickness

• Optional thickness: number

厚度.

Implementation of: IDbLine.thickness

# typename

• Optional typename: string

类型.

Implementation of: IDbLine.typename

Inherited from: DbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Implementation of: IDbLine.visibility

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Implementation of: IDbLine.xdata

Inherited from: DbEntity.xdata

vjmap / Exports / DbLineType

# Class: DbLineType

DbLineType 线型.

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbLineType(prop?: IDbLinetype): DbLineType

构造函数

# Parameters
Name Type Default value
prop IDbLinetype {}

Returns: DbLineType

# Properties

# comments

• Optional comments: string

评论.

# name

• Optional name: string

线型名称.

# style

• Optional style: IDbLinetypeStyle[]

线型样式 .

vjmap / Exports / DbMLeader

# Class: DbMLeader

DbMLeader 多重引线.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbMLeader(prop?: IDbMText): DbMLeader

构造函数

# Parameters
Name Type Default value
prop IDbMText {}

Returns: DbMLeader

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.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.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.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.layer

# leaderLinePoint

• Optional leaderLinePoint: [number, number, undefined | number]

引线位置.

# leaderVertexPoints

• Optional leaderVertexPoints: [number, number, undefined | number][]

引线顶点位置数组.

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.matrix

# textAttachment

• Optional textAttachment: kTopLeft | kTopCenter | kTopRight | kMiddleLeft | kMiddleCenter | kMiddleRight | kBottomLeft | kBottomCenter | kBottomRight | kBaseLeft | kBaseCenter | kBaseRight | kBaseAlign | kBottomAlign | kMiddleAlign | kTopAlign | kBaseFit | kBottomFit | kMiddleFit | kTopFit | kBaseMid | kBottomMid | kMiddleMid | 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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / DbMText

# Class: DbMText

DbMText 多行文本实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbMText(prop?: IDbMText): DbMText

构造函数

# Parameters
Name Type Default value
prop IDbMText {}

Returns: DbMText

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# attachment

• Optional attachment: kTopLeft | kTopCenter | kTopRight | kMiddleLeft | kMiddleCenter | kMiddleRight | kBottomLeft | kBottomCenter | kBottomRight | kBaseLeft | kBaseCenter | kBaseRight | kBaseAlign | kBottomAlign | kMiddleAlign | kTopAlign | kBaseFit | kBottomFit | kMiddleFit | kTopFit | kBaseMid | kBottomMid | kMiddleMid | kTopMid

对齐方式.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# contents

• Optional contents: string

文本内容.

# height

• Optional height: number

高.

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# location

• Optional location: [number, number, undefined | number]

位置.

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.matrix

# rotation

• Optional rotation: number

旋转角度.

# textHeight

• Optional textHeight: number

文本高.

# textStyle

• Optional textStyle: string

文本样式.

# typename

• Optional typename: string

类型.

Inherited from: DbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# width

• Optional width: number

宽.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / DbOrdinateDimension

# Class: DbOrdinateDimension

DbOrdinateDimension 坐标标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbOrdinateDimension(prop?: IDbOrdinateDimension): DbOrdinateDimension

构造函数

# Parameters
Name Type Default value
prop IDbOrdinateDimension {}

Returns: DbOrdinateDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# definingPoint

• Optional definingPoint: [number, number, undefined | number][]

定义点.

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# leaderEndPoint

• Optional leaderEndPoint: [number, number, undefined | number][]

引线点.

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# origin

• Optional origin: [number, number, undefined | number][]

基点.

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# useXAxis

• Optional useXAxis: boolean

是否用X轴.

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / DbPolyline

# Class: DbPolyline

DbPolyline 多段线实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbPolyline(prop?: IDbPolyline): DbPolyline

构造函数

# Parameters
Name Type Default value
prop IDbPolyline {}

Returns: DbPolyline

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# bulge

• Optional bulge: number[]

凸度.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# elevation

• Optional elevation: number

高程.

# endWidth

• Optional endWidth: number[]

终点宽.

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# points

• Optional points: [number, number, undefined | number][]

坐标.

# startWidth

• Optional startWidth: number[]

起点宽.

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / DbRadialDimension

# Class: DbRadialDimension

DbRadialDimension 半径标注实体

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbRadialDimension(prop?: IDbRadialDimension): DbRadialDimension

构造函数

# Parameters
Name Type Default value
prop IDbRadialDimension {}

Returns: DbRadialDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.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.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# leaderLength

• Optional leaderLength: number

引线长度.

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / DbRadialDimensionLarge

# Class: DbRadialDimensionLarge

DbRadialDimensionLarge 半径折线标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbRadialDimensionLarge(prop?: IDbRadialDimensionLarge): DbRadialDimensionLarge

构造函数

# Parameters
Name Type Default value
prop IDbRadialDimensionLarge {}

Returns: DbRadialDimensionLarge

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.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.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# jogAngle

• Optional jogAngle: number

设置此Dimension实体的折角。.

# jogPoint

• Optional jogPoint: [number, number, undefined | number][]

设置此Dimension实体的折角点。.

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# overrideCenter

• Optional overrideCenter: [number, number, undefined | number][]

设置由该Dimension实体确定尺寸的弧的WCS覆盖中心。.

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / DbRasterImage

# Class: DbRasterImage

DbRasterImage 栅格图像实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbRasterImage(prop?: IDbRasterImage): DbRasterImage

构造函数

# Parameters
Name Type Default value
prop IDbRasterImage {}

Returns: DbRasterImage

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# brightness

• Optional brightness: number

明亮度 [0.0 .. 100.0]

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.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.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# units

• Optional units: kNone | kMillimeter | kCentimeter | kMeter | kKilometer | kInch | kFoot | kYard | kMile | kMicroinches | kMils | kAngstroms | kNanometers | kMicrons | kDecimeters | kDekameters | kHectometers | kGigameters | kAstronomical | kLightYears | kParsecs

单位.

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# widthRatio

• Optional widthRatio: number

宽比例.

# xPelsPerUnit

• Optional xPelsPerUnit: number

x轴每像素代表长度.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

# yPelsPerUnit

• Optional yPelsPerUnit: number

y轴每像素代表长度.

vjmap / Exports / DbRotatedDimension

# Class: DbRotatedDimension

DbRotatedDimension 转角标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbRotatedDimension(prop?: IDbRotatedDimension): DbRotatedDimension

构造函数

# Parameters
Name Type Default value
prop IDbRotatedDimension {}

Returns: DbRotatedDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimLinePoint

• Optional dimLinePoint: [number, number, undefined | number][]

设置定义此dimension实体尺寸线位置的WCS点。.

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线上点1.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线上点2.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / DbShape

# Class: DbShape

DbShape 型实体

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbShape(prop?: IDbShape): DbShape

构造函数

# Parameters
Name Type Default value
prop IDbShape {}

Returns: DbShape

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / DbSpline

# Class: DbSpline

DbSpline 样条曲线实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbSpline(prop?: IDbSpline): DbSpline

构造函数

# Parameters
Name Type Default value
prop IDbSpline {}

Returns: DbSpline

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.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.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / DbTable

# Class: DbTable

DbBlockReference 块参照实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbTable(prop?: IDbTable): DbTable

构造函数

# Parameters
Name Type Default value
prop IDbTable {}

Returns: DbTable

Overrides: DbBlockReference

# Properties

# alignment

• Optional alignment: kTopLeft | kTopCenter | kTopRight | kMiddleLeft | kMiddleCenter | kMiddleRight | kBottomLeft | kBottomCenter | kBottomRight

单元格对齐方式(所有单元格).

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbBlockReference.alpha

# attribute

• Optional attribute: Record<string, string | number | DbText>

属性字段值

Inherited from: DbBlockReference.attribute

# backgroundColor

• Optional backgroundColor: number

背景颜色(所有单元格).

# blockname

• Optional blockname: string

块名称.

Inherited from: DbBlockReference.blockname

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbBlockReference.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbBlockReference.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbBlockReference.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbBlockReference.colorIndex

# columnWidth

• Optional columnWidth: number

列宽.

# contentColor

• Optional contentColor: number

文字颜色(所有单元格).

# data

• Optional data: (string | { alignment: TableCellAlignment ; 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.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbBlockReference.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbBlockReference.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbBlockReference.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbBlockReference.matrix

# mergeCells

• Optional mergeCells: [number, number, number, number][]

需要合并的单元格 [[minRow, maxRow,minColumn, maxColumn], ...]

# normal

• Optional normal: [number, number, undefined | number]

法向量.

Inherited from: DbBlockReference.normal

# numColumns

• Optional numColumns: number

表格列数.

# numRows

• Optional numRows: number

表格行数.

# position

• Optional position: [number, number, undefined | number]

坐标.

Inherited from: DbBlockReference.position

# ref

• Optional ref: string

参考外部图形，形式为 mapid/version,如 exam/v1.

Inherited from: DbBlockReference.ref

# rotation

• Optional rotation: number

旋转角度.

Inherited from: DbBlockReference.rotation

# rowHeight

• Optional rowHeight: number

行高.

# scaleFactors

• Optional scaleFactors: [number, number, undefined | number]

缩放因子. [x方向，y方向,z方向]

Inherited from: DbBlockReference.scaleFactors

# tableStyleName

• Optional tableStyleName: string

表样式名称.

# textHeight

• Optional textHeight: number

文字高度(所有单元格).

# typename

• Optional typename: string

类型.

Inherited from: DbBlockReference.typename

# vertCellMargin

• Optional vertCellMargin: number

竖直方向单元格边距.

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbBlockReference.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbBlockReference.xdata

vjmap / Exports / DbText

# Class: DbText

DbText 文本实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbText(prop?: IDbText): DbText

构造函数

# Parameters
Name Type Default value
prop IDbText {}

Returns: DbText

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# contents

• Optional contents: string

文本内容， 同text.

# height

• Optional height: number

高.

# horizontalMode

• Optional horizontalMode: kTextLeft | kTextCenter | kTextRight | kTextAlign | kTextMid | kTextFit

水平模式.

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# verticalMode

• Optional verticalMode: kTextBase | kTextBottom | kTextVertMid | kTextTop

垂直模式.

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / DbTextStyle

# Class: DbTextStyle

DbTextStyle 文字样式.

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbTextStyle(prop?: IDbTextStyle): DbTextStyle

构造函数

# Parameters
Name Type Default value
prop IDbTextStyle {}

Returns: DbTextStyle

# 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 / Exports / DbWipeout

# Class: DbWipeout

DbWipeout 遮罩实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbWipeout(prop?: IDbWipeout): DbWipeout

构造函数

# Parameters
Name Type Default value
prop IDbWipeout {}

Returns: DbWipeout

Overrides: DbRasterImage

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbRasterImage.alpha

# brightness

• Optional brightness: number

明亮度 [0.0 .. 100.0]

Inherited from: DbRasterImage.brightness

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbRasterImage.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbRasterImage.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbRasterImage.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbRasterImage.colorIndex

# heightRatio

• Optional heightRatio: number

高比例..

Inherited from: DbRasterImage.heightRatio

# imageDisplayOptClip

• Optional imageDisplayOptClip: boolean

是否裁剪.

Inherited from: DbRasterImage.imageDisplayOptClip

# imageDisplayOptShow

• Optional imageDisplayOptShow: boolean

是否显示.

Inherited from: DbRasterImage.imageDisplayOptShow

# imageDisplayOptShowUnAligned

• Optional imageDisplayOptShowUnAligned: boolean

是否对齐.

Inherited from: DbRasterImage.imageDisplayOptShowUnAligned

# imageDisplayOptTransparent

• Optional imageDisplayOptTransparent: boolean

是否透明.

Inherited from: DbRasterImage.imageDisplayOptTransparent

# layer

• Optional layer: string

图层.

Inherited from: DbRasterImage.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbRasterImage.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbRasterImage.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbRasterImage.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbRasterImage.matrix

# pixelHeight

• Optional pixelHeight: number

源图片高.

Inherited from: DbRasterImage.pixelHeight

# pixelWidth

• Optional pixelWidth: number

源图片宽.

Inherited from: DbRasterImage.pixelWidth

# points

• Optional points: [number, number, undefined | number][]

坐标.

# position

• Optional position: [number, number, undefined | number]

位置.

Inherited from: DbRasterImage.position

# sourceHttpUrl

• Optional sourceHttpUrl: string

图片url地址.

Inherited from: DbRasterImage.sourceHttpUrl

# typename

• Optional typename: string

类型.

Inherited from: DbRasterImage.typename

# units

• Optional units: kNone | kMillimeter | kCentimeter | kMeter | kKilometer | kInch | kFoot | kYard | kMile | kMicroinches | kMils | kAngstroms | kNanometers | kMicrons | kDecimeters | kDekameters | kHectometers | kGigameters | kAstronomical | kLightYears | kParsecs

单位.

Inherited from: DbRasterImage.units

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbRasterImage.visibility

# widthRatio

• Optional widthRatio: number

宽比例.

Inherited from: DbRasterImage.widthRatio

# xPelsPerUnit

• Optional xPelsPerUnit: number

x轴每像素代表长度.

Inherited from: DbRasterImage.xPelsPerUnit

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbRasterImage.xdata

# yPelsPerUnit

• Optional yPelsPerUnit: number

y轴每像素代表长度.

Inherited from: DbRasterImage.yPelsPerUnit

vjmap / Exports / DeckLayer

# Class: DeckLayer

deck.gl图层.

# Hierarchy

  • Evented

    ↳ DeckLayer

# Implements

  • CustomLayerInterface

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new DeckLayer(props: any): DeckLayer

# Parameters
Name Type
props any

Returns: DeckLayer

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 / Exports / default / AnimateMarkerLayer

# Class: AnimateMarkerLayer

default.AnimateMarkerLayer

动画标记图层.

# Hierarchy

  • Evented

    ↳ AnimateMarkerLayer

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new AnimateMarkerLayer(features: FeatureCollection<Geometry | GeometryCollection, Properties>, options?: AnimateMarkerLayerOption): AnimateMarkerLayer

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>
options? AnimateMarkerLayerOption

Returns: AnimateMarkerLayer

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, options?: AnimateMarkerLayerOption): void

# Parameters
Name Type
type AnimateMarkerType
options? AnimateMarkerLayerOption

Returns: void

vjmap / Exports / default / BackgroundLayer

# Class: BackgroundLayer

default.BackgroundLayer

创建一个背景图层.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new BackgroundLayer(options: BackgroundLayerOptions): BackgroundLayer

# Parameters
Name Type
options BackgroundLayerOptions

Returns: BackgroundLayer

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: BackgroundLayerOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getBackgroundColor

▸ getBackgroundColor(): PropertyValueSpecificationEx<string>

Returns: PropertyValueSpecificationEx<string>

# getBackgroundOpacity

▸ getBackgroundOpacity(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getBackgroundPattern

▸ getBackgroundPattern(): PropertyValueSpecificationEx<string>

Returns: PropertyValueSpecificationEx<string>

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setBackgroundColor

▸ setBackgroundColor(value: PropertyValueSpecificationEx<string>): BackgroundLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<string>

Returns: BackgroundLayer

# setBackgroundOpacity

▸ setBackgroundOpacity(value: PropertyValueSpecificationEx<number>): BackgroundLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: BackgroundLayer

# setBackgroundPattern

▸ setBackgroundPattern(value: PropertyValueSpecificationEx<string>): BackgroundLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<string>

Returns: BackgroundLayer

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / default / BreathingApertureMarker

# Class: BreathingApertureMarker

default.BreathingApertureMarker

呼吸的光圈.

# Hierarchy

  • MarkerBase

    ↳ BreathingApertureMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new BreathingApertureMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): BreathingApertureMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: BreathingApertureMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

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 / Exports / default / ButtonGroupControl

# Class: ButtonGroupControl

default.ButtonGroupControl

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new ButtonGroupControl(options?: Record<string, any>): ButtonGroupControl

# Parameters
Name Type Default value
options Record<string, any> {}

Returns: ButtonGroupControl

# Methods

# onAdd

▸ onAdd(map: Map): HTMLElement

# Parameters
Name Type
map Map

Returns: HTMLElement

# onRemove

▸ onRemove(): void

Returns: void

vjmap / Exports / default / Circle

# Class: Circle

default.Circle

创建圆符号图层.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Circle(options: CircleOptions): Circle

# Parameters
Name Type
options CircleOptions

Returns: Circle

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: CircleOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getCircleBlur

▸ getCircleBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCircleColor

▸ getCircleColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getCircleOpacity

▸ getCircleOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCirclePitchAlignment

▸ getCirclePitchAlignment(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getCirclePitchScale

▸ getCirclePitchScale(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getCircleRadius

▸ getCircleRadius(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCircleSortKey

▸ getCircleSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCircleStrokeColor

▸ getCircleStrokeColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getCircleStrokeOpacity

▸ getCircleStrokeOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCircleStrokeWidth

▸ getCircleStrokeWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getCircleTranslate

▸ getCircleTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getCircleTranslateAnchor

▸ getCircleTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getVisibility

▸ getVisibility(): "visible" | "none"

Returns: "visible" | "none"

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setCircleBlur

▸ setCircleBlur(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCircleColor

▸ setCircleColor(value: DataDrivenPropertyValueSpecification<string>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Circle

# setCircleOpacity

▸ setCircleOpacity(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCirclePitchAlignment

▸ setCirclePitchAlignment(value: PropertyValueSpecificationEx<"map" | "viewport">): Circle

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Circle

# setCirclePitchScale

▸ setCirclePitchScale(value: PropertyValueSpecificationEx<"map" | "viewport">): Circle

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Circle

# setCircleRadius

▸ setCircleRadius(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCircleSortKey

▸ setCircleSortKey(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCircleStrokeColor

▸ setCircleStrokeColor(value: DataDrivenPropertyValueSpecification<string>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Circle

# setCircleStrokeOpacity

▸ setCircleStrokeOpacity(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCircleStrokeWidth

▸ setCircleStrokeWidth(value: DataDrivenPropertyValueSpecification<number>): Circle

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Circle

# setCircleTranslate

▸ setCircleTranslate(value: PropertyValueSpecificationEx<[number, number]>): Circle

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: Circle

# setCircleTranslateAnchor

▸ setCircleTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Circle

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Circle

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# setVisibility

▸ setVisibility(value: "visible" | "none"): Circle

# Parameters
Name Type
value "visible" | "none"

Returns: Circle

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / default / CircleEdge

# Class: CircleEdge

default.CircleEdge

创建只有边框的圆或圆弧

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new CircleEdge(options: CircleEdgeOptions): CircleEdge

# Parameters
Name Type
options CircleEdgeOptions

Returns: CircleEdge

Overrides: Polyline

# Properties

# _map

• Optional _map: Map

Inherited from: Polyline._map

# layerId

• Optional layerId: string

Inherited from: Polyline.layerId

# options

• options: PolylineOptions

Inherited from: Polyline.options

# sourceId

• Optional sourceId: string

Inherited from: Polyline.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: Polyline

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getCenter

▸ getCenter(): GeoPointLike

得到中心点。

Returns: GeoPointLike

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: Polyline

# getEndAngle

▸ getEndAngle(): number

得到结束角度。

Returns: number

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: Polyline

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: Polyline

# getLineBlur

▸ getLineBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineCap

▸ getLineCap(): DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Inherited from: Polyline

# getLineColor

▸ getLineColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polyline

# getLineDasharray

▸ getLineDasharray(): DataDrivenPropertyValueSpecification<number[]>

Returns: DataDrivenPropertyValueSpecification<number[]>

Inherited from: Polyline

# getLineGapWidth

▸ getLineGapWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineGradient

▸ getLineGradient(): ExpressionSpecificationEx

Returns: ExpressionSpecificationEx

Inherited from: Polyline

# getLineJoin

▸ getLineJoin(): DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Inherited from: Polyline

# getLineMiterMimit

▸ getLineMiterMimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

Inherited from: Polyline

# getLineOffset

▸ getLineOffset(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineOpacity

▸ getLineOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLinePattern

▸ getLinePattern(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polyline

# getLineRoundLimit

▸ getLineRoundLimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

Inherited from: Polyline

# getLineSortKey

▸ getLineSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineTranslate

▸ getLineTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

Inherited from: Polyline

# getLineTranslateAnchor

▸ getLineTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

Inherited from: Polyline

# getLineWidth

▸ getLineWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getPoints

▸ getPoints(): number

得到离散化的点的个数。

Returns: number

# getRadius

▸ getRadius(): number

得到半径。

Returns: number

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: Polyline

# getStartAngle

▸ getStartAngle(): number

得到开始角度。

Returns: number

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: Polyline

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: Polyline

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: Polyline

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: Polyline

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: Polyline

# setCenter

▸ setCenter(value: GeoPointLike, bFocusUpdateData?: boolean): CircleEdge

设置中心点。

# Parameters
Name Type Default value
value GeoPointLike -
bFocusUpdateData boolean true

Returns: CircleEdge

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

Inherited from: Polyline

# setEndAngle

▸ setEndAngle(value: number, bFocusUpdateData?: boolean): CircleEdge

设置结束角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleEdge

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: Polyline

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: Polyline

# setLineBlur

▸ setLineBlur(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineCap

▸ setLineCap(value: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: CircleEdge

Inherited from: Polyline

# setLineColor

▸ setLineColor(value: DataDrivenPropertyValueSpecification<string>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleEdge

Inherited from: Polyline

# setLineDasharray

▸ setLineDasharray(value: DataDrivenPropertyValueSpecification<number[]>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number[]>

Returns: CircleEdge

Inherited from: Polyline

# setLineGapWidth

▸ setLineGapWidth(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineGradient

▸ setLineGradient(value: ExpressionSpecificationEx): CircleEdge

# Parameters
Name Type
value ExpressionSpecificationEx

Returns: CircleEdge

Inherited from: Polyline

# setLineJoin

▸ setLineJoin(value: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: CircleEdge

Inherited from: Polyline

# setLineMiterMimit

▸ setLineMiterMimit(value: PropertyValueSpecificationEx<number>): CircleEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineOffset

▸ setLineOffset(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineOpacity

▸ setLineOpacity(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setLinePattern

▸ setLinePattern(value: DataDrivenPropertyValueSpecification<string>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleEdge

Inherited from: Polyline

# setLineRoundLimit

▸ setLineRoundLimit(value: PropertyValueSpecificationEx<number>): CircleEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineSortKey

▸ setLineSortKey(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setLineTranslate

▸ setLineTranslate(value: PropertyValueSpecificationEx<[number, number]>): CircleEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: CircleEdge

Inherited from: Polyline

# setLineTranslateAnchor

▸ setLineTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): CircleEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: CircleEdge

Inherited from: Polyline

# setLineWidth

▸ setLineWidth(value: DataDrivenPropertyValueSpecification<number>): CircleEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleEdge

Inherited from: Polyline

# setPoints

▸ setPoints(value: number, bFocusUpdateData?: boolean): CircleEdge

设置离散化的点的个数。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleEdge

# 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

# setRadius

▸ setRadius(value: number, bFocusUpdateData?: boolean): CircleEdge

设置半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleEdge

# setStartAngle

▸ setStartAngle(value: number, bFocusUpdateData?: boolean): CircleEdge

设置开始角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleEdge

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: Polyline

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: Polyline

# updateData

▸ updateData(): void

Returns: void

vjmap / Exports / default / CircleFill

# Class: CircleFill

default.CircleFill

创建填充的圆或圆弧

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new CircleFill(options: CircleFillOptions): CircleFill

# Parameters
Name Type
options CircleFillOptions

Returns: CircleFill

Overrides: Polygon

# Properties

# _map

• Optional _map: Map

Inherited from: Polygon._map

# layerId

• Optional layerId: string

Inherited from: Polygon.layerId

# options

• options: PolygonOptions

Inherited from: Polygon.options

# sourceId

• Optional sourceId: string

Inherited from: Polygon.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: Polygon

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getCenter

▸ getCenter(): GeoPointLike

得到中心点。

Returns: GeoPointLike

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: Polygon

# getEndAngle

▸ getEndAngle(): number

得到结束角度。

Returns: number

# getFillAntialias

▸ getFillAntialias(): PropertyValueSpecificationEx<boolean>

获取图层的“填充抗锯齿”绘制属性。

Returns: PropertyValueSpecificationEx<boolean>

Inherited from: Polygon

# getFillColor

▸ getFillColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillOpacity

▸ getFillOpacity(): DataDrivenPropertyValueSpecification<number>

获取图层的 fill-opacity 绘制属性。

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polygon

# getFillOutlineColor

▸ getFillOutlineColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-outline-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillPattern

▸ getFillPattern(): DataDrivenPropertyValueSpecification<string>

获取图层的fill-pattern 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillSortKey

▸ getFillSortKey(): DataDrivenPropertyValueSpecification<number>

获取图层的fill-sort-key 布局属性.

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polygon

# getFillTranslate

▸ getFillTranslate(): PropertyValueSpecificationEx<[number, number]>

获取图层的 fill-translate 绘制属性。

Returns: PropertyValueSpecificationEx<[number, number]>

Inherited from: Polygon

# getFillTranslateAnchor

▸ getFillTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

获取图层的 fill-translate-anchor 绘制属性。

Returns: PropertyValueSpecificationEx<"map" | "viewport">

Inherited from: Polygon

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: Polygon

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: Polygon

# getPoints

▸ getPoints(): number

得到离散化的点的个数。

Returns: number

# getRadius

▸ getRadius(): number

得到半径。

Returns: number

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: Polygon

# getStartAngle

▸ getStartAngle(): number

得到开始角度。

Returns: number

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: Polygon

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: Polygon

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: Polygon

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: Polygon

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: Polygon

# setCenter

▸ setCenter(value: GeoPointLike, bFocusUpdateData?: boolean): CircleFill

设置中心点。

# Parameters
Name Type Default value
value GeoPointLike -
bFocusUpdateData boolean true

Returns: CircleFill

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

Inherited from: Polygon

# setEndAngle

▸ setEndAngle(value: number, bFocusUpdateData?: boolean): CircleFill

设置结束角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleFill

# setFillAntialias

▸ setFillAntialias(value: PropertyValueSpecificationEx<boolean>): CircleFill

为一个或多个图层设置fill-antialias 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: CircleFill

Inherited from: Polygon

# setFillColor

▸ setFillColor(value: DataDrivenPropertyValueSpecification<string>): CircleFill

为一个或多个图层设置fill-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleFill

Inherited from: Polygon

# setFillOpacity

▸ setFillOpacity(value: DataDrivenPropertyValueSpecification<number>): CircleFill

为一个或多个图层设置fill-opacity 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleFill

Inherited from: Polygon

# setFillOutlineColor

▸ setFillOutlineColor(value: DataDrivenPropertyValueSpecification<string>): CircleFill

为一个或多个图层设置fill-outline-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleFill

Inherited from: Polygon

# setFillPattern

▸ setFillPattern(value: DataDrivenPropertyValueSpecification<string>): CircleFill

为一个或多个图层设置fill-pattern 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleFill

Inherited from: Polygon

# setFillSortKey

▸ setFillSortKey(value: DataDrivenPropertyValueSpecification<number>): CircleFill

为一层或多层设置fill-sort-key布局属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: CircleFill

Inherited from: Polygon

# setFillTranslate

▸ setFillTranslate(value: DataDrivenPropertyValueSpecification<string>): CircleFill

为一个或多个图层设置fill-translate 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: CircleFill

Inherited from: Polygon

# setFillTranslateAnchor

▸ setFillTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): CircleFill

为一个或多个图层设置fill-translate-anchor 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: CircleFill

Inherited from: Polygon

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: Polygon

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: Polygon

# setPoints

▸ setPoints(value: number, bFocusUpdateData?: boolean): CircleFill

设置离散化的点的个数。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleFill

# 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

# setRadius

▸ setRadius(value: number, bFocusUpdateData?: boolean): CircleFill

设置半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleFill

# setStartAngle

▸ setStartAngle(value: number, bFocusUpdateData?: boolean): CircleFill

设置开始角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: CircleFill

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: Polygon

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: Polygon

# updateData

▸ updateData(): void

Returns: void

vjmap / Exports / default / Compare

# Class: Compare

default.Compare

# Hierarchy

  • Evented

    ↳ Compare

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new Compare(a: Map, b: Map, container: string | Element, options?: { mousemove: boolean ; orientation: "vertical" | "horizontal" }): Compare

# Parameters
Name Type
a Map
b Map
container string | Element
options? object
options.mousemove boolean
options.orientation "vertical" | "horizontal"

Returns: Compare

Overrides: Evented.constructor

# Methods

# remove

▸ remove(): void

Returns: void

# setSlider

▸ setSlider(x: number): void

# Parameters
Name Type
x number

Returns: void

vjmap / Exports / default / ContextMenu

# Class: ContextMenu

default.ContextMenu

上下文菜单.

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new ContextMenu(opts: ContextMenuOptions): ContextMenu

Creates a new ContextMenu menu

# Parameters
Name Type Description
opts ContextMenuOptions options which build the menu e.g. position and items

Returns: ContextMenu

# 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 / Exports / default / Db2dPolyline

# Class: Db2dPolyline

default.Db2dPolyline

Db2dPolyline 二维多段线实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new Db2dPolyline(prop?: IDb2dPolyline): Db2dPolyline

构造函数

# Parameters
Name Type Default value
prop IDb2dPolyline {}

Returns: Db2dPolyline

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# elevation

• Optional elevation: number

高程.

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# points

• Optional points: [number, number, undefined | number][]

坐标.

# polyType

• Optional polyType: k2dSimplePoly | k2dFitCurvePoly | k2dQuadSplinePoly | k2dCubicSplinePoly

2d折线类型

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / default / Db2LineAngularDimension

# Class: Db2LineAngularDimension

default.Db2LineAngularDimension

Db2LineAngularDimension 角度标注[两条线]实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new Db2LineAngularDimension(prop?: IDb2LineAngularDimension): Db2LineAngularDimension

构造函数

# Parameters
Name Type Default value
prop IDb2LineAngularDimension {}

Returns: Db2LineAngularDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点位置.

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.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.xdata

vjmap / Exports / default / Db3dPolyline

# Class: Db3dPolyline

default.Db3dPolyline

Db3dPolyline 三维多段线实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new Db3dPolyline(prop?: IDb3dPolyline): Db3dPolyline

构造函数

# Parameters
Name Type Default value
prop IDb3dPolyline {}

Returns: Db3dPolyline

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# points

• Optional points: [number, number, undefined | number][]

坐标.

# polyType

• Optional polyType: k3dSimplePoly | k3dQuadSplinePoly | k3dCubicSplinePoly

3d折线类型

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / default / Db3PointAngularDimension

# Class: Db3PointAngularDimension

default.Db3PointAngularDimension

Db3PointAngularDimension 角度标注[三点]实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new Db3PointAngularDimension(prop?: IDb3PointAngularDimension): Db3PointAngularDimension

构造函数

# Parameters
Name Type Default value
prop IDb3PointAngularDimension {}

Returns: Db3PointAngularDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点位置.

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# centerPoint

• Optional centerPoint: [number, number, undefined | number][]

中点.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

点1.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

点2.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / default / DbAlignedDimension

# Class: DbAlignedDimension

default.DbAlignedDimension

DbAlignedDimension 对齐标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbAlignedDimension(prop?: IDbAlignedDimension): DbAlignedDimension

构造函数

# Parameters
Name Type Default value
prop IDbAlignedDimension {}

Returns: DbAlignedDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimLinePoint

• Optional dimLinePoint: [number, number, undefined | number][]

设置定义此dimension实体尺寸线位置的WCS点.

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# jogSymbolHeight

• Optional jogSymbolHeight: number

设置此实体的符号高度。.

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线1点.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线2点.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / default / DbArc

# Class: DbArc

default.DbArc

DbArc 圆弧实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbArc(prop?: IDbArc): DbArc

构造函数

# Parameters
Name Type Default value
prop IDbArc {}

Returns: DbArc

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# endAngle

• Optional endAngle: number

结束弧度.

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / default / DbArcDimension

# Class: DbArcDimension

default.DbArcDimension

DbArcDimension 圆弧标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbArcDimension(prop?: IDbArcDimension): DbArcDimension

构造函数

# Parameters
Name Type Default value
prop IDbArcDimension {}

Returns: DbArcDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点.

# arcSymbolType

• Optional arcSymbolType: number

文本中使用的弧符号的类型。 0 弧符号在文本前面; 1 弧线符号在文字上方; 2 没有符号.

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# centerPoint

• Optional centerPoint: [number, number, undefined | number][]

中心点.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线1点.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线2点.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / default / DbAttributeDefinition

# Class: DbAttributeDefinition

default.DbAttributeDefinition

DbText 属性定义实体.

# Hierarchy

  • DbText

    ↳ DbAttributeDefinition

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbAttributeDefinition(prop?: IDbText): DbAttributeDefinition

构造函数

# Parameters
Name Type Default value
prop IDbText {}

Returns: DbAttributeDefinition

Overrides: DbText

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbText.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbText.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbText.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbText.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbText.colorIndex

# contents

• Optional contents: string

文本内容， 同text.

Inherited from: DbText.contents

# height

• Optional height: number

高.

Inherited from: DbText.height

# horizontalMode

• Optional horizontalMode: kTextLeft | kTextCenter | kTextRight | kTextAlign | kTextMid | kTextFit

水平模式.

Inherited from: DbText.horizontalMode

# layer

• Optional layer: string

图层.

Inherited from: DbText.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbText.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbText.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbText.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbText.matrix

# position

• Optional position: [number, number, undefined | number]

位置.

Inherited from: DbText.position

# prompt

• Optional prompt: string

属性提示.

# rotation

• Optional rotation: number

旋转角度.

Inherited from: DbText.rotation

# tag

• Optional tag: string

属性名.

# text

• Optional text: string

文本内容， 同contents.

Inherited from: DbText.text

# textStyle

• Optional textStyle: string

文本样式.

Inherited from: DbText.textStyle

# typename

• Optional typename: string

类型.

Inherited from: DbText.typename

# verticalMode

• Optional verticalMode: kTextBase | kTextBottom | kTextVertMid | kTextTop

垂直模式.

Inherited from: DbText.verticalMode

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbText.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbText.xdata

vjmap / Exports / default / DbBlock

# Class: DbBlock

default.DbBlock

DbBlock 块定义.

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbBlock(prop?: IDbBlock): DbBlock

构造函数

# Parameters
Name Type Default value
prop IDbBlock {}

Returns: DbBlock

# Properties

# comments

• Optional comments: string

备注.

# entitys

• Optional entitys: IDbEntity[]

由哪些实体创建而成.

# explodable

• Optional explodable: boolean

是否可炸开.

# insertUnits

• Optional insertUnits: number

设置此块的块插入单位 .

# name

• Optional name: string

块名称.

# origin

• Optional origin: [number, number, undefined | number]

原点。 .

# scaling

• Optional scaling: number

设置此块的参照的缩放特征.

vjmap / Exports / default / DbBlockReference

# Class: DbBlockReference

default.DbBlockReference

DbBlockReference 块参照实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbBlockReference(prop?: IDbBlockReference): DbBlockReference

构造函数

# Parameters
Name Type Default value
prop IDbBlockReference {}

Returns: DbBlockReference

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# attribute

• Optional attribute: Record<string, string | number | DbText>

属性字段值

# blockname

• Optional blockname: string

块名称.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / default / DbCircle

# Class: DbCircle

default.DbCircle

DbCircle 圆实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbCircle(prop?: IDbCircle): DbCircle

构造函数

# Parameters
Name Type Default value
prop IDbCircle {}

Returns: DbCircle

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# normal

• Optional normal: [number, number, undefined | number]

法向量.

# radius

• Optional radius: number

半径.

# thickness

• Optional thickness: number

厚度.

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / default / DbCurve

# Class: DbCurve

default.DbCurve

DbCurve 曲线实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbCurve(prop?: IDbCurve): DbCurve

构造函数

# Parameters
Name Type Default value
prop IDbCurve {}

Returns: DbCurve

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.matrix

# typename

• Optional typename: string

类型.

Inherited from: DbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / default / DbDiametricDimension

# Class: DbDiametricDimension

default.DbDiametricDimension

DbDiametricDimension 直径标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbDiametricDimension(prop?: IDbDiametricDimension): DbDiametricDimension

构造函数

# Parameters
Name Type Default value
prop IDbDiametricDimension {}

Returns: DbDiametricDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# chordPoint

• Optional chordPoint: [number, number, undefined | number][]

圆上1点.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# farChordPoint

• Optional farChordPoint: [number, number, undefined | number][]

圆上2点.

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# leaderLength

• Optional leaderLength: number

引线长度.

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / default / DbDimension

# Class: DbDimension

default.DbDimension

DbDimension 标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbDimension(prop?: IDbDimension): DbDimension

构造函数

# Parameters
Name Type Default value
prop IDbDimension {}

Returns: DbDimension

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

# arrowSize

• Optional arrowSize: number

箭头大小.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

# dimScale

• Optional dimScale: number

注记比例.

# dimStyle

• Optional dimStyle: string

标注样式.

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineColor

• Optional lineColor: number

引线颜色.

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / default / DbDocument

# Class: DbDocument

default.DbDocument

DbDocument 地图数据库文档.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new DbDocument(prop?: IDbDocument): DbDocument

构造函数

# Parameters
Name Type Default value
prop IDbDocument {}

Returns: DbDocument

# Properties

# blocks

• Optional blocks: IDbBlock[]

块定义.

# dimStyles

• Optional dimStyles: IDbDimStyle[]

标注样式.

# entitys

• Optional entitys: IDbEntity[]

实体集.

# environment

• Optional environment: Record<string, any>

文档环境，用于设置是否显示线宽等设置, 设置线宽为 LWDISPLAY ,true显示或 false不显示线宽

# from

• Optional from: string

来源于哪个图，会在此图的上面进行修改或新增删除，格式如 形式为 mapid/version,如 exam/v1 .

# isClearFromDb

• Optional isClearFromDb: boolean

# isRenameBlockNameIfExist

• Optional isRenameBlockNameIfExist: boolean

来源于其他图的实体时，如果块定义重复，则自动重命名 ，默认true

# layers

• Optional layers: IDbLayer[]

图层集.

# linetypes

• Optional linetypes: IDbLinetype[]

线型.

# pickEntitys

• Optional pickEntitys: string[]

来源于哪个图时有效，表示从此图中选择指定的实体ID，不在指定的实体ID将不会显示

# pickExpr

• Optional pickExpr: string

来源于哪个图时有效，使用表达式，表示从此图中选择指定的实体ID，不在指定的实体ID将不会显示 结果与pickEntitys的取并

# pickLayers

• Optional pickLayers: string[]

来源于哪个图时有效，表示从此图中选择指定的图层，不在指定的图层将不会显示

# textStyles

• Optional textStyles: IDbTextStyle[]

文字样式.

# Methods

# appendBlock

▸ appendBlock(block: IDbBlock | IDbBlock[]): void

增加块

# Parameters
Name Type
block IDbBlock | IDbBlock[]

Returns: void

# appendDimStyle

▸ appendDimStyle(dimStyle: IDbDimStyle | IDbDimStyle[]): void

增加标注样式

# Parameters
Name Type
dimStyle IDbDimStyle | IDbDimStyle[]

Returns: void

# appendEntity

▸ appendEntity(entity: IDbEntity | IDbEntity[]): void

增加实体

# Parameters
Name Type
entity IDbEntity | IDbEntity[]

Returns: void

# appendLayer

▸ appendLayer(layer: IDbLayer | IDbLayer[]): void

增加图层

# Parameters
Name Type
layer IDbLayer | IDbLayer[]

Returns: void

# appendLinetype

▸ appendLinetype(linetype: IDbLinetype | IDbLinetype[]): void

增加线型

# Parameters
Name Type
linetype IDbLinetype | IDbLinetype[]

Returns: void

# appendTextStyle

▸ appendTextStyle(textStyle: IDbTextStyle | IDbTextStyle[]): void

增加样式样式

# Parameters
Name Type
textStyle IDbTextStyle | IDbTextStyle[]

Returns: void

# toDoc

▸ toDoc(content?: string): string

转成文档字符串

# Parameters
Name Type Description
content? string 如果传入了内容，则以content为主。json格式

Returns: string

vjmap / Exports / default / DbEllipse

# Class: DbEllipse

default.DbEllipse

DbEllipse 椭圆实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbEllipse(prop?: IDbEllipse): DbEllipse

构造函数

# Parameters
Name Type Default value
prop IDbEllipse {}

Returns: DbEllipse

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# endAngle

• Optional endAngle: number

结束弧度.

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# minorAxis

• Optional minorAxis: [number, number, undefined | number]

主轴方向.

# radiusRatio

• Optional radiusRatio: number

短轴和长轴的比例.

# startAngle

• Optional startAngle: number

开始弧度.

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / default / DbEntity

# Class: DbEntity

default.DbEntity

DbEntity 实体基类.

# Hierarchy

# Implements

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ Protected new DbEntity(prop?: IDbEntity): DbEntity

构造函数

# Parameters
Name Type Default value
prop IDbEntity {}

Returns: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Implementation of: IDbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

# color

• Optional color: number

颜色.

Implementation of: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Implementation of: IDbEntity.colorIndex

# layer

• Optional layer: string

图层.

Implementation of: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Implementation of: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Implementation of: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Implementation of: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Implementation of: IDbEntity.matrix

# typename

• Optional typename: string

类型.

Implementation of: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Implementation of: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Implementation of: IDbEntity.xdata

vjmap / Exports / default / DbHatch

# Class: DbHatch

default.DbHatch

DbHatch 图案实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbHatch(prop?: IDbHatch): DbHatch

构造函数

# Parameters
Name Type Default value
prop IDbHatch {}

Returns: DbHatch

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# elevation

• Optional elevation: number

高程.

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / default / DbLayer

# Class: DbLayer

default.DbLayer

DbLayer 图层.

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbLayer(prop?: IDbLayer): DbLayer

构造函数

# Parameters
Name Type Default value
prop IDbLayer {}

Returns: DbLayer

# 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 / Exports / default / DbLine

# Class: DbLine

default.DbLine

DbLine 线实体.

# Hierarchy

# Implements

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbLine(prop?: IDbLine): DbLine

构造函数

# Parameters
Name Type Default value
prop IDbLine {}

Returns: DbLine

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Implementation of: IDbLine.alpha

Inherited from: DbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Implementation of: IDbLine.color

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Implementation of: IDbLine.colorIndex

Inherited from: DbEntity.colorIndex

# end

• Optional end: [number, number, undefined | number]

终点.

Implementation of: IDbLine.end

# layer

• Optional layer: string

图层.

Implementation of: IDbLine.layer

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Implementation of: IDbLine.lineWidth

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Implementation of: IDbLine.linetype

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Implementation of: IDbLine.linetypeScale

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Implementation of: IDbLine.matrix

Inherited from: DbEntity.matrix

# start

• Optional start: [number, number, undefined | number]

起点.

Implementation of: IDbLine.start

# thickness

• Optional thickness: number

厚度.

Implementation of: IDbLine.thickness

# typename

• Optional typename: string

类型.

Implementation of: IDbLine.typename

Inherited from: DbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Implementation of: IDbLine.visibility

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Implementation of: IDbLine.xdata

Inherited from: DbEntity.xdata

vjmap / Exports / default / DbLineType

# Class: DbLineType

default.DbLineType

DbLineType 线型.

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbLineType(prop?: IDbLinetype): DbLineType

构造函数

# Parameters
Name Type Default value
prop IDbLinetype {}

Returns: DbLineType

# Properties

# comments

• Optional comments: string

评论.

# name

• Optional name: string

线型名称.

# style

• Optional style: IDbLinetypeStyle[]

线型样式 .

vjmap / Exports / default / DbMLeader

# Class: DbMLeader

default.DbMLeader

DbMLeader 多重引线.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbMLeader(prop?: IDbMText): DbMLeader

构造函数

# Parameters
Name Type Default value
prop IDbMText {}

Returns: DbMLeader

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.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.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.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.layer

# leaderLinePoint

• Optional leaderLinePoint: [number, number, undefined | number]

引线位置.

# leaderVertexPoints

• Optional leaderVertexPoints: [number, number, undefined | number][]

引线顶点位置数组.

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.matrix

# textAttachment

• Optional textAttachment: kTopLeft | kTopCenter | kTopRight | kMiddleLeft | kMiddleCenter | kMiddleRight | kBottomLeft | kBottomCenter | kBottomRight | kBaseLeft | kBaseCenter | kBaseRight | kBaseAlign | kBottomAlign | kMiddleAlign | kTopAlign | kBaseFit | kBottomFit | kMiddleFit | kTopFit | kBaseMid | kBottomMid | kMiddleMid | 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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / default / DbMText

# Class: DbMText

default.DbMText

DbMText 多行文本实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbMText(prop?: IDbMText): DbMText

构造函数

# Parameters
Name Type Default value
prop IDbMText {}

Returns: DbMText

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# attachment

• Optional attachment: kTopLeft | kTopCenter | kTopRight | kMiddleLeft | kMiddleCenter | kMiddleRight | kBottomLeft | kBottomCenter | kBottomRight | kBaseLeft | kBaseCenter | kBaseRight | kBaseAlign | kBottomAlign | kMiddleAlign | kTopAlign | kBaseFit | kBottomFit | kMiddleFit | kTopFit | kBaseMid | kBottomMid | kMiddleMid | kTopMid

对齐方式.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# contents

• Optional contents: string

文本内容.

# height

• Optional height: number

高.

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# location

• Optional location: [number, number, undefined | number]

位置.

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.matrix

# rotation

• Optional rotation: number

旋转角度.

# textHeight

• Optional textHeight: number

文本高.

# textStyle

• Optional textStyle: string

文本样式.

# typename

• Optional typename: string

类型.

Inherited from: DbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# width

• Optional width: number

宽.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / default / DbOrdinateDimension

# Class: DbOrdinateDimension

default.DbOrdinateDimension

DbOrdinateDimension 坐标标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbOrdinateDimension(prop?: IDbOrdinateDimension): DbOrdinateDimension

构造函数

# Parameters
Name Type Default value
prop IDbOrdinateDimension {}

Returns: DbOrdinateDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# definingPoint

• Optional definingPoint: [number, number, undefined | number][]

定义点.

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# leaderEndPoint

• Optional leaderEndPoint: [number, number, undefined | number][]

引线点.

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# origin

• Optional origin: [number, number, undefined | number][]

基点.

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# useXAxis

• Optional useXAxis: boolean

是否用X轴.

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / default / DbPolyline

# Class: DbPolyline

default.DbPolyline

DbPolyline 多段线实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbPolyline(prop?: IDbPolyline): DbPolyline

构造函数

# Parameters
Name Type Default value
prop IDbPolyline {}

Returns: DbPolyline

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# bulge

• Optional bulge: number[]

凸度.

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.colorIndex

# elevation

• Optional elevation: number

高程.

# endWidth

• Optional endWidth: number[]

终点宽.

# layer

• Optional layer: string

图层.

Inherited from: DbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# points

• Optional points: [number, number, undefined | number][]

坐标.

# startWidth

• Optional startWidth: number[]

起点宽.

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / default / DbRadialDimension

# Class: DbRadialDimension

default.DbRadialDimension

DbRadialDimension 半径标注实体

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbRadialDimension(prop?: IDbRadialDimension): DbRadialDimension

构造函数

# Parameters
Name Type Default value
prop IDbRadialDimension {}

Returns: DbRadialDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.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.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# leaderLength

• Optional leaderLength: number

引线长度.

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / default / DbRadialDimensionLarge

# Class: DbRadialDimensionLarge

default.DbRadialDimensionLarge

DbRadialDimensionLarge 半径折线标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbRadialDimensionLarge(prop?: IDbRadialDimensionLarge): DbRadialDimensionLarge

构造函数

# Parameters
Name Type Default value
prop IDbRadialDimensionLarge {}

Returns: DbRadialDimensionLarge

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.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.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# jogAngle

• Optional jogAngle: number

设置此Dimension实体的折角。.

# jogPoint

• Optional jogPoint: [number, number, undefined | number][]

设置此Dimension实体的折角点。.

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# overrideCenter

• Optional overrideCenter: [number, number, undefined | number][]

设置由该Dimension实体确定尺寸的弧的WCS覆盖中心。.

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / default / DbRasterImage

# Class: DbRasterImage

default.DbRasterImage

DbRasterImage 栅格图像实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbRasterImage(prop?: IDbRasterImage): DbRasterImage

构造函数

# Parameters
Name Type Default value
prop IDbRasterImage {}

Returns: DbRasterImage

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# brightness

• Optional brightness: number

明亮度 [0.0 .. 100.0]

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.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.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# units

• Optional units: kNone | kMillimeter | kCentimeter | kMeter | kKilometer | kInch | kFoot | kYard | kMile | kMicroinches | kMils | kAngstroms | kNanometers | kMicrons | kDecimeters | kDekameters | kHectometers | kGigameters | kAstronomical | kLightYears | kParsecs

单位.

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# widthRatio

• Optional widthRatio: number

宽比例.

# xPelsPerUnit

• Optional xPelsPerUnit: number

x轴每像素代表长度.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

# yPelsPerUnit

• Optional yPelsPerUnit: number

y轴每像素代表长度.

vjmap / Exports / default / DbRotatedDimension

# Class: DbRotatedDimension

default.DbRotatedDimension

DbRotatedDimension 转角标注实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbRotatedDimension(prop?: IDbRotatedDimension): DbRotatedDimension

构造函数

# Parameters
Name Type Default value
prop IDbRotatedDimension {}

Returns: DbRotatedDimension

Overrides: DbDimension

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbDimension.alpha

# arrowColor

• Optional arrowColor: number

箭头颜色.

Inherited from: DbDimension.arrowColor

# arrowSize

• Optional arrowSize: number

箭头大小.

Inherited from: DbDimension.arrowSize

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbDimension.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbDimension.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbDimension.colorIndex

# dimDec

• Optional dimDec: number

设置标注主单位显示的小数位位数.

Inherited from: DbDimension.dimDec

# dimLinePoint

• Optional dimLinePoint: [number, number, undefined | number][]

设置定义此dimension实体尺寸线位置的WCS点。.

# dimRnd

• Optional dimRnd: number

所有标注距离舍入到指定值.

Inherited from: DbDimension.dimRnd

# dimScale

• Optional dimScale: number

注记比例.

Inherited from: DbDimension.dimScale

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: DbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: DbDimension.layer

# lineColor

• Optional lineColor: number

引线颜色.

Inherited from: DbDimension.lineColor

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbDimension.matrix

# textColor

• Optional textColor: number

文本颜色.

Inherited from: DbDimension.textColor

# textHeight

• Optional textHeight: number

文字高度.

Inherited from: DbDimension.textHeight

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: DbDimension.textPosition

# textRotation

• Optional textRotation: number

文字旋转角度.

Inherited from: DbDimension.textRotation

# typename

• Optional typename: string

类型.

Inherited from: DbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线上点1.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线上点2.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbDimension.xdata

vjmap / Exports / default / DbShape

# Class: DbShape

default.DbShape

DbShape 型实体

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbShape(prop?: IDbShape): DbShape

构造函数

# Parameters
Name Type Default value
prop IDbShape {}

Returns: DbShape

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / default / DbSpline

# Class: DbSpline

default.DbSpline

DbSpline 样条曲线实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbSpline(prop?: IDbSpline): DbSpline

构造函数

# Parameters
Name Type Default value
prop IDbSpline {}

Returns: DbSpline

Overrides: DbCurve

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbCurve.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbCurve.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbCurve.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbCurve.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.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbCurve.matrix

# typename

• Optional typename: string

类型.

Inherited from: DbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbCurve.xdata

vjmap / Exports / default / DbTable

# Class: DbTable

default.DbTable

DbBlockReference 块参照实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbTable(prop?: IDbTable): DbTable

构造函数

# Parameters
Name Type Default value
prop IDbTable {}

Returns: DbTable

Overrides: DbBlockReference

# Properties

# alignment

• Optional alignment: kTopLeft | kTopCenter | kTopRight | kMiddleLeft | kMiddleCenter | kMiddleRight | kBottomLeft | kBottomCenter | kBottomRight

单元格对齐方式(所有单元格).

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbBlockReference.alpha

# attribute

• Optional attribute: Record<string, string | number | DbText>

属性字段值

Inherited from: DbBlockReference.attribute

# backgroundColor

• Optional backgroundColor: number

背景颜色(所有单元格).

# blockname

• Optional blockname: string

块名称.

Inherited from: DbBlockReference.blockname

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbBlockReference.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbBlockReference.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbBlockReference.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbBlockReference.colorIndex

# columnWidth

• Optional columnWidth: number

列宽.

# contentColor

• Optional contentColor: number

文字颜色(所有单元格).

# data

• Optional data: (string | { alignment: TableCellAlignment ; 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.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbBlockReference.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbBlockReference.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbBlockReference.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbBlockReference.matrix

# mergeCells

• Optional mergeCells: [number, number, number, number][]

需要合并的单元格 [[minRow, maxRow,minColumn, maxColumn], ...]

# normal

• Optional normal: [number, number, undefined | number]

法向量.

Inherited from: DbBlockReference.normal

# numColumns

• Optional numColumns: number

表格列数.

# numRows

• Optional numRows: number

表格行数.

# position

• Optional position: [number, number, undefined | number]

坐标.

Inherited from: DbBlockReference.position

# ref

• Optional ref: string

参考外部图形，形式为 mapid/version,如 exam/v1.

Inherited from: DbBlockReference.ref

# rotation

• Optional rotation: number

旋转角度.

Inherited from: DbBlockReference.rotation

# rowHeight

• Optional rowHeight: number

行高.

# scaleFactors

• Optional scaleFactors: [number, number, undefined | number]

缩放因子. [x方向，y方向,z方向]

Inherited from: DbBlockReference.scaleFactors

# tableStyleName

• Optional tableStyleName: string

表样式名称.

# textHeight

• Optional textHeight: number

文字高度(所有单元格).

# typename

• Optional typename: string

类型.

Inherited from: DbBlockReference.typename

# vertCellMargin

• Optional vertCellMargin: number

竖直方向单元格边距.

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbBlockReference.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbBlockReference.xdata

vjmap / Exports / default / DbText

# Class: DbText

default.DbText

DbText 文本实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbText(prop?: IDbText): DbText

构造函数

# Parameters
Name Type Default value
prop IDbText {}

Returns: DbText

Overrides: DbEntity

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbEntity.alpha

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbEntity.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbEntity.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbEntity.colorIndex

# contents

• Optional contents: string

文本内容， 同text.

# height

• Optional height: number

高.

# horizontalMode

• Optional horizontalMode: kTextLeft | kTextCenter | kTextRight | kTextAlign | kTextMid | kTextFit

水平模式.

# layer

• Optional layer: string

图层.

Inherited from: DbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbEntity.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.typename

# verticalMode

• Optional verticalMode: kTextBase | kTextBottom | kTextVertMid | kTextTop

垂直模式.

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbEntity.xdata

vjmap / Exports / default / DbTextStyle

# Class: DbTextStyle

default.DbTextStyle

DbTextStyle 文字样式.

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbTextStyle(prop?: IDbTextStyle): DbTextStyle

构造函数

# Parameters
Name Type Default value
prop IDbTextStyle {}

Returns: DbTextStyle

# 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 / Exports / default / DbWipeout

# Class: DbWipeout

default.DbWipeout

DbWipeout 遮罩实体.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DbWipeout(prop?: IDbWipeout): DbWipeout

构造函数

# Parameters
Name Type Default value
prop IDbWipeout {}

Returns: DbWipeout

Overrides: DbRasterImage

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: DbRasterImage.alpha

# brightness

• Optional brightness: number

明亮度 [0.0 .. 100.0]

Inherited from: DbRasterImage.brightness

# cloneFromDb

• Optional cloneFromDb: string

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: DbRasterImage.cloneFromDb

# cloneObjectId

• Optional cloneObjectId: string

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: DbRasterImage.cloneObjectId

# color

• Optional color: number

颜色.

Inherited from: DbRasterImage.color

# colorIndex

• Optional colorIndex: number

颜色索引. 0 随块. 1 Red. 2 Yellow. 3 Green. 4 Cyan. 5 Blue. 6 Magenta. 256 表示随层

Inherited from: DbRasterImage.colorIndex

# heightRatio

• Optional heightRatio: number

高比例..

Inherited from: DbRasterImage.heightRatio

# imageDisplayOptClip

• Optional imageDisplayOptClip: boolean

是否裁剪.

Inherited from: DbRasterImage.imageDisplayOptClip

# imageDisplayOptShow

• Optional imageDisplayOptShow: boolean

是否显示.

Inherited from: DbRasterImage.imageDisplayOptShow

# imageDisplayOptShowUnAligned

• Optional imageDisplayOptShowUnAligned: boolean

是否对齐.

Inherited from: DbRasterImage.imageDisplayOptShowUnAligned

# imageDisplayOptTransparent

• Optional imageDisplayOptTransparent: boolean

是否透明.

Inherited from: DbRasterImage.imageDisplayOptTransparent

# layer

• Optional layer: string

图层.

Inherited from: DbRasterImage.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: DbRasterImage.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: DbRasterImage.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: DbRasterImage.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: DbRasterImage.matrix

# pixelHeight

• Optional pixelHeight: number

源图片高.

Inherited from: DbRasterImage.pixelHeight

# pixelWidth

• Optional pixelWidth: number

源图片宽.

Inherited from: DbRasterImage.pixelWidth

# points

• Optional points: [number, number, undefined | number][]

坐标.

# position

• Optional position: [number, number, undefined | number]

位置.

Inherited from: DbRasterImage.position

# sourceHttpUrl

• Optional sourceHttpUrl: string

图片url地址.

Inherited from: DbRasterImage.sourceHttpUrl

# typename

• Optional typename: string

类型.

Inherited from: DbRasterImage.typename

# units

• Optional units: kNone | kMillimeter | kCentimeter | kMeter | kKilometer | kInch | kFoot | kYard | kMile | kMicroinches | kMils | kAngstroms | kNanometers | kMicrons | kDecimeters | kDekameters | kHectometers | kGigameters | kAstronomical | kLightYears | kParsecs

单位.

Inherited from: DbRasterImage.units

# visibility

• Optional visibility: boolean

可见.

Inherited from: DbRasterImage.visibility

# widthRatio

• Optional widthRatio: number

宽比例.

Inherited from: DbRasterImage.widthRatio

# xPelsPerUnit

• Optional xPelsPerUnit: number

x轴每像素代表长度.

Inherited from: DbRasterImage.xPelsPerUnit

# xdata

• Optional xdata: string

扩展数据.

Inherited from: DbRasterImage.xdata

# yPelsPerUnit

• Optional yPelsPerUnit: number

y轴每像素代表长度.

Inherited from: DbRasterImage.yPelsPerUnit

vjmap / Exports / default / DeckLayer

# Class: DeckLayer

default.DeckLayer

deck.gl图层.

# Hierarchy

  • Evented

    ↳ DeckLayer

# Implements

  • CustomLayerInterface

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new DeckLayer(props: any): DeckLayer

# Parameters
Name Type
props any

Returns: DeckLayer

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 / Exports / default / DiffusedApertureMarker

# Class: DiffusedApertureMarker

default.DiffusedApertureMarker

扩散的点.

# Hierarchy

  • MarkerBase

    ↳ DiffusedApertureMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new DiffusedApertureMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): DiffusedApertureMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: DiffusedApertureMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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

# setFeatures

▸ setFeatures(features: FeatureCollection<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

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 / Exports / default / DivOverlay

# Class: DivOverlay

default.DivOverlay

在一个地理范围内创建一个随缩放而缩放的div的覆盖物 注：如果是svg，则需设置为 viewBox="0 0 width height" preserveAspectRatio="xMinYMin meet", updateDivSize选项设置为true

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new DivOverlay(options: DivOverlayOptions): DivOverlay

# Parameters
Name Type
options DivOverlayOptions

Returns: DivOverlay

# Properties

# _map

• Optional _map: Map

# isRemoved

• isRemoved: boolean

# isShow

• isShow: boolean

# maxPitch

• maxPitch: number

# maxZoom

• maxZoom: number

# minZoom

• minZoom: number

# options

• options: DivOverlayOptions

# parentContainer

• Optional parentContainer: HTMLElement

# Methods

# addTo

▸ addTo(map: Map, insertId?: string | HTMLElement): void

# Parameters
Name Type
map Map
insertId? string | HTMLElement

Returns: void

# remove

▸ remove(): void

Returns: void

# setVisible

▸ setVisible(visible?: boolean, isDisplay?: boolean): void

设置是否显示隐藏

# Parameters
Name Type Description
visible? boolean 是否显示
isDisplay? boolean true的话，表示用style的display去控制隐藏显示，dom还在文档中。false的话，会从文档动态清空增加

Returns: void

# updateBounds

▸ updateBounds(bounds: GeoBounds | [GeoPointLike, GeoPointLike, GeoPointLike, GeoPointLike]): void

# Parameters
Name Type
bounds GeoBounds | [GeoPointLike, GeoPointLike, GeoPointLike, GeoPointLike]

Returns: void

# updateSize

▸ updateSize(width: number, height: number): void

# Parameters
Name Type
width number
height number

Returns: void

vjmap / Exports / default / DrawTool

# Class: DrawTool

default.DrawTool

# Implements

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DrawTool(options?: IDrawOptions): DrawTool

构造函数

# Parameters
Name Type
options? IDrawOptions

Returns: DrawTool

# Properties

# add

• add: (geojson: any) => string[]

此方法采用 GeoJSON Feature、FeatureCollection 或 Geometry 并将其添加到 Draw。它返回一个 id 数组，用于与添加的功能进行交互。如果某个功能没有自己的 id，则会自动生成一个

# Type declaration

▸ (geojson: any): string[]

# Parameters
Name Type
geojson any

Returns: string[]

Implementation of: IDrawTool.add

# changeMode

• changeMode: (mode: string, modeOptions?: any) => IDrawTool

将绘图更改为另一种模式。返回用于链接的绘制实例

# Type declaration

▸ (mode: string, modeOptions?: any): IDrawTool

# Parameters
Name Type
mode string
modeOptions? any

Returns: IDrawTool

Implementation of: IDrawTool.changeMode

# combineFeatures

• combineFeatures: () => IDrawTool

调用当前模式的combineFeatures操作。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

Implementation of: IDrawTool.combineFeatures

# delete

• delete: (featureIds: string | string[]) => IDrawTool

删除具有指定 ID 的功能。返回用于链接的绘制实例

# Type declaration

▸ (featureIds: string | string[]): IDrawTool

# Parameters
Name Type
featureIds string | string[]

Returns: IDrawTool

Implementation of: IDrawTool.delete

# deleteAll

• deleteAll: () => IDrawTool

删除所有功能。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

Implementation of: IDrawTool.deleteAll

# doAction

• doAction: (actionName: string) => any

在当前模式下执行动作

# Type declaration

▸ (actionName: string): any

# Parameters
Name Type
actionName string

Returns: any

Implementation of: IDrawTool.doAction

# forceRefresh

• forceRefresh: () => any

强制刷新

# Type declaration

▸ (): any

Returns: any

Implementation of: IDrawTool.forceRefresh

# get

• get: (id: string) => any

返回 Draw 中具有指定 id 的 GeoJSON 功能，或者undefined如果 id 不匹配任何功能

# Type declaration

▸ (id: string): any

# Parameters
Name Type
id string

Returns: any

Implementation of: IDrawTool.get

# getAll

• getAll: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回所有功能的 FeatureCollection

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

Implementation of: IDrawTool.getAll

# getFeatureIdsAt

• getFeatureIdsAt: (point: { x: number ; y: number }) => string[]

返回当前在指定点呈现的功能的功能 ID 数组。

# Type declaration

▸ (point: { x: number ; y: number }): string[]

# Parameters
Name Type
point object
point.x number
point.y number

Returns: string[]

Implementation of: IDrawTool.getFeatureIdsAt

# getMode

• getMode: () => string

返回 Draw 的当前模式

# Type declaration

▸ (): string

Returns: string

Implementation of: IDrawTool.getMode

# getSelected

• getSelected: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回当前选择的所有功能的 FeatureCollection

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

Implementation of: IDrawTool.getSelected

# getSelectedIds

• getSelectedIds: () => string[]

返回当前所选功能的功能 ID 数组

# Type declaration

▸ (): string[]

Returns: string[]

Implementation of: IDrawTool.getSelectedIds

# getSelectedPoints

• getSelectedPoints: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回代表当前选择的所有顶点的 FeatureCollection 点

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

Implementation of: IDrawTool.getSelectedPoints

# modes

• modes: Record<string, any>

内部变量模式值

Implementation of: IDrawTool.modes

# onAdd

• onAdd: (map: any) => any

增加时回调接口

# Type declaration

▸ (map: any): any

# Parameters
Name Type
map any

Returns: any

Implementation of: IDrawTool.onAdd

# onRemove

• onRemove: () => any

移除时回调接口

# Type declaration

▸ (): any

Returns: any

Implementation of: IDrawTool.onRemove

# options

• options: Record<string, any>

内部变量选项值

Implementation of: IDrawTool.options

# redo

• redo: () => any

# Type declaration

▸ (): any

Returns: any

Implementation of: IDrawTool.redo

# set

• set: (featureCollection: FeatureCollection<Geometry | GeometryCollection, Properties>) => string[]

将 Draw 的功能设置为指定的 FeatureCollection

# Type declaration

▸ (featureCollection: FeatureCollection<Geometry | GeometryCollection, Properties>): string[]

# Parameters
Name Type
featureCollection FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: string[]

Implementation of: IDrawTool.set

# setFeatureProperty

• setFeatureProperty: (featureId: string, property: string, value: any) => IDrawTool

设置具有指定 id 的要素的属性值。返回用于链接的绘制实例

# Type declaration

▸ (featureId: string, property: string, value: any): IDrawTool

# Parameters
Name Type
featureId string
property string
value any

Returns: IDrawTool

Implementation of: IDrawTool.setFeatureProperty

# trash

• trash: () => IDrawTool

调用当前模式的删除trash操作。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

Implementation of: IDrawTool.trash

# uncombineFeatures

• uncombineFeatures: () => IDrawTool

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

Implementation of: IDrawTool.uncombineFeatures

# undo

• undo: () => any

# Type declaration

▸ (): any

Returns: any

Implementation of: IDrawTool.undo

vjmap / Exports / default / EllipseEdge

# Class: EllipseEdge

default.EllipseEdge

创建只有边框的椭圆或椭圆弧

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new EllipseEdge(options: EllipseEdgeOptions): EllipseEdge

# Parameters
Name Type
options EllipseEdgeOptions

Returns: EllipseEdge

Overrides: Polyline

# Properties

# _map

• Optional _map: Map

Inherited from: Polyline._map

# layerId

• Optional layerId: string

Inherited from: Polyline.layerId

# options

• options: PolylineOptions

Inherited from: Polyline.options

# sourceId

• Optional sourceId: string

Inherited from: Polyline.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: Polyline

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getCenter

▸ getCenter(): GeoPointLike

得到中心点。

Returns: GeoPointLike

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: Polyline

# getEndAngle

▸ getEndAngle(): number

得到结束角度。

Returns: number

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: Polyline

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: Polyline

# getLineBlur

▸ getLineBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineCap

▸ getLineCap(): DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Inherited from: Polyline

# getLineColor

▸ getLineColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polyline

# getLineDasharray

▸ getLineDasharray(): DataDrivenPropertyValueSpecification<number[]>

Returns: DataDrivenPropertyValueSpecification<number[]>

Inherited from: Polyline

# getLineGapWidth

▸ getLineGapWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineGradient

▸ getLineGradient(): ExpressionSpecificationEx

Returns: ExpressionSpecificationEx

Inherited from: Polyline

# getLineJoin

▸ getLineJoin(): DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Inherited from: Polyline

# getLineMiterMimit

▸ getLineMiterMimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

Inherited from: Polyline

# getLineOffset

▸ getLineOffset(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineOpacity

▸ getLineOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLinePattern

▸ getLinePattern(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polyline

# getLineRoundLimit

▸ getLineRoundLimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

Inherited from: Polyline

# getLineSortKey

▸ getLineSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineTranslate

▸ getLineTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

Inherited from: Polyline

# getLineTranslateAnchor

▸ getLineTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

Inherited from: Polyline

# getLineWidth

▸ getLineWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getMajorAxisRadius

▸ getMajorAxisRadius(): number

得到长轴半径。

Returns: number

# getMinorAxisRadius

▸ getMinorAxisRadius(): number

得到短轴半径。

Returns: number

# getPoints

▸ getPoints(): number

得到离散化的点的个数。

Returns: number

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: Polyline

# getStartAngle

▸ getStartAngle(): number

得到开始角度。

Returns: number

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: Polyline

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: Polyline

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: Polyline

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: Polyline

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: Polyline

# setCenter

▸ setCenter(value: GeoPointLike, bFocusUpdateData?: boolean): EllipseEdge

设置中心点。

# Parameters
Name Type Default value
value GeoPointLike -
bFocusUpdateData boolean true

Returns: EllipseEdge

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

Inherited from: Polyline

# setEndAngle

▸ setEndAngle(value: number, bFocusUpdateData?: boolean): EllipseEdge

设置结束角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseEdge

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: Polyline

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: Polyline

# setLineBlur

▸ setLineBlur(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineCap

▸ setLineCap(value: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: EllipseEdge

Inherited from: Polyline

# setLineColor

▸ setLineColor(value: DataDrivenPropertyValueSpecification<string>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseEdge

Inherited from: Polyline

# setLineDasharray

▸ setLineDasharray(value: DataDrivenPropertyValueSpecification<number[]>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number[]>

Returns: EllipseEdge

Inherited from: Polyline

# setLineGapWidth

▸ setLineGapWidth(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineGradient

▸ setLineGradient(value: ExpressionSpecificationEx): EllipseEdge

# Parameters
Name Type
value ExpressionSpecificationEx

Returns: EllipseEdge

Inherited from: Polyline

# setLineJoin

▸ setLineJoin(value: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: EllipseEdge

Inherited from: Polyline

# setLineMiterMimit

▸ setLineMiterMimit(value: PropertyValueSpecificationEx<number>): EllipseEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineOffset

▸ setLineOffset(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineOpacity

▸ setLineOpacity(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLinePattern

▸ setLinePattern(value: DataDrivenPropertyValueSpecification<string>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseEdge

Inherited from: Polyline

# setLineRoundLimit

▸ setLineRoundLimit(value: PropertyValueSpecificationEx<number>): EllipseEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineSortKey

▸ setLineSortKey(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineTranslate

▸ setLineTranslate(value: PropertyValueSpecificationEx<[number, number]>): EllipseEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: EllipseEdge

Inherited from: Polyline

# setLineTranslateAnchor

▸ setLineTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): EllipseEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: EllipseEdge

Inherited from: Polyline

# setLineWidth

▸ setLineWidth(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setMajorAxisRadius

▸ setMajorAxisRadius(value: number, bFocusUpdateData?: boolean): EllipseEdge

设置长轴半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseEdge

# setMinorAxisRadius

▸ setMinorAxisRadius(value: number, bFocusUpdateData?: boolean): EllipseEdge

设置短轴半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseEdge

# setPoints

▸ setPoints(value: number, bFocusUpdateData?: boolean): EllipseEdge

设置离散化的点的个数。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseEdge

# 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

# setStartAngle

▸ setStartAngle(value: number, bFocusUpdateData?: boolean): EllipseEdge

设置开始角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseEdge

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: Polyline

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: Polyline

# updateData

▸ updateData(): void

Returns: void

vjmap / Exports / default / EllipseFill

# Class: EllipseFill

default.EllipseFill

创建填充的的椭圆或椭圆弧

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new EllipseFill(options: EllipseFillOptions): EllipseFill

# Parameters
Name Type
options EllipseFillOptions

Returns: EllipseFill

Overrides: Polygon

# Properties

# _map

• Optional _map: Map

Inherited from: Polygon._map

# layerId

• Optional layerId: string

Inherited from: Polygon.layerId

# options

• options: PolygonOptions

Inherited from: Polygon.options

# sourceId

• Optional sourceId: string

Inherited from: Polygon.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: Polygon

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getCenter

▸ getCenter(): GeoPointLike

得到中心点。

Returns: GeoPointLike

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: Polygon

# getEndAngle

▸ getEndAngle(): number

得到结束角度。

Returns: number

# getFillAntialias

▸ getFillAntialias(): PropertyValueSpecificationEx<boolean>

获取图层的“填充抗锯齿”绘制属性。

Returns: PropertyValueSpecificationEx<boolean>

Inherited from: Polygon

# getFillColor

▸ getFillColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillOpacity

▸ getFillOpacity(): DataDrivenPropertyValueSpecification<number>

获取图层的 fill-opacity 绘制属性。

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polygon

# getFillOutlineColor

▸ getFillOutlineColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-outline-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillPattern

▸ getFillPattern(): DataDrivenPropertyValueSpecification<string>

获取图层的fill-pattern 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillSortKey

▸ getFillSortKey(): DataDrivenPropertyValueSpecification<number>

获取图层的fill-sort-key 布局属性.

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polygon

# getFillTranslate

▸ getFillTranslate(): PropertyValueSpecificationEx<[number, number]>

获取图层的 fill-translate 绘制属性。

Returns: PropertyValueSpecificationEx<[number, number]>

Inherited from: Polygon

# getFillTranslateAnchor

▸ getFillTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

获取图层的 fill-translate-anchor 绘制属性。

Returns: PropertyValueSpecificationEx<"map" | "viewport">

Inherited from: Polygon

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: Polygon

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: Polygon

# getMajorAxisRadius

▸ getMajorAxisRadius(): number

得到长轴半径。

Returns: number

# getMinorAxisRadius

▸ getMinorAxisRadius(): number

得到短轴半径。

Returns: number

# getPoints

▸ getPoints(): number

得到离散化的点的个数。

Returns: number

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: Polygon

# getStartAngle

▸ getStartAngle(): number

得到开始角度。

Returns: number

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: Polygon

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: Polygon

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: Polygon

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: Polygon

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: Polygon

# setCenter

▸ setCenter(value: GeoPointLike, bFocusUpdateData?: boolean): EllipseFill

设置中心点。

# Parameters
Name Type Default value
value GeoPointLike -
bFocusUpdateData boolean true

Returns: EllipseFill

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

Inherited from: Polygon

# setEndAngle

▸ setEndAngle(value: number, bFocusUpdateData?: boolean): EllipseFill

设置结束角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseFill

# setFillAntialias

▸ setFillAntialias(value: PropertyValueSpecificationEx<boolean>): EllipseFill

为一个或多个图层设置fill-antialias 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: EllipseFill

Inherited from: Polygon

# setFillColor

▸ setFillColor(value: DataDrivenPropertyValueSpecification<string>): EllipseFill

为一个或多个图层设置fill-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseFill

Inherited from: Polygon

# setFillOpacity

▸ setFillOpacity(value: DataDrivenPropertyValueSpecification<number>): EllipseFill

为一个或多个图层设置fill-opacity 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseFill

Inherited from: Polygon

# setFillOutlineColor

▸ setFillOutlineColor(value: DataDrivenPropertyValueSpecification<string>): EllipseFill

为一个或多个图层设置fill-outline-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseFill

Inherited from: Polygon

# setFillPattern

▸ setFillPattern(value: DataDrivenPropertyValueSpecification<string>): EllipseFill

为一个或多个图层设置fill-pattern 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseFill

Inherited from: Polygon

# setFillSortKey

▸ setFillSortKey(value: DataDrivenPropertyValueSpecification<number>): EllipseFill

为一层或多层设置fill-sort-key布局属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseFill

Inherited from: Polygon

# setFillTranslate

▸ setFillTranslate(value: DataDrivenPropertyValueSpecification<string>): EllipseFill

为一个或多个图层设置fill-translate 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseFill

Inherited from: Polygon

# setFillTranslateAnchor

▸ setFillTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): EllipseFill

为一个或多个图层设置fill-translate-anchor 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: EllipseFill

Inherited from: Polygon

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: Polygon

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: Polygon

# setMajorAxisRadius

▸ setMajorAxisRadius(value: number, bFocusUpdateData?: boolean): EllipseFill

设置长轴半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseFill

# setMinorAxisRadius

▸ setMinorAxisRadius(value: number, bFocusUpdateData?: boolean): EllipseFill

设置短轴半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseFill

# setPoints

▸ setPoints(value: number, bFocusUpdateData?: boolean): EllipseFill

设置离散化的点的个数。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseFill

# 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

# setStartAngle

▸ setStartAngle(value: number, bFocusUpdateData?: boolean): EllipseFill

设置开始角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseFill

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: Polygon

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: Polygon

# updateData

▸ updateData(): void

Returns: void

vjmap / Exports / default / FillExtrusion

# Class: FillExtrusion

default.FillExtrusion

创建拉伸的多边形.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new FillExtrusion(options: FillExtrusionOptions): FillExtrusion

# Parameters
Name Type
options FillExtrusionOptions

Returns: FillExtrusion

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: FillExtrusionOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getFillExtrusionBase

▸ getFillExtrusionBase(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getFillExtrusionColor

▸ getFillExtrusionColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getFillExtrusionHeight

▸ getFillExtrusionHeight(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getFillExtrusionOpacity

▸ getFillExtrusionOpacity(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getFillExtrusionPattern

▸ getFillExtrusionPattern(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getFillExtrusionTranslate

▸ getFillExtrusionTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getFillExtrusionTranslateAnchor

▸ getFillExtrusionTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getFillExtrusionVerticalGradient

▸ getFillExtrusionVerticalGradient(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFillExtrusionBase

▸ setFillExtrusionBase(value: DataDrivenPropertyValueSpecification<number>): FillExtrusion

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: FillExtrusion

# setFillExtrusionColor

▸ setFillExtrusionColor(value: DataDrivenPropertyValueSpecification<string>): FillExtrusion

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: FillExtrusion

# setFillExtrusionHeight

▸ setFillExtrusionHeight(value: DataDrivenPropertyValueSpecification<number>): FillExtrusion

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: FillExtrusion

# setFillExtrusionOpacity

▸ setFillExtrusionOpacity(value: PropertyValueSpecificationEx<number>): FillExtrusion

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: FillExtrusion

# setFillExtrusionPattern

▸ setFillExtrusionPattern(value: DataDrivenPropertyValueSpecification<string>): FillExtrusion

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: FillExtrusion

# setFillExtrusionTranslate

▸ setFillExtrusionTranslate(value: PropertyValueSpecificationEx<[number, number]>): FillExtrusion

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: FillExtrusion

# setFillExtrusionTranslateAnchor

▸ setFillExtrusionTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): FillExtrusion

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: FillExtrusion

# setFillExtrusionVerticalGradient

▸ setFillExtrusionVerticalGradient(value: PropertyValueSpecificationEx<boolean>): FillExtrusion

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: FillExtrusion

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / default / FluorescenceMarker

# Class: FluorescenceMarker

default.FluorescenceMarker

荧光点.

# Hierarchy

  • MarkerBase

    ↳ FluorescenceMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new FluorescenceMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): FluorescenceMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: FluorescenceMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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

# setFeatures

▸ setFeatures(features: FeatureCollection<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

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 / Exports / default / GeoBounds

# Class: GeoBounds

default.GeoBounds

GeoBounds 地理范围.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GeoBounds(min?: GeoPoint, max?: GeoPoint): GeoBounds

# Parameters
Name Type
min? GeoPoint
max? GeoPoint

Returns: GeoBounds

# Properties

# max

• max: GeoPoint

# min

• min: GeoPoint

# Methods

# center

▸ center(): GeoPoint

得到中心点

Returns: GeoPoint

# clone

▸ clone(): GeoBounds

克隆

Returns: GeoBounds

# closestPoint

▸ closestPoint(testPoint: GeoPoint, includeInterior?: boolean): GeoPoint

查找边界框上最近的点并返回该点.

# Parameters
Name Type Default value Description
testPoint GeoPoint - 点.
includeInterior boolean true 如果为true，则最近的点可以位于边界框内。如果为false，则最近的点只能位于边界框的外边缘上.

Returns: GeoPoint

# contains

▸ contains(point: GeoPoint): boolean

查看点是否在包围盒中

# Parameters
Name Type
point GeoPoint

Returns: boolean

# height

▸ height(): number

获取高度

Returns: number

# intersect

▸ intersect(b: GeoBounds): null | GeoBounds

两包围盒求交集

# Parameters
Name Type
b GeoBounds

Returns: null | GeoBounds

# isContains

▸ isContains(bound: GeoBounds): boolean

求一个包围盒是否包含另一个包围盒

# Parameters
Name Type
bound GeoBounds

Returns: boolean

# isIntersect

▸ isIntersect(bound: GeoBounds): boolean

判断与另一个包围盒是否相交

# Parameters
Name Type
bound GeoBounds

Returns: boolean

# leftBottom

▸ leftBottom(): GeoPoint

得到左下角

Returns: GeoPoint

# leftTop

▸ leftTop(): GeoPoint

得到左上角

Returns: GeoPoint

# randomGeoJsonLineCollection

▸ randomGeoJsonLineCollection(maxLineCount: number, maxPointCount: number, xRatio?: number, yRatio?: number, propertiesCb?: (index: number) => Object, minLineCount?: number, minPointCount?: number): GeoJsonGeomertry

生成一个随机geojson线集合

# Parameters
Name Type Default value Description
maxLineCount number - 最多线的数目
maxPointCount number - 每条线最多的点的数目
xRatio number 0.6 x轴范围比例 缺省 0.6
yRatio number 0.6 y轴范围比例 缺省 0.6
propertiesCb? (index: number) => Object - 属性回调函数
minLineCount? number - 最少线的数目（缺省为1)
minPointCount? number - 每条线最少的点的数目（缺省为2)

Returns: GeoJsonGeomertry

# randomGeoJsonPointCollection

▸ randomGeoJsonPointCollection(count: number, xRatio?: number, yRatio?: number, propertiesCb?: (index: number) => Object): GeoJsonGeomertry

生成一个随机geojson点集合

# Parameters
Name Type Default value Description
count number - 点的数目
xRatio number 0.6 x轴范围比例 缺省 0.6
yRatio number 0.6 y轴范围比例 缺省 0.6
propertiesCb? (index: number) => Object - 属性回调函数

Returns: GeoJsonGeomertry

# randomGeoJsonPolygonCollection

▸ randomGeoJsonPolygonCollection(maxPolygonCount: number, maxPointCount: number, xRatio?: number, yRatio?: number, propertiesCb?: (index: number) => Object, minPolygonCount?: number, minPointCount?: number): GeoJsonGeomertry

生成一个随机geojson多边形集合

# Parameters
Name Type Default value Description
maxPolygonCount number - 最多多边形的数目
maxPointCount number - 每条线最多的点的数目
xRatio number 0.6 x轴范围比例 缺省 0.6
yRatio number 0.6 y轴范围比例 缺省 0.6
propertiesCb? (index: number) => Object - 属性回调函数
minPolygonCount? number - 最少多边形的数目(缺省为1)
minPointCount? number - 每条线最少的点的数目(缺省为3)

Returns: GeoJsonGeomertry

# randomPoint

▸ randomPoint(xRatio?: number, yRatio?: number): GeoPoint

生成一个随机点

# Parameters
Name Type Default value Description
xRatio number 0.6 x轴范围比例 缺省 0.6
yRatio number 0.6 y轴范围比例 缺省 0.6

Returns: GeoPoint

# randomPoints

▸ randomPoints(minPointCount: number, maxPointCount: number, xRatio?: number, yRatio?: number): GeoPoint[]

生成一个随机点序列

# Parameters
Name Type Default value Description
minPointCount number - 最少的点数
maxPointCount number - 最多的点数
xRatio number 0.6 x轴范围比例 缺省 0.6
yRatio number 0.6 y轴范围比例 缺省 0.6

Returns: GeoPoint[]

# rightBottom

▸ rightBottom(): GeoPoint

得到右下角

Returns: GeoPoint

# rightTop

▸ rightTop(): GeoPoint

得到右上角

Returns: GeoPoint

# scale

▸ scale(ratio: number, origin?: null | GeoPoint): GeoBounds

按照比例扩大/缩小出一个新的 GeoBounds。

# Parameters
Name Type Description
ratio number 比例
origin? null | GeoPoint 扩大时的基准点，默认为当前 bounds 的中心点

Returns: GeoBounds

# scaleXY

▸ scaleXY(ratioX: number, ratioY: number, origin?: null | GeoPoint): GeoBounds

按照XY比例扩大/缩小出一个新的 GeoBounds。

# Parameters
Name Type Description
ratioX number X比例
ratioY number Y比例
origin? null | GeoPoint 扩大时的基准点，默认为当前 bounds 的中心点

Returns: GeoBounds

# set

▸ set(min: GeoPoint, max: GeoPoint): void

设置包围盒范围

# Parameters
Name Type Description
min GeoPoint 最小值
max GeoPoint 最大值

Returns: void

# square

▸ square(isLatlng?: boolean, isMinValue?: boolean): GeoBounds

变成正方形，使宽高相等

return{geobounds}

# Parameters
Name Type Description
isLatlng? boolean 是否是经纬度
isMinValue? boolean 是否取宽高的最小值或最大值，默认最大值

Returns: GeoBounds

# toArray

▸ toArray(): number[]

返回数组

Returns: number[]

The coordinates represented as a array of the format [minx, miny, maxx, maxy]'.

# toPointArray

▸ toPointArray(): [number, number][]

返回点数组，包括四个顶点

Returns: [number, number][]

The coordinates represented as a array of the format [[minx,maxy], [maxx,maxy], [maxx,miny], [minx,miny]]'.

# toString

▸ toString(fixed?: number): string

返回字符串.

# Parameters
Name Type Default value
fixed number 6

Returns: string

The coordinates represented as a string of the format minx, miny, maxx, maxy'.

# translate

▸ translate(dx: number, dy: number): void

位移包围盒

# Parameters
Name Type
dx number
dy number

Returns: void

# union

▸ union(bound: GeoBounds): GeoBounds

求多个包围盒的并集

# Parameters
Name Type
bound GeoBounds

Returns: GeoBounds

# update

▸ update(vertices: GeoPoint[]): void

更新包围盒

# Parameters
Name Type
vertices GeoPoint[]

Returns: void

# updateByBounds

▸ updateByBounds(bounds: GeoBounds | GeoBounds[]): void

根据子包围盒更新包围盒

# Parameters
Name Type
bounds GeoBounds | GeoBounds[]

Returns: void

# width

▸ width(): number

获取宽度

Returns: number

# fromArray

▸ Static fromArray(input: [number, number, number, number]): GeoBounds

根据数组创建 GeoBounds.

Example:

const b = GeoBounds.fromArray([left, bottom, right, top]);
1
# Parameters
Name Type
input [number, number, number, number]

Returns: GeoBounds

# fromCenterWH

▸ Static fromCenterWH(center: GeoPointLike, width: number, height?: number): GeoBounds

根据中心点和长，宽生成bounds

# Parameters
Name Type Description
center GeoPointLike 中心点
width number 宽
height? number 高，不输入时与宽一样

Returns: GeoBounds

# fromDataExtent

▸ Static fromDataExtent(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): GeoBounds

根据数据范围来生成bounds

# Parameters
Name Type
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

Returns: GeoBounds

# fromString

▸ Static fromString(input: string): GeoBounds

根据数组创建 GeoBounds.

Example:

const b = GeoBounds.fromString("[1,2,3,4]");
1
# Parameters
Name Type
input string

Returns: GeoBounds

vjmap / Exports / default / GeoPoint

# Class: GeoPoint

default.GeoPoint

GeoPoint 地理坐标.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GeoPoint(x: number, y: number, z?: number): GeoPoint

GeoPoint 构造函数

# Parameters
Name Type Description
x number x坐标.
y number y坐标.
z? number z坐标(可选）.

Returns: GeoPoint

# Properties

# x

• x: number

坐标X.

# y

• y: number

坐标y.

# z

• Optional z: number

坐标z(可选）.

# Methods

# add

▸ add(p: GeoPoint): GeoPoint

两个点相加.

# Parameters
Name Type Description
p GeoPoint 要相加的点.

Returns: GeoPoint

# angle

▸ angle(): number

角度.

Returns: number

# angleTo

▸ angleTo(b: GeoPoint): number

距一个点的角度

# Parameters
Name Type
b GeoPoint

Returns: number

# angleWith

▸ angleWith(b: GeoPoint): number

距一个点的interiorAngle

# Parameters
Name Type
b GeoPoint

Returns: number

# angleWithSep

▸ angleWithSep(x: number, y: number): number

距一个点的interiorAngle

# Parameters
Name Type
x number
y number

Returns: number

# clone

▸ clone(): GeoPoint

克隆一个坐标

Returns: GeoPoint

# distSqr

▸ distSqr(p: GeoPoint): number

两点之间距离平方.

# Parameters
Name Type
p GeoPoint

Returns: number

# distanceTo

▸ distanceTo(p: GeoPoint): number

两点之间距离.

# Parameters
Name Type
p GeoPoint

Returns: number

# div

▸ div(k: number): GeoPoint

除一个系数.

# Parameters
Name Type Description
k number 系数.

Returns: GeoPoint

# divByPoint

▸ divByPoint(p: GeoPoint): GeoPoint

两个点相除.

# Parameters
Name Type Description
p GeoPoint 要相除的点.

Returns: GeoPoint

# dot

▸ dot(p: GeoPoint): number

# Parameters
Name Type
p GeoPoint

Returns: number

# equals

▸ equals(other: GeoPoint, dotErr?: number): boolean

判断是否相等

# Parameters
Name Type Default value Description
other GeoPoint - 另外一个点
dotErr number 8 允许误差的小数点后几位，默认8位

Returns: boolean

# equalsZ

▸ equalsZ(other: GeoPoint): boolean

是否相等（判断z).

# Parameters
Name Type
other GeoPoint

Returns: boolean

# lengthSq

▸ lengthSq(): number

Returns: number

# lerp

▸ lerp(v: GeoPoint, alpha: number): GeoPoint

# Parameters
Name Type
v GeoPoint
alpha number

Returns: GeoPoint

# mag

▸ mag(): number

长度.

Returns: number

# matMult

▸ matMult(m: number[]): GeoPoint

乘一个矩阵.

# Parameters
Name Type Description
m number[] 矩阵值.

Returns: GeoPoint

# mult

▸ mult(k: number): GeoPoint

乘一个系数.

# Parameters
Name Type Description
k number 系数.

Returns: GeoPoint

# multByPoint

▸ multByPoint(p: GeoPoint): GeoPoint

两个点相乘.

# Parameters
Name Type Description
p GeoPoint 要相乘的点.

Returns: GeoPoint

# perp

▸ perp(): GeoPoint

投影 [x,y] = [-y, x].

Returns: GeoPoint

# roateAround

▸ roateAround(angle: number, p: GeoPoint): GeoPoint

绕一个点旋转.

# Parameters
Name Type Description
angle number 弧度.
p GeoPoint 围绕的点.

Returns: GeoPoint

# rotate

▸ rotate(angle: number): GeoPoint

旋转.

# Parameters
Name Type Description
angle number 弧度.

Returns: GeoPoint

# round

▸ round(fixed?: number): GeoPoint

后小数点几位取整

# Parameters
Name Type Default value
fixed number 6

Returns: GeoPoint

# roundInt

▸ roundInt(): GeoPoint

四舍五入取整.

Returns: GeoPoint

# roundStr

▸ roundStr(fixed?: number): string

# Parameters
Name Type Default value
fixed number 6

Returns: string

# sub

▸ sub(p: GeoPoint): GeoPoint

两个点相减.

# Parameters
Name Type Description
p GeoPoint 要相减的点.

Returns: GeoPoint

# toArray

▸ toArray(): number[]

返回数组

Returns: number[]

The coordinates represeted as an array of x and y.

var ll = new vjmap.GeoPoint(-73.9749, 40.7736);
ll.toArray(); // = [-73.9749, 40.7736]
1
2

# toString

▸ toString(fixed?: number): string

返回字符串.

# Parameters
Name Type Default value
fixed number 6

Returns: string

The coordinates represented as a string of the format 'x, y, z?'.

var ll = new vjmap.GeoPoint(-73.9749, 40.7736);
ll.toString(); // = "GeoPoint(-73.9749, 40.7736)"
1
2

# transform

▸ transform(basePt: GeoPoint, destPt: GeoPoint, scale?: number, angle?: number): GeoPoint

对一个点围绕一个基点进行缩放旋转平移操作.

# Parameters
Name Type Description
basePt GeoPoint 围绕的基点坐标
destPt GeoPoint 要平移至的目的地坐标
scale? number 缩放比例，默认1.0
angle? number 旋转角度，逆时针，默认0

Returns: GeoPoint

# unit

▸ unit(): GeoPoint

单位长度.

Returns: GeoPoint

# convert

▸ Static convert(input: GeoPointLike): GeoPoint

根据不同的类型创建地理坐标 GeoPoint .

Example:

const p1 = GeoPoint.convert(new GeoPoint(x, y, z));
const p2 = GeoPoint.convert([x, y]);
const p3 = GeoPoint.convert([x, y, z]);
const p4 = GeoPoint.convert(lng: -73.9749, lat: 40.7736});
const p5 = GeoPoint.convert(lon: -73.9749, lat: 40.7736});
1
2
3
4
5
# Parameters
Name Type Description
input GeoPointLike Either GeoPointLike, GeoPointLike or GeoPointLike object literal.

Returns: GeoPoint

# fromString

▸ Static fromString(input: string): GeoPoint

根据字符串创建 GeoPoint.

Example:

const b = GeoPoint.fromString("1,2");
1
# Parameters
Name Type
input string

Returns: GeoPoint

vjmap / Exports / default / GeoProjection

# Class: GeoProjection

default.GeoProjection

GeoProjection 地理坐标投影.

Example:

const mapExtent = new GeoBounds(new GeoPoint(10, 20), new GeoPoint(80, 90));
const prj = new GeoProjection(mapExtent);
const pt = [30, 30];
const latlng = prj.toLngLat(pt);
const pt_geo = prj.fromLngLat(latlng);
const mkt = prj.toMercator(pt);
const pt_mkt = prj.fromMercator(mkt);
1
2
3
4
5
6
7

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GeoProjection(extent: GeoBounds): GeoProjection

GeoBounds 构造函数

extent extent - 地图地理范围.

# Parameters
Name Type
extent GeoBounds

Returns: GeoProjection

Overrides: Projection

# Properties

# mapExtent

• mapExtent: GeoBounds

地图地理范围.

# EARTH_BOUNDS

▪ Static EARTH_BOUNDS: [number, number, number, number]

The equatorial semi perimeter in meters.

Inherited from: Projection.EARTH_BOUNDS

# EQUATORIAL_SEMIPERIMETER

▪ Static EQUATORIAL_SEMIPERIMETER: number= 20037508.3427892

The equatorial semi perimeter in meters.

Inherited from: Projection.EQUATORIAL_SEMIPERIMETER

# Methods

# fromLngLat

▸ fromLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

经纬度转地图地理坐标

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 经纬度坐标点

Returns: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

Overrides: Projection

# fromMercator

▸ fromMercator(input: GeoPointLike): [number, number]

墨卡托(epsg:3857)转坐标

# Parameters
Name Type Description
input GeoPointLike 墨卡托坐标点

Returns: [number, number]

Overrides: Projection

# fromMeter

▸ fromMeter(meter: number): number

把米转化为距离

# Parameters
Name Type
meter number

Returns: number

Overrides: Projection

# getMapExtent

▸ getMapExtent(): GeoBounds

得到地图范围

Returns: GeoBounds

Overrides: Projection

# setExtent

▸ setExtent(extent: GeoBounds): void

设置地图范围

extent extent - 地图地理范围.

# Parameters
Name Type
extent GeoBounds

Returns: void

# toLngLat

▸ toLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): LngLatLike

地图地理坐标转经纬度

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 地理坐标点

Returns: LngLatLike

Overrides: Projection

# toMercator

▸ toMercator(input: GeoPointLike): [number, number]

坐标转墨卡托(epsg:3857)

# Parameters
Name Type Description
input GeoPointLike 坐标点

Returns: [number, number]

Overrides: Projection

# toMeter

▸ toMeter(dist: number): number

把距离转化为米

# Parameters
Name Type
dist number

Returns: number

Overrides: Projection

# lngLat2Mercator

▸ Static lngLat2Mercator(input: GeoPointLike): [number, number]

经纬度转墨卡托 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

Inherited from: Projection

# mercator2LngLat

▸ Static mercator2LngLat(input: GeoPointLike): [number, number]

墨卡托转经纬度 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

Inherited from: Projection

vjmap / Exports / default / GlAdapterLayer

# Class: GlAdapterLayer

default.GlAdapterLayer

# Hierarchy

# Implements

  • CustomLayerInterface

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GlAdapterLayer(): GlAdapterLayer

Returns: GlAdapterLayer

Inherited from: Evented.constructor

# Properties

# id

• id: string

Implementation of: CustomLayerInterface.id

# map

• map: Map

# regl

• regl: any

# renderAnimation

• Optional renderAnimation: boolean

# type

• type: "custom"

Implementation of: CustomLayerInterface.type

# Methods

# frame

▸ Protected Abstract frame(gl: WebGLRenderingContext, matrix: number[], context?: any): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]
context? any

Returns: void

# getReglInitializationOptions

▸ Protected Abstract getReglInitializationOptions(): any

Returns: any

# init

▸ Protected Abstract init(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

# onAdd

▸ onAdd(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Implementation of: CustomLayerInterface.onAdd

# onRemove

▸ onRemove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Implementation of: CustomLayerInterface.onRemove

# prerender

▸ prerender(gl: WebGLRenderingContext, matrix: number[]): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Implementation of: CustomLayerInterface.prerender

# remove

▸ Protected Abstract remove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

# render

▸ render(gl: WebGLRenderingContext, matrix: number[]): void

NOTE: map won't call it every frame.

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Implementation of: CustomLayerInterface.render

# triggerRepaint

▸ triggerRepaint(): void

Returns: void

vjmap / Exports / default / GlPolyLineLayer

# Class: GlPolyLineLayer

default.GlPolyLineLayer

# Hierarchy

# Implements

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GlPolyLineLayer(options: Partial<ILineLayerOptions>): GlPolyLineLayer

# Parameters
Name Type
options Partial<ILineLayerOptions>

Returns: GlPolyLineLayer

Overrides: GlAdapterLayer

# Properties

# drawPoints

• drawPoints: any

# id

• id: string= 'custom-line'

Overrides: GlAdapterLayer.id

# instance

• instance: boolean= true

# map

• map: Map

Inherited from: GlAdapterLayer.map

# pointColor

• pointColor: number[]

# points

• points: { lat: number ; lng: number }[]= []

Implementation of: ILineLayerOptions.points

# regl

• regl: any

Inherited from: GlAdapterLayer.regl

# renderAnimation

• Optional renderAnimation: boolean

Inherited from: GlAdapterLayer.renderAnimation

# type

• type: "custom"

Inherited from: GlAdapterLayer.type

# Methods

# frame

▸ frame(gl: WebGLRenderingContext, matrix: number[], context?: any): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]
context? any

Returns: void

Overrides: GlAdapterLayer

# getReglInitializationOptions

▸ getReglInitializationOptions(): any

Returns: any

Overrides: GlAdapterLayer

# init

▸ init(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Overrides: GlAdapterLayer

# onAdd

▸ onAdd(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Inherited from: GlAdapterLayer

# onRemove

▸ onRemove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Inherited from: GlAdapterLayer

# prerender

▸ prerender(gl: WebGLRenderingContext, matrix: number[]): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Inherited from: GlAdapterLayer

# remove

▸ remove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Overrides: GlAdapterLayer

# render

▸ render(gl: WebGLRenderingContext, matrix: number[]): void

NOTE: map won't call it every frame.

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Inherited from: GlAdapterLayer

# triggerRepaint

▸ triggerRepaint(): void

Returns: void

Inherited from: GlAdapterLayer

vjmap / Exports / default / GridLayer

# Class: GridLayer

default.GridLayer

网络线图层

# Implements

  • CustomLayerInterface

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GridLayer(options?: GridLayerOptions): GridLayer

# Parameters
Name Type Default value
options GridLayerOptions {}

Returns: GridLayer

# Properties

# id

• id: string

Implementation of: CustomLayerInterface.id

# renderingMode

• Optional renderingMode: "2d" | "3d"

Implementation of: CustomLayerInterface.renderingMode

# type

• type: "custom"

Implementation of: CustomLayerInterface.type

# Methods

# getWrapNum

▸ getWrapNum(x: number, includeMax?: boolean, includeMin?: boolean, range?: number[]): number

# Parameters
Name Type Default value
x number -
includeMax boolean true
includeMin boolean true
range number[] -

Returns: number

# onAdd

▸ onAdd(map: Map): void

# Parameters
Name Type
map Map

Returns: void

Implementation of: CustomLayerInterface.onAdd

# removeFromMap

▸ removeFromMap(): void

description 移除图层。

Returns: void

# render

▸ render(gl: WebGLRenderingContext, matrix: number[]): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Implementation of: CustomLayerInterface.render

# setExtent

▸ setExtent(extent: LngLatBounds): void

description 设置坐标网格渲染的边界范围。

# Parameters
Name Type Description
extent LngLatBounds 坐标网格渲染的边界范围。

Returns: void

# setIntervals

▸ setIntervals(interval: number | Function): void

description 设置经纬度的间隔（以度为单位)

# Parameters
Name Type Description
interval number | Function 经纬度的间隔（以度为单位），可以是数字，也可以是函数，参数是map。

Returns: void

# setMaxZoom

▸ setMaxZoom(maxZoom: number): void

description 该图层可见的最大视图缩放级别。

# Parameters
Name Type Description
maxZoom number 该图层可见的最大视图缩放级别（含）。

Returns: void

# setMinZoom

▸ setMinZoom(minZoom: number): void

description 设置最小视图缩放级别。

# Parameters
Name Type Description
minZoom number 最小视图缩放级别（不包括此级别），在该级别之上，该层将可见。

Returns: void

# setShowLabel

▸ setShowLabel(showLabel: boolean): void

description 设置显示标签。

# Parameters
Name Type Description
showLabel boolean 是否显示标签。

Returns: void

# setStrokeStyle

▸ setStrokeStyle(strokeStyle: GridLayerStrokeStyle): void

description 设置经纬线样式。

# Parameters
Name Type Description
strokeStyle GridLayerStrokeStyle 经纬线样式。

Returns: void

# setVisibility

▸ setVisibility(visible?: boolean): void

description 设置可见性。

# Parameters
Name Type Description
visible? boolean 是否可见。

Returns: void

# setXLabelStyle

▸ setXLabelStyle(labelStyle: GridLayerLabelStyle): void

description 设置经度标签样式。

# Parameters
Name Type Description
labelStyle GridLayerLabelStyle 标签样式。

Returns: void

# setYLabelStyle

▸ setYLabelStyle(labelStyle: GridLayerLabelStyle): void

description 设置纬度标签样式。

# Parameters
Name Type Description
labelStyle GridLayerLabelStyle 标签样式。

Returns: void

vjmap / Exports / default / HaloRingMarker

# Class: HaloRingMarker

default.HaloRingMarker

发光的光环.

# Hierarchy

  • MarkerBase

    ↳ HaloRingMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new HaloRingMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): HaloRingMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: HaloRingMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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

# setFeatures

▸ setFeatures(features: FeatureCollection<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

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 / Exports / default / Heatmap

# Class: Heatmap

default.Heatmap

创建热力图图层.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Heatmap(options: HeatmapOptions): Heatmap

# Parameters
Name Type
options HeatmapOptions

Returns: Heatmap

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: HeatmapOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getHeatmapColor

▸ getHeatmapColor(): ExpressionSpecificationEx

Returns: ExpressionSpecificationEx

# getHeatmapIntensity

▸ getHeatmapIntensity(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getHeatmapOpacity

▸ getHeatmapOpacity(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getHeatmapRadius

▸ getHeatmapRadius(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getHeatmapWeight

▸ getHeatmapWeight(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setHeatmapColor

▸ setHeatmapColor(value: ExpressionSpecificationEx): Heatmap

# Parameters
Name Type
value ExpressionSpecificationEx

Returns: Heatmap

# setHeatmapIntensity

▸ setHeatmapIntensity(value: PropertyValueSpecificationEx<number>): Heatmap

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Heatmap

# setHeatmapOpacity

▸ setHeatmapOpacity(value: PropertyValueSpecificationEx<number>): Heatmap

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Heatmap

# setHeatmapRadius

▸ setHeatmapRadius(value: DataDrivenPropertyValueSpecification<number>): Heatmap

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Heatmap

# setHeatmapWeight

▸ setHeatmapWeight(value: DataDrivenPropertyValueSpecification<number>): Heatmap

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Heatmap

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / default / LnglatProjection

# Class: LnglatProjection

default.LnglatProjection

LnglatProjection 经纬度坐标投影.

Example:

const mapExtent = new GeoBounds(new GeoPoint(10, 20), new GeoPoint(80, 90));
const prj = new LnglatProjection(mapExtent);
const pt = [30, 30];
const latlng = prj.toLngLat(pt);
const pt_geo = prj.fromLngLat(latlng);
const mkt = prj.toMercator(pt);
const pt_mkt = prj.fromMercator(mkt);
1
2
3
4
5
6
7

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new LnglatProjection(): LnglatProjection

GeoBounds 构造函数

extent extent - 地图地理范围.

Returns: LnglatProjection

Overrides: Projection

# Properties

# mapExtent

• mapExtent: GeoBounds

地图地理范围.

# EARTH_BOUNDS

▪ Static EARTH_BOUNDS: [number, number, number, number]

The equatorial semi perimeter in meters.

Inherited from: Projection.EARTH_BOUNDS

# EQUATORIAL_SEMIPERIMETER

▪ Static EQUATORIAL_SEMIPERIMETER: number= 20037508.3427892

The equatorial semi perimeter in meters.

Inherited from: Projection.EQUATORIAL_SEMIPERIMETER

# Methods

# fromLngLat

▸ fromLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

经纬度转地图地理坐标

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 经纬度坐标点

Returns: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

Overrides: Projection

# fromMercator

▸ fromMercator(input: GeoPointLike): [number, number]

墨卡托(epsg:3857)转坐标

# Parameters
Name Type Description
input GeoPointLike 墨卡托坐标点

Returns: [number, number]

Overrides: Projection

# fromMeter

▸ fromMeter(meter: number): number

把米转化为距离

# Parameters
Name Type
meter number

Returns: number

Overrides: Projection

# getMapExtent

▸ getMapExtent(): GeoBounds

得到地图范围

Returns: GeoBounds

Overrides: Projection

# setExtent

▸ setExtent(extent: GeoBounds): void

设置地图范围

extent extent - 地图地理范围.

# Parameters
Name Type
extent GeoBounds

Returns: void

# toLngLat

▸ toLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): LngLatLike

地图地理坐标转经纬度

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 地理坐标点

Returns: LngLatLike

Overrides: Projection

# toMercator

▸ toMercator(input: GeoPointLike): [number, number]

坐标转墨卡托(epsg:3857)

# Parameters
Name Type Description
input GeoPointLike 坐标点

Returns: [number, number]

Overrides: Projection

# toMeter

▸ toMeter(dist: number): number

把距离转化为米

# Parameters
Name Type
dist number

Returns: number

Overrides: Projection

# lngLat2Mercator

▸ Static lngLat2Mercator(input: GeoPointLike): [number, number]

经纬度转墨卡托 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

Inherited from: Projection

# mercator2LngLat

▸ Static mercator2LngLat(input: GeoPointLike): [number, number]

墨卡托转经纬度 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

Inherited from: Projection

vjmap / Exports / default / MapGlUtils

# Class: MapGlUtils

default.MapGlUtils

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new MapGlUtils(): MapGlUtils

Returns: MapGlUtils

# Methods

# init

▸ Static init(map: any, bindToMap: any): any

# Parameters
Name Type
map any
bindToMap any

Returns: any

# newMap

▸ Static newMap(params?: {}, options?: {}): Promise<Map>

# Parameters
Name Type Default value
params object {}
options object {}

Returns: Promise<Map>

vjmap / Exports / default / MarkerCluster

# Class: MarkerCluster

default.MarkerCluster

创建文本组件.

# Hierarchy

  • Evented

    ↳ MarkerCluster

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new MarkerCluster(options: MarkerClusterOptions): MarkerCluster

构造函数

# Parameters
Name Type
options MarkerClusterOptions

Returns: MarkerCluster

Overrides: Evented.constructor

# Methods

# addTo

▸ addTo(map: Map): MarkerCluster

将 MarkerCluster 附加到 Map 对象。

# Parameters
Name Type
map Map

Returns: MarkerCluster

# allowOverlap

▸ allowOverlap(bAllowOverlap: boolean): void

# Parameters
Name Type
bAllowOverlap boolean

Returns: void

# allowOverlapMaxZoom

▸ allowOverlapMaxZoom(zoom: number): void

# Parameters
Name Type
zoom number

Returns: void

# getData

▸ getData(): MarkerClusterData[]

获取数据。

Returns: MarkerClusterData[]

# hide

▸ hide(): void

隐藏

Returns: void

# remove

▸ remove(): void

从地图中删除。

Returns: void

# show

▸ show(): void

显示

Returns: void

# updateData

▸ updateData(data: FeatureCollection<Geometry | GeometryCollection, Properties> | MarkerClusterData[]): void

更新数据。

# Parameters
Name Type
data FeatureCollection<Geometry | GeometryCollection, Properties> | MarkerClusterData[]

Returns: void

# updateMarkers

▸ updateMarkers(): void

更新markers。

Returns: void

vjmap / Exports / default / Math2D / Box

# Class: Box

default.Math2D.Box

Alternative 2D box object with less memory impact (four numbers instead of two min/max objects with two numbers each). Should be faster.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Box(x?: number, y?: number, w?: number, h?: number): Box

Alternative 2D box object with less memory impact (four numbers instead of two min/max objects with two numbers each). Should be faster.

# Parameters
Name Type Default value Description
x number 0 New X value.
y number 0 New y value.
w number 0 New w value.
h number 0 New h value.

Returns: Box

# Properties

# h

• h: number= 0

# w

• w: number= 0

# x

• x: number= 0

# y

• y: number= 0

# Methods

# contains

▸ contains(x: number, y: number): boolean

Test box for inclusion of point.

# Parameters
Name Type Description
x number X coordinate of point.
y number Y coordinate of point.

Returns: boolean

# containsBox

▸ containsBox(other: Box): boolean

Test box for inclusion of another box.

# Parameters
Name Type Description
other Box Box 2 to test for inclusion.

Returns: boolean

# intersects

▸ intersects(other: Box): boolean

Test two boxes for intersection.

# Parameters
Name Type Description
other Box Box 2 to test for intersection.

Returns: boolean

# set

▸ set(x: number, y: number, w: number, h: number): void

Set new values to all properties of the box.

# Parameters
Name Type Description
x number New X value.
y number New y value.
w number New w value.
h number New h value.

Returns: void

vjmap / Exports / default / MiniMapControl

# Class: MiniMapControl

default.MiniMapControl

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new MiniMapControl(options: MiniMapControlOption): MiniMapControl

# Parameters
Name Type
options MiniMapControlOption

Returns: MiniMapControl

# Methods

# _convertBoundsToPoints

▸ _convertBoundsToPoints(bounds: any): void

# Parameters
Name Type
bounds any

Returns: void

# _createContainer

▸ _createContainer(parentMap: Map): HTMLDivElement

# Parameters
Name Type
parentMap Map

Returns: HTMLDivElement

# _load

▸ _load(): void

Returns: void

# _mouseDown

▸ _mouseDown(e: any): void

# Parameters
Name Type
e any

Returns: void

# _mouseMove

▸ _mouseMove(e: any): void

# Parameters
Name Type
e any

Returns: void

# _mouseUp

▸ _mouseUp(): void

Returns: void

# _moveTrackingRect

▸ _moveTrackingRect(offset: any): any

# Parameters
Name Type
offset any

Returns: any

# _onAdd

▸ _onAdd(parentMap: Map): HTMLElement

# Parameters
Name Type
parentMap Map

Returns: HTMLElement

# _onRemove

▸ _onRemove(): void

Returns: void

# _onSize

▸ _onSize(): void

Returns: void

# _preventDefault

▸ _preventDefault(e: any): void

# Parameters
Name Type
e any

Returns: void

# _setTrackingRectBounds

▸ _setTrackingRectBounds(bounds: any): void

# Parameters
Name Type
bounds any

Returns: void

# _update

▸ _update(e: any): void

# Parameters
Name Type
e any

Returns: void

# _updateMapExtent

▸ _updateMapExtent(data: any): void

# Parameters
Name Type
data any

Returns: void

# _zoomAdjust

▸ _zoomAdjust(): void

Returns: void

# getDefaultPosition

▸ getDefaultPosition(): string

Returns: string

# getMap

▸ getMap(): Map

Returns: Map

# init

▸ init(options: MiniMapControlOption): void

# Parameters
Name Type
options MiniMapControlOption

Returns: void

# onAdd

▸ onAdd(parentMap: Map): HTMLElement

# Parameters
Name Type
parentMap Map

Returns: HTMLElement

# onRemove

▸ onRemove(): void

Returns: void

vjmap / Exports / default / MousePositionControl

# Class: MousePositionControl

default.MousePositionControl

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new MousePositionControl(options?: MousePositionControlOption): MousePositionControl

# Parameters
Name Type Default value
options MousePositionControlOption {}

Returns: MousePositionControl

# Methods

# defaultLabelFormat

▸ defaultLabelFormat(lng: number, lat: number, x: number, y: number): string

# Parameters
Name Type
lng number
lat number
x number
y number

Returns: string

# getDefaultPosition

▸ getDefaultPosition(): string

Returns: string

# insertControl

▸ insertControl(): void

Returns: void

# onAdd

▸ onAdd(map: Map): HTMLElement

# Parameters
Name Type
map Map

Returns: HTMLElement

# onMouseMove

▸ onMouseMove(evt?: any): void

# Parameters
Name Type
evt? any

Returns: void

# onRemove

▸ onRemove(): void

Returns: void

vjmap / Exports / default / OverlayLayerBase

# Class: OverlayLayerBase

default.OverlayLayerBase

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new OverlayLayerBase(): OverlayLayerBase

Returns: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

# layerId

• Optional layerId: string

# sourceId

• Optional sourceId: string

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

# 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.

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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.

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

# setProperty

▸ setProperty(prop: string | object, value?: any): void

在一个或多个图层上设置绘制或布局属性。

example setProperty('fillOpacity', 0.5)

# Parameters
Name Type
prop string | object
value? any

Returns: void

# show

▸ show(): void

使给定的图层可见。

Returns: void

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

vjmap / Exports / default / Polygon

# Class: Polygon

default.Polygon

创建多边形.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Polygon(options: PolygonOptions): Polygon

# Parameters
Name Type
options PolygonOptions

Returns: Polygon

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: PolygonOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getFillAntialias

▸ getFillAntialias(): PropertyValueSpecificationEx<boolean>

获取图层的“填充抗锯齿”绘制属性。

Returns: PropertyValueSpecificationEx<boolean>

# getFillColor

▸ getFillColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

# getFillOpacity

▸ getFillOpacity(): DataDrivenPropertyValueSpecification<number>

获取图层的 fill-opacity 绘制属性。

Returns: DataDrivenPropertyValueSpecification<number>

# getFillOutlineColor

▸ getFillOutlineColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-outline-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

# getFillPattern

▸ getFillPattern(): DataDrivenPropertyValueSpecification<string>

获取图层的fill-pattern 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

# getFillSortKey

▸ getFillSortKey(): DataDrivenPropertyValueSpecification<number>

获取图层的fill-sort-key 布局属性.

Returns: DataDrivenPropertyValueSpecification<number>

# getFillTranslate

▸ getFillTranslate(): PropertyValueSpecificationEx<[number, number]>

获取图层的 fill-translate 绘制属性。

Returns: PropertyValueSpecificationEx<[number, number]>

# getFillTranslateAnchor

▸ getFillTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

获取图层的 fill-translate-anchor 绘制属性。

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFillAntialias

▸ setFillAntialias(value: PropertyValueSpecificationEx<boolean>): Polygon

为一个或多个图层设置fill-antialias 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Polygon

# setFillColor

▸ setFillColor(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

# setFillOpacity

▸ setFillOpacity(value: DataDrivenPropertyValueSpecification<number>): Polygon

为一个或多个图层设置fill-opacity 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polygon

# setFillOutlineColor

▸ setFillOutlineColor(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-outline-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

# setFillPattern

▸ setFillPattern(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-pattern 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

# setFillSortKey

▸ setFillSortKey(value: DataDrivenPropertyValueSpecification<number>): Polygon

为一层或多层设置fill-sort-key布局属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polygon

# setFillTranslate

▸ setFillTranslate(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-translate 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

# setFillTranslateAnchor

▸ setFillTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Polygon

为一个或多个图层设置fill-translate-anchor 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Polygon

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / default / Polyline

# Class: Polyline

default.Polyline

创建多段线.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Polyline(options: PolylineOptions): Polyline

# Parameters
Name Type
options PolylineOptions

Returns: Polyline

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: PolylineOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getLineBlur

▸ getLineBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLineCap

▸ getLineCap(): DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

# getLineColor

▸ getLineColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getLineDasharray

▸ getLineDasharray(): DataDrivenPropertyValueSpecification<number[]>

Returns: DataDrivenPropertyValueSpecification<number[]>

# getLineGapWidth

▸ getLineGapWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLineGradient

▸ getLineGradient(): ExpressionSpecificationEx

Returns: ExpressionSpecificationEx

# getLineJoin

▸ getLineJoin(): DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

# getLineMiterMimit

▸ getLineMiterMimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getLineOffset

▸ getLineOffset(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLineOpacity

▸ getLineOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLinePattern

▸ getLinePattern(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getLineRoundLimit

▸ getLineRoundLimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getLineSortKey

▸ getLineSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLineTranslate

▸ getLineTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getLineTranslateAnchor

▸ getLineTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getLineWidth

▸ getLineWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# setLineBlur

▸ setLineBlur(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# setLineCap

▸ setLineCap(value: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: Polyline

# setLineColor

▸ setLineColor(value: DataDrivenPropertyValueSpecification<string>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polyline

# setLineDasharray

▸ setLineDasharray(value: DataDrivenPropertyValueSpecification<number[]>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number[]>

Returns: Polyline

# setLineGapWidth

▸ setLineGapWidth(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# setLineGradient

▸ setLineGradient(value: ExpressionSpecificationEx): Polyline

# Parameters
Name Type
value ExpressionSpecificationEx

Returns: Polyline

# setLineJoin

▸ setLineJoin(value: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: Polyline

# setLineMiterMimit

▸ setLineMiterMimit(value: PropertyValueSpecificationEx<number>): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Polyline

# setLineOffset

▸ setLineOffset(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# setLineOpacity

▸ setLineOpacity(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# setLinePattern

▸ setLinePattern(value: DataDrivenPropertyValueSpecification<string>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polyline

# setLineRoundLimit

▸ setLineRoundLimit(value: PropertyValueSpecificationEx<number>): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Polyline

# setLineSortKey

▸ setLineSortKey(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# setLineTranslate

▸ setLineTranslate(value: PropertyValueSpecificationEx<[number, number]>): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: Polyline

# setLineTranslateAnchor

▸ setLineTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Polyline

# setLineWidth

▸ setLineWidth(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# 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

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / default / PolylineArrow

# Class: PolylineArrow

default.PolylineArrow

创建箭头多段线.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new PolylineArrow(options: PolylineArrowOptions): PolylineArrow

# Parameters
Name Type
options PolylineArrowOptions

Returns: PolylineArrow

# Properties

# animateFun

• animateFun: null | Function

# animatedPointIdx

• animatedPointIdx: number

# borderGeoJson

• borderGeoJson: any

# geojson

• geojson: any

# id

• id: string

# lineArrowImageName

• lineArrowImageName: string

# lineGeojson

• lineGeojson: any

# options

• options: PolylineArrowOptions

# strokeImageName

• strokeImageName: undefined | string

# type

• type: string

# Methods

# _addLayer

▸ _addLayer(): void

Returns: void

# _addShowDirFun

▸ _addShowDirFun(): void

Returns: void

# _addStrokeImage

▸ _addStrokeImage(): void

Returns: void

# _creatDirLine

▸ _creatDirLine(): void

Returns: void

# _createBorderLine

▸ _createBorderLine(): void

Returns: void

# _createLineGeojson

▸ _createLineGeojson(): void

Returns: void

# _mouseenterCallbackFun

▸ _mouseenterCallbackFun(): void

Returns: void

# _mouseleaveCallbackFun

▸ _mouseleaveCallbackFun(): void

Returns: void

# _updateLineStyle

▸ _updateLineStyle(options: any): void

# Parameters
Name Type
options any

Returns: void

# addDir

▸ addDir(): void

Returns: void

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

# animate

▸ animate(step?: number, fps?: number, isLoop?: boolean, stopCallBack?: (status: FrameAnimationStatus) => void, onFrameCallBack?: (status: FrameAnimationStatus, context: any) => void): FrameAnimation

开启动画

# Parameters
Name Type Default value Description
step number 100 把线段分成多少段
fps number 10 每一秒跑多少段
isLoop boolean false 是否循环
stopCallBack? (status: FrameAnimationStatus) => void - 结束回调
onFrameCallBack? (status: FrameAnimationStatus, context: any) => void - 每一帧的回调

Returns: FrameAnimation

# createGeojson

▸ createGeojson(): void

Returns: void

# getBounds

▸ getBounds(): GeoBounds

Returns: GeoBounds

# getId

▸ getId(): string

Returns: string

# getLength

▸ getLength(): number

Returns: number

# getOptions

▸ getOptions(): PolylineArrowOptions

Returns: PolylineArrowOptions

# getPath

▸ getPath(): any

Returns: any

# hide

▸ hide(): void

Returns: void

# hideDir

▸ hideDir(): void

Returns: void

# init

▸ init(): void

Returns: void

# off

▸ off(type: any, listener: EventedListener): void

# Parameters
Name Type
type any
listener EventedListener

Returns: void

# on

▸ on(type: any, listener: EventedListener): void

# Parameters
Name Type
type any
listener EventedListener

Returns: void

# once

▸ once(type: any, listener: EventedListener): void

# Parameters
Name Type
type any
listener EventedListener

Returns: void

# remove

▸ remove(): void

Returns: void

# removeDir

▸ removeDir(): void

Returns: void

# setBorderColor

▸ setBorderColor(value: any): void

# Parameters
Name Type
value any

Returns: void

# setBorderOpacity

▸ setBorderOpacity(val: any): void

# Parameters
Name Type
val any

Returns: void

# setBorderWidth

▸ setBorderWidth(weight: any): void

# Parameters
Name Type
weight any

Returns: void

# setColor

▸ setColor(color: any): void

# Parameters
Name Type
color any

Returns: void

# setCursor

▸ setCursor(cursor?: string): void

# Parameters
Name Type
cursor? string

Returns: void

# setOpacity

▸ setOpacity(val: any): void

# Parameters
Name Type
val any

Returns: void

# setOptions

▸ setOptions(options: PolylineArrowOptions): void

# Parameters
Name Type
options PolylineArrowOptions

Returns: void

# setPath

▸ setPath(val: GeoPointLike[]): void

# Parameters
Name Type
val GeoPointLike[]

Returns: void

# setStrokeImage

▸ setStrokeImage(strokeImage: string): void

# Parameters
Name Type
strokeImage string

Returns: void

# setWeight

▸ setWeight(val: any): void

# Parameters
Name Type
val any

Returns: void

# show

▸ show(): void

Returns: void

# showDir

▸ showDir(): void

Returns: void

vjmap / Exports / default / Projection

# Class: Projection

default.Projection

GeoPoint 地理坐标.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Projection(): Projection

Returns: Projection

# Properties

# EARTH_BOUNDS

▪ Static EARTH_BOUNDS: [number, number, number, number]

The equatorial semi perimeter in meters.

# EQUATORIAL_SEMIPERIMETER

▪ Static EQUATORIAL_SEMIPERIMETER: number= 20037508.3427892

The equatorial semi perimeter in meters.

# Methods

# fromLngLat

▸ Abstract fromLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

经纬度转地图地理坐标

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 经纬度坐标点

Returns: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

# fromMercator

▸ Abstract fromMercator(input: GeoPointLike): [number, number]

墨卡托(epsg:3857)转坐标

# Parameters
Name Type Description
input GeoPointLike 墨卡托坐标点

Returns: [number, number]

# fromMeter

▸ Abstract fromMeter(meter: number): number

把米转化为距离

# Parameters
Name Type
meter number

Returns: number

# getMapExtent

▸ Abstract getMapExtent(): GeoBounds

得到地图范围

Returns: GeoBounds

# toLngLat

▸ Abstract toLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): LngLatLike

地图地理坐标转经纬度

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 地理坐标点

Returns: LngLatLike

# toMercator

▸ Abstract toMercator(input: GeoPointLike): [number, number]

坐标转墨卡托(epsg:3857)

# Parameters
Name Type Description
input GeoPointLike 坐标点

Returns: [number, number]

# toMeter

▸ Abstract toMeter(dist: number): number

把距离转化为米

# Parameters
Name Type
dist number

Returns: number

# lngLat2Mercator

▸ Static lngLat2Mercator(input: GeoPointLike): [number, number]

经纬度转墨卡托 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

# mercator2LngLat

▸ Static mercator2LngLat(input: GeoPointLike): [number, number]

墨卡托转经纬度 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

vjmap / Exports / default / ReglBaseLayer

# Class: ReglBaseLayer

default.ReglBaseLayer

# Hierarchy

  • Evented

    ↳ ReglBaseLayer

# Implements

  • CustomLayerInterface

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new ReglBaseLayer(): ReglBaseLayer

Returns: ReglBaseLayer

Inherited from: Evented.constructor

# Properties

# id

• id: string

Implementation of: CustomLayerInterface.id

# map

• map: Map

# regl

• regl: any

# renderAnimation

• Optional renderAnimation: boolean

# type

• type: "custom"

Implementation of: CustomLayerInterface.type

# Methods

# frame

▸ Protected Abstract frame(gl: WebGLRenderingContext, matrix: number[], context?: any): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]
context? any

Returns: void

# getReglInitialization

▸ Protected Abstract getReglInitialization(gl: WebGLRenderingContext): any

# Parameters
Name Type
gl WebGLRenderingContext

Returns: any

# init

▸ Protected Abstract init(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

# onAdd

▸ onAdd(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Implementation of: CustomLayerInterface.onAdd

# onRemove

▸ onRemove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Implementation of: CustomLayerInterface.onRemove

# prerender

▸ prerender(gl: WebGLRenderingContext, matrix: number[]): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Implementation of: CustomLayerInterface.prerender

# remove

▸ Protected Abstract remove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

# render

▸ render(gl: WebGLRenderingContext, matrix: number[]): void

NOTE: map won't call it every frame.

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Implementation of: CustomLayerInterface.render

# triggerRepaint

▸ triggerRepaint(): void

Returns: void

vjmap / Exports / default / RotatingApertureMarker

# Class: RotatingApertureMarker

default.RotatingApertureMarker

旋转的光环.

# Hierarchy

  • MarkerBase

    ↳ RotatingApertureMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new RotatingApertureMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): RotatingApertureMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: RotatingApertureMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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

# setFeatures

▸ setFeatures(features: FeatureCollection<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

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 / Exports / default / RotatingTextBorderMarker

# Class: RotatingTextBorderMarker

default.RotatingTextBorderMarker

旋转的文本框.

# Hierarchy

  • MarkerBase

    ↳ RotatingTextBorderMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new RotatingTextBorderMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): RotatingTextBorderMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: RotatingTextBorderMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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

# _setMarkerContainerProperty

▸ _setMarkerContainerProperty(properties: any, index?: number): void

# Parameters
Name Type
properties any
index? number

Returns: void

# createMarker

▸ createMarker(options?: createMarkerOptions, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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

# setFeatures

▸ setFeatures(features: FeatureCollection<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: void

Inherited from: MarkerBase.setFeatures

# setMarkersColors

▸ setMarkersColors(colors: string[], index?: number): void

# Parameters
Name Type
colors string[]
index? number

Returns: void

# setMarkersHeight

▸ setMarkersHeight(height: number): void

# Parameters
Name Type
height 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

Overrides: MarkerBase.setMarkersTextColor

# setMarkersTextField

▸ setMarkersTextField(textField: string, index?: number): void

# Parameters
Name Type
textField string
index? number

Returns: void

Overrides: MarkerBase.setMarkersTextField

# setMarkersTextFontSize

▸ setMarkersTextFontSize(textFontSize: number, index?: number): void

# Parameters
Name Type
textFontSize number
index? number

Returns: void

Overrides: MarkerBase.setMarkersTextFontSize

# setMarkersWidth

▸ setMarkersWidth(width: number): void

# Parameters
Name Type
width number

Returns: void

vjmap / Exports / default / Service

# Class: Service

default.Service

Service 服务类.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Service(url: string, token?: string, req?: IRequest): Service

构造函数

# Parameters
Name Type Description
url string 服务地址
token? string 访问凭证
req? IRequest 请求的方法实现（默认内部实现)

Returns: Service

# Properties

# accessToken

• accessToken: string= ""

访问凭证

# serverUrl

• serverUrl: string= ""

服务器地址

# Methods

# addAccessKey

▸ addAccessKey(key: string): Set<string>

增加访问key

# Parameters
Name Type Description
key string key值

Returns: Set<string>

# addSecretKey

▸ addSecretKey(key: string): Set<string>

增加秘钥key

# Parameters
Name Type Description
key string key值

Returns: Set<string>

# baseUrl

▸ baseUrl(): string

服务根地址

Returns: string

# blankTileUrl

▸ blankTileUrl(): string

空白瓦片地址

Returns: string

# checkFileHasUpload

▸ checkFileHasUpload(filemd5: string): Promise<any>

检查文件是否上传过

# Parameters
Name Type Description
filemd5 string 文件md5值

Returns: Promise<any>

# clearCache

▸ clearCache(prefix?: string): Promise<{}>

清空服务器缓存数据

# Parameters
Name Type Default value Description
prefix string "" key前缀

Returns: Promise<{}>

# clone

▸ clone(isCloneWorkspace?: boolean): Service

克隆一个新的服务实例对象

# Parameters
Name Type Description
isCloneWorkspace? boolean 是否克隆当前工作区 (默认是)

Returns: Service

Service

# cmdClearMapCache

▸ cmdClearMapCache(mapid: string, version: string): Promise<any>

清空地图的几何和瓦片缓存数据

# Parameters
Name Type Description
mapid string 地图ID
version string 版本号

Returns: Promise<any>

# cmdClearTileCache

▸ cmdClearTileCache(mapid: string, version: string): Promise<any>

清空地图的瓦片缓存数据

# Parameters
Name Type Description
mapid string 地图ID
version string 版本号

Returns: Promise<any>

# cmdCreateEntitiesGeomData

▸ cmdCreateEntitiesGeomData(param: ICreateEntitiesGeomData, cb?: (point: [number, number]) => undefined | null | [number, number]): Promise<any>

获取创建实体的几何数据

# Parameters
Name Type Description
param ICreateEntitiesGeomData 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: Promise<any>

# cmdDeleteCache

▸ cmdDeleteCache(param: IDeleteCache): Promise<any>

删除地图缓存

# Parameters
Name Type Description
param IDeleteCache 缓存接口

Returns: Promise<any>

# cmdDeleteMap

▸ cmdDeleteMap(mapid: string, version: string, retainVersionMaxCount?: number): Promise<any>

删除地图

# Parameters
Name Type Description
mapid string 地图ID
version string 版本号，如删除所有版本，输入"*"号
retainVersionMaxCount? number 删除所有版本时，保留的最新的版本总数。如总共有10个版本，retainVersionMaxCount为3时，会保存最新的3个版本，其余的都会删除

Returns: Promise<any>

# cmdDeleteStyle

▸ cmdDeleteStyle(param: IDeleteStyle): Promise<any>

删除地图样式

# Parameters
Name Type Description
param IDeleteStyle 样式接口

Returns: Promise<any>

# cmdExportLayout

▸ cmdExportLayout(param: IExportLayout): Promise<any>

导出布局空间为dwg图

# Parameters
Name Type Description
param IExportLayout 参数

Returns: Promise<any>

# cmdGetAccessKey

▸ cmdGetAccessKey(mapid: string, key: string): Promise<any>

获取地图的AccessKey，获取之前请确保已成功打开了地图

# Parameters
Name Type Description
mapid string 地图ID
key string secretKey秘钥和超级管理员superKey

Returns: Promise<any>

# cmdGetDrawBounds

▸ cmdGetDrawBounds(mapid?: string, version?: string): Promise<null | GeoBounds>

获取图形中有数据的范围区域

# Parameters
Name Type Description
mapid? string 地图id
version? string 版本号

Returns: Promise<null | GeoBounds>

# cmdGetSupportFormat

▸ cmdGetSupportFormat(): Promise<any>

获取支持的格式类型

Returns: Promise<any>

# cmdMapDiff

▸ cmdMapDiff(param: IMapDiff): Promise<any>

比较地图不同

# Parameters
Name Type Description
param IMapDiff 组合参数

Returns: Promise<any>

# cmdMatchObject

▸ cmdMatchObject(param: IMatchObject): Promise<any>

目标匹配

# Parameters
Name Type Description
param IMatchObject 参数

Returns: Promise<any>

# cmdPrjWktToPrj4

▸ cmdPrjWktToPrj4(wkt: string, from?: "" | "url" | "wmsauto" | "xml" | "urn" | "crsurl" | "micoordsys" | "pci"): Promise<any>

投影prj文件WKT字符转proj4字符串

# Parameters
Name Type Description
wkt string -
from? "" | "url" | "wmsauto" | "xml" | "urn" | "crsurl" | "micoordsys" | "pci" 字符串来源，为空为话为WKT

Returns: Promise<any>

# cmdRenameMap

▸ cmdRenameMap(oldMapID: string, newMapID: string): Promise<any>

地图ID重命名

# Parameters
Name Type Description
oldMapID string 旧地图ID
newMapID string 新地图ID

Returns: Promise<any>

# cmdResetAccessKey

▸ cmdResetAccessKey(mapid: string, key: string): Promise<any>

重置地图的AccessKey，获取之前请确保已成功打开了地图

# Parameters
Name Type Description
mapid string 地图ID
key string secretKey秘钥和超级管理员superKey

Returns: Promise<any>

# cmdRunStatus

▸ cmdRunStatus(bDetail?: boolean): Promise<any>

获取当前运行状态

# Parameters
Name Type Description
bDetail? boolean 是否需要细节 (默认false)

Returns: Promise<any>

# cmdSetMapPassword

▸ cmdSetMapPassword(mapid: string, key: string, newKey: string): Promise<any>

重置地图的密码，如果之前有密码，则是修改密码。如果之前没有密码，则是把此地图设置了密码保护。如果设置密码为空，则取消对此地图的密码保护。

# Parameters
Name Type Description
mapid string 地图ID
key string 旧的secretKey秘钥和超级管理员superKey
newKey string 新的secretKey秘钥

Returns: Promise<any>

# cmdSliceLayer

▸ cmdSliceLayer(param: ISliceLayer): Promise<any>

对图层进行切片缓存

# Parameters
Name Type
param ISliceLayer

Returns: Promise<any>

# cmdSwitchLayers

▸ cmdSwitchLayers(visibleLayers: string[]): Promise<any>

切换图层

# Parameters
Name Type Description
visibleLayers string[] 让可见的图层列表数组

Returns: Promise<any>

# cmdTransform

▸ cmdTransform(srs: string, crs: string, points: GeoPoint | GeoPoint[], fourParameter?: string | string[], isInverseFourParamter?: boolean): Promise<any>

坐标转换

# Parameters
Name Type Description
srs string 源坐标系名称，如 EPSG:4326
crs string 目标坐标系名称，如 EPSG:3857
points GeoPoint | GeoPoint[] 要转换的坐标
fourParameter? string | string[] 四参数(x偏移,y偏移,缩放，旋转弧度)，可选，对坐标最后进行修正
isInverseFourParamter? boolean 是否是上面四参数坐标的反算

Returns: Promise<any>

# cmdUpdateStyle

▸ cmdUpdateStyle(param: IUpdateStyle): Promise<any>

更新样式

# Parameters
Name Type Description
param IUpdateStyle 样式参数

Returns: Promise<any>

Example:

const res = svc.cmdUpdateStyle({
    name: "style1",
    layeron: [0,1,2,4,5,6,7,8,9],
    layeroff: "",
    clipbounds: "",
    backcolor: 0,
    lineweight:[1,1,0]
    expression: "gOutColorRed := gInColorGreen;gOutColorGreen := gInColorBlue;gOutColorBlue := gInColorRed;gOutColorAlpha := gInColorAlpha;"
});
1
2
3
4
5
6
7
8
9

# composeNewMap

▸ composeNewMap(param: IComposeNewMap | IComposeNewMap[]): Promise<any>

组合成新地图

# Parameters
Name Type Description
param IComposeNewMap | IComposeNewMap[] 组合参数

Returns: Promise<any>

# conditionQueryFeature

▸ conditionQueryFeature(param: IConditionQueryFeatures, cb?: (point: [number, number]) => undefined | null | [number, number]): Promise<any>

条件查询实体

# Parameters
Name Type Description
param IConditionQueryFeatures 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: Promise<any>

# createStyle

▸ createStyle(style: IMapStyleParam, mapid?: string, version?: string, isGeomLayer?: boolean): Promise<any>

获取样式图层名

# Parameters
Name Type Description
style IMapStyleParam 样式参数
mapid? string 地图ID
version? string 版本号，为空，则获取最新的;
isGeomLayer? boolean 几何渲染图层优先(默认true)

Returns: Promise<any>

# currentMapParam

▸ currentMapParam(): null | IOpenMapResponse

当前地图参数

Returns: null | IOpenMapResponse

# deleteCustomData

▸ deleteCustomData(key: string | string[], isPrefix?: boolean): Promise<any>

删除用户自定义数据

# Parameters
Name Type Description
key string | string[] 键名，如果是数组的话，可以查询
isPrefix? boolean 是否删除所有前缀为key的所有键值，默认false

Returns: Promise<any>

# execCommand

▸ execCommand(cmdname: string, param?: Record<string, any>, mapid?: string, version?: string, useGet?: boolean): Promise<any>

执行命令

# Parameters
Name Type
cmdname string
param? Record<string, any>
mapid? string
version? string
useGet? boolean

Returns: Promise<any>

# exprQueryFeature

▸ exprQueryFeature(param: IExprQueryFeatures, cb?: (point: [number, number]) => undefined | null | [number, number]): Promise<any>

表达式查询实体

# Parameters
Name Type Description
param IExprQueryFeatures 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: Promise<any>

# fileMd5

▸ fileMd5(file: File): Promise<any>

获取文件的Md5值

# Parameters
Name Type
file File

Returns: Promise<any>

# getConstData

▸ getConstData(): Promise<any>

获取服务后台常量设置

Returns: Promise<any>

# getCurWorkspaceName

▸ getCurWorkspaceName(): string

获取当前的工作区名称

Returns: string

# getCustomData

▸ getCustomData(key: string | string[], options?: { contentType?: "" | "image" ; retDataType?: "" | "value" | "prop" }): Promise<any>

获取用户自定义数据

# Parameters
Name Type Description
key string | string[] 键名，如果是数组的话，可以查询.
options? object 选项 retDataType为空时查询数据及属性,"value"只查询数据，"prop"只查询属性。contentType返回类型,为空时为json，为"image"时为图片.
options.contentType? "" | "image" -
options.retDataType? "" | "value" | "prop" -

Returns: Promise<any>

# getCustomDataKeysByPrefix

▸ getCustomDataKeysByPrefix(prefix: string): Promise<any>

通过前缀获取用户自定义数据的键值

# Parameters
Name Type Description
prefix string 键名前缀

Returns: Promise<any>

# getFontsCapacity

▸ getFontsCapacity(): Promise<{}>

得到所有矢量字体名称

Returns: Promise<{}>

# getMapLayers

▸ getMapLayers(): IMapLayer[]

得到地图图层集合，调用前请确保地图已打开，否则会抛异常

Returns: IMapLayer[]

# getSliceCacheZoom

▸ getSliceCacheZoom(param: ISliceCacheZoom): Promise<any>

获取已缓存的切片级别

# Parameters
Name Type Description
param ISliceCacheZoom 参数

Returns: Promise<any>

# getStyleLayerName

▸ getStyleLayerName(mapid: string, version?: string, isGeomLayer?: boolean, name?: string): Promise<any>

获取样式图层名

# Parameters
Name Type Description
mapid string 地图ID
version? string 版本号，为空，则获取最新的;
isGeomLayer? boolean 几何渲染图层优先(默认true)
name? string 有名称时，根据名称来查找;

Returns: Promise<any>

# getWorkspaces

▸ getWorkspaces(): Promise<any>

获取所有工作区(如果不是root权限的token获取非公开的工作区名称将返回空)

Returns: Promise<any>

# glyphsUrl

▸ glyphsUrl(): string

字体地址

Returns: string

# listMaps

▸ listMaps(mapid?: string | string[] | { curPage: number ; mapIds?: string[] ; pageCount: number }, version?: string): Promise<any>

获取所有地图信息

# Parameters
Name Type Default value Description
mapid string | string[] | { curPage: number ; mapIds?: string[] ; pageCount: number } "_" 地图ID，为空，则获取所有的；如果传入的是地图ID数组，则获取指定的地图ID数组的信息。如果不想一次性获取，可通过传入分页对象获取，如{curPage: 1, pageCount: 10}
version string "_" 版本号，为空，则获取最新的; * 则获取所有的版本

Returns: Promise<any>

# metadata

▸ metadata(mapid?: string, version?: string): Promise<any>

获取地图元数据

# Parameters
Name Type Description
mapid? string 地图ID ，为空, 则为当前打开的图形
version? string 版本号，为空 则为当前打开的版本;

Returns: Promise<any>

# openMap

▸ openMap(param: IOpenMapParam, isWaitFinish?: boolean): Promise<any>

打开图

# Parameters
Name Type Default value Description
param IOpenMapParam -
isWaitFinish boolean true 是否等待打开完成

Returns: Promise<any>

# pointQueryFeature

▸ pointQueryFeature(param: IPointQueryFeatures, cb?: (point: [number, number]) => undefined | null | [number, number]): Promise<any>

点查询实体

# Parameters
Name Type Description
param IPointQueryFeatures 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: Promise<any>

# processQueryResult

▸ processQueryResult(param: any, cb?: (point: [number, number]) => undefined | null | [number, number]): any

处理查询结果

# Parameters
Name Type Description
param any 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: any

# pwdToSecretKey

▸ pwdToSecretKey(pwd: string): string

密码转换为秘钥

# Parameters
Name Type Description
pwd string 密码

Returns: string

# qrcodeUrl

▸ qrcodeUrl(content: string, size?: number): string

二维码图片地址

# Parameters
Name Type Description
content string 生成二维码的内容
size? number 生成二维码的大小，默认256

Returns: string

# rasterBlankStyle

▸ rasterBlankStyle(minzoom?: number, maxzoom?: number, prefix?: string): Style

空白栅格style

# Parameters
Name Type Description
minzoom? number 最小级别，缺省0
maxzoom? number 最大级别，缺省24
prefix? string 前缀，缺省rasterBlank

Returns: Style

# rasterLayerId

▸ rasterLayerId(prefix?: string): string

获取栅格图层ID

# Parameters
Name Type
prefix? string

Returns: string

# rasterSourceId

▸ rasterSourceId(prefix?: string): string

获取栅格源ID

# Parameters
Name Type
prefix? string

Returns: string

# rasterStyle

▸ rasterStyle(tileUrl?: string, minzoom?: number, maxzoom?: number, prefix?: string): Style

栅格style

# Parameters
Name Type Description
tileUrl? string 栅格瓦片地址
minzoom? number 最小级别，缺省0
maxzoom? number 最大级别，缺省24
prefix? string 前缀，缺省raster

Returns: Style

# rasterTileUrl

▸ rasterTileUrl(param?: ITileUrlParam): string

栅格瓦片地址

# Parameters
Name Type Default value
param ITileUrlParam {}

Returns: string

# rectQueryFeature

▸ rectQueryFeature(param: IRectQueryFeatures, cb?: (point: [number, number]) => undefined | null | [number, number]): Promise<any>

矩形查询实体

# Parameters
Name Type Description
param IRectQueryFeatures 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: Promise<any>

# removeAccessKey

▸ removeAccessKey(key: string): void

移除访问key, 如果key为undefined时，则移除所有的

# Parameters
Name Type Description
key string key值

Returns: void

# removeSecretKey

▸ removeSecretKey(key: string): undefined | Set<string>

移除秘钥key, 如果key为undefined时，则移除所有的

# Parameters
Name Type Description
key string key值

Returns: undefined | Set<string>

# saveCustomData

▸ saveCustomData(key: string | { key: string ; prop?: any ; ttl?: number ; value: any }[], value?: any, prop?: any, ttl?: number): Promise<any>

保存用户自定义数据

# Parameters
Name Type Description
key string | { key: string ; prop?: any ; ttl?: number ; value: any }[] 键名(必须唯一，否则会覆盖之前的数据，同类型的key前缀尽量一样)，如果是数组的话，可以批量
value? any 键值
prop? any 属性值
ttl? number 有效时间，单位秒，默认长期有效

Returns: Promise<any>

# serviceUrl

▸ serviceUrl(u: string): string

得到服务地址

# Parameters
Name Type Description
u string 要拼接的地址

Returns: string

string

# setCurrentMapParam

▸ setCurrentMapParam(param: IOpenMapResponse): null | IOpenMapResponse

设置打开地图参数

# Parameters
Name Type
param IOpenMapResponse

Returns: null | IOpenMapResponse

# setSprite

▸ setSprite(name: string): string

设置精灵图片名称

# Parameters
Name Type Description
name string 精灵名称

Returns: string

# spriteUrl

▸ spriteUrl(name: string): string

精灵图片名称

# Parameters
Name Type Description
name string 精灵名称

Returns: string

# strMd5

▸ strMd5(str: string): string

获取字符串的Md5值

# Parameters
Name Type
str string

Returns: string

# styleVersion

▸ styleVersion(): number

得到style的版本号

Returns: number

# switchWorkspace

▸ switchWorkspace(workspaceName: string): void

切换至工作区

# Parameters
Name Type Description
workspaceName string 工作区名称

Returns: void

# thumbnailUrl

▸ thumbnailUrl(mapid?: string, version?: string, width?: number, height?: number, darkTheme?: boolean): string

获取图的缩略图

# Parameters
Name Type Description
mapid? string
version? string
width? number
height? number
darkTheme? boolean 是否是深色主题，是的话，图片将反色（黑色变白色）

Returns: string

# toLayerIndex

▸ toLayerIndex(layernames: string[], layers: any[]): number[]

把图层名称数组转成图层索引数组

# Parameters
Name Type Description
layernames string[] 图层名称数组
layers any[] 图层列表

Returns: number[]

# updateMap

▸ updateMap(param: IUpdateMapParam, isWaitFinish?: boolean): Promise<any>

更新地图

# Parameters
Name Type Default value Description
param IUpdateMapParam -
isWaitFinish boolean true 是否等待打开完成

Returns: Promise<any>

# updateMetadata

▸ updateMetadata(meta: Record<string, undefined | null | string | number | boolean>, mapid?: string, version?: string): Promise<any>

修改地图元数据

# Parameters
Name Type Description
meta Record<string, undefined | null | string | number | boolean> 要修改的元数据项
mapid? string 地图ID ，为空, 则为当前打开的图形
version? string 版本号，为空 则为当前打开的版本;

Returns: Promise<any>

# uploadMap

▸ uploadMap(file: File): Promise<any>

上传地图

# Parameters
Name Type
file File

Returns: Promise<any>

# uploadUrl

▸ uploadUrl(): string

返回上传文件的url地址

Returns: string

# vectorStyle

▸ vectorStyle(tileUrl?: string | Record<string, any>, minzoom?: number, maxzoom?: number, prefix?: string, hoverColor?: string, hoverOpacity?: number, hoverLineWidth?: number, customColorCaseExpr?: any[], customOpacityCaseExpr?: any[], customLineWidthCaseExpr?: any[], disableHover?: boolean): Style

矢量style

# Parameters
Name Type Description
tileUrl? string | Record<string, any> 矢量瓦片地址 或者为一个Object，为Object时，设置项为参数的每个项值，做为一个参数传入
minzoom? number 最小级别，缺省0
maxzoom? number 最大级别，缺省24
prefix? string 前缀，缺省vector
hoverColor? string 高亮时颜色，缺省rgba(0,0,255,255)
hoverOpacity? number 高亮时透明度,缺省0.5
hoverLineWidth? number 高亮时线宽,缺省3
customColorCaseExpr? any[] 自定义颜色表达式，必须为数组[条件1，值，条件2，值,...]，如[['==', ['feature-state', 'status'], 'alarm'], '#ff0000', ['==', ['feature-state', 'status'], 'normal'], '#00ff00'],缺省默认
customOpacityCaseExpr? any[] 自定义透明度表达式，必须为数组,缺省默认
customLineWidthCaseExpr? any[] 自定义线宽表达式，必须为数组,缺省默认
disableHover? boolean 禁止hover

Returns: Style

# vectorTileUrl

▸ vectorTileUrl(param?: ITileUrlParam): string

矢量瓦片地址

# Parameters
Name Type Default value
param ITileUrlParam {}

Returns: string

# waitMapOpenFinish

▸ waitMapOpenFinish(mapid: string, version: string, tryTime?: number, maxTryTimes?: number): Promise<any>

等待地图打开完成

# Parameters
Name Type Default value Description
mapid string - 地图ID
version string - 地图版本号
tryTime number 5 每次尝试时间间隔(秒)
maxTryTimes number 120 最大尝试次数

Returns: Promise<any>

# webMapUrl

▸ webMapUrl(tileProvider: { fourParameterAfter?: string ; fourParameterBefore?: string ; mapbounds?: string ; srs?: string ; tileCrs?: "gcj02" | "wgs84" ; tileFlipY?: boolean ; tileMaxZoom?: number ; tileRetina?: number ; tileShards?: string ; tileSize?: number ; tileToken?: string | string[] ; tileUrl: string | string[] }): string

获取服务器地图服务地址

# Parameters
Name Type
tileProvider object
tileProvider.fourParameterAfter? string
tileProvider.fourParameterBefore? string
tileProvider.mapbounds? string
tileProvider.srs? string
tileProvider.tileCrs? "gcj02" | "wgs84"
tileProvider.tileFlipY? boolean
tileProvider.tileMaxZoom? number
tileProvider.tileRetina? number
tileProvider.tileShards? string
tileProvider.tileSize? number
tileProvider.tileToken? string | string[]
tileProvider.tileUrl string | string[]

Returns: string

# wmsTileUrl

▸ wmsTileUrl(param: IWmsTileUrl): string

# Parameters
Name Type
param IWmsTileUrl

Returns: string

# workspaceCreate

▸ workspaceCreate(workspace: IWorkspace): Promise<any>

创建工作区(默认需要root权限)

# Parameters
Name Type Description
workspace IWorkspace 工作区设置

Returns: Promise<any>

# workspaceDelete

▸ workspaceDelete(name: string): Promise<any>

删除工作区（会同时删除工作区下面的所有目录文件）(默认需要root权限)

# Parameters
Name Type Description
name string 要删除的工作区名称

Returns: Promise<any>

# workspaceModify

▸ workspaceModify(workspace: IWorkspace): Promise<any>

修改工作区(默认需要root权限)

# Parameters
Name Type Description
workspace IWorkspace 工作区

Returns: Promise<any>

vjmap / Exports / default / SkyLayer

# Class: SkyLayer

default.SkyLayer

创建天空图层.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new SkyLayer(options: SkyLayerOptions): SkyLayer

# Parameters
Name Type
options SkyLayerOptions

Returns: SkyLayer

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: SkyLayerOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSkyAtmosphereColor

▸ getSkyAtmosphereColor(): string

Returns: string

# getSkyAtmosphereHaloColor

▸ getSkyAtmosphereHaloColor(): string

Returns: string

# getSkyAtmosphereSun

▸ getSkyAtmosphereSun(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getSkyAtmosphereSunIntensity

▸ getSkyAtmosphereSunIntensity(): number

Returns: number

# getSkyGradient

▸ getSkyGradient(): ExpressionSpecificationEx

Returns: ExpressionSpecificationEx

# getSkyGradientCenter

▸ getSkyGradientCenter(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getSkyGradientRadius

▸ getSkyGradientRadius(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getSkyOpacity

▸ getSkyOpacity(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getSkyType

▸ getSkyType(): PropertyValueSpecificationEx<"gradient" | "atmosphere">

Returns: PropertyValueSpecificationEx<"gradient" | "atmosphere">

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# setSkyAtmosphereColor

▸ setSkyAtmosphereColor(value: string): SkyLayer

# Parameters
Name Type
value string

Returns: SkyLayer

# setSkyAtmosphereHaloColor

▸ setSkyAtmosphereHaloColor(value: string): SkyLayer

# Parameters
Name Type
value string

Returns: SkyLayer

# setSkyAtmosphereSun

▸ setSkyAtmosphereSun(value: PropertyValueSpecificationEx<[number, number]>): SkyLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: SkyLayer

# setSkyAtmosphereSunIntensity

▸ setSkyAtmosphereSunIntensity(value: number): SkyLayer

# Parameters
Name Type
value number

Returns: SkyLayer

# setSkyGradient

▸ setSkyGradient(value: ExpressionSpecificationEx): SkyLayer

# Parameters
Name Type
value ExpressionSpecificationEx

Returns: SkyLayer

# setSkyGradientCenter

▸ setSkyGradientCenter(value: PropertyValueSpecificationEx<[number, number]>): SkyLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: SkyLayer

# setSkyGradientRadius

▸ setSkyGradientRadius(value: PropertyValueSpecificationEx<number>): SkyLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: SkyLayer

# setSkyOpacity

▸ setSkyOpacity(value: PropertyValueSpecificationEx<number>): SkyLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: SkyLayer

# setSkyType

▸ setSkyType(value: PropertyValueSpecificationEx<"gradient" | "atmosphere">): SkyLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<"gradient" | "atmosphere">

Returns: SkyLayer

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / default / SvgOverlay

# Class: SvgOverlay

default.SvgOverlay

在一个地理范围内创建一个随缩放而缩放的svg的覆盖物，(注：svg覆盖物性能低，不建议大量使用，同时在级别特别大时会导致失真，在倾斜角很大时会导致不可见)

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new SvgOverlay(options?: SvgOverlayOptions): SvgOverlay

# Parameters
Name Type
options? SvgOverlayOptions

Returns: SvgOverlay

# Properties

# divOverlay

• divOverlay: DivOverlay

# elements

• elements: SvgElementOptions[]

# options

• options: SvgOverlayOptions

# Methods

# addElement

▸ addElement(element: string | SvgElementOptions, noUpdate?: boolean): void

增加svg元素

# Parameters
Name Type Description
element string | SvgElementOptions 要增加的元素
noUpdate? boolean 不立即更新

Returns: void

# addElements

▸ addElements(elements: SvgElementOptions[], noUpdate?: boolean): void

增加svg元素

# Parameters
Name Type Description
elements SvgElementOptions[] 多个元素内容
noUpdate? boolean 不立即更新

Returns: void

# addTo

▸ addTo(map: Map, insertId?: string | HTMLElement): void

# Parameters
Name Type
map Map
insertId? string | HTMLElement

Returns: void

# getElements

▸ getElements(): SvgElementOptions[]

获取所有的元素

Returns: SvgElementOptions[]

# getSvgContainer

▸ getSvgContainer(): SVGSVGElement

获取svg获取

Returns: SVGSVGElement

# remove

▸ remove(): void

Returns: void

# removeElements

▸ removeElements(id: string | string[]): SvgElementOptions[]

移动一个元素

# Parameters
Name Type
id string | string[]

Returns: SvgElementOptions[]

# updateElements

▸ updateElements(elements: SvgElementOptions | SvgElementOptions[]): SvgElementOptions[]

更新一个元素

# Parameters
Name Type
elements SvgElementOptions | SvgElementOptions[]

Returns: SvgElementOptions[]

# attr_cx_cy_r

▸ Static attr_cx_cy_r(cx: number, cy: number, r: number): string

圆心半径属性字符串

# Parameters
Name Type
cx number
cy number
r number

Returns: string

# attr_cx_cy_rx_ry

▸ Static attr_cx_cy_rx_ry(cx: number, cy: number, rx: number, ry: number): string

椭圆心半径属性字符串

# Parameters
Name Type
cx number
cy number
rx number
ry number

Returns: string

# attr_fontsize

▸ Static attr_fontsize(fontsize: number): string

字体属性字符串

# Parameters
Name Type
fontsize number

Returns: string

# attr_length

▸ Static attr_length(len: number): string

和长度有关属性字符串

# Parameters
Name Type
len number

Returns: string

# attr_path

▸ Static attr_path(points: GeoPoint[]): string

路径序列属性字符串

# Parameters
Name Type
points GeoPoint[]

Returns: string

# attr_point

▸ Static attr_point(point: GeoPoint, joinComma?: boolean): string

和点坐标有关属性字符串

# Parameters
Name Type
point GeoPoint
joinComma? boolean

Returns: string

# attr_points

▸ Static attr_points(points: GeoPoint[]): string

坐标序列属性字符串

# Parameters
Name Type
points GeoPoint[]

Returns: string

# attr_x1_y1_x2_y2

▸ Static attr_x1_y1_x2_y2(x1: number, y1: number, x2: number, y2: number): string

直线坐标属性字符串

# Parameters
Name Type
x1 number
y1 number
x2 number
y2 number

Returns: string

# attr_x_y

▸ Static attr_x_y(x: number, y: number): string

坐标属性字符串

# Parameters
Name Type
x number
y number

Returns: string

# attr_x_y_w_h

▸ Static attr_x_y_w_h(x: number, y: number, w: number, h: number): string

坐标宽高属性字符串

# Parameters
Name Type
x number
y number
w number
h number

Returns: string

vjmap / Exports / default / Symbol

# Class: Symbol

default.Symbol

创建符号图层.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Symbol(options: SymbolOptions): Symbol

# Parameters
Name Type
options SymbolOptions

Returns: Symbol

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: SymbolOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getIconAllowOverlap

▸ getIconAllowOverlap(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getIconAnchor

▸ getIconAnchor(): DataDrivenPropertyValueSpecification<Anchor>

Returns: DataDrivenPropertyValueSpecification<Anchor>

# getIconColor

▸ getIconColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getIconHaloBlur

▸ getIconHaloBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getIconHaloColor

▸ getIconHaloColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getIconHaloWidth

▸ getIconHaloWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getIconIgnorePlacement

▸ getIconIgnorePlacement(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getIconImage

▸ getIconImage(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getIconKeepUpright

▸ getIconKeepUpright(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getIconOffset

▸ getIconOffset(): DataDrivenPropertyValueSpecification<[number, number]>

Returns: DataDrivenPropertyValueSpecification<[number, number]>

# getIconOpacity

▸ getIconOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getIconOptional

▸ getIconOptional(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getIconPadding

▸ getIconPadding(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getIconPitchAlignment

▸ getIconPitchAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">

# getIconRotate

▸ getIconRotate(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getIconRotationAlignment

▸ getIconRotationAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">

# getIconSize

▸ getIconSize(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getIconTextFit

▸ getIconTextFit(): PropertyValueSpecificationEx<"none" | "width" | "height" | "both">

Returns: PropertyValueSpecificationEx<"none" | "width" | "height" | "both">

# getIconTextFitPadding

▸ getIconTextFitPadding(): PropertyValueSpecificationEx<[number, number, number, number]>

Returns: PropertyValueSpecificationEx<[number, number, number, number]>

# getIconTranslate

▸ getIconTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getIconTranslateAnchor

▸ getIconTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getSymbolAvoidEdges

▸ getSymbolAvoidEdges(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getSymbolPlacement

▸ getSymbolPlacement(): PropertyValueSpecificationEx<"line" | "point" | "line-center">

Returns: PropertyValueSpecificationEx<"line" | "point" | "line-center">

# getSymbolSortKey

▸ getSymbolSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getSymbolSpacing

▸ getSymbolSpacing(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getSymbolZOrder

▸ getSymbolZOrder(): PropertyValueSpecificationEx<"source" | "auto" | "viewport-y">

Returns: PropertyValueSpecificationEx<"source" | "auto" | "viewport-y">

# getTextAllowOverlap

▸ getTextAllowOverlap(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getTextAnchor

▸ getTextAnchor(): DataDrivenPropertyValueSpecification<Anchor>

Returns: DataDrivenPropertyValueSpecification<Anchor>

# getTextColor

▸ getTextColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getTextField

▸ getTextField(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getTextFont

▸ getTextFont(): DataDrivenPropertyValueSpecification<string[]>

Returns: DataDrivenPropertyValueSpecification<string[]>

# getTextHaloBlur

▸ getTextHaloBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextHaloColor

▸ getTextHaloColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getTextHaloWidth

▸ getTextHaloWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextIgnorePlacement

▸ getTextIgnorePlacement(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getTextJustify

▸ getTextJustify(): DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto">

Returns: DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto">

# getTextKeepUpright

▸ getTextKeepUpright(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getTextLetterSpacing

▸ getTextLetterSpacing(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextLineHeight

▸ getTextLineHeight(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextMaxAngle

▸ getTextMaxAngle(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getTextMaxWidth

▸ getTextMaxWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextOffset

▸ getTextOffset(): DataDrivenPropertyValueSpecification<[number, number]>

Returns: DataDrivenPropertyValueSpecification<[number, number]>

# getTextOpacity

▸ getTextOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextOptional

▸ getTextOptional(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getTextPadding

▸ getTextPadding(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getTextPitchAlignment

▸ getTextPitchAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">

# getTextRadialOffset

▸ getTextRadialOffset(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextRotate

▸ getTextRotate(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextRotationAlignment

▸ getTextRotationAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">

# getTextSize

▸ getTextSize(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextTransform

▸ getTextTransform(): DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">

Returns: DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">

# getTextTranslate

▸ getTextTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getTextTranslateAnchor

▸ getTextTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getTextVariableAnchor

▸ getTextVariableAnchor(): PropertyValueSpecificationEx<Anchor[]>

Returns: PropertyValueSpecificationEx<Anchor[]>

# getTextWritingMode

▸ getTextWritingMode(): PropertyValueSpecificationEx<("vertical" | "horizontal")[]>

Returns: PropertyValueSpecificationEx<("vertical" | "horizontal")[]>

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setIconAllowOverlap

▸ setIconAllowOverlap(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setIconAnchor

▸ setIconAnchor(value: DataDrivenPropertyValueSpecification<Anchor>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<Anchor>

Returns: Symbol

# setIconColor

▸ setIconColor(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setIconHaloBlur

▸ setIconHaloBlur(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setIconHaloColor

▸ setIconHaloColor(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setIconHaloWidth

▸ setIconHaloWidth(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setIconIgnorePlacement

▸ setIconIgnorePlacement(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setIconImage

▸ setIconImage(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setIconKeepUpright

▸ setIconKeepUpright(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setIconOffset

▸ setIconOffset(value: DataDrivenPropertyValueSpecification<[number, number]>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<[number, number]>

Returns: Symbol

# setIconOpacity

▸ setIconOpacity(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setIconOptional

▸ setIconOptional(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setIconPadding

▸ setIconPadding(value: PropertyValueSpecificationEx<number>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Symbol

# setIconPitchAlignment

▸ setIconPitchAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: Symbol

# setIconRotate

▸ setIconRotate(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setIconRotationAlignment

▸ setIconRotationAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: Symbol

# setIconSize

▸ setIconSize(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setIconTextFit

▸ setIconTextFit(value: PropertyValueSpecificationEx<"none" | "width" | "height" | "both">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"none" | "width" | "height" | "both">

Returns: Symbol

# setIconTextFitPadding

▸ setIconTextFitPadding(value: PropertyValueSpecificationEx<[number, number, number, number]>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number, number, number]>

Returns: Symbol

# setIconTranslate

▸ setIconTranslate(value: PropertyValueSpecificationEx<[number, number]>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: Symbol

# setIconTranslateAnchor

▸ setIconTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Symbol

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# setSymbolAvoidEdges

▸ setSymbolAvoidEdges(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setSymbolPlacement

▸ setSymbolPlacement(value: PropertyValueSpecificationEx<"line" | "point" | "line-center">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"line" | "point" | "line-center">

Returns: Symbol

# setSymbolSortKey

▸ setSymbolSortKey(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setSymbolSpacing

▸ setSymbolSpacing(value: PropertyValueSpecificationEx<number>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Symbol

# setSymbolZOrder

▸ setSymbolZOrder(value: PropertyValueSpecificationEx<"source" | "auto" | "viewport-y">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"source" | "auto" | "viewport-y">

Returns: Symbol

# setTextAllowOverlap

▸ setTextAllowOverlap(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setTextAnchor

▸ setTextAnchor(value: DataDrivenPropertyValueSpecification<Anchor>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<Anchor>

Returns: Symbol

# setTextColor

▸ setTextColor(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setTextField

▸ setTextField(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setTextFont

▸ setTextFont(value: DataDrivenPropertyValueSpecification<string[]>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string[]>

Returns: Symbol

# setTextHaloBlur

▸ setTextHaloBlur(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextHaloColor

▸ setTextHaloColor(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setTextHaloWidth

▸ setTextHaloWidth(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextIgnorePlacement

▸ setTextIgnorePlacement(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setTextJustify

▸ setTextJustify(value: DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto">): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto">

Returns: Symbol

# setTextKeepUpright

▸ setTextKeepUpright(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setTextLetterSpacing

▸ setTextLetterSpacing(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextLineHeight

▸ setTextLineHeight(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextMaxAngle

▸ setTextMaxAngle(value: PropertyValueSpecificationEx<number>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Symbol

# setTextMaxWidth

▸ setTextMaxWidth(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextOffset

▸ setTextOffset(value: DataDrivenPropertyValueSpecification<[number, number]>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<[number, number]>

Returns: Symbol

# setTextOpacity

▸ setTextOpacity(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextOptional

▸ setTextOptional(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setTextPadding

▸ setTextPadding(value: PropertyValueSpecificationEx<number>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Symbol

# setTextPitchAlignment

▸ setTextPitchAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: Symbol

# setTextRadialOffset

▸ setTextRadialOffset(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextRotate

▸ setTextRotate(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextRotationAlignment

▸ setTextRotationAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: Symbol

# setTextSize

▸ setTextSize(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextTransform

▸ setTextTransform(value: DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">

Returns: Symbol

# setTextTranslate

▸ setTextTranslate(value: PropertyValueSpecificationEx<[number, number]>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: Symbol

# setTextTranslateAnchor

▸ setTextTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Symbol

# setTextVariableAnchor

▸ setTextVariableAnchor(value: PropertyValueSpecificationEx<Anchor[]>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<Anchor[]>

Returns: Symbol

# setTextWritingMode

▸ setTextWritingMode(value: PropertyValueSpecificationEx<("vertical" | "horizontal")[]>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<("vertical" | "horizontal")[]>

Returns: Symbol

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / default / Text

# Class: Text

default.Text

创建文本组件.

param

param 文字内容

param 文字样式

param 用作文本的 DOM 元素。

param 一个字符串，指示应该放置在最靠近坐标的标记部分。选项有“center”、“top”、“bottom”、“left”、“right”、“top-left”、“top-right”、“top-right” “左下”和“右下”.

param 作为要应用的对象相对于元素中心的偏移量（以像素为单位）。负数表示向左和向上.

param 如果未提供options.element.

param 如果未提供options.element，则用于默认文本的比例。.

param 一个布尔值，指示是否可以将文本拖动到地图上的新位置.

param 用户在单击文本期间可以移动鼠标指针以将其视为有效单击（与文本拖动相反）的最大像素数。默认是继承地图的clickTolerance.

param 文本相对于其各自的“rotationAlignment”设置的旋转角度（以度为单位）。正值将顺时针旋转文本.

param map 将 Text 与地图平面对齐。 viewport 将 Text 与视口平面对齐。 auto 自动匹配 rotationAlignment 的值.

param map 对齐 Text 相对于地图的旋转，在地图旋转时保持方位。 viewport 对齐 Text 相对于视口的旋转，与地图旋转无关。 auto 等价于 viewport.

example // Create a new Text. const text = new vjmap.Text({text: "abc“}) .setLngLat([30.5, 50.5]) .addTo(map);

example // Set text options. const text = new vjmap.Text({ text: "abc“, draggable: true }).setLngLat([30.5, 50.5]) .addTo(map);

# Hierarchy

  • Evented

    ↳ Text

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Text(options?: TextOptions): Text

构造函数

# Parameters
Name Type
options? TextOptions

Returns: Text

Overrides: Evented.constructor

# Properties

# _style

• _style: object

# _textContainerDom

• _textContainerDom: HTMLElement

# Methods

# addTo

▸ addTo(map: Map): Text

将 Text 附加到 Map 对象。

example const text = new vjmap.Text({text: "abc"}) .setLngLat([30.5, 50.5]) .addTo(map); // add the text to the map

# Parameters
Name Type Description
map Map to add the text to.

Returns: Text

Returns itself to allow for method chaining.

# getElement

▸ getElement(): HTMLElement

返回 Text 的 HTML 元素。

example const element = text.getElement();

Returns: HTMLElement

Returns the text element.

# getLngLat

▸ getLngLat(): LngLatLike

得到经纬度

Returns: LngLatLike

# getMarker

▸ getMarker(): Marker

返回 Text 的 Marker 对象。

Returns: Marker

# getOffset

▸ getOffset(): number

获取文本的偏移量.

Returns: number

The text's screen coordinates in pixels.

# getPitchAlignment

▸ getPitchAlignment(): string

返回文本的当前 pitchAlignment 属性.

Returns: string

The current pitch alignment of the text in degrees.

# getPopup

▸ getPopup(): Popup

返回绑定到 Text 的 Popup 实例。

Returns: Popup

Returns the popup.

# getRotation

▸ getRotation(): number

返回文本的当前旋转角度（以度为单位）.

Returns: number

The current rotation angle of the text.

# getRotationAlignment

▸ getRotationAlignment(): string

返回文本的当前 rotationAlignment 属性.

Returns: string

The current rotational alignment of the text.

# getStyle

▸ getStyle(): object

得到文本样式

Returns: object

# getText

▸ getText(): string

得到文本内容

Returns: string

# hide

▸ hide(): void

隐藏

Returns: void

# isDraggable

▸ isDraggable(): boolean

如果可以拖动文本，则返回 true。

Returns: boolean

True if the text is draggable.

# remove

▸ remove(): Text

从地图中删除文本。

example const text = new vjmap.Text().addTo(map); text.remove();

Returns: Text

Returns itself to allow for method chaining.

# setAnimation

▸ setAnimation(animationType: string): void

设置动画

# Parameters
Name Type Description
animationType string MAP_ANIMATION_NONE 无动画 MAP_ANIMATION_BOUNCE 弹跳 MAP_ANIMATION_DROP 坠落

Returns: void

# setCursor

▸ setCursor(cur: string): void

设置光标

# Parameters
Name Type Description
cur string 光标名称

Returns: void

# setDraggable

▸ setDraggable(shouldBeDraggable: boolean): Text

设置文本的 draggable 属性和功能.

# Parameters
Name Type
shouldBeDraggable boolean

Returns: Text

Returns itself to allow for method chaining.

# setLngLat

▸ setLngLat(lnglat: LngLatLike): Text

设置经纬度

# Parameters
Name Type
lnglat LngLatLike

Returns: Text

# setOffset

▸ setOffset(offset: PointLike): Text

设置文本的偏移量.

# Parameters
Name Type Description
offset PointLike 以像素为单位的偏移量，作为 PointLike 对象相对于元素的中心应用。负数表示向左和向上。

Returns: Text

Returns itself to allow for method chaining.

# setPitchAlignment

▸ setPitchAlignment(alignment: string): Text

设置文本的 pitchAlignment 属性.

# Parameters
Name Type
alignment string

Returns: Text

Returns itself to allow for method chaining.

# setPopup

▸ setPopup(popup?: Popup): Text

Binds a Popup to the Text

# Parameters
Name Type
popup? Popup

Returns: Text

# setRotation

▸ setRotation(rotation: number): Text

Sets the rotation property of the text.

# Parameters
Name Type
rotation number

Returns: Text

Returns itself to allow for method chaining.

# setRotationAlignment

▸ setRotationAlignment(alignment: string): Text

设置文本的 rotationAlignment 属性.

# Parameters
Name Type
alignment string

Returns: Text

Returns itself to allow for method chaining.

# setStyle

▸ setStyle(style?: object): Text

设置文本样式

# Parameters
Name Type Default value
style object {}

Returns: Text

# setText

▸ setText(txt: string): Text

设置文本内容

# Parameters
Name Type
txt string

Returns: Text

# show

▸ show(): void

显示

Returns: void

# togglePopup

▸ togglePopup(): Text

根据 Popup 的当前状态打开或关闭绑定到 Text 的 Popup 实例.

Returns: Text

Returns itself to allow for method chaining.

vjmap / Exports / default / ThreeLayer

# Class: ThreeLayer

default.ThreeLayer

threejs图层.

# Hierarchy

  • Evented

    ↳ ThreeLayer

# Implements

  • CustomLayerInterface

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new ThreeLayer(options: ThreeLayerOptions): ThreeLayer

# Parameters
Name Type
options ThreeLayerOptions

Returns: ThreeLayer

Overrides: Evented.constructor

# Properties

# context

• context: ThreeJsContext

# id

• id: string

Implementation of: CustomLayerInterface.id

# 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

vjmap / Exports / DiffusedApertureMarker

# Class: DiffusedApertureMarker

扩散的点.

# Hierarchy

  • MarkerBase

    ↳ DiffusedApertureMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new DiffusedApertureMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): DiffusedApertureMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: DiffusedApertureMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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

# setFeatures

▸ setFeatures(features: FeatureCollection<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

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 / Exports / DivOverlay

# Class: DivOverlay

在一个地理范围内创建一个随缩放而缩放的div的覆盖物 注：如果是svg，则需设置为 viewBox="0 0 width height" preserveAspectRatio="xMinYMin meet", updateDivSize选项设置为true

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new DivOverlay(options: DivOverlayOptions): DivOverlay

# Parameters
Name Type
options DivOverlayOptions

Returns: DivOverlay

# Properties

# _map

• Optional _map: Map

# isRemoved

• isRemoved: boolean

# isShow

• isShow: boolean

# maxPitch

• maxPitch: number

# maxZoom

• maxZoom: number

# minZoom

• minZoom: number

# options

• options: DivOverlayOptions

# parentContainer

• Optional parentContainer: HTMLElement

# Methods

# addTo

▸ addTo(map: Map, insertId?: string | HTMLElement): void

# Parameters
Name Type
map Map
insertId? string | HTMLElement

Returns: void

# remove

▸ remove(): void

Returns: void

# setVisible

▸ setVisible(visible?: boolean, isDisplay?: boolean): void

设置是否显示隐藏

# Parameters
Name Type Description
visible? boolean 是否显示
isDisplay? boolean true的话，表示用style的display去控制隐藏显示，dom还在文档中。false的话，会从文档动态清空增加

Returns: void

# updateBounds

▸ updateBounds(bounds: GeoBounds | [GeoPointLike, GeoPointLike, GeoPointLike, GeoPointLike]): void

# Parameters
Name Type
bounds GeoBounds | [GeoPointLike, GeoPointLike, GeoPointLike, GeoPointLike]

Returns: void

# updateSize

▸ updateSize(width: number, height: number): void

# Parameters
Name Type
width number
height number

Returns: void

vjmap / Exports / DrawTool

# Class: DrawTool

# Implements

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new DrawTool(options?: IDrawOptions): DrawTool

构造函数

# Parameters
Name Type
options? IDrawOptions

Returns: DrawTool

# Properties

# add

• add: (geojson: any) => string[]

此方法采用 GeoJSON Feature、FeatureCollection 或 Geometry 并将其添加到 Draw。它返回一个 id 数组，用于与添加的功能进行交互。如果某个功能没有自己的 id，则会自动生成一个

# Type declaration

▸ (geojson: any): string[]

# Parameters
Name Type
geojson any

Returns: string[]

Implementation of: IDrawTool.add

# changeMode

• changeMode: (mode: string, modeOptions?: any) => IDrawTool

将绘图更改为另一种模式。返回用于链接的绘制实例

# Type declaration

▸ (mode: string, modeOptions?: any): IDrawTool

# Parameters
Name Type
mode string
modeOptions? any

Returns: IDrawTool

Implementation of: IDrawTool.changeMode

# combineFeatures

• combineFeatures: () => IDrawTool

调用当前模式的combineFeatures操作。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

Implementation of: IDrawTool.combineFeatures

# delete

• delete: (featureIds: string | string[]) => IDrawTool

删除具有指定 ID 的功能。返回用于链接的绘制实例

# Type declaration

▸ (featureIds: string | string[]): IDrawTool

# Parameters
Name Type
featureIds string | string[]

Returns: IDrawTool

Implementation of: IDrawTool.delete

# deleteAll

• deleteAll: () => IDrawTool

删除所有功能。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

Implementation of: IDrawTool.deleteAll

# doAction

• doAction: (actionName: string) => any

在当前模式下执行动作

# Type declaration

▸ (actionName: string): any

# Parameters
Name Type
actionName string

Returns: any

Implementation of: IDrawTool.doAction

# forceRefresh

• forceRefresh: () => any

强制刷新

# Type declaration

▸ (): any

Returns: any

Implementation of: IDrawTool.forceRefresh

# get

• get: (id: string) => any

返回 Draw 中具有指定 id 的 GeoJSON 功能，或者undefined如果 id 不匹配任何功能

# Type declaration

▸ (id: string): any

# Parameters
Name Type
id string

Returns: any

Implementation of: IDrawTool.get

# getAll

• getAll: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回所有功能的 FeatureCollection

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

Implementation of: IDrawTool.getAll

# getFeatureIdsAt

• getFeatureIdsAt: (point: { x: number ; y: number }) => string[]

返回当前在指定点呈现的功能的功能 ID 数组。

# Type declaration

▸ (point: { x: number ; y: number }): string[]

# Parameters
Name Type
point object
point.x number
point.y number

Returns: string[]

Implementation of: IDrawTool.getFeatureIdsAt

# getMode

• getMode: () => string

返回 Draw 的当前模式

# Type declaration

▸ (): string

Returns: string

Implementation of: IDrawTool.getMode

# getSelected

• getSelected: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回当前选择的所有功能的 FeatureCollection

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

Implementation of: IDrawTool.getSelected

# getSelectedIds

• getSelectedIds: () => string[]

返回当前所选功能的功能 ID 数组

# Type declaration

▸ (): string[]

Returns: string[]

Implementation of: IDrawTool.getSelectedIds

# getSelectedPoints

• getSelectedPoints: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回代表当前选择的所有顶点的 FeatureCollection 点

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

Implementation of: IDrawTool.getSelectedPoints

# modes

• modes: Record<string, any>

内部变量模式值

Implementation of: IDrawTool.modes

# onAdd

• onAdd: (map: any) => any

增加时回调接口

# Type declaration

▸ (map: any): any

# Parameters
Name Type
map any

Returns: any

Implementation of: IDrawTool.onAdd

# onRemove

• onRemove: () => any

移除时回调接口

# Type declaration

▸ (): any

Returns: any

Implementation of: IDrawTool.onRemove

# options

• options: Record<string, any>

内部变量选项值

Implementation of: IDrawTool.options

# redo

• redo: () => any

# Type declaration

▸ (): any

Returns: any

Implementation of: IDrawTool.redo

# set

• set: (featureCollection: FeatureCollection<Geometry | GeometryCollection, Properties>) => string[]

将 Draw 的功能设置为指定的 FeatureCollection

# Type declaration

▸ (featureCollection: FeatureCollection<Geometry | GeometryCollection, Properties>): string[]

# Parameters
Name Type
featureCollection FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: string[]

Implementation of: IDrawTool.set

# setFeatureProperty

• setFeatureProperty: (featureId: string, property: string, value: any) => IDrawTool

设置具有指定 id 的要素的属性值。返回用于链接的绘制实例

# Type declaration

▸ (featureId: string, property: string, value: any): IDrawTool

# Parameters
Name Type
featureId string
property string
value any

Returns: IDrawTool

Implementation of: IDrawTool.setFeatureProperty

# trash

• trash: () => IDrawTool

调用当前模式的删除trash操作。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

Implementation of: IDrawTool.trash

# uncombineFeatures

• uncombineFeatures: () => IDrawTool

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

Implementation of: IDrawTool.uncombineFeatures

# undo

• undo: () => any

# Type declaration

▸ (): any

Returns: any

Implementation of: IDrawTool.undo

vjmap / Exports / EllipseEdge

# Class: EllipseEdge

创建只有边框的椭圆或椭圆弧

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new EllipseEdge(options: EllipseEdgeOptions): EllipseEdge

# Parameters
Name Type
options EllipseEdgeOptions

Returns: EllipseEdge

Overrides: Polyline

# Properties

# _map

• Optional _map: Map

Inherited from: Polyline._map

# layerId

• Optional layerId: string

Inherited from: Polyline.layerId

# options

• options: PolylineOptions

Inherited from: Polyline.options

# sourceId

• Optional sourceId: string

Inherited from: Polyline.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: Polyline

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getCenter

▸ getCenter(): GeoPointLike

得到中心点。

Returns: GeoPointLike

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: Polyline

# getEndAngle

▸ getEndAngle(): number

得到结束角度。

Returns: number

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: Polyline

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: Polyline

# getLineBlur

▸ getLineBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineCap

▸ getLineCap(): DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Inherited from: Polyline

# getLineColor

▸ getLineColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polyline

# getLineDasharray

▸ getLineDasharray(): DataDrivenPropertyValueSpecification<number[]>

Returns: DataDrivenPropertyValueSpecification<number[]>

Inherited from: Polyline

# getLineGapWidth

▸ getLineGapWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineGradient

▸ getLineGradient(): ExpressionSpecificationEx

Returns: ExpressionSpecificationEx

Inherited from: Polyline

# getLineJoin

▸ getLineJoin(): DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Inherited from: Polyline

# getLineMiterMimit

▸ getLineMiterMimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

Inherited from: Polyline

# getLineOffset

▸ getLineOffset(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineOpacity

▸ getLineOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLinePattern

▸ getLinePattern(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polyline

# getLineRoundLimit

▸ getLineRoundLimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

Inherited from: Polyline

# getLineSortKey

▸ getLineSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getLineTranslate

▸ getLineTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

Inherited from: Polyline

# getLineTranslateAnchor

▸ getLineTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

Inherited from: Polyline

# getLineWidth

▸ getLineWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polyline

# getMajorAxisRadius

▸ getMajorAxisRadius(): number

得到长轴半径。

Returns: number

# getMinorAxisRadius

▸ getMinorAxisRadius(): number

得到短轴半径。

Returns: number

# getPoints

▸ getPoints(): number

得到离散化的点的个数。

Returns: number

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: Polyline

# getStartAngle

▸ getStartAngle(): number

得到开始角度。

Returns: number

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: Polyline

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: Polyline

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: Polyline

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: Polyline

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: Polyline

# setCenter

▸ setCenter(value: GeoPointLike, bFocusUpdateData?: boolean): EllipseEdge

设置中心点。

# Parameters
Name Type Default value
value GeoPointLike -
bFocusUpdateData boolean true

Returns: EllipseEdge

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

Inherited from: Polyline

# setEndAngle

▸ setEndAngle(value: number, bFocusUpdateData?: boolean): EllipseEdge

设置结束角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseEdge

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: Polyline

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: Polyline

# setLineBlur

▸ setLineBlur(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineCap

▸ setLineCap(value: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: EllipseEdge

Inherited from: Polyline

# setLineColor

▸ setLineColor(value: DataDrivenPropertyValueSpecification<string>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseEdge

Inherited from: Polyline

# setLineDasharray

▸ setLineDasharray(value: DataDrivenPropertyValueSpecification<number[]>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number[]>

Returns: EllipseEdge

Inherited from: Polyline

# setLineGapWidth

▸ setLineGapWidth(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineGradient

▸ setLineGradient(value: ExpressionSpecificationEx): EllipseEdge

# Parameters
Name Type
value ExpressionSpecificationEx

Returns: EllipseEdge

Inherited from: Polyline

# setLineJoin

▸ setLineJoin(value: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: EllipseEdge

Inherited from: Polyline

# setLineMiterMimit

▸ setLineMiterMimit(value: PropertyValueSpecificationEx<number>): EllipseEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineOffset

▸ setLineOffset(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineOpacity

▸ setLineOpacity(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLinePattern

▸ setLinePattern(value: DataDrivenPropertyValueSpecification<string>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseEdge

Inherited from: Polyline

# setLineRoundLimit

▸ setLineRoundLimit(value: PropertyValueSpecificationEx<number>): EllipseEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineSortKey

▸ setLineSortKey(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setLineTranslate

▸ setLineTranslate(value: PropertyValueSpecificationEx<[number, number]>): EllipseEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: EllipseEdge

Inherited from: Polyline

# setLineTranslateAnchor

▸ setLineTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): EllipseEdge

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: EllipseEdge

Inherited from: Polyline

# setLineWidth

▸ setLineWidth(value: DataDrivenPropertyValueSpecification<number>): EllipseEdge

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseEdge

Inherited from: Polyline

# setMajorAxisRadius

▸ setMajorAxisRadius(value: number, bFocusUpdateData?: boolean): EllipseEdge

设置长轴半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseEdge

# setMinorAxisRadius

▸ setMinorAxisRadius(value: number, bFocusUpdateData?: boolean): EllipseEdge

设置短轴半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseEdge

# setPoints

▸ setPoints(value: number, bFocusUpdateData?: boolean): EllipseEdge

设置离散化的点的个数。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseEdge

# 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

# setStartAngle

▸ setStartAngle(value: number, bFocusUpdateData?: boolean): EllipseEdge

设置开始角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseEdge

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: Polyline

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: Polyline

# updateData

▸ updateData(): void

Returns: void

vjmap / Exports / EllipseFill

# Class: EllipseFill

创建填充的的椭圆或椭圆弧

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new EllipseFill(options: EllipseFillOptions): EllipseFill

# Parameters
Name Type
options EllipseFillOptions

Returns: EllipseFill

Overrides: Polygon

# Properties

# _map

• Optional _map: Map

Inherited from: Polygon._map

# layerId

• Optional layerId: string

Inherited from: Polygon.layerId

# options

• options: PolygonOptions

Inherited from: Polygon.options

# sourceId

• Optional sourceId: string

Inherited from: Polygon.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: Polygon

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getCenter

▸ getCenter(): GeoPointLike

得到中心点。

Returns: GeoPointLike

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: Polygon

# getEndAngle

▸ getEndAngle(): number

得到结束角度。

Returns: number

# getFillAntialias

▸ getFillAntialias(): PropertyValueSpecificationEx<boolean>

获取图层的“填充抗锯齿”绘制属性。

Returns: PropertyValueSpecificationEx<boolean>

Inherited from: Polygon

# getFillColor

▸ getFillColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillOpacity

▸ getFillOpacity(): DataDrivenPropertyValueSpecification<number>

获取图层的 fill-opacity 绘制属性。

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polygon

# getFillOutlineColor

▸ getFillOutlineColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-outline-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillPattern

▸ getFillPattern(): DataDrivenPropertyValueSpecification<string>

获取图层的fill-pattern 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

Inherited from: Polygon

# getFillSortKey

▸ getFillSortKey(): DataDrivenPropertyValueSpecification<number>

获取图层的fill-sort-key 布局属性.

Returns: DataDrivenPropertyValueSpecification<number>

Inherited from: Polygon

# getFillTranslate

▸ getFillTranslate(): PropertyValueSpecificationEx<[number, number]>

获取图层的 fill-translate 绘制属性。

Returns: PropertyValueSpecificationEx<[number, number]>

Inherited from: Polygon

# getFillTranslateAnchor

▸ getFillTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

获取图层的 fill-translate-anchor 绘制属性。

Returns: PropertyValueSpecificationEx<"map" | "viewport">

Inherited from: Polygon

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: Polygon

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: Polygon

# getMajorAxisRadius

▸ getMajorAxisRadius(): number

得到长轴半径。

Returns: number

# getMinorAxisRadius

▸ getMinorAxisRadius(): number

得到短轴半径。

Returns: number

# getPoints

▸ getPoints(): number

得到离散化的点的个数。

Returns: number

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: Polygon

# getStartAngle

▸ getStartAngle(): number

得到开始角度。

Returns: number

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: Polygon

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: Polygon

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: Polygon

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: Polygon

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: Polygon

# setCenter

▸ setCenter(value: GeoPointLike, bFocusUpdateData?: boolean): EllipseFill

设置中心点。

# Parameters
Name Type Default value
value GeoPointLike -
bFocusUpdateData boolean true

Returns: EllipseFill

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

Inherited from: Polygon

# setEndAngle

▸ setEndAngle(value: number, bFocusUpdateData?: boolean): EllipseFill

设置结束角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseFill

# setFillAntialias

▸ setFillAntialias(value: PropertyValueSpecificationEx<boolean>): EllipseFill

为一个或多个图层设置fill-antialias 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: EllipseFill

Inherited from: Polygon

# setFillColor

▸ setFillColor(value: DataDrivenPropertyValueSpecification<string>): EllipseFill

为一个或多个图层设置fill-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseFill

Inherited from: Polygon

# setFillOpacity

▸ setFillOpacity(value: DataDrivenPropertyValueSpecification<number>): EllipseFill

为一个或多个图层设置fill-opacity 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseFill

Inherited from: Polygon

# setFillOutlineColor

▸ setFillOutlineColor(value: DataDrivenPropertyValueSpecification<string>): EllipseFill

为一个或多个图层设置fill-outline-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseFill

Inherited from: Polygon

# setFillPattern

▸ setFillPattern(value: DataDrivenPropertyValueSpecification<string>): EllipseFill

为一个或多个图层设置fill-pattern 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseFill

Inherited from: Polygon

# setFillSortKey

▸ setFillSortKey(value: DataDrivenPropertyValueSpecification<number>): EllipseFill

为一层或多层设置fill-sort-key布局属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: EllipseFill

Inherited from: Polygon

# setFillTranslate

▸ setFillTranslate(value: DataDrivenPropertyValueSpecification<string>): EllipseFill

为一个或多个图层设置fill-translate 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: EllipseFill

Inherited from: Polygon

# setFillTranslateAnchor

▸ setFillTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): EllipseFill

为一个或多个图层设置fill-translate-anchor 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: EllipseFill

Inherited from: Polygon

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: Polygon

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: Polygon

# setMajorAxisRadius

▸ setMajorAxisRadius(value: number, bFocusUpdateData?: boolean): EllipseFill

设置长轴半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseFill

# setMinorAxisRadius

▸ setMinorAxisRadius(value: number, bFocusUpdateData?: boolean): EllipseFill

设置短轴半径。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseFill

# setPoints

▸ setPoints(value: number, bFocusUpdateData?: boolean): EllipseFill

设置离散化的点的个数。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseFill

# 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

# setStartAngle

▸ setStartAngle(value: number, bFocusUpdateData?: boolean): EllipseFill

设置开始角度。

# Parameters
Name Type Default value
value number -
bFocusUpdateData boolean true

Returns: EllipseFill

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: Polygon

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: Polygon

# updateData

▸ updateData(): void

Returns: void

vjmap / Exports / ErrorEvent

# Class: ErrorEvent

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new ErrorEvent(error: Error, target: any): ErrorEvent

# Parameters
Name Type
error Error
target any

Returns: ErrorEvent

Overrides: WebSocketEvent

# Properties

# error

• error: Error

# message

• message: string

# target

• target: any

Inherited from: WebSocketEvent.target

# type

• type: string

Inherited from: WebSocketEvent.type

vjmap / Exports / FillExtrusion

# Class: FillExtrusion

创建拉伸的多边形.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new FillExtrusion(options: FillExtrusionOptions): FillExtrusion

# Parameters
Name Type
options FillExtrusionOptions

Returns: FillExtrusion

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: FillExtrusionOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getFillExtrusionBase

▸ getFillExtrusionBase(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getFillExtrusionColor

▸ getFillExtrusionColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getFillExtrusionHeight

▸ getFillExtrusionHeight(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getFillExtrusionOpacity

▸ getFillExtrusionOpacity(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getFillExtrusionPattern

▸ getFillExtrusionPattern(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getFillExtrusionTranslate

▸ getFillExtrusionTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getFillExtrusionTranslateAnchor

▸ getFillExtrusionTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getFillExtrusionVerticalGradient

▸ getFillExtrusionVerticalGradient(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFillExtrusionBase

▸ setFillExtrusionBase(value: DataDrivenPropertyValueSpecification<number>): FillExtrusion

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: FillExtrusion

# setFillExtrusionColor

▸ setFillExtrusionColor(value: DataDrivenPropertyValueSpecification<string>): FillExtrusion

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: FillExtrusion

# setFillExtrusionHeight

▸ setFillExtrusionHeight(value: DataDrivenPropertyValueSpecification<number>): FillExtrusion

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: FillExtrusion

# setFillExtrusionOpacity

▸ setFillExtrusionOpacity(value: PropertyValueSpecificationEx<number>): FillExtrusion

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: FillExtrusion

# setFillExtrusionPattern

▸ setFillExtrusionPattern(value: DataDrivenPropertyValueSpecification<string>): FillExtrusion

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: FillExtrusion

# setFillExtrusionTranslate

▸ setFillExtrusionTranslate(value: PropertyValueSpecificationEx<[number, number]>): FillExtrusion

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: FillExtrusion

# setFillExtrusionTranslateAnchor

▸ setFillExtrusionTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): FillExtrusion

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: FillExtrusion

# setFillExtrusionVerticalGradient

▸ setFillExtrusionVerticalGradient(value: PropertyValueSpecificationEx<boolean>): FillExtrusion

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: FillExtrusion

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / FluorescenceMarker

# Class: FluorescenceMarker

荧光点.

# Hierarchy

  • MarkerBase

    ↳ FluorescenceMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new FluorescenceMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): FluorescenceMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: FluorescenceMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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

# setFeatures

▸ setFeatures(features: FeatureCollection<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

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 / Exports / GeoBounds

# Class: GeoBounds

GeoBounds 地理范围.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GeoBounds(min?: GeoPoint, max?: GeoPoint): GeoBounds

# Parameters
Name Type
min? GeoPoint
max? GeoPoint

Returns: GeoBounds

# Properties

# max

• max: GeoPoint

# min

• min: GeoPoint

# Methods

# center

▸ center(): GeoPoint

得到中心点

Returns: GeoPoint

# clone

▸ clone(): GeoBounds

克隆

Returns: GeoBounds

# closestPoint

▸ closestPoint(testPoint: GeoPoint, includeInterior?: boolean): GeoPoint

查找边界框上最近的点并返回该点.

# Parameters
Name Type Default value Description
testPoint GeoPoint - 点.
includeInterior boolean true 如果为true，则最近的点可以位于边界框内。如果为false，则最近的点只能位于边界框的外边缘上.

Returns: GeoPoint

# contains

▸ contains(point: GeoPoint): boolean

查看点是否在包围盒中

# Parameters
Name Type
point GeoPoint

Returns: boolean

# height

▸ height(): number

获取高度

Returns: number

# intersect

▸ intersect(b: GeoBounds): null | GeoBounds

两包围盒求交集

# Parameters
Name Type
b GeoBounds

Returns: null | GeoBounds

# isContains

▸ isContains(bound: GeoBounds): boolean

求一个包围盒是否包含另一个包围盒

# Parameters
Name Type
bound GeoBounds

Returns: boolean

# isIntersect

▸ isIntersect(bound: GeoBounds): boolean

判断与另一个包围盒是否相交

# Parameters
Name Type
bound GeoBounds

Returns: boolean

# leftBottom

▸ leftBottom(): GeoPoint

得到左下角

Returns: GeoPoint

# leftTop

▸ leftTop(): GeoPoint

得到左上角

Returns: GeoPoint

# randomGeoJsonLineCollection

▸ randomGeoJsonLineCollection(maxLineCount: number, maxPointCount: number, xRatio?: number, yRatio?: number, propertiesCb?: (index: number) => Object, minLineCount?: number, minPointCount?: number): GeoJsonGeomertry

生成一个随机geojson线集合

# Parameters
Name Type Default value Description
maxLineCount number - 最多线的数目
maxPointCount number - 每条线最多的点的数目
xRatio number 0.6 x轴范围比例 缺省 0.6
yRatio number 0.6 y轴范围比例 缺省 0.6
propertiesCb? (index: number) => Object - 属性回调函数
minLineCount? number - 最少线的数目（缺省为1)
minPointCount? number - 每条线最少的点的数目（缺省为2)

Returns: GeoJsonGeomertry

# randomGeoJsonPointCollection

▸ randomGeoJsonPointCollection(count: number, xRatio?: number, yRatio?: number, propertiesCb?: (index: number) => Object): GeoJsonGeomertry

生成一个随机geojson点集合

# Parameters
Name Type Default value Description
count number - 点的数目
xRatio number 0.6 x轴范围比例 缺省 0.6
yRatio number 0.6 y轴范围比例 缺省 0.6
propertiesCb? (index: number) => Object - 属性回调函数

Returns: GeoJsonGeomertry

# randomGeoJsonPolygonCollection

▸ randomGeoJsonPolygonCollection(maxPolygonCount: number, maxPointCount: number, xRatio?: number, yRatio?: number, propertiesCb?: (index: number) => Object, minPolygonCount?: number, minPointCount?: number): GeoJsonGeomertry

生成一个随机geojson多边形集合

# Parameters
Name Type Default value Description
maxPolygonCount number - 最多多边形的数目
maxPointCount number - 每条线最多的点的数目
xRatio number 0.6 x轴范围比例 缺省 0.6
yRatio number 0.6 y轴范围比例 缺省 0.6
propertiesCb? (index: number) => Object - 属性回调函数
minPolygonCount? number - 最少多边形的数目(缺省为1)
minPointCount? number - 每条线最少的点的数目(缺省为3)

Returns: GeoJsonGeomertry

# randomPoint

▸ randomPoint(xRatio?: number, yRatio?: number): GeoPoint

生成一个随机点

# Parameters
Name Type Default value Description
xRatio number 0.6 x轴范围比例 缺省 0.6
yRatio number 0.6 y轴范围比例 缺省 0.6

Returns: GeoPoint

# randomPoints

▸ randomPoints(minPointCount: number, maxPointCount: number, xRatio?: number, yRatio?: number): GeoPoint[]

生成一个随机点序列

# Parameters
Name Type Default value Description
minPointCount number - 最少的点数
maxPointCount number - 最多的点数
xRatio number 0.6 x轴范围比例 缺省 0.6
yRatio number 0.6 y轴范围比例 缺省 0.6

Returns: GeoPoint[]

# rightBottom

▸ rightBottom(): GeoPoint

得到右下角

Returns: GeoPoint

# rightTop

▸ rightTop(): GeoPoint

得到右上角

Returns: GeoPoint

# scale

▸ scale(ratio: number, origin?: null | GeoPoint): GeoBounds

按照比例扩大/缩小出一个新的 GeoBounds。

# Parameters
Name Type Description
ratio number 比例
origin? null | GeoPoint 扩大时的基准点，默认为当前 bounds 的中心点

Returns: GeoBounds

# scaleXY

▸ scaleXY(ratioX: number, ratioY: number, origin?: null | GeoPoint): GeoBounds

按照XY比例扩大/缩小出一个新的 GeoBounds。

# Parameters
Name Type Description
ratioX number X比例
ratioY number Y比例
origin? null | GeoPoint 扩大时的基准点，默认为当前 bounds 的中心点

Returns: GeoBounds

# set

▸ set(min: GeoPoint, max: GeoPoint): void

设置包围盒范围

# Parameters
Name Type Description
min GeoPoint 最小值
max GeoPoint 最大值

Returns: void

# square

▸ square(isLatlng?: boolean, isMinValue?: boolean): GeoBounds

变成正方形，使宽高相等

return{geobounds}

# Parameters
Name Type Description
isLatlng? boolean 是否是经纬度
isMinValue? boolean 是否取宽高的最小值或最大值，默认最大值

Returns: GeoBounds

# toArray

▸ toArray(): number[]

返回数组

Returns: number[]

The coordinates represented as a array of the format [minx, miny, maxx, maxy]'.

# toPointArray

▸ toPointArray(): [number, number][]

返回点数组，包括四个顶点

Returns: [number, number][]

The coordinates represented as a array of the format [[minx,maxy], [maxx,maxy], [maxx,miny], [minx,miny]]'.

# toString

▸ toString(fixed?: number): string

返回字符串.

# Parameters
Name Type Default value
fixed number 6

Returns: string

The coordinates represented as a string of the format minx, miny, maxx, maxy'.

# translate

▸ translate(dx: number, dy: number): void

位移包围盒

# Parameters
Name Type
dx number
dy number

Returns: void

# union

▸ union(bound: GeoBounds): GeoBounds

求多个包围盒的并集

# Parameters
Name Type
bound GeoBounds

Returns: GeoBounds

# update

▸ update(vertices: GeoPoint[]): void

更新包围盒

# Parameters
Name Type
vertices GeoPoint[]

Returns: void

# updateByBounds

▸ updateByBounds(bounds: GeoBounds | GeoBounds[]): void

根据子包围盒更新包围盒

# Parameters
Name Type
bounds GeoBounds | GeoBounds[]

Returns: void

# width

▸ width(): number

获取宽度

Returns: number

# fromArray

▸ Static fromArray(input: [number, number, number, number]): GeoBounds

根据数组创建 GeoBounds.

Example:

const b = GeoBounds.fromArray([left, bottom, right, top]);
1
# Parameters
Name Type
input [number, number, number, number]

Returns: GeoBounds

# fromCenterWH

▸ Static fromCenterWH(center: GeoPointLike, width: number, height?: number): GeoBounds

根据中心点和长，宽生成bounds

# Parameters
Name Type Description
center GeoPointLike 中心点
width number 宽
height? number 高，不输入时与宽一样

Returns: GeoBounds

# fromDataExtent

▸ Static fromDataExtent(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): GeoBounds

根据数据范围来生成bounds

# Parameters
Name Type
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

Returns: GeoBounds

# fromString

▸ Static fromString(input: string): GeoBounds

根据数组创建 GeoBounds.

Example:

const b = GeoBounds.fromString("[1,2,3,4]");
1
# Parameters
Name Type
input string

Returns: GeoBounds

vjmap / Exports / GeoPoint

# Class: GeoPoint

GeoPoint 地理坐标.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GeoPoint(x: number, y: number, z?: number): GeoPoint

GeoPoint 构造函数

# Parameters
Name Type Description
x number x坐标.
y number y坐标.
z? number z坐标(可选）.

Returns: GeoPoint

# Properties

# x

• x: number

坐标X.

# y

• y: number

坐标y.

# z

• Optional z: number

坐标z(可选）.

# Methods

# add

▸ add(p: GeoPoint): GeoPoint

两个点相加.

# Parameters
Name Type Description
p GeoPoint 要相加的点.

Returns: GeoPoint

# angle

▸ angle(): number

角度.

Returns: number

# angleTo

▸ angleTo(b: GeoPoint): number

距一个点的角度

# Parameters
Name Type
b GeoPoint

Returns: number

# angleWith

▸ angleWith(b: GeoPoint): number

距一个点的interiorAngle

# Parameters
Name Type
b GeoPoint

Returns: number

# angleWithSep

▸ angleWithSep(x: number, y: number): number

距一个点的interiorAngle

# Parameters
Name Type
x number
y number

Returns: number

# clone

▸ clone(): GeoPoint

克隆一个坐标

Returns: GeoPoint

# distSqr

▸ distSqr(p: GeoPoint): number

两点之间距离平方.

# Parameters
Name Type
p GeoPoint

Returns: number

# distanceTo

▸ distanceTo(p: GeoPoint): number

两点之间距离.

# Parameters
Name Type
p GeoPoint

Returns: number

# div

▸ div(k: number): GeoPoint

除一个系数.

# Parameters
Name Type Description
k number 系数.

Returns: GeoPoint

# divByPoint

▸ divByPoint(p: GeoPoint): GeoPoint

两个点相除.

# Parameters
Name Type Description
p GeoPoint 要相除的点.

Returns: GeoPoint

# dot

▸ dot(p: GeoPoint): number

# Parameters
Name Type
p GeoPoint

Returns: number

# equals

▸ equals(other: GeoPoint, dotErr?: number): boolean

判断是否相等

# Parameters
Name Type Default value Description
other GeoPoint - 另外一个点
dotErr number 8 允许误差的小数点后几位，默认8位

Returns: boolean

# equalsZ

▸ equalsZ(other: GeoPoint): boolean

是否相等（判断z).

# Parameters
Name Type
other GeoPoint

Returns: boolean

# lengthSq

▸ lengthSq(): number

Returns: number

# lerp

▸ lerp(v: GeoPoint, alpha: number): GeoPoint

# Parameters
Name Type
v GeoPoint
alpha number

Returns: GeoPoint

# mag

▸ mag(): number

长度.

Returns: number

# matMult

▸ matMult(m: number[]): GeoPoint

乘一个矩阵.

# Parameters
Name Type Description
m number[] 矩阵值.

Returns: GeoPoint

# mult

▸ mult(k: number): GeoPoint

乘一个系数.

# Parameters
Name Type Description
k number 系数.

Returns: GeoPoint

# multByPoint

▸ multByPoint(p: GeoPoint): GeoPoint

两个点相乘.

# Parameters
Name Type Description
p GeoPoint 要相乘的点.

Returns: GeoPoint

# perp

▸ perp(): GeoPoint

投影 [x,y] = [-y, x].

Returns: GeoPoint

# roateAround

▸ roateAround(angle: number, p: GeoPoint): GeoPoint

绕一个点旋转.

# Parameters
Name Type Description
angle number 弧度.
p GeoPoint 围绕的点.

Returns: GeoPoint

# rotate

▸ rotate(angle: number): GeoPoint

旋转.

# Parameters
Name Type Description
angle number 弧度.

Returns: GeoPoint

# round

▸ round(fixed?: number): GeoPoint

后小数点几位取整

# Parameters
Name Type Default value
fixed number 6

Returns: GeoPoint

# roundInt

▸ roundInt(): GeoPoint

四舍五入取整.

Returns: GeoPoint

# roundStr

▸ roundStr(fixed?: number): string

# Parameters
Name Type Default value
fixed number 6

Returns: string

# sub

▸ sub(p: GeoPoint): GeoPoint

两个点相减.

# Parameters
Name Type Description
p GeoPoint 要相减的点.

Returns: GeoPoint

# toArray

▸ toArray(): number[]

返回数组

Returns: number[]

The coordinates represeted as an array of x and y.

var ll = new vjmap.GeoPoint(-73.9749, 40.7736);
ll.toArray(); // = [-73.9749, 40.7736]
1
2

# toString

▸ toString(fixed?: number): string

返回字符串.

# Parameters
Name Type Default value
fixed number 6

Returns: string

The coordinates represented as a string of the format 'x, y, z?'.

var ll = new vjmap.GeoPoint(-73.9749, 40.7736);
ll.toString(); // = "GeoPoint(-73.9749, 40.7736)"
1
2

# transform

▸ transform(basePt: GeoPoint, destPt: GeoPoint, scale?: number, angle?: number): GeoPoint

对一个点围绕一个基点进行缩放旋转平移操作.

# Parameters
Name Type Description
basePt GeoPoint 围绕的基点坐标
destPt GeoPoint 要平移至的目的地坐标
scale? number 缩放比例，默认1.0
angle? number 旋转角度，逆时针，默认0

Returns: GeoPoint

# unit

▸ unit(): GeoPoint

单位长度.

Returns: GeoPoint

# convert

▸ Static convert(input: GeoPointLike): GeoPoint

根据不同的类型创建地理坐标 GeoPoint .

Example:

const p1 = GeoPoint.convert(new GeoPoint(x, y, z));
const p2 = GeoPoint.convert([x, y]);
const p3 = GeoPoint.convert([x, y, z]);
const p4 = GeoPoint.convert(lng: -73.9749, lat: 40.7736});
const p5 = GeoPoint.convert(lon: -73.9749, lat: 40.7736});
1
2
3
4
5
# Parameters
Name Type Description
input GeoPointLike Either GeoPointLike, GeoPointLike or GeoPointLike object literal.

Returns: GeoPoint

# fromString

▸ Static fromString(input: string): GeoPoint

根据字符串创建 GeoPoint.

Example:

const b = GeoPoint.fromString("1,2");
1
# Parameters
Name Type
input string

Returns: GeoPoint

vjmap / Exports / GeoProjection

# Class: GeoProjection

GeoProjection 地理坐标投影.

Example:

const mapExtent = new GeoBounds(new GeoPoint(10, 20), new GeoPoint(80, 90));
const prj = new GeoProjection(mapExtent);
const pt = [30, 30];
const latlng = prj.toLngLat(pt);
const pt_geo = prj.fromLngLat(latlng);
const mkt = prj.toMercator(pt);
const pt_mkt = prj.fromMercator(mkt);
1
2
3
4
5
6
7

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GeoProjection(extent: GeoBounds): GeoProjection

GeoBounds 构造函数

extent extent - 地图地理范围.

# Parameters
Name Type
extent GeoBounds

Returns: GeoProjection

Overrides: Projection

# Properties

# mapExtent

• mapExtent: GeoBounds

地图地理范围.

# EARTH_BOUNDS

▪ Static EARTH_BOUNDS: [number, number, number, number]

The equatorial semi perimeter in meters.

Inherited from: Projection.EARTH_BOUNDS

# EQUATORIAL_SEMIPERIMETER

▪ Static EQUATORIAL_SEMIPERIMETER: number= 20037508.3427892

The equatorial semi perimeter in meters.

Inherited from: Projection.EQUATORIAL_SEMIPERIMETER

# Methods

# fromLngLat

▸ fromLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

经纬度转地图地理坐标

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 经纬度坐标点

Returns: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

Overrides: Projection

# fromMercator

▸ fromMercator(input: GeoPointLike): [number, number]

墨卡托(epsg:3857)转坐标

# Parameters
Name Type Description
input GeoPointLike 墨卡托坐标点

Returns: [number, number]

Overrides: Projection

# fromMeter

▸ fromMeter(meter: number): number

把米转化为距离

# Parameters
Name Type
meter number

Returns: number

Overrides: Projection

# getMapExtent

▸ getMapExtent(): GeoBounds

得到地图范围

Returns: GeoBounds

Overrides: Projection

# setExtent

▸ setExtent(extent: GeoBounds): void

设置地图范围

extent extent - 地图地理范围.

# Parameters
Name Type
extent GeoBounds

Returns: void

# toLngLat

▸ toLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): LngLatLike

地图地理坐标转经纬度

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 地理坐标点

Returns: LngLatLike

Overrides: Projection

# toMercator

▸ toMercator(input: GeoPointLike): [number, number]

坐标转墨卡托(epsg:3857)

# Parameters
Name Type Description
input GeoPointLike 坐标点

Returns: [number, number]

Overrides: Projection

# toMeter

▸ toMeter(dist: number): number

把距离转化为米

# Parameters
Name Type
dist number

Returns: number

Overrides: Projection

# lngLat2Mercator

▸ Static lngLat2Mercator(input: GeoPointLike): [number, number]

经纬度转墨卡托 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

Inherited from: Projection

# mercator2LngLat

▸ Static mercator2LngLat(input: GeoPointLike): [number, number]

墨卡托转经纬度 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

Inherited from: Projection

vjmap / Exports / GlAdapterLayer

# Class: GlAdapterLayer

# Hierarchy

  • Evented

    ↳ GlAdapterLayer

# Implements

  • CustomLayerInterface

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GlAdapterLayer(): GlAdapterLayer

Returns: GlAdapterLayer

Inherited from: Evented.constructor

# Properties

# id

• id: string

Implementation of: CustomLayerInterface.id

# map

• map: Map

# regl

• regl: any

# renderAnimation

• Optional renderAnimation: boolean

# type

• type: "custom"

Implementation of: CustomLayerInterface.type

# Methods

# frame

▸ Protected Abstract frame(gl: WebGLRenderingContext, matrix: number[], context?: any): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]
context? any

Returns: void

# getReglInitializationOptions

▸ Protected Abstract getReglInitializationOptions(): any

Returns: any

# init

▸ Protected Abstract init(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

# onAdd

▸ onAdd(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Implementation of: CustomLayerInterface.onAdd

# onRemove

▸ onRemove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Implementation of: CustomLayerInterface.onRemove

# prerender

▸ prerender(gl: WebGLRenderingContext, matrix: number[]): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Implementation of: CustomLayerInterface.prerender

# remove

▸ Protected Abstract remove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

# render

▸ render(gl: WebGLRenderingContext, matrix: number[]): void

NOTE: map won't call it every frame.

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Implementation of: CustomLayerInterface.render

# triggerRepaint

▸ triggerRepaint(): void

Returns: void

vjmap / Exports / GlPolyLineLayer

# Class: GlPolyLineLayer

# Hierarchy

# Implements

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GlPolyLineLayer(options: Partial<ILineLayerOptions>): GlPolyLineLayer

# Parameters
Name Type
options Partial<ILineLayerOptions>

Returns: GlPolyLineLayer

Overrides: GlAdapterLayer

# Properties

# drawPoints

• drawPoints: any

# id

• id: string= 'custom-line'

Overrides: GlAdapterLayer.id

# instance

• instance: boolean= true

# map

• map: Map

Inherited from: GlAdapterLayer.map

# pointColor

• pointColor: number[]

# points

• points: { lat: number ; lng: number }[]= []

Implementation of: ILineLayerOptions.points

# regl

• regl: any

Inherited from: GlAdapterLayer.regl

# renderAnimation

• Optional renderAnimation: boolean

Inherited from: GlAdapterLayer.renderAnimation

# type

• type: "custom"

Inherited from: GlAdapterLayer.type

# Methods

# frame

▸ frame(gl: WebGLRenderingContext, matrix: number[], context?: any): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]
context? any

Returns: void

Overrides: GlAdapterLayer

# getReglInitializationOptions

▸ getReglInitializationOptions(): any

Returns: any

Overrides: GlAdapterLayer

# init

▸ init(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Overrides: GlAdapterLayer

# onAdd

▸ onAdd(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Inherited from: GlAdapterLayer

# onRemove

▸ onRemove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Inherited from: GlAdapterLayer

# prerender

▸ prerender(gl: WebGLRenderingContext, matrix: number[]): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Inherited from: GlAdapterLayer

# remove

▸ remove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Overrides: GlAdapterLayer

# render

▸ render(gl: WebGLRenderingContext, matrix: number[]): void

NOTE: map won't call it every frame.

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Inherited from: GlAdapterLayer

# triggerRepaint

▸ triggerRepaint(): void

Returns: void

Inherited from: GlAdapterLayer

vjmap / Exports / GridLayer

# Class: GridLayer

网络线图层

# Implements

  • CustomLayerInterface

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new GridLayer(options?: GridLayerOptions): GridLayer

# Parameters
Name Type Default value
options GridLayerOptions {}

Returns: GridLayer

# Properties

# id

• id: string

Implementation of: CustomLayerInterface.id

# renderingMode

• Optional renderingMode: "2d" | "3d"

Implementation of: CustomLayerInterface.renderingMode

# type

• type: "custom"

Implementation of: CustomLayerInterface.type

# Methods

# getWrapNum

▸ getWrapNum(x: number, includeMax?: boolean, includeMin?: boolean, range?: number[]): number

# Parameters
Name Type Default value
x number -
includeMax boolean true
includeMin boolean true
range number[] -

Returns: number

# onAdd

▸ onAdd(map: Map): void

# Parameters
Name Type
map Map

Returns: void

Implementation of: CustomLayerInterface.onAdd

# removeFromMap

▸ removeFromMap(): void

description 移除图层。

Returns: void

# render

▸ render(gl: WebGLRenderingContext, matrix: number[]): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Implementation of: CustomLayerInterface.render

# setExtent

▸ setExtent(extent: LngLatBounds): void

description 设置坐标网格渲染的边界范围。

# Parameters
Name Type Description
extent LngLatBounds 坐标网格渲染的边界范围。

Returns: void

# setIntervals

▸ setIntervals(interval: number | Function): void

description 设置经纬度的间隔（以度为单位)

# Parameters
Name Type Description
interval number | Function 经纬度的间隔（以度为单位），可以是数字，也可以是函数，参数是map。

Returns: void

# setMaxZoom

▸ setMaxZoom(maxZoom: number): void

description 该图层可见的最大视图缩放级别。

# Parameters
Name Type Description
maxZoom number 该图层可见的最大视图缩放级别（含）。

Returns: void

# setMinZoom

▸ setMinZoom(minZoom: number): void

description 设置最小视图缩放级别。

# Parameters
Name Type Description
minZoom number 最小视图缩放级别（不包括此级别），在该级别之上，该层将可见。

Returns: void

# setShowLabel

▸ setShowLabel(showLabel: boolean): void

description 设置显示标签。

# Parameters
Name Type Description
showLabel boolean 是否显示标签。

Returns: void

# setStrokeStyle

▸ setStrokeStyle(strokeStyle: GridLayerStrokeStyle): void

description 设置经纬线样式。

# Parameters
Name Type Description
strokeStyle GridLayerStrokeStyle 经纬线样式。

Returns: void

# setVisibility

▸ setVisibility(visible?: boolean): void

description 设置可见性。

# Parameters
Name Type Description
visible? boolean 是否可见。

Returns: void

# setXLabelStyle

▸ setXLabelStyle(labelStyle: GridLayerLabelStyle): void

description 设置经度标签样式。

# Parameters
Name Type Description
labelStyle GridLayerLabelStyle 标签样式。

Returns: void

# setYLabelStyle

▸ setYLabelStyle(labelStyle: GridLayerLabelStyle): void

description 设置纬度标签样式。

# Parameters
Name Type Description
labelStyle GridLayerLabelStyle 标签样式。

Returns: void

vjmap / Exports / HaloRingMarker

# Class: HaloRingMarker

发光的光环.

# Hierarchy

  • MarkerBase

    ↳ HaloRingMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new HaloRingMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): HaloRingMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: HaloRingMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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

# setFeatures

▸ setFeatures(features: FeatureCollection<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

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 / Exports / Heatmap

# Class: Heatmap

创建热力图图层.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Heatmap(options: HeatmapOptions): Heatmap

# Parameters
Name Type
options HeatmapOptions

Returns: Heatmap

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: HeatmapOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getHeatmapColor

▸ getHeatmapColor(): ExpressionSpecificationEx

Returns: ExpressionSpecificationEx

# getHeatmapIntensity

▸ getHeatmapIntensity(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getHeatmapOpacity

▸ getHeatmapOpacity(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getHeatmapRadius

▸ getHeatmapRadius(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getHeatmapWeight

▸ getHeatmapWeight(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setHeatmapColor

▸ setHeatmapColor(value: ExpressionSpecificationEx): Heatmap

# Parameters
Name Type
value ExpressionSpecificationEx

Returns: Heatmap

# setHeatmapIntensity

▸ setHeatmapIntensity(value: PropertyValueSpecificationEx<number>): Heatmap

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Heatmap

# setHeatmapOpacity

▸ setHeatmapOpacity(value: PropertyValueSpecificationEx<number>): Heatmap

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Heatmap

# setHeatmapRadius

▸ setHeatmapRadius(value: DataDrivenPropertyValueSpecification<number>): Heatmap

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Heatmap

# setHeatmapWeight

▸ setHeatmapWeight(value: DataDrivenPropertyValueSpecification<number>): Heatmap

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Heatmap

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / LnglatProjection

# Class: LnglatProjection

LnglatProjection 经纬度坐标投影.

Example:

const mapExtent = new GeoBounds(new GeoPoint(10, 20), new GeoPoint(80, 90));
const prj = new LnglatProjection(mapExtent);
const pt = [30, 30];
const latlng = prj.toLngLat(pt);
const pt_geo = prj.fromLngLat(latlng);
const mkt = prj.toMercator(pt);
const pt_mkt = prj.fromMercator(mkt);
1
2
3
4
5
6
7

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new LnglatProjection(): LnglatProjection

GeoBounds 构造函数

extent extent - 地图地理范围.

Returns: LnglatProjection

Overrides: Projection

# Properties

# mapExtent

• mapExtent: GeoBounds

地图地理范围.

# EARTH_BOUNDS

▪ Static EARTH_BOUNDS: [number, number, number, number]

The equatorial semi perimeter in meters.

Inherited from: Projection.EARTH_BOUNDS

# EQUATORIAL_SEMIPERIMETER

▪ Static EQUATORIAL_SEMIPERIMETER: number= 20037508.3427892

The equatorial semi perimeter in meters.

Inherited from: Projection.EQUATORIAL_SEMIPERIMETER

# Methods

# fromLngLat

▸ fromLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

经纬度转地图地理坐标

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 经纬度坐标点

Returns: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

Overrides: Projection

# fromMercator

▸ fromMercator(input: GeoPointLike): [number, number]

墨卡托(epsg:3857)转坐标

# Parameters
Name Type Description
input GeoPointLike 墨卡托坐标点

Returns: [number, number]

Overrides: Projection

# fromMeter

▸ fromMeter(meter: number): number

把米转化为距离

# Parameters
Name Type
meter number

Returns: number

Overrides: Projection

# getMapExtent

▸ getMapExtent(): GeoBounds

得到地图范围

Returns: GeoBounds

Overrides: Projection

# setExtent

▸ setExtent(extent: GeoBounds): void

设置地图范围

extent extent - 地图地理范围.

# Parameters
Name Type
extent GeoBounds

Returns: void

# toLngLat

▸ toLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): LngLatLike

地图地理坐标转经纬度

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 地理坐标点

Returns: LngLatLike

Overrides: Projection

# toMercator

▸ toMercator(input: GeoPointLike): [number, number]

坐标转墨卡托(epsg:3857)

# Parameters
Name Type Description
input GeoPointLike 坐标点

Returns: [number, number]

Overrides: Projection

# toMeter

▸ toMeter(dist: number): number

把距离转化为米

# Parameters
Name Type
dist number

Returns: number

Overrides: Projection

# lngLat2Mercator

▸ Static lngLat2Mercator(input: GeoPointLike): [number, number]

经纬度转墨卡托 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

Inherited from: Projection

# mercator2LngLat

▸ Static mercator2LngLat(input: GeoPointLike): [number, number]

墨卡托转经纬度 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

Inherited from: Projection

vjmap / Exports / MapGlUtils

# Class: MapGlUtils

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new MapGlUtils(): MapGlUtils

Returns: MapGlUtils

# Methods

# init

▸ Static init(map: any, bindToMap: any): any

# Parameters
Name Type
map any
bindToMap any

Returns: any

# newMap

▸ Static newMap(params?: {}, options?: {}): Promise<Map>

# Parameters
Name Type Default value
params object {}
options object {}

Returns: Promise<Map>

vjmap / Exports / MarkerCluster

# Class: MarkerCluster

创建文本组件.

# Hierarchy

  • Evented

    ↳ MarkerCluster

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new MarkerCluster(options: MarkerClusterOptions): MarkerCluster

构造函数

# Parameters
Name Type
options MarkerClusterOptions

Returns: MarkerCluster

Overrides: Evented.constructor

# Methods

# addTo

▸ addTo(map: Map): MarkerCluster

将 MarkerCluster 附加到 Map 对象。

# Parameters
Name Type
map Map

Returns: MarkerCluster

# allowOverlap

▸ allowOverlap(bAllowOverlap: boolean): void

# Parameters
Name Type
bAllowOverlap boolean

Returns: void

# allowOverlapMaxZoom

▸ allowOverlapMaxZoom(zoom: number): void

# Parameters
Name Type
zoom number

Returns: void

# getData

▸ getData(): MarkerClusterData[]

获取数据。

Returns: MarkerClusterData[]

# hide

▸ hide(): void

隐藏

Returns: void

# remove

▸ remove(): void

从地图中删除。

Returns: void

# show

▸ show(): void

显示

Returns: void

# updateData

▸ updateData(data: FeatureCollection<Geometry | GeometryCollection, Properties> | MarkerClusterData[]): void

更新数据。

# Parameters
Name Type
data FeatureCollection<Geometry | GeometryCollection, Properties> | MarkerClusterData[]

Returns: void

# updateMarkers

▸ updateMarkers(): void

更新markers。

Returns: void

vjmap / Exports / Math2D / Box

# Class: Box

Math2D.Box

Alternative 2D box object with less memory impact (four numbers instead of two min/max objects with two numbers each). Should be faster.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Box(x?: number, y?: number, w?: number, h?: number): Box

Alternative 2D box object with less memory impact (four numbers instead of two min/max objects with two numbers each). Should be faster.

# Parameters
Name Type Default value Description
x number 0 New X value.
y number 0 New y value.
w number 0 New w value.
h number 0 New h value.

Returns: Box

# Properties

# h

• h: number= 0

# w

• w: number= 0

# x

• x: number= 0

# y

• y: number= 0

# Methods

# contains

▸ contains(x: number, y: number): boolean

Test box for inclusion of point.

# Parameters
Name Type Description
x number X coordinate of point.
y number Y coordinate of point.

Returns: boolean

# containsBox

▸ containsBox(other: Box): boolean

Test box for inclusion of another box.

# Parameters
Name Type Description
other Box Box 2 to test for inclusion.

Returns: boolean

# intersects

▸ intersects(other: Box): boolean

Test two boxes for intersection.

# Parameters
Name Type Description
other Box Box 2 to test for intersection.

Returns: boolean

# set

▸ set(x: number, y: number, w: number, h: number): void

Set new values to all properties of the box.

# Parameters
Name Type Description
x number New X value.
y number New y value.
w number New w value.
h number New h value.

Returns: void

vjmap / Exports / MiniMapControl

# Class: MiniMapControl

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new MiniMapControl(options: MiniMapControlOption): MiniMapControl

# Parameters
Name Type
options MiniMapControlOption

Returns: MiniMapControl

# Methods

# _convertBoundsToPoints

▸ _convertBoundsToPoints(bounds: any): void

# Parameters
Name Type
bounds any

Returns: void

# _createContainer

▸ _createContainer(parentMap: Map): HTMLDivElement

# Parameters
Name Type
parentMap Map

Returns: HTMLDivElement

# _load

▸ _load(): void

Returns: void

# _mouseDown

▸ _mouseDown(e: any): void

# Parameters
Name Type
e any

Returns: void

# _mouseMove

▸ _mouseMove(e: any): void

# Parameters
Name Type
e any

Returns: void

# _mouseUp

▸ _mouseUp(): void

Returns: void

# _moveTrackingRect

▸ _moveTrackingRect(offset: any): any

# Parameters
Name Type
offset any

Returns: any

# _onAdd

▸ _onAdd(parentMap: Map): HTMLElement

# Parameters
Name Type
parentMap Map

Returns: HTMLElement

# _onRemove

▸ _onRemove(): void

Returns: void

# _onSize

▸ _onSize(): void

Returns: void

# _preventDefault

▸ _preventDefault(e: any): void

# Parameters
Name Type
e any

Returns: void

# _setTrackingRectBounds

▸ _setTrackingRectBounds(bounds: any): void

# Parameters
Name Type
bounds any

Returns: void

# _update

▸ _update(e: any): void

# Parameters
Name Type
e any

Returns: void

# _updateMapExtent

▸ _updateMapExtent(data: any): void

# Parameters
Name Type
data any

Returns: void

# _zoomAdjust

▸ _zoomAdjust(): void

Returns: void

# getDefaultPosition

▸ getDefaultPosition(): string

Returns: string

# getMap

▸ getMap(): Map

Returns: Map

# init

▸ init(options: MiniMapControlOption): void

# Parameters
Name Type
options MiniMapControlOption

Returns: void

# onAdd

▸ onAdd(parentMap: Map): HTMLElement

# Parameters
Name Type
parentMap Map

Returns: HTMLElement

# onRemove

▸ onRemove(): void

Returns: void

vjmap / Exports / MousePositionControl

# Class: MousePositionControl

# Table of contents

# Constructors

# Methods

# Constructors

# constructor

+ new MousePositionControl(options?: MousePositionControlOption): MousePositionControl

# Parameters
Name Type Default value
options MousePositionControlOption {}

Returns: MousePositionControl

# Methods

# defaultLabelFormat

▸ defaultLabelFormat(lng: number, lat: number, x: number, y: number): string

# Parameters
Name Type
lng number
lat number
x number
y number

Returns: string

# getDefaultPosition

▸ getDefaultPosition(): string

Returns: string

# insertControl

▸ insertControl(): void

Returns: void

# onAdd

▸ onAdd(map: Map): HTMLElement

# Parameters
Name Type
map Map

Returns: HTMLElement

# onMouseMove

▸ onMouseMove(evt?: any): void

# Parameters
Name Type
evt? any

Returns: void

# onRemove

▸ onRemove(): void

Returns: void

vjmap / Exports / OverlayLayerBase

# Class: OverlayLayerBase

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new OverlayLayerBase(): OverlayLayerBase

Returns: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

# layerId

• Optional layerId: string

# sourceId

• Optional sourceId: string

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

# 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.

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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.

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

# setProperty

▸ setProperty(prop: string | object, value?: any): void

在一个或多个图层上设置绘制或布局属性。

example setProperty('fillOpacity', 0.5)

# Parameters
Name Type
prop string | object
value? any

Returns: void

# show

▸ show(): void

使给定的图层可见。

Returns: void

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

vjmap / Exports / Polygon

# Class: Polygon

创建多边形.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Polygon(options: PolygonOptions): Polygon

# Parameters
Name Type
options PolygonOptions

Returns: Polygon

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: PolygonOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getFillAntialias

▸ getFillAntialias(): PropertyValueSpecificationEx<boolean>

获取图层的“填充抗锯齿”绘制属性。

Returns: PropertyValueSpecificationEx<boolean>

# getFillColor

▸ getFillColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

# getFillOpacity

▸ getFillOpacity(): DataDrivenPropertyValueSpecification<number>

获取图层的 fill-opacity 绘制属性。

Returns: DataDrivenPropertyValueSpecification<number>

# getFillOutlineColor

▸ getFillOutlineColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-outline-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

# getFillPattern

▸ getFillPattern(): DataDrivenPropertyValueSpecification<string>

获取图层的fill-pattern 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

# getFillSortKey

▸ getFillSortKey(): DataDrivenPropertyValueSpecification<number>

获取图层的fill-sort-key 布局属性.

Returns: DataDrivenPropertyValueSpecification<number>

# getFillTranslate

▸ getFillTranslate(): PropertyValueSpecificationEx<[number, number]>

获取图层的 fill-translate 绘制属性。

Returns: PropertyValueSpecificationEx<[number, number]>

# getFillTranslateAnchor

▸ getFillTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

获取图层的 fill-translate-anchor 绘制属性。

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFillAntialias

▸ setFillAntialias(value: PropertyValueSpecificationEx<boolean>): Polygon

为一个或多个图层设置fill-antialias 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Polygon

# setFillColor

▸ setFillColor(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

# setFillOpacity

▸ setFillOpacity(value: DataDrivenPropertyValueSpecification<number>): Polygon

为一个或多个图层设置fill-opacity 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polygon

# setFillOutlineColor

▸ setFillOutlineColor(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-outline-color 绘画属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

# setFillPattern

▸ setFillPattern(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-pattern 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

# setFillSortKey

▸ setFillSortKey(value: DataDrivenPropertyValueSpecification<number>): Polygon

为一层或多层设置fill-sort-key布局属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polygon

# setFillTranslate

▸ setFillTranslate(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-translate 绘制属性。

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

# setFillTranslateAnchor

▸ setFillTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Polygon

为一个或多个图层设置fill-translate-anchor 绘制属性。

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Polygon

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / Polyline

# Class: Polyline

创建多段线.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Polyline(options: PolylineOptions): Polyline

# Parameters
Name Type
options PolylineOptions

Returns: Polyline

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: PolylineOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getLineBlur

▸ getLineBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLineCap

▸ getLineCap(): DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

# getLineColor

▸ getLineColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getLineDasharray

▸ getLineDasharray(): DataDrivenPropertyValueSpecification<number[]>

Returns: DataDrivenPropertyValueSpecification<number[]>

# getLineGapWidth

▸ getLineGapWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLineGradient

▸ getLineGradient(): ExpressionSpecificationEx

Returns: ExpressionSpecificationEx

# getLineJoin

▸ getLineJoin(): DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

# getLineMiterMimit

▸ getLineMiterMimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getLineOffset

▸ getLineOffset(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLineOpacity

▸ getLineOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLinePattern

▸ getLinePattern(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getLineRoundLimit

▸ getLineRoundLimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getLineSortKey

▸ getLineSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getLineTranslate

▸ getLineTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getLineTranslateAnchor

▸ getLineTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getLineWidth

▸ getLineWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# setLineBlur

▸ setLineBlur(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# setLineCap

▸ setLineCap(value: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: Polyline

# setLineColor

▸ setLineColor(value: DataDrivenPropertyValueSpecification<string>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polyline

# setLineDasharray

▸ setLineDasharray(value: DataDrivenPropertyValueSpecification<number[]>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number[]>

Returns: Polyline

# setLineGapWidth

▸ setLineGapWidth(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# setLineGradient

▸ setLineGradient(value: ExpressionSpecificationEx): Polyline

# Parameters
Name Type
value ExpressionSpecificationEx

Returns: Polyline

# setLineJoin

▸ setLineJoin(value: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: Polyline

# setLineMiterMimit

▸ setLineMiterMimit(value: PropertyValueSpecificationEx<number>): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Polyline

# setLineOffset

▸ setLineOffset(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# setLineOpacity

▸ setLineOpacity(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# setLinePattern

▸ setLinePattern(value: DataDrivenPropertyValueSpecification<string>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polyline

# setLineRoundLimit

▸ setLineRoundLimit(value: PropertyValueSpecificationEx<number>): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Polyline

# setLineSortKey

▸ setLineSortKey(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# setLineTranslate

▸ setLineTranslate(value: PropertyValueSpecificationEx<[number, number]>): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: Polyline

# setLineTranslateAnchor

▸ setLineTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Polyline

# setLineWidth

▸ setLineWidth(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline

# 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

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / PolylineArrow

# Class: PolylineArrow

创建箭头多段线.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new PolylineArrow(options: PolylineArrowOptions): PolylineArrow

# Parameters
Name Type
options PolylineArrowOptions

Returns: PolylineArrow

# Properties

# animateFun

• animateFun: null | Function

# animatedPointIdx

• animatedPointIdx: number

# borderGeoJson

• borderGeoJson: any

# geojson

• geojson: any

# id

• id: string

# lineArrowImageName

• lineArrowImageName: string

# lineGeojson

• lineGeojson: any

# options

• options: PolylineArrowOptions

# strokeImageName

• strokeImageName: undefined | string

# type

• type: string

# Methods

# _addLayer

▸ _addLayer(): void

Returns: void

# _addShowDirFun

▸ _addShowDirFun(): void

Returns: void

# _addStrokeImage

▸ _addStrokeImage(): void

Returns: void

# _creatDirLine

▸ _creatDirLine(): void

Returns: void

# _createBorderLine

▸ _createBorderLine(): void

Returns: void

# _createLineGeojson

▸ _createLineGeojson(): void

Returns: void

# _mouseenterCallbackFun

▸ _mouseenterCallbackFun(): void

Returns: void

# _mouseleaveCallbackFun

▸ _mouseleaveCallbackFun(): void

Returns: void

# _updateLineStyle

▸ _updateLineStyle(options: any): void

# Parameters
Name Type
options any

Returns: void

# addDir

▸ addDir(): void

Returns: void

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

# animate

▸ animate(step?: number, fps?: number, isLoop?: boolean, stopCallBack?: (status: FrameAnimationStatus) => void, onFrameCallBack?: (status: FrameAnimationStatus, context: any) => void): FrameAnimation

开启动画

# Parameters
Name Type Default value Description
step number 100 把线段分成多少段
fps number 10 每一秒跑多少段
isLoop boolean false 是否循环
stopCallBack? (status: FrameAnimationStatus) => void - 结束回调
onFrameCallBack? (status: FrameAnimationStatus, context: any) => void - 每一帧的回调

Returns: FrameAnimation

# createGeojson

▸ createGeojson(): void

Returns: void

# getBounds

▸ getBounds(): GeoBounds

Returns: GeoBounds

# getId

▸ getId(): string

Returns: string

# getLength

▸ getLength(): number

Returns: number

# getOptions

▸ getOptions(): PolylineArrowOptions

Returns: PolylineArrowOptions

# getPath

▸ getPath(): any

Returns: any

# hide

▸ hide(): void

Returns: void

# hideDir

▸ hideDir(): void

Returns: void

# init

▸ init(): void

Returns: void

# off

▸ off(type: any, listener: EventedListener): void

# Parameters
Name Type
type any
listener EventedListener

Returns: void

# on

▸ on(type: any, listener: EventedListener): void

# Parameters
Name Type
type any
listener EventedListener

Returns: void

# once

▸ once(type: any, listener: EventedListener): void

# Parameters
Name Type
type any
listener EventedListener

Returns: void

# remove

▸ remove(): void

Returns: void

# removeDir

▸ removeDir(): void

Returns: void

# setBorderColor

▸ setBorderColor(value: any): void

# Parameters
Name Type
value any

Returns: void

# setBorderOpacity

▸ setBorderOpacity(val: any): void

# Parameters
Name Type
val any

Returns: void

# setBorderWidth

▸ setBorderWidth(weight: any): void

# Parameters
Name Type
weight any

Returns: void

# setColor

▸ setColor(color: any): void

# Parameters
Name Type
color any

Returns: void

# setCursor

▸ setCursor(cursor?: string): void

# Parameters
Name Type
cursor? string

Returns: void

# setOpacity

▸ setOpacity(val: any): void

# Parameters
Name Type
val any

Returns: void

# setOptions

▸ setOptions(options: PolylineArrowOptions): void

# Parameters
Name Type
options PolylineArrowOptions

Returns: void

# setPath

▸ setPath(val: GeoPointLike[]): void

# Parameters
Name Type
val GeoPointLike[]

Returns: void

# setStrokeImage

▸ setStrokeImage(strokeImage: string): void

# Parameters
Name Type
strokeImage string

Returns: void

# setWeight

▸ setWeight(val: any): void

# Parameters
Name Type
val any

Returns: void

# show

▸ show(): void

Returns: void

# showDir

▸ showDir(): void

Returns: void

vjmap / Exports / Projection

# Class: Projection

GeoPoint 地理坐标.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Projection(): Projection

Returns: Projection

# Properties

# EARTH_BOUNDS

▪ Static EARTH_BOUNDS: [number, number, number, number]

The equatorial semi perimeter in meters.

# EQUATORIAL_SEMIPERIMETER

▪ Static EQUATORIAL_SEMIPERIMETER: number= 20037508.3427892

The equatorial semi perimeter in meters.

# Methods

# fromLngLat

▸ Abstract fromLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

经纬度转地图地理坐标

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 经纬度坐标点

Returns: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

# fromMercator

▸ Abstract fromMercator(input: GeoPointLike): [number, number]

墨卡托(epsg:3857)转坐标

# Parameters
Name Type Description
input GeoPointLike 墨卡托坐标点

Returns: [number, number]

# fromMeter

▸ Abstract fromMeter(meter: number): number

把米转化为距离

# Parameters
Name Type
meter number

Returns: number

# getMapExtent

▸ Abstract getMapExtent(): GeoBounds

得到地图范围

Returns: GeoBounds

# toLngLat

▸ Abstract toLngLat(input: GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]): LngLatLike

地图地理坐标转经纬度

# Parameters
Name Type Description
input GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[] 地理坐标点

Returns: LngLatLike

# toMercator

▸ Abstract toMercator(input: GeoPointLike): [number, number]

坐标转墨卡托(epsg:3857)

# Parameters
Name Type Description
input GeoPointLike 坐标点

Returns: [number, number]

# toMeter

▸ Abstract toMeter(dist: number): number

把距离转化为米

# Parameters
Name Type
dist number

Returns: number

# lngLat2Mercator

▸ Static lngLat2Mercator(input: GeoPointLike): [number, number]

经纬度转墨卡托 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

# mercator2LngLat

▸ Static mercator2LngLat(input: GeoPointLike): [number, number]

墨卡托转经纬度 .

# Parameters
Name Type
input GeoPointLike

Returns: [number, number]

vjmap / Exports / ReglBaseLayer

# Class: ReglBaseLayer

# Hierarchy

  • Evented

    ↳ ReglBaseLayer

# Implements

  • CustomLayerInterface

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new ReglBaseLayer(): ReglBaseLayer

Returns: ReglBaseLayer

Inherited from: Evented.constructor

# Properties

# id

• id: string

Implementation of: CustomLayerInterface.id

# map

• map: Map

# regl

• regl: any

# renderAnimation

• Optional renderAnimation: boolean

# type

• type: "custom"

Implementation of: CustomLayerInterface.type

# Methods

# frame

▸ Protected Abstract frame(gl: WebGLRenderingContext, matrix: number[], context?: any): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]
context? any

Returns: void

# getReglInitialization

▸ Protected Abstract getReglInitialization(gl: WebGLRenderingContext): any

# Parameters
Name Type
gl WebGLRenderingContext

Returns: any

# init

▸ Protected Abstract init(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

# onAdd

▸ onAdd(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Implementation of: CustomLayerInterface.onAdd

# onRemove

▸ onRemove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

Implementation of: CustomLayerInterface.onRemove

# prerender

▸ prerender(gl: WebGLRenderingContext, matrix: number[]): void

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Implementation of: CustomLayerInterface.prerender

# remove

▸ Protected Abstract remove(map: Map, gl: WebGLRenderingContext): void

# Parameters
Name Type
map Map
gl WebGLRenderingContext

Returns: void

# render

▸ render(gl: WebGLRenderingContext, matrix: number[]): void

NOTE: map won't call it every frame.

# Parameters
Name Type
gl WebGLRenderingContext
matrix number[]

Returns: void

Implementation of: CustomLayerInterface.render

# triggerRepaint

▸ triggerRepaint(): void

Returns: void

vjmap / Exports / RotatingApertureMarker

# Class: RotatingApertureMarker

旋转的光环.

# Hierarchy

  • MarkerBase

    ↳ RotatingApertureMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new RotatingApertureMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): RotatingApertureMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: RotatingApertureMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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

# setFeatures

▸ setFeatures(features: FeatureCollection<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

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 / Exports / RotatingTextBorderMarker

# Class: RotatingTextBorderMarker

旋转的文本框.

# Hierarchy

  • MarkerBase

    ↳ RotatingTextBorderMarker

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new RotatingTextBorderMarker(features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }, options?: AnimateMarkerLayerOption): RotatingTextBorderMarker

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }
options? AnimateMarkerLayerOption

Returns: RotatingTextBorderMarker

Overrides: MarkerBase.constructor

# Properties

# features

• Protected features: FeatureCollection<Geometry | GeometryCollection, Properties> | { lngLat: LngLatLike ; text?: string }

Inherited from: MarkerBase.features

# markersElement

• Protected markersElement: any

Inherited from: MarkerBase.markersElement

# options

• Protected options: AnimateMarkerLayerOption

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

# _setMarkerContainerProperty

▸ _setMarkerContainerProperty(properties: any, index?: number): void

# Parameters
Name Type
properties any
index? number

Returns: void

# createMarker

▸ createMarker(options?: createMarkerOptions, index?: number): Marker

# Parameters
Name Type
options? createMarkerOptions
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

# setFeatures

▸ setFeatures(features: FeatureCollection<Geometry | GeometryCollection, Properties>): void

# Parameters
Name Type
features FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: void

Inherited from: MarkerBase.setFeatures

# setMarkersColors

▸ setMarkersColors(colors: string[], index?: number): void

# Parameters
Name Type
colors string[]
index? number

Returns: void

# setMarkersHeight

▸ setMarkersHeight(height: number): void

# Parameters
Name Type
height 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

Overrides: MarkerBase.setMarkersTextColor

# setMarkersTextField

▸ setMarkersTextField(textField: string, index?: number): void

# Parameters
Name Type
textField string
index? number

Returns: void

Overrides: MarkerBase.setMarkersTextField

# setMarkersTextFontSize

▸ setMarkersTextFontSize(textFontSize: number, index?: number): void

# Parameters
Name Type
textFontSize number
index? number

Returns: void

Overrides: MarkerBase.setMarkersTextFontSize

# setMarkersWidth

▸ setMarkersWidth(width: number): void

# Parameters
Name Type
width number

Returns: void

vjmap / Exports / Service

# Class: Service

Service 服务类.

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Service(url: string, token?: string, req?: IRequest): Service

构造函数

# Parameters
Name Type Description
url string 服务地址
token? string 访问凭证
req? IRequest 请求的方法实现（默认内部实现)

Returns: Service

# Properties

# accessToken

• accessToken: string= ""

访问凭证

# serverUrl

• serverUrl: string= ""

服务器地址

# Methods

# addAccessKey

▸ addAccessKey(key: string): Set<string>

增加访问key

# Parameters
Name Type Description
key string key值

Returns: Set<string>

# addSecretKey

▸ addSecretKey(key: string): Set<string>

增加秘钥key

# Parameters
Name Type Description
key string key值

Returns: Set<string>

# baseUrl

▸ baseUrl(): string

服务根地址

Returns: string

# blankTileUrl

▸ blankTileUrl(): string

空白瓦片地址

Returns: string

# checkFileHasUpload

▸ checkFileHasUpload(filemd5: string): Promise<any>

检查文件是否上传过

# Parameters
Name Type Description
filemd5 string 文件md5值

Returns: Promise<any>

# clearCache

▸ clearCache(prefix?: string): Promise<{}>

清空服务器缓存数据

# Parameters
Name Type Default value Description
prefix string "" key前缀

Returns: Promise<{}>

# clone

▸ clone(isCloneWorkspace?: boolean): Service

克隆一个新的服务实例对象

# Parameters
Name Type Description
isCloneWorkspace? boolean 是否克隆当前工作区 (默认是)

Returns: Service

Service

# cmdClearMapCache

▸ cmdClearMapCache(mapid: string, version: string): Promise<any>

清空地图的几何和瓦片缓存数据

# Parameters
Name Type Description
mapid string 地图ID
version string 版本号

Returns: Promise<any>

# cmdClearTileCache

▸ cmdClearTileCache(mapid: string, version: string): Promise<any>

清空地图的瓦片缓存数据

# Parameters
Name Type Description
mapid string 地图ID
version string 版本号

Returns: Promise<any>

# cmdCreateEntitiesGeomData

▸ cmdCreateEntitiesGeomData(param: ICreateEntitiesGeomData, cb?: (point: [number, number]) => undefined | null | [number, number]): Promise<any>

获取创建实体的几何数据

# Parameters
Name Type Description
param ICreateEntitiesGeomData 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: Promise<any>

# cmdDeleteCache

▸ cmdDeleteCache(param: IDeleteCache): Promise<any>

删除地图缓存

# Parameters
Name Type Description
param IDeleteCache 缓存接口

Returns: Promise<any>

# cmdDeleteMap

▸ cmdDeleteMap(mapid: string, version: string, retainVersionMaxCount?: number): Promise<any>

删除地图

# Parameters
Name Type Description
mapid string 地图ID
version string 版本号，如删除所有版本，输入"*"号
retainVersionMaxCount? number 删除所有版本时，保留的最新的版本总数。如总共有10个版本，retainVersionMaxCount为3时，会保存最新的3个版本，其余的都会删除

Returns: Promise<any>

# cmdDeleteStyle

▸ cmdDeleteStyle(param: IDeleteStyle): Promise<any>

删除地图样式

# Parameters
Name Type Description
param IDeleteStyle 样式接口

Returns: Promise<any>

# cmdExportLayout

▸ cmdExportLayout(param: IExportLayout): Promise<any>

导出布局空间为dwg图

# Parameters
Name Type Description
param IExportLayout 参数

Returns: Promise<any>

# cmdGetAccessKey

▸ cmdGetAccessKey(mapid: string, key: string): Promise<any>

获取地图的AccessKey，获取之前请确保已成功打开了地图

# Parameters
Name Type Description
mapid string 地图ID
key string secretKey秘钥和超级管理员superKey

Returns: Promise<any>

# cmdGetDrawBounds

▸ cmdGetDrawBounds(mapid?: string, version?: string): Promise<null | GeoBounds>

获取图形中有数据的范围区域

# Parameters
Name Type Description
mapid? string 地图id
version? string 版本号

Returns: Promise<null | GeoBounds>

# cmdGetSupportFormat

▸ cmdGetSupportFormat(): Promise<any>

获取支持的格式类型

Returns: Promise<any>

# cmdMapDiff

▸ cmdMapDiff(param: IMapDiff): Promise<any>

比较地图不同

# Parameters
Name Type Description
param IMapDiff 组合参数

Returns: Promise<any>

# cmdMatchObject

▸ cmdMatchObject(param: IMatchObject): Promise<any>

目标匹配

# Parameters
Name Type Description
param IMatchObject 参数

Returns: Promise<any>

# cmdPrjWktToPrj4

▸ cmdPrjWktToPrj4(wkt: string, from?: "" | "url" | "wmsauto" | "xml" | "urn" | "crsurl" | "micoordsys" | "pci"): Promise<any>

投影prj文件WKT字符转proj4字符串

# Parameters
Name Type Description
wkt string -
from? "" | "url" | "wmsauto" | "xml" | "urn" | "crsurl" | "micoordsys" | "pci" 字符串来源，为空为话为WKT

Returns: Promise<any>

# cmdRenameMap

▸ cmdRenameMap(oldMapID: string, newMapID: string): Promise<any>

地图ID重命名

# Parameters
Name Type Description
oldMapID string 旧地图ID
newMapID string 新地图ID

Returns: Promise<any>

# cmdResetAccessKey

▸ cmdResetAccessKey(mapid: string, key: string): Promise<any>

重置地图的AccessKey，获取之前请确保已成功打开了地图

# Parameters
Name Type Description
mapid string 地图ID
key string secretKey秘钥和超级管理员superKey

Returns: Promise<any>

# cmdRunStatus

▸ cmdRunStatus(bDetail?: boolean): Promise<any>

获取当前运行状态

# Parameters
Name Type Description
bDetail? boolean 是否需要细节 (默认false)

Returns: Promise<any>

# cmdSetMapPassword

▸ cmdSetMapPassword(mapid: string, key: string, newKey: string): Promise<any>

重置地图的密码，如果之前有密码，则是修改密码。如果之前没有密码，则是把此地图设置了密码保护。如果设置密码为空，则取消对此地图的密码保护。

# Parameters
Name Type Description
mapid string 地图ID
key string 旧的secretKey秘钥和超级管理员superKey
newKey string 新的secretKey秘钥

Returns: Promise<any>

# cmdSliceLayer

▸ cmdSliceLayer(param: ISliceLayer): Promise<any>

对图层进行切片缓存

# Parameters
Name Type
param ISliceLayer

Returns: Promise<any>

# cmdSwitchLayers

▸ cmdSwitchLayers(visibleLayers: string[]): Promise<any>

切换图层

# Parameters
Name Type Description
visibleLayers string[] 让可见的图层列表数组

Returns: Promise<any>

# cmdTransform

▸ cmdTransform(srs: string, crs: string, points: GeoPoint | GeoPoint[], fourParameter?: string | string[], isInverseFourParamter?: boolean): Promise<any>

坐标转换

# Parameters
Name Type Description
srs string 源坐标系名称，如 EPSG:4326
crs string 目标坐标系名称，如 EPSG:3857
points GeoPoint | GeoPoint[] 要转换的坐标
fourParameter? string | string[] 四参数(x偏移,y偏移,缩放，旋转弧度)，可选，对坐标最后进行修正
isInverseFourParamter? boolean 是否是上面四参数坐标的反算

Returns: Promise<any>

# cmdUpdateStyle

▸ cmdUpdateStyle(param: IUpdateStyle): Promise<any>

更新样式

# Parameters
Name Type Description
param IUpdateStyle 样式参数

Returns: Promise<any>

Example:

const res = svc.cmdUpdateStyle({
    name: "style1",
    layeron: [0,1,2,4,5,6,7,8,9],
    layeroff: "",
    clipbounds: "",
    backcolor: 0,
    lineweight:[1,1,0]
    expression: "gOutColorRed := gInColorGreen;gOutColorGreen := gInColorBlue;gOutColorBlue := gInColorRed;gOutColorAlpha := gInColorAlpha;"
});
1
2
3
4
5
6
7
8
9

# composeNewMap

▸ composeNewMap(param: IComposeNewMap | IComposeNewMap[]): Promise<any>

组合成新地图

# Parameters
Name Type Description
param IComposeNewMap | IComposeNewMap[] 组合参数

Returns: Promise<any>

# conditionQueryFeature

▸ conditionQueryFeature(param: IConditionQueryFeatures, cb?: (point: [number, number]) => undefined | null | [number, number]): Promise<any>

条件查询实体

# Parameters
Name Type Description
param IConditionQueryFeatures 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: Promise<any>

# createStyle

▸ createStyle(style: IMapStyleParam, mapid?: string, version?: string, isGeomLayer?: boolean): Promise<any>

获取样式图层名

# Parameters
Name Type Description
style IMapStyleParam 样式参数
mapid? string 地图ID
version? string 版本号，为空，则获取最新的;
isGeomLayer? boolean 几何渲染图层优先(默认true)

Returns: Promise<any>

# currentMapParam

▸ currentMapParam(): null | IOpenMapResponse

当前地图参数

Returns: null | IOpenMapResponse

# deleteCustomData

▸ deleteCustomData(key: string | string[], isPrefix?: boolean): Promise<any>

删除用户自定义数据

# Parameters
Name Type Description
key string | string[] 键名，如果是数组的话，可以查询
isPrefix? boolean 是否删除所有前缀为key的所有键值，默认false

Returns: Promise<any>

# execCommand

▸ execCommand(cmdname: string, param?: Record<string, any>, mapid?: string, version?: string, useGet?: boolean): Promise<any>

执行命令

# Parameters
Name Type
cmdname string
param? Record<string, any>
mapid? string
version? string
useGet? boolean

Returns: Promise<any>

# exprQueryFeature

▸ exprQueryFeature(param: IExprQueryFeatures, cb?: (point: [number, number]) => undefined | null | [number, number]): Promise<any>

表达式查询实体

# Parameters
Name Type Description
param IExprQueryFeatures 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: Promise<any>

# fileMd5

▸ fileMd5(file: File): Promise<any>

获取文件的Md5值

# Parameters
Name Type
file File

Returns: Promise<any>

# getConstData

▸ getConstData(): Promise<any>

获取服务后台常量设置

Returns: Promise<any>

# getCurWorkspaceName

▸ getCurWorkspaceName(): string

获取当前的工作区名称

Returns: string

# getCustomData

▸ getCustomData(key: string | string[], options?: { contentType?: "" | "image" ; retDataType?: "" | "value" | "prop" }): Promise<any>

获取用户自定义数据

# Parameters
Name Type Description
key string | string[] 键名，如果是数组的话，可以查询.
options? object 选项 retDataType为空时查询数据及属性,"value"只查询数据，"prop"只查询属性。contentType返回类型,为空时为json，为"image"时为图片.
options.contentType? "" | "image" -
options.retDataType? "" | "value" | "prop" -

Returns: Promise<any>

# getCustomDataKeysByPrefix

▸ getCustomDataKeysByPrefix(prefix: string): Promise<any>

通过前缀获取用户自定义数据的键值

# Parameters
Name Type Description
prefix string 键名前缀

Returns: Promise<any>

# getFontsCapacity

▸ getFontsCapacity(): Promise<{}>

得到所有矢量字体名称

Returns: Promise<{}>

# getMapLayers

▸ getMapLayers(): IMapLayer[]

得到地图图层集合，调用前请确保地图已打开，否则会抛异常

Returns: IMapLayer[]

# getSliceCacheZoom

▸ getSliceCacheZoom(param: ISliceCacheZoom): Promise<any>

获取已缓存的切片级别

# Parameters
Name Type Description
param ISliceCacheZoom 参数

Returns: Promise<any>

# getStyleLayerName

▸ getStyleLayerName(mapid: string, version?: string, isGeomLayer?: boolean, name?: string): Promise<any>

获取样式图层名

# Parameters
Name Type Description
mapid string 地图ID
version? string 版本号，为空，则获取最新的;
isGeomLayer? boolean 几何渲染图层优先(默认true)
name? string 有名称时，根据名称来查找;

Returns: Promise<any>

# getWorkspaces

▸ getWorkspaces(): Promise<any>

获取所有工作区(如果不是root权限的token获取非公开的工作区名称将返回空)

Returns: Promise<any>

# glyphsUrl

▸ glyphsUrl(): string

字体地址

Returns: string

# listMaps

▸ listMaps(mapid?: string | string[] | { curPage: number ; mapIds?: string[] ; pageCount: number }, version?: string): Promise<any>

获取所有地图信息

# Parameters
Name Type Default value Description
mapid string | string[] | { curPage: number ; mapIds?: string[] ; pageCount: number } "_" 地图ID，为空，则获取所有的；如果传入的是地图ID数组，则获取指定的地图ID数组的信息。如果不想一次性获取，可通过传入分页对象获取，如{curPage: 1, pageCount: 10}
version string "_" 版本号，为空，则获取最新的; * 则获取所有的版本

Returns: Promise<any>

# metadata

▸ metadata(mapid?: string, version?: string): Promise<any>

获取地图元数据

# Parameters
Name Type Description
mapid? string 地图ID ，为空, 则为当前打开的图形
version? string 版本号，为空 则为当前打开的版本;

Returns: Promise<any>

# openMap

▸ openMap(param: IOpenMapParam, isWaitFinish?: boolean): Promise<any>

打开图

# Parameters
Name Type Default value Description
param IOpenMapParam -
isWaitFinish boolean true 是否等待打开完成

Returns: Promise<any>

# pointQueryFeature

▸ pointQueryFeature(param: IPointQueryFeatures, cb?: (point: [number, number]) => undefined | null | [number, number]): Promise<any>

点查询实体

# Parameters
Name Type Description
param IPointQueryFeatures 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: Promise<any>

# processQueryResult

▸ processQueryResult(param: any, cb?: (point: [number, number]) => undefined | null | [number, number]): any

处理查询结果

# Parameters
Name Type Description
param any 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: any

# pwdToSecretKey

▸ pwdToSecretKey(pwd: string): string

密码转换为秘钥

# Parameters
Name Type Description
pwd string 密码

Returns: string

# qrcodeUrl

▸ qrcodeUrl(content: string, size?: number): string

二维码图片地址

# Parameters
Name Type Description
content string 生成二维码的内容
size? number 生成二维码的大小，默认256

Returns: string

# rasterBlankStyle

▸ rasterBlankStyle(minzoom?: number, maxzoom?: number, prefix?: string): Style

空白栅格style

# Parameters
Name Type Description
minzoom? number 最小级别，缺省0
maxzoom? number 最大级别，缺省24
prefix? string 前缀，缺省rasterBlank

Returns: Style

# rasterLayerId

▸ rasterLayerId(prefix?: string): string

获取栅格图层ID

# Parameters
Name Type
prefix? string

Returns: string

# rasterSourceId

▸ rasterSourceId(prefix?: string): string

获取栅格源ID

# Parameters
Name Type
prefix? string

Returns: string

# rasterStyle

▸ rasterStyle(tileUrl?: string, minzoom?: number, maxzoom?: number, prefix?: string): Style

栅格style

# Parameters
Name Type Description
tileUrl? string 栅格瓦片地址
minzoom? number 最小级别，缺省0
maxzoom? number 最大级别，缺省24
prefix? string 前缀，缺省raster

Returns: Style

# rasterTileUrl

▸ rasterTileUrl(param?: ITileUrlParam): string

栅格瓦片地址

# Parameters
Name Type Default value
param ITileUrlParam {}

Returns: string

# rectQueryFeature

▸ rectQueryFeature(param: IRectQueryFeatures, cb?: (point: [number, number]) => undefined | null | [number, number]): Promise<any>

矩形查询实体

# Parameters
Name Type Description
param IRectQueryFeatures 参数
cb? (point: [number, number]) => undefined | null | [number, number] 结果中每个点的处理回调。如果返回空的话，则用默认处理方法

Returns: Promise<any>

# removeAccessKey

▸ removeAccessKey(key: string): void

移除访问key, 如果key为undefined时，则移除所有的

# Parameters
Name Type Description
key string key值

Returns: void

# removeSecretKey

▸ removeSecretKey(key: string): undefined | Set<string>

移除秘钥key, 如果key为undefined时，则移除所有的

# Parameters
Name Type Description
key string key值

Returns: undefined | Set<string>

# saveCustomData

▸ saveCustomData(key: string | { key: string ; prop?: any ; ttl?: number ; value: any }[], value?: any, prop?: any, ttl?: number): Promise<any>

保存用户自定义数据

# Parameters
Name Type Description
key string | { key: string ; prop?: any ; ttl?: number ; value: any }[] 键名(必须唯一，否则会覆盖之前的数据，同类型的key前缀尽量一样)，如果是数组的话，可以批量
value? any 键值
prop? any 属性值
ttl? number 有效时间，单位秒，默认长期有效

Returns: Promise<any>

# serviceUrl

▸ serviceUrl(u: string): string

得到服务地址

# Parameters
Name Type Description
u string 要拼接的地址

Returns: string

string

# setCurrentMapParam

▸ setCurrentMapParam(param: IOpenMapResponse): null | IOpenMapResponse

设置打开地图参数

# Parameters
Name Type
param IOpenMapResponse

Returns: null | IOpenMapResponse

# setSprite

▸ setSprite(name: string): string

设置精灵图片名称

# Parameters
Name Type Description
name string 精灵名称

Returns: string

# spriteUrl

▸ spriteUrl(name: string): string

精灵图片名称

# Parameters
Name Type Description
name string 精灵名称

Returns: string

# strMd5

▸ strMd5(str: string): string

获取字符串的Md5值

# Parameters
Name Type
str string

Returns: string

# styleVersion

▸ styleVersion(): number

得到style的版本号

Returns: number

# switchWorkspace

▸ switchWorkspace(workspaceName: string): void

切换至工作区

# Parameters
Name Type Description
workspaceName string 工作区名称

Returns: void

# thumbnailUrl

▸ thumbnailUrl(mapid?: string, version?: string, width?: number, height?: number, darkTheme?: boolean): string

获取图的缩略图

# Parameters
Name Type Description
mapid? string
version? string
width? number
height? number
darkTheme? boolean 是否是深色主题，是的话，图片将反色（黑色变白色）

Returns: string

# toLayerIndex

▸ toLayerIndex(layernames: string[], layers: any[]): number[]

把图层名称数组转成图层索引数组

# Parameters
Name Type Description
layernames string[] 图层名称数组
layers any[] 图层列表

Returns: number[]

# updateMap

▸ updateMap(param: IUpdateMapParam, isWaitFinish?: boolean): Promise<any>

更新地图

# Parameters
Name Type Default value Description
param IUpdateMapParam -
isWaitFinish boolean true 是否等待打开完成

Returns: Promise<any>

# updateMetadata

▸ updateMetadata(meta: Record<string, undefined | null | string | number | boolean>, mapid?: string, version?: string): Promise<any>

修改地图元数据

# Parameters
Name Type Description
meta Record<string, undefined | null | string | number | boolean> 要修改的元数据项
mapid? string 地图ID ，为空, 则为当前打开的图形
version? string 版本号，为空 则为当前打开的版本;

Returns: Promise<any>

# uploadMap

▸ uploadMap(file: File): Promise<any>

上传地图

# Parameters
Name Type
file File

Returns: Promise<any>

# uploadUrl

▸ uploadUrl(): string

返回上传文件的url地址

Returns: string

# vectorStyle

▸ vectorStyle(tileUrl?: string | Record<string, any>, minzoom?: number, maxzoom?: number, prefix?: string, hoverColor?: string, hoverOpacity?: number, hoverLineWidth?: number, customColorCaseExpr?: any[], customOpacityCaseExpr?: any[], customLineWidthCaseExpr?: any[], disableHover?: boolean): Style

矢量style

# Parameters
Name Type Description
tileUrl? string | Record<string, any> 矢量瓦片地址 或者为一个Object，为Object时，设置项为参数的每个项值，做为一个参数传入
minzoom? number 最小级别，缺省0
maxzoom? number 最大级别，缺省24
prefix? string 前缀，缺省vector
hoverColor? string 高亮时颜色，缺省rgba(0,0,255,255)
hoverOpacity? number 高亮时透明度,缺省0.5
hoverLineWidth? number 高亮时线宽,缺省3
customColorCaseExpr? any[] 自定义颜色表达式，必须为数组[条件1，值，条件2，值,...]，如[['==', ['feature-state', 'status'], 'alarm'], '#ff0000', ['==', ['feature-state', 'status'], 'normal'], '#00ff00'],缺省默认
customOpacityCaseExpr? any[] 自定义透明度表达式，必须为数组,缺省默认
customLineWidthCaseExpr? any[] 自定义线宽表达式，必须为数组,缺省默认
disableHover? boolean 禁止hover

Returns: Style

# vectorTileUrl

▸ vectorTileUrl(param?: ITileUrlParam): string

矢量瓦片地址

# Parameters
Name Type Default value
param ITileUrlParam {}

Returns: string

# waitMapOpenFinish

▸ waitMapOpenFinish(mapid: string, version: string, tryTime?: number, maxTryTimes?: number): Promise<any>

等待地图打开完成

# Parameters
Name Type Default value Description
mapid string - 地图ID
version string - 地图版本号
tryTime number 5 每次尝试时间间隔(秒)
maxTryTimes number 120 最大尝试次数

Returns: Promise<any>

# webMapUrl

▸ webMapUrl(tileProvider: { fourParameterAfter?: string ; fourParameterBefore?: string ; mapbounds?: string ; srs?: string ; tileCrs?: "gcj02" | "wgs84" ; tileFlipY?: boolean ; tileMaxZoom?: number ; tileRetina?: number ; tileShards?: string ; tileSize?: number ; tileToken?: string | string[] ; tileUrl: string | string[] }): string

获取服务器地图服务地址

# Parameters
Name Type
tileProvider object
tileProvider.fourParameterAfter? string
tileProvider.fourParameterBefore? string
tileProvider.mapbounds? string
tileProvider.srs? string
tileProvider.tileCrs? "gcj02" | "wgs84"
tileProvider.tileFlipY? boolean
tileProvider.tileMaxZoom? number
tileProvider.tileRetina? number
tileProvider.tileShards? string
tileProvider.tileSize? number
tileProvider.tileToken? string | string[]
tileProvider.tileUrl string | string[]

Returns: string

# wmsTileUrl

▸ wmsTileUrl(param: IWmsTileUrl): string

# Parameters
Name Type
param IWmsTileUrl

Returns: string

# workspaceCreate

▸ workspaceCreate(workspace: IWorkspace): Promise<any>

创建工作区(默认需要root权限)

# Parameters
Name Type Description
workspace IWorkspace 工作区设置

Returns: Promise<any>

# workspaceDelete

▸ workspaceDelete(name: string): Promise<any>

删除工作区（会同时删除工作区下面的所有目录文件）(默认需要root权限)

# Parameters
Name Type Description
name string 要删除的工作区名称

Returns: Promise<any>

# workspaceModify

▸ workspaceModify(workspace: IWorkspace): Promise<any>

修改工作区(默认需要root权限)

# Parameters
Name Type Description
workspace IWorkspace 工作区

Returns: Promise<any>

vjmap / Exports / SkyLayer

# Class: SkyLayer

创建天空图层.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new SkyLayer(options: SkyLayerOptions): SkyLayer

# Parameters
Name Type
options SkyLayerOptions

Returns: SkyLayer

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: SkyLayerOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSkyAtmosphereColor

▸ getSkyAtmosphereColor(): string

Returns: string

# getSkyAtmosphereHaloColor

▸ getSkyAtmosphereHaloColor(): string

Returns: string

# getSkyAtmosphereSun

▸ getSkyAtmosphereSun(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getSkyAtmosphereSunIntensity

▸ getSkyAtmosphereSunIntensity(): number

Returns: number

# getSkyGradient

▸ getSkyGradient(): ExpressionSpecificationEx

Returns: ExpressionSpecificationEx

# getSkyGradientCenter

▸ getSkyGradientCenter(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getSkyGradientRadius

▸ getSkyGradientRadius(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getSkyOpacity

▸ getSkyOpacity(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getSkyType

▸ getSkyType(): PropertyValueSpecificationEx<"gradient" | "atmosphere">

Returns: PropertyValueSpecificationEx<"gradient" | "atmosphere">

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# setSkyAtmosphereColor

▸ setSkyAtmosphereColor(value: string): SkyLayer

# Parameters
Name Type
value string

Returns: SkyLayer

# setSkyAtmosphereHaloColor

▸ setSkyAtmosphereHaloColor(value: string): SkyLayer

# Parameters
Name Type
value string

Returns: SkyLayer

# setSkyAtmosphereSun

▸ setSkyAtmosphereSun(value: PropertyValueSpecificationEx<[number, number]>): SkyLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: SkyLayer

# setSkyAtmosphereSunIntensity

▸ setSkyAtmosphereSunIntensity(value: number): SkyLayer

# Parameters
Name Type
value number

Returns: SkyLayer

# setSkyGradient

▸ setSkyGradient(value: ExpressionSpecificationEx): SkyLayer

# Parameters
Name Type
value ExpressionSpecificationEx

Returns: SkyLayer

# setSkyGradientCenter

▸ setSkyGradientCenter(value: PropertyValueSpecificationEx<[number, number]>): SkyLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: SkyLayer

# setSkyGradientRadius

▸ setSkyGradientRadius(value: PropertyValueSpecificationEx<number>): SkyLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: SkyLayer

# setSkyOpacity

▸ setSkyOpacity(value: PropertyValueSpecificationEx<number>): SkyLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: SkyLayer

# setSkyType

▸ setSkyType(value: PropertyValueSpecificationEx<"gradient" | "atmosphere">): SkyLayer

# Parameters
Name Type
value PropertyValueSpecificationEx<"gradient" | "atmosphere">

Returns: SkyLayer

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / SvgOverlay

# Class: SvgOverlay

在一个地理范围内创建一个随缩放而缩放的svg的覆盖物，(注：svg覆盖物性能低，不建议大量使用，同时在级别特别大时会导致失真，在倾斜角很大时会导致不可见)

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new SvgOverlay(options?: SvgOverlayOptions): SvgOverlay

# Parameters
Name Type
options? SvgOverlayOptions

Returns: SvgOverlay

# Properties

# divOverlay

• divOverlay: DivOverlay

# elements

• elements: SvgElementOptions[]

# options

• options: SvgOverlayOptions

# Methods

# addElement

▸ addElement(element: string | SvgElementOptions, noUpdate?: boolean): void

增加svg元素

# Parameters
Name Type Description
element string | SvgElementOptions 要增加的元素
noUpdate? boolean 不立即更新

Returns: void

# addElements

▸ addElements(elements: SvgElementOptions[], noUpdate?: boolean): void

增加svg元素

# Parameters
Name Type Description
elements SvgElementOptions[] 多个元素内容
noUpdate? boolean 不立即更新

Returns: void

# addTo

▸ addTo(map: Map, insertId?: string | HTMLElement): void

# Parameters
Name Type
map Map
insertId? string | HTMLElement

Returns: void

# getElements

▸ getElements(): SvgElementOptions[]

获取所有的元素

Returns: SvgElementOptions[]

# getSvgContainer

▸ getSvgContainer(): SVGSVGElement

获取svg获取

Returns: SVGSVGElement

# remove

▸ remove(): void

Returns: void

# removeElements

▸ removeElements(id: string | string[]): SvgElementOptions[]

移动一个元素

# Parameters
Name Type
id string | string[]

Returns: SvgElementOptions[]

# updateElements

▸ updateElements(elements: SvgElementOptions | SvgElementOptions[]): SvgElementOptions[]

更新一个元素

# Parameters
Name Type
elements SvgElementOptions | SvgElementOptions[]

Returns: SvgElementOptions[]

# attr_cx_cy_r

▸ Static attr_cx_cy_r(cx: number, cy: number, r: number): string

圆心半径属性字符串

# Parameters
Name Type
cx number
cy number
r number

Returns: string

# attr_cx_cy_rx_ry

▸ Static attr_cx_cy_rx_ry(cx: number, cy: number, rx: number, ry: number): string

椭圆心半径属性字符串

# Parameters
Name Type
cx number
cy number
rx number
ry number

Returns: string

# attr_fontsize

▸ Static attr_fontsize(fontsize: number): string

字体属性字符串

# Parameters
Name Type
fontsize number

Returns: string

# attr_length

▸ Static attr_length(len: number): string

和长度有关属性字符串

# Parameters
Name Type
len number

Returns: string

# attr_path

▸ Static attr_path(points: GeoPoint[]): string

路径序列属性字符串

# Parameters
Name Type
points GeoPoint[]

Returns: string

# attr_point

▸ Static attr_point(point: GeoPoint, joinComma?: boolean): string

和点坐标有关属性字符串

# Parameters
Name Type
point GeoPoint
joinComma? boolean

Returns: string

# attr_points

▸ Static attr_points(points: GeoPoint[]): string

坐标序列属性字符串

# Parameters
Name Type
points GeoPoint[]

Returns: string

# attr_x1_y1_x2_y2

▸ Static attr_x1_y1_x2_y2(x1: number, y1: number, x2: number, y2: number): string

直线坐标属性字符串

# Parameters
Name Type
x1 number
y1 number
x2 number
y2 number

Returns: string

# attr_x_y

▸ Static attr_x_y(x: number, y: number): string

坐标属性字符串

# Parameters
Name Type
x number
y number

Returns: string

# attr_x_y_w_h

▸ Static attr_x_y_w_h(x: number, y: number, w: number, h: number): string

坐标宽高属性字符串

# Parameters
Name Type
x number
y number
w number
h number

Returns: string

vjmap / Exports / Symbol

# Class: Symbol

创建符号图层.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Symbol(options: SymbolOptions): Symbol

# Parameters
Name Type
options SymbolOptions

Returns: Symbol

Overrides: OverlayLayerBase

# Properties

# _map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

# options

• options: SymbolOptions

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

# Methods

# addTo

▸ addTo(map: Map, beforeId?: string): void

# Parameters
Name Type
map Map
beforeId? string

Returns: void

Overrides: OverlayLayerBase

# 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

# clickPopup

▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any

每当单击这些图层中的要素时都会显示一个弹出窗口。

example clickPopup(f => <h3>${f.properties.Name}</h3> ${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

# getData

▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

获取数据源的数据

Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection

Inherited from: OverlayLayerBase

# getIconAllowOverlap

▸ getIconAllowOverlap(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getIconAnchor

▸ getIconAnchor(): DataDrivenPropertyValueSpecification<Anchor>

Returns: DataDrivenPropertyValueSpecification<Anchor>

# getIconColor

▸ getIconColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getIconHaloBlur

▸ getIconHaloBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getIconHaloColor

▸ getIconHaloColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getIconHaloWidth

▸ getIconHaloWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getIconIgnorePlacement

▸ getIconIgnorePlacement(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getIconImage

▸ getIconImage(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getIconKeepUpright

▸ getIconKeepUpright(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getIconOffset

▸ getIconOffset(): DataDrivenPropertyValueSpecification<[number, number]>

Returns: DataDrivenPropertyValueSpecification<[number, number]>

# getIconOpacity

▸ getIconOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getIconOptional

▸ getIconOptional(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getIconPadding

▸ getIconPadding(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getIconPitchAlignment

▸ getIconPitchAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">

# getIconRotate

▸ getIconRotate(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getIconRotationAlignment

▸ getIconRotationAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">

# getIconSize

▸ getIconSize(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getIconTextFit

▸ getIconTextFit(): PropertyValueSpecificationEx<"none" | "width" | "height" | "both">

Returns: PropertyValueSpecificationEx<"none" | "width" | "height" | "both">

# getIconTextFitPadding

▸ getIconTextFitPadding(): PropertyValueSpecificationEx<[number, number, number, number]>

Returns: PropertyValueSpecificationEx<[number, number, number, number]>

# getIconTranslate

▸ getIconTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getIconTranslateAnchor

▸ getIconTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getLayerStyle

▸ getLayerStyle(): LayerSpecification

根据样式规范，获取给定图层 ID 的图层定义。

Returns: LayerSpecification

Inherited from: OverlayLayerBase

# getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

# getSymbolAvoidEdges

▸ getSymbolAvoidEdges(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getSymbolPlacement

▸ getSymbolPlacement(): PropertyValueSpecificationEx<"line" | "point" | "line-center">

Returns: PropertyValueSpecificationEx<"line" | "point" | "line-center">

# getSymbolSortKey

▸ getSymbolSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getSymbolSpacing

▸ getSymbolSpacing(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getSymbolZOrder

▸ getSymbolZOrder(): PropertyValueSpecificationEx<"source" | "auto" | "viewport-y">

Returns: PropertyValueSpecificationEx<"source" | "auto" | "viewport-y">

# getTextAllowOverlap

▸ getTextAllowOverlap(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getTextAnchor

▸ getTextAnchor(): DataDrivenPropertyValueSpecification<Anchor>

Returns: DataDrivenPropertyValueSpecification<Anchor>

# getTextColor

▸ getTextColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getTextField

▸ getTextField(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getTextFont

▸ getTextFont(): DataDrivenPropertyValueSpecification<string[]>

Returns: DataDrivenPropertyValueSpecification<string[]>

# getTextHaloBlur

▸ getTextHaloBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextHaloColor

▸ getTextHaloColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

# getTextHaloWidth

▸ getTextHaloWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextIgnorePlacement

▸ getTextIgnorePlacement(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getTextJustify

▸ getTextJustify(): DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto">

Returns: DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto">

# getTextKeepUpright

▸ getTextKeepUpright(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getTextLetterSpacing

▸ getTextLetterSpacing(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextLineHeight

▸ getTextLineHeight(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextMaxAngle

▸ getTextMaxAngle(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getTextMaxWidth

▸ getTextMaxWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextOffset

▸ getTextOffset(): DataDrivenPropertyValueSpecification<[number, number]>

Returns: DataDrivenPropertyValueSpecification<[number, number]>

# getTextOpacity

▸ getTextOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextOptional

▸ getTextOptional(): PropertyValueSpecificationEx<boolean>

Returns: PropertyValueSpecificationEx<boolean>

# getTextPadding

▸ getTextPadding(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>

# getTextPitchAlignment

▸ getTextPitchAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">

# getTextRadialOffset

▸ getTextRadialOffset(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextRotate

▸ getTextRotate(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextRotationAlignment

▸ getTextRotationAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">

# getTextSize

▸ getTextSize(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

# getTextTransform

▸ getTextTransform(): DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">

Returns: DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">

# getTextTranslate

▸ getTextTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

# getTextTranslateAnchor

▸ getTextTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

# getTextVariableAnchor

▸ getTextVariableAnchor(): PropertyValueSpecificationEx<Anchor[]>

Returns: PropertyValueSpecificationEx<Anchor[]>

# getTextWritingMode

▸ getTextWritingMode(): PropertyValueSpecificationEx<("vertical" | "horizontal")[]>

Returns: PropertyValueSpecificationEx<("vertical" | "horizontal")[]>

# hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

# hoverFeatureState

▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

# Parameters
Name Type
enterCb? (arg0: {}) => void
leaveCb? (arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

# hoverLayer

▸ hoverLayer(cb: any): any

当鼠标悬停在这些图层中的要素上时触发回调。

# Parameters
Name Type
cb any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPointer

▸ hoverPointer(): void

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

# hoverPopup

▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

example hoverPopup(f => <h3>${f.properties.Name}</h3> ${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

# remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

# setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

# Parameters
Name Type
data any

Returns: void

# setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

example setFilter(['==','level','0']]);

# Parameters
Name Type Description
filter FilterSpecification New filter to set.

Returns: void

Inherited from: OverlayLayerBase

# setIconAllowOverlap

▸ setIconAllowOverlap(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setIconAnchor

▸ setIconAnchor(value: DataDrivenPropertyValueSpecification<Anchor>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<Anchor>

Returns: Symbol

# setIconColor

▸ setIconColor(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setIconHaloBlur

▸ setIconHaloBlur(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setIconHaloColor

▸ setIconHaloColor(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setIconHaloWidth

▸ setIconHaloWidth(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setIconIgnorePlacement

▸ setIconIgnorePlacement(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setIconImage

▸ setIconImage(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setIconKeepUpright

▸ setIconKeepUpright(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setIconOffset

▸ setIconOffset(value: DataDrivenPropertyValueSpecification<[number, number]>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<[number, number]>

Returns: Symbol

# setIconOpacity

▸ setIconOpacity(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setIconOptional

▸ setIconOptional(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setIconPadding

▸ setIconPadding(value: PropertyValueSpecificationEx<number>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Symbol

# setIconPitchAlignment

▸ setIconPitchAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: Symbol

# setIconRotate

▸ setIconRotate(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setIconRotationAlignment

▸ setIconRotationAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: Symbol

# setIconSize

▸ setIconSize(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setIconTextFit

▸ setIconTextFit(value: PropertyValueSpecificationEx<"none" | "width" | "height" | "both">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"none" | "width" | "height" | "both">

Returns: Symbol

# setIconTextFitPadding

▸ setIconTextFitPadding(value: PropertyValueSpecificationEx<[number, number, number, number]>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number, number, number]>

Returns: Symbol

# setIconTranslate

▸ setIconTranslate(value: PropertyValueSpecificationEx<[number, number]>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: Symbol

# setIconTranslateAnchor

▸ setIconTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Symbol

# setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase

# 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

# setSymbolAvoidEdges

▸ setSymbolAvoidEdges(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setSymbolPlacement

▸ setSymbolPlacement(value: PropertyValueSpecificationEx<"line" | "point" | "line-center">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"line" | "point" | "line-center">

Returns: Symbol

# setSymbolSortKey

▸ setSymbolSortKey(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setSymbolSpacing

▸ setSymbolSpacing(value: PropertyValueSpecificationEx<number>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Symbol

# setSymbolZOrder

▸ setSymbolZOrder(value: PropertyValueSpecificationEx<"source" | "auto" | "viewport-y">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"source" | "auto" | "viewport-y">

Returns: Symbol

# setTextAllowOverlap

▸ setTextAllowOverlap(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setTextAnchor

▸ setTextAnchor(value: DataDrivenPropertyValueSpecification<Anchor>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<Anchor>

Returns: Symbol

# setTextColor

▸ setTextColor(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setTextField

▸ setTextField(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setTextFont

▸ setTextFont(value: DataDrivenPropertyValueSpecification<string[]>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string[]>

Returns: Symbol

# setTextHaloBlur

▸ setTextHaloBlur(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextHaloColor

▸ setTextHaloColor(value: DataDrivenPropertyValueSpecification<string>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Symbol

# setTextHaloWidth

▸ setTextHaloWidth(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextIgnorePlacement

▸ setTextIgnorePlacement(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setTextJustify

▸ setTextJustify(value: DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto">): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto">

Returns: Symbol

# setTextKeepUpright

▸ setTextKeepUpright(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setTextLetterSpacing

▸ setTextLetterSpacing(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextLineHeight

▸ setTextLineHeight(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextMaxAngle

▸ setTextMaxAngle(value: PropertyValueSpecificationEx<number>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Symbol

# setTextMaxWidth

▸ setTextMaxWidth(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextOffset

▸ setTextOffset(value: DataDrivenPropertyValueSpecification<[number, number]>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<[number, number]>

Returns: Symbol

# setTextOpacity

▸ setTextOpacity(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextOptional

▸ setTextOptional(value: PropertyValueSpecificationEx<boolean>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Symbol

# setTextPadding

▸ setTextPadding(value: PropertyValueSpecificationEx<number>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Symbol

# setTextPitchAlignment

▸ setTextPitchAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: Symbol

# setTextRadialOffset

▸ setTextRadialOffset(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextRotate

▸ setTextRotate(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextRotationAlignment

▸ setTextRotationAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport" | "auto">

Returns: Symbol

# setTextSize

▸ setTextSize(value: DataDrivenPropertyValueSpecification<number>): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Symbol

# setTextTransform

▸ setTextTransform(value: DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">): Symbol

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">

Returns: Symbol

# setTextTranslate

▸ setTextTranslate(value: PropertyValueSpecificationEx<[number, number]>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: Symbol

# setTextTranslateAnchor

▸ setTextTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Symbol

# setTextVariableAnchor

▸ setTextVariableAnchor(value: PropertyValueSpecificationEx<Anchor[]>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<Anchor[]>

Returns: Symbol

# setTextWritingMode

▸ setTextWritingMode(value: PropertyValueSpecificationEx<("vertical" | "horizontal")[]>): Symbol

# Parameters
Name Type
value PropertyValueSpecificationEx<("vertical" | "horizontal")[]>

Returns: Symbol

# show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

# toggle

▸ toggle(state: boolean): boolean

根据参数使给定的图层隐藏或可见。

# Parameters
Name Type Description
state boolean True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / Text

# Class: Text

创建文本组件.

param

param 文字内容

param 文字样式

param 用作文本的 DOM 元素。

param 一个字符串，指示应该放置在最靠近坐标的标记部分。选项有“center”、“top”、“bottom”、“left”、“right”、“top-left”、“top-right”、“top-right” “左下”和“右下”.

param 作为要应用的对象相对于元素中心的偏移量（以像素为单位）。负数表示向左和向上.

param 如果未提供options.element.

param 如果未提供options.element，则用于默认文本的比例。.

param 一个布尔值，指示是否可以将文本拖动到地图上的新位置.

param 用户在单击文本期间可以移动鼠标指针以将其视为有效单击（与文本拖动相反）的最大像素数。默认是继承地图的clickTolerance.

param 文本相对于其各自的“rotationAlignment”设置的旋转角度（以度为单位）。正值将顺时针旋转文本.

param map 将 Text 与地图平面对齐。 viewport 将 Text 与视口平面对齐。 auto 自动匹配 rotationAlignment 的值.

param map 对齐 Text 相对于地图的旋转，在地图旋转时保持方位。 viewport 对齐 Text 相对于视口的旋转，与地图旋转无关。 auto 等价于 viewport.

example // Create a new Text. const text = new vjmap.Text({text: "abc“}) .setLngLat([30.5, 50.5]) .addTo(map);

example // Set text options. const text = new vjmap.Text({ text: "abc“, draggable: true }).setLngLat([30.5, 50.5]) .addTo(map);

# Hierarchy

  • Evented

    ↳ Text

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Text(options?: TextOptions): Text

构造函数

# Parameters
Name Type
options? TextOptions

Returns: Text

Overrides: Evented.constructor

# Properties

# _style

• _style: object

# _textContainerDom

• _textContainerDom: HTMLElement

# Methods

# addTo

▸ addTo(map: Map): Text

将 Text 附加到 Map 对象。

example const text = new vjmap.Text({text: "abc"}) .setLngLat([30.5, 50.5]) .addTo(map); // add the text to the map

# Parameters
Name Type Description
map Map to add the text to.

Returns: Text

Returns itself to allow for method chaining.

# getElement

▸ getElement(): HTMLElement

返回 Text 的 HTML 元素。

example const element = text.getElement();

Returns: HTMLElement

Returns the text element.

# getLngLat

▸ getLngLat(): LngLatLike

得到经纬度

Returns: LngLatLike

# getMarker

▸ getMarker(): Marker

返回 Text 的 Marker 对象。

Returns: Marker

# getOffset

▸ getOffset(): number

获取文本的偏移量.

Returns: number

The text's screen coordinates in pixels.

# getPitchAlignment

▸ getPitchAlignment(): string

返回文本的当前 pitchAlignment 属性.

Returns: string

The current pitch alignment of the text in degrees.

# getPopup

▸ getPopup(): Popup

返回绑定到 Text 的 Popup 实例。

Returns: Popup

Returns the popup.

# getRotation

▸ getRotation(): number

返回文本的当前旋转角度（以度为单位）.

Returns: number

The current rotation angle of the text.

# getRotationAlignment

▸ getRotationAlignment(): string

返回文本的当前 rotationAlignment 属性.

Returns: string

The current rotational alignment of the text.

# getStyle

▸ getStyle(): object

得到文本样式

Returns: object

# getText

▸ getText(): string

得到文本内容

Returns: string

# hide

▸ hide(): void

隐藏

Returns: void

# isDraggable

▸ isDraggable(): boolean

如果可以拖动文本，则返回 true。

Returns: boolean

True if the text is draggable.

# remove

▸ remove(): Text

从地图中删除文本。

example const text = new vjmap.Text().addTo(map); text.remove();

Returns: Text

Returns itself to allow for method chaining.

# setAnimation

▸ setAnimation(animationType: string): void

设置动画

# Parameters
Name Type Description
animationType string MAP_ANIMATION_NONE 无动画 MAP_ANIMATION_BOUNCE 弹跳 MAP_ANIMATION_DROP 坠落

Returns: void

# setCursor

▸ setCursor(cur: string): void

设置光标

# Parameters
Name Type Description
cur string 光标名称

Returns: void

# setDraggable

▸ setDraggable(shouldBeDraggable: boolean): Text

设置文本的 draggable 属性和功能.

# Parameters
Name Type
shouldBeDraggable boolean

Returns: Text

Returns itself to allow for method chaining.

# setLngLat

▸ setLngLat(lnglat: LngLatLike): Text

设置经纬度

# Parameters
Name Type
lnglat LngLatLike

Returns: Text

# setOffset

▸ setOffset(offset: PointLike): Text

设置文本的偏移量.

# Parameters
Name Type Description
offset PointLike 以像素为单位的偏移量，作为 PointLike 对象相对于元素的中心应用。负数表示向左和向上。

Returns: Text

Returns itself to allow for method chaining.

# setPitchAlignment

▸ setPitchAlignment(alignment: string): Text

设置文本的 pitchAlignment 属性.

# Parameters
Name Type
alignment string

Returns: Text

Returns itself to allow for method chaining.

# setPopup

▸ setPopup(popup?: Popup): Text

Binds a Popup to the Text

# Parameters
Name Type
popup? Popup

Returns: Text

# setRotation

▸ setRotation(rotation: number): Text

Sets the rotation property of the text.

# Parameters
Name Type
rotation number

Returns: Text

Returns itself to allow for method chaining.

# setRotationAlignment

▸ setRotationAlignment(alignment: string): Text

设置文本的 rotationAlignment 属性.

# Parameters
Name Type
alignment string

Returns: Text

Returns itself to allow for method chaining.

# setStyle

▸ setStyle(style?: object): Text

设置文本样式

# Parameters
Name Type Default value
style object {}

Returns: Text

# setText

▸ setText(txt: string): Text

设置文本内容

# Parameters
Name Type
txt string

Returns: Text

# show

▸ show(): void

显示

Returns: void

# togglePopup

▸ togglePopup(): Text

根据 Popup 的当前状态打开或关闭绑定到 Text 的 Popup 实例.

Returns: Text

Returns itself to allow for method chaining.

vjmap / Exports / ThreeLayer

# Class: ThreeLayer

threejs图层.

# Hierarchy

  • Evented

    ↳ ThreeLayer

# Implements

  • CustomLayerInterface

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new ThreeLayer(options: ThreeLayerOptions): ThreeLayer

# Parameters
Name Type
options ThreeLayerOptions

Returns: ThreeLayer

Overrides: Evented.constructor

# Properties

# context

• context: ThreeJsContext

# id

• id: string

Implementation of: CustomLayerInterface.id

# 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

vjmap / Exports / WebSocketEvent

# Class: WebSocketEvent

# Hierarchy

# Table of contents

# Constructors

# Properties

# Constructors

# constructor

+ new WebSocketEvent(type: string, target: any): WebSocketEvent

# Parameters
Name Type
type string
target any

Returns: WebSocketEvent

# Properties

# target

• target: any

# type

• type: string

# Enums

vjmap / Exports / AnimationStatus

# Enumeration: AnimationStatus

# Table of contents

# Enumeration members

# Enumeration members

# End

• End: = 3

结束 (回调函数中返回true).

# Pause

• Pause: = 2

暂停.

# Run

• Run: = 0

运行.

# Stop

• Stop: = 1

停止（用户主动调用stop).

vjmap / Exports / DbTextHorzMode

# Enumeration: DbTextHorzMode

# Table of contents

# Enumeration members

# Enumeration members

# kTextAlign

• kTextAlign: = 3

# kTextCenter

• kTextCenter: = 1

# kTextFit

• kTextFit: = 5

# kTextLeft

• kTextLeft: = 0

# kTextMid

• kTextMid: = 4

# kTextRight

• kTextRight: = 2

vjmap / Exports / DbTextVertMode

# Enumeration: DbTextVertMode

# Table of contents

# Enumeration members

# Enumeration members

# kTextBase

• kTextBase: = 0

# kTextBottom

• kTextBottom: = 1

# kTextTop

• kTextTop: = 3

# kTextVertMid

• kTextVertMid: = 2

vjmap / Exports / default / DbTextHorzMode

# Enumeration: DbTextHorzMode

default.DbTextHorzMode

# Table of contents

# Enumeration members

# Enumeration members

# kTextAlign

• kTextAlign: = 3

# kTextCenter

• kTextCenter: = 1

# kTextFit

• kTextFit: = 5

# kTextLeft

• kTextLeft: = 0

# kTextMid

• kTextMid: = 4

# kTextRight

• kTextRight: = 2

vjmap / Exports / default / DbTextVertMode

# Enumeration: DbTextVertMode

default.DbTextVertMode

# Table of contents

# Enumeration members

# Enumeration members

# kTextBase

• kTextBase: = 0

# kTextBottom

• kTextBottom: = 1

# kTextTop

• kTextTop: = 3

# kTextVertMid

• kTextVertMid: = 2

vjmap / Exports / default / FrameAnimationStatus

# Enumeration: FrameAnimationStatus

default.FrameAnimationStatus

# Table of contents

# Enumeration members

# Enumeration members

# End

• End: = 3

结束 (回调函数中返回true).

# Pause

• Pause: = 2

暂停.

# Run

• Run: = 0

运行.

# Stop

• Stop: = 1

停止（用户主动调用stop).

vjmap / Exports / default / IDbLinetypeStyleMethod

# Enumeration: IDbLinetypeStyleMethod

default.IDbLinetypeStyleMethod

# Table of contents

# Enumeration members

# Enumeration members

# dashLengthAt

• dashLengthAt: = "dashLengthAt"

[int dashIndex, double dashLength ].

# isScaledToFit

• isScaledToFit: = "isScaledToFit"

[ bool bScaleToFit] .

# numDashes

• numDashes: = "numDashes"

[int count] .

# patternLength

• patternLength: = "patternLength"

[double dPatLen] .

# shapeNumberAt

• shapeNumberAt: = "shapeNumberAt"

[int dashIndex, int shapeNumber] .

# shapeOffsetAt

• shapeOffsetAt: = "shapeOffsetAt"

[int dashIndex, [int, int] shapeOffset] .

# shapeRotationAt

• shapeRotationAt: = "shapeRotationAt"

[int dashIndex, double shapeRotation] .

# shapeScaleAt

• shapeScaleAt: = "shapeScaleAt"

[ int dashIndex, double shapeScale] .

# shapeStyleAt

• shapeStyleAt: = "shapeStyleAt"

[int dashIndex, string idTextStyle] .

# textAt

• textAt: = "textAt"

[int dashIndex, string textString] .

vjmap / Exports / default / IDbMatrixOpName

# Enumeration: IDbMatrixOpName

default.IDbMatrixOpName

# Table of contents

# Enumeration members

# Enumeration members

# rotate

• rotate: = "rotate"

rotate.

# scale

• scale: = "scale"

缩放 .

# translation

• translation: = "translation"

平移 .

vjmap / Exports / default / MapOpenWay

# Enumeration: MapOpenWay

default.MapOpenWay

# Table of contents

# Enumeration members

# Enumeration members

# GeomRender

• GeomRender: = "GeomRender"

存储为几何数据再渲染模式

# Memory

• Memory: = "Memory"

内存模式.

vjmap / Exports / default / MTextAttachmentPoint

# Enumeration: MTextAttachmentPoint

default.MTextAttachmentPoint

# Table of contents

# Enumeration members

# Enumeration members

# kBaseAlign

• kBaseAlign: = 13

# kBaseCenter

• kBaseCenter: = 11

# kBaseFit

• kBaseFit: = 17

# kBaseLeft

• kBaseLeft: = 10

# kBaseMid

• kBaseMid: = 21

# kBaseRight

• kBaseRight: = 12

# kBottomAlign

• kBottomAlign: = 14

# kBottomCenter

• kBottomCenter: = 8

# kBottomFit

• kBottomFit: = 18

# kBottomLeft

• kBottomLeft: = 7

# kBottomMid

• kBottomMid: = 22

# kBottomRight

• kBottomRight: = 9

# kMiddleAlign

• kMiddleAlign: = 15

# kMiddleCenter

• kMiddleCenter: = 5

# kMiddleFit

• kMiddleFit: = 19

# kMiddleLeft

• kMiddleLeft: = 4

# kMiddleMid

• kMiddleMid: = 23

# kMiddleRight

• kMiddleRight: = 6

# kTopAlign

• kTopAlign: = 16

# kTopCenter

• kTopCenter: = 2

# kTopFit

• kTopFit: = 20

# kTopLeft

• kTopLeft: = 1

# kTopMid

• kTopMid: = 24

# kTopRight

• kTopRight: = 3

vjmap / Exports / default / Poly2dType

# Enumeration: Poly2dType

default.Poly2dType

2d折线类型接口

# Table of contents

# Enumeration members

# Enumeration members

# k2dCubicSplinePoly

• k2dCubicSplinePoly: = 3

# k2dFitCurvePoly

• k2dFitCurvePoly: = 1

# k2dQuadSplinePoly

• k2dQuadSplinePoly: = 2

# k2dSimplePoly

• k2dSimplePoly: = 0

vjmap / Exports / default / Poly3dType

# Enumeration: Poly3dType

default.Poly3dType

3d折线类型接口

# Table of contents

# Enumeration members

# Enumeration members

# k3dCubicSplinePoly

• k3dCubicSplinePoly: = 2

# k3dQuadSplinePoly

• k3dQuadSplinePoly: = 1

# k3dSimplePoly

• k3dSimplePoly: = 0

vjmap / Exports / default / RasterImageUnits

# Enumeration: RasterImageUnits

default.RasterImageUnits

# Table of contents

# Enumeration members

# Enumeration members

# kAngstroms

• kAngstroms: = 11

Angstroms (10^-10 of a meter or ten-billionths of a meter) are used.

# kAstronomical

• kAstronomical: = 18

Astronominal units (149597870700 meters) are used.

# kCentimeter

• kCentimeter: = 2

Centimeters are used.

# kDecimeters

• kDecimeters: = 14

Decimeters are used.

# kDekameters

• kDekameters: = 15

Dekameters (10 meters) are used.

# kFoot

• kFoot: = 6

Foots are used.

# kGigameters

• kGigameters: = 17

Gigameters (10^9 meters) are used.

# kHectometers

• kHectometers: = 16

Hectometers (10^2 meters) are used.

# kInch

• kInch: = 5

Inches are used.

# kKilometer

• kKilometer: = 4

Kilometers are used.

# kLightYears

• kLightYears: = 19

Light years (9460730472580800 meters) are used.

# kMeter

• kMeter: = 3

Meters are used.

# kMicroinches

• kMicroinches: = 9

Microinches are used.

# kMicrons

• kMicrons: = 13

Microns are used.

# kMile

• kMile: = 8

Miles are used.

# kMillimeter

• kMillimeter: = 1

Millimeters are used.

# kMils

• kMils: = 10

Mils (thousandths of an inch) are used.

# kNanometers

• kNanometers: = 12

Nanometers are used.

# kNone

• kNone: = 0

No measurement units are used.

# kParsecs

• kParsecs: = 20

Parsecs (approx 3.261563777 light years) are used.

# kYard

• kYard: = 7

Yards are used.

vjmap / Exports / default / TableCellAlignment

# Enumeration: TableCellAlignment

default.TableCellAlignment

表格单元格对齐方式

# Table of contents

# Enumeration members

# Enumeration members

# kBottomCenter

• kBottomCenter: = 8

# kBottomLeft

• kBottomLeft: = 7

# kBottomRight

• kBottomRight: = 9

# kMiddleCenter

• kMiddleCenter: = 5

# kMiddleLeft

• kMiddleLeft: = 4

# kMiddleRight

• kMiddleRight: = 6

# kTopCenter

• kTopCenter: = 2

# kTopLeft

• kTopLeft: = 1

# kTopRight

• kTopRight: = 3

vjmap / Exports / FrameAnimationStatus

# Enumeration: FrameAnimationStatus

# Table of contents

# Enumeration members

# Enumeration members

# End

• End: = 3

结束 (回调函数中返回true).

# Pause

• Pause: = 2

暂停.

# Run

• Run: = 0

运行.

# Stop

• Stop: = 1

停止（用户主动调用stop).

vjmap / Exports / IDbLinetypeStyleMethod

# Enumeration: IDbLinetypeStyleMethod

# Table of contents

# Enumeration members

# Enumeration members

# dashLengthAt

• dashLengthAt: = "dashLengthAt"

[int dashIndex, double dashLength ].

# isScaledToFit

• isScaledToFit: = "isScaledToFit"

[ bool bScaleToFit] .

# numDashes

• numDashes: = "numDashes"

[int count] .

# patternLength

• patternLength: = "patternLength"

[double dPatLen] .

# shapeNumberAt

• shapeNumberAt: = "shapeNumberAt"

[int dashIndex, int shapeNumber] .

# shapeOffsetAt

• shapeOffsetAt: = "shapeOffsetAt"

[int dashIndex, [int, int] shapeOffset] .

# shapeRotationAt

• shapeRotationAt: = "shapeRotationAt"

[int dashIndex, double shapeRotation] .

# shapeScaleAt

• shapeScaleAt: = "shapeScaleAt"

[ int dashIndex, double shapeScale] .

# shapeStyleAt

• shapeStyleAt: = "shapeStyleAt"

[int dashIndex, string idTextStyle] .

# textAt

• textAt: = "textAt"

[int dashIndex, string textString] .

vjmap / Exports / IDbMatrixOpName

# Enumeration: IDbMatrixOpName

# Table of contents

# Enumeration members

# Enumeration members

# rotate

• rotate: = "rotate"

rotate.

# scale

• scale: = "scale"

缩放 .

# translation

• translation: = "translation"

平移 .

vjmap / Exports / MapOpenWay

# Enumeration: MapOpenWay

# Table of contents

# Enumeration members

# Enumeration members

# GeomRender

• GeomRender: = "GeomRender"

存储为几何数据再渲染模式

# Memory

• Memory: = "Memory"

内存模式.

vjmap / Exports / MTextAttachmentPoint

# Enumeration: MTextAttachmentPoint

# Table of contents

# Enumeration members

# Enumeration members

# kBaseAlign

• kBaseAlign: = 13

# kBaseCenter

• kBaseCenter: = 11

# kBaseFit

• kBaseFit: = 17

# kBaseLeft

• kBaseLeft: = 10

# kBaseMid

• kBaseMid: = 21

# kBaseRight

• kBaseRight: = 12

# kBottomAlign

• kBottomAlign: = 14

# kBottomCenter

• kBottomCenter: = 8

# kBottomFit

• kBottomFit: = 18

# kBottomLeft

• kBottomLeft: = 7

# kBottomMid

• kBottomMid: = 22

# kBottomRight

• kBottomRight: = 9

# kMiddleAlign

• kMiddleAlign: = 15

# kMiddleCenter

• kMiddleCenter: = 5

# kMiddleFit

• kMiddleFit: = 19

# kMiddleLeft

• kMiddleLeft: = 4

# kMiddleMid

• kMiddleMid: = 23

# kMiddleRight

• kMiddleRight: = 6

# kTopAlign

• kTopAlign: = 16

# kTopCenter

• kTopCenter: = 2

# kTopFit

• kTopFit: = 20

# kTopLeft

• kTopLeft: = 1

# kTopMid

• kTopMid: = 24

# kTopRight

• kTopRight: = 3

vjmap / Exports / Poly2dType

# Enumeration: Poly2dType

2d折线类型接口

# Table of contents

# Enumeration members

# Enumeration members

# k2dCubicSplinePoly

• k2dCubicSplinePoly: = 3

# k2dFitCurvePoly

• k2dFitCurvePoly: = 1

# k2dQuadSplinePoly

• k2dQuadSplinePoly: = 2

# k2dSimplePoly

• k2dSimplePoly: = 0

vjmap / Exports / Poly3dType

# Enumeration: Poly3dType

3d折线类型接口

# Table of contents

# Enumeration members

# Enumeration members

# k3dCubicSplinePoly

• k3dCubicSplinePoly: = 2

# k3dQuadSplinePoly

• k3dQuadSplinePoly: = 1

# k3dSimplePoly

• k3dSimplePoly: = 0

vjmap / Exports / RasterImageUnits

# Enumeration: RasterImageUnits

# Table of contents

# Enumeration members

# Enumeration members

# kAngstroms

• kAngstroms: = 11

Angstroms (10^-10 of a meter or ten-billionths of a meter) are used.

# kAstronomical

• kAstronomical: = 18

Astronominal units (149597870700 meters) are used.

# kCentimeter

• kCentimeter: = 2

Centimeters are used.

# kDecimeters

• kDecimeters: = 14

Decimeters are used.

# kDekameters

• kDekameters: = 15

Dekameters (10 meters) are used.

# kFoot

• kFoot: = 6

Foots are used.

# kGigameters

• kGigameters: = 17

Gigameters (10^9 meters) are used.

# kHectometers

• kHectometers: = 16

Hectometers (10^2 meters) are used.

# kInch

• kInch: = 5

Inches are used.

# kKilometer

• kKilometer: = 4

Kilometers are used.

# kLightYears

• kLightYears: = 19

Light years (9460730472580800 meters) are used.

# kMeter

• kMeter: = 3

Meters are used.

# kMicroinches

• kMicroinches: = 9

Microinches are used.

# kMicrons

• kMicrons: = 13

Microns are used.

# kMile

• kMile: = 8

Miles are used.

# kMillimeter

• kMillimeter: = 1

Millimeters are used.

# kMils

• kMils: = 10

Mils (thousandths of an inch) are used.

# kNanometers

• kNanometers: = 12

Nanometers are used.

# kNone

• kNone: = 0

No measurement units are used.

# kParsecs

• kParsecs: = 20

Parsecs (approx 3.261563777 light years) are used.

# kYard

• kYard: = 7

Yards are used.

vjmap / Exports / TableCellAlignment

# Enumeration: TableCellAlignment

表格单元格对齐方式

# Table of contents

# Enumeration members

# Enumeration members

# kBottomCenter

• kBottomCenter: = 8

# kBottomLeft

• kBottomLeft: = 7

# kBottomRight

• kBottomRight: = 9

# kMiddleCenter

• kMiddleCenter: = 5

# kMiddleLeft

• kMiddleLeft: = 4

# kMiddleRight

• kMiddleRight: = 6

# kTopCenter

• kTopCenter: = 2

# kTopLeft

• kTopLeft: = 1

# kTopRight

• kTopRight: = 3

# Interfaces

vjmap / Exports / Animate

# Interface: Animate<V>

# Type parameters

Name
V

# Table of contents

# Properties

# Properties

# flipTarget

• flipTarget: () => void

# Type declaration

▸ (): void

Returns: void

# next

• next: (t: number) => { done: boolean ; value: V }

# Type declaration

▸ (t: number): object

# Parameters
Name Type
t number

Returns: object

Name Type
done boolean
value V

vjmap / Exports / AnimateMarkerLayerOption

# Interface: AnimateMarkerLayerOption

# Table of contents

# Properties

# Properties

# colors

• Optional colors: string[]

# height

• Optional height: number

# textColor

• Optional textColor: string

# textField

• Optional textField: string

# textFontSize

• Optional textFontSize: number

# type

• Optional type: "breathingAperture" | "rotatingAperture" | "haloRing" | "diffusedAperture" | "rotatingTextBorder" | "fluorescence"

# width

• Optional width: number

vjmap / Exports / Animation

# Interface: Animation<V>

# Type parameters

Name
V

# Table of contents

# Properties

# Properties

# flipTarget

• flipTarget: () => void

# Type declaration

▸ (): void

Returns: void

# next

• next: (t: number) => { done: boolean ; value: V }

# Type declaration

▸ (t: number): object

# Parameters
Name Type
t number

Returns: object

Name Type
done boolean
value V

vjmap / Exports / AnimationState

# Interface: AnimationState<V>

# Type parameters

Name
V

# Table of contents

# Properties

# Properties

# done

• done: boolean

# value

• value: V

vjmap / Exports / BackgroundLayerOptions

# Interface: BackgroundLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# backgroundColor

• Optional backgroundColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" }

# backgroundOpacity

• Optional backgroundOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# backgroundPattern

• Optional backgroundPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" }

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / CircleEdgeOptions

# Interface: CircleEdgeOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# center

• center: GeoPointLike

中心点

# data

• data: any

Inherited from: PolylineOptions.data

# endAngle

• Optional endAngle: number

# filter

• Optional filter: any

Inherited from: PolylineOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: PolylineOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: PolylineOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: PolylineOptions.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineBlur

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

Inherited from: PolylineOptions.lineCap

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolylineOptions.lineColor

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

Inherited from: PolylineOptions.lineDasharray

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineGapWidth

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

Inherited from: PolylineOptions.lineGradient

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

Inherited from: PolylineOptions.lineJoin

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: PolylineOptions.lineMiterMimit

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineOffset

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineOpacity

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolylineOptions.linePattern

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: PolylineOptions.lineRoundLimit

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineSortKey

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: PolylineOptions.lineTranslate

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: PolylineOptions.lineTranslateAnchor

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineWidth

# maxzoom

• Optional maxzoom: number

Inherited from: PolylineOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: PolylineOptions.minzoom

# points

• Optional points: number

# properties

• Optional properties: object

属性数据

# radius

• radius: number

半径

# sourceId

• Optional sourceId: string

Inherited from: PolylineOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: PolylineOptions.sourceLayer

# startAngle

• Optional startAngle: number

开始角度

# visibility

• Optional visibility: "visible" | "none"

Inherited from: PolylineOptions.visibility

vjmap / Exports / CircleFillOptions

# Interface: CircleFillOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# center

• center: GeoPointLike

中心点

# data

• data: any

Inherited from: PolygonOptions.data

# endAngle

• Optional endAngle: number

终止角度

# fillAntialias

• Optional fillAntialias: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: PolygonOptions.fillAntialias

# fillColor

• Optional fillColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillColor

# fillOpacity

• Optional fillOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolygonOptions.fillOpacity

# fillOutlineColor

• Optional fillOutlineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillOutlineColor

# fillPattern

• Optional fillPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillPattern

# fillSortKey

• Optional fillSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolygonOptions.fillSortKey

# fillTranslate

• Optional fillTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: PolygonOptions.fillTranslate

# fillTranslateAnchor

• Optional fillTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: PolygonOptions.fillTranslateAnchor

# filter

• Optional filter: any

Inherited from: PolygonOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: PolygonOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: PolygonOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: PolygonOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: PolygonOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: PolygonOptions.minzoom

# points

• Optional points: number

离散化的点的个数

# properties

• Optional properties: object

属性数据

# radius

• radius: number

半径

# sourceId

• Optional sourceId: string

Inherited from: PolygonOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: PolygonOptions.sourceLayer

# startAngle

• Optional startAngle: number

开始角度

# visibility

• Optional visibility: "visible" | "none"

Inherited from: PolygonOptions.visibility

vjmap / Exports / CircleOptions

# Interface: CircleOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# circleBlur

• Optional circleBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circleColor

• Optional circleColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# circleOpacity

• Optional circleOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circlePitchAlignment

• Optional circlePitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# circlePitchScale

• Optional circlePitchScale: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# circleRadius

• Optional circleRadius: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circleSortKey

• Optional circleSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circleStrokeColor

• Optional circleStrokeColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# circleStrokeOpacity

• Optional circleStrokeOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circleStrokeWidth

• Optional circleStrokeWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circleTranslate

• Optional circleTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# circleTranslateAnchor

• Optional circleTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# data

• data: any

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / Config

# Interface: Config<T>

# Type parameters

Name Default
T unknown

# Table of contents

# Properties

# Properties

# abort

• Optional abort: any

# data

• Optional data: string | Document | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams | ReadableStream<Uint8Array>

# dump

• dump: (data: T) => string

# Type declaration

▸ (data: T): string

# Parameters
Name Type
data T

Returns: string

# events

• Optional events: object

# Type declaration

# headers

• headers: object

# Type declaration

# load

• load: (str: string) => T

# Type declaration

▸ (str: string): T

# Parameters
Name Type
str string

Returns: T

# method

• method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD"

# params

• Optional params: string | URLSearchParams | string[][] | Record<string, string>

# promise

• promise: (fn: () => Promise<unknown>) => Promise<unknown>

# Type declaration

▸ (fn: () => Promise<unknown>): Promise<unknown>

# Parameters
Name Type
fn () => Promise<unknown>

Returns: Promise<unknown>

# raw

• Optional raw: boolean

# url

• Optional url: string

# withCredentials

• withCredentials: boolean

# xmlHttpRequest

• xmlHttpRequest: () => XMLHttpRequest

# Type declaration

▸ (): XMLHttpRequest

Returns: XMLHttpRequest

vjmap / Exports / ContextMenuOptions

# Interface: ContextMenuOptions

上下文菜单选项.

# Table of contents

# Properties

# Properties

# event

• event: Event

事件对象.

# innerHeight

• Optional innerHeight: number

菜单外面容器的内部宽，用于菜单超时范围时自动调位置，默认是window大小高 可通过 map.getContainer().getBoundingClientRect().height来设置

# innerWidth

• Optional innerWidth: number

菜单外面容器的内部宽，用于菜单超时范围时自动调位置，默认是window大小宽 可通过 map.getContainer().getBoundingClientRect().width来设置

# items

• items: ContextMenuSubItemOptions[]

子项

# theme

• Optional theme: string

菜单主题色.(dark和light,默认dark)

# width

• Optional width: string

菜单宽度（包括子菜单),像素，默认150px.

vjmap / Exports / ContextMenuSubItemOptions

# Interface: ContextMenuSubItemOptions

上下文菜单子项选项.

# Table of contents

# Properties

# Properties

# cssIcon

• Optional cssIcon: string

css图标

# enabled

• Optional enabled: boolean

是否能用

# icon

• Optional icon: string

图标

# items

• Optional items: ContextMenuSubItemOptions[]

类型为'multi'时子菜单项

# label

• Optional label: string

菜单名称

# markup

• Optional markup: string

类型为'custom'时的自定义html内容

# onClick

• Optional onClick: Function

点击事件

# shortcut

• Optional shortcut: string

快捷菜单

# type

• Optional type: "custom" | "multi" | "Button" | "seperator" | "submenu" | "hovermenu" | "normal"

子菜单类型.

vjmap / Exports / createMarkerOptions

# Interface: createMarkerOptions

# Hierarchy

  • MarkerOptions

    ↳ createMarkerOptions

# Table of contents

# Properties

# Properties

# height

• Optional height: number

高度值.

# lngLat

• Optional lngLat: [number, number] | LngLat | {} | {}

LngLat值.

# maxZoom

• Optional maxZoom: number

显示的最大级别.

# minZoom

• Optional minZoom: number

显示的最小级别.

# removeWhenNoInMapView

• Optional removeWhenNoInMapView: boolean

设置当marker不在当前地图视图范围内时，将自动移除。进入视图范围内时，将自动增加上

# removeWhenNoInMapViewPadding

• Optional removeWhenNoInMapViewPadding: number

设置当marker不在当前地图视图范围内时，将自动移除。范围向外扩的像素范围，默认500px，向视图范围往外扩些像素，在平移的时候，能看到marker，体验效果好些。

# scaleMaxZoom

• Optional scaleMaxZoom: number

设置能缩放的最大级别。如果小于这个级别，div将根据缩小级别自动缩小比例。默认不会自动缩放

vjmap / Exports / DecayOptions

# Interface: DecayOptions

# Table of contents

# Properties

# Properties

# from

• Optional from: number

# modifyTarget

• Optional modifyTarget: (target: number) => number

# Type declaration

▸ (target: number): number

# Parameters
Name Type
target number

Returns: number

# power

• Optional power: number

# restDelta

• Optional restDelta: number

# timeConstant

• Optional timeConstant: number

# to

• Optional to: number

# velocity

• Optional velocity: number

vjmap / Exports / default / AnimateMarkerLayerOption

# Interface: AnimateMarkerLayerOption

default.AnimateMarkerLayerOption

# Table of contents

# Properties

# Properties

# colors

• Optional colors: string[]

# height

• Optional height: number

# textColor

• Optional textColor: string

# textField

• Optional textField: string

# textFontSize

• Optional textFontSize: number

# type

• Optional type: "breathingAperture" | "rotatingAperture" | "haloRing" | "diffusedAperture" | "rotatingTextBorder" | "fluorescence"

# width

• Optional width: number

vjmap / Exports / default / Animation

# Interface: Animation<V>

default.Animation

# Type parameters

Name
V

# Table of contents

# Properties

# Properties

# flipTarget

• flipTarget: () => void

# Type declaration

▸ (): void

Returns: void

# next

• next: (t: number) => { done: boolean ; value: V }

# Type declaration

▸ (t: number): object

# Parameters
Name Type
t number

Returns: object

Name Type
done boolean
value V

vjmap / Exports / default / AnimationState

# Interface: AnimationState<V>

default.AnimationState

# Type parameters

Name
V

# Table of contents

# Properties

# Properties

# done

• done: boolean

# value

• value: V

vjmap / Exports / default / BackgroundLayerOptions

# Interface: BackgroundLayerOptions

default.BackgroundLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# backgroundColor

• Optional backgroundColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" }

# backgroundOpacity

• Optional backgroundOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# backgroundPattern

• Optional backgroundPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" }

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / default / CircleEdgeOptions

# Interface: CircleEdgeOptions

default.CircleEdgeOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# center

• center: GeoPointLike

中心点

# data

• data: any

Inherited from: PolylineOptions.data

# endAngle

• Optional endAngle: number

# filter

• Optional filter: any

Inherited from: PolylineOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: PolylineOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: PolylineOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: PolylineOptions.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineBlur

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

Inherited from: PolylineOptions.lineCap

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolylineOptions.lineColor

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

Inherited from: PolylineOptions.lineDasharray

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineGapWidth

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

Inherited from: PolylineOptions.lineGradient

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

Inherited from: PolylineOptions.lineJoin

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: PolylineOptions.lineMiterMimit

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineOffset

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineOpacity

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolylineOptions.linePattern

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: PolylineOptions.lineRoundLimit

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineSortKey

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: PolylineOptions.lineTranslate

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: PolylineOptions.lineTranslateAnchor

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineWidth

# maxzoom

• Optional maxzoom: number

Inherited from: PolylineOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: PolylineOptions.minzoom

# points

• Optional points: number

# properties

• Optional properties: object

属性数据

# radius

• radius: number

半径

# sourceId

• Optional sourceId: string

Inherited from: PolylineOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: PolylineOptions.sourceLayer

# startAngle

• Optional startAngle: number

开始角度

# visibility

• Optional visibility: "visible" | "none"

Inherited from: PolylineOptions.visibility

vjmap / Exports / default / CircleFillOptions

# Interface: CircleFillOptions

default.CircleFillOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# center

• center: GeoPointLike

中心点

# data

• data: any

Inherited from: PolygonOptions.data

# endAngle

• Optional endAngle: number

终止角度

# fillAntialias

• Optional fillAntialias: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: PolygonOptions.fillAntialias

# fillColor

• Optional fillColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillColor

# fillOpacity

• Optional fillOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolygonOptions.fillOpacity

# fillOutlineColor

• Optional fillOutlineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillOutlineColor

# fillPattern

• Optional fillPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillPattern

# fillSortKey

• Optional fillSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolygonOptions.fillSortKey

# fillTranslate

• Optional fillTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: PolygonOptions.fillTranslate

# fillTranslateAnchor

• Optional fillTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: PolygonOptions.fillTranslateAnchor

# filter

• Optional filter: any

Inherited from: PolygonOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: PolygonOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: PolygonOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: PolygonOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: PolygonOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: PolygonOptions.minzoom

# points

• Optional points: number

离散化的点的个数

# properties

• Optional properties: object

属性数据

# radius

• radius: number

半径

# sourceId

• Optional sourceId: string

Inherited from: PolygonOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: PolygonOptions.sourceLayer

# startAngle

• Optional startAngle: number

开始角度

# visibility

• Optional visibility: "visible" | "none"

Inherited from: PolygonOptions.visibility

vjmap / Exports / default / CircleOptions

# Interface: CircleOptions

default.CircleOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# circleBlur

• Optional circleBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circleColor

• Optional circleColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# circleOpacity

• Optional circleOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circlePitchAlignment

• Optional circlePitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# circlePitchScale

• Optional circlePitchScale: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# circleRadius

• Optional circleRadius: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circleSortKey

• Optional circleSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circleStrokeColor

• Optional circleStrokeColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# circleStrokeOpacity

• Optional circleStrokeOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circleStrokeWidth

• Optional circleStrokeWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# circleTranslate

• Optional circleTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# circleTranslateAnchor

• Optional circleTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# data

• data: any

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / default / Config

# Interface: Config<T>

default.Config

# Type parameters

Name Default
T unknown

# Table of contents

# Properties

# Properties

# abort

• Optional abort: any

# data

• Optional data: string | Document | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams | ReadableStream<Uint8Array>

# dump

• dump: (data: T) => string

# Type declaration

▸ (data: T): string

# Parameters
Name Type
data T

Returns: string

# events

• Optional events: object

# Type declaration

# headers

• headers: object

# Type declaration

# load

• load: (str: string) => T

# Type declaration

▸ (str: string): T

# Parameters
Name Type
str string

Returns: T

# method

• method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD"

# params

• Optional params: string | URLSearchParams | string[][] | Record<string, string>

# promise

• promise: (fn: () => Promise<unknown>) => Promise<unknown>

# Type declaration

▸ (fn: () => Promise<unknown>): Promise<unknown>

# Parameters
Name Type
fn () => Promise<unknown>

Returns: Promise<unknown>

# raw

• Optional raw: boolean

# url

• Optional url: string

# withCredentials

• withCredentials: boolean

# xmlHttpRequest

• xmlHttpRequest: () => XMLHttpRequest

# Type declaration

▸ (): XMLHttpRequest

Returns: XMLHttpRequest

vjmap / Exports / default / ContextMenuOptions

# Interface: ContextMenuOptions

default.ContextMenuOptions

上下文菜单选项.

# Table of contents

# Properties

# Properties

# event

• event: Event

事件对象.

# innerHeight

• Optional innerHeight: number

菜单外面容器的内部宽，用于菜单超时范围时自动调位置，默认是window大小高 可通过 map.getContainer().getBoundingClientRect().height来设置

# innerWidth

• Optional innerWidth: number

菜单外面容器的内部宽，用于菜单超时范围时自动调位置，默认是window大小宽 可通过 map.getContainer().getBoundingClientRect().width来设置

# items

• items: ContextMenuSubItemOptions[]

子项

# theme

• Optional theme: string

菜单主题色.(dark和light,默认dark)

# width

• Optional width: string

菜单宽度（包括子菜单),像素，默认150px.

vjmap / Exports / default / ContextMenuSubItemOptions

# Interface: ContextMenuSubItemOptions

default.ContextMenuSubItemOptions

上下文菜单子项选项.

# Table of contents

# Properties

# Properties

# cssIcon

• Optional cssIcon: string

css图标

# enabled

• Optional enabled: boolean

是否能用

# icon

• Optional icon: string

图标

# items

• Optional items: ContextMenuSubItemOptions[]

类型为'multi'时子菜单项

# label

• Optional label: string

菜单名称

# markup

• Optional markup: string

类型为'custom'时的自定义html内容

# onClick

• Optional onClick: Function

点击事件

# shortcut

• Optional shortcut: string

快捷菜单

# type

• Optional type: "custom" | "multi" | "Button" | "seperator" | "submenu" | "hovermenu" | "normal"

子菜单类型.

vjmap / Exports / default / createMarkerOptions

# Interface: createMarkerOptions

default.createMarkerOptions

# Hierarchy

  • MarkerOptions

    ↳ createMarkerOptions

# Table of contents

# Properties

# Properties

# height

• Optional height: number

高度值.

# lngLat

• Optional lngLat: [number, number] | LngLat | {} | {}

LngLat值.

# maxZoom

• Optional maxZoom: number

显示的最大级别.

# minZoom

• Optional minZoom: number

显示的最小级别.

# removeWhenNoInMapView

• Optional removeWhenNoInMapView: boolean

设置当marker不在当前地图视图范围内时，将自动移除。进入视图范围内时，将自动增加上

# removeWhenNoInMapViewPadding

• Optional removeWhenNoInMapViewPadding: number

设置当marker不在当前地图视图范围内时，将自动移除。范围向外扩的像素范围，默认500px，向视图范围往外扩些像素，在平移的时候，能看到marker，体验效果好些。

# scaleMaxZoom

• Optional scaleMaxZoom: number

设置能缩放的最大级别。如果小于这个级别，div将根据缩小级别自动缩小比例。默认不会自动缩放

vjmap / Exports / default / DecayOptions

# Interface: DecayOptions

default.DecayOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# from

• Optional from: number

# modifyTarget

• Optional modifyTarget: (target: number) => number

# Type declaration

▸ (target: number): number

# Parameters
Name Type
target number

Returns: number

# power

• Optional power: number

# restDelta

• Optional restDelta: number

# timeConstant

• Optional timeConstant: number

# to

• Optional to: number

# velocity

• Optional velocity: number

vjmap / Exports / default / DivOverlayOptions

# Interface: DivOverlayOptions

default.DivOverlayOptions

# Table of contents

# Properties

# Properties

# bounds

• bounds: GeoBounds | [GeoPointLike, GeoPointLike, GeoPointLike, GeoPointLike]

范围，四个点坐标

# element

• element: HTMLElement

html元素

# height

• height: number

元素高

# maxDivSize

• Optional maxDivSize: number

放大div时，最大的div大小，超过了就像素放大了

# maxPitch

• Optional maxPitch: number

显示最大倾斜角

# maxZoom

• Optional maxZoom: number

显示最小级别

# minZoom

• Optional minZoom: number

显示最大级别

# updateDivSize

• Optional updateDivSize: boolean

自动更新div大小，（如果需要svg放大，需要设置为true)

# width

• width: number

元素宽

vjmap / Exports / default / DriverControls

# Interface: DriverControls

default.DriverControls

Drivers accept a update function and call it at an interval. This interval could be a synchronous loop, a setInterval, or tied to the device's framerate.

# Table of contents

# Properties

# Properties

# start

• start: () => void

# Type declaration

▸ (): void

Returns: void

# stop

• stop: () => void

# Type declaration

▸ (): void

Returns: void

vjmap / Exports / default / EllipseEdgeOptions

# Interface: EllipseEdgeOptions

default.EllipseEdgeOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# center

• center: GeoPointLike

中心点

# data

• data: any

Inherited from: PolylineOptions.data

# endAngle

• Optional endAngle: number

# filter

• Optional filter: any

Inherited from: PolylineOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: PolylineOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: PolylineOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: PolylineOptions.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineBlur

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

Inherited from: PolylineOptions.lineCap

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolylineOptions.lineColor

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

Inherited from: PolylineOptions.lineDasharray

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineGapWidth

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

Inherited from: PolylineOptions.lineGradient

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

Inherited from: PolylineOptions.lineJoin

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: PolylineOptions.lineMiterMimit

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineOffset

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineOpacity

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolylineOptions.linePattern

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: PolylineOptions.lineRoundLimit

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineSortKey

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: PolylineOptions.lineTranslate

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: PolylineOptions.lineTranslateAnchor

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineWidth

# majorAxisRadius

• majorAxisRadius: number

长轴半径

# maxzoom

• Optional maxzoom: number

Inherited from: PolylineOptions.maxzoom

# minorAxisRadius

• minorAxisRadius: number

短轴半径

# minzoom

• Optional minzoom: number

Inherited from: PolylineOptions.minzoom

# points

• Optional points: number

# properties

• Optional properties: object

属性数据

# sourceId

• Optional sourceId: string

Inherited from: PolylineOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: PolylineOptions.sourceLayer

# startAngle

• Optional startAngle: number

开始角度

# visibility

• Optional visibility: "visible" | "none"

Inherited from: PolylineOptions.visibility

vjmap / Exports / default / EllipseFillOptions

# Interface: EllipseFillOptions

default.EllipseFillOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# center

• center: GeoPointLike

中心点

# data

• data: any

Inherited from: PolygonOptions.data

# endAngle

• Optional endAngle: number

# fillAntialias

• Optional fillAntialias: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: PolygonOptions.fillAntialias

# fillColor

• Optional fillColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillColor

# fillOpacity

• Optional fillOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolygonOptions.fillOpacity

# fillOutlineColor

• Optional fillOutlineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillOutlineColor

# fillPattern

• Optional fillPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillPattern

# fillSortKey

• Optional fillSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolygonOptions.fillSortKey

# fillTranslate

• Optional fillTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: PolygonOptions.fillTranslate

# fillTranslateAnchor

• Optional fillTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: PolygonOptions.fillTranslateAnchor

# filter

• Optional filter: any

Inherited from: PolygonOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: PolygonOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: PolygonOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: PolygonOptions.layerId

# majorAxisRadius

• majorAxisRadius: number

长轴半径

# maxzoom

• Optional maxzoom: number

Inherited from: PolygonOptions.maxzoom

# minorAxisRadius

• minorAxisRadius: number

短轴半径

# minzoom

• Optional minzoom: number

Inherited from: PolygonOptions.minzoom

# points

• Optional points: number

# properties

• Optional properties: object

属性数据

# sourceId

• Optional sourceId: string

Inherited from: PolygonOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: PolygonOptions.sourceLayer

# startAngle

• Optional startAngle: number

开始角度

# visibility

• Optional visibility: "visible" | "none"

Inherited from: PolygonOptions.visibility

vjmap / Exports / default / Events

# Interface: Events

default.Events

# Table of contents

# Properties

# Properties

# ABORT

• ABORT: "abort"

# ERROR

• ERROR: "error"

# LOAD

• LOAD: "load"

# LOAD_END

• LOAD_END: "loadend"

# LOAD_START

• LOAD_START: "loadstart"

# PROGRESS

• PROGRESS: "progress"

# READY_STATE_CHANGE

• READY_STATE_CHANGE: "readystatechange"

# TIMEOUT

• TIMEOUT: "timeout"

vjmap / Exports / default / FillExtrusionOptions

# Interface: FillExtrusionOptions

default.FillExtrusionOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# data

• data: any

# fillExtrusionBase

• Optional fillExtrusionBase: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# fillExtrusionColor

• Optional fillExtrusionColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# fillExtrusionHeight

• Optional fillExtrusionHeight: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# fillExtrusionOpacity

• Optional fillExtrusionOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# fillExtrusionPattern

• Optional fillExtrusionPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# fillExtrusionTranslate

• Optional fillExtrusionTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# fillExtrusionTranslateAnchor

• Optional fillExtrusionTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# fillExtrusionVerticalGradient

• Optional fillExtrusionVerticalGradient: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / default / FrameAnimation

# Interface: FrameAnimation

default.FrameAnimation

property {Boolean} running - Getter that indicates if animation is running.

property {function():void} stop - Stops the animation.

property {function():void} start - Starts the animation.

# Table of contents

# Properties

# Properties

# changeFps

• changeFps: (fps: number) => void

一秒运行多少帧，用来控制速度

# Type declaration

▸ (fps: number): void

# Parameters
Name Type
fps number

Returns: void

# pause

• pause: () => void

pause the animation.

# Type declaration

▸ (): void

Returns: void

# running

• Readonly running: boolean

A getter property that indicates if animation is running.

# start

• start: () => void

Starts the animation.

# Type declaration

▸ (): void

Returns: void

# status

• Readonly status: FrameAnimationStatus

A getter property that indicates if animation is running.

# stop

• stop: () => void

Stops the animation.

# Type declaration

▸ (): void

Returns: void

vjmap / Exports / default / GridLayerLabelStyle

# Interface: GridLayerLabelStyle

default.GridLayerLabelStyle

# Table of contents

# Properties

# Properties

# textAnchor

• Optional textAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right"

字体基线

# textColor

• Optional textColor: string

字体颜色

# textFont

• Optional textFont: string[]

字体样式

# textHaloColor

• Optional textHaloColor: string

描边颜色

# textHaloWidth

• Optional textHaloWidth: number

描边宽度

# textSize

• Optional textSize: string

字体大小

vjmap / Exports / default / GridLayerOptions

# Interface: GridLayerOptions

default.GridLayerOptions

# Table of contents

# Properties

# Properties

# extent

• Optional extent: LngLatBounds

坐标网格渲染的边界经纬度范围（[minx, miny, maxx, maxy]），默认为整个地图范围。

# interval

• Optional interval: number | Function

经纬度的间隔（以度为单位），可以是数字，也可以是函数，参数是map，默认10

# layerID

• Optional layerID: string

图层 ID。默认使用创建图层随机ID。

# maxZoom

• Optional maxZoom: number

该图层可见的最大视图缩放级别（含）

# minZoom

• Optional minZoom: number

最小视图缩放级别（不包括此级别），在该级别之上，该层将可见。

# opacity

• Optional opacity: number

画布不透明度。 默认1

# showLabel

• Optional showLabel: boolean

是否显示标签 默认true

# strokeStyle

• Optional strokeStyle: GridLayerStrokeStyle

绘制网络线的样式

# visible

• Optional visible: boolean

是否显示坐标网格 默认true

# xLabelDigit

• Optional xLabelDigit: number

x标签小数位数。默认2位

# xLabelFormatter

• Optional xLabelFormatter: Function

x标签转换函数

# xLabelStyle

• Optional xLabelStyle: GridLayerLabelStyle

x轴标签样式

# yLabelDigit

• Optional yLabelDigit: number

y标签小数位数。默认2位

# yLabelFormatter

• Optional yLabelFormatter: Function

y标签转换函数

# yLabelStyle

• Optional yLabelStyle: GridLayerLabelStyle

y轴标签样式

vjmap / Exports / default / GridLayerStrokeStyle

# Interface: GridLayerStrokeStyle

default.GridLayerStrokeStyle

# Table of contents

# Properties

# Properties

# lindDasharray

• Optional lindDasharray: Function | number[]

虚线样式

# lineCap

• Optional lineCap: "butt" | "round" | "square"

线端点风格：butt, round, square

# lineColor

• Optional lineColor: string

线颜色

# lineDashOffset

• Optional lineDashOffset: number

虚线样式

# lineJoin

• Optional lineJoin: "round" | "bevel" | "miter"

线连接样式：bevel, round, miter

# lineWidth

• Optional lineWidth: number | Function

线宽

vjmap / Exports / default / HeatmapOptions

# Interface: HeatmapOptions

default.HeatmapOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# data

• data: any

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# heatmapColor

• Optional heatmapColor: ExpressionSpecificationEx

# heatmapIntensity

• Optional heatmapIntensity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# heatmapOpacity

• Optional heatmapOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# heatmapRadius

• Optional heatmapRadius: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# heatmapWeight

• Optional heatmapWeight: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / default / IAnimateFillLayerOptions

# Interface: IAnimateFillLayerOptions

default.IAnimateFillLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

动画图集.

# fillAntialias

• Optional fillAntialias: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.fillAntialias

# fillColor

• Optional fillColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.fillColor

# fillOpacity

• Optional fillOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.fillOpacity

# fillOutlineColor

• Optional fillOutlineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.fillOutlineColor

# fillPattern

• Optional fillPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.fillPattern

# fillSortKey

• Optional fillSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.fillSortKey

# fillTranslate

• Optional fillTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: Omit.fillTranslate

# fillTranslateAnchor

• Optional fillTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: Omit.fillTranslateAnchor

# filter

• Optional filter: any

Inherited from: Omit.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: Omit.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: Omit.isHoverPointer

# layerBefore

• Optional layerBefore: string

创建的图层位于哪个图层之前.

# layerId

• Optional layerId: string

Inherited from: Omit.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: Omit.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: Omit.minzoom

# sourceId

• Optional sourceId: string

Inherited from: Omit.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: Omit.sourceLayer

# speed

• Optional speed: number

速度，默认1.

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

# visibility

• Optional visibility: "visible" | "none"

Inherited from: Omit.visibility

vjmap / Exports / default / IAnimateLineLayerOptions

# Interface: IAnimateLineLayerOptions

default.IAnimateLineLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number } | ImageBitmap)[]

动画图集.

# filter

• Optional filter: any

Inherited from: Omit.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: Omit.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: Omit.isHoverPointer

# layerBefore

• Optional layerBefore: string

创建的图层位于哪个图层之前.

# layerId

• Optional layerId: string

Inherited from: Omit.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineBlur

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

Inherited from: Omit.lineCap

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.lineColor

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

Inherited from: Omit.lineDasharray

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineGapWidth

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

Inherited from: Omit.lineGradient

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

Inherited from: Omit.lineJoin

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.lineMiterMimit

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineOffset

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineOpacity

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.linePattern

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.lineRoundLimit

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineSortKey

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: Omit.lineTranslate

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: Omit.lineTranslateAnchor

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineWidth

# maxzoom

• Optional maxzoom: number

Inherited from: Omit.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: Omit.minzoom

# sourceId

• Optional sourceId: string

Inherited from: Omit.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: Omit.sourceLayer

# speed

• Optional speed: number

速度，默认1.

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

# visibility

• Optional visibility: "visible" | "none"

Inherited from: Omit.visibility

vjmap / Exports / default / IAnimateSymbolLayerOptions

# Interface: IAnimateSymbolLayerOptions

default.IAnimateSymbolLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

动画图集.

# filter

• Optional filter: any

Inherited from: Omit.filter

# iconAllowOverlap

• Optional iconAllowOverlap: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.iconAllowOverlap

# iconAnchor

• Optional iconAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | ExpressionSpecificationEx | { stops: [number, Anchor][] ; type: "exponential" } | { stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [string | number | boolean, Anchor][] ; type: "categorical" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; type: "identity" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, Anchor][] ; type: "categorical" }

Inherited from: Omit.iconAnchor

# iconColor

• Optional iconColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.iconColor

# iconHaloBlur

• Optional iconHaloBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.iconHaloBlur

# iconHaloColor

• Optional iconHaloColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.iconHaloColor

# iconHaloWidth

• Optional iconHaloWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.iconHaloWidth

# iconIgnorePlacement

• Optional iconIgnorePlacement: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.iconIgnorePlacement

# iconImage

• Optional iconImage: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.iconImage

# iconKeepUpright

• Optional iconKeepUpright: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.iconKeepUpright

# iconOffset

• Optional iconOffset: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [string | number | boolean, [number, number]][] ; type: "categorical" } | { default?: [number, number] ; property: string ; type: "identity" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, [number, number]][] ; type: "categorical" }

Inherited from: Omit.iconOffset

# iconOpacity

• Optional iconOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.iconOpacity

# iconOptional

• Optional iconOptional: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.iconOptional

# iconPadding

• Optional iconPadding: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.iconPadding

# iconPitchAlignment

• Optional iconPitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

Inherited from: Omit.iconPitchAlignment

# iconRotate

• Optional iconRotate: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.iconRotate

# iconRotationAlignment

• Optional iconRotationAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

Inherited from: Omit.iconRotationAlignment

# iconSize

• Optional iconSize: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.iconSize

# iconTextFit

• Optional iconTextFit: ExpressionSpecificationEx | "none" | "width" | "height" | "both" | { stops: [number, "none" | "width" | "height" | "both"][] ; type: "exponential" } | { stops: [number, "none" | "width" | "height" | "both"][] ; type: "interval" }

Inherited from: Omit.iconTextFit

# iconTextFitPadding

• Optional iconTextFitPadding: [number, number, number, number] | ExpressionSpecificationEx | { stops: [number, [number, number, number, number]][] ; type: "exponential" } | { stops: [number, [number, number, number, number]][] ; type: "interval" }

Inherited from: Omit.iconTextFitPadding

# iconTranslate

• Optional iconTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: Omit.iconTranslate

# iconTranslateAnchor

• Optional iconTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: Omit.iconTranslateAnchor

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: Omit.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: Omit.isHoverPointer

# layerBefore

• Optional layerBefore: string

创建的图层位于哪个图层之前.

# layerId

• Optional layerId: string

Inherited from: Omit.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: Omit.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: Omit.minzoom

# sourceId

• Optional sourceId: string

Inherited from: Omit.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: Omit.sourceLayer

# speed

• Optional speed: number

速度，默认1.

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

# symbolAvoidEdges

• Optional symbolAvoidEdges: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.symbolAvoidEdges

# symbolPlacement

• Optional symbolPlacement: "line" | ExpressionSpecificationEx | "point" | "line-center" | { stops: [number, "line" | "point" | "line-center"][] ; type: "exponential" } | { stops: [number, "line" | "point" | "line-center"][] ; type: "interval" }

Inherited from: Omit.symbolPlacement

# symbolSortKey

• Optional symbolSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.symbolSortKey

# symbolSpacing

• Optional symbolSpacing: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.symbolSpacing

# symbolZOrder

• Optional symbolZOrder: "source" | ExpressionSpecificationEx | "auto" | "viewport-y" | { stops: [number, "source" | "auto" | "viewport-y"][] ; type: "exponential" } | { stops: [number, "source" | "auto" | "viewport-y"][] ; type: "interval" }

Inherited from: Omit.symbolZOrder

# textAllowOverlap

• Optional textAllowOverlap: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.textAllowOverlap

# textAnchor

• Optional textAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | ExpressionSpecificationEx | { stops: [number, Anchor][] ; type: "exponential" } | { stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [string | number | boolean, Anchor][] ; type: "categorical" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; type: "identity" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, Anchor][] ; type: "categorical" }

Inherited from: Omit.textAnchor

# textColor

• Optional textColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.textColor

# textField

• Optional textField: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.textField

# textFont

• Optional textFont: string[] | ExpressionSpecificationEx | { stops: [number, string[]][] ; type: "exponential" } | { stops: [number, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [number, string[]][] ; type: "exponential" } | { default?: string[] ; property: string ; stops: [number, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [string | number | boolean, string[]][] ; type: "categorical" } | { default?: string[] ; property: string ; type: "identity" } | { default?: string[] ; property: string ; stops: [{ value: number ; zoom: number }, string[]][] ; type: "exponential" } | { default?: string[] ; property: string ; stops: [{ value: number ; zoom: number }, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string[]][] ; type: "categorical" }

Inherited from: Omit.textFont

# textHaloBlur

• Optional textHaloBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textHaloBlur

# textHaloColor

• Optional textHaloColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.textHaloColor

# textHaloWidth

• Optional textHaloWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textHaloWidth

# textIgnorePlacement

• Optional textIgnorePlacement: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.textIgnorePlacement

# textJustify

• Optional textJustify: "center" | "left" | "right" | ExpressionSpecificationEx | "auto" | { stops: [number, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { stops: [number, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [number, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [number, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [string | number | boolean, "center" | "left" | "right" | "auto"][] ; type: "categorical" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; type: "identity" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: number ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: number ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "categorical" }

Inherited from: Omit.textJustify

# textKeepUpright

• Optional textKeepUpright: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.textKeepUpright

# textLetterSpacing

• Optional textLetterSpacing: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textLetterSpacing

# textLineHeight

• Optional textLineHeight: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textLineHeight

# textMaxAngle

• Optional textMaxAngle: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.textMaxAngle

# textMaxWidth

• Optional textMaxWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textMaxWidth

# textOffset

• Optional textOffset: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [string | number | boolean, [number, number]][] ; type: "categorical" } | { default?: [number, number] ; property: string ; type: "identity" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, [number, number]][] ; type: "categorical" }

Inherited from: Omit.textOffset

# textOpacity

• Optional textOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textOpacity

# textOptional

• Optional textOptional: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.textOptional

# textPadding

• Optional textPadding: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.textPadding

# textPitchAlignment

• Optional textPitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

Inherited from: Omit.textPitchAlignment

# textRadialOffset

• Optional textRadialOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textRadialOffset

# textRotate

• Optional textRotate: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textRotate

# textRotationAlignment

• Optional textRotationAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

Inherited from: Omit.textRotationAlignment

# textSize

• Optional textSize: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textSize

# textTransform

• Optional textTransform: ExpressionSpecificationEx | "none" | "uppercase" | "lowercase" | { stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [string | number | boolean, "none" | "uppercase" | "lowercase"][] ; type: "categorical" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; type: "identity" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: number ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: number ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "categorical" }

Inherited from: Omit.textTransform

# textTranslate

• Optional textTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: Omit.textTranslate

# textTranslateAnchor

• Optional textTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: Omit.textTranslateAnchor

# textVariableAnchor

• Optional textVariableAnchor: ExpressionSpecificationEx | Anchor[] | { stops: [number, Anchor[]][] ; type: "exponential" } | { stops: [number, Anchor[]][] ; type: "interval" }

Inherited from: Omit.textVariableAnchor

# textWritingMode

• Optional textWritingMode: ExpressionSpecificationEx | ("vertical" | "horizontal")[] | { stops: [number, ("vertical" | "horizontal")[]][] ; type: "exponential" } | { stops: [number, ("vertical" | "horizontal")[]][] ; type: "interval" }

Inherited from: Omit.textWritingMode

# visibility

• Optional visibility: "visible" | "none"

Inherited from: Omit.visibility

vjmap / Exports / default / IAnimateVectorLayerOptions

# Interface: IAnimateVectorLayerOptions

default.IAnimateVectorLayerOptions

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

动画图集.

# speed

• Optional speed: number

速度，默认1.

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

vjmap / Exports / default / IAnimateVectorLayerResult

# Interface: IAnimateVectorLayerResult

default.IAnimateVectorLayerResult

# Table of contents

# Properties

# Properties

# remove

• remove: () => void

移除.

# Type declaration

▸ (): void

Returns: void

# setSpeed

• setSpeed: (speed: number) => void

设置速度.

# Type declaration

▸ (speed: number): void

# Parameters
Name Type
speed number

Returns: void

# startAnimation

• startAnimation: () => void

开始动画函数.

# Type declaration

▸ (): void

Returns: void

# stopAnimation

• stopAnimation: () => void

结束动画函数.

# Type declaration

▸ (): void

Returns: void

# updateImages

• updateImages: (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]) => void

更新动画图片集.

# Type declaration

▸ (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]): void

# Parameters
Name Type
images (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

Returns: void

vjmap / Exports / default / IComposeNewMap

# Interface: IComposeNewMap

default.IComposeNewMap

组合新地图参数

# Table of contents

# Properties

# Properties

# cadVersion

• Optional cadVersion: string

导出的CAD版本号。如果为*表示为当前CAD图的版本

# clipbounds

• Optional clipbounds: [number, number, number, number]

地图裁剪范围，范围如[x1,y1,x2,y2]， 为空的话，表示不裁剪

# fourParameter

• Optional fourParameter: [number, number, number, number]

四参数(x偏移,y偏移,缩放，旋转弧度)，可选，对坐标最后进行修正

# isInverseFourParamter

• Optional isInverseFourParamter: boolean

是否用上面的四参数进行反算，默认false

# isRenameBlockNameIfExist

• Optional isRenameBlockNameIfExist: boolean

来源于其他图的实体时，如果块定义重复，则自动重命名 ，默认true

# layerPrefix

• Optional layerPrefix: string

生新成图的图层名称前缀，如果设置为null将不会有默认的图层前缀。如果没有前缀，不同的图有图层重名时，如果设置了随层属性有可能会导致绘制的不一样

# layerSuffix

• Optional layerSuffix: string

生新成图的图层名称后缀

# layers

• Optional layers: string[]

要显示的图层名称，为空的时候，表示全部图层

# mapid

• mapid: string

地图ID.

# purge

• Optional purge: boolean

生成后清理图形数据以减少dwg文件大小

# savefilename

• Optional savefilename: string

保存的文件名称，为空的时候，自根据参数自动生成

# selByCrossing

• Optional selByCrossing: boolean

选择是包含还是相交（默认false表示包含，true相交）

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

vjmap / Exports / default / IConditionQueryFeatures

# Interface: IConditionQueryFeatures

default.IConditionQueryFeatures

条件查询实体参数

# Hierarchy

# Table of contents

# Properties

# Properties

# beginpos

• Optional beginpos: number

记录开始位置.

# bounds

• Optional bounds: [number, number, number, number]

范围.

# condition

• condition: string

条件.

# fields

• Optional fields: string

是返回的字段列表，多个之是用逗号,分开,如. "name,objectid"

Inherited from: IQueryBaseFeatures.fields

# geom

• Optional geom: boolean

是否为几何图形查询.

Inherited from: IQueryBaseFeatures.geom

# includegeom

• Optional includegeom: boolean

是否返回几何数据,为了性能问题，realgeom为false时，如果返回条数大于1.只会返回每个实体的外包矩形，如果条数为1的话，会返回此实体的真实geojson；realgeom为true时每条都会返回实体的geojson

# isContains

• Optional isContains: boolean

是否为包含关系, true为包含关系,false为相交关系，默认false. (传入了bounds进行范围查询时有效)

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称).

Inherited from: IQueryBaseFeatures.layer

# limit

• Optional limit: number

返回最多的记录条数.

Inherited from: IQueryBaseFeatures.limit

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

Inherited from: IQueryBaseFeatures.mapid

# realgeom

• Optional realgeom: boolean

是否返回真实实体几何geojson.与 includegeom参数，结合使用。参考includegeom的用法

# simplifyTolerance

• Optional simplifyTolerance: boolean

GeoJSON几何数据简化墨托卡距离，默认为零，不简化。例如允许10级别以上一个像素级别的误差，可用 map.pixelToGeoLength(1, 10) * vjmap.Projection.EQUATORIAL_SEMIPERIMETER * 2 / map.getGeoBounds(1.0).width()

Inherited from: IQueryBaseFeatures.simplifyTolerance

# toMapCoordinate

• Optional toMapCoordinate: boolean

查询返回的坐标默认为墨卡托坐标，返回会程序会自动转化为cad坐标，如果要直接返回cad地图坐标，需要把toMapCoordinate设置为true.

Inherited from: IQueryBaseFeatures.toMapCoordinate

# useCache

• Optional useCache: boolean

启动cache(内存打开的图形有效).

Inherited from: IQueryBaseFeatures.useCache

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

Inherited from: IQueryBaseFeatures.version

# zoom

• Optional zoom: number

当前级别.

Inherited from: IQueryBaseFeatures.zoom

vjmap / Exports / default / ICreateAnimateImagesFromImageOptions

# Interface: ICreateAnimateImagesFromImageOptions

default.ICreateAnimateImagesFromImageOptions

# Indexable

▪ [key: string]: any

其他数据.

# Table of contents

# Properties

# Properties

# canvasHeight

• Optional canvasHeight: number

画片高(2的n次幂，如2,4,8, 16, 32....).默认32

# canvasWidth

• Optional canvasWidth: number

画片宽(2的n次幂，如2,4,8, 16, 32....).默认64

# from

• Optional from: number

生成的动画图片集中从第几个开始，默认0.

# fromImage

• Optional fromImage: HTMLImageElement

来源图片.

# spriteHeight

• Optional spriteHeight: number

来源图片中精灵图所占高.

# spriteWidth

• Optional spriteWidth: number

来源图片中精灵图所占宽.

# to

• Optional to: number

生成的动画图片集中到第几个结束，默认数组最后一个..

vjmap / Exports / default / ICreateAnimateImagesOptions

# Interface: ICreateAnimateImagesOptions

default.ICreateAnimateImagesOptions

# Hierarchy

# Indexable

▪ [key: string]: any

其他数据.

# Table of contents

# Properties

# Properties

# canvasHeight

• Optional canvasHeight: number

画片高(2的n次幂，如2,4,8, 16, 32....).默认32

# canvasWidth

• Optional canvasWidth: number

画片宽(2的n次幂，如2,4,8, 16, 32....).默认64

# directionReverse

• Optional directionReverse: boolean

方向是否反向.

# draw

• Optional draw: (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions) => void

绘制内容回调(此函数只需绘制第一帧，其作帧图片会根据移动方向和帧数自动计算出来).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
opts ICreateAnimateImagesOptions

Returns: void

# drawFrame

• Optional drawFrame: (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions) => void

每帧内容回调(此函数每帧都会调用，需要根据不同的帧数生成不同的图片，与上面的draw冲突，如果设置了drawFrame，则上面的draw函数无效).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
frameCount number
curFrameIndex number
opts ICreateAnimateImagesOptions

Returns: void

# frameCount

• Optional frameCount: number

要生成的动画图片帧的个数.默认2

# from

• Optional from: number

生成的动画图片集中从第几个开始，默认0.

# fromImage

• Optional fromImage: HTMLImageElement

来源图片.

# spriteHeight

• Optional spriteHeight: number

来源图片中精灵图所占高.

# spriteWidth

• Optional spriteWidth: number

来源图片中精灵图所占宽.

# to

• Optional to: number

生成的动画图片集中到第几个结束，默认数组最后一个..

# yAxis

• Optional yAxis: boolean

是否y方向生成动画图片集.

vjmap / Exports / default / ICreateAnimateLayerResult

# Interface: ICreateAnimateLayerResult

default.ICreateAnimateLayerResult

# Hierarchy

# Table of contents

# Properties

# Properties

# createAnimateImages

• createAnimateImages: (options: ICreateAnimateImagesOptions) => ImageData[]

创建动画图片集.

# Type declaration

▸ (options: ICreateAnimateImagesOptions): ImageData[]

# Parameters
Name Type
options ICreateAnimateImagesOptions

Returns: ImageData[]

# layerId

• layerId: string

图层ID.

# remove

• remove: () => void

移除.

# Type declaration

▸ (): void

Returns: void

# setSpeed

• setSpeed: (speed: number) => void

设置速度.

# Type declaration

▸ (speed: number): void

# Parameters
Name Type
speed number

Returns: void

# sourceId

• sourceId: string

数据源ID.

# startAnimation

• startAnimation: () => void

开始动画函数.

# Type declaration

▸ (): void

Returns: void

# stopAnimation

• stopAnimation: () => void

结束动画函数.

# Type declaration

▸ (): void

Returns: void

# updateData

• updateData: (input: any) => void

更新数据.

# Type declaration

▸ (input: any): void

# Parameters
Name Type
input any

Returns: void

# updateImages

• updateImages: (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]) => void

更新动画图片集.

# Type declaration

▸ (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]): void

# Parameters
Name Type
images (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

Returns: void

vjmap / Exports / default / ICreateAntPathAnimateLineLayerOptions

# Interface: ICreateAntPathAnimateLineLayerOptions

default.ICreateAntPathAnimateLineLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number } | ImageBitmap)[]

动画图集.

Inherited from: IAnimateLineLayerOptions.animateImages

# canvasHeight

• Optional canvasHeight: number

画片高(2的n次幂，如2,4,8, 16, 32....).默认32

Inherited from: ICreateAnimateImagesOptions.canvasHeight

# canvasWidth

• Optional canvasWidth: number

画片宽(2的n次幂，如2,4,8, 16, 32....).默认64

Inherited from: ICreateAnimateImagesOptions.canvasWidth

# directionReverse

• Optional directionReverse: boolean

方向是否反向.

Inherited from: ICreateAnimateImagesOptions.directionReverse

# draw

• Optional draw: (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions) => void

绘制内容回调(此函数只需绘制第一帧，其作帧图片会根据移动方向和帧数自动计算出来).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
opts ICreateAnimateImagesOptions

Returns: void

Inherited from: ICreateAnimateImagesOptions.draw

# drawFrame

• Optional drawFrame: (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions) => void

每帧内容回调(此函数每帧都会调用，需要根据不同的帧数生成不同的图片，与上面的draw冲突，如果设置了drawFrame，则上面的draw函数无效).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
frameCount number
curFrameIndex number
opts ICreateAnimateImagesOptions

Returns: void

Inherited from: ICreateAnimateImagesOptions.drawFrame

# fillColor1

• Optional fillColor1: string | CanvasGradient | CanvasPattern

填充背景颜色1.

# fillColor2

• Optional fillColor2: string | CanvasGradient | CanvasPattern

填充背景颜色1.

# filter

• Optional filter: any

Inherited from: IAnimateLineLayerOptions.filter

# frameCount

• Optional frameCount: number

要生成的动画图片帧的个数.默认2

Inherited from: ICreateAnimateImagesOptions.frameCount

# from

• Optional from: number

生成的动画图片集中从第几个开始，默认0.

Inherited from: ICreateAnimateImagesOptions.from

# fromImage

• Optional fromImage: HTMLImageElement

来源图片.

Inherited from: ICreateAnimateImagesOptions.fromImage

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: IAnimateLineLayerOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: IAnimateLineLayerOptions.isHoverPointer

# layerBefore

• Optional layerBefore: string

创建的图层位于哪个图层之前.

Inherited from: IAnimateLineLayerOptions.layerBefore

# layerId

• Optional layerId: string

Inherited from: IAnimateLineLayerOptions.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineBlur

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineCap

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineColor

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineDasharray

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineGapWidth

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

Inherited from: IAnimateLineLayerOptions.lineGradient

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineJoin

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineMiterMimit

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineOffset

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineOpacity

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.linePattern

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineRoundLimit

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineSortKey

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineTranslate

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineTranslateAnchor

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineWidth

# maxzoom

• Optional maxzoom: number

Inherited from: IAnimateLineLayerOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: IAnimateLineLayerOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: IAnimateLineLayerOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: IAnimateLineLayerOptions.sourceLayer

# speed

• Optional speed: number

速度，默认1.

Inherited from: IAnimateLineLayerOptions.speed

# spriteHeight

• Optional spriteHeight: number

来源图片中精灵图所占高.

Inherited from: ICreateAnimateImagesOptions.spriteHeight

# spriteWidth

• Optional spriteWidth: number

来源图片中精灵图所占宽.

Inherited from: ICreateAnimateImagesOptions.spriteWidth

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

Inherited from: IAnimateLineLayerOptions.startAutoAnimation

# to

• Optional to: number

生成的动画图片集中到第几个结束，默认数组最后一个..

Inherited from: ICreateAnimateImagesOptions.to

# visibility

• Optional visibility: "visible" | "none"

Inherited from: IAnimateLineLayerOptions.visibility

# yAxis

• Optional yAxis: boolean

是否y方向生成动画图片集.

Inherited from: ICreateAnimateImagesOptions.yAxis

vjmap / Exports / default / ICreateArrowAnimateLineLayerOptions

# Interface: ICreateArrowAnimateLineLayerOptions

default.ICreateArrowAnimateLineLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number } | ImageBitmap)[]

动画图集.

Inherited from: IAnimateLineLayerOptions.animateImages

# arrowFillColor

• Optional arrowFillColor: string | CanvasGradient | CanvasPattern

箭头填充背景颜色.

# arrowStrokeColor

• Optional arrowStrokeColor: string | CanvasGradient | CanvasPattern

箭头颜色.

# arrowStrokeWidth

• Optional arrowStrokeWidth: number

箭头线宽.

# arrowWidth

• Optional arrowWidth: number

箭头宽(默认为画布的一半).

# canvasHeight

• Optional canvasHeight: number

画片高(2的n次幂，如2,4,8, 16, 32....).默认32

Inherited from: ICreateAnimateImagesOptions.canvasHeight

# canvasWidth

• Optional canvasWidth: number

画片宽(2的n次幂，如2,4,8, 16, 32....).默认64

Inherited from: ICreateAnimateImagesOptions.canvasWidth

# directionReverse

• Optional directionReverse: boolean

方向是否反向.

Inherited from: ICreateAnimateImagesOptions.directionReverse

# draw

• Optional draw: (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions) => void

绘制内容回调(此函数只需绘制第一帧，其作帧图片会根据移动方向和帧数自动计算出来).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
opts ICreateAnimateImagesOptions

Returns: void

Inherited from: ICreateAnimateImagesOptions.draw

# drawFrame

• Optional drawFrame: (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions) => void

每帧内容回调(此函数每帧都会调用，需要根据不同的帧数生成不同的图片，与上面的draw冲突，如果设置了drawFrame，则上面的draw函数无效).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
frameCount number
curFrameIndex number
opts ICreateAnimateImagesOptions

Returns: void

Inherited from: ICreateAnimateImagesOptions.drawFrame

# filter

• Optional filter: any

Inherited from: IAnimateLineLayerOptions.filter

# frameCount

• Optional frameCount: number

要生成的动画图片帧的个数.默认2

Inherited from: ICreateAnimateImagesOptions.frameCount

# from

• Optional from: number

生成的动画图片集中从第几个开始，默认0.

Inherited from: ICreateAnimateImagesOptions.from

# fromImage

• Optional fromImage: HTMLImageElement

来源图片.

Inherited from: ICreateAnimateImagesOptions.fromImage

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: IAnimateLineLayerOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: IAnimateLineLayerOptions.isHoverPointer

# layerBefore

• Optional layerBefore: string

创建的图层位于哪个图层之前.

Inherited from: IAnimateLineLayerOptions.layerBefore

# layerId

• Optional layerId: string

Inherited from: IAnimateLineLayerOptions.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineBlur

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineCap

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineColor

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineDasharray

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineGapWidth

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

Inherited from: IAnimateLineLayerOptions.lineGradient

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineJoin

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineMiterMimit

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineOffset

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineOpacity

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.linePattern

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineRoundLimit

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineSortKey

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineTranslate

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineTranslateAnchor

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineWidth

# maxzoom

• Optional maxzoom: number

Inherited from: IAnimateLineLayerOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: IAnimateLineLayerOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: IAnimateLineLayerOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: IAnimateLineLayerOptions.sourceLayer

# speed

• Optional speed: number

速度，默认1.

Inherited from: IAnimateLineLayerOptions.speed

# spriteHeight

• Optional spriteHeight: number

来源图片中精灵图所占高.

Inherited from: ICreateAnimateImagesOptions.spriteHeight

# spriteWidth

• Optional spriteWidth: number

来源图片中精灵图所占宽.

Inherited from: ICreateAnimateImagesOptions.spriteWidth

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

Inherited from: IAnimateLineLayerOptions.startAutoAnimation

# to

• Optional to: number

生成的动画图片集中到第几个结束，默认数组最后一个..

Inherited from: ICreateAnimateImagesOptions.to

# visibility

• Optional visibility: "visible" | "none"

Inherited from: IAnimateLineLayerOptions.visibility

# yAxis

• Optional yAxis: boolean

是否y方向生成动画图片集.

Inherited from: ICreateAnimateImagesOptions.yAxis

vjmap / Exports / default / ICreateEntitiesGeomData

# Interface: ICreateEntitiesGeomData

default.ICreateEntitiesGeomData

获取创建实体的几何数据

# Table of contents

# Properties

# Properties

# excludeAttribute

• Optional excludeAttribute: boolean

返回的数据中排除属性数据( 默认true)

# filedoc

• filedoc: string

文件文档.

# mapBounds

• Optional mapBounds: [number, number, number, number]

图形范围.如果不填的话，则使用全图范围

# renderAccuracy

• Optional renderAccuracy: number

渲染精度，默认1，有时候图形特别大导致圆或圆弧精度不够时,不够光滑，可以先清空之前的缓存数据，再重新上传时，改变渲染精度来使圆或圆弧光滑些。注：提高精度会导致空间数据文件增大，渲染性能下降

# useZip

• Optional useZip: boolean

返回的数据是否启用zip压缩( 默认true)

vjmap / Exports / default / ICreateFillAnimateLayerResult

# Interface: ICreateFillAnimateLayerResult

default.ICreateFillAnimateLayerResult

# Hierarchy

# Table of contents

# Properties

# Properties

# createAnimateImages

• createAnimateImages: (options: ICreateAnimateImagesOptions) => ImageData[]

创建动画图片集.

# Type declaration

▸ (options: ICreateAnimateImagesOptions): ImageData[]

# Parameters
Name Type
options ICreateAnimateImagesOptions

Returns: ImageData[]

Inherited from: ICreateAnimateLayerResult.createAnimateImages

# layerId

• layerId: string

图层ID.

Inherited from: ICreateAnimateLayerResult.layerId

# polygon

• polygon: Polygon

# remove

• remove: () => void

移除.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.remove

# setSpeed

• setSpeed: (speed: number) => void

设置速度.

# Type declaration

▸ (speed: number): void

# Parameters
Name Type
speed number

Returns: void

Inherited from: ICreateAnimateLayerResult.setSpeed

# sourceId

• sourceId: string

数据源ID.

Inherited from: ICreateAnimateLayerResult.sourceId

# startAnimation

• startAnimation: () => void

开始动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.startAnimation

# stopAnimation

• stopAnimation: () => void

结束动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.stopAnimation

# updateData

• updateData: (input: any) => void

更新数据.

# Type declaration

▸ (input: any): void

# Parameters
Name Type
input any

Returns: void

Inherited from: ICreateAnimateLayerResult.updateData

# updateImages

• updateImages: (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]) => void

更新动画图片集.

# Type declaration

▸ (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]): void

# Parameters
Name Type
images (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

Returns: void

Inherited from: ICreateAnimateLayerResult.updateImages

vjmap / Exports / default / ICreateLineAnimateLayerResult

# Interface: ICreateLineAnimateLayerResult

default.ICreateLineAnimateLayerResult

# Hierarchy

# Table of contents

# Properties

# Properties

# createAnimateImages

• createAnimateImages: (options: ICreateAnimateImagesOptions) => ImageData[]

创建动画图片集.

# Type declaration

▸ (options: ICreateAnimateImagesOptions): ImageData[]

# Parameters
Name Type
options ICreateAnimateImagesOptions

Returns: ImageData[]

Inherited from: ICreateAnimateLayerResult.createAnimateImages

# layerId

• layerId: string

图层ID.

Inherited from: ICreateAnimateLayerResult.layerId

# polyline

• polyline: Polyline

# remove

• remove: () => void

移除.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.remove

# setSpeed

• setSpeed: (speed: number) => void

设置速度.

# Type declaration

▸ (speed: number): void

# Parameters
Name Type
speed number

Returns: void

Inherited from: ICreateAnimateLayerResult.setSpeed

# sourceId

• sourceId: string

数据源ID.

Inherited from: ICreateAnimateLayerResult.sourceId

# startAnimation

• startAnimation: () => void

开始动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.startAnimation

# stopAnimation

• stopAnimation: () => void

结束动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.stopAnimation

# updateData

• updateData: (input: any) => void

更新数据.

# Type declaration

▸ (input: any): void

# Parameters
Name Type
input any

Returns: void

Inherited from: ICreateAnimateLayerResult.updateData

# updateImages

• updateImages: (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]) => void

更新动画图片集.

# Type declaration

▸ (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]): void

# Parameters
Name Type
images (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

Returns: void

Inherited from: ICreateAnimateLayerResult.updateImages

vjmap / Exports / default / ICreateSymbolAnimateLayerResult

# Interface: ICreateSymbolAnimateLayerResult

default.ICreateSymbolAnimateLayerResult

# Hierarchy

# Table of contents

# Properties

# Properties

# createAnimateImages

• createAnimateImages: (options: ICreateAnimateImagesOptions) => ImageData[]

创建动画图片集.

# Type declaration

▸ (options: ICreateAnimateImagesOptions): ImageData[]

# Parameters
Name Type
options ICreateAnimateImagesOptions

Returns: ImageData[]

Inherited from: ICreateAnimateLayerResult.createAnimateImages

# layerId

• layerId: string

图层ID.

Inherited from: ICreateAnimateLayerResult.layerId

# remove

• remove: () => void

移除.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.remove

# setSpeed

• setSpeed: (speed: number) => void

设置速度.

# Type declaration

▸ (speed: number): void

# Parameters
Name Type
speed number

Returns: void

Inherited from: ICreateAnimateLayerResult.setSpeed

# sourceId

• sourceId: string

数据源ID.

Inherited from: ICreateAnimateLayerResult.sourceId

# startAnimation

• startAnimation: () => void

开始动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.startAnimation

# stopAnimation

• stopAnimation: () => void

结束动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.stopAnimation

# symbol

• symbol: Symbol

# updateData

• updateData: (input: any) => void

更新数据.

# Type declaration

▸ (input: any): void

# Parameters
Name Type
input any

Returns: void

Inherited from: ICreateAnimateLayerResult.updateData

# updateImages

• updateImages: (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]) => void

更新动画图片集.

# Type declaration

▸ (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]): void

# Parameters
Name Type
images (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

Returns: void

Inherited from: ICreateAnimateLayerResult.updateImages

vjmap / Exports / default / IDb2dPolyline

# Interface: IDb2dPolyline

default.IDb2dPolyline

2d折线实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# elevation

• Optional elevation: number

高程.

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# points

• Optional points: [number, number, undefined | number][]

坐标.

# polyType

• Optional polyType: k2dSimplePoly | k2dFitCurvePoly | k2dQuadSplinePoly | k2dCubicSplinePoly

2d折线类型

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / default / IDb2LineAngularDimension

# Interface: IDb2LineAngularDimension

default.IDb2LineAngularDimension

角度标注[两条线]实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点位置.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.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: IDbDimension.xdata

vjmap / Exports / default / IDb3dPolyline

# Interface: IDb3dPolyline

default.IDb3dPolyline

3d折线实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# points

• Optional points: [number, number, undefined | number][]

坐标.

# polyType

• Optional polyType: k3dSimplePoly | k3dQuadSplinePoly | k3dCubicSplinePoly

3d折线类型

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / default / IDb3PointAngularDimension

# Interface: IDb3PointAngularDimension

default.IDb3PointAngularDimension

角度标注[三点]实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点位置.

# centerPoint

• Optional centerPoint: [number, number, undefined | number][]

中点.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

点1.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

点2.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / default / IDbAlignedDimension

# Interface: IDbAlignedDimension

default.IDbAlignedDimension

对齐标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimLinePoint

• Optional dimLinePoint: [number, number, undefined | number][]

设置定义此dimension实体尺寸线位置的WCS点.

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# jogSymbolHeight

• Optional jogSymbolHeight: number

设置此实体的符号高度。.

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线1点.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线2点.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / default / IDbArc

# Interface: IDbArc

default.IDbArc

圆弧实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# endAngle

• Optional endAngle: number

结束弧度.

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# normal

• Optional normal: [number, number, undefined | number]

法向量.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# radius

• Optional radius: number

半径.

# startAngle

• Optional startAngle: number

开始弧度.

# thickness

• Optional thickness: number

厚度.

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / default / IDbArcDimension

# Interface: IDbArcDimension

default.IDbArcDimension

圆弧标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点.

# arcSymbolType

• Optional arcSymbolType: number

文本中使用的弧符号的类型。 0 弧符号在文本前面; 1 弧线符号在文字上方; 2 没有符号.

# centerPoint

• Optional centerPoint: [number, number, undefined | number][]

中心点.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线1点.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线2点.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / default / IDbBlock

# Interface: IDbBlock

default.IDbBlock

块定义接口

# Table of contents

# Properties

# Properties

# comments

• Optional comments: string

备注.

# entitys

• Optional entitys: IDbEntity[]

由哪些实体创建而成.

# explodable

• Optional explodable: boolean

是否可炸开.

# insertUnits

• Optional insertUnits: number

设置此块的块插入单位 .

# name

• Optional name: string

块名称.

# origin

• Optional origin: [number, number, undefined | number][]

原点。 .

# scaling

• Optional scaling: number

设置此块的参照的缩放特征.

vjmap / Exports / default / IDbBlockReference

# Interface: IDbBlockReference

default.IDbBlockReference

块参照实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# blockname

• Optional blockname: string

块名称.

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# normal

• Optional normal: [number, number, undefined | number]

法向量.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# position

• Optional position: [number, number, undefined | number]

坐标.

# ref

• Optional ref: string

参考外部图形，形式为 mapid/version,如 exam/v1.

# rotation

• Optional rotation: number

旋转角度.

# scaleFactors

• Optional scaleFactors: number

缩放因子.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / default / IDbCircle

# Interface: IDbCircle

default.IDbCircle

圆实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# normal

• Optional normal: [number, number, undefined | number]

法向量.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# radius

• Optional radius: number

半径.

# thickness

• Optional thickness: number

厚度.

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / default / IDbCurve

# Interface: IDbCurve

default.IDbCurve

曲线实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / default / IDbDiametricDimension

# Interface: IDbDiametricDimension

default.IDbDiametricDimension

直径标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# chordPoint

• Optional chordPoint: [number, number, undefined | number][]

圆上1点.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# farChordPoint

• Optional farChordPoint: [number, number, undefined | number][]

圆上2点.

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# leaderLength

• Optional leaderLength: number

引线长度.

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / default / IDbDimension

# Interface: IDbDimension

default.IDbDimension

标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# dimStyle

• Optional dimStyle: string

标注样式.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / default / IDbDimStyle

# Interface: IDbDimStyle

default.IDbDimStyle

标注样式接口

# Table of contents

# Properties

# Properties

# dimblk1

• Optional dimblk1: string

符号和箭头1 .“” 实心闭合,“_DOT” 点,“_DOTSMALL” 小点,“_DOTBLANK” 空心点,“_ORIGIN” 指示原点,“_ORIGIN2” 指示原点 2,“_OPEN” 打开,“_OPEN90” 直角,“_OPEN30” 30 度角,“_CLOSED” 闭合,“_SMALL” 空心小点,“_NONE” 无,“_OBLIQUE” 倾斜,“_BOXFILLED” 填充框,“_BOXBLANK” 框,“_CLOSEDBLANK” 空心闭合,“_DATUMFILLED” 实心基准三角形,“_DATUMBLANK” 基准三角形,“_INTEGRAL” 完整标记,“_ARCHTICK” 建筑标记

# dimblk2

• Optional dimblk2: string

符号和箭头2 .同dimblk1

# dimsah

• Optional dimsah: boolean

尺寸线箭头块的显示 .

# name

• Optional name: string

样式名称.

# textStyle

• Optional textStyle: string

文字样式名称.

vjmap / Exports / default / IDbDocument

# Interface: IDbDocument

default.IDbDocument

DB文档定义接口

# Table of contents

# Properties

# Properties

# blocks

• Optional blocks: IDbBlock[]

块定义.

# dimStyles

• Optional dimStyles: IDbDimStyle[]

标注样式.

# entitys

• Optional entitys: IDbEntity[]

实体集.

# from

• Optional from: string

来源于哪个图，会在此图的上面进行修改或新增删除，格式如 形式为 mapid/version,如 exam/v1 .

# layers

• Optional layers: IDbLayer[]

图层集.

# linetypes

• Optional linetypes: IDbLinetype[]

线型.

# textStyles

• Optional textStyles: IDbTextStyle[]

文字样式.

vjmap / Exports / default / IDbEllipse

# Interface: IDbEllipse

default.IDbEllipse

椭圆实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# endAngle

• Optional endAngle: number

结束弧度.

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# minorAxis

• Optional minorAxis: [number, number, undefined | number]

主轴方向.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# radiusRatio

• Optional radiusRatio: number

短轴和长轴的比例.

# startAngle

• Optional startAngle: number

开始弧度.

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / default / IDbEntity

# Interface: IDbEntity

default.IDbEntity

实体类型接口

# Hierarchy

# Implemented by

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

# color

• Optional color: number

颜色.

# colorIndex

• Optional colorIndex: number

颜色索引.

# delete

• Optional delete: boolean

是否删除此实体.

# layer

• Optional layer: string

图层.

# lineWidth

• Optional lineWidth: number

线宽.

# linetype

• Optional linetype: string

线型.

# linetypeScale

• Optional linetypeScale: number

线型比例.

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

# typename

• Optional typename: string

类型.

# visibility

• Optional visibility: boolean

可见.

# xdata

• Optional xdata: string

扩展数据.

vjmap / Exports / default / IDbHatch

# Interface: IDbHatch

default.IDbHatch

填充实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# elevation

• Optional elevation: number

高程.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# pattern

• Optional pattern: string

填充图案, 缺省 SOLID

# points

• Optional points: [number, number, undefined | number][]

坐标.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / default / IDbLayer

# Interface: IDbLayer

default.IDbLayer

图层接口

# Table of contents

# Properties

# Properties

# color

• Optional color: number

图层颜色索引.

# linetype

• Optional linetype: string

图层线型，缺省 CONTINUOUS .

# name

• Optional name: string

图层名称.

vjmap / Exports / default / IDbLine

# Interface: IDbLine

default.IDbLine

线实体类型接口

# Hierarchy

# Implemented by

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# end

• Optional end: [number, number, undefined | number]

终点.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# start

• Optional start: [number, number, undefined | number]

起点.

# thickness

• Optional thickness: number

厚度.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / default / IDbLinetype

# Interface: IDbLinetype

default.IDbLinetype

线型接口

# Table of contents

# Properties

# Properties

# comments

• Optional comments: string

评论.

# name

• Optional name: string

线型名称.

# style

• Optional style: IDbLinetypeStyle[]

线型样式 .

vjmap / Exports / default / IDbLinetypeStyle

# Interface: IDbLinetypeStyle

default.IDbLinetypeStyle

线型样式接口

# Table of contents

# Properties

# Properties

# method

• Optional method: numDashes | patternLength | dashLengthAt | shapeStyleAt | shapeOffsetAt | textAt | shapeScaleAt | shapeNumberAt | shapeRotationAt | isScaledToFit

方法.

# parameter

• Optional parameter: string

参数.

vjmap / Exports / default / IDbMatrixOp

# Interface: IDbMatrixOp

default.IDbMatrixOp

矩阵操作接口

# Table of contents

# Properties

# Properties

# angle

• Optional angle: number

旋转的角度 .

# op

• Optional op: translation | scale | rotate

操作名称.

# origin

• Optional origin: [number, number, undefined | number]

基点.

# scale

• Optional scale: number

缩放大小 .

# vector

• Optional vector: [number, number, undefined | number]

平移的向量.

vjmap / Exports / default / IDbMText

# Interface: IDbMText

default.IDbMText

多行文本实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# attachment

• Optional attachment: kTopLeft | kTopCenter | kTopRight | kMiddleLeft | kMiddleCenter | kMiddleRight | kBottomLeft | kBottomCenter | kBottomRight | kBaseLeft | kBaseCenter | kBaseRight | kBaseAlign | kBottomAlign | kMiddleAlign | kTopAlign | kBaseFit | kBottomFit | kMiddleFit | kTopFit | kBaseMid | kBottomMid | kMiddleMid | kTopMid

对齐方式.

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# contents

• Optional contents: string

文本内容.

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# height

• Optional height: number

高.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# location

• Optional location: [number, number, undefined | number]

位置.

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# rotation

• Optional rotation: number

旋转角度.

# textHeight

• Optional textHeight: number

文本高.

# textStyle

• Optional textStyle: string

文本样式.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# width

• Optional width: number

宽.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / default / IDbOrdinateDimension

# Interface: IDbOrdinateDimension

default.IDbOrdinateDimension

坐标标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# definingPoint

• Optional definingPoint: [number, number, undefined | number][]

定义点.

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# leaderEndPoint

• Optional leaderEndPoint: [number, number, undefined | number][]

引线点.

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# origin

• Optional origin: [number, number, undefined | number][]

基点.

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# useXAxis

• Optional useXAxis: boolean

是否用X轴.

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / default / IDbPolyline

# Interface: IDbPolyline

default.IDbPolyline

折线实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# bulge

• Optional bulge: number[]

凸度.

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# elevation

• Optional elevation: number

高程.

# endWidth

• Optional endWidth: number[]

终点宽.

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# points

• Optional points: [number, number, undefined | number][]

坐标.

# startWidth

• Optional startWidth: number[]

起点宽.

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / default / IDbRadialDimension

# Interface: IDbRadialDimension

default.IDbRadialDimension

半径标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# center

• Optional center: [number, number, undefined | number][]

中心点.

# chordPoint

• Optional chordPoint: [number, number, undefined | number][]

圆上点.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# leaderLength

• Optional leaderLength: number

引线长度.

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / default / IDbRadialDimensionLarge

# Interface: IDbRadialDimensionLarge

default.IDbRadialDimensionLarge

半径折线标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# center

• Optional center: [number, number, undefined | number][]

中心点.

# chordPoint

• Optional chordPoint: [number, number, undefined | number][]

圆上点.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# jogAngle

• Optional jogAngle: number

设置此Dimension实体的折角。.

# jogPoint

• Optional jogPoint: [number, number, undefined | number][]

设置此Dimension实体的折角点。.

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# overrideCenter

• Optional overrideCenter: [number, number, undefined | number][]

设置由该Dimension实体确定尺寸的弧的WCS覆盖中心。.

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / default / IDbRasterImage

# Interface: IDbRasterImage

default.IDbRasterImage

栅格图片实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# brightness

• Optional brightness: number

明亮度 [0.0 .. 100.0]

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# height

• Optional height: number

高.

# imageDisplayOptClip

• Optional imageDisplayOptClip: boolean

是否裁剪.

# imageDisplayOptShow

• Optional imageDisplayOptShow: boolean

是否显示.

# imageDisplayOptShowUnAligned

• Optional imageDisplayOptShowUnAligned: boolean

是否对齐.

# imageDisplayOptTransparent

• Optional imageDisplayOptTransparent: boolean

是否透明.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# 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: IDbEntity.typename

# units

• Optional units: kNone | kMillimeter | kCentimeter | kMeter | kKilometer | kInch | kFoot | kYard | kMile | kMicroinches | kMils | kAngstroms | kNanometers | kMicrons | kDecimeters | kDekameters | kHectometers | kGigameters | kAstronomical | kLightYears | kParsecs

单位.

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# width

• Optional width: number

宽.

# xPelsPerUnit

• Optional xPelsPerUnit: number

x轴每像素代表长度.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

# yPelsPerUnit

• Optional yPelsPerUnit: number

y轴每像素代表长度.

vjmap / Exports / default / IDbRotatedDimension

# Interface: IDbRotatedDimension

default.IDbRotatedDimension

转角标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimLinePoint

• Optional dimLinePoint: [number, number, undefined | number][]

设置定义此dimension实体尺寸线位置的WCS点。.

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线上点1.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线上点2.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / default / IDbShape

# Interface: IDbShape

default.IDbShape

型实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# name

• Optional name: string

型名称.

# normal

• Optional normal: [number, number, undefined | number]

法向量.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# position

• Optional position: [number, number, undefined | number]

位置.

# rotation

• Optional rotation: number

旋转角度.

# size

• Optional size: number

大小.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / default / IDbSpline

# Interface: IDbSpline

default.IDbSpline

样条曲线实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# controlPoints

• Optional controlPoints: [number, number, undefined | number][]

控制点.

# degree

• Optional degree: number

Increased the degree of this spline to the specified value.

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# 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: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / default / IDbTable

# Interface: IDbTable

default.IDbTable

表格实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alignment

• Optional alignment: kTopLeft | kTopCenter | kTopRight | kMiddleLeft | kMiddleCenter | kMiddleRight | kBottomLeft | kBottomCenter | kBottomRight

单元格对齐方式(所有单元格).

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbBlockReference.alpha

# backgroundColor

• Optional backgroundColor: number

背景颜色(所有单元格).

# blockname

• Optional blockname: string

块名称.

Inherited from: IDbBlockReference.blockname

# color

• Optional color: number

颜色.

Inherited from: IDbBlockReference.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbBlockReference.colorIndex

# columnWidth

• Optional columnWidth: number

列宽.

# contentColor

• Optional contentColor: number

文字颜色(所有单元格).

# data

• Optional data: (string | { alignment: TableCellAlignment ; backgroundColor: number ; contentColor: number ; gridColor: number ; gridVisibility: boolean ; text: string ; textHeight: number })[][]

数据.

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbBlockReference.delete

# 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)

# height

• Optional height: number

表格总共的高度.

# horzCellMargin

• Optional horzCellMargin: number

水平方向单元格边距.

# layer

• Optional layer: string

图层.

Inherited from: IDbBlockReference.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbBlockReference.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbBlockReference.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbBlockReference.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbBlockReference.matrix

# mergeCells

• Optional mergeCells: [number, number, number, number][]

需要合并的单元格 [[minRow, maxRow,minColumn, maxColumn], ...]

# normal

• Optional normal: [number, number, undefined | number]

法向量.

Inherited from: IDbBlockReference.normal

# numColumns

• Optional numColumns: number

表格列数.

# numRows

• Optional numRows: number

表格行数.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbBlockReference.objectid

# position

• Optional position: [number, number, undefined | number]

坐标.

Inherited from: IDbBlockReference.position

# ref

• Optional ref: string

参考外部图形，形式为 mapid/version,如 exam/v1.

Inherited from: IDbBlockReference.ref

# rotation

• Optional rotation: number

旋转角度.

Inherited from: IDbBlockReference.rotation

# rowHeight

• Optional rowHeight: number

行高.

# scaleFactors

• Optional scaleFactors: number

缩放因子.

Inherited from: IDbBlockReference.scaleFactors

# tableStyleName

• Optional tableStyleName: string

表样式名称.

# textHeight

• Optional textHeight: number

文字高度(所有单元格).

# typename

• Optional typename: string

类型.

Inherited from: IDbBlockReference.typename

# vertCellMargin

• Optional vertCellMargin: number

竖直方向单元格边距.

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbBlockReference.visibility

# width

• Optional width: number

表格总共的宽度.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbBlockReference.xdata

vjmap / Exports / default / IDbText

# Interface: IDbText

default.IDbText

单行文本实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# contents

• Optional contents: string

文本内容， 同text.

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# height

• Optional height: number

高.

# horizontalMode

• Optional horizontalMode: kTextLeft | kTextCenter | kTextRight | kTextAlign | kTextMid | kTextFit

水平模式.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# 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: IDbEntity.typename

# verticalMode

• Optional verticalMode: kTextBase | kTextBottom | kTextVertMid | kTextTop

垂直模式.

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# widthFactor

• Optional widthFactor: number

宽度因子.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / default / IDbTextStyle

# Interface: IDbTextStyle

default.IDbTextStyle

文字样式接口

# Table of contents

# Properties

# 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 / Exports / default / IDbWipeout

# Interface: IDbWipeout

default.IDbWipeout

遮罩实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbRasterImage.alpha

# brightness

• Optional brightness: number

明亮度 [0.0 .. 100.0]

Inherited from: IDbRasterImage.brightness

# color

• Optional color: number

颜色.

Inherited from: IDbRasterImage.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbRasterImage.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbRasterImage.delete

# height

• Optional height: number

高.

Inherited from: IDbRasterImage.height

# imageDisplayOptClip

• Optional imageDisplayOptClip: boolean

是否裁剪.

Inherited from: IDbRasterImage.imageDisplayOptClip

# imageDisplayOptShow

• Optional imageDisplayOptShow: boolean

是否显示.

Inherited from: IDbRasterImage.imageDisplayOptShow

# imageDisplayOptShowUnAligned

• Optional imageDisplayOptShowUnAligned: boolean

是否对齐.

Inherited from: IDbRasterImage.imageDisplayOptShowUnAligned

# imageDisplayOptTransparent

• Optional imageDisplayOptTransparent: boolean

是否透明.

Inherited from: IDbRasterImage.imageDisplayOptTransparent

# layer

• Optional layer: string

图层.

Inherited from: IDbRasterImage.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbRasterImage.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbRasterImage.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbRasterImage.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbRasterImage.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbRasterImage.objectid

# pixelHeight

• Optional pixelHeight: number

源图片高.

Inherited from: IDbRasterImage.pixelHeight

# pixelWidth

• Optional pixelWidth: number

源图片宽.

Inherited from: IDbRasterImage.pixelWidth

# points

• Optional points: [number, number, undefined | number][]

坐标.

# position

• Optional position: [number, number, undefined | number]

位置.

Inherited from: IDbRasterImage.position

# sourceHttpUrl

• Optional sourceHttpUrl: string

图片url地址.

Inherited from: IDbRasterImage.sourceHttpUrl

# typename

• Optional typename: string

类型.

Inherited from: IDbRasterImage.typename

# units

• Optional units: kNone | kMillimeter | kCentimeter | kMeter | kKilometer | kInch | kFoot | kYard | kMile | kMicroinches | kMils | kAngstroms | kNanometers | kMicrons | kDecimeters | kDekameters | kHectometers | kGigameters | kAstronomical | kLightYears | kParsecs

单位.

Inherited from: IDbRasterImage.units

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbRasterImage.visibility

# width

• Optional width: number

宽.

Inherited from: IDbRasterImage.width

# xPelsPerUnit

• Optional xPelsPerUnit: number

x轴每像素代表长度.

Inherited from: IDbRasterImage.xPelsPerUnit

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbRasterImage.xdata

# yPelsPerUnit

• Optional yPelsPerUnit: number

y轴每像素代表长度.

Inherited from: IDbRasterImage.yPelsPerUnit

vjmap / Exports / default / IDeleteCache

# Interface: IDeleteCache

default.IDeleteCache

清空地图缓存接口

# Table of contents

# Properties

# Properties

# key

• Optional key: string

匹配的键值.

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本, 如清空所有版本缓存，输入"*"号).

vjmap / Exports / default / IDeleteStyle

# Interface: IDeleteStyle

default.IDeleteStyle

删除地图样式接口

# Table of contents

# Properties

# Properties

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# onlycleardata

• onlycleardata: boolean

是否只清空数据, false 删除表和数据; true 只删除数据.

# styleid

• styleid: string

样式名称.如删除所有样式，输入""号； 删除所有系统产生的样式，输入 "a"；内存打开的样式,输入"m*";几何打开的样式输入 "s*"

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本, 如删除所有版本，输入"*"号).

vjmap / Exports / default / IDraw

# Interface: IDraw

default.IDraw

# Table of contents

# Properties

# Properties

# Tool

• Tool: (options?: IDrawOptions) => IDrawTool

工具类.

# Type declaration

+ new IDraw(options?: IDrawOptions): IDrawTool

# Parameters
Name Type
options? IDrawOptions

Returns: IDrawTool

# actionDraw

• actionDraw: (map: any, modename: string, options?: Record<string, any>) => any

绘制动作.

# Type declaration

▸ (map: any, modename: string, options?: Record<string, any>): any

# Parameters
Name Type
map any
modename string
options? Record<string, any>

Returns: any

# actionDrawCircle

• actionDrawCircle: (map: any, options?: Record<string, any>) => any

绘制圆动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionDrawLineSting

• actionDrawLineSting: (map: any, options?: Record<string, any>) => any

绘制线动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionDrawPoint

• actionDrawPoint: (map: any, options?: Record<string, any>) => any

绘制点动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionDrawPolygon

• actionDrawPolygon: (map: any, options?: Record<string, any>) => any

绘制多边形动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionDrawRectangle

• actionDrawRectangle: (map: any, options?: Record<string, any>) => any

绘制矩形动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionDrawSlantRectangle

• actionDrawSlantRectangle: (map: any, options?: Record<string, any>) => any

绘制斜矩形动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionSelect

• actionSelect: (map: any, draw: any, options?: Record<string, any>) => any

选择实体. 如果只能选择一个实体，options选项请输入selectSingle为true

# Type declaration

▸ (map: any, draw: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
draw any
options? Record<string, any>

Returns: any

# defaultOptions

• defaultOptions: () => any

缺省配置项.

# Type declaration

▸ (): any

Returns: any

# modes

• modes: Record<string, any>

模式.

vjmap / Exports / default / IDrawOptions

# Interface: IDrawOptions

default.IDrawOptions

# Indexable

▪ [key: string]: any

# Table of contents

# Properties

# Properties

# addControls

• Optional addControls: any[]

# api

• api: object

# Type declaration
Name Type
getSnapFeatures any

# controls

• Optional controls: Record<string, boolean>

# guides

• Optional guides: boolean

# midpoints

• Optional midpoints: boolean

# modes

• Optional modes: Record<string, any>

# snap

• Optional snap: boolean

# snapOptions

• snapOptions: object

# Type declaration
Name Type
snapGridPx? number
snapPx? number
snapToMidPoints? boolean
snapVertexPriorityDistance? number

# styles

• Optional styles: any[]

# userProperties

• Optional userProperties: boolean

vjmap / Exports / default / IDrawTool

# Interface: IDrawTool

default.IDrawTool

# Table of contents

# Properties

# Properties

# add

• add: (geojson: any) => string[]

此方法采用 GeoJSON Feature、FeatureCollection 或 Geometry 并将其添加到 Draw。它返回一个 id 数组，用于与添加的功能进行交互。如果某个功能没有自己的 id，则会自动生成一个

# Type declaration

▸ (geojson: any): string[]

# Parameters
Name Type
geojson any

Returns: string[]

# changeMode

• changeMode: (mode: string, modeOptions?: any) => IDrawTool

将绘图更改为另一种模式。返回用于链接的绘制实例

# Type declaration

▸ (mode: string, modeOptions?: any): IDrawTool

# Parameters
Name Type
mode string
modeOptions? any

Returns: IDrawTool

# combineFeatures

• combineFeatures: () => IDrawTool

调用当前模式的combineFeatures操作。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

# delete

• delete: (featureIds: string | string[]) => IDrawTool

删除具有指定 ID 的功能。返回用于链接的绘制实例

# Type declaration

▸ (featureIds: string | string[]): IDrawTool

# Parameters
Name Type
featureIds string | string[]

Returns: IDrawTool

# deleteAll

• deleteAll: () => IDrawTool

删除所有功能。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

# doAction

• doAction: (actionName: string) => any

在当前模式下执行动作

# Type declaration

▸ (actionName: string): any

# Parameters
Name Type
actionName string

Returns: any

# forceRefresh

• forceRefresh: () => any

强制刷新

# Type declaration

▸ (): any

Returns: any

# get

• get: (id: string) => any

返回 Draw 中具有指定 id 的 GeoJSON 功能，或者undefined如果 id 不匹配任何功能

# Type declaration

▸ (id: string): any

# Parameters
Name Type
id string

Returns: any

# getAll

• getAll: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回所有功能的 FeatureCollection

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

# getFeatureIdsAt

• getFeatureIdsAt: (point: { x: number ; y: number }) => string[]

返回当前在指定点呈现的功能的功能 ID 数组。

# Type declaration

▸ (point: { x: number ; y: number }): string[]

# Parameters
Name Type
point object
point.x number
point.y number

Returns: string[]

# getMode

• getMode: () => string

返回 Draw 的当前模式

# Type declaration

▸ (): string

Returns: string

# getSelected

• getSelected: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回当前选择的所有功能的 FeatureCollection

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

# getSelectedIds

• getSelectedIds: () => string[]

返回当前所选功能的功能 ID 数组

# Type declaration

▸ (): string[]

Returns: string[]

# getSelectedPoints

• getSelectedPoints: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回代表当前选择的所有顶点的 FeatureCollection 点

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

# modes

• modes: Record<string, any>

内部变量模式值

# onAdd

• onAdd: (map: any) => any

增加时回调接口

# Type declaration

▸ (map: any): any

# Parameters
Name Type
map any

Returns: any

# onRemove

• onRemove: () => any

移除时回调接口

# Type declaration

▸ (): any

Returns: any

# options

• options: Record<string, any>

内部变量选项值

# redo

• redo: () => any

# Type declaration

▸ (): any

Returns: any

# set

• set: (featureCollection: FeatureCollection<Geometry | GeometryCollection, Properties>) => string[]

将 Draw 的功能设置为指定的 FeatureCollection

# Type declaration

▸ (featureCollection: FeatureCollection<Geometry | GeometryCollection, Properties>): string[]

# Parameters
Name Type
featureCollection FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: string[]

# setFeatureProperty

• setFeatureProperty: (featureId: string, property: string, value: any) => IDrawTool

设置具有指定 id 的要素的属性值。返回用于链接的绘制实例

# Type declaration

▸ (featureId: string, property: string, value: any): IDrawTool

# Parameters
Name Type
featureId string
property string
value any

Returns: IDrawTool

# trash

• trash: () => IDrawTool

调用当前模式的删除trash操作。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

# uncombineFeatures

• uncombineFeatures: () => IDrawTool

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

# undo

• undo: () => any

# Type declaration

▸ (): any

Returns: any

vjmap / Exports / default / IExportLayout

# Interface: IExportLayout

default.IExportLayout

导出布局空间为dwg图

# Table of contents

# Properties

# Properties

# layoutIndex

• Optional layoutIndex: string

布局索引，layoutIndex和layoutName只要输入一个就行，layoutIndex优先。如果都为空，则使用dwg当前的布局空间.

# layoutName

• Optional layoutName: string

布局名称. layoutIndex和layoutName只要输入一个就行，layoutIndex优先。如果都为空，则使用dwg当前的布局空间.

# mapid

• mapid: string

地图ID.

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

vjmap / Exports / default / IExprQueryFeatures

# Interface: IExprQueryFeatures

default.IExprQueryFeatures

表达式查询实体参数

# Hierarchy

# Table of contents

# Properties

# Properties

# beginpos

• Optional beginpos: number

记录开始位置.

# expr

• expr: string

表达式.

# fields

• Optional fields: string

是返回的字段列表，多个之是用逗号,分开,如. "name,objectid"

Inherited from: IQueryBaseFeatures.fields

# geom

• Optional geom: boolean

是否为几何图形查询.

Inherited from: IQueryBaseFeatures.geom

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称).

Inherited from: IQueryBaseFeatures.layer

# limit

• Optional limit: number

返回最多的记录条数.

Inherited from: IQueryBaseFeatures.limit

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

Inherited from: IQueryBaseFeatures.mapid

# simplifyTolerance

• Optional simplifyTolerance: boolean

GeoJSON几何数据简化墨托卡距离，默认为零，不简化。例如允许10级别以上一个像素级别的误差，可用 map.pixelToGeoLength(1, 10) * vjmap.Projection.EQUATORIAL_SEMIPERIMETER * 2 / map.getGeoBounds(1.0).width()

Inherited from: IQueryBaseFeatures.simplifyTolerance

# toMapCoordinate

• Optional toMapCoordinate: boolean

查询返回的坐标默认为墨卡托坐标，返回会程序会自动转化为cad坐标，如果要直接返回cad地图坐标，需要把toMapCoordinate设置为true.

Inherited from: IQueryBaseFeatures.toMapCoordinate

# useCache

• Optional useCache: boolean

启动cache(内存打开的图形有效).

Inherited from: IQueryBaseFeatures.useCache

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

Inherited from: IQueryBaseFeatures.version

# zoom

• Optional zoom: number

当前级别.

Inherited from: IQueryBaseFeatures.zoom

vjmap / Exports / default / ILineLayerOptions

# Interface: ILineLayerOptions

default.ILineLayerOptions

# Implemented by

# Table of contents

# Properties

# Properties

# points

• points: { lat: number ; lng: number }[]

vjmap / Exports / default / IMapDiff

# Interface: IMapDiff

default.IMapDiff

比较地图不同

# Table of contents

# Properties

# Properties

# cellsize

• Optional cellsize: number

比较单元大小.

# diffMinAlpha

• Optional diffMinAlpha: number

不同的透明最小值.

# diffMinColor

• Optional diffMinColor: number

不同的颜色最小值.

# diffMinPixel

• Optional diffMinPixel: number

不同的像素最小值.

# layer1

• Optional layer1: string

地图一样式图层.

# layer2

• Optional layer2: string

地图二样式图层.

# mapid1

• mapid1: string

地图一ID.

# mapid2

• mapid2: string

地图二ID.

# noCompareDelete

• Optional noCompareDelete: boolean

不比较删除部分.

# noCompareNew

• Optional noCompareNew: boolean

不比较新增部分.

# size

• Optional size: number

比较大小.

# version1

• Optional version1: string

地图一版本(为空时采用当前打开的地图版本).

# version2

• Optional version2: string

地图二版本(为空时采用当前打开的地图版本).

vjmap / Exports / default / IMapLayer

# Interface: IMapLayer

default.IMapLayer

地图图层

# Table of contents

# Properties

# Properties

# color

• color: string

颜色.

# index

• index: number

图层索引.

# isFrozen

• isFrozen: boolean

是否冻结.

# isLocked

• isLocked: boolean

是否锁定.

# isOff

• isOff: boolean

图层是否关闭.

# lineWeight

• lineWeight: number

线宽.

# linetype

• linetype: number

线型.

# name

• name: string

图层名称.

vjmap / Exports / default / IMapStyleParam

# Interface: IMapStyleParam

default.IMapStyleParam

地图样式参数参数

# Table of contents

# Properties

# Properties

# backcolor

• Optional backcolor: number

颜色.

# clipbounds

• Optional clipbounds: number | [number, number, number, number]

地图裁剪范围，范围如[x1,y1,x2,y2].如果只需入了数值的话，表示是缩放倍数

# expression

• Optional expression: string

表达式.

# layeroff

• Optional layeroff: string | number[]

要关的图层索引列表，格式如[2,4]. layeron与layeroff只要输入一个即可

# layeron

• Optional layeron: string | number[]

要开的图层索引列表，格式如[0,1,3].

# lineweight

• Optional lineweight: string | number[]

线宽，格式如[1，1，1，1，0].表式第1，2，3，4级线宽开，第5级线宽关，大于第5级的，以最后设置的级别状态为主，所以也是关。如为空，则和原图线宽显示状态相同

# name

• Optional name: string

样式名称.

vjmap / Exports / default / IMatchObject

# Interface: IMatchObject

default.IMatchObject

目标匹配

# Table of contents

# Properties

# Properties

# canOverlap

• Optional canOverlap: boolean

允许重叠 (默认false).

# layer

• Optional layer: string

图层样式名.为空时，将由选择的实体的图层来决定

# layeron

• Optional layeron: string

目标匹配的地图打开的图层

# mapBounds

• Optional mapBounds: string

目标匹配的地图范围，默认为全图的数据范围.

# mapid

• mapid: string

地图ID.

# maxCount

• Optional maxCount: number

允许返回的最大条数. 默认 200

# maxOverlap

• Optional maxOverlap: number

重叠比例 范围(0-0.8)，默认 0.3.

# method

• Optional method: "matchTemplate" | "matchPattern"

方法. 默认 matchPattern

# minReduceArea

• Optional minReduceArea: number

金字塔大小 范围(64-2048).默认256， 方法为matchPattern有效

# objectBounds

• objectBounds: string

目标匹配的实体范围

# objectIds

• Optional objectIds: string

目标匹配的实体objectid数组，用||隔开.

# score

• Optional score: number

分数，小于此分类将不显示 (0 -1)，默认 0.6 .

# size

• Optional size: number

匹配时的图像尺寸，默认10000

# tolerance1

• Optional tolerance1: number

角度区间1开始角度. 方法为matchPattern有效

# tolerance2

• Optional tolerance2: number

角度区间1结束角度. 方法为matchPattern有效

# tolerance3

• Optional tolerance3: number

角度区间2开始角度. 方法为matchPattern有效

# tolerance4

• Optional tolerance4: number

角度区间2结束角度. 方法为matchPattern有效

# toleranceAngle

• Optional toleranceAngle: number

角度范围(-180, 180)有旋转的时候需要。方法为matchPattern有效. 默认180

# useToleranceRange

• Optional useToleranceRange: boolean

是否使用角度区间范围,默认false. 方法为matchPattern有效

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

vjmap / Exports / default / InertiaOptions

# Interface: InertiaOptions

default.InertiaOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# bounceDamping

• Optional bounceDamping: number

# bounceStiffness

• Optional bounceStiffness: number

# driver

• Optional driver: Driver

# from

• Optional from: number

Inherited from: DecayOptions.from

# max

• Optional max: number

# min

• Optional min: number

# modifyTarget

• Optional modifyTarget: (target: number) => number

# Type declaration

▸ (target: number): number

# Parameters
Name Type
target number

Returns: number

Inherited from: DecayOptions.modifyTarget

# onComplete

• Optional onComplete: () => void

# Type declaration

▸ (): void

Returns: void

# onStop

• Optional onStop: () => void

# Type declaration

▸ (): void

Returns: void

# onUpdate

• Optional onUpdate: (v: number) => void

# Type declaration

▸ (v: number): void

# Parameters
Name Type
v number

Returns: void

# power

• Optional power: number

Inherited from: DecayOptions.power

# restDelta

• Optional restDelta: number

Overrides: DecayOptions.restDelta

# restSpeed

• Optional restSpeed: number

# timeConstant

• Optional timeConstant: number

Inherited from: DecayOptions.timeConstant

# to

• Optional to: number

Inherited from: DecayOptions.to

# velocity

• Optional velocity: number

Inherited from: DecayOptions.velocity

vjmap / Exports / default / IOpenMapBaseParam

# Interface: IOpenMapBaseParam

default.IOpenMapBaseParam

地图打开参数

# Hierarchy

# Table of contents

# Properties

# Properties

# accessKey

• Optional accessKey: string

访问权限的key，权限小于secretKey，不能对图进行删除等操作.

# cadVersion

• Optional cadVersion: string

新建地图有fileDoc时有效

# cbInputPassword

• Optional cbInputPassword: (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }) => Promise<string>

要求输入密码回调.

# Type declaration

▸ (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }): Promise<string>

# Parameters
Name Type
param object
param.isPasswordError boolean
param.mapid string
param.result any
param.tryPasswordCount number

Returns: Promise<string>

# filedoc

• Optional filedoc: string

文件文档.

# fileid

• Optional fileid: string

文件唯一ID. 地图ID第一次打开时，需传递fileid

# filename

• Optional filename: string

文件名称.

# fontReplaceRule

• Optional fontReplaceRule: string | Record<string, string>

字符替换规则. openMap返回的字段findFonts为系统查找的字体替换规则。如需修改默认的话，请传入替换的字体规则，如fontReplaceRule: {"tssdeng.shx_1": "default.ttc"}

# imageLeft

• Optional imageLeft: number

图像左上角坐标x 第一次打开图像类型时有效

# imageResolution

• Optional imageResolution: number

图像分辨率 第一次打开图像类型时有效, 一个像素单位代表多少地理长度，计算公式为 真实坐标长度 / 图像像素宽

# imageTop

• Optional imageTop: number

图像左上角坐标y 第一次打开图像类型时有效

# mapdependencies

• Optional mapdependencies: string

地图依赖项.

# mapfrom

• Optional mapfrom: string

地图来源参数.

# mapid

• mapid: string

地图ID.

# mapopenway

• Optional mapopenway: Memory | GeomRender

地图打开方式(缺省: GeomRender) .

# notReplaceLineType

• Optional notReplaceLineType: boolean

不自动替换线型.

# notUseDefaultShxFont

• Optional notUseDefaultShxFont: boolean

不使用缺省的型文字文件，将使用缺省的字体来代替型文件.

# notUseDefaultTtfFont

• Optional notUseDefaultTtfFont: boolean

不使用缺省的字体文件，将使用缺省的型文件来代替字体文件.

# openFinishMaxTryCount

• Optional openFinishMaxTryCount: number

判断是否打开或更新成功重试最大次数。默认 120 次

# openFinishTryInterval

• Optional openFinishTryInterval: number

判断是否打开或更新成功重试间隔（秒）。默认 5s 一次

# renderAccuracy

• Optional renderAccuracy: number

渲染精度，默认1，有时候图形特别大导致圆或圆弧精度不够时,不够光滑，可以先清空之前的缓存数据，再重新上传时，改变渲染精度来使圆或圆弧光滑些。注：提高精度会导致空间数据文件增大，渲染性能下降

# secretKey

• Optional secretKey: string

秘钥(第一次上传打开图时有效，表示此图需要密码保护).

# style

• Optional style: IMapStyleParam

样式.

# subdependencies

• Optional subdependencies: string

地图依赖项(这是子项的设置，与mapdependencies不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapdependencies一样的话，则为空

# subfrom

• Optional subfrom: string

地图来源参数(这是子项的设置，与mapfrom不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapfrom一样的话，则为空

# uploadname

• Optional uploadname: string

上传时的文件名.

vjmap / Exports / default / IOpenMapParam

# Interface: IOpenMapParam

default.IOpenMapParam

地图打开参数

# Hierarchy

# Table of contents

# Properties

# Properties

# accessKey

• Optional accessKey: string

访问权限的key，权限小于secretKey，不能对图进行删除等操作.

Inherited from: IOpenMapBaseParam.accessKey

# cadVersion

• Optional cadVersion: string

新建地图有fileDoc时有效

Inherited from: IOpenMapBaseParam.cadVersion

# cbInputPassword

• Optional cbInputPassword: (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }) => Promise<string>

要求输入密码回调.

# Type declaration

▸ (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }): Promise<string>

# Parameters
Name Type
param object
param.isPasswordError boolean
param.mapid string
param.result any
param.tryPasswordCount number

Returns: Promise<string>

Inherited from: IOpenMapBaseParam.cbInputPassword

# filedoc

• Optional filedoc: string

文件文档.

Inherited from: IOpenMapBaseParam.filedoc

# fileid

• Optional fileid: string

文件唯一ID. 地图ID第一次打开时，需传递fileid

Inherited from: IOpenMapBaseParam.fileid

# filename

• Optional filename: string

文件名称.

Inherited from: IOpenMapBaseParam.filename

# fontReplaceRule

• Optional fontReplaceRule: string | Record<string, string>

字符替换规则. openMap返回的字段findFonts为系统查找的字体替换规则。如需修改默认的话，请传入替换的字体规则，如fontReplaceRule: {"tssdeng.shx_1": "default.ttc"}

Inherited from: IOpenMapBaseParam.fontReplaceRule

# imageLeft

• Optional imageLeft: number

图像左上角坐标x 第一次打开图像类型时有效

Inherited from: IOpenMapBaseParam.imageLeft

# imageResolution

• Optional imageResolution: number

图像分辨率 第一次打开图像类型时有效, 一个像素单位代表多少地理长度，计算公式为 真实坐标长度 / 图像像素宽

Inherited from: IOpenMapBaseParam.imageResolution

# imageTop

• Optional imageTop: number

图像左上角坐标y 第一次打开图像类型时有效

Inherited from: IOpenMapBaseParam.imageTop

# layer

• Optional layer: string

图层名称，组合图层用英文逗号分开

# layoutIndex

• Optional layoutIndex: number

布局索引 (从1开始)，默认为0，表示是模型空间

# mapdependencies

• Optional mapdependencies: string

地图依赖项.

Inherited from: IOpenMapBaseParam.mapdependencies

# mapfrom

• Optional mapfrom: string

地图来源参数.

Inherited from: IOpenMapBaseParam.mapfrom

# mapid

• mapid: string

地图ID.

Inherited from: IOpenMapBaseParam.mapid

# mapopenway

• Optional mapopenway: Memory | GeomRender

地图打开方式(缺省: GeomRender) .

Inherited from: IOpenMapBaseParam.mapopenway

# notReplaceLineType

• Optional notReplaceLineType: boolean

不自动替换线型.

Inherited from: IOpenMapBaseParam.notReplaceLineType

# notUseDefaultShxFont

• Optional notUseDefaultShxFont: boolean

不使用缺省的型文字文件，将使用缺省的字体来代替型文件.

Inherited from: IOpenMapBaseParam.notUseDefaultShxFont

# notUseDefaultTtfFont

• Optional notUseDefaultTtfFont: boolean

不使用缺省的字体文件，将使用缺省的型文件来代替字体文件.

Inherited from: IOpenMapBaseParam.notUseDefaultTtfFont

# openFinishMaxTryCount

• Optional openFinishMaxTryCount: number

判断是否打开或更新成功重试最大次数。默认 120 次

Inherited from: IOpenMapBaseParam.openFinishMaxTryCount

# openFinishTryInterval

• Optional openFinishTryInterval: number

判断是否打开或更新成功重试间隔（秒）。默认 5s 一次

Inherited from: IOpenMapBaseParam.openFinishTryInterval

# renderAccuracy

• Optional renderAccuracy: number

渲染精度，默认1，有时候图形特别大导致圆或圆弧精度不够时,不够光滑，可以先清空之前的缓存数据，再重新上传时，改变渲染精度来使圆或圆弧光滑些。注：提高精度会导致空间数据文件增大，渲染性能下降

Inherited from: IOpenMapBaseParam.renderAccuracy

# secretKey

• Optional secretKey: string

秘钥(第一次上传打开图时有效，表示此图需要密码保护).

Inherited from: IOpenMapBaseParam.secretKey

# style

• Optional style: IMapStyleParam

样式.

Inherited from: IOpenMapBaseParam.style

# subdependencies

• Optional subdependencies: string

地图依赖项(这是子项的设置，与mapdependencies不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapdependencies一样的话，则为空

Inherited from: IOpenMapBaseParam.subdependencies

# subfrom

• Optional subfrom: string

地图来源参数(这是子项的设置，与mapfrom不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapfrom一样的话，则为空

Inherited from: IOpenMapBaseParam.subfrom

# uploadname

• Optional uploadname: string

上传时的文件名.

Inherited from: IOpenMapBaseParam.uploadname

# version

• Optional version: string

版本号(缺省: "" ).

vjmap / Exports / default / IOpenMapResponse

# Interface: IOpenMapResponse

default.IOpenMapResponse

地图打开返回成功参数

# Table of contents

# Properties

# Properties

# bounds

• Optional bounds: GeoBounds

地图范围(如果通过clipBounds打开，则是clipBounds的范围).

# darkMode

• Optional darkMode: boolean

暗黑模式(背景色为黑时).

# dbBounds

• Optional dbBounds: GeoBounds

数据库地图范围

# dbid

• Optional dbid: string

DbID.

# description

• Optional description: string

描述.

# drawBounds

• Optional drawBounds: GeoBounds

图形中有数据的范围（此范围是非精确值，精确的数据范围需调用cmdGetDrawBounds去获取）

# fileid

• Optional fileid: string

文件唯一ID.

# filename

• Optional filename: string

文件名称.

# imageHeight

• Optional imageHeight: number

图像类型时图像像素高

# imageLeft

• Optional imageLeft: number

图像左上角坐标x

# imageResolution

• Optional imageResolution: number

图像分辨率 一个像素单位代表多少地理长度，计算公式为 真实坐标长度 / 图像像素宽

# imageTop

• Optional imageTop: number

图像左上角坐标y

# imageWidth

• Optional imageWidth: number

图像类型时图像像素宽

# initViewScale

• Optional initViewScale: number

初始视图缩放倍数，bounds * initViewScale = dbBounds

# layer

• Optional layer: string

图层名称

# layers

• Optional layers: any

图层列表.

# layouts

• Optional layouts: string[]

所有布局.

# lineWidthDisplay

• Optional lineWidthDisplay: boolean

默认是否显示线宽.

# mapBounds

• Optional mapBounds: GeoBounds

地图范围(地图的范围，如果没有通过clipBounds打开,则为空).

# mapdependencies

• Optional mapdependencies: string

地图依赖项.

# mapfrom

• Optional mapfrom: string

地图来源参数.

# mapid

• Optional mapid: string

地图ID.

# mapopenway

• Optional mapopenway: Memory | GeomRender

地图打开方式(缺省: GeomRender) .

# maptype

• Optional maptype: string

地图类型. 为空时表示是cad类型，image表示是图像

# maxzoom

• Optional maxzoom: number

图像类型时最大级别

# renderAccuracy

• Optional renderAccuracy: number

渲染精度，默认1，有时候图形特别大导致圆或圆弧精度不够时,不够光滑，可以先清空之前的缓存数据，再重新上传时，改变渲染精度来使圆或圆弧光滑些。注：提高精度会导致空间数据文件增大，渲染性能下降

# status

• Optional status: string

状态.

# styles

• Optional styles: any

图层样式.

# subdependencies

• Optional subdependencies: string

地图依赖项(这是子项的设置，与mapdependencies不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapdependencies一样的话，则为空

# subfrom

• Optional subfrom: string

地图来源参数(这是子项的设置，与mapfrom不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapfrom一样的话，则为空

# type

• Optional type: string

类型.

# ucsorg

• Optional ucsorg: string

ucs基点坐标.

# uploadname

• Optional uploadname: string

上传的文件名.

# version

• Optional version: string

版本号(缺省: "" ).

# view

• Optional view: object

初始视图.

# Type declaration
Name Type Description
bearing? number 初始视图方位角.
center? [number, number] 初始视图中心点.
zoom? number 初始视图级别.

vjmap / Exports / default / IPointQueryFeatures

# Interface: IPointQueryFeatures

default.IPointQueryFeatures

点查询实体参数

# Hierarchy

# Table of contents

# Properties

# Properties

# condition

• Optional condition: string

条件.

# fields

• Optional fields: string

是返回的字段列表，多个之是用逗号,分开,如. "name,objectid"

Inherited from: IQueryBaseFeatures.fields

# geom

• Optional geom: boolean

是否为几何图形查询.

Inherited from: IQueryBaseFeatures.geom

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称).

Inherited from: IQueryBaseFeatures.layer

# limit

• Optional limit: number

返回最多的记录条数.

Inherited from: IQueryBaseFeatures.limit

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

Inherited from: IQueryBaseFeatures.mapid

# maxGeomBytesSize

• Optional maxGeomBytesSize: number

返回最大的几何字节数.

# pixelToGeoLength

• Optional pixelToGeoLength: number

当前一个像素表示多少几何长度，如果输入了此值，则为此值为主，否则，根据输入的zoom值后台自动计算.

# pixelsize

• Optional pixelsize: number

像素大小.

# simplifyTolerance

• Optional simplifyTolerance: boolean

GeoJSON几何数据简化墨托卡距离，默认为零，不简化。例如允许10级别以上一个像素级别的误差，可用 map.pixelToGeoLength(1, 10) * vjmap.Projection.EQUATORIAL_SEMIPERIMETER * 2 / map.getGeoBounds(1.0).width()

Inherited from: IQueryBaseFeatures.simplifyTolerance

# toMapCoordinate

• Optional toMapCoordinate: boolean

查询返回的坐标默认为墨卡托坐标，返回会程序会自动转化为cad坐标，如果要直接返回cad地图坐标，需要把toMapCoordinate设置为true.

Inherited from: IQueryBaseFeatures.toMapCoordinate

# useCache

• Optional useCache: boolean

启动cache(内存打开的图形有效).

Inherited from: IQueryBaseFeatures.useCache

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

Inherited from: IQueryBaseFeatures.version

# x

• x: number

查询的坐标X.

# y

• y: number

查询的坐标Y.

# zoom

• Optional zoom: number

当前级别.

Inherited from: IQueryBaseFeatures.zoom

vjmap / Exports / default / IQueryBaseFeatures

# Interface: IQueryBaseFeatures

default.IQueryBaseFeatures

查询实体参数

# Hierarchy

# Table of contents

# Properties

# Properties

# fields

• Optional fields: string

是返回的字段列表，多个之是用逗号,分开,如. "name,objectid"

# geom

• Optional geom: boolean

是否为几何图形查询.

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称).

# limit

• Optional limit: number

返回最多的记录条数.

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# simplifyTolerance

• Optional simplifyTolerance: boolean

GeoJSON几何数据简化墨托卡距离，默认为零，不简化。例如允许10级别以上一个像素级别的误差，可用 map.pixelToGeoLength(1, 10) * vjmap.Projection.EQUATORIAL_SEMIPERIMETER * 2 / map.getGeoBounds(1.0).width()

# toMapCoordinate

• Optional toMapCoordinate: boolean

查询返回的坐标默认为墨卡托坐标，返回会程序会自动转化为cad坐标，如果要直接返回cad地图坐标，需要把toMapCoordinate设置为true.

# useCache

• Optional useCache: boolean

启动cache(内存打开的图形有效).

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

# zoom

• Optional zoom: number

当前级别.

vjmap / Exports / default / IRectQueryFeatures

# Interface: IRectQueryFeatures

default.IRectQueryFeatures

矩形查询实体参数

# Hierarchy

# Table of contents

# Properties

# Properties

# condition

• Optional condition: string

条件.

# fields

• Optional fields: string

是返回的字段列表，多个之是用逗号,分开,如. "name,objectid"

Inherited from: IQueryBaseFeatures.fields

# geom

• Optional geom: boolean

是否为几何图形查询.

Inherited from: IQueryBaseFeatures.geom

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称).

Inherited from: IQueryBaseFeatures.layer

# limit

• Optional limit: number

返回最多的记录条数.

Inherited from: IQueryBaseFeatures.limit

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

Inherited from: IQueryBaseFeatures.mapid

# maxGeomBytesSize

• Optional maxGeomBytesSize: number

返回最大的几何字节数.

# simplifyTolerance

• Optional simplifyTolerance: boolean

GeoJSON几何数据简化墨托卡距离，默认为零，不简化。例如允许10级别以上一个像素级别的误差，可用 map.pixelToGeoLength(1, 10) * vjmap.Projection.EQUATORIAL_SEMIPERIMETER * 2 / map.getGeoBounds(1.0).width()

Inherited from: IQueryBaseFeatures.simplifyTolerance

# toMapCoordinate

• Optional toMapCoordinate: boolean

查询返回的坐标默认为墨卡托坐标，返回会程序会自动转化为cad坐标，如果要直接返回cad地图坐标，需要把toMapCoordinate设置为true.

Inherited from: IQueryBaseFeatures.toMapCoordinate

# useCache

• Optional useCache: boolean

启动cache(内存打开的图形有效).

Inherited from: IQueryBaseFeatures.useCache

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

Inherited from: IQueryBaseFeatures.version

# x1

• Optional x1: number

查询的坐标X1. (如果x1,y1,x2,y2同时不输的话，表示是查询整个图的范围

# x2

• Optional x2: number

查询的坐标X2.

# y1

• Optional y1: number

查询的坐标Y1.

# y2

• Optional y2: number

查询的坐标Y2.

# zoom

• Optional zoom: number

当前级别.

Inherited from: IQueryBaseFeatures.zoom

vjmap / Exports / default / IRequest

# Interface: IRequest

default.IRequest

# Table of contents

# Properties

# Properties

# del

• del: (url: string, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
args? Partial<Config<unknown>>

Returns: Promise<any>

# get

• get: (url: string, params?: Record<string, any>, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, params?: Record<string, any>, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
params? Record<string, any>
args? Partial<Config<unknown>>

Returns: Promise<any>

# options

• options: (url: string, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
args? Partial<Config<unknown>>

Returns: Promise<any>

# patch

• patch: (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, data: any, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
data any
args? Partial<Config<unknown>>

Returns: Promise<any>

# post

• post: (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, data: any, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
data any
args? Partial<Config<unknown>>

Returns: Promise<any>

# put

• put: (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, data: any, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
data any
args? Partial<Config<unknown>>

Returns: Promise<any>

vjmap / Exports / default / ISliceCacheZoom

# Interface: ISliceCacheZoom

default.ISliceCacheZoom

获取图片切片缓存级别

# Table of contents

# Properties

# Properties

# ismvt

• ismvt: boolean

是否是矢量切片，如果否则为栅格瓦片切片

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称)

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

vjmap / Exports / default / ISliceLayer

# Interface: ISliceLayer

default.ISliceLayer

对图层进行切片

# Table of contents

# Properties

# Properties

# batchNum

• Optional batchNum: number

批处理的条数（默认10000）.

# busyBatchSleepMs

• Optional busyBatchSleepMs: number

繁忙时一次批处理等待时间（默认10000ms）.

# idleBatchSleepMs

• Optional idleBatchSleepMs: number

空闲一次批处理等待时间（默认1ms）.

# isAllCancel

• Optional isAllCancel: boolean

是否取消所有的切片（正在切时有效）.

# iscancel

• Optional iscancel: boolean

是否取消对此图层的切片（正在切时有效）.

# ismvt

• ismvt: boolean | boolean[]

是否是矢量切片，如果否则为栅格瓦片切片. 如果为数组时，layer也必须是数组，一一对应

# layer

• layer: string | string[]

图层名称（为空时采用当前打开的地图图层名称).如果为数组时，表示对多个图层进行切片

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

# zoom

• zoom: number | number[]

级别（切的第几级）, 如果为数组时，layer也必须是数组，一一对应

vjmap / Exports / default / ITileUrlParam

# Interface: ITileUrlParam

default.ITileUrlParam

地图瓦片参数

# Table of contents

# Properties

# Properties

# fileid

• Optional fileid: string

文件唯一ID.

# layer

• Optional layer: string

图层名称.

# mapid

• Optional mapid: string

地图ID.

# version

• Optional version: string

版本号.

vjmap / Exports / default / IUpdateMapParam

# Interface: IUpdateMapParam

default.IUpdateMapParam

更新地图参数

# Hierarchy

# Table of contents

# Properties

# Properties

# accessKey

• Optional accessKey: string

访问权限的key，权限小于secretKey，不能对图进行删除等操作.

Inherited from: IOpenMapBaseParam.accessKey

# cadVersion

• Optional cadVersion: string

新建地图有fileDoc时有效

Inherited from: IOpenMapBaseParam.cadVersion

# cbInputPassword

• Optional cbInputPassword: (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }) => Promise<string>

要求输入密码回调.

# Type declaration

▸ (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }): Promise<string>

# Parameters
Name Type
param object
param.isPasswordError boolean
param.mapid string
param.result any
param.tryPasswordCount number

Returns: Promise<string>

Inherited from: IOpenMapBaseParam.cbInputPassword

# deleteOldVersion

• Optional deleteOldVersion: boolean

是否删除老版本(缺省: false ).

# filedoc

• Optional filedoc: string

文件文档.

Inherited from: IOpenMapBaseParam.filedoc

# fileid

• Optional fileid: string

文件唯一ID. 地图ID第一次打开时，需传递fileid

Inherited from: IOpenMapBaseParam.fileid

# filename

• Optional filename: string

文件名称.

Inherited from: IOpenMapBaseParam.filename

# fontReplaceRule

• Optional fontReplaceRule: string | Record<string, string>

字符替换规则. openMap返回的字段findFonts为系统查找的字体替换规则。如需修改默认的话，请传入替换的字体规则，如fontReplaceRule: {"tssdeng.shx_1": "default.ttc"}

Inherited from: IOpenMapBaseParam.fontReplaceRule

# imageLeft

• Optional imageLeft: number

图像左上角坐标x 第一次打开图像类型时有效

Inherited from: IOpenMapBaseParam.imageLeft

# imageResolution

• Optional imageResolution: number

图像分辨率 第一次打开图像类型时有效, 一个像素单位代表多少地理长度，计算公式为 真实坐标长度 / 图像像素宽

Inherited from: IOpenMapBaseParam.imageResolution

# imageTop

• Optional imageTop: number

图像左上角坐标y 第一次打开图像类型时有效

Inherited from: IOpenMapBaseParam.imageTop

# mapdependencies

• Optional mapdependencies: string

地图依赖项.

Inherited from: IOpenMapBaseParam.mapdependencies

# mapfrom

• Optional mapfrom: string

地图来源参数.

Inherited from: IOpenMapBaseParam.mapfrom

# mapid

• mapid: string

地图ID.

Inherited from: IOpenMapBaseParam.mapid

# mapopenway

• Optional mapopenway: Memory | GeomRender

地图打开方式(缺省: GeomRender) .

Inherited from: IOpenMapBaseParam.mapopenway

# notReplaceLineType

• Optional notReplaceLineType: boolean

不自动替换线型.

Inherited from: IOpenMapBaseParam.notReplaceLineType

# notUseDefaultShxFont

• Optional notUseDefaultShxFont: boolean

不使用缺省的型文字文件，将使用缺省的字体来代替型文件.

Inherited from: IOpenMapBaseParam.notUseDefaultShxFont

# notUseDefaultTtfFont

• Optional notUseDefaultTtfFont: boolean

不使用缺省的字体文件，将使用缺省的型文件来代替字体文件.

Inherited from: IOpenMapBaseParam.notUseDefaultTtfFont

# openFinishMaxTryCount

• Optional openFinishMaxTryCount: number

判断是否打开或更新成功重试最大次数。默认 120 次

Inherited from: IOpenMapBaseParam.openFinishMaxTryCount

# openFinishTryInterval

• Optional openFinishTryInterval: number

判断是否打开或更新成功重试间隔（秒）。默认 5s 一次

Inherited from: IOpenMapBaseParam.openFinishTryInterval

# renderAccuracy

• Optional renderAccuracy: number

渲染精度，默认1，有时候图形特别大导致圆或圆弧精度不够时,不够光滑，可以先清空之前的缓存数据，再重新上传时，改变渲染精度来使圆或圆弧光滑些。注：提高精度会导致空间数据文件增大，渲染性能下降

Inherited from: IOpenMapBaseParam.renderAccuracy

# secretKey

• Optional secretKey: string

秘钥(第一次上传打开图时有效，表示此图需要密码保护).

Inherited from: IOpenMapBaseParam.secretKey

# style

• Optional style: IMapStyleParam

样式.

Inherited from: IOpenMapBaseParam.style

# subdependencies

• Optional subdependencies: string

地图依赖项(这是子项的设置，与mapdependencies不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapdependencies一样的话，则为空

Inherited from: IOpenMapBaseParam.subdependencies

# subfrom

• Optional subfrom: string

地图来源参数(这是子项的设置，与mapfrom不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapfrom一样的话，则为空

Inherited from: IOpenMapBaseParam.subfrom

# uploadname

• Optional uploadname: string

上传时的文件名.

Inherited from: IOpenMapBaseParam.uploadname

vjmap / Exports / default / IUpdateStyle

# Interface: IUpdateStyle

default.IUpdateStyle

更新样式接口

# Table of contents

# Properties

# Properties

# backcolor

• Optional backcolor: number

颜色.

# clipbounds

• Optional clipbounds: number | [number, number, number, number]

地图裁剪范围，范围如[x1,y1,x2,y2].如果只有数字的话，表示是缩放系数

# expression

• Optional expression: string

表达式.

# layeroff

• Optional layeroff: string | number[]

要关的图层索引列表，格式如[2,4]. layeron与layeroff只要输入一个即可

# layeron

• Optional layeron: string | number[]

要开的图层索引列表，格式如[0,1,3].

# lineweight

• Optional lineweight: string | number[]

线宽，格式如[1，1，1，1，0].表式第1，2，3，4级线宽开，第5级线宽关，大于第5级的，以最后设置的级别状态为主，所以也是关。如为空，则和原图线宽显示状态相同

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# name

• Optional name: string

样式名称.

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

vjmap / Exports / default / IWmsTileUrl

# Interface: IWmsTileUrl

default.IWmsTileUrl

wms服务url地址接口

# Table of contents

# Properties

# Properties

# backgroundColor

• Optional backgroundColor: string

不透明时的背景颜色，默认为白色。格式必须为rgb(r,g,b)或rgba(r,g,b,a),a不透明应该是255.

# bbox

• Optional bbox: string

范围，缺省{bbox-epsg-3857}. (如果要获取地图cad一个范围的wms数据无需任何坐标转换，将此范围填cad范围,srs,crs,mapbounds填为空).

# crs

• Optional crs: string | string[]

cad图的坐标系，为空的时候由元数据坐标系决定. 也可直接输入proj4字符串

# fourParameter

• Optional fourParameter: string | string[]

四参数(x偏移,y偏移,缩放，旋转弧度)，可选，对坐标最后进行修正

# height

• Optional height: number

高.

# imageProcessAlg

• Optional imageProcessAlg: number

旋转时图像处理算法. 1或2,默认自动选择（旋转时有用）

# isInverseFourParamter

• Optional isInverseFourParamter: boolean | boolean[]

是否用上面的四参数进行反算，默认false

# layers

• Optional layers: string | string[]

图层名称（为空时采用当前打开的地图图层名称).

# mapbounds

• Optional mapbounds: string

地理真实范围，如有值时,srs将不起作用

# mapid

• Optional mapid: string | string[]

地图ID(为空时采用当前打开的mapid)， 为数组时表时同时请求多个.

# mvt

• Optional mvt: boolean

是否是矢量瓦片.

# srs

• Optional srs: string

当前坐标系,缺省(EPSG:3857).

# transparent

• Optional transparent: boolean

是否透明.

# useImageRotate

• Optional useImageRotate: boolean

是否考虑旋转，在不同坐标系中转换是需要考虑。默认自动考虑是否需要旋转.

# version

• Optional version: string | string[]

地图版本(为空时采用当前打开的地图版本).

# webMapType

• Optional webMapType: "WGS84" | "GCJ02" | "BD09LL" | "BD09MC"

当前互联网底图地图类型 WGS84(84坐标，如天地图，osm), GCJ02(火星坐标，如高德，腾讯地图)， BD09LL(百度经纬度坐标，如百度地图)， BD09MC(百度墨卡托米制坐标，如百度地图)

# width

• Optional width: number

宽.

vjmap / Exports / default / IWorkspace

# Interface: IWorkspace

default.IWorkspace

工作区（工作区主要用来对图纸进行分类管理。不同工作区的图纸存在的位置不同，查看不同工作区的图纸，需要切换到相应工作区才能查看）

# Table of contents

# Properties

# Properties

# alias

• Optional alias: string

工作区别名(可以是中文).

# isPublic

• Optional isPublic: boolean

是否公开（不公开的话，无法通过获取工作区功能来获取到此工作区信息）.

# name

• name: string

工作区名称(英文名称，不要有特殊字符，用于做为键值和路由).

# workDir

• Optional workDir: string

工作区目录，如果是相对于工作区路径的一个路径或绝对路径，如为空的话，则用工作区名称做为工作目录.

vjmap / Exports / default / KeyframeOptions

# Interface: KeyframeOptions<V>

default.KeyframeOptions

# Type parameters

Name Default
V number

# Table of contents

# Properties

# Properties

# duration

• Optional duration: number

# ease

• Optional ease: Easing | Easing[]

# from

• Optional from: V

# offset

• Optional offset: number[]

# to

• to: V | V[]

vjmap / Exports / default / LineGeoJsonInput

# Interface: LineGeoJsonInput

default.LineGeoJsonInput

# Table of contents

# Properties

# Properties

# points

• points: GeoPointLike[]

# properties

• Optional properties: object

vjmap / Exports / default / MarkerClusterData

# Interface: MarkerClusterData

default.MarkerClusterData

# Indexable

▪ [propName: string]: any

# Table of contents

# Properties

# Properties

# point

• point: GeoPointLike

# properties

• Optional properties: Record<string, any>

vjmap / Exports / default / MarkerClusterOptions

# Interface: MarkerClusterOptions

default.MarkerClusterOptions

# Table of contents

# Properties

# Properties

# allowOverlap

• Optional allowOverlap: boolean

是否允许重叠，默认false.

# allowOverlapMaxZoom

• Optional allowOverlapMaxZoom: number

允许重叠的最大缩放级别，小于或等于此级别才会处理重叠，超过此级时会全部显示当前所有的(如果不允许重叠时有效).默认4级

# cameraNearFront

• Optional cameraNearFront: boolean

离相机最近的在显示在前面，默认false.

# createMarker

• createMarker: (curMarkerData: MarkerClusterData, clusterMarkersData: MarkerClusterData[]) => Marker | Text

# Type declaration

▸ (curMarkerData: MarkerClusterData, clusterMarkersData: MarkerClusterData[]): Marker | Text

# Parameters
Name Type
curMarkerData MarkerClusterData
clusterMarkersData MarkerClusterData[]

Returns: Marker | Text

# data

• data: FeatureCollection<Geometry | GeometryCollection, Properties> | MarkerClusterData[]

数据内容.(传入坐标为CAD地理坐标)

# markerHeight

• Optional markerHeight: number

marker div的像素高，用于计算重叠时需要，默认40. 如果在data的properties设置了属性markerHeight，则以data设置的为准

# markerWidth

• Optional markerWidth: number

marker div的像素宽，用于计算重叠时需要，默认40. 如果在data的properties设置了属性markerWidth，则以data设置的为准

# updateMarker

• Optional updateMarker: (curMarkerData: MarkerClusterData, clusterMarkersData: MarkerClusterData[], marker: Marker) => undefined | Marker | Text

# Type declaration

▸ (curMarkerData: MarkerClusterData, clusterMarkersData: MarkerClusterData[], marker: Marker): undefined | Marker | Text

# Parameters
Name Type
curMarkerData MarkerClusterData
clusterMarkersData MarkerClusterData[]
marker Marker

Returns: undefined | Marker | Text

vjmap / Exports / default / markerOptions

# Interface: markerOptions

default.markerOptions

# Hierarchy

  • MarkerOptions

    ↳ markerOptions

# Table of contents

# Properties

# Properties

# height

• Optional height: number

高度值.

# lngLat

• Optional lngLat: [number, number] | LngLat | {} | {}

LngLat值.

# maxZoom

• Optional maxZoom: number

显示的最大级别.

# minZoom

• Optional minZoom: number

显示的最小级别.

# removeWhenNoInMapView

• Optional removeWhenNoInMapView: boolean

设置当marker不在当前地图视图范围内时，将自动移除。进入视图范围内时，将自动增加上

# removeWhenNoInMapViewPadding

• Optional removeWhenNoInMapViewPadding: boolean

设置当marker不在当前地图视图范围内时，将自动移除。范围向外扩的像素范围，默认500px，向视图范围往外扩些像素，在平移的时候，能看到marker，体验效果好些。

# scaleMaxZoom

• Optional scaleMaxZoom: number

设置能缩放的最大级别。如果小于这个级别，div将根据缩小级别自动缩小比例。默认不会自动缩放

vjmap / Exports / default / Math2D / UvBox

# Interface: UvBox

default.Math2D.UvBox

Box to store UV coordinates.

# Table of contents

# Properties

# Properties

# s0

• s0: number

# s1

• s1: number

# t0

• t0: number

# t1

• t1: number

vjmap / Exports / default / Methods

# Interface: Methods

default.Methods

# Table of contents

# Properties

# Properties

# DELETE

• DELETE: "DELETE"

# GET

• GET: "GET"

• HEAD: "HEAD"

# OPTIONS

• OPTIONS: "OPTIONS"

# PATCH

• PATCH: "PATCH"

# POST

• POST: "POST"

# PUT

• PUT: "PUT"

vjmap / Exports / default / MiniMapControlOption

# Interface: MiniMapControlOption

default.MiniMapControlOption

# Table of contents

# Properties

# Properties

# boxZoom

• Optional boxZoom: boolean

# center

• Optional center: [number, number]

# containerStyle

• Optional containerStyle: Partial<CSSStyleDeclaration>

# doubleClickZoom

• Optional doubleClickZoom: boolean

# dragPan

• Optional dragPan: boolean

# dragRotate

• Optional dragRotate: boolean

# fillColor

• Optional fillColor: string

# fillOpacity

• Optional fillOpacity: number

# height

• Optional height: string

# id

• Optional id: string

# keyboard

• Optional keyboard: boolean

# lineColor

• Optional lineColor: string

# lineOpacity

• Optional lineOpacity: number

# lineWidth

• Optional lineWidth: number

# maxBounds

• Optional maxBounds: LngLatBounds

# scrollZoom

• Optional scrollZoom: boolean

# style

• Optional style: string | Style

# touchZoomRotate

• Optional touchZoomRotate: boolean

# width

• Optional width: string

# zoom

• Optional zoom: number

# zoomAdjust

• Optional zoomAdjust: null

vjmap / Exports / default / MousePositionControlOption

# Interface: MousePositionControlOption

default.MousePositionControlOption

# Table of contents

# Properties

# Properties

# digits

• Optional digits: number

# labelFormat

• Optional labelFormat: (lng: number, lat: number, x: number, y: number, map?: Map) => string

# Type declaration

▸ (lng: number, lat: number, x: number, y: number, map?: Map): string

# Parameters
Name Type
lng number
lat number
x number
y number
map? Map

Returns: string

# projection

• Optional projection: Projection

# showBearing

• Optional showBearing: boolean

# showLatLng

• Optional showLatLng: boolean

# showPitch

• Optional showPitch: boolean

# showZoom

• Optional showZoom: boolean

# style

• Optional style: object

# Type declaration
Name Type
backgroundColor string
border string

# trackCenter

• Optional trackCenter: boolean

vjmap / Exports / default / OverlayLayerBaseOptions

# Interface: OverlayLayerBaseOptions

default.OverlayLayerBaseOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# filter

• Optional filter: any

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

# isHoverPointer

• Optional isHoverPointer: boolean

# layerId

• Optional layerId: string

# maxzoom

• Optional maxzoom: number

# minzoom

• Optional minzoom: number

# sourceId

• Optional sourceId: string

# sourceLayer

• Optional sourceLayer: string

# visibility

• Optional visibility: "visible" | "none"

vjmap / Exports / default / PhysicsSpringOptions

# Interface: PhysicsSpringOptions

default.PhysicsSpringOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# damping

• Optional damping: number

# mass

• Optional mass: number

# stiffness

• Optional stiffness: number

# velocity

• Optional velocity: number

vjmap / Exports / default / PlaybackControls

# Interface: PlaybackControls

default.PlaybackControls

# Table of contents

# Properties

# Properties

# stop

• stop: () => void

# Type declaration

▸ (): void

Returns: void

vjmap / Exports / default / PlaybackOptions

# Interface: PlaybackOptions<V>

default.PlaybackOptions

Playback options common to all animations.

# Type parameters

Name
V

# Table of contents

# Properties

# Properties

# autoplay

• Optional autoplay: boolean

Whether to autoplay the animation when animate is called. If set to false, the animation must be started manually via the returned play method.

# driver

• Optional driver: Driver

# elapsed

• Optional elapsed: number

# from

• Optional from: V

# onComplete

• Optional onComplete: () => void

# Type declaration

▸ (): void

Returns: void

# onPlay

• Optional onPlay: () => void

# Type declaration

▸ (): void

Returns: void

# onRepeat

• Optional onRepeat: () => void

# Type declaration

▸ (): void

Returns: void

# onStop

• Optional onStop: () => void

# Type declaration

▸ (): void

Returns: void

# onUpdate

• Optional onUpdate: (latest: V) => void

# Type declaration

▸ (latest: V): void

# Parameters
Name Type
latest V

Returns: void

# repeat

• Optional repeat: number

# repeatDelay

• Optional repeatDelay: number

# repeatType

• Optional repeatType: "loop" | "reverse" | "mirror"

# type

• Optional type: "spring" | "decay" | "keyframes"

vjmap / Exports / default / PointGeoJsonInput

# Interface: PointGeoJsonInput

default.PointGeoJsonInput

# Table of contents

# Properties

# Properties

# point

• point: GeoPointLike

# properties

• Optional properties: object

vjmap / Exports / default / PolygonOptions

# Interface: PolygonOptions

default.PolygonOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# data

• data: any

# fillAntialias

• Optional fillAntialias: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# fillColor

• Optional fillColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# fillOpacity

• Optional fillOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# fillOutlineColor

• Optional fillOutlineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# fillPattern

• Optional fillPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# fillSortKey

• Optional fillSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# fillTranslate

• Optional fillTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# fillTranslateAnchor

• Optional fillTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / default / PolylineArrowOptions

# Interface: PolylineArrowOptions

default.PolylineArrowOptions

# Table of contents

# Properties

# Properties

# animated

• Optional animated: boolean

# beforeId

• Optional beforeId: string

# borderBlur

• Optional borderBlur: number

# borderColor

• Optional borderColor: string

# borderGapWidth

• Optional borderGapWidth: number

# borderGradient

• Optional borderGradient: string

# borderMiterLimit

• Optional borderMiterLimit: number

# borderOffset

• Optional borderOffset: number

# borderOpacity

• Optional borderOpacity: number

# borderTranslateAnchor

• Optional borderTranslateAnchor: string

# borderWidth

• Optional borderWidth: number

# cursor

• Optional cursor: string

# dirIconColor

• Optional dirIconColor: string

# dirImageColor

• Optional dirImageColor: string

# dirImageHeight

• Optional dirImageHeight: number

# dirImageSrc

• Optional dirImageSrc: string

# dirImageWidth

• Optional dirImageWidth: number

# dirLayout

• Optional dirLayout: object

# dirSize

• Optional dirSize: number

# dirSpacing

• Optional dirSpacing: number

# lineBlur

• Optional lineBlur: number

# lineCap

• Optional lineCap: string

# lineColor

• Optional lineColor: string

# lineGapWidth

• Optional lineGapWidth: number

# lineGradient

• Optional lineGradient: string

# lineJoin

• Optional lineJoin: string

# lineMiterLimit

• Optional lineMiterLimit: number

# lineOffset

• Optional lineOffset: number

# lineOpacity

• Optional lineOpacity: number

# lineSortKey

• Optional lineSortKey: number

# lineTranslate

• Optional lineTranslate: number[]

# lineTranslateAnchor

• Optional lineTranslateAnchor: string

# lineWidth

• Optional lineWidth: number

# map

• Optional map: Map

# maxZoom

• Optional maxZoom: number

# minZoom

• Optional minZoom: number

# path

• Optional path: any

# showBorder

• Optional showBorder: boolean

# showDir

• Optional showDir: boolean

# strokeDasharray

• Optional strokeDasharray: number[]

# strokeImage

• Optional strokeImage: string

# strokeStyle

• Optional strokeStyle: string

# visible

• Optional visible: boolean

# zIndex

• Optional zIndex: number

vjmap / Exports / default / PolylineOptions

# Interface: PolylineOptions

default.PolylineOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# data

• data: any

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / default / Response

# Interface: Response

default.Response

# Table of contents

# Properties

# Properties

# data

• Optional data: string | Record<string, unknown>

# response

• response: Record<string, unknown>

# status

• status: number

# xhr

• xhr: XMLHttpRequest

vjmap / Exports / default / ScriptDefaultOptions

# Interface: ScriptDefaultOptions

default.ScriptDefaultOptions

# Table of contents

# Properties

# Properties

# async

• Optional async: boolean

# injectLocation

• Optional injectLocation: string

# src

• src: string

# strategy

• Optional strategy: string

vjmap / Exports / default / SkyLayerOptions

# Interface: SkyLayerOptions

default.SkyLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# skyAtmosphereColor

• Optional skyAtmosphereColor: string

# skyAtmosphereHaloColor

• Optional skyAtmosphereHaloColor: string

# skyAtmosphereSun

• Optional skyAtmosphereSun: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# skyAtmosphereSunIntensity

• Optional skyAtmosphereSunIntensity: number

# skyGradient

• Optional skyGradient: ExpressionSpecificationEx

# skyGradientCenter

• Optional skyGradientCenter: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# skyGradientRadius

• Optional skyGradientRadius: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# skyOpacity

• Optional skyOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# skyType

• Optional skyType: ExpressionSpecificationEx | "gradient" | "atmosphere" | { stops: [number, "gradient" | "atmosphere"][] ; type: "exponential" } | { stops: [number, "gradient" | "atmosphere"][] ; type: "interval" }

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / default / SpringOptions

# Interface: SpringOptions

default.SpringOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# bounce

• Optional bounce: number

# damping

• Optional damping: number

Inherited from: PhysicsSpringOptions.damping

# duration

• Optional duration: number

# from

• Optional from: number

# mass

• Optional mass: number

Inherited from: PhysicsSpringOptions.mass

# restDelta

• Optional restDelta: number

# restSpeed

• Optional restSpeed: number

# stiffness

• Optional stiffness: number

Inherited from: PhysicsSpringOptions.stiffness

# to

• Optional to: number

# velocity

• Optional velocity: number

Inherited from: PhysicsSpringOptions.velocity

vjmap / Exports / default / SvgElementOptions

# Interface: SvgElementOptions

default.SvgElementOptions

# Table of contents

# Properties

# Properties

# bounds

• Optional bounds: GeoBounds | [number, number, number, number]

元素地理范围，如果不填，会根据传入的坐标自动计算，但对于一些复杂的图形，需传入，

# event

• Optional event: (svgParentElement: SVGSVGElement) => {}

事件，在回调函数里，响应要处理的事件，每次更新图形会重新执行

# Type declaration

▸ (svgParentElement: SVGSVGElement): object

# Parameters
Name Type
svgParentElement SVGSVGElement

Returns: object

# hidden

• Optional hidden: boolean

是否不显示

# html

• html: string

元素字符串内容，地理坐标用来表示，长度用来代表

# id

• Optional id: string | number

id

# maxZoom

• Optional maxZoom: boolean

最大缩放级别

# minZoom

• Optional minZoom: number

最小缩放级别

vjmap / Exports / default / SvgOverlayOptions

# Interface: SvgOverlayOptions

default.SvgOverlayOptions

# Table of contents

# Properties

# Properties

# divClassName

• Optional divClassName: string

类名

# maxDivSize

• Optional maxDivSize: number

放大div时，最大的div大小，超过了就像素放大了

# maxPitch

• Optional maxPitch: number

显示最大倾斜角

# maxZoom

• Optional maxZoom: number

显示最小级别

# minZoom

• Optional minZoom: number

显示最大级别

# noUpdateBoundsWhenMoveend

• Optional noUpdateBoundsWhenMoveend: boolean

当移动结束时不自动更新范围

# svgMaxHeight

• Optional svgMaxHeight: number

svg初始化时最大像素高,默认1000

# svgMaxWidth

• Optional svgMaxWidth: number

svg初始化时最大像素宽,默认1000

# svgOffset

• Optional svgOffset: number

svg初始化时Offset像素距离,默认100

# updateDivSize

• Optional updateDivSize: boolean

自动更新div大小，（如果需要svg放大，需要设置为true)

vjmap / Exports / default / SymbolOptions

# Interface: SymbolOptions

default.SymbolOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# data

• data: any

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# iconAllowOverlap

• Optional iconAllowOverlap: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# iconAnchor

• Optional iconAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | ExpressionSpecificationEx | { stops: [number, Anchor][] ; type: "exponential" } | { stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [string | number | boolean, Anchor][] ; type: "categorical" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; type: "identity" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, Anchor][] ; type: "categorical" }

# iconColor

• Optional iconColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# iconHaloBlur

• Optional iconHaloBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# iconHaloColor

• Optional iconHaloColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# iconHaloWidth

• Optional iconHaloWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# iconIgnorePlacement

• Optional iconIgnorePlacement: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# iconImage

• Optional iconImage: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# iconKeepUpright

• Optional iconKeepUpright: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# iconOffset

• Optional iconOffset: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [string | number | boolean, [number, number]][] ; type: "categorical" } | { default?: [number, number] ; property: string ; type: "identity" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, [number, number]][] ; type: "categorical" }

# iconOpacity

• Optional iconOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# iconOptional

• Optional iconOptional: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# iconPadding

• Optional iconPadding: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# iconPitchAlignment

• Optional iconPitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

# iconRotate

• Optional iconRotate: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# iconRotationAlignment

• Optional iconRotationAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

# iconSize

• Optional iconSize: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# iconTextFit

• Optional iconTextFit: ExpressionSpecificationEx | "none" | "width" | "height" | "both" | { stops: [number, "none" | "width" | "height" | "both"][] ; type: "exponential" } | { stops: [number, "none" | "width" | "height" | "both"][] ; type: "interval" }

# iconTextFitPadding

• Optional iconTextFitPadding: [number, number, number, number] | ExpressionSpecificationEx | { stops: [number, [number, number, number, number]][] ; type: "exponential" } | { stops: [number, [number, number, number, number]][] ; type: "interval" }

# iconTranslate

• Optional iconTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# iconTranslateAnchor

• Optional iconTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# symbolAvoidEdges

• Optional symbolAvoidEdges: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# symbolPlacement

• Optional symbolPlacement: "line" | ExpressionSpecificationEx | "point" | "line-center" | { stops: [number, "line" | "point" | "line-center"][] ; type: "exponential" } | { stops: [number, "line" | "point" | "line-center"][] ; type: "interval" }

# symbolSortKey

• Optional symbolSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# symbolSpacing

• Optional symbolSpacing: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# symbolZOrder

• Optional symbolZOrder: "source" | ExpressionSpecificationEx | "auto" | "viewport-y" | { stops: [number, "source" | "auto" | "viewport-y"][] ; type: "exponential" } | { stops: [number, "source" | "auto" | "viewport-y"][] ; type: "interval" }

# textAllowOverlap

• Optional textAllowOverlap: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# textAnchor

• Optional textAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | ExpressionSpecificationEx | { stops: [number, Anchor][] ; type: "exponential" } | { stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [string | number | boolean, Anchor][] ; type: "categorical" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; type: "identity" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, Anchor][] ; type: "categorical" }

# textColor

• Optional textColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# textField

• Optional textField: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# textFont

• Optional textFont: string[] | ExpressionSpecificationEx | { stops: [number, string[]][] ; type: "exponential" } | { stops: [number, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [number, string[]][] ; type: "exponential" } | { default?: string[] ; property: string ; stops: [number, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [string | number | boolean, string[]][] ; type: "categorical" } | { default?: string[] ; property: string ; type: "identity" } | { default?: string[] ; property: string ; stops: [{ value: number ; zoom: number }, string[]][] ; type: "exponential" } | { default?: string[] ; property: string ; stops: [{ value: number ; zoom: number }, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string[]][] ; type: "categorical" }

# textHaloBlur

• Optional textHaloBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textHaloColor

• Optional textHaloColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# textHaloWidth

• Optional textHaloWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textIgnorePlacement

• Optional textIgnorePlacement: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# textJustify

• Optional textJustify: "center" | "left" | "right" | ExpressionSpecificationEx | "auto" | { stops: [number, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { stops: [number, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [number, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [number, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [string | number | boolean, "center" | "left" | "right" | "auto"][] ; type: "categorical" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; type: "identity" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: number ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: number ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "categorical" }

# textKeepUpright

• Optional textKeepUpright: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# textLetterSpacing

• Optional textLetterSpacing: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textLineHeight

• Optional textLineHeight: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textMaxAngle

• Optional textMaxAngle: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# textMaxWidth

• Optional textMaxWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textOffset

• Optional textOffset: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [string | number | boolean, [number, number]][] ; type: "categorical" } | { default?: [number, number] ; property: string ; type: "identity" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, [number, number]][] ; type: "categorical" }

# textOpacity

• Optional textOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textOptional

• Optional textOptional: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# textPadding

• Optional textPadding: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# textPitchAlignment

• Optional textPitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

# textRadialOffset

• Optional textRadialOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textRotate

• Optional textRotate: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textRotationAlignment

• Optional textRotationAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

# textSize

• Optional textSize: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textTransform

• Optional textTransform: ExpressionSpecificationEx | "none" | "uppercase" | "lowercase" | { stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [string | number | boolean, "none" | "uppercase" | "lowercase"][] ; type: "categorical" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; type: "identity" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: number ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: number ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "categorical" }

# textTranslate

• Optional textTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# textTranslateAnchor

• Optional textTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# textVariableAnchor

• Optional textVariableAnchor: ExpressionSpecificationEx | Anchor[] | { stops: [number, Anchor[]][] ; type: "exponential" } | { stops: [number, Anchor[]][] ; type: "interval" }

# textWritingMode

• Optional textWritingMode: ExpressionSpecificationEx | ("vertical" | "horizontal")[] | { stops: [number, ("vertical" | "horizontal")[]][] ; type: "exponential" } | { stops: [number, ("vertical" | "horizontal")[]][] ; type: "interval" }

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / default / TextOptions

# Interface: TextOptions

default.TextOptions

# Hierarchy

  • MarkerOptions

    ↳ TextOptions

# Table of contents

# Properties

# Properties

# style

• Optional style: object

文本样式.

# text

• Optional text: string

文本内容.

vjmap / Exports / default / ThreeJsContext

# Interface: ThreeJsContext

default.ThreeJsContext

# Table of contents

# Methods

# Methods

# Object3D

▸ Object3D(options: any): any

# Parameters
Name Type
options any

Returns: any

# add

▸ add(obj: any, layerId?: string, sourceId?: string): any

# Parameters
Name Type
obj any
layerId? string
sourceId? string

Returns: any

# clear

▸ clear(layerId?: string, dispose?: boolean): any

# Parameters
Name Type
layerId? string
dispose? boolean

Returns: any

# coneMesh

▸ coneMesh(co: GeoPoint, opts?: { animation?: boolean ; animationUpDown?: boolean ; color?: string | number ; height?: number ; obj3dOpts?: object ; size?: number }): any

创建一个四棱锥

# Parameters
Name Type
co GeoPoint
opts? object
opts.animation? boolean
opts.animationUpDown? boolean
opts.color? string | number
opts.height? number
opts.obj3dOpts? object
opts.size? number

Returns: any

# createSkyLayer

▸ createSkyLayer(): void

Returns: void

# createTerrainLayer

▸ createTerrainLayer(): void

Returns: void

# defaultLights

▸ defaultLights(): any

Returns: any

# dispose

▸ dispose(): any

Returns: any

# extrusion

▸ extrusion(options: any): any

# Parameters
Name Type
options any

Returns: any

# findParent3DObject

▸ findParent3DObject(mesh: any): any

# Parameters
Name Type
mesh any

Returns: any

# flyline

▸ flyline(opts: { color: string | number ; color2?: string | number ; count?: number ; height?: number ; opacity?: number ; range?: number ; size?: number ; source: GeoPoint ; speed?: number ; target: GeoPoint }): any

创建一条飞行线

# Parameters
Name Type
opts object
opts.color string | number
opts.color2? string | number
opts.count? number
opts.height? number
opts.opacity? number
opts.range? number
opts.size? number
opts.source GeoPoint
opts.speed? number
opts.target GeoPoint

Returns: any

# getFeatureCenter

▸ getFeatureCenter(feature: any, obj: any, level: number): any

# Parameters
Name Type
feature any
obj any
level number

Returns: any

# getObjectHeightOnFloor

▸ getObjectHeightOnFloor(coords: any, obj: any, level: number): any

# Parameters
Name Type
coords any
obj any
level number

Returns: any

# getSunPosition

▸ getSunPosition(date: any, coords: any): any

# Parameters
Name Type
date any
coords any

Returns: any

# getSunSky

▸ getSunSky(date: any, sunPos: any): any

# Parameters
Name Type
date any
sunPos any

Returns: any

# getSunTimes

▸ getSunTimes(date: any, coords: any): any

# Parameters
Name Type
date any
coords any

Returns: any

# getWorldSize

▸ getWorldSize(): number

threejs世界坐标总长度.

Returns: number

# label

▸ label(options: any): any

# Parameters
Name Type
options any

Returns: any

# line

▸ line(options: any): any

# Parameters
Name Type
options any

Returns: any

# loadTexture

▸ loadTexture(img: string, defaultImg?: string): any

加载材质，要使用base64图片，返回 THREE.Texture 对象.

# Parameters
Name Type
img string
defaultImg? string

Returns: any

# mapToWorld

▸ mapToWorld(coords: any): any

地图几何坐标转threejs世界坐标.

# Parameters
Name Type
coords any

Returns: any

# mapToWorldLength

▸ mapToWorldLength(coords: any): any

threejs世界坐标地转图几何坐标.

# Parameters
Name Type
coords any

Returns: any

▸ mapToWorldLength(len: number): number

地图几何长度转threejs世界坐标长度.

# Parameters
Name Type
len number

Returns: number

# memory

▸ memory(): any

Returns: any

# programs

▸ programs(): any

Returns: any

# projectToWorld

▸ projectToWorld(coords: any): any

# Parameters
Name Type
coords any

Returns: any

# projectedUnitsPerMeter

▸ projectedUnitsPerMeter(lat: any): any

# Parameters
Name Type
lat any

Returns: any

# queryRenderedFeatures

▸ queryRenderedFeatures(point: any): any

# Parameters
Name Type
point any

Returns: any

# radar

▸ radar(co: GeoPoint, opts?: { color1?: string | number ; color2?: string | number ; size?: number ; speed?: number ; texture1: string ; texture2: string }): any

创建一个扫描雷达

# Parameters
Name Type
co GeoPoint
opts? object
opts.color1? string | number
opts.color2? string | number
opts.size? number
opts.speed? number
opts.texture1 string
opts.texture2 string

Returns: any

# radialGradient

▸ radialGradient(co: GeoPoint, opts?: { color?: any ; size?: number ; speed?: number }): any

创建一个径向渐变球

# Parameters
Name Type
co GeoPoint
opts? object
opts.color? any
opts.size? number
opts.speed? number

Returns: any

# realSunlight

▸ realSunlight(helper?: boolean): any

# Parameters
Name Type
helper? boolean

Returns: any

# remove

▸ remove(obj: any): any

# Parameters
Name Type
obj any

Returns: any

# removeByName

▸ removeByName(name: string): any

# Parameters
Name Type
name string

Returns: any

# removeLayer

▸ removeLayer(layerId: string): any

# Parameters
Name Type
layerId string

Returns: any

# repaint

▸ repaint(): void

Returns: void

# setBuildingShadows

▸ setBuildingShadows(options: any): any

# Parameters
Name Type
options any

Returns: any

# setDefaultView

▸ setDefaultView(options: any, defOptions: any): any

# Parameters
Name Type
options any
defOptions any

Returns: any

# setLayerHeigthProperty

▸ setLayerHeigthProperty(layerId: string, level: number): any

# Parameters
Name Type
layerId string
level number

Returns: any

# setLayerZoomRange

▸ setLayerZoomRange(layerId: string, minZoomLayer: number, maxZoomLayer: number): any

# Parameters
Name Type
layerId string
minZoomLayer number
maxZoomLayer number

Returns: any

# setLayoutProperty

▸ setLayoutProperty(layerId: string, name: string, value: any): any

# Parameters
Name Type
layerId string
name string
value any

Returns: any

# setObjectsScale

▸ setObjectsScale(): any

Returns: any

# setStyle

▸ setStyle(styleId: string, options: any): any

# Parameters
Name Type
styleId string
options any

Returns: any

# setSunlight

▸ setSunlight(newDate: any, coords: any): any

# Parameters
Name Type
newDate any
coords any

Returns: any

# sphere

▸ sphere(options: any): any

# Parameters
Name Type
options any

Returns: any

# toggle

▸ toggle(layerId: string, visible?: boolean): any

# Parameters
Name Type
layerId string
visible? boolean

Returns: any

# toggleLayer

▸ toggleLayer(layerId: string, visible?: boolean): any

# Parameters
Name Type
layerId string
visible? boolean

Returns: any

# tooltip

▸ tooltip(options: any): any

# Parameters
Name Type
options any

Returns: any

# tube

▸ tube(options: any): any

# Parameters
Name Type
options any

Returns: any

# unprojectFromWorld

▸ unprojectFromWorld(v3: any): any

# Parameters
Name Type
v3 any

Returns: any

# update

▸ update(): any

Returns: any

# updateLightHelper

▸ updateLightHelper(): any

Returns: any

# updateSunGround

▸ updateSunGround(sunPos: any): any

# Parameters
Name Type
sunPos any

Returns: any

# updateSunSky

▸ updateSunSky(sunPos: any): any

# Parameters
Name Type
sunPos any

Returns: any

# wall

▸ wall(pts: GeoPoint[], opts?: { color1?: string | number ; color2?: string | number ; flyline?: boolean ; height?: number ; obj3dOpts?: object ; offsetX?: number ; offsetY?: number ; opacity?: number ; repeatX?: number ; repeatY?: number ; texture1?: string ; texture2?: string }): any

创建一个立体光墙

# Parameters
Name Type
pts GeoPoint[]
opts? object
opts.color1? string | number
opts.color2? string | number
opts.flyline? boolean
opts.height? number
opts.obj3dOpts? object
opts.offsetX? number
opts.offsetY? number
opts.opacity? number
opts.repeatX? number
opts.repeatY? number
opts.texture1? string
opts.texture2? string

Returns: any

# wave

▸ wave(co: GeoPoint, opts?: { color?: string | number ; size?: number ; speed?: number ; texture?: string }): any

创建一个波动光圈

# Parameters
Name Type
co GeoPoint
opts? object
opts.color? string | number
opts.size? number
opts.speed? number
opts.texture? string

Returns: any

# waveWall

▸ waveWall(co: GeoPoint, opts?: { color?: string | number ; height?: number ; opacity?: number ; size?: number ; speed?: number ; texture?: string }): any

创建一个波动光圈

# Parameters
Name Type
co GeoPoint
opts? object
opts.color? string | number
opts.height? number
opts.opacity? number
opts.size? number
opts.speed? number
opts.texture? string

Returns: any

# worldToMapLength

▸ worldToMapLength(len: number): number

threejs世界坐标长度转地图几何长度.

# Parameters
Name Type
len number

Returns: number

vjmap / Exports / default / ThreeJsContextOptions

# Interface: ThreeJsContextOptions

default.ThreeJsContextOptions

# Table of contents

# Properties

# Properties

# defaultLights

• Optional defaultLights: boolean

# enableDraggingObjects

• Optional enableDraggingObjects: boolean

# enableRotatingObjects

• Optional enableRotatingObjects: boolean

# enableSelectingFeatures

• Optional enableSelectingFeatures: boolean

# enableSelectingObjects

• Optional enableSelectingObjects: boolean

# enableTooltips

• Optional enableTooltips: boolean

# fov

• Optional fov: number

# multiLayer

• Optional multiLayer: boolean

# orthographic

• Optional orthographic: boolean

# passiveRendering

• Optional passiveRendering: boolean

# preserveDrawingBuffer

• Optional preserveDrawingBuffer: boolean

# realSunlight

• Optional realSunlight: boolean

# realSunlightHelper

• Optional realSunlightHelper: boolean

# sky

• Optional sky: boolean

# terrain

• Optional terrain: boolean

vjmap / Exports / default / ThreeLayerOptions

# Interface: ThreeLayerOptions

default.ThreeLayerOptions

# Table of contents

# Properties

# Properties

# context

• context: ThreeJsContext

# id

• Optional id: string

# onAdd

• Optional onAdd: (map: any, gl: any) => void

# Type declaration

▸ (map: any, gl: any): void

# Parameters
Name Type
map any
gl any

Returns: void

# onRemove

• Optional onRemove: () => void

# Type declaration

▸ (): void

Returns: void

# render

• Optional render: (gl: any, matrix: any) => void

# Type declaration

▸ (gl: any, matrix: any): void

# Parameters
Name Type
gl any
matrix any

Returns: void

vjmap / Exports / DivOverlayOptions

# Interface: DivOverlayOptions

# Table of contents

# Properties

# Properties

# bounds

• bounds: GeoBounds | [GeoPointLike, GeoPointLike, GeoPointLike, GeoPointLike]

范围，四个点坐标

# element

• element: HTMLElement

html元素

# height

• height: number

元素高

# maxDivSize

• Optional maxDivSize: number

放大div时，最大的div大小，超过了就像素放大了

# maxPitch

• Optional maxPitch: number

显示最大倾斜角

# maxZoom

• Optional maxZoom: number

显示最小级别

# minZoom

• Optional minZoom: number

显示最大级别

# updateDivSize

• Optional updateDivSize: boolean

自动更新div大小，（如果需要svg放大，需要设置为true)

# width

• width: number

元素宽

vjmap / Exports / DriverControls

# Interface: DriverControls

Drivers accept a update function and call it at an interval. This interval could be a synchronous loop, a setInterval, or tied to the device's framerate.

# Table of contents

# Properties

# Properties

# start

• start: () => void

# Type declaration

▸ (): void

Returns: void

# stop

• stop: () => void

# Type declaration

▸ (): void

Returns: void

vjmap / Exports / EllipseEdgeOptions

# Interface: EllipseEdgeOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# center

• center: GeoPointLike

中心点

# data

• data: any

Inherited from: PolylineOptions.data

# endAngle

• Optional endAngle: number

# filter

• Optional filter: any

Inherited from: PolylineOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: PolylineOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: PolylineOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: PolylineOptions.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineBlur

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

Inherited from: PolylineOptions.lineCap

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolylineOptions.lineColor

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

Inherited from: PolylineOptions.lineDasharray

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineGapWidth

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

Inherited from: PolylineOptions.lineGradient

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

Inherited from: PolylineOptions.lineJoin

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: PolylineOptions.lineMiterMimit

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineOffset

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineOpacity

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolylineOptions.linePattern

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: PolylineOptions.lineRoundLimit

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineSortKey

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: PolylineOptions.lineTranslate

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: PolylineOptions.lineTranslateAnchor

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolylineOptions.lineWidth

# majorAxisRadius

• majorAxisRadius: number

长轴半径

# maxzoom

• Optional maxzoom: number

Inherited from: PolylineOptions.maxzoom

# minorAxisRadius

• minorAxisRadius: number

短轴半径

# minzoom

• Optional minzoom: number

Inherited from: PolylineOptions.minzoom

# points

• Optional points: number

# properties

• Optional properties: object

属性数据

# sourceId

• Optional sourceId: string

Inherited from: PolylineOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: PolylineOptions.sourceLayer

# startAngle

• Optional startAngle: number

开始角度

# visibility

• Optional visibility: "visible" | "none"

Inherited from: PolylineOptions.visibility

vjmap / Exports / EllipseFillOptions

# Interface: EllipseFillOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# center

• center: GeoPointLike

中心点

# data

• data: any

Inherited from: PolygonOptions.data

# endAngle

• Optional endAngle: number

# fillAntialias

• Optional fillAntialias: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: PolygonOptions.fillAntialias

# fillColor

• Optional fillColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillColor

# fillOpacity

• Optional fillOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolygonOptions.fillOpacity

# fillOutlineColor

• Optional fillOutlineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillOutlineColor

# fillPattern

• Optional fillPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: PolygonOptions.fillPattern

# fillSortKey

• Optional fillSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: PolygonOptions.fillSortKey

# fillTranslate

• Optional fillTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: PolygonOptions.fillTranslate

# fillTranslateAnchor

• Optional fillTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: PolygonOptions.fillTranslateAnchor

# filter

• Optional filter: any

Inherited from: PolygonOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: PolygonOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: PolygonOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: PolygonOptions.layerId

# majorAxisRadius

• majorAxisRadius: number

长轴半径

# maxzoom

• Optional maxzoom: number

Inherited from: PolygonOptions.maxzoom

# minorAxisRadius

• minorAxisRadius: number

短轴半径

# minzoom

• Optional minzoom: number

Inherited from: PolygonOptions.minzoom

# points

• Optional points: number

# properties

• Optional properties: object

属性数据

# sourceId

• Optional sourceId: string

Inherited from: PolygonOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: PolygonOptions.sourceLayer

# startAngle

• Optional startAngle: number

开始角度

# visibility

• Optional visibility: "visible" | "none"

Inherited from: PolygonOptions.visibility

vjmap / Exports / Events

# Interface: Events

# Table of contents

# Properties

# Properties

# ABORT

• ABORT: "abort"

# ERROR

• ERROR: "error"

# LOAD

• LOAD: "load"

# LOAD_END

• LOAD_END: "loadend"

# LOAD_START

• LOAD_START: "loadstart"

# PROGRESS

• PROGRESS: "progress"

# READY_STATE_CHANGE

• READY_STATE_CHANGE: "readystatechange"

# TIMEOUT

• TIMEOUT: "timeout"

vjmap / Exports / FillExtrusionOptions

# Interface: FillExtrusionOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# data

• data: any

# fillExtrusionBase

• Optional fillExtrusionBase: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# fillExtrusionColor

• Optional fillExtrusionColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# fillExtrusionHeight

• Optional fillExtrusionHeight: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# fillExtrusionOpacity

• Optional fillExtrusionOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# fillExtrusionPattern

• Optional fillExtrusionPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# fillExtrusionTranslate

• Optional fillExtrusionTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# fillExtrusionTranslateAnchor

• Optional fillExtrusionTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# fillExtrusionVerticalGradient

• Optional fillExtrusionVerticalGradient: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / FrameAnimation

# Interface: FrameAnimation

property {Boolean} running - Getter that indicates if animation is running.

property {function():void} stop - Stops the animation.

property {function():void} start - Starts the animation.

# Table of contents

# Properties

# Properties

# changeFps

• changeFps: (fps: number) => void

一秒运行多少帧，用来控制速度

# Type declaration

▸ (fps: number): void

# Parameters
Name Type
fps number

Returns: void

# pause

• pause: () => void

pause the animation.

# Type declaration

▸ (): void

Returns: void

# running

• Readonly running: boolean

A getter property that indicates if animation is running.

# start

• start: () => void

Starts the animation.

# Type declaration

▸ (): void

Returns: void

# status

• Readonly status: FrameAnimationStatus

A getter property that indicates if animation is running.

# stop

• stop: () => void

Stops the animation.

# Type declaration

▸ (): void

Returns: void

vjmap / Exports / GridLayerLabelStyle

# Interface: GridLayerLabelStyle

# Table of contents

# Properties

# Properties

# textAnchor

• Optional textAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right"

字体基线

# textColor

• Optional textColor: string

字体颜色

# textFont

• Optional textFont: string[]

字体样式

# textHaloColor

• Optional textHaloColor: string

描边颜色

# textHaloWidth

• Optional textHaloWidth: number

描边宽度

# textSize

• Optional textSize: string

字体大小

vjmap / Exports / GridLayerOptions

# Interface: GridLayerOptions

# Table of contents

# Properties

# Properties

# extent

• Optional extent: LngLatBounds

坐标网格渲染的边界经纬度范围（[minx, miny, maxx, maxy]），默认为整个地图范围。

# interval

• Optional interval: number | Function

经纬度的间隔（以度为单位），可以是数字，也可以是函数，参数是map，默认10

# layerID

• Optional layerID: string

图层 ID。默认使用创建图层随机ID。

# maxZoom

• Optional maxZoom: number

该图层可见的最大视图缩放级别（含）

# minZoom

• Optional minZoom: number

最小视图缩放级别（不包括此级别），在该级别之上，该层将可见。

# opacity

• Optional opacity: number

画布不透明度。 默认1

# showLabel

• Optional showLabel: boolean

是否显示标签 默认true

# strokeStyle

• Optional strokeStyle: GridLayerStrokeStyle

绘制网络线的样式

# visible

• Optional visible: boolean

是否显示坐标网格 默认true

# xLabelDigit

• Optional xLabelDigit: number

x标签小数位数。默认2位

# xLabelFormatter

• Optional xLabelFormatter: Function

x标签转换函数

# xLabelStyle

• Optional xLabelStyle: GridLayerLabelStyle

x轴标签样式

# yLabelDigit

• Optional yLabelDigit: number

y标签小数位数。默认2位

# yLabelFormatter

• Optional yLabelFormatter: Function

y标签转换函数

# yLabelStyle

• Optional yLabelStyle: GridLayerLabelStyle

y轴标签样式

vjmap / Exports / GridLayerStrokeStyle

# Interface: GridLayerStrokeStyle

# Table of contents

# Properties

# Properties

# lindDasharray

• Optional lindDasharray: Function | number[]

虚线样式

# lineCap

• Optional lineCap: "butt" | "round" | "square"

线端点风格：butt, round, square

# lineColor

• Optional lineColor: string

线颜色

# lineDashOffset

• Optional lineDashOffset: number

虚线样式

# lineJoin

• Optional lineJoin: "round" | "bevel" | "miter"

线连接样式：bevel, round, miter

# lineWidth

• Optional lineWidth: number | Function

线宽

vjmap / Exports / HeatmapOptions

# Interface: HeatmapOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# data

• data: any

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# heatmapColor

• Optional heatmapColor: ExpressionSpecificationEx

# heatmapIntensity

• Optional heatmapIntensity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# heatmapOpacity

• Optional heatmapOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# heatmapRadius

• Optional heatmapRadius: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# heatmapWeight

• Optional heatmapWeight: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / IAnimateFillLayerOptions

# Interface: IAnimateFillLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

动画图集.

# fillAntialias

• Optional fillAntialias: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.fillAntialias

# fillColor

• Optional fillColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.fillColor

# fillOpacity

• Optional fillOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.fillOpacity

# fillOutlineColor

• Optional fillOutlineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.fillOutlineColor

# fillPattern

• Optional fillPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.fillPattern

# fillSortKey

• Optional fillSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.fillSortKey

# fillTranslate

• Optional fillTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: Omit.fillTranslate

# fillTranslateAnchor

• Optional fillTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: Omit.fillTranslateAnchor

# filter

• Optional filter: any

Inherited from: Omit.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: Omit.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: Omit.isHoverPointer

# layerBefore

• Optional layerBefore: string

创建的图层位于哪个图层之前.

# layerId

• Optional layerId: string

Inherited from: Omit.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: Omit.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: Omit.minzoom

# sourceId

• Optional sourceId: string

Inherited from: Omit.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: Omit.sourceLayer

# speed

• Optional speed: number

速度，默认1.

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

# visibility

• Optional visibility: "visible" | "none"

Inherited from: Omit.visibility

vjmap / Exports / IAnimateLineLayerOptions

# Interface: IAnimateLineLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number } | ImageBitmap)[]

动画图集.

# filter

• Optional filter: any

Inherited from: Omit.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: Omit.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: Omit.isHoverPointer

# layerBefore

• Optional layerBefore: string

创建的图层位于哪个图层之前.

# layerId

• Optional layerId: string

Inherited from: Omit.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineBlur

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

Inherited from: Omit.lineCap

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.lineColor

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

Inherited from: Omit.lineDasharray

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineGapWidth

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

Inherited from: Omit.lineGradient

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

Inherited from: Omit.lineJoin

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.lineMiterMimit

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineOffset

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineOpacity

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.linePattern

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.lineRoundLimit

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineSortKey

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: Omit.lineTranslate

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: Omit.lineTranslateAnchor

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.lineWidth

# maxzoom

• Optional maxzoom: number

Inherited from: Omit.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: Omit.minzoom

# sourceId

• Optional sourceId: string

Inherited from: Omit.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: Omit.sourceLayer

# speed

• Optional speed: number

速度，默认1.

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

# visibility

• Optional visibility: "visible" | "none"

Inherited from: Omit.visibility

vjmap / Exports / IAnimateSymbolLayerOptions

# Interface: IAnimateSymbolLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

动画图集.

# filter

• Optional filter: any

Inherited from: Omit.filter

# iconAllowOverlap

• Optional iconAllowOverlap: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.iconAllowOverlap

# iconAnchor

• Optional iconAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | ExpressionSpecificationEx | { stops: [number, Anchor][] ; type: "exponential" } | { stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [string | number | boolean, Anchor][] ; type: "categorical" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; type: "identity" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, Anchor][] ; type: "categorical" }

Inherited from: Omit.iconAnchor

# iconColor

• Optional iconColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.iconColor

# iconHaloBlur

• Optional iconHaloBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.iconHaloBlur

# iconHaloColor

• Optional iconHaloColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.iconHaloColor

# iconHaloWidth

• Optional iconHaloWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.iconHaloWidth

# iconIgnorePlacement

• Optional iconIgnorePlacement: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.iconIgnorePlacement

# iconImage

• Optional iconImage: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.iconImage

# iconKeepUpright

• Optional iconKeepUpright: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.iconKeepUpright

# iconOffset

• Optional iconOffset: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [string | number | boolean, [number, number]][] ; type: "categorical" } | { default?: [number, number] ; property: string ; type: "identity" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, [number, number]][] ; type: "categorical" }

Inherited from: Omit.iconOffset

# iconOpacity

• Optional iconOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.iconOpacity

# iconOptional

• Optional iconOptional: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.iconOptional

# iconPadding

• Optional iconPadding: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.iconPadding

# iconPitchAlignment

• Optional iconPitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

Inherited from: Omit.iconPitchAlignment

# iconRotate

• Optional iconRotate: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.iconRotate

# iconRotationAlignment

• Optional iconRotationAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

Inherited from: Omit.iconRotationAlignment

# iconSize

• Optional iconSize: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.iconSize

# iconTextFit

• Optional iconTextFit: ExpressionSpecificationEx | "none" | "width" | "height" | "both" | { stops: [number, "none" | "width" | "height" | "both"][] ; type: "exponential" } | { stops: [number, "none" | "width" | "height" | "both"][] ; type: "interval" }

Inherited from: Omit.iconTextFit

# iconTextFitPadding

• Optional iconTextFitPadding: [number, number, number, number] | ExpressionSpecificationEx | { stops: [number, [number, number, number, number]][] ; type: "exponential" } | { stops: [number, [number, number, number, number]][] ; type: "interval" }

Inherited from: Omit.iconTextFitPadding

# iconTranslate

• Optional iconTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: Omit.iconTranslate

# iconTranslateAnchor

• Optional iconTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: Omit.iconTranslateAnchor

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: Omit.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: Omit.isHoverPointer

# layerBefore

• Optional layerBefore: string

创建的图层位于哪个图层之前.

# layerId

• Optional layerId: string

Inherited from: Omit.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: Omit.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: Omit.minzoom

# sourceId

• Optional sourceId: string

Inherited from: Omit.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: Omit.sourceLayer

# speed

• Optional speed: number

速度，默认1.

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

# symbolAvoidEdges

• Optional symbolAvoidEdges: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.symbolAvoidEdges

# symbolPlacement

• Optional symbolPlacement: "line" | ExpressionSpecificationEx | "point" | "line-center" | { stops: [number, "line" | "point" | "line-center"][] ; type: "exponential" } | { stops: [number, "line" | "point" | "line-center"][] ; type: "interval" }

Inherited from: Omit.symbolPlacement

# symbolSortKey

• Optional symbolSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.symbolSortKey

# symbolSpacing

• Optional symbolSpacing: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.symbolSpacing

# symbolZOrder

• Optional symbolZOrder: "source" | ExpressionSpecificationEx | "auto" | "viewport-y" | { stops: [number, "source" | "auto" | "viewport-y"][] ; type: "exponential" } | { stops: [number, "source" | "auto" | "viewport-y"][] ; type: "interval" }

Inherited from: Omit.symbolZOrder

# textAllowOverlap

• Optional textAllowOverlap: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.textAllowOverlap

# textAnchor

• Optional textAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | ExpressionSpecificationEx | { stops: [number, Anchor][] ; type: "exponential" } | { stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [string | number | boolean, Anchor][] ; type: "categorical" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; type: "identity" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, Anchor][] ; type: "categorical" }

Inherited from: Omit.textAnchor

# textColor

• Optional textColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.textColor

# textField

• Optional textField: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.textField

# textFont

• Optional textFont: string[] | ExpressionSpecificationEx | { stops: [number, string[]][] ; type: "exponential" } | { stops: [number, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [number, string[]][] ; type: "exponential" } | { default?: string[] ; property: string ; stops: [number, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [string | number | boolean, string[]][] ; type: "categorical" } | { default?: string[] ; property: string ; type: "identity" } | { default?: string[] ; property: string ; stops: [{ value: number ; zoom: number }, string[]][] ; type: "exponential" } | { default?: string[] ; property: string ; stops: [{ value: number ; zoom: number }, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string[]][] ; type: "categorical" }

Inherited from: Omit.textFont

# textHaloBlur

• Optional textHaloBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textHaloBlur

# textHaloColor

• Optional textHaloColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: Omit.textHaloColor

# textHaloWidth

• Optional textHaloWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textHaloWidth

# textIgnorePlacement

• Optional textIgnorePlacement: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.textIgnorePlacement

# textJustify

• Optional textJustify: "center" | "left" | "right" | ExpressionSpecificationEx | "auto" | { stops: [number, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { stops: [number, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [number, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [number, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [string | number | boolean, "center" | "left" | "right" | "auto"][] ; type: "categorical" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; type: "identity" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: number ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: number ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "categorical" }

Inherited from: Omit.textJustify

# textKeepUpright

• Optional textKeepUpright: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.textKeepUpright

# textLetterSpacing

• Optional textLetterSpacing: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textLetterSpacing

# textLineHeight

• Optional textLineHeight: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textLineHeight

# textMaxAngle

• Optional textMaxAngle: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.textMaxAngle

# textMaxWidth

• Optional textMaxWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textMaxWidth

# textOffset

• Optional textOffset: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [string | number | boolean, [number, number]][] ; type: "categorical" } | { default?: [number, number] ; property: string ; type: "identity" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, [number, number]][] ; type: "categorical" }

Inherited from: Omit.textOffset

# textOpacity

• Optional textOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textOpacity

# textOptional

• Optional textOptional: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

Inherited from: Omit.textOptional

# textPadding

• Optional textPadding: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: Omit.textPadding

# textPitchAlignment

• Optional textPitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

Inherited from: Omit.textPitchAlignment

# textRadialOffset

• Optional textRadialOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textRadialOffset

# textRotate

• Optional textRotate: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textRotate

# textRotationAlignment

• Optional textRotationAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

Inherited from: Omit.textRotationAlignment

# textSize

• Optional textSize: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: Omit.textSize

# textTransform

• Optional textTransform: ExpressionSpecificationEx | "none" | "uppercase" | "lowercase" | { stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [string | number | boolean, "none" | "uppercase" | "lowercase"][] ; type: "categorical" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; type: "identity" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: number ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: number ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "categorical" }

Inherited from: Omit.textTransform

# textTranslate

• Optional textTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: Omit.textTranslate

# textTranslateAnchor

• Optional textTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: Omit.textTranslateAnchor

# textVariableAnchor

• Optional textVariableAnchor: ExpressionSpecificationEx | Anchor[] | { stops: [number, Anchor[]][] ; type: "exponential" } | { stops: [number, Anchor[]][] ; type: "interval" }

Inherited from: Omit.textVariableAnchor

# textWritingMode

• Optional textWritingMode: ExpressionSpecificationEx | ("vertical" | "horizontal")[] | { stops: [number, ("vertical" | "horizontal")[]][] ; type: "exponential" } | { stops: [number, ("vertical" | "horizontal")[]][] ; type: "interval" }

Inherited from: Omit.textWritingMode

# visibility

• Optional visibility: "visible" | "none"

Inherited from: Omit.visibility

vjmap / Exports / IAnimateVectorLayerOptions

# Interface: IAnimateVectorLayerOptions

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

动画图集.

# speed

• Optional speed: number

速度，默认1.

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

vjmap / Exports / IAnimateVectorLayerResult

# Interface: IAnimateVectorLayerResult

# Table of contents

# Properties

# Properties

# remove

• remove: () => void

移除.

# Type declaration

▸ (): void

Returns: void

# setSpeed

• setSpeed: (speed: number) => void

设置速度.

# Type declaration

▸ (speed: number): void

# Parameters
Name Type
speed number

Returns: void

# startAnimation

• startAnimation: () => void

开始动画函数.

# Type declaration

▸ (): void

Returns: void

# stopAnimation

• stopAnimation: () => void

结束动画函数.

# Type declaration

▸ (): void

Returns: void

# updateImages

• updateImages: (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]) => void

更新动画图片集.

# Type declaration

▸ (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]): void

# Parameters
Name Type
images (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

Returns: void

vjmap / Exports / IComposeNewMap

# Interface: IComposeNewMap

组合新地图参数

# Table of contents

# Properties

# Properties

# cadVersion

• Optional cadVersion: string

导出的CAD版本号。如果为*表示为当前CAD图的版本

# clipbounds

• Optional clipbounds: [number, number, number, number]

地图裁剪范围，范围如[x1,y1,x2,y2]， 为空的话，表示不裁剪

# fourParameter

• Optional fourParameter: [number, number, number, number]

四参数(x偏移,y偏移,缩放，旋转弧度)，可选，对坐标最后进行修正

# isInverseFourParamter

• Optional isInverseFourParamter: boolean

是否用上面的四参数进行反算，默认false

# isRenameBlockNameIfExist

• Optional isRenameBlockNameIfExist: boolean

来源于其他图的实体时，如果块定义重复，则自动重命名 ，默认true

# layerPrefix

• Optional layerPrefix: string

生新成图的图层名称前缀，如果设置为null将不会有默认的图层前缀。如果没有前缀，不同的图有图层重名时，如果设置了随层属性有可能会导致绘制的不一样

# layerSuffix

• Optional layerSuffix: string

生新成图的图层名称后缀

# layers

• Optional layers: string[]

要显示的图层名称，为空的时候，表示全部图层

# mapid

• mapid: string

地图ID.

# purge

• Optional purge: boolean

生成后清理图形数据以减少dwg文件大小

# savefilename

• Optional savefilename: string

保存的文件名称，为空的时候，自根据参数自动生成

# selByCrossing

• Optional selByCrossing: boolean

选择是包含还是相交（默认false表示包含，true相交）

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

vjmap / Exports / IConditionQueryFeatures

# Interface: IConditionQueryFeatures

条件查询实体参数

# Hierarchy

# Table of contents

# Properties

# Properties

# beginpos

• Optional beginpos: number

记录开始位置.

# bounds

• Optional bounds: [number, number, number, number]

范围.

# condition

• condition: string

条件.

# fields

• Optional fields: string

是返回的字段列表，多个之是用逗号,分开,如. "name,objectid"

Inherited from: IQueryBaseFeatures.fields

# geom

• Optional geom: boolean

是否为几何图形查询.

Inherited from: IQueryBaseFeatures.geom

# includegeom

• Optional includegeom: boolean

是否返回几何数据,为了性能问题，realgeom为false时，如果返回条数大于1.只会返回每个实体的外包矩形，如果条数为1的话，会返回此实体的真实geojson；realgeom为true时每条都会返回实体的geojson

# isContains

• Optional isContains: boolean

是否为包含关系, true为包含关系,false为相交关系，默认false. (传入了bounds进行范围查询时有效)

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称).

Inherited from: IQueryBaseFeatures.layer

# limit

• Optional limit: number

返回最多的记录条数.

Inherited from: IQueryBaseFeatures.limit

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

Inherited from: IQueryBaseFeatures.mapid

# realgeom

• Optional realgeom: boolean

是否返回真实实体几何geojson.与 includegeom参数，结合使用。参考includegeom的用法

# simplifyTolerance

• Optional simplifyTolerance: boolean

GeoJSON几何数据简化墨托卡距离，默认为零，不简化。例如允许10级别以上一个像素级别的误差，可用 map.pixelToGeoLength(1, 10) * vjmap.Projection.EQUATORIAL_SEMIPERIMETER * 2 / map.getGeoBounds(1.0).width()

Inherited from: IQueryBaseFeatures.simplifyTolerance

# toMapCoordinate

• Optional toMapCoordinate: boolean

查询返回的坐标默认为墨卡托坐标，返回会程序会自动转化为cad坐标，如果要直接返回cad地图坐标，需要把toMapCoordinate设置为true.

Inherited from: IQueryBaseFeatures.toMapCoordinate

# useCache

• Optional useCache: boolean

启动cache(内存打开的图形有效).

Inherited from: IQueryBaseFeatures.useCache

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

Inherited from: IQueryBaseFeatures.version

# zoom

• Optional zoom: number

当前级别.

Inherited from: IQueryBaseFeatures.zoom

vjmap / Exports / ICreateAnimateImagesFromImageOptions

# Interface: ICreateAnimateImagesFromImageOptions

# Indexable

▪ [key: string]: any

其他数据.

# Table of contents

# Properties

# Properties

# canvasHeight

• Optional canvasHeight: number

画片高(2的n次幂，如2,4,8, 16, 32....).默认32

# canvasWidth

• Optional canvasWidth: number

画片宽(2的n次幂，如2,4,8, 16, 32....).默认64

# from

• Optional from: number

生成的动画图片集中从第几个开始，默认0.

# fromImage

• Optional fromImage: HTMLImageElement

来源图片.

# spriteHeight

• Optional spriteHeight: number

来源图片中精灵图所占高.

# spriteWidth

• Optional spriteWidth: number

来源图片中精灵图所占宽.

# to

• Optional to: number

生成的动画图片集中到第几个结束，默认数组最后一个..

vjmap / Exports / ICreateAnimateImagesOptions

# Interface: ICreateAnimateImagesOptions

# Indexable

▪ [key: string]: any

其他数据.

# Table of contents

# Properties

# Properties

# canvasHeight

• Optional canvasHeight: number

画片高(2的n次幂，如2,4,8, 16, 32....).默认32

# canvasWidth

• Optional canvasWidth: number

画片宽(2的n次幂，如2,4,8, 16, 32....).默认64

# directionReverse

• Optional directionReverse: boolean

方向是否反向.

# draw

• Optional draw: (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions) => void

绘制内容回调(此函数只需绘制第一帧，其作帧图片会根据移动方向和帧数自动计算出来).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
opts ICreateAnimateImagesOptions

Returns: void

# drawFrame

• Optional drawFrame: (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions) => void

每帧内容回调(此函数每帧都会调用，需要根据不同的帧数生成不同的图片，与上面的draw冲突，如果设置了drawFrame，则上面的draw函数无效).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
frameCount number
curFrameIndex number
opts ICreateAnimateImagesOptions

Returns: void

# frameCount

• Optional frameCount: number

要生成的动画图片帧的个数.默认2

# from

• Optional from: number

生成的动画图片集中从第几个开始，默认0.

# fromImage

• Optional fromImage: HTMLImageElement

来源图片.

# spriteHeight

• Optional spriteHeight: number

来源图片中精灵图所占高.

# spriteWidth

• Optional spriteWidth: number

来源图片中精灵图所占宽.

# to

• Optional to: number

生成的动画图片集中到第几个结束，默认数组最后一个..

# yAxis

• Optional yAxis: boolean

是否y方向生成动画图片集.

vjmap / Exports / ICreateAnimateLayerResult

# Interface: ICreateAnimateLayerResult

# Table of contents

# Properties

# Properties

# createAnimateImages

• createAnimateImages: (options: ICreateAnimateImagesOptions) => ImageData[]

创建动画图片集.

# Type declaration

▸ (options: ICreateAnimateImagesOptions): ImageData[]

# Parameters
Name Type
options ICreateAnimateImagesOptions

Returns: ImageData[]

# layerId

• layerId: string

图层ID.

# remove

• remove: () => void

移除.

# Type declaration

▸ (): void

Returns: void

# setSpeed

• setSpeed: (speed: number) => void

设置速度.

# Type declaration

▸ (speed: number): void

# Parameters
Name Type
speed number

Returns: void

# sourceId

• sourceId: string

数据源ID.

# startAnimation

• startAnimation: () => void

开始动画函数.

# Type declaration

▸ (): void

Returns: void

# stopAnimation

• stopAnimation: () => void

结束动画函数.

# Type declaration

▸ (): void

Returns: void

# updateData

• updateData: (input: any) => void

更新数据.

# Type declaration

▸ (input: any): void

# Parameters
Name Type
input any

Returns: void

# updateImages

• updateImages: (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]) => void

更新动画图片集.

# Type declaration

▸ (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]): void

# Parameters
Name Type
images (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

Returns: void

vjmap / Exports / ICreateAntPathAnimateLineLayerOptions

# Interface: ICreateAntPathAnimateLineLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number } | ImageBitmap)[]

动画图集.

Inherited from: IAnimateLineLayerOptions.animateImages

# canvasHeight

• Optional canvasHeight: number

画片高(2的n次幂，如2,4,8, 16, 32....).默认32

Inherited from: ICreateAnimateImagesOptions.canvasHeight

# canvasWidth

• Optional canvasWidth: number

画片宽(2的n次幂，如2,4,8, 16, 32....).默认64

Inherited from: ICreateAnimateImagesOptions.canvasWidth

# directionReverse

• Optional directionReverse: boolean

方向是否反向.

Inherited from: ICreateAnimateImagesOptions.directionReverse

# draw

• Optional draw: (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions) => void

绘制内容回调(此函数只需绘制第一帧，其作帧图片会根据移动方向和帧数自动计算出来).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
opts ICreateAnimateImagesOptions

Returns: void

Inherited from: ICreateAnimateImagesOptions.draw

# drawFrame

• Optional drawFrame: (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions) => void

每帧内容回调(此函数每帧都会调用，需要根据不同的帧数生成不同的图片，与上面的draw冲突，如果设置了drawFrame，则上面的draw函数无效).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
frameCount number
curFrameIndex number
opts ICreateAnimateImagesOptions

Returns: void

Inherited from: ICreateAnimateImagesOptions.drawFrame

# fillColor1

• Optional fillColor1: string | CanvasGradient | CanvasPattern

填充背景颜色1.

# fillColor2

• Optional fillColor2: string | CanvasGradient | CanvasPattern

填充背景颜色1.

# filter

• Optional filter: any

Inherited from: IAnimateLineLayerOptions.filter

# frameCount

• Optional frameCount: number

要生成的动画图片帧的个数.默认2

Inherited from: ICreateAnimateImagesOptions.frameCount

# from

• Optional from: number

生成的动画图片集中从第几个开始，默认0.

Inherited from: ICreateAnimateImagesOptions.from

# fromImage

• Optional fromImage: HTMLImageElement

来源图片.

Inherited from: ICreateAnimateImagesOptions.fromImage

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: IAnimateLineLayerOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: IAnimateLineLayerOptions.isHoverPointer

# layerBefore

• Optional layerBefore: string

创建的图层位于哪个图层之前.

Inherited from: IAnimateLineLayerOptions.layerBefore

# layerId

• Optional layerId: string

Inherited from: IAnimateLineLayerOptions.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineBlur

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineCap

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineColor

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineDasharray

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineGapWidth

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

Inherited from: IAnimateLineLayerOptions.lineGradient

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineJoin

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineMiterMimit

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineOffset

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineOpacity

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.linePattern

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineRoundLimit

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineSortKey

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineTranslate

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineTranslateAnchor

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineWidth

# maxzoom

• Optional maxzoom: number

Inherited from: IAnimateLineLayerOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: IAnimateLineLayerOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: IAnimateLineLayerOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: IAnimateLineLayerOptions.sourceLayer

# speed

• Optional speed: number

速度，默认1.

Inherited from: IAnimateLineLayerOptions.speed

# spriteHeight

• Optional spriteHeight: number

来源图片中精灵图所占高.

Inherited from: ICreateAnimateImagesOptions.spriteHeight

# spriteWidth

• Optional spriteWidth: number

来源图片中精灵图所占宽.

Inherited from: ICreateAnimateImagesOptions.spriteWidth

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

Inherited from: IAnimateLineLayerOptions.startAutoAnimation

# to

• Optional to: number

生成的动画图片集中到第几个结束，默认数组最后一个..

Inherited from: ICreateAnimateImagesOptions.to

# visibility

• Optional visibility: "visible" | "none"

Inherited from: IAnimateLineLayerOptions.visibility

# yAxis

• Optional yAxis: boolean

是否y方向生成动画图片集.

Inherited from: ICreateAnimateImagesOptions.yAxis

vjmap / Exports / ICreateArrowAnimateLineLayerOptions

# Interface: ICreateArrowAnimateLineLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# animateImages

• Optional animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number } | ImageBitmap)[]

动画图集.

Inherited from: IAnimateLineLayerOptions.animateImages

# arrowFillColor

• Optional arrowFillColor: string | CanvasGradient | CanvasPattern

箭头填充背景颜色.

# arrowStrokeColor

• Optional arrowStrokeColor: string | CanvasGradient | CanvasPattern

箭头颜色.

# arrowStrokeWidth

• Optional arrowStrokeWidth: number

箭头线宽.

# arrowWidth

• Optional arrowWidth: number

箭头宽(默认为画布的一半).

# canvasHeight

• Optional canvasHeight: number

画片高(2的n次幂，如2,4,8, 16, 32....).默认32

Inherited from: ICreateAnimateImagesOptions.canvasHeight

# canvasWidth

• Optional canvasWidth: number

画片宽(2的n次幂，如2,4,8, 16, 32....).默认64

Inherited from: ICreateAnimateImagesOptions.canvasWidth

# directionReverse

• Optional directionReverse: boolean

方向是否反向.

Inherited from: ICreateAnimateImagesOptions.directionReverse

# draw

• Optional draw: (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions) => void

绘制内容回调(此函数只需绘制第一帧，其作帧图片会根据移动方向和帧数自动计算出来).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
opts ICreateAnimateImagesOptions

Returns: void

Inherited from: ICreateAnimateImagesOptions.draw

# drawFrame

• Optional drawFrame: (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions) => void

每帧内容回调(此函数每帧都会调用，需要根据不同的帧数生成不同的图片，与上面的draw冲突，如果设置了drawFrame，则上面的draw函数无效).

# Type declaration

▸ (context: CanvasRenderingContext2D, width: number, height: number, frameCount: number, curFrameIndex: number, opts: ICreateAnimateImagesOptions): void

# Parameters
Name Type
context CanvasRenderingContext2D
width number
height number
frameCount number
curFrameIndex number
opts ICreateAnimateImagesOptions

Returns: void

Inherited from: ICreateAnimateImagesOptions.drawFrame

# filter

• Optional filter: any

Inherited from: IAnimateLineLayerOptions.filter

# frameCount

• Optional frameCount: number

要生成的动画图片帧的个数.默认2

Inherited from: ICreateAnimateImagesOptions.frameCount

# from

• Optional from: number

生成的动画图片集中从第几个开始，默认0.

Inherited from: ICreateAnimateImagesOptions.from

# fromImage

• Optional fromImage: HTMLImageElement

来源图片.

Inherited from: ICreateAnimateImagesOptions.fromImage

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: IAnimateLineLayerOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: IAnimateLineLayerOptions.isHoverPointer

# layerBefore

• Optional layerBefore: string

创建的图层位于哪个图层之前.

Inherited from: IAnimateLineLayerOptions.layerBefore

# layerId

• Optional layerId: string

Inherited from: IAnimateLineLayerOptions.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineBlur

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineCap

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineColor

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineDasharray

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineGapWidth

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

Inherited from: IAnimateLineLayerOptions.lineGradient

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineJoin

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineMiterMimit

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineOffset

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineOpacity

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.linePattern

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineRoundLimit

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineSortKey

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineTranslate

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

Inherited from: IAnimateLineLayerOptions.lineTranslateAnchor

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

Inherited from: IAnimateLineLayerOptions.lineWidth

# maxzoom

• Optional maxzoom: number

Inherited from: IAnimateLineLayerOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: IAnimateLineLayerOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: IAnimateLineLayerOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: IAnimateLineLayerOptions.sourceLayer

# speed

• Optional speed: number

速度，默认1.

Inherited from: IAnimateLineLayerOptions.speed

# spriteHeight

• Optional spriteHeight: number

来源图片中精灵图所占高.

Inherited from: ICreateAnimateImagesOptions.spriteHeight

# spriteWidth

• Optional spriteWidth: number

来源图片中精灵图所占宽.

Inherited from: ICreateAnimateImagesOptions.spriteWidth

# startAutoAnimation

• Optional startAutoAnimation: boolean

开始时自动动画，默认true.

Inherited from: IAnimateLineLayerOptions.startAutoAnimation

# to

• Optional to: number

生成的动画图片集中到第几个结束，默认数组最后一个..

Inherited from: ICreateAnimateImagesOptions.to

# visibility

• Optional visibility: "visible" | "none"

Inherited from: IAnimateLineLayerOptions.visibility

# yAxis

• Optional yAxis: boolean

是否y方向生成动画图片集.

Inherited from: ICreateAnimateImagesOptions.yAxis

vjmap / Exports / ICreateEntitiesGeomData

# Interface: ICreateEntitiesGeomData

获取创建实体的几何数据

# Table of contents

# Properties

# Properties

# excludeAttribute

• Optional excludeAttribute: boolean

返回的数据中排除属性数据( 默认true)

# filedoc

• filedoc: string

文件文档.

# mapBounds

• Optional mapBounds: [number, number, number, number]

图形范围.如果不填的话，则使用全图范围

# renderAccuracy

• Optional renderAccuracy: number

渲染精度，默认1，有时候图形特别大导致圆或圆弧精度不够时,不够光滑，可以先清空之前的缓存数据，再重新上传时，改变渲染精度来使圆或圆弧光滑些。注：提高精度会导致空间数据文件增大，渲染性能下降

# useZip

• Optional useZip: boolean

返回的数据是否启用zip压缩( 默认true)

vjmap / Exports / ICreateFillAnimateLayerResult

# Interface: ICreateFillAnimateLayerResult

# Hierarchy

# Table of contents

# Properties

# Properties

# createAnimateImages

• createAnimateImages: (options: ICreateAnimateImagesOptions) => ImageData[]

创建动画图片集.

# Type declaration

▸ (options: ICreateAnimateImagesOptions): ImageData[]

# Parameters
Name Type
options ICreateAnimateImagesOptions

Returns: ImageData[]

Inherited from: ICreateAnimateLayerResult.createAnimateImages

# layerId

• layerId: string

图层ID.

Inherited from: ICreateAnimateLayerResult.layerId

# polygon

• polygon: Polygon

# remove

• remove: () => void

移除.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.remove

# setSpeed

• setSpeed: (speed: number) => void

设置速度.

# Type declaration

▸ (speed: number): void

# Parameters
Name Type
speed number

Returns: void

Inherited from: ICreateAnimateLayerResult.setSpeed

# sourceId

• sourceId: string

数据源ID.

Inherited from: ICreateAnimateLayerResult.sourceId

# startAnimation

• startAnimation: () => void

开始动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.startAnimation

# stopAnimation

• stopAnimation: () => void

结束动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.stopAnimation

# updateData

• updateData: (input: any) => void

更新数据.

# Type declaration

▸ (input: any): void

# Parameters
Name Type
input any

Returns: void

Inherited from: ICreateAnimateLayerResult.updateData

# updateImages

• updateImages: (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]) => void

更新动画图片集.

# Type declaration

▸ (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]): void

# Parameters
Name Type
images (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

Returns: void

Inherited from: ICreateAnimateLayerResult.updateImages

vjmap / Exports / ICreateLineAnimateLayerResult

# Interface: ICreateLineAnimateLayerResult

# Hierarchy

# Table of contents

# Properties

# Properties

# createAnimateImages

• createAnimateImages: (options: ICreateAnimateImagesOptions) => ImageData[]

创建动画图片集.

# Type declaration

▸ (options: ICreateAnimateImagesOptions): ImageData[]

# Parameters
Name Type
options ICreateAnimateImagesOptions

Returns: ImageData[]

Inherited from: ICreateAnimateLayerResult.createAnimateImages

# layerId

• layerId: string

图层ID.

Inherited from: ICreateAnimateLayerResult.layerId

# polyline

• polyline: Polyline

# remove

• remove: () => void

移除.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.remove

# setSpeed

• setSpeed: (speed: number) => void

设置速度.

# Type declaration

▸ (speed: number): void

# Parameters
Name Type
speed number

Returns: void

Inherited from: ICreateAnimateLayerResult.setSpeed

# sourceId

• sourceId: string

数据源ID.

Inherited from: ICreateAnimateLayerResult.sourceId

# startAnimation

• startAnimation: () => void

开始动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.startAnimation

# stopAnimation

• stopAnimation: () => void

结束动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.stopAnimation

# updateData

• updateData: (input: any) => void

更新数据.

# Type declaration

▸ (input: any): void

# Parameters
Name Type
input any

Returns: void

Inherited from: ICreateAnimateLayerResult.updateData

# updateImages

• updateImages: (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]) => void

更新动画图片集.

# Type declaration

▸ (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]): void

# Parameters
Name Type
images (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

Returns: void

Inherited from: ICreateAnimateLayerResult.updateImages

vjmap / Exports / ICreateSymbolAnimateLayerResult

# Interface: ICreateSymbolAnimateLayerResult

# Hierarchy

# Table of contents

# Properties

# Properties

# createAnimateImages

• createAnimateImages: (options: ICreateAnimateImagesOptions) => ImageData[]

创建动画图片集.

# Type declaration

▸ (options: ICreateAnimateImagesOptions): ImageData[]

# Parameters
Name Type
options ICreateAnimateImagesOptions

Returns: ImageData[]

Inherited from: ICreateAnimateLayerResult.createAnimateImages

# layerId

• layerId: string

图层ID.

Inherited from: ICreateAnimateLayerResult.layerId

# remove

• remove: () => void

移除.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.remove

# setSpeed

• setSpeed: (speed: number) => void

设置速度.

# Type declaration

▸ (speed: number): void

# Parameters
Name Type
speed number

Returns: void

Inherited from: ICreateAnimateLayerResult.setSpeed

# sourceId

• sourceId: string

数据源ID.

Inherited from: ICreateAnimateLayerResult.sourceId

# startAnimation

• startAnimation: () => void

开始动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.startAnimation

# stopAnimation

• stopAnimation: () => void

结束动画函数.

# Type declaration

▸ (): void

Returns: void

Inherited from: ICreateAnimateLayerResult.stopAnimation

# symbol

• symbol: Symbol

# updateData

• updateData: (input: any) => void

更新数据.

# Type declaration

▸ (input: any): void

# Parameters
Name Type
input any

Returns: void

Inherited from: ICreateAnimateLayerResult.updateData

# updateImages

• updateImages: (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]) => void

更新动画图片集.

# Type declaration

▸ (images: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]): void

# Parameters
Name Type
images (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data: Uint8Array | Uint8ClampedArray ; height: number ; width: number })[]

Returns: void

Inherited from: ICreateAnimateLayerResult.updateImages

vjmap / Exports / IDb2dPolyline

# Interface: IDb2dPolyline

2d折线实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# elevation

• Optional elevation: number

高程.

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# points

• Optional points: [number, number, undefined | number][]

坐标.

# polyType

• Optional polyType: k2dSimplePoly | k2dFitCurvePoly | k2dQuadSplinePoly | k2dCubicSplinePoly

2d折线类型

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / IDb2LineAngularDimension

# Interface: IDb2LineAngularDimension

角度标注[两条线]实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点位置.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.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: IDbDimension.xdata

vjmap / Exports / IDb3dPolyline

# Interface: IDb3dPolyline

3d折线实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# points

• Optional points: [number, number, undefined | number][]

坐标.

# polyType

• Optional polyType: k3dSimplePoly | k3dQuadSplinePoly | k3dCubicSplinePoly

3d折线类型

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / IDb3PointAngularDimension

# Interface: IDb3PointAngularDimension

角度标注[三点]实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点位置.

# centerPoint

• Optional centerPoint: [number, number, undefined | number][]

中点.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

点1.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

点2.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / IDbAlignedDimension

# Interface: IDbAlignedDimension

对齐标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimLinePoint

• Optional dimLinePoint: [number, number, undefined | number][]

设置定义此dimension实体尺寸线位置的WCS点.

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# jogSymbolHeight

• Optional jogSymbolHeight: number

设置此实体的符号高度。.

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线1点.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线2点.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / IDbArc

# Interface: IDbArc

圆弧实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# endAngle

• Optional endAngle: number

结束弧度.

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# normal

• Optional normal: [number, number, undefined | number]

法向量.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# radius

• Optional radius: number

半径.

# startAngle

• Optional startAngle: number

开始弧度.

# thickness

• Optional thickness: number

厚度.

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / IDbArcDimension

# Interface: IDbArcDimension

圆弧标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# arcPoint

• Optional arcPoint: [number, number, undefined | number][]

圆弧点.

# arcSymbolType

• Optional arcSymbolType: number

文本中使用的弧符号的类型。 0 弧符号在文本前面; 1 弧线符号在文字上方; 2 没有符号.

# centerPoint

• Optional centerPoint: [number, number, undefined | number][]

中心点.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线1点.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线2点.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / IDbBlock

# Interface: IDbBlock

块定义接口

# Table of contents

# Properties

# Properties

# comments

• Optional comments: string

备注.

# entitys

• Optional entitys: IDbEntity[]

由哪些实体创建而成.

# explodable

• Optional explodable: boolean

是否可炸开.

# insertUnits

• Optional insertUnits: number

设置此块的块插入单位 .

# name

• Optional name: string

块名称.

# origin

• Optional origin: [number, number, undefined | number][]

原点。 .

# scaling

• Optional scaling: number

设置此块的参照的缩放特征.

vjmap / Exports / IDbBlockReference

# Interface: IDbBlockReference

块参照实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# blockname

• Optional blockname: string

块名称.

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# normal

• Optional normal: [number, number, undefined | number]

法向量.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# position

• Optional position: [number, number, undefined | number]

坐标.

# ref

• Optional ref: string

参考外部图形，形式为 mapid/version,如 exam/v1.

# rotation

• Optional rotation: number

旋转角度.

# scaleFactors

• Optional scaleFactors: number

缩放因子.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / IDbCircle

# Interface: IDbCircle

圆实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# normal

• Optional normal: [number, number, undefined | number]

法向量.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# radius

• Optional radius: number

半径.

# thickness

• Optional thickness: number

厚度.

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / IDbCurve

# Interface: IDbCurve

曲线实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / IDbDiametricDimension

# Interface: IDbDiametricDimension

直径标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# chordPoint

• Optional chordPoint: [number, number, undefined | number][]

圆上1点.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# farChordPoint

• Optional farChordPoint: [number, number, undefined | number][]

圆上2点.

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# leaderLength

• Optional leaderLength: number

引线长度.

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / IDbDimension

# Interface: IDbDimension

标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# dimStyle

• Optional dimStyle: string

标注样式.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / IDbDimStyle

# Interface: IDbDimStyle

标注样式接口

# Table of contents

# Properties

# Properties

# dimblk1

• Optional dimblk1: string

符号和箭头1 .“” 实心闭合,“_DOT” 点,“_DOTSMALL” 小点,“_DOTBLANK” 空心点,“_ORIGIN” 指示原点,“_ORIGIN2” 指示原点 2,“_OPEN” 打开,“_OPEN90” 直角,“_OPEN30” 30 度角,“_CLOSED” 闭合,“_SMALL” 空心小点,“_NONE” 无,“_OBLIQUE” 倾斜,“_BOXFILLED” 填充框,“_BOXBLANK” 框,“_CLOSEDBLANK” 空心闭合,“_DATUMFILLED” 实心基准三角形,“_DATUMBLANK” 基准三角形,“_INTEGRAL” 完整标记,“_ARCHTICK” 建筑标记

# dimblk2

• Optional dimblk2: string

符号和箭头2 .同dimblk1

# dimsah

• Optional dimsah: boolean

尺寸线箭头块的显示 .

# name

• Optional name: string

样式名称.

# textStyle

• Optional textStyle: string

文字样式名称.

vjmap / Exports / IDbDocument

# Interface: IDbDocument

DB文档定义接口

# Table of contents

# Properties

# Properties

# blocks

• Optional blocks: IDbBlock[]

块定义.

# dimStyles

• Optional dimStyles: IDbDimStyle[]

标注样式.

# entitys

• Optional entitys: IDbEntity[]

实体集.

# from

• Optional from: string

来源于哪个图，会在此图的上面进行修改或新增删除，格式如 形式为 mapid/version,如 exam/v1 .

# layers

• Optional layers: IDbLayer[]

图层集.

# linetypes

• Optional linetypes: IDbLinetype[]

线型.

# textStyles

• Optional textStyles: IDbTextStyle[]

文字样式.

vjmap / Exports / IDbEllipse

# Interface: IDbEllipse

椭圆实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# center

• Optional center: [number, number, undefined | number]

中心坐标.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# endAngle

• Optional endAngle: number

结束弧度.

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# minorAxis

• Optional minorAxis: [number, number, undefined | number]

主轴方向.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# radiusRatio

• Optional radiusRatio: number

短轴和长轴的比例.

# startAngle

• Optional startAngle: number

开始弧度.

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / IDbEntity

# Interface: IDbEntity

实体类型接口

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

# color

• Optional color: number

颜色.

# colorIndex

• Optional colorIndex: number

颜色索引.

# delete

• Optional delete: boolean

是否删除此实体.

# layer

• Optional layer: string

图层.

# lineWidth

• Optional lineWidth: number

线宽.

# linetype

• Optional linetype: string

线型.

# linetypeScale

• Optional linetypeScale: number

线型比例.

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

# typename

• Optional typename: string

类型.

# visibility

• Optional visibility: boolean

可见.

# xdata

• Optional xdata: string

扩展数据.

vjmap / Exports / IDbHatch

# Interface: IDbHatch

填充实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# elevation

• Optional elevation: number

高程.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# pattern

• Optional pattern: string

填充图案, 缺省 SOLID

# points

• Optional points: [number, number, undefined | number][]

坐标.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / IDbLayer

# Interface: IDbLayer

图层接口

# Table of contents

# Properties

# Properties

# color

• Optional color: number

图层颜色索引.

# linetype

• Optional linetype: string

图层线型，缺省 CONTINUOUS .

# name

• Optional name: string

图层名称.

vjmap / Exports / IDbLine

# Interface: IDbLine

线实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# end

• Optional end: [number, number, undefined | number]

终点.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# start

• Optional start: [number, number, undefined | number]

起点.

# thickness

• Optional thickness: number

厚度.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / IDbLinetype

# Interface: IDbLinetype

线型接口

# Table of contents

# Properties

# Properties

# comments

• Optional comments: string

评论.

# name

• Optional name: string

线型名称.

# style

• Optional style: IDbLinetypeStyle[]

线型样式 .

vjmap / Exports / IDbLinetypeStyle

# Interface: IDbLinetypeStyle

线型样式接口

# Table of contents

# Properties

# Properties

# method

• Optional method: numDashes | patternLength | dashLengthAt | shapeStyleAt | shapeOffsetAt | textAt | shapeScaleAt | shapeNumberAt | shapeRotationAt | isScaledToFit

方法.

# parameter

• Optional parameter: string

参数.

vjmap / Exports / IDbMatrixOp

# Interface: IDbMatrixOp

矩阵操作接口

# Table of contents

# Properties

# Properties

# angle

• Optional angle: number

旋转的角度 .

# op

• Optional op: translation | scale | rotate

操作名称.

# origin

• Optional origin: [number, number, undefined | number]

基点.

# scale

• Optional scale: number

缩放大小 .

# vector

• Optional vector: [number, number, undefined | number]

平移的向量.

vjmap / Exports / IDbMText

# Interface: IDbMText

多行文本实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# attachment

• Optional attachment: kTopLeft | kTopCenter | kTopRight | kMiddleLeft | kMiddleCenter | kMiddleRight | kBottomLeft | kBottomCenter | kBottomRight | kBaseLeft | kBaseCenter | kBaseRight | kBaseAlign | kBottomAlign | kMiddleAlign | kTopAlign | kBaseFit | kBottomFit | kMiddleFit | kTopFit | kBaseMid | kBottomMid | kMiddleMid | kTopMid

对齐方式.

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# contents

• Optional contents: string

文本内容.

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# height

• Optional height: number

高.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# location

• Optional location: [number, number, undefined | number]

位置.

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# rotation

• Optional rotation: number

旋转角度.

# textHeight

• Optional textHeight: number

文本高.

# textStyle

• Optional textStyle: string

文本样式.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# width

• Optional width: number

宽.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / IDbOrdinateDimension

# Interface: IDbOrdinateDimension

坐标标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# definingPoint

• Optional definingPoint: [number, number, undefined | number][]

定义点.

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# leaderEndPoint

• Optional leaderEndPoint: [number, number, undefined | number][]

引线点.

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# origin

• Optional origin: [number, number, undefined | number][]

基点.

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# useXAxis

• Optional useXAxis: boolean

是否用X轴.

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / IDbPolyline

# Interface: IDbPolyline

折线实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# bulge

• Optional bulge: number[]

凸度.

# closed

• Optional closed: boolean

是否闭合.

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# elevation

• Optional elevation: number

高程.

# endWidth

• Optional endWidth: number[]

终点宽.

# layer

• Optional layer: string

图层.

Inherited from: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# points

• Optional points: [number, number, undefined | number][]

坐标.

# startWidth

• Optional startWidth: number[]

起点宽.

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / IDbRadialDimension

# Interface: IDbRadialDimension

半径标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# center

• Optional center: [number, number, undefined | number][]

中心点.

# chordPoint

• Optional chordPoint: [number, number, undefined | number][]

圆上点.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# leaderLength

• Optional leaderLength: number

引线长度.

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / IDbRadialDimensionLarge

# Interface: IDbRadialDimensionLarge

半径折线标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# center

• Optional center: [number, number, undefined | number][]

中心点.

# chordPoint

• Optional chordPoint: [number, number, undefined | number][]

圆上点.

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# jogAngle

• Optional jogAngle: number

设置此Dimension实体的折角。.

# jogPoint

• Optional jogPoint: [number, number, undefined | number][]

设置此Dimension实体的折角点。.

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# overrideCenter

• Optional overrideCenter: [number, number, undefined | number][]

设置由该Dimension实体确定尺寸的弧的WCS覆盖中心。.

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / IDbRasterImage

# Interface: IDbRasterImage

栅格图片实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# brightness

• Optional brightness: number

明亮度 [0.0 .. 100.0]

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# height

• Optional height: number

高.

# imageDisplayOptClip

• Optional imageDisplayOptClip: boolean

是否裁剪.

# imageDisplayOptShow

• Optional imageDisplayOptShow: boolean

是否显示.

# imageDisplayOptShowUnAligned

• Optional imageDisplayOptShowUnAligned: boolean

是否对齐.

# imageDisplayOptTransparent

• Optional imageDisplayOptTransparent: boolean

是否透明.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# 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: IDbEntity.typename

# units

• Optional units: kNone | kMillimeter | kCentimeter | kMeter | kKilometer | kInch | kFoot | kYard | kMile | kMicroinches | kMils | kAngstroms | kNanometers | kMicrons | kDecimeters | kDekameters | kHectometers | kGigameters | kAstronomical | kLightYears | kParsecs

单位.

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# width

• Optional width: number

宽.

# xPelsPerUnit

• Optional xPelsPerUnit: number

x轴每像素代表长度.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

# yPelsPerUnit

• Optional yPelsPerUnit: number

y轴每像素代表长度.

vjmap / Exports / IDbRotatedDimension

# Interface: IDbRotatedDimension

转角标注实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbDimension.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbDimension.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbDimension.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbDimension.delete

# dimLinePoint

• Optional dimLinePoint: [number, number, undefined | number][]

设置定义此dimension实体尺寸线位置的WCS点。.

# dimStyle

• Optional dimStyle: string

标注样式.

Inherited from: IDbDimension.dimStyle

# layer

• Optional layer: string

图层.

Inherited from: IDbDimension.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbDimension.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbDimension.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbDimension.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbDimension.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbDimension.objectid

# textPosition

• Optional textPosition: [number, number, undefined | number][]

文字位置.

Inherited from: IDbDimension.textPosition

# typename

• Optional typename: string

类型.

Inherited from: IDbDimension.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbDimension.visibility

# xLine1Point

• Optional xLine1Point: [number, number, undefined | number][]

线上点1.

# xLine2Point

• Optional xLine2Point: [number, number, undefined | number][]

线上点2.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbDimension.xdata

vjmap / Exports / IDbShape

# Interface: IDbShape

型实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# name

• Optional name: string

型名称.

# normal

• Optional normal: [number, number, undefined | number]

法向量.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# position

• Optional position: [number, number, undefined | number]

位置.

# rotation

• Optional rotation: number

旋转角度.

# size

• Optional size: number

大小.

# typename

• Optional typename: string

类型.

Inherited from: IDbEntity.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / IDbSpline

# Interface: IDbSpline

样条曲线实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbCurve.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbCurve.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbCurve.colorIndex

# controlPoints

• Optional controlPoints: [number, number, undefined | number][]

控制点.

# degree

• Optional degree: number

Increased the degree of this spline to the specified value.

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbCurve.delete

# 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: IDbCurve.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbCurve.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbCurve.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbCurve.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbCurve.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbCurve.objectid

# typename

• Optional typename: string

类型.

Inherited from: IDbCurve.typename

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbCurve.visibility

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbCurve.xdata

vjmap / Exports / IDbTable

# Interface: IDbTable

表格实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alignment

• Optional alignment: kTopLeft | kTopCenter | kTopRight | kMiddleLeft | kMiddleCenter | kMiddleRight | kBottomLeft | kBottomCenter | kBottomRight

单元格对齐方式(所有单元格).

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbBlockReference.alpha

# backgroundColor

• Optional backgroundColor: number

背景颜色(所有单元格).

# blockname

• Optional blockname: string

块名称.

Inherited from: IDbBlockReference.blockname

# color

• Optional color: number

颜色.

Inherited from: IDbBlockReference.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbBlockReference.colorIndex

# columnWidth

• Optional columnWidth: number

列宽.

# contentColor

• Optional contentColor: number

文字颜色(所有单元格).

# data

• Optional data: (string | { alignment: TableCellAlignment ; backgroundColor: number ; contentColor: number ; gridColor: number ; gridVisibility: boolean ; text: string ; textHeight: number })[][]

数据.

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbBlockReference.delete

# 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)

# height

• Optional height: number

表格总共的高度.

# horzCellMargin

• Optional horzCellMargin: number

水平方向单元格边距.

# layer

• Optional layer: string

图层.

Inherited from: IDbBlockReference.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbBlockReference.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbBlockReference.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbBlockReference.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbBlockReference.matrix

# mergeCells

• Optional mergeCells: [number, number, number, number][]

需要合并的单元格 [[minRow, maxRow,minColumn, maxColumn], ...]

# normal

• Optional normal: [number, number, undefined | number]

法向量.

Inherited from: IDbBlockReference.normal

# numColumns

• Optional numColumns: number

表格列数.

# numRows

• Optional numRows: number

表格行数.

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbBlockReference.objectid

# position

• Optional position: [number, number, undefined | number]

坐标.

Inherited from: IDbBlockReference.position

# ref

• Optional ref: string

参考外部图形，形式为 mapid/version,如 exam/v1.

Inherited from: IDbBlockReference.ref

# rotation

• Optional rotation: number

旋转角度.

Inherited from: IDbBlockReference.rotation

# rowHeight

• Optional rowHeight: number

行高.

# scaleFactors

• Optional scaleFactors: number

缩放因子.

Inherited from: IDbBlockReference.scaleFactors

# tableStyleName

• Optional tableStyleName: string

表样式名称.

# textHeight

• Optional textHeight: number

文字高度(所有单元格).

# typename

• Optional typename: string

类型.

Inherited from: IDbBlockReference.typename

# vertCellMargin

• Optional vertCellMargin: number

竖直方向单元格边距.

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbBlockReference.visibility

# width

• Optional width: number

表格总共的宽度.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbBlockReference.xdata

vjmap / Exports / IDbText

# Interface: IDbText

单行文本实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbEntity.alpha

# color

• Optional color: number

颜色.

Inherited from: IDbEntity.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbEntity.colorIndex

# contents

• Optional contents: string

文本内容， 同text.

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbEntity.delete

# height

• Optional height: number

高.

# horizontalMode

• Optional horizontalMode: kTextLeft | kTextCenter | kTextRight | kTextAlign | kTextMid | kTextFit

水平模式.

# layer

• Optional layer: string

图层.

Inherited from: IDbEntity.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbEntity.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbEntity.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbEntity.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbEntity.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbEntity.objectid

# 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: IDbEntity.typename

# verticalMode

• Optional verticalMode: kTextBase | kTextBottom | kTextVertMid | kTextTop

垂直模式.

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbEntity.visibility

# widthFactor

• Optional widthFactor: number

宽度因子.

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbEntity.xdata

vjmap / Exports / IDbTextStyle

# Interface: IDbTextStyle

文字样式接口

# Table of contents

# Properties

# 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 / Exports / IDbWipeout

# Interface: IDbWipeout

遮罩实体类型接口

# Hierarchy

# Table of contents

# Properties

# Properties

# alpha

• Optional alpha: number

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: IDbRasterImage.alpha

# brightness

• Optional brightness: number

明亮度 [0.0 .. 100.0]

Inherited from: IDbRasterImage.brightness

# color

• Optional color: number

颜色.

Inherited from: IDbRasterImage.color

# colorIndex

• Optional colorIndex: number

颜色索引.

Inherited from: IDbRasterImage.colorIndex

# delete

• Optional delete: boolean

是否删除此实体.

Inherited from: IDbRasterImage.delete

# height

• Optional height: number

高.

Inherited from: IDbRasterImage.height

# imageDisplayOptClip

• Optional imageDisplayOptClip: boolean

是否裁剪.

Inherited from: IDbRasterImage.imageDisplayOptClip

# imageDisplayOptShow

• Optional imageDisplayOptShow: boolean

是否显示.

Inherited from: IDbRasterImage.imageDisplayOptShow

# imageDisplayOptShowUnAligned

• Optional imageDisplayOptShowUnAligned: boolean

是否对齐.

Inherited from: IDbRasterImage.imageDisplayOptShowUnAligned

# imageDisplayOptTransparent

• Optional imageDisplayOptTransparent: boolean

是否透明.

Inherited from: IDbRasterImage.imageDisplayOptTransparent

# layer

• Optional layer: string

图层.

Inherited from: IDbRasterImage.layer

# lineWidth

• Optional lineWidth: number

线宽.

Inherited from: IDbRasterImage.lineWidth

# linetype

• Optional linetype: string

线型.

Inherited from: IDbRasterImage.linetype

# linetypeScale

• Optional linetypeScale: number

线型比例.

Inherited from: IDbRasterImage.linetypeScale

# matrix

• Optional matrix: IDbMatrixOp[]

矩阵.

Inherited from: IDbRasterImage.matrix

# objectid

• Optional objectid: string

实体句柄，如传了实体句柄，是表示修改此实体.

Inherited from: IDbRasterImage.objectid

# pixelHeight

• Optional pixelHeight: number

源图片高.

Inherited from: IDbRasterImage.pixelHeight

# pixelWidth

• Optional pixelWidth: number

源图片宽.

Inherited from: IDbRasterImage.pixelWidth

# points

• Optional points: [number, number, undefined | number][]

坐标.

# position

• Optional position: [number, number, undefined | number]

位置.

Inherited from: IDbRasterImage.position

# sourceHttpUrl

• Optional sourceHttpUrl: string

图片url地址.

Inherited from: IDbRasterImage.sourceHttpUrl

# typename

• Optional typename: string

类型.

Inherited from: IDbRasterImage.typename

# units

• Optional units: kNone | kMillimeter | kCentimeter | kMeter | kKilometer | kInch | kFoot | kYard | kMile | kMicroinches | kMils | kAngstroms | kNanometers | kMicrons | kDecimeters | kDekameters | kHectometers | kGigameters | kAstronomical | kLightYears | kParsecs

单位.

Inherited from: IDbRasterImage.units

# visibility

• Optional visibility: boolean

可见.

Inherited from: IDbRasterImage.visibility

# width

• Optional width: number

宽.

Inherited from: IDbRasterImage.width

# xPelsPerUnit

• Optional xPelsPerUnit: number

x轴每像素代表长度.

Inherited from: IDbRasterImage.xPelsPerUnit

# xdata

• Optional xdata: string

扩展数据.

Inherited from: IDbRasterImage.xdata

# yPelsPerUnit

• Optional yPelsPerUnit: number

y轴每像素代表长度.

Inherited from: IDbRasterImage.yPelsPerUnit

vjmap / Exports / IDeleteCache

# Interface: IDeleteCache

清空地图缓存接口

# Table of contents

# Properties

# Properties

# key

• Optional key: string

匹配的键值.

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本, 如清空所有版本缓存，输入"*"号).

vjmap / Exports / IDeleteStyle

# Interface: IDeleteStyle

删除地图样式接口

# Table of contents

# Properties

# Properties

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# onlycleardata

• onlycleardata: boolean

是否只清空数据, false 删除表和数据; true 只删除数据.

# styleid

• styleid: string

样式名称.如删除所有样式，输入""号； 删除所有系统产生的样式，输入 "a"；内存打开的样式,输入"m*";几何打开的样式输入 "s*"

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本, 如删除所有版本，输入"*"号).

vjmap / Exports / IDraw

# Interface: IDraw

# Table of contents

# Properties

# Properties

# Tool

• Tool: (options?: IDrawOptions) => IDrawTool

工具类.

# Type declaration

+ new IDraw(options?: IDrawOptions): IDrawTool

# Parameters
Name Type
options? IDrawOptions

Returns: IDrawTool

# actionDraw

• actionDraw: (map: any, modename: string, options?: Record<string, any>) => any

绘制动作.

# Type declaration

▸ (map: any, modename: string, options?: Record<string, any>): any

# Parameters
Name Type
map any
modename string
options? Record<string, any>

Returns: any

# actionDrawCircle

• actionDrawCircle: (map: any, options?: Record<string, any>) => any

绘制圆动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionDrawLineSting

• actionDrawLineSting: (map: any, options?: Record<string, any>) => any

绘制线动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionDrawPoint

• actionDrawPoint: (map: any, options?: Record<string, any>) => any

绘制点动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionDrawPolygon

• actionDrawPolygon: (map: any, options?: Record<string, any>) => any

绘制多边形动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionDrawRectangle

• actionDrawRectangle: (map: any, options?: Record<string, any>) => any

绘制矩形动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionDrawSlantRectangle

• actionDrawSlantRectangle: (map: any, options?: Record<string, any>) => any

绘制斜矩形动作.

# Type declaration

▸ (map: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
options? Record<string, any>

Returns: any

# actionSelect

• actionSelect: (map: any, draw: any, options?: Record<string, any>) => any

选择实体. 如果只能选择一个实体，options选项请输入selectSingle为true

# Type declaration

▸ (map: any, draw: any, options?: Record<string, any>): any

# Parameters
Name Type
map any
draw any
options? Record<string, any>

Returns: any

# defaultOptions

• defaultOptions: () => any

缺省配置项.

# Type declaration

▸ (): any

Returns: any

# modes

• modes: Record<string, any>

模式.

vjmap / Exports / IDrawOptions

# Interface: IDrawOptions

# Indexable

▪ [key: string]: any

# Table of contents

# Properties

# Properties

# addControls

• Optional addControls: any[]

# api

• api: object

# Type declaration
Name Type
getSnapFeatures any

# controls

• Optional controls: Record<string, boolean>

# guides

• Optional guides: boolean

# midpoints

• Optional midpoints: boolean

# modes

• Optional modes: Record<string, any>

# snap

• Optional snap: boolean

# snapOptions

• snapOptions: object

# Type declaration
Name Type
snapGridPx? number
snapPx? number
snapToMidPoints? boolean
snapVertexPriorityDistance? number

# styles

• Optional styles: any[]

# userProperties

• Optional userProperties: boolean

vjmap / Exports / IDrawTool

# Interface: IDrawTool

# Table of contents

# Properties

# Properties

# add

• add: (geojson: any) => string[]

此方法采用 GeoJSON Feature、FeatureCollection 或 Geometry 并将其添加到 Draw。它返回一个 id 数组，用于与添加的功能进行交互。如果某个功能没有自己的 id，则会自动生成一个

# Type declaration

▸ (geojson: any): string[]

# Parameters
Name Type
geojson any

Returns: string[]

# changeMode

• changeMode: (mode: string, modeOptions?: any) => IDrawTool

将绘图更改为另一种模式。返回用于链接的绘制实例

# Type declaration

▸ (mode: string, modeOptions?: any): IDrawTool

# Parameters
Name Type
mode string
modeOptions? any

Returns: IDrawTool

# combineFeatures

• combineFeatures: () => IDrawTool

调用当前模式的combineFeatures操作。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

# delete

• delete: (featureIds: string | string[]) => IDrawTool

删除具有指定 ID 的功能。返回用于链接的绘制实例

# Type declaration

▸ (featureIds: string | string[]): IDrawTool

# Parameters
Name Type
featureIds string | string[]

Returns: IDrawTool

# deleteAll

• deleteAll: () => IDrawTool

删除所有功能。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

# doAction

• doAction: (actionName: string) => any

在当前模式下执行动作

# Type declaration

▸ (actionName: string): any

# Parameters
Name Type
actionName string

Returns: any

# forceRefresh

• forceRefresh: () => any

强制刷新

# Type declaration

▸ (): any

Returns: any

# get

• get: (id: string) => any

返回 Draw 中具有指定 id 的 GeoJSON 功能，或者undefined如果 id 不匹配任何功能

# Type declaration

▸ (id: string): any

# Parameters
Name Type
id string

Returns: any

# getAll

• getAll: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回所有功能的 FeatureCollection

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

# getFeatureIdsAt

• getFeatureIdsAt: (point: { x: number ; y: number }) => string[]

返回当前在指定点呈现的功能的功能 ID 数组。

# Type declaration

▸ (point: { x: number ; y: number }): string[]

# Parameters
Name Type
point object
point.x number
point.y number

Returns: string[]

# getMode

• getMode: () => string

返回 Draw 的当前模式

# Type declaration

▸ (): string

Returns: string

# getSelected

• getSelected: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回当前选择的所有功能的 FeatureCollection

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

# getSelectedIds

• getSelectedIds: () => string[]

返回当前所选功能的功能 ID 数组

# Type declaration

▸ (): string[]

Returns: string[]

# getSelectedPoints

• getSelectedPoints: () => FeatureCollection<Geometry | GeometryCollection, Properties>

返回代表当前选择的所有顶点的 FeatureCollection 点

# Type declaration

▸ (): FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: FeatureCollection<Geometry | GeometryCollection, Properties>

# modes

• modes: Record<string, any>

内部变量模式值

# onAdd

• onAdd: (map: any) => any

增加时回调接口

# Type declaration

▸ (map: any): any

# Parameters
Name Type
map any

Returns: any

# onRemove

• onRemove: () => any

移除时回调接口

# Type declaration

▸ (): any

Returns: any

# options

• options: Record<string, any>

内部变量选项值

# redo

• redo: () => any

# Type declaration

▸ (): any

Returns: any

# set

• set: (featureCollection: FeatureCollection<Geometry | GeometryCollection, Properties>) => string[]

将 Draw 的功能设置为指定的 FeatureCollection

# Type declaration

▸ (featureCollection: FeatureCollection<Geometry | GeometryCollection, Properties>): string[]

# Parameters
Name Type
featureCollection FeatureCollection<Geometry | GeometryCollection, Properties>

Returns: string[]

# setFeatureProperty

• setFeatureProperty: (featureId: string, property: string, value: any) => IDrawTool

设置具有指定 id 的要素的属性值。返回用于链接的绘制实例

# Type declaration

▸ (featureId: string, property: string, value: any): IDrawTool

# Parameters
Name Type
featureId string
property string
value any

Returns: IDrawTool

# trash

• trash: () => IDrawTool

调用当前模式的删除trash操作。返回用于链接的绘制实例

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

# uncombineFeatures

• uncombineFeatures: () => IDrawTool

# Type declaration

▸ (): IDrawTool

Returns: IDrawTool

# undo

• undo: () => any

# Type declaration

▸ (): any

Returns: any

vjmap / Exports / IExportLayout

# Interface: IExportLayout

导出布局空间为dwg图

# Table of contents

# Properties

# Properties

# layoutIndex

• Optional layoutIndex: string

布局索引，layoutIndex和layoutName只要输入一个就行，layoutIndex优先。如果都为空，则使用dwg当前的布局空间.

# layoutName

• Optional layoutName: string

布局名称. layoutIndex和layoutName只要输入一个就行，layoutIndex优先。如果都为空，则使用dwg当前的布局空间.

# mapid

• mapid: string

地图ID.

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

vjmap / Exports / IExprQueryFeatures

# Interface: IExprQueryFeatures

表达式查询实体参数

# Hierarchy

# Table of contents

# Properties

# Properties

# beginpos

• Optional beginpos: number

记录开始位置.

# expr

• expr: string

表达式.

# fields

• Optional fields: string

是返回的字段列表，多个之是用逗号,分开,如. "name,objectid"

Inherited from: IQueryBaseFeatures.fields

# geom

• Optional geom: boolean

是否为几何图形查询.

Inherited from: IQueryBaseFeatures.geom

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称).

Inherited from: IQueryBaseFeatures.layer

# limit

• Optional limit: number

返回最多的记录条数.

Inherited from: IQueryBaseFeatures.limit

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

Inherited from: IQueryBaseFeatures.mapid

# simplifyTolerance

• Optional simplifyTolerance: boolean

GeoJSON几何数据简化墨托卡距离，默认为零，不简化。例如允许10级别以上一个像素级别的误差，可用 map.pixelToGeoLength(1, 10) * vjmap.Projection.EQUATORIAL_SEMIPERIMETER * 2 / map.getGeoBounds(1.0).width()

Inherited from: IQueryBaseFeatures.simplifyTolerance

# toMapCoordinate

• Optional toMapCoordinate: boolean

查询返回的坐标默认为墨卡托坐标，返回会程序会自动转化为cad坐标，如果要直接返回cad地图坐标，需要把toMapCoordinate设置为true.

Inherited from: IQueryBaseFeatures.toMapCoordinate

# useCache

• Optional useCache: boolean

启动cache(内存打开的图形有效).

Inherited from: IQueryBaseFeatures.useCache

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

Inherited from: IQueryBaseFeatures.version

# zoom

• Optional zoom: number

当前级别.

Inherited from: IQueryBaseFeatures.zoom

vjmap / Exports / ILineLayerOptions

# Interface: ILineLayerOptions

# Table of contents

# Properties

# Properties

# points

• points: { lat: number ; lng: number }[]

vjmap / Exports / IMapDiff

# Interface: IMapDiff

比较地图不同

# Table of contents

# Properties

# Properties

# cellsize

• Optional cellsize: number

比较单元大小.

# diffMinAlpha

• Optional diffMinAlpha: number

不同的透明最小值.

# diffMinColor

• Optional diffMinColor: number

不同的颜色最小值.

# diffMinPixel

• Optional diffMinPixel: number

不同的像素最小值.

# layer1

• Optional layer1: string

地图一样式图层.

# layer2

• Optional layer2: string

地图二样式图层.

# mapid1

• mapid1: string

地图一ID.

# mapid2

• mapid2: string

地图二ID.

# noCompareDelete

• Optional noCompareDelete: boolean

不比较删除部分.

# noCompareNew

• Optional noCompareNew: boolean

不比较新增部分.

# size

• Optional size: number

比较大小.

# version1

• Optional version1: string

地图一版本(为空时采用当前打开的地图版本).

# version2

• Optional version2: string

地图二版本(为空时采用当前打开的地图版本).

vjmap / Exports / IMapLayer

# Interface: IMapLayer

地图图层

# Table of contents

# Properties

# Properties

# color

• color: string

颜色.

# index

• index: number

图层索引.

# isFrozen

• isFrozen: boolean

是否冻结.

# isLocked

• isLocked: boolean

是否锁定.

# isOff

• isOff: boolean

图层是否关闭.

# lineWeight

• lineWeight: number

线宽.

# linetype

• linetype: number

线型.

# name

• name: string

图层名称.

vjmap / Exports / IMapStyleParam

# Interface: IMapStyleParam

地图样式参数参数

# Table of contents

# Properties

# Properties

# backcolor

• Optional backcolor: number

颜色.

# clipbounds

• Optional clipbounds: number | [number, number, number, number]

地图裁剪范围，范围如[x1,y1,x2,y2].如果只需入了数值的话，表示是缩放倍数

# expression

• Optional expression: string

表达式.

# layeroff

• Optional layeroff: string | number[]

要关的图层索引列表，格式如[2,4]. layeron与layeroff只要输入一个即可

# layeron

• Optional layeron: string | number[]

要开的图层索引列表，格式如[0,1,3].

# lineweight

• Optional lineweight: string | number[]

线宽，格式如[1，1，1，1，0].表式第1，2，3，4级线宽开，第5级线宽关，大于第5级的，以最后设置的级别状态为主，所以也是关。如为空，则和原图线宽显示状态相同

# name

• Optional name: string

样式名称.

vjmap / Exports / IMatchObject

# Interface: IMatchObject

目标匹配

# Table of contents

# Properties

# Properties

# canOverlap

• Optional canOverlap: boolean

允许重叠 (默认false).

# layer

• Optional layer: string

图层样式名.为空时，将由选择的实体的图层来决定

# layeron

• Optional layeron: string

目标匹配的地图打开的图层

# mapBounds

• Optional mapBounds: string

目标匹配的地图范围，默认为全图的数据范围.

# mapid

• mapid: string

地图ID.

# maxCount

• Optional maxCount: number

允许返回的最大条数. 默认 200

# maxOverlap

• Optional maxOverlap: number

重叠比例 范围(0-0.8)，默认 0.3.

# method

• Optional method: "matchTemplate" | "matchPattern"

方法. 默认 matchPattern

# minReduceArea

• Optional minReduceArea: number

金字塔大小 范围(64-2048).默认256， 方法为matchPattern有效

# objectBounds

• objectBounds: string

目标匹配的实体范围

# objectIds

• Optional objectIds: string

目标匹配的实体objectid数组，用||隔开.

# score

• Optional score: number

分数，小于此分类将不显示 (0 -1)，默认 0.6 .

# size

• Optional size: number

匹配时的图像尺寸，默认10000

# tolerance1

• Optional tolerance1: number

角度区间1开始角度. 方法为matchPattern有效

# tolerance2

• Optional tolerance2: number

角度区间1结束角度. 方法为matchPattern有效

# tolerance3

• Optional tolerance3: number

角度区间2开始角度. 方法为matchPattern有效

# tolerance4

• Optional tolerance4: number

角度区间2结束角度. 方法为matchPattern有效

# toleranceAngle

• Optional toleranceAngle: number

角度范围(-180, 180)有旋转的时候需要。方法为matchPattern有效. 默认180

# useToleranceRange

• Optional useToleranceRange: boolean

是否使用角度区间范围,默认false. 方法为matchPattern有效

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

vjmap / Exports / InertiaOptions

# Interface: InertiaOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# bounceDamping

• Optional bounceDamping: number

# bounceStiffness

• Optional bounceStiffness: number

# driver

• Optional driver: Driver

# from

• Optional from: number

Inherited from: DecayOptions.from

# max

• Optional max: number

# min

• Optional min: number

# modifyTarget

• Optional modifyTarget: (target: number) => number

# Type declaration

▸ (target: number): number

# Parameters
Name Type
target number

Returns: number

Inherited from: DecayOptions.modifyTarget

# onComplete

• Optional onComplete: () => void

# Type declaration

▸ (): void

Returns: void

# onStop

• Optional onStop: () => void

# Type declaration

▸ (): void

Returns: void

# onUpdate

• Optional onUpdate: (v: number) => void

# Type declaration

▸ (v: number): void

# Parameters
Name Type
v number

Returns: void

# power

• Optional power: number

Inherited from: DecayOptions.power

# restDelta

• Optional restDelta: number

Overrides: DecayOptions.restDelta

# restSpeed

• Optional restSpeed: number

# timeConstant

• Optional timeConstant: number

Inherited from: DecayOptions.timeConstant

# to

• Optional to: number

Inherited from: DecayOptions.to

# velocity

• Optional velocity: number

Inherited from: DecayOptions.velocity

vjmap / Exports / IOpenMapBaseParam

# Interface: IOpenMapBaseParam

地图打开参数

# Table of contents

# Properties

# Properties

# accessKey

• Optional accessKey: string

访问权限的key，权限小于secretKey，不能对图进行删除等操作.

# cadVersion

• Optional cadVersion: string

新建地图有fileDoc时有效

# cbInputPassword

• Optional cbInputPassword: (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }) => Promise<string>

要求输入密码回调.

# Type declaration

▸ (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }): Promise<string>

# Parameters
Name Type
param object
param.isPasswordError boolean
param.mapid string
param.result any
param.tryPasswordCount number

Returns: Promise<string>

# filedoc

• Optional filedoc: string

文件文档.

# fileid

• Optional fileid: string

文件唯一ID. 地图ID第一次打开时，需传递fileid

# filename

• Optional filename: string

文件名称.

# fontReplaceRule

• Optional fontReplaceRule: string | Record<string, string>

字符替换规则. openMap返回的字段findFonts为系统查找的字体替换规则。如需修改默认的话，请传入替换的字体规则，如fontReplaceRule: {"tssdeng.shx_1": "default.ttc"}

# imageLeft

• Optional imageLeft: number

图像左上角坐标x 第一次打开图像类型时有效

# imageResolution

• Optional imageResolution: number

图像分辨率 第一次打开图像类型时有效, 一个像素单位代表多少地理长度，计算公式为 真实坐标长度 / 图像像素宽

# imageTop

• Optional imageTop: number

图像左上角坐标y 第一次打开图像类型时有效

# mapdependencies

• Optional mapdependencies: string

地图依赖项.

# mapfrom

• Optional mapfrom: string

地图来源参数.

# mapid

• mapid: string

地图ID.

# mapopenway

• Optional mapopenway: Memory | GeomRender

地图打开方式(缺省: GeomRender) .

# notReplaceLineType

• Optional notReplaceLineType: boolean

不自动替换线型.

# notUseDefaultShxFont

• Optional notUseDefaultShxFont: boolean

不使用缺省的型文字文件，将使用缺省的字体来代替型文件.

# notUseDefaultTtfFont

• Optional notUseDefaultTtfFont: boolean

不使用缺省的字体文件，将使用缺省的型文件来代替字体文件.

# openFinishMaxTryCount

• Optional openFinishMaxTryCount: number

判断是否打开或更新成功重试最大次数。默认 120 次

# openFinishTryInterval

• Optional openFinishTryInterval: number

判断是否打开或更新成功重试间隔（秒）。默认 5s 一次

# renderAccuracy

• Optional renderAccuracy: number

渲染精度，默认1，有时候图形特别大导致圆或圆弧精度不够时,不够光滑，可以先清空之前的缓存数据，再重新上传时，改变渲染精度来使圆或圆弧光滑些。注：提高精度会导致空间数据文件增大，渲染性能下降

# secretKey

• Optional secretKey: string

秘钥(第一次上传打开图时有效，表示此图需要密码保护).

# style

• Optional style: IMapStyleParam

样式.

# subdependencies

• Optional subdependencies: string

地图依赖项(这是子项的设置，与mapdependencies不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapdependencies一样的话，则为空

# subfrom

• Optional subfrom: string

地图来源参数(这是子项的设置，与mapfrom不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapfrom一样的话，则为空

# uploadname

• Optional uploadname: string

上传时的文件名.

vjmap / Exports / IOpenMapParam

# Interface: IOpenMapParam

地图打开参数

# Hierarchy

# Table of contents

# Properties

# Properties

# accessKey

• Optional accessKey: string

访问权限的key，权限小于secretKey，不能对图进行删除等操作.

Inherited from: IOpenMapBaseParam.accessKey

# cadVersion

• Optional cadVersion: string

新建地图有fileDoc时有效

Inherited from: IOpenMapBaseParam.cadVersion

# cbInputPassword

• Optional cbInputPassword: (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }) => Promise<string>

要求输入密码回调.

# Type declaration

▸ (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }): Promise<string>

# Parameters
Name Type
param object
param.isPasswordError boolean
param.mapid string
param.result any
param.tryPasswordCount number

Returns: Promise<string>

Inherited from: IOpenMapBaseParam.cbInputPassword

# filedoc

• Optional filedoc: string

文件文档.

Inherited from: IOpenMapBaseParam.filedoc

# fileid

• Optional fileid: string

文件唯一ID. 地图ID第一次打开时，需传递fileid

Inherited from: IOpenMapBaseParam.fileid

# filename

• Optional filename: string

文件名称.

Inherited from: IOpenMapBaseParam.filename

# fontReplaceRule

• Optional fontReplaceRule: string | Record<string, string>

字符替换规则. openMap返回的字段findFonts为系统查找的字体替换规则。如需修改默认的话，请传入替换的字体规则，如fontReplaceRule: {"tssdeng.shx_1": "default.ttc"}

Inherited from: IOpenMapBaseParam.fontReplaceRule

# imageLeft

• Optional imageLeft: number

图像左上角坐标x 第一次打开图像类型时有效

Inherited from: IOpenMapBaseParam.imageLeft

# imageResolution

• Optional imageResolution: number

图像分辨率 第一次打开图像类型时有效, 一个像素单位代表多少地理长度，计算公式为 真实坐标长度 / 图像像素宽

Inherited from: IOpenMapBaseParam.imageResolution

# imageTop

• Optional imageTop: number

图像左上角坐标y 第一次打开图像类型时有效

Inherited from: IOpenMapBaseParam.imageTop

# layer

• Optional layer: string

图层名称，组合图层用英文逗号分开

# layoutIndex

• Optional layoutIndex: number

布局索引 (从1开始)，默认为0，表示是模型空间

# mapdependencies

• Optional mapdependencies: string

地图依赖项.

Inherited from: IOpenMapBaseParam.mapdependencies

# mapfrom

• Optional mapfrom: string

地图来源参数.

Inherited from: IOpenMapBaseParam.mapfrom

# mapid

• mapid: string

地图ID.

Inherited from: IOpenMapBaseParam.mapid

# mapopenway

• Optional mapopenway: Memory | GeomRender

地图打开方式(缺省: GeomRender) .

Inherited from: IOpenMapBaseParam.mapopenway

# notReplaceLineType

• Optional notReplaceLineType: boolean

不自动替换线型.

Inherited from: IOpenMapBaseParam.notReplaceLineType

# notUseDefaultShxFont

• Optional notUseDefaultShxFont: boolean

不使用缺省的型文字文件，将使用缺省的字体来代替型文件.

Inherited from: IOpenMapBaseParam.notUseDefaultShxFont

# notUseDefaultTtfFont

• Optional notUseDefaultTtfFont: boolean

不使用缺省的字体文件，将使用缺省的型文件来代替字体文件.

Inherited from: IOpenMapBaseParam.notUseDefaultTtfFont

# openFinishMaxTryCount

• Optional openFinishMaxTryCount: number

判断是否打开或更新成功重试最大次数。默认 120 次

Inherited from: IOpenMapBaseParam.openFinishMaxTryCount

# openFinishTryInterval

• Optional openFinishTryInterval: number

判断是否打开或更新成功重试间隔（秒）。默认 5s 一次

Inherited from: IOpenMapBaseParam.openFinishTryInterval

# renderAccuracy

• Optional renderAccuracy: number

渲染精度，默认1，有时候图形特别大导致圆或圆弧精度不够时,不够光滑，可以先清空之前的缓存数据，再重新上传时，改变渲染精度来使圆或圆弧光滑些。注：提高精度会导致空间数据文件增大，渲染性能下降

Inherited from: IOpenMapBaseParam.renderAccuracy

# secretKey

• Optional secretKey: string

秘钥(第一次上传打开图时有效，表示此图需要密码保护).

Inherited from: IOpenMapBaseParam.secretKey

# style

• Optional style: IMapStyleParam

样式.

Inherited from: IOpenMapBaseParam.style

# subdependencies

• Optional subdependencies: string

地图依赖项(这是子项的设置，与mapdependencies不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapdependencies一样的话，则为空

Inherited from: IOpenMapBaseParam.subdependencies

# subfrom

• Optional subfrom: string

地图来源参数(这是子项的设置，与mapfrom不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapfrom一样的话，则为空

Inherited from: IOpenMapBaseParam.subfrom

# uploadname

• Optional uploadname: string

上传时的文件名.

Inherited from: IOpenMapBaseParam.uploadname

# version

• Optional version: string

版本号(缺省: "" ).

vjmap / Exports / IOpenMapResponse

# Interface: IOpenMapResponse

地图打开返回成功参数

# Table of contents

# Properties

# Properties

# bounds

• Optional bounds: GeoBounds

地图范围(如果通过clipBounds打开，则是clipBounds的范围).

# darkMode

• Optional darkMode: boolean

暗黑模式(背景色为黑时).

# dbBounds

• Optional dbBounds: GeoBounds

数据库地图范围

# dbid

• Optional dbid: string

DbID.

# description

• Optional description: string

描述.

# drawBounds

• Optional drawBounds: GeoBounds

图形中有数据的范围（此范围是非精确值，精确的数据范围需调用cmdGetDrawBounds去获取）

# fileid

• Optional fileid: string

文件唯一ID.

# filename

• Optional filename: string

文件名称.

# imageHeight

• Optional imageHeight: number

图像类型时图像像素高

# imageLeft

• Optional imageLeft: number

图像左上角坐标x

# imageResolution

• Optional imageResolution: number

图像分辨率 一个像素单位代表多少地理长度，计算公式为 真实坐标长度 / 图像像素宽

# imageTop

• Optional imageTop: number

图像左上角坐标y

# imageWidth

• Optional imageWidth: number

图像类型时图像像素宽

# initViewScale

• Optional initViewScale: number

初始视图缩放倍数，bounds * initViewScale = dbBounds

# layer

• Optional layer: string

图层名称

# layers

• Optional layers: any

图层列表.

# layouts

• Optional layouts: string[]

所有布局.

# lineWidthDisplay

• Optional lineWidthDisplay: boolean

默认是否显示线宽.

# mapBounds

• Optional mapBounds: GeoBounds

地图范围(地图的范围，如果没有通过clipBounds打开,则为空).

# mapdependencies

• Optional mapdependencies: string

地图依赖项.

# mapfrom

• Optional mapfrom: string

地图来源参数.

# mapid

• Optional mapid: string

地图ID.

# mapopenway

• Optional mapopenway: Memory | GeomRender

地图打开方式(缺省: GeomRender) .

# maptype

• Optional maptype: string

地图类型. 为空时表示是cad类型，image表示是图像

# maxzoom

• Optional maxzoom: number

图像类型时最大级别

# renderAccuracy

• Optional renderAccuracy: number

渲染精度，默认1，有时候图形特别大导致圆或圆弧精度不够时,不够光滑，可以先清空之前的缓存数据，再重新上传时，改变渲染精度来使圆或圆弧光滑些。注：提高精度会导致空间数据文件增大，渲染性能下降

# status

• Optional status: string

状态.

# styles

• Optional styles: any

图层样式.

# subdependencies

• Optional subdependencies: string

地图依赖项(这是子项的设置，与mapdependencies不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapdependencies一样的话，则为空

# subfrom

• Optional subfrom: string

地图来源参数(这是子项的设置，与mapfrom不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapfrom一样的话，则为空

# type

• Optional type: string

类型.

# ucsorg

• Optional ucsorg: string

ucs基点坐标.

# uploadname

• Optional uploadname: string

上传的文件名.

# version

• Optional version: string

版本号(缺省: "" ).

# view

• Optional view: object

初始视图.

# Type declaration
Name Type Description
bearing? number 初始视图方位角.
center? [number, number] 初始视图中心点.
zoom? number 初始视图级别.

vjmap / Exports / IPointQueryFeatures

# Interface: IPointQueryFeatures

点查询实体参数

# Hierarchy

# Table of contents

# Properties

# Properties

# condition

• Optional condition: string

条件.

# fields

• Optional fields: string

是返回的字段列表，多个之是用逗号,分开,如. "name,objectid"

Inherited from: IQueryBaseFeatures.fields

# geom

• Optional geom: boolean

是否为几何图形查询.

Inherited from: IQueryBaseFeatures.geom

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称).

Inherited from: IQueryBaseFeatures.layer

# limit

• Optional limit: number

返回最多的记录条数.

Inherited from: IQueryBaseFeatures.limit

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

Inherited from: IQueryBaseFeatures.mapid

# maxGeomBytesSize

• Optional maxGeomBytesSize: number

返回最大的几何字节数.

# pixelToGeoLength

• Optional pixelToGeoLength: number

当前一个像素表示多少几何长度，如果输入了此值，则为此值为主，否则，根据输入的zoom值后台自动计算.

# pixelsize

• Optional pixelsize: number

像素大小.

# simplifyTolerance

• Optional simplifyTolerance: boolean

GeoJSON几何数据简化墨托卡距离，默认为零，不简化。例如允许10级别以上一个像素级别的误差，可用 map.pixelToGeoLength(1, 10) * vjmap.Projection.EQUATORIAL_SEMIPERIMETER * 2 / map.getGeoBounds(1.0).width()

Inherited from: IQueryBaseFeatures.simplifyTolerance

# toMapCoordinate

• Optional toMapCoordinate: boolean

查询返回的坐标默认为墨卡托坐标，返回会程序会自动转化为cad坐标，如果要直接返回cad地图坐标，需要把toMapCoordinate设置为true.

Inherited from: IQueryBaseFeatures.toMapCoordinate

# useCache

• Optional useCache: boolean

启动cache(内存打开的图形有效).

Inherited from: IQueryBaseFeatures.useCache

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

Inherited from: IQueryBaseFeatures.version

# x

• x: number

查询的坐标X.

# y

• y: number

查询的坐标Y.

# zoom

• Optional zoom: number

当前级别.

Inherited from: IQueryBaseFeatures.zoom

vjmap / Exports / IQueryBaseFeatures

# Interface: IQueryBaseFeatures

查询实体参数

# Table of contents

# Properties

# Properties

# fields

• Optional fields: string

是返回的字段列表，多个之是用逗号,分开,如. "name,objectid"

# geom

• Optional geom: boolean

是否为几何图形查询.

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称).

# limit

• Optional limit: number

返回最多的记录条数.

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# simplifyTolerance

• Optional simplifyTolerance: boolean

GeoJSON几何数据简化墨托卡距离，默认为零，不简化。例如允许10级别以上一个像素级别的误差，可用 map.pixelToGeoLength(1, 10) * vjmap.Projection.EQUATORIAL_SEMIPERIMETER * 2 / map.getGeoBounds(1.0).width()

# toMapCoordinate

• Optional toMapCoordinate: boolean

查询返回的坐标默认为墨卡托坐标，返回会程序会自动转化为cad坐标，如果要直接返回cad地图坐标，需要把toMapCoordinate设置为true.

# useCache

• Optional useCache: boolean

启动cache(内存打开的图形有效).

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

# zoom

• Optional zoom: number

当前级别.

vjmap / Exports / IRectQueryFeatures

# Interface: IRectQueryFeatures

矩形查询实体参数

# Hierarchy

# Table of contents

# Properties

# Properties

# condition

• Optional condition: string

条件.

# fields

• Optional fields: string

是返回的字段列表，多个之是用逗号,分开,如. "name,objectid"

Inherited from: IQueryBaseFeatures.fields

# geom

• Optional geom: boolean

是否为几何图形查询.

Inherited from: IQueryBaseFeatures.geom

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称).

Inherited from: IQueryBaseFeatures.layer

# limit

• Optional limit: number

返回最多的记录条数.

Inherited from: IQueryBaseFeatures.limit

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

Inherited from: IQueryBaseFeatures.mapid

# maxGeomBytesSize

• Optional maxGeomBytesSize: number

返回最大的几何字节数.

# simplifyTolerance

• Optional simplifyTolerance: boolean

GeoJSON几何数据简化墨托卡距离，默认为零，不简化。例如允许10级别以上一个像素级别的误差，可用 map.pixelToGeoLength(1, 10) * vjmap.Projection.EQUATORIAL_SEMIPERIMETER * 2 / map.getGeoBounds(1.0).width()

Inherited from: IQueryBaseFeatures.simplifyTolerance

# toMapCoordinate

• Optional toMapCoordinate: boolean

查询返回的坐标默认为墨卡托坐标，返回会程序会自动转化为cad坐标，如果要直接返回cad地图坐标，需要把toMapCoordinate设置为true.

Inherited from: IQueryBaseFeatures.toMapCoordinate

# useCache

• Optional useCache: boolean

启动cache(内存打开的图形有效).

Inherited from: IQueryBaseFeatures.useCache

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

Inherited from: IQueryBaseFeatures.version

# x1

• Optional x1: number

查询的坐标X1. (如果x1,y1,x2,y2同时不输的话，表示是查询整个图的范围

# x2

• Optional x2: number

查询的坐标X2.

# y1

• Optional y1: number

查询的坐标Y1.

# y2

• Optional y2: number

查询的坐标Y2.

# zoom

• Optional zoom: number

当前级别.

Inherited from: IQueryBaseFeatures.zoom

vjmap / Exports / IRequest

# Interface: IRequest

# Table of contents

# Properties

# Properties

# del

• del: (url: string, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
args? Partial<Config<unknown>>

Returns: Promise<any>

# get

• get: (url: string, params?: Record<string, any>, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, params?: Record<string, any>, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
params? Record<string, any>
args? Partial<Config<unknown>>

Returns: Promise<any>

# options

• options: (url: string, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
args? Partial<Config<unknown>>

Returns: Promise<any>

# patch

• patch: (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, data: any, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
data any
args? Partial<Config<unknown>>

Returns: Promise<any>

# post

• post: (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, data: any, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
data any
args? Partial<Config<unknown>>

Returns: Promise<any>

# put

• put: (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>

# Type declaration

▸ (url: string, data: any, args?: Partial<Config<unknown>>): Promise<any>

# Parameters
Name Type
url string
data any
args? Partial<Config<unknown>>

Returns: Promise<any>

vjmap / Exports / ISliceCacheZoom

# Interface: ISliceCacheZoom

获取图片切片缓存级别

# Table of contents

# Properties

# Properties

# ismvt

• ismvt: boolean

是否是矢量切片，如果否则为栅格瓦片切片

# layer

• Optional layer: string

图层名称（为空时采用当前打开的地图图层名称)

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

vjmap / Exports / ISliceLayer

# Interface: ISliceLayer

对图层进行切片

# Table of contents

# Properties

# Properties

# batchNum

• Optional batchNum: number

批处理的条数（默认10000）.

# busyBatchSleepMs

• Optional busyBatchSleepMs: number

繁忙时一次批处理等待时间（默认10000ms）.

# idleBatchSleepMs

• Optional idleBatchSleepMs: number

空闲一次批处理等待时间（默认1ms）.

# isAllCancel

• Optional isAllCancel: boolean

是否取消所有的切片（正在切时有效）.

# iscancel

• Optional iscancel: boolean

是否取消对此图层的切片（正在切时有效）.

# ismvt

• ismvt: boolean | boolean[]

是否是矢量切片，如果否则为栅格瓦片切片. 如果为数组时，layer也必须是数组，一一对应

# layer

• layer: string | string[]

图层名称（为空时采用当前打开的地图图层名称).如果为数组时，表示对多个图层进行切片

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

# zoom

• zoom: number | number[]

级别（切的第几级）, 如果为数组时，layer也必须是数组，一一对应

vjmap / Exports / ITileUrlParam

# Interface: ITileUrlParam

地图瓦片参数

# Table of contents

# Properties

# Properties

# fileid

• Optional fileid: string

文件唯一ID.

# layer

• Optional layer: string

图层名称.

# mapid

• Optional mapid: string

地图ID.

# version

• Optional version: string

版本号.

vjmap / Exports / IUpdateMapParam

# Interface: IUpdateMapParam

更新地图参数

# Hierarchy

# Table of contents

# Properties

# Properties

# accessKey

• Optional accessKey: string

访问权限的key，权限小于secretKey，不能对图进行删除等操作.

Inherited from: IOpenMapBaseParam.accessKey

# cadVersion

• Optional cadVersion: string

新建地图有fileDoc时有效

Inherited from: IOpenMapBaseParam.cadVersion

# cbInputPassword

• Optional cbInputPassword: (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }) => Promise<string>

要求输入密码回调.

# Type declaration

▸ (param: { isPasswordError: boolean ; mapid: string ; result: any ; tryPasswordCount: number }): Promise<string>

# Parameters
Name Type
param object
param.isPasswordError boolean
param.mapid string
param.result any
param.tryPasswordCount number

Returns: Promise<string>

Inherited from: IOpenMapBaseParam.cbInputPassword

# deleteOldVersion

• Optional deleteOldVersion: boolean

是否删除老版本(缺省: false ).

# filedoc

• Optional filedoc: string

文件文档.

Inherited from: IOpenMapBaseParam.filedoc

# fileid

• Optional fileid: string

文件唯一ID. 地图ID第一次打开时，需传递fileid

Inherited from: IOpenMapBaseParam.fileid

# filename

• Optional filename: string

文件名称.

Inherited from: IOpenMapBaseParam.filename

# fontReplaceRule

• Optional fontReplaceRule: string | Record<string, string>

字符替换规则. openMap返回的字段findFonts为系统查找的字体替换规则。如需修改默认的话，请传入替换的字体规则，如fontReplaceRule: {"tssdeng.shx_1": "default.ttc"}

Inherited from: IOpenMapBaseParam.fontReplaceRule

# imageLeft

• Optional imageLeft: number

图像左上角坐标x 第一次打开图像类型时有效

Inherited from: IOpenMapBaseParam.imageLeft

# imageResolution

• Optional imageResolution: number

图像分辨率 第一次打开图像类型时有效, 一个像素单位代表多少地理长度，计算公式为 真实坐标长度 / 图像像素宽

Inherited from: IOpenMapBaseParam.imageResolution

# imageTop

• Optional imageTop: number

图像左上角坐标y 第一次打开图像类型时有效

Inherited from: IOpenMapBaseParam.imageTop

# mapdependencies

• Optional mapdependencies: string

地图依赖项.

Inherited from: IOpenMapBaseParam.mapdependencies

# mapfrom

• Optional mapfrom: string

地图来源参数.

Inherited from: IOpenMapBaseParam.mapfrom

# mapid

• mapid: string

地图ID.

Inherited from: IOpenMapBaseParam.mapid

# mapopenway

• Optional mapopenway: Memory | GeomRender

地图打开方式(缺省: GeomRender) .

Inherited from: IOpenMapBaseParam.mapopenway

# notReplaceLineType

• Optional notReplaceLineType: boolean

不自动替换线型.

Inherited from: IOpenMapBaseParam.notReplaceLineType

# notUseDefaultShxFont

• Optional notUseDefaultShxFont: boolean

不使用缺省的型文字文件，将使用缺省的字体来代替型文件.

Inherited from: IOpenMapBaseParam.notUseDefaultShxFont

# notUseDefaultTtfFont

• Optional notUseDefaultTtfFont: boolean

不使用缺省的字体文件，将使用缺省的型文件来代替字体文件.

Inherited from: IOpenMapBaseParam.notUseDefaultTtfFont

# openFinishMaxTryCount

• Optional openFinishMaxTryCount: number

判断是否打开或更新成功重试最大次数。默认 120 次

Inherited from: IOpenMapBaseParam.openFinishMaxTryCount

# openFinishTryInterval

• Optional openFinishTryInterval: number

判断是否打开或更新成功重试间隔（秒）。默认 5s 一次

Inherited from: IOpenMapBaseParam.openFinishTryInterval

# renderAccuracy

• Optional renderAccuracy: number

渲染精度，默认1，有时候图形特别大导致圆或圆弧精度不够时,不够光滑，可以先清空之前的缓存数据，再重新上传时，改变渲染精度来使圆或圆弧光滑些。注：提高精度会导致空间数据文件增大，渲染性能下降

Inherited from: IOpenMapBaseParam.renderAccuracy

# secretKey

• Optional secretKey: string

秘钥(第一次上传打开图时有效，表示此图需要密码保护).

Inherited from: IOpenMapBaseParam.secretKey

# style

• Optional style: IMapStyleParam

样式.

Inherited from: IOpenMapBaseParam.style

# subdependencies

• Optional subdependencies: string

地图依赖项(这是子项的设置，与mapdependencies不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapdependencies一样的话，则为空

Inherited from: IOpenMapBaseParam.subdependencies

# subfrom

• Optional subfrom: string

地图来源参数(这是子项的设置，与mapfrom不同的是，这个没有转化为基础图形，有可能还有依赖关系）.如与mapfrom一样的话，则为空

Inherited from: IOpenMapBaseParam.subfrom

# uploadname

• Optional uploadname: string

上传时的文件名.

Inherited from: IOpenMapBaseParam.uploadname

vjmap / Exports / IUpdateStyle

# Interface: IUpdateStyle

更新样式接口

# Table of contents

# Properties

# Properties

# backcolor

• Optional backcolor: number

颜色.

# clipbounds

• Optional clipbounds: number | [number, number, number, number]

地图裁剪范围，范围如[x1,y1,x2,y2].如果只有数字的话，表示是缩放系数

# expression

• Optional expression: string

表达式.

# layeroff

• Optional layeroff: string | number[]

要关的图层索引列表，格式如[2,4]. layeron与layeroff只要输入一个即可

# layeron

• Optional layeron: string | number[]

要开的图层索引列表，格式如[0,1,3].

# lineweight

• Optional lineweight: string | number[]

线宽，格式如[1，1，1，1，0].表式第1，2，3，4级线宽开，第5级线宽关，大于第5级的，以最后设置的级别状态为主，所以也是关。如为空，则和原图线宽显示状态相同

# mapid

• Optional mapid: string

地图ID(为空时采用当前打开的mapid).

# name

• Optional name: string

样式名称.

# version

• Optional version: string

地图版本(为空时采用当前打开的地图版本).

vjmap / Exports / IWmsTileUrl

# Interface: IWmsTileUrl

wms服务url地址接口

# Table of contents

# Properties

# Properties

# backgroundColor

• Optional backgroundColor: string

不透明时的背景颜色，默认为白色。格式必须为rgb(r,g,b)或rgba(r,g,b,a),a不透明应该是255.

# bbox

• Optional bbox: string

范围，缺省{bbox-epsg-3857}. (如果要获取地图cad一个范围的wms数据无需任何坐标转换，将此范围填cad范围,srs,crs,mapbounds填为空).

# crs

• Optional crs: string | string[]

cad图的坐标系，为空的时候由元数据坐标系决定. 也可直接输入proj4字符串

# fourParameter

• Optional fourParameter: string | string[]

四参数(x偏移,y偏移,缩放，旋转弧度)，可选，对坐标最后进行修正

# height

• Optional height: number

高.

# imageProcessAlg

• Optional imageProcessAlg: number

旋转时图像处理算法. 1或2,默认自动选择（旋转时有用）

# isInverseFourParamter

• Optional isInverseFourParamter: boolean | boolean[]

是否用上面的四参数进行反算，默认false

# layers

• Optional layers: string | string[]

图层名称（为空时采用当前打开的地图图层名称).

# mapbounds

• Optional mapbounds: string

地理真实范围，如有值时,srs将不起作用

# mapid

• Optional mapid: string | string[]

地图ID(为空时采用当前打开的mapid)， 为数组时表时同时请求多个.

# mvt

• Optional mvt: boolean

是否是矢量瓦片.

# srs

• Optional srs: string

当前坐标系,缺省(EPSG:3857).

# transparent

• Optional transparent: boolean

是否透明.

# useImageRotate

• Optional useImageRotate: boolean

是否考虑旋转，在不同坐标系中转换是需要考虑。默认自动考虑是否需要旋转.

# version

• Optional version: string | string[]

地图版本(为空时采用当前打开的地图版本).

# webMapType

• Optional webMapType: "WGS84" | "GCJ02" | "BD09LL" | "BD09MC"

当前互联网底图地图类型 WGS84(84坐标，如天地图，osm), GCJ02(火星坐标，如高德，腾讯地图)， BD09LL(百度经纬度坐标，如百度地图)， BD09MC(百度墨卡托米制坐标，如百度地图)

# width

• Optional width: number

宽.

vjmap / Exports / IWorkspace

# Interface: IWorkspace

工作区（工作区主要用来对图纸进行分类管理。不同工作区的图纸存在的位置不同，查看不同工作区的图纸，需要切换到相应工作区才能查看）

# Table of contents

# Properties

# Properties

# alias

• Optional alias: string

工作区别名(可以是中文).

# isPublic

• Optional isPublic: boolean

是否公开（不公开的话，无法通过获取工作区功能来获取到此工作区信息）.

# name

• name: string

工作区名称(英文名称，不要有特殊字符，用于做为键值和路由).

# workDir

• Optional workDir: string

工作区目录，如果是相对于工作区路径的一个路径或绝对路径，如为空的话，则用工作区名称做为工作目录.

vjmap / Exports / KeyframeOptions

# Interface: KeyframeOptions<V>

# Type parameters

Name Default
V number

# Table of contents

# Properties

# Properties

# duration

• Optional duration: number

# ease

• Optional ease: Easing | Easing[]

# from

• Optional from: V

# offset

• Optional offset: number[]

# to

• to: V | V[]

vjmap / Exports / LineGeoJsonInput

# Interface: LineGeoJsonInput

# Table of contents

# Properties

# Properties

# points

• points: GeoPointLike[]

# properties

• Optional properties: object

vjmap / Exports / ListenersMap

# Interface: ListenersMap

# Table of contents

# Properties

# Properties

# close

• close: (event: CloseEvent) => void | { handleEvent: (event: CloseEvent) => void }[]

# error

• error: (event: ErrorEvent) => void | { handleEvent: (event: ErrorEvent) => void }[]

# message

• message: (event: MessageEvent) => void | { handleEvent: (event: MessageEvent) => void }[]

# open

• open: (event: WebSocketEvent) => void | { handleEvent: (event: WebSocketEvent) => void }[]

vjmap / Exports / MarkerClusterData

# Interface: MarkerClusterData

# Indexable

▪ [propName: string]: any

# Table of contents

# Properties

# Properties

# point

• point: GeoPointLike

# properties

• Optional properties: Record<string, any>

vjmap / Exports / MarkerClusterOptions

# Interface: MarkerClusterOptions

# Table of contents

# Properties

# Properties

# allowOverlap

• Optional allowOverlap: boolean

是否允许重叠，默认false.

# allowOverlapMaxZoom

• Optional allowOverlapMaxZoom: number

允许重叠的最大缩放级别，小于或等于此级别才会处理重叠，超过此级时会全部显示当前所有的(如果不允许重叠时有效).默认4级

# cameraNearFront

• Optional cameraNearFront: boolean

离相机最近的在显示在前面，默认false.

# createMarker

• createMarker: (curMarkerData: MarkerClusterData, clusterMarkersData: MarkerClusterData[]) => Marker | Text

# Type declaration

▸ (curMarkerData: MarkerClusterData, clusterMarkersData: MarkerClusterData[]): Marker | Text

# Parameters
Name Type
curMarkerData MarkerClusterData
clusterMarkersData MarkerClusterData[]

Returns: Marker | Text

# data

• data: FeatureCollection<Geometry | GeometryCollection, Properties> | MarkerClusterData[]

数据内容.(传入坐标为CAD地理坐标)

# markerHeight

• Optional markerHeight: number

marker div的像素高，用于计算重叠时需要，默认40. 如果在data的properties设置了属性markerHeight，则以data设置的为准

# markerWidth

• Optional markerWidth: number

marker div的像素宽，用于计算重叠时需要，默认40. 如果在data的properties设置了属性markerWidth，则以data设置的为准

# updateMarker

• Optional updateMarker: (curMarkerData: MarkerClusterData, clusterMarkersData: MarkerClusterData[], marker: Marker) => undefined | Marker | Text

# Type declaration

▸ (curMarkerData: MarkerClusterData, clusterMarkersData: MarkerClusterData[], marker: Marker): undefined | Marker | Text

# Parameters
Name Type
curMarkerData MarkerClusterData
clusterMarkersData MarkerClusterData[]
marker Marker

Returns: undefined | Marker | Text

vjmap / Exports / markerOptions

# Interface: markerOptions

# Hierarchy

  • MarkerOptions

    ↳ markerOptions

# Table of contents

# Properties

# Properties

# height

• Optional height: number

高度值.

# lngLat

• Optional lngLat: [number, number] | LngLat | {} | {}

LngLat值.

# maxZoom

• Optional maxZoom: number

显示的最大级别.

# minZoom

• Optional minZoom: number

显示的最小级别.

# removeWhenNoInMapView

• Optional removeWhenNoInMapView: boolean

设置当marker不在当前地图视图范围内时，将自动移除。进入视图范围内时，将自动增加上

# removeWhenNoInMapViewPadding

• Optional removeWhenNoInMapViewPadding: boolean

设置当marker不在当前地图视图范围内时，将自动移除。范围向外扩的像素范围，默认500px，向视图范围往外扩些像素，在平移的时候，能看到marker，体验效果好些。

# scaleMaxZoom

• Optional scaleMaxZoom: number

设置能缩放的最大级别。如果小于这个级别，div将根据缩小级别自动缩小比例。默认不会自动缩放

vjmap / Exports / Math2D / UvBox

# Interface: UvBox

Math2D.UvBox

Box to store UV coordinates.

# Table of contents

# Properties

# Properties

# s0

• s0: number

# s1

• s1: number

# t0

• t0: number

# t1

• t1: number

vjmap / Exports / Methods

# Interface: Methods

# Table of contents

# Properties

# Properties

# DELETE

• DELETE: "DELETE"

# GET

• GET: "GET"

# HEAD

• HEAD: "HEAD"

# OPTIONS

• OPTIONS: "OPTIONS"

# PATCH

• PATCH: "PATCH"

# POST

• POST: "POST"

# PUT

• PUT: "PUT"

vjmap / Exports / MiniMapControlOption

# Interface: MiniMapControlOption

# Table of contents

# Properties

# Properties

# boxZoom

• Optional boxZoom: boolean

# center

• Optional center: [number, number]

# containerStyle

• Optional containerStyle: Partial<CSSStyleDeclaration>

# doubleClickZoom

• Optional doubleClickZoom: boolean

# dragPan

• Optional dragPan: boolean

# dragRotate

• Optional dragRotate: boolean

# fillColor

• Optional fillColor: string

# fillOpacity

• Optional fillOpacity: number

# height

• Optional height: string

# id

• Optional id: string

# keyboard

• Optional keyboard: boolean

# lineColor

• Optional lineColor: string

# lineOpacity

• Optional lineOpacity: number

# lineWidth

• Optional lineWidth: number

# maxBounds

• Optional maxBounds: LngLatBounds

# scrollZoom

• Optional scrollZoom: boolean

# style

• Optional style: string | Style

# touchZoomRotate

• Optional touchZoomRotate: boolean

# width

• Optional width: string

# zoom

• Optional zoom: number

# zoomAdjust

• Optional zoomAdjust: null

vjmap / Exports / MousePositionControlOption

# Interface: MousePositionControlOption

# Table of contents

# Properties

# Properties

# digits

• Optional digits: number

# labelFormat

• Optional labelFormat: (lng: number, lat: number, x: number, y: number, map?: Map) => string

# Type declaration

▸ (lng: number, lat: number, x: number, y: number, map?: Map): string

# Parameters
Name Type
lng number
lat number
x number
y number
map? Map

Returns: string

# projection

• Optional projection: Projection

# showBearing

• Optional showBearing: boolean

# showLatLng

• Optional showLatLng: boolean

# showPitch

• Optional showPitch: boolean

# showZoom

• Optional showZoom: boolean

# style

• Optional style: object

# Type declaration
Name Type
backgroundColor string
border string

# trackCenter

• Optional trackCenter: boolean

vjmap / Exports / Options

# Interface: Options

# Table of contents

# Properties

# Properties

# WebSocket

• Optional WebSocket: any

# connectionTimeout

• Optional connectionTimeout: number

# debug

• Optional debug: boolean

# maxEnqueuedMessages

• Optional maxEnqueuedMessages: number

# maxReconnectionDelay

• Optional maxReconnectionDelay: number

# maxRetries

• Optional maxRetries: number

# minReconnectionDelay

• Optional minReconnectionDelay: number

# minUptime

• Optional minUptime: number

# reconnectionDelayGrowFactor

• Optional reconnectionDelayGrowFactor: number

# startClosed

• Optional startClosed: boolean

vjmap / Exports / OverlayLayerBaseOptions

# Interface: OverlayLayerBaseOptions

# Table of contents

# Properties

# Properties

# filter

• Optional filter: any

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

# isHoverPointer

• Optional isHoverPointer: boolean

# layerId

• Optional layerId: string

# maxzoom

• Optional maxzoom: number

# minzoom

• Optional minzoom: number

# sourceId

• Optional sourceId: string

# sourceLayer

• Optional sourceLayer: string

# visibility

• Optional visibility: "visible" | "none"

vjmap / Exports / PhysicsSpringOptions

# Interface: PhysicsSpringOptions

# Table of contents

# Properties

# Properties

# damping

• Optional damping: number

# mass

• Optional mass: number

# stiffness

• Optional stiffness: number

# velocity

• Optional velocity: number

vjmap / Exports / PlaybackControls

# Interface: PlaybackControls

# Table of contents

# Properties

# Properties

# stop

• stop: () => void

# Type declaration

▸ (): void

Returns: void

vjmap / Exports / PlaybackOptions

# Interface: PlaybackOptions<V>

Playback options common to all animations.

# Type parameters

Name
V

# Table of contents

# Properties

# Properties

# autoplay

• Optional autoplay: boolean

Whether to autoplay the animation when animate is called. If set to false, the animation must be started manually via the returned play method.

# driver

• Optional driver: Driver

# elapsed

• Optional elapsed: number

# from

• Optional from: V

# onComplete

• Optional onComplete: () => void

# Type declaration

▸ (): void

Returns: void

# onPlay

• Optional onPlay: () => void

# Type declaration

▸ (): void

Returns: void

# onRepeat

• Optional onRepeat: () => void

# Type declaration

▸ (): void

Returns: void

# onStop

• Optional onStop: () => void

# Type declaration

▸ (): void

Returns: void

# onUpdate

• Optional onUpdate: (latest: V) => void

# Type declaration

▸ (latest: V): void

# Parameters
Name Type
latest V

Returns: void

# repeat

• Optional repeat: number

# repeatDelay

• Optional repeatDelay: number

# repeatType

• Optional repeatType: "loop" | "reverse" | "mirror"

# type

• Optional type: "spring" | "decay" | "keyframes"

vjmap / Exports / PointGeoJsonInput

# Interface: PointGeoJsonInput

# Table of contents

# Properties

# Properties

# point

• point: GeoPointLike

# properties

• Optional properties: object

vjmap / Exports / PolygonOptions

# Interface: PolygonOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# data

• data: any

# fillAntialias

• Optional fillAntialias: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# fillColor

• Optional fillColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# fillOpacity

• Optional fillOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# fillOutlineColor

• Optional fillOutlineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# fillPattern

• Optional fillPattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# fillSortKey

• Optional fillSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# fillTranslate

• Optional fillTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# fillTranslateAnchor

• Optional fillTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / PolylineArrowOptions

# Interface: PolylineArrowOptions

# Table of contents

# Properties

# Properties

# animated

• Optional animated: boolean

# beforeId

• Optional beforeId: string

# borderBlur

• Optional borderBlur: number

# borderColor

• Optional borderColor: string

# borderGapWidth

• Optional borderGapWidth: number

# borderGradient

• Optional borderGradient: string

# borderMiterLimit

• Optional borderMiterLimit: number

# borderOffset

• Optional borderOffset: number

# borderOpacity

• Optional borderOpacity: number

# borderTranslateAnchor

• Optional borderTranslateAnchor: string

# borderWidth

• Optional borderWidth: number

# cursor

• Optional cursor: string

# dirIconColor

• Optional dirIconColor: string

# dirImageColor

• Optional dirImageColor: string

# dirImageHeight

• Optional dirImageHeight: number

# dirImageSrc

• Optional dirImageSrc: string

# dirImageWidth

• Optional dirImageWidth: number

# dirLayout

• Optional dirLayout: object

# dirSize

• Optional dirSize: number

# dirSpacing

• Optional dirSpacing: number

# lineBlur

• Optional lineBlur: number

# lineCap

• Optional lineCap: string

# lineColor

• Optional lineColor: string

# lineGapWidth

• Optional lineGapWidth: number

# lineGradient

• Optional lineGradient: string

# lineJoin

• Optional lineJoin: string

# lineMiterLimit

• Optional lineMiterLimit: number

# lineOffset

• Optional lineOffset: number

# lineOpacity

• Optional lineOpacity: number

# lineSortKey

• Optional lineSortKey: number

# lineTranslate

• Optional lineTranslate: number[]

# lineTranslateAnchor

• Optional lineTranslateAnchor: string

# lineWidth

• Optional lineWidth: number

# map

• Optional map: Map

# maxZoom

• Optional maxZoom: number

# minZoom

• Optional minZoom: number

# path

• Optional path: any

# showBorder

• Optional showBorder: boolean

# showDir

• Optional showDir: boolean

# strokeDasharray

• Optional strokeDasharray: number[]

# strokeImage

• Optional strokeImage: string

# strokeStyle

• Optional strokeStyle: string

# visible

• Optional visible: boolean

# zIndex

• Optional zIndex: number

vjmap / Exports / PolylineOptions

# Interface: PolylineOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# data

• data: any

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# lineBlur

• Optional lineBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# lineCap

• Optional lineCap: ExpressionSpecificationEx | "butt" | "round" | "square" | { stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [number, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [string | number | boolean, "butt" | "round" | "square"][] ; type: "categorical" } | { default?: "butt" | "round" | "square" ; property: string ; type: "identity" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "exponential" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: number ; zoom: number }, "butt" | "round" | "square"][] ; type: "interval" } | { default?: "butt" | "round" | "square" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "butt" | "round" | "square"][] ; type: "categorical" }

# lineColor

• Optional lineColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# lineDasharray

• Optional lineDasharray: number[] | ExpressionSpecificationEx | { stops: [number, number[]][] ; type: "exponential" } | { stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [number, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [string | number | boolean, number[]][] ; type: "categorical" } | { default?: number[] ; property: string ; type: "identity" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "exponential" } | { default?: number[] ; property: string ; stops: [{ value: number ; zoom: number }, number[]][] ; type: "interval" } | { default?: number[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number[]][] ; type: "categorical" }

# lineGapWidth

• Optional lineGapWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# lineGradient

• Optional lineGradient: ExpressionSpecificationEx

# lineJoin

• Optional lineJoin: ExpressionSpecificationEx | "round" | "bevel" | "miter" | { stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [number, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [string | number | boolean, "round" | "bevel" | "miter"][] ; type: "categorical" } | { default?: "round" | "bevel" | "miter" ; property: string ; type: "identity" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "exponential" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: number ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "interval" } | { default?: "round" | "bevel" | "miter" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "round" | "bevel" | "miter"][] ; type: "categorical" }

# lineMiterMimit

• Optional lineMiterMimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# lineOffset

• Optional lineOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# lineOpacity

• Optional lineOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# linePattern

• Optional linePattern: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# lineRoundLimit

• Optional lineRoundLimit: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# lineSortKey

• Optional lineSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# lineTranslate

• Optional lineTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# lineTranslateAnchor

• Optional lineTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# lineWidth

• Optional lineWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / Response

# Interface: Response

# Table of contents

# Properties

# Properties

# data

• Optional data: string | Record<string, unknown>

# response

• response: Record<string, unknown>

# status

• status: number

# xhr

• xhr: XMLHttpRequest

vjmap / Exports / ScriptDefaultOptions

# Interface: ScriptDefaultOptions

# Table of contents

# Properties

# Properties

# async

• Optional async: boolean

# injectLocation

• Optional injectLocation: string

# src

• src: string

# strategy

• Optional strategy: string

vjmap / Exports / SkyLayerOptions

# Interface: SkyLayerOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# skyAtmosphereColor

• Optional skyAtmosphereColor: string

# skyAtmosphereHaloColor

• Optional skyAtmosphereHaloColor: string

# skyAtmosphereSun

• Optional skyAtmosphereSun: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# skyAtmosphereSunIntensity

• Optional skyAtmosphereSunIntensity: number

# skyGradient

• Optional skyGradient: ExpressionSpecificationEx

# skyGradientCenter

• Optional skyGradientCenter: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# skyGradientRadius

• Optional skyGradientRadius: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# skyOpacity

• Optional skyOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# skyType

• Optional skyType: ExpressionSpecificationEx | "gradient" | "atmosphere" | { stops: [number, "gradient" | "atmosphere"][] ; type: "exponential" } | { stops: [number, "gradient" | "atmosphere"][] ; type: "interval" }

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / SpringOptions

# Interface: SpringOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# bounce

• Optional bounce: number

# damping

• Optional damping: number

Inherited from: PhysicsSpringOptions.damping

# duration

• Optional duration: number

# from

• Optional from: number

# mass

• Optional mass: number

Inherited from: PhysicsSpringOptions.mass

# restDelta

• Optional restDelta: number

# restSpeed

• Optional restSpeed: number

# stiffness

• Optional stiffness: number

Inherited from: PhysicsSpringOptions.stiffness

# to

• Optional to: number

# velocity

• Optional velocity: number

Inherited from: PhysicsSpringOptions.velocity

vjmap / Exports / SvgElementOptions

# Interface: SvgElementOptions

# Table of contents

# Properties

# Properties

# bounds

• Optional bounds: GeoBounds | [number, number, number, number]

元素地理范围，如果不填，会根据传入的坐标自动计算，但对于一些复杂的图形，需传入，

# event

• Optional event: (svgParentElement: SVGSVGElement) => {}

事件，在回调函数里，响应要处理的事件，每次更新图形会重新执行

# Type declaration

▸ (svgParentElement: SVGSVGElement): object

# Parameters
Name Type
svgParentElement SVGSVGElement

Returns: object

# hidden

• Optional hidden: boolean

是否不显示

# html

• html: string

元素字符串内容，地理坐标用来表示，长度用来代表

# id

• Optional id: string | number

id

# maxZoom

• Optional maxZoom: boolean

最大缩放级别

# minZoom

• Optional minZoom: number

最小缩放级别

vjmap / Exports / SvgOverlayOptions

# Interface: SvgOverlayOptions

# Table of contents

# Properties

# Properties

# divClassName

• Optional divClassName: string

类名

# maxDivSize

• Optional maxDivSize: number

放大div时，最大的div大小，超过了就像素放大了

# maxPitch

• Optional maxPitch: number

显示最大倾斜角

# maxZoom

• Optional maxZoom: number

显示最小级别

# minZoom

• Optional minZoom: number

显示最大级别

# noUpdateBoundsWhenMoveend

• Optional noUpdateBoundsWhenMoveend: boolean

当移动结束时不自动更新范围

# svgMaxHeight

• Optional svgMaxHeight: number

svg初始化时最大像素高,默认1000

# svgMaxWidth

• Optional svgMaxWidth: number

svg初始化时最大像素宽,默认1000

# svgOffset

• Optional svgOffset: number

svg初始化时Offset像素距离,默认100

# updateDivSize

• Optional updateDivSize: boolean

自动更新div大小，（如果需要svg放大，需要设置为true)

vjmap / Exports / SymbolOptions

# Interface: SymbolOptions

# Hierarchy

# Table of contents

# Properties

# Properties

# data

• data: any

# filter

• Optional filter: any

Inherited from: OverlayLayerBaseOptions.filter

# iconAllowOverlap

• Optional iconAllowOverlap: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# iconAnchor

• Optional iconAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | ExpressionSpecificationEx | { stops: [number, Anchor][] ; type: "exponential" } | { stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [string | number | boolean, Anchor][] ; type: "categorical" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; type: "identity" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, Anchor][] ; type: "categorical" }

# iconColor

• Optional iconColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# iconHaloBlur

• Optional iconHaloBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# iconHaloColor

• Optional iconHaloColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# iconHaloWidth

• Optional iconHaloWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# iconIgnorePlacement

• Optional iconIgnorePlacement: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# iconImage

• Optional iconImage: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# iconKeepUpright

• Optional iconKeepUpright: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# iconOffset

• Optional iconOffset: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [string | number | boolean, [number, number]][] ; type: "categorical" } | { default?: [number, number] ; property: string ; type: "identity" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, [number, number]][] ; type: "categorical" }

# iconOpacity

• Optional iconOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# iconOptional

• Optional iconOptional: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# iconPadding

• Optional iconPadding: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# iconPitchAlignment

• Optional iconPitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

# iconRotate

• Optional iconRotate: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# iconRotationAlignment

• Optional iconRotationAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

# iconSize

• Optional iconSize: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# iconTextFit

• Optional iconTextFit: ExpressionSpecificationEx | "none" | "width" | "height" | "both" | { stops: [number, "none" | "width" | "height" | "both"][] ; type: "exponential" } | { stops: [number, "none" | "width" | "height" | "both"][] ; type: "interval" }

# iconTextFitPadding

• Optional iconTextFitPadding: [number, number, number, number] | ExpressionSpecificationEx | { stops: [number, [number, number, number, number]][] ; type: "exponential" } | { stops: [number, [number, number, number, number]][] ; type: "interval" }

# iconTranslate

• Optional iconTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# iconTranslateAnchor

• Optional iconTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# isHoverFeatureState

• Optional isHoverFeatureState: boolean

Inherited from: OverlayLayerBaseOptions.isHoverFeatureState

# isHoverPointer

• Optional isHoverPointer: boolean

Inherited from: OverlayLayerBaseOptions.isHoverPointer

# layerId

• Optional layerId: string

Inherited from: OverlayLayerBaseOptions.layerId

# maxzoom

• Optional maxzoom: number

Inherited from: OverlayLayerBaseOptions.maxzoom

# minzoom

• Optional minzoom: number

Inherited from: OverlayLayerBaseOptions.minzoom

# sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBaseOptions.sourceId

# sourceLayer

• Optional sourceLayer: string

Inherited from: OverlayLayerBaseOptions.sourceLayer

# symbolAvoidEdges

• Optional symbolAvoidEdges: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# symbolPlacement

• Optional symbolPlacement: "line" | ExpressionSpecificationEx | "point" | "line-center" | { stops: [number, "line" | "point" | "line-center"][] ; type: "exponential" } | { stops: [number, "line" | "point" | "line-center"][] ; type: "interval" }

# symbolSortKey

• Optional symbolSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# symbolSpacing

• Optional symbolSpacing: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# symbolZOrder

• Optional symbolZOrder: "source" | ExpressionSpecificationEx | "auto" | "viewport-y" | { stops: [number, "source" | "auto" | "viewport-y"][] ; type: "exponential" } | { stops: [number, "source" | "auto" | "viewport-y"][] ; type: "interval" }

# textAllowOverlap

• Optional textAllowOverlap: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# textAnchor

• Optional textAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | ExpressionSpecificationEx | { stops: [number, Anchor][] ; type: "exponential" } | { stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [string | number | boolean, Anchor][] ; type: "categorical" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; type: "identity" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, Anchor][] ; type: "categorical" }

# textColor

• Optional textColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# textField

• Optional textField: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# textFont

• Optional textFont: string[] | ExpressionSpecificationEx | { stops: [number, string[]][] ; type: "exponential" } | { stops: [number, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [number, string[]][] ; type: "exponential" } | { default?: string[] ; property: string ; stops: [number, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [string | number | boolean, string[]][] ; type: "categorical" } | { default?: string[] ; property: string ; type: "identity" } | { default?: string[] ; property: string ; stops: [{ value: number ; zoom: number }, string[]][] ; type: "exponential" } | { default?: string[] ; property: string ; stops: [{ value: number ; zoom: number }, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string[]][] ; type: "categorical" }

# textHaloBlur

• Optional textHaloBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textHaloColor

• Optional textHaloColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }

# textHaloWidth

• Optional textHaloWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textIgnorePlacement

• Optional textIgnorePlacement: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# textJustify

• Optional textJustify: "center" | "left" | "right" | ExpressionSpecificationEx | "auto" | { stops: [number, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { stops: [number, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [number, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [number, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [string | number | boolean, "center" | "left" | "right" | "auto"][] ; type: "categorical" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; type: "identity" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: number ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: number ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "categorical" }

# textKeepUpright

• Optional textKeepUpright: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# textLetterSpacing

• Optional textLetterSpacing: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textLineHeight

• Optional textLineHeight: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textMaxAngle

• Optional textMaxAngle: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# textMaxWidth

• Optional textMaxWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textOffset

• Optional textOffset: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [string | number | boolean, [number, number]][] ; type: "categorical" } | { default?: [number, number] ; property: string ; type: "identity" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, [number, number]][] ; type: "categorical" }

# textOpacity

• Optional textOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textOptional

• Optional textOptional: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }

# textPadding

• Optional textPadding: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }

# textPitchAlignment

• Optional textPitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

# textRadialOffset

• Optional textRadialOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textRotate

• Optional textRotate: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textRotationAlignment

• Optional textRotationAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }

# textSize

• Optional textSize: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }

# textTransform

• Optional textTransform: ExpressionSpecificationEx | "none" | "uppercase" | "lowercase" | { stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [string | number | boolean, "none" | "uppercase" | "lowercase"][] ; type: "categorical" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; type: "identity" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: number ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: number ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "categorical" }

# textTranslate

• Optional textTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }

# textTranslateAnchor

• Optional textTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }

# textVariableAnchor

• Optional textVariableAnchor: ExpressionSpecificationEx | Anchor[] | { stops: [number, Anchor[]][] ; type: "exponential" } | { stops: [number, Anchor[]][] ; type: "interval" }

# textWritingMode

• Optional textWritingMode: ExpressionSpecificationEx | ("vertical" | "horizontal")[] | { stops: [number, ("vertical" | "horizontal")[]][] ; type: "exponential" } | { stops: [number, ("vertical" | "horizontal")[]][] ; type: "interval" }

# visibility

• Optional visibility: "visible" | "none"

Inherited from: OverlayLayerBaseOptions.visibility

vjmap / Exports / TextOptions

# Interface: TextOptions

# Hierarchy

  • MarkerOptions

    ↳ TextOptions

# Table of contents

# Properties

# Properties

# style

• Optional style: object

文本样式.

# text

• Optional text: string

文本内容.

vjmap / Exports / ThreeJsContext

# Interface: ThreeJsContext

# Table of contents

# Methods

# Methods

# Object3D

▸ Object3D(options: any): any

# Parameters
Name Type
options any

Returns: any

# add

▸ add(obj: any, layerId?: string, sourceId?: string): any

# Parameters
Name Type
obj any
layerId? string
sourceId? string

Returns: any

# clear

▸ clear(layerId?: string, dispose?: boolean): any

# Parameters
Name Type
layerId? string
dispose? boolean

Returns: any

# coneMesh

▸ coneMesh(co: GeoPoint, opts?: { animation?: boolean ; animationUpDown?: boolean ; color?: string | number ; height?: number ; obj3dOpts?: object ; size?: number }): any

创建一个四棱锥

# Parameters
Name Type
co GeoPoint
opts? object
opts.animation? boolean
opts.animationUpDown? boolean
opts.color? string | number
opts.height? number
opts.obj3dOpts? object
opts.size? number

Returns: any

# createSkyLayer

▸ createSkyLayer(): void

Returns: void

# createTerrainLayer

▸ createTerrainLayer(): void

Returns: void

# defaultLights

▸ defaultLights(): any

Returns: any

# dispose

▸ dispose(): any

Returns: any

# extrusion

▸ extrusion(options: any): any

# Parameters
Name Type
options any

Returns: any

# findParent3DObject

▸ findParent3DObject(mesh: any): any

# Parameters
Name Type
mesh any

Returns: any

# flyline

▸ flyline(opts: { color: string | number ; color2?: string | number ; count?: number ; height?: number ; opacity?: number ; range?: number ; size?: number ; source: GeoPoint ; speed?: number ; target: GeoPoint }): any

创建一条飞行线

# Parameters
Name Type
opts object
opts.color string | number
opts.color2? string | number
opts.count? number
opts.height? number
opts.opacity? number
opts.range? number
opts.size? number
opts.source GeoPoint
opts.speed? number
opts.target GeoPoint

Returns: any

# getFeatureCenter

▸ getFeatureCenter(feature: any, obj: any, level: number): any

# Parameters
Name Type
feature any
obj any
level number

Returns: any

# getObjectHeightOnFloor

▸ getObjectHeightOnFloor(coords: any, obj: any, level: number): any

# Parameters
Name Type
coords any
obj any
level number

Returns: any

# getSunPosition

▸ getSunPosition(date: any, coords: any): any

# Parameters
Name Type
date any
coords any

Returns: any

# getSunSky

▸ getSunSky(date: any, sunPos: any): any

# Parameters
Name Type
date any
sunPos any

Returns: any

# getSunTimes

▸ getSunTimes(date: any, coords: any): any

# Parameters
Name Type
date any
coords any

Returns: any

# getWorldSize

▸ getWorldSize(): number

threejs世界坐标总长度.

Returns: number

# label

▸ label(options: any): any

# Parameters
Name Type
options any

Returns: any

# line

▸ line(options: any): any

# Parameters
Name Type
options any

Returns: any

# loadTexture

▸ loadTexture(img: string, defaultImg?: string): any

加载材质，要使用base64图片，返回 THREE.Texture 对象.

# Parameters
Name Type
img string
defaultImg? string

Returns: any

# mapToWorld

▸ mapToWorld(coords: any): any

地图几何坐标转threejs世界坐标.

# Parameters
Name Type
coords any

Returns: any

# mapToWorldLength

▸ mapToWorldLength(coords: any): any

threejs世界坐标地转图几何坐标.

# Parameters
Name Type
coords any

Returns: any

▸ mapToWorldLength(len: number): number

地图几何长度转threejs世界坐标长度.

# Parameters
Name Type
len number

Returns: number

# memory

▸ memory(): any

Returns: any

# programs

▸ programs(): any

Returns: any

# projectToWorld

▸ projectToWorld(coords: any): any

# Parameters
Name Type
coords any

Returns: any

# projectedUnitsPerMeter

▸ projectedUnitsPerMeter(lat: any): any

# Parameters
Name Type
lat any

Returns: any

# queryRenderedFeatures

▸ queryRenderedFeatures(point: any): any

# Parameters
Name Type
point any

Returns: any

# radar

▸ radar(co: GeoPoint, opts?: { color1?: string | number ; color2?: string | number ; size?: number ; speed?: number ; texture1: string ; texture2: string }): any

创建一个扫描雷达

# Parameters
Name Type
co GeoPoint
opts? object
opts.color1? string | number
opts.color2? string | number
opts.size? number
opts.speed? number
opts.texture1 string
opts.texture2 string

Returns: any

# radialGradient

▸ radialGradient(co: GeoPoint, opts?: { color?: any ; size?: number ; speed?: number }): any

创建一个径向渐变球

# Parameters
Name Type
co GeoPoint
opts? object
opts.color? any
opts.size? number
opts.speed? number

Returns: any

# realSunlight

▸ realSunlight(helper?: boolean): any

# Parameters
Name Type
helper? boolean

Returns: any

# remove

▸ remove(obj: any): any

# Parameters
Name Type
obj any

Returns: any

# removeByName

▸ removeByName(name: string): any

# Parameters
Name Type
name string

Returns: any

# removeLayer

▸ removeLayer(layerId: string): any

# Parameters
Name Type
layerId string

Returns: any

# repaint

▸ repaint(): void

Returns: void

# setBuildingShadows

▸ setBuildingShadows(options: any): any

# Parameters
Name Type
options any

Returns: any

# setDefaultView

▸ setDefaultView(options: any, defOptions: any): any

# Parameters
Name Type
options any
defOptions any

Returns: any

# setLayerHeigthProperty

▸ setLayerHeigthProperty(layerId: string, level: number): any

# Parameters
Name Type
layerId string
level number

Returns: any

# setLayerZoomRange

▸ setLayerZoomRange(layerId: string, minZoomLayer: number, maxZoomLayer: number): any

# Parameters
Name Type
layerId string
minZoomLayer number
maxZoomLayer number

Returns: any

# setLayoutProperty

▸ setLayoutProperty(layerId: string, name: string, value: any): any

# Parameters
Name Type
layerId string
name string
value any

Returns: any

# setObjectsScale

▸ setObjectsScale(): any

Returns: any

# setStyle

▸ setStyle(styleId: string, options: any): any

# Parameters
Name Type
styleId string
options any

Returns: any

# setSunlight

▸ setSunlight(newDate: any, coords: any): any

# Parameters
Name Type
newDate any
coords any

Returns: any

# sphere

▸ sphere(options: any): any

# Parameters
Name Type
options any

Returns: any

# toggle

▸ toggle(layerId: string, visible?: boolean): any

# Parameters
Name Type
layerId string
visible? boolean

Returns: any

# toggleLayer

▸ toggleLayer(layerId: string, visible?: boolean): any

# Parameters
Name Type
layerId string
visible? boolean

Returns: any

# tooltip

▸ tooltip(options: any): any

# Parameters
Name Type
options any

Returns: any

# tube

▸ tube(options: any): any

# Parameters
Name Type
options any

Returns: any

# unprojectFromWorld

▸ unprojectFromWorld(v3: any): any

# Parameters
Name Type
v3 any

Returns: any

# update

▸ update(): any

Returns: any

# updateLightHelper

▸ updateLightHelper(): any

Returns: any

# updateSunGround

▸ updateSunGround(sunPos: any): any

# Parameters
Name Type
sunPos any

Returns: any

# updateSunSky

▸ updateSunSky(sunPos: any): any

# Parameters
Name Type
sunPos any

Returns: any

# wall

▸ wall(pts: GeoPoint[], opts?: { color1?: string | number ; color2?: string | number ; flyline?: boolean ; height?: number ; obj3dOpts?: object ; offsetX?: number ; offsetY?: number ; opacity?: number ; repeatX?: number ; repeatY?: number ; texture1?: string ; texture2?: string }): any

创建一个立体光墙

# Parameters
Name Type
pts GeoPoint[]
opts? object
opts.color1? string | number
opts.color2? string | number
opts.flyline? boolean
opts.height? number
opts.obj3dOpts? object
opts.offsetX? number
opts.offsetY? number
opts.opacity? number
opts.repeatX? number
opts.repeatY? number
opts.texture1? string
opts.texture2? string

Returns: any

# wave

▸ wave(co: GeoPoint, opts?: { color?: string | number ; size?: number ; speed?: number ; texture?: string }): any

创建一个波动光圈

# Parameters
Name Type
co GeoPoint
opts? object
opts.color? string | number
opts.size? number
opts.speed? number
opts.texture? string

Returns: any

# waveWall

▸ waveWall(co: GeoPoint, opts?: { color?: string | number ; height?: number ; opacity?: number ; size?: number ; speed?: number ; texture?: string }): any

创建一个波动光圈

# Parameters
Name Type
co GeoPoint
opts? object
opts.color? string | number
opts.height? number
opts.opacity? number
opts.size? number
opts.speed? number
opts.texture? string

Returns: any

# worldToMapLength

▸ worldToMapLength(len: number): number

threejs世界坐标长度转地图几何长度.

# Parameters
Name Type
len number

Returns: number

vjmap / Exports / ThreeJsContextOptions

# Interface: ThreeJsContextOptions

# Table of contents

# Properties

# Properties

# defaultLights

• Optional defaultLights: boolean

# enableDraggingObjects

• Optional enableDraggingObjects: boolean

# enableRotatingObjects

• Optional enableRotatingObjects: boolean

# enableSelectingFeatures

• Optional enableSelectingFeatures: boolean

# enableSelectingObjects

• Optional enableSelectingObjects: boolean

# enableTooltips

• Optional enableTooltips: boolean

# fov

• Optional fov: number

# multiLayer

• Optional multiLayer: boolean

# orthographic

• Optional orthographic: boolean

# passiveRendering

• Optional passiveRendering: boolean

# preserveDrawingBuffer

• Optional preserveDrawingBuffer: boolean

# realSunlight

• Optional realSunlight: boolean

# realSunlightHelper

• Optional realSunlightHelper: boolean

# sky

• Optional sky: boolean

# terrain

• Optional terrain: boolean

vjmap / Exports / ThreeLayerOptions

# Interface: ThreeLayerOptions

# Table of contents

# Properties

# Properties

# context

• context: ThreeJsContext

# id

• Optional id: string

# onAdd

• Optional onAdd: (map: any, gl: any) => void

# Type declaration

▸ (map: any, gl: any): void

# Parameters
Name Type
map any
gl any

Returns: void

# onRemove

• Optional onRemove: () => void

# Type declaration

▸ (): void

Returns: void

# render

• Optional render: (gl: any, matrix: any) => void

# Type declaration

▸ (gl: any, matrix: any): void

# Parameters
Name Type
gl any
matrix any

Returns: void

vjmap / Exports / WebSocketEventListenerMap

# Interface: WebSocketEventListenerMap

# Table of contents

# Properties

# Properties

# close

• close: (event: CloseEvent) => void | { handleEvent: (event: CloseEvent) => void }

# Type declaration

▸ (event: CloseEvent): void | { handleEvent: (event: CloseEvent) => void }

# Parameters
Name Type
event CloseEvent

Returns: void | { handleEvent: (event: CloseEvent) => void }

# error

• error: (event: ErrorEvent) => void | { handleEvent: (event: ErrorEvent) => void }

# Type declaration

▸ (event: ErrorEvent): void | { handleEvent: (event: ErrorEvent) => void }

# Parameters
Name Type
event ErrorEvent

Returns: void | { handleEvent: (event: ErrorEvent) => void }

# message

• message: (event: MessageEvent) => void | { handleEvent: (event: MessageEvent) => void }

# Type declaration

▸ (event: MessageEvent): void | { handleEvent: (event: MessageEvent) => void }

# Parameters
Name Type
event MessageEvent

Returns: void | { handleEvent: (event: MessageEvent) => void }

# open

• open: (event: WebSocketEvent) => void | { handleEvent: (event: WebSocketEvent) => void }

# Type declaration

▸ (event: WebSocketEvent): void | { handleEvent: (event: WebSocketEvent) => void }

# Parameters
Name Type
event WebSocketEvent

Returns: void | { handleEvent: (event: WebSocketEvent) => void }

vjmap / Exports / WebSocketEventMap

# Interface: WebSocketEventMap

# Table of contents

# Properties

# Properties

# close

• close: CloseEvent

# error

• error: ErrorEvent

# message

• message: MessageEvent

# open

• open: WebSocketEvent

vjmap / Exports

# vjmap

# Table of contents

# References

# Namespaces

# Enumerations

# Classes

# Interfaces

# Type aliases

# Variables

# Functions

# References

# Draw

Re-exports: Draw

# angle

Re-exports: angle

# anticipate

Re-exports: anticipate

# applyOffset

Re-exports: applyOffset

# attract

Re-exports: attract

# attractExpo

Re-exports: attractExpo

# backIn

Re-exports: backIn

# backInOut

Re-exports: backInOut

# backOut

Re-exports: backOut

# bezierCurveToPolyline

Re-exports: bezierCurveToPolyline

# bounceIn

Re-exports: bounceIn

# bounceInOut

Re-exports: bounceInOut

# bounceOut

Re-exports: bounceOut

# circIn

Re-exports: circIn

# circInOut

Re-exports: circInOut

# circOut

Re-exports: circOut

# clamp

Re-exports: clamp

# createAnimation

Re-exports: createAnimation

# createAnticipate

Re-exports: createAnticipate

# createAttractor

Re-exports: createAttractor

# createBackIn

Re-exports: createBackIn

# createExpoIn

Re-exports: createExpoIn

# cubicBezier

Re-exports: cubicBezier

# decay

Re-exports: decay

# degreesToRadians

Re-exports: degreesToRadians

# distance

Re-exports: distance

# easeIn

Re-exports: easeIn

# easeInOut

Re-exports: easeInOut

# easeOut

Re-exports: easeOut

# getBezierCurveLength

Re-exports: getBezierCurveLength

# inertia

Re-exports: inertia

# interpolate

Re-exports: interpolate

# isPoint

Re-exports: isPoint

# isPoint3D

Re-exports: isPoint3D

# keyframes

Re-exports: keyframes

# linear

Re-exports: linear

# mirrorEasing

Re-exports: mirrorEasing

# mix

Re-exports: mix

# mixColor

Re-exports: mixColor

# mixComplex

Re-exports: mixComplex

# pipe

Re-exports: pipe

# pointFromVector

Re-exports: pointFromVector

# polylineToBezierCurve

Re-exports: polylineToBezierCurve

# progress

Re-exports: progress

# radiansToDegrees

Re-exports: radiansToDegrees

# reverseEasing

Re-exports: reverseEasing

# smooth

Re-exports: smooth

# smoothFrame

Re-exports: smoothFrame

# snap

Re-exports: snap

# spring

Re-exports: spring

# steps

Re-exports: steps

# toDecimal

Re-exports: toDecimal

# velocityPerFrame

Re-exports: velocityPerFrame

# velocityPerSecond

Re-exports: velocityPerSecond

# wrap

Re-exports: wrap

# Type aliases

# AnimateMarkerType

Ƭ AnimateMarkerType: "breathingAperture" | "rotatingAperture" | "haloRing" | "diffusedAperture" | "rotatingTextBorder" | "fluorescence"

breathingAperture 呼吸的光圈. rotatingAperture 旋转的光环 haloRing 发光的光环 diffusedAperture 扩散的点 rotatingTextBorder 旋转的文本框 fluorescence 荧光点

# AnimationOps

Ƭ AnimationOps<V>: PlaybackOptions<V> & DecayOptions | KeyframeOptions<V> | SpringOptions

# Type parameters

Name
V

# BackgroundLayerSpecification

Ƭ BackgroundLayerSpecification: object

# Type declaration

Name Type
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.background-color? PropertyValueSpecificationEx<ColorSpecification>
paint.background-opacity? PropertyValueSpecificationEx<number>
paint.background-pattern? PropertyValueSpecificationEx<ResolvedImageSpecification>
type "background"

# CameraFunctionSpecificationEx

Ƭ CameraFunctionSpecificationEx<T>: { stops: [number, T][] ; type: "exponential" } | { stops: [number, T][] ; type: "interval" }

# Type parameters

Name
T

# CircleLayerSpecification

Ƭ CircleLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.circle-sort-key? DataDrivenPropertyValueSpecification<number>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.circle-blur? DataDrivenPropertyValueSpecification<number>
paint.circle-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.circle-opacity? DataDrivenPropertyValueSpecification<number>
paint.circle-pitch-alignment? PropertyValueSpecificationEx<"map" | "viewport">
paint.circle-pitch-scale? PropertyValueSpecificationEx<"map" | "viewport">
paint.circle-radius? DataDrivenPropertyValueSpecification<number>
paint.circle-stroke-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.circle-stroke-opacity? DataDrivenPropertyValueSpecification<number>
paint.circle-stroke-width? DataDrivenPropertyValueSpecification<number>
paint.circle-translate? PropertyValueSpecificationEx<[number, number]>
paint.circle-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
source string
source-layer? string
type "circle"

# CircleLayerStyleProp

Ƭ CircleLayerStyleProp: object

# Type declaration

Name Type
circleBlur? DataDrivenPropertyValueSpecification<number>
circleColor? DataDrivenPropertyValueSpecification<ColorSpecification>
circleOpacity? DataDrivenPropertyValueSpecification<number>
circlePitchAlignment? PropertyValueSpecificationEx<"map" | "viewport">
circlePitchScale? PropertyValueSpecificationEx<"map" | "viewport">
circleRadius? DataDrivenPropertyValueSpecification<number>
circleSortKey? DataDrivenPropertyValueSpecification<number>
circleStrokeColor? DataDrivenPropertyValueSpecification<ColorSpecification>
circleStrokeOpacity? DataDrivenPropertyValueSpecification<number>
circleStrokeWidth? DataDrivenPropertyValueSpecification<number>
circleTranslate? PropertyValueSpecificationEx<[number, number]>
circleTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# ColorSpecification

Ƭ ColorSpecification: string

# CompositeFunctionSpecification

Ƭ CompositeFunctionSpecification<T>: { default?: T ; property: string ; stops: [{ value: number ; zoom: number }, T][] ; type: "exponential" } | { default?: T ; property: string ; stops: [{ value: number ; zoom: number }, T][] ; type: "interval" } | { default?: T ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, T][] ; type: "categorical" }

# Type parameters

Name
T

# DataDrivenPropertyValueSpecification

Ƭ DataDrivenPropertyValueSpecification<T>: T | CameraFunctionSpecificationEx<T> | SourceFunctionSpecification<T> | CompositeFunctionSpecification<T> | ExpressionSpecificationEx

# Type parameters

Name
T

# Driver

Ƭ Driver: (update: Update) => DriverControls

# Type declaration

▸ (update: Update): DriverControls

# Parameters

Name Type
update Update

Returns: DriverControls

# Easing

Ƭ Easing: (v: number) => number

# Type declaration

▸ (v: number): number

# Parameters

Name Type
v number

Returns: number

# EasingModifier

Ƭ EasingModifier: (easing: Easing) => Easing

# Type declaration

▸ (easing: Easing): Easing

# Parameters

Name Type
easing Easing

Returns: Easing

# ExpressionSpecificationEx

Ƭ ExpressionSpecificationEx: unknown[]

# FillExtrusionLayerSpecification

Ƭ FillExtrusionLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.fill-extrusion-base? DataDrivenPropertyValueSpecification<number>
paint.fill-extrusion-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.fill-extrusion-height? DataDrivenPropertyValueSpecification<number>
paint.fill-extrusion-opacity? PropertyValueSpecificationEx<number>
paint.fill-extrusion-pattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
paint.fill-extrusion-translate? PropertyValueSpecificationEx<[number, number]>
paint.fill-extrusion-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.fill-extrusion-vertical-gradient? PropertyValueSpecificationEx<boolean>
source string
source-layer? string
type "fill-extrusion"

# FillExtrusionLayerStyleProp

Ƭ FillExtrusionLayerStyleProp: object

# Type declaration

Name Type
fillExtrusionBase? DataDrivenPropertyValueSpecification<number>
fillExtrusionColor? DataDrivenPropertyValueSpecification<ColorSpecification>
fillExtrusionHeight? DataDrivenPropertyValueSpecification<number>
fillExtrusionOpacity? PropertyValueSpecificationEx<number>
fillExtrusionPattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
fillExtrusionTranslate? PropertyValueSpecificationEx<[number, number]>
fillExtrusionTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
fillExtrusionVerticalGradient? PropertyValueSpecificationEx<boolean>
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# FillLayerSpecification

Ƭ FillLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.fill-sort-key? DataDrivenPropertyValueSpecification<number>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.fill-antialias? PropertyValueSpecificationEx<boolean>
paint.fill-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.fill-opacity? DataDrivenPropertyValueSpecification<number>
paint.fill-outline-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.fill-pattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
paint.fill-translate? PropertyValueSpecificationEx<[number, number]>
paint.fill-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
source string
source-layer? string
type "fill"

# FillLayerStyleProp

Ƭ FillLayerStyleProp: object

# Type declaration

Name Type
fillAntialias? PropertyValueSpecificationEx<boolean>
fillColor? DataDrivenPropertyValueSpecification<ColorSpecification>
fillOpacity? DataDrivenPropertyValueSpecification<number>
fillOutlineColor? DataDrivenPropertyValueSpecification<ColorSpecification>
fillPattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
fillSortKey? DataDrivenPropertyValueSpecification<number>
fillTranslate? PropertyValueSpecificationEx<[number, number]>
fillTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# FilterSpecification

Ƭ FilterSpecification: ["has", string] | ["!has", string] | ["==", string, string | number | boolean] | ["!=", string, string | number | boolean] | [">", string, string | number | boolean] | [">=", string, string | number | boolean] | ["<", string, string | number | boolean] | ["<=", string, string | number | boolean] | (string | FilterSpecification)[]

# FogSpecification

Ƭ FogSpecification: object

# Type declaration

Name Type
color? PropertyValueSpecificationEx<ColorSpecification>
horizon-blend? PropertyValueSpecificationEx<number>
range? PropertyValueSpecificationEx<[number, number]>

# FormattedSpecification

Ƭ FormattedSpecification: string

# GeoJSONSourceSpecification

Ƭ GeoJSONSourceSpecification: object

# Type declaration

Name Type
attribution? string
buffer? number
cluster? boolean
clusterMaxZoom? number
clusterMinPoints? number
clusterProperties? unknown
clusterRadius? number
data? unknown
filter? unknown
generateId? boolean
lineMetrics? boolean
maxzoom? number
promoteId? PromoteIdSpecificationEx
tolerance? number
type "geojson"

# GeoPointLike

Ƭ GeoPointLike: [number, number] | [number, number, number] | GeoPoint | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number }

# HeatmapLayerSpecification

Ƭ HeatmapLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.heatmap-color? ExpressionSpecificationEx
paint.heatmap-intensity? PropertyValueSpecificationEx<number>
paint.heatmap-opacity? PropertyValueSpecificationEx<number>
paint.heatmap-radius? DataDrivenPropertyValueSpecification<number>
paint.heatmap-weight? DataDrivenPropertyValueSpecification<number>
source string
source-layer? string
type "heatmap"

# HeatmapLayerStyleProp

Ƭ HeatmapLayerStyleProp: object

# Type declaration

Name Type
filter? FilterSpecification
heatmapColor? ExpressionSpecificationEx
heatmapIntensity? PropertyValueSpecificationEx<number>
heatmapOpacity? PropertyValueSpecificationEx<number>
heatmapRadius? DataDrivenPropertyValueSpecification<number>
heatmapWeight? DataDrivenPropertyValueSpecification<number>
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# HillshadeLayerSpecification

Ƭ HillshadeLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.hillshade-accent-color? PropertyValueSpecificationEx<ColorSpecification>
paint.hillshade-exaggeration? PropertyValueSpecificationEx<number>
paint.hillshade-highlight-color? PropertyValueSpecificationEx<ColorSpecification>
paint.hillshade-illumination-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.hillshade-illumination-direction? PropertyValueSpecificationEx<number>
paint.hillshade-shadow-color? PropertyValueSpecificationEx<ColorSpecification>
source string
source-layer? string
type "hillshade"

# HillshadeLayerStyleProp

Ƭ HillshadeLayerStyleProp: object

# Type declaration

Name Type
filter? FilterSpecification
hillshadeAccentColor? PropertyValueSpecificationEx<ColorSpecification>
hillshadeExaggeration? PropertyValueSpecificationEx<number>
hillshadeHighlightColor? PropertyValueSpecificationEx<ColorSpecification>
hillshadeIlluminationAnchor? PropertyValueSpecificationEx<"map" | "viewport">
hillshadeIlluminationDirection? PropertyValueSpecificationEx<number>
hillshadeShadowColor? PropertyValueSpecificationEx<ColorSpecification>
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# IDbPoint

Ƭ IDbPoint: [number, number, number?]

坐标类型接口

# ImageSourceSpecification

Ƭ ImageSourceSpecification: object

# Type declaration

Name Type
coordinates [[number, number], [number, number], [number, number], [number, number]]
type "image"
url string

# LayerCallback

Ƭ LayerCallback: (arg0: {}) => void

# Type declaration

▸ (arg0: {}): void

# Parameters

Name Type
arg0 object

Returns: void

# LayerRef

Ƭ LayerRef: string | string[] | RegExp | (arg0: LayerSpecification) => boolean

# LayerRefFunc

Ƭ LayerRefFunc: (arg0: LayerRef, ...args: any[]) => void

# Type declaration

▸ (arg0: LayerRef, ...args: any[]): void

# Parameters

Name Type
arg0 LayerRef
...args any[]

Returns: void

# LayerRefFunc0

Ƭ LayerRefFunc0: (arg0: LayerRef) => void

# Type declaration

▸ (arg0: LayerRef): void

# Parameters

Name Type
arg0 LayerRef

Returns: void

# LayerRefFunc1

Ƭ LayerRefFunc1<T1>: (arg0: LayerRef, arg1: T1) => void

# Type parameters

Name
T1

# Type declaration

▸ (arg0: LayerRef, arg1: T1): void

# Parameters

Name Type
arg0 LayerRef
arg1 T1

Returns: void

# LayerRefFunc2

Ƭ LayerRefFunc2<T1, T2>: (arg0: LayerRef, arg1: T1, arg2: T2) => void

# Type parameters

Name
T1
T2

# Type declaration

▸ (arg0: LayerRef, arg1: T1, arg2: T2): void

# Parameters

Name Type
arg0 LayerRef
arg1 T1
arg2 T2

Returns: void

# LayerRefFunc3

Ƭ LayerRefFunc3<T1, T2, T3>: (arg0: LayerRef, arg1: T1, arg2: T2, arg3: T3) => void

# Type parameters

Name
T1
T2
T3

# Type declaration

▸ (arg0: LayerRef, arg1: T1, arg2: T2, arg3: T3): void

# Parameters

Name Type
arg0 LayerRef
arg1 T1
arg2 T2
arg3 T3

Returns: void

# LayerSpecification

Ƭ LayerSpecification: FillLayerSpecification | LineLayerSpecification | SymbolLayerSpecification | CircleLayerSpecification | HeatmapLayerSpecification | FillExtrusionLayerSpecification | RasterLayerSpecification | HillshadeLayerSpecification | BackgroundLayerSpecification | SkyLayerSpecification

# LightSpecification

Ƭ LightSpecification: object

# Type declaration

Name Type
anchor? PropertyValueSpecificationEx<"map" | "viewport">
color? PropertyValueSpecificationEx<ColorSpecification>
intensity? PropertyValueSpecificationEx<number>
position? PropertyValueSpecificationEx<[number, number, number]>

# LineLayerSpecification

Ƭ LineLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.line-cap? DataDrivenPropertyValueSpecification<"butt" | "round" | "square">
layout.line-join? DataDrivenPropertyValueSpecification<"bevel" | "round" | "miter">
layout.line-miter-limit? PropertyValueSpecificationEx<number>
layout.line-round-limit? PropertyValueSpecificationEx<number>
layout.line-sort-key? DataDrivenPropertyValueSpecification<number>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.line-blur? DataDrivenPropertyValueSpecification<number>
paint.line-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.line-dasharray? DataDrivenPropertyValueSpecification<number[]>
paint.line-gap-width? DataDrivenPropertyValueSpecification<number>
paint.line-gradient? ExpressionSpecificationEx
paint.line-offset? DataDrivenPropertyValueSpecification<number>
paint.line-opacity? DataDrivenPropertyValueSpecification<number>
paint.line-pattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
paint.line-translate? PropertyValueSpecificationEx<[number, number]>
paint.line-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.line-width? DataDrivenPropertyValueSpecification<number>
source string
source-layer? string
type "line"

# LineLayerStyleProp

Ƭ LineLayerStyleProp: object

# Type declaration

Name Type
filter? FilterSpecification
lineBlur? DataDrivenPropertyValueSpecification<number>
lineCap? DataDrivenPropertyValueSpecification<"butt" | "round" | "square">
lineColor? DataDrivenPropertyValueSpecification<ColorSpecification>
lineDasharray? DataDrivenPropertyValueSpecification<number[]>
lineGapWidth? DataDrivenPropertyValueSpecification<number>
lineGradient? ExpressionSpecificationEx
lineJoin? DataDrivenPropertyValueSpecification<"bevel" | "round" | "miter">
lineMiterMimit? PropertyValueSpecificationEx<number>
lineOffset? DataDrivenPropertyValueSpecification<number>
lineOpacity? DataDrivenPropertyValueSpecification<number>
linePattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
lineRoundLimit? PropertyValueSpecificationEx<number>
lineSortKey? DataDrivenPropertyValueSpecification<number>
lineTranslate? PropertyValueSpecificationEx<[number, number]>
lineTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
lineWidth? DataDrivenPropertyValueSpecification<number>
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# OffHandler

Ƭ OffHandler: () => void

# Type declaration

▸ (): void

Returns: void

# PromoteIdSpecificationEx

Ƭ PromoteIdSpecificationEx: Record<string, string> | string

# PropName

Ƭ PropName: string

# PropValue

Ƭ PropValue: string | any[] | null | number | {}

# PropertyValueSpecificationEx

Ƭ PropertyValueSpecificationEx<T>: T | CameraFunctionSpecificationEx<T> | ExpressionSpecificationEx

# Type parameters

Name
T

# RasterDEMSourceSpecification

Ƭ RasterDEMSourceSpecification: object

# Type declaration

Name Type
attribution? string
bounds? [number, number, number, number]
encoding? "terrarium" | "mapbox"
maxzoom? number
minzoom? number
tileSize? number
tiles? string[]
type "raster-dem"
url? string
volatile? boolean

# RasterLayerSpecification

Ƭ RasterLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.raster-brightness-max? PropertyValueSpecificationEx<number>
paint.raster-brightness-min? PropertyValueSpecificationEx<number>
paint.raster-contrast? PropertyValueSpecificationEx<number>
paint.raster-fade-duration? PropertyValueSpecificationEx<number>
paint.raster-hue-rotate? PropertyValueSpecificationEx<number>
paint.raster-opacity? PropertyValueSpecificationEx<number>
paint.raster-resampling? PropertyValueSpecificationEx<"linear" | "nearest">
paint.raster-saturation? PropertyValueSpecificationEx<number>
source string
source-layer? string
type "raster"

# RasterLayerStyleProp

Ƭ RasterLayerStyleProp: object

# Type declaration

Name Type
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
rasterBrightnessMax? PropertyValueSpecificationEx<number>
rasterBrightnessMin? PropertyValueSpecificationEx<number>
rasterContrast? PropertyValueSpecificationEx<number>
rasterFadeDuration? PropertyValueSpecificationEx<number>
rasterHueRotate? PropertyValueSpecificationEx<number>
rasterOpacity? PropertyValueSpecificationEx<number>
rasterResampling? PropertyValueSpecificationEx<"linear" | "nearest">
rasterSaturation? PropertyValueSpecificationEx<number>
source? string
sourceLayer? string
visibility? "visible" | "none"

# RasterSourceSpecification

Ƭ RasterSourceSpecification: object

# Type declaration

Name Type
attribution? string
bounds? [number, number, number, number]
maxzoom? number
minzoom? number
scheme? "xyz" | "tms"
tileSize? number
tiles? string[]
type "raster"
url? string
volatile? boolean

# ResolvedImageSpecification

Ƭ ResolvedImageSpecification: string

# SkyLayerSpecification

Ƭ SkyLayerSpecification: object

# Type declaration

Name Type
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.sky-atmosphere-color? ColorSpecification
paint.sky-atmosphere-halo-color? ColorSpecification
paint.sky-atmosphere-sun? PropertyValueSpecificationEx<[number, number]>
paint.sky-atmosphere-sun-intensity? number
paint.sky-gradient? ExpressionSpecificationEx
paint.sky-gradient-center? PropertyValueSpecificationEx<[number, number]>
paint.sky-gradient-radius? PropertyValueSpecificationEx<number>
paint.sky-opacity? PropertyValueSpecificationEx<number>
paint.sky-type? PropertyValueSpecificationEx<"gradient" | "atmosphere">
type "sky"

# SourceBoundUtils

Ƭ SourceBoundUtils: MapGlUtils

# SourceFunctionSpecification

Ƭ SourceFunctionSpecification<T>: { default?: T ; property: string ; stops: [number, T][] ; type: "exponential" } | { default?: T ; property: string ; stops: [number, T][] ; type: "interval" } | { default?: T ; property: string ; stops: [string | number | boolean, T][] ; type: "categorical" } | { default?: T ; property: string ; type: "identity" }

# Type parameters

Name
T

# SourceOrData

Ƭ SourceOrData: SourceSpecification | string | GeoJsonGeomertry

# SourceRef

Ƭ SourceRef: LayerRef

# SourceRefFunc0

Ƭ SourceRefFunc0: (arg0: SourceRef) => void

# Type declaration

▸ (arg0: SourceRef): void

# Parameters

Name Type
arg0 SourceRef

Returns: void

# SourceRefFunc1

Ƭ SourceRefFunc1<T1>: (arg0: SourceRef, arg1: T1) => void

# Type parameters

Name
T1

# Type declaration

▸ (arg0: SourceRef, arg1: T1): void

# Parameters

Name Type
arg0 SourceRef
arg1 T1

Returns: void

# SourceRefFunc2

Ƭ SourceRefFunc2<T1, T2>: (arg0: SourceRef, arg1: T1, arg2: T2) => void

# Type parameters

Name
T1
T2

# Type declaration

▸ (arg0: SourceRef, arg1: T1, arg2: T2): void

# Parameters

Name Type
arg0 SourceRef
arg1 T1
arg2 T2

Returns: void

# SourceRefFunc3

Ƭ SourceRefFunc3<T1, T2, T3>: (arg0: SourceRef, arg1: T1, arg2: T2, arg3: T3) => void

# Type parameters

Name
T1
T2
T3

# Type declaration

▸ (arg0: SourceRef, arg1: T1, arg2: T2, arg3: T3): void

# Parameters

Name Type
arg0 SourceRef
arg1 T1
arg2 T2
arg3 T3

Returns: void

# SourceSpecification

Ƭ SourceSpecification: VectorSourceSpecification | RasterSourceSpecification | RasterDEMSourceSpecification | GeoJSONSourceSpecification | VideoSourceSpecification | ImageSourceSpecification

# StyleSpecification

Ƭ StyleSpecification: object

# Type declaration

Name Type
bearing? number
center? number[]
fog? FogSpecification
glyphs? string
layers LayerSpecification[]
light? LightSpecification
metadata? unknown
name? string
pitch? number
sources Record<string, SourceSpecification>
sprite? string
terrain? TerrainSpecificationEx
transition? TransitionSpecification
version 8
zoom? number

# SymbolLayerSpecification

Ƭ SymbolLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.icon-allow-overlap? PropertyValueSpecificationEx<boolean>
layout.icon-anchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
layout.icon-ignore-placement? PropertyValueSpecificationEx<boolean>
layout.icon-image? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
layout.icon-keep-upright? PropertyValueSpecificationEx<boolean>
layout.icon-offset? DataDrivenPropertyValueSpecification<[number, number]>
layout.icon-optional? PropertyValueSpecificationEx<boolean>
layout.icon-padding? PropertyValueSpecificationEx<number>
layout.icon-pitch-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.icon-rotate? DataDrivenPropertyValueSpecification<number>
layout.icon-rotation-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.icon-size? DataDrivenPropertyValueSpecification<number>
layout.icon-text-fit? PropertyValueSpecificationEx<"none" | "width" | "height" | "both">
layout.icon-text-fit-padding? PropertyValueSpecificationEx<[number, number, number, number]>
layout.symbol-avoid-edges? PropertyValueSpecificationEx<boolean>
layout.symbol-placement? PropertyValueSpecificationEx<"point" | "line" | "line-center">
layout.symbol-sort-key? DataDrivenPropertyValueSpecification<number>
layout.symbol-spacing? PropertyValueSpecificationEx<number>
layout.symbol-z-order? PropertyValueSpecificationEx<"auto" | "viewport-y" | "source">
layout.text-allow-overlap? PropertyValueSpecificationEx<boolean>
layout.text-anchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
layout.text-field? DataDrivenPropertyValueSpecification<FormattedSpecification>
layout.text-font? DataDrivenPropertyValueSpecification<string[]>
layout.text-ignore-placement? PropertyValueSpecificationEx<boolean>
layout.text-justify? DataDrivenPropertyValueSpecification<"auto" | "left" | "center" | "right">
layout.text-keep-upright? PropertyValueSpecificationEx<boolean>
layout.text-letter-spacing? DataDrivenPropertyValueSpecification<number>
layout.text-line-height? DataDrivenPropertyValueSpecification<number>
layout.text-max-angle? PropertyValueSpecificationEx<number>
layout.text-max-width? DataDrivenPropertyValueSpecification<number>
layout.text-offset? DataDrivenPropertyValueSpecification<[number, number]>
layout.text-optional? PropertyValueSpecificationEx<boolean>
layout.text-padding? PropertyValueSpecificationEx<number>
layout.text-pitch-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.text-radial-offset? DataDrivenPropertyValueSpecification<number>
layout.text-rotate? DataDrivenPropertyValueSpecification<number>
layout.text-rotation-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.text-size? DataDrivenPropertyValueSpecification<number>
layout.text-transform? DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">
layout.text-variable-anchor? PropertyValueSpecificationEx<("center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right")[]>
layout.text-writing-mode? PropertyValueSpecificationEx<("horizontal" | "vertical")[]>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.icon-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.icon-halo-blur? DataDrivenPropertyValueSpecification<number>
paint.icon-halo-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.icon-halo-width? DataDrivenPropertyValueSpecification<number>
paint.icon-opacity? DataDrivenPropertyValueSpecification<number>
paint.icon-translate? PropertyValueSpecificationEx<[number, number]>
paint.icon-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.text-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.text-halo-blur? DataDrivenPropertyValueSpecification<number>
paint.text-halo-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.text-halo-width? DataDrivenPropertyValueSpecification<number>
paint.text-opacity? DataDrivenPropertyValueSpecification<number>
paint.text-translate? PropertyValueSpecificationEx<[number, number]>
paint.text-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
source string
source-layer? string
type "symbol"

# SymbolLayerStyleProp

Ƭ SymbolLayerStyleProp: object

# Type declaration

Name Type
filter? FilterSpecification
iconAllowOverlap? PropertyValueSpecificationEx<boolean>
iconAnchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
iconColor? DataDrivenPropertyValueSpecification<ColorSpecification>
iconHaloBlur? DataDrivenPropertyValueSpecification<number>
iconHaloColor? DataDrivenPropertyValueSpecification<ColorSpecification>
iconHaloWidth? DataDrivenPropertyValueSpecification<number>
iconIgnorePlacement? PropertyValueSpecificationEx<boolean>
iconImage? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
iconKeepUpright? PropertyValueSpecificationEx<boolean>
iconOffset? DataDrivenPropertyValueSpecification<[number, number]>
iconOpacity? DataDrivenPropertyValueSpecification<number>
iconOptional? PropertyValueSpecificationEx<boolean>
iconPadding? PropertyValueSpecificationEx<number>
iconPitchAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
iconRotate? DataDrivenPropertyValueSpecification<number>
iconRotationAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
iconSize? DataDrivenPropertyValueSpecification<number>
iconTextFit? PropertyValueSpecificationEx<"none" | "width" | "height" | "both">
iconTextFitPadding? PropertyValueSpecificationEx<[number, number, number, number]>
iconTranslate? PropertyValueSpecificationEx<[number, number]>
iconTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
symbolAvoidEdges? PropertyValueSpecificationEx<boolean>
symbolPlacement? PropertyValueSpecificationEx<"point" | "line" | "line-center">
symbolSortKey? DataDrivenPropertyValueSpecification<number>
symbolSpacing? PropertyValueSpecificationEx<number>
symbolZOrder? PropertyValueSpecificationEx<"auto" | "viewport-y" | "source">
textAllowOverlap? PropertyValueSpecificationEx<boolean>
textAnchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
textColor? DataDrivenPropertyValueSpecification<ColorSpecification>
textField? DataDrivenPropertyValueSpecification<FormattedSpecification>
textFont? DataDrivenPropertyValueSpecification<string[]>
textHaloBlur? DataDrivenPropertyValueSpecification<number>
textHaloColor? DataDrivenPropertyValueSpecification<ColorSpecification>
textHaloWidth? DataDrivenPropertyValueSpecification<number>
textIgnorePlacement? PropertyValueSpecificationEx<boolean>
textJustify? DataDrivenPropertyValueSpecification<"auto" | "left" | "center" | "right">
textKeepUpright? PropertyValueSpecificationEx<boolean>
textLetterSpacing? DataDrivenPropertyValueSpecification<number>
textLineHeight? DataDrivenPropertyValueSpecification<number>
textMaxAngle? PropertyValueSpecificationEx<number>
textMaxWidth? DataDrivenPropertyValueSpecification<number>
textOffset? DataDrivenPropertyValueSpecification<[number, number]>
textOpacity? DataDrivenPropertyValueSpecification<number>
textOptional? PropertyValueSpecificationEx<boolean>
textPadding? PropertyValueSpecificationEx<number>
textPitchAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
textRadialOffset? DataDrivenPropertyValueSpecification<number>
textRotate? DataDrivenPropertyValueSpecification<number>
textRotationAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
textSize? DataDrivenPropertyValueSpecification<number>
textTransform? DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">
textTranslate? PropertyValueSpecificationEx<[number, number]>
textTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
textVariableAnchor? PropertyValueSpecificationEx<("center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right")[]>
textWritingMode? PropertyValueSpecificationEx<("horizontal" | "vertical")[]>
visibility? "visible" | "none"

# TerrainSpecificationEx

Ƭ TerrainSpecificationEx: object

# Type declaration

Name Type
exaggeration? PropertyValueSpecificationEx<number>
source string

# TransitionSpecification

Ƭ TransitionSpecification: object

# Type declaration

Name Type
delay? number
duration? number

# VectorSourceSpecification

Ƭ VectorSourceSpecification: object

# Type declaration

Name Type
attribution? string
bounds? [number, number, number, number]
maxzoom? number
minzoom? number
promoteId? PromoteIdSpecificationEx
scheme? "xyz" | "tms"
tiles? string[]
type "vector"
url? string
volatile? boolean

# VideoSourceSpecification

Ƭ VideoSourceSpecification: object

# Type declaration

Name Type
coordinates [[number, number], [number, number], [number, number], [number, number]]
type "video"
urls string[]

# mat2dtype

Ƭ mat2dtype: [number, number, number, number, number, number] | Float32Array

# mat2type

Ƭ mat2type: [number, number, number, number] | Float32Array

# mat3type

Ƭ mat3type: [number, number, number, number, number, number, number, number, number] | Float32Array

# mat4type

Ƭ mat4type: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number] | Float32Array

# quattype

Ƭ quattype: [number, number, number, number] | Float32Array

# vec2type

Ƭ vec2type: [number, number] | Float32Array

# vec3type

Ƭ vec3type: [number, number, number] | Float32Array

# vec4type

Ƭ vec4type: [number, number, number, number] | Float32Array

# Variables

# EPSILON

• Const EPSILON: 1e-8= 0.00000001

# EVENTS

• Const EVENTS: object

# Type declaration

Name Type
ABORT string
ERROR string
LOAD string
LOAD_END string
LOAD_START string
PROGRESS string
READY_STATE_CHANGE string
TIMEOUT string

# METHODS

• Const METHODS: Methods

# httpHelper

• Const httpHelper: object

# Type declaration

Name Type
configure (opts: Partial<Config<unknown>>) => void
del (url: string, args?: Partial<Config<unknown>>) => Promise<any>
event object
event.ABORT string
event.ERROR string
event.LOAD string
event.LOAD_END string
event.LOAD_START string
event.PROGRESS string
event.READY_STATE_CHANGE string
event.TIMEOUT string
get (url: string, params?: Record<string, any>, args?: Partial<Config<unknown>>) => Promise<any>
methods Methods
options (url: string, args?: Partial<Config<unknown>>) => Promise<any>
patch (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>
post (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>
put (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>
rqeust (args: Partial<Config<unknown>>) => Promise<any>

# transform

• Const transform: object

# Type declaration

Name Type
CRSTypes typeof CRSTypes
EpsgCrsTypes typeof EpsgCrsTypes
convert <T>(input: T | string, crsFrom: (pt: GeoPoint) => GeoPoint | CRSTypes, crsTo?: CRSTypes) => T
getEpsgCode (coordinate: number | [number, number], crs?: EpsgCrsTypes, is3DegreeBelt?: boolean) => { crs: string ; epsg: string ; is3DegreeBelt: boolean ; proj: undefined | string }[]
getEpsgParam (crs: EpsgCrsTypes, lon?: number) => null | { epsg: string ; proj: string }

# Functions

# Graph

▸ Graph(serialized?: Serialized): object

具有深度优先搜索和拓扑排序的图数据结构。

example var graph = Graph() .addEdge("s", "t", 10) .addEdge("s", "y", 5) .addEdge("s", "y", 4) .addEdge("t", "y", 2) .addEdge("y", "t", 3) .addEdge("t", "x", 1) .addEdge("y", "x", 9) .addEdge("y", "z", 2) .addEdge("x", "z", 4) .addEdge("z", "x", 6); var res = graph.shortestPath("s", "z")

# Parameters

Name Type
serialized? Serialized

Returns: object

Name Type
addEdge (u: NodeId, v: NodeId, weight?: EdgeWeight) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
addNode (node: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
adjacent (node: NodeId) => NodeId[]
depthFirstSearch (sourceNodes?: NodeId[], includeSourceNodes: boolean, errorOnCycle: boolean) => string[]
deserialize (serialized: Serialized) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
getEdgeWeight (u: NodeId, v: NodeId) => EdgeWeight
hasCycle () => boolean
hasEdge (u: NodeId, v: NodeId) => boolean
indegree (node: NodeId) => number
lowestCommonAncestors (node1: NodeId, node2: NodeId) => string[]
nodes () => NodeId[]
outdegree (node: NodeId) => number
removeEdge (u: NodeId, v: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
removeNode (node: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
serialize () => Serialized
setEdgeWeight (u: NodeId, v: NodeId, weight: EdgeWeight) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
shortestPath (source: NodeId, destination: NodeId) => string[] & { weight?: number }
topologicalSort (sourceNodes?: NodeId[], includeSourceNodes: boolean) => string[]

# RandomID

▸ RandomID(length?: number): string

生成随机ID

# Parameters

Name Type
length? number

Returns: string

# Scene

▸ Scene(L7: any, map: Map, option?: object): object

L7图层，可参考https://l7.antv.vision/. 返回一个场景对象

# Parameters

Name Type Description
L7 any L7命名空间
map Map
option? object

Returns: object

Name Type
addControl (ctr: any) => void
addFontFace (fontFamily: string, fontPath: string) => void
addIconFont (name: string, fontUnicode: string) => void
addIconFontGlyphs (fontFamily: string, glyphs: any[]) => void
addIconFonts (options: string[][]) => void
addImage (id: string, img: any) => void
addLayer (layer: any) => void
addMarker (marker: any) => void
addMarkerLayer (layer: any) => void
addPopup (popup: any) => void
containerToLngLat (pixel: any) => any
destroy () => void
diasbleShaderPick () => void
enableShaderPick () => void
exportMap (type?: "png" | "jpg") => string
exportPng (type?: "png" | "jpg") => string
fitBounds (bound: any, options?: unknown) => void
getBounds () => any
getCenter (options?: any) => any
getContainer () => null | HTMLElement
getControlByName (name: string) => any
getLayer (id: string) => any
getLayerByName (name: string) => any
getLayers () => any[]
getMapCanvasContainer () => HTMLElement
getMapContainer () => null | HTMLElement
getMapService () => any
getMaxZoom () => number
getMinZoom () => number
getPitch () => number
getPointSizeRange () => Float32Array
getRotation () => number
getServiceContainer () => any
getSize () => [number, number]
getType () => string
getZoom () => number
hasImage (id: string) => boolean
lngLatToContainer (lnglat: any) => any
lngLatToPixel (lnglat: any) => any
off (type: string, handle: (...args: any[]) => void) => void
on (type: string, handle: (...args: any[]) => void) => void
once (type: string, handle: (...args: any[]) => void) => void
panBy (x: number, y: number) => void
panTo (p: any) => void
pixelToLngLat (pixel: any) => any
registerPostProcessingPass (constructor: (...args: any[]) => any, name: string) => void
registerRenderService (render: any) => void
removeAllLayer () => void
removeAllMakers () => void
removeControl (ctr: any) => void
removeImage (id: string) => void
removeLayer (layer: any, parentLayer?: any) => void
removeMarkerLayer (layer: any) => void
render () => void
setBgColor (color: string) => void
setCenter (center: [number, number], options?: any) => void
setEnableRender (flag: boolean) => void
setMapStatus (options: Partial<any>) => void
setMapStyle (style: any) => void
setPitch (pitch: number) => void
setRotation (rotation: number) => void
setZoom (zoom: number) => void
setZoomAndCenter (zoom: number, center: any) => void
zoomIn () => void
zoomOut () => void

# WorkerExpose

▸ WorkerExpose(target: any): void

# Parameters

Name Type
target any

Returns: void

▸ WorkerLink(worker: Worker): any

和一个Worker相关联

# Parameters

Name Type
worker Worker

Returns: any

# WorkerProxy

▸ WorkerProxy(obj: Function | string, funcContext?: Record<string, Function | string>): Function

将独立函数/类移动到工作线程的一种非常简单的方法。 或者，将 worker 中的对象或函数暴露给主线程。 所有调用都是异步的。与 async/await 配合使用效果很好

Example:

function busyAdd(a, b) {
 let st = Date.now();
 while (true) {
   if ((Date.now() - st) > 2000) break;
 }
 return a + b;
}

(async () => {
 let workerAdd = vjmap.WorkerProxy(busyAdd);
 console.log(await workerAdd(10, 20)); //30
 // the busyAdd is executed in a worker so
 // the UI does not get blocked
})();

class Adder {
constructor() {
  this.count = 0;
}
add(a, b) {
 this.count++;
  return a + b;
}
}

(async () => {
let WAdder = vjmap.WorkerProxy(Adder);
let a = await new WAdder(); // instance created/running in worker
console.log(await a.count); // 0
console.log(await a.add(10, 20)); // 30
console.log(await a.count); // 1
})();

// or:
// worker.js

importScripts('https://cdn.jsdelivr.net/npm/moment@2.20.1/moment.min.js', '../dist/workly.js');
function friendlyTime(value) {
return moment(value).calendar(null, {
  sameDay: function (now) {
   if (now - this < 1000 * 60) {
      return "[Just now]";
   } else if (now - this < 1000 * 60 * 60) {
      return "[" + Math.round((now - this) / (1000 * 60)) + " mins ago]";
   } else {
     return '[Today at] LT'
   }
 }
});
}
vjmap.WorkerExpose(friendlyTime);
main.js

(async () => {
let w = vjmap.WorkerProxy("./worker.js");
let now = Date.now();
console.log(now);
console.log(await w(now));
console.log(await w(now - (24 * 60 * 60 * 1000)));
console.log(await w(now - (4 * 24 * 60 * 60 * 1000)));
})();

 function randAdd(a, b) {
     return randInt(a, b)  + 1000; // randInt这个函数是上下文传递进来的
 }

let randAddFunc = vjmap.WorkerProxy(randAdd, {
   randInt: vjmap.randInt // 把主进程库的函数做为上下文传进去
});
console.log(await randAddFunc(100, 300));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# Parameters

Name Type Description
obj Function | string
funcContext? Record<string, Function | string> 函数上下文，如果传入的obj是函数的话，需要把obj中函数里调用的函数名称和函数方法传进来

Returns: Function

# _getEdgeIntersection

▸ _getEdgeIntersection(a: GeoPoint, b: GeoPoint, code: number, bounds: GeoBounds): GeoPoint

# Parameters

Name Type
a GeoPoint
b GeoPoint
code number
bounds GeoBounds

Returns: GeoPoint

# addScript

▸ addScript(scripts: ScriptDefaultOptions | ScriptDefaultOptions[]): Promise<unknown[]>

将脚本注入. 脚本选项信息: strategy: 用于运行 JavaScript 的策略。可以是inject、eval 或href。默认自动检测. injectLocation: 用于注入资源的位置的 document.querySelector 参数。默认为 head. async: 异步加载脚本 src: 脚本的来源

method

async

example // you can add multiple loads awit addScript([{ src: "https://code.jquery.com/jquery-3.5.0.js" }, { src: "https://code.jquery.com/jquery-3.2.0.js", async: true }, { src: "https://code.jquery.com/jquery-3.3.0.js", async: true, injectLocation: '#main div.test', }, { src: "https://code.jquery.com/jquery-3.4.0.js", strategy: 'eval', }, { // link tag // css autodetected src: "https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.0.2/css/bootstrap-grid.min.css", }])

# Parameters

Name Type Description
scripts ScriptDefaultOptions | ScriptDefaultOptions[] Options for a script

Returns: Promise<unknown[]>

# animateVectorLayer

▸ Const animateVectorLayer(map: Map, layerId: string, options?: IAnimateVectorLayerOptions, layerType?: number): IAnimateVectorLayerResult

创建矢量图层动画图层

# Parameters

Name Type Default value Description
map Map - 地图对象
layerId string - 矢量图层id
options IAnimateVectorLayerOptions {} 选项
layerType? number - 图层类型 0 线 1 填充 2 符号点

Returns: IAnimateVectorLayerResult

# applyMixins

▸ applyMixins(derivedCtor: any, baseCtors: any[]): void

Copy methods and properties from one prototype into another.

see https://www.typescriptlang.org/docs/handbook/mixins.html

# Parameters

Name Type Description
derivedCtor any Class to mix methods and properties into.
baseCtors any[] Class to take all methods and properties from.

Returns: void

# applyMixinsWithoutProperties

▸ applyMixinsWithoutProperties(derivedCtor: any, baseCtors: any[]): void

Copy methods from one prototype into another.

see https://www.typescriptlang.org/docs/handbook/mixins.html

# Parameters

Name Type Description
derivedCtor any Class to mix methods into.
baseCtors any[] Class to take all methods from.

Returns: void

# bufferConvexPolygon

▸ bufferConvexPolygon(ring: GeoPoint[], buffer: number): GeoPoint[]

取一个凸环并通过在其周围应用缓冲区将其向外扩展。 此功能假定环是顺时针缠绕的。

# Parameters

Name Type
ring GeoPoint[]
buffer number

Returns: GeoPoint[]

# buildTopoGraph

▸ buildTopoGraph(lines: { id?: string ; points: GeoPoint[] ; weight?: number }[], precision?: number, hasDirection?: boolean): object

根据多条多段线，建立topo

# Parameters

Name Type Description
lines { id?: string ; points: GeoPoint[] ; weight?: number }[] 坐标，请转成几何坐标，再传入
precision? number 误差，小数点后几位， 以为相同, 如果两个点的坐标距离小于此值，则认为是同一个节点
hasDirection? boolean 是否考虑方向

Returns: object

Name Type
graph object
graph.addEdge (u: NodeId, v: NodeId, weight?: EdgeWeight) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.addNode (node: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.adjacent (node: NodeId) => NodeId[]
graph.depthFirstSearch (sourceNodes?: NodeId[], includeSourceNodes: boolean, errorOnCycle: boolean) => string[]
graph.deserialize (serialized: Serialized) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.getEdgeWeight (u: NodeId, v: NodeId) => EdgeWeight
graph.hasCycle () => boolean
graph.hasEdge (u: NodeId, v: NodeId) => boolean
graph.indegree (node: NodeId) => number
graph.lowestCommonAncestors (node1: NodeId, node2: NodeId) => string[]
graph.nodes () => NodeId[]
graph.outdegree (node: NodeId) => number
graph.removeEdge (u: NodeId, v: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.removeNode (node: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.serialize () => Serialized
graph.setEdgeWeight (u: NodeId, v: NodeId, weight: EdgeWeight) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.shortestPath (source: NodeId, destination: NodeId) => string[] & { weight?: number }
graph.topologicalSort (sourceNodes?: NodeId[], includeSourceNodes: boolean) => string[]
topo any

, lowestCommonAncestors: (node1: NodeId, node2: NodeId) => NodeId[], shortestPath: (source: NodeId, destination: NodeId) => NodeId[] & {weight?: EdgeWeight}, setEdgeWeight: (u: NodeId, v: NodeId, weight: EdgeWeight) => {topologicalSort: (sourceNodes?: NodeId[], includeSourceNodes?: boolean) => ...[], addNode: (node: NodeId) => any, lowestCommonAncestors: (node1: NodeId, node2: NodeId) => ...[], shortestPath: (source: NodeId, destination: NodeId) => ... & ..., setEdgeWeight: (u: NodeId, v: NodeId, weight: EdgeWeight) => any, adjacent: (node: NodeId) => NodeId[], depthFirstSearch: (sourceNodes?: NodeId[], includeSourceNodes?: boolean, errorOnCycle?: boolean) => ...[], hasCycle: () => boolean, getEdgeWeight: (u: NodeId, v: NodeId) => EdgeWeight, serialize: () => Serialized, removeEdge: (u: NodeId, v: NodeId) => any, ...}, adjacent: (node: NodeId) => NodeId[], depthFirstSearch: (sourceNodes?: NodeId[], includeSourceNodes?: boolean, errorOnCycle?: boolean) => NodeId[], hasCycle: () => boolean, getEdgeWeight: (u: NodeId, v: NodeId) => EdgeWeight, serialize: () => Serialized, removeEdge: (u: NodeId, v: NodeId) => {topologicalSort: (sourceNodes?: NodeId[], includeSourceNodes?: boolean) => ...[], addNode: (node: NodeId) => any, lowestCommonAncestors: (node1: NodeId, node2: NodeId) => ...[], shortestPath: (source: NodeId, destination: NodeId) => ... & ..., setEdgeWeight: (u: NodeId, v: NodeId, weight: EdgeWeight) => any, adjacent: (node: NodeId) => NodeId[], depthFirstSearch: (sourceNodes?: NodeId[], includeSourceNodes?: boolean, errorOnCycle?: boolean) => ...[], hasCycle: () => boolean, getEdgeWeight: (u: NodeId, v: NodeId) => EdgeWeight, serialize: () => Serialized, removeEdge: (u: NodeId, v: NodeId) => any, ...}, ...}}}

# buildTransformer

▸ buildTransformer(src: number[], dest: number[]): undefined | number[]

Usage:

const transformer = buildTransformer(
    [10, 44, 100, 44, 100, 300, 10, 300],
    [50, 54, 130, 14, 140, 330, 14, 220]
);
1
2
3
4

# Parameters

Name Type Description
src number[] source four points, [x0, y0, x1, y1, x2, y2, x3, y3]
dest number[] destination four points, [x0, y0, x1, y1, x2, y2, x3, y3]

Returns: undefined | number[]

transformer If fail, return null/undefined.

# buildTransformerMatrix3d

▸ buildTransformerMatrix3d(src: number[], dest: number[]): undefined | string

透视投影转3d css 矩阵 Usage:

const transformer = buildTransformerMatrix3d(
    [10, 44, 100, 44, 100, 300, 10, 300],
    [50, 54, 130, 14, 140, 330, 14, 220]
);
1
2
3
4

# Parameters

Name Type Description
src number[] source four points, [x0, y0, x1, y1, x2, y2, x3, y3]
dest number[] destination four points, [x0, y0, x1, y1, x2, y2, x3, y3]

Returns: undefined | string

# calcPolygonArea

▸ calcPolygonArea(points: GeoPoint[]): number

计算多边形面积

# Parameters

Name Type
points GeoPoint[]

Returns: number

# calculateSignedArea

▸ calculateSignedArea(ring: GeoPoint[]): number

返回多边形的有符号的面积。正区域为外环，具有顺时针绕组。负区域为内环，按逆时针顺序排列。

# Parameters

Name Type
ring GeoPoint[]

Returns: number

# clipPolygon

▸ clipPolygon(points: GeoPoint[], bounds: GeoBounds): GeoPoint[]

根据范围裁剪多边形

# Parameters

Name Type
points GeoPoint[]
bounds GeoBounds

Returns: GeoPoint[]

# clipSegment

▸ clipSegment(a: GeoPoint, b: GeoPoint, bounds: GeoBounds): GeoPoint[] | Boolean

根据范围裁剪线段

# Parameters

Name Type
a GeoPoint
b GeoPoint
bounds GeoBounds

Returns: GeoPoint[] | Boolean

# cloneDeep

▸ cloneDeep<T>(obj: T): T

Deep clone of object.

Like JSON.parse(JSON.stringify(obj)), but supports basic javascript types (string, number, object), Date and RegExps and cycles.

Throws error if enounters object with prototype assuming that in general class instances cannot be reliably cloned by generic algorithm.

# Type parameters

Name
T

# Parameters

Name Type
obj T

Returns: T

# closePolygon

▸ closePolygon(points: GeoPoint[]): GeoPoint[]

闭合多边形

# Parameters

Name Type
points GeoPoint[]

Returns: GeoPoint[]

points

# closestPointOnPolyline

▸ closestPointOnPolyline(p: GeoPoint, points: GeoPoint[]): object

点到多段线的最近点

# Parameters

Name Type
p GeoPoint
points GeoPoint[]

Returns: object

Name Type
closestIndex number
closestLength number
closestPoint GeoPoint
closestPrePointDist number

# closestPointOnPolylines

▸ closestPointOnPolylines(p: GeoPoint, lines: GeoPoint[][]): object

点到多条线的最近点

# Parameters

Name Type
p GeoPoint
lines GeoPoint[][]

Returns: object

Name Type
closestIndex number
closestLength number
closestPoint GeoPoint
closestPointIndex number
closestPrePointDist number

# closestPointOnSegment

▸ closestPointOnSegment(p: GeoPoint, p1: GeoPoint, p2: GeoPoint): GeoPoint

点到线段的最近点

# Parameters

Name Type
p GeoPoint
p1 GeoPoint
p2 GeoPoint

Returns: GeoPoint

# coordTransfromByFourParamter

▸ coordTransfromByFourParamter(pt: GeoPoint, param: { dx: number ; dy: number ; rotate: number ; scale: number }): GeoPoint

通过四参数进行坐标转换

# Parameters

Name Type Description
pt GeoPoint 点
param object 四参数
param.dx number -
param.dy number -
param.rotate number -
param.scale number -

Returns: GeoPoint

# coordTransfromByInvFourParamter

▸ coordTransfromByInvFourParamter(pt: GeoPoint, param: { dx: number ; dy: number ; rotate: number ; scale: number }): GeoPoint

通过四参数反算进行坐标转换

# Parameters

Name Type Description
pt GeoPoint 点
param object 四参数
param.dx number -
param.dy number -
param.rotate number -
param.scale number -

Returns: GeoPoint

# coordTransfromGetFourParamter

▸ coordTransfromGetFourParamter(srcArr: GeoPoint[], destArr: GeoPoint[], isSetRotateZero: boolean, isConsiderPointOrder?: boolean): object

坐标转换得到四参数

# Parameters

Name Type Description
srcArr GeoPoint[] 原始点数组
destArr GeoPoint[] 目标点数组
isSetRotateZero boolean 是否设置旋转为零，默认false,如果为true,则只考虑平移和缩放
isConsiderPointOrder? boolean 不考虑点的次序(这样旋转角度方向总是上面，在-180,180之间）

Returns: object

Name Type
dx number
dy number
rotate number
scale number

# createAnimateFillLayer

▸ createAnimateFillLayer(map: Map, path: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any, options?: IAnimateFillLayerOptions): ICreateFillAnimateLayerResult

创建多边形动画图层

# Parameters

Name Type Default value Description
map Map - 地图对象
path LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any - 线坐标(lngLat)
options IAnimateFillLayerOptions {} 选项

Returns: ICreateFillAnimateLayerResult

# createAnimateImages

▸ createAnimateImages(options?: ICreateAnimateImagesOptions): ImageData[]

创建动画图片集

# Parameters

Name Type Description
options? ICreateAnimateImagesOptions 选项

Returns: ImageData[]

# createAnimateLineLayer

▸ createAnimateLineLayer(map: Map, path: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any, options?: IAnimateLineLayerOptions): ICreateLineAnimateLayerResult

创建多段线动画图层

# Parameters

Name Type Description
map Map 地图对象
path LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any 线坐标(lngLat)
options? IAnimateLineLayerOptions 选项

Returns: ICreateLineAnimateLayerResult

# createAnimateSymbolLayer

▸ createAnimateSymbolLayer(map: Map, path: PointGeoJsonInput | PointGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike | any, options?: IAnimateSymbolLayerOptions): ICreateSymbolAnimateLayerResult

创建符号动画图层

# Parameters

Name Type Description
map Map 地图对象
path PointGeoJsonInput | PointGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike | any 符号坐标(lngLat)
options? IAnimateSymbolLayerOptions 选项

Returns: ICreateSymbolAnimateLayerResult

# createAntPathAnimateImages

▸ createAntPathAnimateImages(options?: ICreateAntPathAnimateLineLayerOptions): ImageData[]

创建蚂蚁线动画图像集

# Parameters

Name Type Description
options? ICreateAntPathAnimateLineLayerOptions 选项

Returns: ImageData[]

# createAntPathAnimateLineLayer

▸ createAntPathAnimateLineLayer(map: Map, path: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any, options?: ICreateAntPathAnimateLineLayerOptions): ICreateLineAnimateLayerResult

创建蚂蚁线动画线图层

# Parameters

Name Type Default value Description
map Map - 地图对象
path LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any - 线坐标(lngLat)
options ICreateAntPathAnimateLineLayerOptions {} 选项

Returns: ICreateLineAnimateLayerResult

# createArrowAnimateImages

▸ createArrowAnimateImages(options?: ICreateArrowAnimateLineLayerOptions): ImageData[]

创建箭头动画图像集

# Parameters

Name Type Description
options? ICreateArrowAnimateLineLayerOptions 选项

Returns: ImageData[]

# createArrowAnimateLineLayer

▸ createArrowAnimateLineLayer(map: Map, path: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any, options?: ICreateArrowAnimateLineLayerOptions): ICreateLineAnimateLayerResult

创建箭头动画线图层

# Parameters

Name Type Description
map Map 地图对象
path LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any 线坐标(lngLat)
options? ICreateArrowAnimateLineLayerOptions 选项

Returns: ICreateLineAnimateLayerResult

# createFrameAnimation

▸ createFrameAnimation(callback: (status: FrameAnimationStatus) => boolean, fps?: number, stopCallBack?: (status: FrameAnimationStatus) => void): FrameAnimation

创建一个 FrameAnimation 对象来启动和停止你的动画功能.

example const count = 0;

const animation = createFrameAnimation(() => { context.clearRect(0, 0, width, height); context.font = "4rem monospace"; context.textAlign = 'center'; context.fillText(count, width / 2, height / 2);

count++; });

animation.start();

# Parameters

Name Type Description
callback (status: FrameAnimationStatus) => boolean 处理动画的回调,如果返回true，表示结束动画，返回false表示继续动画， .
fps? number 一秒运行多少帧，用来控制速度，如为0，则默认为系统帧率
stopCallBack? (status: FrameAnimationStatus) => void 结束动画的回调，参数表示是取消（true)，还是正常结束(false)

Returns: FrameAnimation

| boolean}

# createLineGeoJson

▸ createLineGeoJson(input: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any): GeoJsonGeomertry

创建geoson格式的线

# Parameters

Name Type
input LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any

Returns: GeoJsonGeomertry

# createMarker

▸ createMarker(options?: createMarkerOptions): Marker

创建一个Makrer对象，相当于new Marker()

# Parameters

Name Type
options? createMarkerOptions

Returns: Marker

# createObjectOffset

▸ createObjectOffset(): object

Returns: object

Name Type
data (vertices: any) => any
margin (dist: number) => any
offset (dist: number) => any
offsetLines (dist: number) => any
padding (dist: number) => any

# createObjectPolygonUtil

▸ createObjectPolygonUtil(): object

Returns: object

Name Type
diff (polygonA: Number[][], polygonB: Number[][]) => null | Number[][]
intersection (polygonA: Number[][], polygonB: Number[][]) => null | Number[][]
union (polygonA: Number[][], polygonB: Number[][]) => null | Number[][]

# createPointGeoJson

▸ createPointGeoJson(input: PointGeoJsonInput | PointGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike | any): GeoJsonGeomertry

创建geoson格式的点

# Parameters

Name Type
input PointGeoJsonInput | PointGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike | any

Returns: GeoJsonGeomertry

# createPolygonGeoJson

▸ createPolygonGeoJson(input: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any): GeoJsonGeomertry

创建geoson格式的多边形

# Parameters

Name Type
input LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any

Returns: GeoJsonGeomertry

# degToRad

▸ degToRad(a: number): number

角度转弧度

# Parameters

Name Type
a number

Returns: number

# entColorToHtmlColor

▸ entColorToHtmlColor(color: number | string, darkMode?: boolean, alpha?: number): string

实体颜色转html颜色

# Parameters

Name Type Description
color number | string 实体颜色
darkMode? boolean 样式是否为暗黑框
alpha? number 透明度的值

Returns: string

# equals

▸ equals(a: number, b: number): boolean

Tests whether or not the arguments have approximately the same value, within an absolute or relative tolerance of glMatrix.EPSILON (an absolute tolerance is used for values less than or equal to 1.0, and a relative tolerance is used for larger values)

# Parameters

Name Type Description
a number The first number to test.
b number The second number to test.

Returns: boolean

True if the numbers are approximately equal, false otherwise.

# findShortestPath

▸ findShortestPath(startPoint: GeoPoint, endPoint: GeoPoint, lines: { id?: string ; points: GeoPoint[] ; weight?: number }[], precision?: number, hasDirection?: boolean): { endPoint: { closestIndex: number ; closestLength: number ; closestPoint: GeoPoint ; closestPointIndex: number ; closestPrePointDist: number } ; error: undefined ; route: any[] ; routeDetail: { index: any ; points: any[] ; reverse: boolean = false }[] ; startPoint: { closestIndex: number ; closestLength: number ; closestPoint: GeoPoint ; closestPointIndex: number ; closestPrePointDist: number } } | { endPoint: undefined ; error: any ; route: undefined ; routeDetail: undefined ; startPoint: undefined }

给定所有路线、起始点、终点生成最短路径

# Parameters

Name Type Description
startPoint GeoPoint 起点
endPoint GeoPoint 终点
lines { id?: string ; points: GeoPoint[] ; weight?: number }[] 坐标，请转成几何坐标，再传入
precision? number 误差，小数点后几位， 以为相同, 如果两个点的坐标距离小于此值，则认为是同一个节点
hasDirection? boolean 是否考虑方向

Returns: { endPoint: { closestIndex: number ; closestLength: number ; closestPoint: GeoPoint ; closestPointIndex: number ; closestPrePointDist: number } ; error: undefined ; route: any[] ; routeDetail: { index: any ; points: any[] ; reverse: boolean = false }[] ; startPoint: { closestIndex: number ; closestLength: number ; closestPoint: GeoPoint ; closestPointIndex: number ; closestPrePointDist: number } } | { endPoint: undefined ; error: any ; route: undefined ; routeDetail: undefined ; startPoint: undefined }

# geoBounds

▸ geoBounds(min?: GeoPoint, max?: GeoPoint): GeoBounds

new一个GeoBounds实例

# Parameters

Name Type
min? GeoPoint
max? GeoPoint

Returns: GeoBounds

# geoPoint

▸ geoPoint(input: GeoPointLike): GeoPoint

new一个GeoPoint实例

# Parameters

Name Type
input GeoPointLike

Returns: GeoPoint

# getCircleFeature

▸ getCircleFeature(center: GeoPointLike, radius: number, points?: number, startAngle?: number, endAngle?: number, includeCenterWhenArc?: boolean): GeoJsonGeomertry

得到圆或圆弧的离散化的多边形的geojson的形式

# Parameters

Name Type Default value Description
center GeoPointLike - 中心点
radius number - 半径
points number 360 离散化的个数
startAngle number 0 开始角度
endAngle number 360 结束角度
includeCenterWhenArc boolean true 如果是圆弧时，最后一个点加上中心点

Returns: GeoJsonGeomertry

, type: string, properties: {}}}

# getCirclePolygonCoordinates

▸ getCirclePolygonCoordinates(center: GeoPointLike, radius: number, points?: number, startAngle?: number, endAngle?: number, includeCenterWhenArc?: boolean): number[][]

得到圆或圆弧的离散化的多边形的点

# Parameters

Name Type Default value Description
center GeoPointLike - 中心点
radius number - 半径
points number 360 离散化的个数
startAngle number 0 开始角度
endAngle number 360 结束角度
includeCenterWhenArc boolean true 如果是圆弧时，最后一个点加上中心点

Returns: number[][]

# getEllipseFeature

▸ getEllipseFeature(center: GeoPointLike, majorAxisRadius: number, minorAxisRadius: number, points?: number, startAngle?: number, endAngle?: number, includeCenterWhenArc?: boolean): GeoJsonGeomertry

得到圆或圆弧的离散化的多边形的geojson的形式

# Parameters

Name Type Default value Description
center GeoPointLike - 中心点
majorAxisRadius number - -
minorAxisRadius number - -
points number 360 离散化的个数
startAngle number 0 开始角度
endAngle number 360 结束角度
includeCenterWhenArc boolean true 如果是圆弧时，最后一个点加上中心点

Returns: GeoJsonGeomertry

, type: string, properties: {}}}

# getEllipsePolygonCoordinates

▸ getEllipsePolygonCoordinates(center: GeoPointLike, majorAxisRadius: number, minorAxisRadius: number, points?: number, startAngle?: number, endAngle?: number, includeCenterWhenArc?: boolean): number[][]

得到椭圆或椭圆弧的离散化的多边形的点

# Parameters

Name Type Default value Description
center GeoPointLike - 中心点
majorAxisRadius number - 长轴半径
minorAxisRadius number - 短轴半径
points number 360 离散化的个数
startAngle number 0 开始角度
endAngle number 360 结束角度
includeCenterWhenArc boolean true 如果是椭/圆弧时，最后一个点加上中心点

Returns: number[][]

# getEnvelopBounds

▸ getEnvelopBounds(envelop: string, prj: any): GeoBounds

根据外包矩形创建 GeoBounds.

Example:

const b = vjmap.getEnvelopBounds('POLYGON((3466315.697899 6704304.297588, 3466315.697899 7784496.211226, 4546475.901198 7784496.211226, 4546475.901198 6704304.297588, 3466315.697899 6704304.297588))', prj);
1

# Parameters

Name Type
envelop string
prj any

Returns: GeoBounds

# getGeoBounds

▸ getGeoBounds<T>(data: T | string): GeoBounds

获取一个geojson的范围值

# Type parameters

Name Type
T GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]

# Parameters

Name Type Description
data T | string 输入值

Returns: GeoBounds

获取的范围值

# getOptionValue

▸ getOptionValue<T>(a: T): T

Get first defined value.

Specialized "replacement" for a || b || c used frequently to get value from various sources (defaults, configs constants). In contrast to ||, this function provides proper typing for usual use cases (constant as last argument) and correct treatment of null and undefined.

If last parameter is "defined" then return type is T, otherwise return type is T | undefined.

Usage example:

interface Config {
    x?: number;
}
const someConfig: Config = {};
const val: number | undefined = undefined;
const DEFAULT = 5;
const x = getOptionValue(val, someConfig.x, DEFAULT);
    // typeof x === 'number' because DEFAULT is defined
const y = getOptionValue(val, someConfig.x);
    // typeof y === 'number | undefined' because someConfig.x is possibly undefined

# Type parameters

Name
T

# Parameters

Name Type
a T

Returns: T

▸ getOptionValue<T>(a: T | undefined, b: T): T

# Type parameters

Name
T

# Parameters

Name Type
a T | undefined
b T

Returns: T

▸ getOptionValue<T>(a: T | undefined, b: T | undefined, c: T): T

# Type parameters

Name
T

# Parameters

Name Type
a T | undefined
b T | undefined
c T

Returns: T

▸ getOptionValue<T>(a: T | undefined, b: T | undefined, c: T | undefined, d: T): T

# Type parameters

Name
T

# Parameters

Name Type
a T | undefined
b T | undefined
c T | undefined
d T

Returns: T

▸ getOptionValue<T>(...values: (T | undefined)[]): T | undefined

# Type parameters

Name
T

# Parameters

Name Type
...values (T | undefined)[]

Returns: T | undefined

# getTempMapId

▸ getTempMapId(expireTime?: number, isVisible?: boolean): string

获取一个临时的图id(临时图形只会用临时查看，过期会自动删除)

# Parameters

Name Type Description
expireTime? number 临时图形不浏览情况下过期自动删除时间，单位分钟。默认30
isVisible? boolean 是否可见，（可见的话，将可通过ListMaps获取，否则为隐藏图）。默认不可见

Returns: string

# hexToBinStr

▸ hexToBinStr(strHex: string, isPadding?: boolean, reverse?: boolean): string

十六进制字符串转二进制字符串(可用于协同图形，图层开头显示设置的转换)

# Parameters

Name Type Default value Description
strHex string - 十进制的内容
isPadding boolean true 前面是否自动0，默认true
reverse boolean true 结果倒序，默认true

Returns: string

# htmlColorToEntColor

▸ htmlColorToEntColor(color: string): number

html颜色转实体颜色

# Parameters

Name Type Description
color string html

Returns: number

# interpolateLineRange

▸ interpolateLineRange(points: GeoPointLike[] | any, number: number, isLngLat?: boolean, offsetDist?: number, minGap?: number, includeSrcPoint?: boolean): any[]

# Parameters

Name Type Default value Description
points GeoPointLike[] | any - 要插值的（多段）线的顶点(输入必须为经纬度).
number number - 沿线插入的点数；这包括端点，并且有效最小值为 2（如果给出较小的数字，则仍将返回端点）.
isLngLat boolean false 点坐标序列是否是经纬度坐标
offsetDist number 0 一个可选的垂直距离，用于从线段偏移每个点，否则它会位于.
minGap number 0 在后续插值点之间保持可选的最小间隙；如果一组“number”点的后续点之间的投影间隙低于此值，则“number”将减小到合适的值.
includeSrcPoint boolean true 包括原有点

Returns: any[]

# interpolatePointsByRatio

▸ interpolatePointsByRatio(points: GeoPointLike[] | any, ratio: number, isLngLat?: boolean): any[]

通过比例(0-1)的值，得到坐标序列的点坐标的值

# Parameters

Name Type Default value
points GeoPointLike[] | any -
ratio number -
isLngLat boolean false

Returns: any[]

# isClosedPolygon

▸ isClosedPolygon(points: GeoPoint[]): boolean

多边形是否闭合

# Parameters

Name Type
points GeoPoint[]

Returns: boolean

# isCounterClockwise

▸ isCounterClockwise(a: GeoPoint, b: GeoPoint, c: GeoPoint): boolean

指示提供的点是按逆时针（真）还是顺时针（假）顺序排列

# Parameters

Name Type
a GeoPoint
b GeoPoint
c GeoPoint

Returns: boolean

# isGeoPointLike

▸ isGeoPointLike(geoPoint: any): geoPoint is GeoPointLike

A GeoPointLike object, an array of two numbers representing longitude and latitude, or an object with lng and lat or lon and lat properties.

Example:

const center = { lat: 53.3, lng: 13.4 };
mapView.geoCenter = GeoCoordinates.fromLatLng(center);
1
2

# Parameters

Name Type
geoPoint any

Returns: geoPoint is GeoPointLike

# isPointInPolygon

▸ Const isPointInPolygon(pos: GeoPoint, polygon: GeoPoint[]): boolean

判断点是否在多边形内。

# Parameters

Name Type Description
pos GeoPoint 点
polygon GeoPoint[] 多边形坐标

Returns: boolean

# isZero

▸ isZero(value: number, precision?: number): boolean

判断是否为零

# Parameters

Name Type Description
value number 值
precision? number 精度，缺省1e-6

Returns: boolean

# kebabCase

▸ Const kebabCase(s: any): any

# Parameters

Name Type
s any

Returns: any

# lineSplit

▸ lineSplit(line: GeoPoint[], splitLine: GeoPoint[], dotErr?: number): GeoPoint[][]

线被另外一条线分开多条线段，返回新的线段

# Parameters

Name Type Description
line GeoPoint[]
splitLine GeoPoint[]
dotErr? number 允许误差的小数点后几位，默认6位

Returns: GeoPoint[][]

# metersPerPixel

▸ metersPerPixel(zoomLevel: number, latitude?: number): number

求不同级级别下，每米表示多少像素

# Parameters

Name Type Description
zoomLevel number 级别从0表示
latitude? number 纬度

Returns: number

# multiLineSplit

▸ multiLineSplit(lines: GeoPoint[][], dotErr?: number): GeoPoint[][]

多条线之间根据交点相互分开,返回相交后的所有线段，请确保每条线段不要自相交

# Parameters

Name Type Description
lines GeoPoint[][]
dotErr? number 允许误差的小数点后几位，默认6位

Returns: GeoPoint[][]

# offsetPointLine

▸ offsetPointLine(points: GeoPoint[], distance: number): any[]

# Parameters

Name Type
points GeoPoint[]
distance number

Returns: any[]

# offsetPoints

▸ offsetPoints(pts: GeoPointLike[], options: { offset: number ; smoothFactor?: number }): any[]

# Parameters

Name Type
pts GeoPointLike[]
options object
options.offset number
options.smoothFactor? number

Returns: any[]

# openMapDarkStyle

▸ openMapDarkStyle(): IMapStyleParam

打开地图的深色背景样式，值为 {backcolor: 0}

Returns: IMapStyleParam

# openMapLightStyle

▸ openMapLightStyle(): IMapStyleParam

打开地图的浅色色背景样式，值为 {backcolor: 0xFFFFFF}

Returns: IMapStyleParam

# pick

▸ pick<T, K>(object: T, props: K[]): Pick<T, K>

Pick props from `object.

Runtime version of Pick<T,K>.

# Type parameters

Name Type
T object
K string | number | symbol

# Parameters

Name Type
object T
props K[]

Returns: Pick<T, K>

# pixelValue

▸ pixelValue(meters: number, zoomLevel: number, latitude?: number): number

不同级别下根据米数来求像素值

# Parameters

Name Type Description
meters number 米
zoomLevel number 级别从0表示
latitude? number 纬度

Returns: number

# pointToSegmentDistance

▸ pointToSegmentDistance(p: GeoPoint, p1: GeoPoint, p2: GeoPoint): number

点到线段的距离

# Parameters

Name Type
p GeoPoint
p1 GeoPoint
p2 GeoPoint

Returns: number

# polygonCentroid

▸ polygonCentroid(vertices: GeoPoint[]): GeoPoint

根据 [x,y] 坐标列表计算多边形的质心。

# Parameters

Name Type Description
vertices GeoPoint[] 顶点坐标

Returns: GeoPoint

# polygonIsClockwise

▸ polygonIsClockwise(points: GeoPoint[]): boolean

根据格林公式判断多边形是否为顺时针

# Parameters

Name Type
points GeoPoint[]

Returns: boolean

false:逆时针

# polylineMarginToPolygon

▸ polylineMarginToPolygon(pts: GeoPointLike[], options: { arcSegments?: number ; offset: number ; smoothFactor?: number }): any

把多段线往外扩展成多边形

# Parameters

Name Type
pts GeoPointLike[]
options object
options.arcSegments? number
options.offset number
options.smoothFactor? number

Returns: any

# radToDeg

▸ radToDeg(a: number): number

弧度转角度

# Parameters

Name Type
a number

Returns: number

# randInt

▸ randInt(n: number, m: number): number

生成一个区间的随机总数

# Parameters

Name Type
n number
m number

Returns: number

# randomColor

▸ randomColor(): string

生成随机颜色

Returns: string

# segmentIntersect

▸ segmentIntersect(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number): { ratio: undefined ; result: string = "COLINEAR"; status: boolean = false; x: undefined ; y: undefined } | { ratio: number ; result: undefined = "COLINEAR"; status: boolean = true; x: number ; y: number }

线段相交

# Parameters

Name Type
x1 number
y1 number
x2 number
y2 number
x3 number
y3 number
x4 number
y4 number

Returns: { ratio: undefined ; result: string = "COLINEAR"; status: boolean = false; x: undefined ; y: undefined } | { ratio: number ; result: undefined = "COLINEAR"; status: boolean = true; x: number ; y: number }

| {result: string, status: boolean} | {x: number, y: number, status: boolean, ratio: number} | {result: string, status: boolean}}

# simplify

▸ simplify(points: GeoPoint[], tolerance?: number): GeoPoint[]

简化点坐标

# Parameters

Name Type
points GeoPoint[]
tolerance? number

Returns: GeoPoint[]

# syncMaps

▸ syncMaps(...args: Map[]): function

同步两张地图的移动。

# Parameters

Name Type
...args Map[]

Returns: () => void

# toRadian

▸ toRadian(a: number): number

Convert Degree To Radian

# Parameters

Name Type Description
a number Angle in Degrees

Returns: number

# upperCamelCase

▸ Const upperCamelCase(s: any): any

# Parameters

Name Type
s any

Returns: any

# utf8ToUnicode

▸ utf8ToUnicode(strUtf8: string): string

utf8转unicode

# Parameters

Name Type Description
strUtf8 string utf8的内容

Returns: string

# vectorContour

▸ vectorContour(featureCollection: FeatureCollection, weight: string, breaks: number[], params?: { alpha?: number ; canvas?: HTMLCanvasElement ; colors?: string[] ; extent?: [number, number, number, number] ; model?: "exponential" | "gaussian" | "spherical" ; sigma2?: number ; width?: number ; xlim?: number ; ylim?: number }): object

生成矢量等值面

# Parameters

Name Type Description
featureCollection FeatureCollection -
weight string -
breaks number[] -
params? object params:{ model:'exponential','gaussian','spherical'，三选一，默认exponential sigma2: 0, // sigma2是σ²，对应高斯过程的方差参数，也就是这组数据z的距离，方差参数σ²的似然性反映了高斯过程中的误差，并应手动设置。一般设置为 0 ，其他数值设了可能会出空白图 alpha: 100, // Alpha α对应方差函数的先验值，此参数可能控制钻孔扩散范围,越小范围越大,少量点效果明显，但点多了且分布均匀以后改变该数字即基本无效果了，默认设置为100 canvas: HTMLCanvasElement, // 如果要渲染到画布上填这个 xlim: number, // canvas有效 ylim: number, // canvas有效 colors:string[] // canvas有效 等值面分级区间 width: number // 生成等值线宽度参数。像素长度。默认200。宽度值越大，绘制越精确，但也会导致速度变慢，内存占用越多 }
params.alpha? number -
params.canvas? HTMLCanvasElement -
params.colors? string[] -
params.extent? [number, number, number, number] -
params.model? "exponential" | "gaussian" | "spherical" -
params.sigma2? number -
params.width? number -
params.xlim? number -
params.ylim? number -

Returns: object

Name Type
alg? any
contour? FeatureCollection
grid? object
grid.grid number[]
grid.m number
grid.n number
grid.x_resolution number
grid.xlim number
grid.y_resolution number
grid.ylim number
grid.zlim number
variogram? any

# Modules

vjmap / Exports / common

# Namespace: common

# Table of contents

# Type aliases

# Variables

# Functions

# Type aliases

# mat2dtype

Ƭ mat2dtype: number[] | Float32Array

# mat3type

Ƭ mat3type: number[] | Float32Array

# mat4type

Ƭ mat4type: number[] | Float32Array

# quattype

Ƭ quattype: number[] | Float32Array

# vec2type

Ƭ vec2type: number[] | Float32Array

# vec3type

Ƭ vec3type: number[] | Float32Array

# vec4type

Ƭ vec4type: number[] | Float32Array

# Variables

# EPSILON

• Const EPSILON: 1e-8= 0.00000001

# Functions

# equals

▸ equals(a: number, b: number): boolean

Tests whether or not the arguments have approximately the same value, within an absolute or relative tolerance of glMatrix.EPSILON (an absolute tolerance is used for values less than or equal to 1.0, and a relative tolerance is used for larger values)

# Parameters
Name Type Description
a number The first number to test.
b number The second number to test.

Returns: boolean

True if the numbers are approximately equal, false otherwise.

# toRadian

▸ toRadian(a: number): number

Convert Degree To Radian

# Parameters
Name Type Description
a number Angle in Degrees

Returns: number

vjmap / Exports / default / Dom

# Namespace: Dom

default.Dom

# Table of contents

# Type aliases

# Variables

# Functions

# Type aliases

# Anchor

Ƭ Anchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right"

# Variables

# anchorTranslate

• Const anchorTranslate: Record<Anchor, string>

# Functions

# addClass

▸ addClass(el: HTMLElement, name: string): void

# Parameters
Name Type
el HTMLElement
name string

Returns: void

# addEventListener

▸ addEventListener(target: any, type: any, callback: any, options?: { capture?: boolean ; passive?: boolean }): void

# Parameters
Name Type Default value
target any -
type any -
callback any -
options object {}
options.capture? boolean -
options.passive? boolean -

Returns: void

# create

▸ create(tagName: string, className?: string, container?: HTMLElement): HTMLElement

# Parameters
Name Type
tagName string
className? string
container? HTMLElement

Returns: HTMLElement

# createNS

▸ createNS(namespaceURI: string, tagName: string): Element

# Parameters
Name Type
namespaceURI string
tagName string

Returns: Element

# disableDrag

▸ disableDrag(): void

Returns: void

# enableDrag

▸ enableDrag(): void

Returns: void

# getClass

▸ getClass(el: HTMLElement): any

# Parameters
Name Type
el HTMLElement

Returns: any

# hasClass

▸ hasClass(el: HTMLElement, name: string): boolean

# Parameters
Name Type
el HTMLElement
name string

Returns: boolean

# mouseButton

▸ mouseButton(e: MouseEvent): number

# Parameters
Name Type
e MouseEvent

Returns: number

# mousePos

▸ mousePos(el: HTMLElement, e: MouseEvent | WheelEvent): GeoPoint

# Parameters
Name Type
el HTMLElement
e MouseEvent | WheelEvent

Returns: GeoPoint

# remove

▸ remove(node: HTMLElement): void

# Parameters
Name Type
node HTMLElement

Returns: void

# removeClass

▸ removeClass(el: HTMLElement, name: string): void

# Parameters
Name Type
el HTMLElement
name string

Returns: void

# removeEventListener

▸ removeEventListener(target: any, type: any, callback: any, options?: { capture?: boolean ; passive?: boolean }): void

# Parameters
Name Type Default value
target any -
type any -
callback any -
options object {}
options.capture? boolean -
options.passive? boolean -

Returns: void

# setClass

▸ setClass(el: HTMLElement, name: string): void

# Parameters
Name Type
el HTMLElement
name string

Returns: void

# setTransform

▸ setTransform(el: HTMLElement, value: string): void

# Parameters
Name Type
el HTMLElement
value string

Returns: void

# suppressClick

▸ suppressClick(): void

Returns: void

# touchPos

▸ touchPos(el: HTMLElement, touches: TouchList): GeoPoint[]

# Parameters
Name Type
el HTMLElement
touches TouchList

Returns: GeoPoint[]

vjmap / Exports / default / mat2

# Namespace: mat2

default.mat2

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: mat2type

# Functions

# LDU

▸ LDU(L: mat2type, D: mat2type, U: mat2type, a: mat2type): mat2type[]

Returns L, D and U matrices (Lower triangular, Diagonal and Upper triangular) by factorizing the input matrix

# Parameters
Name Type Description
L mat2type the lower triangular matrix
D mat2type the diagonal matrix
U mat2type the upper triangular matrix
a mat2type the input matrix to factorize

Returns: mat2type[]

# add

▸ add(out: mat2type, a: mat2type, b: mat2type): mat2type

Adds two mat2's

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the first operand
b mat2type the second operand

Returns: mat2type

out

# adjoint

▸ adjoint(out: mat2type, a: mat2type): mat2type

Calculates the adjugate of a mat2

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the source matrix

Returns: mat2type

out

# clone

▸ clone(a: mat2type): Float32Array

Creates a new mat2 initialized with values from an existing matrix

# Parameters
Name Type Description
a mat2type matrix to clone

Returns: Float32Array

a new 2x2 matrix

# copy

▸ copy(out: mat2type, a: mat2type): mat2type

Copy the values from one mat2 to another

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the source matrix

Returns: mat2type

out

# create

▸ create(): Float32Array

Creates a new identity mat2

Returns: Float32Array

a new 2x2 matrix

# determinant

▸ determinant(a: mat2type): number

Calculates the determinant of a mat2

# Parameters
Name Type Description
a mat2type the source matrix

Returns: number

determinant of a

# equals

▸ equals(a: mat2type, b: mat2type): boolean

Returns whether or not the matrices have approximately the same elements in the same position.

# Parameters
Name Type Description
a mat2type The first matrix.
b mat2type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# exactEquals

▸ exactEquals(a: mat2type, b: mat2type): boolean

Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a mat2type The first matrix.
b mat2type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# frob

▸ frob(a: mat2type): number

Returns Frobenius norm of a mat2

# Parameters
Name Type Description
a mat2type the matrix to calculate Frobenius norm of

Returns: number

Frobenius norm

# fromRotation

▸ fromRotation(out: mat2type, rad: number): mat2type

Creates a matrix from a given angle This is equivalent to (but much faster than):

mat2.identity(dest);
mat2.rotate(dest, dest, rad);
# Parameters
Name Type Description
out mat2type mat2 receiving operation result
rad number the angle to rotate the matrix by

Returns: mat2type

out

# fromScaling

▸ fromScaling(out: mat2type, v: mat2type): mat2type

Creates a matrix from a vector scaling This is equivalent to (but much faster than):

mat2.identity(dest);
mat2.scale(dest, dest, vec);
# Parameters
Name Type Description
out mat2type mat2 receiving operation result
v mat2type Scaling vector

Returns: mat2type

out

# fromValues

▸ fromValues(m00: number, m01: number, m10: number, m11: number): mat2type

Create a new mat2 with the given values

# Parameters
Name Type Description
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m10 number Component in column 1, row 0 position (index 2)
m11 number Component in column 1, row 1 position (index 3)

Returns: mat2type

out A new 2x2 matrix

# identity

▸ identity(out: mat2type): mat2type

Set a mat2 to the identity matrix

# Parameters
Name Type Description
out mat2type the receiving matrix

Returns: mat2type

out

# invert

▸ invert(out: mat2type, a: mat2type): mat2type | null

Inverts a mat2

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the source matrix

Returns: mat2type | null

out

# multiply

▸ multiply(out: mat2type, a: mat2type, b: mat2type): mat2type

Multiplies two mat2's

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the first operand
b mat2type the second operand

Returns: mat2type

out

# multiplyScalar

▸ multiplyScalar(out: mat2type, a: mat2type, b: number): mat2type

Multiply each element of the matrix by a scalar.

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the matrix to scale
b number amount to scale the matrix's elements by

Returns: mat2type

out

# multiplyScalarAndAdd

▸ multiplyScalarAndAdd(out: mat2type, a: mat2type, b: mat2type, scale: number): mat2type

Adds two mat2's after multiplying each element of the second operand by a scalar value.

# Parameters
Name Type Description
out mat2type the receiving vector
a mat2type the first operand
b mat2type the second operand
scale number the amount to scale b's elements by before adding

Returns: mat2type

out

# rotate

▸ rotate(out: mat2type, a: mat2type, rad: number): mat2type

Rotates a mat2 by the given angle

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat2type

out

# scale

▸ scale(out: mat2type, a: mat2type, v: mat2type): mat2type

Scales the mat2 by the dimensions in the given vec2

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the matrix to rotate
v mat2type the vec2 to scale the matrix by

Returns: mat2type

out

# set

▸ set(out: mat2type, m00: number, m01: number, m10: number, m11: number): mat2type

Set the components of a mat2 to the given values

# Parameters
Name Type Description
out mat2type the receiving matrix
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m10 number Component in column 1, row 0 position (index 2)
m11 number Component in column 1, row 1 position (index 3)

Returns: mat2type

out

# str

▸ str(a: mat2type): string

Returns a string representation of a mat2

# Parameters
Name Type Description
a mat2type matrix to represent as a string

Returns: string

string representation of the matrix

# subtract

▸ subtract(out: mat2type, a: mat2type, b: mat2type): mat2type

Subtracts matrix b from matrix a

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the first operand
b mat2type the second operand

Returns: mat2type

out

# transpose

▸ transpose(out: mat2type, a: mat2type): mat2type

Transpose the values of a mat2

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the source matrix

Returns: mat2type

out

vjmap / Exports / default / mat2d

# Namespace: mat2d

default.mat2d

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: mat2dtype

# Functions

# add

▸ add(out: mat2dtype, a: mat2dtype, b: mat2dtype): mat2dtype

Adds two mat2d's

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the first operand
b mat2dtype the second operand

Returns: mat2dtype

out

# clone

▸ clone(a: mat2dtype): mat2dtype

Creates a new mat2d initialized with values from an existing matrix

# Parameters
Name Type Description
a mat2dtype matrix to clone

Returns: mat2dtype

a new 2x3 matrix

# copy

▸ copy(out: mat2dtype, a: mat2dtype): mat2dtype

Copy the values from one mat2d to another

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the source matrix

Returns: mat2dtype

out

# create

▸ create(): mat2dtype

Creates a new identity mat2d

Returns: mat2dtype

a new 2x3 matrix

# determinant

▸ determinant(a: mat2dtype): number

Calculates the determinant of a mat2d

# Parameters
Name Type Description
a mat2dtype the source matrix

Returns: number

determinant of a

# equals

▸ equals(a: mat2dtype, b: mat2dtype): boolean

Returns whether or not the matrices have approximately the same elements in the same position.

# Parameters
Name Type Description
a mat2dtype The first matrix.
b mat2dtype The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# exactEquals

▸ exactEquals(a: mat2dtype, b: mat2dtype): boolean

Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a mat2dtype The first matrix.
b mat2dtype The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# frob

▸ frob(a: mat2dtype): number

Returns Frobenius norm of a mat2d

# Parameters
Name Type Description
a mat2dtype the matrix to calculate Frobenius norm of

Returns: number

Frobenius norm

# fromRotation

▸ fromRotation(out: mat2dtype, rad: number): mat2dtype

Creates a matrix from a given angle This is equivalent to (but much faster than):

mat2d.identity(dest);
mat2d.rotate(dest, dest, rad);
# Parameters
Name Type Description
out mat2dtype mat2d receiving operation result
rad number the angle to rotate the matrix by

Returns: mat2dtype

out

# fromScaling

▸ fromScaling(out: mat2dtype, v: mat2dtype): mat2dtype

Creates a matrix from a vector scaling This is equivalent to (but much faster than):

mat2d.identity(dest);
mat2d.scale(dest, dest, vec);
# Parameters
Name Type Description
out mat2dtype mat2d receiving operation result
v mat2dtype Scaling vector

Returns: mat2dtype

out

# fromTranslation

▸ fromTranslation(out: mat2dtype, v: mat2dtype): mat2dtype

Creates a matrix from a vector translation This is equivalent to (but much faster than):

mat2d.identity(dest);
mat2d.translate(dest, dest, vec);
# Parameters
Name Type Description
out mat2dtype mat2d receiving operation result
v mat2dtype Translation vector

Returns: mat2dtype

out

# fromValues

▸ fromValues(a: number, b: number, c: number, d: number, tx: number, ty: number): mat2dtype

Create a new mat2d with the given values

# Parameters
Name Type Description
a number Component A (index 0)
b number Component B (index 1)
c number Component C (index 2)
d number Component D (index 3)
tx number Component TX (index 4)
ty number Component TY (index 5)

Returns: mat2dtype

A new mat2d

# identity

▸ identity(out: mat2dtype): mat2dtype

Set a mat2d to the identity matrix

# Parameters
Name Type Description
out mat2dtype the receiving matrix

Returns: mat2dtype

out

# invert

▸ invert(out: mat2dtype, a: mat2dtype): mat2dtype | null

Inverts a mat2d

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the source matrix

Returns: mat2dtype | null

out

# multiply

▸ multiply(out: mat2dtype, a: mat2dtype, b: mat2dtype): mat2dtype

Multiplies two mat2d's

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the first operand
b mat2dtype the second operand

Returns: mat2dtype

out

# multiplyScalar

▸ multiplyScalar(out: mat2dtype, a: mat2dtype, b: number): mat2dtype

Multiply each element of the matrix by a scalar.

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the matrix to scale
b number amount to scale the matrix's elements by

Returns: mat2dtype

out

# multiplyScalarAndAdd

▸ multiplyScalarAndAdd(out: mat2dtype, a: mat2dtype, b: mat2dtype, scale: number): mat2dtype

Adds two mat2d's after multiplying each element of the second operand by a scalar value.

# Parameters
Name Type Description
out mat2dtype the receiving vector
a mat2dtype the first operand
b mat2dtype the second operand
scale number the amount to scale b's elements by before adding

Returns: mat2dtype

out

# rotate

▸ rotate(out: mat2dtype, a: mat2dtype, rad: number): mat2dtype

Rotates a mat2d by the given angle

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat2dtype

out

# scale

▸ scale(out: mat2dtype, a: mat2dtype, v: mat2dtype): mat2dtype

Scales the mat2d by the dimensions in the given vec2

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the matrix to translate
v mat2dtype the vec2 to scale the matrix by

Returns: mat2dtype

out

# set

▸ set(out: mat2dtype, a: number, b: number, c: number, d: number, tx: number, ty: number): mat2dtype

Set the components of a mat2d to the given values

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a number Component A (index 0)
b number Component B (index 1)
c number Component C (index 2)
d number Component D (index 3)
tx number Component TX (index 4)
ty number Component TY (index 5)

Returns: mat2dtype

out

# str

▸ str(a: mat2dtype): string

Returns a string representation of a mat2d

# Parameters
Name Type Description
a mat2dtype matrix to represent as a string

Returns: string

string representation of the matrix

# subtract

▸ subtract(out: mat2dtype, a: mat2dtype, b: mat2dtype): mat2dtype

Subtracts matrix b from matrix a

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the first operand
b mat2dtype the second operand

Returns: mat2dtype

out

# translate

▸ translate(out: mat2dtype, a: mat2dtype, v: mat2dtype): mat2dtype

Translates the mat2d by the dimensions in the given vec2

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the matrix to translate
v mat2dtype the vec2 to translate the matrix by

Returns: mat2dtype

out

vjmap / Exports / default / mat3

# Namespace: mat3

default.mat3

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: mat3type

# Functions

# add

▸ add(out: mat3type, a: mat3type, b: mat3type): mat3type

Adds two mat3's

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the first operand
b mat3type the second operand

Returns: mat3type

out

# adjoint

▸ adjoint(out: mat3type, a: mat3type): mat3type

Calculates the adjugate of a mat3

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the source matrix

Returns: mat3type

out

# clone

▸ clone(a: mat3type): mat3type

Creates a new mat3 initialized with values from an existing matrix

# Parameters
Name Type Description
a mat3type matrix to clone

Returns: mat3type

a new 3x3 matrix

# copy

▸ copy(out: mat3type, a: mat3type): mat3type

Copy the values from one mat3 to another

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the source matrix

Returns: mat3type

out

# create

▸ create(): mat3type

Creates a new identity mat3

Returns: mat3type

a new 3x3 matrix

# determinant

▸ determinant(a: mat3type): number

Calculates the determinant of a mat3

# Parameters
Name Type Description
a mat3type the source matrix

Returns: number

determinant of a

# equals

▸ equals(a: mat3type, b: mat3type): boolean

Returns whether or not the matrices have approximately the same elements in the same position.

# Parameters
Name Type Description
a mat3type The first matrix.
b mat3type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# exactEquals

▸ exactEquals(a: mat3type, b: mat3type): boolean

Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a mat3type The first matrix.
b mat3type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# frob

▸ frob(a: mat3type): number

Returns Frobenius norm of a mat3

# Parameters
Name Type Description
a mat3type the matrix to calculate Frobenius norm of

Returns: number

Frobenius norm

# fromMat2d

▸ fromMat2d(out: mat3type, a: mat2dtype): mat3type

Copies the values from a mat2d into a mat3

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat2dtype the matrix to copy

Returns: mat3type

out

# fromMat4

▸ fromMat4(out: mat3type, a: mat3type): mat3type

Copies the upper-left 3x3 values into the given mat3.

# Parameters
Name Type Description
out mat3type the receiving 3x3 matrix
a mat3type the source 4x4 matrix

Returns: mat3type

out

# fromQuat

▸ fromQuat(out: mat3type, q: quattype): mat3type

Calculates a 3x3 matrix from the given quaternion

# Parameters
Name Type Description
out mat3type mat3 receiving operation result
q quattype Quaternion to create matrix from

Returns: mat3type

out

# fromRotation

▸ fromRotation(out: mat3type, rad: number): mat3type

Creates a matrix from a given angle This is equivalent to (but much faster than):

mat3.identity(dest);
mat3.rotate(dest, dest, rad);
# Parameters
Name Type Description
out mat3type mat3 receiving operation result
rad number the angle to rotate the matrix by

Returns: mat3type

out

# fromScaling

▸ fromScaling(out: mat3type, v: vec2type): mat3type

Creates a matrix from a vector scaling This is equivalent to (but much faster than):

mat3.identity(dest);
mat3.scale(dest, dest, vec);
# Parameters
Name Type Description
out mat3type mat3 receiving operation result
v vec2type Scaling vector

Returns: mat3type

out

# fromTranslation

▸ fromTranslation(out: mat3type, v: vec2type): mat3type

Creates a matrix from a vector translation This is equivalent to (but much faster than):

mat3.identity(dest);
mat3.translate(dest, dest, vec);
# Parameters
Name Type Description
out mat3type mat3 receiving operation result
v vec2type Translation vector

Returns: mat3type

out

# fromValues

▸ fromValues(m00: number, m01: number, m02: number, m10: number, m11: number, m12: number, m20: number, m21: number, m22: number): mat3type

Create a new mat3 with the given values

# Parameters
Name Type Description
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m02 number Component in column 0, row 2 position (index 2)
m10 number Component in column 1, row 0 position (index 3)
m11 number Component in column 1, row 1 position (index 4)
m12 number Component in column 1, row 2 position (index 5)
m20 number Component in column 2, row 0 position (index 6)
m21 number Component in column 2, row 1 position (index 7)
m22 number Component in column 2, row 2 position (index 8)

Returns: mat3type

A new mat3

# identity

▸ identity(out: mat3type): mat3type

Set a mat3 to the identity matrix

# Parameters
Name Type Description
out mat3type the receiving matrix

Returns: mat3type

out

# invert

▸ invert(out: mat3type, a: mat3type): mat3type | null

Inverts a mat3

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the source matrix

Returns: mat3type | null

out

# multiply

▸ multiply(out: mat3type, a: mat3type, b: mat3type): mat3type

Multiplies two mat3's

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the first operand
b mat3type the second operand

Returns: mat3type

out

# multiplyScalar

▸ multiplyScalar(out: mat3type, a: mat3type, b: number): mat3type

Multiply each element of the matrix by a scalar.

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the matrix to scale
b number amount to scale the matrix's elements by

Returns: mat3type

out

# multiplyScalarAndAdd

▸ multiplyScalarAndAdd(out: mat3type, a: mat3type, b: mat3type, s: number): mat3type

Adds two mat3's after multiplying each element of the second operand by a scalar value.

# Parameters
Name Type Description
out mat3type the receiving vector
a mat3type the first operand
b mat3type the second operand
s number the amount to scale b's elements by before adding

Returns: mat3type

out

# normalFromMat4

▸ normalFromMat4(out: mat3type, a: mat4type): mat3type | null

Calculates a 3x3 normal matrix (transpose inverse) from the 4x4 matrix

# Parameters
Name Type Description
out mat3type mat3 receiving operation result
a mat4type Mat4 to derive the normal matrix from

Returns: mat3type | null

out

# rotate

▸ rotate(out: mat3type, a: mat3type, rad: number): mat3type

Rotates a mat3 by the given angle

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat3type

out

# scale

▸ scale(out: mat3type, a: mat3type, v: vec2type): mat3type

Scales the mat3 by the dimensions in the given vec2

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the matrix to rotate
v vec2type the vec2 to scale the matrix by

Returns: mat3type

out

# set

▸ set(out: mat3type, m00: number, m01: number, m02: number, m10: number, m11: number, m12: number, m20: number, m21: number, m22: number): mat3type

Set the components of a mat3 to the given values

# Parameters
Name Type Description
out mat3type the receiving matrix
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m02 number Component in column 0, row 2 position (index 2)
m10 number Component in column 1, row 0 position (index 3)
m11 number Component in column 1, row 1 position (index 4)
m12 number Component in column 1, row 2 position (index 5)
m20 number Component in column 2, row 0 position (index 6)
m21 number Component in column 2, row 1 position (index 7)
m22 number Component in column 2, row 2 position (index 8)

Returns: mat3type

out

# str

▸ str(a: mat3type): string

Returns a string representation of a mat3

# Parameters
Name Type Description
a mat3type matrix to represent as a string

Returns: string

string representation of the matrix

# subtract

▸ subtract(out: mat3type, a: mat3type, b: mat3type): mat3type

Subtracts matrix b from matrix a

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the first operand
b mat3type the second operand

Returns: mat3type

out

# translate

▸ translate(out: mat3type, a: mat3type, v: vec2type): mat3type

Translate a mat3 by the given vector

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the matrix to translate
v vec2type vector to translate by

Returns: mat3type

out

# transpose

▸ transpose(out: mat3type, a: mat3type): mat3type

Transpose the values of a mat3

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the source matrix

Returns: mat3type

out

vjmap / Exports / default / mat4

# Namespace: mat4

default.mat4

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: mat4type

# Functions

# add

▸ add(out: mat4type, a: mat4type, b: mat4type): mat4type

Adds two mat4's

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the first operand
b mat4type the second operand

Returns: mat4type

out

# adjoint

▸ adjoint(out: mat4type, a: mat4type): mat4type

Calculates the adjugate of a mat4

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the source matrix

Returns: mat4type

out

# clone

▸ clone(a: mat4type): mat4type

Creates a new mat4 initialized with values from an existing matrix

# Parameters
Name Type Description
a mat4type matrix to clone

Returns: mat4type

a new 4x4 matrix

# copy

▸ copy(out: mat4type, a: mat4type): mat4type

Copy the values from one mat4 to another

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the source matrix

Returns: mat4type

out

# create

▸ create(): mat4type

Creates a new identity mat4

Returns: mat4type

a new 4x4 matrix

# determinant

▸ determinant(a: mat4type): number

Calculates the determinant of a mat4

# Parameters
Name Type Description
a mat4type the source matrix

Returns: number

determinant of a

# equals

▸ equals(a: mat4type, b: mat4type): boolean

Returns whether or not the matrices have approximately the same elements in the same position.

# Parameters
Name Type Description
a mat4type The first matrix.
b mat4type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# exactEquals

▸ exactEquals(a: mat4type, b: mat4type): boolean

Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a mat4type The first matrix.
b mat4type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# frob

▸ frob(a: mat4type): number

Returns Frobenius norm of a mat4

# Parameters
Name Type Description
a mat4type the matrix to calculate Frobenius norm of

Returns: number

Frobenius norm

# fromQuat

▸ fromQuat(out: mat4type, q: quattype): mat4type

Calculates a 4x4 matrix from the given quaternion

# Parameters
Name Type Description
out mat4type mat4 receiving operation result
q quattype Quaternion to create matrix from

Returns: mat4type

out

# fromRotation

▸ fromRotation(out: mat4type, rad: number, axis: vec3type): mat4type | null

Creates a matrix from a given angle around a given axis This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.rotate(dest, dest, rad, axis);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
rad number the angle to rotate the matrix by
axis vec3type the axis to rotate around

Returns: mat4type | null

out

# fromRotationTranslation

▸ fromRotationTranslation(out: mat4type, q: quattype, v: vec3type): mat4type

Creates a matrix from a quaternion rotation and vector translation This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.translate(dest, vec);
var quatMat = mat4.create();
quat.toMat4(quat, quatMat);
mat4.multiply(dest, quatMat);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
q quattype Rotation quaternion
v vec3type Translation vector

Returns: mat4type

out

# fromRotationTranslationScale

▸ fromRotationTranslationScale(out: mat4type, q: quattype, v: vec3type, s: vec3type): mat4type

Creates a matrix from a quaternion rotation, vector translation and vector scale This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.translate(dest, vec);
var quatMat = mat4.create();
quat4.toMat4(quat, quatMat);
mat4.multiply(dest, quatMat);
mat4.scale(dest, scale)
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
q quattype Rotation quaternion
v vec3type Translation vector
s vec3type Scaling vector

Returns: mat4type

out

# fromRotationTranslationScaleOrigin

▸ fromRotationTranslationScaleOrigin(out: mat4type, q: quattype, v: vec3type, s: vec3type, o: vec3type): mat4type

Creates a matrix from a quaternion rotation, vector translation and vector scale, rotating and scaling around the given origin This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.translate(dest, vec);
mat4.translate(dest, origin);
var quatMat = mat4.create();
quat4.toMat4(quat, quatMat);
mat4.multiply(dest, quatMat);
mat4.scale(dest, scale)
mat4.translate(dest, negativeOrigin);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
q quattype Rotation quaternion
v vec3type Translation vector
s vec3type Scaling vector
o vec3type The origin vector around which to scale and rotate

Returns: mat4type

out

# fromScaling

▸ fromScaling(out: mat4type, v: vec3type): mat4type

Creates a matrix from a vector scaling This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.scale(dest, dest, vec);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
v vec3type Scaling vector

Returns: mat4type

out

# fromTranslation

▸ fromTranslation(out: mat4type, v: vec3type): mat4type

Creates a matrix from a vector translation This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.translate(dest, dest, vec);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
v vec3type Translation vector

Returns: mat4type

out

# fromValues

▸ fromValues(m00: number, m01: number, m02: number, m03: number, m10: number, m11: number, m12: number, m13: number, m20: number, m21: number, m22: number, m23: number, m30: number, m31: number, m32: number, m33: number): mat4type

Create a new mat4 with the given values

# Parameters
Name Type Description
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m02 number Component in column 0, row 2 position (index 2)
m03 number Component in column 0, row 3 position (index 3)
m10 number Component in column 1, row 0 position (index 4)
m11 number Component in column 1, row 1 position (index 5)
m12 number Component in column 1, row 2 position (index 6)
m13 number Component in column 1, row 3 position (index 7)
m20 number Component in column 2, row 0 position (index 8)
m21 number Component in column 2, row 1 position (index 9)
m22 number Component in column 2, row 2 position (index 10)
m23 number Component in column 2, row 3 position (index 11)
m30 number Component in column 3, row 0 position (index 12)
m31 number Component in column 3, row 1 position (index 13)
m32 number Component in column 3, row 2 position (index 14)
m33 number Component in column 3, row 3 position (index 15)

Returns: mat4type

A new mat4

# fromXRotation

▸ fromXRotation(out: mat4type, rad: number): mat4type

Creates a matrix from the given angle around the X axis This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.rotateX(dest, dest, rad);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
rad number the angle to rotate the matrix by

Returns: mat4type

out

# fromYRotation

▸ fromYRotation(out: mat4type, rad: number): mat4type

Creates a matrix from the given angle around the Y axis This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.rotateY(dest, dest, rad);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
rad number the angle to rotate the matrix by

Returns: mat4type

out

# fromZRotation

▸ fromZRotation(out: mat4type, rad: number): mat4type

Creates a matrix from the given angle around the Z axis This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.rotateZ(dest, dest, rad);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
rad number the angle to rotate the matrix by

Returns: mat4type

out

# frustum

▸ frustum(out: mat4type, left: number, right: number, bottom: number, top: number, near: number, far: number): mat4type

Generates a frustum matrix with the given bounds

# Parameters
Name Type Description
out mat4type mat4 frustum matrix will be written into
left number Left bound of the frustum
right number Right bound of the frustum
bottom number Bottom bound of the frustum
top number Top bound of the frustum
near number Near bound of the frustum
far number Far bound of the frustum

Returns: mat4type

out

# getRotation

▸ getRotation(out: vec4type, mat: mat4type): quattype

Returns a quaternion representing the rotational component of a transformation matrix. If a matrix is built with fromRotationTranslation, the returned quaternion will be the same as the quaternion originally supplied.

# Parameters
Name Type Description
out vec4type Quaternion to receive the rotation component
mat mat4type Matrix to be decomposed (input)

Returns: quattype

out

# getScaling

▸ getScaling(out: vec3type, mat: mat4type): vec3type

Returns the scaling factor component of a transformation matrix. If a matrix is built with fromRotationTranslationScale with a normalized Quaternion paramter, the returned vector will be the same as the scaling vector originally supplied.

# Parameters
Name Type Description
out vec3type Vector to receive scaling factor component
mat mat4type Matrix to be decomposed (input)

Returns: vec3type

out

# getTranslation

▸ getTranslation(out: vec3type, mat: mat4type): vec3type

Returns the translation vector component of a transformation matrix. If a matrix is built with fromRotationTranslation, the returned vector will be the same as the translation vector originally supplied.

# Parameters
Name Type Description
out vec3type Vector to receive translation component
mat mat4type Matrix to be decomposed (input)

Returns: vec3type

out

# identity

▸ identity(out: mat4type): mat4type

Set a mat4 to the identity matrix

# Parameters
Name Type Description
out mat4type the receiving matrix

Returns: mat4type

out

# invert

▸ invert(out: mat4type, a: mat4type): mat4type | null

Inverts a mat4

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the source matrix

Returns: mat4type | null

out

# lookAt

▸ lookAt(out: mat4type, eye: vec3type, center: vec3type, up: vec3type): mat4type

Generates a look-at matrix with the given eye position, focal point, and up axis

# Parameters
Name Type Description
out mat4type mat4 frustum matrix will be written into
eye vec3type Position of the viewer
center vec3type Point the viewer is looking at
up vec3type vec3 pointing up

Returns: mat4type

out

# multiply

▸ multiply(out: mat4type, a: mat4type, b: mat4type): mat4type

Multiplies two mat4s

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the first operand
b mat4type the second operand

Returns: mat4type

out

# multiplyScalar

▸ multiplyScalar(out: mat4type, a: mat4type, b: number): mat4type

Multiply each element of the matrix by a scalar.

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to scale
b number amount to scale the matrix's elements by

Returns: mat4type

out

# multiplyScalarAndAdd

▸ multiplyScalarAndAdd(out: mat4type, a: mat4type, b: mat4type, s: number): mat4type

Adds two mat4's after multiplying each element of the second operand by a scalar value.

# Parameters
Name Type Description
out mat4type the receiving vector
a mat4type the first operand
b mat4type the second operand
s number the amount to scale b's elements by before adding

Returns: mat4type

out

# ortho

▸ ortho(out: mat4type, left: number, right: number, bottom: number, top: number, near: number, far: number): mat4type

Generates a orthogonal projection matrix with the given bounds

# Parameters
Name Type Description
out mat4type mat4 frustum matrix will be written into
left number Left bound of the frustum
right number Right bound of the frustum
bottom number Bottom bound of the frustum
top number Top bound of the frustum
near number Near bound of the frustum
far number Far bound of the frustum

Returns: mat4type

out

# perspective

▸ perspective(out: mat4type, fovy: number, aspect: number, near: number, far: number): mat4type

Generates a perspective projection matrix with the given bounds

# Parameters
Name Type Description
out mat4type mat4 frustum matrix will be written into
fovy number Vertical field of view in radians
aspect number Aspect ratio. typically viewport width/height
near number Near bound of the frustum
far number Far bound of the frustum

Returns: mat4type

out

# perspectiveFromFieldOfView

▸ perspectiveFromFieldOfView(out: mat4type, fov: { downDegrees: number ; leftDegrees: number ; rightDegrees: number ; upDegrees: number }, near: number, far: number): mat4type

Generates a perspective projection matrix with the given field of view. This is primarily useful for generating projection matrices to be used with the still experiemental WebVR API.

# Parameters
Name Type Description
out mat4type mat4 frustum matrix will be written into
fov object Object containing the following values: upDegrees, downDegrees, leftDegrees, rightDegrees
fov.downDegrees number -
fov.leftDegrees number -
fov.rightDegrees number -
fov.upDegrees number -
near number Near bound of the frustum
far number Far bound of the frustum

Returns: mat4type

out

# rotate

▸ rotate(out: mat4type, a: mat4type, rad: number, axis: vec3type): mat4type | null

Rotates a mat4 by the given angle around the given axis

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to rotate
rad number the angle to rotate the matrix by
axis vec3type the axis to rotate around

Returns: mat4type | null

out

# rotateX

▸ rotateX(out: mat4type, a: mat4type, rad: number): mat4type

Rotates a matrix by the given angle around the X axis

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat4type

out

# rotateY

▸ rotateY(out: mat4type, a: mat4type, rad: number): mat4type

Rotates a matrix by the given angle around the Y axis

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat4type

out

# rotateZ

▸ rotateZ(out: mat4type, a: mat4type, rad: number): mat4type

Rotates a matrix by the given angle around the Z axis

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat4type

out

# scale

▸ scale(out: mat4type, a: mat4type, v: vec3type): mat4type

Scales the mat4 by the dimensions in the given vec3 not using vectorization

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to scale
v vec3type the vec3 to scale the matrix by

Returns: mat4type

out

# set

▸ set(out: mat4type, m00: number, m01: number, m02: number, m03: number, m10: number, m11: number, m12: number, m13: number, m20: number, m21: number, m22: number, m23: number, m30: number, m31: number, m32: number, m33: number): mat4type

Set the components of a mat4 to the given values

# Parameters
Name Type Description
out mat4type the receiving matrix
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m02 number Component in column 0, row 2 position (index 2)
m03 number Component in column 0, row 3 position (index 3)
m10 number Component in column 1, row 0 position (index 4)
m11 number Component in column 1, row 1 position (index 5)
m12 number Component in column 1, row 2 position (index 6)
m13 number Component in column 1, row 3 position (index 7)
m20 number Component in column 2, row 0 position (index 8)
m21 number Component in column 2, row 1 position (index 9)
m22 number Component in column 2, row 2 position (index 10)
m23 number Component in column 2, row 3 position (index 11)
m30 number Component in column 3, row 0 position (index 12)
m31 number Component in column 3, row 1 position (index 13)
m32 number Component in column 3, row 2 position (index 14)
m33 number Component in column 3, row 3 position (index 15)

Returns: mat4type

out

# str

▸ str(a: mat4type): string

Returns a string representation of a mat4

# Parameters
Name Type Description
a mat4type matrix to represent as a string

Returns: string

string representation of the matrix

# subtract

▸ subtract(out: mat4type, a: mat4type, b: mat4type): mat4type

Subtracts matrix b from matrix a

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the first operand
b mat4type the second operand

Returns: mat4type

out

# translate

▸ translate(out: mat4type, a: mat4type, v: vec3type): mat4type

Translate a mat4 by the given vector

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to translate
v vec3type vector to translate by

Returns: mat4type

out

# transpose

▸ transpose(out: mat4type, a: mat4type): mat4type

Transpose the values of a mat4

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the source matrix

Returns: mat4type

out

vjmap / Exports / default / Math2D

# Namespace: Math2D

default.Math2D

# Table of contents

# Classes

# Interfaces

# Functions

# Functions

# computeSquaredLineLength

▸ computeSquaredLineLength(line: number[]): number

Computes the squared length of a line.

# Parameters
Name Type Description
line number[] An array of that forms a line via [x,y,z,x,y,z,...] tuples.

Returns: number

# dist

▸ dist(ax: number, ay: number, bx: number, by: number, az?: number, bz?: number): number

Compute distance between two 2D points a and b.

# Parameters
Name Type Description
ax number Point a.x
ay number Point a.y
bx number Point b.x
by number Point b.y
az? number
bz? number

Returns: number

between the two points

# distSquared

▸ distSquared(ax: number, ay: number, bx: number, by: number): number

Compute squared distance between two 2D points a and b.

# Parameters
Name Type Description
ax number Point a.x
ay number Point a.y
bx number Point b.x
by number Point b.y

Returns: number

Squared distance between the two points

# distToSegmentSquared

▸ distToSegmentSquared(px: number, py: number, l0x: number, l0y: number, l1x: number, l1y: number): number

Compute squared distance between a 2D point and a 2D line segment.

# Parameters
Name Type Description
px number Test point X
py number Test point y
l0x number Line segment start X
l0y number Line segment start Y
l1x number Line segment end X
l1y number Line segment end Y

Returns: number

Squared distance between point and line segment

# intersectLineAndCircle

▸ intersectLineAndCircle(xLine1: number, yLine1: number, xLine2: number, yLine2: number, radius: number, xCenter?: number, yCenter?: number): { x1: number ; x2?: number ; y1: number ; y2?: number } | undefined

Finds the intersections of a line and a circle.

# Parameters
Name Type Default value Description
xLine1 number - abscissa of first line point.
yLine1 number - ordinate of second line point.
xLine2 number - abscissa of second line point.
yLine2 number - ordinate of second line point.
radius number - circle radius.
xCenter number 0 abscissa of circle center.
yCenter number 0 ordinate of circle center.

Returns: { x1: number ; x2?: number ; y1: number ; y2?: number } | undefined

coordinates of the intersections (1 if the line is tangent to the circle, 2 if it's secant) or undefined if there's no intersection.

# intersectLines

▸ intersectLines(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number, result?: Vec2Like): Vec2Like | undefined

Computes the intersection point between two lines.

remarks This functions computes the line-line intersection (opens new window) of two lines given two points on each line.

# Parameters
Name Type Description
x1 number x coordinate of the first point of the first line.
y1 number y coordinate of the first point of the first line.
x2 number x coordinate of the second point of the first line.
y2 number y coordinate of the second point of the first line.
x3 number x coordinate of the first point of the second line.
y3 number y coordinate of the first point of the second line.
x4 number x coordinate of the second point of the second line.
y4 number y coordinate of the second point of the second line.
result Vec2Like The resulting point.

Returns: Vec2Like | undefined

# lineDist

▸ lineDist(pts: GeoPointLike[]): number

求线的距离

# Parameters
Name Type
pts GeoPointLike[]

Returns: number

vjmap / Exports / default / MathUtils

# Namespace: MathUtils

default.MathUtils

# Table of contents

# Functions

# Functions

# clamp

▸ clamp(value: number, min: number, max: number): number

Ensures that input value fits in a given range.

# Parameters
Name Type Description
value number The value to be clamped.
min number Minimum value.
max number Maximum value.

Returns: number

Clamped value.

# easeInOutCubic

▸ easeInOutCubic(startValue: number, endValue: number, time: number): number

Smoothly interpolates between two values using cubic formula

# Parameters
Name Type Description
startValue number -
endValue number -
time number -

Returns: number

Result of the interpolation within the range of [startValue, endValue]

# equals

▸ equals(num1: number, num2: number, dotErr?: number): boolean

判断两个数是否相等

# Parameters
Name Type Default value Description
num1 number -
num2 number -
dotErr number 8 允许误差的小数点后几位，默认8位

Returns: boolean

# isClamped

▸ isClamped(value: number, lowerBound: number | undefined, upperBound: number | undefined): boolean

Checks if the value of a given number is inside an upper or lower bound. The bounds may be undefined, in which case their value is ignored.

# Parameters
Name Type Description
value number Value to check.
lowerBound number | undefined The lower bound to check the value against.
upperBound number | undefined The upper bound to check the value against.

Returns: boolean

true if value is inside the bounds or if the bounds are undefined, false otherwise.

# lerp

▸ lerp(v1: number, v2: number, value: number): number

线性插值

# Parameters
Name Type
v1 number
v2 number
value number

Returns: number

# map

▸ map(val: number, inMin: number, inMax: number, outMin: number, outMax: number): number

Maps a number from one range to another.

# Parameters
Name Type Description
val number The incoming value to be converted.
inMin number Lower bound of the value's current range.
inMax number Upper bound of the value's current range.
outMin number Lower bound of the value's target range.
outMax number Upper bound of the value's target range.

Returns: number

# max2

▸ max2(a: number | undefined, b: number | undefined): number | undefined

Returns the larger of the two given numbers. Both numbers may be undefined, in which case the result is undefined. If only one of the numbers is undefined, the other number is returned.

# Parameters
Name Type Description
a number | undefined First number.
b number | undefined Second number.

Returns: number | undefined

# min2

▸ min2(a: number | undefined, b: number | undefined): number | undefined

Returns the smaller of the two given numbers. Both numbers may be undefined, in which case the result is undefined. If only one of the numbers is undefined, the other number is returned.

# Parameters
Name Type Description
a number | undefined First number.
b number | undefined Second number.

Returns: number | undefined

# smoothStep

▸ smoothStep(edge0: number, edge1: number, x: number): number

Returns a smooth interpolation between the values edge0 and edge1 based on the interpolation factor x. 0 <= x <= 1.

see https://en.wikipedia.org/wiki/Smoothstep

# Parameters
Name Type Description
edge0 number -
edge1 number -
x number -

Returns: number

# smootherStep

▸ smootherStep(edge0: number, edge1: number, x: number): number

Returns a smooth interpolation between the values edge0 and edge1 based on the interpolation factor x. 0 <= x <= 1.

Improved version by Ken Perlin, which has zero 1st- and 2nd-order derivatives at x = 0 and x = 1:

see https://en.wikipedia.org/wiki/Smoothstep

# Parameters
Name Type Description
edge0 number -
edge1 number -
x number -

Returns: number

# wrap

▸ wrap(n: number, min: number, max: number, isMin?: boolean): number

constrain n to the given range, excluding the minimum, via modular arithmetic

# Parameters
Name Type Default value Description
n number - value
min number - the minimum value to be returned, (isMin is false, exclusive, is true inclusive)
max number - the maximum value to be returned, (isMin is false, inclusive, is true exclusive)
isMin boolean false

Returns: number

number

vjmap / Exports / default

# Namespace: default

# Table of contents

# Namespaces

# Enumerations

# Classes

# Interfaces

# Type aliases

# Variables

# Functions

# Type aliases

# AnimateMarkerType

Ƭ AnimateMarkerType: "breathingAperture" | "rotatingAperture" | "haloRing" | "diffusedAperture" | "rotatingTextBorder" | "fluorescence"

breathingAperture 呼吸的光圈. rotatingAperture 旋转的光环 haloRing 发光的光环 diffusedAperture 扩散的点 rotatingTextBorder 旋转的文本框 fluorescence 荧光点

# AnimationOps

Ƭ AnimationOps<V>: PlaybackOptions<V> & DecayOptions | KeyframeOptions<V> | SpringOptions

# Type parameters
Name
V

# BackgroundLayerSpecification

Ƭ BackgroundLayerSpecification: object

# Type declaration
Name Type
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.background-color? PropertyValueSpecificationEx<ColorSpecification>
paint.background-opacity? PropertyValueSpecificationEx<number>
paint.background-pattern? PropertyValueSpecificationEx<ResolvedImageSpecification>
type "background"

# CameraFunctionSpecificationEx

Ƭ CameraFunctionSpecificationEx<T>: { stops: [number, T][] ; type: "exponential" } | { stops: [number, T][] ; type: "interval" }

# Type parameters
Name
T

# CircleLayerSpecification

Ƭ CircleLayerSpecification: object

# Type declaration
Name Type
filter? FilterSpecification
id string
layout? object
layout.circle-sort-key? DataDrivenPropertyValueSpecification<number>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.circle-blur? DataDrivenPropertyValueSpecification<number>
paint.circle-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.circle-opacity? DataDrivenPropertyValueSpecification<number>
paint.circle-pitch-alignment? PropertyValueSpecificationEx<"map" | "viewport">
paint.circle-pitch-scale? PropertyValueSpecificationEx<"map" | "viewport">
paint.circle-radius? DataDrivenPropertyValueSpecification<number>
paint.circle-stroke-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.circle-stroke-opacity? DataDrivenPropertyValueSpecification<number>
paint.circle-stroke-width? DataDrivenPropertyValueSpecification<number>
paint.circle-translate? PropertyValueSpecificationEx<[number, number]>
paint.circle-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
source string
source-layer? string
type "circle"

# CircleLayerStyleProp

Ƭ CircleLayerStyleProp: object

# Type declaration
Name Type
circleBlur? DataDrivenPropertyValueSpecification<number>
circleColor? DataDrivenPropertyValueSpecification<ColorSpecification>
circleOpacity? DataDrivenPropertyValueSpecification<number>
circlePitchAlignment? PropertyValueSpecificationEx<"map" | "viewport">
circlePitchScale? PropertyValueSpecificationEx<"map" | "viewport">
circleRadius? DataDrivenPropertyValueSpecification<number>
circleSortKey? DataDrivenPropertyValueSpecification<number>
circleStrokeColor? DataDrivenPropertyValueSpecification<ColorSpecification>
circleStrokeOpacity? DataDrivenPropertyValueSpecification<number>
circleStrokeWidth? DataDrivenPropertyValueSpecification<number>
circleTranslate? PropertyValueSpecificationEx<[number, number]>
circleTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# ColorSpecification

Ƭ ColorSpecification: string

# CompositeFunctionSpecification

Ƭ CompositeFunctionSpecification<T>: { default?: T ; property: string ; stops: [{ value: number ; zoom: number }, T][] ; type: "exponential" } | { default?: T ; property: string ; stops: [{ value: number ; zoom: number }, T][] ; type: "interval" } | { default?: T ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, T][] ; type: "categorical" }

# Type parameters
Name
T

# DataDrivenPropertyValueSpecification

Ƭ DataDrivenPropertyValueSpecification<T>: T | CameraFunctionSpecificationEx<T> | SourceFunctionSpecification<T> | CompositeFunctionSpecification<T> | ExpressionSpecificationEx

# Type parameters
Name
T

# Driver

Ƭ Driver: (update: Update) => DriverControls

# Type declaration

▸ (update: Update): DriverControls

# Parameters
Name Type
update Update

Returns: DriverControls

# Easing

Ƭ Easing: (v: number) => number

# Type declaration

▸ (v: number): number

# Parameters
Name Type
v number

Returns: number

# EasingModifier

Ƭ EasingModifier: (easing: Easing) => Easing

# Type declaration

▸ (easing: Easing): Easing

# Parameters
Name Type
easing Easing

Returns: Easing

# ExpressionSpecificationEx

Ƭ ExpressionSpecificationEx: unknown[]

# FillExtrusionLayerSpecification

Ƭ FillExtrusionLayerSpecification: object

# Type declaration
Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.fill-extrusion-base? DataDrivenPropertyValueSpecification<number>
paint.fill-extrusion-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.fill-extrusion-height? DataDrivenPropertyValueSpecification<number>
paint.fill-extrusion-opacity? PropertyValueSpecificationEx<number>
paint.fill-extrusion-pattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
paint.fill-extrusion-translate? PropertyValueSpecificationEx<[number, number]>
paint.fill-extrusion-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.fill-extrusion-vertical-gradient? PropertyValueSpecificationEx<boolean>
source string
source-layer? string
type "fill-extrusion"

# FillExtrusionLayerStyleProp

Ƭ FillExtrusionLayerStyleProp: object

# Type declaration
Name Type
fillExtrusionBase? DataDrivenPropertyValueSpecification<number>
fillExtrusionColor? DataDrivenPropertyValueSpecification<ColorSpecification>
fillExtrusionHeight? DataDrivenPropertyValueSpecification<number>
fillExtrusionOpacity? PropertyValueSpecificationEx<number>
fillExtrusionPattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
fillExtrusionTranslate? PropertyValueSpecificationEx<[number, number]>
fillExtrusionTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
fillExtrusionVerticalGradient? PropertyValueSpecificationEx<boolean>
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# FillLayerSpecification

Ƭ FillLayerSpecification: object

# Type declaration
Name Type
filter? FilterSpecification
id string
layout? object
layout.fill-sort-key? DataDrivenPropertyValueSpecification<number>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.fill-antialias? PropertyValueSpecificationEx<boolean>
paint.fill-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.fill-opacity? DataDrivenPropertyValueSpecification<number>
paint.fill-outline-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.fill-pattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
paint.fill-translate? PropertyValueSpecificationEx<[number, number]>
paint.fill-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
source string
source-layer? string
type "fill"

# FillLayerStyleProp

Ƭ FillLayerStyleProp: object

# Type declaration
Name Type
fillAntialias? PropertyValueSpecificationEx<boolean>
fillColor? DataDrivenPropertyValueSpecification<ColorSpecification>
fillOpacity? DataDrivenPropertyValueSpecification<number>
fillOutlineColor? DataDrivenPropertyValueSpecification<ColorSpecification>
fillPattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
fillSortKey? DataDrivenPropertyValueSpecification<number>
fillTranslate? PropertyValueSpecificationEx<[number, number]>
fillTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# FilterSpecification

Ƭ FilterSpecification: ["has", string] | ["!has", string] | ["==", string, string | number | boolean] | ["!=", string, string | number | boolean] | [">", string, string | number | boolean] | [">=", string, string | number | boolean] | ["<", string, string | number | boolean] | ["<=", string, string | number | boolean] | (string | FilterSpecification)[]

# FogSpecification

Ƭ FogSpecification: object

# Type declaration
Name Type
color? PropertyValueSpecificationEx<ColorSpecification>
horizon-blend? PropertyValueSpecificationEx<number>
range? PropertyValueSpecificationEx<[number, number]>

# FormattedSpecification

Ƭ FormattedSpecification: string

# GeoJSONSourceSpecification

Ƭ GeoJSONSourceSpecification: object

# Type declaration
Name Type
attribution? string
buffer? number
cluster? boolean
clusterMaxZoom? number
clusterMinPoints? number
clusterProperties? unknown
clusterRadius? number
data? unknown
filter? unknown
generateId? boolean
lineMetrics? boolean
maxzoom? number
promoteId? PromoteIdSpecificationEx
tolerance? number
type "geojson"

# GeoPointLike

Ƭ GeoPointLike: [number, number] | [number, number, number] | GeoPoint | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number }

# HeatmapLayerSpecification

Ƭ HeatmapLayerSpecification: object

# Type declaration
Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.heatmap-color? ExpressionSpecificationEx
paint.heatmap-intensity? PropertyValueSpecificationEx<number>
paint.heatmap-opacity? PropertyValueSpecificationEx<number>
paint.heatmap-radius? DataDrivenPropertyValueSpecification<number>
paint.heatmap-weight? DataDrivenPropertyValueSpecification<number>
source string
source-layer? string
type "heatmap"

# HeatmapLayerStyleProp

Ƭ HeatmapLayerStyleProp: object

# Type declaration
Name Type
filter? FilterSpecification
heatmapColor? ExpressionSpecificationEx
heatmapIntensity? PropertyValueSpecificationEx<number>
heatmapOpacity? PropertyValueSpecificationEx<number>
heatmapRadius? DataDrivenPropertyValueSpecification<number>
heatmapWeight? DataDrivenPropertyValueSpecification<number>
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# HillshadeLayerSpecification

Ƭ HillshadeLayerSpecification: object

# Type declaration
Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.hillshade-accent-color? PropertyValueSpecificationEx<ColorSpecification>
paint.hillshade-exaggeration? PropertyValueSpecificationEx<number>
paint.hillshade-highlight-color? PropertyValueSpecificationEx<ColorSpecification>
paint.hillshade-illumination-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.hillshade-illumination-direction? PropertyValueSpecificationEx<number>
paint.hillshade-shadow-color? PropertyValueSpecificationEx<ColorSpecification>
source string
source-layer? string
type "hillshade"

# HillshadeLayerStyleProp

Ƭ HillshadeLayerStyleProp: object

# Type declaration
Name Type
filter? FilterSpecification
hillshadeAccentColor? PropertyValueSpecificationEx<ColorSpecification>
hillshadeExaggeration? PropertyValueSpecificationEx<number>
hillshadeHighlightColor? PropertyValueSpecificationEx<ColorSpecification>
hillshadeIlluminationAnchor? PropertyValueSpecificationEx<"map" | "viewport">
hillshadeIlluminationDirection? PropertyValueSpecificationEx<number>
hillshadeShadowColor? PropertyValueSpecificationEx<ColorSpecification>
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# IDbPoint

Ƭ IDbPoint: [number, number, number?]

坐标类型接口

# ImageSourceSpecification

Ƭ ImageSourceSpecification: object

# Type declaration
Name Type
coordinates [[number, number], [number, number], [number, number], [number, number]]
type "image"
url string

# LayerCallback

Ƭ LayerCallback: (arg0: {}) => void

# Type declaration

▸ (arg0: {}): void

# Parameters
Name Type
arg0 object

Returns: void

# LayerRef

Ƭ LayerRef: string | string[] | RegExp | (arg0: LayerSpecification) => boolean

# LayerRefFunc

Ƭ LayerRefFunc: (arg0: LayerRef, ...args: any[]) => void

# Type declaration

▸ (arg0: LayerRef, ...args: any[]): void

# Parameters
Name Type
arg0 LayerRef
...args any[]

Returns: void

# LayerRefFunc0

Ƭ LayerRefFunc0: (arg0: LayerRef) => void

# Type declaration

▸ (arg0: LayerRef): void

# Parameters
Name Type
arg0 LayerRef

Returns: void

# LayerRefFunc1

Ƭ LayerRefFunc1<T1>: (arg0: LayerRef, arg1: T1) => void

# Type parameters
Name
T1
# Type declaration

▸ (arg0: LayerRef, arg1: T1): void

# Parameters
Name Type
arg0 LayerRef
arg1 T1

Returns: void

# LayerRefFunc2

Ƭ LayerRefFunc2<T1, T2>: (arg0: LayerRef, arg1: T1, arg2: T2) => void

# Type parameters
Name
T1
T2
# Type declaration

▸ (arg0: LayerRef, arg1: T1, arg2: T2): void

# Parameters
Name Type
arg0 LayerRef
arg1 T1
arg2 T2

Returns: void

# LayerRefFunc3

Ƭ LayerRefFunc3<T1, T2, T3>: (arg0: LayerRef, arg1: T1, arg2: T2, arg3: T3) => void

# Type parameters
Name
T1
T2
T3
# Type declaration

▸ (arg0: LayerRef, arg1: T1, arg2: T2, arg3: T3): void

# Parameters
Name Type
arg0 LayerRef
arg1 T1
arg2 T2
arg3 T3

Returns: void

# LayerSpecification

Ƭ LayerSpecification: FillLayerSpecification | LineLayerSpecification | SymbolLayerSpecification | CircleLayerSpecification | HeatmapLayerSpecification | FillExtrusionLayerSpecification | RasterLayerSpecification | HillshadeLayerSpecification | BackgroundLayerSpecification | SkyLayerSpecification

# LightSpecification

Ƭ LightSpecification: object

# Type declaration
Name Type
anchor? PropertyValueSpecificationEx<"map" | "viewport">
color? PropertyValueSpecificationEx<ColorSpecification>
intensity? PropertyValueSpecificationEx<number>
position? PropertyValueSpecificationEx<[number, number, number]>

# LineLayerSpecification

Ƭ LineLayerSpecification: object

# Type declaration
Name Type
filter? FilterSpecification
id string
layout? object
layout.line-cap? DataDrivenPropertyValueSpecification<"butt" | "round" | "square">
layout.line-join? DataDrivenPropertyValueSpecification<"bevel" | "round" | "miter">
layout.line-miter-limit? PropertyValueSpecificationEx<number>
layout.line-round-limit? PropertyValueSpecificationEx<number>
layout.line-sort-key? DataDrivenPropertyValueSpecification<number>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.line-blur? DataDrivenPropertyValueSpecification<number>
paint.line-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.line-dasharray? DataDrivenPropertyValueSpecification<number[]>
paint.line-gap-width? DataDrivenPropertyValueSpecification<number>
paint.line-gradient? ExpressionSpecificationEx
paint.line-offset? DataDrivenPropertyValueSpecification<number>
paint.line-opacity? DataDrivenPropertyValueSpecification<number>
paint.line-pattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
paint.line-translate? PropertyValueSpecificationEx<[number, number]>
paint.line-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.line-width? DataDrivenPropertyValueSpecification<number>
source string
source-layer? string
type "line"

# LineLayerStyleProp

Ƭ LineLayerStyleProp: object

# Type declaration
Name Type
filter? FilterSpecification
lineBlur? DataDrivenPropertyValueSpecification<number>
lineCap? DataDrivenPropertyValueSpecification<"butt" | "round" | "square">
lineColor? DataDrivenPropertyValueSpecification<ColorSpecification>
lineDasharray? DataDrivenPropertyValueSpecification<number[]>
lineGapWidth? DataDrivenPropertyValueSpecification<number>
lineGradient? ExpressionSpecificationEx
lineJoin? DataDrivenPropertyValueSpecification<"bevel" | "round" | "miter">
lineMiterMimit? PropertyValueSpecificationEx<number>
lineOffset? DataDrivenPropertyValueSpecification<number>
lineOpacity? DataDrivenPropertyValueSpecification<number>
linePattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
lineRoundLimit? PropertyValueSpecificationEx<number>
lineSortKey? DataDrivenPropertyValueSpecification<number>
lineTranslate? PropertyValueSpecificationEx<[number, number]>
lineTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
lineWidth? DataDrivenPropertyValueSpecification<number>
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# OffHandler

Ƭ OffHandler: () => void

# Type declaration

▸ (): void

Returns: void

# PromoteIdSpecificationEx

Ƭ PromoteIdSpecificationEx: Record<string, string> | string

# PropName

Ƭ PropName: string

# PropValue

Ƭ PropValue: string | any[] | null | number | {}

# PropertyValueSpecificationEx

Ƭ PropertyValueSpecificationEx<T>: T | CameraFunctionSpecificationEx<T> | ExpressionSpecificationEx

# Type parameters
Name
T

# RasterDEMSourceSpecification

Ƭ RasterDEMSourceSpecification: object

# Type declaration
Name Type
attribution? string
bounds? [number, number, number, number]
encoding? "terrarium" | "mapbox"
maxzoom? number
minzoom? number
tileSize? number
tiles? string[]
type "raster-dem"
url? string
volatile? boolean

# RasterLayerSpecification

Ƭ RasterLayerSpecification: object

# Type declaration
Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.raster-brightness-max? PropertyValueSpecificationEx<number>
paint.raster-brightness-min? PropertyValueSpecificationEx<number>
paint.raster-contrast? PropertyValueSpecificationEx<number>
paint.raster-fade-duration? PropertyValueSpecificationEx<number>
paint.raster-hue-rotate? PropertyValueSpecificationEx<number>
paint.raster-opacity? PropertyValueSpecificationEx<number>
paint.raster-resampling? PropertyValueSpecificationEx<"linear" | "nearest">
paint.raster-saturation? PropertyValueSpecificationEx<number>
source string
source-layer? string
type "raster"

# RasterLayerStyleProp

Ƭ RasterLayerStyleProp: object

# Type declaration
Name Type
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
rasterBrightnessMax? PropertyValueSpecificationEx<number>
rasterBrightnessMin? PropertyValueSpecificationEx<number>
rasterContrast? PropertyValueSpecificationEx<number>
rasterFadeDuration? PropertyValueSpecificationEx<number>
rasterHueRotate? PropertyValueSpecificationEx<number>
rasterOpacity? PropertyValueSpecificationEx<number>
rasterResampling? PropertyValueSpecificationEx<"linear" | "nearest">
rasterSaturation? PropertyValueSpecificationEx<number>
source? string
sourceLayer? string
visibility? "visible" | "none"

# RasterSourceSpecification

Ƭ RasterSourceSpecification: object

# Type declaration
Name Type
attribution? string
bounds? [number, number, number, number]
maxzoom? number
minzoom? number
scheme? "xyz" | "tms"
tileSize? number
tiles? string[]
type "raster"
url? string
volatile? boolean

# ResolvedImageSpecification

Ƭ ResolvedImageSpecification: string

# SkyLayerSpecification

Ƭ SkyLayerSpecification: object

# Type declaration
Name Type
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.sky-atmosphere-color? ColorSpecification
paint.sky-atmosphere-halo-color? ColorSpecification
paint.sky-atmosphere-sun? PropertyValueSpecificationEx<[number, number]>
paint.sky-atmosphere-sun-intensity? number
paint.sky-gradient? ExpressionSpecificationEx
paint.sky-gradient-center? PropertyValueSpecificationEx<[number, number]>
paint.sky-gradient-radius? PropertyValueSpecificationEx<number>
paint.sky-opacity? PropertyValueSpecificationEx<number>
paint.sky-type? PropertyValueSpecificationEx<"gradient" | "atmosphere">
type "sky"

# SourceBoundUtils

Ƭ SourceBoundUtils: MapGlUtils

# SourceFunctionSpecification

Ƭ SourceFunctionSpecification<T>: { default?: T ; property: string ; stops: [number, T][] ; type: "exponential" } | { default?: T ; property: string ; stops: [number, T][] ; type: "interval" } | { default?: T ; property: string ; stops: [string | number | boolean, T][] ; type: "categorical" } | { default?: T ; property: string ; type: "identity" }

# Type parameters
Name
T

# SourceOrData

Ƭ SourceOrData: SourceSpecification | string | GeoJsonGeomertry

# SourceRef

Ƭ SourceRef: LayerRef

# SourceRefFunc0

Ƭ SourceRefFunc0: (arg0: SourceRef) => void

# Type declaration

▸ (arg0: SourceRef): void

# Parameters
Name Type
arg0 SourceRef

Returns: void

# SourceRefFunc1

Ƭ SourceRefFunc1<T1>: (arg0: SourceRef, arg1: T1) => void

# Type parameters
Name
T1
# Type declaration

▸ (arg0: SourceRef, arg1: T1): void

# Parameters
Name Type
arg0 SourceRef
arg1 T1

Returns: void

# SourceRefFunc2

Ƭ SourceRefFunc2<T1, T2>: (arg0: SourceRef, arg1: T1, arg2: T2) => void

# Type parameters
Name
T1
T2
# Type declaration

▸ (arg0: SourceRef, arg1: T1, arg2: T2): void

# Parameters
Name Type
arg0 SourceRef
arg1 T1
arg2 T2

Returns: void

# SourceRefFunc3

Ƭ SourceRefFunc3<T1, T2, T3>: (arg0: SourceRef, arg1: T1, arg2: T2, arg3: T3) => void

# Type parameters
Name
T1
T2
T3
# Type declaration

▸ (arg0: SourceRef, arg1: T1, arg2: T2, arg3: T3): void

# Parameters
Name Type
arg0 SourceRef
arg1 T1
arg2 T2
arg3 T3

Returns: void

# SourceSpecification

Ƭ SourceSpecification: VectorSourceSpecification | RasterSourceSpecification | RasterDEMSourceSpecification | GeoJSONSourceSpecification | VideoSourceSpecification | ImageSourceSpecification

# StyleSpecification

Ƭ StyleSpecification: object

# Type declaration
Name Type
bearing? number
center? number[]
fog? FogSpecification
glyphs? string
layers LayerSpecification[]
light? LightSpecification
metadata? unknown
name? string
pitch? number
sources Record<string, SourceSpecification>
sprite? string
terrain? TerrainSpecificationEx
transition? TransitionSpecification
version 8
zoom? number

# SymbolLayerSpecification

Ƭ SymbolLayerSpecification: object

# Type declaration
Name Type
filter? FilterSpecification
id string
layout? object
layout.icon-allow-overlap? PropertyValueSpecificationEx<boolean>
layout.icon-anchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
layout.icon-ignore-placement? PropertyValueSpecificationEx<boolean>
layout.icon-image? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
layout.icon-keep-upright? PropertyValueSpecificationEx<boolean>
layout.icon-offset? DataDrivenPropertyValueSpecification<[number, number]>
layout.icon-optional? PropertyValueSpecificationEx<boolean>
layout.icon-padding? PropertyValueSpecificationEx<number>
layout.icon-pitch-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.icon-rotate? DataDrivenPropertyValueSpecification<number>
layout.icon-rotation-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.icon-size? DataDrivenPropertyValueSpecification<number>
layout.icon-text-fit? PropertyValueSpecificationEx<"none" | "width" | "height" | "both">
layout.icon-text-fit-padding? PropertyValueSpecificationEx<[number, number, number, number]>
layout.symbol-avoid-edges? PropertyValueSpecificationEx<boolean>
layout.symbol-placement? PropertyValueSpecificationEx<"point" | "line" | "line-center">
layout.symbol-sort-key? DataDrivenPropertyValueSpecification<number>
layout.symbol-spacing? PropertyValueSpecificationEx<number>
layout.symbol-z-order? PropertyValueSpecificationEx<"auto" | "viewport-y" | "source">
layout.text-allow-overlap? PropertyValueSpecificationEx<boolean>
layout.text-anchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
layout.text-field? DataDrivenPropertyValueSpecification<FormattedSpecification>
layout.text-font? DataDrivenPropertyValueSpecification<string[]>
layout.text-ignore-placement? PropertyValueSpecificationEx<boolean>
layout.text-justify? DataDrivenPropertyValueSpecification<"auto" | "left" | "center" | "right">
layout.text-keep-upright? PropertyValueSpecificationEx<boolean>
layout.text-letter-spacing? DataDrivenPropertyValueSpecification<number>
layout.text-line-height? DataDrivenPropertyValueSpecification<number>
layout.text-max-angle? PropertyValueSpecificationEx<number>
layout.text-max-width? DataDrivenPropertyValueSpecification<number>
layout.text-offset? DataDrivenPropertyValueSpecification<[number, number]>
layout.text-optional? PropertyValueSpecificationEx<boolean>
layout.text-padding? PropertyValueSpecificationEx<number>
layout.text-pitch-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.text-radial-offset? DataDrivenPropertyValueSpecification<number>
layout.text-rotate? DataDrivenPropertyValueSpecification<number>
layout.text-rotation-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.text-size? DataDrivenPropertyValueSpecification<number>
layout.text-transform? DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">
layout.text-variable-anchor? PropertyValueSpecificationEx<("center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right")[]>
layout.text-writing-mode? PropertyValueSpecificationEx<("horizontal" | "vertical")[]>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.icon-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.icon-halo-blur? DataDrivenPropertyValueSpecification<number>
paint.icon-halo-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.icon-halo-width? DataDrivenPropertyValueSpecification<number>
paint.icon-opacity? DataDrivenPropertyValueSpecification<number>
paint.icon-translate? PropertyValueSpecificationEx<[number, number]>
paint.icon-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.text-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.text-halo-blur? DataDrivenPropertyValueSpecification<number>
paint.text-halo-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.text-halo-width? DataDrivenPropertyValueSpecification<number>
paint.text-opacity? DataDrivenPropertyValueSpecification<number>
paint.text-translate? PropertyValueSpecificationEx<[number, number]>
paint.text-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
source string
source-layer? string
type "symbol"

# SymbolLayerStyleProp

Ƭ SymbolLayerStyleProp: object

# Type declaration
Name Type
filter? FilterSpecification
iconAllowOverlap? PropertyValueSpecificationEx<boolean>
iconAnchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
iconColor? DataDrivenPropertyValueSpecification<ColorSpecification>
iconHaloBlur? DataDrivenPropertyValueSpecification<number>
iconHaloColor? DataDrivenPropertyValueSpecification<ColorSpecification>
iconHaloWidth? DataDrivenPropertyValueSpecification<number>
iconIgnorePlacement? PropertyValueSpecificationEx<boolean>
iconImage? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
iconKeepUpright? PropertyValueSpecificationEx<boolean>
iconOffset? DataDrivenPropertyValueSpecification<[number, number]>
iconOpacity? DataDrivenPropertyValueSpecification<number>
iconOptional? PropertyValueSpecificationEx<boolean>
iconPadding? PropertyValueSpecificationEx<number>
iconPitchAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
iconRotate? DataDrivenPropertyValueSpecification<number>
iconRotationAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
iconSize? DataDrivenPropertyValueSpecification<number>
iconTextFit? PropertyValueSpecificationEx<"none" | "width" | "height" | "both">
iconTextFitPadding? PropertyValueSpecificationEx<[number, number, number, number]>
iconTranslate? PropertyValueSpecificationEx<[number, number]>
iconTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
symbolAvoidEdges? PropertyValueSpecificationEx<boolean>
symbolPlacement? PropertyValueSpecificationEx<"point" | "line" | "line-center">
symbolSortKey? DataDrivenPropertyValueSpecification<number>
symbolSpacing? PropertyValueSpecificationEx<number>
symbolZOrder? PropertyValueSpecificationEx<"auto" | "viewport-y" | "source">
textAllowOverlap? PropertyValueSpecificationEx<boolean>
textAnchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
textColor? DataDrivenPropertyValueSpecification<ColorSpecification>
textField? DataDrivenPropertyValueSpecification<FormattedSpecification>
textFont? DataDrivenPropertyValueSpecification<string[]>
textHaloBlur? DataDrivenPropertyValueSpecification<number>
textHaloColor? DataDrivenPropertyValueSpecification<ColorSpecification>
textHaloWidth? DataDrivenPropertyValueSpecification<number>
textIgnorePlacement? PropertyValueSpecificationEx<boolean>
textJustify? DataDrivenPropertyValueSpecification<"auto" | "left" | "center" | "right">
textKeepUpright? PropertyValueSpecificationEx<boolean>
textLetterSpacing? DataDrivenPropertyValueSpecification<number>
textLineHeight? DataDrivenPropertyValueSpecification<number>
textMaxAngle? PropertyValueSpecificationEx<number>
textMaxWidth? DataDrivenPropertyValueSpecification<number>
textOffset? DataDrivenPropertyValueSpecification<[number, number]>
textOpacity? DataDrivenPropertyValueSpecification<number>
textOptional? PropertyValueSpecificationEx<boolean>
textPadding? PropertyValueSpecificationEx<number>
textPitchAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
textRadialOffset? DataDrivenPropertyValueSpecification<number>
textRotate? DataDrivenPropertyValueSpecification<number>
textRotationAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
textSize? DataDrivenPropertyValueSpecification<number>
textTransform? DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">
textTranslate? PropertyValueSpecificationEx<[number, number]>
textTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
textVariableAnchor? PropertyValueSpecificationEx<("center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right")[]>
textWritingMode? PropertyValueSpecificationEx<("horizontal" | "vertical")[]>
visibility? "visible" | "none"

# TerrainSpecificationEx

Ƭ TerrainSpecificationEx: object

# Type declaration
Name Type
exaggeration? PropertyValueSpecificationEx<number>
source string

# TransitionSpecification

Ƭ TransitionSpecification: object

# Type declaration
Name Type
delay? number
duration? number

# VectorSourceSpecification

Ƭ VectorSourceSpecification: object

# Type declaration
Name Type
attribution? string
bounds? [number, number, number, number]
maxzoom? number
minzoom? number
promoteId? PromoteIdSpecificationEx
scheme? "xyz" | "tms"
tiles? string[]
type "vector"
url? string
volatile? boolean

# VideoSourceSpecification

Ƭ VideoSourceSpecification: object

# Type declaration
Name Type
coordinates [[number, number], [number, number], [number, number], [number, number]]
type "video"
urls string[]

# mat2dtype

Ƭ mat2dtype: [number, number, number, number, number, number] | Float32Array

# mat2type

Ƭ mat2type: [number, number, number, number] | Float32Array

# mat3type

Ƭ mat3type: [number, number, number, number, number, number, number, number, number] | Float32Array

# mat4type

Ƭ mat4type: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number] | Float32Array

# quattype

Ƭ quattype: [number, number, number, number] | Float32Array

# vec2type

Ƭ vec2type: [number, number] | Float32Array

# vec3type

Ƭ vec3type: [number, number, number] | Float32Array

# vec4type

Ƭ vec4type: [number, number, number, number] | Float32Array

# Variables

# Draw

• Const Draw: object

# Type declaration
Name Type Description
Tool (options?: IDrawOptions) => IDrawTool 工具类.
actionDraw (map: any, modename: string, options?: Record<string, any>) => any 绘制动作.
actionDrawCircle (map: any, options?: Record<string, any>) => any 绘制圆动作.
actionDrawLineSting (map: any, options?: Record<string, any>) => any 绘制线动作.
actionDrawPoint (map: any, options?: Record<string, any>) => any 绘制点动作.
actionDrawPolygon (map: any, options?: Record<string, any>) => any 绘制多边形动作.
actionDrawRectangle (map: any, options?: Record<string, any>) => any 绘制矩形动作.
actionDrawSlantRectangle (map: any, options?: Record<string, any>) => any 绘制斜矩形动作.
actionSelect (map: any, draw: any, options?: Record<string, any>) => any 选择实体. 如果只能选择一个实体，options选项请输入selectSingle为true
defaultOptions () => any 缺省配置项.
modes Record<string, any> 模式.

# EPSILON

• Const EPSILON: 1e-8= 0.00000001

# EVENTS

• Const EVENTS: object

# Type declaration
Name Type
ABORT string
ERROR string
LOAD string
LOAD_END string
LOAD_START string
PROGRESS string
READY_STATE_CHANGE string
TIMEOUT string

# METHODS

• Const METHODS: Methods

# httpHelper

• Const httpHelper: object

# Type declaration
Name Type
configure (opts: Partial<Config<unknown>>) => void
del (url: string, args?: Partial<Config<unknown>>) => Promise<any>
event object
event.ABORT string
event.ERROR string
event.LOAD string
event.LOAD_END string
event.LOAD_START string
event.PROGRESS string
event.READY_STATE_CHANGE string
event.TIMEOUT string
get (url: string, params?: Record<string, any>, args?: Partial<Config<unknown>>) => Promise<any>
methods Methods
options (url: string, args?: Partial<Config<unknown>>) => Promise<any>
patch (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>
post (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>
put (url: string, data: any, args?: Partial<Config<unknown>>) => Promise<any>
rqeust (args: Partial<Config<unknown>>) => Promise<any>

# transform

• Const transform: object

# Type declaration
Name Type
CRSTypes typeof CRSTypes
EpsgCrsTypes typeof EpsgCrsTypes
convert <T>(input: T | string, crsFrom: (pt: GeoPoint) => GeoPoint | CRSTypes, crsTo?: CRSTypes) => T
getEpsgCode (coordinate: number | [number, number], crs?: EpsgCrsTypes, is3DegreeBelt?: boolean) => { crs: string ; epsg: string ; is3DegreeBelt: boolean ; proj: undefined | string }[]
getEpsgParam (crs: EpsgCrsTypes, lon?: number) => null | { epsg: string ; proj: string }

# Functions

# Graph

▸ Graph(serialized?: Serialized): object

具有深度优先搜索和拓扑排序的图数据结构。

example var graph = Graph() .addEdge("s", "t", 10) .addEdge("s", "y", 5) .addEdge("s", "y", 4) .addEdge("t", "y", 2) .addEdge("y", "t", 3) .addEdge("t", "x", 1) .addEdge("y", "x", 9) .addEdge("y", "z", 2) .addEdge("x", "z", 4) .addEdge("z", "x", 6); var res = graph.shortestPath("s", "z")

# Parameters
Name Type
serialized? Serialized

Returns: object

Name Type
addEdge (u: NodeId, v: NodeId, weight?: EdgeWeight) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
addNode (node: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
adjacent (node: NodeId) => NodeId[]
depthFirstSearch (sourceNodes?: NodeId[], includeSourceNodes: boolean, errorOnCycle: boolean) => string[]
deserialize (serialized: Serialized) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
getEdgeWeight (u: NodeId, v: NodeId) => EdgeWeight
hasCycle () => boolean
hasEdge (u: NodeId, v: NodeId) => boolean
indegree (node: NodeId) => number
lowestCommonAncestors (node1: NodeId, node2: NodeId) => string[]
nodes () => NodeId[]
outdegree (node: NodeId) => number
removeEdge (u: NodeId, v: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
removeNode (node: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
serialize () => Serialized
setEdgeWeight (u: NodeId, v: NodeId, weight: EdgeWeight) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
shortestPath (source: NodeId, destination: NodeId) => string[] & { weight?: number }
topologicalSort (sourceNodes?: NodeId[], includeSourceNodes: boolean) => string[]

# RandomID

▸ RandomID(length?: number): string

生成随机ID

# Parameters
Name Type
length? number

Returns: string

# Scene

▸ Scene(L7: any, map: Map, option?: object): object

L7图层，可参考https://l7.antv.vision/. 返回一个场景对象

# Parameters
Name Type Description
L7 any L7命名空间
map Map
option? object

Returns: object

Name Type
addControl (ctr: any) => void
addFontFace (fontFamily: string, fontPath: string) => void
addIconFont (name: string, fontUnicode: string) => void
addIconFontGlyphs (fontFamily: string, glyphs: any[]) => void
addIconFonts (options: string[][]) => void
addImage (id: string, img: any) => void
addLayer (layer: any) => void
addMarker (marker: any) => void
addMarkerLayer (layer: any) => void
addPopup (popup: any) => void
containerToLngLat (pixel: any) => any
destroy () => void
diasbleShaderPick () => void
enableShaderPick () => void
exportMap (type?: "png" | "jpg") => string
exportPng (type?: "png" | "jpg") => string
fitBounds (bound: any, options?: unknown) => void
getBounds () => any
getCenter (options?: any) => any
getContainer () => null | HTMLElement
getControlByName (name: string) => any
getLayer (id: string) => any
getLayerByName (name: string) => any
getLayers () => any[]
getMapCanvasContainer () => HTMLElement
getMapContainer () => null | HTMLElement
getMapService () => any
getMaxZoom () => number
getMinZoom () => number
getPitch () => number
getPointSizeRange () => Float32Array
getRotation () => number
getServiceContainer () => any
getSize () => [number, number]
getType () => string
getZoom () => number
hasImage (id: string) => boolean
lngLatToContainer (lnglat: any) => any
lngLatToPixel (lnglat: any) => any
off (type: string, handle: (...args: any[]) => void) => void
on (type: string, handle: (...args: any[]) => void) => void
once (type: string, handle: (...args: any[]) => void) => void
panBy (x: number, y: number) => void
panTo (p: any) => void
pixelToLngLat (pixel: any) => any
registerPostProcessingPass (constructor: (...args: any[]) => any, name: string) => void
registerRenderService (render: any) => void
removeAllLayer () => void
removeAllMakers () => void
removeControl (ctr: any) => void
removeImage (id: string) => void
removeLayer (layer: any, parentLayer?: any) => void
removeMarkerLayer (layer: any) => void
render () => void
setBgColor (color: string) => void
setCenter (center: [number, number], options?: any) => void
setEnableRender (flag: boolean) => void
setMapStatus (options: Partial<any>) => void
setMapStyle (style: any) => void
setPitch (pitch: number) => void
setRotation (rotation: number) => void
setZoom (zoom: number) => void
setZoomAndCenter (zoom: number, center: any) => void
zoomIn () => void
zoomOut () => void

# WorkerExpose

▸ WorkerExpose(target: any): void

# Parameters
Name Type
target any

Returns: void

▸ WorkerLink(worker: Worker): any

和一个Worker相关联

# Parameters
Name Type
worker Worker

Returns: any

# WorkerProxy

▸ WorkerProxy(obj: Function | string, funcContext?: Record<string, Function | string>): Function

将独立函数/类移动到工作线程的一种非常简单的方法。 或者，将 worker 中的对象或函数暴露给主线程。 所有调用都是异步的。与 async/await 配合使用效果很好

Example:

function busyAdd(a, b) {
 let st = Date.now();
 while (true) {
   if ((Date.now() - st) > 2000) break;
 }
 return a + b;
}

(async () => {
 let workerAdd = vjmap.WorkerProxy(busyAdd);
 console.log(await workerAdd(10, 20)); //30
 // the busyAdd is executed in a worker so
 // the UI does not get blocked
})();

class Adder {
constructor() {
  this.count = 0;
}
add(a, b) {
 this.count++;
  return a + b;
}
}

(async () => {
let WAdder = vjmap.WorkerProxy(Adder);
let a = await new WAdder(); // instance created/running in worker
console.log(await a.count); // 0
console.log(await a.add(10, 20)); // 30
console.log(await a.count); // 1
})();

// or:
// worker.js

importScripts('https://cdn.jsdelivr.net/npm/moment@2.20.1/moment.min.js', '../dist/workly.js');
function friendlyTime(value) {
return moment(value).calendar(null, {
  sameDay: function (now) {
   if (now - this < 1000 * 60) {
      return "[Just now]";
   } else if (now - this < 1000 * 60 * 60) {
      return "[" + Math.round((now - this) / (1000 * 60)) + " mins ago]";
   } else {
     return '[Today at] LT'
   }
 }
});
}
vjmap.WorkerExpose(friendlyTime);
main.js

(async () => {
let w = vjmap.WorkerProxy("./worker.js");
let now = Date.now();
console.log(now);
console.log(await w(now));
console.log(await w(now - (24 * 60 * 60 * 1000)));
console.log(await w(now - (4 * 24 * 60 * 60 * 1000)));
})();

 function randAdd(a, b) {
     return randInt(a, b)  + 1000; // randInt这个函数是上下文传递进来的
 }

let randAddFunc = vjmap.WorkerProxy(randAdd, {
   randInt: vjmap.randInt // 把主进程库的函数做为上下文传进去
});
console.log(await randAddFunc(100, 300));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# Parameters
Name Type Description
obj Function | string
funcContext? Record<string, Function | string> 函数上下文，如果传入的obj是函数的话，需要把obj中函数里调用的函数名称和函数方法传进来

Returns: Function

# _getEdgeIntersection

▸ _getEdgeIntersection(a: GeoPoint, b: GeoPoint, code: number, bounds: GeoBounds): GeoPoint

# Parameters
Name Type
a GeoPoint
b GeoPoint
code number
bounds GeoBounds

Returns: GeoPoint

# addScript

▸ addScript(scripts: ScriptDefaultOptions | ScriptDefaultOptions[]): Promise<unknown[]>

将脚本注入. 脚本选项信息: strategy: 用于运行 JavaScript 的策略。可以是inject、eval 或href。默认自动检测. injectLocation: 用于注入资源的位置的 document.querySelector 参数。默认为 head. async: 异步加载脚本 src: 脚本的来源

method

async

example // you can add multiple loads awit addScript([{ src: "https://code.jquery.com/jquery-3.5.0.js" }, { src: "https://code.jquery.com/jquery-3.2.0.js", async: true }, { src: "https://code.jquery.com/jquery-3.3.0.js", async: true, injectLocation: '#main div.test', }, { src: "https://code.jquery.com/jquery-3.4.0.js", strategy: 'eval', }, { // link tag // css autodetected src: "https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.0.2/css/bootstrap-grid.min.css", }])

# Parameters
Name Type Description
scripts ScriptDefaultOptions | ScriptDefaultOptions[] Options for a script

Returns: Promise<unknown[]>

# angle

▸ Const angle(a: Point23D, b?: Point23D): number

# Parameters
Name Type
a Point23D
b Point23D

Returns: number

# animateVectorLayer

▸ Const animateVectorLayer(map: Map, layerId: string, options?: IAnimateVectorLayerOptions, layerType?: number): IAnimateVectorLayerResult

创建矢量图层动画图层

# Parameters
Name Type Default value Description
map Map - 地图对象
layerId string - 矢量图层id
options IAnimateVectorLayerOptions {} 选项
layerType? number - 图层类型 0 线 1 填充 2 符号点

Returns: IAnimateVectorLayerResult

# anticipate

▸ Const anticipate(v: number): number

# Parameters
Name Type
v number

Returns: number

# applyMixins

▸ applyMixins(derivedCtor: any, baseCtors: any[]): void

Copy methods and properties from one prototype into another.

see https://www.typescriptlang.org/docs/handbook/mixins.html

# Parameters
Name Type Description
derivedCtor any Class to mix methods and properties into.
baseCtors any[] Class to take all methods and properties from.

Returns: void

# applyMixinsWithoutProperties

▸ applyMixinsWithoutProperties(derivedCtor: any, baseCtors: any[]): void

Copy methods from one prototype into another.

see https://www.typescriptlang.org/docs/handbook/mixins.html

# Parameters
Name Type Description
derivedCtor any Class to mix methods into.
baseCtors any[] Class to take all methods from.

Returns: void

# applyOffset

▸ Const applyOffset(from: number, to?: number): function

Apply offset A function that, given a value, will get the offset from from and apply it to to

# Parameters
Name Type
from number
to? number

Returns: (v: number) => undefined | number

# attract

▸ Const attract(constant: number, origin: number, v: number): number

# Parameters
Name Type
constant number
origin number
v number

Returns: number

# attractExpo

▸ Const attractExpo(constant: number, origin: number, v: number): number

# Parameters
Name Type
constant number
origin number
v number

Returns: number

# backIn

▸ Const backIn(v: number): number

# Parameters
Name Type
v number

Returns: number

# backInOut

▸ Const backInOut(v: number): number

# Parameters
Name Type
v number

Returns: number

# backOut

▸ Const backOut(v: number): number

# Parameters
Name Type
v number

Returns: number

# bezierCurveToPolyline

▸ bezierCurveToPolyline(bezierCurve: BezierCurve, precision?: number, recursiveCount?: number): CurvePoint[]

description 将 bezierCurve 转换为折线 [理想情况下，计算结果中相邻的两个点的距离等于设置的精度（单位 px）]

# Parameters
Name Type Default value Description
bezierCurve BezierCurve - 贝塞尔曲线
precision number 5 想要的精度（并非总是可以实现）[建议精度 5-10。设置的精度通常是达不到的，除非设置较高的迭代次数，计算成本较高。]
recursiveCount number 0 递归计数

Returns: CurvePoint[]

# bounceIn

▸ Const bounceIn(v: number): number

# Parameters
Name Type
v number

Returns: number

# bounceInOut

▸ Const bounceInOut(p: number): number

# Parameters
Name Type
p number

Returns: number

# bounceOut

▸ Const bounceOut(p: number): number

# Parameters
Name Type
p number

Returns: number

# bufferConvexPolygon

▸ bufferConvexPolygon(ring: GeoPoint[], buffer: number): GeoPoint[]

取一个凸环并通过在其周围应用缓冲区将其向外扩展。 此功能假定环是顺时针缠绕的。

# Parameters
Name Type
ring GeoPoint[]
buffer number

Returns: GeoPoint[]

# buildTopoGraph

▸ buildTopoGraph(lines: { id?: string ; points: GeoPoint[] ; weight?: number }[], precision?: number, hasDirection?: boolean): object

根据多条多段线，建立topo

# Parameters
Name Type Description
lines { id?: string ; points: GeoPoint[] ; weight?: number }[] 坐标，请转成几何坐标，再传入
precision? number 误差，小数点后几位， 以为相同, 如果两个点的坐标距离小于此值，则认为是同一个节点
hasDirection? boolean 是否考虑方向

Returns: object

Name Type
graph object
graph.addEdge (u: NodeId, v: NodeId, weight?: EdgeWeight) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.addNode (node: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.adjacent (node: NodeId) => NodeId[]
graph.depthFirstSearch (sourceNodes?: NodeId[], includeSourceNodes: boolean, errorOnCycle: boolean) => string[]
graph.deserialize (serialized: Serialized) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.getEdgeWeight (u: NodeId, v: NodeId) => EdgeWeight
graph.hasCycle () => boolean
graph.hasEdge (u: NodeId, v: NodeId) => boolean
graph.indegree (node: NodeId) => number
graph.lowestCommonAncestors (node1: NodeId, node2: NodeId) => string[]
graph.nodes () => NodeId[]
graph.outdegree (node: NodeId) => number
graph.removeEdge (u: NodeId, v: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.removeNode (node: NodeId) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.serialize () => Serialized
graph.setEdgeWeight (u: NodeId, v: NodeId, weight: EdgeWeight) => { addNode: (node: string) => ...; removeNode: (node: string) => ...; nodes: () => string[]; adjacent: (node: string) => string[]; addEdge: (u: string, v: string, weight?: number | undefined) => ...; ... 12 more ...; deserialize: (serialized: Serialized) => ...; }
graph.shortestPath (source: NodeId, destination: NodeId) => string[] & { weight?: number }
graph.topologicalSort (sourceNodes?: NodeId[], includeSourceNodes: boolean) => string[]
topo any

, lowestCommonAncestors: (node1: NodeId, node2: NodeId) => NodeId[], shortestPath: (source: NodeId, destination: NodeId) => NodeId[] & {weight?: EdgeWeight}, setEdgeWeight: (u: NodeId, v: NodeId, weight: EdgeWeight) => {topologicalSort: (sourceNodes?: NodeId[], includeSourceNodes?: boolean) => ...[], addNode: (node: NodeId) => any, lowestCommonAncestors: (node1: NodeId, node2: NodeId) => ...[], shortestPath: (source: NodeId, destination: NodeId) => ... & ..., setEdgeWeight: (u: NodeId, v: NodeId, weight: EdgeWeight) => any, adjacent: (node: NodeId) => NodeId[], depthFirstSearch: (sourceNodes?: NodeId[], includeSourceNodes?: boolean, errorOnCycle?: boolean) => ...[], hasCycle: () => boolean, getEdgeWeight: (u: NodeId, v: NodeId) => EdgeWeight, serialize: () => Serialized, removeEdge: (u: NodeId, v: NodeId) => any, ...}, adjacent: (node: NodeId) => NodeId[], depthFirstSearch: (sourceNodes?: NodeId[], includeSourceNodes?: boolean, errorOnCycle?: boolean) => NodeId[], hasCycle: () => boolean, getEdgeWeight: (u: NodeId, v: NodeId) => EdgeWeight, serialize: () => Serialized, removeEdge: (u: NodeId, v: NodeId) => {topologicalSort: (sourceNodes?: NodeId[], includeSourceNodes?: boolean) => ...[], addNode: (node: NodeId) => any, lowestCommonAncestors: (node1: NodeId, node2: NodeId) => ...[], shortestPath: (source: NodeId, destination: NodeId) => ... & ..., setEdgeWeight: (u: NodeId, v: NodeId, weight: EdgeWeight) => any, adjacent: (node: NodeId) => NodeId[], depthFirstSearch: (sourceNodes?: NodeId[], includeSourceNodes?: boolean, errorOnCycle?: boolean) => ...[], hasCycle: () => boolean, getEdgeWeight: (u: NodeId, v: NodeId) => EdgeWeight, serialize: () => Serialized, removeEdge: (u: NodeId, v: NodeId) => any, ...}, ...}}}

# buildTransformer

▸ buildTransformer(src: number[], dest: number[]): undefined | number[]

Usage:

const transformer = buildTransformer(
    [10, 44, 100, 44, 100, 300, 10, 300],
    [50, 54, 130, 14, 140, 330, 14, 220]
);
1
2
3
4
# Parameters
Name Type Description
src number[] source four points, [x0, y0, x1, y1, x2, y2, x3, y3]
dest number[] destination four points, [x0, y0, x1, y1, x2, y2, x3, y3]

Returns: undefined | number[]

transformer If fail, return null/undefined.

# buildTransformerMatrix3d

▸ buildTransformerMatrix3d(src: number[], dest: number[]): undefined | string

透视投影转3d css 矩阵 Usage:

const transformer = buildTransformerMatrix3d(
    [10, 44, 100, 44, 100, 300, 10, 300],
    [50, 54, 130, 14, 140, 330, 14, 220]
);
1
2
3
4
# Parameters
Name Type Description
src number[] source four points, [x0, y0, x1, y1, x2, y2, x3, y3]
dest number[] destination four points, [x0, y0, x1, y1, x2, y2, x3, y3]

Returns: undefined | string

# calcPolygonArea

▸ calcPolygonArea(points: GeoPoint[]): number

计算多边形面积

# Parameters
Name Type
points GeoPoint[]

Returns: number

# calculateSignedArea

▸ calculateSignedArea(ring: GeoPoint[]): number

返回多边形的有符号的面积。正区域为外环，具有顺时针绕组。负区域为内环，按逆时针顺序排列。

# Parameters
Name Type
ring GeoPoint[]

Returns: number

# circIn

▸ Const circIn(v: number): number

# Parameters
Name Type
v number

Returns: number

# circInOut

▸ Const circInOut(v: number): number

# Parameters
Name Type
v number

Returns: number

# circOut

▸ Const circOut(v: number): number

# Parameters
Name Type
v number

Returns: number

# clamp

▸ Const clamp(min: number, max: number, v: number): number

# Parameters
Name Type
min number
max number
v number

Returns: number

# clipPolygon

▸ clipPolygon(points: GeoPoint[], bounds: GeoBounds): GeoPoint[]

根据范围裁剪多边形

# Parameters
Name Type
points GeoPoint[]
bounds GeoBounds

Returns: GeoPoint[]

# clipSegment

▸ clipSegment(a: GeoPoint, b: GeoPoint, bounds: GeoBounds): GeoPoint[] | Boolean

根据范围裁剪线段

# Parameters
Name Type
a GeoPoint
b GeoPoint
bounds GeoBounds

Returns: GeoPoint[] | Boolean

# cloneDeep

▸ cloneDeep<T>(obj: T): T

Deep clone of object.

Like JSON.parse(JSON.stringify(obj)), but supports basic javascript types (string, number, object), Date and RegExps and cycles.

Throws error if enounters object with prototype assuming that in general class instances cannot be reliably cloned by generic algorithm.

# Type parameters
Name
T
# Parameters
Name Type
obj T

Returns: T

# closePolygon

▸ closePolygon(points: GeoPoint[]): GeoPoint[]

闭合多边形

# Parameters
Name Type
points GeoPoint[]

Returns: GeoPoint[]

points

# closestPointOnPolyline

▸ closestPointOnPolyline(p: GeoPoint, points: GeoPoint[]): object

点到多段线的最近点

# Parameters
Name Type
p GeoPoint
points GeoPoint[]

Returns: object

Name Type
closestIndex number
closestLength number
closestPoint GeoPoint
closestPrePointDist number

# closestPointOnPolylines

▸ closestPointOnPolylines(p: GeoPoint, lines: GeoPoint[][]): object

点到多条线的最近点

# Parameters
Name Type
p GeoPoint
lines GeoPoint[][]

Returns: object

Name Type
closestIndex number
closestLength number
closestPoint GeoPoint
closestPointIndex number
closestPrePointDist number

# closestPointOnSegment

▸ closestPointOnSegment(p: GeoPoint, p1: GeoPoint, p2: GeoPoint): GeoPoint

点到线段的最近点

# Parameters
Name Type
p GeoPoint
p1 GeoPoint
p2 GeoPoint

Returns: GeoPoint

# coordTransfromByFourParamter

▸ coordTransfromByFourParamter(pt: GeoPoint, param: { dx: number ; dy: number ; rotate: number ; scale: number }): GeoPoint

通过四参数进行坐标转换

# Parameters
Name Type Description
pt GeoPoint 点
param object 四参数
param.dx number -
param.dy number -
param.rotate number -
param.scale number -

Returns: GeoPoint

# coordTransfromByInvFourParamter

▸ coordTransfromByInvFourParamter(pt: GeoPoint, param: { dx: number ; dy: number ; rotate: number ; scale: number }): GeoPoint

通过四参数反算进行坐标转换

# Parameters
Name Type Description
pt GeoPoint 点
param object 四参数
param.dx number -
param.dy number -
param.rotate number -
param.scale number -

Returns: GeoPoint

# coordTransfromGetFourParamter

▸ coordTransfromGetFourParamter(srcArr: GeoPoint[], destArr: GeoPoint[], isSetRotateZero: boolean, isConsiderPointOrder?: boolean): object

坐标转换得到四参数

# Parameters
Name Type Description
srcArr GeoPoint[] 原始点数组
destArr GeoPoint[] 目标点数组
isSetRotateZero boolean 是否设置旋转为零，默认false,如果为true,则只考虑平移和缩放
isConsiderPointOrder? boolean 不考虑点的次序(这样旋转角度方向总是上面，在-180,180之间）

Returns: object

Name Type
dx number
dy number
rotate number
scale number

# createAnimateFillLayer

▸ createAnimateFillLayer(map: Map, path: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any, options?: IAnimateFillLayerOptions): ICreateFillAnimateLayerResult

创建多边形动画图层

# Parameters
Name Type Default value Description
map Map - 地图对象
path LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any - 线坐标(lngLat)
options IAnimateFillLayerOptions {} 选项

Returns: ICreateFillAnimateLayerResult

# createAnimateImages

▸ createAnimateImages(options?: ICreateAnimateImagesOptions): ImageData[]

创建动画图片集

# Parameters
Name Type Description
options? ICreateAnimateImagesOptions 选项

Returns: ImageData[]

# createAnimateLineLayer

▸ createAnimateLineLayer(map: Map, path: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any, options?: IAnimateLineLayerOptions): ICreateLineAnimateLayerResult

创建多段线动画图层

# Parameters
Name Type Description
map Map 地图对象
path LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any 线坐标(lngLat)
options? IAnimateLineLayerOptions 选项

Returns: ICreateLineAnimateLayerResult

# createAnimateSymbolLayer

▸ createAnimateSymbolLayer(map: Map, path: PointGeoJsonInput | PointGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike | any, options?: IAnimateSymbolLayerOptions): ICreateSymbolAnimateLayerResult

创建符号动画图层

# Parameters
Name Type Description
map Map 地图对象
path PointGeoJsonInput | PointGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike | any 符号坐标(lngLat)
options? IAnimateSymbolLayerOptions 选项

Returns: ICreateSymbolAnimateLayerResult

# createAnimation

▸ createAnimation<V>(__namedParameters: any): object

# Type parameters
Name Default
V number
# Parameters
Name Type
__namedParameters any

Returns: object

Name Type
start (reset?: boolean) => void
stop () => void

# createAntPathAnimateImages

▸ createAntPathAnimateImages(options?: ICreateAntPathAnimateLineLayerOptions): ImageData[]

创建蚂蚁线动画图像集

# Parameters
Name Type Description
options? ICreateAntPathAnimateLineLayerOptions 选项

Returns: ImageData[]

# createAntPathAnimateLineLayer

▸ createAntPathAnimateLineLayer(map: Map, path: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any, options?: ICreateAntPathAnimateLineLayerOptions): ICreateLineAnimateLayerResult

创建蚂蚁线动画线图层

# Parameters
Name Type Default value Description
map Map - 地图对象
path LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any - 线坐标(lngLat)
options ICreateAntPathAnimateLineLayerOptions {} 选项

Returns: ICreateLineAnimateLayerResult

# createAnticipate

▸ Const createAnticipate(power: number): Easing

# Parameters
Name Type
power number

Returns: Easing

# createArrowAnimateImages

▸ createArrowAnimateImages(options?: ICreateArrowAnimateLineLayerOptions): ImageData[]

创建箭头动画图像集

# Parameters
Name Type Description
options? ICreateArrowAnimateLineLayerOptions 选项

Returns: ImageData[]

# createArrowAnimateLineLayer

▸ createArrowAnimateLineLayer(map: Map, path: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any, options?: ICreateArrowAnimateLineLayerOptions): ICreateLineAnimateLayerResult

创建箭头动画线图层

# Parameters
Name Type Description
map Map 地图对象
path LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any 线坐标(lngLat)
options? ICreateArrowAnimateLineLayerOptions 选项

Returns: ICreateLineAnimateLayerResult

# createAttractor

▸ Const createAttractor(alterDisplacement?: Function): function

Creates an attractor that, given a strength constant, origin and value, will calculate value as attracted to origin.

# Parameters
Name Type
alterDisplacement Function

Returns: (constant: number, origin: number, v: number) => number

# createBackIn

▸ Const createBackIn(power: number): Easing

# Parameters
Name Type
power number

Returns: Easing

# createExpoIn

▸ Const createExpoIn(power: number): Easing

# Parameters
Name Type
power number

Returns: Easing

# createFrameAnimation

▸ createFrameAnimation(callback: (status: FrameAnimationStatus) => boolean, fps?: number, stopCallBack?: (status: FrameAnimationStatus) => void): FrameAnimation

创建一个 FrameAnimation 对象来启动和停止你的动画功能.

example const count = 0;

const animation = createFrameAnimation(() => { context.clearRect(0, 0, width, height); context.font = "4rem monospace"; context.textAlign = 'center'; context.fillText(count, width / 2, height / 2);

count++; });

animation.start();

# Parameters
Name Type Description
callback (status: FrameAnimationStatus) => boolean 处理动画的回调,如果返回true，表示结束动画，返回false表示继续动画， .
fps? number 一秒运行多少帧，用来控制速度，如为0，则默认为系统帧率
stopCallBack? (status: FrameAnimationStatus) => void 结束动画的回调，参数表示是取消（true)，还是正常结束(false)

Returns: FrameAnimation

| boolean}

# createLineGeoJson

▸ createLineGeoJson(input: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any): GeoJsonGeomertry

创建geoson格式的线

# Parameters
Name Type
input LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any

Returns: GeoJsonGeomertry

# createMarker

▸ createMarker(options?: createMarkerOptions): Marker

创建一个Makrer对象，相当于new Marker()

# Parameters
Name Type
options? createMarkerOptions

Returns: Marker

# createObjectOffset

▸ createObjectOffset(): object

Returns: object

Name Type
data (vertices: any) => any
margin (dist: number) => any
offset (dist: number) => any
offsetLines (dist: number) => any
padding (dist: number) => any

# createObjectPolygonUtil

▸ createObjectPolygonUtil(): object

Returns: object

Name Type
diff (polygonA: Number[][], polygonB: Number[][]) => null | Number[][]
intersection (polygonA: Number[][], polygonB: Number[][]) => null | Number[][]
union (polygonA: Number[][], polygonB: Number[][]) => null | Number[][]

# createPointGeoJson

▸ createPointGeoJson(input: PointGeoJsonInput | PointGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike | any): GeoJsonGeomertry

创建geoson格式的点

# Parameters
Name Type
input PointGeoJsonInput | PointGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike | any

Returns: GeoJsonGeomertry

# createPolygonGeoJson

▸ createPolygonGeoJson(input: LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any): GeoJsonGeomertry

创建geoson格式的多边形

# Parameters
Name Type
input LineGeoJsonInput | LineGeoJsonInput[] | GeoJsonGeomertry | GeoPointLike[] | any

Returns: GeoJsonGeomertry

# cubicBezier

▸ cubicBezier(mX1: number, mY1: number, mX2: number, mY2: number): any

# Parameters
Name Type
mX1 number
mY1 number
mX2 number
mY2 number

Returns: any

# decay

▸ decay(__namedParameters: DecayOptions): any

# Parameters
Name Type
__namedParameters DecayOptions

Returns: any

# degToRad

▸ degToRad(a: number): number

角度转弧度

# Parameters
Name Type
a number

Returns: number

# degreesToRadians

▸ Const degreesToRadians(degrees: number): number

# Parameters
Name Type
degrees number

Returns: number

# distance

▸ distance<P>(a: P, b: P): number

# Type parameters
Name Type
P number | Point2D | Point3D
# Parameters
Name Type
a P
b P

Returns: number

# easeIn

▸ Const easeIn(v: number): number

# Parameters
Name Type
v number

Returns: number

# easeInOut

▸ Const easeInOut(v: number): number

# Parameters
Name Type
v number

Returns: number

# easeOut

▸ Const easeOut(v: number): number

# Parameters
Name Type
v number

Returns: number

# entColorToHtmlColor

▸ entColorToHtmlColor(color: number | string, darkMode?: boolean, alpha?: number): string

实体颜色转html颜色

# Parameters
Name Type Description
color number | string 实体颜色
darkMode? boolean 样式是否为暗黑框
alpha? number 透明度的值

Returns: string

# equals

▸ equals(a: number, b: number): boolean

Tests whether or not the arguments have approximately the same value, within an absolute or relative tolerance of glMatrix.EPSILON (an absolute tolerance is used for values less than or equal to 1.0, and a relative tolerance is used for larger values)

# Parameters
Name Type Description
a number The first number to test.
b number The second number to test.

Returns: boolean

True if the numbers are approximately equal, false otherwise.

# findShortestPath

▸ findShortestPath(startPoint: GeoPoint, endPoint: GeoPoint, lines: { id?: string ; points: GeoPoint[] ; weight?: number }[], precision?: number, hasDirection?: boolean): { endPoint: { closestIndex: number ; closestLength: number ; closestPoint: GeoPoint ; closestPointIndex: number ; closestPrePointDist: number } ; error: undefined ; route: any[] ; routeDetail: { index: any ; points: any[] ; reverse: boolean = false }[] ; startPoint: { closestIndex: number ; closestLength: number ; closestPoint: GeoPoint ; closestPointIndex: number ; closestPrePointDist: number } } | { endPoint: undefined ; error: any ; route: undefined ; routeDetail: undefined ; startPoint: undefined }

给定所有路线、起始点、终点生成最短路径

# Parameters
Name Type Description
startPoint GeoPoint 起点
endPoint GeoPoint 终点
lines { id?: string ; points: GeoPoint[] ; weight?: number }[] 坐标，请转成几何坐标，再传入
precision? number 误差，小数点后几位， 以为相同, 如果两个点的坐标距离小于此值，则认为是同一个节点
hasDirection? boolean 是否考虑方向

Returns: { endPoint: { closestIndex: number ; closestLength: number ; closestPoint: GeoPoint ; closestPointIndex: number ; closestPrePointDist: number } ; error: undefined ; route: any[] ; routeDetail: { index: any ; points: any[] ; reverse: boolean = false }[] ; startPoint: { closestIndex: number ; closestLength: number ; closestPoint: GeoPoint ; closestPointIndex: number ; closestPrePointDist: number } } | { endPoint: undefined ; error: any ; route: undefined ; routeDetail: undefined ; startPoint: undefined }

# geoBounds

▸ geoBounds(min?: GeoPoint, max?: GeoPoint): GeoBounds

new一个GeoBounds实例

# Parameters
Name Type
min? GeoPoint
max? GeoPoint

Returns: GeoBounds

# geoPoint

▸ geoPoint(input: GeoPointLike): GeoPoint

new一个GeoPoint实例

# Parameters
Name Type
input GeoPointLike

Returns: GeoPoint

# getBezierCurveLength

▸ getBezierCurveLength(bezierCurve: BezierCurve, precision?: number, recursiveCount?: number): number

计算贝塞尔曲线的长度

# Parameters
Name Type Default value Description
bezierCurve BezierCurve - 贝塞尔曲线
precision number 5 需要的计算精度
recursiveCount number 0 迭代次数

Returns: number

# getCircleFeature

▸ getCircleFeature(center: GeoPointLike, radius: number, points?: number, startAngle?: number, endAngle?: number, includeCenterWhenArc?: boolean): GeoJsonGeomertry

得到圆或圆弧的离散化的多边形的geojson的形式

# Parameters
Name Type Default value Description
center GeoPointLike - 中心点
radius number - 半径
points number 360 离散化的个数
startAngle number 0 开始角度
endAngle number 360 结束角度
includeCenterWhenArc boolean true 如果是圆弧时，最后一个点加上中心点

Returns: GeoJsonGeomertry

, type: string, properties: {}}}

# getCirclePolygonCoordinates

▸ getCirclePolygonCoordinates(center: GeoPointLike, radius: number, points?: number, startAngle?: number, endAngle?: number, includeCenterWhenArc?: boolean): number[][]

得到圆或圆弧的离散化的多边形的点

# Parameters
Name Type Default value Description
center GeoPointLike - 中心点
radius number - 半径
points number 360 离散化的个数
startAngle number 0 开始角度
endAngle number 360 结束角度
includeCenterWhenArc boolean true 如果是圆弧时，最后一个点加上中心点

Returns: number[][]

# getEllipseFeature

▸ getEllipseFeature(center: GeoPointLike, majorAxisRadius: number, minorAxisRadius: number, points?: number, startAngle?: number, endAngle?: number, includeCenterWhenArc?: boolean): GeoJsonGeomertry

得到圆或圆弧的离散化的多边形的geojson的形式

# Parameters
Name Type Default value Description
center GeoPointLike - 中心点
majorAxisRadius number - -
minorAxisRadius number - -
points number 360 离散化的个数
startAngle number 0 开始角度
endAngle number 360 结束角度
includeCenterWhenArc boolean true 如果是圆弧时，最后一个点加上中心点

Returns: GeoJsonGeomertry

, type: string, properties: {}}}

# getEllipsePolygonCoordinates

▸ getEllipsePolygonCoordinates(center: GeoPointLike, majorAxisRadius: number, minorAxisRadius: number, points?: number, startAngle?: number, endAngle?: number, includeCenterWhenArc?: boolean): number[][]

得到椭圆或椭圆弧的离散化的多边形的点

# Parameters
Name Type Default value Description
center GeoPointLike - 中心点
majorAxisRadius number - 长轴半径
minorAxisRadius number - 短轴半径
points number 360 离散化的个数
startAngle number 0 开始角度
endAngle number 360 结束角度
includeCenterWhenArc boolean true 如果是椭/圆弧时，最后一个点加上中心点

Returns: number[][]

# getEnvelopBounds

▸ getEnvelopBounds(envelop: string, prj: any): GeoBounds

根据外包矩形创建 GeoBounds.

Example:

const b = vjmap.getEnvelopBounds('POLYGON((3466315.697899 6704304.297588, 3466315.697899 7784496.211226, 4546475.901198 7784496.211226, 4546475.901198 6704304.297588, 3466315.697899 6704304.297588))', prj);
1
# Parameters
Name Type
envelop string
prj any

Returns: GeoBounds

# getGeoBounds

▸ getGeoBounds<T>(data: T | string): GeoBounds

获取一个geojson的范围值

# Type parameters
Name Type
T GeoPoint | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection | [number, number] | [number, number, number] | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number } | GeoPointLike[]
# Parameters
Name Type Description
data T | string 输入值

Returns: GeoBounds

获取的范围值

# getOptionValue

▸ getOptionValue<T>(a: T): T

Get first defined value.

Specialized "replacement" for a || b || c used frequently to get value from various sources (defaults, configs constants). In contrast to ||, this function provides proper typing for usual use cases (constant as last argument) and correct treatment of null and undefined.

If last parameter is "defined" then return type is T, otherwise return type is T | undefined.

Usage example:

interface Config {
    x?: number;
}
const someConfig: Config = {};
const val: number | undefined = undefined;
const DEFAULT = 5;
const x = getOptionValue(val, someConfig.x, DEFAULT);
    // typeof x === 'number' because DEFAULT is defined
const y = getOptionValue(val, someConfig.x);
    // typeof y === 'number | undefined' because someConfig.x is possibly undefined
# Type parameters
Name
T
# Parameters
Name Type
a T

Returns: T

▸ getOptionValue<T>(a: T | undefined, b: T): T

# Type parameters
Name
T
# Parameters
Name Type
a T | undefined
b T

Returns: T

▸ getOptionValue<T>(a: T | undefined, b: T | undefined, c: T): T

# Type parameters
Name
T
# Parameters
Name Type
a T | undefined
b T | undefined
c T

Returns: T

▸ getOptionValue<T>(a: T | undefined, b: T | undefined, c: T | undefined, d: T): T

# Type parameters
Name
T
# Parameters
Name Type
a T | undefined
b T | undefined
c T | undefined
d T

Returns: T

▸ getOptionValue<T>(...values: (T | undefined)[]): T | undefined

# Type parameters
Name
T
# Parameters
Name Type
...values (T | undefined)[]

Returns: T | undefined

# getTempMapId

▸ getTempMapId(expireTime?: number, isVisible?: boolean): string

获取一个临时的图id(临时图形只会用临时查看，过期会自动删除)

# Parameters
Name Type Description
expireTime? number 临时图形不浏览情况下过期自动删除时间，单位分钟。默认30
isVisible? boolean 是否可见，（可见的话，将可通过ListMaps获取，否则为隐藏图）。默认不可见

Returns: string

# hexToBinStr

▸ hexToBinStr(strHex: string, isPadding?: boolean, reverse?: boolean): string

十六进制字符串转二进制字符串(可用于协同图形，图层开头显示设置的转换)

# Parameters
Name Type Default value Description
strHex string - 十进制的内容
isPadding boolean true 前面是否自动0，默认true
reverse boolean true 结果倒序，默认true

Returns: string

# htmlColorToEntColor

▸ htmlColorToEntColor(color: string): number

html颜色转实体颜色

# Parameters
Name Type Description
color string html

Returns: number

# inertia

▸ inertia(__namedParameters: InertiaOptions): object

# Parameters
Name Type
__namedParameters InertiaOptions

Returns: object

Name Type
stop () => void

# interpolate

▸ interpolate<T>(input: number[], output: T[], __namedParameters?: InterpolateOptions<T>): function

Create a function that maps from a numerical input array to a generic output array.

Accepts:

  • Numbers
  • Colors (hex, hsl, hsla, rgb, rgba)
  • Complex (combinations of one or more numbers or strings)
const mixColor = interpolate([0, 1], ['#fff', '#000'])

mixColor(0.5) // 'rgba(128, 128, 128, 1)'
1
2
3
# Type parameters
Name
T
# Parameters
Name Type Default value
input number[] -
output T[] -
__namedParameters InterpolateOptions<T> {}

Returns: (v: number) => T

# interpolateLineRange

▸ interpolateLineRange(points: GeoPointLike[] | any, number: number, isLngLat?: boolean, offsetDist?: number, minGap?: number, includeSrcPoint?: boolean): any[]

# Parameters
Name Type Default value Description
points GeoPointLike[] | any - 要插值的（多段）线的顶点(输入必须为经纬度).
number number - 沿线插入的点数；这包括端点，并且有效最小值为 2（如果给出较小的数字，则仍将返回端点）.
isLngLat boolean false 点坐标序列是否是经纬度坐标
offsetDist number 0 一个可选的垂直距离，用于从线段偏移每个点，否则它会位于.
minGap number 0 在后续插值点之间保持可选的最小间隙；如果一组“number”点的后续点之间的投影间隙低于此值，则“number”将减小到合适的值.
includeSrcPoint boolean true 包括原有点

Returns: any[]

# interpolatePointsByRatio

▸ interpolatePointsByRatio(points: GeoPointLike[] | any, ratio: number, isLngLat?: boolean): any[]

通过比例(0-1)的值，得到坐标序列的点坐标的值

# Parameters
Name Type Default value
points GeoPointLike[] | any -
ratio number -
isLngLat boolean false

Returns: any[]

# isClosedPolygon

▸ isClosedPolygon(points: GeoPoint[]): boolean

多边形是否闭合

# Parameters
Name Type
points GeoPoint[]

Returns: boolean

# isCounterClockwise

▸ isCounterClockwise(a: GeoPoint, b: GeoPoint, c: GeoPoint): boolean

指示提供的点是按逆时针（真）还是顺时针（假）顺序排列

# Parameters
Name Type
a GeoPoint
b GeoPoint
c GeoPoint

Returns: boolean

# isGeoPointLike

▸ isGeoPointLike(geoPoint: any): geoPoint is GeoPointLike

A GeoPointLike object, an array of two numbers representing longitude and latitude, or an object with lng and lat or lon and lat properties.

Example:

const center = { lat: 53.3, lng: 13.4 };
mapView.geoCenter = GeoCoordinates.fromLatLng(center);
1
2
# Parameters
Name Type
geoPoint any

Returns: geoPoint is GeoPointLike

# isPoint

▸ Const isPoint(point: Object): point is Point23D

# Parameters
Name Type
point Object

Returns: point is Point23D

# isPoint3D

▸ Const isPoint3D(point: Point23D): point is Point3D

# Parameters
Name Type
point Point23D

Returns: point is Point3D

# isPointInPolygon

▸ Const isPointInPolygon(pos: GeoPoint, polygon: GeoPoint[]): boolean

判断点是否在多边形内。

# Parameters
Name Type Description
pos GeoPoint 点
polygon GeoPoint[] 多边形坐标

Returns: boolean

# isZero

▸ isZero(value: number, precision?: number): boolean

判断是否为零

# Parameters
Name Type Description
value number 值
precision? number 精度，缺省1e-6

Returns: boolean

# kebabCase

▸ Const kebabCase(s: any): any

# Parameters
Name Type
s any

Returns: any

# keyframes

▸ keyframes<V>(__namedParameters: KeyframeOptions): any

# Type parameters
Name
V
# Parameters
Name Type
__namedParameters KeyframeOptions

Returns: any

# lineSplit

▸ lineSplit(line: GeoPoint[], splitLine: GeoPoint[], dotErr?: number): GeoPoint[][]

线被另外一条线分开多条线段，返回新的线段

# Parameters
Name Type Description
line GeoPoint[]
splitLine GeoPoint[]
dotErr? number 允许误差的小数点后几位，默认6位

Returns: GeoPoint[][]

# linear

▸ Const linear(v: number): number

# Parameters
Name Type
v number

Returns: number

# metersPerPixel

▸ metersPerPixel(zoomLevel: number, latitude?: number): number

求不同级级别下，每米表示多少像素

# Parameters
Name Type Description
zoomLevel number 级别从0表示
latitude? number 纬度

Returns: number

# mirrorEasing

▸ Const mirrorEasing(easing: Easing): Easing

# Parameters
Name Type
easing Easing

Returns: Easing

# mix

▸ Const mix(from: number, to: number, progress: number): number

# Parameters
Name Type
from number
to number
progress number

Returns: number

# mixColor

▸ Const mixColor(from: any, to: any): function

# Parameters
Name Type
from any
to any

Returns: (v: number) => any

# mixComplex

▸ Const mixComplex(origin: string, target: string): MixComplex

# Parameters
Name Type
origin string
target string

Returns: MixComplex

# multiLineSplit

▸ multiLineSplit(lines: GeoPoint[][], dotErr?: number): GeoPoint[][]

多条线之间根据交点相互分开,返回相交后的所有线段，请确保每条线段不要自相交

# Parameters
Name Type Description
lines GeoPoint[][]
dotErr? number 允许误差的小数点后几位，默认6位

Returns: GeoPoint[][]

# offsetPointLine

▸ offsetPointLine(points: GeoPoint[], distance: number): any[]

# Parameters
Name Type
points GeoPoint[]
distance number

Returns: any[]

# offsetPoints

▸ offsetPoints(pts: GeoPointLike[], options: { offset: number ; smoothFactor?: number }): any[]

# Parameters
Name Type
pts GeoPointLike[]
options object
options.offset number
options.smoothFactor? number

Returns: any[]

# openMapDarkStyle

▸ openMapDarkStyle(): IMapStyleParam

打开地图的深色背景样式，值为 {backcolor: 0}

Returns: IMapStyleParam

# openMapLightStyle

▸ openMapLightStyle(): IMapStyleParam

打开地图的浅色色背景样式，值为 {backcolor: 0xFFFFFF}

Returns: IMapStyleParam

# pick

▸ pick<T, K>(object: T, props: K[]): Pick<T, K>

Pick props from `object.

Runtime version of Pick<T,K>.

# Type parameters
Name Type
T object
K string | number | symbol
# Parameters
Name Type
object T
props K[]

Returns: Pick<T, K>

# pipe

▸ Const pipe(...transformers: Function[]): Function

# Parameters
Name Type
...transformers Function[]

Returns: Function

# pixelValue

▸ pixelValue(meters: number, zoomLevel: number, latitude?: number): number

不同级别下根据米数来求像素值

# Parameters
Name Type Description
meters number 米
zoomLevel number 级别从0表示
latitude? number 纬度

Returns: number

# pointFromVector

▸ Const pointFromVector(origin: Point2D, angle: number, distance: number): object

# Parameters
Name Type
origin Point2D
angle number
distance number

Returns: object

Name Type
x number
y number

# pointToSegmentDistance

▸ pointToSegmentDistance(p: GeoPoint, p1: GeoPoint, p2: GeoPoint): number

点到线段的距离

# Parameters
Name Type
p GeoPoint
p1 GeoPoint
p2 GeoPoint

Returns: number

# polygonCentroid

▸ polygonCentroid(vertices: GeoPoint[]): GeoPoint

根据 [x,y] 坐标列表计算多边形的质心。

# Parameters
Name Type Description
vertices GeoPoint[] 顶点坐标

Returns: GeoPoint

# polygonIsClockwise

▸ polygonIsClockwise(points: GeoPoint[]): boolean

根据格林公式判断多边形是否为顺时针

# Parameters
Name Type
points GeoPoint[]

Returns: boolean

false:逆时针

# polylineMarginToPolygon

▸ polylineMarginToPolygon(pts: GeoPointLike[], options: { arcSegments?: number ; offset: number ; smoothFactor?: number }): any

把多段线往外扩展成多边形

# Parameters
Name Type
pts GeoPointLike[]
options object
options.arcSegments? number
options.offset number
options.smoothFactor? number

Returns: any

# polylineToBezierCurve

▸ polylineToBezierCurve(polyline: CurvePoint[], close?: boolean, offsetA?: number, offsetB?: number): BezierCurve

description 将折线转换为贝塞尔曲线

# Parameters
Name Type Default value Description
polyline CurvePoint[] - 组成折线的一组点
close boolean false 闭合曲线
offsetA number 0.25 光滑程度A
offsetB number 0.25 光滑程度B

Returns: BezierCurve

一组贝塞尔曲线（无效输入将返回false）

# progress

▸ Const progress(from: number, to: number, value: number): number

# Parameters
Name Type
from number
to number
value number

Returns: number

# radToDeg

▸ radToDeg(a: number): number

弧度转角度

# Parameters
Name Type
a number

Returns: number

# radiansToDegrees

▸ Const radiansToDegrees(radians: number): number

# Parameters
Name Type
radians number

Returns: number

# randInt

▸ randInt(n: number, m: number): number

生成一个区间的随机总数

# Parameters
Name Type
n number
m number

Returns: number

# randomColor

▸ randomColor(): string

生成随机颜色

Returns: string

# reverseEasing

▸ Const reverseEasing(easing: Easing): Easing

# Parameters
Name Type
easing Easing

Returns: Easing

# segmentIntersect

▸ segmentIntersect(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number): { ratio: undefined ; result: string = "COLINEAR"; status: boolean = false; x: undefined ; y: undefined } | { ratio: number ; result: undefined = "COLINEAR"; status: boolean = true; x: number ; y: number }

线段相交

# Parameters
Name Type
x1 number
y1 number
x2 number
y2 number
x3 number
y3 number
x4 number
y4 number

Returns: { ratio: undefined ; result: string = "COLINEAR"; status: boolean = false; x: undefined ; y: undefined } | { ratio: number ; result: undefined = "COLINEAR"; status: boolean = true; x: number ; y: number }

| {result: string, status: boolean} | {x: number, y: number, status: boolean, ratio: number} | {result: string, status: boolean}}

# simplify

▸ simplify(points: GeoPoint[], tolerance?: number): GeoPoint[]

简化点坐标

# Parameters
Name Type
points GeoPoint[]
tolerance? number

Returns: GeoPoint[]

# smooth

▸ Const smooth(strength?: number): function

# Parameters
Name Type Default value
strength number 50

Returns: (v: number) => number

# smoothFrame

▸ Const smoothFrame(prevValue: number, nextValue: number, duration: number, smoothing?: number): number

# Parameters
Name Type Default value
prevValue number -
nextValue number -
duration number -
smoothing number 0

Returns: number

# snap

▸ Const snap(points: number | number[]): function

# Parameters
Name Type
points number | number[]

Returns: (v: number) => undefined | number

# spring

▸ spring(__namedParameters: SpringOptions): any

This is based on the spring implementation of Wobble https://github.com/skevy/wobble

# Parameters
Name Type
__namedParameters SpringOptions

Returns: any

# steps

▸ Const steps(steps: number, direction?: Direction): Easing

# Parameters
Name Type Default value
steps number -
direction Direction "end"

Returns: Easing

# syncMaps

▸ syncMaps(...args: Map[]): function

同步两张地图的移动。

# Parameters
Name Type
...args Map[]

Returns: () => void

# toDecimal

▸ Const toDecimal(num: number, precision?: number): number

# Parameters
Name Type Default value
num number -
precision number 2

Returns: number

# toRadian

▸ toRadian(a: number): number

Convert Degree To Radian

# Parameters
Name Type Description
a number Angle in Degrees

Returns: number

# upperCamelCase

▸ Const upperCamelCase(s: any): any

# Parameters
Name Type
s any

Returns: any

# utf8ToUnicode

▸ utf8ToUnicode(strUtf8: string): string

utf8转unicode

# Parameters
Name Type Description
strUtf8 string utf8的内容

Returns: string

# vectorContour

▸ vectorContour(featureCollection: FeatureCollection, weight: string, breaks: number[], params?: { alpha?: number ; canvas?: HTMLCanvasElement ; colors?: string[] ; extent?: [number, number, number, number] ; model?: "exponential" | "gaussian" | "spherical" ; sigma2?: number ; width?: number ; xlim?: number ; ylim?: number }): object

生成矢量等值面

# Parameters
Name Type Description
featureCollection FeatureCollection -
weight string -
breaks number[] -
params? object params:{ model:'exponential','gaussian','spherical'，三选一，默认exponential sigma2: 0, // sigma2是σ²，对应高斯过程的方差参数，也就是这组数据z的距离，方差参数σ²的似然性反映了高斯过程中的误差，并应手动设置。一般设置为 0 ，其他数值设了可能会出空白图 alpha: 100, // Alpha α对应方差函数的先验值，此参数可能控制钻孔扩散范围,越小范围越大,少量点效果明显，但点多了且分布均匀以后改变该数字即基本无效果了，默认设置为100 canvas: HTMLCanvasElement, // 如果要渲染到画布上填这个 xlim: number, // canvas有效 ylim: number, // canvas有效 colors:string[] // canvas有效 等值面分级区间 width: number // 生成等值线宽度参数。像素长度。默认200。宽度值越大，绘制越精确，但也会导致速度变慢，内存占用越多 }
params.alpha? number -
params.canvas? HTMLCanvasElement -
params.colors? string[] -
params.extent? [number, number, number, number] -
params.model? "exponential" | "gaussian" | "spherical" -
params.sigma2? number -
params.width? number -
params.xlim? number -
params.ylim? number -

Returns: object

Name Type
alg? any
contour? FeatureCollection
grid? object
grid.grid number[]
grid.m number
grid.n number
grid.x_resolution number
grid.xlim number
grid.y_resolution number
grid.ylim number
grid.zlim number
variogram? any

# velocityPerFrame

▸ velocityPerFrame(xps: number, frameDuration: number): number

# Parameters
Name Type
xps number
frameDuration number

Returns: number

# velocityPerSecond

▸ velocityPerSecond(velocity: number, frameDuration: number): number

# Parameters
Name Type
velocity number
frameDuration number

Returns: number

# wrap

▸ Const wrap(min: number, max: number, v: number): number

# Parameters
Name Type
min number
max number
v number

Returns: number

vjmap / Exports / default / quat

# Namespace: quat

default.quat

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: quattype

# Functions

# add

▸ Const add(out: vec4type, a: vec4type, b: vec4type): vec4type

Adds two quat's

function

# Parameters
Name Type Description
out vec4type the receiving quaternion
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# calculateW

▸ calculateW(out: quattype, a: quattype): quattype

Calculates the W component of a quat from the X, Y, and Z components. Assumes that quaternion is 1 unit in length. Any existing W component will be ignored.

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype quat to calculate W component of

Returns: quattype

out

# clone

▸ Const clone(a: vec4type): vec4type

Creates a new quat initialized with values from an existing quaternion

function

# Parameters
Name Type Description
a vec4type quaternion to clone

Returns: vec4type

a new quaternion

# conjugate

▸ conjugate(out: quattype, a: quattype): quattype

Calculates the conjugate of a quat If the quaternion is normalized, this function is faster than quat.inverse and produces the same result.

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype quat to calculate conjugate of

Returns: quattype

out

# copy

▸ Const copy(out: vec4type, a: vec4type): vec4type

Copy the values from one quat to another

function

# Parameters
Name Type Description
out vec4type the receiving quaternion
a vec4type the source quaternion

Returns: vec4type

out

# create

▸ create(): quattype

Creates a new identity quat

Returns: quattype

a new quaternion

# dot

▸ Const dot(a: vec4type, b: vec4type): number

Calculates the dot product of two quat's

function

# Parameters
Name Type Description
a vec4type the first operand
b vec4type the second operand

Returns: number

dot product of a and b

# equals

▸ Const equals(a: vec4type, b: vec4type): boolean

Returns whether or not the quaternions have approximately the same elements in the same position.

# Parameters
Name Type Description
a vec4type The first vector.
b vec4type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# exactEquals

▸ Const exactEquals(a: vec4type, b: vec4type): boolean

Returns whether or not the quaternions have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a vec4type The first quaternion.
b vec4type The second quaternion.

Returns: boolean

True if the vectors are equal, false otherwise.

# fromMat3

▸ fromMat3(out: quattype, m: mat3type): quattype

Creates a quaternion from the given 3x3 rotation matrix.

NOTE: The resultant quaternion is not normalized, so you should be sure to renormalize the quaternion yourself where necessary.

function

# Parameters
Name Type Description
out quattype the receiving quaternion
m mat3type rotation matrix

Returns: quattype

out

# fromValues

▸ Const fromValues(x: number, y: number, z: number, w: number): vec4type

Creates a new quat initialized with the given values

function

# Parameters
Name Type Description
x number X component
y number Y component
z number Z component
w number W component

Returns: vec4type

a new quaternion

# getAxisAngle

▸ getAxisAngle(outAxis: vec3type, q: quattype): number

Gets the rotation axis and angle for a given quaternion. If a quaternion is created with setAxisAngle, this method will return the same values as providied in the original parameter list OR functionally equivalent values. Example: The quaternion formed by axis [0, 0, 1] and angle -90 is the same as the quaternion formed by [0, 0, 1] and 270. This method favors the latter.

# Parameters
Name Type Description
outAxis vec3type Vector receiving the axis of rotation
q quattype Quaternion to be decomposed

Returns: number

Angle, in radians, of the rotation

# identity

▸ identity(out: quattype): quattype

Set a quat to the identity quaternion

# Parameters
Name Type Description
out quattype the receiving quaternion

Returns: quattype

out

# invert

▸ invert(out: quattype, a: quattype): quattype

Calculates the inverse of a quat

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype quat to calculate inverse of

Returns: quattype

out

# length

▸ Const length(a: vec4type): number

Calculates the length of a quat

function

# Parameters
Name Type Description
a vec4type vector to calculate length of

Returns: number

length of a

# lerp

▸ Const lerp(out: vec4type, a: vec4type, b: vec4type, t: number): vec4type

Performs a linear interpolation between two quat's

function

# Parameters
Name Type Description
out vec4type the receiving quaternion
a vec4type the first operand
b vec4type the second operand
t number interpolation amount between the two inputs

Returns: vec4type

out

# multiply

▸ multiply(out: quattype, a: quattype, b: quattype): quattype

Multiplies two quat's

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype the first operand
b quattype the second operand

Returns: quattype

out

# normalize

▸ Const normalize(out: vec4type, a: vec4type): vec4type

Normalize a quat

function

# Parameters
Name Type Description
out vec4type the receiving quaternion
a vec4type quaternion to normalize

Returns: vec4type

out

# rotateX

▸ rotateX(out: quattype, a: quattype, rad: number): quattype

Rotates a quaternion by the given angle about the X axis

# Parameters
Name Type Description
out quattype quat receiving operation result
a quattype quat to rotate
rad number angle (in radians) to rotate

Returns: quattype

out

# rotateY

▸ rotateY(out: quattype, a: quattype, rad: number): quattype

Rotates a quaternion by the given angle about the Y axis

# Parameters
Name Type Description
out quattype quat receiving operation result
a quattype quat to rotate
rad number angle (in radians) to rotate

Returns: quattype

out

# rotateZ

▸ rotateZ(out: quattype, a: quattype, rad: number): quattype

Rotates a quaternion by the given angle about the Z axis

# Parameters
Name Type Description
out quattype quat receiving operation result
a quattype quat to rotate
rad number angle (in radians) to rotate

Returns: quattype

out

# rotationTo

▸ rotationTo(out: quattype, a: vec3type, b: vec3type): quattype

Sets a quaternion to represent the shortest rotation from one vector to another.

Both vectors are assumed to be unit length.

# Parameters
Name Type Description
out quattype the receiving quaternion.
a vec3type the initial vector
b vec3type the destination vector

Returns: quattype

out

# scale

▸ Const scale(out: vec4type, a: vec4type, b: number): vec4type

Scales a quat by a scalar number

function

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the vector to scale
b number amount to scale the vector by

Returns: vec4type

out

# set

▸ Const set(out: vec4type, x: number, y: number, z: number, w: number): vec4type

Set the components of a quat to the given values

function

# Parameters
Name Type Description
out vec4type the receiving quaternion
x number X component
y number Y component
z number Z component
w number W component

Returns: vec4type

out

# setAxes

▸ setAxes(out: quattype, view: vec3type, right: vec3type, up: vec3type): quattype

Sets the specified quaternion with values corresponding to the given axes. Each axis is a vec3 and is expected to be unit length and perpendicular to all other specified axes.

# Parameters
Name Type Description
out quattype -
view vec3type the vector representing the viewing direction
right vec3type the vector representing the local "right" direction
up vec3type the vector representing the local "up" direction

Returns: quattype

out

# setAxisAngle

▸ setAxisAngle(out: quattype, axis: vec3type, rad: number): quattype

Sets a quat from the given angle and rotation axis, then returns it.

# Parameters
Name Type Description
out quattype the receiving quaternion
axis vec3type the axis around which to rotate
rad number the angle in radians

Returns: quattype

out

# slerp

▸ slerp(out: quattype, a: quattype, b: quattype, t: number): quattype

Performs a spherical linear interpolation between two quat

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype the first operand
b quattype the second operand
t number interpolation amount between the two inputs

Returns: quattype

out

# sqlerp

▸ sqlerp(out: quattype, a: quattype, b: quattype, c: quattype, d: quattype, t: number): quattype

Performs a spherical linear interpolation with two control points

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype the first operand
b quattype the second operand
c quattype the third operand
d quattype the fourth operand
t number interpolation amount

Returns: quattype

out

# squaredLength

▸ Const squaredLength(a: vec4type): number

Calculates the squared length of a quat

function

# Parameters
Name Type Description
a vec4type vector to calculate squared length of

Returns: number

squared length of a

# str

▸ str(a: quattype): string

Returns a string representation of a quatenion

# Parameters
Name Type Description
a quattype vector to represent as a string

Returns: string

string representation of the vector

vjmap / Exports / default / spring

# Namespace: spring

default.spring

# Table of contents

# Functions

# Functions

# needsInterpolation

▸ needsInterpolation(a: any, b: any): boolean

# Parameters
Name Type
a any
b any

Returns: boolean

vjmap / Exports / default / vec2

# Namespace: vec2

default.vec2

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: vec2type

# Functions

# add

▸ add(out: vec2type, a: vec2type, b: vec2type): vec2type

Adds two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# angle

▸ angle(a: vec2type, b: vec2type): number

Get the angle between two 2D vectors

# Parameters
Name Type Description
a vec2type The first operand
b vec2type The second operand

Returns: number

The angle in radians

# ceil

▸ ceil(out: vec2type, a: vec2type): vec2type

Math.ceil the components of a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to ceil

Returns: vec2type

out

# clone

▸ clone(a: vec2type): vec2type

Creates a new vec2 initialized with values from an existing vector

# Parameters
Name Type Description
a vec2type vector to clone

Returns: vec2type

a new 2D vector

# copy

▸ copy(out: vec2type, a: vec2type): vec2type

Copy the values from one vec2 to another

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the source vector

Returns: vec2type

out

# create

▸ create(): vec2type

Creates a new, empty vec2

Returns: vec2type

a new 2D vector

# cross

▸ cross(out: vec2type, a: vec2type, b: vec2type): vec2type

Computes the cross product of two vec2's Note that the cross product must by definition produce a 3D vector

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# distance

▸ distance(a: vec2type, b: vec2type): number

Calculates the euclidian distance between two vec2's

# Parameters
Name Type Description
a vec2type the first operand
b vec2type the second operand

Returns: number

distance between a and b

# divide

▸ divide(out: vec2type, a: vec2type, b: vec2type): vec2type

Divides two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# dot

▸ dot(a: vec2type, b: vec2type): number

Calculates the dot product of two vec2's

# Parameters
Name Type Description
a vec2type the first operand
b vec2type the second operand

Returns: number

dot product of a and b

# equals

▸ equals(a: vec2type, b: vec2type): boolean

Returns whether or not the vectors have approximately the same elements in the same position.

# Parameters
Name Type Description
a vec2type The first vector.
b vec2type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# exactEquals

▸ exactEquals(a: vec2type, b: vec2type): boolean

Returns whether or not the vectors exactly have the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a vec2type The first vector.
b vec2type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# floor

▸ floor(out: vec2type, a: vec2type): vec2type

Math.floor the components of a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to floor

Returns: vec2type

out

# forEach

▸ Const forEach(a: any, stride: any, offset: any, count: any, fn: any, arg: any): any

Perform some operation over an array of vec2s.

function

# Parameters
Name Type Description
a any the array of vectors to iterate over
stride any Number of elements between the start of each vec2. If 0 assumes tightly packed
offset any Number of elements to skip at the beginning of the array
count any Number of vec2s to iterate over. If 0 iterates over entire array
fn any Function to call for each vector in the array
arg any -

Returns: any

a

# fromValues

▸ fromValues(x: number, y: number): vec2type

Creates a new vec2 initialized with the given values

# Parameters
Name Type Description
x number X component
y number Y component

Returns: vec2type

a new 2D vector

# inverse

▸ inverse(out: vec2type, a: vec2type): vec2type

Returns the inverse of the components of a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to invert

Returns: vec2type

out

# length

▸ length(a: vec2type): number

Calculates the length of a vec2

# Parameters
Name Type Description
a vec2type vector to calculate length of

Returns: number

length of a

# lerp

▸ lerp(out: vec2type, a: vec2type, b: vec2type, t: number): vec2type

Performs a linear interpolation between two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand
t number interpolation amount, in the range [0-1], between the two inputs

Returns: vec2type

out

# max

▸ max(out: vec2type, a: vec2type, b: vec2type): vec2type

Returns the maximum of two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# min

▸ min(out: vec2type, a: vec2type, b: vec2type): vec2type

Returns the minimum of two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# multiply

▸ multiply(out: vec2type, a: vec2type, b: vec2type): vec2type

Multiplies two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# negate

▸ negate(out: vec2type, a: vec2type): vec2type

Negates the components of a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to negate

Returns: vec2type

out

# normalize

▸ normalize(out: vec2type, a: vec2type): vec2type

Normalize a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to normalize

Returns: vec2type

out

# random

▸ random(out: vec2type, scale: number): vec2type

Generates a random vector with the given scale

# Parameters
Name Type Description
out vec2type the receiving vector
scale number -

Returns: vec2type

out

# rotate

▸ rotate(out: vec2type, a: vec2type, b: vec2type, rad: number): vec2type

Rotate a 2D vector

# Parameters
Name Type Description
out vec2type The receiving vec2
a vec2type The vec2 point to rotate
b vec2type The origin of the rotation
rad number The angle of rotation in radians

Returns: vec2type

out

# round

▸ round(out: vec2type, a: vec2type): vec2type

Math.round the components of a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to round

Returns: vec2type

out

# scale

▸ scale(out: vec2type, a: vec2type, b: number): vec2type

Scales a vec2 by a scalar number

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the vector to scale
b number amount to scale the vector by

Returns: vec2type

out

# scaleAndAdd

▸ scaleAndAdd(out: vec2type, a: vec2type, b: vec2type, scale: number): vec2type

Adds two vec2's after scaling the second operand by a scalar value

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand
scale number the amount to scale b by before adding

Returns: vec2type

out

# set

▸ set(out: vec2type, x: number, y: number): vec2type

Set the components of a vec2 to the given values

# Parameters
Name Type Description
out vec2type the receiving vector
x number X component
y number Y component

Returns: vec2type

out

# squaredDistance

▸ squaredDistance(a: vec2type, b: vec2type): number

Calculates the squared euclidian distance between two vec2's

# Parameters
Name Type Description
a vec2type the first operand
b vec2type the second operand

Returns: number

squared distance between a and b

# squaredLength

▸ squaredLength(a: vec2type): number

Calculates the squared length of a vec2

# Parameters
Name Type Description
a vec2type vector to calculate squared length of

Returns: number

squared length of a

# str

▸ str(a: vec2type): string

Returns a string representation of a vector

# Parameters
Name Type Description
a vec2type vector to represent as a string

Returns: string

string representation of the vector

# subtract

▸ subtract(out: vec2type, a: vec2type, b: vec2type): vec2type

Subtracts vector b from vector a

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# transformMat2

▸ transformMat2(out: vec2type, a: vec2type, m: vec2type): vec2type

Transforms the vec2 with a mat2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the vector to transform
m vec2type matrix to transform with

Returns: vec2type

out

# transformMat2d

▸ transformMat2d(out: vec2type, a: vec2type, m: vec2type): vec2type

Transforms the vec2 with a mat2d

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the vector to transform
m vec2type matrix to transform with

Returns: vec2type

out

# transformMat3

▸ transformMat3(out: vec2type, a: vec2type, m: vec2type): vec2type

Transforms the vec2 with a mat3 3rd vector component is implicitly '1'

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the vector to transform
m vec2type matrix to transform with

Returns: vec2type

out

# transformMat4

▸ transformMat4(out: vec2type, a: vec2type, m: vec2type): vec2type

Transforms the vec2 with a mat4 3rd vector component is implicitly '0' 4th vector component is implicitly '1'

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the vector to transform
m vec2type matrix to transform with

Returns: vec2type

out

# zero

▸ zero(out: vec2type): vec2type

Set the components of a vec2 to zero

# Parameters
Name Type Description
out vec2type the receiving vector

Returns: vec2type

out

vjmap / Exports / default / vec3

# Namespace: vec3

default.vec3

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: vec3type

# Functions

# add

▸ add(out: vec3type, a: vec3type, b: vec3type): vec3type

Adds two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# angle

▸ angle(a: vec3type, b: vec3type): number

Get the angle between two 3D vectors

# Parameters
Name Type Description
a vec3type The first operand
b vec3type The second operand

Returns: number

The angle in radians

# bezier

▸ bezier(out: vec3type, a: vec3type, b: vec3type, c: vec3type, d: vec3type, t: number): vec3type

Performs a bezier interpolation with two control points

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand
c vec3type the third operand
d vec3type the fourth operand
t number interpolation amount between the two inputs

Returns: vec3type

out

# ceil

▸ ceil(out: vec3type, a: vec3type): vec3type

Math.ceil the components of a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to ceil

Returns: vec3type

out

# clone

▸ clone(a: vec3type): vec3type

Creates a new vec3 initialized with values from an existing vector

# Parameters
Name Type Description
a vec3type vector to clone

Returns: vec3type

a new 3D vector

# copy

▸ copy(out: vec3type, a: vec3type): vec3type

Copy the values from one vec3 to another

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the source vector

Returns: vec3type

out

# create

▸ create(): vec3type

Creates a new, empty vec3

Returns: vec3type

a new 3D vector

# cross

▸ cross(out: vec3type, a: vec3type, b: vec3type): vec3type

Computes the cross product of two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# distance

▸ distance(a: vec3type, b: vec3type): number

Calculates the euclidian distance between two vec3's

# Parameters
Name Type Description
a vec3type the first operand
b vec3type the second operand

Returns: number

distance between a and b

# divide

▸ divide(out: vec3type, a: vec3type, b: vec3type): vec3type

Divides two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# dot

▸ dot(a: vec3type, b: vec3type): number

Calculates the dot product of two vec3's

# Parameters
Name Type Description
a vec3type the first operand
b vec3type the second operand

Returns: number

dot product of a and b

# equals

▸ equals(a: vec3type, b: vec3type): boolean

Returns whether or not the vectors have approximately the same elements in the same position.

# Parameters
Name Type Description
a vec3type The first vector.
b vec3type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# exactEquals

▸ exactEquals(a: vec3type, b: vec3type): boolean

Returns whether or not the vectors have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a vec3type The first vector.
b vec3type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# floor

▸ floor(out: vec3type, a: vec3type): vec3type

Math.floor the components of a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to floor

Returns: vec3type

out

# forEach

▸ forEach(a: vec3type, stride: number, offset: number, count: number, fn: (out: vec3type, vec: vec3type, arg: any) => void, arg?: any): any

Perform some operation over an array of vec3s.

function

# Parameters
Name Type Description
a vec3type the array of vectors to iterate over
stride number Number of elements between the start of each vec3. If 0 assumes tightly packed
offset number Number of elements to skip at the beginning of the array
count number Number of vec3s to iterate over. If 0 iterates over entire array
fn (out: vec3type, vec: vec3type, arg: any) => void Function to call for each vector in the array
arg? any -

Returns: any

a

# fromValues

▸ fromValues(x: number, y: number, z: number): vec3type

Creates a new vec3 initialized with the given values

# Parameters
Name Type Description
x number X component
y number Y component
z number Z component

Returns: vec3type

a new 3D vector

# hermite

▸ hermite(out: vec3type, a: vec3type, b: vec3type, c: vec3type, d: vec3type, t: number): vec3type

Performs a hermite interpolation with two control points

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand
c vec3type the third operand
d vec3type the fourth operand
t number interpolation amount between the two inputs

Returns: vec3type

out

# inverse

▸ inverse(out: vec3type, a: vec3type): vec3type

Returns the inverse of the components of a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to invert

Returns: vec3type

out

# length

▸ length(a: vec3type): number

Calculates the length of a vec3

# Parameters
Name Type Description
a vec3type vector to calculate length of

Returns: number

length of a

# lerp

▸ lerp(out: vec3type, a: vec3type, b: vec3type, t: number): vec3type

Performs a linear interpolation between two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand
t number interpolation amount between the two inputs

Returns: vec3type

out

# max

▸ max(out: vec3type, a: vec3type, b: vec3type): vec3type

Returns the maximum of two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# min

▸ min(out: vec3type, a: vec3type, b: vec3type): vec3type

Returns the minimum of two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# multiply

▸ multiply(out: vec3type, a: vec3type, b: vec3type): vec3type

Multiplies two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# negate

▸ negate(out: vec3type, a: vec3type): vec3type

Negates the components of a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to negate

Returns: vec3type

out

# normalize

▸ normalize(out: vec3type, a: vec3type): vec3type

Normalize a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to normalize

Returns: vec3type

out

# random

▸ random(out: vec3type, s?: number): vec3type

Generates a random vector with the given scale

# Parameters
Name Type Default value Description
out vec3type - the receiving vector
s number 1.0 -

Returns: vec3type

out

# rotateX

▸ rotateX(out: vec3type, a: vec3type, b: vec3type, c: number): vec3type

Rotate a 3D vector around the x-axis

# Parameters
Name Type Description
out vec3type The receiving vec3
a vec3type The vec3 point to rotate
b vec3type The origin of the rotation
c number The angle of rotation

Returns: vec3type

out

# rotateY

▸ rotateY(out: vec3type, a: vec3type, b: vec3type, c: number): vec3type

Rotate a 3D vector around the y-axis

# Parameters
Name Type Description
out vec3type The receiving vec3
a vec3type The vec3 point to rotate
b vec3type The origin of the rotation
c number The angle of rotation

Returns: vec3type

out

# rotateZ

▸ rotateZ(out: vec3type, a: vec3type, b: vec3type, c: number): vec3type

Rotate a 3D vector around the z-axis

# Parameters
Name Type Description
out vec3type The receiving vec3
a vec3type The vec3 point to rotate
b vec3type The origin of the rotation
c number The angle of rotation

Returns: vec3type

out

# round

▸ round(out: vec3type, a: vec3type): vec3type

Math.round the components of a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to round

Returns: vec3type

out

# scale

▸ scale(out: vec3type, a: vec3type, b: number): vec3type

Scales a vec3 by a scalar number

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the vector to scale
b number amount to scale the vector by

Returns: vec3type

out

# scaleAndAdd

▸ scaleAndAdd(out: vec3type, a: vec3type, b: vec3type, s: number): vec3type

Adds two vec3's after scaling the second operand by a scalar value

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand
s number the amount to scale b by before adding

Returns: vec3type

out

# set

▸ set(out: vec3type, x: number, y: number, z: number): vec3type

Set the components of a vec3 to the given values

# Parameters
Name Type Description
out vec3type the receiving vector
x number X component
y number Y component
z number Z component

Returns: vec3type

out

# squaredDistance

▸ squaredDistance(a: vec3type, b: vec3type): number

Calculates the squared euclidian distance between two vec3's

# Parameters
Name Type Description
a vec3type the first operand
b vec3type the second operand

Returns: number

squared distance between a and b

# squaredLength

▸ squaredLength(a: vec3type): number

Calculates the squared length of a vec3

# Parameters
Name Type Description
a vec3type vector to calculate squared length of

Returns: number

squared length of a

# str

▸ str(a: vec3type): string

Returns a string representation of a vector

# Parameters
Name Type Description
a vec3type vector to represent as a string

Returns: string

string representation of the vector

# subtract

▸ subtract(out: vec3type, a: vec3type, b: vec3type): vec3type

Subtracts vector b from vector a

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# transformMat3

▸ transformMat3(out: vec3type, a: vec3type, m: mat4type): vec3type

Transforms the vec3 with a mat3.

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the vector to transform
m mat4type the 3x3 matrix to transform with

Returns: vec3type

out

# transformMat4

▸ transformMat4(out: vec3type, a: vec3type, m: mat4type): vec3type

Transforms the vec3 with a mat4. 4th vector component is implicitly '1'

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the vector to transform
m mat4type matrix to transform with

Returns: vec3type

out

# transformQuat

▸ transformQuat(out: vec3type, a: vec3type, q: quattype): vec3type

Transforms the vec3 with a quat

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the vector to transform
q quattype quaternion to transform with

Returns: vec3type

out

vjmap / Exports / default / vec4

# Namespace: vec4

default.vec4

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: vec4type

# Functions

# add

▸ add(out: vec4type, a: vec4type, b: vec4type): vec4type

Adds two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# ceil

▸ ceil(out: vec4type, a: vec4type): vec4type

Math.ceil the components of a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to ceil

Returns: vec4type

out

# clone

▸ clone(a: vec4type): vec4type

Creates a new vec4 initialized with values from an existing vector

# Parameters
Name Type Description
a vec4type vector to clone

Returns: vec4type

a new 4D vector

# copy

▸ copy(out: vec4type, a: vec4type): vec4type

Copy the values from one vec4 to another

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the source vector

Returns: vec4type

out

# create

▸ create(): vec4type

Creates a new, empty vec4

Returns: vec4type

a new 4D vector

# distance

▸ distance(a: vec4type, b: vec4type): number

Calculates the euclidian distance between two vec4's

# Parameters
Name Type Description
a vec4type the first operand
b vec4type the second operand

Returns: number

distance between a and b

# divide

▸ divide(out: vec4type, a: vec4type, b: vec4type): vec4type

Divides two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# dot

▸ dot(a: vec4type, b: vec4type): number

Calculates the dot product of two vec4's

# Parameters
Name Type Description
a vec4type the first operand
b vec4type the second operand

Returns: number

dot product of a and b

# equals

▸ equals(a: vec4type, b: vec4type): boolean

Returns whether or not the vectors have approximately the same elements in the same position.

# Parameters
Name Type Description
a vec4type The first vector.
b vec4type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# exactEquals

▸ exactEquals(a: vec4type, b: vec4type): boolean

Returns whether or not the vectors have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a vec4type The first vector.
b vec4type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# floor

▸ floor(out: vec4type, a: vec4type): vec4type

Math.floor the components of a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to floor

Returns: vec4type

out

# forEach

▸ forEach(a: vec4type, stride: number, offset: number, count: number, fn: (out: vec4type, vec: vec4type, arg: any) => void, arg?: any): any

Perform some operation over an array of vec4s.

function

# Parameters
Name Type Description
a vec4type the array of vectors to iterate over
stride number Number of elements between the start of each vec4. If 0 assumes tightly packed
offset number Number of elements to skip at the beginning of the array
count number Number of vec4s to iterate over. If 0 iterates over entire array
fn (out: vec4type, vec: vec4type, arg: any) => void Function to call for each vector in the array
arg? any -

Returns: any

a

# fromValues

▸ fromValues(x: number, y: number, z: number, w: number): vec4type

Creates a new vec4 initialized with the given values

# Parameters
Name Type Description
x number X component
y number Y component
z number Z component
w number W component

Returns: vec4type

a new 4D vector

# inverse

▸ inverse(out: vec4type, a: vec4type): vec4type

Returns the inverse of the components of a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to invert

Returns: vec4type

out

# length

▸ length(a: vec4type): number

Calculates the length of a vec4

# Parameters
Name Type Description
a vec4type vector to calculate length of

Returns: number

length of a

# lerp

▸ lerp(out: vec4type, a: vec4type, b: vec4type, t: number): vec4type

Performs a linear interpolation between two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand
t number interpolation amount between the two inputs

Returns: vec4type

out

# max

▸ max(out: vec4type, a: vec4type, b: vec4type): vec4type

Returns the maximum of two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# min

▸ min(out: vec4type, a: vec4type, b: vec4type): vec4type

Returns the minimum of two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# multiply

▸ multiply(out: vec4type, a: vec4type, b: vec4type): vec4type

Multiplies two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# negate

▸ negate(out: vec4type, a: vec4type): vec4type

Negates the components of a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to negate

Returns: vec4type

out

# normalize

▸ normalize(out: vec4type, a: vec4type): vec4type

Normalize a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to normalize

Returns: vec4type

out

# random

▸ random(out: vec4type, s?: number): vec4type

Generates a random vector with the given scale

# Parameters
Name Type Default value Description
out vec4type - the receiving vector
s number 1.0 -

Returns: vec4type

out

# round

▸ round(out: vec4type, a: vec4type): vec4type

Math.round the components of a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to round

Returns: vec4type

out

# scale

▸ scale(out: vec4type, a: vec4type, b: number): vec4type

Scales a vec4 by a scalar number

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the vector to scale
b number amount to scale the vector by

Returns: vec4type

out

# scaleAndAdd

▸ scaleAndAdd(out: vec4type, a: vec4type, b: vec4type, s: number): vec4type

Adds two vec4's after scaling the second operand by a scalar value

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand
s number the amount to scale b by before adding

Returns: vec4type

out

# set

▸ set(out: vec4type, x: number, y: number, z: number, w: number): vec4type

Set the components of a vec4 to the given values

# Parameters
Name Type Description
out vec4type the receiving vector
x number X component
y number Y component
z number Z component
w number W component

Returns: vec4type

out

# squaredDistance

▸ squaredDistance(a: vec4type, b: vec4type): number

Calculates the squared euclidian distance between two vec4's

# Parameters
Name Type Description
a vec4type the first operand
b vec4type the second operand

Returns: number

squared distance between a and b

# squaredLength

▸ squaredLength(a: vec4type): number

Calculates the squared length of a vec4

# Parameters
Name Type Description
a vec4type vector to calculate squared length of

Returns: number

squared length of a

# str

▸ str(a: vec4type): string

Returns a string representation of a vector

# Parameters
Name Type Description
a vec4type vector to represent as a string

Returns: string

string representation of the vector

# subtract

▸ subtract(out: vec4type, a: vec4type, b: vec4type): vec4type

Subtracts vector b from vector a

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# transformMat4

▸ transformMat4(out: vec4type, a: vec4type, m: mat4type): vec4type

Transforms the vec4 with a mat4.

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the vector to transform
m mat4type matrix to transform with

Returns: vec4type

out

# transformQuat

▸ transformQuat(out: vec4type, a: vec4type, q: quattype): vec4type

Transforms the vec4 with a quat

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the vector to transform
q quattype quaternion to transform with

Returns: vec4type

out

vjmap / Exports / Dom

# Namespace: Dom

# Table of contents

# Type aliases

# Variables

# Functions

# Type aliases

# Anchor

Ƭ Anchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right"

# Variables

# anchorTranslate

• Const anchorTranslate: Record<Anchor, string>

# Functions

# addClass

▸ addClass(el: HTMLElement, name: string): void

# Parameters
Name Type
el HTMLElement
name string

Returns: void

# addEventListener

▸ addEventListener(target: any, type: any, callback: any, options?: { capture?: boolean ; passive?: boolean }): void

# Parameters
Name Type Default value
target any -
type any -
callback any -
options object {}
options.capture? boolean -
options.passive? boolean -

Returns: void

# create

▸ create(tagName: string, className?: string, container?: HTMLElement): HTMLElement

# Parameters
Name Type
tagName string
className? string
container? HTMLElement

Returns: HTMLElement

# createNS

▸ createNS(namespaceURI: string, tagName: string): Element

# Parameters
Name Type
namespaceURI string
tagName string

Returns: Element

# disableDrag

▸ disableDrag(): void

Returns: void

# enableDrag

▸ enableDrag(): void

Returns: void

# getClass

▸ getClass(el: HTMLElement): any

# Parameters
Name Type
el HTMLElement

Returns: any

# hasClass

▸ hasClass(el: HTMLElement, name: string): boolean

# Parameters
Name Type
el HTMLElement
name string

Returns: boolean

# mouseButton

▸ mouseButton(e: MouseEvent): number

# Parameters
Name Type
e MouseEvent

Returns: number

# mousePos

▸ mousePos(el: HTMLElement, e: MouseEvent | WheelEvent): GeoPoint

# Parameters
Name Type
el HTMLElement
e MouseEvent | WheelEvent

Returns: GeoPoint

# remove

▸ remove(node: HTMLElement): void

# Parameters
Name Type
node HTMLElement

Returns: void

# removeClass

▸ removeClass(el: HTMLElement, name: string): void

# Parameters
Name Type
el HTMLElement
name string

Returns: void

# removeEventListener

▸ removeEventListener(target: any, type: any, callback: any, options?: { capture?: boolean ; passive?: boolean }): void

# Parameters
Name Type Default value
target any -
type any -
callback any -
options object {}
options.capture? boolean -
options.passive? boolean -

Returns: void

# setClass

▸ setClass(el: HTMLElement, name: string): void

# Parameters
Name Type
el HTMLElement
name string

Returns: void

# setTransform

▸ setTransform(el: HTMLElement, value: string): void

# Parameters
Name Type
el HTMLElement
value string

Returns: void

# suppressClick

▸ suppressClick(): void

Returns: void

# touchPos

▸ touchPos(el: HTMLElement, touches: TouchList): GeoPoint[]

# Parameters
Name Type
el HTMLElement
touches TouchList

Returns: GeoPoint[]

vjmap / Exports / mat2

# Namespace: mat2

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: mat2type

# Functions

# LDU

▸ LDU(L: mat2type, D: mat2type, U: mat2type, a: mat2type): mat2type[]

Returns L, D and U matrices (Lower triangular, Diagonal and Upper triangular) by factorizing the input matrix

# Parameters
Name Type Description
L mat2type the lower triangular matrix
D mat2type the diagonal matrix
U mat2type the upper triangular matrix
a mat2type the input matrix to factorize

Returns: mat2type[]

# add

▸ add(out: mat2type, a: mat2type, b: mat2type): mat2type

Adds two mat2's

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the first operand
b mat2type the second operand

Returns: mat2type

out

# adjoint

▸ adjoint(out: mat2type, a: mat2type): mat2type

Calculates the adjugate of a mat2

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the source matrix

Returns: mat2type

out

# clone

▸ clone(a: mat2type): Float32Array

Creates a new mat2 initialized with values from an existing matrix

# Parameters
Name Type Description
a mat2type matrix to clone

Returns: Float32Array

a new 2x2 matrix

# copy

▸ copy(out: mat2type, a: mat2type): mat2type

Copy the values from one mat2 to another

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the source matrix

Returns: mat2type

out

# create

▸ create(): Float32Array

Creates a new identity mat2

Returns: Float32Array

a new 2x2 matrix

# determinant

▸ determinant(a: mat2type): number

Calculates the determinant of a mat2

# Parameters
Name Type Description
a mat2type the source matrix

Returns: number

determinant of a

# equals

▸ equals(a: mat2type, b: mat2type): boolean

Returns whether or not the matrices have approximately the same elements in the same position.

# Parameters
Name Type Description
a mat2type The first matrix.
b mat2type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# exactEquals

▸ exactEquals(a: mat2type, b: mat2type): boolean

Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a mat2type The first matrix.
b mat2type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# frob

▸ frob(a: mat2type): number

Returns Frobenius norm of a mat2

# Parameters
Name Type Description
a mat2type the matrix to calculate Frobenius norm of

Returns: number

Frobenius norm

# fromRotation

▸ fromRotation(out: mat2type, rad: number): mat2type

Creates a matrix from a given angle This is equivalent to (but much faster than):

mat2.identity(dest);
mat2.rotate(dest, dest, rad);
# Parameters
Name Type Description
out mat2type mat2 receiving operation result
rad number the angle to rotate the matrix by

Returns: mat2type

out

# fromScaling

▸ fromScaling(out: mat2type, v: mat2type): mat2type

Creates a matrix from a vector scaling This is equivalent to (but much faster than):

mat2.identity(dest);
mat2.scale(dest, dest, vec);
# Parameters
Name Type Description
out mat2type mat2 receiving operation result
v mat2type Scaling vector

Returns: mat2type

out

# fromValues

▸ fromValues(m00: number, m01: number, m10: number, m11: number): mat2type

Create a new mat2 with the given values

# Parameters
Name Type Description
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m10 number Component in column 1, row 0 position (index 2)
m11 number Component in column 1, row 1 position (index 3)

Returns: mat2type

out A new 2x2 matrix

# identity

▸ identity(out: mat2type): mat2type

Set a mat2 to the identity matrix

# Parameters
Name Type Description
out mat2type the receiving matrix

Returns: mat2type

out

# invert

▸ invert(out: mat2type, a: mat2type): mat2type | null

Inverts a mat2

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the source matrix

Returns: mat2type | null

out

# multiply

▸ multiply(out: mat2type, a: mat2type, b: mat2type): mat2type

Multiplies two mat2's

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the first operand
b mat2type the second operand

Returns: mat2type

out

# multiplyScalar

▸ multiplyScalar(out: mat2type, a: mat2type, b: number): mat2type

Multiply each element of the matrix by a scalar.

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the matrix to scale
b number amount to scale the matrix's elements by

Returns: mat2type

out

# multiplyScalarAndAdd

▸ multiplyScalarAndAdd(out: mat2type, a: mat2type, b: mat2type, scale: number): mat2type

Adds two mat2's after multiplying each element of the second operand by a scalar value.

# Parameters
Name Type Description
out mat2type the receiving vector
a mat2type the first operand
b mat2type the second operand
scale number the amount to scale b's elements by before adding

Returns: mat2type

out

# rotate

▸ rotate(out: mat2type, a: mat2type, rad: number): mat2type

Rotates a mat2 by the given angle

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat2type

out

# scale

▸ scale(out: mat2type, a: mat2type, v: mat2type): mat2type

Scales the mat2 by the dimensions in the given vec2

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the matrix to rotate
v mat2type the vec2 to scale the matrix by

Returns: mat2type

out

# set

▸ set(out: mat2type, m00: number, m01: number, m10: number, m11: number): mat2type

Set the components of a mat2 to the given values

# Parameters
Name Type Description
out mat2type the receiving matrix
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m10 number Component in column 1, row 0 position (index 2)
m11 number Component in column 1, row 1 position (index 3)

Returns: mat2type

out

# str

▸ str(a: mat2type): string

Returns a string representation of a mat2

# Parameters
Name Type Description
a mat2type matrix to represent as a string

Returns: string

string representation of the matrix

# subtract

▸ subtract(out: mat2type, a: mat2type, b: mat2type): mat2type

Subtracts matrix b from matrix a

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the first operand
b mat2type the second operand

Returns: mat2type

out

# transpose

▸ transpose(out: mat2type, a: mat2type): mat2type

Transpose the values of a mat2

# Parameters
Name Type Description
out mat2type the receiving matrix
a mat2type the source matrix

Returns: mat2type

out

vjmap / Exports / mat2d

# Namespace: mat2d

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: mat2dtype

# Functions

# add

▸ add(out: mat2dtype, a: mat2dtype, b: mat2dtype): mat2dtype

Adds two mat2d's

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the first operand
b mat2dtype the second operand

Returns: mat2dtype

out

# clone

▸ clone(a: mat2dtype): mat2dtype

Creates a new mat2d initialized with values from an existing matrix

# Parameters
Name Type Description
a mat2dtype matrix to clone

Returns: mat2dtype

a new 2x3 matrix

# copy

▸ copy(out: mat2dtype, a: mat2dtype): mat2dtype

Copy the values from one mat2d to another

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the source matrix

Returns: mat2dtype

out

# create

▸ create(): mat2dtype

Creates a new identity mat2d

Returns: mat2dtype

a new 2x3 matrix

# determinant

▸ determinant(a: mat2dtype): number

Calculates the determinant of a mat2d

# Parameters
Name Type Description
a mat2dtype the source matrix

Returns: number

determinant of a

# equals

▸ equals(a: mat2dtype, b: mat2dtype): boolean

Returns whether or not the matrices have approximately the same elements in the same position.

# Parameters
Name Type Description
a mat2dtype The first matrix.
b mat2dtype The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# exactEquals

▸ exactEquals(a: mat2dtype, b: mat2dtype): boolean

Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a mat2dtype The first matrix.
b mat2dtype The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# frob

▸ frob(a: mat2dtype): number

Returns Frobenius norm of a mat2d

# Parameters
Name Type Description
a mat2dtype the matrix to calculate Frobenius norm of

Returns: number

Frobenius norm

# fromRotation

▸ fromRotation(out: mat2dtype, rad: number): mat2dtype

Creates a matrix from a given angle This is equivalent to (but much faster than):

mat2d.identity(dest);
mat2d.rotate(dest, dest, rad);
# Parameters
Name Type Description
out mat2dtype mat2d receiving operation result
rad number the angle to rotate the matrix by

Returns: mat2dtype

out

# fromScaling

▸ fromScaling(out: mat2dtype, v: mat2dtype): mat2dtype

Creates a matrix from a vector scaling This is equivalent to (but much faster than):

mat2d.identity(dest);
mat2d.scale(dest, dest, vec);
# Parameters
Name Type Description
out mat2dtype mat2d receiving operation result
v mat2dtype Scaling vector

Returns: mat2dtype

out

# fromTranslation

▸ fromTranslation(out: mat2dtype, v: mat2dtype): mat2dtype

Creates a matrix from a vector translation This is equivalent to (but much faster than):

mat2d.identity(dest);
mat2d.translate(dest, dest, vec);
# Parameters
Name Type Description
out mat2dtype mat2d receiving operation result
v mat2dtype Translation vector

Returns: mat2dtype

out

# fromValues

▸ fromValues(a: number, b: number, c: number, d: number, tx: number, ty: number): mat2dtype

Create a new mat2d with the given values

# Parameters
Name Type Description
a number Component A (index 0)
b number Component B (index 1)
c number Component C (index 2)
d number Component D (index 3)
tx number Component TX (index 4)
ty number Component TY (index 5)

Returns: mat2dtype

A new mat2d

# identity

▸ identity(out: mat2dtype): mat2dtype

Set a mat2d to the identity matrix

# Parameters
Name Type Description
out mat2dtype the receiving matrix

Returns: mat2dtype

out

# invert

▸ invert(out: mat2dtype, a: mat2dtype): mat2dtype | null

Inverts a mat2d

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the source matrix

Returns: mat2dtype | null

out

# multiply

▸ multiply(out: mat2dtype, a: mat2dtype, b: mat2dtype): mat2dtype

Multiplies two mat2d's

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the first operand
b mat2dtype the second operand

Returns: mat2dtype

out

# multiplyScalar

▸ multiplyScalar(out: mat2dtype, a: mat2dtype, b: number): mat2dtype

Multiply each element of the matrix by a scalar.

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the matrix to scale
b number amount to scale the matrix's elements by

Returns: mat2dtype

out

# multiplyScalarAndAdd

▸ multiplyScalarAndAdd(out: mat2dtype, a: mat2dtype, b: mat2dtype, scale: number): mat2dtype

Adds two mat2d's after multiplying each element of the second operand by a scalar value.

# Parameters
Name Type Description
out mat2dtype the receiving vector
a mat2dtype the first operand
b mat2dtype the second operand
scale number the amount to scale b's elements by before adding

Returns: mat2dtype

out

# rotate

▸ rotate(out: mat2dtype, a: mat2dtype, rad: number): mat2dtype

Rotates a mat2d by the given angle

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat2dtype

out

# scale

▸ scale(out: mat2dtype, a: mat2dtype, v: mat2dtype): mat2dtype

Scales the mat2d by the dimensions in the given vec2

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the matrix to translate
v mat2dtype the vec2 to scale the matrix by

Returns: mat2dtype

out

# set

▸ set(out: mat2dtype, a: number, b: number, c: number, d: number, tx: number, ty: number): mat2dtype

Set the components of a mat2d to the given values

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a number Component A (index 0)
b number Component B (index 1)
c number Component C (index 2)
d number Component D (index 3)
tx number Component TX (index 4)
ty number Component TY (index 5)

Returns: mat2dtype

out

# str

▸ str(a: mat2dtype): string

Returns a string representation of a mat2d

# Parameters
Name Type Description
a mat2dtype matrix to represent as a string

Returns: string

string representation of the matrix

# subtract

▸ subtract(out: mat2dtype, a: mat2dtype, b: mat2dtype): mat2dtype

Subtracts matrix b from matrix a

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the first operand
b mat2dtype the second operand

Returns: mat2dtype

out

# translate

▸ translate(out: mat2dtype, a: mat2dtype, v: mat2dtype): mat2dtype

Translates the mat2d by the dimensions in the given vec2

# Parameters
Name Type Description
out mat2dtype the receiving matrix
a mat2dtype the matrix to translate
v mat2dtype the vec2 to translate the matrix by

Returns: mat2dtype

out

vjmap / Exports / mat3

# Namespace: mat3

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: mat3type

# Functions

# add

▸ add(out: mat3type, a: mat3type, b: mat3type): mat3type

Adds two mat3's

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the first operand
b mat3type the second operand

Returns: mat3type

out

# adjoint

▸ adjoint(out: mat3type, a: mat3type): mat3type

Calculates the adjugate of a mat3

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the source matrix

Returns: mat3type

out

# clone

▸ clone(a: mat3type): mat3type

Creates a new mat3 initialized with values from an existing matrix

# Parameters
Name Type Description
a mat3type matrix to clone

Returns: mat3type

a new 3x3 matrix

# copy

▸ copy(out: mat3type, a: mat3type): mat3type

Copy the values from one mat3 to another

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the source matrix

Returns: mat3type

out

# create

▸ create(): mat3type

Creates a new identity mat3

Returns: mat3type

a new 3x3 matrix

# determinant

▸ determinant(a: mat3type): number

Calculates the determinant of a mat3

# Parameters
Name Type Description
a mat3type the source matrix

Returns: number

determinant of a

# equals

▸ equals(a: mat3type, b: mat3type): boolean

Returns whether or not the matrices have approximately the same elements in the same position.

# Parameters
Name Type Description
a mat3type The first matrix.
b mat3type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# exactEquals

▸ exactEquals(a: mat3type, b: mat3type): boolean

Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a mat3type The first matrix.
b mat3type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# frob

▸ frob(a: mat3type): number

Returns Frobenius norm of a mat3

# Parameters
Name Type Description
a mat3type the matrix to calculate Frobenius norm of

Returns: number

Frobenius norm

# fromMat2d

▸ fromMat2d(out: mat3type, a: mat2dtype): mat3type

Copies the values from a mat2d into a mat3

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat2dtype the matrix to copy

Returns: mat3type

out

# fromMat4

▸ fromMat4(out: mat3type, a: mat3type): mat3type

Copies the upper-left 3x3 values into the given mat3.

# Parameters
Name Type Description
out mat3type the receiving 3x3 matrix
a mat3type the source 4x4 matrix

Returns: mat3type

out

# fromQuat

▸ fromQuat(out: mat3type, q: quattype): mat3type

Calculates a 3x3 matrix from the given quaternion

# Parameters
Name Type Description
out mat3type mat3 receiving operation result
q quattype Quaternion to create matrix from

Returns: mat3type

out

# fromRotation

▸ fromRotation(out: mat3type, rad: number): mat3type

Creates a matrix from a given angle This is equivalent to (but much faster than):

mat3.identity(dest);
mat3.rotate(dest, dest, rad);
# Parameters
Name Type Description
out mat3type mat3 receiving operation result
rad number the angle to rotate the matrix by

Returns: mat3type

out

# fromScaling

▸ fromScaling(out: mat3type, v: vec2type): mat3type

Creates a matrix from a vector scaling This is equivalent to (but much faster than):

mat3.identity(dest);
mat3.scale(dest, dest, vec);
# Parameters
Name Type Description
out mat3type mat3 receiving operation result
v vec2type Scaling vector

Returns: mat3type

out

# fromTranslation

▸ fromTranslation(out: mat3type, v: vec2type): mat3type

Creates a matrix from a vector translation This is equivalent to (but much faster than):

mat3.identity(dest);
mat3.translate(dest, dest, vec);
# Parameters
Name Type Description
out mat3type mat3 receiving operation result
v vec2type Translation vector

Returns: mat3type

out

# fromValues

▸ fromValues(m00: number, m01: number, m02: number, m10: number, m11: number, m12: number, m20: number, m21: number, m22: number): mat3type

Create a new mat3 with the given values

# Parameters
Name Type Description
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m02 number Component in column 0, row 2 position (index 2)
m10 number Component in column 1, row 0 position (index 3)
m11 number Component in column 1, row 1 position (index 4)
m12 number Component in column 1, row 2 position (index 5)
m20 number Component in column 2, row 0 position (index 6)
m21 number Component in column 2, row 1 position (index 7)
m22 number Component in column 2, row 2 position (index 8)

Returns: mat3type

A new mat3

# identity

▸ identity(out: mat3type): mat3type

Set a mat3 to the identity matrix

# Parameters
Name Type Description
out mat3type the receiving matrix

Returns: mat3type

out

# invert

▸ invert(out: mat3type, a: mat3type): mat3type | null

Inverts a mat3

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the source matrix

Returns: mat3type | null

out

# multiply

▸ multiply(out: mat3type, a: mat3type, b: mat3type): mat3type

Multiplies two mat3's

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the first operand
b mat3type the second operand

Returns: mat3type

out

# multiplyScalar

▸ multiplyScalar(out: mat3type, a: mat3type, b: number): mat3type

Multiply each element of the matrix by a scalar.

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the matrix to scale
b number amount to scale the matrix's elements by

Returns: mat3type

out

# multiplyScalarAndAdd

▸ multiplyScalarAndAdd(out: mat3type, a: mat3type, b: mat3type, s: number): mat3type

Adds two mat3's after multiplying each element of the second operand by a scalar value.

# Parameters
Name Type Description
out mat3type the receiving vector
a mat3type the first operand
b mat3type the second operand
s number the amount to scale b's elements by before adding

Returns: mat3type

out

# normalFromMat4

▸ normalFromMat4(out: mat3type, a: mat4type): mat3type | null

Calculates a 3x3 normal matrix (transpose inverse) from the 4x4 matrix

# Parameters
Name Type Description
out mat3type mat3 receiving operation result
a mat4type Mat4 to derive the normal matrix from

Returns: mat3type | null

out

# rotate

▸ rotate(out: mat3type, a: mat3type, rad: number): mat3type

Rotates a mat3 by the given angle

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat3type

out

# scale

▸ scale(out: mat3type, a: mat3type, v: vec2type): mat3type

Scales the mat3 by the dimensions in the given vec2

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the matrix to rotate
v vec2type the vec2 to scale the matrix by

Returns: mat3type

out

# set

▸ set(out: mat3type, m00: number, m01: number, m02: number, m10: number, m11: number, m12: number, m20: number, m21: number, m22: number): mat3type

Set the components of a mat3 to the given values

# Parameters
Name Type Description
out mat3type the receiving matrix
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m02 number Component in column 0, row 2 position (index 2)
m10 number Component in column 1, row 0 position (index 3)
m11 number Component in column 1, row 1 position (index 4)
m12 number Component in column 1, row 2 position (index 5)
m20 number Component in column 2, row 0 position (index 6)
m21 number Component in column 2, row 1 position (index 7)
m22 number Component in column 2, row 2 position (index 8)

Returns: mat3type

out

# str

▸ str(a: mat3type): string

Returns a string representation of a mat3

# Parameters
Name Type Description
a mat3type matrix to represent as a string

Returns: string

string representation of the matrix

# subtract

▸ subtract(out: mat3type, a: mat3type, b: mat3type): mat3type

Subtracts matrix b from matrix a

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the first operand
b mat3type the second operand

Returns: mat3type

out

# translate

▸ translate(out: mat3type, a: mat3type, v: vec2type): mat3type

Translate a mat3 by the given vector

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the matrix to translate
v vec2type vector to translate by

Returns: mat3type

out

# transpose

▸ transpose(out: mat3type, a: mat3type): mat3type

Transpose the values of a mat3

# Parameters
Name Type Description
out mat3type the receiving matrix
a mat3type the source matrix

Returns: mat3type

out

vjmap / Exports / mat4

# Namespace: mat4

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: mat4type

# Functions

# add

▸ add(out: mat4type, a: mat4type, b: mat4type): mat4type

Adds two mat4's

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the first operand
b mat4type the second operand

Returns: mat4type

out

# adjoint

▸ adjoint(out: mat4type, a: mat4type): mat4type

Calculates the adjugate of a mat4

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the source matrix

Returns: mat4type

out

# clone

▸ clone(a: mat4type): mat4type

Creates a new mat4 initialized with values from an existing matrix

# Parameters
Name Type Description
a mat4type matrix to clone

Returns: mat4type

a new 4x4 matrix

# copy

▸ copy(out: mat4type, a: mat4type): mat4type

Copy the values from one mat4 to another

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the source matrix

Returns: mat4type

out

# create

▸ create(): mat4type

Creates a new identity mat4

Returns: mat4type

a new 4x4 matrix

# determinant

▸ determinant(a: mat4type): number

Calculates the determinant of a mat4

# Parameters
Name Type Description
a mat4type the source matrix

Returns: number

determinant of a

# equals

▸ equals(a: mat4type, b: mat4type): boolean

Returns whether or not the matrices have approximately the same elements in the same position.

# Parameters
Name Type Description
a mat4type The first matrix.
b mat4type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# exactEquals

▸ exactEquals(a: mat4type, b: mat4type): boolean

Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a mat4type The first matrix.
b mat4type The second matrix.

Returns: boolean

True if the matrices are equal, false otherwise.

# frob

▸ frob(a: mat4type): number

Returns Frobenius norm of a mat4

# Parameters
Name Type Description
a mat4type the matrix to calculate Frobenius norm of

Returns: number

Frobenius norm

# fromQuat

▸ fromQuat(out: mat4type, q: quattype): mat4type

Calculates a 4x4 matrix from the given quaternion

# Parameters
Name Type Description
out mat4type mat4 receiving operation result
q quattype Quaternion to create matrix from

Returns: mat4type

out

# fromRotation

▸ fromRotation(out: mat4type, rad: number, axis: vec3type): mat4type | null

Creates a matrix from a given angle around a given axis This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.rotate(dest, dest, rad, axis);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
rad number the angle to rotate the matrix by
axis vec3type the axis to rotate around

Returns: mat4type | null

out

# fromRotationTranslation

▸ fromRotationTranslation(out: mat4type, q: quattype, v: vec3type): mat4type

Creates a matrix from a quaternion rotation and vector translation This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.translate(dest, vec);
var quatMat = mat4.create();
quat.toMat4(quat, quatMat);
mat4.multiply(dest, quatMat);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
q quattype Rotation quaternion
v vec3type Translation vector

Returns: mat4type

out

# fromRotationTranslationScale

▸ fromRotationTranslationScale(out: mat4type, q: quattype, v: vec3type, s: vec3type): mat4type

Creates a matrix from a quaternion rotation, vector translation and vector scale This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.translate(dest, vec);
var quatMat = mat4.create();
quat4.toMat4(quat, quatMat);
mat4.multiply(dest, quatMat);
mat4.scale(dest, scale)
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
q quattype Rotation quaternion
v vec3type Translation vector
s vec3type Scaling vector

Returns: mat4type

out

# fromRotationTranslationScaleOrigin

▸ fromRotationTranslationScaleOrigin(out: mat4type, q: quattype, v: vec3type, s: vec3type, o: vec3type): mat4type

Creates a matrix from a quaternion rotation, vector translation and vector scale, rotating and scaling around the given origin This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.translate(dest, vec);
mat4.translate(dest, origin);
var quatMat = mat4.create();
quat4.toMat4(quat, quatMat);
mat4.multiply(dest, quatMat);
mat4.scale(dest, scale)
mat4.translate(dest, negativeOrigin);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
q quattype Rotation quaternion
v vec3type Translation vector
s vec3type Scaling vector
o vec3type The origin vector around which to scale and rotate

Returns: mat4type

out

# fromScaling

▸ fromScaling(out: mat4type, v: vec3type): mat4type

Creates a matrix from a vector scaling This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.scale(dest, dest, vec);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
v vec3type Scaling vector

Returns: mat4type

out

# fromTranslation

▸ fromTranslation(out: mat4type, v: vec3type): mat4type

Creates a matrix from a vector translation This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.translate(dest, dest, vec);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
v vec3type Translation vector

Returns: mat4type

out

# fromValues

▸ fromValues(m00: number, m01: number, m02: number, m03: number, m10: number, m11: number, m12: number, m13: number, m20: number, m21: number, m22: number, m23: number, m30: number, m31: number, m32: number, m33: number): mat4type

Create a new mat4 with the given values

# Parameters
Name Type Description
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m02 number Component in column 0, row 2 position (index 2)
m03 number Component in column 0, row 3 position (index 3)
m10 number Component in column 1, row 0 position (index 4)
m11 number Component in column 1, row 1 position (index 5)
m12 number Component in column 1, row 2 position (index 6)
m13 number Component in column 1, row 3 position (index 7)
m20 number Component in column 2, row 0 position (index 8)
m21 number Component in column 2, row 1 position (index 9)
m22 number Component in column 2, row 2 position (index 10)
m23 number Component in column 2, row 3 position (index 11)
m30 number Component in column 3, row 0 position (index 12)
m31 number Component in column 3, row 1 position (index 13)
m32 number Component in column 3, row 2 position (index 14)
m33 number Component in column 3, row 3 position (index 15)

Returns: mat4type

A new mat4

# fromXRotation

▸ fromXRotation(out: mat4type, rad: number): mat4type

Creates a matrix from the given angle around the X axis This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.rotateX(dest, dest, rad);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
rad number the angle to rotate the matrix by

Returns: mat4type

out

# fromYRotation

▸ fromYRotation(out: mat4type, rad: number): mat4type

Creates a matrix from the given angle around the Y axis This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.rotateY(dest, dest, rad);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
rad number the angle to rotate the matrix by

Returns: mat4type

out

# fromZRotation

▸ fromZRotation(out: mat4type, rad: number): mat4type

Creates a matrix from the given angle around the Z axis This is equivalent to (but much faster than):

mat4.identity(dest);
mat4.rotateZ(dest, dest, rad);
# Parameters
Name Type Description
out mat4type mat4 receiving operation result
rad number the angle to rotate the matrix by

Returns: mat4type

out

# frustum

▸ frustum(out: mat4type, left: number, right: number, bottom: number, top: number, near: number, far: number): mat4type

Generates a frustum matrix with the given bounds

# Parameters
Name Type Description
out mat4type mat4 frustum matrix will be written into
left number Left bound of the frustum
right number Right bound of the frustum
bottom number Bottom bound of the frustum
top number Top bound of the frustum
near number Near bound of the frustum
far number Far bound of the frustum

Returns: mat4type

out

# getRotation

▸ getRotation(out: vec4type, mat: mat4type): quattype

Returns a quaternion representing the rotational component of a transformation matrix. If a matrix is built with fromRotationTranslation, the returned quaternion will be the same as the quaternion originally supplied.

# Parameters
Name Type Description
out vec4type Quaternion to receive the rotation component
mat mat4type Matrix to be decomposed (input)

Returns: quattype

out

# getScaling

▸ getScaling(out: vec3type, mat: mat4type): vec3type

Returns the scaling factor component of a transformation matrix. If a matrix is built with fromRotationTranslationScale with a normalized Quaternion paramter, the returned vector will be the same as the scaling vector originally supplied.

# Parameters
Name Type Description
out vec3type Vector to receive scaling factor component
mat mat4type Matrix to be decomposed (input)

Returns: vec3type

out

# getTranslation

▸ getTranslation(out: vec3type, mat: mat4type): vec3type

Returns the translation vector component of a transformation matrix. If a matrix is built with fromRotationTranslation, the returned vector will be the same as the translation vector originally supplied.

# Parameters
Name Type Description
out vec3type Vector to receive translation component
mat mat4type Matrix to be decomposed (input)

Returns: vec3type

out

# identity

▸ identity(out: mat4type): mat4type

Set a mat4 to the identity matrix

# Parameters
Name Type Description
out mat4type the receiving matrix

Returns: mat4type

out

# invert

▸ invert(out: mat4type, a: mat4type): mat4type | null

Inverts a mat4

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the source matrix

Returns: mat4type | null

out

# lookAt

▸ lookAt(out: mat4type, eye: vec3type, center: vec3type, up: vec3type): mat4type

Generates a look-at matrix with the given eye position, focal point, and up axis

# Parameters
Name Type Description
out mat4type mat4 frustum matrix will be written into
eye vec3type Position of the viewer
center vec3type Point the viewer is looking at
up vec3type vec3 pointing up

Returns: mat4type

out

# multiply

▸ multiply(out: mat4type, a: mat4type, b: mat4type): mat4type

Multiplies two mat4s

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the first operand
b mat4type the second operand

Returns: mat4type

out

# multiplyScalar

▸ multiplyScalar(out: mat4type, a: mat4type, b: number): mat4type

Multiply each element of the matrix by a scalar.

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to scale
b number amount to scale the matrix's elements by

Returns: mat4type

out

# multiplyScalarAndAdd

▸ multiplyScalarAndAdd(out: mat4type, a: mat4type, b: mat4type, s: number): mat4type

Adds two mat4's after multiplying each element of the second operand by a scalar value.

# Parameters
Name Type Description
out mat4type the receiving vector
a mat4type the first operand
b mat4type the second operand
s number the amount to scale b's elements by before adding

Returns: mat4type

out

# ortho

▸ ortho(out: mat4type, left: number, right: number, bottom: number, top: number, near: number, far: number): mat4type

Generates a orthogonal projection matrix with the given bounds

# Parameters
Name Type Description
out mat4type mat4 frustum matrix will be written into
left number Left bound of the frustum
right number Right bound of the frustum
bottom number Bottom bound of the frustum
top number Top bound of the frustum
near number Near bound of the frustum
far number Far bound of the frustum

Returns: mat4type

out

# perspective

▸ perspective(out: mat4type, fovy: number, aspect: number, near: number, far: number): mat4type

Generates a perspective projection matrix with the given bounds

# Parameters
Name Type Description
out mat4type mat4 frustum matrix will be written into
fovy number Vertical field of view in radians
aspect number Aspect ratio. typically viewport width/height
near number Near bound of the frustum
far number Far bound of the frustum

Returns: mat4type

out

# perspectiveFromFieldOfView

▸ perspectiveFromFieldOfView(out: mat4type, fov: { downDegrees: number ; leftDegrees: number ; rightDegrees: number ; upDegrees: number }, near: number, far: number): mat4type

Generates a perspective projection matrix with the given field of view. This is primarily useful for generating projection matrices to be used with the still experiemental WebVR API.

# Parameters
Name Type Description
out mat4type mat4 frustum matrix will be written into
fov object Object containing the following values: upDegrees, downDegrees, leftDegrees, rightDegrees
fov.downDegrees number -
fov.leftDegrees number -
fov.rightDegrees number -
fov.upDegrees number -
near number Near bound of the frustum
far number Far bound of the frustum

Returns: mat4type

out

# rotate

▸ rotate(out: mat4type, a: mat4type, rad: number, axis: vec3type): mat4type | null

Rotates a mat4 by the given angle around the given axis

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to rotate
rad number the angle to rotate the matrix by
axis vec3type the axis to rotate around

Returns: mat4type | null

out

# rotateX

▸ rotateX(out: mat4type, a: mat4type, rad: number): mat4type

Rotates a matrix by the given angle around the X axis

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat4type

out

# rotateY

▸ rotateY(out: mat4type, a: mat4type, rad: number): mat4type

Rotates a matrix by the given angle around the Y axis

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat4type

out

# rotateZ

▸ rotateZ(out: mat4type, a: mat4type, rad: number): mat4type

Rotates a matrix by the given angle around the Z axis

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to rotate
rad number the angle to rotate the matrix by

Returns: mat4type

out

# scale

▸ scale(out: mat4type, a: mat4type, v: vec3type): mat4type

Scales the mat4 by the dimensions in the given vec3 not using vectorization

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to scale
v vec3type the vec3 to scale the matrix by

Returns: mat4type

out

# set

▸ set(out: mat4type, m00: number, m01: number, m02: number, m03: number, m10: number, m11: number, m12: number, m13: number, m20: number, m21: number, m22: number, m23: number, m30: number, m31: number, m32: number, m33: number): mat4type

Set the components of a mat4 to the given values

# Parameters
Name Type Description
out mat4type the receiving matrix
m00 number Component in column 0, row 0 position (index 0)
m01 number Component in column 0, row 1 position (index 1)
m02 number Component in column 0, row 2 position (index 2)
m03 number Component in column 0, row 3 position (index 3)
m10 number Component in column 1, row 0 position (index 4)
m11 number Component in column 1, row 1 position (index 5)
m12 number Component in column 1, row 2 position (index 6)
m13 number Component in column 1, row 3 position (index 7)
m20 number Component in column 2, row 0 position (index 8)
m21 number Component in column 2, row 1 position (index 9)
m22 number Component in column 2, row 2 position (index 10)
m23 number Component in column 2, row 3 position (index 11)
m30 number Component in column 3, row 0 position (index 12)
m31 number Component in column 3, row 1 position (index 13)
m32 number Component in column 3, row 2 position (index 14)
m33 number Component in column 3, row 3 position (index 15)

Returns: mat4type

out

# str

▸ str(a: mat4type): string

Returns a string representation of a mat4

# Parameters
Name Type Description
a mat4type matrix to represent as a string

Returns: string

string representation of the matrix

# subtract

▸ subtract(out: mat4type, a: mat4type, b: mat4type): mat4type

Subtracts matrix b from matrix a

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the first operand
b mat4type the second operand

Returns: mat4type

out

# translate

▸ translate(out: mat4type, a: mat4type, v: vec3type): mat4type

Translate a mat4 by the given vector

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the matrix to translate
v vec3type vector to translate by

Returns: mat4type

out

# transpose

▸ transpose(out: mat4type, a: mat4type): mat4type

Transpose the values of a mat4

# Parameters
Name Type Description
out mat4type the receiving matrix
a mat4type the source matrix

Returns: mat4type

out

vjmap / Exports / Math2D

# Namespace: Math2D

# Table of contents

# Classes

# Interfaces

# Functions

# Functions

# computeSquaredLineLength

▸ computeSquaredLineLength(line: number[]): number

Computes the squared length of a line.

# Parameters
Name Type Description
line number[] An array of that forms a line via [x,y,z,x,y,z,...] tuples.

Returns: number

# dist

▸ dist(ax: number, ay: number, bx: number, by: number, az?: number, bz?: number): number

Compute distance between two 2D points a and b.

# Parameters
Name Type Description
ax number Point a.x
ay number Point a.y
bx number Point b.x
by number Point b.y
az? number
bz? number

Returns: number

between the two points

# distSquared

▸ distSquared(ax: number, ay: number, bx: number, by: number): number

Compute squared distance between two 2D points a and b.

# Parameters
Name Type Description
ax number Point a.x
ay number Point a.y
bx number Point b.x
by number Point b.y

Returns: number

Squared distance between the two points

# distToSegmentSquared

▸ distToSegmentSquared(px: number, py: number, l0x: number, l0y: number, l1x: number, l1y: number): number

Compute squared distance between a 2D point and a 2D line segment.

# Parameters
Name Type Description
px number Test point X
py number Test point y
l0x number Line segment start X
l0y number Line segment start Y
l1x number Line segment end X
l1y number Line segment end Y

Returns: number

Squared distance between point and line segment

# intersectLineAndCircle

▸ intersectLineAndCircle(xLine1: number, yLine1: number, xLine2: number, yLine2: number, radius: number, xCenter?: number, yCenter?: number): { x1: number ; x2?: number ; y1: number ; y2?: number } | undefined

Finds the intersections of a line and a circle.

# Parameters
Name Type Default value Description
xLine1 number - abscissa of first line point.
yLine1 number - ordinate of second line point.
xLine2 number - abscissa of second line point.
yLine2 number - ordinate of second line point.
radius number - circle radius.
xCenter number 0 abscissa of circle center.
yCenter number 0 ordinate of circle center.

Returns: { x1: number ; x2?: number ; y1: number ; y2?: number } | undefined

coordinates of the intersections (1 if the line is tangent to the circle, 2 if it's secant) or undefined if there's no intersection.

# intersectLines

▸ intersectLines(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number, result?: Vec2Like): Vec2Like | undefined

Computes the intersection point between two lines.

remarks This functions computes the line-line intersection (opens new window) of two lines given two points on each line.

# Parameters
Name Type Description
x1 number x coordinate of the first point of the first line.
y1 number y coordinate of the first point of the first line.
x2 number x coordinate of the second point of the first line.
y2 number y coordinate of the second point of the first line.
x3 number x coordinate of the first point of the second line.
y3 number y coordinate of the first point of the second line.
x4 number x coordinate of the second point of the second line.
y4 number y coordinate of the second point of the second line.
result Vec2Like The resulting point.

Returns: Vec2Like | undefined

# lineDist

▸ lineDist(pts: GeoPointLike[]): number

求线的距离

# Parameters
Name Type
pts GeoPointLike[]

Returns: number

vjmap / Exports / MathUtils

# Namespace: MathUtils

# Table of contents

# Functions

# Functions

# clamp

▸ clamp(value: number, min: number, max: number): number

Ensures that input value fits in a given range.

# Parameters
Name Type Description
value number The value to be clamped.
min number Minimum value.
max number Maximum value.

Returns: number

Clamped value.

# easeInOutCubic

▸ easeInOutCubic(startValue: number, endValue: number, time: number): number

Smoothly interpolates between two values using cubic formula

# Parameters
Name Type Description
startValue number -
endValue number -
time number -

Returns: number

Result of the interpolation within the range of [startValue, endValue]

# equals

▸ equals(num1: number, num2: number, dotErr?: number): boolean

判断两个数是否相等

# Parameters
Name Type Default value Description
num1 number -
num2 number -
dotErr number 8 允许误差的小数点后几位，默认8位

Returns: boolean

# isClamped

▸ isClamped(value: number, lowerBound: number | undefined, upperBound: number | undefined): boolean

Checks if the value of a given number is inside an upper or lower bound. The bounds may be undefined, in which case their value is ignored.

# Parameters
Name Type Description
value number Value to check.
lowerBound number | undefined The lower bound to check the value against.
upperBound number | undefined The upper bound to check the value against.

Returns: boolean

true if value is inside the bounds or if the bounds are undefined, false otherwise.

# lerp

▸ lerp(v1: number, v2: number, value: number): number

线性插值

# Parameters
Name Type
v1 number
v2 number
value number

Returns: number

# map

▸ map(val: number, inMin: number, inMax: number, outMin: number, outMax: number): number

Maps a number from one range to another.

# Parameters
Name Type Description
val number The incoming value to be converted.
inMin number Lower bound of the value's current range.
inMax number Upper bound of the value's current range.
outMin number Lower bound of the value's target range.
outMax number Upper bound of the value's target range.

Returns: number

# max2

▸ max2(a: number | undefined, b: number | undefined): number | undefined

Returns the larger of the two given numbers. Both numbers may be undefined, in which case the result is undefined. If only one of the numbers is undefined, the other number is returned.

# Parameters
Name Type Description
a number | undefined First number.
b number | undefined Second number.

Returns: number | undefined

# min2

▸ min2(a: number | undefined, b: number | undefined): number | undefined

Returns the smaller of the two given numbers. Both numbers may be undefined, in which case the result is undefined. If only one of the numbers is undefined, the other number is returned.

# Parameters
Name Type Description
a number | undefined First number.
b number | undefined Second number.

Returns: number | undefined

# smoothStep

▸ smoothStep(edge0: number, edge1: number, x: number): number

Returns a smooth interpolation between the values edge0 and edge1 based on the interpolation factor x. 0 <= x <= 1.

see https://en.wikipedia.org/wiki/Smoothstep

# Parameters
Name Type Description
edge0 number -
edge1 number -
x number -

Returns: number

# smootherStep

▸ smootherStep(edge0: number, edge1: number, x: number): number

Returns a smooth interpolation between the values edge0 and edge1 based on the interpolation factor x. 0 <= x <= 1.

Improved version by Ken Perlin, which has zero 1st- and 2nd-order derivatives at x = 0 and x = 1:

see https://en.wikipedia.org/wiki/Smoothstep

# Parameters
Name Type Description
edge0 number -
edge1 number -
x number -

Returns: number

# wrap

▸ wrap(n: number, min: number, max: number, isMin?: boolean): number

constrain n to the given range, excluding the minimum, via modular arithmetic

# Parameters
Name Type Default value Description
n number - value
min number - the minimum value to be returned, (isMin is false, exclusive, is true inclusive)
max number - the maximum value to be returned, (isMin is false, inclusive, is true exclusive)
isMin boolean false

Returns: number

number

vjmap / Exports / quat

# Namespace: quat

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: quattype

# Functions

# add

▸ Const add(out: vec4type, a: vec4type, b: vec4type): vec4type

Adds two quat's

function

# Parameters
Name Type Description
out vec4type the receiving quaternion
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# calculateW

▸ calculateW(out: quattype, a: quattype): quattype

Calculates the W component of a quat from the X, Y, and Z components. Assumes that quaternion is 1 unit in length. Any existing W component will be ignored.

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype quat to calculate W component of

Returns: quattype

out

# clone

▸ Const clone(a: vec4type): vec4type

Creates a new quat initialized with values from an existing quaternion

function

# Parameters
Name Type Description
a vec4type quaternion to clone

Returns: vec4type

a new quaternion

# conjugate

▸ conjugate(out: quattype, a: quattype): quattype

Calculates the conjugate of a quat If the quaternion is normalized, this function is faster than quat.inverse and produces the same result.

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype quat to calculate conjugate of

Returns: quattype

out

# copy

▸ Const copy(out: vec4type, a: vec4type): vec4type

Copy the values from one quat to another

function

# Parameters
Name Type Description
out vec4type the receiving quaternion
a vec4type the source quaternion

Returns: vec4type

out

# create

▸ create(): quattype

Creates a new identity quat

Returns: quattype

a new quaternion

# dot

▸ Const dot(a: vec4type, b: vec4type): number

Calculates the dot product of two quat's

function

# Parameters
Name Type Description
a vec4type the first operand
b vec4type the second operand

Returns: number

dot product of a and b

# equals

▸ Const equals(a: vec4type, b: vec4type): boolean

Returns whether or not the quaternions have approximately the same elements in the same position.

# Parameters
Name Type Description
a vec4type The first vector.
b vec4type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# exactEquals

▸ Const exactEquals(a: vec4type, b: vec4type): boolean

Returns whether or not the quaternions have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a vec4type The first quaternion.
b vec4type The second quaternion.

Returns: boolean

True if the vectors are equal, false otherwise.

# fromMat3

▸ fromMat3(out: quattype, m: mat3type): quattype

Creates a quaternion from the given 3x3 rotation matrix.

NOTE: The resultant quaternion is not normalized, so you should be sure to renormalize the quaternion yourself where necessary.

function

# Parameters
Name Type Description
out quattype the receiving quaternion
m mat3type rotation matrix

Returns: quattype

out

# fromValues

▸ Const fromValues(x: number, y: number, z: number, w: number): vec4type

Creates a new quat initialized with the given values

function

# Parameters
Name Type Description
x number X component
y number Y component
z number Z component
w number W component

Returns: vec4type

a new quaternion

# getAxisAngle

▸ getAxisAngle(outAxis: vec3type, q: quattype): number

Gets the rotation axis and angle for a given quaternion. If a quaternion is created with setAxisAngle, this method will return the same values as providied in the original parameter list OR functionally equivalent values. Example: The quaternion formed by axis [0, 0, 1] and angle -90 is the same as the quaternion formed by [0, 0, 1] and 270. This method favors the latter.

# Parameters
Name Type Description
outAxis vec3type Vector receiving the axis of rotation
q quattype Quaternion to be decomposed

Returns: number

Angle, in radians, of the rotation

# identity

▸ identity(out: quattype): quattype

Set a quat to the identity quaternion

# Parameters
Name Type Description
out quattype the receiving quaternion

Returns: quattype

out

# invert

▸ invert(out: quattype, a: quattype): quattype

Calculates the inverse of a quat

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype quat to calculate inverse of

Returns: quattype

out

# length

▸ Const length(a: vec4type): number

Calculates the length of a quat

function

# Parameters
Name Type Description
a vec4type vector to calculate length of

Returns: number

length of a

# lerp

▸ Const lerp(out: vec4type, a: vec4type, b: vec4type, t: number): vec4type

Performs a linear interpolation between two quat's

function

# Parameters
Name Type Description
out vec4type the receiving quaternion
a vec4type the first operand
b vec4type the second operand
t number interpolation amount between the two inputs

Returns: vec4type

out

# multiply

▸ multiply(out: quattype, a: quattype, b: quattype): quattype

Multiplies two quat's

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype the first operand
b quattype the second operand

Returns: quattype

out

# normalize

▸ Const normalize(out: vec4type, a: vec4type): vec4type

Normalize a quat

function

# Parameters
Name Type Description
out vec4type the receiving quaternion
a vec4type quaternion to normalize

Returns: vec4type

out

# rotateX

▸ rotateX(out: quattype, a: quattype, rad: number): quattype

Rotates a quaternion by the given angle about the X axis

# Parameters
Name Type Description
out quattype quat receiving operation result
a quattype quat to rotate
rad number angle (in radians) to rotate

Returns: quattype

out

# rotateY

▸ rotateY(out: quattype, a: quattype, rad: number): quattype

Rotates a quaternion by the given angle about the Y axis

# Parameters
Name Type Description
out quattype quat receiving operation result
a quattype quat to rotate
rad number angle (in radians) to rotate

Returns: quattype

out

# rotateZ

▸ rotateZ(out: quattype, a: quattype, rad: number): quattype

Rotates a quaternion by the given angle about the Z axis

# Parameters
Name Type Description
out quattype quat receiving operation result
a quattype quat to rotate
rad number angle (in radians) to rotate

Returns: quattype

out

# rotationTo

▸ rotationTo(out: quattype, a: vec3type, b: vec3type): quattype

Sets a quaternion to represent the shortest rotation from one vector to another.

Both vectors are assumed to be unit length.

# Parameters
Name Type Description
out quattype the receiving quaternion.
a vec3type the initial vector
b vec3type the destination vector

Returns: quattype

out

# scale

▸ Const scale(out: vec4type, a: vec4type, b: number): vec4type

Scales a quat by a scalar number

function

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the vector to scale
b number amount to scale the vector by

Returns: vec4type

out

# set

▸ Const set(out: vec4type, x: number, y: number, z: number, w: number): vec4type

Set the components of a quat to the given values

function

# Parameters
Name Type Description
out vec4type the receiving quaternion
x number X component
y number Y component
z number Z component
w number W component

Returns: vec4type

out

# setAxes

▸ setAxes(out: quattype, view: vec3type, right: vec3type, up: vec3type): quattype

Sets the specified quaternion with values corresponding to the given axes. Each axis is a vec3 and is expected to be unit length and perpendicular to all other specified axes.

# Parameters
Name Type Description
out quattype -
view vec3type the vector representing the viewing direction
right vec3type the vector representing the local "right" direction
up vec3type the vector representing the local "up" direction

Returns: quattype

out

# setAxisAngle

▸ setAxisAngle(out: quattype, axis: vec3type, rad: number): quattype

Sets a quat from the given angle and rotation axis, then returns it.

# Parameters
Name Type Description
out quattype the receiving quaternion
axis vec3type the axis around which to rotate
rad number the angle in radians

Returns: quattype

out

# slerp

▸ slerp(out: quattype, a: quattype, b: quattype, t: number): quattype

Performs a spherical linear interpolation between two quat

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype the first operand
b quattype the second operand
t number interpolation amount between the two inputs

Returns: quattype

out

# sqlerp

▸ sqlerp(out: quattype, a: quattype, b: quattype, c: quattype, d: quattype, t: number): quattype

Performs a spherical linear interpolation with two control points

# Parameters
Name Type Description
out quattype the receiving quaternion
a quattype the first operand
b quattype the second operand
c quattype the third operand
d quattype the fourth operand
t number interpolation amount

Returns: quattype

out

# squaredLength

▸ Const squaredLength(a: vec4type): number

Calculates the squared length of a quat

function

# Parameters
Name Type Description
a vec4type vector to calculate squared length of

Returns: number

squared length of a

# str

▸ str(a: quattype): string

Returns a string representation of a quatenion

# Parameters
Name Type Description
a quattype vector to represent as a string

Returns: string

string representation of the vector

vjmap / Exports / spring

# Namespace: spring

# Table of contents

# Functions

# Functions

# needsInterpolation

▸ needsInterpolation(a: any, b: any): boolean

# Parameters
Name Type
a any
b any

Returns: boolean

vjmap / Exports / vec2

# Namespace: vec2

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: vec2type

# Functions

# add

▸ add(out: vec2type, a: vec2type, b: vec2type): vec2type

Adds two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# angle

▸ angle(a: vec2type, b: vec2type): number

Get the angle between two 2D vectors

# Parameters
Name Type Description
a vec2type The first operand
b vec2type The second operand

Returns: number

The angle in radians

# ceil

▸ ceil(out: vec2type, a: vec2type): vec2type

Math.ceil the components of a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to ceil

Returns: vec2type

out

# clone

▸ clone(a: vec2type): vec2type

Creates a new vec2 initialized with values from an existing vector

# Parameters
Name Type Description
a vec2type vector to clone

Returns: vec2type

a new 2D vector

# copy

▸ copy(out: vec2type, a: vec2type): vec2type

Copy the values from one vec2 to another

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the source vector

Returns: vec2type

out

# create

▸ create(): vec2type

Creates a new, empty vec2

Returns: vec2type

a new 2D vector

# cross

▸ cross(out: vec2type, a: vec2type, b: vec2type): vec2type

Computes the cross product of two vec2's Note that the cross product must by definition produce a 3D vector

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# distance

▸ distance(a: vec2type, b: vec2type): number

Calculates the euclidian distance between two vec2's

# Parameters
Name Type Description
a vec2type the first operand
b vec2type the second operand

Returns: number

distance between a and b

# divide

▸ divide(out: vec2type, a: vec2type, b: vec2type): vec2type

Divides two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# dot

▸ dot(a: vec2type, b: vec2type): number

Calculates the dot product of two vec2's

# Parameters
Name Type Description
a vec2type the first operand
b vec2type the second operand

Returns: number

dot product of a and b

# equals

▸ equals(a: vec2type, b: vec2type): boolean

Returns whether or not the vectors have approximately the same elements in the same position.

# Parameters
Name Type Description
a vec2type The first vector.
b vec2type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# exactEquals

▸ exactEquals(a: vec2type, b: vec2type): boolean

Returns whether or not the vectors exactly have the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a vec2type The first vector.
b vec2type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# floor

▸ floor(out: vec2type, a: vec2type): vec2type

Math.floor the components of a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to floor

Returns: vec2type

out

# forEach

▸ Const forEach(a: any, stride: any, offset: any, count: any, fn: any, arg: any): any

Perform some operation over an array of vec2s.

function

# Parameters
Name Type Description
a any the array of vectors to iterate over
stride any Number of elements between the start of each vec2. If 0 assumes tightly packed
offset any Number of elements to skip at the beginning of the array
count any Number of vec2s to iterate over. If 0 iterates over entire array
fn any Function to call for each vector in the array
arg any -

Returns: any

a

# fromValues

▸ fromValues(x: number, y: number): vec2type

Creates a new vec2 initialized with the given values

# Parameters
Name Type Description
x number X component
y number Y component

Returns: vec2type

a new 2D vector

# inverse

▸ inverse(out: vec2type, a: vec2type): vec2type

Returns the inverse of the components of a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to invert

Returns: vec2type

out

# length

▸ length(a: vec2type): number

Calculates the length of a vec2

# Parameters
Name Type Description
a vec2type vector to calculate length of

Returns: number

length of a

# lerp

▸ lerp(out: vec2type, a: vec2type, b: vec2type, t: number): vec2type

Performs a linear interpolation between two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand
t number interpolation amount, in the range [0-1], between the two inputs

Returns: vec2type

out

# max

▸ max(out: vec2type, a: vec2type, b: vec2type): vec2type

Returns the maximum of two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# min

▸ min(out: vec2type, a: vec2type, b: vec2type): vec2type

Returns the minimum of two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# multiply

▸ multiply(out: vec2type, a: vec2type, b: vec2type): vec2type

Multiplies two vec2's

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# negate

▸ negate(out: vec2type, a: vec2type): vec2type

Negates the components of a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to negate

Returns: vec2type

out

# normalize

▸ normalize(out: vec2type, a: vec2type): vec2type

Normalize a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to normalize

Returns: vec2type

out

# random

▸ random(out: vec2type, scale: number): vec2type

Generates a random vector with the given scale

# Parameters
Name Type Description
out vec2type the receiving vector
scale number -

Returns: vec2type

out

# rotate

▸ rotate(out: vec2type, a: vec2type, b: vec2type, rad: number): vec2type

Rotate a 2D vector

# Parameters
Name Type Description
out vec2type The receiving vec2
a vec2type The vec2 point to rotate
b vec2type The origin of the rotation
rad number The angle of rotation in radians

Returns: vec2type

out

# round

▸ round(out: vec2type, a: vec2type): vec2type

Math.round the components of a vec2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type vector to round

Returns: vec2type

out

# scale

▸ scale(out: vec2type, a: vec2type, b: number): vec2type

Scales a vec2 by a scalar number

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the vector to scale
b number amount to scale the vector by

Returns: vec2type

out

# scaleAndAdd

▸ scaleAndAdd(out: vec2type, a: vec2type, b: vec2type, scale: number): vec2type

Adds two vec2's after scaling the second operand by a scalar value

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand
scale number the amount to scale b by before adding

Returns: vec2type

out

# set

▸ set(out: vec2type, x: number, y: number): vec2type

Set the components of a vec2 to the given values

# Parameters
Name Type Description
out vec2type the receiving vector
x number X component
y number Y component

Returns: vec2type

out

# squaredDistance

▸ squaredDistance(a: vec2type, b: vec2type): number

Calculates the squared euclidian distance between two vec2's

# Parameters
Name Type Description
a vec2type the first operand
b vec2type the second operand

Returns: number

squared distance between a and b

# squaredLength

▸ squaredLength(a: vec2type): number

Calculates the squared length of a vec2

# Parameters
Name Type Description
a vec2type vector to calculate squared length of

Returns: number

squared length of a

# str

▸ str(a: vec2type): string

Returns a string representation of a vector

# Parameters
Name Type Description
a vec2type vector to represent as a string

Returns: string

string representation of the vector

# subtract

▸ subtract(out: vec2type, a: vec2type, b: vec2type): vec2type

Subtracts vector b from vector a

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the first operand
b vec2type the second operand

Returns: vec2type

out

# transformMat2

▸ transformMat2(out: vec2type, a: vec2type, m: vec2type): vec2type

Transforms the vec2 with a mat2

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the vector to transform
m vec2type matrix to transform with

Returns: vec2type

out

# transformMat2d

▸ transformMat2d(out: vec2type, a: vec2type, m: vec2type): vec2type

Transforms the vec2 with a mat2d

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the vector to transform
m vec2type matrix to transform with

Returns: vec2type

out

# transformMat3

▸ transformMat3(out: vec2type, a: vec2type, m: vec2type): vec2type

Transforms the vec2 with a mat3 3rd vector component is implicitly '1'

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the vector to transform
m vec2type matrix to transform with

Returns: vec2type

out

# transformMat4

▸ transformMat4(out: vec2type, a: vec2type, m: vec2type): vec2type

Transforms the vec2 with a mat4 3rd vector component is implicitly '0' 4th vector component is implicitly '1'

# Parameters
Name Type Description
out vec2type the receiving vector
a vec2type the vector to transform
m vec2type matrix to transform with

Returns: vec2type

out

# zero

▸ zero(out: vec2type): vec2type

Set the components of a vec2 to zero

# Parameters
Name Type Description
out vec2type the receiving vector

Returns: vec2type

out

vjmap / Exports / vec3

# Namespace: vec3

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: vec3type

# Functions

# add

▸ add(out: vec3type, a: vec3type, b: vec3type): vec3type

Adds two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# angle

▸ angle(a: vec3type, b: vec3type): number

Get the angle between two 3D vectors

# Parameters
Name Type Description
a vec3type The first operand
b vec3type The second operand

Returns: number

The angle in radians

# bezier

▸ bezier(out: vec3type, a: vec3type, b: vec3type, c: vec3type, d: vec3type, t: number): vec3type

Performs a bezier interpolation with two control points

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand
c vec3type the third operand
d vec3type the fourth operand
t number interpolation amount between the two inputs

Returns: vec3type

out

# ceil

▸ ceil(out: vec3type, a: vec3type): vec3type

Math.ceil the components of a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to ceil

Returns: vec3type

out

# clone

▸ clone(a: vec3type): vec3type

Creates a new vec3 initialized with values from an existing vector

# Parameters
Name Type Description
a vec3type vector to clone

Returns: vec3type

a new 3D vector

# copy

▸ copy(out: vec3type, a: vec3type): vec3type

Copy the values from one vec3 to another

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the source vector

Returns: vec3type

out

# create

▸ create(): vec3type

Creates a new, empty vec3

Returns: vec3type

a new 3D vector

# cross

▸ cross(out: vec3type, a: vec3type, b: vec3type): vec3type

Computes the cross product of two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# distance

▸ distance(a: vec3type, b: vec3type): number

Calculates the euclidian distance between two vec3's

# Parameters
Name Type Description
a vec3type the first operand
b vec3type the second operand

Returns: number

distance between a and b

# divide

▸ divide(out: vec3type, a: vec3type, b: vec3type): vec3type

Divides two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# dot

▸ dot(a: vec3type, b: vec3type): number

Calculates the dot product of two vec3's

# Parameters
Name Type Description
a vec3type the first operand
b vec3type the second operand

Returns: number

dot product of a and b

# equals

▸ equals(a: vec3type, b: vec3type): boolean

Returns whether or not the vectors have approximately the same elements in the same position.

# Parameters
Name Type Description
a vec3type The first vector.
b vec3type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# exactEquals

▸ exactEquals(a: vec3type, b: vec3type): boolean

Returns whether or not the vectors have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a vec3type The first vector.
b vec3type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# floor

▸ floor(out: vec3type, a: vec3type): vec3type

Math.floor the components of a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to floor

Returns: vec3type

out

# forEach

▸ forEach(a: vec3type, stride: number, offset: number, count: number, fn: (out: vec3type, vec: vec3type, arg: any) => void, arg?: any): any

Perform some operation over an array of vec3s.

function

# Parameters
Name Type Description
a vec3type the array of vectors to iterate over
stride number Number of elements between the start of each vec3. If 0 assumes tightly packed
offset number Number of elements to skip at the beginning of the array
count number Number of vec3s to iterate over. If 0 iterates over entire array
fn (out: vec3type, vec: vec3type, arg: any) => void Function to call for each vector in the array
arg? any -

Returns: any

a

# fromValues

▸ fromValues(x: number, y: number, z: number): vec3type

Creates a new vec3 initialized with the given values

# Parameters
Name Type Description
x number X component
y number Y component
z number Z component

Returns: vec3type

a new 3D vector

# hermite

▸ hermite(out: vec3type, a: vec3type, b: vec3type, c: vec3type, d: vec3type, t: number): vec3type

Performs a hermite interpolation with two control points

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand
c vec3type the third operand
d vec3type the fourth operand
t number interpolation amount between the two inputs

Returns: vec3type

out

# inverse

▸ inverse(out: vec3type, a: vec3type): vec3type

Returns the inverse of the components of a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to invert

Returns: vec3type

out

# length

▸ length(a: vec3type): number

Calculates the length of a vec3

# Parameters
Name Type Description
a vec3type vector to calculate length of

Returns: number

length of a

# lerp

▸ lerp(out: vec3type, a: vec3type, b: vec3type, t: number): vec3type

Performs a linear interpolation between two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand
t number interpolation amount between the two inputs

Returns: vec3type

out

# max

▸ max(out: vec3type, a: vec3type, b: vec3type): vec3type

Returns the maximum of two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# min

▸ min(out: vec3type, a: vec3type, b: vec3type): vec3type

Returns the minimum of two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# multiply

▸ multiply(out: vec3type, a: vec3type, b: vec3type): vec3type

Multiplies two vec3's

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# negate

▸ negate(out: vec3type, a: vec3type): vec3type

Negates the components of a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to negate

Returns: vec3type

out

# normalize

▸ normalize(out: vec3type, a: vec3type): vec3type

Normalize a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to normalize

Returns: vec3type

out

# random

▸ random(out: vec3type, s?: number): vec3type

Generates a random vector with the given scale

# Parameters
Name Type Default value Description
out vec3type - the receiving vector
s number 1.0 -

Returns: vec3type

out

# rotateX

▸ rotateX(out: vec3type, a: vec3type, b: vec3type, c: number): vec3type

Rotate a 3D vector around the x-axis

# Parameters
Name Type Description
out vec3type The receiving vec3
a vec3type The vec3 point to rotate
b vec3type The origin of the rotation
c number The angle of rotation

Returns: vec3type

out

# rotateY

▸ rotateY(out: vec3type, a: vec3type, b: vec3type, c: number): vec3type

Rotate a 3D vector around the y-axis

# Parameters
Name Type Description
out vec3type The receiving vec3
a vec3type The vec3 point to rotate
b vec3type The origin of the rotation
c number The angle of rotation

Returns: vec3type

out

# rotateZ

▸ rotateZ(out: vec3type, a: vec3type, b: vec3type, c: number): vec3type

Rotate a 3D vector around the z-axis

# Parameters
Name Type Description
out vec3type The receiving vec3
a vec3type The vec3 point to rotate
b vec3type The origin of the rotation
c number The angle of rotation

Returns: vec3type

out

# round

▸ round(out: vec3type, a: vec3type): vec3type

Math.round the components of a vec3

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type vector to round

Returns: vec3type

out

# scale

▸ scale(out: vec3type, a: vec3type, b: number): vec3type

Scales a vec3 by a scalar number

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the vector to scale
b number amount to scale the vector by

Returns: vec3type

out

# scaleAndAdd

▸ scaleAndAdd(out: vec3type, a: vec3type, b: vec3type, s: number): vec3type

Adds two vec3's after scaling the second operand by a scalar value

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand
s number the amount to scale b by before adding

Returns: vec3type

out

# set

▸ set(out: vec3type, x: number, y: number, z: number): vec3type

Set the components of a vec3 to the given values

# Parameters
Name Type Description
out vec3type the receiving vector
x number X component
y number Y component
z number Z component

Returns: vec3type

out

# squaredDistance

▸ squaredDistance(a: vec3type, b: vec3type): number

Calculates the squared euclidian distance between two vec3's

# Parameters
Name Type Description
a vec3type the first operand
b vec3type the second operand

Returns: number

squared distance between a and b

# squaredLength

▸ squaredLength(a: vec3type): number

Calculates the squared length of a vec3

# Parameters
Name Type Description
a vec3type vector to calculate squared length of

Returns: number

squared length of a

# str

▸ str(a: vec3type): string

Returns a string representation of a vector

# Parameters
Name Type Description
a vec3type vector to represent as a string

Returns: string

string representation of the vector

# subtract

▸ subtract(out: vec3type, a: vec3type, b: vec3type): vec3type

Subtracts vector b from vector a

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the first operand
b vec3type the second operand

Returns: vec3type

out

# transformMat3

▸ transformMat3(out: vec3type, a: vec3type, m: mat4type): vec3type

Transforms the vec3 with a mat3.

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the vector to transform
m mat4type the 3x3 matrix to transform with

Returns: vec3type

out

# transformMat4

▸ transformMat4(out: vec3type, a: vec3type, m: mat4type): vec3type

Transforms the vec3 with a mat4. 4th vector component is implicitly '1'

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the vector to transform
m mat4type matrix to transform with

Returns: vec3type

out

# transformQuat

▸ transformQuat(out: vec3type, a: vec3type, q: quattype): vec3type

Transforms the vec3 with a quat

# Parameters
Name Type Description
out vec3type the receiving vector
a vec3type the vector to transform
q quattype quaternion to transform with

Returns: vec3type

out

vjmap / Exports / vec4

# Namespace: vec4

# Table of contents

# Type aliases

# Functions

# Type aliases

# valueType

Ƭ valueType: vec4type

# Functions

# add

▸ add(out: vec4type, a: vec4type, b: vec4type): vec4type

Adds two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# ceil

▸ ceil(out: vec4type, a: vec4type): vec4type

Math.ceil the components of a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to ceil

Returns: vec4type

out

# clone

▸ clone(a: vec4type): vec4type

Creates a new vec4 initialized with values from an existing vector

# Parameters
Name Type Description
a vec4type vector to clone

Returns: vec4type

a new 4D vector

# copy

▸ copy(out: vec4type, a: vec4type): vec4type

Copy the values from one vec4 to another

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the source vector

Returns: vec4type

out

# create

▸ create(): vec4type

Creates a new, empty vec4

Returns: vec4type

a new 4D vector

# distance

▸ distance(a: vec4type, b: vec4type): number

Calculates the euclidian distance between two vec4's

# Parameters
Name Type Description
a vec4type the first operand
b vec4type the second operand

Returns: number

distance between a and b

# divide

▸ divide(out: vec4type, a: vec4type, b: vec4type): vec4type

Divides two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# dot

▸ dot(a: vec4type, b: vec4type): number

Calculates the dot product of two vec4's

# Parameters
Name Type Description
a vec4type the first operand
b vec4type the second operand

Returns: number

dot product of a and b

# equals

▸ equals(a: vec4type, b: vec4type): boolean

Returns whether or not the vectors have approximately the same elements in the same position.

# Parameters
Name Type Description
a vec4type The first vector.
b vec4type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# exactEquals

▸ exactEquals(a: vec4type, b: vec4type): boolean

Returns whether or not the vectors have exactly the same elements in the same position (when compared with ===)

# Parameters
Name Type Description
a vec4type The first vector.
b vec4type The second vector.

Returns: boolean

True if the vectors are equal, false otherwise.

# floor

▸ floor(out: vec4type, a: vec4type): vec4type

Math.floor the components of a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to floor

Returns: vec4type

out

# forEach

▸ forEach(a: vec4type, stride: number, offset: number, count: number, fn: (out: vec4type, vec: vec4type, arg: any) => void, arg?: any): any

Perform some operation over an array of vec4s.

function

# Parameters
Name Type Description
a vec4type the array of vectors to iterate over
stride number Number of elements between the start of each vec4. If 0 assumes tightly packed
offset number Number of elements to skip at the beginning of the array
count number Number of vec4s to iterate over. If 0 iterates over entire array
fn (out: vec4type, vec: vec4type, arg: any) => void Function to call for each vector in the array
arg? any -

Returns: any

a

# fromValues

▸ fromValues(x: number, y: number, z: number, w: number): vec4type

Creates a new vec4 initialized with the given values

# Parameters
Name Type Description
x number X component
y number Y component
z number Z component
w number W component

Returns: vec4type

a new 4D vector

# inverse

▸ inverse(out: vec4type, a: vec4type): vec4type

Returns the inverse of the components of a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to invert

Returns: vec4type

out

# length

▸ length(a: vec4type): number

Calculates the length of a vec4

# Parameters
Name Type Description
a vec4type vector to calculate length of

Returns: number

length of a

# lerp

▸ lerp(out: vec4type, a: vec4type, b: vec4type, t: number): vec4type

Performs a linear interpolation between two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand
t number interpolation amount between the two inputs

Returns: vec4type

out

# max

▸ max(out: vec4type, a: vec4type, b: vec4type): vec4type

Returns the maximum of two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# min

▸ min(out: vec4type, a: vec4type, b: vec4type): vec4type

Returns the minimum of two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# multiply

▸ multiply(out: vec4type, a: vec4type, b: vec4type): vec4type

Multiplies two vec4's

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# negate

▸ negate(out: vec4type, a: vec4type): vec4type

Negates the components of a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to negate

Returns: vec4type

out

# normalize

▸ normalize(out: vec4type, a: vec4type): vec4type

Normalize a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to normalize

Returns: vec4type

out

# random

▸ random(out: vec4type, s?: number): vec4type

Generates a random vector with the given scale

# Parameters
Name Type Default value Description
out vec4type - the receiving vector
s number 1.0 -

Returns: vec4type

out

# round

▸ round(out: vec4type, a: vec4type): vec4type

Math.round the components of a vec4

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type vector to round

Returns: vec4type

out

# scale

▸ scale(out: vec4type, a: vec4type, b: number): vec4type

Scales a vec4 by a scalar number

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the vector to scale
b number amount to scale the vector by

Returns: vec4type

out

# scaleAndAdd

▸ scaleAndAdd(out: vec4type, a: vec4type, b: vec4type, s: number): vec4type

Adds two vec4's after scaling the second operand by a scalar value

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand
s number the amount to scale b by before adding

Returns: vec4type

out

# set

▸ set(out: vec4type, x: number, y: number, z: number, w: number): vec4type

Set the components of a vec4 to the given values

# Parameters
Name Type Description
out vec4type the receiving vector
x number X component
y number Y component
z number Z component
w number W component

Returns: vec4type

out

# squaredDistance

▸ squaredDistance(a: vec4type, b: vec4type): number

Calculates the squared euclidian distance between two vec4's

# Parameters
Name Type Description
a vec4type the first operand
b vec4type the second operand

Returns: number

squared distance between a and b

# squaredLength

▸ squaredLength(a: vec4type): number

Calculates the squared length of a vec4

# Parameters
Name Type Description
a vec4type vector to calculate squared length of

Returns: number

squared length of a

# str

▸ str(a: vec4type): string

Returns a string representation of a vector

# Parameters
Name Type Description
a vec4type vector to represent as a string

Returns: string

string representation of the vector

# subtract

▸ subtract(out: vec4type, a: vec4type, b: vec4type): vec4type

Subtracts vector b from vector a

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the first operand
b vec4type the second operand

Returns: vec4type

out

# transformMat4

▸ transformMat4(out: vec4type, a: vec4type, m: mat4type): vec4type

Transforms the vec4 with a mat4.

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the vector to transform
m mat4type matrix to transform with

Returns: vec4type

out

# transformQuat

▸ transformQuat(out: vec4type, a: vec4type, q: quattype): vec4type

Transforms the vec4 with a quat

# Parameters
Name Type Description
out vec4type the receiving vector
a vec4type the vector to transform
q quattype quaternion to transform with

Returns: vec4type

out