SpreadsheetColumn extends TableColumn

The configuration class for Spreadsheet columns

Example

Custom Column Type

Spreadsheet.columnTypeRegistry.foo = class FooColumn extends SpreadsheetColumn {
    ...
}
new Spreadsheet({
    data: [...]
    columns: [{ type: 'foo' }]
})

Constructor


new SpreadsheetColumn(options)

options :


            
                Object

optional

headerEditable :


            
                boolean

optional

allow header to be changed, fires events when changed

type :


            
                string

optional

Key into Table.columnTypeRegistry that determines which column class to instantiate. Defaults to "default".

frozen :


            
                boolean

optional

Make column stay in place when table body scrolls

class :


            
                string

optional

classes to append to header and cells (space separated)

render :


            
                function

optional

Render method for the cell. Receives (record, cell, columnConfiguration, table)

header :

optional

Render method for the header. Receives (columnConfiguration, table)

width :


            
                string

optional

Valid value for css grid template (i.e. px, percent, min-content...)

splitInto :

optional

split cell into multiple rows by the result of this method. If String, key is called on record. If Function, function is called with record as argument.

Column attribute changes fire cancellable events on the parent Table:

headerChange / headerChanged — when the header value changes
indexChange / indexChanged — when the column index changes
widthChange / widthChanged — when the column width changes

Call event.preventDefault() on the pre-action event to cancel default behavior.

Instance Methods


cellActivated(cell, floater)

Called after a cell spawns its input floater and focus has been set up. Receives the cell and its floater directly, so column types can wire input-specific keyboard and lifecycle behavior without reaching through the DOM. Override to customize; not calling super opts out of the default navigation below.

Default behavior provides spreadsheet keyboard navigation: Escape cancels the edit and refocuses the cell, Enter commits and moves to the cell below.

Parameters

cell :


            
                SpreadsheetCell

floater :


            
                Floater


onEnter()