Class Manifest

Hierarchy (View Summary)

IIIFResource
- Manifest

Constructors

constructor

new Manifest(jsonld?: any, options?: IManifestoOptions): Manifest
Parameters
- Optionaljsonld: any
- Optionaloptions: IManifestoOptions
Returns Manifest
Overrides IIIFResource.constructor
- Defined in src/Manifest.ts:26

Properties

__jsonld

__jsonld: any

context

context: string

defaultTree

defaultTree: TreeNode

externalResource

externalResource: IExternalResource

id

id: string

index

index: number = 0

isLoaded

isLoaded: boolean = false

items

items: Sequence[] = []

options

options: IManifestoOptions

parentCollection

parentCollection: Collection

parentLabel

parentLabel: string

Methods

getAccompanyingCanvas

getAccompanyingCanvas(): null | Canvas
Returns null | Canvas
- Defined in src/Manifest.ts:50

getAllRanges

getAllRanges(): Range[]
Returns Range[]
- Defined in src/Manifest.ts:196

getAttribution

getAttribution(): PropertyValue
Returns PropertyValue
Deprecated
Inherited from IIIFResource.getAttribution
- Defined in src/IIIFResource.ts:40

getBehavior

getBehavior(): null | Behavior
Returns null | Behavior
- Defined in src/Manifest.ts:60

getDefaultLabel

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

getDefaultTree

getDefaultTree(): TreeNode
Returns TreeNode
Overrides IIIFResource.getDefaultTree
- Defined in src/Manifest.ts:74

getDescription

getDescription(): PropertyValue
Returns PropertyValue
Inherited from IIIFResource.getDescription
- Defined in src/IIIFResource.ts:52

getHomepage

getHomepage(): null | string
Returns null | string
Inherited from IIIFResource.getHomepage
- Defined in src/IIIFResource.ts:62

getIIIFResourceType

getIIIFResourceType(): IIIFResourceType
Returns IIIFResourceType
Inherited from IIIFResource.getIIIFResourceType
- Defined in src/IIIFResource.ts:72

getLabel

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

getLicense

getLicense(): null | string
Returns null | string
Inherited from IIIFResource.getLicense
- Defined in src/IIIFResource.ts:107

getLogo

getLogo(): null | string
Returns null | string
Inherited from IIIFResource.getLogo
- Defined in src/IIIFResource.ts:76

getManifestType

getManifestType(): ManifestType
Returns ManifestType
- Defined in src/Manifest.ts:282

getMetadata

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

getNavDate

getNavDate(): Date
Returns Date
Inherited from IIIFResource.getNavDate
- Defined in src/IIIFResource.ts:124

getPosterCanvas

getPosterCanvas(): null | Canvas
Returns null | Canvas
Deprecated
Use getAccompanyingCanvas instead
- Defined in src/Manifest.ts:40

getProperty

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

getRangeById

getRangeById(id: string): null | Range
Parameters
- id: string
Returns null | Range
- Defined in src/Manifest.ts:225

getRangeByPath

getRangeByPath(path: string): null | Range
Parameters
- path: string
Returns null | Range
- Defined in src/Manifest.ts:238

getRelated

getRelated(): any
Returns any
Inherited from IIIFResource.getRelated
- Defined in src/IIIFResource.ts:128

getRendering

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

getRenderings

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

getRequiredStatement

getRequiredStatement(): null | LabelValuePair
Returns null | LabelValuePair
Inherited from IIIFResource.getRequiredStatement
- Defined in src/IIIFResource.ts:152

getRights

getRights(): null | string
Returns null | string
Inherited from IIIFResource.getRights
- Defined in src/IIIFResource.ts:114

getSeeAlso

getSeeAlso(): any
Returns any
Inherited from IIIFResource.getSeeAlso
- Defined in src/IIIFResource.ts:132

getSequenceByIndex

getSequenceByIndex(sequenceIndex: number): Sequence
Parameters
- sequenceIndex: number
Returns Sequence
- Defined in src/Manifest.ts:274

getSequences

getSequences(): Sequence[]
Returns Sequence[]
- Defined in src/Manifest.ts:251

getService

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

getServices

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

getThumbnail

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

getTopRanges

getTopRanges(): Range[]
Returns Range[]
- Defined in src/Manifest.ts:117

getTotalSequences

getTotalSequences(): number
Returns number
- Defined in src/Manifest.ts:278

getTrackingLabel

getTrackingLabel(): string
Returns string
Inherited from IIIFResource.getTrackingLabel
- Defined in src/IIIFResource.ts:136

getViewingDirection

getViewingDirection(): null | ViewingDirection
Returns null | ViewingDirection
- Defined in src/Manifest.ts:312

getViewingHint

getViewingHint(): null | ViewingHint
Returns null | ViewingHint
- Defined in src/Manifest.ts:316

isAnnotation

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

isCanvas

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

isCollection

isCollection(): boolean
Returns boolean
Inherited from IIIFResource.isCollection
- Defined in src/IIIFResource.ts:173

isManifest

isManifest(): boolean
Returns boolean
Inherited from IIIFResource.isManifest
- Defined in src/IIIFResource.ts:180

isMultiSequence

isMultiSequence(): boolean
Returns boolean
- Defined in src/Manifest.ts:292

isPagingEnabled

isPagingEnabled(): boolean
Returns boolean
- Defined in src/Manifest.ts:296

isRange

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

isSequence

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

load

load(): Promise<IIIFResource>
Returns Promise<IIIFResource>
Inherited from IIIFResource.load
- Defined in src/IIIFResource.ts:187