# 3dmol 中文文档

规范地址：https://npmcn.com/package/3dmol/

版本：2\.5\.5
npm 元数据更新时间：2026-05-22T18:44:40.200Z
中文译文更新时间：2026-11-05T17:28:15.784Z
软件包许可：BSD-3-Clause

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

原始 npm 页面：https://www.npmjs.com/package/3dmol
原文对照：https://npmcn.com/package/3dmol/?lang=original
项目主页：http://3dmol.org/
源码仓库：https://github.com/3dmol/3Dmol.js

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

- 包体积（解压后）：20.7 MB，494 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.16\.0
- 运行依赖：4 个
- 首次发布：2016-12-11T18:47:28.385Z
- 最新版本发布：2026-05-22T18:44:40.105Z
- 近 30 天下载量：353200（2026-10-04 至 2026-11-02，npm 官方下载统计）
- 已发布版本数：51（近 12 个月 2 个）

## 中文简介

JavaScript/ TypeScript 分子可视化库

## 安装

```sh
npm install 3dmol
```

也可以使用：`pnpm add 3dmol`、`yarn add 3dmol`、`bun add 3dmol`

## README

# 3Dmol.js (英语)

[![CDNJS](https://img.shields.io/cdnjs/v/3Dmol.svg)](https://cdnjs.com/libraries/3Dmol) [![codecov](https://codecov.io/gh/3dmol/3Dmol.js/branch/master/graph/badge.svg)](https://codecov.io/gh/3dmol/3Dmol.js) [![Github CI](https://github.com/3dmol/3Dmol.js/actions/workflows/CI.yml/badge.svg)](https://github.com/3dmol/3Dmol.js/actions)

3Dmol.js是一个面向对象,WebGL加速JavaScript库,用于在线分子可视化.

由于3Dmol.js根据允许的BSD开源许可证获得许可,只要代码得到正确承认,任何项目都可以自由使用 [引用](http://dx.doi.org/10.1093/bioinformatics/btu829)。 。 。 .

有了3Dmol.js,你就可以在你的网络应用中加入精致地制作的分子可视化. 特征包括:

-   支持 pdb, sdf, mol2, xyz, cif, cdjson, mmtf, prmtop, group, pqr, cube, 和 vasp 格式
-   平行分子表面计算
-   球体、棍子、线条、交叉、卡通和表面样式
-   基于原子属性的选择和样式
-   标签
-   可点击分子数据的交互性
-   包括球和箭在内的几何形状

见 [文档](https://3dmol.org/doc/index.html) 学习如何使用 3Dmol.js 作为一种 [主机查看器](https://3dmol.org/doc/tutorial-url.html), (中文(简体) ), [嵌入式查看器](https://3dmol.org/doc/tutorial-embeddable.html),或作为较大应用程序的组成部分.

## 实例

### [HTML 语言](https://3dmol.org/doc/tutorial-embeddable.html)

![](https://npmcn.com/package/3dmol/examples/embed.png)

```html
<script src="https://3Dmol.org/build/3Dmol-min.js"></script>     
 
 <div style="width: 400px; height: 400px;" 
        class='viewer_3Dmoljs' data-pdb='4N8T' data-style='cartoon:color=spectrum'
        data-surface='opacity:.7;color:white'></div>
```

#### Java 脚本

我们支持同时使用 PDB 查询和 PDB 文件 .

![Alt Text](https://npmcn.com/package/3dmol/examples/example1.png)

首先你只是用div的ID来创建取景器.

```javascript
var viewer = $3Dmol.createViewer($("#div"));
```

然后可以下载蛋白质数据库模型(这里的pdb:1MO8),并用选择的造型显示.

```javascript
$3Dmol.download("pdb:1MO8",viewer,{multimodel:true, frames:true},function(){
    viewer.setStyle({}, {cartoon:{color:"spectrum"}});
    viewer.render();
});

```

#### 表面

我们也支持使用同步加载的表面,支持不同的颜色方案

![Alt Text](https://npmcn.com/package/3dmol/examples/example2.png)

```javascript
viewer.addSurface($3Dmol.SurfaceType.VDW, {
    opacity:0.85,
    voldata: new $3Dmol.VolumeData(volumedata, "cube"),
    volscheme: new $3Dmol.Gradient.ROYGB(range[1],range[0])
},{});
```

#### 形状

支持使用不同的形状和风格.

![Alt Text](https://npmcn.com/package/3dmol/examples/example3.png)

```javascript
viewer.addCylinder({start:{x:0.0,y:2.0,z:0.0},
    end:{x:0.0,y:10.0,z:0.0},
    radius:0.5,
    fromCap:false,
    toCap:true,
    color:'teal'});
viewer.addCylinder({start:{x:15.0,y:0.0,z:0.0},
    end:{x:20.0,y:0.0,z:0.0},
    radius:1.0,
    color:'black',
    fromCap:false,
    toCap:false});
```

## 文档

请检查我们的文档 [3dmol.js (英语)](https://3dmol.org/doc/index.html). 我们有教程, 以及稳定发布平台.

## 联系人

请回答任何问题或关注 [dkoes@pitt.edu (英语)](mailto:dkoes+3dmol@pitt.edu)。 。 。 . 你们也可以 [提交问题](https://github.com/3dmol/3Dmol.js/issues/new/choose) 在 gi上.

## 引用

如果你使用3Dmol.js,请引用我们 [生物信息学论文](http://bioinformatics.oxfordjournals.org/content/31/8/1322)。 。 。 .

## 供资

3DMol.js通过R35GM140753(以及之前来自国家普通医学研究所的R01GM108340)获得资金. 内容完全由作者负责,并不一定代表国家普通医学研究所或国家卫生研究所的官方观点.

## 常见问题

### 3dmol 是什么？

JavaScript/ TypeScript 分子可视化库

### 如何安装 3dmol？

在项目目录运行 npm install 3dmol，或使用 pnpm add / yarn add / bun add。

### 3dmol 支持 TypeScript 吗？

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

### 3dmol 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### 3dmol 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=16\.16\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### 3dmol 可以商用吗？

3dmol 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### 3dmol 的下载量有多少？

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

### 3dmol 还在维护吗？

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

