类型定义
基础类型
FeatureColor
| 名称 | 类型 | 描述 |
|---|---|---|
| FeatureColor | string | 颜色值,如:"#fff"、"rgba(255,255,255,0.5)",也可以是feature.properties中的属性名称 |
SourceData
| 名称 | 类型 | 描述 |
|---|---|---|
| SourceData | GeoJSON.FeatureCollection|string | 数据源,可以是GeoJSON要素集合对象或URL字符串 |
事件类型
Events
| 名称 | 类型 | 描述 |
|---|---|---|
| Events | Object | 事件回调函数集合 |
Events 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| onMouseEnter | (event: any) => void | 鼠标移入事件回调 |
| onMouseMove | (event: any) => void | 鼠标移动事件回调 |
| onMouseLeave | (event: any) => void | 鼠标移出事件回调 |
| onClick | (event: any) => void | 鼠标点击事件回调 |
图层配置类型
TileOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| TileOptions | Object | 瓦片图层配置 |
TileOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| tiles | string|string[] | 瓦片地址 |
| beforeId | string | 在某个图层之前的图层key |
ImageOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| ImageOptions | Object | 图片图层配置 |
ImageOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| url | string | 图片地址 |
| coordinates | [number, number][] | 图片四个角坐标 |
| beforeId | string | 在某个图层之前的图层key |
PolygonOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| PolygonOptions | Object & Events | 多边形图层配置 |
PolygonOptions 属性详情
| 属性名 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| source | SourceData | 数据源 | - |
| beforeId | string | 在某个图层之前的图层key | - |
| defaultColor | FeatureColor | 默认颜色 | transparent |
| hoverColor | FeatureColor | 鼠标悬停颜色 | rgba(105,164,236,0.3) |
| activeColor | FeatureColor | 鼠标点击颜色 | rgba(105,164,236,0.5) |
| defaultLineColor | FeatureColor | 默认边框颜色 | - |
| hoverLineColor | FeatureColor | 鼠标悬停时边框颜色 | - |
| activeLineColor | FeatureColor | 鼠标点击时边框颜色 | - |
| lineWidth | number | 边框宽度 | 0 |
PolylineOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| PolylineOptions | Object & Events | 折线图层配置 |
PolylineOptions 属性详情
| 属性名 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| source | SourceData | 数据源 | - |
| beforeId | string | 在某个图层之前的图层key | - |
| defaultColor | FeatureColor | 默认颜色 | transparent |
| hoverColor | FeatureColor | 鼠标悬停颜色 | transparent |
| activeColor | FeatureColor | 鼠标点击颜色 | transparent |
| lineWidth | number | 线宽度 | 2 |
DrawOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| DrawOptions | Object & mapdraw.DrawOptions | 绘制工具配置 |
DrawOptions 属性详情
| 选项 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|
| displayControlsDefault | boolean | false | 否 | 是否显示默认控件 |
| snap | boolean | false | 否 | 是否开启绘制吸附 |
| guides | boolean | false | 否 | 是否开启绘制辅助线 |
| autoCreateCenterText | boolean | false | 否 | 是否自动创建中心文字 |
| snapOptions | object | 否 | 吸附配置 | |
| snapOptions.snapPx | number | 5 | 否 | 吸附距离(像素) |
| snapOptions.guideSnapDistance | number | 0.01 | 否 | 辅助线吸附距离 |
| snapOptions.snapVertexPriorityDistance | number | 0.01 | 否 | 顶点优先吸附距离 |
| snapOptions.rBushSearchDistance | number | 0.001 | 否 | 空间索引搜索距离 |
| snapOptions.snapToMidPoints | boolean | false | 否 | 是否吸附到线段中点 |
| fillColor | thmap.FeatureColor | rgba(59,178,208,0.3) | 否 | 填充颜色,填写颜色值(如:"#fff")或feature.properties中的属性名称 |
| fillActiveColor | thmap.FeatureColor | rgba(59,178,208,0.5) | 否 | 激活状态填充颜色 |
| fillLineColor | thmap.FeatureColor | rgba(59,178,208,1) | 否 | 面边框颜色 |
| fillLineActiveColor | thmap.FeatureColor | rgba(251,176,59,1) | 否 | 激活面边框颜色 |
| fillLineWidth | number | 3 | 否 | 面边框宽度 |
| lineColor | thmap.FeatureColor | #3BB2D0 | 否 | 线条颜色 |
| lineActiveColor | thmap.FeatureColor | #3BB2D0 | 否 | 激活状态线条颜色 |
| lineWidth | number | 3 | 否 | 线条宽度 |
| pointColor | thmap.FeatureColor | #3BB2D0 | 否 | 点颜色 |
| pointActiveColor | thmap.FeatureColor | #3BB2D0 | 否 | 激活状态点颜色 |
| pointOuterColor | thmap.FeatureColor | #ffffff | 否 | 点外框颜色 |
| pointOuterActiveColor | thmap.FeatureColor | #ffffff | 否 | 激活状态点外框颜色 |
| pointRadius | number | 5 | 否 | 点半径 |
| vertexColor | thmap.FeatureColor | #fbb03b | 否 | 顶点颜色 |
| vertexActiveColor | thmap.FeatureColor | #fbb03b | 否 | 激活状态顶点颜色 |
| vertexOuterColor | thmap.FeatureColor | #ffffff | 否 | 顶点外框颜色 |
| vertexOuterActiveColor | thmap.FeatureColor | #ffffff | 否 | 激活状态顶点外框颜色 |
| vertexRadius | number | 3 | 否 | 顶点半径 |
| midpointColor | thmap.FeatureColor | #fbb03b | 否 | 中点颜色 |
| midpointRadius | number | 3 | 否 | 中点半径 |
| imageLineColor | thmap.FeatureColor | transparent | 否 | 图片边框颜色 |
| imageLineActiveColor | thmap.FeatureColor | #fbb03b | 否 | 激活图片边框颜色 |
| imageLineWidth | number | 3 | 否 | 边框宽度 |
覆盖物类型
PopupOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| PopupOptions | Object | 弹窗配置 |
PopupOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| coordinate | LngLatLike | 弹窗坐标 |
| addMap | boolean | 是否添加进地图 |
| domContent | Node | dom结构内容 |
| html | string | 富文本 |
| text | string | 文本内容 |
| show | boolean | 显示隐藏弹窗 |
| pointerEvents | auto|none | 弹窗响应鼠标事件 |
| altitude | number | 海拔 |
| closeButton | boolean | 弹窗关闭按钮 |
| closeOnClick | boolean | 弹窗点击地图关闭 |
| closeOnMove | boolean | 弹窗移动地图关闭 |
| focusAfterOpen | boolean | 弹窗打开时是否聚焦 |
| anchor | Anchor | 弹窗锚点 |
| className | string | 弹窗样式类名 |
| offset | Offset | 弹窗偏移量 |
| maxWidth | string | 弹窗最大宽度 |
MarkerOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| MarkerOptions | Object | 标记配置 |
MarkerOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| coordinate | LngLatLike | 位置坐标 |
| addMap | boolean | 是否添加进地图 |
| show | boolean | 显示隐藏 |
| pointerEvents | auto|none | 响应鼠标事件 |
| popup | Popup | 弹窗 |
| altitude | number | 海拔 |
| anchor | Anchor | 弹窗锚点 |
| className | string | 弹窗样式类名 |
| offset | PointLike | 弹窗偏移量 |
| draggable | boolean | 是否可以拖拽 |
| element | HTMLElement | 元素 |
| rotation | number | 旋转角度 |
| rotationAlignment | string | 旋转对齐方向 |
| pitchAlignment | string | 俯仰对齐 |
| occludedOpacity | number | 闭塞不透明 |
控件类型
ControlTypes
| 名称 | 类型 | 描述 |
|---|---|---|
| ControlTypes | Enum | 控件类型枚举 |
ControlTypes 枚举值详情
| 枚举值 | 描述 |
|---|---|
scale | 比例尺控件 |
compass | 指南针控件 |
attribution | 版权信息控件 |
miniMap | 鹰眼地图控件 |
fullscreen | 全屏控件 |
navigation | 导航控件 |
geolocate | 定位控件 |
ControlOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| ControlOptions | ScaleOptions | CompassOptions | AttributionOptions | MiniMapOptions | FullscreenOptions | NavigationOptions | GeolocateOptions | 控件配置选项 |
ScaleOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| ScaleOptions | Object & mapboxgl.ScaleControlOptions | 比例尺控件配置 |
ScaleOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| position | mapboxgl.ControlPosition | 控件位置 |
CompassOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| CompassOptions | Object & mapboxgl.ControlOptions | 指南针控件配置 |
CompassOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| position | mapboxgl.ControlPosition | 控件位置 |
| rotateAble | boolean | 是否可旋转 |
| pitchAble | boolean | 是否可俯仰 |
| className | string | 样式类名 |
MiniMapOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| MiniMapOptions | Object | 鹰眼地图控件配置 |
MiniMapOptions 属性详情
| 属性名 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| layer | string | 瓦片地址 | - |
| width | string | 控件的宽度 | 300px |
| height | string | 控件的高度 | 200px |
| position | string | 控件位置 | top-left, top-right, bottom-left, bottom-right |
| bounds | string | 控件的显示边界 | parent |
| zoomLevels | number | 鹰眼地图与当前地图的zoom差 | 4 |
| lineColor | FeatureColor | 鹰眼控件边界范围的线颜色 | #f17c67 |
| lineWidth | number | 鹰眼控件边界范围的线宽 | 2 |
| lineOpacity | number | 鹰眼控件边界范围的线透明度 | 1 |
| fillColor | FeatureColor | 鹰眼控件边界范围的面颜色 | #eb3f2f |
| fillOpacity | number | 鹰眼控件边界范围的面透明度 | 0.5 |
NavigationOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| NavigationOptions | Object & mapboxgl.NavigationControlOptions | 导航控件配置 |
NavigationOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| position | mapboxgl.ControlPosition | 控件位置 |
GeolocateOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| GeolocateOptions | Object & mapboxgl.GeolocateControlOptions | 定位控件配置 |
GeolocateOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| position | mapboxgl.ControlPosition | 控件位置 |
FullscreenOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| FullscreenOptions | Object & mapboxgl.FullscreenControlOptions | 全屏控件配置 |
FullscreenOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| position | mapboxgl.ControlPosition | 控件位置 |
AttributionOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| AttributionOptions | Object & mapboxgl.AttributionControlOptions | 版权信息控件配置 |
AttributionOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| position | mapboxgl.ControlPosition | 控件位置 |
其他类型
Layer
| 名称 | 类型 | 描述 |
|---|---|---|
| Layer | PolygonLayer | PolylineLayer | 图层类型 |
Overlay
| 名称 | 类型 | 描述 |
|---|---|---|
| Overlay | MarkerOverlay | PopupOverlay | 覆盖物类型 |
Offset
| 名称 | 类型 | 描述 |
|---|---|---|
| Offset | number|PointLike|Partial<Record<Anchor, PointLike>> | 偏移量 |
地图核心类型
Map
| 名称 | 类型 | 描述 |
|---|---|---|
| Map | Object | 地图实例对象 |
Map 方法详情
| 方法名 | 类型 | 描述 |
|---|---|---|
| addLayer | (layer: [Layer](#Layer), beforeId?: string) => string | 添加图层 |
| removeLayer | (id: string) => void | 移除图层 |
| setFilter | (layerId: string, filter: any[]) => void | 设置图层过滤条件 |
| getLayer | (id: string) => [Layer](#Layer)| undefined | 获取图层 |
| load | (style: Style| string) => Promise<void> | 加载地图样式 |
| loadURL | (url: string) => Promise<void> | 从URL加载地图样式 |
| loadJSON | (json: Style) => Promise<void> | 加载JSON格式的地图样式 |
| queryRenderedFeatures | (geometry?: [Geometry](#Geometry), options?: [QueryOptions](#QueryOptions)) => [Feature](#Feature)[] | 查询渲染的要素 |
| querySourceFeatures | (sourceId: string, options?: [QuerySourceFeaturesOptions](#QuerySourceFeaturesOptions)) => [Feature](#Feature)[] | 查询源数据要素 |
| setCenter | (center: LngLatLike) => Map | 设置地图中心点 |
| getCenter | () => LngLat | 获取地图中心点 |
| setZoom | (zoom: number) => Map | 设置地图缩放级别 |
| getZoom | () => number | 获取地图缩放级别 |
| setPitch | (pitch: number) => Map | 设置地图俯仰角 |
| getPitch | () => number | 获取地图俯仰角 |
| setBearing | (bearing: number) => Map | 设置地图旋转角 |
| getBearing | () => number | 获取地图旋转角 |
| fitBounds | (bounds: LngLatBoundsLike, options?: [FitBoundsOptions](#FitBoundsOptions)) => [Map](#Map) | 调整地图视野以适应边界 |
| panTo | (lnglat: LngLatLike, options?: [PanOptions](#PanOptions)) => [Map](#Map) | 平移地图到指定位置 |
| zoomTo | (zoom: number, options?: [ZoomOptions](#ZoomOptions)) => [Map](#Map) | 缩放地图到指定级别 |
Style
| 名称 | 类型 | 描述 |
|---|---|---|
| Style | Object | 地图样式对象 |
Style 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| version | number | 样式版本 |
| name | string | 样式名称 |
| sources | Record<string, [Source](#Source)> | 数据源集合 |
| layers | [Layer](#Layer)[] | 图层数组 |
| center | [number, number] | 地图中心点 |
| zoom | number | 地图缩放级别 |
| pitch | number | 地图俯仰角 |
| bearing | number | 地图旋转角 |
| terrain | TerrainOptions | 地形配置 |
| fog | FogOptions | 雾效配置 |
| light | LightOptions | 光照配置 |
Source
| 名称 | 类型 | 描述 |
|---|---|---|
| Source | GeoJSONSource | VectorSource | RasterSource | RasterDemSource | 数据源基类 |
GeoJSONSource
| 名称 | 类型 | 描述 |
|---|---|---|
| GeoJSONSource | Object | GeoJSON数据源 |
GeoJSONSource 属性详情
- type:
'geojson'- 数据源类型 - data:
GeoJSON.FeatureCollection|string- GeoJSON数据或URL - cluster:
boolean- 是否聚合 - clusterRadius:
number- 聚合半径 - clusterMaxZoom:
number- 聚合最大缩放级别 - clusterMinPoints:
number- 最小聚合点数 - generateId:
boolean- 是否生成要素ID
VectorSource
| 名称 | 类型 | 描述 |
|---|---|---|
| VectorSource | Object | 矢量数据源 |
VectorSource 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | 'vector' | 数据源类型 |
| tiles | string[] | 瓦片URL数组 |
| minzoom | number | 最小缩放级别 |
| maxzoom | number | 最大缩放级别 |
| attribution | string | 版权信息 |
RasterSource
| 名称 | 类型 | 描述 |
|---|---|---|
| RasterSource | Object | 栅格数据源 |
RasterSource 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | 'raster' | 数据源类型 |
| tiles | string[] | 瓦片URL数组 |
| minzoom | number | 最小缩放级别 |
| maxzoom | number | 最大缩放级别 |
| tileSize | number | 瓦片大小 |
| attribution | string | 版权信息 |
RasterDemSource
| 名称 | 类型 | 描述 |
|---|---|---|
| RasterDemSource | Object | 栅格DEM数据源 |
RasterDemSource 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | 'raster-dem' | 数据源类型 |
| tiles | string[] | 瓦片URL数组 |
| minzoom | number | 最小缩放级别 |
| maxzoom | number | 最大缩放级别 |
| tileSize | number | 瓦片大小 |
| attribution | string | 版权信息 |
坐标转换类型
LngLat
| 名称 | 类型 | 描述 |
|---|---|---|
| LngLat | Object | 经纬度坐标 |
LngLat 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| lng | number | 经度 |
| lat | number | 纬度 |
LngLat 方法详情
| 方法名 | 类型 | 描述 |
|---|---|---|
| distanceTo | (lnglat: LngLatLike) => number | 计算到另一个坐标的距离(米) |
| wrap | () => LngLat | 将经度包装到[-180, 180)范围 |
| toArray | () => [number, number] | 转换为数组 |
| toString | () => string | 转换为字符串 |
LngLatBounds
| 名称 | 类型 | 描述 |
|---|---|---|
| LngLatBounds | Object | 经纬度边界 |
LngLatBounds 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| southwest | LngLat | 西南角坐标 |
| northeast | LngLat | 东北角坐标 |
LngLatBounds 方法详情
| 方法名 | 类型 | 描述 |
|---|---|---|
| contains | (lnglat: LngLatLike) => boolean | 判断坐标是否在边界内 |
| getCenter | () => LngLat | 获取边界中心点 |
| getSouthWest | () => LngLat | 获取西南角坐标 |
| getNorthEast | () => LngLat | 获取东北角坐标 |
| toArray | () => [number, number, number, number] | 转换为数组 |
Point
| 名称 | 类型 | 描述 |
|---|---|---|
| Point | Object | 屏幕坐标 |
Point 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| x | number | X坐标 |
| y | number | Y坐标 |
Point 方法详情
| 方法名 | 类型 | 描述 |
|---|---|---|
| distanceTo | (point: PointLike) => number | 计算到另一个点的距离 |
| toArray | () => [number, number] | 转换为数组 |
查询参数类型
QueryOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| QueryOptions | Object | 查询渲染要素参数 |
QueryOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| layers | string[] | 要查询的图层ID数组 |
| filter | any[] | 查询过滤条件 |
| validate | boolean | 是否验证要素几何 |
QuerySourceFeaturesOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| QuerySourceFeaturesOptions | Object | 查询源数据要素参数 |
QuerySourceFeaturesOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| sourceLayer | string | 源图层名称 |
| filter | any[] | 查询过滤条件 |
| geometry | Geometry | 几何范围 |
环境配置类型
TerrainOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| TerrainOptions | Object | 地形配置 |
TerrainOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| source | string | 地形数据源ID |
| exaggeration | number | 地形夸张程度 |
| displacement | number | 地形位移 |
| mask | Geometry | 地形蒙版 |
FogOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| FogOptions | Object | 雾效配置 |
FogOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| color | string | 雾颜色 |
| range | [number, number] | 雾范围 |
| exponent | number | 雾指数 |
| horizonBlend | number | 地平线混合度 |
LightOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| LightOptions | Object | 光照配置 |
LightOptions 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| color | string | 光颜色 |
| intensity | number | 光强度 |
| position | [number, number, number] | 光源位置 |
| direction | [number, number, number] | 光方向 |
| ambient | number | 环境光强度 |
地图事件类型
MapEvent
| 名称 | 类型 | 描述 |
|---|---|---|
| MapEvent | Object | 地图事件对象 |
MapEvent 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | string | 事件类型 |
| target | Map | 事件目标 |
| originalEvent | Event | 原始DOM事件 |
| point | Point | 事件发生的屏幕坐标 |
| lngLat | LngLat | 事件发生的经纬度坐标 |
| features | Feature[] | 与事件相关的要素数组 |
| layer | Layer | 与事件相关的图层 |
MapEventType
| 名称 | 类型 | 描述 |
|---|---|---|
| MapEventType | string | 地图事件类型枚举 |
MapEventType 可选值
| 值 | 描述 |
|---|---|
load | 地图加载完成 |
style.load | 地图样式加载完成 |
error | 地图加载错误 |
click | 鼠标点击 |
dblclick | 鼠标双击 |
mousedown | 鼠标按下 |
mouseup | 鼠标释放 |
mousemove | 鼠标移动 |
mouseenter | 鼠标进入 |
mouseleave | 鼠标离开 |
contextmenu | 右键菜单 |
wheel | 鼠标滚轮 |
touchstart | 触摸开始 |
touchmove | 触摸移动 |
touchend | 触摸结束 |
resize | 地图大小改变 |
move | 地图移动 |
moveend | 地图移动结束 |
zoom | 地图缩放 |
zoomend | 地图缩放结束 |
pitch | 地图俯仰角改变 |
pitchend | 地图俯仰角改变结束 |
rotate | 地图旋转 |
rotateend | 地图旋转结束 |
图层样式类型
LayerStyle
| 名称 | 类型 | 描述 |
|---|---|---|
| LayerStyle | Object | 图层样式基类 |
LayerStyle 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| id | string | 图层ID |
| type | string | 图层类型 |
| source | string | 数据源ID |
| sourceLayer | string | 源图层名称 |
| minzoom | number | 最小缩放级别 |
| maxzoom | number | 最大缩放级别 |
| filter | any[] | 过滤条件 |
| layout | Object | 布局属性 |
| paint | Object | 绘制属性 |
PolygonLayerStyle
| 名称 | 类型 | 描述 |
|---|---|---|
| PolygonLayerStyle | Object & LayerStyle | 多边形图层样式 |
PolygonLayerStyle 特有属性
| 属性名 | 类型 | 描述 |
|---|---|---|
| fillColor | FeatureColor | 填充颜色 |
| fillOpacity | number | 填充透明度 |
| fillOutlineColor | FeatureColor | 轮廓颜色 |
| fillPattern | string | 填充图案 |
PolylineLayerStyle
| 名称 | 类型 | 描述 |
|---|---|---|
| PolylineLayerStyle | Object & LayerStyle | 折线图层样式 |
PolylineLayerStyle 特有属性
| 属性名 | 类型 | 描述 |
|---|---|---|
| lineColor | FeatureColor | 线颜色 |
| lineOpacity | number | 线透明度 |
| lineWidth | number | 线宽度 |
| lineJoin | string | 线连接方式 |
| lineCap | string | 线端点样式 |
| lineDasharray | string | 虚线样式 |
| linePattern | string | 线图案 |
几何类型
Geometry
| 名称 | 类型 | 描述 |
|---|---|---|
| Geometry | PointGeometry|LineStringGeometry|PolygonGeometry|MultiPointGeometry|MultiLineStringGeometry|MultiPolygonGeometry|GeometryCollection | 几何类型基类 |
PointGeometry
| 名称 | 类型 | 描述 |
|---|---|---|
| PointGeometry | Object | 点几何 |
PointGeometry 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | 'Point' | 几何类型 |
| coordinates | [number, number] | 坐标 |
| bbox | [number, number, number, number] | 边界框 |
LineStringGeometry
| 名称 | 类型 | 描述 |
|---|---|---|
| LineStringGeometry | Object | 线几何 |
LineStringGeometry 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | 'LineString' | 几何类型 |
| coordinates | [number, number][] | 坐标数组 |
| bbox | [number, number, number, number] | 边界框 |
PolygonGeometry
| 名称 | 类型 | 描述 |
|---|---|---|
| PolygonGeometry | Object | 面几何 |
PolygonGeometry 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | 'Polygon' | 几何类型 |
| coordinates | [[number, number][]] | 坐标数组 |
| bbox | [number, number, number, number] | 边界框 |
动画配置类型
AnimationOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| AnimationOptions | Object | 动画配置 |
AnimationOptions 属性详情
| 属性名 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| duration | number | 动画持续时间(毫秒) | 300 |
| easing | (t: number) => number | 缓动函数 | t => t |
| offset | Offset | 动画偏移量 | 0 |
| animate | boolean | 是否启用动画 | true |
高级地图类型
MapDataAdapter
| 名称 | 类型 | 描述 |
|---|---|---|
| MapDataAdapter | Object | 地图数据适配器 |
MapDataAdapter 方法详情
| 方法名 | 类型 | 描述 |
|---|---|---|
| getData | (params: any) => Promise<[GeoJSON.FeatureCollection](#GeoJSONFeatureCollection)> | 获取数据 |
| updateData | (data: [GeoJSON.FeatureCollection](#GeoJSONFeatureCollection)) => void | 更新数据 |
| clearData | () => void | 清除数据 |
| getFeatureById | (id: string) => [Feature](#Feature) | undefined | 根据ID获取要素 |
| updateFeature | (feature: [Feature](#Feature)) => void | 更新要素 |
| removeFeature | (id: string) => void | 删除要素 |
MapAnalysis
| 名称 | 类型 | 描述 |
|---|---|---|
| MapAnalysis | Object | 地图分析工具 |
MapAnalysis 方法详情
| 方法名 | 类型 | 描述 |
|---|---|---|
| buffer | (geometry: [Geometry](#Geometry), radius: number) => [Geometry](#Geometry) | 缓冲区分析 |
| intersect | (geometry1: [Geometry](#Geometry), geometry2: [Geometry](#Geometry)) => [Geometry](#Geometry) | 相交分析 |
| union | (geometry1: [Geometry](#Geometry), geometry2: [Geometry](#Geometry)) => [Geometry](#Geometry) | 合并分析 |
| difference | (geometry1: [Geometry](#Geometry), geometry2: [Geometry](#Geometry)) => [Geometry](#Geometry) | 差异分析 |
| contains | (geometry1: [Geometry](#Geometry), geometry2: [Geometry](#Geometry)) => boolean | 包含分析 |
| distance | (geometry1: [Geometry](#Geometry), geometry2: [Geometry](#Geometry)) => number | 距离计算 |
| area | (geometry: [Geometry](#Geometry)) => number | 面积计算 |
| length | (geometry: [Geometry](#Geometry)) => number | 长度计算 |
MapLayerManager
| 名称 | 类型 | 描述 |
|---|---|---|
| MapLayerManager | Object | 图层管理器 |
MapLayerManager 方法详情
| 方法名 | 类型 | 描述 |
|---|---|---|
| addLayer | (layer: [Layer](#Layer), options?: {beforeId?: string}) => string | 添加图层 |
| removeLayer | (id: string) => void | 移除图层 |
| getLayer | (id: string) => [Layer](#Layer) | undefined | 获取图层 |
| updateLayer | (id: string, update: Partial<[Layer](#Layer)>) => void | 更新图层 |
| setLayerVisibility | (id: string, visible: boolean) => void | 设置图层可见性 |
| getLayerVisibility | (id: string) => boolean | 获取图层可见性 |
| setLayerStyle | (id: string, style: Object) => void | 设置图层样式 |
| getLayerStyle | (id: string) => Object | 获取图层样式 |
| getAllLayers | () => [Layer](#Layer)[] | 获取所有图层 |
| getLayersByType | (type: string) => [Layer](#Layer)[] | 按类型获取图层 |
MapUtil
| 名称 | 类型 | 描述 |
|---|---|---|
| MapUtil | Object | 地图工具类 |
MapUtil 静态方法详情
| 方法名 | 类型 | 描述 |
|---|---|---|
| transform | (point: [Point](#Point), from: string, to: string) => [Point](#Point) | 坐标转换 |
| project | (lnglat: LngLatLike) => [Point](#Point) | 经纬度转屏幕坐标 |
| unproject | (point: PointLike) => [LngLat](#LngLat) | 屏幕坐标转经纬度 |
| wrapLng | (lng: number) => number | 经度包装到[-180, 180) |
| formatNumber | (num: number, precision?: number) => string | 数字格式化 |
| distanceFormat | (distance: number) => string | 距离格式化 |
| isPointInPolygon | (point: PointLike, polygon: [Geometry](#Geometry)) => boolean | 判断点是否在多边形内 |
| generateUUID | () => string | 生成UUID |
完善现有类型定义
扩展 Geometry 类型
MultiPointGeometry
| 名称 | 类型 | 描述 |
|---|---|---|
| MultiPointGeometry | Object | 多点几何 |
MultiPointGeometry 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | 'MultiPoint' | 几何类型 |
| coordinates | [number, number][] | 坐标数组 |
| bbox | [number, number, number, number] | 边界框 |
MultiLineStringGeometry
| 名称 | 类型 | 描述 |
|---|---|---|
| MultiLineStringGeometry | Object | 多线几何 |
MultiLineStringGeometry 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | 'MultiLineString' | 几何类型 |
| coordinates | [[number, number][]] | 坐标数组 |
| bbox | [number, number, number, number] | 边界框 |
MultiPolygonGeometry
| 名称 | 类型 | 描述 |
|---|---|---|
| MultiPolygonGeometry | Object | 多面几何 |
MultiPolygonGeometry 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | 'MultiPolygon' | 几何类型 |
| coordinates | [[[number, number][]]] | 坐标数组 |
| bbox | [number, number, number, number] | 边界框 |
GeometryCollection
| 名称 | 类型 | 描述 |
|---|---|---|
| GeometryCollection | Object | 几何集合 |
GeometryCollection 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | 'GeometryCollection' | 几何类型 |
| geometries | Geometry[] | 几何数组 |
| bbox | [number, number, number, number] | 边界框 |
扩展 Layer 类型
CircleLayer
| 名称 | 类型 | 描述 |
|---|---|---|
| CircleLayer | Object | 圆形图层 |
CircleLayer 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| id | string | 图层ID |
| type | 'circle' | 图层类型 |
| source | string | 数据源ID |
| sourceLayer | string | 源图层名称 |
| minzoom | number | 最小缩放级别 |
| maxzoom | number | 最大缩放级别 |
| filter | any[] | 过滤条件 |
| layout | Object | 布局属性 |
| paint | Object | 绘制属性 |
SymbolLayer
| 名称 | 类型 | 描述 |
|---|---|---|
| SymbolLayer | Object | 符号图层 |
SymbolLayer 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| id | string | 图层ID |
| type | 'symbol' | 图层类型 |
| source | string | 数据源ID |
| sourceLayer | string | 源图层名称 |
| minzoom | number | 最小缩放级别 |
| maxzoom | number | 最大缩放级别 |
| filter | any[] | 过滤条件 |
| layout | Object | 布局属性 |
| paint | Object | 绘制属性 |
HeatmapLayer
| 名称 | 类型 | 描述 |
|---|---|---|
| HeatmapLayer | Object | 热力图图层 |
HeatmapLayer 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| id | string | 图层ID |
| type | 'heatmap' | 图层类型 |
| source | string | 数据源ID |
| sourceLayer | string | 源图层名称 |
| minzoom | number | 最小缩放级别 |
| maxzoom | number | 最大缩放级别 |
| filter | any[] | 过滤条件 |
| layout | Object | 布局属性 |
| paint | Object | 绘制属性 |
扩展控制选项类型
FitBoundsOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| FitBoundsOptions | Object | 调整视野选项 |
FitBoundsOptions 属性详情
| 属性名 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| padding | number | Object | 内边距 | 0 |
| maxZoom | number | 最大缩放级别 | - |
| duration | number | 动画持续时间 | 300 |
| easing | (t: number) => number | 缓动函数 | t => t |
PanOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| PanOptions | Object | 平移选项 |
PanOptions 属性详情
| 属性名 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| duration | number | 动画持续时间 | 300 |
| easing | (t: number) => number | 缓动函数 | t => t |
| offset | Offset | 偏移量 | 0 |
ZoomOptions
| 名称 | 类型 | 描述 |
|---|---|---|
| ZoomOptions | Object | 缩放选项 |
ZoomOptions 属性详情
| 属性名 | 类型 | 描述 | 默认值 |
|---|---|---|---|
| duration | number | 动画持续时间 | 300 |
| easing | (t: number) => number | 缓动函数 | t => t |
| around | LngLatLike | PointLike | 缩放中心点 | - |
其他类型
Anchor
| 名称 | 类型 | 描述 |
|---|---|---|
| Anchor | string | 锚点位置 |
Anchor 可选值
| 值 | 描述 |
|---|---|
center | 中心 |
top | 顶部 |
bottom | 底部 |
left | 左侧 |
right | 右侧 |
top-left | 左上角 |
top-right | 右上角 |
bottom-left | 左下角 |
bottom-right | 右下角 |
GeoJSON.FeatureCollection
| 名称 | 类型 | 描述 |
|---|---|---|
| GeoJSON.FeatureCollection | Object | GeoJSON要素集合 |
GeoJSON.FeatureCollection 属性详情
| 属性名 | 类型 | 描述 |
|---|---|---|
| type | string | 类型,固定为FeatureCollection |
| features | Array<[Feature](#Feature)> | 要素数组 |
| bbox | [number, number, number, number]|[number, number, number, number, number, number] | 边界框 |