Interface Hotspot

Represents a hotspot in a 3D scene. A hotspot is an interactive element that can be clicked or tapped to trigger an action or display additional information.

interface Hotspot {
    attach: ((element, options?) => void);
    element?: HTMLElement;
    name: string;
    position: number[];
    position3D: number[];
    visible: boolean;
}

Properties

attach element? name position position3D visible

Properties

attach

attach: ((element, options?) => void)

Attaches an html element to the hotspot for analytic events, auto positioning, and auto showing.

Type declaration

    • (element, options?): void

    • Parameters

      • element: HTMLElement

        The html element to attach.

      • Optional options: HotspotAttachOptions

        Options for attaching the element.

      Returns void

Optional element

element?: HTMLElement

The attached element.

name

name: string

The name of the hotspot.

position

position: number[]

The position of the hotspot in 2D space is specified as an array, where x and y are its coordinates, and z is the distance of the hotspot from the camera.

position3D

position3D: number[]

The position of the hotspot in the 3D world, specified as an array of [x, y, z] coordinates.

visible

visible: boolean

Whether the hotspot is currently visible in the scene.

Settings

Member Visibility

Theme

On This Page

attachelementnamepositionposition3Dvisible

Generated using TypeDoc