matterviz 0.3.6 → 0.4.0

package/dist/plot/core/types.d.ts

@@ -0,0 +1,771 @@
+import type { D3SymbolName } from '../../labels';
+import type { Point2D, Point3D, Vec2, Vec3 } from '../../math';
+import type DraggablePane from '../../overlays/DraggablePane.svelte';
+import type { ComponentProps, Snippet } from 'svelte';
+import type { HTMLAttributes } from 'svelte/elements';
+import type { TweenOptions } from 'svelte/motion';
+import type { Sides } from './layout';
+import type PlotLegend from './components/PlotLegend.svelte';
+import type { TicksOption } from './scales';
+export type { TweenOptions } from 'svelte/motion';
+export type { BandwidthOption, BoxHandlerProps, BoxPlotSeries, ViolinKind, ViolinSide, WhiskerMode, } from '../box/box-plot';
+export type { CleaningConfig, CleaningQuality, CleaningResult, InstabilityResult, InvalidValueMode, LocalOutlierConfig, LocalOutlierResult, OscillationWeights, PhysicalBounds, SmoothingConfig, TruncationMode, } from './data-cleaning';
+export type { SankeyData, SankeyHandlerProps, SankeyLink, SankeyLinkColorMode, SankeyLinkHandlerProps, SankeyNode, SankeyNodeAlign, SankeyNodeHandlerProps, SankeyOrientation, } from '../sankey/sankey-types';
+export type { SunburstLabelRotation, SunburstLabelText, SunburstNode, SunburstNodeHandlerProps, SunburstShape, SunburstSort, SunburstValueMode, } from '../sunburst/sunburst';
+export type XyShift = {
+    x?: number;
+    y?: number;
+};
+export type InitialRanges = {
+    initial_x_range: Vec2;
+    initial_x2_range: Vec2;
+    initial_y_range: Vec2;
+    initial_y2_range: Vec2;
+};
+export type AxisRanges = {
+    x: Vec2;
+    x2: Vec2;
+    y: Vec2;
+    y2: Vec2;
+};
+export type Point<Metadata = Record<string, unknown>> = {
+    x: number;
+    y: number;
+    metadata?: Metadata;
+    offset?: Point2D;
+};
+export interface PointStyle {
+    fill?: string;
+    radius?: number;
+    stroke?: string;
+    stroke_width?: number;
+    stroke_opacity?: number;
+    fill_opacity?: number;
+    symbol_type?: D3SymbolName;
+    symbol_size?: number | null;
+    shape?: string;
+    cursor?: string;
+    is_highlighted?: boolean;
+    highlight_color?: string;
+    highlight_effect?: `pulse` | `glow` | `size` | `color` | `both`;
+}
+export interface HoverStyle {
+    enabled?: boolean;
+    scale?: number;
+    stroke?: string;
+    stroke_width?: number;
+    brightness?: number;
+}
+export interface LabelStyle {
+    text?: string;
+    offset?: Point2D;
+    font_size?: string;
+    font_family?: string;
+    auto_placement?: boolean;
+    size?: {
+        width: number;
+        height: number;
+    };
+}
+export interface BarStyle {
+    color?: string;
+    opacity?: number;
+    stroke_width?: number;
+    stroke_color?: string;
+    stroke_opacity?: number;
+    border_radius?: number;
+    rx?: number;
+    ry?: number;
+    [key: string]: unknown;
+}
+export interface LineStyle {
+    color?: string;
+    width?: number;
+    dash?: string;
+    [key: string]: unknown;
+}
+export interface PlotPoint<Metadata = Record<string, unknown>> extends Point<Metadata> {
+    color_value?: number | null;
+    point_style?: PointStyle;
+    point_hover?: HoverStyle;
+    point_label?: LabelStyle;
+    point_offset?: Point2D;
+    point_tween?: TweenOptions<Point2D>;
+}
+export type Markers = `line` | `points` | `line+points` | `none`;
+export interface DataSeries<Metadata = Record<string, unknown>> {
+    id?: string | number;
+    x: readonly number[];
+    y: readonly number[];
+    markers?: Markers;
+    x_axis?: `x1` | `x2`;
+    y_axis?: `y1` | `y2`;
+    color_values?: (number | null)[] | null;
+    size_values?: readonly (number | null)[] | null;
+    metadata?: Metadata[] | Metadata;
+    point_style?: PointStyle[] | PointStyle;
+    point_hover?: HoverStyle[] | HoverStyle;
+    point_label?: LabelStyle[] | LabelStyle;
+    point_offset?: Point2D[] | Point2D;
+    point_tween?: TweenOptions<Point2D>;
+    visible?: boolean;
+    label?: string;
+    legend_group?: string;
+    unit?: string;
+    line_style?: {
+        stroke?: string;
+        stroke_width?: number;
+        line_dash?: string;
+    };
+    filtered_data?: InternalPoint<Metadata>[];
+    _id?: string | number;
+    orig_series_idx?: number;
+}
+export interface InternalPoint<Metadata = Record<string, unknown>> extends PlotPoint<Metadata> {
+    series_idx: number;
+    point_idx: number;
+    size_value?: number | null;
+}
+export interface Tooltip {
+    show: boolean;
+    x: number;
+    y: number;
+    title?: string;
+    items?: {
+        label: string;
+        value: string;
+        color?: string;
+    }[];
+}
+export interface HandlerProps<Metadata = Record<string, unknown>> {
+    x: number;
+    y: number;
+    metadata?: Metadata | null;
+    label?: string | null;
+    series_idx: number;
+    x_axis: AxisConfig;
+    x2_axis?: AxisConfig;
+    y_axis: AxisConfig;
+    y2_axis?: AxisConfig;
+    fullscreen?: boolean;
+}
+export interface ScatterHandlerProps<Metadata = Record<string, unknown>> extends HandlerProps<Metadata> {
+    cx: number;
+    cy: number;
+    x_formatted: string;
+    y_formatted: string;
+    color_value?: number | null;
+    colorbar?: {
+        value?: number | null;
+        title?: string | null;
+        scale?: unknown;
+        tick_format?: string | null;
+    };
+}
+export type ScatterHandlerEvent<Metadata = Record<string, unknown>> = ScatterHandlerProps<Metadata> & {
+    event: MouseEvent;
+    point: InternalPoint<Metadata>;
+};
+export interface BarHandlerProps<Metadata = Record<string, unknown>> extends HandlerProps<Metadata> {
+    bar_idx: number;
+    orient_x: number;
+    orient_y: number;
+    active_y_axis: `y1` | `y2`;
+    active_x_axis: `x1` | `x2`;
+    color: string;
+    category_label?: string;
+}
+export interface HistogramHandlerProps<Metadata = Record<string, unknown>> extends HandlerProps<Metadata> {
+    value: number;
+    count: number;
+    property: string;
+    active_y_axis: `y1` | `y2`;
+    active_x_axis: `x1` | `x2`;
+}
+export type TimeInterval = `day` | `month` | `year`;
+export type ScaleTypeName = `linear` | `log` | `arcsinh` | `time`;
+export interface ArcsinhScaleConfig {
+    type: `arcsinh`;
+    threshold?: number;
+}
+export type ScaleType = `linear` | `log` | `arcsinh` | `time` | ArcsinhScaleConfig;
+export declare const is_scale_type_name: (val: string) => val is ScaleTypeName;
+export declare function get_scale_type_name(scale_type: ScaleType | undefined): ScaleTypeName;
+export declare function get_arcsinh_threshold(scale_type: ScaleType | undefined): number;
+export declare function is_time_scale(scale_type: ScaleType | undefined, format: string | undefined): boolean;
+export type QuadrantCounts = {
+    top_left: number;
+    top_right: number;
+    bottom_left: number;
+    bottom_right: number;
+};
+export interface LabelPlacementWeights {
+    overlap?: number;
+    marker?: number;
+    leader_cross?: number;
+    leader_text?: number;
+    distance?: number;
+    bounds?: number;
+}
+export interface LabelPlacementConfig {
+    sa_iterations?: number;
+    weights?: LabelPlacementWeights;
+    leader_line_threshold?: number;
+    max_labels?: number;
+    candidate_gap?: number;
+    max_neighbors?: {
+        count: number;
+        radius: number;
+    };
+}
+export type HoverConfig = {
+    threshold_px: number;
+};
+export type LegendConfig = Omit<ComponentProps<typeof PlotLegend>, `series_data` | `on_drag_start` | `on_drag` | `on_drag_end`> & {
+    margin?: number | Sides;
+    tween?: TweenOptions<Point2D>;
+    responsive?: boolean;
+    draggable?: boolean;
+    axis_clearance?: number;
+};
+export interface LegendItem {
+    label: string;
+    visible: boolean;
+    series_idx: number;
+    legend_group?: string;
+    item_type?: `series` | `fill`;
+    fill_idx?: number;
+    fill_source_type?: `fill_region` | `error_band`;
+    fill_source_idx?: number;
+    display_style: {
+        symbol_type?: D3SymbolName;
+        symbol_color?: string;
+        line_color?: string;
+        line_dash?: string;
+        fill_color?: string;
+        fill_opacity?: number;
+        edge_color?: string;
+        fill_gradient?: FillGradient;
+    };
+}
+export type UserContentProps = {
+    height: number;
+    width: number;
+    x_scale_fn: (x: number) => number;
+    x2_scale_fn?: (x: number) => number;
+    y_scale_fn: (y: number) => number;
+    y2_scale_fn?: (y: number) => number;
+    pad: Required<Sides>;
+    x_range: Vec2;
+    x2_range?: Vec2;
+    y_range: Vec2;
+    y2_range?: Vec2;
+    fullscreen: boolean;
+};
+export type Orientation = `vertical` | `horizontal`;
+export type BarMode = `overlay` | `stacked` | `grouped`;
+export interface BarSeries<Metadata = Record<string, unknown>> {
+    id?: string | number;
+    x: readonly (number | string)[];
+    y: readonly number[];
+    label?: string;
+    legend_group?: string;
+    color?: string;
+    bar_width?: number | readonly number[];
+    visible?: boolean;
+    metadata?: Metadata[] | Metadata;
+    labels?: readonly (string | null | undefined)[];
+    render_mode?: `bar` | `line`;
+    x_axis?: `x1` | `x2`;
+    y_axis?: `y1` | `y2`;
+    line_style?: {
+        stroke_width?: number;
+        line_dash?: string;
+    };
+    markers?: Markers;
+    color_values?: (number | null)[] | null;
+    size_values?: readonly (number | null)[] | null;
+    point_style?: PointStyle[] | PointStyle;
+    point_hover?: HoverStyle[] | HoverStyle;
+    point_label?: LabelStyle[] | LabelStyle;
+    point_offset?: Point2D[] | Point2D;
+}
+export interface TickLabelConfig {
+    inside?: boolean;
+    shift?: XyShift;
+    rotation?: number;
+}
+export interface TickConfig {
+    label?: TickLabelConfig;
+}
+export interface AxisOption {
+    key: string;
+    label: string;
+    unit?: string;
+}
+export type Y2SyncMode = `none` | `synced` | `align`;
+export declare const is_y2_sync_mode: (val: string) => val is Y2SyncMode;
+export interface Y2SyncConfig {
+    mode: Y2SyncMode;
+    align_value?: number;
+}
+export interface AxisConfig {
+    label?: string;
+    format?: string;
+    ticks?: TicksOption;
+    tick?: TickConfig;
+    scale_type?: ScaleType;
+    range?: [number | null, number | null];
+    unit?: string;
+    label_shift?: XyShift;
+    grid_style?: HTMLAttributes<SVGLineElement>;
+    color?: string | null;
+    options?: AxisOption[];
+    selected_key?: string;
+    sync?: Y2SyncConfig | Y2SyncMode;
+    categories?: readonly string[];
+}
+export interface DataLoaderResult<Metadata = Record<string, unknown>, SeriesType = DataSeries<Metadata>> {
+    series: SeriesType[];
+    axis_label?: string;
+    axis_unit?: string;
+}
+export type DataLoaderFn<Metadata = Record<string, unknown>, SeriesType = DataSeries<Metadata>> = (axis: AxisKey, property_key: string, current_series: readonly SeriesType[]) => Promise<DataLoaderResult<Metadata, SeriesType>>;
+export interface AxisLoadError {
+    axis: AxisKey;
+    key: string;
+    message: string;
+}
+export interface ColorScaleOption {
+    key: string;
+    label: string;
+    scale: string | ((t: number) => string);
+}
+export type ColorBarDataLoaderFn = (property_key: string) => Promise<{
+    range: Vec2;
+    title?: string;
+}>;
+export interface DisplayConfig {
+    x_grid?: boolean;
+    x2_grid?: boolean;
+    y_grid?: boolean;
+    y2_grid?: boolean;
+    x_zero_line?: boolean;
+    x2_zero_line?: boolean;
+    y_zero_line?: boolean;
+    y2_zero_line?: boolean;
+}
+export interface StyleOverrides {
+    point?: {
+        size?: number;
+        color?: string;
+        opacity?: number;
+        stroke_width?: number;
+        stroke_color?: string;
+        stroke_opacity?: number;
+    };
+    line?: {
+        width?: number;
+        color?: string;
+        opacity?: number;
+        dash?: string;
+    };
+    show_points?: boolean;
+    show_lines?: boolean;
+}
+export type AxisKey = `x` | `x2` | `y` | `y2`;
+export interface PlotConfig {
+    x_axis?: AxisConfig;
+    x2_axis?: AxisConfig;
+    y_axis?: AxisConfig;
+    y2_axis?: AxisConfig;
+    display?: DisplayConfig;
+}
+export interface ControlsConfig {
+    show?: boolean;
+    open?: boolean;
+    toggle_props?: ComponentProps<typeof DraggablePane>[`toggle_props`];
+    pane_props?: ComponentProps<typeof DraggablePane>[`pane_props`];
+}
+export interface PanConfig {
+    enabled?: boolean;
+    wheel_sensitivity?: number;
+    drag_sensitivity?: number;
+    touch_enabled?: boolean;
+}
+export type ControlsState = Required<PlotConfig> & {
+    show_controls: boolean;
+    controls_open: boolean;
+    range_inputs: Record<string, [number | null, number | null]>;
+};
+export interface PlotControlsProps extends PlotConfig {
+    show_controls?: boolean;
+    controls_open?: boolean;
+    children?: Snippet<[ControlsState]>;
+    post_children?: Snippet<[ControlsState]>;
+    auto_x_range?: Vec2;
+    auto_x2_range?: Vec2;
+    auto_y_range?: Vec2;
+    auto_y2_range?: Vec2;
+    has_x2_points?: boolean;
+    has_y2_points?: boolean;
+    show_ticks?: boolean;
+    controls_title?: string;
+    controls_class?: string;
+    toggle_props?: ComponentProps<typeof DraggablePane>[`toggle_props`];
+    pane_props?: ComponentProps<typeof DraggablePane>[`pane_props`];
+}
+export interface BasePlotProps {
+    range_padding?: number;
+    padding?: Sides;
+    hovered?: boolean;
+    show_controls?: boolean;
+    controls_open?: boolean;
+    controls_toggle_props?: ComponentProps<typeof DraggablePane>[`toggle_props`];
+    controls_pane_props?: ComponentProps<typeof DraggablePane>[`pane_props`];
+    fullscreen?: boolean;
+    fullscreen_toggle?: boolean;
+    change?: (data: Record<string, unknown> | null) => void;
+    children?: Snippet<[{
+        height: number;
+        width: number;
+        fullscreen?: boolean;
+    }]>;
+}
+export declare const LINE_TYPES: readonly ["solid", "dashed", "dotted"];
+export type LineType = (typeof LINE_TYPES)[number];
+export declare const CELLS_3X3: readonly ["top-left", "top-center", "top-right", "middle-left", "middle-center", "middle-right", "bottom-left", "bottom-center", "bottom-right"];
+export declare const CORNER_CELLS: readonly ["top-left", "top-right", "bottom-left", "bottom-right"];
+export type Cell3x3 = (typeof CELLS_3X3)[number];
+export type Corner = (typeof CORNER_CELLS)[number];
+export declare const DEFAULT_GRID_STYLE: {
+    readonly stroke: "var(--border-color, gray)";
+    readonly 'stroke-dasharray': "4";
+    readonly 'stroke-width': "0.5";
+};
+export declare const DEFAULT_MARKERS: "line+points";
+export declare const DEFAULT_SERIES_COLORS: readonly ["#4e79a7", "#f28e2c", "#e15759", "#76b7b2", "#59a14f", "#edc949", "#af7aa1", "#ff9da7", "#9c755f", "#bab0ab"];
+export declare const DEFAULT_SERIES_SYMBOLS: readonly ["Circle", "Square", "Triangle", "Cross", "Diamond", "Star", "Wye"];
+export interface ScatterPoint3D<Metadata = Record<string, unknown>> extends Point<Metadata> {
+    z: number;
+}
+export interface DataSeries3D<Metadata = Record<string, unknown>> extends Omit<DataSeries<Metadata>, `y_axis` | `filtered_data`> {
+    z: readonly number[];
+    filtered_data?: InternalPoint3D<Metadata>[];
+}
+export interface InternalPoint3D<Metadata = Record<string, unknown>> extends ScatterPoint3D<Metadata> {
+    series_idx: number;
+    point_idx: number;
+    color_value?: number | null;
+    size_value?: number | null;
+    point_style?: PointStyle;
+}
+export type SurfaceType = `grid` | `parametric` | `triangulated`;
+export interface Surface3DConfig {
+    id?: string | number;
+    type: SurfaceType;
+    x_range?: Vec2;
+    y_range?: Vec2;
+    resolution?: number | Vec2;
+    z_fn?: (x: number, y: number) => number;
+    u_range?: Vec2;
+    v_range?: Vec2;
+    parametric_fn?: (u: number, v: number) => Point3D;
+    points?: Point3D[];
+    triangles?: Vec3[];
+    color?: string;
+    color_fn?: (x: number, y: number, z: number) => string;
+    opacity?: number;
+    wireframe?: boolean;
+    wireframe_color?: string;
+    wireframe_width?: number;
+    visible?: boolean;
+    double_sided?: boolean;
+}
+export interface AxisConfig3D extends AxisConfig {
+    show_plane?: boolean;
+    plane_opacity?: number;
+}
+export interface DisplayConfig3D extends DisplayConfig {
+    z_grid?: boolean;
+    z_zero_line?: boolean;
+    show_axes?: boolean;
+    show_axis_labels?: boolean;
+    show_bounding_box?: boolean;
+    show_grid?: boolean;
+    projections?: {
+        xy?: boolean;
+        xz?: boolean;
+        yz?: boolean;
+    };
+    projection_opacity?: number;
+    projection_scale?: number;
+}
+export interface Scatter3DHandlerProps<Metadata = Record<string, unknown>> extends Omit<HandlerProps<Metadata>, `x_axis` | `x2_axis` | `y_axis` | `y2_axis`> {
+    z: number;
+    x_axis: AxisConfig3D;
+    y_axis: AxisConfig3D;
+    z_axis: AxisConfig3D;
+    x_formatted: string;
+    y_formatted: string;
+    z_formatted: string;
+    color_value?: number | null;
+}
+export type Scatter3DHandlerEvent<Metadata = Record<string, unknown>> = Scatter3DHandlerProps<Metadata> & {
+    event?: MouseEvent;
+    point: InternalPoint3D<Metadata>;
+};
+export type CameraProjection3D = `perspective` | `orthographic`;
+export interface PlotConfig3D {
+    x_axis?: AxisConfig3D;
+    y_axis?: AxisConfig3D;
+    z_axis?: AxisConfig3D;
+    display?: DisplayConfig3D;
+}
+export interface StyleOverrides3D extends StyleOverrides {
+    point?: StyleOverrides[`point`] & {
+        sphere_segments?: number;
+    };
+}
+export interface ControlsConfig3D extends ControlsConfig {
+    show_camera_controls?: boolean;
+    show_surface_controls?: boolean;
+}
+export type FillBoundary = {
+    type: `series`;
+    series_idx: number;
+} | {
+    type: `series`;
+    series_id: string | number;
+} | {
+    type: `constant`;
+    value: number;
+} | {
+    type: `axis`;
+    axis: `x` | `x2` | `y` | `y2`;
+    value?: number;
+} | {
+    type: `function`;
+    fn: (coord: number) => number;
+} | {
+    type: `data`;
+    values: readonly number[];
+    x?: readonly number[];
+} | number;
+export interface FillGradient {
+    type: `linear` | `radial`;
+    angle?: number;
+    center?: {
+        x: number;
+        y: number;
+    };
+    stops: readonly [number, string][];
+}
+export interface FillEdgeStyle {
+    color?: string;
+    width?: number;
+    dash?: string;
+    opacity?: number;
+}
+export interface FillHoverStyle {
+    fill?: string;
+    fill_opacity?: number;
+    edge?: FillEdgeStyle;
+    cursor?: string;
+    scale?: number;
+    stroke?: string;
+    stroke_width?: number;
+}
+export interface FillHandlerEvent {
+    event: MouseEvent | KeyboardEvent;
+    region_idx: number;
+    region_id?: string | number;
+    x: number;
+    y: number;
+    px: number;
+    py: number;
+    label?: string;
+    metadata?: Record<string, unknown>;
+}
+export type LayerZIndex = `below-grid` | `below-lines` | `below-points` | `above-all`;
+export declare const FILL_CURVE_TYPES: readonly ["linear", "monotoneX", "monotoneY", "step", "stepBefore", "stepAfter", "basis", "cardinal", "catmullRom", "natural"];
+export type FillCurveType = (typeof FILL_CURVE_TYPES)[number];
+export interface FillRegion {
+    id?: string | number;
+    label?: string;
+    upper: FillBoundary;
+    lower: FillBoundary;
+    x_range?: [number | null, number | null];
+    y_range?: [number | null, number | null];
+    where?: (x: number, y_upper: number, y_lower: number) => boolean;
+    fill?: string | FillGradient;
+    fill_opacity?: number;
+    edge_upper?: FillEdgeStyle;
+    edge_lower?: FillEdgeStyle;
+    curve?: FillCurveType;
+    step_position?: number;
+    z_index?: LayerZIndex;
+    visible?: boolean;
+    hover_style?: FillHoverStyle;
+    on_click?: (event: FillHandlerEvent) => void;
+    on_hover?: (event: FillHandlerEvent | null) => void;
+    show_in_legend?: boolean;
+    legend_group?: string;
+    metadata?: Record<string, unknown>;
+}
+export interface ErrorBand {
+    series: {
+        type: `series`;
+        series_idx: number;
+    } | {
+        type: `series`;
+        series_id: string | number;
+    };
+    error: number | readonly number[] | {
+        upper: number | readonly number[];
+        lower: number | readonly number[];
+    };
+    fill?: string;
+    fill_opacity?: number;
+    edge_style?: FillEdgeStyle;
+    id?: string | number;
+    label?: string;
+    show_in_legend?: boolean;
+}
+export interface RefLineStyle {
+    color?: string;
+    width?: number;
+    dash?: string;
+    opacity?: number;
+}
+export interface RefLineAnnotation {
+    text: string;
+    position?: `start` | `center` | `end`;
+    side?: `above` | `below` | `left` | `right`;
+    offset?: {
+        x?: number;
+        y?: number;
+    };
+    gap?: number;
+    edge_padding?: number;
+    font_size?: string;
+    font_family?: string;
+    color?: string;
+    background?: string;
+    padding?: number;
+    rotate?: boolean;
+}
+export interface RefLineEvent {
+    event: MouseEvent | KeyboardEvent | FocusEvent;
+    line_idx: number;
+    line_id?: string | number;
+    type: RefLine[`type`];
+    label?: string;
+    metadata?: Record<string, unknown>;
+}
+export interface RefLineBase {
+    id?: string | number;
+    x_span?: [number | null, number | null];
+    y_span?: [number | null, number | null];
+    coord_mode?: `data` | `relative`;
+    x_axis?: `x1` | `x2`;
+    y_axis?: `y1` | `y2`;
+    style?: RefLineStyle;
+    annotation?: RefLineAnnotation;
+    z_index?: LayerZIndex;
+    visible?: boolean;
+    hover_style?: RefLineStyle;
+    on_click?: (event: RefLineEvent) => void;
+    on_hover?: (event: RefLineEvent | null) => void;
+    show_in_legend?: boolean;
+    label?: string;
+    legend_group?: string;
+    metadata?: Record<string, unknown>;
+}
+export type RefLineValue = number | Date | string;
+export type RefLine = RefLineBase & ({
+    type: `horizontal`;
+    y: RefLineValue;
+} | {
+    type: `vertical`;
+    x: RefLineValue;
+} | {
+    type: `diagonal`;
+    slope: number;
+    intercept: number;
+} | {
+    type: `segment`;
+    p1: [RefLineValue, RefLineValue];
+    p2: [RefLineValue, RefLineValue];
+} | {
+    type: `line`;
+    p1: [RefLineValue, RefLineValue];
+    p2: [RefLineValue, RefLineValue];
+});
+export declare const REF_LINE_STYLE_DEFAULTS: Required<RefLineStyle>;
+type Ref3DBase = Omit<RefLineBase, `coord_mode` | `x_axis` | `y_axis` | `style` | `hover_style` | `annotation` | `on_click` | `on_hover`> & {
+    z_span?: [number | null, number | null];
+};
+export interface RefLine3DBase extends Ref3DBase {
+    style?: RefLineStyle;
+    hover_style?: RefLineStyle;
+    annotation?: RefLineAnnotation;
+    on_click?: (event: {
+        line_idx: number;
+        line_id?: string | number;
+    }) => void;
+    on_hover?: (event: {
+        line_idx: number;
+        line_id?: string | number;
+    } | null) => void;
+}
+export type RefLine3D = RefLine3DBase & ({
+    type: `x-axis`;
+    y: number;
+    z: number;
+} | {
+    type: `y-axis`;
+    x: number;
+    z: number;
+} | {
+    type: `z-axis`;
+    x: number;
+    y: number;
+} | {
+    type: `segment`;
+    p1: Vec3;
+    p2: Vec3;
+} | {
+    type: `line`;
+    p1: Vec3;
+    p2: Vec3;
+});
+export interface RefPlaneStyle {
+    color?: string;
+    opacity?: number;
+    wireframe?: boolean;
+    wireframe_color?: string;
+    double_sided?: boolean;
+}
+export interface RefPlaneBase extends Ref3DBase {
+    style?: RefPlaneStyle;
+}
+export type RefPlane = RefPlaneBase & ({
+    type: `xy`;
+    z: number;
+} | {
+    type: `xz`;
+    y: number;
+} | {
+    type: `yz`;
+    x: number;
+} | {
+    type: `normal`;
+    normal: Vec3;
+    point: Vec3;
+} | {
+    type: `points`;
+    p1: Vec3;
+    p2: Vec3;
+    p3: Vec3;
+});