@equinor/videx-map

中文文档
2.2.4发布于 2026/11/03MITTypeScriptESM + CJS构建来源已验证近 30 天下载 2597

皮克西-在Leaflet的覆盖组件.

中文使用文档
文档目录12 节
  1. 安装
  2. 使用量
  3. 井喷模块
  4. 配置
  5. 外地模块
  6. 配置
  7. 断层模块
  8. GeoJSON 模块
  9. 配置
  10. 大纲模块
  11. 捐款
  12. 快开始

npm version SCM Compliance

Videx 地图

用于可视化井泡相关数据的传单层.

安装

npm install --save @equinor/videx-map

使用量

// ES6
import { WellboreModule, FaultlineModule, FieldModule, GeoJSONModule, OutlineModule } from '@equinor/videx-map';

模块

Videx地图分为各种具有特定目的的模块. 这些模块可以单独使用或合并为单一的WebGL上下文.

井喷模块

负责可视化有根和路径的井口的模块.

配置

  • 缩放 - 一切的相对规模。 (过失:1.0)
  • 标签缩放 - 标签规模。 (过失:0.011)
  • 标签 Bg 距离 - 标签背景不透明。 (过失:0.5)
  • 字体大小 - 字体尺寸。 (过失:18)
  • 批量大小 - 每批井口数量。 (过失:20)
  • 缩放 - 源缩放级别,即缩放函数的输入为0. (过失: 0)
  • 自定义事件汉德勒 - 提供自定义事件处理器.
  • 缩放 - 放大事件处理器.
  • 网格大小 - 网格大小以控制空间索引的分辨率.
  • 恢复状态 - 改变井口的配置.
  • root 响应 - 改变根的配置大小.
  • 井喷 Dash - 井口宽度 (过失:0.01)
  • 勾选 - 对象 { width, height } 沿着井口线的刻痕.
  • 在WellboreClick上 (英语) - 选择井井时需要调用功能.
  • 显示 - 井泡突出时称为功能.
  • 突出显示 - 删除亮点时要调用的函数.
// Example configuration
const wellbores: WellboreModule = new WellboreModule({
  rootRadius: 0.3,
  scale: 1.5,
  labelBgOpacity: 0.2,
  zoomOrigin: 0,
  scaling: zoom => factors[zoom] || 0,
  rootResize: {
    base: 1.75,
    multiplier: 0.5,
    zoomReference: 12.0,
  },
  onHighlightOn: event => {
    // Special 'HighlightOn' logic ...
  },
  onHighlightOff: () => {
    // Special 'HighlightOff' logic ...
  },
  onWellboreClick: wellbore => {
    // Special 'WellboreClick' logic ...
  }
});

外地模块

负责可视化油气田并有填充的多边形,轮廓和标签的模块.

配置

  • 首页 - 场散列模式的初始规模。 (过失:1.0)
  • 分钟 - 最小规模的野外散列模式。 (过失: 0.0)
  • 最大小时 - 最大范围野外散列图案。 (过失:无限)
// Example configuration
const fields: FieldModule = new FieldModule({
  initialHash: 0.5,
  minHash: 0.1,
  maxHash: 2.0,
});

断层模块

负责可视化地上断层的模块.

  • 颜色 - 格式0xRRGGB上的断层颜色。 (默认:0x727D88)
  • 阿尔法 - 阿尔法断层。 (过失:1.0)
  • 大纲 - 宽度的轮廓。 (过失:0.125)
// Example configuration
const faultlines: FaultlineModule = new FaultlineModule({
  color: 0xFF00FF,
  alpha: 0.75,
  outlineWidth: 0.13,
});

GeoJSON 模块

负责可视化任意GeoJSON数据的模块,支持 Point, (中文(简体) ), LineString, (中文(简体) ), Polygon,以及 MultiPolygon 几何类型.

配置

  • 自定义事件汉德勒 - 提供自定义事件处理器.
  • 浮点数 - 当一个特性被徘徊时调用函数 .
  • 大纲回复 - 调整大纲的配置大小.
  • 标签恢复 - 更改标签配置大小.
// Example usage
const geojson: GeoJSONModule = new GeoJSONModule({
  onFeatureHover: (event, data) => {
    // Handle hover ...
  },
});

// Pass a GeoJSON FeatureCollection and an optional props mapper
geojson.set(featureCollection, feature => ({
  id: feature.properties.id,
  label: feature.properties.name,
  style: {
    lineColor: '#FF0000',
    lineWidth: 2,
    fillColor: '#00FF00',
    fillOpacity: 0.5,
  },
}));

大纲模块

负责可视化场面轮廓的模块.

  • 缩放 - 源缩放级别,即缩放函数的输入为0. (过失: 0)
  • 行风 - 线的宽度。 (过失:0.125)
  • 缩放 - 放大事件处理器.
// Example configuration
const outlines: OutlineModule = new OutlineModule({
  zoomOrigin: 12,
  lineWidth: 0.1,
  scaling: zoom => (1.5 ** -zoom),
});

捐款

我们非常感谢对这个存放处的贡献,见我们 贡献页 如何开始.

快开始

$ git clone https://github.com/equinor/videx-map.git
$ npm install
$ npm start

Equinor Logo

版本与发布记录

@equinor/videx-map 共发布 118 个版本,首次发布于 2019/12/04;过去 12 个月发布了 25 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.2.4latest2026/11/0310 天前
2.2.32026/10/2717 天前
2.2.22026/10/2421 天前
2.2.12026/10/2024 天前
2.2.02026/10/131 个月前
2.1.172026/10/061 个月前

关于 @equinor/videx-map 的常见问题

@equinor/videx-map 是什么?

皮克西-在Leaflet的覆盖组件.

如何安装 @equinor/videx-map?

在项目目录运行 npm install @equinor/videx-map,或使用 pnpm add / yarn add / bun add。

@equinor/videx-map 支持 TypeScript 吗?

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

@equinor/videx-map 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@equinor/videx-map 可以商用吗?

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

@equinor/videx-map 的下载量有多少?

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

@equinor/videx-map 还在维护吗?

最新版本 2.2.4 发布于 2026/11/03(10 天前);至今共发布 118 个版本,其中过去 12 个月发布了 25 个;首次发布于 2019/12/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。