Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RowColumnDefinition

Hierarchy

  • RowColumnDefinition

The RowColumnDefinition class describes constraints on a row or a column in a Panel of type Panel.Table. It also provides information about the actual layout after the Table Panel has been arranged.

Index

Constructors

Properties

  • This read-only property returns the usable row height or column width, after arrangement, in local coordinates, that objects in this row or column can be arranged within. This does not include separatorPadding or separatorStrokeWidth, as total does.

    This value gives the row height if isRow is true; otherwise this gives the column width. The value is meaningless until after the Table Panel using this RowColumnDefinition has been arranged.

    see

    total, height, width, sizing

  • Gets or sets the background color for a particular row or column, which fills the entire span of the row or column, including any separatorPadding.

    The default value is null, which means nothing is drawn in the background of the row or column.

    see

    GraphObject.background

    since

    1.2

  • Determines whether or not the background, if there is one, is in front of or behind the separators.

    The default value is false -- any background is drawn behind any separator lines.

    since

    1.2

  • Gets or sets the row height, in local coordinates. This describes the row height if isRow is true; otherwise this property is meaningless. The value must be non-negative and finite.

    The default value is NaN, which means this row will get a height that is just big enough to hold all of the objects in the row.

    Setting this value to a number will mean that all of the objects of this Panel in this row will be allocated that amount of row height. Whether an object in the row is actually arranged to have that height depends on whether the GraphObject.stretch stretches vertically.

    see

    width, minimum, maximum, sizing

  • This read-only property is true when this describes a row instead of a column in the panel. When this is true, the height, minimum, and maximum all describe the row height. Otherwise width and the other two properties describe the column width.

  • Gets or sets the maximum row height or column width, in local coordinates. The maximum describes the row height if isRow is true; otherwise this describes the column width.

    The value must be non-negative. The default value is Infinity. The arranged height of all objects in this row, or the arranged width of all objects in this column, will be no greater than this value.

    see

    width, height, minimum, sizing

  • Gets or sets the minimum row height or column width, in local coordinates. The minimum describes the row height if isRow is true; otherwise this describes the column width.

    The value must be non-negative and finite. The default value is zero. The arranged height of all objects in this row, or the arranged width of all objects in this column, will be no less than this value.

    see

    width, height, maximum, sizing

  • This read-only property returns the Panel that this row or column definition is in.

  • This read-only property returns the total arranged row height or column width, after arrangement, in local coordinates. This value gives the actual size plus the separatorPadding and separatorStrokeWidth.

    This value gives the vertical space occupied by the row if isRow is true; otherwise this gives the horizontal space occupied by the column. The value is meaningless until after the Table Panel using this RowColumnDefinition has been arranged.

    see

    actual, height, width, sizing

    since

    1.2

  • Gets or sets the column width, in local coordinates. The size describes the column width if isRow is false; otherwise this property is meaningless. The value must be non-negative and finite.

    The default value is NaN, which means this column will get a width that is just big enough to hold all of the objects in the column.

    Setting this value to a number will mean that all of the objects of this Panel in this column will be allocated that amount of column width. Whether an object in the column is actually arranged to have that width depends on whether the GraphObject.stretch stretches horizontally.

    see

    height, minimum, maximum, sizing

Methods

  • Add a data-binding to this RowColumnDefinition for the given property names and optional conversion function. You can pass in the argumetns to a new Binding: .bind(a, b) instead of calling .bind(new go.Binding(a, b).

    since

    2.2

    Parameters

    • Optional targetprop: string

      A string naming the target property on the target object. This should not be the empty string.

    • Optional sourceprop: string

      A string naming the source property on the bound data object. If this is the empty string, the whole Panel.data object is used. If this argument is not supplied, the source property is assumed to be the same as the target property.

    • Optional conv: (val: any, targetObj: any) => any

      An optional side-effect-free function converting the data property value to the value to set the target property. If the function is null or not supplied, no conversion takes place.

        • (val: any, targetObj: any): any
        • Parameters

          • val: any
          • targetObj: any

          Returns any

    • Optional backconv: (val: any, sourceData: any, model: Model) => any

      An optional conversion function to convert property values back to data values. Specifying this modifies the binding to set its Binding.mode to be Binding.TwoWay. If you want a two-way binding without a back-conversion function, call this method with the new Binding argument instead, and call Binding.makeTwoWay on it: .bind(new go.Binding(...).makeTwoWay())

        • (val: any, sourceData: any, model: Model): any
        • Parameters

          • val: any
          • sourceData: any
          • model: Model

          Returns any

    Returns RowColumnDefinition

    this RowColumnDefinition

  • Add a data-binding of a property on this RowColumnDefinition to a property on a data object. You can pass in the argumetns to a new Binding: .bind(a, b) instead of calling .bind(new go.Binding(a, b).

    Parameters

    Returns RowColumnDefinition

    this RowColumnDefinition

Constants

The default sizing, which resolves to RowColumnDefinition.None or else the Table Panel's rowSizing and columnSizing if present.

The default sizing if none is specified on the Table Panel's rowSizing and columnSizing.

If a Table Panel is larger than all the rows then this sizing grants this row and any others with the same value the extra space, apportioned proportionally between them