Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RowResizingTool

This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. Extensions can be found in the GoJS kit under the extensions or extensionsTS folders. See the Extensions intro page for more information.

Hierarchy

  • Tool
    • RowResizingTool

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

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

Index

Constructors

constructor

  • Constructs a RowResizingTool and sets the handle and name of the tool.

    Returns RowResizingTool

Properties

Read-only adornedTable : Panel | null

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

Read-only handle : GraphObject | null

handleArchetype : GraphObject

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

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

tableName : string

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

    The default value is the name "TABLE".

Methods

Override canStart

  • canStart(): boolean
  • This tool may run when there is a mouse-down event on a "RowResizing" 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

Virtual computeResize

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

    Parameters

    • p: Point

      the point where the handle is being dragged.

    Returns Point

Override doActivate

  • doActivate(): void
  • Find the handle, ensure type Panel.Table, capture the mouse, and start a transaction.

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

    Returns void

Override doDeactivate

  • doDeactivate(): void
  • Stop the current transaction and release the mouse.

    Returns void

Override doKeyDown

  • doKeyDown(): void
  • Pressing the Delete key removes any column width setting and stops this tool.

    Returns void

Override doMouseMove

  • doMouseMove(): void
  • Call resize with a new size determined by the current mouse point. This determines the new bounds by calling computeResize.

    Returns void

Override doMouseUp

  • doMouseUp(): 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

resize

  • resize(newPoint: Point): void

Override updateAdornments

  • updateAdornments(part: Part): void