# @cesium-extends/common 中文文档

规范地址：https://npmcn.com/package/%40cesium-extends/common/

版本：1\.0\.2
npm 元数据更新时间：2024-11-25T02:13:26.859Z
中文译文更新时间：2026-11-09T19:53:54.367Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cesium-extends/common
原文对照：https://npmcn.com/package/%40cesium-extends/common/?lang=original
项目主页：https://github.com/hongfaqiu/cesium-extends#readme
源码仓库：https://github.com/hongfaqiu/cesium-extends

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：7.1 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：cesium \*
- 首次发布：2023-04-10T02:24:51.534Z
- 最新版本发布：2024-11-25T02:13:26.654Z
- 近 30 天下载量：1767（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

-   `Widget` 是一个基础类,可以扩展为创建自己的部件。 您可以导入到您的工程中: - `DomUtil` 是一种提供一些 DOM 操作方法的功能类. [读取](https://npmcn.com/package/%40cesium-extends/common/README_CN.md)

## 安装

```sh
npm install @cesium-extends/common
```

也可以使用：`pnpm add @cesium-extends/common`、`yarn add @cesium-extends/common`、`bun add @cesium-extends/common`

## README

# @ cesium- extends/ 常见

-   `Widget` 是一个基础类,可以扩展为创建自己的部件。 您可以导入到您的项目中 :
-   `DomUtil` 是一种提供一些 DOM 操作方法的功能类. [读取](https://npmcn.com/package/%40cesium-extends/common/README_CN.md)

## 安装

```bash
npm install --save @cesium-extends/common
```

## 使用量

```javascript
import { Widget, DomUtil } from "@cesium-extends/common";
```

## 部件

`Widget` 是基于铯应用程序的部件的基础类。 它提供了一些常见的部件操作方法和属性.

### API 密码

#### `constructor(viewer: Cesium.Viewer, wrapper: HTMLElement)`

创建新实例 `Widget` 分类并附在指定的铯查看器上.

##### 参数

-   `viewer`: 将部件附加到铯查看器实例.
-   `wrapper`: 将部件挂载到的 DOM 元素.

#### `enabled`

用于控制部件是否启用的布尔属性 .

#### `ready`

显示部件是否准备好的布尔属性 .

#### `setContent(content: string | Element): Widget`

设置部件内容的方法 .

##### 参数

-   `content`: 表示要设置的内容的字符串或 DOM 元素.

#### `hide()`

隐藏部件的方法 .

#### `show()`

显示部件的方法 .

#### `destroy()`

销毁部件的方法 .

## 多穆蒂尔

`DomUtil` 是一种提供一些 DOM 操作方法的功能类.

### API 密码

#### `create(tagName: string, className: string, container: Element | null = null): HTMLElement`

创建带有指定的 HTML 元素 `tagName`,设定其类为 `className`,可选择附加到 `container` 键.

##### 参数

-   `tagName`: 要创建的 HTML 标签名 .
-   `className`: HTML 元素上设置的类名.
-   `container` (可选) : 添加新元素的容器元素 .

#### `parseDom(domStr: string, className: string): HTMLDivElement`

将字符串分解为 DOM 元素并返回包含该元素的 DIV 元素.

##### 参数

-   `domStr`:要解析的字符串.
-   `className`: DIV 元素上要设置的类名.

## 常见问题

### @cesium-extends/common 是什么？

Widget 是一个基础类,可以扩展为创建自己的部件。 您可以导入到您的工程中: - DomUtil 是一种提供一些 DOM 操作方法的功能类\. 读取

### 如何安装 @cesium-extends/common？

在项目目录运行 npm install @cesium-extends/common，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：cesium（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cesium-extends/common 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cesium-extends/common 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cesium-extends/common 可以商用吗？

@cesium-extends/common 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cesium-extends/common 的下载量有多少？

根据 npm 官方下载统计，@cesium-extends/common 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,767 次，日均约 59 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cesium-extends/common 还在维护吗？

最新版本 1\.0\.2 发布于 2024/11/25（2 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/04/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。