@equinor/esv-intersection 3.0.0-beta.0 → 3.0.0-beta.2

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.
Files changed (57) hide show
  1. package/dist/components/axis.d.ts +47 -0
  2. package/dist/components/index.d.ts +1 -0
  3. package/dist/constants.d.ts +11 -0
  4. package/dist/control/ExtendedCurveInterpolator.d.ts +58 -0
  5. package/dist/control/IntersectionReferenceSystem.d.ts +96 -0
  6. package/dist/control/LayerManager.d.ts +76 -0
  7. package/dist/control/MainController.d.ts +154 -0
  8. package/dist/control/ZoomPanHandler.d.ts +158 -0
  9. package/dist/control/index.d.ts +5 -0
  10. package/dist/control/interfaces.d.ts +37 -0
  11. package/dist/control/overlay.d.ts +20 -0
  12. package/dist/datautils/camelcase.d.ts +5 -0
  13. package/dist/datautils/colortable.d.ts +1 -0
  14. package/dist/datautils/findsample.d.ts +2 -0
  15. package/dist/datautils/index.d.ts +6 -0
  16. package/dist/datautils/interfaces.d.ts +63 -0
  17. package/dist/datautils/picks.d.ts +74 -0
  18. package/dist/datautils/schematicShapeGenerator.d.ts +50 -0
  19. package/dist/datautils/seismicimage.d.ts +45 -0
  20. package/dist/datautils/surfacedata.d.ts +10 -0
  21. package/dist/datautils/trajectory.d.ts +14 -0
  22. package/dist/index.d.ts +6 -0
  23. package/dist/index.esm.js +1 -0
  24. package/dist/index.js +1 -0
  25. package/dist/index.umd.js +412 -0
  26. package/dist/interfaces.d.ts +86 -0
  27. package/dist/layers/CalloutCanvasLayer.d.ts +60 -0
  28. package/dist/layers/CustomDisplayObjects/ComplexRope.d.ts +22 -0
  29. package/dist/layers/CustomDisplayObjects/ComplexRopeGeometry.d.ts +27 -0
  30. package/dist/layers/CustomDisplayObjects/FixedWidthSimpleRope.d.ts +20 -0
  31. package/dist/layers/CustomDisplayObjects/FixedWidthSimpleRopeGeometry.d.ts +26 -0
  32. package/dist/layers/CustomDisplayObjects/UniformTextureStretchRope.d.ts +17 -0
  33. package/dist/layers/CustomDisplayObjects/UniformTextureStretchRopeGeometry.d.ts +24 -0
  34. package/dist/layers/GeomodelCanvasLayer.d.ts +28 -0
  35. package/dist/layers/GeomodelLabelsLayer.d.ts +49 -0
  36. package/dist/layers/GeomodelLayerV2.d.ts +12 -0
  37. package/dist/layers/GridLayer.d.ts +29 -0
  38. package/dist/layers/ImageCanvasLayer.d.ts +20 -0
  39. package/dist/layers/SchematicLayer.d.ts +94 -0
  40. package/dist/layers/SeismicCanvasLayer.d.ts +19 -0
  41. package/dist/layers/WellborePathLayer.d.ts +17 -0
  42. package/dist/layers/base/CanvasLayer.d.ts +19 -0
  43. package/dist/layers/base/HTMLLayer.d.ts +13 -0
  44. package/dist/layers/base/Layer.d.ts +69 -0
  45. package/dist/layers/base/PixiLayer.d.ts +32 -0
  46. package/dist/layers/base/SVGLayer.d.ts +13 -0
  47. package/dist/layers/base/index.d.ts +5 -0
  48. package/dist/layers/index.d.ts +15 -0
  49. package/dist/layers/schematicInterfaces.d.ts +191 -0
  50. package/dist/utils/arc-length.d.ts +23 -0
  51. package/dist/utils/binary-search.d.ts +8 -0
  52. package/dist/utils/color.d.ts +5 -0
  53. package/dist/utils/index.d.ts +1 -0
  54. package/dist/utils/root-finder.d.ts +34 -0
  55. package/dist/utils/text.d.ts +14 -0
  56. package/dist/utils/vectorUtils.d.ts +15 -0
  57. package/package.json +2 -1
