Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Helper

Hierarchy

  • Helper

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _multiSelectState

_multiSelectState: MultiSelectState

canvasIndex

canvasIndex: number

collectionIndex

collectionIndex: number

iiifResource

iiifResource: IIIFResource

iiifResourceUri

iiifResourceUri: string

manifest

manifest: Manifest

manifestIndex

manifestIndex: number

options

options: IManifoldOptions

rangeId

rangeId: string | null

sequenceIndex

sequenceIndex: number

Methods

Private _flattenTree

Private _getRangeMetadata

Private _getTopRanges

  • _getTopRanges(): Range[]

Private _parseMetadataOptions

createDateNodes

createDecadeNodes

createMonthNodes

createYearNodes

getAttribution

  • getAttribution(): string | null

getAutoCompleteService

  • getAutoCompleteService(): Service | null

getCanvasById

  • getCanvasById(id: string): Canvas | null

  • Parameters

    • id: string

    Returns Canvas | null

getCanvasByIndex

  • getCanvasByIndex(index: number): Canvas

  • Parameters

    • index: number

    Returns Canvas

getCanvasIndexById

  • getCanvasIndexById(id: string): number | null

  • Parameters

    • id: string

    Returns number | null

getCanvasIndexByLabel

  • getCanvasIndexByLabel(label: string): number

  • Parameters

    • label: string

    Returns number

getCanvasRange

  • getCanvasRange(canvas: Canvas, path?: undefined | string): Range | null

  • Parameters

    • canvas: Canvas
    • Optional path: undefined | string

    Returns Range | null

getCanvasRanges

  • getCanvasRanges(canvas: Canvas): Range[]

  • Parameters

    • canvas: Canvas

    Returns Range[]

getCanvases

  • getCanvases(): Canvas[]

getCanvasesById

  • getCanvasesById(ids: string[]): Canvas[]

  • Parameters

    • ids: string[]

    Returns Canvas[]

getCollectionIndex

  • getCollectionIndex(iiifResource: IIIFResource): number | null

  • Parameters

    • iiifResource: IIIFResource

    Returns number | null

getCurrentCanvas

  • getCurrentCanvas(): Canvas

getCurrentRange

  • getCurrentRange(): Range | null

getCurrentSequence

  • getCurrentSequence(): Sequence

getDecadeNode

getDescription

  • getDescription(): string | null

getFirstPageIndex

  • getFirstPageIndex(): number

getFlattenedTree

getLabel

  • getLabel(): string | null

getLastCanvasLabel

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

  • Parameters

    • Optional alphanumeric: undefined | false | true

    Returns string

getLastPageIndex

  • getLastPageIndex(): number

getLicense

  • getLicense(): string | null

getLogo

  • getLogo(): string | null

getManifestType

  • getManifestType(): ManifestType

getMetadata

getMonthNode

getMultiSelectState

getNextRange

  • getNextRange(range?: Range): Range | null

  • Parameters

    • Optional range: Range

    Returns Range | null

getNodeDisplayDate

getNodeDisplayMonth

getNodeMonth

getNodeYear

getPosterCanvas

  • getPosterCanvas(): Canvas | null

getPosterImage

  • getPosterImage(): string | null

getPreviousRange

  • getPreviousRange(range?: Range): Range | null

  • Parameters

    • Optional range: Range

    Returns Range | null

getRangeById

  • getRangeById(id: string): Range | null

  • Parameters

    • id: string

    Returns Range | null

getRangeByPath

  • getRangeByPath(path: string): Range | null

  • Parameters

    • path: string

    Returns Range | null

getRangeCanvases

  • getRangeCanvases(range: Range): Canvas[]

  • Parameters

    • range: Range

    Returns Canvas[]

getRanges

  • getRanges(): Range[]

getRelated

  • getRelated(): any

getRequiredStatement

getSearchService

  • getSearchService(): Service | null

getSeeAlso

  • getSeeAlso(): any

getSequenceByIndex

  • getSequenceByIndex(index: number): Sequence

  • Parameters

    • index: number

    Returns Sequence

getShareServiceUrl

  • getShareServiceUrl(): string | null

getSortedTreeNodesByDate

getStartCanvasIndex

  • getStartCanvasIndex(): number

getThumbs

  • getThumbs(width: number, height: number): Thumb[]

  • Parameters

    • width: number
    • height: number

    Returns Thumb[]

getTopRanges

  • getTopRanges(): Range[]

getTotalCanvases

  • getTotalCanvases(): number

getTrackingLabel

  • getTrackingLabel(): string

getTree

getViewingDirection

  • getViewingDirection(): ViewingDirection | null

getViewingHint

  • getViewingHint(): ViewingHint | null

getYearNode

hasParentCollection

  • hasParentCollection(): boolean

hasRelatedPage

  • hasRelatedPage(): boolean

hasResources

  • hasResources(): boolean

isBottomToTop

  • isBottomToTop(): boolean

isCanvasIndexOutOfRange

  • isCanvasIndexOutOfRange(index: number): boolean

  • Parameters

    • index: number

    Returns boolean

isContinuous

  • isContinuous(): boolean

isFirstCanvas

  • isFirstCanvas(index?: undefined | number): boolean

  • Parameters

    • Optional index: undefined | number

    Returns boolean

isHorizontallyAligned

  • isHorizontallyAligned(): boolean

isLastCanvas

  • isLastCanvas(index?: undefined | number): boolean

  • Parameters

    • Optional index: undefined | number

    Returns boolean

isLeftToRight

  • isLeftToRight(): boolean

isMultiCanvas

  • isMultiCanvas(): boolean

isMultiSequence

  • isMultiSequence(): boolean

isPaged

  • isPaged(): boolean

isPagingAvailable

  • isPagingAvailable(): boolean

isPagingEnabled

  • isPagingEnabled(): boolean

isRightToLeft

  • isRightToLeft(): boolean

isTopToBottom

  • isTopToBottom(): boolean

isTotalCanvasesEven

  • isTotalCanvasesEven(): boolean

isUIEnabled

  • isUIEnabled(name: string): boolean

  • Parameters

    • name: string

    Returns boolean

isVerticallyAligned

  • isVerticallyAligned(): boolean

pruneDecadeNodes

sortDecadeNodes

sortMonthNodes

sortYearNodes

treeHasNavDates

Generated using TypeDoc