@indicia-js/core NPM

@indicia-js/core

A tiny library with no dependencies that helps to manage biological records based on Samples and Occurrences.

Usage

import { Sample, Occurrence, Media } from '@indicia-js/core';

// Sample
var sample = new Sample();
sample.attrs.date = '12/2/2012';
sample.attrs.location = '12.345, -12.345';

// Occurrence
var occ = new Occurrence();
occ.attrs.taxon = 'bee';
occ.attrs.number = 5;
occ.attrs.colours = ['red', 'green'];

sample.occurrences.push(occ);

// Image
var image = new Media();
await image.resize(800, 400);
await image.addThumbnail();

occ.media.push(image);

Initialization

Step 1: Get the library

npm i @indicia-js/core

Step 2: include JS files

You can find them in the root folder of the library.

<!-- Add JS library file -->
<script src="path/to/indicia.js"></script>

import { Sample, Occurrence, Media } from 'indicia';

API

// all models
static Model.fromJSON() ⇒ Promise

model.cid: UUID
model.attrs: Object
model.metadata: Object

model.toJSON() ⇒ Promise


// Sample
sample.occurrences: Array
sample.samples: Array
sample.media: Array

// Occurrence
occurrence.media: Array

// Media
media.getURL() ⇒ String
media.addThumbnail() ⇒ Promise
media.resize(MAX_WIDTH, MAX_HEIGHT) ⇒ Promise