Class MicrioImage

An individual Micrio image

Author

Marcel Duin marcel@micr.io

Properties

album? camera data embeds error grid id info openedView opts settings state swiper tileBase uuid video viewport visible wasm

Accessors

$data $info $settings

Methods

addEmbed fadeIn fadeOut getEmbedMediaElement

Properties

Optionalalbum

album?: Album

Album info if image is part of an album (V5+)

camera

camera: Camera

The virtual camera instance to control the current main image views

Readonlydata

data: Writable<ImageData> = ...

The Micrio culture data Writable

Readonlyembeds

embeds: MicrioImage[] = []

Embedded in-image children

error

error: string

Error, if any

grid

grid: Grid

Grid controller

Readonlyid

id: string

The image id

Readonlyinfo

info: Readable<ImageInfo>

The Micrio info data Readable store

openedView

openedView: View

The last opened view

opts

opts: {
    area?: View;
    isEmbed?: boolean;
    isPassive?: boolean;
    secondaryTo?: MicrioImage;
    useParentCamera?: boolean;
} = {}

Optional settings

Type declaration

  • Optionalarea?: View

    Optional sub area for partial / embedded images

  • OptionalisEmbed?: boolean

    This is an in-image embed

  • OptionalisPassive?: boolean

    Follow the movements of the main image

  • OptionalsecondaryTo?: MicrioImage

    For split screen, the image this is secondary to

  • OptionaluseParentCamera?: boolean

    For non-independent embeds, use the parent's .camera

Readonlysettings

settings: Writable<Settings> = ...

The image settings Writable

Readonlystate

state: State.Image

State manager

swiper

swiper: GallerySwiper

Gallery swiper instance

tileBase

tileBase: string

The tile basePath

Readonlyuuid

uuid: string = ...

Unique instance id

Readonlyvideo

video: Writable<HTMLVideoElement> = ...

The 2D or 360 video MediaElement

Readonlyviewport

viewport: Writable<View> = ...

Rendered pixel rectangle [left, top, width, height]

Readonlyvisible

visible: Writable<boolean> = ...

The canvas is currently visible

wasm

wasm: Wasm

The global Wasm controller

Accessors

$data

$info

$settings

Methods

addEmbed

fadeIn

  • fadeIn(direct?): void

  • Fade in the individual image

    Parameters

    • direct: boolean = false

    Returns void

fadeOut

  • fadeOut(direct?): void

  • Parameters

    • direct: boolean = false

    Returns void

getEmbedMediaElement

  • getEmbedMediaElement(id): HTMLMediaElement

  • Get the accompanying HTMLMediaElement for any in-image video embeds

    Parameters

    • id: string

    Returns HTMLMediaElement

Settings

Member Visibility

On This Page

Properties
Accessors
Methods