Micrio Client - v6.0.0
    Preparing search index...

    Interface GridImage

    Virtual ImageInfo extension to support grid logic

    interface GridImage {
        albumId?: string;
        area?: CameraArray;
        body?: Partial<Models.ImageInfo.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<Models.ImageInfo.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?: CameraArray;
        viewsWH?: boolean;
        watermark?: string;
        width?: number;
    }

    Hierarchy

    Index

    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

    albumId?: string

    The album (V5+) ID

    area?: CameraArray

    Optionalbody

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

    Created date

    forceInfoPath?: boolean

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

    format?: string

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

    height?: number

    The original image height

    autoloaded
    id?: string

    The image id

    iiifManifest?: string

    Optional IIIF source for tiles

    is360?: boolean

    The image is 360 degrees

    isDeepZoom?: boolean

    The tiled image is in DeepZoom format

    isIIIF?: boolean

    The image has a IIIF source

    isPng?: boolean

    The image tiles are in PNG format

    isSingle?: boolean

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

    isWebP?: boolean

    The image tiles are in WebP format

    items?: Partial<Models.ImageInfo.ImageInfo>[]
    lang?: string

    The initial data language

    organisation?: Organisation

    Optional organisation data

    path?: string

    The image base path URI, with a trailing /

    https://b.micr.io/
    revision?: RevisionType

    For V5+: published revisions per language

    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: [number, number?]
    spacesId?: string

    The 360 tour space ID

    tileBasePath?: string

    Use an alternative basePath for image tiles

    tileExtension?: string

    Optional custom file extension for tiles

    tilesId?: string

    Use an alternative image ID for the image tiles

    tileSize?: number

    The original tile size in px

    autoloaded
    title?: string

    The image title (default: autoloaded)

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

    Single-canvas sequence -- IIIF Presentation API 3

    version?: string

    The Micrio version this image was created in

    autoloaded
    view?: CameraArray
    viewsWH?: boolean

    Has new viewport model, optimized for 360 images

    watermark?: string

    Optional watermark image URI

    width?: number

    The original image width

    autoloaded

    Settings

    Member Visibility

    On This Page

    Properties