Class Helper

Index

Constructors

Properties

canvasIndex choiceIndex collectionIndex iiifResource manifest manifestIndex manifestUri options rangeId sequenceIndex

Methods

createDateNodes createDecadeNodes createMonthNodes createYearNodes getAccompanyingCanvas getAccompanyingCanvasImage getActiveChoice getAllRequiredStatements getAttribution getAutoCompleteService getBehavior getCanvasById getCanvasByIndex getCanvases getCanvasesById getCanvasIndexById getCanvasIndexByLabel getCanvasRange getCanvasRanges getChoices getCollectionIndex getCurrentCanvas getCurrentRange getCurrentSequence getDecadeNode getDescription getFirstPageIndex getFlattenedTree getLabel getLastCanvasLabel getLastPageIndex getLicense getLogo getManifestType getMetadata getMonthNode getMostSpecificRequiredStatement getMultiSelectState getNextRange getNodeDisplayDate getNodeDisplayMonth getNodeMonth getNodeYear getPosterCanvas getPosterImage getPreviousRange getRangeById getRangeByPath getRangeCanvases getRanges getRelated getRequiredStatement getRights getSearchService getSeeAlso getSequenceByIndex getShareServiceUrl getStartCanvasIndex getSummary getThumbs getTopRanges getTotalCanvases getTrackingLabel getTree getViewingDirection getViewingHint getYearNode hasAnnotations hasChoices hasParentCollection hasRelatedPage hasResources isBottomToTop isCanvasIndexOutOfRange isContinuous isFirstCanvas isHorizontallyAligned isLastCanvas isLeftToRight isMultiCanvas isMultiSequence isPaged isPagingAvailable isPagingEnabled isRightToLeft isTopToBottom isTotalCanvasesEven isUIEnabled isVerticallyAligned parseStatement pruneDecadeNodes sortDecadeNodes sortMonthNodes sortYearNodes treeHasNavDates

Constructors

constructor

new Helper(options: IManifoldOptions): Helper
Parameters
- options: IManifoldOptions
Returns Helper
- Defined in src/Helper.ts:50

Properties

canvasIndex

canvasIndex: number

choiceIndex

choiceIndex: number

collectionIndex

collectionIndex: number

iiifResource

iiifResource: undefined | IIIFResource

manifest

manifest: undefined | Manifest

manifestIndex

manifestIndex: number

manifestUri

manifestUri: string

options

options: IManifoldOptions

rangeId

rangeId: undefined | string

sequenceIndex

sequenceIndex: number

Methods

createDateNodes

createDateNodes(rootNode: TreeNode, nodes: TreeNode[]): void
Parameters
- rootNode: TreeNode
- nodes: TreeNode[]
Returns void
- Defined in src/Helper.ts:1270

createDecadeNodes

createDecadeNodes(rootNode: TreeNode, nodes: TreeNode[]): void
Parameters
- rootNode: TreeNode
- nodes: TreeNode[]
Returns void
- Defined in src/Helper.ts:1300

createMonthNodes

createMonthNodes(rootNode: TreeNode, nodes: TreeNode[]): void
Parameters
- rootNode: TreeNode
- nodes: TreeNode[]
Returns void
- Defined in src/Helper.ts:1322

createYearNodes

createYearNodes(rootNode: TreeNode, nodes: TreeNode[]): void
Parameters
- rootNode: TreeNode
- nodes: TreeNode[]
Returns void
- Defined in src/Helper.ts:1350

getAccompanyingCanvas

getAccompanyingCanvas(): null | Canvas
Returns null | Canvas
- Defined in src/Helper.ts:636

getAccompanyingCanvasImage

getAccompanyingCanvasImage(): null | string
Returns null | string
- Defined in src/Helper.ts:661

getActiveChoice

getActiveChoice(): null | AnnotationBody
Returns null | AnnotationBody
- Defined in src/Helper.ts:1044

getAllRequiredStatements

