cs

content-state

A library for working with IIIF Content State annotations

Showing:

Popularity

Downloads/wk

9

GitHub Stars

7

Maintenance

Last Commit

1mo ago

Contributors

1

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

ContentState.js

API

Classes

ContentStateError

This is the custom Error class we're assuming we'll throw on parse errors.

Functions

expandAnnotation(annotation)Object

Given a contentState annotation, add back in the context if it's missing. Given a mimimal target-only contentState, assume that it's a target and wrap it in the annotation.

validateAnnotation(annotation)

Given an annotation, confirm that it has the correct context and that it has a target property. Will throw errors if it is not.

isContentStateAnnotation(annotation)Boolean

Inspect the motivation of an annotation and see if it contains the "contentState" motivation.

encodeLink(url, annotation)string

Helper function to create a full link that includes the annotation param.

parseURL(url)Object

Extract the annotation information from a full URL

expandAnnotation(annotation) ⇒ Object

Given a contentState annotation, add back in the context if it's missing. Given a mimimal target-only contentState, assume that it's a target and wrap it in the annotation.

Kind: global function Returns: Object - the annotation with any transformations applied

ParamTypeDescription
annotationObjectthe annotation to expand

validateAnnotation(annotation)

Given an annotation, confirm that it has the correct context and that it has a target property. Will throw errors if it is not.

Kind: global function

ParamTypeDescription
annotationObjectthe annotation to expand

isContentStateAnnotation(annotation) ⇒ Boolean

Inspect the motivation of an annotation and see if it contains the "contentState" motivation.

Kind: global function Returns: Boolean - true if it's a contentState Annotation, false if not.

ParamTypeDescription
annotationObjectthe annotation to inspect

encodeLink(url, annotation) ⇒ string

Helper function to create a full link that includes the annotation param.

Kind: global function Returns: string - The augmented URL

ParamTypeDescription
urlstringThe URL that should have a contentState param added.
annotationObjectThe annotation Object

parseURL(url) ⇒ Object

Extract the annotation information from a full URL

Kind: global function Returns: Object - The annotation data and manifest value

ParamTypeDescription
urlStringThe URL to parse

Credits

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100