A viewer for browsing through and zooming in on magazine pages.
JavaScript HTML CSS PHP
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.
dist
src
.gitignore
LICENSE
README.md
gulpfile.js
index.html
node_modules
package.json

README.md

catalog.js: Scanned Print Media Viewer

A viewer for browsing through and zooming in on magazine pages.

Try the demo.

How to include the script

The stylesheet is best included in the header of the document.

<link rel="stylesheet" href="./css/catalog.css"/>

This include can be added to the header or placed inline before the script is invoked.

<script src="./js/catalog.js"></script>

How to start the script

var catalog = new Catalog({
	'element' : document.getElementById('catalogExample'),
	'imageslice' : 'php/imageslice.php?src=../{src}&width={width}&height={height}&left={left}&top={top}&right={right}&bottom={bottom}',
	'cache' : 256,
	'delay' : 100,
	'duration' : 1600,
	'tile' : 128,
	'split' : 2,
	'open' : 0,
	'colorPassive' : '#ff6a00',
	'colorActive' : '#d45800',
	'colorHover' : '#ff9800',
	'colorDisabled' : '#7f7f7f'
});

tileSource : {url} - A webservice that provides image tiles (PHP example included).

tileCache : {integer} - The amount of tiles that can be active at one time. Reduce this to save memory at the expense of bandwidth.

tileSize : {integer} - The horizontal and vertical size of each tile in pixels.

allowRotation : {boolean} - Enable or disable rotation as well as pan and zoom.

How to control the script

zoomTo

catalog.zoomTo(factor);

Applies a zoom factor to the viewer.

factor : {integer} - Zoom factor to apply.

pageTo

catalog.pageTo(page);

Open a specific page in the viewer.

page : {integer} - Page number to display.

pageBy

catalog.pageBy(increment);

Increase or decrease the page number.

increment : {integer} - Increment to add to the page number (can be negative).

How to build the script

This project uses node.js from http://nodejs.org/

This project uses gulp.js from http://gulpjs.com/

The following commands are available for development:

  • npm install - Installs the prerequisites.
  • gulp import - Re-imports libraries from supporting projects to ./src/libs/ if available under the same folder tree.
  • gulp dev - Builds the project for development purposes.
  • gulp dist - Builds the project for deployment purposes.
  • gulp watch - Continuously recompiles updated files during development sessions.
  • gulp serve - Serves the project on a temporary web server at http://localhost:8500/.
  • gulp php - Serves the project on a temporary php server at http://localhost:8500/.

License

This work is licensed under a Creative Commons Attribution 3.0 Unported License. The latest version of this and other scripts by the same author can be found at http://www.woollymittens.nl/