Skip to content

Commit caea88c

Browse files
committed
chore(release): 4.0.2 [skip ci]
## [4.0.2](4.0.1...4.0.2) (2020-01-16) ### Bug Fixes * **zoomtopoint:** should be able to override animate ([e0e8190](e0e8190))
1 parent c014fd1 commit caea88c

File tree

2 files changed

+44
-44
lines changed

2 files changed

+44
-44
lines changed

README.md

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ setTimeout(() => panzoom.pan(100, 100))
134134

135135
**Panzoom**(`elem`: HTMLElement | SVGElement, `options?`: Omit‹[PanzoomOptions](#PanzoomOptions), "force"›): _[PanzoomObject](#PanzoomObject)_
136136

137-
_Defined in [panzoom.ts:49](https://github.com/timmywil/panzoom/blob/3f1f525/src/panzoom.ts#L49)_
137+
_Defined in [panzoom.ts:49](https://github.com/timmywil/panzoom/blob/c014fd1/src/panzoom.ts#L49)_
138138

139139
**Parameters:**
140140

@@ -157,7 +157,7 @@ Includes `MiscOptions`, `PanOptions`, and `ZoomOptions`
157157

158158
**animate**? : _boolean_ (Default: **false**)
159159

160-
_Defined in [types.ts:13](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L13)_
160+
_Defined in [types.ts:13](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L13)_
161161

162162
Whether to animate transitions
163163

@@ -167,7 +167,7 @@ Whether to animate transitions
167167

168168
**duration**? : _number_ (Default: **200**)
169169

170-
_Defined in [types.ts:15](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L15)_
170+
_Defined in [types.ts:15](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L15)_
171171

172172
Duration of the transition (ms)
173173

@@ -177,7 +177,7 @@ Duration of the transition (ms)
177177

178178
**easing**? : _string_ (Default: **"ease-in-out"**)
179179

180-
_Defined in [types.ts:17](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L17)_
180+
_Defined in [types.ts:17](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L17)_
181181

182182
CSS Easing used for transitions
183183

@@ -187,7 +187,7 @@ CSS Easing used for transitions
187187

188188
**exclude**? : _Element[]_
189189

190-
_Defined in [types.ts:24](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L24)_
190+
_Defined in [types.ts:24](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L24)_
191191

192192
Add elements to this array that should be excluded
193193
from Panzoom handling.
@@ -200,7 +200,7 @@ e.g. links and buttons that should not propagate the click event.
200200

201201
**excludeClass**? : _string_ (Default: **"panzoom-exclude"**)
202202

203-
_Defined in [types.ts:31](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L31)_
203+
_Defined in [types.ts:31](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L31)_
204204

205205
Add this class to any element within the Panzoom element
206206
that you want to exclude from Panzoom handling. That
@@ -213,7 +213,7 @@ e.g. links and buttons that should not propagate the click event.
213213

214214
**force**? : _boolean_
215215

216-
_Defined in [types.ts:47](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L47)_
216+
_Defined in [types.ts:47](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L47)_
217217

218218
`force` should be used sparingly to temporarily
219219
override and ignore options such as disablePan,
@@ -235,7 +235,7 @@ panzoom.zoom(1, { force: true })
235235

236236
**handleStartEvent**? : _function_
237237

238-
_Defined in [types.ts:71](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L71)_
238+
_Defined in [types.ts:71](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L71)_
239239

240240
On the first pointer event, when panning starts,
241241
the default Panzoom behavior is to call
@@ -275,7 +275,7 @@ Panzoom(elem, {
275275

276276
**origin**? : _string_
277277

278-
_Defined in [types.ts:85](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L85)_
278+
_Defined in [types.ts:85](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L85)_
279279

280280
**Change this at your own risk.**
281281
The `transform-origin` is the origin from which transforms are applied.
@@ -295,7 +295,7 @@ And again, changing this for SVG in IE doesn't work at all.
295295

296296
**overflow**? : _string_ (Default: **"hidden"**)
297297

298-
_Defined in [types.ts:87](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L87)_
298+
_Defined in [types.ts:87](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L87)_
299299

300300
The overflow CSS value for the parent. Defaults to 'hidden'
301301

@@ -305,7 +305,7 @@ The overflow CSS value for the parent. Defaults to 'hidden'
305305

306306
**setTransform**? : _setTransform_
307307

308-
_Defined in [types.ts:105](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L105)_
308+
_Defined in [types.ts:105](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L105)_
309309

310310
Override the transform setter.
311311
This is exposed mostly so the user could
@@ -329,7 +329,7 @@ const panzoom = Panzoom(elem, {
329329

330330
**silent**? : _boolean_
331331

332-
_Defined in [types.ts:107](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L107)_
332+
_Defined in [types.ts:107](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L107)_
333333

334334
Silence all events
335335

@@ -339,7 +339,7 @@ Silence all events
339339

340340
**startScale**? : _number_ (Default: **1**)
341341

342-
_Defined in [types.ts:113](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L113)_
342+
_Defined in [types.ts:113](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L113)_
343343

344344
Scale used to set the beginning transform
345345

@@ -349,7 +349,7 @@ Scale used to set the beginning transform
349349

350350
**startX**? : _number_ (Default: **0**)
351351

352-
_Defined in [types.ts:109](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L109)_
352+
_Defined in [types.ts:109](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L109)_
353353

354354
X Value used to set the beginning transform
355355

@@ -359,7 +359,7 @@ X Value used to set the beginning transform
359359

360360
**startY**? : _number_ (Default: **0**)
361361

362-
_Defined in [types.ts:111](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L111)_
362+
_Defined in [types.ts:111](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L111)_
363363

364364
Y Value used to set the beginning transform
365365

@@ -373,7 +373,7 @@ Includes `MiscOptions`
373373

374374
**contain**? : _"inside" | "outside"_
375375

376-
_Defined in [types.ts:130](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L130)_
376+
_Defined in [types.ts:130](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L130)_
377377

378378
Contain the panzoom element either
379379
inside or outside the parent.
@@ -391,7 +391,7 @@ empty space around the element will be shown.
391391

392392
**cursor**? : _string_ (Default: **"move"**)
393393

394-
_Defined in [types.ts:132](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L132)_
394+
_Defined in [types.ts:132](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L132)_
395395

396396
The cursor style to set on the panzoom element
397397

@@ -401,7 +401,7 @@ The cursor style to set on the panzoom element
401401

402402
**disablePan**? : _boolean_ (Default: **false**)
403403

404-
_Defined in [types.ts:138](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L138)_
404+
_Defined in [types.ts:138](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L138)_
405405

406406
Disable panning functionality.
407407
Note: disablePan does not affect focal point zooming or the constrain option.
@@ -413,7 +413,7 @@ The element will still pan accordingly.
413413

414414
**disableXAxis**? : _boolean_ (Default: **false**)
415415

416-
_Defined in [types.ts:140](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L140)_
416+
_Defined in [types.ts:140](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L140)_
417417

418418
Pan only on the Y axis
419419

@@ -423,7 +423,7 @@ Pan only on the Y axis
423423

424424
**disableYAxis**? : _boolean_ (Default: **false**)
425425

426-
_Defined in [types.ts:142](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L142)_
426+
_Defined in [types.ts:142](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L142)_
427427

428428
Pan only on the X axis
429429

@@ -433,7 +433,7 @@ Pan only on the X axis
433433

434434
**panOnlyWhenZoomed**? : _boolean_ (Default: **false**)
435435

436-
_Defined in [types.ts:146](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L146)_
436+
_Defined in [types.ts:146](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L146)_
437437

438438
Disable panning while the scale is equal to the starting value
439439

@@ -443,7 +443,7 @@ Disable panning while the scale is equal to the starting value
443443

444444
**relative**? : _boolean_ (Default: **false**)
445445

446-
_Defined in [types.ts:144](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L144)_
446+
_Defined in [types.ts:144](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L144)_
447447

448448
When passing x and y values to .pan(), treat the values as relative to their current values
449449

@@ -457,7 +457,7 @@ Includes `MiscOptions`
457457

458458
**disableZoom**? : _boolean_ (Default: **false**)
459459

460-
_Defined in [types.ts:151](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L151)_
460+
_Defined in [types.ts:151](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L151)_
461461

462462
Disable zooming functionality
463463

@@ -467,7 +467,7 @@ Disable zooming functionality
467467

468468
**focal**? : _object_
469469

470-
_Defined in [types.ts:158](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L158)_
470+
_Defined in [types.ts:158](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L158)_
471471

472472
Zoom to the given point on the panzoom element.
473473
This point is expected to be relative to
@@ -486,7 +486,7 @@ to the parent dimensions.
486486

487487
**maxScale**? : _number_ (Default: **4**)
488488

489-
_Defined in [types.ts:162](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L162)_
489+
_Defined in [types.ts:162](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L162)_
490490

491491
The maximum scale when zooming
492492

@@ -496,7 +496,7 @@ The maximum scale when zooming
496496

497497
**minScale**? : _number_ (Default: **0.125**)
498498

499-
_Defined in [types.ts:160](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L160)_
499+
_Defined in [types.ts:160](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L160)_
500500

501501
The minimum scale when zooming
502502

@@ -506,7 +506,7 @@ The minimum scale when zooming
506506

507507
**step**? : _number_ (Default: **0.3**)
508508

509-
_Defined in [types.ts:164](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L164)_
509+
_Defined in [types.ts:164](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L164)_
510510

511511
The step affects zoom calculation when zooming with a mouse wheel, when pinch zooming, or when using zoomIn/zoomOut
512512

@@ -520,7 +520,7 @@ These methods are available after initializing Panzoom
520520

521521
**destroy**: _function_
522522

523-
_Defined in [types.ts:179](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L179)_
523+
_Defined in [types.ts:179](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L179)_
524524

525525
Remove all event listeners bind to the the Panzoom element
526526

@@ -534,7 +534,7 @@ Remove all event listeners bind to the the Panzoom element
534534

535535
**getOptions**: _function_
536536

537-
_Defined in [types.ts:185](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L185)_
537+
_Defined in [types.ts:185](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L185)_
538538

539539
Returns a _copy_ of the current options object
540540

@@ -548,7 +548,7 @@ Returns a _copy_ of the current options object
548548

549549
**getPan**: _function_
550550

551-
_Defined in [types.ts:181](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L181)_
551+
_Defined in [types.ts:181](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L181)_
552552

553553
Get the current x/y translation
554554

@@ -566,7 +566,7 @@ Get the current x/y translation
566566

567567
**getScale**: _function_
568568

569-
_Defined in [types.ts:183](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L183)_
569+
_Defined in [types.ts:183](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L183)_
570570

571571
Get the current scale
572572

@@ -580,7 +580,7 @@ Get the current scale
580580

581581
**pan**: _function_
582582

583-
_Defined in [types.ts:196](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L196)_
583+
_Defined in [types.ts:196](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L196)_
584584

585585
Pan the Panzoom element to the given x and y coordinates
586586

@@ -609,7 +609,7 @@ panzoom.pan(10, 10, { relative: true })
609609

610610
**reset**: _function_
611611

612-
_Defined in [types.ts:209](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L209)_
612+
_Defined in [types.ts:209](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L209)_
613613

614614
Reset the pan and zoom to startX, startY, and startScale.
615615
Animates by default, ignoring the global option.
@@ -638,7 +638,7 @@ panzoom.reset({ animate: false })
638638

639639
**setOptions**: _function_
640640

641-
_Defined in [types.ts:211](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L211)_
641+
_Defined in [types.ts:211](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L211)_
642642

643643
Change options for the Panzoom instance
644644

@@ -658,7 +658,7 @@ Change options for the Panzoom instance
658658

659659
**setStyle**: _function_
660660

661-
_Defined in [types.ts:213](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L213)_
661+
_Defined in [types.ts:213](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L213)_
662662

663663
A convenience method for setting prefixed styles on the Panzoom element
664664

@@ -679,7 +679,7 @@ A convenience method for setting prefixed styles on the Panzoom element
679679

680680
**zoom**: _function_
681681

682-
_Defined in [types.ts:222](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L222)_
682+
_Defined in [types.ts:222](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L222)_
683683

684684
Zoom the Panzoom element to the given scale
685685

@@ -705,7 +705,7 @@ panzoom.zoom(2.2, { animate: true })
705705

706706
**zoomIn**: _function_
707707

708-
_Defined in [types.ts:233](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L233)_
708+
_Defined in [types.ts:233](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L233)_
709709

710710
Zoom in using the predetermined increment set in options.
711711
Animates by default, ignoring the global option.
@@ -732,7 +732,7 @@ panzoom.zoomIn({ animate: false })
732732

733733
**zoomOut**: _function_
734734

735-
_Defined in [types.ts:244](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L244)_
735+
_Defined in [types.ts:244](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L244)_
736736

737737
Zoom out using the predetermined increment set in options.
738738
Animates by default, ignoring the global option.
@@ -759,7 +759,7 @@ panzoom.zoomOut({ animate: false })
759759

760760
**zoomToPoint**: _function_
761761

762-
_Defined in [types.ts:255](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L255)_
762+
_Defined in [types.ts:255](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L255)_
763763

764764
Zoom the Panzoom element to a focal point using
765765
the given pointer/touch/mouse event or constructed point.
@@ -793,7 +793,7 @@ panzoom.zoomToPoint(1.2, pointerEvent)
793793

794794
**zoomWithWheel**: _function_
795795

796-
_Defined in [types.ts:284](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L284)_
796+
_Defined in [types.ts:284](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L284)_
797797

798798
Zoom the Panzoom element to a focal point using the given WheelEvent
799799

@@ -837,23 +837,23 @@ elem.parentElement.addEventListener('wheel', function(event) {
837837

838838
**scale**: _number_
839839

840-
_Defined in [types.ts:174](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L174)_
840+
_Defined in [types.ts:174](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L174)_
841841

842842
---
843843

844844
### x
845845

846846
**x**: _number_
847847

848-
_Defined in [types.ts:172](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L172)_
848+
_Defined in [types.ts:172](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L172)_
849849

850850
---
851851

852852
### y
853853

854854
**y**: _number_
855855

856-
_Defined in [types.ts:173](https://github.com/timmywil/panzoom/blob/3f1f525/src/types.ts#L173)_
856+
_Defined in [types.ts:173](https://github.com/timmywil/panzoom/blob/c014fd1/src/types.ts#L173)_
857857

858858
## Events
859859

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@panzoom/panzoom",
3-
"version": "4.0.1",
3+
"version": "4.0.2",
44
"description": "Pan and zoom elements anywhere using native transformations",
55
"main": "dist/panzoom.js",
66
"scripts": {

0 commit comments

Comments
 (0)