Class ManiiifestAnnotationPage

Parses and provides access to a standalone W3C Annotation Page.

Create via Maniiifest.parseAnnotationPage(data) or new ManiiifestAnnotationPage(data).

Hierarchy

ManiiifestAnnotationPage

Index

Constructors

constructor

Methods

Constructors

constructor

new ManiiifestAnnotationPage(data: any): ManiiifestAnnotationPage

- Defined in ManiiifestAnnotationPage.ts:12
Parameters
- data: any
Returns ManiiifestAnnotationPage

Methods

getAnnotationPage

getAnnotationPage(): AnnotationPage

- Defined in ManiiifestAnnotationPage.ts:20
Returns AnnotationPage

getAnnotationPageContext

getAnnotationPageContext(): Context

- Defined in ManiiifestAnnotationPage.ts:32
Returns Context

getAnnotationPageId

getAnnotationPageId(): string

- Defined in ManiiifestAnnotationPage.ts:24
Returns string

getAnnotationPageLabel

getAnnotationPageLabel(): Label

- Defined in ManiiifestAnnotationPage.ts:44
Returns Label

getAnnotationPageNext

getAnnotationPageNext(): string

- Defined in ManiiifestAnnotationPage.ts:50
Returns string

getAnnotationPagePartOf

getAnnotationPagePartOf(): PartOf

- Defined in ManiiifestAnnotationPage.ts:38
Returns PartOf

getAnnotationPageStartIndex

getAnnotationPageStartIndex(): number

- Defined in ManiiifestAnnotationPage.ts:54
Returns number

getAnnotationPageType

getAnnotationPageType(): string

- Defined in ManiiifestAnnotationPage.ts:28
Returns string

iterateAnnotationPageAnnotation

iterateAnnotationPageAnnotation(): IterableIterator<Annotation>

- Defined in ManiiifestAnnotationPage.ts:59
yields
{U.Annotation} Each annotation in the page.

Returns IterableIterator<Annotation>

iterateAnnotationPageAnnotationCanvasRef

iterateAnnotationPageAnnotationCanvasRef(): IterableIterator<AnnotationTargetCanvasRef>

- Defined in ManiiifestAnnotationPage.ts:83
yields
{U.AnnotationTargetCanvasRef} Each canvas reference target from annotations in the page.

Returns IterableIterator<AnnotationTargetCanvasRef>

iterateAnnotationPageAnnotationTextualBody

iterateAnnotationPageAnnotationTextualBody(): IterableIterator<AnnotationBodyTextualBody>

- Defined in ManiiifestAnnotationPage.ts:66
yields
{U.AnnotationBodyTextualBody} Each textual body from annotations in the page.

Returns IterableIterator<AnnotationBodyTextualBody>

Generated using TypeDoc