Skip to content

Annotations Library

HyperPath.Viewer.Annotations is a viewer-agnostic annotation layer for whole-slide imaging. It renders an SVG overlay and is designed to work with viewers such as OpenSeadragon or Leaflet.

Development

npm install
npm run build
npm run dev
npm run typecheck

Testing

npm test
npm run test:coverage
npm run test:watch

Demo Deployment

Publish the built assets to a consuming app’s wwwroot/lib/annotations directory.

./publish-annotations-to-api.ps1

Keyboard Shortcuts

  • V view mode
  • S select mode
  • C circle
  • R rectangle
  • P polygon
  • A arrow
  • F freehand
  • Escape cancel
  • Delete or Backspace delete selected shape