Skip to content

Commit

Permalink
chore(release): 4.0.4 [skip ci]
Browse files Browse the repository at this point in the history
## [4.0.4](4.0.3...4.0.4) (2020-03-27)

### Bug Fixes

* **package:** upgrade dependencies, including prettier to 2.0 ([8d5dfa5](8d5dfa5))
* **panzoom:** export PanzoomObject and PanzoomOptions ([8f48c2f](8f48c2f)), closes [#470](#470)
  • Loading branch information
timmywil committed Mar 27, 2020
1 parent 65ce285 commit 3843d57
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 45 deletions.
88 changes: 44 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ setTimeout(() => panzoom.pan(100, 100))

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

_Defined in [panzoom.ts:49](https://github.com/timmywil/panzoom/blob/103d4fa/src/panzoom.ts#L49)_
_Defined in [panzoom.ts:49](https://github.com/timmywil/panzoom/blob/65ce285/src/panzoom.ts#L49)_

**Parameters:**

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

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

_Defined in [types.ts:13](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L13)_
_Defined in [types.ts:13](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L13)_

Whether to animate transitions

Expand All @@ -167,7 +167,7 @@ Whether to animate transitions

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

_Defined in [types.ts:15](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L15)_
_Defined in [types.ts:15](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L15)_

Duration of the transition (ms)

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

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

_Defined in [types.ts:17](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L17)_
_Defined in [types.ts:17](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L17)_

CSS Easing used for transitions

Expand All @@ -187,7 +187,7 @@ CSS Easing used for transitions

**exclude**? : _Element[]_

_Defined in [types.ts:24](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L24)_
_Defined in [types.ts:24](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L24)_

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

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

_Defined in [types.ts:31](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L31)_
_Defined in [types.ts:31](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L31)_

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

**force**? : _boolean_

_Defined in [types.ts:47](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L47)_
_Defined in [types.ts:47](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L47)_

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

**handleStartEvent**? : _function_

_Defined in [types.ts:71](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L71)_
_Defined in [types.ts:71](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L71)_

On the first pointer event, when panning starts,
the default Panzoom behavior is to call
Expand Down Expand Up @@ -275,7 +275,7 @@ Panzoom(elem, {

**origin**? : _string_

_Defined in [types.ts:85](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L85)_
_Defined in [types.ts:85](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L85)_

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

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

_Defined in [types.ts:87](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L87)_
_Defined in [types.ts:87](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L87)_

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

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

**setTransform**? : _typeof setTransform_

_Defined in [types.ts:105](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L105)_
_Defined in [types.ts:105](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L105)_

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

**silent**? : _boolean_

_Defined in [types.ts:107](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L107)_
_Defined in [types.ts:107](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L107)_

Silence all events

Expand All @@ -339,7 +339,7 @@ Silence all events

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

_Defined in [types.ts:113](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L113)_
_Defined in [types.ts:113](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L113)_

Scale used to set the beginning transform

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

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

_Defined in [types.ts:109](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L109)_
_Defined in [types.ts:109](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L109)_

X Value used to set the beginning transform

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

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

_Defined in [types.ts:111](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L111)_
_Defined in [types.ts:111](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L111)_

Y Value used to set the beginning transform

Expand All @@ -373,7 +373,7 @@ Includes `MiscOptions`

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

_Defined in [types.ts:130](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L130)_
_Defined in [types.ts:130](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L130)_

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

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

_Defined in [types.ts:132](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L132)_
_Defined in [types.ts:132](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L132)_

The cursor style to set on the panzoom element

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

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

_Defined in [types.ts:138](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L138)_
_Defined in [types.ts:138](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L138)_

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

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

_Defined in [types.ts:140](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L140)_
_Defined in [types.ts:140](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L140)_

Pan only on the Y axis

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

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

_Defined in [types.ts:142](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L142)_
_Defined in [types.ts:142](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L142)_

Pan only on the X axis

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

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

_Defined in [types.ts:146](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L146)_
_Defined in [types.ts:146](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L146)_

Disable panning while the scale is equal to the starting value

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

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

_Defined in [types.ts:144](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L144)_
_Defined in [types.ts:144](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L144)_

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

Expand All @@ -457,7 +457,7 @@ Includes `MiscOptions`

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

_Defined in [types.ts:151](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L151)_
_Defined in [types.ts:151](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L151)_

Disable zooming functionality

Expand All @@ -467,7 +467,7 @@ Disable zooming functionality

**focal**? : _object_

_Defined in [types.ts:158](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L158)_
_Defined in [types.ts:158](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L158)_

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

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

_Defined in [types.ts:162](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L162)_
_Defined in [types.ts:162](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L162)_

The maximum scale when zooming

Expand All @@ -496,7 +496,7 @@ The maximum scale when zooming

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

_Defined in [types.ts:160](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L160)_
_Defined in [types.ts:160](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L160)_

The minimum scale when zooming

Expand All @@ -506,7 +506,7 @@ The minimum scale when zooming

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

_Defined in [types.ts:164](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L164)_
_Defined in [types.ts:164](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L164)_

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

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

**destroy**: _function_

_Defined in [types.ts:180](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L180)_
_Defined in [types.ts:180](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L180)_

Remove all event listeners bind to the the Panzoom element

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

**getOptions**: _function_

_Defined in [types.ts:186](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L186)_
_Defined in [types.ts:186](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L186)_

Returns a _copy_ of the current options object

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

**getPan**: _function_

_Defined in [types.ts:182](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L182)_
_Defined in [types.ts:182](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L182)_

Get the current x/y translation

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

**getScale**: _function_

_Defined in [types.ts:184](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L184)_
_Defined in [types.ts:184](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L184)_

Get the current scale

Expand All @@ -580,7 +580,7 @@ Get the current scale

**pan**: _function_

_Defined in [types.ts:197](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L197)_
_Defined in [types.ts:197](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L197)_

Pan the Panzoom element to the given x and y coordinates

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

**reset**: _function_

_Defined in [types.ts:210](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L210)_
_Defined in [types.ts:210](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L210)_

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

**setOptions**: _function_

_Defined in [types.ts:212](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L212)_
_Defined in [types.ts:212](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L212)_

Change options for the Panzoom instance

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

**setStyle**: _function_

_Defined in [types.ts:214](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L214)_
_Defined in [types.ts:214](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L214)_

A convenience method for setting prefixed styles on the Panzoom element

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

**zoom**: _function_

_Defined in [types.ts:223](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L223)_
_Defined in [types.ts:223](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L223)_

Zoom the Panzoom element to the given scale

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

**zoomIn**: _function_

_Defined in [types.ts:234](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L234)_
_Defined in [types.ts:234](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L234)_

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

**zoomOut**: _function_

_Defined in [types.ts:245](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L245)_
_Defined in [types.ts:245](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L245)_

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

**zoomToPoint**: _function_

_Defined in [types.ts:256](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L256)_
_Defined in [types.ts:256](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L256)_

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

**zoomWithWheel**: _function_

_Defined in [types.ts:285](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L285)_
_Defined in [types.ts:285](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L285)_

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

Expand Down Expand Up @@ -837,31 +837,31 @@ elem.parentElement.addEventListener('wheel', function (event) {

**isSVG**? : _boolean_

_Defined in [types.ts:175](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L175)_
_Defined in [types.ts:175](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L175)_

---

### scale

**scale**: _number_

_Defined in [types.ts:174](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L174)_
_Defined in [types.ts:174](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L174)_

---

### x

**x**: _number_

_Defined in [types.ts:172](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L172)_
_Defined in [types.ts:172](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L172)_

---

### y

**y**: _number_

_Defined in [types.ts:173](https://github.com/timmywil/panzoom/blob/103d4fa/src/types.ts#L173)_
_Defined in [types.ts:173](https://github.com/timmywil/panzoom/blob/65ce285/src/types.ts#L173)_

## Events

Expand Down
Loading

0 comments on commit 3843d57

Please sign in to comment.