Class Canvas

constructor

• new Canvas(jsonld?, options?): Canvas

• Parameters

  • Optionaljsonld: any
  • Optionaloptions: IManifestoOptions

  Returns Canvas

ranges

aspectRatio

• get aspectRatio(): number

• Returns number

iiifImageResources

• get iiifImageResources(): any

• Returns any

imageResources

• get imageResources(): any

• Returns any

imageServiceIds

• get imageServiceIds(): any

• Returns any

resourceAnnotations

• get resourceAnnotations(): any

• Returns any

getAnnotations

• getAnnotations(): AnnotationPage[]

• Returns AnnotationPage[]

getCanonicalImageUri

• getCanonicalImageUri(w?): string

• Parameters

  • Optionalw: number

  Returns string

getContent

• getContent(): Annotation[]

• Returns Annotation[]

getDuration

• getDuration(): null | number

• Returns null | number

getHeight

• getHeight(): number

• Returns number

getImages

• getImages(): Annotation[]

• Returns Annotation[]

getIndex

• getIndex(): number

• Returns number

getMaxDimensions

• getMaxDimensions(): null | Size

• Returns null | Size

getOtherContent

• getOtherContent(): Promise<AnnotationList[]>

• Returns Promise<AnnotationList[]>

getViewingHint

• getViewingHint(): null | ViewingHint

• Returns null | ViewingHint

getWidth

• getWidth(): number

• Returns number

onFragment

• onFragment(id): any

• Returns the fragment placement values if a resourceAnnotation is placed on a canvas somewhere besides the full extent

  Parameters

  • id: any

  Returns any

resourceAnnotation

• resourceAnnotation(id): any

• Returns a given resource Annotation, based on a contained resource or body id

  Parameters

  • id: any

  Returns any