pdf-annotate.js

WebJar for pdf-annotate.js

License	MIT
Categories	PDF Data
GroupId	org.webjars.bowergithub.vimalkumar010
ArtifactId	pdf-annotate.js
Last Version	2.2.2
Release Date	Jun 9, 2020
Type	jar
Description	pdf-annotate.js WebJar for pdf-annotate.js
Project URL	https://www.webjars.org
Source Code Management	https://github.com/vimalkumar010/pdf-annotate.js

Download pdf-annotate.js

Filename	Size
pdf-annotate.js-2.2.2.pom
pdf-annotate.js-2.2.2.jar	1 MB
pdf-annotate.js-2.2.2-sources.jar	22 bytes
pdf-annotate.js-2.2.2-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.bowergithub.vimalkumar010/pdf-annotate.js/ -->
<dependency>
    <groupId>org.webjars.bowergithub.vimalkumar010</groupId>
    <artifactId>pdf-annotate.js</artifactId>
    <version>2.2.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.bowergithub.vimalkumar010/pdf-annotate.js/
implementation 'org.webjars.bowergithub.vimalkumar010:pdf-annotate.js:2.2.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.bowergithub.vimalkumar010/pdf-annotate.js/
implementation ("org.webjars.bowergithub.vimalkumar010:pdf-annotate.js:2.2.2")

Apache Buildr

'org.webjars.bowergithub.vimalkumar010:pdf-annotate.js:jar:2.2.2'

Apache Ivy

<dependency org="org.webjars.bowergithub.vimalkumar010" name="pdf-annotate.js" rev="2.2.2">
  <artifact name="pdf-annotate.js" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.bowergithub.vimalkumar010', module='pdf-annotate.js', version='2.2.2')
)

Scala SBT

libraryDependencies += "org.webjars.bowergithub.vimalkumar010" % "pdf-annotate.js" % "2.2.2"

Leiningen

[org.webjars.bowergithub.vimalkumar010/pdf-annotate.js "2.2.2"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

pdf-annotate.js

Annotation layer for PDF.js.

Combined fork of archived instructure/pdf-annotate.js and deleted DynamicEnvironmentSystems/pdf-annotate.js. Under active development for usage within Submitty.

To report issues for pdf-annotate.js, please file them under the Submitty/Submitty repository.

Objectives

• Provide a low level annotation layer for pdf.js.
• Optional high level UI for managing annotations.
• Agnostic of backend, just supply your own StoreAdapter to fetch/store data.
• Prescribe annotation format.

Example

import pdfjsLib from 'pdfjs-dist/build/pdf';
import PDFJSAnnotate from 'pdfjs-annotate';
import MyStoreAdapter from './myStoreAdapter';

const { UI } = PDFJSAnnotate;
const VIEWER = document.getElementById('viewer');
const RENDER_OPTIONS = {
  documentId: 'MyPDF.pdf',
  pdfDocument: null,
  scale: 1,
  rotate: 0
};

pdfjsLib.workerSrc = 'pdf.worker.js';
PDFJSAnnotate.setStoreAdapter(MyStoreAdapter);

pdfjsLib.getDocument(RENDER_OPTIONS.documentId).promise.then((pdf) => {
  RENDER_OPTIONS.pdfDocument = pdf;
  VIEWER.appendChild(UI.createPage(1));
  UI.renderPage(1, RENDER_OPTIONS);
});

See more examples.

Documentation

View the docs.

Developing

# clone the repo
$ git clone https://github.com/Submitty/pdf-annotate.js.git
$ cd pdf-annotate.js

# intall dependencies
$ npm install

# start example server
$ npm start
$ open http://127.0.0.1:8080

# run tests
$ npm test

# lint the code
$ npm run lint

Versions

Version
2.2.2 Jun 9, 2020