Interface StoriiiesViewerConfig

Config object used when instantiating a new StoriiiesViewer

interface StoriiiesViewerConfig {
    container: string | Element | HTMLElement | null;
    disablePanAndZoom?: boolean;
    manifestUrl: string;
    pointOfInterestSvgUrl?: string;
    showCreditSlide?: boolean;
}

Properties

container: string | Element | HTMLElement | null

The container element where StoriiiesViewer should be mounted. Must exist in the page

disablePanAndZoom?: boolean

Whether to disable user panning and zooming (default: false)

manifestUrl: string

The URL for the IIIF manifest to be loaded into StoriiiesViewer

pointOfInterestSvgUrl?: string

URL for a custom SVG to use for points of interest (default: a ring with a dot in the middle)

showCreditSlide?: boolean

Whether to show the final credit slide (default: true)