Documentation

Namespace: rxTableColumn

rxTableColumn

Members

cells :external:ElementArrayFinder

An array of the WebeElement objects for the column's cells.
Type:

columnIndex :Integer

The column index that the column was built with.
Type:
  • Integer

config :rxTable.tableConfig

The configuration object that the column was built with.
Type:

data :Mixed

A promise to an array of the data in the column's cells.

The data will be transformed by the data method for the rxTableColumn.columnType specified in the configuration for the column.

Type:
  • Mixed
A promise to the header text for the column.
Type:
  • String
Web element for any links if present.
Type:

rootElement :external:ElementFinder

The root <th> ElementFinder for this table column.
Type:

rxTable :rxTable

The rxTable object that the row was built with.
Type:

rxTableRow :rxTableRow

The rxTableRow object that the row was built with.
Type:

sortableColumn :external:rxSortableColumn

The rxSortableColumn page object for the column.
Type:

Methods

<static> initialize(rxTable, columnIndex, rxTableRow)

Parameters:
Name Type Argument Description
rxTable rxTable Parent rxTable page object for the column.
columnIndex Integer The zero-index of a column in the table.
rxTableRow rxTableRow <optional>
 The optional rxTableRow page object for the column.
Returns:
Page object representing the indicated column for the parent rxTable.
Type
rxTableColumn

<static> initializeByRow(rxTableRow, columnIndex)

Parameters:
Name Type Description
rxTableRow Object Parent rxRow page object for the column.
columnIndex Integer The zero-index of a column in the row.
Returns:
Page object representing the indicated column for the parent rxRow.
Type
rxTableColumn

cell(rowNumber)

Parameters:
Name Type Description
rowNumber Integer The zero-index of a row in the table.
Returns:
The rxTableRow page object for the row (see rxTableRow).
Type
rxTableRow

isPresent()

Returns:
Whether or not the column is present in the table, searches by label, not index!
Type
Boolean

Type Definitions

columnType

Type:
  • Object
Properties:
Name Type Description
data function Data transformation function to be applied to the element. Should return a promise to a native Object or primitive.
sort function Sort transformation function to be applied to the element. Must return a consistent primitive that will be sorted using the javascript sort method.

columnTypes

All default column types available in rxTableColumn.

The format for the date column type in particular comes from the Encore UI Framework.
See Styleguide > Formatting.

Type:
  • Object
Properties:
Name Type Description
checkbox rxTableColumn.columnType Transformation functions for a Checkbox column
date rxTableColumn.columnType Transformation functions for a Date column
relativeDate rxTableColumn.columnType Transformation functions for a Relative Date column
string rxTableColumn.columnType Transformation functions for a String column
ipAddress rxTableColumn.columnType Transformation functions for an IP Address column
nameId rxTableColumn.columnType Transformation functions for a Name/ID column
status rxTableColumn.columnType Transformation functions for a Status column
number rxTableColumn.columnType Transformation functions for a Number column
bytes rxTableColumn.columnType Transformation functions for a Bytes column
actionCog rxTableColumn.columnType Transformation functions for a Action Cog column