1
0
mirror of https://github.com/konvajs/konva.git synced 2025-04-24 19:03:56 +08:00

docs update

This commit is contained in:
Anton Lavrenov 2020-06-09 15:45:28 -05:00
parent 33ac099ce9
commit bafe7d3b20

View File

@ -220,7 +220,7 @@ function getSnap(snaps: Array<number>, newRotationRad: number, tol: number) {
* *
* @example * @example
* var transformer = new Konva.Transformer({ * var transformer = new Konva.Transformer({
* node: rectangle, * nodes: [rectangle],
* rotateAnchorOffset: 60, * rotateAnchorOffset: 60,
* enabledAnchors: ['top-left', 'top-right', 'bottom-left', 'bottom-right'] * enabledAnchors: ['top-left', 'top-right', 'bottom-left', 'bottom-right']
* }); * });
@ -1531,26 +1531,13 @@ Factory.addGetterSetter(Transformer, 'ignoreStroke', false);
*/ */
Factory.addGetterSetter(Transformer, 'padding', 0, getNumberValidator()); Factory.addGetterSetter(Transformer, 'padding', 0, getNumberValidator());
/** // TODO: that property is deprecated
* get/set attached node of the Transformer. Transformer will adapt to its size and listen to its events.
* **This method is deprecated and will be removed soon.** Please use `tr.nodes([shape1, shape2]);` instead
* @method
* @name Konva.Transformer#Konva.Transformer#node
* @returns {Konva.Node}
* @example
* // get
* const node = transformer.node();
*
* // set
* transformer.node(shape);
*/
Factory.addGetterSetter(Transformer, 'node'); Factory.addGetterSetter(Transformer, 'node');
/** /**
* get/set attached nodes of the Transformer. Transformer will adapt to their size and listen to their events * get/set attached nodes of the Transformer. Transformer will adapt to their size and listen to their events
* @method * @method
* @name Konva.Transformer#Konva.Transformer#node * @name Konva.Transformer#nodes
* @returns {Konva.Node} * @returns {Konva.Node}
* @example * @example
* // get * // get
@ -1558,10 +1545,11 @@ Factory.addGetterSetter(Transformer, 'node');
* *
* // set * // set
* transformer.nodes([rect, circle]); * transformer.nodes([rect, circle]);
* // push new item:
* *
* // push new item:
* const oldNodes = transformer.nodes(); * const oldNodes = transformer.nodes();
* const newNodes = oldNodes.concat([newShape]); * const newNodes = oldNodes.concat([newShape]);
* // it is important to set new array instance (and concat method above will create it)
* transformer.nodes(newNodes); * transformer.nodes(newNodes);
*/ */