Class Manifest

Remarks

Scenes are conveniently retrieved from a Manifest by iterating through Sequence in the Manifest, inner loop the Scenes in each sequence

See

Sequence

Example

var manifest: Manifest;
function doSomethingWithScene(scene:Scene)...
...
foreach(var seq:Sequence of manifest.getSequences()
  foreach(var scene : Scene of seq.getScenes() 
    doSomethingWithScene(scene);

Hierarchy (view full)

IIIFResource
- Manifest

Index

Constructors

constructor

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

Properties

__jsonld

__jsonld: any

`Private` _allRanges

_allRanges: null | Range[] = null

_annotationIdMap

_annotationIdMap: any

`Private` _topRanges

_topRanges: Range[] = []

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

Accessors

annotationIdMap

get annotationIdMap(): Object
Developer Note: The concept of the "id map" appear in the JSON-LD specification https://www.w3.org/TR/json-ld11/#dfn-id-map This functionality may be available as well in the 'nodeMap' code of the digitalbazaar/jsonld library

this very simplified version just returns a mao of id -> Annotation nodes in manifest

THe annotationIdMap is a Javascript object whose property names are IRI (id values) and property values are instances of the Annotation class

Returns Object
- Defined in src/Manifest.ts:356

Methods

`Private` _getRangeById

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

`Private` _getTopRanges

_getTopRanges(): any[]
Returns any[]
- Defined in src/Manifest.ts:113

`Private` _parseRanges

_parseRanges(r, path, parentRange?): void
Parameters
- r: any
- path: string
- Optional parentRange: Range
Returns void
- Defined in src/Manifest.ts:158

getAccompanyingCanvas

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

getAllRanges

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

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:78

getDefaultLabel

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

getDefaultTree

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

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 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

Example

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

getLicense

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

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:304

getMetadata

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

getNavDate

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

getPosterCanvas

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

getProperty

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

getPropertyAsObject

getPropertyAsObject(name): 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
Inherited from IIIFResource.getPropertyAsObject
- Defined in src/JSONLDResource.ts:40

getRangeById

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

getRangeByPath

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

getRelated

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

getRendering

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

getRenderings

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

getRequiredStatement

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

getSeeAlso

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

getSequenceByIndex

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

getSequences

getSequences(): Sequence[]
Returns Sequence[]
Array of Sequence instances
- Defined in src/Manifest.ts:273

getService

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

getServices

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

getSummary

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

getThumbnail

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

getTopRanges

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

getTotalSequences

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

getTrackingLabel

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

getViewingDirection

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

getViewingHint

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

isAnnotation

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

isCanvas

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

isCollection

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

isManifest

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

isMultiSequence

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

isPagingEnabled

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

isRange

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

isScene

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

isSequence

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

load

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

Class Manifest

Remarks

See

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Manifest

Properties

__jsonld

Private _allRanges

_annotationIdMap

Private _topRanges

context

defaultTree

externalResource

id

index

isLoaded

items

options

parentCollection

parentLabel

Accessors

annotationIdMap

Returns Object

Methods

Private _getRangeById

Parameters

Returns null | Range

Private _getTopRanges

Returns any[]

Private _parseRanges

Parameters

Returns void

getAccompanyingCanvas

Returns null | Canvas

getAllRanges

Returns Range[]

getAttribution

Returns PropertyValue

Deprecated

getBehavior

Returns null | Behavior

getDefaultLabel

Returns null | string

getDefaultTree

Returns TreeNode

getDescription

Returns PropertyValue

getHomepage

Returns null | string

getIIIFResourceType

Returns IIIFResourceType

getLabel

Returns PropertyValue

Example

Example

getLicense

Returns null | string

getLogo

Returns null | string

getManifestType

Returns ManifestType

getMetadata

Returns LabelValuePair[]

getNavDate

Returns Date

getPosterCanvas

Returns null | Canvas

Deprecated

getProperty

Parameters

Returns any

`Private` _allRanges

`Private` _topRanges

`Private` _getRangeById

`Private` _getTopRanges

`Private` _parseRanges