Interface GridImage

Virtual ImageInfo extension to support grid logic

interface GridImage {
    albumId?: string;
    area?: Models.Camera.ViewRect;
    body?: Partial<ImageInfo> & {
        format: string;
        height: number;
        service: {
            id: string;
            type: "ImageService3";
        }[];
        width: number;
    };
    created?: number;
    forceInfoPath?: boolean;
    format?: string;
    height?: number;
    id?: string;
    iiifManifest?: string;
    is360?: boolean;
    isDeepZoom?: boolean;
    isIIIF?: boolean;
    isPng?: boolean;
    isSingle?: boolean;
    isWebP?: boolean;
    items?: Partial<ImageInfo>[];
    lang?: string;
    organisation?: Organisation;
    path?: string;
    revision?: RevisionType;
    settings?: Partial<Settings>;
    size: [number, number?];
    spacesId?: string;
    tileBasePath?: string;
    tileExtension?: string;
    tilesId?: string;
    tileSize?: number;
    title?: string;
    type?:
        | "Manifest"
        | "Canvas"
        | "AnnotationPage"
        | "Annotation"
        | "Image";
    version?: string;
    view?: Models.Camera.ViewRect;
    viewsWH?: boolean;
    watermark?: string;
    width?: number;
}

Hierarchy

Properties

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

Properties

OptionalalbumId

albumId?: string

The album (V5+) ID

Optionalarea

area?: Models.Camera.ViewRect

Optionalbody

body?: Partial<ImageInfo> & {
    format: string;
    height: number;
    service: {
        id: string;
        type: "ImageService3";
    }[];
    width: number;
}

Optionalcreated

created?: number

Created date

OptionalforceInfoPath

forceInfoPath?: boolean

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

Optionalformat

format?: string

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

Optionalheight

height?: number

The original image height

Default

autoloaded

Optionalid

id?: string

The image id

OptionaliiifManifest

iiifManifest?: string

Optional IIIF source for tiles

Optionalis360

is360?: boolean

The image is 360 degrees

OptionalisDeepZoom

isDeepZoom?: boolean

The tiled image is in DeepZoom format

OptionalisIIIF

isIIIF?: boolean

The image has a IIIF source

OptionalisPng

isPng?: boolean

The image tiles are in PNG format

OptionalisSingle

isSingle?: boolean

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

OptionalisWebP

isWebP?: boolean

The image tiles are in WebP format

Optionalitems

items?: Partial<ImageInfo>[]

Optionallang

lang?: string

The initial data language

Optionalorganisation

organisation?: Organisation

Optional organisation data

Optionalpath

path?: string

The image base path URI, with a trailing /

Default

https://b.micr.io/

Optionalrevision

revision?: RevisionType

For V5+: published revisions per language

Optionalsettings

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?]

OptionalspacesId

spacesId?: string

The 360 tour space ID

OptionaltileBasePath

tileBasePath?: string

Use an alternative basePath for image tiles

OptionaltileExtension

tileExtension?: string

Optional custom file extension for tiles

OptionaltilesId

tilesId?: string

Use an alternative image ID for the image tiles

OptionaltileSize

tileSize?: number

The original tile size in px

Default

autoloaded

Optionaltitle

title?: string

The image title (default: autoloaded)

Optionaltype

type?:
    | "Manifest"
    | "Canvas"
    | "AnnotationPage"
    | "Annotation"
    | "Image"

Single-canvas sequence -- IIIF Presentation API 3

Optionalversion

version?: string

The Micrio version this image was created in

Default

autoloaded

Optionalview

view?: Models.Camera.ViewRect

OptionalviewsWH

viewsWH?: boolean

Has new viewport model, optimized for 360 images

Optionalwatermark

watermark?: string

Optional watermark image URI

Optionalwidth

width?: number

The original image width

Default

autoloaded

Settings

Member Visibility

On This Page

Properties