Class Sequence

Hierarchy (View Summary)

ManifestResource
- Sequence

Constructors

constructor

new Sequence(jsonld?: any, options?: IManifestoOptions): Sequence
Parameters
- Optionaljsonld: any
- Optionaloptions: IManifestoOptions
Returns Sequence
Overrides ManifestResource.constructor
- Defined in src/Sequence.ts:16

Properties

__jsonld

__jsonld: any

context

context: string

externalResource

externalResource: IExternalResource

id

id: string

items

items: Canvas[] = []

options

options: IManifestoOptions

Methods

getCanvasById

getCanvasById(id: string): Canvas | null
Parameters
- id: string
Returns Canvas | null
- Defined in src/Sequence.ts:46

getCanvasByIndex

getCanvasByIndex(canvasIndex: number): any
Parameters
- canvasIndex: number
Returns any
- Defined in src/Sequence.ts:61

getCanvases

getCanvases(): Canvas[]
Returns Canvas[]
- Defined in src/Sequence.ts:20

getCanvasIndexById

getCanvasIndexById(id: string): number | null
Parameters
- id: string
Returns number | null
- Defined in src/Sequence.ts:65

getCanvasIndexByLabel

getCanvasIndexByLabel(label: string, foliated?: boolean): number
Parameters
- label: string
- Optionalfoliated: boolean
Returns number
- Defined in src/Sequence.ts:77

getDefaultLabel

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

getIIIFResourceType

getIIIFResourceType(): IIIFResourceType
Returns IIIFResourceType
Inherited from ManifestResource.getIIIFResourceType
- Defined in src/ManifestResource.ts:27

getLabel

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

getLastCanvasLabel

getLastCanvasLabel(alphanumeric?: boolean): string
Parameters
- Optionalalphanumeric: boolean
Returns string
- Defined in src/Sequence.ts:119

getLastPageIndex

getLastPageIndex(): number
Returns number
- Defined in src/Sequence.ts:140

getMetadata

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

getNextPageIndex

getNextPageIndex(canvasIndex: number, pagingEnabled?: boolean): number
Parameters
- canvasIndex: number
- OptionalpagingEnabled: boolean
Returns number
- Defined in src/Sequence.ts:144

getPagedIndices

getPagedIndices(canvasIndex: number, pagingEnabled?: boolean): number[]
Parameters
- canvasIndex: number
- OptionalpagingEnabled: boolean
Returns number[]
- Defined in src/Sequence.ts:172

getPrevPageIndex

getPrevPageIndex(canvasIndex: number, pagingEnabled?: boolean): number
Parameters
- canvasIndex: number
- OptionalpagingEnabled: boolean
Returns number
- Defined in src/Sequence.ts:200

getProperty

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

getRendering

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

getRenderings

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

getRequiredStatement

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

getService

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

getServices

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

getStartCanvas

getStartCanvas(): string
Returns string
- Defined in src/Sequence.ts:271

getStartCanvasIndex

getStartCanvasIndex(): number
Returns number
- Defined in src/Sequence.ts:224

getThumbnail

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

getThumbnails

getThumbnails(): Thumbnail[]
Returns Thumbnail[]
- Defined in src/Sequence.ts:255

getThumbs

getThumbs(width: number, height?: number): Thumb[]
Parameters
- width: number
- Optionalheight: number
Returns Thumb[]
- Defined in src/Sequence.ts:241

getTotalCanvases

getTotalCanvases(): number
Returns number
- Defined in src/Sequence.ts:275

getViewingDirection

getViewingDirection(): ViewingDirection | null
Returns ViewingDirection | null
- Defined in src/Sequence.ts:279

getViewingHint

getViewingHint(): ViewingHint | null
Returns ViewingHint | null
- Defined in src/Sequence.ts:289

isAnnotation

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

isCanvas

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

isCanvasIndexOutOfRange

isCanvasIndexOutOfRange(canvasIndex: number): boolean
Parameters
- canvasIndex: number
Returns boolean
- Defined in src/Sequence.ts:303

isCollection

isCollection(): boolean
Returns boolean
Inherited from ManifestResource.isCollection
- Defined in src/ManifestResource.ts:148

isFirstCanvas

isFirstCanvas(canvasIndex: number): boolean
Parameters
- canvasIndex: number
Returns boolean
- Defined in src/Sequence.ts:307

isLastCanvas

isLastCanvas(canvasIndex: number): boolean
Parameters
- canvasIndex: number
Returns boolean
- Defined in src/Sequence.ts:311

isManifest

isManifest(): boolean
Returns boolean
Inherited from ManifestResource.isManifest
- Defined in src/ManifestResource.ts:152

isMultiCanvas

isMultiCanvas(): boolean
Returns boolean
- Defined in src/Sequence.ts:315

isPagingEnabled

isPagingEnabled(): boolean
Returns boolean
- Defined in src/Sequence.ts:319

isRange

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

isSequence

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

isTotalCanvasesEven

isTotalCanvasesEven(): boolean
Returns boolean
- Defined in src/Sequence.ts:330