Type alias ImageInfo

ImageInfo: {
    albumId?: string;
    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>;
    spacesId?: string;
    tileBasePath?: string;
    tileExtension?: string;
    tileSize: number;
    tilesId?: string;
    title?: string;
    version: number;
    width: number;
}

A Micrio image's main static image data object

Type declaration

  • Optional albumId?: string

    The album (V5+) ID

  • Optional created?: number

    Created date

  • Optional forceInfoPath?: boolean

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

  • Optional format?: string

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

  • height: number

    The original image height

    Default

    autoloaded
  • id: string

    The image id

    Required

  • Optional iiifManifest?: string

    Optional IIIF source for tiles

  • Optional is360?: boolean

    The image is 360 degrees

  • Optional isDeepZoom?: boolean

    The tiled image is in DeepZoom format

  • Optional isIIIF?: boolean

    The image has a IIIF source

  • 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 isWebP?: boolean

    The image tiles are in WebP format

  • Optional lang?: string

    The initial data language

  • Optional organisation?: Organisation

    Optional organisation data

  • path: string

    The image base path URI, with a trailing /

    Default

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

    For V5+: published revisions per language

  • Optional 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.

  • Optional spacesId?: string

    The 360 tour space ID

  • Optional tileBasePath?: string

    Use an alternative basePath for image tiles

  • Optional tileExtension?: string

    Optional custom file extension for tiles

  • tileSize: number

    The original tile size in px

    Default

    autoloaded
  • Optional tilesId?: string

    Use an alternative image ID for the image tiles

  • Optional title?: string

    The image title (default: autoloaded)

  • version: number

    The Micrio version this image was created in

    Default

    autoloaded
  • width: number

    The original image width

    Default

    autoloaded

Settings

Member Visibility

Theme