Class Sequence

Hierarchy

ManifestResource
- Sequence

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Sequence(jsonld?: any, options?: IManifestoOptions): Sequence

Overrides ManifestResource.constructor
- Defined in Sequence.ts:13
Parameters
- Optional jsonld: any
- Optional options: IManifestoOptions
Returns Sequence

Properties

__jsonld

__jsonld: any

Private _thumbnails

_thumbnails: Thumbnail[] | null = null

context

context: string

externalResource

externalResource: IExternalResource

id

id: string

items

items: Canvas[] = []

options

options: IManifestoOptions

Methods

getCanvasById

getCanvasById(id: string): Canvas | null

- Defined in Sequence.ts:45
Parameters
- id: string
Returns Canvas | null

getCanvasByIndex

getCanvasByIndex(canvasIndex: number): any

- Defined in Sequence.ts:61
Parameters
- canvasIndex: number
Returns any

getCanvasIndexById

getCanvasIndexById(id: string): number | null

- Defined in Sequence.ts:65
Parameters
- id: string
Returns number | null

getCanvasIndexByLabel

getCanvasIndexByLabel(label: string, foliated?: undefined | false | true): number

- Defined in Sequence.ts:78
Parameters
- label: string
- Optional foliated: undefined | false | true
Returns number

getCanvases

getCanvases(): Canvas[]

- Defined in Sequence.ts:19
Returns Canvas[]

getDefaultLabel

getDefaultLabel(): string | null

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

getIIIFResourceType

getIIIFResourceType(): IIIFResourceType

Inherited from ManifestResource.getIIIFResourceType
- Defined in ManifestResource.ts:12
Returns IIIFResourceType

getLabel

getLabel(): LanguageMap

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

getLastCanvasLabel

getLastCanvasLabel(alphanumeric?: undefined | false | true): string

- Defined in Sequence.ts:119
Parameters
- Optional alphanumeric: undefined | false | true
Returns string

getLastPageIndex

getLastPageIndex(): number

- Defined in Sequence.ts:139
Returns number

getMetadata

getMetadata(): LabelValuePair[]

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

getNextPageIndex

getNextPageIndex(canvasIndex: number, pagingEnabled?: undefined | false | true): number

- Defined in Sequence.ts:143
Parameters
- canvasIndex: number
- Optional pagingEnabled: undefined | false | true
Returns number

getPagedIndices

getPagedIndices(canvasIndex: number, pagingEnabled?: undefined | false | true): number[]

- Defined in Sequence.ts:168
Parameters
- canvasIndex: number
- Optional pagingEnabled: undefined | false | true
Returns number[]

getPrevPageIndex

getPrevPageIndex(canvasIndex: number, pagingEnabled?: undefined | false | true): number

- Defined in Sequence.ts:193
Parameters
- canvasIndex: number
- Optional pagingEnabled: undefined | false | true
Returns number

getProperty

getProperty(name: string): any

Inherited from JSONLDResource.getProperty
- Defined in JSONLDResource.ts:12
Parameters
- name: string
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[]

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

getStartCanvas

getStartCanvas(): string

- Defined in Sequence.ts:262
Returns string

getStartCanvasIndex

getStartCanvasIndex(): number

- Defined in Sequence.ts:215
Returns number

getThumbnail

getThumbnail(): Thumbnail | null

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

getThumbnails

getThumbnails(): Thumbnail[]

- Defined in Sequence.ts:246
Returns Thumbnail[]

getThumbs

getThumbs(width: number, height?: undefined | number): Thumb[]

- Defined in Sequence.ts:232
Parameters
- width: number
- Optional height: undefined | number
Returns Thumb[]

getTotalCanvases

getTotalCanvases(): number

- Defined in Sequence.ts:266
Returns number

getViewingDirection

getViewingDirection(): ViewingDirection | null

- Defined in Sequence.ts:270
Returns ViewingDirection | null

getViewingHint

getViewingHint(): ViewingHint | null

- Defined in Sequence.ts:280
Returns ViewingHint | null

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

isCanvasIndexOutOfRange

isCanvasIndexOutOfRange(canvasIndex: number): boolean

- Defined in Sequence.ts:284
Parameters
- canvasIndex: number
Returns boolean

isCollection

isCollection(): boolean

Inherited from ManifestResource.isCollection
- Defined in ManifestResource.ts:118
Returns boolean

isFirstCanvas

isFirstCanvas(canvasIndex: number): boolean

- Defined in Sequence.ts:288
Parameters
- canvasIndex: number
Returns boolean

isLastCanvas

isLastCanvas(canvasIndex: number): boolean

- Defined in Sequence.ts:292
Parameters
- canvasIndex: number
Returns boolean

isManifest

isManifest(): boolean

Inherited from ManifestResource.isManifest
- Defined in ManifestResource.ts:122
Returns boolean

isMultiCanvas

isMultiCanvas(): boolean

- Defined in Sequence.ts:296
Returns boolean

isPagingEnabled

isPagingEnabled(): boolean

- Defined in Sequence.ts:300
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

isTotalCanvasesEven

isTotalCanvasesEven(): boolean

- Defined in Sequence.ts:311
Returns boolean

Generated using TypeDoc