videx-3d/dist/types/components/Html/WellMap/WellMap.d.ts

React 3D component library designed for sub surface visualizations in the browser

import { PropsWithChildren } from 'react';
import { WellboreHeader } from '../../../sdk/data/types/WellboreHeader';
import { WellMapStyles } from './themes';
/**
 * WellMap props
 * @expand
 */
export type WellMapProps = {
    wellIdentifier: string;
    excluded?: string[];
    selected?: string;
    onSelect?: (wellbore: string, depth: number) => void;
    depth?: number;
    onDepthChanged?: (depth: number) => void;
    color?: string;
    colors?: Record<string, string> | ((wellbore: WellboreHeader, slot: number) => string);
    interactive?: boolean;
    headless?: boolean;
    depthCursor?: boolean;
    theme?: WellMapStyles;
};
/**
 * This HTML component visualizes the trajectories of a well side-by-side according to the measured depth. It shows
 * each wellbore from its kickoff depth to the terminal end point.
 *
 * The well map supports various interactions, which can be used to control selection and camera position/focus.
 * You can customize colors by providing a color dictionary or color selection function via the `colors` prop.
 *
 * For other colors, use the `theme` prop.
 *
 * @example
 * <WellMap wellIdentifier="NO 16/2-D-1" />
 *
 * @remarks
 * The WellMap must be placed as a child of the `DataProvider` component, but outside of the R3F fiber `Canvas` component.
 *
 * @see [Storybook](/videx-3d/?path=/docs/components-html-wellmap--docs)
 * @see {@link WellMapStyles}
 * @see {@link WellMapCasingShoes}
 * @see {@link WellMapCompletionIntervals}
 * @see {@link WellMapFormations}
 * @see {@link WellMapTvd}
 * @see {@link WellMapContext}
 * @group Components
 */
export declare const WellMap: ({ wellIdentifier, excluded, selected, onSelect, depth, onDepthChanged, color, colors, interactive, headless, depthCursor, theme, children }: PropsWithChildren<WellMapProps>) => import("react/jsx-runtime").JSX.Element;