@@ -0,0 +1,47 @@
1
+ import { Selection } from 'd3-selection';
2
+ import { ScaleLinear } from 'd3-scale';
3
+ import { OnResizeEvent, OnRescaleEvent } from '../interfaces';
4
+ export declare type Options = {
5
+ offsetX: number;
6
+ offsetY: number;
7
+ visible: boolean;
8
+ };
9
+ export declare class Axis {
10
+ private mainGroup;
11
+ private _scaleX;
12
+ private _scaleY;
13
+ private _showLabels;
14
+ private _labelXDesc;
15
+ private _labelYDesc;
16
+ private _unitOfMeasure;
17
+ private _offsetX;
18
+ private _offsetY;
19
+ private _flipX;
20
+ private _flipY;
21
+ private visible;
22
+ constructor(mainGroup: Selection<SVGElement, unknown, null, undefined>, showLabels: boolean, labelXDesc: string, labelYDesc: string, unitOfMeasure: string, options?: Options);
23
+ private renderLabelx;
24
+ private renderLabely;
25
+ private renderGy;
26
+ private renderGx;
27
+ private createOrGet;
28
+ render(): void;
29
+ onResize(event: OnResizeEvent): void;
30
+ onRescale(event: OnRescaleEvent): void;
31
+ show(): Axis;
32
+ hide(): Axis;
33
+ flipX(flipX: boolean): Axis;
34
+ flipY(flipY: boolean): Axis;
35
+ showLabels(): Axis;
36
+ hideLabels(): Axis;
37
+ setLabelX(label: string): Axis;
38
+ setLabelY(label: string): Axis;
39
+ setUnitOfMeasure(uom: string): Axis;
40
+ setLabels(labelX: string, labelY: string, unitOfMeasure: string): Axis;
41
+ get offsetX(): number;
42
+ set offsetX(offset: number);
43
+ get offsetY(): number;
44
+ set offsetY(offset: number);
45
+ get scaleX(): ScaleLinear<number, number>;
46
+ get scaleY(): ScaleLinear<number, number>;
47
+ }
@@ -0,0 +1 @@
1
+ export * from './axis';
@@ -0,0 +1,11 @@
1
+ export declare const DEFAULT_LAYER_WIDTH = 200;
2
+ export declare const DEFAULT_LAYER_HEIGHT = 300;
3
+ export declare const HORIZONTAL_AXIS_MARGIN = 40;
4
+ export declare const VERTICAL_AXIS_MARGIN = 30;
5
+ export declare const EXAGGERATED_DIAMETER = 100;
6
+ export declare const HOLE_OUTLINE = 0.6;
7
+ export declare const SCREEN_OUTLINE = 0.3;
8
+ export declare const SHOE_WIDTH = 8;
9
+ export declare const SHOE_LENGTH = 16;
10
+ export declare const DEFAULT_TEXTURE_SIZE = 64;
11
+ export declare const SURFACE_LINE_WIDTH = 1;
@@ -0,0 +1,58 @@
1
+ import { CurveInterpolator } from 'curve-interpolator';
2
+ import { Vector } from 'curve-interpolator/dist/src/interfaces';
3
+ import { CurveInterpolatorOptions } from 'curve-interpolator/dist/src/curve-interpolator';
4
+ export declare class ExtendedCurveInterpolator extends CurveInterpolator {
5
+ arcLengthLookup: number[];
6
+ constructor(points: Vector[], options?: CurveInterpolatorOptions);
7
+ /**
8
+ * Function which finds t value for arc length
9
+ * @param {Number} arcLength Target arc length
10
+ * @param {Number} tolerance Tolerance for result
11
+ * @param {Number} iterations Max number of iterations to use
12
+ */
13
+ findTForArcLength(arcLength: number, options?: {
14
+ approxT?: boolean;
15
+ quickT?: boolean;
16
+ normalizedLength?: number;
17
+ }): number;
18
+ /**
19
+ * Function which finds t value for arc length by finding root
20
+ * @param {Number} arcLength Target arc length
21
+ * @param {Number} tolerance Tolerance for result
22
+ * @param {Number} iterations Max number of iterations to use
23
+ */
24
+ findTByRootForArcLength(arcLength: number, tolerance?: number, iterations?: number): number;
25
+ /**
26
+ * Function which finds t value for arc length by simple approximation
27
+ * @param {Number} arcLength Target arclength
28
+ */
29
+ findApproxTForArcLength(arcLength: number, normalizedLength?: number): number;
30
+ /**
31
+ * Function which finds t value for arc length using lookup table
32
+ * @param {Number} arcLength Target arclength
33
+ */
34
+ findTQuickForArcLength(arcLength: number): number;
35
+ generateArcLengthLookup(segments?: number): void;
36
+ /**
37
+ * Function calculating length along curve using interpolator.
38
+ * @param {Number} from t at start (default = 0)
39
+ * @param {Number} to t at end (default = 1)
40
+ */
41
+ getArcLength(from?: number, to?: number): number;
42
+ /**
43
+ * Function calculating length along curve using interpolator.
44
+ * @param {Number} from t at start (default = 0)
45
+ * @param {Number} to t at end (default = 1)
46
+ */
47
+ getQuickArcLength(from?: number, to?: number): number;
48
+ /**
49
+ * Function getting a point at curve length.
50
+ * @param {Number} arcLength
51
+ */
52
+ getPointAtArcLength(arcLength: number, options?: {
53
+ approxT?: boolean;
54
+ quickT?: boolean;
55
+ normalizedLength?: number;
56
+ }): Vector;
57
+ getPointAt(t: number): Vector;
58
+ }
@@ -0,0 +1,96 @@
1
+ import { CurveInterpolator } from 'curve-interpolator';
2
+ import { Interpolators, Trajectory, MDPoint } from '../interfaces';
3
+ import { ExtendedCurveInterpolator } from './ExtendedCurveInterpolator';
4
+ export interface ReferenceSystemOptions {
5
+ normalizedLength?: number;
6
+ arcDivisions?: number;
7
+ tension?: number;
8
+ trajectoryAngle?: number;
9
+ calculateDisplacementFromBottom?: boolean;
10
+ curveInterpolator?: ExtendedCurveInterpolator;
11
+ trajectoryInterpolator?: ExtendedCurveInterpolator;
12
+ curtainInterpolator?: ExtendedCurveInterpolator;
13
+ approxT?: boolean;
14
+ quickT?: boolean;
15
+ }
16
+ export declare class IntersectionReferenceSystem {
17
+ options: ReferenceSystemOptions;
18
+ path: number[][];
19
+ projectedPath: number[][];
20
+ projectedTrajectory: number[][];
21
+ private _offset;
22
+ displacement: number;
23
+ depthReference: number;
24
+ wellboreId: number;
25
+ trajectoryOffset: number;
26
+ interpolators: Interpolators;
27
+ startVector: number[];
28
+ endVector: number[];
29
+ _curtainPathCache: MDPoint[];
30
+ /**
31
+ * Creates a common reference system that layers and other components can use
32
+ * @param path (required) array of 3d coordinates: [x, y, z]
33
+ * @param options (optional)
34
+ * @param options.trajectoryAngle (optional) - trajectory angle in degrees, overrides the calculated value
35
+ * @param options.calculateDisplacementFromBottom - (optional) specify if the path is passed from bottom up
36
+ */
37
+ constructor(path: number[][], options?: ReferenceSystemOptions);
38
+ private setPath;
39
+ /**
40
+ * Map a length along the curve to intersection coordinates
41
+ * @param length length along the curve
42
+ */
43
+ project(length: number): number[];
44
+ curtainTangent(length: number): number[];
45
+ /**
46
+ * Returns as resampled version of the projected path between start and end
47
+ * Samples are picked from the beginning of the path at every CURTAIN_SAMPLING_INTERVAL meters
48
+ * If the angle between two consecutive segments is close to 180 degrees depending on CURTAIN_SAMPLING_ANGLE_THRESHOLD,
49
+ * a sample in between is discarded.
50
+ *
51
+ * The start and the end are not guaranteed to be part of the returned set of points
52
+ * @param startMd in MD
53
+ * @param endMd in MD
54
+ * @param includeStartEnd guarantee to include the starting and end points
55
+ */
56
+ getCurtainPath(startMd: number, endMd: number, includeStartEnd?: boolean): MDPoint[];
57
+ /**
58
+ * Map a displacement back to length along the curve
59
+ */
60
+ unproject(displacement: number): number;
61
+ /**
62
+ * Get the normalized displacement [0 - 1] of a specific length along the curve
63
+ */
64
+ getProjectedLength(length: number): number;
65
+ /**
66
+ * Get the trajectory position at a length along the curve
67
+ */
68
+ getPosition(length: number): number[];
69
+ /**
70
+ * Generate a set of coordinates along the trajectory of the curve
71
+ */
72
+ getTrajectory(steps: number, from?: number, to?: number): Trajectory;
73
+ /**
74
+ * Generate a set of coordinates along the trajectory of the curve
75
+ */
76
+ getExtendedTrajectory(numPoints: number, startExtensionLength?: number, endExtensionLength?: number): Trajectory;
77
+ getTrajectoryVector(): number[];
78
+ /**
79
+ * Perform a curtain projection on a set of points in 3D
80
+ * @param points
81
+ * @param origin
82
+ * @param offset
83
+ * @returns {array}
84
+ */
85
+ static toDisplacement(points: number[][], offset?: number): number[][];
86
+ /**
87
+ * returns a normalized vector
88
+ * @param interpolator interpolated curve
89
+ * @param from number between 0 and 1
90
+ * @param to number between 0 and 1
91
+ */
92
+ static getDirectionVector(interpolator: CurveInterpolator, from: number, to: number): number[];
93
+ get length(): number;
94
+ get offset(): number;
95
+ set offset(offset: number);
96
+ }
@@ -0,0 +1,76 @@
1
+ import { ZoomPanHandler } from './ZoomPanHandler';
2
+ import { Layer, LayerOptions } from '../layers';
3
+ import { ScaleOptions } from '../interfaces';
4
+ import { Axis } from '../components';
5
+ import { IntersectionReferenceSystem } from './IntersectionReferenceSystem';
6
+ import { AxisOptions } from './interfaces';
7
+ export declare class LayerManager {
8
+ private container;
9
+ private layerContainer;
10
+ private _zoomPanHandler;
11
+ private layers;
12
+ private _axis;
13
+ private _svgContainer;
14
+ /**
15
+ * Handles layers and axis also holds a zoom and pan handler object
16
+ * @param container root container
17
+ * @param scaleOptions
18
+ * @param axisOptions
19
+ */
20
+ constructor(container: HTMLElement, scaleOptions?: ScaleOptions, axisOptions?: AxisOptions);
21
+ /**
22
+ * Adds and mounts an array of layers
23
+ * @param layers array of layers
24
+ */
25
+ addLayers(layers: Layer<unknown>[]): LayerManager;
26
+ /**
27
+ * Gets all layers currently mounted
28
+ */
29
+ getLayers(): Layer<unknown>[];
30
+ /**
31
+ * Clears data from all mounted layers
32
+ * @param includeReferenceSystem - (optional) if true also removes reference system, default is true
33
+ */
34
+ clearAllData(includeReferenceSystem?: boolean): LayerManager;
35
+ /**
36
+ * Adds the layer to the manager, and mounts it
37
+ * @param layer Layer
38
+ * @param params extra params to pass to the onUpdate method
39
+ */
40
+ addLayer(layer: Layer<unknown>, params?: LayerOptions<unknown>): LayerManager;
41
+ /**
42
+ * Remove and unmount layer from manager
43
+ * @param layerId name of layer
44
+ */
45
+ removeLayer(layerId: string): LayerManager;
46
+ /**
47
+ * Remove and unmount all layers from manager
48
+ */
49
+ removeAllLayers(): LayerManager;
50
+ getLayer(layerId: string): Layer<unknown>;
51
+ initLayer(layer: Layer<unknown>, params?: LayerOptions<unknown>): LayerManager;
52
+ showLayer(layerId: string): LayerManager;
53
+ hideLayer(layerId: string): LayerManager;
54
+ /**
55
+ * Adjust layers, axis, and zoom according to inputted dimensions
56
+ * @param width (required)
57
+ * @param height (required)
58
+ */
59
+ adjustToSize(width: number, height: number): void;
60
+ setReferenceSystem(irs: IntersectionReferenceSystem): void;
61
+ showAxis(): LayerManager;
62
+ hideAxis(): LayerManager;
63
+ showAxisLabels(): LayerManager;
64
+ hideAxisLabels(): LayerManager;
65
+ setAxisOffset(x: number, y: number): LayerManager;
66
+ setXAxisOffset(x: number): LayerManager;
67
+ setYAxisOffset(y: number): LayerManager;
68
+ setZoomLevelBoundary(zoomlevels: [number, number]): LayerManager;
69
+ setMaxZoomLevel(zoomlevel: number): LayerManager;
70
+ setMinZoomLevel(zoomlevel: number): LayerManager;
71
+ destroy(): LayerManager;
72
+ get zoomPanHandler(): ZoomPanHandler;
73
+ get axis(): Axis;
74
+ private rescale;
75
+ private createAxis;
76
+ }
@@ -0,0 +1,154 @@
1
+ import { IntersectionReferenceSystem } from './IntersectionReferenceSystem';
2
+ import { Layer } from '../layers';
3
+ import { ControllerOptions } from './interfaces';
4
+ import { ZoomPanHandler } from './ZoomPanHandler';
5
+ import { LayerOptions, OnRescaleEvent, ReferenceSystemOptions } from '..';
6
+ import { Axis } from '../components';
7
+ import { Overlay } from './overlay';
8
+ /**
9
+ * API for controlling data and layers
10
+ */
11
+ export declare class Controller {
12
+ private _referenceSystem;
13
+ private layerManager;
14
+ private _overlay;
15
+ /**
16
+ * Interface to control layers, reference system, axis and overlay. overlay is created on instantiation, does not currently support opt-out.
17
+ * @param options
18
+ * @param options.container (required) Currently only supports HTMLElement
19
+ * @param options.scaleOptions (optional) currently supports formats listed in examples below
20
+ * @example scaleOptions = { xMin: 0, xMax: 100, yMin: 0, yMax: 100 }
21
+ * @example scaleOptions = { xBounds: [0 , 100], yBounds: [0, 100] }
22
+ * @param options.axisOptions (optional) creates axis with supplied labels, currently only supports creating axis on instantiation
23
+ * @param options.layers (optional) list of layers
24
+ * @param options.path (optional) creates a reference system based on an array of 3d coordinates
25
+ * @param options.referenceSystem (optional) sets reference system, takes priority over path if both are supplied
26
+ */
27
+ constructor(options: ControllerOptions);
28
+ /**
29
+ * Sets reference system, overrides any existing reference systems in place
30
+ * @param referenceSystem IntersectionReferenceSystem
31
+ */
32
+ setReferenceSystem(referenceSystem: IntersectionReferenceSystem): Controller;
33
+ /**
34
+ * Creates new reference system based on path, overrides any existing reference systems in place
35
+ * @param path array of coords
36
+ * @param options optional
37
+ * @param options.trajectoryAngle (optional) angle in degrees
38
+ */
39
+ updatePath(path: number[][], options?: ReferenceSystemOptions): Controller;
40
+ /**
41
+ * Clears data from all mounted layers
42
+ * @param includeReferenceSystem - (optional) if true also removes reference system, default is true
43
+ */
44
+ clearAllData(includeReferenceSystem?: boolean): Controller;
45
+ /**
46
+ * Adds layer to list, and initializes it
47
+ * @param layer layer object
48
+ * @param params (optional) adds additional parameters to the onUpdateEvent
49
+ */
50
+ addLayer(layer: Layer<unknown>, params?: LayerOptions<unknown>): Controller;
51
+ /**
52
+ * Remove and unmount layer from list
53
+ * @param layerId string id
54
+ */
55
+ removeLayer(layerId: string): Controller;
56
+ /**
57
+ * Remove and unmount all layers from list
58
+ */
59
+ removeAllLayers(): Controller;
60
+ /**
61
+ * Find first layer with given id, returns undefined if none are found
62
+ * @param layerId string id
63
+ */
64
+ getLayer(layerId: string): Layer<unknown>;
65
+ /**
66
+ * Sets visibility to true and rescales the layer
67
+ * @param layerId string id
68
+ */
69
+ showLayer(layerId: string): Controller;
70
+ /**
71
+ * Sets visibility to false
72
+ * @param layerId string id
73
+ */
74
+ hideLayer(layerId: string): Controller;
75
+ /**
76
+ * Adjust layers, axis, overlay, and zoom according to inputted dimensions
77
+ * @param width (required)
78
+ * @param height (required)
79
+ */
80
+ adjustToSize(width: number, height: number): Controller;
81
+ /**
82
+ * Set new viewport
83
+ * @param cx - center X pos
84
+ * @param cy - center Y pos
85
+ * @param displ - displacement
86
+ * @param duration - duration of transition
87
+ */
88
+ setViewport(cx?: number, cy?: number, displacement?: number, duration?: number): Controller;
89
+ /**
90
+ * Sets bounds for zoom and pan handler
91
+ * @param xBounds - domain in x-direction
92
+ * @param yBounds - domain in y-direction
93
+ */
94
+ setBounds(xBounds: [number, number], yBounds: [number, number]): Controller;
95
+ /**
96
+ * Display both axes
97
+ */
98
+ showAxis(): Controller;
99
+ /**
100
+ * Hide both axes
101
+ */
102
+ hideAxis(): Controller;
103
+ /**
104
+ * Shows labels in x and y
105
+ */
106
+ showAxisLabels(): Controller;
107
+ /**
108
+ * Hide labels in x and y
109
+ */
110
+ hideAxisLabels(): Controller;
111
+ /**
112
+ * Sets domain offset, offset is subtracted from domain
113
+ * @param x
114
+ * @param y
115
+ */
116
+ setAxisOffset(x: number, y: number): Controller;
117
+ /**
118
+ * Sets domain offset in x-direction, offset is subtracted from domain
119
+ * @param x
120
+ */
121
+ setXAxisOffset(x: number): Controller;
122
+ /**
123
+ * Sets domain offset in y-direction, offset is subtracted from domain
124
+ * @param y
125
+ */
126
+ setYAxisOffset(y: number): Controller;
127
+ /**
128
+ * Defines min and max of how much one can zoom
129
+ * @param zoomlevels
130
+ */
131
+ setZoomLevelBoundary(zoomlevels: [number, number]): Controller;
132
+ /**
133
+ * Defines how far in one can zoom
134
+ * @param zoomlevel
135
+ */
136
+ setMaxZoomLevel(zoomlevel: number): Controller;
137
+ /**
138
+ * Defines how far out one can zoom
139
+ * @param zoomlevel
140
+ */
141
+ setMinZoomLevel(zoomlevel: number): Controller;
142
+ /**
143
+ * Destroy Controller
144
+ * Convenience method for removing from DOM and clearing references
145
+ */
146
+ destroy(): Controller;
147
+ private getHighestZIndex;
148
+ private setOverlayZIndex;
149
+ get overlay(): Overlay<Controller>;
150
+ get referenceSystem(): IntersectionReferenceSystem;
151
+ get zoomPanHandler(): ZoomPanHandler;
152
+ get axis(): Axis;
153
+ get currentStateAsEvent(): OnRescaleEvent;
154
+ }
@@ -0,0 +1,158 @@
1
+ import { Selection } from 'd3-selection';
2
+ import { ScaleLinear } from 'd3-scale';
3
+ import { ZoomBehavior, ZoomTransform } from 'd3-zoom';
4
+ import { ZoomAndPanOptions, OnRescaleEvent } from '../interfaces';
5
+ export declare type RescaleFunction = (event: OnRescaleEvent) => void;
6
+ /**
7
+ * Handle zoom and pan for intersection layers
8
+ */
9
+ export declare class ZoomPanHandler {
10
+ zoom: ZoomBehavior<Element, unknown>;
11
+ elm: HTMLElement;
12
+ container: Selection<HTMLElement, unknown, null, undefined>;
13
+ onRescale: RescaleFunction;
14
+ options: ZoomAndPanOptions;
15
+ xBounds: [number, number];
16
+ yBounds: [number, number];
17
+ translateBoundsX: [number, number];
18
+ translateBoundsY: [number, number];
19
+ scaleX: ScaleLinear<number, number>;
20
+ scaleY: ScaleLinear<number, number>;
21
+ _zFactor: number;
22
+ _enableTranslateExtent: boolean;
23
+ currentTransform: ZoomTransform;
24
+ /**
25
+ * Constructor
26
+ * @param elm, -
27
+ * @param options - options
28
+ */
29
+ constructor(elm: HTMLElement, onRescale: RescaleFunction, options?: ZoomAndPanOptions);
30
+ /**
31
+ * Getter returning width of target
32
+ * @returns width
33
+ */
34
+ get width(): number;
35
+ /**
36
+ * Getter returning height of target
37
+ * @returns height
38
+ */
39
+ get height(): number;
40
+ /**
41
+ * Getter which calculate span from x bounds
42
+ * @returns x span
43
+ */
44
+ get xSpan(): number;
45
+ /**
46
+ * Calculate span from y bounds
47
+ * @returns y span
48
+ */
49
+ get ySpan(): number;
50
+ /**
51
+ * Ratio between height and width
52
+ * @returns ratio
53
+ */
54
+ get viewportRatio(): number;
55
+ /**
56
+ * x ratios screen to value ratio
57
+ * @returns ratio
58
+ */
59
+ get xRatio(): number;
60
+ /**
61
+ * y scale screen to value ratio
62
+ * @returns ratio
63
+ */
64
+ get yRatio(): number;
65
+ /**
66
+ * Get z-factor
67
+ * @returns z-factor
68
+ */
69
+ get zFactor(): number;
70
+ /**
71
+ * Set z factor
72
+ * @param factor
73
+ */
74
+ set zFactor(factor: number);
75
+ /**
76
+ * Check if x is inverted (right to left is positive) from x bounds
77
+ * @returns true if inverted
78
+ */
79
+ get isXInverted(): boolean;
80
+ /**
81
+ * Check if y is inverted (bottom to top is positive) from y bounds
82
+ * @returns true if inverted
83
+ */
84
+ get isYInverted(): boolean;
85
+ /**
86
+ * Get if enable translate extent (pan limit)
87
+ * @returns true if enabled
88
+ */
89
+ get enableTranslateExtent(): boolean;
90
+ /**
91
+ * Set enable translate extent (pan limit)
92
+ * @param enabled - If should be enabled
93
+ */
94
+ set enableTranslateExtent(enabled: boolean);
95
+ /**
96
+ * Update translate extent (pan limits)
97
+ */
98
+ updateTranslateExtent(): void;
99
+ /**
100
+ * Create an event object from current state
101
+ */
102
+ currentStateAsEvent(): OnRescaleEvent;
103
+ /**
104
+ * Update scale
105
+ */
106
+ rescale(): void;
107
+ /**
108
+ * Initialized handler
109
+ */
110
+ init(): void;
111
+ /**
112
+ * Handle zoom
113
+ */
114
+ onZoom(event: {
115
+ transform: ZoomTransform;
116
+ }): void;
117
+ /**
118
+ * Update scale
119
+ */
120
+ applyTransform(transform: ZoomTransform): void;
121
+ /**
122
+ * Set new viewport
123
+ * @param cx - center X pos
124
+ * @param cy - center Y pos
125
+ * @param displ
126
+ * @param duration - duration of transition
127
+ * @returns a merge of filter and payload
128
+ */
129
+ setViewport(cx?: number, cy?: number, displ?: number, duration?: number): void;
130
+ /**
131
+ * Set bounds
132
+ */
133
+ setBounds(xBounds: [number, number], yBounds: [number, number]): void;
134
+ /**
135
+ * Set bounds
136
+ */
137
+ setTranslateBounds(xBounds: [number, number], yBounds: [number, number]): void;
138
+ /**
139
+ * Adjust zoom due to changes in size of target
140
+ * @param force - force update even if size did not change
141
+ */
142
+ adjustToSize(width?: number | boolean, height?: number, force?: boolean): void;
143
+ /**
144
+ * Calculate new transform
145
+ * @param dx0
146
+ * @param dx1
147
+ * @param dy
148
+ * @returns New transformation matrix
149
+ */
150
+ calculateTransform(dx0: number, dx1: number, dy: number): ZoomTransform;
151
+ /**
152
+ * Recalcualate the transform
153
+ */
154
+ recalculateZoomTransform(): void;
155
+ setZoomLevelBoundary(zoomlevels: [number, number]): ZoomPanHandler;
156
+ setMaxZoomLevel(zoomlevel: number): ZoomPanHandler;
157
+ setMinZoomLevel(zoomlevel: number): ZoomPanHandler;
158
+ }
@@ -0,0 +1,5 @@
1
+ export * from './interfaces';
2
+ export * from './IntersectionReferenceSystem';
3
+ export * from './LayerManager';
4
+ export * from './MainController';
5
+ export * from './ZoomPanHandler';
@@ -0,0 +1,37 @@
1
+ import { IntersectionReferenceSystem } from './IntersectionReferenceSystem';
2
+ import { ScaleOptions } from '../interfaces';
3
+ import { Layer } from '../layers';
4
+ export interface AxisOptions {
5
+ xLabel: string;
6
+ yLabel: string;
7
+ unitOfMeasure: string;
8
+ }
9
+ export interface ControllerOptions {
10
+ container: HTMLElement;
11
+ axisOptions?: AxisOptions;
12
+ scaleOptions?: ScaleOptions;
13
+ referenceSystem?: IntersectionReferenceSystem;
14
+ layers?: Layer<unknown>[];
15
+ path?: number[][];
16
+ }
17
+ interface OverlayEvent<T> {
18
+ target?: Element;
19
+ source: Element;
20
+ caller: T;
21
+ }
22
+ export interface OverlayResizeEvent<T> extends OverlayEvent<T> {
23
+ width: number;
24
+ height: number;
25
+ }
26
+ export interface OverlayMouseMoveEvent<T> extends OverlayEvent<T> {
27
+ x: number;
28
+ y: number;
29
+ }
30
+ export interface OverlayMouseExitEvent<T> extends OverlayEvent<T> {
31
+ }
32
+ export interface OverlayCallbacks<T> {
33
+ onMouseMove?(event: OverlayMouseMoveEvent<T>): void;
34
+ onMouseExit?(event: OverlayMouseExitEvent<T>): void;
35
+ onResize?(event: OverlayResizeEvent<T>): void;
36
+ }
37
+ export {};
@@ -0,0 +1,20 @@
1
+ import { Selection } from 'd3-selection';
2
+ import { OverlayCallbacks } from './interfaces';
3
+ export declare class Overlay<T> {
4
+ elm: Selection<Element, unknown, null, undefined>;
5
+ source: Element;
6
+ elements: {
7
+ [propName: string]: Element;
8
+ };
9
+ listeners: {
10
+ [propName: string]: OverlayCallbacks<T>;
11
+ };
12
+ enabled: boolean;
13
+ constructor(caller: T, container: HTMLElement);
14
+ create(key: string, callbacks?: OverlayCallbacks<T>): HTMLElement;
15
+ register(key: string, callbacks: OverlayCallbacks<T>): void;
16
+ remove(key: string): void;
17
+ setZIndex(zIndex: number): void;
18
+ destroy(): void;
19
+ }
20
+ export declare const overlay: <T>(caller: T, container: HTMLElement) => Overlay<T>;
@@ -0,0 +1,5 @@
1
+ /**
2
+ * Convert json input keys to camelcase
3
+ * @param {*} data
4
+ */
5
+ export declare function convertToCamelCase(data: any): any;
@@ -0,0 +1 @@
1
+ export declare function createColorTable(colorMap: string[], size: number): number[][];
@@ -0,0 +1,2 @@
1
+ export declare function findIndexOfSample(data: number[][], pos: number): number;
2
+ export declare function findSampleAtPos(data: number[][], pos: number, topLimit?: number, bottomLimit?: number): number;