Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
javascripts
stylesheets
MIT-LICENSE
image_viewer.js
readme.md

readme.md

Image Viewer

ImageViewer is a jQuery plugin developed in house at Pro Medical, Inc. It's purpose is to display an array of images on a page, typically next to a form. It has several hot keys (all activated by entering command-mode) to manipulate the image without having to leave the home row. An example is available on GitHub pages here.


Installation and Basic Usage

add to the head of your html

<script src="shortcut.js" type="text/javascript" charset="utf-8"></script>
<script src="image_viewer.js" type="text/javascript" charset="utf-8" ></script>
<link rel="StyleSheet" href="stylesheets/image-viewer.css" type="text/css" media="screen">

add to the body of your html

<div id="your_div"></div>

Call the plugin like so:

$("#your_div").imageViewer(["Array", "of", "Images"])

To manually call publicly accessible functions simply

$("#your_div").imageViewer.zoom(10)

Available methods are:

  • zoom(increment)
  • scroll(top, left)
  • scrollPage(increment)
  • rotate(degree)
  • print()

Nav Links containing these functions as onclick events are created by default just above the window pane. If you would like to suppress these pass 'nav_links':false like so

$('#your_div').imageViewer(["Array", "of", "Images"], {'nav_links':false})

jQuery allows for the plugins to be built in a way that limits namespace pollution significantly so you can have multiple imageViewers dispayed at once and call them independently (maybe to toggle visiblility between two sets of images).

Available Shortcuts

In order to access these shortcuts press "/"(slash) to enable command-mode. Once you press this a "CM" will pop up in the overlay box. These keys can be changed by modifying ImageViewer.setupKeyBindings(). However, they were chosen so that a user would not have to leave the home row keys.

These are created using a nifty library found here by Mathew Temple

  • "i" = Zoom the image in.
  • "k" = Zoom the image out.
  • "l" = Go to the next page.
  • "j" = Go to the previous page.
  • "e" = Scroll Image upward (only available if image is taller than container).
  • "d" = Scroll Image downward (only available if image is taller than container).
  • "s" = Scroll Image to left (only available if image is wider than container).
  • "f" = Scroll Image to right (only available if image is wider than container).
  • "r" = Rotate image 90 degrees clockwise

Contributions

Pro Medical, Inc. promedical paid for development time on this small project some time back and has continued to support our effort to open-source it.

Robert Jackson rjackson came up with the idea a long while ago and together we wrote the initial rendition of the script which is still used on multiple production sites.


Thank you for reading this all the way through. Please fork, use, and enjoy this project. I've had a great time working on it, and I hope that you will find it useful.