Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TableLayout

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

This Layout positions non-Link Parts into a table according to the values of GraphObject.row, GraphObject.column, GraphObject.rowSpan, GraphObject.columnSpan, GraphObject.alignment, GraphObject.stretch. If the value of GraphObject.stretch is not GraphObject.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: RowColumnDefinition.alignment, RowColumnDefinition.height, RowColumnDefinition.width, RowColumnDefinition.maximum, RowColumnDefinition.minimum, 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 (RowColumnDefinition.separatorStroke, RowColumnDefinition.separatorStrokeWidth, and RowColumnDefinition.separatorDashArray properties) nor background (RowColumnDefinition.background and RowColumnDefinition.coversSeparators properties). There is no support for RowColumnDefinition.sizing, either.

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

Index

Properties

Read-only columnCount : number

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

defaultAlignment : Spot

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

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

defaultStretch : EnumValue

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

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

Read-only rowCount : number

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

Methods

Protected Virtual afterArrange

  • afterArrange(parts: List<Part>, rowcol: Array<Array<Array<any>>>): void
  • Override this method in order to perform some operations after arranging. By default this method does nothing.

    Parameters

    • parts: List<Part>
    • rowcol: Array<Array<Array<any>>>

    Returns void

Protected Virtual beforeMeasure

  • beforeMeasure(parts: List<Part>, rowcol: Array<Array<Array<any>>>): void
  • Override this method in order to perform some operations before measuring. By default this method does nothing.

    Parameters

    • parts: List<Part>
    • rowcol: Array<Array<Array<any>>>

    Returns void

Override cloneProtected

  • cloneProtected(copy: this): void
  • Copies properties to a cloned Layout.

    Parameters

    • copy: this

    Returns void

Override doLayout

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

    Parameters

    Returns void

findColumnForDocumentX

  • findColumnForDocumentX(x: number): number
  • Returns the cell at a given x-coordinate in document coordinates. This information is only valid when this layout has been performed and 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.

    see

    findRowForDocumentY

    Parameters

    • x: number

    Returns number

    a zero-based integer

findRowForDocumentY

  • findRowForDocumentY(y: number): number
  • Returns the row at a given y-coordinate in document coordinates. This information is only valid when this layout has been performed and 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.

    see

    findColumnForDocumentX

    Parameters

    • y: number

    Returns number

    a zero-based integer

getColumnDefinition

  • Gets the RowColumnDefinition for a particular column in this TableLayout. If you ask for the definition of a column at or beyond the columnCount, it will automatically create one and return it.

    Parameters

    • idx: number

      the non-negative zero-based integer column index.

    Returns RowColumnDefinition

getRowDefinition

  • Gets the RowColumnDefinition for a particular row in this TableLayout. If you ask for the definition of a row at or beyond the rowCount, it will automatically create one and return it.

    Parameters

    • idx: number

      the non-negative zero-based integer row index.

    Returns RowColumnDefinition