Class Collection

Hierarchy

IIIFResource
- Collection

Index

Constructors

constructor

Properties

Constructors

constructor

new Collection(jsonld: any, options: IManifestoOptions): Collection

Overrides IIIFResource.constructor
- Defined in Collection.ts:13
Parameters
- jsonld: any
- options: IManifestoOptions
Returns Collection

Properties

__jsonld

__jsonld: any

Private _collections

_collections: Collection[] | null = null

Private _manifests

_manifests: Manifest[] | null = null

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

Private _parseCollections

_parseCollections(parentCollection: Collection): void

- Defined in Collection.ts:110
Parameters
- parentCollection: Collection
Returns void

Private _parseManifests

_parseManifests(parentCollection: Collection): void

- Defined in Collection.ts:96
Parameters
- parentCollection: Collection
Returns void

getAttribution

getAttribution(): LanguageMap

Inherited from IIIFResource.getAttribution
- Defined in IIIFResource.ts:23
Returns LanguageMap

getCollectionByIndex

getCollectionByIndex(collectionIndex: number): Promise<Collection>

- Defined in Collection.ts:34
Parameters
- collectionIndex: number
Returns Promise<Collection>

getCollections

getCollections(): Collection[]

- Defined in Collection.ts:20
Returns Collection[]

getDefaultLabel

getDefaultLabel(): string | null

Inherited from ManifestResource.getDefaultLabel
- Defined in ManifestResource.ts:26
Returns string | null

getDefaultTree

getDefaultTree(): TreeNode

Overrides IIIFResource.getDefaultTree
- Defined in Collection.ts:82
Get a tree of sub collections and manifests, using each child manifest's first 'top' range.

Returns TreeNode

getDescription

getDescription(): LanguageMap

Inherited from IIIFResource.getDescription
- Defined in IIIFResource.ts:36
Returns LanguageMap

getIIIFResourceType

getIIIFResourceType(): IIIFResourceType

Inherited from IIIFResource.getIIIFResourceType

Overrides ManifestResource.getIIIFResourceType
- Defined in IIIFResource.ts:46
Returns IIIFResourceType

getLabel

getLabel(): LanguageMap

Inherited from ManifestResource.getLabel
- Defined in ManifestResource.ts:16
Returns LanguageMap

getLicense

getLicense(): string | null

Inherited from IIIFResource.getLicense
- Defined in IIIFResource.ts:60
Returns string | null

getLogo

getLogo(): string | null

Inherited from IIIFResource.getLogo
- Defined in IIIFResource.ts:50
Returns string | null

getManifestByIndex

getManifestByIndex(manifestIndex: number): Promise<Manifest>

- Defined in Collection.ts:47
Parameters
- manifestIndex: number
Returns Promise<Manifest>

getManifests

getManifests(): Manifest[]

- Defined in Collection.ts:27
Returns Manifest[]

getMetadata

getMetadata(): LabelValuePair[]

Inherited from ManifestResource.getMetadata
- Defined in ManifestResource.ts:30
Returns LabelValuePair[]

getNavDate

getNavDate(): Date

Inherited from IIIFResource.getNavDate
- Defined in IIIFResource.ts:64
Returns Date

getProperty

getProperty(name: string): any

Inherited from JSONLDResource.getProperty
- Defined in JSONLDResource.ts:12
Parameters
- name: string
Returns any

getRelated

getRelated(): any

Inherited from IIIFResource.getRelated
- Defined in IIIFResource.ts:68
Returns any

getRendering

getRendering(format: RenderingFormat): Rendering | null

Inherited from ManifestResource.getRendering
- Defined in ManifestResource.ts:47
Parameters
- format: RenderingFormat
Returns Rendering | null

getRenderings

getRenderings(): Rendering[]

Inherited from ManifestResource.getRenderings
- Defined in ManifestResource.ts:61
Returns Rendering[]

getRequiredStatement

getRequiredStatement(): LabelValuePair | null

Inherited from IIIFResource.getRequiredStatement
- Defined in IIIFResource.ts:82
Returns LabelValuePair | null

getSeeAlso

getSeeAlso(): any

Inherited from IIIFResource.getSeeAlso
- Defined in IIIFResource.ts:72
Returns any

getService

getService(profile: ServiceProfile): Service | null

Inherited from ManifestResource.getService
- Defined in ManifestResource.ts:88
Parameters
- profile: ServiceProfile
Returns Service | null

getServices

getServices(): Service[]

Inherited from ManifestResource.getServices
- Defined in ManifestResource.ts:92
Returns Service[]

getThumbnail

getThumbnail(): Thumbnail | null

Inherited from ManifestResource.getThumbnail
- Defined in ManifestResource.ts:96
Returns Thumbnail | null

getTotalCollections

getTotalCollections(): number

- Defined in Collection.ts:59
Returns number

getTotalItems

getTotalItems(): number

- Defined in Collection.ts:67
Returns number

getTotalManifests

getTotalManifests(): number

- Defined in Collection.ts:63
Returns number

getViewingDirection

getViewingDirection(): ViewingDirection

- Defined in Collection.ts:71
Returns ViewingDirection

isAnnotation

isAnnotation(): boolean

Inherited from ManifestResource.isAnnotation
- Defined in ManifestResource.ts:110
Returns boolean

isCanvas

isCanvas(): boolean

Inherited from ManifestResource.isCanvas
- Defined in ManifestResource.ts:114
Returns boolean

isCollection

isCollection(): boolean

Inherited from IIIFResource.isCollection

Overrides ManifestResource.isCollection
- Defined in IIIFResource.ts:107
Returns boolean

isManifest

isManifest(): boolean

Inherited from IIIFResource.isManifest

Overrides ManifestResource.isManifest
- Defined in IIIFResource.ts:114
Returns boolean

isRange

isRange(): boolean

Inherited from ManifestResource.isRange
- Defined in ManifestResource.ts:126
Returns boolean

isSequence

isSequence(): boolean

Inherited from ManifestResource.isSequence
- Defined in ManifestResource.ts:130
Returns boolean

load

load(): Promise<IIIFResource>

Inherited from IIIFResource.load
- Defined in IIIFResource.ts:121
Returns Promise<IIIFResource>

Generated using TypeDoc