getAllRequiredStatements(): (
    ILabelValuePair & {
        source: "Range"
        | "Canvas"
        | "Manifest"
        | "Collection";
    }
)[]
Returns (ILabelValuePair & { source: "Range" | "Canvas" | "Manifest" | "Collection" })[]
- Defined in src/Helper.ts:431

getAttribution

getAttribution(): null | string
Returns null | string
- Defined in src/Helper.ts:100

getAutoCompleteService

getAutoCompleteService(): null | Service
Returns null | Service
- Defined in src/Helper.ts:74

getBehavior

getBehavior(): null | Behavior
Returns null | Behavior
- Defined in src/Helper.ts:1024

getCanvasById

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

getCanvasByIndex

getCanvasByIndex(index: number): Canvas
Parameters
- index: number
Returns Canvas
- Defined in src/Helper.ts:136

getCanvases

getCanvases(): Canvas[]
Returns Canvas[]
- Defined in src/Helper.ts:114

getCanvasesById

getCanvasesById(ids: string[]): Canvas[]
Parameters
- ids: string[]
Returns Canvas[]
- Defined in src/Helper.ts:122

getCanvasIndexById

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

getCanvasIndexByLabel

getCanvasIndexByLabel(label: string): number
Parameters
- label: string
Returns number
- Defined in src/Helper.ts:144

getCanvasRange

getCanvasRange(canvas: Canvas, path?: string): null | Range
Parameters
- canvas: Canvas
- Optionalpath: string
Returns null | Range
- Defined in src/Helper.ts:150

getCanvasRanges

getCanvasRanges(canvas: Canvas): Range[]
Parameters
- canvas: Canvas
Returns Range[]
- Defined in src/Helper.ts:168

getChoices

getChoices(): AnnotationBody[]
Returns AnnotationBody[]
- Defined in src/Helper.ts:1039

getCollectionIndex

getCollectionIndex(iiifResource: IIIFResource): undefined | number
Parameters
- iiifResource: IIIFResource
Returns undefined | number
- Defined in src/Helper.ts:194

getCurrentCanvas

getCurrentCanvas(): Canvas
Returns Canvas
- Defined in src/Helper.ts:208

getCurrentRange

getCurrentRange(): null | Range
Returns null | Range
- Defined in src/Helper.ts:619

getCurrentSequence

getCurrentSequence(): Sequence
Returns Sequence
- Defined in src/Helper.ts:212

getDecadeNode

getDecadeNode(rootNode: TreeNode, year: number): null | TreeNode
Parameters
- rootNode: TreeNode
- year: number
Returns null | TreeNode
- Defined in src/Helper.ts:1372

getDescription

getDescription(): null | string
Returns null | string
Deprecated
Use getSummary instead
- Defined in src/Helper.ts:219

getFirstPageIndex

getFirstPageIndex(): number
Returns number
- Defined in src/Helper.ts:265

getFlattenedTree

getFlattenedTree(treeNode?: TreeNode): null | TreeNode[]
Parameters
- OptionaltreeNode: TreeNode
Returns null | TreeNode[]
- Defined in src/Helper.ts:748

getLabel

getLabel(): null | string
Returns null | string
- Defined in src/Helper.ts:247

getLastCanvasLabel

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

getLastPageIndex

getLastPageIndex(): number
Returns number
- Defined in src/Helper.ts:269

getLicense

getLicense(): null | string
Returns null | string
- Defined in src/Helper.ts:273

getLogo

getLogo(): null | string
Returns null | string
- Defined in src/Helper.ts:289

getManifestType

getManifestType(): null | ManifestType
Returns null | ManifestType
- Defined in src/Helper.ts:297

getMetadata

getMetadata(options?: MetadataOptions): MetadataGroup[]
Parameters
- Optionaloptions: MetadataOptions
Returns MetadataGroup[]
- Defined in src/Helper.ts:312

getMonthNode

