Class Helper

Index

Constructors

Properties

canvasIndex collectionIndex iiifResource manifest manifestIndex manifestUri options rangeId sequenceIndex

Methods

createDateNodes createDecadeNodes createMonthNodes createYearNodes getAccompanyingCanvas getAccompanyingCanvasImage getAllRequiredStatements getAttribution getAutoCompleteService getBehavior getCanvasById getCanvasByIndex getCanvases getCanvasesById getCanvasIndexById getCanvasIndexByLabel getCanvasRange getCanvasRanges 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 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:49

Properties

canvasIndex

canvasIndex: 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:1253

createDecadeNodes

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

createMonthNodes

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

createYearNodes

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

getAccompanyingCanvas

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

getAccompanyingCanvasImage

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

getAllRequiredStatements

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

getAttribution

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

getAutoCompleteService

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

getBehavior

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

getCanvasById

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

getCanvasByIndex

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

getCanvases

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

getCanvasesById

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

getCanvasIndexById

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

getCanvasIndexByLabel

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

getCanvasRange

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

getCanvasRanges

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

getCollectionIndex

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

getCurrentCanvas

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

getCurrentRange

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

getCurrentSequence

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

getDecadeNode

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

getDescription

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

getFirstPageIndex

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

getFlattenedTree

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

getLabel

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

getLastCanvasLabel

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

getLastPageIndex

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

getLicense

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

getLogo

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

getManifestType

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

getMetadata

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

getMonthNode

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

getMostSpecificRequiredStatement

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

getMultiSelectState

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

getNextRange

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

getNodeDisplayDate

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

getNodeDisplayMonth

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

getNodeMonth

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

getNodeYear

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

getPosterCanvas

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

getPosterImage

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

getPreviousRange

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

getRangeById

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

getRangeByPath

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

getRangeCanvases

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

getRanges

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

getRelated

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

getRequiredStatement

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

getRights

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

getSearchService

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

getSeeAlso

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

getSequenceByIndex

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

getShareServiceUrl

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

getStartCanvasIndex

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

getSummary

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

getThumbs

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

getTopRanges

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

getTotalCanvases

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

getTrackingLabel

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

getTree

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

getViewingDirection

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

getViewingHint

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

getYearNode

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

hasAnnotations

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

hasParentCollection

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

hasRelatedPage

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

hasResources

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

isBottomToTop

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

isCanvasIndexOutOfRange

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

isContinuous

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

isFirstCanvas

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

isHorizontallyAligned

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

isLastCanvas

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

isLeftToRight

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

isMultiCanvas

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

isMultiSequence

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

isPaged

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

isPagingAvailable

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

isPagingEnabled

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

isRightToLeft

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

isTopToBottom

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

isTotalCanvasesEven

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

isUIEnabled

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

isVerticallyAligned

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

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

pruneDecadeNodes

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

sortDecadeNodes

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

sortMonthNodes

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

sortYearNodes

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

treeHasNavDates

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