Class Collection

Hierarchy (view full)

IIIFResource
- Collection

Constructors

constructor

new Collection(jsonld, options): Collection
Parameters
- jsonld: any
- options: IManifestoOptions
Returns Collection
Overrides IIIFResource.constructor
- Defined in src/Collection.ts:20

Properties

__jsonld

__jsonld: any

context

context: string

defaultTree

defaultTree: TreeNode

externalResource

externalResource: IExternalResource

id

id: string

index

index: number = -1

isLoaded

isLoaded: boolean = false

items

items: IIIFResource[] = []

options

options: IManifestoOptions

parentCollection

parentCollection: Collection

parentLabel

parentLabel: string

Methods

getAttribution

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

getBehavior

getBehavior(): null | Behavior
Note: this only will return the first behavior as per the manifesto convention IIIF v3 supports multiple behaviors

Returns null | Behavior
- Defined in src/Collection.ts:108

getCollectionByIndex

getCollectionByIndex(collectionIndex): Promise<Collection>
Parameters
- collectionIndex: number
Returns Promise<Collection>
- Defined in src/Collection.ts:43

getCollections

getCollections(): Collection[]
Returns Collection[]
- Defined in src/Collection.ts:25

getDefaultLabel

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

getDefaultTree

getDefaultTree(): TreeNode
Get a tree of sub collections and manifests, using each child manifest's first 'top' range.

Returns TreeNode
Overrides IIIFResource.getDefaultTree
- Defined in src/Collection.ts:139

getDescription

getDescription(): PropertyValue
Returns PropertyValue
Deprecated
Use getSummary instead
Inherited from IIIFResource.getDescription
- Defined in src/IIIFResource.ts:54

getHomepage

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

getIIIFResourceType

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

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

getLogo

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

getManifestByIndex

getManifestByIndex(manifestIndex): Promise<Manifest>
Parameters
- manifestIndex: number
Returns Promise<Manifest>
- Defined in src/Collection.ts:64

getManifests

getManifests(): Manifest[]
Returns Manifest[]
- Defined in src/Collection.ts:34

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

getProperty

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

getRelated

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

getRendering

getRendering(format): 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:170

getRights

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

getSeeAlso

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

getService

getService(profile): 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

getSummary

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

getThumbnail

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

getTotalCollections

getTotalCollections(): number
Returns number
- Defined in src/Collection.ts:84

getTotalItems

getTotalItems(): number
Returns number
- Defined in src/Collection.ts:92

getTotalManifests

getTotalManifests(): number
Returns number
- Defined in src/Collection.ts:88

getTrackingLabel

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

getViewingDirection

getViewingDirection(): ViewingDirection
Returns ViewingDirection
- Defined in src/Collection.ts:96

getViewingHint

getViewingHint(): null | ViewingHint
Returns null | ViewingHint
- Defined in src/Collection.ts:122

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

isManifest

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

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