getMonthNode(yearNode: TreeNode, month: Number): null | TreeNode
Parameters
- yearNode: TreeNode
- month: Number
Returns null | TreeNode
- Defined in src/Helper.ts:1381

getMostSpecificRequiredStatement

getMostSpecificRequiredStatement(): null | ILabelValuePair
Returns null | ILabelValuePair
- Defined in src/Helper.ts:483

getMultiSelectState

getMultiSelectState(): MultiSelectState
Returns MultiSelectState
- Defined in src/Helper.ts:605

getNextRange

getNextRange(range?: Range): null | Range
Parameters
- Optionalrange: Range
Returns null | Range
- Defined in src/Helper.ts:711

getNodeDisplayDate

getNodeDisplayDate(node: TreeNode): string
Parameters
- node: TreeNode
Returns string
- Defined in src/Helper.ts:1390

getNodeDisplayMonth

getNodeDisplayMonth(node: TreeNode): string
Parameters
- node: TreeNode
Returns string
- Defined in src/Helper.ts:1394

getNodeMonth

getNodeMonth(node: TreeNode): number
Parameters
- node: TreeNode
Returns number
- Defined in src/Helper.ts:1412

getNodeYear

getNodeYear(node: TreeNode): number
Parameters
- node: TreeNode
Returns number
- Defined in src/Helper.ts:1416

getPosterCanvas

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

getPosterImage

getPosterImage(): null | string
Returns null | string
Deprecated
Use getAccompanyingCanvasImage instead
- Defined in src/Helper.ts:645

getPreviousRange

getPreviousRange(range?: Range): null | Range
Parameters
- Optionalrange: Range
Returns null | Range
- Defined in src/Helper.ts:677

getRangeById

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

getRangeByPath

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

getRangeCanvases

getRangeCanvases(range: Range): Canvas[]
Parameters
- range: Range
Returns Canvas[]
- Defined in src/Helper.ts:804

getRanges

getRanges(): Range[]
Returns Range[]
- Defined in src/Helper.ts:784

getRelated

getRelated(): any
Returns any
- Defined in src/Helper.ts:809

getRequiredStatement

getRequiredStatement(): null | ILabelValuePair
Returns null | ILabelValuePair
- Defined in src/Helper.ts:510

getRights

getRights(): null | string
Returns null | string
- Defined in src/Helper.ts:281

getSearchService

getSearchService(): null | Service
Returns null | Service
- Defined in src/Helper.ts:817

getSeeAlso

getSeeAlso(): any
Returns any
- Defined in src/Helper.ts:837

getSequenceByIndex

getSequenceByIndex(index: number): Sequence
Parameters
- index: number
Returns Sequence
- Defined in src/Helper.ts:845

getShareServiceUrl

getShareServiceUrl(): null | string
Returns null | string
- Defined in src/Helper.ts:853

getStartCanvasIndex

getStartCanvasIndex(): number
Returns number
- Defined in src/Helper.ts:903

getSummary

getSummary(): null | string
Returns null | string
- Defined in src/Helper.ts:233

getThumbs

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

getTopRanges

getTopRanges(): Range[]
Returns Range[]
- Defined in src/Helper.ts:911

getTotalCanvases

getTotalCanvases(): number
Returns number
- Defined in src/Helper.ts:919

getTrackingLabel

getTrackingLabel(): null | string
Returns null | string
- Defined in src/Helper.ts:923

getTree

getTree(topRangeIndex?: number, sortType?: TreeSortType): null | TreeNode
Parameters
- topRangeIndex: number = 0
- sortType: TreeSortType = TreeSortType.NONE
Returns null | TreeNode
- Defined in src/Helper.ts:935

getViewingDirection

getViewingDirection(): null | ViewingDirection
Returns null | ViewingDirection
- Defined in src/Helper.ts:994

getViewingHint

getViewingHint(): null | ViewingHint
Returns null | ViewingHint
- Defined in src/Helper.ts:1009

getYearNode

