Type Alias TAddImageOptions

TAddImageOptions: {
    flipImageToFaceCamera?: boolean;
    height: number;
    interactive?: boolean;
    maxImageSize?: number;
    rotation?: number;
    verticalOffset?: number;
    width: number;
}

Options for controlling the behavior of an Image3DView.

Type declaration

  • OptionalflipImageToFaceCamera?: boolean

    If true, the image will automatically rotate to face the camera, creating a billboard effect.

    Default

    false
  • height: number

    Height of the image in meters.

  • Optionalinteractive?: boolean

    Whether the Image3DView should be clickable. When true, click and hover events for the image will be dispatched via MapView.on('click') and MapView.on('hover') under the images property of the event payload. Can be toggled at runtime via MapView.updateState(image, { interactive }).

    Default

    false
  • OptionalmaxImageSize?: number

    Maximum image width or height in pixels. If the image's largest dimension exceeds this value, it will be scaled down proportionally. This helps prevent VRAM exhaustion on mobile devices.

    Default

    1024
  • Optionalrotation?: number

    Rotation of the image in degrees clockwise from North. 0 degrees is North, 90 degrees is East, 180 degrees is South, and 270 degrees is West.

    Default

    0
  • OptionalverticalOffset?: number

    Vertical offset of the image in meters.

    Default

    0
  • width: number

    Width of the image in meters.

Settings

Member Visibility