外观
API文档引导
如何查阅 API 文档
API 文档是按“类”组织的，查一个功能时按下面顺序看：
- 找类：先确定功能所属的类（地图 =
Map，图层 =*Layer，矢量 =graphic.*，控件 =control.*，分析 =thing.*）。 - 看构造参数 options：类页面顶部的参数表，说明可传入哪些配置项、默认值是什么。
- 看属性 / 方法 / 事件：页面下方按“属性 Methods Events”分节，方法和事件通常带参数说明与示例。
- 对照示例：每个主要类都能在功能示例中找到可运行代码，两边对照最快。
小技巧：文档顶部自带搜索框，直接搜类名或方法名；不确定类名时，先在下方“主要类名及对应示例清单”里按功能找。
API文档
- 在线文档地址：http://mars2d.cn/api/Map.html
- 离线文档下载：下载最新版(v)
主要类名及对应示例清单
地图核心类
| 功能 | 类名 | 功能示例 |
|---|---|---|
| 地图类 | mars2d.Map | 查看 |
基础类
| 功能 | 类名 | 备注 |
|---|---|---|
| 基础类 | mars2d.BaseClass | 所有类的父类，包括事件的处理 |
| 坐标点 | mars2d.PointTrans | 含坐标的转换方法 |
| 集合存储管理类 | mars2d.MarsArray |
静态方法类
| 类名 | 类功能说明 |
|---|---|
| mars2d.PointUtil | 单点坐标计算相关功能 |
| mars2d.PolyUtil | 多点、线面坐标计算相关功能 |
| mars2d.PointTrans | 坐标系转换功能 |
| mars2d.LayerUtil | 图层相关创建、注册、工具功能 |
| mars2d.GraphicUtil | 矢量数据相关创建、注册、工具功能 |
| mars2d.MeasureUtil | 空间量算功能（距离/面积/高度差测量） |
| mars2d.DrawUtil | 标绘编辑点样式设置 |
| mars2d.Util | 通用工具方法，包括不好分类的 |
常量枚举类
| 功能 | 类名 | 备注 |
|---|---|---|
| 坐标系 | mars2d.CRS | |
| 国内坐标系 | mars2d.ChinaCRS | 用于加偏纠偏 |
| 事件类型 | mars2d.EventType | |
| 矢量数据类型 | mars2d.GraphicType | |
| 图层类型 | mars2d.LayerType | |
| 第3方相关Token令牌 | mars2d.Token |
图层
| 功能 | 类名 | 功能示例 |
|---|---|---|
| 图层组 | mars2d.layer.GroupLayer | 配置type:'group'中使用 |
| 栅格瓦片图层 | 见附表(1)瓦片图层 | |
| 矢量图层 | 见附表(2)矢量图层 |
(1)栅格瓦片图层
栅格瓦片图层，大部分都是继承自TileLayer类的子类对象。
| 类型名 | 功能 | 类名 | 功能示例 | 备注 |
|---|---|---|---|---|
| image | 单张图片数据源图层 | mars2d.layer.ImageLayer | 查看 | 通用标准 |
| xyz | XYZ标准瓦片图层 | mars2d.layer.XyzLayer | 查看 | 通用标准 |
| wms | WMS标准服务图层 | mars2d.layer.WmsLayer | 查看 | 通用标准 |
| wmts | WMTS标准服务图层 | mars2d.layer.WmtsLayer | 查看 | 通用标准 |
| arcgis | ArcGIS服务图层 | mars2d.layer.ArcGisLayer | 查看 | 通用标准 |
| arcgis_cache | ArcGIS切片 | mars2d.layer.ArcGisLayer | 查看 | 通用标准 |
| tdt | 天地图在线服务图层 | mars2d.layer.TdtLayer | 查看 | 在线地图 |
| gaode | 高德在线服务图层 | mars2d.layer.GaodeLayer | 查看 | 在线地图 |
| tencent | 腾讯在线服务图层 | mars2d.layer.TencentLayer | 查看 | 在线地图 |
| baidu | 百度在线服务图层 | mars2d.layer.BaiduLayer | 查看 | 在线地图 |
| 谷歌在线服务图层 | mars2d.layer.GoogleLayer | 查看 | 在线地图 | |
| mapbox | Mapbox在线服务图层 | mars2d.layer.MapboxLayer | 查看 | 在线地图 |
(2)矢量图层
| 类型名 | 功能 | 类名 | 功能示例 |
|---|---|---|---|
| graphic | 矢量图层 | mars2d.layer.GraphicLayer | 查看 |
| wfs | WFS标准服务图层 | mars2d.layer.WfsLayer | 查看 |
| arcgis_feature | AraGIS Server WFS矢量服务 | mars2d.layer.ArcGisFeatureLayer | 查看 |
| geojson | GeoJson文件图层 | mars2d.layer.GeoJsonLayer | 查看 |
| geojson_shp | Shapefile(SHP)文件图层 | Shp2JsonLayer.js 独立插件JS | 查看 |
| geojson_kml | KML文件图层 | Kml2JsonLayer.js 独立插件JS | 查看 |
面板控件
| 功能 | 类名 | 功能示例 |
|---|---|---|
| 鼠标单击弹窗 | 查看 | |
| 鼠标移入弹窗 | 查看 | |
| 工具按钮栏 | mars2d.control.ToolBar | 查看 |
| 图层管理 | mars2d.control.layers | 查看 |
| 地图切换按钮 | mars2d.control.MapSwich | 查看 |
| 放大缩小工具栏按钮 | L.control.Zoom | 查看 |
| POI兴趣点搜索按钮 | mars2d.control.ToolButton | 查看 |
| 自定义工具栏按钮 | mars2d.control.ToolButton | 查看 |
| 下侧状态栏 | mars2d.control.LocationBar | 查看 |
| 时钟播放 | \ | 查看 |
| 比例尺 | mars2d.control.scale | 查看 |
| 鹰眼地图 | mars2d.control.OverviewMap | 查看 |
| 鱼骨导航 | mars2d.control.Slider | 查看 |
| 卷帘对比 | mars2d.control.MapSplit | 查看 |
管理或分析
| 功能 | 类名 | 功能示例 |
|---|---|---|
| 管理或分析基类 | mars2d.BaseThing | 基类，继承后子类使用 |
| 图上量算 | mars2d.thing.Measure | 查看 |