GLOBAL: remove 'will'
parent
e502789d7d
commit
90a2c1bfc3
12
src/mouse.js
12
src/mouse.js
|
@ -396,21 +396,21 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
||||||
- mcontext (object) #optional context for moving handler
|
- mcontext (object) #optional context for moving handler
|
||||||
- scontext (object) #optional context for drag start handler
|
- scontext (object) #optional context for drag start handler
|
||||||
- econtext (object) #optional context for drag end handler
|
- econtext (object) #optional context for drag end handler
|
||||||
* Additionaly following `drag` events will be triggered: `drag.start.<id>` on start,
|
* Additionaly following `drag` events are triggered: `drag.start.<id>` on start,
|
||||||
* `drag.end.<id>` on end and `drag.move.<id>` on every move. When element will be dragged over another element
|
* `drag.end.<id>` on end and `drag.move.<id>` on every move. When element is dragged over another element
|
||||||
* `drag.over.<id>` will be fired as well.
|
* `drag.over.<id>` fires as well.
|
||||||
*
|
*
|
||||||
* Start event and start handler will be called in specified context or in context of the element with following parameters:
|
* Start event and start handler are called in specified context or in context of the element with following parameters:
|
||||||
o x (number) x position of the mouse
|
o x (number) x position of the mouse
|
||||||
o y (number) y position of the mouse
|
o y (number) y position of the mouse
|
||||||
o event (object) DOM event object
|
o event (object) DOM event object
|
||||||
* Move event and move handler will be called in specified context or in context of the element with following parameters:
|
* Move event and move handler are called in specified context or in context of the element with following parameters:
|
||||||
o dx (number) shift by x from the start point
|
o dx (number) shift by x from the start point
|
||||||
o dy (number) shift by y from the start point
|
o dy (number) shift by y from the start point
|
||||||
o x (number) x position of the mouse
|
o x (number) x position of the mouse
|
||||||
o y (number) y position of the mouse
|
o y (number) y position of the mouse
|
||||||
o event (object) DOM event object
|
o event (object) DOM event object
|
||||||
* End event and end handler will be called in specified context or in context of the element with following parameters:
|
* End event and end handler are called in specified context or in context of the element with following parameters:
|
||||||
o event (object) DOM event object
|
o event (object) DOM event object
|
||||||
= (object) @Element
|
= (object) @Element
|
||||||
\*/
|
\*/
|
||||||
|
|
|
@ -67,7 +67,7 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
||||||
**
|
**
|
||||||
* Executes given function for each element in the set.
|
* Executes given function for each element in the set.
|
||||||
*
|
*
|
||||||
* If function returns `false` it will stop loop running.
|
* If the function returns `false`, the loop stops running.
|
||||||
**
|
**
|
||||||
- callback (function) function to run
|
- callback (function) function to run
|
||||||
- thisArg (object) context object for the callback
|
- thisArg (object) context object for the callback
|
||||||
|
|
18
src/svg.js
18
src/svg.js
|
@ -156,10 +156,10 @@ function is(o, type) {
|
||||||
* Replaces construction of type “`{<name>}`” to the corresponding argument.
|
* Replaces construction of type “`{<name>}`” to the corresponding argument.
|
||||||
**
|
**
|
||||||
- token (string) string to format
|
- token (string) string to format
|
||||||
- json (object) object which properties will be used as a replacement
|
- json (object) object which properties are used as a replacement
|
||||||
= (string) formated string
|
= (string) formated string
|
||||||
> Usage
|
> Usage
|
||||||
| // this will draw a rectangular shape equivalent to "M10,20h40v50h-40z"
|
| // this draws a rectangular shape equivalent to "M10,20h40v50h-40z"
|
||||||
| paper.path(Snap.format("M{x},{y}h{dim.width}v{dim.height}h{dim['negative width']}z", {
|
| paper.path(Snap.format("M{x},{y}h{dim.width}v{dim.height}h{dim['negative width']}z", {
|
||||||
| x: 10,
|
| x: 10,
|
||||||
| y: 20,
|
| y: 20,
|
||||||
|
@ -1038,7 +1038,7 @@ Snap.rgb2hsl = function (r, g, b) {
|
||||||
* Utility method
|
* Utility method
|
||||||
**
|
**
|
||||||
* Parses given path string into an array of arrays of path segments.
|
* Parses given path string into an array of arrays of path segments.
|
||||||
- pathString (string|array) path string or array of segments (in the last case it will be returned straight away)
|
- pathString (string|array) path string or array of segments (in the last case it is returned straight away)
|
||||||
= (array) array of segments.
|
= (array) array of segments.
|
||||||
\*/
|
\*/
|
||||||
Snap.parsePathString = function (pathString) {
|
Snap.parsePathString = function (pathString) {
|
||||||
|
@ -1092,7 +1092,7 @@ Snap.parsePathString = function (pathString) {
|
||||||
* Utility method
|
* Utility method
|
||||||
**
|
**
|
||||||
* Parses given transform string into an array of transformations.
|
* Parses given transform string into an array of transformations.
|
||||||
- TString (string|array) transform string or array of transformations (in the last case it will be returned straight away)
|
- TString (string|array) transform string or array of transformations (in the last case it is returned straight away)
|
||||||
= (array) array of transformations.
|
= (array) array of transformations.
|
||||||
\*/
|
\*/
|
||||||
var parseTransformString = Snap.parseTransformString = function (TString) {
|
var parseTransformString = Snap.parseTransformString = function (TString) {
|
||||||
|
@ -1503,9 +1503,9 @@ function arrayFirstValue(arr) {
|
||||||
o h: (number) height,
|
o h: (number) height,
|
||||||
o height: (number) height,
|
o height: (number) height,
|
||||||
o path: (string) path command for the box,
|
o path: (string) path command for the box,
|
||||||
o r0: (number) radius of the circle that will enclose the box,
|
o r0: (number) radius of a circle that fully encloses the box,
|
||||||
o r1: (number) radius of the smallest circle that can be enclosed,
|
o r1: (number) radius of the smallest circle that can be enclosed,
|
||||||
o r2: (number) radius of the biggest circle that can be enclosed,
|
o r2: (number) radius of the largest circle that can be enclosed,
|
||||||
o vb: (string) box as a viewbox command,
|
o vb: (string) box as a viewbox command,
|
||||||
o w: (number) width,
|
o w: (number) width,
|
||||||
o width: (number) width,
|
o width: (number) width,
|
||||||
|
@ -2066,7 +2066,7 @@ function arrayFirstValue(arr) {
|
||||||
**
|
**
|
||||||
- from (number|array) number or array of numbers
|
- from (number|array) number or array of numbers
|
||||||
- to (number|array) number or array of numbers
|
- to (number|array) number or array of numbers
|
||||||
- setter (function) caring function that will take one number argument
|
- setter (function) caring function that accepts one number argument
|
||||||
- duration (number) duration, in milliseconds
|
- duration (number) duration, in milliseconds
|
||||||
- easing (function) #optional easing function from @mina or custom
|
- easing (function) #optional easing function from @mina or custom
|
||||||
- callback (function) #optional callback function to execute when animation ends VERIFY
|
- callback (function) #optional callback function to execute when animation ends VERIFY
|
||||||
|
@ -2716,7 +2716,7 @@ function gradientRadial(defs, cx, cy, r, fx, fy) {
|
||||||
# <tr><td>A</td><td>elliptical arc</td><td>(rx ry x-axis-rotation large-arc-flag sweep-flag x y)+</td></tr>
|
# <tr><td>A</td><td>elliptical arc</td><td>(rx ry x-axis-rotation large-arc-flag sweep-flag x y)+</td></tr>
|
||||||
# <tr><td>R</td><td><a href="http://en.wikipedia.org/wiki/Catmull–Rom_spline#Catmull.E2.80.93Rom_spline">Catmull-Rom curveto</a>*</td><td>x1 y1 (x y)+</td></tr></tbody></table>
|
# <tr><td>R</td><td><a href="http://en.wikipedia.org/wiki/Catmull–Rom_spline#Catmull.E2.80.93Rom_spline">Catmull-Rom curveto</a>*</td><td>x1 y1 (x y)+</td></tr></tbody></table>
|
||||||
* * “Catmull-Rom curveto” is a not standard SVG command and added to make life easier.
|
* * “Catmull-Rom curveto” is a not standard SVG command and added to make life easier.
|
||||||
* Note: there is a special case when path consist of just three commands: “M10,10R…z”. In this case path will smoothly connects to its beginning.
|
* Note: there is a special case when a path consists of only three commands: “M10,10R…z”. In this case, the path connects smoothly to its beginning.
|
||||||
> Usage
|
> Usage
|
||||||
| var c = paper.path("M10 10L90 90");
|
| var c = paper.path("M10 10L90 90");
|
||||||
| // draw a diagonal line:
|
| // draw a diagonal line:
|
||||||
|
@ -2745,7 +2745,7 @@ function gradientRadial(defs, cx, cy, r, fx, fy) {
|
||||||
> Usage
|
> Usage
|
||||||
| var c1 = paper.circle(),
|
| var c1 = paper.circle(),
|
||||||
| c2 = paper.rect(),
|
| c2 = paper.rect(),
|
||||||
| g = paper.g(c2, c1); // note that the order of elements will be different
|
| g = paper.g(c2, c1); // note that the order of elements is different
|
||||||
* or
|
* or
|
||||||
| var c1 = paper.circle(),
|
| var c1 = paper.circle(),
|
||||||
| c2 = paper.rect(),
|
| c2 = paper.rect(),
|
||||||
|
|
Loading…
Reference in New Issue