GLOBAL: standardize parameter values
parent
613740014e
commit
0d2e937d67
|
@ -25,7 +25,7 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
|||
**
|
||||
* Creates a `<filter>` element
|
||||
**
|
||||
- filstr (string) SVG fragment of filter provided as a string.
|
||||
- filstr (string) SVG fragment of filter provided as a string
|
||||
= (object) @Element
|
||||
* Note: It is recommended to use filters embedded into the page inside an empty SVG element.
|
||||
> Usage
|
||||
|
@ -90,8 +90,8 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
|||
**
|
||||
* Returns an SVG markup string for the blur filter
|
||||
**
|
||||
- x (number) amount of horizontal blur in px.
|
||||
- y (number) #optional amount of vertical blur in px.
|
||||
- x (number) amount of horizontal blur, in pixels
|
||||
- y (number) #optional amount of vertical blur, in pixels
|
||||
= (string) filter representation
|
||||
> Usage
|
||||
| var f = paper.filter(Snap.filter.blur(5, 10)),
|
||||
|
@ -117,10 +117,10 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
|||
**
|
||||
* Returns an SVG markup string for the shadow filter
|
||||
**
|
||||
- dx (number) horizontal shift of the shadow in px.
|
||||
- dy (number) vertical shift of the shadow in px.
|
||||
- blur (number) #optional amount of blur.
|
||||
- color (string) #optional color of the shadow.
|
||||
- dx (number) horizontal shift of the shadow, in pixels
|
||||
- dy (number) vertical shift of the shadow, in pixels
|
||||
- blur (number) #optional amount of blur
|
||||
- color (string) #optional color of the shadow
|
||||
= (string) filter representation
|
||||
> Usage
|
||||
| var f = paper.filter(Snap.filter.shadow(0, 2, 3)),
|
||||
|
@ -161,7 +161,7 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
|||
**
|
||||
* Returns an SVG markup string for the grayscale filter
|
||||
**
|
||||
- amount (number) amount of filter (`0..1`).
|
||||
- amount (number) amount of filter (`0..1`)
|
||||
= (string) filter representation
|
||||
\*/
|
||||
Snap.filter.grayscale = function (amount) {
|
||||
|
@ -188,7 +188,7 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
|||
**
|
||||
* Returns an SVG markup string for the sepia filter
|
||||
**
|
||||
- amount (number) amount of filter (`0..1`).
|
||||
- amount (number) amount of filter (`0..1`)
|
||||
= (string) filter representation
|
||||
\*/
|
||||
Snap.filter.sepia = function (amount) {
|
||||
|
@ -216,7 +216,7 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
|||
**
|
||||
* Returns an SVG markup string for the saturate filter
|
||||
**
|
||||
- amount (number) amount of filter (`0..1`).
|
||||
- amount (number) amount of filter (`0..1`)
|
||||
= (string) filter representation
|
||||
\*/
|
||||
Snap.filter.saturate = function (amount) {
|
||||
|
@ -236,7 +236,7 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
|||
**
|
||||
* Returns an SVG markup string for the hue-rotate filter
|
||||
**
|
||||
- angle (number) angle of rotation.
|
||||
- angle (number) angle of rotation
|
||||
= (string) filter representation
|
||||
\*/
|
||||
Snap.filter.hueRotate = function (angle) {
|
||||
|
@ -254,7 +254,7 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
|||
**
|
||||
* Returns an SVG markup string for the invert filter
|
||||
**
|
||||
- amount (number) amount of filter (`0..1`).
|
||||
- amount (number) amount of filter (`0..1`)
|
||||
= (string) filter representation
|
||||
\*/
|
||||
Snap.filter.invert = function (amount) {
|
||||
|
@ -275,7 +275,7 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
|||
**
|
||||
* Returns an SVG markup string for the brightness filter
|
||||
**
|
||||
- amount (number) amount of filter (`0..1`).
|
||||
- amount (number) amount of filter (`0..1`)
|
||||
= (string) filter representation
|
||||
\*/
|
||||
Snap.filter.brightness = function (amount) {
|
||||
|
@ -295,7 +295,7 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
|||
**
|
||||
* Returns an SVG markup string for the contrast filter
|
||||
**
|
||||
- amount (number) amount of filter (`0..1`).
|
||||
- amount (number) amount of filter (`0..1`)
|
||||
= (string) filter representation
|
||||
\*/
|
||||
Snap.filter.contrast = function (amount) {
|
||||
|
|
|
@ -1048,7 +1048,7 @@ Snap.plugin(function (Snap, Element, Paper, glob) {
|
|||
**
|
||||
* Returns the length of the given path in pixels
|
||||
**
|
||||
- path (string) SVG path string.
|
||||
- path (string) SVG path string
|
||||
**
|
||||
= (number) length
|
||||
\*/
|
||||
|
|
|
@ -840,7 +840,7 @@ packageRGB = function (r, g, b, o) {
|
|||
[ method ]
|
||||
**
|
||||
* Parses the color string and returns an object featuring the color's component values
|
||||
- clr (string) color string in one of the supported formats. See @Snap.getRGB.
|
||||
- clr (string) color string in one of the supported formats (see @Snap.getRGB)
|
||||
= (object) Combined RGB/HSB object in the following format:
|
||||
o {
|
||||
o r (number) red,
|
||||
|
@ -2702,7 +2702,7 @@ function gradientRadial(defs, cx, cy, r, fx, fy) {
|
|||
[ method ]
|
||||
**
|
||||
* Creates a `<path>` element using the given string as the path's definition
|
||||
- pathString (string) #optional path string in SVG format.
|
||||
- pathString (string) #optional path string in SVG format
|
||||
* Path string consists of one-letter commands, followed by comma seprarated arguments in numerical form. Example:
|
||||
| "M10,20L30,40"
|
||||
* This example features two commands: `M`, with arguments `(10, 20)` and `L` with arguments `(30, 40)`. Uppercase letter commands express coordinates in absolute terms, while lowercase commands express them in relative terms from the most recently declared coordinates.
|
||||
|
|
Loading…
Reference in New Issue