Class StoriiiesViewer

Hierarchy

  • StoriiiesViewer

Constructors

constructor

Properties

#_activeAnnotationIndex #_activeCanvasIndex #_showInfoArea #annotationIndexCeiling #annotationIndexFloor #prefersReducedMotion #statusCodes DOMPurifyConfig activeCanvasAnnotations annotationPages canvases containerElement controlButtonElements disablePanAndZoom infoAreaElement infoTextElement infoToggleElement instanceId label manifest manifestUrl requiredStatement showCreditSlide summary viewer #instanceCounter

Accessors

activeAnnotationIndex activeCanvasIndex showInfoArea

Methods

#creatTitleSlideMarkup #createAnnotationSlideMarkup #createCreditSlideMarkup #expandServiceID #getActiveCanvasAnnotations #getAnnotationPages #getRegion #initManifest #initViewer #insertInfoAndControls #logger #updateViewer

Constructors

constructor

Properties

Private #_activeAnnotationIndex

#_activeAnnotationIndex: number = -1

Index pointing to the annotation from the annotationPage, currently being viewed
The active annotationPage is treated as being the same as activeCanvasIndex

Private #_activeCanvasIndex

#_activeCanvasIndex: number = 0

Index pointing to the canvas from the manifest currently being viewed
This value is also used to infer the active annotationPage

Private #_showInfoArea

#_showInfoArea: boolean = true

Visibility flag for the infoArea element

Private #annotationIndexCeiling

#annotationIndexCeiling: number

Uppermost number of slides considering factors such as credits

Private #annotationIndexFloor

#annotationIndexFloor: number = -1

Lowermost number of slides considering factors such as a title slide

Private #prefersReducedMotion

#prefersReducedMotion: boolean

Cached user preference on reduced-motion

Private #statusCodes

#statusCodes: statusCodes = ...

Error codes and their levels and user facing log messages

DOMPurifyConfig

DOMPurifyConfig: Config = ...

DOMPurify configuration

activeCanvasAnnotations

activeCanvasAnnotations: Annotation[] = []

The annotations for the current canvas

annotationPages

annotationPages: AnnotationPage[] = []

The annotationPages retrieved from the manifest

canvases

canvases: Canvas[]

The canvases retrieved from the manifest

Readonly containerElement

containerElement: null | HTMLElement = null

The normalised reference to the container where this instance is mounted

Readonly controlButtonElements

controlButtonElements: ControlButtons

References to the navigation control button HTML elements

disablePanAndZoom

disablePanAndZoom: boolean = false

Whether to disable panning and scrolling

Readonly infoAreaElement

infoAreaElement: HTMLElement

A reference to the info-area HTML element

Readonly infoTextElement

infoTextElement: HTMLElement

A reference to the info-text-area HTML element

Readonly infoToggleElement

infoToggleElement: HTMLElement

A reference to the info-toggle HTML element

Readonly instanceId

instanceId: number

ID used for creating id attributes that shouldn't clash, or referencing a particular instance of StoriiiesViewer

label

label: string = ""

The label retrieved from the manifest

manifest

manifest: Manifest

The IIIF manifest loaded into this instance

manifestUrl

manifestUrl: string

The URL for the IIIF manifest loaded into this instance

requiredStatement

requiredStatement: {
    label: string;
    value: string;
}

The required statement label and value retrieved from the manifest

Type declaration

  • label: string
  • value: string

Readonly showCreditSlide

showCreditSlide: boolean = true

Whether to display the closing credit slide. Defaults to true, can be overriden in StoriiiesViewerConfig

summary

summary: string

The summary retrieved from the manifest

viewer

viewer: Viewer

A reference to the OpenSeadragon viewer

Static Private #instanceCounter

#instanceCounter: number = 0

Index representing the number of StoriiiesViewer instances in the current scope

Accessors

activeAnnotationIndex

  • get activeAnnotationIndex(): number

  • Get the active annotation index
    Used to determine which annotation is currently active

    Returns number

  • set activeAnnotationIndex(index): void

  • Set the active annotation index and perform any necessary updates
    Used to navigate between annotations

    Parameters

    • index: number

    Returns void

activeCanvasIndex

  • get activeCanvasIndex(): number

  • Get the active canvas index
    Used to determine which canvas is currently active

    Returns number

  • set activeCanvasIndex(index): void

  • Set the active canvas index and perform any necessary updates
    Used to navigate between canvases

    Parameters

    • index: number

    Returns void

showInfoArea

  • get showInfoArea(): boolean

  • Get the showInfoArea value
    Used to determine whether the info area is visible

    Returns boolean

  • set showInfoArea(value): void

  • Set the showInfoArea value and perform any necessary updates
    Used to toggle the info area visibility

    Parameters

    • value: boolean

    Returns void

Methods

Private #creatTitleSlideMarkup

  • #creatTitleSlideMarkup(): string

  • Generate HTML markup for the title slide

    Returns string

Private #createAnnotationSlideMarkup

  • #createAnnotationSlideMarkup(): string

  • Generate HTML markup for an annotation slide

    Returns string

Private #createCreditSlideMarkup

  • #createCreditSlideMarkup(): string

  • Generate HTML markup for an annotation slide

    Returns string

Private #expandServiceID

  • #expandServiceID(serviceID): string

  • Takes a service ID and returns the expanded URL that includes "/info.json"
    This format is a MUST for the IIIF Image API, so we can rely on our manipulations being valid

    Parameters

    • serviceID: string

    Returns string

Private #getActiveCanvasAnnotations

  • #getActiveCanvasAnnotations(): Annotation[]

  • Get the annotations for the current canvas

    Returns Annotation[]

Private #getAnnotationPages

  • #getAnnotationPages(): AnnotationPage[]

  • Retrieves the annotationPages for the manifest (Temporary solution)

    Returns AnnotationPage[]

Private #getRegion

  • #getRegion(url?): null | Rect

  • Get the region from the URL as a Rect relative to the viewport of this instance's viewer

    Parameters

    • Optional url: string

    Returns null | Rect

Private #initManifest

  • #initManifest(): Promise<void>

  • Load the manifest and extract the label, canvases and annotation pages

    Returns Promise<void>

Private #initViewer

Private #insertInfoAndControls

  • #insertInfoAndControls(): void

  • Create area for label, annotations and controls

    Returns void

Private #logger

  • #logger(code, withException?): void

  • Log a message to the console, or throw an exception

    Parameters

    • code: string
    • withException: boolean = false

    Returns void

Private #updateViewer

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc