API Reference > ui-components > Table > TableColumn

TableColumn Class

Table Column used by the TableColumn.Table component @internal

Extends

  • FilterableColumnBase

Implements

  • FilterableColumn

Methods

Name Description
constructor(filterableTable: FilterableTable, columnDescription: ColumnDescription, reactDataGridColumn: ReactDataGridColumn): TableColumn    
getDistinctValues(maximumValueCount?: number): Promise<DistinctValueCollection> Gets the distinct values for a column.  

Inherited methods

Name Inherited from Description
createColumnFilterDescriptor(): ColumnFilterDescriptor Protected FilterableColumnBase Creates the column filter descriptor.
createSimpleFilterDescriptor(value: any, filterOperator: FilterOperator): TableFilterDescriptor FilterableColumnBase Creates a basic filter descriptor for use .

Properties

Name Type Description
dataProvider undefined | TableDataProvider    
distinctValueCollection undefined | DistinctValueCollection    
key Accessor ReadOnly string    
reactDataGridColumn ConstructorProperty ReactDataGridColumn    

Inherited properties

Name Type Inherited from Description
columnDescription Accessor ReadOnly ColumnDescription FilterableColumnBase Gets the Column Description.
columnFilterDescriptor Accessor ReadOnly ColumnFilterDescriptor FilterableColumnBase Gets the column filter descriptor.
filterable Accessor ReadOnly boolean FilterableColumnBase Indicates whether column is filterable.
filterableTable Accessor ReadOnly FilterableTable FilterableColumnBase Gets the owning filterable Table.
filterMemberKey Accessor ReadOnly string FilterableColumnBase Gets the filter member key.
filterMemberType Accessor ReadOnly string FilterableColumnBase Gets the filter member type.
isFilterActive Accessor ReadOnly boolean FilterableColumnBase Determines if a filter is active.
showDistinctValueFilters Accessor ReadOnly boolean FilterableColumnBase Gets if the filter should show distinct values as a filter option
showFieldFilters Accessor ReadOnly boolean FilterableColumnBase Gets if the filter should show field filter options

Defined in

Last Updated: 08 January, 2020