@ericchen1990/pano-view 0.2.0 → 1.0.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { ReactNode, CSSProperties, ComponentPropsWithoutRef } from 'react';
+import { CSSProperties, ReactNode, ComponentPropsWithoutRef, IframeHTMLAttributes } from 'react';
 import { Texture, ColorRepresentation, Vector3 } from 'three';
 
 declare const MAX_HOTSPOT_PITCH = 90;
@@ -29,9 +29,33 @@ type HotspotDragEvent = HotspotInteractionEvent & {
     source: "pointer";
     startPosition: HotspotPosition;
 };
+/** When a hotspot tooltip is shown. Defaults to `"always"`. */
+type HotspotTooltipTrigger = "always" | "hover" | "click";
+/** Where the tooltip sits relative to the hotspot. Defaults to `"top"`. */
+type HotspotTooltipPlacement = "top" | "bottom" | "left" | "right";
+/** Plain-text and/or image content for a hotspot tooltip. */
+type HotspotTooltipContent = {
+    text?: string;
+    image?: string;
+    imageAlt?: string;
+};
 type HotspotCommonProps = {
     id: string;
     position: HotspotPosition;
+    /**
+     * Tooltip shown at the hotspot anchor. A string is treated as `{ text }`.
+     * Defaults to always visible when content is present.
+     */
+    tooltip?: string | HotspotTooltipContent;
+    /** Defaults to `"always"`. `"hover"` and `"click"` require `interactive`. */
+    tooltipTrigger?: HotspotTooltipTrigger;
+    /** Defaults to `"top"`. */
+    tooltipPlacement?: HotspotTooltipPlacement;
+    /**
+     * Screen-space gap in CSS pixels between the hotspot edge and the tooltip.
+     * Defaults to 12.
+     */
+    tooltipOffset?: number;
     /** Angular width in degrees. Defaults to 12. */
     width?: number;
     /** Angular height in degrees. Defaults to 8. */
@@ -56,6 +80,11 @@ type HotspotCommonProps = {
     visible?: boolean;
     /** Whether the hotspot accepts pointer and keyboard interaction. Defaults to true. */
     interactive?: boolean;
+    /**
+     * Canvas cursor while this hotspot is hovered. Defaults to the viewer's
+     * `cursors.hotspot` value (`"pointer"`).
+     */
+    cursor?: CSSProperties["cursor"];
     draggable?: boolean;
     /** Required for keyboard-accessible clickable hotspots. */
     ariaLabel?: string;
@@ -96,7 +125,7 @@ type KeyboardControlsProps = {
     invert?: boolean;
     /**
      * Maximum FOV change rate in degrees per second. When omitted, no extra
-     * rate cap is applied. Usually supplied by PanoView from `controls.fovSpeed`.
+     * rate cap is applied. Usually supplied by PanoViewer from `controls.fovSpeed`.
      */
     fovSpeed?: number;
     /** Called once when the previous-scene binding is pressed. */
@@ -113,14 +142,14 @@ declare function cycleSceneId(scenes: readonly {
     id: string;
 }[], activeSceneId: string, step: 1 | -1): string | null;
 /**
- * Adds keyboard navigation to the nearest PanoView. PanoView mounts a default
- * instance; render your own to customize bindings or scene callbacks. Hold
- * movement/zoom keys for continuous motion; scene and reset bindings fire once
- * per key press.
+ * Adds keyboard navigation to the nearest PanoViewer. Enabled by default;
+ * render this component only to override properties, bindings, or scene
+ * callbacks. Hold movement/zoom keys for continuous motion; scene and reset
+ * bindings fire once per key press.
  */
 declare function KeyboardControls({ enabled, keys, rotateSpeed, zoomSpeed, shiftMultiplier, invert, fovSpeed, onPreviousScene, onNextScene, }: KeyboardControlsProps): null;
 
-type PanoViewState = {
+type PanoViewerState = {
     /** Horizontal look angle in degrees. Positive values look right. */
     yaw: number;
     /** Vertical look angle in degrees. Positive values look up. */
@@ -128,13 +157,13 @@ type PanoViewState = {
     /** Vertical perspective field of view in degrees. */
     fov: number;
 };
-type SetPanoViewOptions = {
+type SetPanoViewerOptions = {
     /** Apply the new view immediately instead of preserving current inertia. */
     immediate?: boolean;
 };
-type PanoViewHandle = {
-    getView: () => PanoViewState;
-    setView: (view: Partial<PanoViewState>, options?: SetPanoViewOptions) => void;
+type PanoViewerHandle = {
+    getView: () => PanoViewerState;
+    setView: (view: Partial<PanoViewerState>, options?: SetPanoViewerOptions) => void;
     reset: () => void;
     /** @deprecated Control an AutoRotate component's enabled prop instead. */
     startAutoRotate: () => void;
@@ -172,12 +201,12 @@ type TouchControlsOptions = {
 type PanoramaControlsOptions = {
     /**
      * Master switch for user view controls. Defaults to true. Setting
-     * `controls={false}` on PanoView still disables all user input.
+     * `controls={false}` on PanoViewer still disables all user input.
      */
     enabled?: boolean;
     /** Enables drag and zoom inertia. Defaults to true. */
     inertia?: boolean;
-    /** @deprecated Render <AutoRotate enabled /> inside PanoView instead. */
+    /** @deprecated Render <AutoRotate enabled /> inside PanoViewer instead. */
     autoRotate?: boolean;
     /** @deprecated Use AutoRotate's speed prop instead. */
     autoRotateSpeed?: number;
@@ -222,9 +251,9 @@ type PanoramaControlsOptions = {
      */
     zoomDamping?: number;
     /**
-     * Mouse channel. `true` / omit mounts defaults; `false` skips the default
-     * instance (render a custom MouseControls child); an object merges with
-     * defaults and supports `enabled`.
+     * Mouse channel. `true` / omit mounts defaults; `false` disables the
+     * default instance; an object merges with defaults and supports `enabled`.
+     * Rendering `<MouseControls />` as a child also replaces the default.
      */
     mouse?: boolean | MouseControlsOptions;
     /**
@@ -232,8 +261,8 @@ type PanoramaControlsOptions = {
      */
     touch?: boolean | TouchControlsOptions;
     /**
-     * Keyboard channel. Same shape as `mouse`. Set to false when providing a
-     * custom KeyboardControls child.
+     * Keyboard channel. Same shape as `mouse`. Rendering `<KeyboardControls />`
+     * as a child replaces the default (no need to set this to false).
      */
     keyboard?: boolean | KeyboardControlsProps;
 };
@@ -242,7 +271,7 @@ type PanoramaControlsOptions = {
 declare const MIN_PANO_CONTEXT_MENU_BACKGROUND_OPACITY = 0.4;
 type PanoContextMenuSelectContext = {
     position: PanoramaPointerEvent["position"];
-    view: PanoViewState;
+    view: PanoViewerState;
     nativeEvent: MouseEvent | PointerEvent;
     close: () => void;
 };
@@ -308,7 +337,7 @@ type PanoContextMenuAppearance = {
 };
 type PanoContextMenuRenderProps = {
     event: PanoramaPointerEvent;
-    view: PanoViewState;
+    view: PanoViewerState;
     close: () => void;
 };
 type PanoContextMenuProps = {
@@ -341,8 +370,8 @@ type PanoContextMenuProps = {
     children?: (props: PanoContextMenuRenderProps) => ReactNode;
 };
 /**
- * Custom panorama context menu. Must render inside PanoView. Prefer
- * PanoView's `contextMenu` prop for the default menu; use this component
+ * Custom panorama context menu. Must render inside PanoViewer. Prefer
+ * PanoViewer's `contextMenu` prop for the default menu; use this component
  * when replacing the default instance (`contextMenu={false}`).
  */
 declare function PanoContextMenu({ items, prepend, append, appearance, className, style, itemClassName, separatorClassName, children, }: PanoContextMenuProps): null;
@@ -362,7 +391,7 @@ type PanoContextMenuPresets = {
 /**
  * Builds reusable built-in context-menu items. Prefer preset id strings
  * (`"resetView"`, `"fullscreen"`) in `items` / `append` / `prepend` when
- * configuring `PanoView`; use this helper when assembling items manually.
+ * configuring `PanoViewer`; use this helper when assembling items manually.
  */
 declare function createPanoContextMenuPresets(actions: PanoContextMenuPresetActions): PanoContextMenuPresets;
 /** Alias for `createPanoContextMenuPresets(actions).defaults`. */
@@ -376,12 +405,33 @@ declare function resolvePanoContextMenuEntries(entries: readonly PanoContextMenu
  */
 declare function composePanoContextMenuItems(props: Pick<PanoContextMenuProps, "items" | "prepend" | "append">, presets: PanoContextMenuPresets): PanoContextMenuItem[];
 
-type PanoViewProps = Omit<ComponentPropsWithoutRef<"div">, "children" | "onChange" | "contextMenu"> & {
+/** A CSS `cursor` value applied to the panorama canvas. */
+type PanoCursor = NonNullable<CSSProperties["cursor"]>;
+/** Canvas cursor values for viewer idle, drag, and hotspot interaction. */
+type PanoCursors = {
+    /** Idle canvas cursor. Defaults to `"grab"`. */
+    default?: PanoCursor;
+    /** Cursor while dragging the panorama with the mouse. Defaults to `"grabbing"`. */
+    dragging?: PanoCursor;
+    /** Cursor while hovering an interactive hotspot. Defaults to `"pointer"`. */
+    hotspot?: PanoCursor;
+    /** Cursor while dragging a hotspot. Defaults to `"move"`. */
+    hotspotDragging?: PanoCursor;
+};
+declare const DEFAULT_PANO_CURSORS: Required<PanoCursors>;
+
+type PanoViewerProps = Omit<ComponentPropsWithoutRef<"div">, "children" | "onChange" | "contextMenu"> & {
     children?: ReactNode;
-    initialView?: Partial<PanoViewState>;
+    initialView?: Partial<PanoViewerState>;
     minFov?: number;
     maxFov?: number;
     controls?: boolean | PanoramaControlsOptions;
+    /**
+     * Canvas cursor. `true` / omit uses grab / grabbing / pointer / move;
+     * `false` leaves the canvas cursor unchanged; an object merges with the
+     * defaults (`default`, `dragging`, `hotspot`, `hotspotDragging`).
+     */
+    cursors?: boolean | PanoCursors;
     /**
      * Default context menu. `true` / omit mounts Reset view + Fullscreen;
      * `false` skips the default instance; an object merges appearance and
@@ -389,19 +439,25 @@ type PanoViewProps = Omit<ComponentPropsWithoutRef<"div">, "children" | "onChang
      * `append` to keep the defaults and add entries.
      */
     contextMenu?: boolean | PanoContextMenuProps;
-    onViewChange?: (view: PanoViewState) => void;
+    onViewChange?: (view: PanoViewerState) => void;
     onPanoramaClick?: (event: PanoramaPointerEvent) => void;
     onPanoramaDoubleClick?: (event: PanoramaPointerEvent) => void;
     onPanoramaPointerMove?: (event: PanoramaPointerEvent) => void;
     /** Canvas pixel ratio. Defaults to a capped range of 1–2. */
     dpr?: number | [number, number];
 };
-declare const PanoView: react.ForwardRefExoticComponent<Omit<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "children" | "contextMenu" | "onChange"> & {
+declare const PanoViewer: react.ForwardRefExoticComponent<Omit<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "children" | "contextMenu" | "onChange"> & {
     children?: ReactNode;
-    initialView?: Partial<PanoViewState>;
+    initialView?: Partial<PanoViewerState>;
     minFov?: number;
     maxFov?: number;
     controls?: boolean | PanoramaControlsOptions;
+    /**
+     * Canvas cursor. `true` / omit uses grab / grabbing / pointer / move;
+     * `false` leaves the canvas cursor unchanged; an object merges with the
+     * defaults (`default`, `dragging`, `hotspot`, `hotspotDragging`).
+     */
+    cursors?: boolean | PanoCursors;
     /**
      * Default context menu. `true` / omit mounts Reset view + Fullscreen;
      * `false` skips the default instance; an object merges appearance and
@@ -409,13 +465,13 @@ declare const PanoView: react.ForwardRefExoticComponent<Omit<Omit<react.Detailed
      * `append` to keep the defaults and add entries.
      */
     contextMenu?: boolean | PanoContextMenuProps;
-    onViewChange?: (view: PanoViewState) => void;
+    onViewChange?: (view: PanoViewerState) => void;
     onPanoramaClick?: (event: PanoramaPointerEvent) => void;
     onPanoramaDoubleClick?: (event: PanoramaPointerEvent) => void;
     onPanoramaPointerMove?: (event: PanoramaPointerEvent) => void;
     /** Canvas pixel ratio. Defaults to a capped range of 1–2. */
     dpr?: number | [number, number];
-} & react.RefAttributes<PanoViewHandle>>;
+} & react.RefAttributes<PanoViewerHandle>>;
 
 /** Options for automatic horizontal panorama rotation. */
 type AutoRotateProps = {
@@ -432,8 +488,8 @@ type AutoRotateProps = {
     startDelay?: number;
 };
 /**
- * Adds automatic rotation to the nearest PanoView. Render one instance as a
- * child of PanoView, alongside its panorama source.
+ * Adds automatic rotation to the nearest PanoViewer. Render one instance as a
+ * child of PanoViewer, alongside its panorama source.
  */
 declare function AutoRotate({ enabled, speed, acceleration, startDelay, }: AutoRotateProps): null;
 
@@ -451,8 +507,8 @@ type ViewInteractionEvent = {
     source: ViewInteractionSource;
 };
 type PanoEventMap = {
-    viewchange: PanoViewState;
-    viewsettled: PanoViewState;
+    viewchange: PanoViewerState;
+    viewsettled: PanoViewerState;
     viewinteractionstart: ViewInteractionEvent;
     viewinteractionend: ViewInteractionEvent;
     click: PanoramaPointerEvent;
@@ -484,8 +540,8 @@ type PanoEventsProps = {
      * Each PanoEvents instance tracks idle independently.
      */
     idleTime?: number;
-    onViewChange?: (view: PanoViewState) => void;
-    onViewSettled?: (view: PanoViewState) => void;
+    onViewChange?: (view: PanoViewerState) => void;
+    onViewSettled?: (view: PanoViewerState) => void;
     onViewInteractionStart?: (event: ViewInteractionEvent) => void;
     onViewInteractionEnd?: (event: ViewInteractionEvent) => void;
     onClick?: (event: PanoramaPointerEvent) => void;
@@ -505,12 +561,12 @@ type PanoEventsProps = {
     onAutoRotateOneRound?: () => void;
 };
 /**
- * Subscribes to viewer-level panorama events. Must run inside PanoView.
+ * Subscribes to viewer-level panorama events. Must run inside PanoViewer.
  * Prefer the {@link PanoEvents} component for declarative usage.
  */
 declare function usePanoEvents({ idleTime, onViewChange, onViewSettled, onViewInteractionStart, onViewInteractionEnd, onClick, onDoubleClick, onPointerDown, onPointerUp, onPointerMove, onContextMenu, onWheel, onIdle, onIdleEnd, onEnterFullscreen, onExitFullscreen, onResize, onAutoRotateStart, onAutoRotateStop, onAutoRotateOneRound, }: PanoEventsProps): void;
 /**
- * Declarative viewer-level event listeners for the nearest PanoView.
+ * Declarative viewer-level event listeners for the nearest PanoViewer.
  * Multiple instances may coexist; each tracks its own idle timer.
  */
 declare function PanoEvents(props: PanoEventsProps): null;
@@ -518,21 +574,21 @@ declare function PanoEvents(props: PanoEventsProps): null;
 type MouseControlsProps = MouseControlsOptions & {
     /**
      * Maximum FOV change rate in degrees per second for wheel zoom. When
-     * omitted, no extra rate cap is applied. Usually supplied by PanoView from
+     * omitted, no extra rate cap is applied. Usually supplied by PanoViewer from
      * `controls.fovSpeed`.
      */
     fovSpeed?: number;
 };
 /**
- * Adds mouse (and pen) drag / wheel navigation to the nearest PanoView.
- * PanoView mounts a default instance; render your own only to override.
+ * Adds mouse (and pen) drag / wheel navigation to the nearest PanoViewer.
+ * Enabled by default; render this component only to override properties.
  */
 declare function MouseControls({ enabled, rotateSpeed, zoomSpeed, wheel, invert, buttons, fovSpeed, }: MouseControlsProps): null;
 
 type TouchControlsProps = TouchControlsOptions;
 /**
- * Adds touch drag and pinch-zoom navigation to the nearest PanoView.
- * PanoView mounts a default instance; render your own only to override.
+ * Adds touch drag and pinch-zoom navigation to the nearest PanoViewer.
+ * Enabled by default; render this component only to override properties.
  */
 declare function TouchControls({ enabled, rotateSpeed, invert, pinchZoom, }: TouchControlsProps): null;
 
@@ -612,40 +668,40 @@ type TileProps = {
     onLevelChange?: (level: number) => void;
 };
 
-type PanoramaTransitionPreset = "none" | "crossfade" | "zoom" | "blackout" | "whiteFlash" | "slideRightToLeft" | "slideTopToBottom" | "slideDiagonal" | "circleOpen" | "verticalOpen" | "horizontalOpen" | "ellipticZoomOpen";
-type PanoramaTransition = PanoramaTransitionPreset | {
-    preset: PanoramaTransitionPreset;
+type SceneTransitionPreset = "none" | "crossfade" | "zoom" | "blackout" | "whiteFlash" | "slideRightToLeft" | "slideTopToBottom" | "slideDiagonal" | "circleOpen" | "verticalOpen" | "horizontalOpen" | "ellipticZoomOpen";
+type SceneTransition = SceneTransitionPreset | {
+    preset: SceneTransitionPreset;
     /** Overrides the KRpano-compatible default duration in seconds. */
     duration?: number;
 };
-type SpherePanoramaScene = {
+type SphereScene = {
     id: string;
     type: "sphere";
     src: string;
     yawOffset?: number;
 };
-type TilePanoramaScene = Omit<TileProps, "loadMode" | "visible" | "onReady" | "onPreviewError" | "onLoadProgress" | "onTileError" | "onLevelChange"> & {
+type TileScene = Omit<TileProps, "loadMode" | "visible" | "onReady" | "onPreviewError" | "onLoadProgress" | "onTileError" | "onLevelChange"> & {
     id: string;
     type: "tile";
 };
-type PanoramaScene = SpherePanoramaScene | TilePanoramaScene;
-type PanoramaTransitionEndEvent = {
+type Scene = SphereScene | TileScene;
+type SceneTransitionEndEvent = {
     previousSceneId: string;
     sceneId: string;
-    preset: PanoramaTransitionPreset;
+    preset: SceneTransitionPreset;
 };
-type PanoramaTransitionErrorEvent = {
+type SceneTransitionErrorEvent = {
     sceneId: string;
     error: unknown;
 };
-type PanoramaScenesProps = {
-    scenes: readonly PanoramaScene[];
+type ScenesProps = {
+    scenes: readonly Scene[];
     activeSceneId: string;
-    transition?: PanoramaTransition;
+    transition?: SceneTransition;
     /** Rendered only after a scene has finished transitioning in. */
-    renderHotspots?: (scene: PanoramaScene) => ReactNode;
-    onTransitionEnd?: (event: PanoramaTransitionEndEvent) => void;
-    onTransitionError?: (event: PanoramaTransitionErrorEvent) => void;
+    renderHotspots?: (scene: Scene) => ReactNode;
+    onTransitionEnd?: (event: SceneTransitionEndEvent) => void;
+    onTransitionError?: (event: SceneTransitionErrorEvent) => void;
     /** Viewer-wide budget shared by every tile scene. Defaults to 128 MiB. */
     maxTextureMemoryMb?: number;
     /** Viewer-wide tile request limit. Defaults to 4. */
@@ -653,7 +709,7 @@ type PanoramaScenesProps = {
     /** Maximum physical-pixel area of the outgoing GPU snapshot. */
     snapshotMaxPixels?: number;
 };
-declare function PanoramaScenes({ maxTextureMemoryMb, maxConcurrentTileLoads, ...props }: PanoramaScenesProps): react.JSX.Element;
+declare function Scenes({ maxTextureMemoryMb, maxConcurrentTileLoads, ...props }: ScenesProps): react.JSX.Element;
 
 type ImageHotspotProps = HotspotCommonProps & {
     src: string;
@@ -824,6 +880,59 @@ type VideoHotspotProps = HotspotCommonProps & {
 };
 declare function VideoHotspot({ id, src, playing, poster, loop, muted, volume, playsInline, preload, crossOrigin, width, height, opacity, onPlaybackStateChange, onPlaybackError, onEnded, onError, ...anchorProps }: VideoHotspotProps): react.JSX.Element;
 
+type TextHotspotAlign = "left" | "center" | "right";
+type TextHotspotVerticalAlign = "top" | "middle" | "bottom";
+type TextHotspotWhiteSpace = "normal" | "nowrap";
+type TextHotspotFontStyle = "normal" | "italic";
+/** Serializable typography and panel paint for a text hotspot. */
+type TextHotspotStyle = {
+    fontFamily?: string;
+    /** Fraction of the texture height. Defaults to 0.18. */
+    fontSize?: number;
+    fontWeight?: number | string;
+    fontStyle?: TextHotspotFontStyle;
+    color?: string;
+    /** CSS color. An empty string skips the panel fill. */
+    background?: string;
+    backgroundOpacity?: number;
+    /** Fraction of the texture's shorter side. */
+    padding?: number;
+    align?: TextHotspotAlign;
+    verticalAlign?: TextHotspotVerticalAlign;
+    lineHeight?: number;
+    whiteSpace?: TextHotspotWhiteSpace;
+    /** Fraction of the texture's shorter side, from 0 to 0.5. */
+    borderRadius?: number;
+    stroke?: string;
+    strokeWidth?: number;
+};
+type TextHotspotProps = HotspotCommonProps & TextHotspotStyle & {
+    text: string;
+    onLoad?: (texture: Texture) => void;
+    onError?: (error: unknown) => void;
+};
+declare function TextHotspot({ text, width, height, opacity, fontFamily, fontSize, fontWeight, fontStyle, color, background, backgroundOpacity, padding, align, verticalAlign, lineHeight, whiteSpace, borderRadius, stroke, strokeWidth, onLoad, onError, ...anchorProps }: TextHotspotProps): react.JSX.Element;
+
+type IframePointerPolicy = "hotspot" | "content";
+type IframeHotspotProps = HotspotCommonProps & {
+    src: string;
+    /** Accessible iframe title. Falls back to ariaLabel. */
+    title?: string;
+    sandbox?: string;
+    allow?: string;
+    referrerPolicy?: IframeHTMLAttributes<HTMLIFrameElement>["referrerPolicy"];
+    loading?: "eager" | "lazy";
+    /**
+     * `hotspot` lets panorama pointer events hit the WebGL plane.
+     * `content` makes the embedded page interactive.
+     */
+    pointerPolicy?: IframePointerPolicy;
+    background?: string;
+    onLoad?: () => void;
+    onError?: (error: unknown) => void;
+};
+declare function IframeHotspot({ src, title, sandbox, allow, referrerPolicy, loading, pointerPolicy, background, opacity, width, height, onLoad, onError, ...anchorProps }: IframeHotspotProps): react.JSX.Element;
+
 declare function Tile({ baseUrl, multires, previewUrl, previewFaceOrder, urlTemplate, resolveTileUrl, maxTextureMemoryMb, maxConcurrentLoads, retryCount, loadMode, visible, onReady, onPreviewError, onLoadProgress, onTileError, onLevelChange, }: TileProps): react.JSX.Element;
 
 declare function normalizePanoYaw(yaw: number): number;
@@ -832,6 +941,8 @@ declare function normalizePanoPosition(position: HotspotPosition): HotspotPositi
 declare function panoPositionToVector3(position: HotspotPosition, radius?: number): Vector3;
 declare function vector3ToPanoPosition(vector: Pick<Vector3, "x" | "y" | "z">): HotspotPosition;
 
+declare const DEFAULT_HOTSPOT_TOOLTIP_OFFSET = 12;
+
 /** Shared serializable fields for every saved hotspot definition. */
 type HotspotDefinitionBase = {
     id: string;
@@ -839,7 +950,13 @@ type HotspotDefinitionBase = {
     label?: string;
     visible?: boolean;
     interactive?: boolean;
+    /** Canvas cursor while this hotspot is hovered. */
+    cursor?: CSSProperties["cursor"];
     renderOrder?: number;
+    tooltip?: string | HotspotTooltipContent;
+    tooltipTrigger?: HotspotTooltipTrigger;
+    tooltipPlacement?: HotspotTooltipPlacement;
+    tooltipOffset?: number;
 };
 /** Shared serializable fields for a hotspot anchored at one yaw/pitch point. */
 type PointHotspotDefinitionBase = HotspotDefinitionBase & {
@@ -883,6 +1000,21 @@ type VideoHotspotDefinition = PointHotspotDefinitionBase & {
     preload?: "none" | "metadata" | "auto";
     crossOrigin?: "" | "anonymous" | "use-credentials";
 };
+type TextHotspotDefinition = PointHotspotDefinitionBase & TextHotspotStyle & {
+    type: "text";
+    text: string;
+};
+type IframeHotspotDefinition = PointHotspotDefinitionBase & {
+    type: "iframe";
+    src: string;
+    title?: string;
+    sandbox?: string;
+    allow?: string;
+    referrerPolicy?: string;
+    loading?: "eager" | "lazy";
+    pointerPolicy?: IframePointerPolicy;
+    background?: string;
+};
 type PolygonHotspotDefinition = HotspotDefinitionBase & {
     type: "polygon";
     vertices: HotspotPosition[];
@@ -892,7 +1024,7 @@ type PolygonHotspotDefinition = HotspotDefinitionBase & {
     strokeWidth?: number;
     strokeOpacity?: number;
 };
-/** An open path. This extends the original five hotspot categories. */
+/** An open path. This extends the original point and polygon hotspot categories. */
 type PolylineHotspotDefinition = HotspotDefinitionBase & {
     type: "polyline";
     vertices: HotspotPosition[];
@@ -900,8 +1032,8 @@ type PolylineHotspotDefinition = HotspotDefinitionBase & {
     strokeWidth?: number;
     strokeOpacity?: number;
 };
-type PointHotspotDefinition = ImageHotspotDefinition | GraphicHotspotDefinition | SequenceHotspotDefinition | VideoHotspotDefinition;
+type PointHotspotDefinition = ImageHotspotDefinition | GraphicHotspotDefinition | SequenceHotspotDefinition | VideoHotspotDefinition | TextHotspotDefinition | IframeHotspotDefinition;
 /** A serializable, discriminated hotspot collection item. */
 type HotspotDefinition = PointHotspotDefinition | PolygonHotspotDefinition | PolylineHotspotDefinition;
 
-export { type ArrowGraphic, AutoRotate, type AutoRotateProps, type CircleGraphic, type CubeFaceCode, type DiamondGraphic, type GraphicDefinition, GraphicHotspot, type GraphicHotspotDefinition, type GraphicHotspotProps, type HotspotCommonProps, type HotspotDefinition, type HotspotDefinitionBase, type HotspotDragEvent, type HotspotInputSource, type HotspotInteractionEvent, type HotspotMode, type HotspotPosition, type HotspotScaleMode, ImageHotspot, type ImageHotspotDefinition, type ImageHotspotProps, type KeyboardControlAction, type KeyboardControlKeys, KeyboardControls, type KeyboardControlsProps, MAX_HOTSPOT_PITCH, MIN_PANO_CONTEXT_MENU_BACKGROUND_OPACITY, type MouseControlButton, MouseControls, type MouseControlsOptions, type MouseControlsProps, PanoContextMenu, type PanoContextMenuActionItem, type PanoContextMenuAppearance, type PanoContextMenuEntry, type PanoContextMenuItem, type PanoContextMenuPresetActions, type PanoContextMenuPresetId, type PanoContextMenuPresetRef, type PanoContextMenuPresets, type PanoContextMenuProps, type PanoContextMenuRenderProps, type PanoContextMenuSelectContext, type PanoContextMenuSeparatorItem, type PanoEventBus, type PanoEventListener, type PanoEventMap, type PanoEventType, PanoEvents, type PanoEventsProps, type PanoResizeEvent, PanoView, type PanoViewHandle, type PanoViewProps, type PanoViewState, type PanoWheelEvent, type PanoramaControlsOptions, type PanoramaPointerEvent, type PanoramaScene, PanoramaScenes, type PanoramaScenesProps, type PanoramaTransition, type PanoramaTransitionEndEvent, type PanoramaTransitionErrorEvent, type PanoramaTransitionPreset, type PointHotspotDefinition, type PointHotspotDefinitionBase, PolygonHotspot, type PolygonHotspotDefinition, type PolygonHotspotProps, type PolygonValidationCode, type PolygonValidationIssue, type PolygonVerticesChangeEvent, PolylineHotspot, type PolylineHotspotDefinition, type PolylineHotspotProps, type PolylineValidationIssue, type PolylineVerticesChangeEvent, type RectangleGraphic, type RingGraphic, type SequenceFrameDirection, type SequenceFrameEvent, SequenceHotspot, type SequenceHotspotDefinition, type SequenceHotspotErrorEvent, type SequenceHotspotProps, type SequenceLoadProgress, type SequencePlaybackState, type SetPanoViewOptions, Sphere, type SpherePanoramaScene, type SphereProps, type StarGraphic, type SvgGraphic, type SvgPathGraphic, Tile, type TileAddress, type TileLoadError, type TileLoadProgress, type TileMultiresConfig, type TilePanoramaScene, type TileProps, TouchControls, type TouchControlsOptions, type TouchControlsProps, type TriangleGraphic, VideoHotspot, type VideoHotspotDefinition, type VideoHotspotErrorEvent, type VideoHotspotProps, type VideoPlaybackState, type ViewInteractionEvent, type ViewInteractionSource, clampPanoPitch, composePanoContextMenuItems, createDefaultPanoContextMenuItems, createPanoContextMenuPresets, cycleSceneId, normalizePanoPosition, normalizePanoYaw, panoPositionToVector3, resolvePanoContextMenuEntries, unwrapPolygonVertices, usePanoEvents, validatePolygonVertices, validatePolylineVertices, vector3ToPanoPosition };
+export { type ArrowGraphic, AutoRotate, type AutoRotateProps, type CircleGraphic, type CubeFaceCode, DEFAULT_HOTSPOT_TOOLTIP_OFFSET, DEFAULT_PANO_CURSORS, type DiamondGraphic, type GraphicDefinition, GraphicHotspot, type GraphicHotspotDefinition, type GraphicHotspotProps, type HotspotCommonProps, type HotspotDefinition, type HotspotDefinitionBase, type HotspotDragEvent, type HotspotInputSource, type HotspotInteractionEvent, type HotspotMode, type HotspotPosition, type HotspotScaleMode, type HotspotTooltipContent, type HotspotTooltipPlacement, type HotspotTooltipTrigger, IframeHotspot, type IframeHotspotDefinition, type IframeHotspotProps, type IframePointerPolicy, ImageHotspot, type ImageHotspotDefinition, type ImageHotspotProps, type KeyboardControlAction, type KeyboardControlKeys, KeyboardControls, type KeyboardControlsProps, MAX_HOTSPOT_PITCH, MIN_PANO_CONTEXT_MENU_BACKGROUND_OPACITY, type MouseControlButton, MouseControls, type MouseControlsOptions, type MouseControlsProps, PanoContextMenu, type PanoContextMenuActionItem, type PanoContextMenuAppearance, type PanoContextMenuEntry, type PanoContextMenuItem, type PanoContextMenuPresetActions, type PanoContextMenuPresetId, type PanoContextMenuPresetRef, type PanoContextMenuPresets, type PanoContextMenuProps, type PanoContextMenuRenderProps, type PanoContextMenuSelectContext, type PanoContextMenuSeparatorItem, type PanoCursor, type PanoCursors, type PanoEventBus, type PanoEventListener, type PanoEventMap, type PanoEventType, PanoEvents, type PanoEventsProps, type PanoResizeEvent, PanoViewer, type PanoViewerHandle, type PanoViewerProps, type PanoViewerState, type PanoWheelEvent, type PanoramaControlsOptions, type PanoramaPointerEvent, type PointHotspotDefinition, type PointHotspotDefinitionBase, PolygonHotspot, type PolygonHotspotDefinition, type PolygonHotspotProps, type PolygonValidationCode, type PolygonValidationIssue, type PolygonVerticesChangeEvent, PolylineHotspot, type PolylineHotspotDefinition, type PolylineHotspotProps, type PolylineValidationIssue, type PolylineVerticesChangeEvent, type RectangleGraphic, type RingGraphic, type Scene, type SceneTransition, type SceneTransitionEndEvent, type SceneTransitionErrorEvent, type SceneTransitionPreset, Scenes, type ScenesProps, type SequenceFrameDirection, type SequenceFrameEvent, SequenceHotspot, type SequenceHotspotDefinition, type SequenceHotspotErrorEvent, type SequenceHotspotProps, type SequenceLoadProgress, type SequencePlaybackState, type SetPanoViewerOptions, Sphere, type SphereProps, type SphereScene, type StarGraphic, type SvgGraphic, type SvgPathGraphic, TextHotspot, type TextHotspotAlign, type TextHotspotDefinition, type TextHotspotFontStyle, type TextHotspotProps, type TextHotspotStyle, type TextHotspotVerticalAlign, type TextHotspotWhiteSpace, Tile, type TileAddress, type TileLoadError, type TileLoadProgress, type TileMultiresConfig, type TileProps, type TileScene, TouchControls, type TouchControlsOptions, type TouchControlsProps, type TriangleGraphic, VideoHotspot, type VideoHotspotDefinition, type VideoHotspotErrorEvent, type VideoHotspotProps, type VideoPlaybackState, type ViewInteractionEvent, type ViewInteractionSource, clampPanoPitch, composePanoContextMenuItems, createDefaultPanoContextMenuItems, createPanoContextMenuPresets, cycleSceneId, normalizePanoPosition, normalizePanoYaw, panoPositionToVector3, resolvePanoContextMenuEntries, unwrapPolygonVertices, usePanoEvents, validatePolygonVertices, validatePolylineVertices, vector3ToPanoPosition };