grid-tabulator.textformatterparams

Home > @genesislcap/grid-tabulator > TextFormatterParams

TextFormatterParams interface

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.

Parameters for the text formatter

specialValue: Optional special value that should be highlighted (like 2012 in the Year example)

specialColor: Optional color for the highlighted special value

specialFontWeight: Optional font weight for the highlighted special value

prefix: Optional prefix for any custom elements used in formatting

dataTestId: Optional data-test-id for testing purposes

nullText: Optional text to display when the value is null or undefined

Signature:

export interface TextFormatterParams<T = any> 

Properties

Property	Modifiers	Type	Description
dataTestId?		((rowData: T) => string) | string	(ALPHA) (Optional)
nullText?		string	(ALPHA) (Optional)
prefix?		string	(ALPHA) (Optional)
specialColor?		string	(ALPHA) (Optional)
specialFontWeight?		string	(ALPHA) (Optional)
specialValue?		any	(ALPHA) (Optional)