@equinor/esv-intersection 3.0.4 → 3.0.7

package/README.md

@@ -1,5 +1,7 @@
 [![npm version](https://badge.fury.io/js/%40equinor%2Fesv-intersection.svg)](https://badge.fury.io/js/%40equinor%2Fesv-intersection)
+
 # ESV Intersection component
+
 A reusable component to create intersection visualizations for wells
 
 Part of the [Equinor Subsurface Visualization project](https://github.com/equinor/esv)
@@ -13,33 +15,41 @@ Part of the [Equinor Subsurface Visualization project](https://github.com/equino
 ## Getting started
 
 #### Installation
+
 Using npm:
+
 ```bash
 npm install --save @equinor/esv-intersection
 ```
+
 Using yarn:
+
 ```bash
 yarn add @equinor/esv-intersection
 ```
+
 To run application in your machine :
+
 ```bash
 $ git clone git@github.com:equinor/esv-intersection
 $ git submodule update --init --recursive
 $ npm run storybook
 ```
+
 #### Usage
 
 ```javascript
 import { Controller, GridLayer } from '@equinor/esv-intersection';
 
 const container = document.createElement('div');
-const controller = new Controller({container: container});
+const controller = new Controller({ container: container });
 
 // the controller initially has zero height
 controller.adjustToSize(400, 400);
 
 controller.addLayer(new GridLayer('grid'));
 ```
+
 For more examples, check out our stories in our online [storybook](https://equinor.github.io/esv-intersection/storybook/latest).
 
 ## Technical choices
@@ -53,24 +63,27 @@ For more examples, check out our stories in our online [storybook](https://equin
   - Browser support: Target Edge, Chrome, Firefox, Safari
   - Linting and unit tests run automatically on Github Actions
 
-
 ## Development
+
 - The project is maintained by the [VidEx team](https://github.com/orgs/equinor/teams/viz) and the [Heap Purple team](https://github.com/orgs/equinor/teams/heap-purple)
 - New features could be requested by opening a dedicated issue or, even better, by opening a [Pull Requests](CONTRIBUTION.md)
 
-
 ## Support
+
 If you are an Equinor employee, the easiest way to get in touch with the maintainers is through the #esv-intersection channel on Slack.
 
 Otherwise, Github issues are the main communication channel with the maintainers. If you have a bug report, a feature request, or need some help using the component, simply [create an issue in the repository](https://github.com/equinor/esv-intersection/issues) and one of the maintainers will pick it up. Before creating an issue, please have a look at the following guidelines. Also keep in mind that creating [Pull Requests](CONTRIBUTION.md) is the preferred way to contribute to the project.
 
 ### Help needed
+
 Describe your use case in details, make sure to include the version of the component you are using, and relevant software that are part of your pipeline (eg, Chrome/Firefox/Safari, Node, npm, …), including their version as well
 
 ### Bug reports
+
 Follow the instructions from the _Help needed_ section above, but also include precise instructions about how to reproduce the bug. If any data is required for reproducing the bug, it would be beneficial to have access to it as well.
 
 ### Feature requests
+
 Give a precise description of your use case. It would be best if you could formulate your request as a user story, using the format `As a <subject> I would like to <the feature you need> so that <the task you want to accomplish>`
 
 ## Contribution
@@ -78,7 +91,9 @@ Give a precise description of your use case. It would be best if you could formu
 See the contribution [page](CONTRIBUTION.md)
 
 ## License
+
 The large majority of the files in this repository are released under the [MIT license](LICENSE). There are 2 exceptions:
+
 - the [CONTRIBUTION.md](CONTRIBUTION.md) file, which uses _BSD 2-Clause "Simplified" License_, as described at the end of the file itself
 - the content of the [esv-intersection-data](https://github.com/equinor/esv-intersection-data) submodule uses the same license as Equinor's [Volve dataset](https://data.equinor.com/dataset/Volve), which is also available in the submodule
 

package/dist/components/axis.d.ts

@@ -0,0 +1,48 @@
+import { Selection } from 'd3-selection';
+import { ScaleLinear } from 'd3-scale';
+import { OnResizeEvent, OnRescaleEvent } from '../interfaces';
+export type Options = {
+    offsetX: number;
+    offsetY: number;
+    visible: boolean;
+};
+export declare class Axis {
+    private mainGroup;
+    private _scaleX;
+    private _scaleY;
+    private _showLabels;
+    private _labelXDesc;
+    private _labelYDesc;
+    private _unitOfMeasure;
+    private _offsetX;
+    private _offsetY;
+    private _flipX;
+    private _flipY;
+    private visible;
+    constructor(mainGroup: Selection<SVGElement, unknown, null, undefined>, showLabels: boolean, labelXDesc: string, labelYDesc: string, unitOfMeasure: string, options?: Options);
+    private renderLabelx;
+    private renderLabely;
+    private renderGy;
+    private renderGx;
+    private createOrGet;
+    render(): void;
+    onResize(event: OnResizeEvent): void;
+    onRescale(event: OnRescaleEvent): void;
+    show(): Axis;
+    hide(): Axis;
+    flipX(flipX: boolean): Axis;
+    flipY(flipY: boolean): Axis;
+    showLabels(): Axis;
+    hideLabels(): Axis;
+    setLabelX(label: string): Axis;
+    setLabelY(label: string): Axis;
+    setUnitOfMeasure(uom: string): Axis;
+    setLabels(labelX: string, labelY: string, unitOfMeasure: string): Axis;
+    get offsetX(): number;
+    set offsetX(offset: number);
+    get offsetY(): number;
+    set offsetY(offset: number);
+    get scaleX(): ScaleLinear<number, number>;
+    get scaleY(): ScaleLinear<number, number>;
+}
+//# sourceMappingURL=axis.d.ts.map

package/dist/components/axis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"axis.d.ts","sourceRoot":"","sources":["../../../src/components/axis.ts"],"names":[],"mappings":"AACA,OAAO,EAAY,SAAS,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,WAAW,EAAe,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE9D,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,qBAAa,IAAI;IACf,OAAO,CAAC,SAAS,CAAkD;IACnE,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAa;IAC7B,OAAO,CAAC,QAAQ,CAAa;IAC7B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAiB;gBAG9B,SAAS,EAAE,SAAS,CAAC,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,EAC1D,UAAU,SAAO,EACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,OAAO;IAsBnB,OAAO,CAAC,YAAY;IAwBpB,OAAO,CAAC,YAAY;IAwBpB,OAAO,CAAC,QAAQ;IAWhB,OAAO,CAAC,QAAQ;IAWhB,OAAO,CAAC,WAAW,CAOjB;IAEF,MAAM,IAAI,IAAI;IAKd,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI;IAIpC,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAmBtC,IAAI,IAAI,IAAI;IAOZ,IAAI,IAAI,IAAI;IAMZ,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAQ3B,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAQ3B,UAAU,IAAI,IAAI;IAMlB,UAAU,IAAI,IAAI;IAMlB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK9B,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK9B,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAKnC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI;IAOtE,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,OAAO,CAAC,MAAM,EAAE,MAAM,EAEzB;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,OAAO,CAAC,MAAM,EAAE,MAAM,EAEzB;IAED,IAAI,MAAM,IAAI,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAExC;IAED,IAAI,MAAM,IAAI,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAExC;CACF"}

package/dist/components/index.d.ts

@@ -0,0 +1,2 @@
+export * from './axis';
+//# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC"}

package/dist/constants.d.ts

@@ -9,3 +9,4 @@ export declare const SHOE_WIDTH = 8;
 export declare const SHOE_LENGTH = 16;
 export declare const DEFAULT_TEXTURE_SIZE = 64;
 export declare const SURFACE_LINE_WIDTH = 1;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC,eAAO,MAAM,sBAAsB,KAAK,CAAC;AACzC,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC,eAAO,MAAM,oBAAoB,MAAM,CAAC;AACxC,eAAO,MAAM,YAAY,MAAM,CAAC;AAChC,eAAO,MAAM,cAAc,MAAM,CAAC;AAElC,eAAO,MAAM,UAAU,IAAI,CAAC;AAC5B,eAAO,MAAM,WAAW,KAAK,CAAC;AAE9B,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAGvC,eAAO,MAAM,kBAAkB,IAAI,CAAC"}

package/dist/control/ExtendedCurveInterpolator.d.ts

@@ -0,0 +1,59 @@
+import { CurveInterpolator } from 'curve-interpolator';
+import { Vector } from 'curve-interpolator/dist/src/core/interfaces';
+import { CurveInterpolatorOptions } from 'curve-interpolator/dist/src/curve-interpolator';
+export declare class ExtendedCurveInterpolator extends CurveInterpolator {
+    arcLengthLookup: number[];
+    constructor(points: Vector[], options?: CurveInterpolatorOptions);
+    /**
+     * Function which finds t value for arc length
+     * @param {Number} arcLength Target arc length
+     * @param {Number} tolerance Tolerance for result
+     * @param {Number} iterations Max number of iterations to use
+     */
+    findTForArcLength(arcLength: number, options?: {
+        approxT?: boolean;
+        quickT?: boolean;
+        normalizedLength?: number;
+    }): number;
+    /**
+     * Function which finds t value for arc length by finding root
+     * @param {Number} arcLength Target arc length
+     * @param {Number} tolerance Tolerance for result
+     * @param {Number} iterations Max number of iterations to use
+     */
+    findTByRootForArcLength(arcLength: number, tolerance?: number, iterations?: number): number;
+    /**
+     * Function which finds t value for arc length by simple approximation
+     * @param {Number} arcLength Target arclength
+     */
+    findApproxTForArcLength(arcLength: number, normalizedLength?: number): number;
+    /**
+     * Function which finds t value for arc length using lookup table
+     * @param {Number} arcLength Target arclength
+     */
+    findTQuickForArcLength(arcLength: number): number;
+    generateArcLengthLookup(segments?: number): void;
+    /**
+     * Function calculating length along curve using interpolator.
+     * @param {Number} from t at start (default = 0)
+     * @param {Number} to t at end (default = 1)
+     */
+    getArcLength(from?: number, to?: number): number;
+    /**
+     * Function calculating length along curve using interpolator.
+     * @param {Number} from t at start (default = 0)
+     * @param {Number} to t at end (default = 1)
+     */
+    getQuickArcLength(from?: number, to?: number): number;
+    /**
+     * Function getting a point at curve length.
+     * @param {Number} arcLength
+     */
+    getPointAtArcLength(arcLength: number, options?: {
+        approxT?: boolean;
+        quickT?: boolean;
+        normalizedLength?: number;
+    }): Vector;
+    getPointAt(t: number): Vector;
+}
+//# sourceMappingURL=ExtendedCurveInterpolator.d.ts.map

package/dist/control/ExtendedCurveInterpolator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtendedCurveInterpolator.d.ts","sourceRoot":"","sources":["../../../src/control/ExtendedCurveInterpolator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,6CAA6C,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,gDAAgD,CAAC;AAM1F,qBAAa,yBAA0B,SAAQ,iBAAiB;IAC9D,eAAe,EAAE,MAAM,EAAE,CAAM;gBAEnB,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,wBAAwB;IAahE;;;;;OAKG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;IAa1H;;;;;OAKG;IACH,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,SAAO,EAAE,UAAU,SAAM,GAAG,MAAM;IAWtF;;;OAGG;IACH,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM;IAK7E;;;OAGG;IACH,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAWjD,uBAAuB,CAAC,QAAQ,GAAE,MAAa,GAAG,IAAI;IAYtD;;;;OAIG;IACH,YAAY,CAAC,IAAI,SAAI,EAAE,EAAE,SAAI,GAAG,MAAM;IAQtC;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,SAAI,EAAE,EAAE,SAAI,GAAG,MAAM;IAyB3C;;;OAGG;IACH,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;IAKnH,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;CAIvC"}

package/dist/control/IntersectionReferenceSystem.d.ts

@@ -0,0 +1,97 @@
+import { CurveInterpolator } from 'curve-interpolator';
+import { Interpolators, Trajectory, MDPoint } from '../interfaces';
+import { ExtendedCurveInterpolator } from './ExtendedCurveInterpolator';
+export interface ReferenceSystemOptions {
+    normalizedLength?: number;
+    arcDivisions?: number;
+    tension?: number;
+    trajectoryAngle?: number;
+    calculateDisplacementFromBottom?: boolean;
+    curveInterpolator?: ExtendedCurveInterpolator;
+    trajectoryInterpolator?: ExtendedCurveInterpolator;
+    curtainInterpolator?: ExtendedCurveInterpolator;
+    approxT?: boolean;
+    quickT?: boolean;
+}
+export declare class IntersectionReferenceSystem {
+    options: ReferenceSystemOptions;
+    path: number[][];
+    projectedPath: number[][];
+    projectedTrajectory: number[][];
+    private _offset;
+    displacement: number;
+    depthReference: number;
+    wellboreId: number;
+    trajectoryOffset: number;
+    interpolators: Interpolators;
+    startVector: number[];
+    endVector: number[];
+    _curtainPathCache: MDPoint[];
+    /**
+     * Creates a common reference system that layers and other components can use
+     * @param path (required) array of 3d coordinates: [x, y, z]
+     * @param options (optional)
+     * @param options.trajectoryAngle (optional) - trajectory angle in degrees, overrides the calculated value
+     * @param options.calculateDisplacementFromBottom - (optional) specify if the path is passed from bottom up
+     */
+    constructor(path: number[][], options?: ReferenceSystemOptions);
+    private setPath;
+    /**
+     * Map a length along the curve to intersection coordinates
+     * @param length length along the curve
+     */
+    project(length: number): number[];
+    curtainTangent(length: number): number[];
+    /**
+     * Returns as resampled version of the projected path between start and end
+     * Samples are picked from the beginning of the path at every CURTAIN_SAMPLING_INTERVAL meters
+     * If the angle between two consecutive segments is close to 180 degrees depending on CURTAIN_SAMPLING_ANGLE_THRESHOLD,
+     * a sample in between is discarded.
+     *
+     * The start and the end are not guaranteed to be part of the returned set of points
+     * @param startMd in MD
+     * @param endMd in MD
+     * @param includeStartEnd guarantee to include the starting and end points
+     */
+    getCurtainPath(startMd: number, endMd: number, includeStartEnd?: boolean): MDPoint[];
+    /**
+     * Map a displacement back to length along the curve
+     */
+    unproject(displacement: number): number;
+    /**
+     * Get the normalized displacement [0 - 1] of a specific length along the curve
+     */
+    getProjectedLength(length: number): number;
+    /**
+     * Get the trajectory position at a length along the curve
+     */
+    getPosition(length: number): number[];
+    /**
+     * Generate a set of coordinates along the trajectory of the curve
+     */
+    getTrajectory(steps: number, from?: number, to?: number): Trajectory;
+    /**
+     * Generate a set of coordinates along the trajectory of the curve
+     */
+    getExtendedTrajectory(numPoints: number, startExtensionLength?: number, endExtensionLength?: number): Trajectory;
+    getTrajectoryVector(): number[];
+    /**
+     * Perform a curtain projection on a set of points in 3D
+     * @param points
+     * @param origin
+     * @param offset
+     * @returns {array}
+     */
+    static toDisplacement(points: number[][], offset?: number): number[][];
+    /**
+     * returns a normalized vector
+     * @param interpolator interpolated curve
+     * @param from number between 0 and 1
+     * @param to number between 0 and 1
+     */
+    static getDirectionVector(interpolator: CurveInterpolator, from: number, to: number): number[];
+    get length(): number;
+    get offset(): number;
+    set offset(offset: number);
+}
+//# sourceMappingURL=IntersectionReferenceSystem.d.ts.map

package/dist/control/IntersectionReferenceSystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntersectionReferenceSystem.d.ts","sourceRoot":"","sources":["../../../src/control/IntersectionReferenceSystem.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAa,MAAM,oBAAoB,CAAC;AAElE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAmBxE,MAAM,WAAW,sBAAsB;IACrC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C,iBAAiB,CAAC,EAAE,yBAAyB,CAAC;IAC9C,sBAAsB,CAAC,EAAE,yBAAyB,CAAC;IACnD,mBAAmB,CAAC,EAAE,yBAAyB,CAAC;IAChD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,qBAAa,2BAA2B;IACtC,OAAO,EAAE,sBAAsB,CAAC;IAEhC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAM;IAEtB,aAAa,EAAE,MAAM,EAAE,EAAE,CAAM;IAE/B,mBAAmB,EAAE,MAAM,EAAE,EAAE,CAAC;IAEhC,OAAO,CAAC,OAAO,CAAa;IAE5B,YAAY,EAAE,MAAM,CAAC;IAErB,cAAc,EAAE,MAAM,CAAC;IAEvB,UAAU,EAAE,MAAM,CAAC;IAEnB,gBAAgB,EAAE,MAAM,CAAC;IAEzB,aAAa,EAAE,aAAa,CAAC;IAE7B,WAAW,EAAE,MAAM,EAAE,CAAC;IAEtB,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB,iBAAiB,EAAE,OAAO,EAAE,CAAC;IAE7B;;;;;;OAMG;gBACS,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,sBAAsB;IAgB9D,OAAO,CAAC,OAAO;IAsCf;;;OAGG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE;IAQjC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE;IAQxC;;;;;;;;;;OAUG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,UAAQ,GAAG,OAAO,EAAE;IA0BlF;;OAEG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM;IAmBvC;;OAEG;IACH,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAO1C;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE;IAOrC;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,SAAI,EAAE,EAAE,SAAI,GAAG,UAAU;IAqD1D;;OAEG;IACH,qBAAqB,CACnB,SAAS,EAAE,MAAM,EACjB,oBAAoB,SAA8B,EAClD,kBAAkB,SAA4B,GAC7C,UAAU;IA0Cb,mBAAmB,IAAI,MAAM,EAAE;IAgB/B;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,SAAI,GAAG,MAAM,EAAE,EAAE;IAajE;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,YAAY,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE;IAO9F,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,EAGxB;CACF"}

package/dist/control/LayerManager.d.ts

@@ -0,0 +1,77 @@
+import { ZoomPanHandler } from './ZoomPanHandler';
+import { Layer, LayerOptions } from '../layers';
+import { ScaleOptions } from '../interfaces';
+import { Axis } from '../components';
+import { IntersectionReferenceSystem } from './IntersectionReferenceSystem';
+import { AxisOptions } from './interfaces';
+export declare class LayerManager {
+    private container;
+    private layerContainer;
+    private _zoomPanHandler;
+    private layers;
+    private _axis;
+    private _svgContainer;
+    /**
+     * Handles layers and axis also holds a zoom and pan handler object
+     * @param container root container
+     * @param scaleOptions
+     * @param axisOptions
+     */
+    constructor(container: HTMLElement, scaleOptions?: ScaleOptions, axisOptions?: AxisOptions);
+    /**
+     * Adds and mounts an array of layers
+     * @param layers array of layers
+     */
+    addLayers(layers: Layer<unknown>[]): LayerManager;
+    /**
+     * Gets all layers currently mounted
+     */
+    getLayers(): Layer<unknown>[];
+    /**
+     * Clears data from all mounted layers
+     * @param includeReferenceSystem - (optional) if true also removes reference system, default is true
+     */
+    clearAllData(includeReferenceSystem?: boolean): LayerManager;
+    /**
+     * Adds the layer to the manager, and mounts it
+     * @param layer Layer
+     * @param params extra params to pass to the onUpdate method
+     */
+    addLayer(layer: Layer<unknown>, params?: LayerOptions<unknown>): LayerManager;
+    /**
+     * Remove and unmount layer from manager
+     * @param layerId name of layer
+     */
+    removeLayer(layerId: string): LayerManager;
+    /**
+     * Remove and unmount all layers from manager
+     */
+    removeAllLayers(): LayerManager;
+    getLayer(layerId: string): Layer<unknown>;
+    initLayer(layer: Layer<unknown>, params?: LayerOptions<unknown>): LayerManager;
+    showLayer(layerId: string): LayerManager;
+    hideLayer(layerId: string): LayerManager;
+    /**
+     * Adjust layers, axis, and zoom according to inputted dimensions
+     * @param width (required)
+     * @param height (required)
+     */
+    adjustToSize(width: number, height: number): void;
+    setReferenceSystem(irs: IntersectionReferenceSystem): void;
+    showAxis(): LayerManager;
+    hideAxis(): LayerManager;
+    showAxisLabels(): LayerManager;
+    hideAxisLabels(): LayerManager;
+    setAxisOffset(x: number, y: number): LayerManager;
+    setXAxisOffset(x: number): LayerManager;
+    setYAxisOffset(y: number): LayerManager;
+    setZoomLevelBoundary(zoomlevels: [number, number]): LayerManager;
+    setMaxZoomLevel(zoomlevel: number): LayerManager;
+    setMinZoomLevel(zoomlevel: number): LayerManager;
+    destroy(): LayerManager;
+    get zoomPanHandler(): ZoomPanHandler;
+    get axis(): Axis;
+    private rescale;
+    private createAxis;
+}
+//# sourceMappingURL=LayerManager.d.ts.map

package/dist/control/LayerManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LayerManager.d.ts","sourceRoot":"","sources":["../../../src/control/LayerManager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAa,YAAY,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAgC,MAAM,eAAe,CAAC;AAC3E,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,qBAAa,YAAY;IACvB,OAAO,CAAC,SAAS,CAAc;IAE/B,OAAO,CAAC,cAAc,CAAc;IAEpC,OAAO,CAAC,eAAe,CAAiB;IAExC,OAAO,CAAC,MAAM,CAAwB;IAEtC,OAAO,CAAC,KAAK,CAAO;IACpB,OAAO,CAAC,aAAa,CAAmD;IAExE;;;;;OAKG;gBACS,SAAS,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,WAAW;IA0B1F;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,GAAG,YAAY;IAKjD;;OAEG;IACH,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;IAI7B;;;OAGG;IACH,YAAY,CAAC,sBAAsB,GAAE,OAAc,GAAG,YAAY;IAKlE;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,YAAY;IAO7E;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY;IAU1C;;OAEG;IACH,eAAe,IAAI,YAAY;IAQ/B,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC;IAIzC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,YAAY;IAiB9E,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY;IAUxC,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY;IAUxC;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAiBjD,kBAAkB,CAAC,GAAG,EAAE,2BAA2B,GAAG,IAAI;IAI1D,QAAQ,IAAI,YAAY;IAKxB,QAAQ,IAAI,YAAY;IAKxB,cAAc,IAAI,YAAY;IAK9B,cAAc,IAAI,YAAY;IAK9B,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,YAAY;IAWjD,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY;IASvC,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY;IASvC,oBAAoB,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY;IAKhE,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY;IAKhD,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY;IAKhD,OAAO,IAAI,YAAY;IAavB,IAAI,cAAc,IAAI,cAAc,CAEnC;IAED,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,OAAO,CAAC,OAAO;IASf,OAAO,CAAC,UAAU,CAgBhB;CACH"}

package/dist/control/MainController.d.ts

@@ -0,0 +1,155 @@
+import { IntersectionReferenceSystem } from './IntersectionReferenceSystem';
+import { Layer } from '../layers';
+import { ControllerOptions } from './interfaces';
+import { ZoomPanHandler } from './ZoomPanHandler';
+import { LayerOptions, OnRescaleEvent, ReferenceSystemOptions } from '..';
+import { Axis } from '../components';
+import { Overlay } from './overlay';
+/**
+ * API for controlling data and layers
+ */
+export declare class Controller {
+    private _referenceSystem;
+    private layerManager;
+    private _overlay;
+    /**
+     * Interface to control layers, reference system, axis and overlay. overlay is created on instantiation, does not currently support opt-out.
+     * @param options
+     * @param options.container (required) Currently only supports HTMLElement
+     * @param options.scaleOptions (optional) currently supports formats listed in examples below
+     * @example scaleOptions = { xMin: 0, xMax: 100, yMin: 0, yMax: 100 }
+     * @example scaleOptions = { xBounds: [0 , 100], yBounds: [0, 100] }
+     * @param options.axisOptions (optional) creates axis with supplied labels, currently only supports creating axis on instantiation
+     * @param options.layers (optional) list of layers
+     * @param options.path (optional) creates a reference system based on an array of 3d coordinates
+     * @param options.referenceSystem (optional) sets reference system, takes priority over path if both are supplied
+     */
+    constructor(options: ControllerOptions);
+    /**
+     * Sets reference system, overrides any existing reference systems in place
+     * @param referenceSystem IntersectionReferenceSystem
+     */
+    setReferenceSystem(referenceSystem: IntersectionReferenceSystem): Controller;
+    /**
+     * Creates new reference system based on path, overrides any existing reference systems in place
+     * @param path array of coords
+     * @param options optional
+     * @param options.trajectoryAngle (optional) angle in degrees
+     */
+    updatePath(path: number[][], options?: ReferenceSystemOptions): Controller;
+    /**
+     * Clears data from all mounted layers
+     * @param includeReferenceSystem - (optional) if true also removes reference system, default is true
+     */
+    clearAllData(includeReferenceSystem?: boolean): Controller;
+    /**
+     * Adds layer to list, and initializes it
+     * @param layer layer object
+     * @param params (optional) adds additional parameters to the onUpdateEvent
+     */
+    addLayer(layer: Layer<unknown>, params?: LayerOptions<unknown>): Controller;
+    /**
+     * Remove and unmount layer from list
+     * @param layerId string id
+     */
+    removeLayer(layerId: string): Controller;
+    /**
+     * Remove and unmount all layers from list
+     */
+    removeAllLayers(): Controller;
+    /**
+     * Find first layer with given id, returns undefined if none are found
+     * @param layerId string id
+     */
+    getLayer(layerId: string): Layer<unknown>;
+    /**
+     * Sets visibility to true and rescales the layer
+     * @param layerId string id
+     */
+    showLayer(layerId: string): Controller;
+    /**
+     * Sets visibility to false
+     * @param layerId string id
+     */
+    hideLayer(layerId: string): Controller;
+    /**
+     * Adjust layers, axis, overlay, and zoom according to inputted dimensions
+     * @param width (required)
+     * @param height (required)
+     */
+    adjustToSize(width: number, height: number): Controller;
+    /**
+     * Set new viewport
+     * @param  cx - center X pos
+     * @param  cy - center Y pos
+     * @param  displ - displacement
+     * @param  duration - duration of transition
+     */
+    setViewport(cx?: number, cy?: number, displacement?: number, duration?: number): Controller;
+    /**
+     * Sets bounds for zoom and pan handler
+     * @param xBounds - domain in x-direction
+     * @param yBounds - domain in y-direction
+     */
+    setBounds(xBounds: [number, number], yBounds: [number, number]): Controller;
+    /**
+     * Display both axes
+     */
+    showAxis(): Controller;
+    /**
+     * Hide both axes
+     */
+    hideAxis(): Controller;
+    /**
+     * Shows labels in x and y
+     */
+    showAxisLabels(): Controller;
+    /**
+     * Hide labels in x and y
+     */
+    hideAxisLabels(): Controller;
+    /**
+     * Sets domain offset, offset is subtracted from domain
+     * @param x
+     * @param y
+     */
+    setAxisOffset(x: number, y: number): Controller;
+    /**
+     * Sets domain offset in x-direction, offset is subtracted from domain
+     * @param x
+     */
+    setXAxisOffset(x: number): Controller;
+    /**
+     * Sets domain offset in y-direction, offset is subtracted from domain
+     * @param y
+     */
+    setYAxisOffset(y: number): Controller;
+    /**
+     * Defines min and max of how much one can zoom
+     * @param zoomlevels
+     */
+    setZoomLevelBoundary(zoomlevels: [number, number]): Controller;
+    /**
+     * Defines how far in one can zoom
+     * @param zoomlevel
+     */
+    setMaxZoomLevel(zoomlevel: number): Controller;
+    /**
+     * Defines how far out one can zoom
+     * @param zoomlevel
+     */
+    setMinZoomLevel(zoomlevel: number): Controller;
+    /**
+     * Destroy Controller
+     * Convenience method for removing from DOM and clearing references
+     */
+    destroy(): Controller;
+    private getHighestZIndex;
+    private setOverlayZIndex;
+    get overlay(): Overlay<Controller>;
+    get referenceSystem(): IntersectionReferenceSystem;
+    get zoomPanHandler(): ZoomPanHandler;
+    get axis(): Axis;
+    get currentStateAsEvent(): OnRescaleEvent;
+}
+//# sourceMappingURL=MainController.d.ts.map

package/dist/control/MainController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MainController.d.ts","sourceRoot":"","sources":["../../../src/control/MainController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,IAAI,CAAC;AAC1E,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAW,OAAO,EAAE,MAAM,WAAW,CAAC;AAG7C;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,gBAAgB,CAA8B;IAEtD,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,QAAQ,CAAsB;IAEtC;;;;;;;;;;;OAWG;gBACS,OAAO,EAAE,iBAAiB;IActC;;;OAGG;IACH,kBAAkB,CAAC,eAAe,EAAE,2BAA2B,GAAG,UAAU;IAM5E;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,UAAU;IAM1E;;;OAGG;IACH,YAAY,CAAC,sBAAsB,GAAE,OAAc,GAAG,UAAU;IAKhE;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,UAAU;IAM3E;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU;IAKxC;;OAEG;IACH,eAAe,IAAI,UAAU;IAK7B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC;IAIzC;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU;IAKtC;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU;IAKtC;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU;IASvD;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,UAAU;IAK3F;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,UAAU;IAK3E;;OAEG;IACH,QAAQ,IAAI,UAAU;IAKtB;;OAEG;IACH,QAAQ,IAAI,UAAU;IAKtB;;OAEG;IACH,cAAc,IAAI,UAAU;IAK5B;;OAEG;IACH,cAAc,IAAI,UAAU;IAK5B;;;;OAIG;IACH,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,UAAU;IAK/C;;;OAGG;IACH,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,UAAU;IAKrC;;;OAGG;IACH,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,UAAU;IAKrC;;;OAGG;IACH,oBAAoB,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,UAAU;IAK9D;;;OAGG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU;IAK9C;;;OAGG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU;IAK9C;;;OAGG;IACH,OAAO,IAAI,UAAU;IASrB,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,gBAAgB;IAKxB,IAAI,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAEjC;IAED,IAAI,eAAe,IAAI,2BAA2B,CAEjD;IAED,IAAI,cAAc,IAAI,cAAc,CAEnC;IAED,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,IAAI,mBAAmB,IAAI,cAAc,CAExC;CACF"}