Web SDK documentation
  1. Interfaces
  2. Column

File

core/data-grid/data-grid.model.ts

Description

Describes a data grid column.

Index

Properties

Properties

cellCSSClassName
cellCSSClassName: string | string[]
Type : string | string[]
Optional

Additional CSS classes for data cells.
cellRendererComponent
cellRendererComponent: Type<any>
Type : Type<any>
Optional

Custom data cell renderer component. Inject CellRendererContext to get access to data value, item and column object.
custom
custom: boolean
Type : boolean
Optional

Marks a user configured custom column
dataType
dataType: ColumnDataType
Type : ColumnDataType
Optional

Optional type of data in the column (used to set data-type attribute, e.g. for additional styling).
externalFilterQuery
externalFilterQuery: any
Type : any
Optional

Custom filtering form renderer can set any value here and it can be used to build a query to the server.
filterable
filterable: boolean
Type : boolean
Optional

Whether the column is filterable.
filteringFormRendererComponent
filteringFormRendererComponent: Type<any>
Type : Type<any>
Optional

Custom filtering form renderer component. Inject FilteringFormRendererContext to get access to column object and methods: applyFilter, resetFilter.
filterPredicate
filterPredicate: string | FilterPredicateFunction
Type : string | FilterPredicateFunction
Optional

The string to search for or a function for client-side filtering.
gridTrackSize
gridTrackSize: string
Type : string
Optional

The column's size, e.g. "40 px".
header
header: string
Type : string
Optional

The column's header (if not given, name is used by default).
headerCellRendererComponent
headerCellRendererComponent: Type<any>
Type : Type<any>
Optional

Custom header cell renderer component. Inject CellRendererContext to get access to header value and column object.
headerCSSClassName
headerCSSClassName: string | string[]
Type : string | string[]
Optional

Additional CSS classes for the header cell.
name
name: string | SpecialColumnName
Type : string | SpecialColumnName

The name for the column.
path
path: string
Type : string
Optional

The path in a row item to read the cell value from.
positionFixed
positionFixed: boolean
Type : boolean
Optional

Whether the column can be moved to another position.
resizable
resizable: boolean
Type : boolean
Optional

Whether the column can be resized.
sortable
sortable: boolean
Type : boolean
Optional

Whether the column is sortable.
sortOrder
sortOrder: SortOrder
Type : SortOrder
Optional

Whether the sort order is ascending, descending or not specified.
visible
visible: boolean
Type : boolean
Optional

Whether the column is displayed.

results matching ""

    No results matching ""