striped out br tags from the docs

This commit is contained in:
Eric Rowell
2014-04-03 20:17:09 -07:00
parent 150f58b8cf
commit 2df46b4ace
29 changed files with 1668 additions and 1668 deletions

1668
kinetic.js

File diff suppressed because it is too large Load Diff

2
kinetic.min.js vendored

File diff suppressed because one or more lines are too long

View File

@@ -43,13 +43,13 @@
* @param {Kinetic.Layer|Array} [layers] layer(s) to be redrawn on each animation frame. Can be a layer, an array of layers, or null. * @param {Kinetic.Layer|Array} [layers] layer(s) to be redrawn on each animation frame. Can be a layer, an array of layers, or null.
* Not specifying a node will result in no redraw. * Not specifying a node will result in no redraw.
* @example * @example
* // move a node to the right at 50 pixels / second<br> * // move a node to the right at 50 pixels / second
* var velocity = 50;<br><br> * var velocity = 50;
* *
* var anim = new Kinetic.Animation(function(frame) {<br> * var anim = new Kinetic.Animation(function(frame) {
* var dist = velocity * (frame.timeDiff / 1000);<br> * var dist = velocity * (frame.timeDiff / 1000);
* node.move(dist, 0);<br> * node.move(dist, 0);
* }, layer);<br><br> * }, layer);
* *
* anim.start(); * anim.start();
*/ */

View File

