Skip to content

Added get content on different annotation pages #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added get content on different annotation pages #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 52 additions & 3 deletions src/Canvas.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,23 @@ export class Canvas extends Resource {
return maxDimensions;
}

// Presentation API 3.0
getContent(): Annotation[] {
/**
* Return first annotation page of content.
*/
getContent(): Annotation[];

/**
* Get content by index of annotation page
* @param index
*/
getContent(index: number): Annotation[];

/**
* Get canvas content by Identifier on Annotation Page
* @param pageId
*/
getContent(pageId: string): Annotation[];
getContent(index: string | number = 0): Annotation[] {
const content: Annotation[] = [];

const items = this.__jsonld.items || this.__jsonld.content;
Expand All @@ -146,8 +161,13 @@ export class Canvas extends Resource {
// should be contained in an AnnotationPage
let annotationPage: AnnotationPage | null = null;

const page =
typeof index === "string"
? this.getAnnotationPageIndexById(index, 0)
: index;

if (items.length) {
annotationPage = new AnnotationPage(items[0], this.options);
annotationPage = new AnnotationPage(items[page], this.options);
}

if (!annotationPage) {
Expand All @@ -165,6 +185,35 @@ export class Canvas extends Resource {
return content;
}

/**
* Returns the index of the annotation page given an ID.
*
* @param pageId
*/
getAnnotationPageIndexById(pageId: string): number | undefined;
getAnnotationPageIndexById(pageId: string, defaultIndex: number): number;
getAnnotationPageIndexById(
pageId: string,
defaultIndex?: number
): number | undefined {
const items = this.__jsonld.items || this.__jsonld.content;
if (!items || items.length === 0) {
return defaultIndex;
}

for (let index = 0; index < items.length; index++) {
if (items[index].id && items[index].id === pageId) {
return index;
}
}

return defaultIndex;
}

getAnnotationTotalPages(): number {
return (this.__jsonld.items || this.__jsonld.content || []).length;
}

getDuration(): number | null {
return this.getProperty("duration");
}
Expand Down
3 changes: 2 additions & 1 deletion test/fixtures/manifests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ module.exports = {
"witnesstopeter": "http://localhost:3001/witnesstopeter.json",
"wunder": "http://localhost:3001/wunder.json",
"deephierarchytop": "http://localhost:3001/deephierarchytop.json",
"sctagracilis": "http://localhost:3001/sctagracilis.json"
"sctagracilis": "http://localhost:3001/sctagracilis.json",
"pres3MultiAnnotationPages": "http://localhost:3001/pres3-manifest-multi-annotation-pages.json",
//"query-bodleian": "http://iiif.bodleian.ox.ac.uk/iiif/manifest/f22e9dae-c070-48eb-be0b-aa6c5bc195a6.json",
//"query-gams": "http://gams.uni-graz.at/cocoon/mets2json?source=http%3A%2F%2Fgams.uni-graz.at%2Farchive%2Fget%2Fo%3Asrbas.1535%2FMETS_SOURCE"
};
Expand Down
165 changes: 165 additions & 0 deletions test/fixtures/pres3-manifest-multi-annotation-pages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
{
"@context": "http://iiif.io/api/presentation/3/context.json",
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/manifest.json",
"type": "Manifest",
"label": {
"it": [
"L'Elisir D'Amore"
],
"en": [
"The Elixir of Love"
]
},
"metadata": [
{
"label": {
"en": [
"Date Issued"
]
},
"value": {
"en": [
"2019"
]
}
},
{
"label": {
"en": [
"Publisher"
]
},
"value": {
"en": [
"Indiana University Jacobs School of Music"
]
}
}
],
"items": [
{
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1",
"type": "Canvas",
"width": 1920,
"height": 1080,
"duration": 7278.422,
"items": [
{
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1/annotation_page/1",
"type": "AnnotationPage",
"items": [
{
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1/annotation_page/1/annotation/1",
"type": "Annotation",
"motivation": "painting",
"target": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1#t=0",
"body": {
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/vae0637_accessH264_low.mp4",
"type": "Video",
"format": "video/mp4",
"height": 1080,
"width": 1920,
"duration": 3971.24
}
}
]
},
{
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1/annotation_page/2",
"type": "AnnotationPage",
"items": [
{
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1/annotation_page/1/annotation/2",
"type": "Annotation",
"motivation": "painting",
"target": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1#t=3971.24",
"body": {
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/vae0637_accessH264_low_act_2.mp4",
"type": "Video",
"format": "video/mp4",
"height": 1080,
"width": 1920,
"duration": 3307.22
}
}
]
}
],
"thumbnail": [
{
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/act1-thumbnail.png",
"type": "Image"
}
]
}
],
"structures": [
{
"type": "Range",
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/range/1",
"label": {
"it": [
"Gaetano Donizetti, L'Elisir D'Amore"
]
},
"items": [
{
"type": "Range",
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/range/2",
"label": {
"it": [
"Atto Primo"
]
},
"items": [
{
"type": "Range",
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/range/3",
"label": {
"it": [
"Preludio e Coro d'introduzione – Bel conforto al mietitore"
]
},
"items": [
{
"type": "Canvas",
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1#t=0,302.05"
}
]
},
{
"type": "Range",
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/range/4",
"label": {
"en": [
"Remainder of Atto Primo"
]
},
"items": [
{
"type": "Canvas",
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1#t=302.05,3971.24"
}
]
}
]
},
{
"type": "Range",
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/range/5",
"label": {
"it": [
"Atto Secondo"
]
},
"items": [
{
"type": "Canvas",
"id": "https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1#t=3971.24,7278.422"
}
]
}
]
}
]
}
1 change: 1 addition & 0 deletions test/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ importTest('pres3-collection', './tests/pres3-collection');
importTest('pres3-collection2', './tests/pres3-collection2');
importTest('pres3-collection3', './tests/pres3-collection3');
importTest('pres3-collection4', './tests/pres3-collection4');
importTest('pres3-multiple-annotation-pages', './tests/pres3-multiple-annotation-pages');
importTest('pres3-pdf', './tests/pres3-pdf');
importTest('pres3', './tests/pres3');
importTest('presentation2-paging', './tests/presentation2-paging');
Expand Down
42 changes: 42 additions & 0 deletions test/tests/pres3-multiple-annotation-pages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
var expect = require('chai').expect;
var should = require('chai').should();
var manifesto = require('../../dist-commonjs/');
var manifests = require('../fixtures/manifests');

var manifest, canvas;

describe('presentation 3 - multiple annotation pages', function() {

it('loads successfully', function(done) {
manifesto.loadManifest(manifests.pres3MultiAnnotationPages).then(function(data) {
manifest = manifesto.parseManifest(data);
canvas = manifest.getSequenceByIndex(0).getCanvasByIndex(0);
done();
});
});

it('has correct total for annotation pages', function() {

expect(canvas.getAnnotationTotalPages()).to.equal(2);
});

it('can access first and second pages', () => {
const firstPage = canvas.getAnnotationPageIndexById('https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1/annotation_page/1');
expect(firstPage).to.equal(0);

const secondPage = canvas.getAnnotationPageIndexById('https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1/annotation_page/2');
expect(secondPage).to.equal(1);
})

it('create annotation pages correctly', () => {
const firstPage = canvas.getContent('https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1/annotation_page/1');
expect(firstPage).to.have.lengthOf(1);
expect(firstPage[0].id).to.equal('https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1/annotation_page/1/annotation/1');

const secondPage = canvas.getContent('https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1/annotation_page/2');
expect(secondPage).to.have.lengthOf(1);
expect(secondPage[0].id).to.equal('https://iiif.io/api/cookbook/recipe/0064-opera-one-canvas/canvas/1/annotation_page/1/annotation/2');
})

});