Skip to content

Added Bounds in Documentation #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 5, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,27 @@ panzoom(element, {
});
```

## Bounds on Panzoom

By default panzoom will not prevent Image from Panning out of the Container. `bounds` (boolean) and
`boundsPadding` (number) can be defined so that it doesn't fall out. Default value for `boundsPadding` is `0.05` .


``` js
panzoom(element, {
bounds: true,
boundsPadding: 0.1
});
```

## Triggering Pan

To Pan the object using Javascript use `moveTo(<number>,<number>)` function . It expects x, y value to where to move.

``` js
panzoom.moveTo(0, 0);
```

# license

MIT