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

Declares which column class from Table.columnTypeRegistry to use. Optional, default is TableColumn

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.