Class Canvas

Hierarchy (View Summary)

Resource
- Canvas

Constructors

constructor

new Canvas(jsonld?: any, options?: IManifestoOptions): Canvas
Parameters
- Optionaljsonld: any
- Optionaloptions: IManifestoOptions
Returns Canvas
Overrides Resource.constructor
- Defined in src/Canvas.ts:22

Properties

__jsonld

__jsonld: any

context

context: string

externalResource

externalResource: IExternalResource

id

id: string

index

index: number

options

options: IManifestoOptions

ranges

ranges: Range[]

Accessors

aspectRatio

get aspectRatio(): number
Returns number
- Defined in src/Canvas.ts:429

iiifImageResources

get iiifImageResources(): any[]
Returns any[]
- Defined in src/Canvas.ts:419

imageResources

get imageResources(): any[]
Returns any[]
- Defined in src/Canvas.ts:351

imageServiceIds

get imageServiceIds(): any[]
Returns any[]
- Defined in src/Canvas.ts:425

resourceAnnotations

get resourceAnnotations(): any[]
Returns any[]
- Defined in src/Canvas.ts:384

Methods

getAnnotations

getAnnotations(): AnnotationPage[]
Returns AnnotationPage[]
- Defined in src/Canvas.ts:225

getCanonicalImageUri

getCanonicalImageUri(w?: number): string
Parameters
- Optionalw: number
Returns string
- Defined in src/Canvas.ts:27

getChoices

getChoices(): AnnotationBody[]
Returns AnnotationBody[]
- Defined in src/Canvas.ts:433

getContent

getContent(): Annotation[]
Returns Annotation[]
- Defined in src/Canvas.ts:197

getDefaultLabel

getDefaultLabel(): string | null
Returns string | null
Inherited from Resource.getDefaultLabel
- Defined in src/ManifestResource.ts:41

getDuration

getDuration(): number | null
Returns number | null
- Defined in src/Canvas.ts:241

getFormat

getFormat(): MediaType | null
Returns MediaType | null
Inherited from Resource.getFormat
- Defined in src/Resource.ts:19

getHeight

getHeight(): number
Returns number
Overrides Resource.getHeight
- Defined in src/Canvas.ts:333

getIIIFResourceType

getIIIFResourceType(): IIIFResourceType
Returns IIIFResourceType
Inherited from Resource.getIIIFResourceType
- Defined in src/ManifestResource.ts:27

getImages

getImages(): Annotation[]
Returns Annotation[]
- Defined in src/Canvas.ts:246

getIndex

getIndex(): number
Returns number
- Defined in src/Canvas.ts:260

getLabel

getLabel(): PropertyValue
Returns PropertyValue
Inherited from Resource.getLabel
- Defined in src/ManifestResource.ts:31

getMaxDimensions

getMaxDimensions(): Size | null
Returns Size | null
- Defined in src/Canvas.ts:155

getMaxHeight

getMaxHeight(): number | null
Returns number | null
Inherited from Resource.getMaxHeight
- Defined in src/Resource.ts:65

getMaxWidth

getMaxWidth(): number
Returns number
Inherited from Resource.getMaxWidth
- Defined in src/Resource.ts:61

getMetadata

getMetadata(): LabelValuePair[]
Returns LabelValuePair[]
Inherited from Resource.getMetadata
- Defined in src/ManifestResource.ts:45

getOtherContent

getOtherContent(): Promise<AnnotationList[]>
Returns Promise<AnnotationList[]>
- Defined in src/Canvas.ts:264

getProperty

getProperty(name: string): any
Parameters
- name: string
Returns any
Inherited from Resource.getProperty
- Defined in src/JSONLDResource.ts:12

getRendering

getRendering(format: RenderingFormat): Rendering | null
Parameters
- format: RenderingFormat
Returns Rendering | null
Inherited from Resource.getRendering
- Defined in src/ManifestResource.ts:64

getRenderings

getRenderings(): Rendering[]
Returns Rendering[]
Inherited from Resource.getRenderings
- Defined in src/ManifestResource.ts:78

getRequiredStatement

getRequiredStatement(): LabelValuePair | null
Returns LabelValuePair | null
Inherited from Resource.getRequiredStatement
- Defined in src/ManifestResource.ts:105

getResources

getResources(): Annotation[]
Returns Annotation[]
Inherited from Resource.getResources
- Defined in src/Resource.ts:29

getService

getService(profile: ServiceProfile): Service | null
Parameters
- profile: ServiceProfile
Returns Service | null
Inherited from Resource.getService
- Defined in src/ManifestResource.ts:118

getServices

getServices(): Service[]
Returns Service[]
Inherited from Resource.getServices
- Defined in src/ManifestResource.ts:122

getThumbnail

getThumbnail(): Thumbnail | null
Returns Thumbnail | null
Inherited from Resource.getThumbnail
- Defined in src/ManifestResource.ts:126

getType

getType(): ExternalResourceType | null
Returns ExternalResourceType | null
Inherited from Resource.getType
- Defined in src/Resource.ts:43

getViewingHint

getViewingHint(): ViewingHint | null
Returns ViewingHint | null
- Defined in src/Canvas.ts:337

getWidth

getWidth(): number
Returns number
Overrides Resource.getWidth
- Defined in src/Canvas.ts:329

isAnnotation

isAnnotation(): boolean
Returns boolean
Inherited from Resource.isAnnotation
- Defined in src/ManifestResource.ts:140

isCanvas

isCanvas(): boolean
Returns boolean
Inherited from Resource.isCanvas
- Defined in src/ManifestResource.ts:144

isCollection

isCollection(): boolean
Returns boolean
Inherited from Resource.isCollection
- Defined in src/ManifestResource.ts:148

isManifest

isManifest(): boolean
Returns boolean
Inherited from Resource.isManifest
- Defined in src/ManifestResource.ts:152

isRange

isRange(): boolean
Returns boolean
Inherited from Resource.isRange
- Defined in src/ManifestResource.ts:156

isSequence

isSequence(): boolean
Returns boolean
Inherited from Resource.isSequence
- Defined in src/ManifestResource.ts:160

onFragment

onFragment(id: any): any
Returns the fragment placement values if a resourceAnnotation is placed on a canvas somewhere besides the full extent
Parameters
- id: any
Returns any
- Defined in src/Canvas.ts:404

resourceAnnotation

resourceAnnotation(id: any): any
Returns a given resource Annotation, based on a contained resource or body id
Parameters
- id: any
Returns any
- Defined in src/Canvas.ts:392