Class ColumnResizingTool

GoJS® Diagramming Components
version 3.0.5
by Northwoods Software®

This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. See the Extensions intro page for more information.

Hierarchy

  • Tool
    • ColumnResizingTool

The ColumnResizingTool class lets the user resize each column of a named Table Panel in a selected Part.

If you want to experiment with this extension, try the Column Resizing sample.

Index

Constructors

Accessors

  • This read-only property returns the go.Panel of type go.Panel.Table whose columns are being resized. This must be contained within the selected go.Part.

  • Gets or sets small GraphObject that is copied as a resize handle for each column. This tool expects that this object's go.GraphObject.desiredSize (a.k.a width and height) has been set to real numbers.

    The default value is a go.Shape that is a narrow rectangle.

  • Gets or sets the name of the Table Panel to be resized.

    The default value is the name "TABLE".

Methods

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

    Returns boolean

  • This can be overridden in order to customize the resizing process.

    Parameters

    • p: Point

      the point where the handle is being dragged

    Returns Point

  • Find the handle, ensure type go.Panel.Table, capture the mouse, and start a transaction.

    If the call to go.Tool.findToolHandleAt finds no "ColumnResizing" tool handle, this method returns without activating this tool.

    Returns void

  • Stop the current transaction and release the mouse.

    Returns void

  • Pressing the Delete key removes any column width setting and stops this tool.

    Returns void

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

    Returns void

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

    Returns void

  • Actually change the width of a RowColumnDefinition. This is called by resize within the tool's transaction.

    Parameters

    Returns void

  • Change the go.RowColumnDefinition.width of the column being resized to a value corresponding to the given mouse point. This calls doResize to actually change the RowColumnDefinition.

    Parameters

    Returns void