Class Canvas

__jsonld

context

externalResource

id

index

options

getDefaultLabel

• getDefaultLabel(): null | string

  Returns null | string

getFormat

• getFormat(): null | MediaType

  Returns null | MediaType

getIIIFResourceType

• getIIIFResourceType(): IIIFResourceType

  Returns IIIFResourceType

getLabel

• getLabel(): PropertyValue

  returns the PropertyValue which in turn allows a language-specific string encoded in the json as the "label" property

  Returns PropertyValue

  Example

  var label = manifest.getLabel().getValue(); // returns the string for default locale
  Copy

  Example

  var label = manifest.getLabel().getValue(locale); // locale a string , examples
                                                    // would be "fr", "en-US",
  Copy

getMaxHeight

• getMaxHeight(): null | number

  Returns null | number

getMaxWidth

• getMaxWidth(): number

  Returns number

getMetadata

• getMetadata(): LabelValuePair[]

  Returns LabelValuePair[]

getProperty

• getProperty(name: string): any

  Parameters

  • name: string

  Returns any

getPropertyAsObject

• getPropertyAsObject(name: string): any

  A function that wraps the getProperty function, which client code can use if it is needed to identify when the json value of a property is an IRI -- Internationalized Resource Identifier

  If the value of the json value is a bare string, then it will be wrapped in a json object with the string in the property 'id', additionally that property will have a property 'isIRI' which will be true for the literal string case, otherwise false meaning the returned getProperty should be parsed as before.

  Parameters

  • name: string

  Returns any

getRendering

• getRendering(format: RenderingFormat): null | Rendering

  Parameters

  • format: RenderingFormat

  Returns null | Rendering

getRenderings

• getRenderings(): Rendering[]

  Returns Rendering[]

getRequiredStatement

• getRequiredStatement(): null | LabelValuePair

  Returns null | LabelValuePair

getResources

• getResources(): Annotation[]

  Returns Annotation[]

getService

• getService(profile: ServiceProfile): null | Service

  Parameters

  • profile: ServiceProfile

  Returns null | Service

getServices

• getServices(): Service[]

  Returns Service[]

getSummary

• getSummary(): PropertyValue

  Returns PropertyValue

getThumbnail

• getThumbnail(): null | Thumbnail

  Returns null | Thumbnail

getType

• getType(): null | ExternalResourceType

  Returns null | ExternalResourceType

isAnnotation

• isAnnotation(): boolean

  Returns boolean

isCanvas

• isCanvas(): boolean

  Returns boolean

isCollection

• isCollection(): boolean

  Returns boolean

isManifest

• isManifest(): boolean

  Returns boolean

isRange

• isRange(): boolean

  Returns boolean

isScene

• isScene(): boolean

  Returns boolean

isSequence

• isSequence(): boolean

  Returns boolean