Class MicrioImage

An individual Micrio image

Author

Marcel Duin marcel@micr.io

Copyright

Q42 Internet BV, Micrio, 2015 - 2024

Link

https://micr.io/ , https://q42.nl/en/

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

Optional album

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

Readonly data

data: Writable<ImageData> = ...

The Micrio culture data Writable

Readonly embeds

embeds: MicrioImage[] = []

Embedded in-image children

error

error: string

Error, if any

grid

grid: Grid

Grid controller

Readonly id

id: string

The image id

Readonly info

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

  • Optional area?: View

    Optional sub area for partial / embedded images

  • Optional isEmbed?: boolean

    This is an in-image embed

  • Optional isPassive?: boolean

    Follow the movements of the main image

  • Optional secondaryTo?: MicrioImage

    For split screen, the image this is secondary to

  • Optional useParentCamera?: boolean

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

Readonly settings

settings: Writable<Settings> = ...

The image settings Writable

Readonly state

state: State.Image

State manager

swiper

swiper: GallerySwiper

Gallery swiper instance

tileBase

tileBase: string

The tile basePath

Readonly uuid

uuid: string = ...

Unique instance id

Readonly video

video: Writable<HTMLVideoElement> = ...

The 2D or 360 video MediaElement

Readonly viewport

viewport: Writable<View> = ...

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

Readonly visible

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

Theme

On This Page

albumcameradataembedserrorgrididinfoopenedViewoptssettingsstateswipertileBaseuuidvideoviewportvisiblewasm$data$info$settingsaddEmbedfadeInfadeOutgetEmbedMediaElement