maniiifest/dist/ManiiifestAnnotationPage.d.ts

Typesafe IIIF presentation v3 manifest and collection parsing without external dependencies

import type * as U from "./iiif-types";
/**
 * Parses and provides access to a standalone W3C Annotation Page.
 *
 * Create via `Maniiifest.parseAnnotationPage(data)` or `new ManiiifestAnnotationPage(data)`.
 */
export declare class ManiiifestAnnotationPage {
    private specification;
    constructor(data: any);
    getAnnotationPage(): U.AnnotationPage;
    getAnnotationPageId(): U.Id | null;
    getAnnotationPageType(): U.Type;
    getAnnotationPageContext(): U.Context | null;
    getAnnotationPagePartOf(): U.PartOf | null;
    getAnnotationPageLabel(): U.Label | null;
    getAnnotationPageNext(): U.Next | null;
    getAnnotationPageStartIndex(): U.StartIndex | null;
    /** @yields {U.Annotation} Each annotation in the page. */
    iterateAnnotationPageAnnotation(): IterableIterator<U.Annotation>;
    /** @yields {U.AnnotationBodyTextualBody} Each textual body from annotations in the page. */
    iterateAnnotationPageAnnotationTextualBody(): IterableIterator<U.AnnotationBodyTextualBody>;
    /** @yields {U.AnnotationTargetCanvasRef} Each canvas reference target from annotations in the page. */
    iterateAnnotationPageAnnotationCanvasRef(): IterableIterator<U.AnnotationTargetCanvasRef>;
}