@welldot/render 0.4.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -0
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +3 -2
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,7 +1,27 @@
|
|
|
1
1
|
# @welldot/render
|
|
2
2
|
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
3
5
|
D3-based SVG renderer for `.well` geological well profiles. Part of the [welldot](https://github.com/rafaeelneto/welldot) open-source ecosystem.
|
|
4
6
|
|
|
7
|
+
`WellRenderer` draws a well's lithology column, construction (borehole, casings, screens, hole fills, centralizers, cement pad), the current pump, fractures, caves and labels into one or more SVG panels, with zoom, pan and tooltips. This README covers installation, a quick start, what each layer draws, the API, theming and the data format the renderer accepts.
|
|
8
|
+
|
|
9
|
+
## Table of contents
|
|
10
|
+
|
|
11
|
+
- [Install](#install)
|
|
12
|
+
- [Quick start](#quick-start)
|
|
13
|
+
- [What it renders](#what-it-renders)
|
|
14
|
+
- [API](#api)
|
|
15
|
+
- [`WellRenderer`](#wellrenderer)
|
|
16
|
+
- [`drawWellLegend`](#drawwelllegend)
|
|
17
|
+
- [`getWellLegendItems` / `drawWellLegendSymbol`](#getwelllegenditems--drawwelllegendsymbol)
|
|
18
|
+
- [Config presets](#config-presets)
|
|
19
|
+
- [Format utilities](#format-utilities)
|
|
20
|
+
- [Locale](#locale)
|
|
21
|
+
- [Theming](#theming)
|
|
22
|
+
- [Data format](#data-format)
|
|
23
|
+
- [License](#license)
|
|
24
|
+
|
|
5
25
|
## Install
|
|
6
26
|
|
|
7
27
|
```bash
|
package/dist/index.cjs
CHANGED
|
@@ -3529,7 +3529,7 @@ var WellRenderer = class {
|
|
|
3529
3529
|
this.clear();
|
|
3530
3530
|
return;
|
|
3531
3531
|
}
|
|
3532
|
-
if (profile.version !== 2) {
|
|
3532
|
+
if ((0, import_core4.parseFormatVersion)(profile.version)?.major !== 2) {
|
|
3533
3533
|
console.warn(
|
|
3534
3534
|
`[WellRenderer] Received a .well file with version ${profile.version ?? "unknown"}. Only v2 is supported. Normalize with deserializeWell() from @welldot/core before rendering.`
|
|
3535
3535
|
);
|