README.md

NgxAnnotorious

This project was generated using Angular CLI version 19.0.5.

This workspace contains a self-contained Angular wrapper for Annotorious V3, plus a couple of Cadmus-related libraries depending on it.

To use the Annotorious wrapper you just need Annotorious, and no other dependency. Cadmus libraries are in this workspace for practical reasons, but also provide an example for using the library.

• Angular Annotorious wrapper: 📦 @myrmidon/ngx-annotorious.
• Angular OSD Annotorious wrapper: not yet working.
• Cadmus Image Gallery Brick: 📦 @myrmidon/cadmus-img-gallery.
• IIIF support for Cadmus Image Gallery Brick: 📦 @myrmidon/cadmus-img-gallery-iiif.

Quick Start

1. clone or download this repository.
2. install packages with npm i.
3. build libraries with npm run build-lib.
4. run with ng serve.
5. in the homepage, add annotations and play with them. In this case, the custom model linked to the annotation is just a string, so the popup dialog allows you to enter it. Look at the console for more information from logging. Use the menus to access other functionalities.

Dependencies

graph LR;
  ngx-annotorious --> annotorious
  ngx-annotorious-osd --> annotorious
  ngx-annotorious-osd --> annotorious/openseadragon
  ngx-annotorious-osd --> ngx-annotorious
  img-gallery --> ngx-annotorious
  img-gallery-iiif --> ngx-tools
  img-gallery-iiif --> ngx-annotorious
  img-gallery-iiif --> img-gallery

Loading

History

• 2025-01-30 (affecting @myrmidon/cadmus-img-gallery and @myrmidon/ngx-annotorious):
  • removed priority from gallery list component HTML template.
  • completed migration to signals.
  • better handling of image optimizer in gallery.
  • more detailed logging.

0.0.3

• 2025-01-24:
  • updated ngx-annotorious and Angular.
  • added Docker support.

0.0.2

• 2024-12-27: first package.