Skip to content

lunit-io/osd-react-renderer

Repository files navigation

osd-react-renderer (OSD-R)

A custom React renderer for OpenSeadragon viewer, built using react-reconciler package.

Install

npm

$ npm install @lunit/osd-react-renderer

yarn

$ yarn add @lunit/osd-react-renderer

Documentation

OSDViewer and Viewport: The base components used to add OpenSeadragon React Renderer to your projects.

TiledImage: Used to display Deep Zoom Images (DZI) in your OSD-R viewer.

Canvas Overlay: Used to add HTML Canvas-rendered images over your DZI.

Tooltip Overlay: Used to add HTML Canvas-rendered images over your DZI that can be positioned with the mouse

WebGL Overlay: Used to add WebGL2-rendered elements over your DZI.

SVG Overlay: Used to add SVG elements over your DZI