JSPM – @cogic/annotorious@2.7.20

Package Exports

@cogic/annotorious
@cogic/annotorious/dist/annotorious.min.js
@cogic/annotorious/src/selectors
@cogic/annotorious/src/selectors/EmbeddedSVG
@cogic/annotorious/src/selectors/EmbeddedSVG.js
@cogic/annotorious/src/selectors/index.js
@cogic/annotorious/src/tools/EditableShape
@cogic/annotorious/src/tools/EditableShape.js
@cogic/annotorious/src/tools/Tool
@cogic/annotorious/src/tools/Tool.js
@cogic/annotorious/src/tools/ToolsRegistry
@cogic/annotorious/src/tools/ToolsRegistry.js
@cogic/annotorious/src/tools/polygon/PolygonMask
@cogic/annotorious/src/tools/polygon/PolygonMask.js
@cogic/annotorious/src/util/Formatting
@cogic/annotorious/src/util/Formatting.js
@cogic/annotorious/src/util/Geom2D
@cogic/annotorious/src/util/Geom2D.js
@cogic/annotorious/src/util/SVG
@cogic/annotorious/src/util/SVG.js
@cogic/annotorious/src/util/Touch
@cogic/annotorious/src/util/Touch.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@cogic/annotorious) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

A JavaScript image annotation library. Add drawing, commenting and labeling functionality to images in Web pages with just a few lines of code. Weighs less than 300kB. See the project website for details and live demos.

Installing

If you use npm, npm install @recogito/annotorious and

import { Annotorious } from '@recogito/annotorious';

import '@recogito/annotorious/dist/annotorious.min.css';

const anno = new Annotorious({ image: 'hallstatt' }); // image element or ID

Otherwise download the latest release and include it in your web page.

<link rel="stylesheet" href="annotorious.min.css">
<script src="annotorious.min.js"></script>

Using

<body>
  <div id="content">
    <img id="hallstatt" src="640px-Hallstatt.jpg">
  </div>
  <script>
    (function() {
      var anno = Annotorious.init({
        image: 'hallstatt'
      });

      anno.loadAnnotations('annotations.w3c.json');
    })()
  </script>
  <script type="text/javascript" src="annotorious.min.js"></script>
</body>

Full documentation is on the project website. Questions? Feedack? Feature requests? Join the Annotorious chat on Gitter.

License

BSD 3-Clause (= feel free to use this code in whatever way you wish. But keep the attribution/license file, and if this code breaks something, don't complain to us :-)

Who's Using Annotorious

NHS Wales Logo

Using Annotorious? Let us know!

Contributing

Contributions to both the code and documentation are welcome! More details can be found in the Hacker's Guide on the project website.