@webviz/subsurface-viewer 0.11.0 → 0.12.0

package/dist/components/Map.d.ts

@@ -1,20 +1,25 @@
-import type { Color, LayersList, LayerProps, LayerContext, View, PickingInfo } from "@deck.gl/core/typed";
 import React from "react";
+import type { MjolnirGestureEvent } from "mjolnir.js";
+import type { Color, LayersList, LayerProps, LayerContext, View, PickingInfo } from "@deck.gl/core/typed";
 import type { colorTablesArray } from "@emerson-eps/color-tables/";
+import type { BoundingBox3D } from "../utils/BoundingBox3D";
 import type { Unit } from "convert-units";
 import type { LightsType } from "../SubsurfaceViewer";
-import type { MjolnirGestureEvent } from "mjolnir.js";
 /**
  * 3D bounding box defined as [xmin, ymin, zmin, xmax, ymax, zmax].
  */
-export type BoundingBox3D = [number, number, number, number, number, number];
-export type ReportBoundingBoxAction = {
-    layerBoundingBox: BoundingBox3D;
-};
+export type { BoundingBox3D };
+/**
+ * 2D bounding box defined as [left, bottom, right, top]
+ */
+export type BoundingBox2D = [number, number, number, number];
 /**
  * Type of the function returning coordinate boundary for the view defined as [left, bottom, right, top].
  */
-export type BoundsAccessor = () => [number, number, number, number];
+export type BoundsAccessor = () => BoundingBox2D;
+export type ReportBoundingBoxAction = {
+    layerBoundingBox: BoundingBox3D;
+};
 export type TooltipCallback = (info: PickingInfo) => string | Record<string, unknown> | null;
 /**
  * Views
@@ -69,7 +74,7 @@ export interface ViewportType {
  */
 export interface ViewStateType {
     target: number[];
-    zoom: number | BoundingBox3D;
+    zoom: number | BoundingBox3D | undefined;
     rotationX: number;
     rotationOrbit: number;
     minZoom?: number;
@@ -82,7 +87,18 @@ export interface DeckGLLayerContext extends LayerContext {
         colorTables: colorTablesArray;
     };
 }
+export interface MapMouseEvent {
+    type: "click" | "hover" | "contextmenu";
+    infos: PickingInfo[];
+    x?: number;
+    y?: number;
+    wellname?: string;
+    wellcolor?: Color;
+    md?: number;
+    tvd?: number;
+}
 export type EventCallback = (event: MapMouseEvent) => void;
+export declare function useHoverInfo(): [PickingInfo[], EventCallback];
 export interface MapProps {
     /**
      * The ID of this component, used to identify dash components
@@ -103,9 +119,9 @@ export interface MapProps {
      * Coordinate boundary for the view defined as [left, bottom, right, top].
      * Should be used for 2D view only.
      */
-    bounds?: [number, number, number, number] | BoundsAccessor;
+    bounds?: BoundingBox2D | BoundsAccessor;
     /**
-     * Camera state for the view defined as [left, bottom, right, top].
+     * Camera state for the view defined as a ViewStateType.
      * Should be used for 3D view only.
      * If the zoom is given as a 3D bounding box, the camera state is computed to
      * display the full box.
@@ -180,17 +196,6 @@ export interface MapProps {
     children?: React.ReactNode;
     getTooltip?: TooltipCallback;
 }
-export interface MapMouseEvent {
-    type: "click" | "hover" | "contextmenu";
-    infos: PickingInfo[];
-    x?: number;
-    y?: number;
-    wellname?: string;
-    wellcolor?: Color;
-    md?: number;
-    tvd?: number;
-}
-export declare function useHoverInfo(): [PickingInfo[], EventCallback];
 declare const Map: React.FC<MapProps>;
 export default Map;
 export declare function jsonToObject(data: Record<string, unknown>[] | LayerProps[], enums?: Record<string, unknown>[] | undefined): LayersList | View[];