mirror of
https://github.com/konvajs/konva.git
synced 2025-12-29 18:34:36 +08:00
updated more overloaded docs
This commit is contained in:
105
src/Container.js
105
src/Container.js
@@ -307,16 +307,23 @@
|
||||
|
||||
// add getters setters
|
||||
Kinetic.Factory.addBoxGetterSetter(Kinetic.Container, 'clip');
|
||||
|
||||
/**
|
||||
* set clip
|
||||
* get/set clip
|
||||
* @method
|
||||
* @name setClip
|
||||
* @name clip
|
||||
* @memberof Kinetic.Container.prototype
|
||||
* @param {Object} clip {x:x, y:y, width:width, height:height}
|
||||
* @param {Object} clip
|
||||
* @param {Number} clip.x
|
||||
* @param {Number} clip.y
|
||||
* @param {Number} clip.width
|
||||
* @param {Number} clip.height
|
||||
* @returns {Object}
|
||||
* @example
|
||||
* // set clip x, y, width and height<br>
|
||||
* image.setClip({<br>
|
||||
* // get clip<br>
|
||||
* var clip = container.clip();<br><br>
|
||||
*
|
||||
* // set clip<br>
|
||||
* container.setClip({<br>
|
||||
* x: 20,<br>
|
||||
* y: 20,<br>
|
||||
* width: 20,<br>
|
||||
@@ -325,78 +332,62 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* get clip
|
||||
* @name getClip
|
||||
* get/set clip x
|
||||
* @name clipX
|
||||
* @method
|
||||
* @memberof Kinetic.Container.prototype
|
||||
* @returns {Object}
|
||||
*/
|
||||
|
||||
Kinetic.Factory.addGetterSetter(Kinetic.Container, 'clipX', 0);
|
||||
/**
|
||||
* set clip x
|
||||
* @method
|
||||
* @name setClipX
|
||||
* @memberof Kinetic.Container.prototype
|
||||
* @param {Number} x
|
||||
* @returns {Number}
|
||||
* @example
|
||||
* // get clip x<br>
|
||||
* var clipX = container.clipX();<br><br>
|
||||
*
|
||||
* // set clip x<br>
|
||||
* container.clipX(10);
|
||||
*/
|
||||
|
||||
/**
|
||||
* get clip x
|
||||
* @name getClipX
|
||||
* @method
|
||||
* @memberof Kinetic.Container.prototype
|
||||
* @returns {Number}
|
||||
*/
|
||||
|
||||
Kinetic.Factory.addGetterSetter(Kinetic.Container, 'clipY', 0);
|
||||
/**
|
||||
* set clip y
|
||||
* @name setClipY
|
||||
* get/set clip y
|
||||
* @name clipY
|
||||
* @method
|
||||
* @memberof Kinetic.Container.prototype
|
||||
* @param {Number} y
|
||||
* @returns {Number}
|
||||
* @example
|
||||
* // get clip y<br>
|
||||
* var clipY = container.clipY();<br><br>
|
||||
*
|
||||
* // set clip y<br>
|
||||
* container.clipY(10);
|
||||
*/
|
||||
|
||||
/**
|
||||
* get clip y
|
||||
* @name getClipY
|
||||
* @method
|
||||
* @memberof Kinetic.Container.prototype
|
||||
* @returns {Number}
|
||||
*/
|
||||
|
||||
Kinetic.Factory.addGetterSetter(Kinetic.Container, 'clipWidth', 0);
|
||||
/**
|
||||
* set clip width
|
||||
* @name setClipWidth
|
||||
* get/set clip width
|
||||
* @name clipWidth
|
||||
* @method
|
||||
* @memberof Kinetic.Container.prototype
|
||||
* @param {Number} width
|
||||
* @returns {Number}
|
||||
* @example
|
||||
* // get clip width<br>
|
||||
* var clipWidth = container.clipWidth();<br><br>
|
||||
*
|
||||
* // set clip width<br>
|
||||
* container.clipWidth(100);
|
||||
*/
|
||||
|
||||
/**
|
||||
* get clip width
|
||||
* @name getClipWidth
|
||||
* @method
|
||||
* @memberof Kinetic.Container.prototype
|
||||
* @returns {Number}
|
||||
*/
|
||||
|
||||
Kinetic.Factory.addGetterSetter(Kinetic.Container, 'clipHeight', 0);
|
||||
/**
|
||||
* set clip height
|
||||
* @name setClipHeight
|
||||
* get/set clip height
|
||||
* @name clipHeight
|
||||
* @method
|
||||
* @memberof Kinetic.Container.prototype
|
||||
* @param {Number} height
|
||||
*/
|
||||
|
||||
/**
|
||||
* get clip height
|
||||
* @name getClipHeight
|
||||
* @method
|
||||
* @memberof Kinetic.Container.prototype
|
||||
* @returns {Number}
|
||||
* @example
|
||||
* // get clip height<br>
|
||||
* var clipHeight = container.clipHeight();<br><br>
|
||||
*
|
||||
* // set clip height<br>
|
||||
* container.clipHeight(100);
|
||||
*/
|
||||
})();
|
||||
|
||||
47
src/Layer.js
47
src/Layer.js
@@ -293,43 +293,44 @@
|
||||
|
||||
// add getters and setters
|
||||
Kinetic.Factory.addGetterSetter(Kinetic.Layer, 'clearBeforeDraw', true);
|
||||
|
||||
/**
|
||||
* set flag which determines if the layer is cleared or not
|
||||
* get/set clearBeforeDraw flag which determines if the layer is cleared or not
|
||||
* before drawing
|
||||
* @name setClearBeforeDraw
|
||||
* @name clearBeforeDraw
|
||||
* @method
|
||||
* @memberof Kinetic.Layer.prototype
|
||||
* @param {Boolean} clearBeforeDraw
|
||||
* @returns {Node}
|
||||
*/
|
||||
|
||||
/**
|
||||
* get flag which determines if the layer is cleared or not
|
||||
* before drawing
|
||||
* @name getClearBeforeDraw
|
||||
* @method
|
||||
* @memberof Kinetic.Layer.prototype
|
||||
* @returns {Boolean}
|
||||
* @example
|
||||
* // get clearBeforeDraw flag<br>
|
||||
* var clearBeforeDraw = layer.clearBeforeDraw();<br><br>
|
||||
*
|
||||
* // disable clear before draw<br>
|
||||
* layer.clearBeforeDraw(false);<br><br>
|
||||
*
|
||||
* // enable clear before draw<br>
|
||||
* layer.clearBeforeDraw(true);
|
||||
*/
|
||||
|
||||
Kinetic.Factory.addGetterSetter(Kinetic.Layer, 'hitGraphEnabled', true);
|
||||
|
||||
/**
|
||||
* enable/disable hit graph
|
||||
* @name setHitGraphEnabled
|
||||
* get/set hitGraphEnabled flag. Disabling the hit graph will greatly increase
|
||||
* draw performance because the hit graph will not be redrawn each time the layer is
|
||||
* drawn. This, however, also disables mouse/touch event detection
|
||||
* @name hitGraphEnabled
|
||||
* @method
|
||||
* @memberof Kinetic.Layer.prototype
|
||||
* @param {Boolean} enabled
|
||||
* @returns {Node}
|
||||
*/
|
||||
|
||||
/**
|
||||
* determine if hit graph is enabled
|
||||
* @name getHitGraphEnabled
|
||||
* @method
|
||||
* @memberof Kinetic.Layer.prototype
|
||||
* @returns {Boolean}
|
||||
* @example
|
||||
* // get hitGraphEnabled flag<br>
|
||||
* var hitGraphEnabled = layer.hitGraphEnabled();<br><br>
|
||||
*
|
||||
* // disable hit graph<br>
|
||||
* layer.hitGraphEnabled(false);<br><br>
|
||||
*
|
||||
* // enable hit graph<br>
|
||||
* layer.hitGraphEnabled(true);
|
||||
*/
|
||||
|
||||
Kinetic.Layer.prototype.isHitGraphEnabled = Kinetic.Layer.prototype.getHitGraphEnabled;
|
||||
|
||||
@@ -649,12 +649,17 @@
|
||||
|
||||
// add getters and setters
|
||||
Kinetic.Factory.addGetter(Kinetic.Stage, 'container');
|
||||
Kinetic.Factory.addOverloadedGetterSetter(Kinetic.Stage, 'container');
|
||||
|
||||
/**
|
||||
* get container DOM element
|
||||
* @name getContainer
|
||||
* @name container
|
||||
* @method
|
||||
* @memberof Kinetic.Stage.prototype
|
||||
* @returns {DomElement} container
|
||||
* @example
|
||||
* // get container<br>
|
||||
* var container = stage.container();
|
||||
*/
|
||||
|
||||
})();
|
||||
|
||||
Reference in New Issue
Block a user