Properties 50
alwaysRenderColumn
type boolean
Defaults to false, should we always render the column?
asyncPostRender
type (domCellNode: HTMLElement, row: number, dataContext: TData, columnDef: Column, process?: boolean) => void
async background post-rendering formatter
asyncPostRenderCleanup
type (node: HTMLElement, rowIdx: number, column: Column) => void
async background post-render cleanup callback function
autoSize
type AutoSize
column autosize feature
behavior
type string
optional Behavior of a column with action, for example it's used by the Row Move Manager Plugin
cellAttrs
type any
cell attributes
cannotTriggerInsert
type boolean
Block event triggering of a new row insert
columnGroup
type string
Column group name for grouping of column headers spanning accross multiple columns
colspan
type number | string | '*'
Column span in cell count or use `*` to span across the entire row
cssClass
type string
CSS class to add to the column cell
customTooltip
type CustomTooltipOption
Custom Tooltip Options, the tooltip could be defined in any of the Column Definition or in the Grid Options,
it will first try to find it in the Column that the user is hovering over or else (when not found) it will try to find it in the Grid Options
defaultSortAsc
type boolean
Do we want default sort to be ascending? True by default
denyPaste
type boolean
Defaults to false, do we want to deny executing a Paste (from a Copy of CellExternalCopyManager)?
disableTooltip
type boolean
defaults to False, optionally enable/disable tooltip.
This is typically used on a specific column that you would like to completely disable the custom/regular tooltip.
editor
type Editor | EditorConstructor | null
Any inline editor function that implements Editor for the cell value or ColumnEditor
editorFixedDecimalPlaces
type number
Editor number fixed decimal places
excludeFromColumnPicker
type boolean
Default to false, which leads to exclude the column title from the Column Picker.
excludeFromExport
type boolean
Default to false, which leads to exclude the column from the export.
excludeFromQuery
type boolean
Defaults to false, which leads to exclude the field from the query (typically a backend service query)
field
type Join<PathsToStringProps<TData>, '.'>
Field property name to use from the dataset that is used to display the column data.
For example: { id: 'firstName', field: 'firstName' }
focusable
type boolean
are we allowed to focus on the column?
formatter
type Formatter<TData>
Formatter function is meant to format, or visually change, the data shown in the grid (UI) in a different way without affecting the source.
formatterOverride
type { ReturnsTextOnly: boolean; } | FormatterOverrideCallback
Formatter override function
grouping
type Grouping
Grouping option used by a Draggable Grouping Column
groupTotalsFormatter
type GroupTotalsFormatter
Group Totals Formatter function that can be used to add grouping totals in the grid
hidden
type boolean
is the column hidden?
id
type number | string
ID of the column, each column definition ID must be unique or else SlickGrid will throw an error.
maxWidth
type number
Maximum Width of the column in pixels (number only).
minWidth
type number
Minimum Width of the column in pixels (number only).
name
type string | HTMLElement | DocumentFragment
Column Title Name to be displayed in the Grid (UI)
offsetWidth
type number
column offset width
params
type any | any[]
extra custom generic parameters that could be used by your Formatter/Editor or anything else
previousWidth
type number
column previous width
reorderable
type boolean
Defaults to true, makes the column reorderable to another position in the grid.
NOTE: Works best when used as first or last columns of the grid (e.g.: row selection checkbox as first column).
rerenderOnResize
type boolean
Should we re-render when onResize is being triggered?
resizable
type boolean
Is the column resizable, can we make it wider/thinner? A resize cursor will show on the right side of the column when enabled.
rowspan
type number
Row span in cell count or use `*` to span across the entire row
selectable
type boolean
Is the column selectable? Goes with grid option "enableCellNavigation: true".
sortable
type boolean
Is the column sortable? Goes with grid option "enableSorting: true".
toolTip
type string
Custom Tooltip that can ben shown to the column
unselectable
type boolean
Defaults to false, when set to True will lead to the column being unselected in the UI
validator
type EditorValidator
Editor Validator
width
type number
Width of the column in pixels (number only).
widthRequest
type number
column width request when resizing