Search API
  • Preparing search index...
  • The search index is not available

Class 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.

Constructor Summary Details

Name Description
RowColumnDefinition()

You do not need to use this constructor, because calls to Panel.getRowDefinition or Panel.getColumnDefinition will automatically create and remember a RowColumnDefinition for you.

Properties Summary Details

Name, Value Type Description
actual
{number}

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.More... 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.

alignment
{Spot}

Gets or sets a default alignment for elements that are in this row or column.More... The value must be a Spot. The default value is Spot.Default, so that this RowColumnDefinition does not supply any alignment information for the row or column.

When an element's GraphObject.alignment property is Spot.Default, it gets the horizontal alignment from the element's column's RowColumnDefinition and the vertical alignment from the element's row's RowColumnDefinition. When that RowColumnDefinition.alignment property is also Default, it takes the value from the table panel's Panel.defaultAlignment property.

background
{string|Brush} 1.2

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.More...

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

coversSeparators
{boolean} 1.2

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

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

height
{number}

Gets or sets the row height, in local coordinates.More... 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.

index
{number}

This read-only property returns which row or column this RowColumnDefinition describes in the panel.More... The value is a zero-based integer.

isRow
{boolean}

This read-only property is true when this describes a row instead of a column in the panel.More... 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.

maximum
{number}

Gets or sets the maximum row height or column width, in local coordinates.More... 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.

minimum
{number}

Gets or sets the minimum row height or column width, in local coordinates.More... 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.

panel
{Panel}

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

position
{number}

This read-only property returns the actual arranged row or column starting position, after arrangement, in local coordinates.More... This value gives the Y position if isRow is true; otherwise this gives the X position. The value is meaningless until after the Table Panel using this RowColumnDefinition has been arranged.

separatorDashArray
{Array.} 1.2

Gets or sets the dash array for dashing the separator line, provided this row or column has a nonzero RowColumnDefinition.separatorStrokeWidth and non-null RowColumnDefinition.separatorStroke.More...

Must be an array of positive numbers and zeroes, or else null to indicate a solid line.

For example, the array [5, 10] would create dashes of 5 pixels and spaces of 10 pixels.

Setting an array with all zeroes will set the value to null.

Default is null, so that this RowColumnDefinition does not supply any stroke dash array information for what is drawn before the row or column. The separator line may still be drawn using dashes if Panel.defaultRowSeparatorDashArray or Panel.defaultColumnSeparatorDashArray is non-null.

separatorPadding
{Margin} 1.2

Gets or sets the additional padding for a particular row or column, in local coordinates.More... Padding is applied on two sides - before and after a row or column's contents. The separatorStrokeWidth comes before any padding Margin.top or Margin.left.

The default value is null, so that this RowColumnDefinition does not supply any padding information for the row or column. There may still be some padding between rows and/or columns if Panel.defaultSeparatorPadding is non-zero.

separatorStroke
{string|Brush} 1.2

Gets or sets the stroke (color) for the separator line that is drawn before a particular row or column, provided that row or column has a nonzero separatorStrokeWidth.More...

The default value is null, so that this RowColumnDefinition does not specify any brush for the separator line to draw before the row or column. The line may still be drawn if the value of Panel.defaultRowSeparatorStroke or Panel.defaultColumnSeparatorStroke is non-null.

However, if no stroke color is specified, then no stroke width will be drawn, even if the separatorStrokeWidth value is non-zero.

separatorStrokeWidth
{number} 1.2

Gets or sets the stroke width for a particular row or column's separator line, in local coordinates.More...

The default value is NaN, so that this RowColumnDefinition does not supply any stroke width information for what is drawn before the row or column. The separator line may still be drawn if Panel.defaultRowSeparatorStroke or Panel.defaultColumnSeparatorStroke is a real number (they default to 1).

sizing
{EnumValue}

Gets or sets how this row or column deals with a Table Panel's extra space.More... The value must be one of: RowColumnDefinition.None, RowColumnDefinition.ProportionalExtra, or RowColumnDefinition.Default. The default value is RowColumnDefinition.Default.

stretch
{EnumValue}

Gets or sets the default stretch for elements that are in this row or column.More... The only accepted values are listed as constant properties of GraphObject: GraphObject.None, GraphObject.Fill, GraphObject.Horizontal, GraphObject.Vertical, or GraphObject.Default. The default value is GraphObject.Default, so that this RowColumnDefinition does not supply any stretch information for the row or column.

When an element's GraphObject.stretch property is GraphObject.Default, it gets the horizontal stretch from the element's column's RowColumnDefinition and the vertical stretch from the element's row's RowColumnDefinition. When that RowColumnDefinition.stretch property is also Default, it takes the value from the table panel's Panel.defaultStretch property.

total
{number} 1.2

This read-only property returns the total arranged row height or column width, after arrangement, in local coordinates.More... 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.

width
{number}

Gets or sets the column width, in local coordinates.More... 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.

Method Summary Details

Name, Return Type Description
bind(binding)

Add a data-binding of a property on this object to a property on a data object.More...

Parameters:
{Binding} binding

Constants Summary Details

Name Description
Default {EnumValue}

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

None {EnumValue}

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

ProportionalExtra {EnumValue}

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