| 1 | cornerstone Web Image Loader
|
| 2 | =============================
|
| 3 |
|
| 4 | A [cornerstone](https://github.com/cornerstonejs/cornerstone) Image Loader for web images (PNG, JPEG).
|
| 5 |
|
| 6 | Live Examples
|
| 7 | ---------------
|
| 8 |
|
| 9 | [Click here for a live example of this library in use!](http://rawgit.com/cornerstonejs/cornerstoneWebImageLoader/master/examples/index.html)
|
| 10 |
|
| 11 | View the [simple image viewer](http://viewer.ohif.org/) built on cornerstone.
|
| 12 |
|
| 13 | Install
|
| 14 | -------
|
| 15 |
|
| 16 | Get a packaged source file:
|
| 17 |
|
| 18 | * [cornerstoneWebImageLoader.js](https://raw.githubusercontent.com/cornerstonejs/cornerstoneWebImageLoader/master/dist/cornerstoneWebImageLoader.js)
|
| 19 | * [cornerstoneWebImageLoader.min.js](https://raw.githubusercontent.com/cornerstonejs/cornerstoneWebImageLoader/master/dist/cornerstoneWebImageLoader.min.js)
|
| 20 |
|
| 21 | Or install via [NPM](https://www.npmjs.com/):
|
| 22 |
|
| 23 | > npm install cornerstone-web-image-loader
|
| 24 |
|
| 25 | Usage
|
| 26 | -------
|
| 27 |
|
| 28 | Simply include the cornerstoneWebImageLoader.js in your HTML file after you load cornerstone.js and then set the cornerstone instance as an external module for cornerstoneWebImageLoader:
|
| 29 |
|
| 30 | ````javascript
|
| 31 | cornerstoneWebImageLoader.external.cornerstone = cornerstone;
|
| 32 | ````
|
| 33 |
|
| 34 | This will let cornerstoneWebImageLoader register itself with cornerstone to load imageId's that have the http or https url schemes. To display an image, pass the url to the image as the imageId parameter to a cornerstone API function loadImage().
|
| 35 |
|
| 36 | Key Features
|
| 37 | ------------
|
| 38 |
|
| 39 | * Provides a bridge between the cornerstone library and standard web images
|
| 40 | * Allows XHR to be hooked so custom http headers can be added (e.g. for authentication). View the source of the
|
| 41 | [example](http://rawgit.com/cornerstonejs/cornerstoneWebImageLoader/master/examples/index.html) to see how this is done.
|
| 42 |
|
| 43 | Contributors
|
| 44 | ------------
|
| 45 | @onluiz for fixing a bug with images not being properly invalidated
|
| 46 | @leonardorame for adding support for CornerstoneImageLoadProgress
|
| 47 |
|
| 48 | Build System
|
| 49 | ============
|
| 50 |
|
| 51 | This project uses webpack to build the software.
|
| 52 |
|
| 53 | Pre-requisites:
|
| 54 | ---------------
|
| 55 |
|
| 56 | NodeJs - [click to visit web site for installation instructions](http://nodejs.org).
|
| 57 |
|
| 58 | Common Tasks
|
| 59 | ------------
|
| 60 |
|
| 61 | Update dependencies (after each pull):
|
| 62 | > npm install
|
| 63 |
|
| 64 | Running the build:
|
| 65 | > npm start
|
| 66 |
|
| 67 | Automatically running the build and unit tests after each source change:
|
| 68 | > npm run watch
|
| 69 |
|
| 70 | Why is this a separate library from cornerstone?
|
| 71 | ================================================
|
| 72 |
|
| 73 | Cornerstone was designed to support loading of any kind of image regardless of its container,
|
| 74 | compression algorithm, encoding or transport. This is one of many possible image loaders
|
| 75 | that can provide the image pixel data to cornerstone to display
|
| 76 |
|
| 77 | Copyright
|
| 78 | ============
|
| 79 | Copyright 2017 Chris Hafey [chafey@gmail.com](mailto:chafey@gmail.com) |
| \ | No newline at end of file |