Micrio Client - v7.0.0
    Preparing search index...

    Class MicrioImage

    Represents and controls a single Micrio image instance within the viewer. This class manages the image's metadata (info), cultural data (data), settings, camera, state, and interactions with the compute engine for rendering and processing. It handles loading image tiles, embeds, markers, tours, and galleries associated with the image.

    Instances are typically created and managed by the main HTMLMicrioElement.

    Marcel Duin marcel@micr.io

    Index
    album? camera data error grid id omni opts state uuid video visible
    $data $info $settings
    addEmbed getEmbedMediaElement
    album?: Album

    Album information if this image is part of a V5 album.

    camera: Camera

    The virtual camera instance controlling the view for this image.

    data: Writable<ImageData.ImageData> = ...

    Writable store holding the image's cultural data (markers, tours, text content for the current language). See Models.ImageData.ImageData.

    error: string

    Stores an error message if loading failed.

    grid: Grid

    Grid controller instance, if this image is a grid container.

    id: string

    The unique identifier (Micrio ID) for this image.

    omni: OmniUI

    OmniUI instance, if this image is an omni 3D object.

    opts: { area?: CameraArray; isEmbed?: boolean; useParentCamera?: boolean }

    Options controlling this image instance's behaviour (embedding, area, parent camera usage).

    Type Declaration

    • Optionalarea?: CameraArray

      Optional sub area [x, y, width, height] defining placement within a parent canvas (for embeds/galleries).

    • OptionalisEmbed?: boolean

      If true, this image is embedded within another image (affects rendering/camera).

    • OptionaluseParentCamera?: boolean

      If true, uses the parent image's camera instead of creating its own (for switch/omni galleries).

    state: State.Image

    State manager specific to this image instance (view, active marker, etc.). See State.Image.

    uuid: string = ...

    A unique instance identifier (UUID) generated for this specific instance.

    video: Writable<HTMLVideoElement> = ...

    Writable store holding the HTMLVideoElement if this image represents a video.

    visible: Writable<boolean> = ...

    Writable store indicating if this image's canvas is currently visible and being rendered.

    • get $settings(): Settings

      Getter for the current value of the settings store.

      Returns Settings

    • Adds an embedded MicrioImage (representing another Micrio image or video) within this image.

      Parameters

      • info: Partial<ImageInfo.ImageInfo>

        Partial info data for the embed.

      • settings: Partial<Settings>

        Optional settings for the embed.

      • area: CameraArray

        The placement area [x, y, width, height] within the parent image.

      • opts: EmbedOptions = {}

        Embedding options (opacity, fit, etc.).

      Returns MicrioImage

      The newly created embedded MicrioImage instance.

    • Gets the HTMLMediaElement associated with a video embed ID.

      Parameters

      • id: string

        The embed identifier.

      Returns HTMLMediaElement

      The media element, or undefined if not found.

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods