CanvasGradient
An object representing a canvas gradient pattern
Supported Platform(s)
- BlackBerry OS 6.0+
- BlackBerry PlayBook
- Ripple Emulator
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| addColorStop | Y | Y | Y | Y |
Configuration Document Settings
To use all of the API described for this object, you must ensure the following settings are in your configuration document:
This API does not require a <feature> element to be declared in the configuration document of your BlackBerry WebWorks Application.| Permission Elements (PlayBook Only) |
|---|
| This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application. |
addColorStop
| void addColorStop(offset : Number, color : String) |
Supported Platform(s)
- BlackBerry OS 6.0+- BlackBerry PlayBook
- Ripple Emulator
Description
Adds a color stop with the given color to the gradient at the given offset. 0.0 is the offset at one end of the gradient, 1.0 is the offset at the other end.
| Parameter | Type | Description |
|---|---|---|
| offset | Number | the offset of the new stop |
| color | String | the color of the new stop |
| Throws | Description |
|---|---|
| INDEX_SIZE_ERR | If the offset is less than 0, greater than 1, infinite, or NaN |
| SYNTAX_ERR | If the color cannot be parsed |
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:16 GMT-0500 (EST)