官方文档

Cesium 官方开发文档地址为 官方文档 ，打开文档地址可以看到如下界面。

TIP

官方文档共有 500 多个类，其实常用的在 20 个左右，在后面的 api 示例中，会详细介绍常用的 api。

Cesium 文档并没有像其他文档那样进行模块的详细划分，总的就分为了两个大模块，一是 engine（引擎模块），二是 widgets（部件模块），所以在文档的首页就会看到密密麻麻的类型名称。

文档内容

API 类型大致分为以下几类

接口（Interface）

我们将这种只是定义了一些列规范，但是不能实例化的类型称为接口，接口中定义的属性或方法，在子类中必须实现。

在 gis 平台封装中，我们也沿用了这样的封装思想，例如所有的图层我们提炼出 Layer 接口，所有的覆盖物我们提炼出 Overlay 接口等。

这样保证所有的图层类和覆盖物类都遵循相同的规范，从而保证它们具有相同的行为和属性。

类（Class）

我们将这种前面带有 new 关键字的类型称为实例化类，实例化类一般包含以下内容

• 构造函数

• 使用示例

• 属性

readonly 表示该属性只读，不能修改。

static 表示该属性为静态属性，可以通过类名直接访问。

• 方法

static 表示该方法为静态方法，可以通过类名直接访问。

public 表示该方法为实例方法，可以通过实例访问。

protected 表示该方法为受保护方法，只能在类内部和子类中访问。

private 表示该方法为私有方法，只能在类内部访问。

• 类型定义

此模块一般为构造函数的参数类型定义，在对某些类进行二次封装时可以继承此类型定义。

interface CustomViewer: Cesium.Viewer.ConstructorOptions {
  ...
}

class CustomViewer extends Cesium.Viewer {
  constructor(options: CustomViewerOptions) {
    super(options);
  }
}

枚举（Enum）

我们将这种限定取值范围的类型称为枚举，比如 ClassificationType 类型。

全局方法

我们称这种不属于任何类型（最后挂载到 Cesium 上）的方法为全局方法，比如 createGuid 方法。