Interface GridImage

Virtual ImageInfo extension to support grid logic

interface GridImage {
    albumId?: string;
    area?: View;
    created?: number;
    forceInfoPath?: boolean;
    format?: string;
    height?: number;
    id?: string;
    iiifManifest?: string;
    is360?: boolean;
    isDeepZoom?: boolean;
    isIIIF?: boolean;
    isPng?: boolean;
    isSingle?: boolean;
    isWebP?: boolean;
    lang?: string;
    organisation?: Organisation;
    path?: string;
    revision?: RevisionType;
    settings?: Partial<Settings>;
    size: [number, number?];
    spacesId?: string;
    tileBasePath?: string;
    tileExtension?: string;
    tileSize?: number;
    tilesId?: string;
    title?: string;
    version?: number;
    view?: View;
    width?: number;
}

Hierarchy

Properties

albumId? area? created? forceInfoPath? format? height? id? iiifManifest? is360? isDeepZoom? isIIIF? isPng? isSingle? isWebP? lang? organisation? path? revision? settings? size spacesId? tileBasePath? tileExtension? tileSize? tilesId? title? version? view? width?

Properties

Optional albumId

albumId?: string

The album (V5+) ID

Optional area

area?: View

Optional created

created?: number

Created date

Optional forceInfoPath

forceInfoPath?: boolean

Force the path attribute to be used to get the info.json data

Optional format

format?: string

A custom format (dz for DeepZoom, iiif for IIIF)

Optional height

height?: number

The original image height

Default

autoloaded

Optional id

id?: string

The image id

Required

Optional iiifManifest

iiifManifest?: string

Optional IIIF source for tiles

Optional is360

is360?: boolean

The image is 360 degrees

Optional isDeepZoom

isDeepZoom?: boolean

The tiled image is in DeepZoom format

Optional isIIIF

isIIIF?: boolean

The image has a IIIF source

Optional isPng

isPng?: boolean

The image tiles are in PNG format

Optional isSingle

isSingle?: boolean

Use a custom, single source uri for the zoomable image / video

Optional isWebP

isWebP?: boolean

The image tiles are in WebP format

Optional lang

lang?: string

The initial data language

Optional organisation

organisation?: Organisation

Optional organisation data

Optional path

path?: string

The image base path URI, with a trailing /

Default

https://b.micr.io/

Optional revision

revision?: RevisionType

For V5+: published revisions per language

Optional settings

settings?: Partial<Settings>

The image settings, such as viewport/UI settings, camera and user event behavior NOTE: to modify this at runtime, use the MicrioImage.settings Writable store.

size

size: [number, number?]

Optional spacesId

spacesId?: string

The 360 tour space ID

Optional tileBasePath

tileBasePath?: string

Use an alternative basePath for image tiles

Optional tileExtension

tileExtension?: string

Optional custom file extension for tiles

Optional tileSize

tileSize?: number

The original tile size in px

Default

autoloaded

Optional tilesId

tilesId?: string

Use an alternative image ID for the image tiles

Optional title

title?: string

The image title (default: autoloaded)

Optional version

version?: number

The Micrio version this image was created in

Default

autoloaded

Optional view

view?: View

Optional width

width?: number

The original image width

Default

autoloaded

Settings

Member Visibility

Theme

On This Page

albumIdareacreatedforceInfoPathformatheightidiiifManifestis360isDeepZoomisIIIFisPngisSingleisWebPlangorganisationpathrevisionsettingssizespacesIdtileBasePathtileExtensiontileSizetilesIdtitleversionviewwidth