Class ResizingTool

You do not normally need to create an instance of this tool because one already exists as the ToolManager.resizingTool, which you can modify.

The Tool.name of this tool is "Resizing".

Gets or sets the GraphObject that is being resized. This may be the same object as the selected Part or it may be contained within that Part.

This property is also settable, but should only be set when overriding functions in ResizingTool, and not during normal operation.

Gets or sets the width and height multiples with which the user must resize. The effective cell size is computed by first looking at the Adornment.adornedPart's Part.resizeCellSize. If either or both of its width and height are NaN, it will use this property, cellSize. If either or both of this property's width and height are NaN, it will consider the Diagram.grid's Panel.gridCellSize.

The default value is go.Size(NaN, NaN). Setting this property does not raise any events.

Gets or sets whether the ResizingTool moves the member Parts of a Group that has no Group.placeholder. By default this property is true. Setting this property does not raise any events.

Returns the GraphObject that is the tool handle being dragged by the user. This will be contained by an Adornment whose category is "ResizingTool". Its Adornment.adornedObject is the same as the adornedObject. This is normally set by doActivate, remembering the result of the call to Tool.findToolHandleAt.

This property is also settable, but should only be set either within an override of doActivate or prior to calling doActivate.

Gets or sets a small GraphObject that is copied as a resizing handle for the selected part. By default this is a Shape that is a small blue rectangle. Setting this property does not raise any events.

Here is an example of changing the default handle to be larger yellow circles:

  myDiagram.toolManager.resizingTool.handleArchetype =
    $(go.Shape, "Circle",
      { width: 10, height: 10, fill: "yellow" });
Copy

This property is ignored when a custom resizing Adornment is specified as the Part.resizeAdornmentTemplate. That property is normally null, in which case this tool will automatically construct Adornments holding eight copies of this handle archetype, each with a GraphObject.alignment being one of the standard eight Spots.

Gets or sets whether the ResizingTool snaps object sizes to the diagram's background grid during the resize. By default this property is false. Setting this property does not raise any events.

Gets or sets the maximum size to which the user can resize. The effective maximum size is the minimum of this value and the GraphObject.maxSize, independently in each direction.

The default value is go.Size(9999, 9999). Any new value must be of type Size; NaN width or height values are treated as Infinity. Setting this property does not raise any events.

Gets or sets the minimum size to which the user can resize. The effective minimum size is the maximum of this value and the GraphObject.minSize, independently in each direction.

The default value is go.Size(1, 1). Any new value must be of type Size; NaN width or height values are treated as zero. Setting this property does not raise any events.

Gets or sets the Point opposite to the chosen, dragged handle of the "Resizing" Adornment. This property has no meaning until after doActivate has been called.

This read-only property returns the Size that was the original value of the GraphObject.desiredSize of the element that is being resized.

This read-only property returns the Point that was the original value of the Part.location of the Part that is being resized.

This tool may run when there is a mouse-down event on a resize handle, the diagram is not read-only and it allows resizing, the left mouse button is being used, and this tool's adornment's resize handle is at the current mouse point.

This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

The size should be a multiple of the value returned by this method.

This is called once when the tool is activated.

This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

The effective maximum resizing size is the minimum of the maxSize and the adornedObject's GraphObject.maxSize.

This is called once when the tool is activated.

This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

The effective minimum resizing size is the maximum of minSize and the adornedObject's GraphObject.minSize.

This is called once when the tool is activated.

This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

Decide whether to allow arbitrary reshaping or whether to keep the same aspect ratio of the object being resized. If the adornedObject is a Shape, then if the Shape.geometryStretch is GeometryStretch.Uniform, this method will return false to restrict reshaping to maintain the object's current ratio of height to width. Also, if the user is holding down the Shift key, this method will return false.

This is called on each mouse-move and on mouse-up; the result is passed to the call to resize. This permits the user to change the behavior dynamically during resizing.

This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

For example, to always keep the object's original aspect ratio, override this method to return false. When initializing a Diagram:

const diagram = new go.Diagram, "myDiagramDiv"
  {
    "resizingTool.computeReshape": function() { return false; },
    // ... rest of Diagram init
  })
Copy

Or when overriding the method dynamically:

  myDiagram.toolManager.resizingTool.computeReshape = function() { return false; }
Copy

Your override might want to look at the this.adornedObject.part.data properties to decide whether to allow reshaping.

Given a Spot in the original bounds of the object being resized and a new Point, compute the new Rect.

This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

Find the handle, remember the object's original bounds, save the results of calling computeMinSize, computeMaxSize, and computeCellSize, capture the mouse, and start a transaction.

Normally when this method is called the value of handle will be null, resulting in a call to Tool.findToolHandleAt to find a "Resizing" tool handle, which is then remembered as the value of handle. If when this method is called the value of handle is already set, then there is no need to call Tool.findToolHandleAt, because the programmer has already set up which resize handle they want the user to be resizing.

Restore the original size of the GraphObject.

Stop the current transaction, forget the handle and adornedObject, and release the mouse.

Call resize with a new size determined by the current mouse point. This determines the new bounds by calling computeResize.

When this calls computeResize it passes as the reshape argument the result of calling computeReshape. The min, max, and cell arguments will be the saved results of doActivate's calls to computeMinSize, computeMaxSize, and computeCellSize.

Call resize with the final bounds based on the most recent mouse point, commit the transaction, and raise the "PartResized" DiagramEvent. This determines the new bounds by calling computeResize.

When this calls computeResize it passes as the reshape argument the result of calling computeReshape.

Change the size of the selected part's Part.resizeObject to have the given bounds. This modifies its GraphObject.desiredSize and maybe its Part.location.

This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

This calls the super Tool.stopTransaction method, and if the result is true, attempts to optimize the transaction by removing all changes except the first and last by calling Transaction.optimize.

This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

Show an Adornment with the resize handles at points along the edge of the bounds of the selected Part's Part.resizeObject.

First this finds the object in the visual tree of the Part that should get the resize adornment and that the user will be able to resize interactively. It finds the object that has the Part.resizeObjectName property of the Part. If the Part.resizeObjectName property is an empty string, as it is by default, it uses the whole part.

It then builds the adornment, associating it with the chosen resize object. If Part.resizeAdornmentTemplate is non-null, it is copied. Otherwise it constructs a new Adornment with a Placeholder and eight copies of handleArchetype, four at the corners and four at the middle of each side.

This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.