API documentation

An instance of an IIIF image service.

Compose URL for retrieving an image from an IIIF service.

url(img, service; w, extension)

Arguments

• url Cite2Urn for an image.
• service IIIFService
• ht Height of resulting image in pixels.
• extension Extension for file name on server.

Compose markdown wrapping an IIIF URL for retrieving an image.

markdownImage(img, service; w, caption)

Arguments

• img Cite2Urn for an image.
• service IIIFService
• ht Height of resulting image in pixels.

Compose markdown wrapping IIIF URL for image linked to an image citation tool installation.

linkedMarkdownImage(
    ict,
    img,
    service;
    w,
    caption,
    extension
)

Arguments

• ict URL of an instance of the CiteArchitecture ImageCitationTool.
• img Cite2Urn for an image.
• service IIIFService
• w Width of resulting image in pixels.
• caption Caption to embed in resulting linked markdown string.

Given a region-of-interest string, compose percent expression for IIIF.

pctString(s)

Argument

• s string with four comma-separated ROI values

Given a CITE2 URN with region-of-interest subreference, compose percent expression for IIIF.

pctString(u)

Given a region-of-interest string, compute percent values, with result rounded to a given number of digits.

roiFloats(s)
roiFloats(s, digits)

Arguments

• s string with four comma-separated ROI values
• digits precision of resulting float