Javascript Extended Range Imaging Viewer
Switch branches/tags
Nothing to show
Clone or download
cbreak-black Inline Viewer Basic Example
Change the basic example to show how to restrict the viewer to a sub-part
of the page, with fixed size, flowing with the text. This hopefully resolves
issue #2.
Latest commit edf1db9 Oct 15, 2018

README.md

JERI Viewer

The JavaScript Extended-Range Image (JERI) Viewer was designed to be an easy-to-use, interactive component that can be embedded in websites and web-based documents. It contains a version of OpenEXR that was transpiled with emscripten from C++ to JavaScript to enable running it in a web browser. Around this core, JERI offers multi-level tabs that allow easy navigation through large sets of images and supports zooming, panning, changing exposure and view transform, and quickly toggling between images. These features are built using React, but knowledge of this framework is not required to use the viewer.

See jeri.io for a live demonstration.

Getting started--quick and dirty and without Webpack

  1. Build the network (see Contributing section), or get the latest build.
  2. Copy jeri.js, exr-warp.js, exr-warp.wasm and exr.worker.js to your project.
  3. Add <script src="/jeri.js"></script> to your webpage.
  4. See the Examples for use instructions. The examples can be opened in a browser by running a web-server in the build_web directory and then opening http://localhost:3000/examples in a browser.

To run a webserver for viewing the examples, use one of the following:

python -m SimpleHTTPServer 3000 # Python 2
python3 -m http.server 3000 # Python 3
npm install -g serve && serve -s . # JavaScript

Getting started with Webpack

For users experienced with web development that build their projects with webpack and/or use React for their project, it is recommended to directly use the React components defined in src/ and outlined in the API Documentation.

To use JERI Viewer in a web application that is built with webpack, run

npm install --save react
npm install --save react-dom
npm install --save jeri

You can then

import {ImageViewer} from 'jeri';
import {render} from 'react-dom';
const data = {
    title: 'root',
    children: [
        {
            title: 'Mountains',
            image: '/test_image.jpg',
        },
        {
            title: 'Living room',
            image: '/test_image.exr',
            compareTo: {
                reference: '/test_reference.exr',
                input: '/test_input.exr',
            }
        }
    ]
};
render(<ImageViewer data={data} baseUrl='' />, document.getElementById('my-container'));

Contributing

  1. Clone this repository
  2. Run npm install inside the repository directory.
  3. Run npm run docs to generate the API documentation.
  4. Build with npm run build.
  5. Contributors are required to fill out a CLA in order for us to be allowed to accept contributions. See CLA-Individual or CLA-Corporate for details.

Contributors

JERI features contributions by the following people:

  • Jan Novák (Disney Research): Initial code, WebGL
  • Thijs Vogels (Disney Research): Asynchronous EXR loading, React & webpack, UI and API improvements
  • Gerhard Röthlin (Disney Research): Emscripten, code review
  • Alessia Marra (Disney Research): Logo, graphic design