Skip to content

API 总览

GeoVerse 全部为命名导出,从 geoverse 单一入口引入:

ts
import { GMap, Marker, ClusterLayer /* ... */ } from 'geoverse';
import 'geoverse/style.css';

模块顶层零副作用,可安全用于 SSR;DOM 操作只发生在构造函数/方法内部。

继承约定

GeoVerse 的类大量继承并扩展 OpenLayers 的类。文档中每个类都会标注:

  • 继承 —— 直接基类。基类的全部公开方法(如 ol/MapaddLayerol/FeaturegetGeometry)在子类上原样可用,本文档只详列 GeoVerse 新增/重写的成员;基类成员请查 OpenLayers API
  • 扩展 —— GeoVerse 在基类之上新增的能力。

约定:所有面向使用者的经纬度入参/出参一律为 WGS-84[经度, 纬度]);要素几何内部以视图投影存储,加入 GMap 管理的图层后随底图切换自动重投影。

导出索引

地图容器 · 详情

导出继承职责
GMapol/Map地图容器:内置坐标系、底图切换、要素事件、经纬度便捷方法
InfoWindowol/Overlay信息弹窗,open/close + 经纬度定位
FeaturePointerEventol/events/Event要素级 click/mouseover/mouseout 事件对象
LayerKind / CANCEL_BUBBLE_KEY / CLUSTER_FEATURE_KEY图层种类标记与要素属性键常量
version包版本号字符串

坐标系 · 详情

导出类型职责
registerProjections函数幂等注册 GCJ-02 / BD-09 / EPSG:3395
GCJ02_CODE / BD09_CODE / EPSG3395_CODE常量投影代号
gcj02 / bd09对象WGS-84 ↔ 加偏经纬度互转(纯函数)
sphericalMercator / baiduMercator对象墨卡托正反算
outOfChina函数点是否在国境框外

要素 · 详情

导出继承职责
GFeatureol/Feature要素基类:样式/坐标便捷读写 + onPointer
Marker / Circle / Polygon / PolylineGFeature自带样式的点/圆/面/线要素
Graphicol/Object海量点轻量要素(不逐要素渲染)

瓦片源 · 详情

导出继承职责
GaodeSource / BaiduSource / OceanSourceol/source/XYZ高德 / 百度 / 海图瓦片源
TiandituSourceol/source/XYZ天地图瓦片源(需 token)
SuperMapRestSourceol/source/TileImage超图 iServer REST 瓦片源
getTileGrid / createBaiduUrlFunction函数瓦片网格 / 百度 URL 构造
*_ATTRIBUTION常量各源版权串

图层 · 详情

导出继承职责
createBaseLayer函数按代号创建内置底图(高德/百度/天地图/海图)
GVectorLayerol/layer/Vector通用矢量要素图层
HeatLayerol/layer/Heatmap热力图层
GImageLayerol/layer/Image静态栅格图片图层
MassLayer / MassSourceol/layer/Image / ol/source/ImageCanvas海量点(canvas 批量绘制)
ClusterLayerGVectorLayer距离聚合图层(万级以下)
SuperClusterLayer / SuperClusterSourceGVectorLayer / ol/source/Vectorsupercluster 聚合(十万级)
ClusterStyleResolver聚合分档样式计算器
TrafficLayerol/layer/Tile实时路况图层
CustomBaseLayerol/layer/Tile自定义底图(XYZ/WMS/ArcGIS/超图)
isInPolygon函数射线法点在多边形内判断
BASE_LAYER_TYPE / CLUSTER_ICON_*常量底图标记 / 内置聚合图标

交互 · 详情

导出继承职责
Measure测距 / 测面
DrawTool点/线/面/圆/方/矩形绘制
FeatureEditorol/Object要素顶点编辑
EditorEndEvent / EditorAdjustEventol/events/Event编辑事件对象

控件与轨迹工具 · 详情

导出继承职责
Overviewol/control/OverviewMap鹰眼控件
cloneBaseLayers函数复制底图图层(鹰眼用)
PathSimplifier轨迹回放(动画/跳跃、抽稀渲染)
TrackEventol/events/Event轨迹事件对象
NameLayer experimentalGVectorLayer文字避让标注图层
compressLine / douglasPeucker / ...函数轨迹抽稀纯算法

工具函数 · 详情

导出职责
formatLength / formatArea长度/面积人类可读格式化
isHexColor十六进制颜色判断
runAlongTask帧预算内非阻塞执行
SnowflakeIdGenerator雪花 ID 生成
fitChinaView视图调整为中国全境
stringToDom / domToString / hasClass / addClass / removeClassDOM 辅助