MCPcopy Index your code
hub / github.com/annotorious/annotorious

github.com/annotorious/annotorious @v3.4.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v3.4.0 ↗ · + Follow
513 symbols 1,037 edges 166 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Aerial view of Schönbrunn Palace in Vienna annotated with Annotorious

Annotorious - JavaScript Image Annotation

Add image annotation functionality to any web page with a few lines of JavaScript. Visit the project website for documentation and live demos.

npm install @annotorious/annotorious

Quick Start

import { createImageAnnotator } from '@annotorious/annotorious';

import '@annotorious/annotorious/annotorious.css';

const anno = createImageAnnotator('image-to-annotate');

// Load annotations from a file
anno.loadAnnotations('./annotations.json');

// Listen to user events
anno.on('createAnnotation', function(annotation) {
  console.log('new annotation', annotation);
});

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 me :-)

Community

Visit the Discussion Forum for community support, or file an issue on the Issue Tracker.

Become a Sponsor

Using Annotorious at work? Become a sponsor! Your support helps me cover hosting costs, spend more time supporting the community, and make Annotorious better for everyone. Make a one-time or monthly donation via my SteadyHQ account.

Older Versions

Documentation for Annotorious version 2.7 is available here.

Extension points exported contracts — how you extend this code

AnnotoriousOSDOpts (Interface)
(no doc)
packages/annotorious-openseadragon/src/AnnotoriousOSDOpts.ts
LifecycleEvents (Interface)
(no doc)
packages/annotorious-core/src/lifecycle/LifecycleEvents.ts
AnnotoriousManifoldContextValue (Interface)
(no doc)
packages/annotorious-react-manifold/src/AnnotoriousManifold.tsx
ImageAnnotator (Interface)
(no doc)
packages/annotorious/src/Annotorious.ts
Selection (Interface)
(no doc)
packages/annotorious-react/src/Annotorious.tsx
OpenSeadragonAnnotator (Interface)
(no doc)
packages/annotorious-openseadragon/src/Annotorious.ts
PresenceState (Interface)
(no doc)
packages/annotorious-core/src/presence/PresenceState.ts
ManifoldSelection (Interface)
(no doc)
packages/annotorious-react-manifold/src/AnnotoriousManifold.tsx

Core symbols most depended-on inside this repo

getAnnotation
called by 49
packages/annotorious-react-manifold/src/AnnotoriousManifoldInstance.ts
addAnnotation
called by 16
packages/annotorious-core/src/model/Annotator.ts
createStore
called by 16
packages/annotorious-core/src/state/Store.ts
emit
called by 16
packages/annotorious-core/src/state/Store.ts
set
called by 16
packages/annotorious/src/state/spatialTree.ts
emit
called by 14
packages/annotorious-core/src/lifecycle/Lifecycle.ts
clear
called by 14
packages/annotorious-react-manifold/src/AnnotoriousManifoldInstance.ts
subscribe
called by 12
packages/annotorious-core/src/state/SvelteStore.ts

Shape

Function 336
Method 87
Interface 86
Enum 4

Languages

TypeScript100%

Modules by API surface

packages/annotorious-core/src/model/Annotator.ts41 symbols
packages/annotorious-react-manifold/src/AnnotoriousManifoldInstance.ts31 symbols
packages/annotorious-openseadragon/src/Annotorious.ts31 symbols
packages/annotorious-core/src/state/Store.ts30 symbols
packages/annotorious-core/src/state/UndoStack.ts27 symbols
packages/annotorious/src/Annotorious.ts25 symbols
packages/annotorious-openseadragon/src/annotation/pixi/stageRenderer.ts18 symbols
packages/annotorious-react/src/Annotorious.tsx16 symbols
packages/annotorious-core/src/presence/PresenceState.ts15 symbols
packages/annotorious-core/src/state/Selection.ts14 symbols
packages/annotorious-react/src/state/AnnotoriousZustand.tsx12 symbols
packages/annotorious/src/state/spatialTree.ts11 symbols

For agents

$ claude mcp add annotorious \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact