de.digitalcollections.iiif.presentation.model.api.v2

Interface Canvas

All Superinterfaces:

IiifResource

public interface Canvas
extends IiifResource

The canvas represents an individual page or view and acts as a central point for laying out the different content resources that make up the display. As with sequences, the name should not begin with a number. Suggested patterns are “f1r” or “p1”.

Recommended URI Pattern: {scheme}://{host}/{prefix}/{identifier}/canvas/{name}

• Each canvas should have one or more content resources associated with it. Zero is possible but unlikely; it represents the case where the page exists (or existed) but has not been digitized.
• A manifest, sequence or canvas must not have a format.
• A canvas or content resource must not have a viewing direction.

Method Summary

Modifier and Type	Method and Description
PropertyValue	getDescription()
int	getHeight()
List<Image>	getImages()
PropertyValue	getLabel()
List<Metadata>	getMetadata()
List<IiifReference>	getOtherContent()
Thumbnail	getThumbnail()
String	getViewingHint()
int	getWidth()
void	setDescription(PropertyValue description)
void	setHeight(int height)
void	setImages(List<Image> images)
void	setLabel(PropertyValue label)
void	setMetadata(List<Metadata> metadata)
void	setOtherContent(List<IiifReference> iiifReferences)
void	setThumbnail(Thumbnail thumbnail)
void	setViewingHint(String viewingHint)
void	setWidth(int width)

Methods inherited from interface de.digitalcollections.iiif.presentation.model.api.v2.IiifResource

addService, getAttribution, getId, getLicense, getLogo, getRelated, getRendering, getSeeAlso, getServices, getType, getWithin, setAttribution, setId, setId, setLicense, setLogo, setRelated, setRendering, setSeeAlso, setServices, setWithin

Method Detail

getDescription

PropertyValue getDescription()

setDescription

void setDescription(PropertyValue description)

Parameters:

description - A canvas may have a description to describe particular features of the view.

getHeight

int getHeight()

setHeight

void setHeight(int height)

getImages

List<Image> getImages()

setImages

void setImages(List<Image> images)

getLabel

PropertyValue getLabel()

setLabel

void setLabel(PropertyValue label)

getMetadata

List<Metadata> getMetadata()

setMetadata

void setMetadata(List<Metadata> metadata)

Parameters:

metadata - A canvas may have metadata pairs associated with it to describe its particular features.

getOtherContent

List<IiifReference> getOtherContent()

setOtherContent

void setOtherContent(List<IiifReference> iiifReferences)

getThumbnail

Thumbnail getThumbnail()

setThumbnail

void setThumbnail(Thumbnail thumbnail)

Parameters:

thumbnail - A canvas may have a thumbnail and should have a thumbnail if there are multiple images or resources that make up the representation.

getViewingHint

String getViewingHint()

setViewingHint

void setViewingHint(String viewingHint)

Parameters:

viewingHint - A manifest, sequence or range may have a viewing hint, with scope as per viewingDirection. A canvas may have a viewing hint, and the only hint defined by this specification for canvases is "non-paged". "non-paged" is only valid if the canvas is within a manifest, sequence or range that is "paged", and the particular canvas must not be displayed in a page-turning viewer.

getWidth

int getWidth()

setWidth

void setWidth(int width)