Skip to main content

grid-tabulator.gridtabulator

Home > @genesislcap/grid-tabulator > GridTabulator

GridTabulator class​

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Signature:

export declare class GridTabulator extends GridTabulator_base 

Extends: GridTabulator_base

Properties​

Property

Modifiers

Type

Description

autoCellRendererByType

boolean

(ALPHA)

classNames

string

(ALPHA)

columnComponentName

string

The column component name used for querying child column elements

enableCellFlashing

boolean

(ALPHA) If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef

enableRowFlashing

boolean

(ALPHA) If true, will enable row flashing for all rows

grid

Tabulator | undefined

(ALPHA)

gridAutosizingEnabled

boolean

(ALPHA) Boolean attribute to control whether the grid autosizes the columns upon interaction. This will disable the column widths from being manually set, and doesn't save the widths in local storage if you are using persist-column-state-key.

gridDiv

HTMLDivElement

(ALPHA)

gridFontFace

string

(ALPHA)

gridOptions

Options

The current grid options.

headerCaseType

GridTabulatorCaseType

The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.

onlyTemplateColDefs

boolean

(ALPHA)

persistColumnStateKey

string

(ALPHA)

persistFilterModelKey

string

(ALPHA) The key to use for persisting the filter model in local browser or KV storage.

rowData

any[]

(ALPHA)

rowHeight

number

(ALPHA)

showHeaderFilters

boolean

(ALPHA) If true, will show header filters on columns by default

statePersistanceEnabled

readonly

boolean

(ALPHA)

theme

string

(ALPHA)

Methods​

Method

Modifiers

Description

clearFilters()

Clear all filters

downloadDataAs(type, fileName, params, filter)

Download the Grid data as a file of the specified type.

redraw()

Redraw the table

refreshCells()

Refresh the grid cells

setFilter(column, operator, value, filterParams)

Set the Grid client-side filters.