@@ -41,7 +41,7 @@
* @param {Number} [bounds.width] * @param {Number} [bounds.width]
* @param {Number} [bounds.height] * @param {Number} [bounds.height]
* @example * @example
* layer.clear();<br> * layer.clear();
* layer.clear(0, 0, 100, 100); * layer.clear(0, 0, 100, 100);
*/ */
clear: function(bounds) { clear: function(bounds) {
@@ -142,13 +142,13 @@
* @param {Boolean} clearBeforeDraw * @param {Boolean} clearBeforeDraw
* @returns {Boolean} * @returns {Boolean}
* @example * @example
* // get clearBeforeDraw flag<br> * // get clearBeforeDraw flag
* var clearBeforeDraw = layer.clearBeforeDraw();<br><br> * var clearBeforeDraw = layer.clearBeforeDraw();
* *
* // disable clear before draw<br> * // disable clear before draw
* layer.clearBeforeDraw(false);<br><br> * layer.clearBeforeDraw(false);
* *
* // enable clear before draw<br> * // enable clear before draw
* layer.clearBeforeDraw(true); * layer.clearBeforeDraw(true);
*/ */

View File

@@ -11,12 +11,12 @@
* @param {Function} [filterFunc] filter function * @param {Function} [filterFunc] filter function
* @returns {Kinetic.Collection} * @returns {Kinetic.Collection}
* @example * @example
* // get all children<br> * // get all children
* var children = layer.getChildren();<br><br> * var children = layer.getChildren();
* *
* // get only circles<br> * // get only circles
* var circles = layer.getChildren(function(node){<br> * var circles = layer.getChildren(function(node){
* return node.getClassName() === 'Circle';<br> * return node.getClassName() === 'Circle';
* }); * });
*/ */
getChildren: function(predicate) { getChildren: function(predicate) {
@@ -131,19 +131,19 @@
* @param {String} selector * @param {String} selector
* @returns {Collection} * @returns {Collection}
* @example * @example
* // select node with id foo<br> * // select node with id foo
* var node = stage.find('#foo');<br><br> * var node = stage.find('#foo');
* *
* // select nodes with name bar inside layer<br> * // select nodes with name bar inside layer
* var nodes = layer.find('.bar');<br><br> * var nodes = layer.find('.bar');
* *
* // select all groups inside layer<br> * // select all groups inside layer
* var nodes = layer.find('Group');<br><br> * var nodes = layer.find('Group');
* *
* // select all rectangles inside layer<br> * // select all rectangles inside layer
* var nodes = layer.find('Rect');<br><br> * var nodes = layer.find('Rect');
* *
* // select node with an id of foo or a name of bar inside layer<br> * // select node with an id of foo or a name of bar inside layer
* var nodes = layer.find('#foo, .bar'); * var nodes = layer.find('#foo, .bar');
*/ */
find: function(selector) { find: function(selector) {
@@ -364,15 +364,15 @@
* @param {Number} clip.height * @param {Number} clip.height
* @returns {Object} * @returns {Object}
* @example * @example
* // get clip<br> * // get clip
* var clip = container.clip();<br><br> * var clip = container.clip();
* *
* // set clip<br> * // set clip
* container.setClip({<br> * container.setClip({
* x: 20,<br> * x: 20,
* y: 20,<br> * y: 20,
* width: 20,<br> * width: 20,
* height: 20<br> * height: 20
* }); * });
*/ */
@@ -385,10 +385,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get clip x<br> * // get clip x
* var clipX = container.clipX();<br><br> * var clipX = container.clipX();
* *
* // set clip x<br> * // set clip x
* container.clipX(10); * container.clipX(10);
*/ */
@@ -401,10 +401,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get clip y<br> * // get clip y
* var clipY = container.clipY();<br><br> * var clipY = container.clipY();
* *
* // set clip y<br> * // set clip y
* container.clipY(10); * container.clipY(10);
*/ */
@@ -417,10 +417,10 @@
* @param {Number} width * @param {Number} width
* @returns {Number} * @returns {Number}
* @example * @example
* // get clip width<br> * // get clip width
* var clipWidth = container.clipWidth();<br><br> * var clipWidth = container.clipWidth();
* *
* // set clip width<br> * // set clip width
* container.clipWidth(100); * container.clipWidth(100);
*/ */
@@ -433,10 +433,10 @@
* @param {Number} height * @param {Number} height
* @returns {Number} * @returns {Number}
* @example * @example
* // get clip height<br> * // get clip height
* var clipHeight = container.clipHeight();<br><br> * var clipHeight = container.clipHeight();
* *
* // set clip height<br> * // set clip height
* container.clipHeight(100); * container.clipHeight(100);
*/ */

View File

@@ -246,15 +246,15 @@
* @param {Function} dragBoundFunc * @param {Function} dragBoundFunc
* @returns {Function} * @returns {Function}
* @example * @example
* // get drag bound function<br> * // get drag bound function
* var dragBoundFunc = node.dragBoundFunc();<br><br> * var dragBoundFunc = node.dragBoundFunc();
* *
* // create vertical drag and drop<br> * // create vertical drag and drop
* node.dragBoundFunc(function(){<br> * node.dragBoundFunc(function(){
* return {<br> * return {
* x: this.getAbsolutePosition().x,<br> * x: this.getAbsolutePosition().x,
* y: pos.y<br> * y: pos.y
* };<br> * };
* }); * });
*/ */
@@ -269,13 +269,13 @@
* @param {Boolean} draggable * @param {Boolean} draggable
* @returns {Boolean} * @returns {Boolean}
* @example * @example
* // get draggable flag<br> * // get draggable flag
* var draggable = node.draggable();<br><br> * var draggable = node.draggable();
* *
* // enable drag and drop<br> * // enable drag and drop
* node.draggable(true);<br><br> * node.draggable(true);
* *
* // disable drag and drop<br> * // disable drag and drop
* node.draggable(false); * node.draggable(false);
*/ */

View File

@@ -61,7 +61,7 @@
* @param {Number} [bounds.width] * @param {Number} [bounds.width]
* @param {Number} [bounds.height] * @param {Number} [bounds.height]
* @example * @example
* layer.clear();<br> * layer.clear();
* layer.clear(0, 0, 100, 100); * layer.clear(0, 0, 100, 100);
*/ */
clear: function(bounds) { clear: function(bounds) {

View File

@@ -108,19 +108,19 @@ var Kinetic = {};
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* var customShape = new Kinetic.Shape({<br> * var customShape = new Kinetic.Shape({
* x: 5,<br> * x: 5,
* y: 10,<br> * y: 10,
* fill: 'red',<br> * fill: 'red',
* // a Kinetic.Canvas renderer is passed into the drawFunc function<br> * // a Kinetic.Canvas renderer is passed into the drawFunc function
* drawFunc: function(context) {<br> * drawFunc: function(context) {
* context.beginPath();<br> * context.beginPath();
* context.moveTo(200, 50);<br> * context.moveTo(200, 50);
* context.lineTo(420, 80);<br> * context.lineTo(420, 80);
* context.quadraticCurveTo(300, 100, 260, 170);<br> * context.quadraticCurveTo(300, 100, 260, 170);
* context.closePath();<br> * context.closePath();
* context.fillStrokeShape(this);<br> * context.fillStrokeShape(this);
* }<br> * }
*}); *});
*/ */
Shape: function(config) { Shape: function(config) {
@@ -151,10 +151,10 @@ var Kinetic = {};
* @@nodeParams * @@nodeParams
* @@containerParams * @@containerParams
* @example * @example
* var stage = new Kinetic.Stage({<br> * var stage = new Kinetic.Stage({
* width: 500,<br> * width: 500,
* height: 800,<br> * height: 800,
* container: 'containerId'<br> * container: 'containerId'
* }); * });
*/ */
Stage: function(config) { Stage: function(config) {

View File

@@ -148,7 +148,7 @@
* @param {Number} [bounds.width] * @param {Number} [bounds.width]
* @param {Number} [bounds.height] * @param {Number} [bounds.height]
* @example * @example
* layer.clear();<br> * layer.clear();
* layer.clear(0, 0, 100, 100); * layer.clear(0, 0, 100, 100);
*/ */
clear: function(bounds) { clear: function(bounds) {
@@ -205,13 +205,13 @@
* @param {Boolean} enabled * @param {Boolean} enabled
* @returns {Boolean} * @returns {Boolean}
* @example * @example
* // get hitGraphEnabled flag<br> * // get hitGraphEnabled flag
* var hitGraphEnabled = layer.hitGraphEnabled();<br><br> * var hitGraphEnabled = layer.hitGraphEnabled();
* *
* // disable hit graph<br> * // disable hit graph
* layer.hitGraphEnabled(false);<br><br> * layer.hitGraphEnabled(false);
* *
* // enable hit graph<br> * // enable hit graph
* layer.hitGraphEnabled(true); * layer.hitGraphEnabled(true);
*/ */

View File

@@ -120,27 +120,27 @@
* region for debugging purposes * region for debugging purposes
* @returns {Kinetic.Node} * @returns {Kinetic.Node}
* @example * @example
* // cache a shape with the x,y position of the bounding box at the center and<br> * // cache a shape with the x,y position of the bounding box at the center and
* // the width and height of the bounding box equal to the width and height of<br> * // the width and height of the bounding box equal to the width and height of
* // the shape obtained from shape.width() and shape.height()<br> * // the shape obtained from shape.width() and shape.height()
* image.cache();<br><br> * image.cache();
* *
* // cache a node and define the bounding box position and size<br> * // cache a node and define the bounding box position and size
* node.cache({<br> * node.cache({
* x: -30,<br> * x: -30,
* y: -30,<br> * y: -30,
* width: 100,<br> * width: 100,
* height: 200<br> * height: 200
* });<br><br> * });
* *
* // cache a node and draw a red border around the bounding box<br> * // cache a node and draw a red border around the bounding box
* // for debugging purposes<br> * // for debugging purposes
* node.cache({<br> * node.cache({
* x: -30,<br> * x: -30,
* y: -30,<br> * y: -30,
* width: 100,<br> * width: 100,
* height: 200,<br> * height: 200,
* drawBorder: true<br> * drawBorder: true
* }); * });
*/ */
cache: function(config) { cache: function(config) {
@@ -282,45 +282,45 @@
* @param {Function} handler The handler function is passed an event object * @param {Function} handler The handler function is passed an event object
* @returns {Kinetic.Node} * @returns {Kinetic.Node}
* @example * @example
* // add click listener<br> * // add click listener
* node.on('click', function() {<br> * node.on('click', function() {
* console.log('you clicked me!');<br> * console.log('you clicked me!');
* });<br><br> * });
* *
* // get the target node<br> * // get the target node
* node.on('click', function(evt) {<br> * node.on('click', function(evt) {
* console.log(evt.target);<br> * console.log(evt.target);
* });<br><br> * });
* *
* // stop event propagation<br> * // stop event propagation
* node.on('click', function(evt) {<br> * node.on('click', function(evt) {
* evt.cancelBubble = true;<br> * evt.cancelBubble = true;
* });<br><br> * });
* *
* // bind multiple listeners<br> * // bind multiple listeners
* node.on('click touchstart', function() {<br> * node.on('click touchstart', function() {
* console.log('you clicked/touched me!');<br> * console.log('you clicked/touched me!');
* });<br><br> * });
* *
* // namespace listener<br> * // namespace listener
* node.on('click.foo', function() {<br> * node.on('click.foo', function() {
* console.log('you clicked/touched me!');<br> * console.log('you clicked/touched me!');
* });<br><br> * });
* *
* // get the event type<br> * // get the event type
* node.on('click tap', function(evt) {<br> * node.on('click tap', function(evt) {
* var eventType = evt.type;<br> * var eventType = evt.type;
* });<br><br> * });
* *
* // get native event object<br> * // get native event object
* node.on('click tap', function(evt) {<br> * node.on('click tap', function(evt) {
* var nativeEvent = evt.evt;<br> * var nativeEvent = evt.evt;
* });<br><br> * });
* *
* // for change events, get the old and new val<br> * // for change events, get the old and new val
* node.on('xChange', function(evt) {<br> * node.on('xChange', function(evt) {
* var oldVal = evt.oldVal;<br> * var oldVal = evt.oldVal;
* var newVal = evt.newVal;<br> * var newVal = evt.newVal;
* }); * });
*/ */
on: function(evtStr, handler) { on: function(evtStr, handler) {
@@ -375,13 +375,13 @@
* @param {String} evtStr e.g. 'click', 'mousedown touchstart', '.foobar' * @param {String} evtStr e.g. 'click', 'mousedown touchstart', '.foobar'
* @returns {Kinetic.Node} * @returns {Kinetic.Node}
* @example * @example
* // remove listener<br> * // remove listener
* node.off('click');<br><br> * node.off('click');
* *
* // remove multiple listeners<br> * // remove multiple listeners
* node.off('click touchstart');<br><br> * node.off('click touchstart');
* *
* // remove listener by name<br> * // remove listener by name
* node.off('click.foo'); * node.off('click.foo');
*/ */
off: function(evtStr) { off: function(evtStr) {
@@ -520,10 +520,10 @@
* @param {Object} config object containing key value pairs * @param {Object} config object containing key value pairs
* @returns {Kinetic.Node} * @returns {Kinetic.Node}
* @example * @example
* node.setAttrs({<br> * node.setAttrs({
* x: 5,<br> * x: 5,
* fill: 'red'<br> * fill: 'red'
* });<br> * });
*/ */
setAttrs: function(config) { setAttrs: function(config) {
var key, method; var key, method;
@@ -708,7 +708,7 @@
return index; return index;
}, },
/** /**
* get node depth in node tree. Returns an integer.<br><br> * get node depth in node tree. Returns an integer.
* e.g. Stage depth will always be 0. Layers will always be 1. Groups and Shapes will always * e.g. Stage depth will always be 0. Layers will always be 1. Groups and Shapes will always
* be >= 2 * be >= 2
* @method * @method
@@ -835,10 +835,10 @@
* @param {Number} change.y * @param {Number} change.y
* @returns {Kinetic.Node} * @returns {Kinetic.Node}
* @example * @example
* // move node in x direction by 1px and y direction by 2px<br> * // move node in x direction by 1px and y direction by 2px
* node.move({<br> * node.move({
* x: 1,<br> * x: 1,
* y: 2)<br> * y: 2)
* }); * });
*/ */
move: function(change) { move: function(change) {
@@ -1013,7 +1013,7 @@
* @param {Container} newContainer * @param {Container} newContainer
* @returns {Kinetic.Node} * @returns {Kinetic.Node}
* @example * @example
* // move node from current layer into layer2<br> * // move node from current layer into layer2
* node.moveTo(layer2); * node.moveTo(layer2);
*/ */
moveTo: function(newContainer) { moveTo: function(newContainer) {
@@ -1110,18 +1110,18 @@
* not bubbling. Setting the value to true will result in the event bubbling. * not bubbling. Setting the value to true will result in the event bubbling.
* @returns {Kinetic.Node} * @returns {Kinetic.Node}
* @example * @example
* // manually fire click event<br> * // manually fire click event
* node.fire('click');<br><br> * node.fire('click');
* *
* // fire custom event<br> * // fire custom event
* node.fire('foo');<br><br> * node.fire('foo');
* *
* // fire custom event with custom event object<br> * // fire custom event with custom event object
* node.fire('foo', {<br> * node.fire('foo', {
* bar: 10<br> * bar: 10
* });<br><br> * });
* *
* // fire click event that bubbles<br> * // fire click event that bubbles
* node.fire('click', null, true); * node.fire('click', null, true);
*/ */
fire: function(eventType, evt, bubble) { fire: function(eventType, evt, bubble) {
@@ -1218,12 +1218,12 @@
* @param {Object} attrs override attrs * @param {Object} attrs override attrs
* @returns {Kinetic.Node} * @returns {Kinetic.Node}
* @example * @example
* // simple clone<br> * // simple clone
* var clone = node.clone();<br><br> * var clone = node.clone();
* *
* // clone a node and override the x position<br> * // clone a node and override the x position
* var clone = rect.clone({<br> * var clone = rect.clone({
* x: 5<br> * x: 5
* }); * });
*/ */
clone: function(obj) { clone: function(obj) {
@@ -1325,10 +1325,10 @@
* you can specify the quality from 0 to 1, where 0 is very poor quality and 1 * you can specify the quality from 0 to 1, where 0 is very poor quality and 1
* is very high quality * is very high quality
* @example * @example
* var image = node.toImage({<br> * var image = node.toImage({
* callback: function(img) {<br> * callback: function(img) {
* // do stuff with img<br> * // do stuff with img
* }<br> * }
* }); * });
*/ */
toImage: function(config) { toImage: function(config) {
@@ -1597,13 +1597,13 @@
* @param {Nubmer} pos.y * @param {Nubmer} pos.y
* @returns {Object} * @returns {Object}
* @example * @example
* // get position<br> * // get position
* var position = node.position();<br><br> * var position = node.position();
* *
* // set position<br> * // set position
* node.position({<br> * node.position({
* x: 5<br> * x: 5
* y: 10<br> * y: 10
* }); * });
*/ */
@@ -1617,10 +1617,10 @@
* @param {Number} x * @param {Number} x
* @returns {Object} * @returns {Object}
* @example * @example
* // get x<br> * // get x
* var x = node.x();<br><br> * var x = node.x();
* *
* // set x<br> * // set x
* node.x(5); * node.x(5);
*/ */
@@ -1634,10 +1634,10 @@
* @param {Number} y * @param {Number} y
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get y<br> * // get y
* var y = node.y();<br><br> * var y = node.y();
* *
* // set y<br> * // set y
* node.y(5); * node.y(5);
*/ */
@@ -1653,10 +1653,10 @@
* @param {Object} opacity * @param {Object} opacity
* @returns {Number} * @returns {Number}
* @example * @example
* // get opacity<br> * // get opacity
* var opacity = node.opacity();<br><br> * var opacity = node.opacity();
* *
* // set opacity<br> * // set opacity
* node.opacity(0.5); * node.opacity(0.5);
*/ */
@@ -1671,10 +1671,10 @@
* @param {String} name * @param {String} name
* @returns {String} * @returns {String}
* @example * @example
* // get name<br> * // get name
* var name = node.name();<br><br> * var name = node.name();
* *
* // set name<br> * // set name
* node.name('foo'); * node.name('foo');
*/ */
@@ -1689,10 +1689,10 @@
* @param {String} id * @param {String} id
* @returns {String} * @returns {String}
* @example * @example
* // get id<br> * // get id
* var name = node.id();<br><br> * var name = node.id();
* *
* // set id<br> * // set id
* node.id('foo'); * node.id('foo');
*/ */
@@ -1706,10 +1706,10 @@
* @param {Number} rotation * @param {Number} rotation
* @returns {Number} * @returns {Number}
* @example * @example
* // get rotation in degrees<br> * // get rotation in degrees
* var rotation = node.rotation();<br><br> * var rotation = node.rotation();
* *
* // set rotation in degrees<br> * // set rotation in degrees
* node.rotation(45); * node.rotation(45);
*/ */
@@ -1725,13 +1725,13 @@
* @memberof Kinetic.Node.prototype * @memberof Kinetic.Node.prototype
* @returns {Object} * @returns {Object}
* @example * @example
* // get scale<br> * // get scale
* var scale = node.scale();<br><br> * var scale = node.scale();
* *
* // set scale <br> * // set scale
* shape.scale({<br> * shape.scale({
* x: 2<br> * x: 2
* y: 3<br> * y: 3
* }); * });
*/ */
@@ -1745,10 +1745,10 @@
* @memberof Kinetic.Node.prototype * @memberof Kinetic.Node.prototype
* @returns {Number} * @returns {Number}
* @example * @example
* // get scale x<br> * // get scale x
* var scaleX = node.scaleX();<br><br> * var scaleX = node.scaleX();
* *
* // set scale x<br> * // set scale x
* node.scaleX(2); * node.scaleX(2);
*/ */
@@ -1762,10 +1762,10 @@
* @memberof Kinetic.Node.prototype * @memberof Kinetic.Node.prototype
* @returns {Number} * @returns {Number}
* @example * @example
* // get scale y<br> * // get scale y
* var scaleY = node.scaleY();<br><br> * var scaleY = node.scaleY();
* *
* // set scale y<br> * // set scale y
* node.scaleY(2); * node.scaleY(2);
*/ */
@@ -1781,12 +1781,12 @@
* @memberof Kinetic.Node.prototype * @memberof Kinetic.Node.prototype
* @returns {Object} * @returns {Object}
* @example * @example
* // get skew<br> * // get skew
* var skew = node.skew();<br><br> * var skew = node.skew();
* *
* // set skew <br> * // set skew
* node.skew({<br> * node.skew({
* x: 20<br> * x: 20
* y: 10 * y: 10
* }); * });
*/ */
@@ -1801,10 +1801,10 @@
* @memberof Kinetic.Node.prototype * @memberof Kinetic.Node.prototype
* @returns {Number} * @returns {Number}
* @example * @example
* // get skew x<br> * // get skew x
* var skewX = node.skewX();<br><br> * var skewX = node.skewX();
* *
* // set skew x<br> * // set skew x
* node.skewX(3); * node.skewX(3);
*/ */
@@ -1818,10 +1818,10 @@
* @memberof Kinetic.Node.prototype * @memberof Kinetic.Node.prototype
* @returns {Number} * @returns {Number}
* @example * @example
* // get skew y<br> * // get skew y
* var skewY = node.skewY();<br><br> * var skewY = node.skewY();
* *
* // set skew y<br> * // set skew y
* node.skewY(3); * node.skewY(3);
*/ */
@@ -1836,13 +1836,13 @@
* @param {Number} offset.y * @param {Number} offset.y
* @returns {Object} * @returns {Object}
* @example * @example
* // get offset<br> * // get offset
* var offset = node.offset();<br><br> * var offset = node.offset();
* *
* // set offset<br> * // set offset
* node.offset({<br> * node.offset({
* x: 20<br> * x: 20
* y: 10<br> * y: 10
* }); * });
*/ */
@@ -1855,10 +1855,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get offset x<br> * // get offset x
* var offsetX = node.offsetX();<br><br> * var offsetX = node.offsetX();
* *
* // set offset x<br> * // set offset x
* node.offsetX(3); * node.offsetX(3);
*/ */
@@ -1871,13 +1871,13 @@
* @param {Number} distance * @param {Number} distance
* @returns {Number} * @returns {Number}
* @example * @example
* // get drag distance<br> * // get drag distance
* var dragDistance = node.dragDistance();<br><br> * var dragDistance = node.dragDistance();
* *
* // set distance<br> * // set distance
* // node starts dragging only if pointer moved more then 3 pixels<br> * // node starts dragging only if pointer moved more then 3 pixels
* node.dragDistance(3);<br> * node.dragDistance(3);
* // or set globally<br> * // or set globally
* Kinetic.dragDistance = 3; * Kinetic.dragDistance = 3;
*/ */
@@ -1892,10 +1892,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get offset y<br> * // get offset y
* var offsetY = node.offsetY();<br><br> * var offsetY = node.offsetY();
* *
* // set offset y<br> * // set offset y
* node.offsetY(3); * node.offsetY(3);
*/ */
@@ -1909,10 +1909,10 @@
* @param {Number} width * @param {Number} width
* @returns {Number} * @returns {Number}
* @example * @example
* // get width<br> * // get width
* var width = node.width();<br><br> * var width = node.width();
* *
* // set width<br> * // set width
* node.width(100); * node.width(100);
*/ */
@@ -1926,10 +1926,10 @@
* @param {Number} height * @param {Number} height
* @returns {Number} * @returns {Number}
* @example * @example
* // get height<br> * // get height
* var height = node.height();<br><br> * var height = node.height();
* *
* // set height<br> * // set height
* node.height(100); * node.height(100);
*/ */
@@ -1943,16 +1943,16 @@
* @param {Boolean|String} listening Can be "inherit", true, or false. The default is "inherit". * @param {Boolean|String} listening Can be "inherit", true, or false. The default is "inherit".
* @returns {Boolean|String} * @returns {Boolean|String}
* @example * @example
* // get listening attr<br> * // get listening attr
* var listening = node.listening();<br><br> * var listening = node.listening();
* *
* // stop listening for events<br> * // stop listening for events
* node.listening(false);<br><br> * node.listening(false);
* *
* // listen for events<br> * // listen for events
* node.listening(true);<br><br> * node.listening(true);
* *
* // listen to events according to the parent<br> * // listen to events according to the parent
* node.listening('inherit'); * node.listening('inherit');
*/ */
@@ -1965,19 +1965,19 @@
* @param {Array} filters array of filters * @param {Array} filters array of filters
* @returns {Array} * @returns {Array}
* @example * @example
* // get filters<br> * // get filters
* var filters = node.filters();<br><br> * var filters = node.filters();
* *
* // set a single filter<br> * // set a single filter
* node.cache();<br> * node.cache();
* node.filters([Kinetic.Filters.Blur]);<br><br> * node.filters([Kinetic.Filters.Blur]);
* *
* // set multiple filters<br> * // set multiple filters
* node.cache();<br> * node.cache();
* node.filters([<br> * node.filters([
* Kinetic.Filters.Blur,<br> * Kinetic.Filters.Blur,
* Kinetic.Filters.Sepia,<br> * Kinetic.Filters.Sepia,
* Kinetic.Filters.Invert<br> * Kinetic.Filters.Invert
* ]); * ]);
*/ */
@@ -1992,16 +1992,16 @@
* @param {Boolean|String} visible * @param {Boolean|String} visible
* @returns {Boolean|String} * @returns {Boolean|String}
* @example * @example
* // get visible attr<br> * // get visible attr
* var visible = node.visible();<br><br> * var visible = node.visible();
* *
* // make invisible<br> * // make invisible
* node.visible(false);<br><br> * node.visible(false);
* *
* // make visible<br> * // make visible
* node.visible(true);<br><br> * node.visible(true);
* *
* // make visible according to the parent<br> * // make visible according to the parent
* node.visible('inherit'); * node.visible('inherit');
*/ */
@@ -2016,10 +2016,10 @@
* @param {String} enabled * @param {String} enabled
* @returns {String} * @returns {String}
* @example * @example
* // enable position transform only to improve draw performance<br> * // enable position transform only to improve draw performance
* node.transformsEnabled('position');<br><br> * node.transformsEnabled('position');
* *
* // enable all transforms<br> * // enable all transforms
* node.transformsEnabled('all'); * node.transformsEnabled('all');
*/ */
@@ -2035,15 +2035,15 @@
* @param {Number} size.height * @param {Number} size.height
* @returns {Object} * @returns {Object}
* @example * @example
* // get node size<br> * // get node size
* var size = node.size();<br> * var size = node.size();
* var x = size.x;<br> * var x = size.x;
* var y = size.y;<br><br> * var y = size.y;
* *
* // set size<br> * // set size
* node.size({<br> * node.size({
* width: 100,<br> * width: 100,
* height: 200<br> * height: 200
* }); * });
*/ */
Kinetic.Factory.addOverloadedGetterSetter(Kinetic.Node, 'size'); Kinetic.Factory.addOverloadedGetterSetter(Kinetic.Node, 'size');

View File

@@ -283,19 +283,19 @@
* @param {String} color * @param {String} color
* @returns {String} * @returns {String}
* @example * @example
* // get stroke color<br> * // get stroke color
* var stroke = shape.stroke();<br><br> * var stroke = shape.stroke();
* *
* // set stroke color with color string<br> * // set stroke color with color string
* shape.stroke('green');<br><br> * shape.stroke('green');
* *
* // set stroke color with hex<br> * // set stroke color with hex
* shape.stroke('#00ff00');<br><br> * shape.stroke('#00ff00');
* *
* // set stroke color with rgb<br> * // set stroke color with rgb
* shape.stroke('rgb(0,255,0)');<br><br> * shape.stroke('rgb(0,255,0)');
* *
* // set stroke color with rgba and make it 50% opaque<br> * // set stroke color with rgba and make it 50% opaque
* shape.stroke('rgba(0,255,0,0.5'); * shape.stroke('rgba(0,255,0,0.5');
*/ */
@@ -309,10 +309,10 @@
* @param {Integer} red * @param {Integer} red
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get stroke red component<br> * // get stroke red component
* var strokeRed = shape.strokeRed();<br><br> * var strokeRed = shape.strokeRed();
* *
* // set stroke red component<br> * // set stroke red component
* shape.strokeRed(0); * shape.strokeRed(0);
*/ */
@@ -326,10 +326,10 @@
* @param {Integer} green * @param {Integer} green
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get stroke green component<br> * // get stroke green component
* var strokeGreen = shape.strokeGreen();<br><br> * var strokeGreen = shape.strokeGreen();
* *
* // set stroke green component<br> * // set stroke green component
* shape.strokeGreen(255); * shape.strokeGreen(255);
*/ */
@@ -343,10 +343,10 @@
* @param {Integer} blue * @param {Integer} blue
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get stroke blue component<br> * // get stroke blue component
* var strokeBlue = shape.strokeBlue();<br><br> * var strokeBlue = shape.strokeBlue();
* *
* // set stroke blue component<br> * // set stroke blue component
* shape.strokeBlue(0); * shape.strokeBlue(0);
*/ */
@@ -361,10 +361,10 @@
* @param {Number} alpha * @param {Number} alpha
* @returns {Number} * @returns {Number}
* @example * @example
* // get stroke alpha component<br> * // get stroke alpha component
* var strokeAlpha = shape.strokeAlpha();<br><br> * var strokeAlpha = shape.strokeAlpha();
* *
* // set stroke alpha component<br> * // set stroke alpha component
* shape.strokeAlpha(0.5); * shape.strokeAlpha(0.5);
*/ */
@@ -378,10 +378,10 @@
* @param {Number} strokeWidth * @param {Number} strokeWidth
* @returns {Number} * @returns {Number}
* @example * @example
* // get stroke width<br> * // get stroke width
* var strokeWidth = shape.strokeWidth();<br><br> * var strokeWidth = shape.strokeWidth();
* *
* // set stroke width<br> * // set stroke width
* shape.strokeWidth(); * shape.strokeWidth();
*/ */
@@ -396,10 +396,10 @@
* @param {String} lineJoin * @param {String} lineJoin
* @returns {String} * @returns {String}
* @example * @example
* // get line join<br> * // get line join
* var lineJoin = shape.lineJoin();<br><br> * var lineJoin = shape.lineJoin();
* *
* // set line join<br> * // set line join
* shape.lineJoin('round'); * shape.lineJoin('round');
*/ */
@@ -413,10 +413,10 @@
* @param {String} lineCap * @param {String} lineCap
* @returns {String} * @returns {String}
* @example * @example
* // get line cap<br> * // get line cap
* var lineCap = shape.lineCap();<br><br> * var lineCap = shape.lineCap();
* *
* // set line cap<br> * // set line cap
* shape.lineCap('round'); * shape.lineCap('round');
*/ */
@@ -430,15 +430,15 @@
* @param {Function} drawFunc drawing function * @param {Function} drawFunc drawing function
* @returns {Function} * @returns {Function}
* @example * @example
* // get scene draw function<br> * // get scene draw function
* var sceneFunc = shape.sceneFunc();<br><br> * var sceneFunc = shape.sceneFunc();
* *
* // set scene draw function<br> * // set scene draw function
* shape.sceneFunc(function(context) {<br> * shape.sceneFunc(function(context) {
* context.beginPath();<br> * context.beginPath();
* context.rect(0, 0, this.width(), this.height());<br> * context.rect(0, 0, this.width(), this.height());
* context.closePath();<br> * context.closePath();
* context.fillStrokeShape(this);<br> * context.fillStrokeShape(this);
* }); * });
*/ */
@@ -452,15 +452,15 @@
* @param {Function} drawFunc drawing function * @param {Function} drawFunc drawing function
* @returns {Function} * @returns {Function}
* @example * @example
* // get hit draw function<br> * // get hit draw function
* var hitFunc = shape.hitFunc();<br><br> * var hitFunc = shape.hitFunc();
* *
* // set hit draw function<br> * // set hit draw function
* shape.hitFunc(function(context) {<br> * shape.hitFunc(function(context) {
* context.beginPath();<br> * context.beginPath();
* context.rect(0, 0, this.width(), this.height());<br> * context.rect(0, 0, this.width(), this.height());
* context.closePath();<br> * context.closePath();
* context.fillStrokeShape(this);<br> * context.fillStrokeShape(this);
* }); * });
*/ */
@@ -474,12 +474,12 @@
* @param {Array} dash * @param {Array} dash
* @returns {Array} * @returns {Array}
* @example * @example
* // apply dashed stroke that is 10px long and 5 pixels apart<br> * // apply dashed stroke that is 10px long and 5 pixels apart
* line.dash([10, 5]);<br><br> * line.dash([10, 5]);
* *
* // apply dashed stroke that is made up of alternating dashed<br> * // apply dashed stroke that is made up of alternating dashed
* // lines that are 10px long and 20px apart, and dots that have<br> * // lines that are 10px long and 20px apart, and dots that have
* // a radius of 5px and are 20px apart<br> * // a radius of 5px and are 20px apart
* line.dash([10, 20, 0.001, 20]); * line.dash([10, 20, 0.001, 20]);
*/ */
@@ -494,19 +494,19 @@
* @param {String} color * @param {String} color
* @returns {String} * @returns {String}
* @example * @example
* // get shadow color<br> * // get shadow color
* var shadow = shape.shadowColor();<br><br> * var shadow = shape.shadowColor();
* *
* // set shadow color with color string<br> * // set shadow color with color string
* shape.shadowColor('green');<br><br> * shape.shadowColor('green');
* *
* // set shadow color with hex<br> * // set shadow color with hex
* shape.shadowColor('#00ff00');<br><br> * shape.shadowColor('#00ff00');
* *
* // set shadow color with rgb<br> * // set shadow color with rgb
* shape.shadowColor('rgb(0,255,0)');<br><br> * shape.shadowColor('rgb(0,255,0)');
* *
* // set shadow color with rgba and make it 50% opaque<br> * // set shadow color with rgba and make it 50% opaque
* shape.shadowColor('rgba(0,255,0,0.5'); * shape.shadowColor('rgba(0,255,0,0.5');
*/ */
@@ -520,10 +520,10 @@
* @param {Integer} red * @param {Integer} red
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get shadow red component<br> * // get shadow red component
* var shadowRed = shape.shadowRed();<br><br> * var shadowRed = shape.shadowRed();
* *
* // set shadow red component<br> * // set shadow red component
* shape.shadowRed(0); * shape.shadowRed(0);
*/ */
@@ -537,10 +537,10 @@
* @param {Integer} green * @param {Integer} green
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get shadow green component<br> * // get shadow green component
* var shadowGreen = shape.shadowGreen();<br><br> * var shadowGreen = shape.shadowGreen();
* *
* // set shadow green component<br> * // set shadow green component
* shape.shadowGreen(255); * shape.shadowGreen(255);
*/ */
@@ -554,10 +554,10 @@
* @param {Integer} blue * @param {Integer} blue
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get shadow blue component<br> * // get shadow blue component
* var shadowBlue = shape.shadowBlue();<br><br> * var shadowBlue = shape.shadowBlue();
* *
* // set shadow blue component<br> * // set shadow blue component
* shape.shadowBlue(0); * shape.shadowBlue(0);
*/ */
@@ -572,10 +572,10 @@
* @param {Number} alpha * @param {Number} alpha
* @returns {Number} * @returns {Number}
* @example * @example
* // get shadow alpha component<br> * // get shadow alpha component
* var shadowAlpha = shape.shadowAlpha();<br><br> * var shadowAlpha = shape.shadowAlpha();
* *
* // set shadow alpha component<br> * // set shadow alpha component
* shape.shadowAlpha(0.5); * shape.shadowAlpha(0.5);
*/ */
@@ -589,10 +589,10 @@
* @param {Number} blur * @param {Number} blur
* @returns {Number} * @returns {Number}
* @example * @example
* // get shadow blur<br> * // get shadow blur
* var shadowBlur = shape.shadowBlur();<br><br> * var shadowBlur = shape.shadowBlur();
* *
* // set shadow blur<br> * // set shadow blur
* shape.shadowBlur(10); * shape.shadowBlur(10);
*/ */
@@ -606,10 +606,10 @@
* @param {Number} opacity * @param {Number} opacity
* @returns {Number} * @returns {Number}
* @example * @example
* // get shadow opacity<br> * // get shadow opacity
* var shadowOpacity = shape.shadowOpacity();<br><br> * var shadowOpacity = shape.shadowOpacity();
* *
* // set shadow opacity<br> * // set shadow opacity
* shape.shadowOpacity(0.5); * shape.shadowOpacity(0.5);
*/ */
@@ -625,13 +625,13 @@
* @param {Number} offset.y * @param {Number} offset.y
* @returns {Object} * @returns {Object}
* @example * @example
* // get shadow offset<br> * // get shadow offset
* var shadowOffset = shape.shadowOffset();<br><br> * var shadowOffset = shape.shadowOffset();
* *
* // set shadow offset<br> * // set shadow offset
* shape.shadowOffset({<br> * shape.shadowOffset({
* x: 20<br> * x: 20
* y: 10<br> * y: 10
* }); * });
*/ */
@@ -645,10 +645,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get shadow offset x<br> * // get shadow offset x
* var shadowOffsetX = shape.shadowOffsetX();<br><br> * var shadowOffsetX = shape.shadowOffsetX();
* *
* // set shadow offset x<br> * // set shadow offset x
* shape.shadowOffsetX(5); * shape.shadowOffsetX(5);
*/ */
@@ -662,10 +662,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get shadow offset y<br> * // get shadow offset y
* var shadowOffsetY = shape.shadowOffsetY();<br><br> * var shadowOffsetY = shape.shadowOffsetY();
* *
* // set shadow offset y<br> * // set shadow offset y
* shape.shadowOffsetY(5); * shape.shadowOffsetY(5);
*/ */
@@ -679,14 +679,14 @@
* @param {Image} image object * @param {Image} image object
* @returns {Image} * @returns {Image}
* @example * @example
* // get fill pattern image<br> * // get fill pattern image
* var fillPatternImage = shape.fillPatternImage();<br><br> * var fillPatternImage = shape.fillPatternImage();
* *
* // set fill pattern image<br> * // set fill pattern image
* var imageObj = new Image();<br> * var imageObj = new Image();
* imageObj.onload = function() {<br> * imageObj.onload = function() {
* shape.fillPatternImage(imageObj);<br> * shape.fillPatternImage(imageObj);
* };<br> * };
* imageObj.src = 'path/to/image/jpg'; * imageObj.src = 'path/to/image/jpg';
*/ */
@@ -700,19 +700,19 @@
* @param {String} color * @param {String} color
* @returns {String} * @returns {String}
* @example * @example
* // get fill color<br> * // get fill color
* var fill = shape.fill();<br><br> * var fill = shape.fill();
* *
* // set fill color with color string<br> * // set fill color with color string
* shape.fill('green');<br><br> * shape.fill('green');
* *
* // set fill color with hex<br> * // set fill color with hex
* shape.fill('#00ff00');<br><br> * shape.fill('#00ff00');
* *
* // set fill color with rgb<br> * // set fill color with rgb
* shape.fill('rgb(0,255,0)');<br><br> * shape.fill('rgb(0,255,0)');
* *
* // set fill color with rgba and make it 50% opaque<br> * // set fill color with rgba and make it 50% opaque
* shape.fill('rgba(0,255,0,0.5'); * shape.fill('rgba(0,255,0,0.5');
*/ */
@@ -726,10 +726,10 @@
* @param {Integer} red * @param {Integer} red
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get fill red component<br> * // get fill red component
* var fillRed = shape.fillRed();<br><br> * var fillRed = shape.fillRed();
* *
* // set fill red component<br> * // set fill red component
* shape.fillRed(0); * shape.fillRed(0);
*/ */
@@ -743,10 +743,10 @@
* @param {Integer} green * @param {Integer} green
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get fill green component<br> * // get fill green component
* var fillGreen = shape.fillGreen();<br><br> * var fillGreen = shape.fillGreen();
* *
* // set fill green component<br> * // set fill green component
* shape.fillGreen(255); * shape.fillGreen(255);
*/ */
@@ -760,10 +760,10 @@
* @param {Integer} blue * @param {Integer} blue
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get fill blue component<br> * // get fill blue component
* var fillBlue = shape.fillBlue();<br><br> * var fillBlue = shape.fillBlue();
* *
* // set fill blue component<br> * // set fill blue component
* shape.fillBlue(0); * shape.fillBlue(0);
*/ */
@@ -778,10 +778,10 @@
* @param {Number} alpha * @param {Number} alpha
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill alpha component<br> * // get fill alpha component
* var fillAlpha = shape.fillAlpha();<br><br> * var fillAlpha = shape.fillAlpha();
* *
* // set fill alpha component<br> * // set fill alpha component
* shape.fillAlpha(0.5); * shape.fillAlpha(0.5);
*/ */
@@ -796,10 +796,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill pattern x<br> * // get fill pattern x
* var fillPatternX = shape.fillPatternX();<br><br> * var fillPatternX = shape.fillPatternX();
* *
* // set fill pattern x<br> * // set fill pattern x
* shape.fillPatternX(20); * shape.fillPatternX(20);
*/ */
@@ -813,10 +813,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill pattern y<br> * // get fill pattern y
* var fillPatternY = shape.fillPatternY();<br><br> * var fillPatternY = shape.fillPatternY();
* *
* // set fill pattern y<br> * // set fill pattern y
* shape.fillPatternY(20); * shape.fillPatternY(20);
*/ */
@@ -830,11 +830,11 @@
* @param {Array} colorStops * @param {Array} colorStops
* @returns {Array} colorStops * @returns {Array} colorStops
* @example * @example
* // get fill linear gradient color stops<br> * // get fill linear gradient color stops
* var colorStops = shape.fillLinearGradientColorStops();<br><br> * var colorStops = shape.fillLinearGradientColorStops();
* *
* // create a linear gradient that starts with red, changes to blue <br> * // create a linear gradient that starts with red, changes to blue
* // halfway through, and then changes to green<br> * // halfway through, and then changes to green
* shape.fillLinearGradientColorStops(0, 'red', 0.5, 'blue', 1, 'green'); * shape.fillLinearGradientColorStops(0, 'red', 0.5, 'blue', 1, 'green');
*/ */
@@ -848,10 +848,10 @@
* @param {Number} radius * @param {Number} radius
* @returns {Number} * @returns {Number}
* @example * @example
* // get radial gradient start radius<br> * // get radial gradient start radius
* var startRadius = shape.fillRadialGradientStartRadius();<br><br> * var startRadius = shape.fillRadialGradientStartRadius();
* *
* // set radial gradient start radius<br> * // set radial gradient start radius
* shape.fillRadialGradientStartRadius(0); * shape.fillRadialGradientStartRadius(0);
*/ */
@@ -865,10 +865,10 @@
* @param {Number} radius * @param {Number} radius
* @returns {Number} * @returns {Number}
* @example * @example
* // get radial gradient end radius<br> * // get radial gradient end radius
* var endRadius = shape.fillRadialGradientEndRadius();<br><br> * var endRadius = shape.fillRadialGradientEndRadius();
* *
* // set radial gradient end radius<br> * // set radial gradient end radius
* shape.fillRadialGradientEndRadius(100); * shape.fillRadialGradientEndRadius(100);
*/ */
@@ -882,11 +882,11 @@
* @param {Number} colorStops * @param {Number} colorStops
* @returns {Array} * @returns {Array}
* @example * @example
* // get fill radial gradient color stops<br> * // get fill radial gradient color stops
* var colorStops = shape.fillRadialGradientColorStops();<br><br> * var colorStops = shape.fillRadialGradientColorStops();
* *
* // create a radial gradient that starts with red, changes to blue <br> * // create a radial gradient that starts with red, changes to blue
* // halfway through, and then changes to green<br> * // halfway through, and then changes to green
* shape.fillRadialGradientColorStops(0, 'red', 0.5, 'blue', 1, 'green'); * shape.fillRadialGradientColorStops(0, 'red', 0.5, 'blue', 1, 'green');
*/ */
@@ -900,13 +900,13 @@
* @param {String} repeat * @param {String} repeat
* @returns {String} * @returns {String}
* @example * @example
* // get fill pattern repeat<br> * // get fill pattern repeat
* var repeat = shape.fillPatternRepeat();<br><br> * var repeat = shape.fillPatternRepeat();
* *
* // repeat pattern in x direction only<br> * // repeat pattern in x direction only
* shape.fillPatternRepeat('repeat-x');<br><br> * shape.fillPatternRepeat('repeat-x');
* *
* // do not repeat the pattern<br> * // do not repeat the pattern
* shape.fillPatternRepeat('no repeat'); * shape.fillPatternRepeat('no repeat');
*/ */
@@ -920,13 +920,13 @@
* @param {Boolean} enabled * @param {Boolean} enabled
* @returns {Boolean} * @returns {Boolean}
* @example * @example
* // get fill enabled flag<br> * // get fill enabled flag
* var fillEnabled = shape.fillEnabled();<br><br> * var fillEnabled = shape.fillEnabled();
* *
* // disable fill<br> * // disable fill
* shape.fillEnabled(false);<br><br> * shape.fillEnabled(false);
* *
* // enable fill<br> * // enable fill
* shape.fillEnabled(true); * shape.fillEnabled(true);
*/ */
@@ -940,13 +940,13 @@
* @param {Boolean} enabled * @param {Boolean} enabled
* @returns {Boolean} * @returns {Boolean}
* @example * @example
* // get stroke enabled flag<br> * // get stroke enabled flag
* var strokeEnabled = shape.strokeEnabled();<br><br> * var strokeEnabled = shape.strokeEnabled();
* *
* // disable stroke<br> * // disable stroke
* shape.strokeEnabled(false);<br><br> * shape.strokeEnabled(false);
* *
* // enable stroke<br> * // enable stroke
* shape.strokeEnabled(true); * shape.strokeEnabled(true);
*/ */
@@ -960,13 +960,13 @@
* @param {Boolean} enabled * @param {Boolean} enabled
* @returns {Boolean} * @returns {Boolean}
* @example * @example
* // get shadow enabled flag<br> * // get shadow enabled flag
* var shadowEnabled = shape.shadowEnabled();<br><br> * var shadowEnabled = shape.shadowEnabled();
* *
* // disable shadow<br> * // disable shadow
* shape.shadowEnabled(false);<br><br> * shape.shadowEnabled(false);
* *
* // enable shadow<br> * // enable shadow
* shape.shadowEnabled(true); * shape.shadowEnabled(true);
*/ */
@@ -980,13 +980,13 @@
* @param {Boolean} enabled * @param {Boolean} enabled
* @returns {Boolean} * @returns {Boolean}
* @example * @example
* // get dash enabled flag<br> * // get dash enabled flag
* var dashEnabled = shape.dashEnabled();<br><br> * var dashEnabled = shape.dashEnabled();
* *
* // disable dash<br> * // disable dash
* shape.dashEnabled(false);<br><br> * shape.dashEnabled(false);
* *
* // enable dash<br> * // enable dash
* shape.dashEnabled(true); * shape.dashEnabled(true);
*/ */
@@ -1000,13 +1000,13 @@
* @param {Boolean} enabled * @param {Boolean} enabled
* @returns {Boolean} * @returns {Boolean}
* @example * @example
* // get stroke scale enabled flag<br> * // get stroke scale enabled flag
* var strokeScaleEnabled = shape.strokeScaleEnabled();<br><br> * var strokeScaleEnabled = shape.strokeScaleEnabled();
* *
* // disable stroke scale<br> * // disable stroke scale
* shape.strokeScaleEnabled(false);<br><br> * shape.strokeScaleEnabled(false);
* *
* // enable stroke scale<br> * // enable stroke scale
* shape.strokeScaleEnabled(true); * shape.strokeScaleEnabled(true);
*/ */
@@ -1021,10 +1021,10 @@
* @param {String} priority * @param {String} priority
* @returns {String} * @returns {String}
* @example * @example
* // get fill priority<br> * // get fill priority
* var fillPriority = shape.fillPriority();<br><br> * var fillPriority = shape.fillPriority();
* *
* // set fill priority<br> * // set fill priority
* shape.fillPriority('linear-gradient'); * shape.fillPriority('linear-gradient');
*/ */
@@ -1040,13 +1040,13 @@
* @param {Number} offset.y * @param {Number} offset.y
* @returns {Object} * @returns {Object}
* @example * @example
* // get fill pattern offset<br> * // get fill pattern offset
* var patternOffset = shape.fillPatternOffset();<br><br> * var patternOffset = shape.fillPatternOffset();
* *
* // set fill pattern offset<br> * // set fill pattern offset
* shape.fillPatternOffset({<br> * shape.fillPatternOffset({
* x: 20<br> * x: 20
* y: 10<br> * y: 10
* }); * });
*/ */
@@ -1060,10 +1060,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill pattern offset x<br> * // get fill pattern offset x
* var patternOffsetX = shape.fillPatternOffsetX();<br><br> * var patternOffsetX = shape.fillPatternOffsetX();
* *
* // set fill pattern offset x<br> * // set fill pattern offset x
* shape.fillPatternOffsetX(20); * shape.fillPatternOffsetX(20);
*/ */
@@ -1076,10 +1076,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill pattern offset y<br> * // get fill pattern offset y
* var patternOffsetY = shape.fillPatternOffsetY();<br><br> * var patternOffsetY = shape.fillPatternOffsetY();
* *
* // set fill pattern offset y<br> * // set fill pattern offset y
* shape.fillPatternOffsetY(10); * shape.fillPatternOffsetY(10);
*/ */
@@ -1095,13 +1095,13 @@
* @param {Number} scale.y * @param {Number} scale.y
* @returns {Object} * @returns {Object}
* @example * @example
* // get fill pattern scale<br> * // get fill pattern scale
* var patternScale = shape.fillPatternScale();<br><br> * var patternScale = shape.fillPatternScale();
* *
* // set fill pattern scale<br> * // set fill pattern scale
* shape.fillPatternScale({<br> * shape.fillPatternScale({
* x: 2<br> * x: 2
* y: 2<br> * y: 2
* }); * });
*/ */
@@ -1115,10 +1115,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill pattern scale x<br> * // get fill pattern scale x
* var patternScaleX = shape.fillPatternScaleX();<br><br> * var patternScaleX = shape.fillPatternScaleX();
* *
* // set fill pattern scale x<br> * // set fill pattern scale x
* shape.fillPatternScaleX(2); * shape.fillPatternScaleX(2);
*/ */
@@ -1131,10 +1131,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill pattern scale y<br> * // get fill pattern scale y
* var patternScaleY = shape.fillPatternScaleY();<br><br> * var patternScaleY = shape.fillPatternScaleY();
* *
* // set fill pattern scale y<br> * // set fill pattern scale y
* shape.fillPatternScaleY(2); * shape.fillPatternScaleY(2);
*/ */
@@ -1150,13 +1150,13 @@
* @param {Number} startPoint.y * @param {Number} startPoint.y
* @returns {Object} * @returns {Object}
* @example * @example
* // get fill linear gradient start point<br> * // get fill linear gradient start point
* var startPoint = shape.fillLinearGradientStartPoint();<br><br> * var startPoint = shape.fillLinearGradientStartPoint();
* *
* // set fill linear gradient start point<br> * // set fill linear gradient start point
* shape.fillLinearGradientStartPoint({<br> * shape.fillLinearGradientStartPoint({
* x: 20<br> * x: 20
* y: 10<br> * y: 10
* }); * });
*/ */
@@ -1169,10 +1169,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill linear gradient start point x<br> * // get fill linear gradient start point x
* var startPointX = shape.fillLinearGradientStartPointX();<br><br> * var startPointX = shape.fillLinearGradientStartPointX();
* *
* // set fill linear gradient start point x<br> * // set fill linear gradient start point x
* shape.fillLinearGradientStartPointX(20); * shape.fillLinearGradientStartPointX(20);
*/ */
@@ -1185,10 +1185,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill linear gradient start point y<br> * // get fill linear gradient start point y
* var startPointY = shape.fillLinearGradientStartPointY();<br><br> * var startPointY = shape.fillLinearGradientStartPointY();
* *
* // set fill linear gradient start point y<br> * // set fill linear gradient start point y
* shape.fillLinearGradientStartPointY(20); * shape.fillLinearGradientStartPointY(20);
*/ */
@@ -1204,13 +1204,13 @@
* @param {Number} endPoint.y * @param {Number} endPoint.y
* @returns {Object} * @returns {Object}
* @example * @example
* // get fill linear gradient end point<br> * // get fill linear gradient end point
* var endPoint = shape.fillLinearGradientEndPoint();<br><br> * var endPoint = shape.fillLinearGradientEndPoint();
* *
* // set fill linear gradient end point<br> * // set fill linear gradient end point
* shape.fillLinearGradientEndPoint({<br> * shape.fillLinearGradientEndPoint({
* x: 20<br> * x: 20
* y: 10<br> * y: 10
* }); * });
*/ */
@@ -1223,10 +1223,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill linear gradient end point x<br> * // get fill linear gradient end point x
* var endPointX = shape.fillLinearGradientEndPointX();<br><br> * var endPointX = shape.fillLinearGradientEndPointX();
* *
* // set fill linear gradient end point x<br> * // set fill linear gradient end point x
* shape.fillLinearGradientEndPointX(20); * shape.fillLinearGradientEndPointX(20);
*/ */
@@ -1239,10 +1239,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill linear gradient end point y<br> * // get fill linear gradient end point y
* var endPointY = shape.fillLinearGradientEndPointY();<br><br> * var endPointY = shape.fillLinearGradientEndPointY();
* *
* // set fill linear gradient end point y<br> * // set fill linear gradient end point y
* shape.fillLinearGradientEndPointY(20); * shape.fillLinearGradientEndPointY(20);
*/ */
@@ -1258,13 +1258,13 @@
* @param {Number} startPoint.y * @param {Number} startPoint.y
* @returns {Object} * @returns {Object}
* @example * @example
* // get fill radial gradient start point<br> * // get fill radial gradient start point
* var startPoint = shape.fillRadialGradientStartPoint();<br><br> * var startPoint = shape.fillRadialGradientStartPoint();
* *
* // set fill radial gradient start point<br> * // set fill radial gradient start point
* shape.fillRadialGradientStartPoint({<br> * shape.fillRadialGradientStartPoint({
* x: 20<br> * x: 20
* y: 10<br> * y: 10
* }); * });
*/ */
@@ -1277,10 +1277,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill radial gradient start point x<br> * // get fill radial gradient start point x
* var startPointX = shape.fillRadialGradientStartPointX();<br><br> * var startPointX = shape.fillRadialGradientStartPointX();
* *
* // set fill radial gradient start point x<br> * // set fill radial gradient start point x
* shape.fillRadialGradientStartPointX(20); * shape.fillRadialGradientStartPointX(20);
*/ */
@@ -1293,10 +1293,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill radial gradient start point y<br> * // get fill radial gradient start point y
* var startPointY = shape.fillRadialGradientStartPointY();<br><br> * var startPointY = shape.fillRadialGradientStartPointY();
* *
* // set fill radial gradient start point y<br> * // set fill radial gradient start point y
* shape.fillRadialGradientStartPointY(20); * shape.fillRadialGradientStartPointY(20);
*/ */
@@ -1312,13 +1312,13 @@
* @param {Number} endPoint.y * @param {Number} endPoint.y
* @returns {Object} * @returns {Object}
* @example * @example
* // get fill radial gradient end point<br> * // get fill radial gradient end point
* var endPoint = shape.fillRadialGradientEndPoint();<br><br> * var endPoint = shape.fillRadialGradientEndPoint();
* *
* // set fill radial gradient end point<br> * // set fill radial gradient end point
* shape.fillRadialGradientEndPoint({<br> * shape.fillRadialGradientEndPoint({
* x: 20<br> * x: 20
* y: 10<br> * y: 10
* }); * });
*/ */
@@ -1331,10 +1331,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill radial gradient end point x<br> * // get fill radial gradient end point x
* var endPointX = shape.fillRadialGradientEndPointX();<br><br> * var endPointX = shape.fillRadialGradientEndPointX();
* *
* // set fill radial gradient end point x<br> * // set fill radial gradient end point x
* shape.fillRadialGradientEndPointX(20); * shape.fillRadialGradientEndPointX(20);
*/ */
@@ -1347,10 +1347,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get fill radial gradient end point y<br> * // get fill radial gradient end point y
* var endPointY = shape.fillRadialGradientEndPointY();<br><br> * var endPointY = shape.fillRadialGradientEndPointY();
* *
* // set fill radial gradient end point y<br> * // set fill radial gradient end point y
* shape.fillRadialGradientEndPointY(20); * shape.fillRadialGradientEndPointY(20);
*/ */
@@ -1364,10 +1364,10 @@
* @param {Number} rotation * @param {Number} rotation
* @returns {Kinetic.Shape} * @returns {Kinetic.Shape}
* @example * @example
* // get fill pattern rotation<br> * // get fill pattern rotation
* var patternRotation = shape.fillPatternRotation();<br><br> * var patternRotation = shape.fillPatternRotation();
* *
* // set fill pattern rotation<br> * // set fill pattern rotation
* shape.fillPatternRotation(20); * shape.fillPatternRotation(20);
*/ */

View File

@@ -705,12 +705,12 @@
* @memberof Kinetic.Stage.prototype * @memberof Kinetic.Stage.prototype
* @returns {DomElement} container * @returns {DomElement} container
* @example * @example
* // get container<br> * // get container
* var container = stage.container();<br><br> * var container = stage.container();
* *
* // set container<br> * // set container
* var container = document.createElement('div');<br> * var container = document.createElement('div');
* body.appendChild(container);<br> * body.appendChild(container);
* stage.container(container); * stage.container(container);
*/ */

View File

@@ -21,17 +21,17 @@
* @memberof Kinetic * @memberof Kinetic
* @example * @example
* // instantiate new tween which fully rotates a node in 1 second * // instantiate new tween which fully rotates a node in 1 second
* var tween = new Kinetic.Tween({<br> * var tween = new Kinetic.Tween({
* node: node,<br> * node: node,
* rotationDeg: 360,<br> * rotationDeg: 360,
* duration: 1,<br> * duration: 1,
* easing: Kinetic.Easings.EaseInOut<br> * easing: Kinetic.Easings.EaseInOut
* });<br><br> * });
* *
* // play tween<br> * // play tween
* tween.play();<br><br> * tween.play();
* *
* // pause tween<br> * // pause tween
* tween.pause(); * tween.pause();
*/ */
Kinetic.Tween = function(config) { Kinetic.Tween = function(config) {

View File

@@ -23,8 +23,8 @@
* @param {Function} func * @param {Function} func
* @example * @example
* // get all nodes with name foo inside layer, and set x to 10 for each * // get all nodes with name foo inside layer, and set x to 10 for each
* layer.get('.foo').each(function(shape, n) {<br> * layer.get('.foo').each(function(shape, n) {
* shape.setX(10);<br> * shape.setX(10);
* }); * });
*/ */
Kinetic.Collection.prototype.each = function(func) { Kinetic.Collection.prototype.each = function(func) {
@@ -539,9 +539,9 @@
* @memberof Kinetic.Util.prototype * @memberof Kinetic.Util.prototype
* @param {String} color * @param {String} color
* @example * @example
* // each of the following examples return {r:0, g:0, b:255}<br> * // each of the following examples return {r:0, g:0, b:255}
* var rgb = Kinetic.Util.getRGB('blue');<br> * var rgb = Kinetic.Util.getRGB('blue');
* var rgb = Kinetic.Util.getRGB('#0000ff');<br> * var rgb = Kinetic.Util.getRGB('#0000ff');
* var rgb = Kinetic.Util.getRGB('rgb(0,0,255)'); * var rgb = Kinetic.Util.getRGB('rgb(0,0,255)');
*/ */
getRGB: function(color) { getRGB: function(color) {

View File

@@ -20,34 +20,34 @@
* @@nodeParams * @@nodeParams
* @example * @example
* // create label * // create label
* var label = new Kinetic.Label({<br> * var label = new Kinetic.Label({
* x: 100,<br> * x: 100,
* y: 100, <br> * y: 100,
* draggable: true<br> * draggable: true
* });<br><br> * });
* *
* // add a tag to the label<br> * // add a tag to the label
* label.add(new Kinetic.Tag({<br> * label.add(new Kinetic.Tag({
* fill: '#bbb',<br> * fill: '#bbb',
* stroke: '#333',<br> * stroke: '#333',
* shadowColor: 'black',<br> * shadowColor: 'black',
* shadowBlur: 10,<br> * shadowBlur: 10,
* shadowOffset: [10, 10],<br> * shadowOffset: [10, 10],
* shadowOpacity: 0.2,<br> * shadowOpacity: 0.2,
* lineJoin: 'round',<br> * lineJoin: 'round',
* pointerDirection: 'up',<br> * pointerDirection: 'up',
* pointerWidth: 20,<br> * pointerWidth: 20,
* pointerHeight: 20,<br> * pointerHeight: 20,
* cornerRadius: 5<br> * cornerRadius: 5
* }));<br><br> * }));
* *
* // add text to the label<br> * // add text to the label
* label.add(new Kinetic.Text({<br> * label.add(new Kinetic.Text({
* text: 'Hello World!',<br> * text: 'Hello World!',
* fontSize: 50,<br> * fontSize: 50,
* lineHeight: 1.2,<br> * lineHeight: 1.2,
* padding: 10,<br> * padding: 10,
* fill: 'green'<br> * fill: 'green'
* })); * }));
*/ */
Kinetic.Label = function(config) { Kinetic.Label = function(config) {

View File

@@ -10,12 +10,12 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* var path = new Kinetic.Path({<br> * var path = new Kinetic.Path({
* x: 240,<br> * x: 240,
* y: 40,<br> * y: 40,
* data: 'M12.582,9.551C3.251,16.237,0.921,29.021,7.08,38.564l-2.36,1.689l4.893,2.262l4.893,2.262l-0.568-5.36l-0.567-5.359l-2.365,1.694c-4.657-7.375-2.83-17.185,4.352-22.33c7.451-5.338,17.817-3.625,23.156,3.824c5.337,7.449,3.625,17.813-3.821,23.152l2.857,3.988c9.617-6.893,11.827-20.277,4.935-29.896C35.591,4.87,22.204,2.658,12.582,9.551z',<br> * data: 'M12.582,9.551C3.251,16.237,0.921,29.021,7.08,38.564l-2.36,1.689l4.893,2.262l4.893,2.262l-0.568-5.36l-0.567-5.359l-2.365,1.694c-4.657-7.375-2.83-17.185,4.352-22.33c7.451-5.338,17.817-3.625,23.156,3.824c5.337,7.449,3.625,17.813-3.821,23.152l2.857,3.988c9.617-6.893,11.827-20.277,4.935-29.896C35.591,4.87,22.204,2.658,12.582,9.551z',
* fill: 'green',<br> * fill: 'green',
* scale: 2<br> * scale: 2
* }); * });
*/ */
Kinetic.Path = function (config) { Kinetic.Path = function (config) {

View File

@@ -10,14 +10,14 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* var hexagon = new Kinetic.RegularPolygon({<br> * var hexagon = new Kinetic.RegularPolygon({
* x: 100,<br> * x: 100,
* y: 200,<br> * y: 200,
* sides: 6,<br> * sides: 6,
* radius: 70,<br> * radius: 70,
* fill: 'red',<br> * fill: 'red',
* stroke: 'black',<br> * stroke: 'black',
* strokeWidth: 4<br> * strokeWidth: 4
* }); * });
*/ */
Kinetic.RegularPolygon = function(config) { Kinetic.RegularPolygon = function(config) {

View File

@@ -11,15 +11,15 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* var star = new Kinetic.Star({<br> * var star = new Kinetic.Star({
* x: 100,<br> * x: 100,
* y: 200,<br> * y: 200,
* numPoints: 5,<br> * numPoints: 5,
* innerRadius: 70,<br> * innerRadius: 70,
* outerRadius: 70,<br> * outerRadius: 70,
* fill: 'red',<br> * fill: 'red',
* stroke: 'black',<br> * stroke: 'black',
* strokeWidth: 4<br> * strokeWidth: 4
* }); * });
*/ */
Kinetic.Star = function(config) { Kinetic.Star = function(config) {

View File

@@ -19,14 +19,14 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* var textpath = new Kinetic.TextPath({<br> * var textpath = new Kinetic.TextPath({
* x: 100,<br> * x: 100,
* y: 50,<br> * y: 50,
* fill: '#333',<br> * fill: '#333',
* fontSize: '24',<br> * fontSize: '24',
* fontFamily: 'Arial',<br> * fontFamily: 'Arial',
* text: 'All the world\'s a stage, and all the men and women merely players.',<br> * text: 'All the world\'s a stage, and all the men and women merely players.',
* data: 'M10,10 C0,0 10,150 100,100 S300,150 400,50'<br> * data: 'M10,10 C0,0 10,150 100,100 S300,150 400,50'
* }); * });
*/ */
Kinetic.TextPath = function(config) { Kinetic.TextPath = function(config) {

View File

@@ -13,15 +13,15 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* // draw a Arc that's pointing downwards<br> * // draw a Arc that's pointing downwards
* var arc = new Kinetic.Arc({<br> * var arc = new Kinetic.Arc({
* innerRadius: 40,<br> * innerRadius: 40,
* outerRadius: 80,<br> * outerRadius: 80,
* fill: 'red',<br> * fill: 'red',
* stroke: 'black'<br> * stroke: 'black'
* strokeWidth: 5,<br> * strokeWidth: 5,
* angle: 60,<br> * angle: 60,
* rotationDeg: -120<br> * rotationDeg: -120
* }); * });
*/ */
Kinetic.Arc = function(config) { Kinetic.Arc = function(config) {
@@ -76,10 +76,10 @@
* @param {Number} outerRadius * @param {Number} outerRadius
* @returns {Number} * @returns {Number}
* @example * @example
* // get outer radius<br> * // get outer radius
* var outerRadius = arc.outerRadius();<br><br> * var outerRadius = arc.outerRadius();
* *
* // set outer radius<br> * // set outer radius
* arc.outerRadius(20); * arc.outerRadius(20);
*/ */
@@ -93,10 +93,10 @@
* @param {Number} angle * @param {Number} angle
* @returns {Number} * @returns {Number}
* @example * @example
* // get angle<br> * // get angle
* var angle = arc.angle();<br><br> * var angle = arc.angle();
* *
* // set angle<br> * // set angle
* arc.angle(20); * arc.angle(20);
*/ */
@@ -110,13 +110,13 @@
* @param {Boolean} clockwise * @param {Boolean} clockwise
* @returns {Boolean} * @returns {Boolean}
* @example * @example
* // get clockwise flag<br> * // get clockwise flag
* var clockwise = arc.clockwise();<br><br> * var clockwise = arc.clockwise();
* *
* // draw arc counter-clockwise<br> * // draw arc counter-clockwise
* arc.clockwise(false);<br><br> * arc.clockwise(false);
* *
* // draw arc clockwise<br> * // draw arc clockwise
* arc.clockwise(true); * arc.clockwise(true);
*/ */

View File

@@ -14,11 +14,11 @@
* @@nodeParams * @@nodeParams
* @example * @example
* // create circle * // create circle
* var circle = new Kinetic.Circle({<br> * var circle = new Kinetic.Circle({
* radius: 40,<br> * radius: 40,
* fill: 'red',<br> * fill: 'red',
* stroke: 'black'<br> * stroke: 'black'
* strokeWidth: 5<br> * strokeWidth: 5
* }); * });
*/ */
Kinetic.Circle = function(config) { Kinetic.Circle = function(config) {
@@ -70,11 +70,11 @@
* @param {Number} radius * @param {Number} radius
* @returns {Number} * @returns {Number}
* @example * @example
* // get radius<br> * // get radius
* var radius = circle.radius();<br><br> * var radius = circle.radius();
* *
* // set radius<br> * // set radius
* circle.radius(10);<br> * circle.radius(10);
*/ */
Kinetic.Collection.mapMethods(Kinetic.Circle); Kinetic.Collection.mapMethods(Kinetic.Circle);

View File

@@ -12,12 +12,12 @@
* @@ShapeParams * @@ShapeParams
* @@NodeParams * @@NodeParams
* @example * @example
* var ellipse = new Kinetic.Ellipse({<br> * var ellipse = new Kinetic.Ellipse({
* radius : {<br> * radius : {
* x : 50,<br> * x : 50,
* y : 50<br> * y : 50
* },<br> * },
* fill: 'red'<br> * fill: 'red'
* }); * });
*/ */
Kinetic.Ellipse = function(config) { Kinetic.Ellipse = function(config) {
@@ -84,13 +84,13 @@
* @param {Number} radius.y * @param {Number} radius.y
* @returns {Object} * @returns {Object}
* @example * @example
* // get radius<br> * // get radius
* var radius = ellipse.radius();<br><br> * var radius = ellipse.radius();
* *
* // set radius<br> * // set radius
* ellipse.radius({<br> * ellipse.radius({
* x: 200,<br> * x: 200,
* y: 100<br> * y: 100
* }); * });
*/ */
@@ -103,10 +103,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get radius x<br> * // get radius x
* var radiusX = ellipse.radiusX();<br><br> * var radiusX = ellipse.radiusX();
* *
* // set radius x<br> * // set radius x
* ellipse.radiusX(200); * ellipse.radiusX(200);
*/ */
@@ -119,10 +119,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get radius y<br> * // get radius y
* var radiusY = ellipse.radiusY();<br><br> * var radiusY = ellipse.radiusY();
* *
* // set radius y<br> * // set radius y
* ellipse.radiusY(200); * ellipse.radiusY(200);
*/ */

View File

@@ -14,16 +14,16 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* var imageObj = new Image();<br> * var imageObj = new Image();
* imageObj.onload = function() {<br> * imageObj.onload = function() {
* var image = new Kinetic.Image({<br> * var image = new Kinetic.Image({
* x: 200,<br> * x: 200,
* y: 50,<br> * y: 50,
* image: imageObj,<br> * image: imageObj,
* width: 100,<br> * width: 100,
* height: 100<br> * height: 100
* });<br> * });
* };<br> * };
* imageObj.src = '/path/to/image.jpg' * imageObj.src = '/path/to/image.jpg'
*/ */
Kinetic.Image = function(config) { Kinetic.Image = function(config) {
@@ -119,15 +119,15 @@
* @param {Number} crop.height * @param {Number} crop.height
* @returns {Object} * @returns {Object}
* @example * @example
* // get crop<br> * // get crop
* var crop = image.crop();<br><br> * var crop = image.crop();
* *
* // set crop<br> * // set crop
* image.crop({<br> * image.crop({
* x: 20,<br> * x: 20,
* y: 20,<br> * y: 20,
* width: 20,<br> * width: 20,
* height: 20<br> * height: 20
* }); * });
*/ */
@@ -140,10 +140,10 @@
* @param {Number} x * @param {Number} x
* @returns {Number} * @returns {Number}
* @example * @example
* // get crop x<br> * // get crop x
* var cropX = image.cropX();<br><br> * var cropX = image.cropX();
* *
* // set crop x<br> * // set crop x
* image.cropX(20); * image.cropX(20);
*/ */
@@ -156,10 +156,10 @@
* @param {Number} y * @param {Number} y
* @returns {Number} * @returns {Number}
* @example * @example
* // get crop y<br> * // get crop y
* var cropY = image.cropY();<br><br> * var cropY = image.cropY();
* *
* // set crop y<br> * // set crop y
* image.cropY(20); * image.cropY(20);
*/ */
@@ -172,10 +172,10 @@
* @param {Number} width * @param {Number} width
* @returns {Number} * @returns {Number}
* @example * @example
* // get crop width<br> * // get crop width
* var cropWidth = image.cropWidth();<br><br> * var cropWidth = image.cropWidth();
* *
* // set crop width<br> * // set crop width
* image.cropWidth(20); * image.cropWidth(20);
*/ */
@@ -188,10 +188,10 @@
* @param {Number} height * @param {Number} height
* @returns {Number} * @returns {Number}
* @example * @example
* // get crop height<br> * // get crop height
* var cropHeight = image.cropHeight();<br><br> * var cropHeight = image.cropHeight();
* *
* // set crop height<br> * // set crop height
* image.cropHeight(20); * image.cropHeight(20);
*/ */

View File

@@ -13,12 +13,12 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* var line = new Kinetic.Line({<br> * var line = new Kinetic.Line({
* x: 100,<br> * x: 100,
* y: 50,<br> * y: 50,
* points: [73, 70, 340, 23, 450, 60, 500, 20],<br> * points: [73, 70, 340, 23, 450, 60, 500, 20],
* stroke: 'red',<br> * stroke: 'red',
* tension: 1<br> * tension: 1
* }); * });
*/ */
Kinetic.Line = function(config) { Kinetic.Line = function(config) {
@@ -151,13 +151,13 @@
* @param {Boolean} closed * @param {Boolean} closed
* @returns {Boolean} * @returns {Boolean}
* @example * @example
* // get closed flag<br> * // get closed flag
* var closed = line.closed();<br><br> * var closed = line.closed();
* *
* // close the shape<br> * // close the shape
* line.closed(true);<br><br> * line.closed(true);
* *
* // open the shape<br> * // open the shape
* line.closed(false); * line.closed(false);
*/ */
@@ -172,10 +172,10 @@
* The default is 0 * The default is 0
* @returns {Number} * @returns {Number}
* @example * @example
* // get tension<br> * // get tension
* var tension = line.tension();<br><br> * var tension = line.tension();
* *
* // set tension<br> * // set tension
* line.tension(3); * line.tension(3);
*/ */
@@ -188,13 +188,13 @@
* @param {Array} points * @param {Array} points
* @returns {Array} * @returns {Array}
* @example * @example
* // get points<br> * // get points
* var points = line.points();<br><br> * var points = line.points();
* *
* // set points<br> * // set points
* line.points([10, 20, 30, 40, 50, 60]);<br><br> * line.points([10, 20, 30, 40, 50, 60]);
* *
* // push a new point<br> * // push a new point
* line.points(line.points().concat([70, 80])); * line.points(line.points().concat([70, 80]));
*/ */

View File

@@ -9,12 +9,12 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* var rect = new Kinetic.Rect({<br> * var rect = new Kinetic.Rect({
* width: 100,<br> * width: 100,
* height: 50,<br> * height: 50,
* fill: 'red',<br> * fill: 'red',
* stroke: 'black',<br> * stroke: 'black',
* strokeWidth: 5<br> * strokeWidth: 5
* }); * });
*/ */
Kinetic.Rect = function(config) { Kinetic.Rect = function(config) {
@@ -67,10 +67,10 @@
* @param {Number} cornerRadius * @param {Number} cornerRadius
* @returns {Number} * @returns {Number}
* @example * @example
* // get corner radius<br> * // get corner radius
* var cornerRadius = rect.cornerRadius();<br><br> * var cornerRadius = rect.cornerRadius();
* *
* // set corner radius<br> * // set corner radius
* rect.cornerRadius(10); * rect.cornerRadius(10);
*/ */

View File

@@ -13,12 +13,12 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* var ring = new Kinetic.Ring({<br> * var ring = new Kinetic.Ring({
* innerRadius: 40,<br> * innerRadius: 40,
* outerRadius: 80,<br> * outerRadius: 80,
* fill: 'red',<br> * fill: 'red',
* stroke: 'black',<br> * stroke: 'black',
* strokeWidth: 5<br> * strokeWidth: 5
* }); * });
*/ */
Kinetic.Ring = function(config) { Kinetic.Ring = function(config) {
@@ -72,10 +72,10 @@
* @param {Number} innerRadius * @param {Number} innerRadius
* @returns {Number} * @returns {Number}
* @example * @example
* // get inner radius<br> * // get inner radius
* var innerRadius = ring.innerRadius();<br><br> * var innerRadius = ring.innerRadius();
* *
* // set inner radius<br> * // set inner radius
* ring.innerRadius(20); * ring.innerRadius(20);
*/ */
@@ -89,10 +89,10 @@
* @param {Number} outerRadius * @param {Number} outerRadius
* @returns {Number} * @returns {Number}
* @example * @example
* // get outer radius<br> * // get outer radius
* var outerRadius = ring.outerRadius();<br><br> * var outerRadius = ring.outerRadius();
* *
* // set outer radius<br> * // set outer radius
* ring.outerRadius(20); * ring.outerRadius(20);
*/ */

View File

@@ -12,37 +12,37 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* var imageObj = new Image();<br> * var imageObj = new Image();
* imageObj.onload = function() {<br> * imageObj.onload = function() {
* var sprite = new Kinetic.Sprite({<br> * var sprite = new Kinetic.Sprite({
* x: 200,<br> * x: 200,
* y: 100,<br> * y: 100,
* image: imageObj,<br> * image: imageObj,
* animation: 'standing',<br> * animation: 'standing',
* animations: {<br> * animations: {
* standing: [<br> * standing: [
* // x, y, width, height (6 frames)<br> * // x, y, width, height (6 frames)
* 0, 0, 49, 109,<br> * 0, 0, 49, 109,
* 52, 0, 49, 109,<br> * 52, 0, 49, 109,
* 105, 0, 49, 109,<br> * 105, 0, 49, 109,
* 158, 0, 49, 109,<br> * 158, 0, 49, 109,
* 210, 0, 49, 109,<br> * 210, 0, 49, 109,
* 262, 0, 49, 109<br> * 262, 0, 49, 109
* ],<br> * ],
* kicking: [<br> * kicking: [
* // x, y, width, height (6 frames)<br> * // x, y, width, height (6 frames)
* 0, 109, 45, 98,<br> * 0, 109, 45, 98,
* 45, 109, 45, 98,<br> * 45, 109, 45, 98,
* 95, 109, 63, 98,<br> * 95, 109, 63, 98,
* 156, 109, 70, 98,<br> * 156, 109, 70, 98,
* 229, 109, 60, 98,<br> * 229, 109, 60, 98,
* 287, 109, 41, 98<br> * 287, 109, 41, 98
* ]<br> * ]
* },<br> * },
* frameRate: 7,<br> * frameRate: 7,
* frameIndex: 0<br> * frameIndex: 0
* });<br> * });
* };<br> * };
* imageObj.src = '/path/to/image.jpg' * imageObj.src = '/path/to/image.jpg'
*/ */
Kinetic.Sprite = function(config) { Kinetic.Sprite = function(config) {
@@ -173,10 +173,10 @@
* @param {String} anim animation key * @param {String} anim animation key
* @returns {String} * @returns {String}
* @example * @example
* // get animation key<br> * // get animation key
* var animation = sprite.animation();<br><br> * var animation = sprite.animation();
* *
* // set animation key<br> * // set animation key
* sprite.animation('kicking'); * sprite.animation('kicking');
*/ */
@@ -190,29 +190,29 @@
* @param {Object} animations * @param {Object} animations
* @returns {Object} * @returns {Object}
* @example * @example
* // get animations map<br> * // get animations map
* var animations = sprite.animations();<br><br> * var animations = sprite.animations();
* *
* // set animations map<br> * // set animations map
* sprite.animations({<br> * sprite.animations({
* standing: [<br> * standing: [
* // x, y, width, height (6 frames)<br> * // x, y, width, height (6 frames)
* 0, 0, 49, 109,<br> * 0, 0, 49, 109,
* 52, 0, 49, 109,<br> * 52, 0, 49, 109,
* 105, 0, 49, 109,<br> * 105, 0, 49, 109,
* 158, 0, 49, 109,<br> * 158, 0, 49, 109,
* 210, 0, 49, 109,<br> * 210, 0, 49, 109,
* 262, 0, 49, 109<br> * 262, 0, 49, 109
* ],<br> * ],
* kicking: [<br> * kicking: [
* // x, y, width, height (6 frames)<br> * // x, y, width, height (6 frames)
* 0, 109, 45, 98,<br> * 0, 109, 45, 98,
* 45, 109, 45, 98,<br> * 45, 109, 45, 98,
* 95, 109, 63, 98,<br> * 95, 109, 63, 98,
* 156, 109, 70, 98,<br> * 156, 109, 70, 98,
* 229, 109, 60, 98,<br> * 229, 109, 60, 98,
* 287, 109, 41, 98<br> * 287, 109, 41, 98
* ]<br> * ]
* }); * });
*/ */
@@ -227,9 +227,9 @@
* @returns {Image} * @returns {Image}
* @example * @example
* // get image * // get image
* var image = sprite.image();<br><br> * var image = sprite.image();
* *
* // set image<br> * // set image
* sprite.image(imageObj); * sprite.image(imageObj);
*/ */
@@ -243,10 +243,10 @@
* @param {Integer} frameIndex * @param {Integer} frameIndex
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get animation frame index<br> * // get animation frame index
* var frameIndex = sprite.frameIndex();<br><br> * var frameIndex = sprite.frameIndex();
* *
* // set animation frame index<br> * // set animation frame index
* sprite.frameIndex(3); * sprite.frameIndex(3);
*/ */
@@ -262,10 +262,10 @@
* @param {Integer} frameRate * @param {Integer} frameRate
* @returns {Integer} * @returns {Integer}
* @example * @example
* // get frame rate<br> * // get frame rate
* var frameRate = sprite.frameRate();<br><br> * var frameRate = sprite.frameRate();
* *
* // set frame rate to 2 frames per second<br> * // set frame rate to 2 frames per second
* sprite.frameRate(2); * sprite.frameRate(2);
*/ */

View File

@@ -44,13 +44,13 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* var text = new Kinetic.Text({<br> * var text = new Kinetic.Text({
* x: 10,<br> * x: 10,
* y: 15,<br> * y: 15,
* text: 'Simple Text',<br> * text: 'Simple Text',
* fontSize: 30,<br> * fontSize: 30,
* fontFamily: 'Calibri',<br> * fontFamily: 'Calibri',
* fill: 'green'<br> * fill: 'green'
* }); * });
*/ */
Kinetic.Text = function(config) { Kinetic.Text = function(config) {
@@ -324,10 +324,10 @@
* @param {String} fontFamily * @param {String} fontFamily
* @returns {String} * @returns {String}
* @example * @example
* // get font family<br> * // get font family
* var fontFamily = text.fontFamily();<br><br><br> * var fontFamily = text.fontFamily();
* *
* // set font family<br> * // set font family
* text.fontFamily('Arial'); * text.fontFamily('Arial');
*/ */
@@ -341,10 +341,10 @@
* @param {Number} fontSize * @param {Number} fontSize
* @returns {Number} * @returns {Number}
* @example * @example
* // get font size<br> * // get font size
* var fontSize = text.fontSize();<br><br> * var fontSize = text.fontSize();
* *
* // set font size to 22px<br> * // set font size to 22px
* text.fontSize(22); * text.fontSize(22);
*/ */
@@ -358,10 +358,10 @@
* @param {String} fontStyle * @param {String} fontStyle
* @returns {String} * @returns {String}
* @example * @example
* // get font style<br> * // get font style
* var fontStyle = text.fontStyle();<br><br> * var fontStyle = text.fontStyle();
* *
* // set font style<br> * // set font style
* text.fontStyle('bold'); * text.fontStyle('bold');
*/ */
@@ -375,10 +375,10 @@
* @param {String} fontVariant * @param {String} fontVariant
* @returns {String} * @returns {String}
* @example * @example
* // get font variant<br> * // get font variant
* var fontVariant = text.fontVariant();<br><br> * var fontVariant = text.fontVariant();
* *
* // set font variant<br> * // set font variant
* text.fontVariant('small-caps'); * text.fontVariant('small-caps');
*/ */
@@ -392,10 +392,10 @@
* @param {Number} padding * @param {Number} padding
* @returns {Number} * @returns {Number}
* @example * @example
* // get padding<br> * // get padding
* var padding = text.padding();<br><br> * var padding = text.padding();
* *
* // set padding to 10 pixels<br> * // set padding to 10 pixels
* text.padding(10); * text.padding(10);
*/ */
@@ -409,13 +409,13 @@
* @param {String} align * @param {String} align
* @returns {String} * @returns {String}
* @example * @example
* // get text align<br> * // get text align
* var align = text.align();<br><br> * var align = text.align();
* *
* // center text<br> * // center text
* text.align('center');<br><br> * text.align('center');
* *
* // align text to right<br> * // align text to right
* text.align('right'); * text.align('right');
*/ */
@@ -429,10 +429,10 @@
* @param {Number} lineHeight * @param {Number} lineHeight
* @returns {Number} * @returns {Number}
* @example * @example
* // get line height<br> * // get line height
* var lineHeight = text.lineHeight();<br><br><br> * var lineHeight = text.lineHeight();
* *
* // set the line height<br> * // set the line height
* text.lineHeight(2); * text.lineHeight(2);
*/ */
@@ -446,10 +446,10 @@
* @param {String} wrap * @param {String} wrap
* @returns {String} * @returns {String}
* @example * @example
* // get wrap<br> * // get wrap
* var wrap = text.wrap();<br><br> * var wrap = text.wrap();
* *
* // set wrap<br> * // set wrap
* text.wrap('word'); * text.wrap('word');
*/ */
@@ -464,10 +464,10 @@
* @param {String} text * @param {String} text
* @returns {String} * @returns {String}
* @example * @example
* // get text<br> * // get text
* var text = text.text();<br><br> * var text = text.text();
* *
* // set text<br> * // set text
* text.text('Hello world!'); * text.text('Hello world!');
*/ */

View File

@@ -10,14 +10,14 @@
* @@shapeParams * @@shapeParams
* @@nodeParams * @@nodeParams
* @example * @example
* // draw a wedge that's pointing downwards<br> * // draw a wedge that's pointing downwards
* var wedge = new Kinetic.Wedge({<br> * var wedge = new Kinetic.Wedge({
* radius: 40,<br> * radius: 40,
* fill: 'red',<br> * fill: 'red',
* stroke: 'black'<br> * stroke: 'black'
* strokeWidth: 5,<br> * strokeWidth: 5,
* angleDeg: 60,<br> * angleDeg: 60,
* rotationDeg: -120<br> * rotationDeg: -120
* }); * });
*/ */
Kinetic.Wedge = function(config) { Kinetic.Wedge = function(config) {
@@ -52,11 +52,11 @@
* @param {Number} radius * @param {Number} radius
* @returns {Number} * @returns {Number}
* @example * @example
* // get radius<br> * // get radius
* var radius = wedge.radius();<br><br> * var radius = wedge.radius();
* *
* // set radius<br> * // set radius
* wedge.radius(10);<br> * wedge.radius(10);
*/ */
Kinetic.Factory.addGetterSetter(Kinetic.Wedge, 'angle', 0); Kinetic.Factory.addGetterSetter(Kinetic.Wedge, 'angle', 0);
@@ -69,10 +69,10 @@
* @param {Number} angle * @param {Number} angle
* @returns {Number} * @returns {Number}
* @example * @example
* // get angle<br> * // get angle
* var angle = wedge.angle();<br><br> * var angle = wedge.angle();
* *
* // set angle<br> * // set angle
* wedge.angle(20); * wedge.angle(20);
*/ */
@@ -86,13 +86,13 @@
* @param {Number} clockwise * @param {Number} clockwise
* @returns {Number} * @returns {Number}
* @example * @example
* // get clockwise flag<br> * // get clockwise flag
* var clockwise = wedge.clockwise();<br><br> * var clockwise = wedge.clockwise();
* *
* // draw wedge counter-clockwise<br> * // draw wedge counter-clockwise
* wedge.clockwise(false);<br><br> * wedge.clockwise(false);
* *
* // draw wedge clockwise<br> * // draw wedge clockwise
* wedge.clockwise(true); * wedge.clockwise(true);
*/ */