mirror of
https://github.com/konvajs/konva.git
synced 2026-01-09 11:34:38 +08:00
fix doc
This commit is contained in:
@@ -1,27 +1,28 @@
|
||||
(function(Konva) {
|
||||
'use strict';
|
||||
/**
|
||||
* Arrow constructor
|
||||
* @constructor
|
||||
* @memberof Konva
|
||||
* @augments Konva.Shape
|
||||
* @param {Object} config
|
||||
* @param {Array} config.points
|
||||
* @param {Number} [config.tension] Higher values will result in a more curvy line. A value of 0 will result in no interpolation.
|
||||
* The default is 0
|
||||
* @param {Number} config.pointerLength
|
||||
* @param {Number} config.pointerWidth
|
||||
* @@shapeParams
|
||||
* @@nodeParams
|
||||
* @example
|
||||
* var line = new Konva.Line({
|
||||
* points: [73, 70, 340, 23, 450, 60, 500, 20],
|
||||
* stroke: 'red',
|
||||
* tension: 1,
|
||||
* pointerLength : 10,
|
||||
* pointerWidth : 12
|
||||
* });
|
||||
*/
|
||||
* Arrow constructor
|
||||
* @constructor
|
||||
* @memberof Konva
|
||||
* @augments Konva.Shape
|
||||
* @param {Object} config
|
||||
* @param {Array} config.points
|
||||
* @param {Number} [config.tension] Higher values will result in a more curvy line. A value of 0 will result in no interpolation.
|
||||
* The default is 0
|
||||
* @param {Number} config.pointerLength
|
||||
* @param {Number} config.pointerWidth
|
||||
* @param {Boolean} config.pointerAtBeginning Do we need to draw pointer on both sides?. Default false.
|
||||
* @@shapeParams
|
||||
* @@nodeParams
|
||||
* @example
|
||||
* var line = new Konva.Line({
|
||||
* points: [73, 70, 340, 23, 450, 60, 500, 20],
|
||||
* stroke: 'red',
|
||||
* tension: 1,
|
||||
* pointerLength : 10,
|
||||
* pointerWidth : 12
|
||||
* });
|
||||
*/
|
||||
Konva.Arrow = function(config) {
|
||||
this.____init(config);
|
||||
};
|
||||
@@ -71,54 +72,54 @@
|
||||
|
||||
Konva.Util.extend(Konva.Arrow, Konva.Line);
|
||||
/**
|
||||
* get/set pointerLength
|
||||
* @name pointerLength
|
||||
* @method
|
||||
* @memberof Konva.Arrow.prototype
|
||||
* @param {Number} Length of pointer of arrow.
|
||||
* The default is 10.
|
||||
* @returns {Number}
|
||||
* @example
|
||||
* // get tension
|
||||
* var pointerLength = line.pointerLength();
|
||||
*
|
||||
* // set tension
|
||||
* line.pointerLength(15);
|
||||
*/
|
||||
* get/set pointerLength
|
||||
* @name pointerLength
|
||||
* @method
|
||||
* @memberof Konva.Arrow.prototype
|
||||
* @param {Number} Length of pointer of arrow.
|
||||
* The default is 10.
|
||||
* @returns {Number}
|
||||
* @example
|
||||
* // get tension
|
||||
* var pointerLength = line.pointerLength();
|
||||
*
|
||||
* // set tension
|
||||
* line.pointerLength(15);
|
||||
*/
|
||||
|
||||
Konva.Factory.addGetterSetter(Konva.Arrow, 'pointerLength', 10);
|
||||
/**
|
||||
* get/set pointerWidth
|
||||
* @name pointerWidth
|
||||
* @method
|
||||
* @memberof Konva.Arrow.prototype
|
||||
* @param {Number} Width of pointer of arrow.
|
||||
* The default is 10.
|
||||
* @returns {Number}
|
||||
* @example
|
||||
* // get tension
|
||||
* var pointerWidth = line.pointerWidth();
|
||||
*
|
||||
* // set tension
|
||||
* line.pointerWidth(15);
|
||||
*/
|
||||
* get/set pointerWidth
|
||||
* @name pointerWidth
|
||||
* @method
|
||||
* @memberof Konva.Arrow.prototype
|
||||
* @param {Number} Width of pointer of arrow.
|
||||
* The default is 10.
|
||||
* @returns {Number}
|
||||
* @example
|
||||
* // get tension
|
||||
* var pointerWidth = line.pointerWidth();
|
||||
*
|
||||
* // set tension
|
||||
* line.pointerWidth(15);
|
||||
*/
|
||||
|
||||
Konva.Factory.addGetterSetter(Konva.Arrow, 'pointerWidth', 10);
|
||||
/**
|
||||
* get/set pointerAtBeginning
|
||||
* @name pointerAtBeginning
|
||||
* @method
|
||||
* @memberof Konva.Arrow.prototype
|
||||
* @param {Number} Should pointer displayed at beginning of arrow.
|
||||
* The default is false.
|
||||
* @returns {Boolean}
|
||||
* @example
|
||||
* // get tension
|
||||
* var pointerAtBeginning = line.pointerAtBeginning();
|
||||
*
|
||||
* // set tension
|
||||
* line.pointerAtBeginning(true);
|
||||
*/
|
||||
* get/set pointerAtBeginning
|
||||
* @name pointerAtBeginning
|
||||
* @method
|
||||
* @memberof Konva.Arrow.prototype
|
||||
* @param {Number} Should pointer displayed at beginning of arrow.
|
||||
* The default is false.
|
||||
* @returns {Boolean}
|
||||
* @example
|
||||
* // get tension
|
||||
* var pointerAtBeginning = line.pointerAtBeginning();
|
||||
*
|
||||
* // set tension
|
||||
* line.pointerAtBeginning(true);
|
||||
*/
|
||||
|
||||
Konva.Factory.addGetterSetter(Konva.Arrow, 'pointerAtBeginning', false);
|
||||
Konva.Collection.mapMethods(Konva.Arrow);
|
||||
|
||||
Reference in New Issue
Block a user