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 getThumbs getTopRanges getTotalCanvases getTrackingLabel getTree getViewingDirection getViewingHint getYearNode 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:1175

createDecadeNodes

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

createMonthNodes

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

createYearNodes

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

getAccompanyingCanvas

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

getAccompanyingCanvasImage

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

getAllRequiredStatements

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

getAttribution

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

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

getCanvasById

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

getCanvasByIndex

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

getCanvases

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

getCanvasesById

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

getCanvasIndexById

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

getCanvasIndexByLabel

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

getCanvasRange

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

getCanvasRanges

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

getCollectionIndex

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

getCurrentCanvas

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

getCurrentRange

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

getCurrentSequence

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

getDecadeNode

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

getDescription

getDescription(): null | string
Returns null | string
- Defined in src/Helper.ts:208

getFirstPageIndex

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

getFlattenedTree

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

getLabel

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

getLastCanvasLabel

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

getLastPageIndex

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

getLicense

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

getLogo

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

getManifestType

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

getMetadata

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

getMonthNode

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

getMostSpecificRequiredStatement

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

getMultiSelectState

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

getNextRange

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

getNodeDisplayDate

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

getNodeDisplayMonth

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

getNodeMonth

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

getNodeYear

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

getPosterCanvas

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

getPosterImage

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

getPreviousRange

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

getRangeById

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

getRangeByPath

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

getRangeCanvases

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

getRanges

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

getRelated

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

getRequiredStatement

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

getRights

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

getSearchService

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

getSeeAlso

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

getSequenceByIndex

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

getShareServiceUrl

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

getStartCanvasIndex

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

getThumbs

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

getTopRanges

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

getTotalCanvases

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

getTrackingLabel

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

getTree

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

getViewingDirection

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

getViewingHint

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

getYearNode

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

hasParentCollection

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

hasRelatedPage

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

hasResources

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

isBottomToTop

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

isCanvasIndexOutOfRange

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

isContinuous

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

isFirstCanvas

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

isHorizontallyAligned

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

isLastCanvas

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

isLeftToRight

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

isMultiCanvas

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

isMultiSequence

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

isPaged

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

isPagingAvailable

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

isPagingEnabled

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

isRightToLeft

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

isTopToBottom

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

isTotalCanvasesEven

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

isUIEnabled

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

isVerticallyAligned

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

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

pruneDecadeNodes

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

sortDecadeNodes

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

sortMonthNodes

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

sortYearNodes

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

treeHasNavDates

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