afterHide | function | <optional>
| null | A callback to be invoked after the viewfinder is hidden. Note that all options specified callbacks will be invoked with this set to be the plugin's target. |
afterShow | function | <optional>
| null | A callback to be invoked after the viewfinder is shown. |
autoEnable | boolean | <optional>
| true | Determine whether or not SimpleZoom#enable is invoked upon initialization. |
beforeDestroy | function | <optional>
| null | A callback to be invoked before the plugin is destroyed. |
beforeHide | function | <optional>
| null | A callback to be invoked when the viewfinder hide animation begins. |
beforeShow | function | <optional>
| null | A callback to be invoked when the viewfinder show animation begins. |
className | Object | <optional>
| | Properties| Name | Type | Argument | Default | Description |
|---|
overlay | string | <optional>
| "simplezoom-overlay" | The CSS class to be assigned to the element which overlays the plugin target. | viewport | string | <optional>
| "simplezoom-viewport" | The CSS class to be assigned to the designated viewport. | viewfinder | string | <optional>
| "simplezoom-viewfinder' | The CSS class to be assigned to the viewfinder. |
|
confine | boolean | <optional>
| true | Determines if the viewfinder should be confined to the boundary of the target. |
enableScroll | boolean | <optional>
| false | When enabled the plugin will track scroll events on the window and animate the viewfinder accordingly. This option will be automatically disabled if mobile is true or the target lies within a scrollable region which is not the window. |
mobile | boolean | <optional>
| false | Enable mobile support. Currently all functionality is supported except for nableScroll |
onCreate | function | <optional>
| null | A callback to be invoked once the plugin has completed initialization. Note that most plugin methods will throw an exception prior to this event occurring. |
onDestroy | function | <optional>
| null | A callback to be invoked once the plugin has been destroyed. |
onLoad | function | <optional>
| null | A callback to be invoked once the image resources associated with the plugin have been loaded. |
onMoveStart | function | <optional>
| null | A callback to be invoked when the user takes control of the viewfinder. |
onMoveStop | function | <optional>
| null | A callback to be invoked when the user cedes control of the viewfinder. |
onRefresh | function | <optional>
| null | A callback to be invoked every time the plugin's layout is recalculated. |
smoothing | number | <optional>
| 0.35 | A value on the range 0 to 1, inclusive, which determines how smooth the viewfinder animation is. A value of 0 disables animation while 1 causes the viewfinder to remain stationary. |
src | string | <optional>
| null | The URL of an image resource to be displayed within the plugins viewport. |
viewfinder | Object | <optional>
| | * @property {Object} [viewfinder.hide]Properties| Name | Type | Argument | Default | Description |
|---|
height | string | number | <optional>
| | Determines the height of the viewfinder when it is presented as a magnifying lens, e.g., no viewport has been specified. | hide.event | string | <optional>
| 'mouseout' | The trigger event for the viewfinder's hide animation. | hide.duration | number | <optional>
| 100 | The duration of the viewfinder's hide animation in milliseconds. | show | Object | <optional>
| | Properties| Name | Type | Argument | Default | Description |
|---|
event | string | <optional>
| 'mouseover' | The event upon which the viewfinder will be shown. | duration | number | <optional>
| 250 | The duration of the viewfinder's show animation in milliseconds. |
| move.event | string | <optional>
| "mousemove" | The event used to determine the position of the viewfinder. The event type must produce an event object with pageX and pageY properties. | moveStart.jumpTo | boolean | <optional>
| true | 'If true the viewfinder will jump to the users position when the viewfinder.moveStart.event event is triggered, else the viewfinder is animated to the users position from it's previous position. | moveStart.event | string | <optional>
| "mouseover mousemove" | The event which grants control of the viewfinder to the user. Once triggered the event will not be triggered until after a viewfinder.moveStop event has occurred. | moveStop.event | string | <optional>
| "mouseout" | The event upon which the user cedes control of the viewfinder. | width | string | number | <optional>
| '33%' | Analogous to viewfinder.height. |
|
viewport | string | jQuery | <optional>
| | Designates an element as the plugins active viewport. If a collection is specified then the first element is selected. |
zoom | number | <optional>
| null | A decimal representing the percent magnification level. |