开发文档简介

BigMap.cesium · 本仓库

API 开发文档

本页面向在网页中集成三维 Cesium 场景与大地图 BigMap 业务 API的开发者，提供与源码 cesium_API.js 同步的接口说明、参数表与可运行示例。结构编排参考常见「开发指南 / 简介」类文档（如传统 Web 地图 入门指导 的阅读顺序），便于从概览到具体条目逐级深入。

文档能做什么

  • 分类导航：左侧按主题展开（初始化与相机、底图、模型与分层、区域与 AOI、UI、链式辅助等），点击条目即可在右侧查看详情。
  • 签名与参数表：每个 API 含调用签名、形参位置说明及返回值约定，与 BigMap.cesium-API.md 思路一致。
  • 示例代码：详情中的 pre.api-example 可与在线调试页联动，便于复制后本地或沙箱中运行。
  • 在线调试：进入具体 API 后，顶栏会出现「在线调试」，打开 playground.html 并预填对应示例脚本。

外部页面如何引入

cesium_API.js 依赖浏览器中的全局 Cesium。集成时有两种常见方式，任选其一即可（线上可直接使用大地图托管地址，或改为你自己的部署路径）。

方式一：自行外部引入 Cesium — 在页面里先引入官方样式与脚本，再引入 cesium_API.js。示例（与 cesium_API.html、在线调试页一致）： 

<link rel="stylesheet" href="https://cesium.com/downloads/cesiumjs/releases/1.135/Build/Cesium/Widgets/widgets.css" />
<script src="https://cesium.com/downloads/cesiumjs/releases/1.135/Build/Cesium/Cesium.js"></script>
<script src="https://www.daditu.com.cn/page/api/bigMapCesium/cesium_API.js"></script>

采用方式一时，页面实际运行的 Cesium 以你外部写的 link/script 地址为准（建议与内置默认一致，使用 1.135，最低兼容 1.114）。

方式二：只引入 cesium_API.js — 本脚本内置与 Cesium 1.135 对应的官方资源加载逻辑：当页面里还没有全局 Cesium 时，会由脚本自动拉取配套的 Cesium.js 与 widgets.css，因此可以不再手写方式一里的 link/script，只引入 cesium_API.js 即可。若你在引入本脚本之前已在页面中自行引入了 Cesium，则实际使用的 Cesium 版本以你外部引入的为准，脚本会复用已有全局对象而不会按内置地址再装一份。

主要能力概览

场景与相机

初始化 Viewer、飞入指定坐标或区域、与外部 Viewer 挂载等，对应左侧「初始化 / 相机」等分组。

底图与图层

矢量 / 影像 WMTS 加载与清理，统一走 loadMapService 等封装，减少重复样板代码。

模型与分层

GeoJSON 楼栋加载、按楼名分层（loud.fenceng）、CSV 与编辑器相关能力，适合楼宇与规划类业务。

区域与 AOI

多边形挤出、链式 renderAreaBuildings(…).fenceng(…)、URL AOI 分段着色与点击查询等。

链式与 UI

loadModel.show/hide、renderAreaBuildings.show 等挂载在函数对象上的快捷方式，以及 BigMap.ui 弹层注入。

面向读者

适合已掌握 JavaScript 基础、了解异步（Promise）与浏览器环境的开发者。若同时具备 Cesium 或三维地球相关概念，阅读 API 会更快；文档也会在条目中注明与 Cesium 原生行为的差异或前置条件。

如何使用

  1. 在左侧展开感兴趣的大类，点击具体 API 名称。
  2. 右侧主区域切换为「签名 + 说明 + 表格 + 示例」；浏览器地址栏哈希为 #API条目id，可收藏或分享。
  3. 需要动手验证时，点击顶栏「在线调试」进入带预填代码的编辑预览页。
  4. 需要回到本页时，可点击侧栏底部「文档简介」，或去掉地址栏中的 #… 后刷新。

提示：当前未选择左侧条目时，始终显示本简介；选择任意 API 后，主区域会切换为该条目的详细说明窗口。