Properties

Link copied to clipboard

The column filters map for the row. This object tracks whether a row is passing/failing specific filters by their column ID. API Docs Guide

Link copied to clipboard

The column filters meta map for the row. This object tracks any filter meta for a row as optionally provided during the filtering process. API Docs Guide

Link copied to clipboard
abstract var depth: Int

The depth of the row (if nested or grouped) relative to the root row array. API Docs Guide

Link copied to clipboard
abstract var getAllCells: () -> ReadonlyArray<Cell<TData, *>>

Returns all of the cells for the row. API Docs Guide

Link copied to clipboard
abstract var getCanExpand: () -> Boolean

Returns whether the row can be expanded. API Docs Guide

Link copied to clipboard
abstract var getCanMultiSelect: () -> Boolean

Returns whether or not the row can multi-select. API Docs Guide

Link copied to clipboard
abstract var getCanPin: () -> Boolean

Returns whether or not the row can be pinned. API Docs Guide

Link copied to clipboard
abstract var getCanSelect: () -> Boolean

Returns whether or not the row can be selected. API Docs Guide

Link copied to clipboard
abstract var getCanSelectSubRows: () -> Boolean

Returns whether or not the row can select sub rows automatically when the parent row is selected. API Docs Guide

Link copied to clipboard

Returns all center pinned (unpinned) leaf cells in the row. API Docs Guide

Link copied to clipboard
abstract var getGroupingValue: (columnId: String) -> Any

Returns the grouping value for any row and column (including leaf rows). API Docs Guide

Link copied to clipboard
abstract var getIsAllParentsExpanded: () -> Boolean

Returns whether all parent rows of the row are expanded. API Docs Guide

Link copied to clipboard
abstract var getIsAllSubRowsSelected: () -> Boolean

Returns whether or not all of the row's sub rows are selected. API Docs Guide

Link copied to clipboard
abstract var getIsExpanded: () -> Boolean

Returns whether the row is expanded. API Docs Guide

Link copied to clipboard
abstract var getIsGrouped: () -> Boolean

Returns whether or not the row is currently grouped. API Docs Guide

Link copied to clipboard
abstract var getIsPinned: () -> RowPinningPosition

Returns the pinned position of the row. ('top', 'bottom' or false) API Docs Guide

Link copied to clipboard
abstract var getIsSelected: () -> Boolean

Returns whether or not the row is selected. API Docs Guide

Link copied to clipboard
abstract var getIsSomeSelected: () -> Boolean

Returns whether or not some of the row's sub rows are selected. API Docs Guide

Link copied to clipboard
abstract var getLeafRows: () -> ReadonlyArray<Row<TData>>

Returns the leaf rows for the row, not including any parent rows. API Docs Guide

Link copied to clipboard
abstract var getLeftVisibleCells: () -> ReadonlyArray<Cell<TData, *>>

Returns all left pinned leaf cells in the row. API Docs Guide

Link copied to clipboard
abstract var getParentRow: () -> Row<TData>

Returns the parent row for the row, if it exists. API Docs Guide

Link copied to clipboard
abstract var getParentRows: () -> ReadonlyArray<Row<TData>>

Returns the parent rows for the row, all the way up to a root row. API Docs Guide

Link copied to clipboard
abstract var getPinnedIndex: () -> Int

Returns the numeric pinned index of the row within a pinned row group. API Docs Guide

Link copied to clipboard
abstract var getRightVisibleCells: () -> ReadonlyArray<Cell<TData, *>>

Returns all right pinned leaf cells in the row. API Docs Guide

Link copied to clipboard
abstract var getToggleExpandedHandler: () -> () -> Unit

Returns a function that can be used to toggle the expanded state of the row. This function can be used to bind to an event handler to a button. API Docs Guide

Link copied to clipboard
abstract var getToggleSelectedHandler: () -> (event: Any) -> Unit

Returns a handler that can be used to toggle the row. API Docs Guide

Link copied to clipboard
abstract var getUniqueValues: (columnId: String) -> ReadonlyArray<Any?>

Returns a unique array of values from the row for a given columnId. API Docs Guide

Link copied to clipboard
abstract var getValue: (columnId: String) -> Any?

Returns the value from the row for a given columnId. API Docs Guide

Link copied to clipboard
abstract var getVisibleCells: () -> ReadonlyArray<Cell<TData, *>>

Returns an array of cells that account for column visibility for the row. API Docs Guide

Link copied to clipboard
abstract var groupingColumnId: String?

If this row is grouped, this is the id of the column that this row is grouped by. API Docs Guide

Link copied to clipboard
abstract var groupingValue: Any?

If this row is grouped, this is the unique/shared value for the groupingColumnId for all of the rows in this group. API Docs Guide

Link copied to clipboard
abstract var id: String

The resolved unique identifier for the row resolved via the options.getRowId option. Defaults to the row's index (or relative index if it is a subRow). API Docs Guide

Link copied to clipboard
abstract var index: Int

The index of the row within its parent array (or the root data array). API Docs Guide

Link copied to clipboard
abstract var original: TData

The original row object provided to the table. If the row is a grouped row, the original row object will be the first original in the group. API Docs Guide

Link copied to clipboard

An array of the original subRows as returned by the options.getSubRows option. API Docs Guide

Link copied to clipboard
abstract var parentId: String?

If nested, this row's parent row id. API Docs Guide

Link copied to clipboard
abstract var pin: (position: RowPinningPosition, includeLeafRows: Boolean?, includeParentRows: Boolean?) -> Unit

Pins a row to the 'top' or 'bottom', or unpins the row to the center if false is passed. API Docs Guide

Link copied to clipboard
abstract var renderValue: (columnId: String) -> Any?

Renders the value for the row in a given columnId the same as getValue, but will return the renderFallbackValue if no value is found. API Docs Guide

Link copied to clipboard
abstract var subRows: ReadonlyArray<Row<TData>>

An array of subRows for the row as returned and created by the options.getSubRows option. API Docs Guide

Link copied to clipboard
abstract var toggleExpanded: (expanded: Boolean?) -> Unit

Toggles the expanded state (or sets it if expanded is provided) for the row. API Docs Guide

Link copied to clipboard

Selects/deselects the row. API Docs Guide