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