Skip to content

Latest commit

 

History

History
127 lines (91 loc) · 4.21 KB

readme.md

File metadata and controls

127 lines (91 loc) · 4.21 KB
Raw

svg.panzoom.js

A plugin for svg.js that enables panzoom for viewport elements

Getting started

npm install svg.panzoom.js

// enables panZoom
var draw = SVG('id').size(1000,1000).panZoom()

// zoom programatically
draw.zoom(lvl, point)

You can configure panZoom by passing options to it.

  • zoomMin: Minimal zoom level
  • zoomMax: Maximal zoom level
  • zoomFactor: How much is zoomed by one mouse wheel step

This could look like this:

var draw = SVG('id').size(1000,1000).panZoom({zoomMin: 0.5, zoomMax: 20})

Setting the min and max value will automatically restrict the zoom to the provided level.
However you are still able to change the zoom out of that bonds by calling zoom(lvl) programatically.

On touchable devices a pinchZoom gesture is supported. Min and max values also apply here.

Zooming is animatable, too:

draw.zoom(1) // uses center of viewport by default
    .animate()
    .zoom(2, {x:100, y:100}) // zoom into specified point

To disable panZoom or change its options just call it again with false or the new options.

Options

You can override the default options by passing an object in to the .panZoom({options}) call.

Option Default Description
doPanning true Enable panning
doPinchZoom true Enable pinch to zoom
doWheelZoom true Enable mouse wheel zoom
zoomFactor 0.03 How quickly to zoom when using doWheelZoom
zoomMin 0 The minimum zoom level
zoomMax Number.MAX_VALUE The maximum zoom level

Example:

draw.panZoom({
  doWheelZoom: false,
  zoomMin: 0.5,
  zoomMax: 2
})

This will disable wheel zooming and set the maximum zoom to 2 or 200% and the minimum zoom to 0.5 or 50%.

API

svg.panzoom.js adds the .zoom() method to all viewbox elements.

  • zoom() - returns current zoom level
  • zoom(Number) - will zoom in or out depending if the Number is greater or less than the current zoom level
  • zoom(Number, {x,y}) - will zoom with the x/y coordinate as center point
  • zoom(Number, new SVG.Point(x,y)) - will zoom with the x/y coordinate as center point
Method Return Value
zoom() Number
zoom(Number) element
zoom(Number, {x,y}) element
zoom(Number, new SVG.Point(x,y)) element

viewbox elements

Events

Multiple events are fired doing different actions. This allow you to respond to actions and in some cases stop an action via preventDefault().

zoom is fired when a mouse wheel event or programmable zoom() triggers a zoom. This usually doesn't happen on mobile devices, in which case pinchZoomStart is fired when a zoom happens.

Events fired from SVG.js are CustomEvents, so the arguments passed from svg.panzoom.js are in in the .detail property.

Event Name Argument Value preventDefault support
zoom { box, focus } YES
panStart { event } NO
panEnd { event } NO
pinchZoomStart { event } YES
pinchZoomEnd { event } NO

Where box is the new viewport, focus is point of zoom and event is the event that triggered the action.

An example of stopping a pan-zoom action:

var draw = SVG('id').size(1000,1000).panZoom()
draw.on('pinchZoomStart', function(ev) {
    ev.preventDefault()
    ...
})