Class TableLayout

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

This go.Layout positions non-Link Parts into a table according to the values of go.GraphObject.row, go.GraphObject.column, go.GraphObject.rowSpan, go.GraphObject.columnSpan, go.GraphObject.alignment, go.GraphObject.stretch. If the value of GraphObject.stretch is not go.Stretch.None, the Part will be sized according to the available space in the cell(s).

You can specify constraints for whole rows or columns by calling getRowDefinition or getColumnDefinition and setting one of the following properties: go.RowColumnDefinition.alignment, go.RowColumnDefinition.height, go.RowColumnDefinition.width, go.RowColumnDefinition.maximum, go.RowColumnDefinition.minimum, go.RowColumnDefinition.stretch.

The defaultAlignment and defaultStretch properties apply to all parts if not specified on the individual Part or in the corresponding row or column definition.

At the current time, there is no support for separator lines (go.RowColumnDefinition.separatorStroke, go.RowColumnDefinition.separatorStrokeWidth, and go.RowColumnDefinition.separatorDashArray properties) nor background (go.RowColumnDefinition.background and go.RowColumnDefinition.coversSeparators properties). There is no support for go.RowColumnDefinition.sizing, either.

If you want to experiment with this extension, try the Table Layout sample.

Index

Constructors

Accessors

  • This read-only property returns the number of columns in this TableLayout. This value is only valid after the layout has been performed.

  • Gets or sets the alignment to use by default for Parts in rows (vertically) and in columns (horizontally).

    The default value is go.Spot.Default. Setting this property does not raise any events.

  • Gets or sets whether Parts should be stretched in rows (vertically) and in columns (horizontally).

    The default value is go.Stretch.Default. Setting this property does not raise any events.

  • This read-only property returns the number of rows in this TableLayout. This value is only valid after the layout has been performed.

Methods

  • Override this method in order to perform some operations after arranging. By default this method does nothing.

    Parameters

    Returns void

  • Override this method in order to perform some operations before measuring. By default this method does nothing.

    Parameters

    Returns void

  • Copies properties to a cloned Layout.

    Parameters

    Returns void

  • This method performs the measuring and arranging of the table, assiging positions to each part.

    Parameters

    Returns void

  • Returns the cell at a given x-coordinate in document coordinates. This information is only valid when this layout has been performed and go.Layout.isValidLayout is true.

    If the point is to left of the column 0, this method returns -1. If the point to to the right of the last column, this returns the last column + 1.

    Parameters

    • x: number

    Returns number

    a zero-based integer

  • Returns the row at a given y-coordinate in document coordinates. This information is only valid when this layout has been performed and go.Layout.isValidLayout is true.

    If the point is above row 0, this method returns -1. If the point below the last row, this returns the last row + 1.

    Parameters

    • y: number

    Returns number

    a zero-based integer

  • Interpret go.Part.margin differently than normal.

    Parameters

    Returns Rect