Type alias ImageInfo

ImageInfo: {
    id: string;
    path: string;
    version: number;
    width: number;
    height: number;
    tileSize: number;
    settings: Partial<Settings>;
    tilesId?: string;
    tileExtension?: string;
    title?: string;
    slug?: string;
    lang?: string;
    cultures?: string;
    is360?: boolean;
    isWebP?: boolean;
    isPng?: boolean;
    isSingle?: boolean;
    format?: string;
    iiifManifest?: string;
    legacyTiles?: boolean;
    links?: string[];
}

A Micrio image's main static image data object

Type declaration

  • id: string

    The image id

    Required

  • path: string

    The image base path URI, with a trailing /

    Default

    https://b.micr.io/

  • version: number

    The Micrio version this image was created in

    Default

    autoloaded

  • width: number

    The original image width

    Default

    autoloaded

  • height: number

    The original image height

    Default

    autoloaded

  • tileSize: number

    The original tile size in px

    Default

    autoloaded

  • settings: Partial<Settings>

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

  • Optional tilesId?: string

    Use an alternative image ID for the image tiles

  • Optional tileExtension?: string

    Optional custom file extension for tiles

  • Optional title?: string

    The image title (default: autoloaded)

  • Optional slug?: string

    The image slug (default: autoloaded)

  • Optional lang?: string

    The initial data language

  • Optional cultures?: string

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

  • Optional is360?: boolean

    The image is 360 degrees

  • Optional isWebP?: boolean

    The image tiles are in WebP format

  • Optional isPng?: boolean

    The image tiles are in PNG format

  • Optional isSingle?: boolean

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

  • Optional format?: string

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

  • Optional iiifManifest?: string

    Optional IIIF source for tiles

  • Optional legacyTiles?: boolean

    Use this for old (<1.8) versions of Micrio

  • Optional links?: string[]

    [Spaces] The linked Micrio IDs

Settings

Member Visibility

Theme

Generated using TypeDoc