Interface GridImage

Virtual ImageInfo extension to support grid logic

Hierarchy

Properties

size area? view? id? path? version? width? height? tileSize? tilesId? tileExtension? settings? title? slug? lang? cultures? is360? isWebP? isPng? isSingle? format? iiifManifest? legacyTiles? links?

Properties

size

size: [number, number?]

Optional area

area?: View

Optional view

view?: View

Optional id

id?: string

The image id

Required

Optional path

path?: string

The image base path URI, with a trailing /

Default

https://b.micr.io/

Optional version

version?: number

The Micrio version this image was created in

Default

autoloaded

Optional width

width?: number

The original image width

Default

autoloaded

Optional height

height?: number

The original image height

Default

autoloaded

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 tileExtension

tileExtension?: string

Optional custom file extension for tiles

Optional settings

settings?: Partial<Settings>

The image settings, such as viewport/UI settings, camera and user event behavior

Optional title

title?: string

The image title (default: autoloaded)

Optional slug

slug?: string

The image slug (default: autoloaded)

Optional lang

lang?: string

The initial data language

Optional cultures

cultures?: string

The available image data languages, comma-separated (default: autoloaded)

Optional is360

is360?: boolean

The image is 360 degrees

Optional isWebP

isWebP?: boolean

The image tiles are in WebP format

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 format

format?: string

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

Optional iiifManifest

iiifManifest?: string

Optional IIIF source for tiles

Optional legacyTiles

legacyTiles?: boolean

Use this for old (<1.8) versions of Micrio

Optional links

links?: string[]

[Spaces] The linked Micrio IDs

Settings

Member Visibility

Theme

Generated using TypeDoc