getYearNode(decadeNode: TreeNode, year: Number): null | TreeNode
Parameters
- decadeNode: TreeNode
- year: Number
Returns null | TreeNode
- Defined in src/Helper.ts:1420

hasAnnotations

hasAnnotations(): boolean
Returns boolean
- Defined in src/Helper.ts:1085

hasChoices

hasChoices(): boolean
Returns boolean
- Defined in src/Helper.ts:1264

hasParentCollection

hasParentCollection(): boolean
Returns boolean
- Defined in src/Helper.ts:1052

hasRelatedPage

hasRelatedPage(): boolean
Returns boolean
- Defined in src/Helper.ts:1060

hasResources

hasResources(): boolean
Returns boolean
- Defined in src/Helper.ts:1069

isBottomToTop

isBottomToTop(): boolean
Returns boolean
- Defined in src/Helper.ts:1074

isCanvasIndexOutOfRange

isCanvasIndexOutOfRange(index: number): boolean
Parameters
- index: number
Returns boolean
- Defined in src/Helper.ts:1114

isContinuous

isContinuous(): boolean
Returns boolean
- Defined in src/Helper.ts:1118

isFirstCanvas

isFirstCanvas(index?: number): boolean
Parameters
- Optionalindex: number
Returns boolean
- Defined in src/Helper.ts:1134

isHorizontallyAligned

isHorizontallyAligned(): boolean
Returns boolean
- Defined in src/Helper.ts:1142

isLastCanvas

isLastCanvas(index?: number): boolean
Parameters
- Optionalindex: number
Returns boolean
- Defined in src/Helper.ts:1146

isLeftToRight

isLeftToRight(): boolean
Returns boolean
- Defined in src/Helper.ts:1154

isMultiCanvas

isMultiCanvas(): boolean
Returns boolean
- Defined in src/Helper.ts:1165

isMultiSequence

isMultiSequence(): boolean
Returns boolean
- Defined in src/Helper.ts:1169

isPaged

isPaged(): boolean
Returns boolean
- Defined in src/Helper.ts:1177

isPagingAvailable

isPagingAvailable(): boolean
Returns boolean
- Defined in src/Helper.ts:1193

isPagingEnabled

isPagingEnabled(): boolean
Returns boolean
- Defined in src/Helper.ts:1198

isRightToLeft

isRightToLeft(): boolean
Returns boolean
- Defined in src/Helper.ts:1209

isTopToBottom

isTopToBottom(): boolean
Returns boolean
- Defined in src/Helper.ts:1220

isTotalCanvasesEven

isTotalCanvasesEven(): boolean
Returns boolean
- Defined in src/Helper.ts:1231

isUIEnabled

isUIEnabled(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/Helper.ts:1235

isVerticallyAligned

isVerticallyAligned(): boolean
Returns boolean
- Defined in src/Helper.ts:1260

parseStatement

parseStatement(
statement: LabelValuePair,
): { label: null | string; value: null | string }
Parameters
- statement: LabelValuePair
Returns { label: null | string; value: null | string }
- Defined in src/Helper.ts:525

pruneDecadeNodes

pruneDecadeNodes(rootNode: TreeNode): void
Parameters
- rootNode: TreeNode
Returns void
- Defined in src/Helper.ts:1430

sortDecadeNodes

sortDecadeNodes(rootNode: TreeNode): void
Parameters
- rootNode: TreeNode
Returns void
- Defined in src/Helper.ts:1450

sortMonthNodes

sortMonthNodes(rootNode: TreeNode): void
Parameters
- rootNode: TreeNode
Returns void
- Defined in src/Helper.ts:1456

sortYearNodes

sortYearNodes(rootNode: TreeNode): void
Parameters
- rootNode: TreeNode
Returns void
- Defined in src/Helper.ts:1470

treeHasNavDates

treeHasNavDates(tree: TreeNode): boolean
Parameters
- tree: TreeNode
Returns boolean
- Defined in src/Helper.ts:983