GridColumn<TData>
Defined in: src/grid.ts:664
Represents a grid column
Type Parameters
| Type Parameter | Default type |
|---|---|
TData | any |
Constructors
Constructor
new GridColumn<
TData>(dart):GridColumn<TData>
Defined in: src/grid.ts:667
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
GridColumn<TData>
Properties
| Property | Type | Defined in |
|---|---|---|
dart | any | src/grid.ts:665 |
Accessors
backColor
Get Signature
get backColor():
Color
Defined in: src/grid.ts:710
Background column as a 4-byte ARGB number.
Returns
Set Signature
set backColor(
x):void
Defined in: src/grid.ts:711
Parameters
| Parameter | Type |
|---|---|
x | Color |
Returns
void
categoryColors
Get Signature
get categoryColors():
object
Defined in: src/grid.ts:733
Custom colors for categories. Sample: https://public.datagrok.ai/js/samples/grid/category-colors
Returns
object
Set Signature
set categoryColors(
x):void
Defined in: src/grid.ts:734
Parameters
| Parameter | Type |
|---|---|
x | {[s: string]: number; } |
Returns
void
cellType
Get Signature
get cellType():
string
Defined in: src/grid.ts:719
Returns
string
Cell type.
Set Signature
set cellType(
x):void
Defined in: src/grid.ts:720
Parameters
| Parameter | Type |
|---|---|
x | string |
Returns
void
column
Get Signature
get column():
Column<TData,TData> |null
Defined in: src/grid.ts:681
Returns
Column<TData, TData> | null
Corresponding table column, or null.
contentCellStyle
Get Signature
get contentCellStyle():
GridCellStyle
Defined in: src/grid.ts:699
Cell style used for rendering data cells
Returns
editable
Get Signature
get editable():
boolean
Defined in: src/grid.ts:738
Whether the column is editable.
Returns
boolean
Set Signature
set editable(
x):void
Defined in: src/grid.ts:739
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
format
Get Signature
get format():
string
Defined in: src/grid.ts:715
Column format. Sample: https://public.datagrok.ai/js/samples/grid/html-markup-cells
Returns
string
Set Signature
set format(
x):void
Defined in: src/grid.ts:716
Parameters
| Parameter | Type |
|---|---|
x | string |
Returns
void
grid
Get Signature
get grid():
Grid
Defined in: src/grid.ts:676
A Grid this column is associated with
Returns
headerCellStyle
Get Signature
get headerCellStyle():
GridCellStyle
Defined in: src/grid.ts:702
Cell style used for rendering header cells
Returns
idx
Get Signature
get idx():
number
Defined in: src/grid.ts:687
Index of the column.
Returns
number
isTextColorCoded
Get Signature
get isTextColorCoded():
boolean
Defined in: src/grid.ts:758
isTextColorCoded. Whether to apply color to the text or background.
Returns
boolean
Set Signature
set isTextColorCoded(
x):void
Defined in: src/grid.ts:759
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
left
Get Signature
get left():
number
Defined in: src/grid.ts:767
Left border (in pixels in the virtual viewport)
Returns
number
name
Get Signature
get name():
string
Defined in: src/grid.ts:695
Returns
string
Column name.
Set Signature
set name(
x):void
Defined in: src/grid.ts:696
Parameters
| Parameter | Type |
|---|---|
x | string |
Returns
void
onPrepareValueScript
Get Signature
get onPrepareValueScript():
string
Defined in: src/grid.ts:763
A script that returns cell value, using the "gridCell" parameter. See example: ApiSamples/grid/advanced/dynamic-value-retrieval.js
Returns
string
Set Signature
set onPrepareValueScript(
x):void
Defined in: src/grid.ts:764
Parameters
| Parameter | Type |
|---|---|
x | string |
Returns
void
renderer
Get Signature
get renderer():
GridCellRenderer
Defined in: src/grid.ts:723
Grid cell renderer.
Returns
Set Signature
set renderer(
x):void
Defined in: src/grid.ts:724
Parameters
| Parameter | Type |
|---|---|
x | GridCellRenderer |
Returns
void
right
Get Signature
get right():
number
Defined in: src/grid.ts:770
Right border (in pixels in the virtual viewport)
Returns
number
selected
Get Signature
get selected():
boolean
Defined in: src/grid.ts:742
Whether the column is selected.
Returns
boolean
Set Signature
set selected(
x):void
Defined in: src/grid.ts:743
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
settings
Get Signature
get settings():
any
Defined in: src/grid.ts:776
Grid column settings.
Returns
any
Set Signature
set settings(
s):void
Defined in: src/grid.ts:777
Parameters
| Parameter | Type |
|---|---|
s | any |
Returns
void
tags
Get Signature
get tags():
object
Defined in: src/grid.ts:780
Use this field to keep arbitrary auxiliary data. It is serialized as JSON, so be careful. See also temp.
Returns
object
temp
Get Signature
get temp():
object
Defined in: src/grid.ts:783
Use this field to keep auxiliary data. It is not serialized. See also tags.
Returns
object
tooltipColumns
Get Signature
get tooltipColumns():
string[]
Defined in: src/grid.ts:754
Tooltip columns. Also requires tooltipType to be 'Columns'.
Returns
string[]
Set Signature
set tooltipColumns(
x):void
Defined in: src/grid.ts:755
Parameters
| Parameter | Type |
|---|---|
x | string[] |
Returns
void
tooltipForm
Get Signature
get tooltipForm():
string
Defined in: src/grid.ts:750
Tooltip form. Also requires tooltipType to be 'Form'.
Returns
string
Set Signature
set tooltipForm(
x):void
Defined in: src/grid.ts:751
Parameters
| Parameter | Type |
|---|---|
x | string |
Returns
void
tooltipType
Get Signature
get tooltipType():
GridColumnTooltipType
Defined in: src/grid.ts:746
Tooltip type, specific to this column.
Returns
Set Signature
set tooltipType(
x):void
Defined in: src/grid.ts:747
Parameters
| Parameter | Type |
|---|---|
x | GridColumnTooltipType |
Returns
void
visible
Get Signature
get visible():
boolean
Defined in: src/grid.ts:727
Column visibility.
Returns
boolean
Set Signature
set visible(
x):void
Defined in: src/grid.ts:728
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
width
Get Signature
get width():
number
Defined in: src/grid.ts:706
Column width in pixels. Sample: https://public.datagrok.ai/js/samples/grid/resize-columns
Returns
number
Set Signature
set width(
x):void
Defined in: src/grid.ts:707
Parameters
| Parameter | Type |
|---|---|
x | number |
Returns
void
Methods
checkEditable()
checkEditable():
string
Defined in: src/grid.ts:786
Returns null if column is editable, or the reason of not being editable, otherwise
Returns
string
getDataWidth()
getDataWidth():
number
Defined in: src/grid.ts:792
Number of pixels required to render the longest element in the column.
Returns
number
getVisibleCells()
getVisibleCells():
Iterable<GridCell<any>>
Defined in: src/grid.ts:773
Returns all visible cells
Returns
Iterable<GridCell<any>>
move()
move(
position):void
Defined in: src/grid.ts:789
Moves the specified column to the specified position
Parameters
| Parameter | Type |
|---|---|
position | number |
Returns
void
pin()
pin():
void
Defined in: src/grid.ts:691
Returns
void
scrollIntoView()
scrollIntoView():
void
Defined in: src/grid.ts:795
If this column is not entirely visible, scrolls the grid horizontally to show it.
Returns
void
unpin()
unpin():
void
Defined in: src/grid.ts:692
Returns
void
fromDart()
staticfromDart(dart):GridColumn<any> |null
Defined in: src/grid.ts:671
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
GridColumn<any> | null