@iiif/3d-manifesto-dev/dist-commonjs/Sequence.d.ts

IIIF Presentation API utility library for client and server with 3D extension

import { ViewingDirection, ViewingHint } from "@iiif/vocabulary/dist-commonjs";
import { Canvas, IManifestoOptions, ManifestResource, Scene, Thumb, Thumbnail } from "./internal";
export declare class Sequence extends ManifestResource {
    items: Canvas[];
    private _thumbnails;
    constructor(jsonld?: any, options?: IManifestoOptions);
    getCanvases(): Canvas[];
    getCanvasById(id: string): Canvas | null;
    getCanvasByIndex(canvasIndex: number): any;
    getCanvasIndexById(id: string): number | null;
    getCanvasIndexByLabel(label: string, foliated?: boolean): number;
    getLastCanvasLabel(alphanumeric?: boolean): string;
    getLastPageIndex(): number;
    getNextPageIndex(canvasIndex: number, pagingEnabled?: boolean): number;
    getPagedIndices(canvasIndex: number, pagingEnabled?: boolean): number[];
    getPrevPageIndex(canvasIndex: number, pagingEnabled?: boolean): number;
    /**
    * @returns Array of Scene instances in the Sequence
    **/
    getScenes(): Scene[];
    getStartCanvasIndex(): number;
    getThumbs(width: number, height?: number): Thumb[];
    getThumbnails(): Thumbnail[];
    getStartCanvas(): string;
    getTotalCanvases(): number;
    getViewingDirection(): ViewingDirection | null;
    getViewingHint(): ViewingHint | null;
    isCanvasIndexOutOfRange(canvasIndex: number): boolean;
    isFirstCanvas(canvasIndex: number): boolean;
    isLastCanvas(canvasIndex: number): boolean;
    isMultiCanvas(): boolean;
    isPagingEnabled(): boolean;
    isTotalCanvasesEven(): boolean;
}