外观
API文档引导
API文档
- 在线文档地址：http://mars3d.cn/api/Map.html
- 离线文档下载：下载最新版(v)
使用方式
- 下载离线API文档到本地，并使用VS Code打开，可以全局搜api内的中文、属性、方法等任意字符。
- 下载mars3d.d.ts或查看本地ts描述文件，搜单个文件内的任意字符（需要略微懂ts语法）。
- 在线直接查阅API文档
主要类名及对应示例清单
地图核心类
| 功能 | 类名 | 功能示例 |
|---|---|---|
| 地图类 | mars3d.Map | 查看 |
基础类
| 功能 | 类名 | 备注 |
|---|---|---|
| 基础类 | mars3d.BaseClass | 所有类的父类，包括事件的处理 |
| 坐标点 | mars3d.LngLatPoint | 含坐标的转换方法 |
| 多点转换 | mars3d.LngLatArray | 含坐标数组的转换方法 |
| 集合存储管理类 | mars3d.MarsArray | |
| 颜色色带控制类 | mars3d.ColorRamp |
静态方法类
| 类名 | 类功能说明 |
|---|---|
| mars3d.PointUtil | 单点坐标计算相关功能 |
| mars3d.PolyUtil | 多点、线面坐标计算相关功能 |
| mars3d.PointTrans | 坐标系转换功能 |
| mars3d.LayerUtil | 图层相关创建、注册、工具功能 |
| mars3d.GraphicUtil | 矢量数据相关创建、注册、工具功能 |
| mars3d.MaterialUtil | 材质相关创建、注册、工具功能 |
| mars3d.ControlUtil | 控件相关创建、注册、工具功能 |
| mars3d.EffectUtil | 特效相关创建、注册、工具功能 |
| mars3d.ThingUtil | Thing对象相关创建、注册、工具功能 |
| mars3d.MeasureUtil | 空间量算功能（距离/面积/高度差测量） |
| mars3d.DrawUtil | 标绘编辑点样式设置 |
| mars3d.DomUtil | DOM元素创建、class样式管理等功能 |
| mars3d.Util | 通用工具方法，包括不好分类的 |
常量枚举类
| 功能 | 类名 | 备注 |
|---|---|---|
| 坐标系 | mars3d.CRS | |
| 国内坐标系 | mars3d.ChinaCRS | 用于加偏纠偏 |
| 事件类型 | mars3d.EventType | |
| 标绘编辑点类型 | mars3d.EditPointType | |
| 材质类型 | mars3d.MaterialType | |
| 矢量数据类型 | mars3d.GraphicType | |
| 图层类型 | mars3d.LayerType | |
| 控件类型 | mars3d.ControlType | |
| 特效类型 | mars3d.EffectType | |
| Thing分析管理类 类型 | mars3d.ThingType | |
| 多语言相关文本 | mars3d.Lang | |
| 第3方相关Token令牌 | mars3d.Token |
图层
| 功能 | 类名 | 功能示例 |
|---|---|---|
| 图层基类 | mars3d.layer.BaseLayer | 基类，继承后子类使用 |
| 图层组 | mars3d.layer.GroupLayer | 配置type:'group'中使用 |
| 栅格瓦片图层 | 见附表(1)瓦片图层 | |
| 矢量图层 | 见附表(2)矢量图层 |
(1)栅格瓦片图层
栅格瓦片图层，均是继承自BaseTileLayer类的子类对象。
| 类型名 | 功能 | 类名 | 功能示例 | 备注 |
|---|---|---|---|---|
| image | 单张图片数据源图层 | mars3d.layer.ImageLayer | 查看 | 通用标准 |
| xyz | XYZ标准瓦片图层 | mars3d.layer.XyzLayer | 查看 | 通用标准 |
| tms | TMS标准瓦片图层 | mars3d.layer.TmsLayer | 查看 | 通用标准 |
| wms | WMS标准服务图层 | mars3d.layer.WmsLayer | 查看 | 通用标准 |
| wmts | WMTS标准服务图层 | mars3d.layer.WmtsLayer | 查看 | 通用标准 |
| arcgis | ArcGIS服务图层 | mars3d.layer.ArcGisLayer | 查看 | 通用标准 |
| arcgis_cache | ArcGIS切片 | mars3d.layer.ArcGisLayer | 查看 | 通用标准 |
| tdt | 天地图在线服务图层 | mars3d.layer.TdtLayer | 查看 | 在线地图 |
| gaode | 高德在线服务图层 | mars3d.layer.GaodeLayer | 查看 | 在线地图 |
| tencent | 腾讯在线服务图层 | mars3d.layer.TencentLayer | 查看 | 在线地图 |
| baidu | 百度在线服务图层 | mars3d.layer.BaiduLayer | 查看 | 在线地图 |
| 谷歌在线服务图层 | mars3d.layer.GoogleLayer | 查看 | 在线地图 | |
| bing | 微软Bing在线服务图层 | mars3d.layer.BingLayer | 查看 | 在线地图 |
| mapbox | Mapbox在线服务图层 | mars3d.layer.MapboxLayer | 查看 | 在线地图 |
(2)矢量图层
| 类型名 | 功能 | 类名 | 功能示例 |
|---|---|---|---|
| graphic | 矢量图层 | mars3d.layer.GraphicLayer | 查看 |
| busineData | 业务数据图层 | mars3d.layer.BusineDataLayer | 查看 |
| wfs | WFS标准服务图层 | mars3d.layer.WfsLayer | 查看 |
| arcgis_wfs | ArcGIS Feature Server服务图层 | mars3d.layer.ArcGisWfsLayer | 查看 |
| geojson | GeoJson文件图层 | mars3d.layer.GeoJsonLayer | 查看 |
| czml | CZML文件图层 | mars3d.layer.CzmlLayer | 查看 |
| geojson_shp | Shapefile(SHP)文件图层 | Shp2JsonLayer.js 独立插件JS | 查看 |
| geojson_kml | KML文件图层 | Kml2JsonLayer.js 独立插件JS | 查看 |
| tileset | 3DTiles三维模型图层 | mars3d.layer.TilesetLayer | 查看 |
| i3s | I3S三维模型图层 | mars3d.layer.I3SLayer | 查看 |