@equinor/videx-map 1.12.4 → 1.13.0-beta.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 Equinor
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2019 Equinor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,119 +1,119 @@
-[![npm version](https://badge.fury.io/js/%40equinor%2Fvidex-map.svg)](https://badge.fury.io/js/%40equinor%2Fvidex-map)
-![](https://github.com/equinor/videx-map/workflows/Unit%20test/badge.svg)
-
-# Videx map
-
-A leaflet layer for visualizing wellbore related data.
-
-- [GitHub Repository](https://github.com/equinor/videx-map)
-- [Documentation](https://equinor.github.io/videx-map/)
-
-## Installation
-```
-npm install --save @equinor/videx-map
-```
-
-## Usage
-```js
-// ES6
-import { WellboreModule, FaultlineModule, ...  } from '@equinor/videx-map';
-```
-
-<br/>
-
-# Modules
-Videx map is divided into various modules with specific purposes. These modules can be used individually or combined into a single WebGL context.
-
-## Wellbore Module
-Module responsible for visualizing wellbores with roots and paths.
-
-### Configurations
-
-- <b>scale</b> - Relative scale of everything. (Default: 1.0)
-- <b>wellboreWidth</b> - Width of wellbore. (Default: 0.15)
-- <b>rootRadius</b> - Width of root. (Default: 0.4)
-- <b>labelScale</b> - Scale of labels. (Default: 0.011)
-- <b>labelBgOpacity</b> - Opacity of label background. (Default: 0.5)
-- <b>fontSize</b> - Size of font. (Default: 24)
-- <b>batchSize</b> - Amount of wellbores per batch. (Default: 25)
-- <b>zoomOrigin</b> - Origin zoom level, i.e. where input for scaling function is 0. (Default: 0)
-- <b>customEventHandler</b> - Provide your custom event handler.
-- <b>scaling</b> - Zoom event handler.
-- <b>gridSize</b> - Grid size to control resolution of spatial indexing.
-- <b>rootResize</b> - Resize configurations of roots.
-- <b>onWellboreClick</b> - Function to be called when a wellbore is selected.
-- <b>onHighlightOn</b> - Function to be called when wellbores are highlighted.
-- <b>onHighlightOff</b> - Function to be called when highlight is removed.
-
-```js
-// 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 ...
-  }
-});
-```
-
-## Faultline Module
-Module responsible for visualizing faultlines on fields.
-
-- <b>color</b> - Color of faultline on format 0xRRGGBB. (Default: 0x727D88)
-- <b>alpha</b> - Alpha of faultlines. (Default: 1.0)
-- <b>outlineWidth</b> - Width of outline. (Default: 0.125)
-
-```js
-// Example configuration
-const faultlines: FaultlineModule = new FaultlineModule({
-  color: 0xFF00FF,
-  alpha: 0.75,
-  outlineWidth: 0.13,
-});
-```
-
-## Outline Module
-Module responsible for visualizing field outlines.
-
-- <b>zoomOrigin</b> - Origin zoom level, i.e. where input for scaling function is 0. (Default: 0)
-- <b>lineWidth</b> - Width of line. (Default: 0.125)
-- <b>scaling</b> - Zoom event handler.
-
-```js
-// Example configuration
-const outlines: OutlineModule = new OutlineModule({
-  zoomOrigin: 12,
-  lineWidth: 0.1,
-  scaling: zoom => (1.5 ** -zoom),
-});
-```
-
-<br/>
-
-## Contribution
-We greatly appreciate contributions to this repository, see our [contribution page](CONTRIBUTION.md) on how to get started.
-
-### Quick start
-```
-$ git clone https://github.com/equinor/videx-map.git
-$ npm install
-$ npm start
-```
-
-
-
-![Equinor Logo](images/equinor-logo.png)
+[![npm version](https://badge.fury.io/js/%40equinor%2Fvidex-map.svg)](https://badge.fury.io/js/%40equinor%2Fvidex-map)
+![](https://github.com/equinor/videx-map/workflows/Unit%20test/badge.svg)
+
+# Videx map
+
+A leaflet layer for visualizing wellbore related data.
+
+- [GitHub Repository](https://github.com/equinor/videx-map)
+- [Documentation](https://equinor.github.io/videx-map/)
+
+## Installation
+```
+npm install --save @equinor/videx-map
+```
+
+## Usage
+```js
+// ES6
+import { WellboreModule, FaultlineModule, ...  } from '@equinor/videx-map';
+```
+
+<br/>
+
+# Modules
+Videx map is divided into various modules with specific purposes. These modules can be used individually or combined into a single WebGL context.
+
+## Wellbore Module
+Module responsible for visualizing wellbores with roots and paths.
+
+### Configurations
+
+- <b>scale</b> - Relative scale of everything. (Default: 1.0)
+- <b>wellboreWidth</b> - Width of wellbore. (Default: 0.15)
+- <b>rootRadius</b> - Width of root. (Default: 0.4)
+- <b>labelScale</b> - Scale of labels. (Default: 0.011)
+- <b>labelBgOpacity</b> - Opacity of label background. (Default: 0.5)
+- <b>fontSize</b> - Size of font. (Default: 24)
+- <b>batchSize</b> - Amount of wellbores per batch. (Default: 25)
+- <b>zoomOrigin</b> - Origin zoom level, i.e. where input for scaling function is 0. (Default: 0)
+- <b>customEventHandler</b> - Provide your custom event handler.
+- <b>scaling</b> - Zoom event handler.
+- <b>gridSize</b> - Grid size to control resolution of spatial indexing.
+- <b>rootResize</b> - Resize configurations of roots.
+- <b>onWellboreClick</b> - Function to be called when a wellbore is selected.
+- <b>onHighlightOn</b> - Function to be called when wellbores are highlighted.
+- <b>onHighlightOff</b> - Function to be called when highlight is removed.
+
+```js
+// 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 ...
+  }
+});
+```
+
+## Faultline Module
+Module responsible for visualizing faultlines on fields.
+
+- <b>color</b> - Color of faultline on format 0xRRGGBB. (Default: 0x727D88)
+- <b>alpha</b> - Alpha of faultlines. (Default: 1.0)
+- <b>outlineWidth</b> - Width of outline. (Default: 0.125)
+
+```js
+// Example configuration
+const faultlines: FaultlineModule = new FaultlineModule({
+  color: 0xFF00FF,
+  alpha: 0.75,
+  outlineWidth: 0.13,
+});
+```
+
+## Outline Module
+Module responsible for visualizing field outlines.
+
+- <b>zoomOrigin</b> - Origin zoom level, i.e. where input for scaling function is 0. (Default: 0)
+- <b>lineWidth</b> - Width of line. (Default: 0.125)
+- <b>scaling</b> - Zoom event handler.
+
+```js
+// Example configuration
+const outlines: OutlineModule = new OutlineModule({
+  zoomOrigin: 12,
+  lineWidth: 0.1,
+  scaling: zoom => (1.5 ** -zoom),
+});
+```
+
+<br/>
+
+## Contribution
+We greatly appreciate contributions to this repository, see our [contribution page](CONTRIBUTION.md) on how to get started.
+
+### Quick start
+```
+$ git clone https://github.com/equinor/videx-map.git
+$ npm install
+$ npm start
+```
+
+
+
+![Equinor Logo](images/equinor-logo.png)

package/dist/ExplorationLayer.d.ts

@@ -1,7 +1,7 @@
+import * as PIXI from 'pixi.js';
 import { ModuleInterface } from './ModuleInterface';
 import { RootUniforms } from './utils/wellbores/Shader';
 import PointDictionary from './utils/PointDictionary';
-import { selection } from 'd3';
 /**
  * Data assigned each point in point dictionary.
  */

package/dist/FaultlineModule.d.ts

@@ -13,7 +13,7 @@ interface FaultlineData {
     sourceUpdateDate: string;
 }
 /** Interface for faultline config. */
-interface InputConfig {
+export interface InputConfig {
     /** Color of faultline on format 0xRRGGBB. (Default: 0x727D88) */
     color?: number;
     /** Alpha of faultlines. (Default: 1.0) */
@@ -46,6 +46,6 @@ export default class FaultlineModule extends ModuleInterface {
     set(data: FaultlineData[]): void;
     /** Clear all spawned graphic elements and return to pool. */
     clear(): void;
-    resize(zoom: number): void;
+    resize(_zoom: number): void;
 }
 export {};

package/dist/FieldModule.d.ts

@@ -1,11 +1,11 @@
 import * as PIXI from 'pixi.js';
+import Vector2 from '@equinor/videx-vector2';
 import { ModuleInterface } from './ModuleInterface';
 import { MeshData, MeshNormalData } from './utils/Mesh';
 import Highlighter from './utils/fields/Highlighter';
 import LabelManager from './utils/fields/LabelManager';
 import TriangleDictionary from './utils/TriangleDictionary';
-import Vector2 from '@equinor/videx-vector2';
-declare type vec3 = [number, number, number];
+type vec3 = [number, number, number];
 interface FillUniform {
     col1: vec3;
     col2: vec3;
@@ -106,7 +106,7 @@ export default class FieldModule extends ModuleInterface {
      * @returns Projected polygons
      */
     projectPolygons(points: [number, number][]): Vector2[];
-    resize(zoom: number): void;
+    resize(_zoom: number): void;
     highlight(lat: number, long: number): boolean;
     tryUnselect(): void;
 }

package/dist/GeoJSONModule/GeoJSONModule.d.ts

@@ -35,8 +35,8 @@ export default class GeoJSONModule extends ModuleInterface {
    * @returns List of features at the given position
    */
     testPosition(pos: Vector2): any;
-    onAdd(map: import("leaflet").Map): void;
-    onRemove(map: import("leaflet").Map): void;
+    onAdd(map: import('leaflet').Map): void;
+    onRemove(_map: import('leaflet').Map): void;
     resize(zoom: number): void;
     private handleMouseMove;
     private handleMouseOut;

package/dist/GeoJSONModule/labels.d.ts

@@ -1,7 +1,7 @@
 import * as PIXI from 'pixi.js';
 import Vector2 from '@equinor/videx-vector2';
 /** Data for label. */
-export declare type GeoJSONLabelData = {
+export type GeoJSONLabelData = {
     position: Vector2;
     mass: number;
 };

package/dist/GeoJSONModule/linestring.d.ts

@@ -5,7 +5,7 @@ import { MeshNormalData } from '../utils/Mesh';
 import LineDictionary from '../utils/LineDictionary';
 import { FeatureProps, FeatureStyle } from '.';
 import { ResizeConfig } from '../ResizeConfigInterface';
-declare type vec3 = [number, number, number];
+type vec3 = [number, number, number];
 interface OutlineUniform {
     color: vec3;
     width: number;
@@ -49,7 +49,7 @@ export default class GeoJSONLineString {
      */
     projectPolygons(points: [number, number][]): Vector2[];
     resize(zoom: number): void;
-    testPosition(pos: Vector2): any;
+    testPosition(pos: Vector2): number;
     getOutlineRadius(zoom?: number): number;
 }
 export {};

package/dist/GeoJSONModule/multipolygon.d.ts

@@ -6,7 +6,7 @@ import GeoJSONLabels from './labels';
 import TriangleDictionary from '../utils/TriangleDictionary';
 import { FeatureProps, FeatureStyle } from '.';
 import { ResizeConfig, LabelResizeConfig } from '../ResizeConfigInterface';
-declare type vec3 = [number, number, number];
+type vec3 = [number, number, number];
 interface FillUniform {
     col1: vec3;
     col2: vec3;
@@ -87,7 +87,7 @@ export default class GeoJSONMultiPolygon {
      */
     projectPolygons(points: [number, number][]): Vector2[];
     resize(zoom: number): void;
-    testPosition(pos: Vector2): any;
+    testPosition(pos: Vector2): number;
     getOutlineRadius(zoom?: number): number;
     getLabelSize(zoom?: number): number;
 }

package/dist/GeoJSONModule/point.d.ts

@@ -21,6 +21,6 @@ export default class GeoJSONPoint {
       * @returns Projected point
       */
     projectPoint(point: [number, number]): Vector2;
-    resize(zoom: number): void;
+    resize(_zoom: number): void;
     testPosition(pos: Vector2): any;
 }

package/dist/GeoJSONModule/polygon.d.ts

@@ -6,7 +6,7 @@ import GeoJSONLabels from './labels';
 import TriangleDictionary from '../utils/TriangleDictionary';
 import { FeatureProps, FeatureStyle } from '.';
 import { ResizeConfig, LabelResizeConfig } from '../ResizeConfigInterface';
-declare type vec3 = [number, number, number];
+type vec3 = [number, number, number];
 interface FillUniform {
     col1: vec3;
     col2: vec3;

package/dist/ModuleInterface.d.ts

@@ -20,7 +20,7 @@ export declare abstract class ModuleInterface {
      * @returns True if new visibility was set
      */
     setVisibility(visible: boolean): boolean;
-    onAdd(map: L.Map): void;
-    onRemove(map: L.Map): void;
-    resize(zoom: number): void;
+    onAdd(_map: L.Map): void;
+    onRemove(_map: L.Map): void;
+    resize(_zoom: number): void;
 }

package/dist/WellboreModule.d.ts

@@ -20,6 +20,7 @@ export default class WellboreModule extends ModuleInterface {
     highlight: Highlight;
     currentZoom: number;
     private _deferredSelector;
+    private _deferredSelectorKeys;
     private _projector;
     private _eventHandler;
     private _redrawAnimFrame;
@@ -93,8 +94,8 @@ export default class WellboreModule extends ModuleInterface {
      */
     clear(...keys: string[]): void;
     resize(zoom: number): void;
-    onAdd(map: import("leaflet").Map): void;
-    onRemove(map: import("leaflet").Map): void;
+    onAdd(map: import('leaflet').Map): void;
+    onRemove(_map: import('leaflet').Map): void;
     get projector(): Projector;
     /**
      * Calculate root radius based on formula used in Shader.ts!