Package io.kvision.tabulator

Full-featured grid/table component based on the Tabulator library.

Types

AddRowMode

enum AddRowMode : Enum<AddRowMode>

Add row modes.

Align

enum Align : Enum<Align>

Column align.

Calc

enum Calc : Enum<Calc>

Built-in calc functions.

ColumnDefinition

data class ColumnDefinition<T : Any>(title: String, field: String?, columns: List<ColumnDefinition<T>>?, visible: Boolean?, align: Align?, width: String?, minWidth: Int?, widthGrow: Int?, widthShrink: Int?, resizable: Boolean?, frozen: Boolean?, responsive: Int?, tooltip: (cell: Tabulator.CellComponent) -> String?, cssClass: String?, rowHandle: Boolean?, hideInHtml: Boolean?, sorter: Sorter?, sorterFunction: (dynamic, dynamic, aRow: Tabulator.RowComponent, bRow: Tabulator.RowComponent, column: Tabulator.ColumnComponent, dir: SortingDir, dynamic) -> Number?, sorterParams: dynamic, formatter: Formatter?, formatterFunction: (cell: Tabulator.CellComponent, dynamic, onRendered: (callback: () -> Unit) -> Unit) -> dynamic?, formatterComponentFunction: (cell: Tabulator.CellComponent, onRendered: (callback: () -> Unit) -> Unit, T) -> Component?, formatterParams: dynamic, variableHeight: Boolean?, editable: (cell: Tabulator.CellComponent) -> Boolean?, editor: Editor?, editorFunction: (cell: Tabulator.CellComponent, onRendered: (callback: () -> Unit) -> Unit, success: (dynamic) -> Unit, cancel: (dynamic) -> Unit, dynamic) -> dynamic?, editorComponentFunction: (cell: Tabulator.CellComponent, onRendered: (callback: () -> Unit) -> Unit, success: (dynamic) -> Unit, cancel: (dynamic) -> Unit, T) -> Component?, editorParams: dynamic, validator: Validator?, validatorFunction: dynamic, validatorParams: String?, download: Boolean?, downloadTitle: String?, topCalc: Calc?, topCalcParams: dynamic, topCalcFormatter: Formatter?, topCalcFormatterParams: dynamic, bottomCalc: Calc?, bottomCalcParams: dynamic, bottomCalcFormatter: Formatter?, bottomCalcFormatterParams: dynamic, headerSort: Boolean?, headerSortStartingDir: SortingDir?, headerSortTristate: Boolean?, headerClick: (dynamic, column: Tabulator.ColumnComponent) -> Unit?, headerDblClick: (dynamic, column: Tabulator.ColumnComponent) -> Unit?, headerContext: (dynamic, column: Tabulator.ColumnComponent) -> Unit?, headerTap: (dynamic, column: Tabulator.ColumnComponent) -> Unit?, headerDblTap: (dynamic, column: Tabulator.ColumnComponent) -> Unit?, headerTapHold: (dynamic, column: Tabulator.ColumnComponent) -> Unit?, headerTooltip: (column: Tabulator.ColumnComponent) -> String?, headerVertical: Boolean?, editableTitle: Boolean?, titleFormatter: Formatter?, titleFormatterParams: dynamic, headerFilter: Editor?, headerFilterParams: dynamic, headerFilterPlaceholder: String?, headerFilterEmptyCheck: (value: Any) -> Boolean?, headerFilterFunc: Filter?, headerFilterFuncCustom: (dynamic, dynamic, dynamic, dynamic) -> Boolean?, headerFilterFuncParams: dynamic, headerFilterLiveFilter: Boolean?, htmlOutput: Boolean?, print: Boolean?, cellClick: (dynamic, cell: Tabulator.CellComponent) -> Unit?, cellDblClick: (dynamic, cell: Tabulator.CellComponent) -> Unit?, cellContext: (dynamic, cell: Tabulator.CellComponent) -> Unit?, cellTap: (dynamic, cell: Tabulator.CellComponent) -> Unit?, cellDblTap: (dynamic, cell: Tabulator.CellComponent) -> Unit?, cellTapHold: (dynamic, cell: Tabulator.CellComponent) -> Unit?, cellMouseEnter: (dynamic, cell: Tabulator.CellComponent) -> Unit?, cellMouseLeave: (dynamic, cell: Tabulator.CellComponent) -> Unit?, cellMouseOver: (dynamic, cell: Tabulator.CellComponent) -> Unit?, cellMouseOut: (dynamic, cell: Tabulator.CellComponent) -> Unit?, cellMouseMove: (dynamic, cell: Tabulator.CellComponent) -> Unit?, cellEditing: (cell: Tabulator.CellComponent) -> Unit?, cellEdited: (cell: Tabulator.CellComponent) -> Unit?, cellEditCancelled: (cell: Tabulator.CellComponent) -> Unit?, headerMenu: dynamic, headerContextMenu: dynamic, contextMenu: dynamic, hozAlign: Align?, vertAlign: VAlign?, clickMenu: dynamic, headerHozAlign: Align?, accessor: dynamic, accessorParams: dynamic, maxWidth: Int?)

Column definition options.

ColumnPosition

enum ColumnPosition : Enum<ColumnPosition>

Column positions.

DownloadConfig

data class DownloadConfig(columnGroups: Boolean?, rowGroups: Boolean?, columnCalcs: Boolean?)

Download config options.

Editor

enum Editor : Enum<Editor>

Built-in editors.

Filter

enum Filter : Enum<Filter>

Filters.

Formatter

enum Formatter : Enum<Formatter>

Built-in formatters.

Layout

enum Layout : Enum<Layout>

Table layouts.

PaginationMode

enum PaginationMode : Enum<PaginationMode>

Pagination modes.

ProgressiveMode

enum ProgressiveMode : Enum<ProgressiveMode>

Progressive modes.

RangeMode

enum RangeMode : Enum<RangeMode>

Range select modes.

ResponsiveLayout

enum ResponsiveLayout : Enum<ResponsiveLayout>

Responsive layout modes.

RowPos

enum RowPos : Enum<RowPos>

Row positions.

RowPosition

enum RowPosition : Enum<RowPosition>

Row scroll positions .

RowRangeLookup

enum RowRangeLookup : Enum<RowRangeLookup>

Tabulator row range lookup set option.

Sorter

enum Sorter : Enum<Sorter>

Built-in sorters.

SortingDir

enum SortingDir : Enum<SortingDir>

Sorting directions.

Tabulator

open class Tabulator<T : Any>(data: List<T>?, dataUpdateOnEdit: Boolean, options: TabulatorOptions<T>, types: Set<TableType>, classes: Set<String>, kClass: KClass<T>?) : Widget

Tabulator component.

TabulatorOptions

data class TabulatorOptions<T : Any>(height: String?, virtualDom: Boolean?, virtualDomBuffer: Int?, placeholder: String?, footerElement: String?, tooltips: (cell: Tabulator.CellComponent) -> String?, tooltipGenerationMode: TooltipGenerationMode?, history: Boolean?, keybindings: dynamic, downloadDataFormatter: dynamic, downloadConfig: DownloadConfig?, reactiveData: Boolean?, autoResize: Boolean?, columns: List<ColumnDefinition<T>>?, autoColumns: Boolean?, layout: Layout?, layoutColumnsOnNewData: Boolean?, responsiveLayout: ResponsiveLayout?, responsiveLayoutCollapseStartOpen: Boolean?, responsiveLayoutCollapseUseFormatters: Boolean?, columnMinWidth: Int?, resizableColumns: Boolean?, movableColumns: Boolean?, tooltipsHeader: Boolean?, headerFilterPlaceholder: String?, scrollToColumnPosition: ColumnPosition?, scrollToColumnIfVisible: Boolean?, rowFormatter: (row: Tabulator.RowComponent) -> Unit?, addRowPos: RowPos?, selectable: dynamic, selectableRangeMode: RangeMode?, selectableRollingSelection: Boolean?, selectablePersistence: Boolean?, selectableCheck: (row: Tabulator.RowComponent) -> Boolean?, movableRows: Boolean?, movableRowsConnectedTables: dynamic, movableRowsSender: dynamic, movableRowsReceiver: dynamic, resizableRows: Boolean?, scrollToRowPosition: RowPosition?, scrollToRowIfVisible: Boolean?, index: String?, data: Array<T>?, ajaxURL: String?, ajaxParams: dynamic, ajaxConfig: dynamic, ajaxContentType: dynamic, ajaxURLGenerator: (url: String, dynamic, dynamic) -> String?, ajaxRequestFunc: (url: String, dynamic, dynamic) -> <ERROR CLASS><Any>?, ajaxFiltering: Boolean?, ajaxSorting: Boolean?, ajaxProgressiveLoad: ProgressiveMode?, ajaxProgressiveLoadDelay: Int?, ajaxProgressiveLoadScrollMargin: Int?, ajaxLoader: Boolean?, ajaxLoaderLoading: String?, ajaxLoaderError: String?, initialSort: List<Tabulator.Sorter>?, sortOrderReverse: Boolean?, initialFilter: List<Tabulator.Filter>?, initialHeaderFilter: List<Any?>?, pagination: PaginationMode?, paginationSize: Int?, paginationSizeSelector: Boolean?, paginationElement: dynamic, paginationDataReceived: dynamic, paginationDataSent: dynamic, paginationAddRow: AddRowMode?, paginationButtonCount: Int?, persistenceID: String?, persistenceMode: Boolean?, persistentLayout: Boolean?, persistentSort: Boolean?, persistentFilter: Boolean?, locale: String?, langs: dynamic, localized: (locale: String, dynamic) -> Unit?, headerVisible: Boolean?, htmlOutputConfig: dynamic, printAsHtml: Boolean?, printConfig: dynamic, printCopyStyle: Boolean?, printVisibleRows: Boolean?, printHeader: String?, printFooter: String?, printFormatter: (dynamic, dynamic) -> Unit?, tabEndNewRow: dynamic, headerSort: Boolean?, headerSortTristate: Boolean?, invalidOptionWarnings: Boolean?, dataTree: Boolean?, dataTreeChildField: String?, dataTreeCollapseElement: dynamic, dataTreeExpandElement: dynamic, dataTreeElementColumn: String?, dataTreeBranchElement: dynamic, dataTreeChildIndent: Number?, dataTreeStartExpanded: (row: Tabulator.RowComponent, level: Number) -> Boolean?, dataTreeRowExpanded: (row: Tabulator.RowComponent, level: Number) -> Unit?, dataTreeRowCollapsed: (row: Tabulator.RowComponent, level: Number) -> Unit?, movableRowsSendingStart: (toTables: Array<Any>) -> Unit?, movableRowsSent: (fromRow: Tabulator.RowComponent, toRow: Tabulator.RowComponent, toTable: Tabulator) -> Unit?, movableRowsSentFailed: (fromRow: Tabulator.RowComponent, toRow: Tabulator.RowComponent, toTable: Tabulator) -> Unit?, movableRowsSendingStop: (toTables: Array<Any>) -> Unit?, movableRowsReceivingStart: (fromRow: Tabulator.RowComponent, toTable: Tabulator) -> Unit?, movableRowsReceived: (fromRow: Tabulator.RowComponent, toRow: Tabulator.RowComponent, fromTable: Tabulator) -> Unit?, movableRowsReceivedFailed: (fromRow: Tabulator.RowComponent, toRow: Tabulator.RowComponent, fromTable: Tabulator) -> Unit?, movableRowsReceivingStop: (fromTable: Tabulator) -> Unit?, rowClick: (dynamic, row: Tabulator.RowComponent) -> Unit?, rowDblClick: (dynamic, row: Tabulator.RowComponent) -> Unit?, rowContext: (dynamic, row: Tabulator.RowComponent) -> Unit?, rowTap: (dynamic, row: Tabulator.RowComponent) -> Unit?, rowDblTap: (dynamic, row: Tabulator.RowComponent) -> Unit?, rowTapHold: (dynamic, row: Tabulator.RowComponent) -> Unit?, rowMouseEnter: (dynamic, row: Tabulator.RowComponent) -> Unit?, rowMouseLeave: (dynamic, row: Tabulator.RowComponent) -> Unit?, rowMouseOver: (dynamic, row: Tabulator.RowComponent) -> Unit?, rowMouseOut: (dynamic, row: Tabulator.RowComponent) -> Unit?, rowMouseMove: (dynamic, row: Tabulator.RowComponent) -> Unit?, rowAdded: (row: Tabulator.RowComponent) -> Unit?, rowUpdated: (row: Tabulator.RowComponent) -> Unit?, rowDeleted: (row: Tabulator.RowComponent) -> Unit?, rowMoved: (row: Tabulator.RowComponent) -> Unit?, rowResized: (row: Tabulator.RowComponent) -> Unit?, rowSelectionChanged: (data: Array<Any>, rows: Array<Tabulator.RowComponent>) -> Unit?, rowSelected: (row: Tabulator.RowComponent) -> Unit?, rowDeselected: (row: Tabulator.RowComponent) -> Unit?, cellClick: (e: Any, cell: Tabulator.CellComponent) -> Unit?, cellDblClick: (e: Any, cell: Tabulator.CellComponent) -> Unit?, cellContext: (e: Any, cell: Tabulator.CellComponent) -> Unit?, cellTap: (e: Any, cell: Tabulator.CellComponent) -> Unit?, cellDblTap: (e: Any, cell: Tabulator.CellComponent) -> Unit?, cellTapHold: (e: Any, cell: Tabulator.CellComponent) -> Unit?, cellMouseEnter: (e: Any, cell: Tabulator.CellComponent) -> Unit?, cellMouseLeave: (e: Any, cell: Tabulator.CellComponent) -> Unit?, cellMouseOver: (e: Any, cell: Tabulator.CellComponent) -> Unit?, cellMouseOut: (e: Any, cell: Tabulator.CellComponent) -> Unit?, cellMouseMove: (e: Any, cell: Tabulator.CellComponent) -> Unit?, cellEditing: (cell: Tabulator.CellComponent) -> Unit?, cellEdited: (cell: Tabulator.CellComponent) -> Unit?, cellEditCancelled: (cell: Tabulator.CellComponent) -> Unit?, columnMoved: (column: Tabulator.ColumnComponent, columns: Array<dynamic>) -> Unit?, columnResized: (column: Tabulator.ColumnComponent) -> Unit?, columnVisibilityChanged: (column: Tabulator.ColumnComponent, visible: Boolean) -> Unit?, columnTitleChanged: (column: Tabulator.ColumnComponent) -> Unit?, tableBuilding: () -> Unit?, tableBuilt: () -> Unit?, renderStarted: () -> Unit?, renderComplete: () -> Unit?, htmlImporting: () -> Unit?, htmlImported: () -> Unit?, dataLoading: (data: List<T>) -> Unit?, dataLoaded: (data: List<T>) -> Unit?, dataChanged: (data: List<T>) -> Unit?, pageLoaded: (pageno: Int) -> Unit?, dataSorting: (sorters: Array<Tabulator.Sorter>) -> Unit?, dataSorted: (sorters: Array<Tabulator.Sorter>, rows: Array<Tabulator.RowComponent>) -> Unit?, dataFiltering: (filters: Array<Tabulator.Filter>) -> Unit?, dataFiltered: (filters: Array<Tabulator.Filter>, rows: Array<Tabulator.RowComponent>) -> Unit?, validationFailed: (cell: Tabulator.CellComponent, value: Any, dynamic) -> Unit?, ajaxRequesting: (url: String, dynamic) -> Boolean?, ajaxResponse: (url: String, dynamic, dynamic) -> Any?, ajaxError: (dynamic) -> Unit?, persistence: dynamic, persistenceReaderFunc: dynamic, persistenceWriterFunc: dynamic, paginationInitialPage: Int?, columnHeaderVertAlign: VAlign?, maxHeight: String?, minHeight: String?, rowContextMenu: dynamic, dataTreeChildColumnCalcs: Boolean?, dataTreeSelectPropagate: Boolean?, cellHozAlign: Align?, cellVertAlign: VAlign?, headerFilterLiveFilterDelay: Int?, textDirection: TextDirection?, virtualDomHoz: Boolean?, autoColumnsDefinitions: dynamic, rowClickMenu: dynamic, headerHozAlign: Align?, headerSortElement: String?, dataTreeFilter: Boolean?, dataTreeSort: Boolean?, columnMaxWidth: Int?)

Tabulator options.

TabulatorRemote

open class TabulatorRemote<T : Any, E : Any>(serviceManager: <ERROR CLASS><E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?, String?) -> <ERROR CLASS><T>, stateFunction: () -> String?, options: TabulatorOptions<T>, types: Set<TableType>, classes: Set<String>, kClass: KClass<T>?) : Tabulator<T>

Tabulator component connected to the multiplatform service.

TextDirection

enum TextDirection : Enum<TextDirection>

Text direction.

TooltipGenerationMode

enum TooltipGenerationMode : Enum<TooltipGenerationMode>

Tooltip generation mode.

Validator

enum Validator : Enum<Validator>

Built-in validators.

VAlign

enum VAlign : Enum<VAlign>

Column align.

Functions

tabulator

inline fun <T : Any> Container.tabulator(options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String>? = null, className: String? = null, noinline init: Tabulator<T>.() -> Unit? = null): Tabulator<T>

DSL builder extension function for dynamic data (send within options parameter).

inline fun <T : Any, S : Any> Container.tabulator(store: ObservableState<S>, noinline dataFactory: (S) -> List<T>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String>? = null, className: String? = null, noinline init: Tabulator<T>.() -> Unit? = null): Tabulator<T>

DSL builder extension function for a general observable store.

inline fun <T : Any> Container.tabulator(data: List<T>? = null, dataUpdateOnEdit: Boolean = true, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String>? = null, className: String? = null, noinline init: Tabulator<T>.() -> Unit? = null): Tabulator<T>

DSL builder extension function.

tabulatorRemote

inline fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: <ERROR CLASS><E>, noinline function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?, String?) -> <ERROR CLASS><T>, noinline stateFunction: () -> String? = null, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String>? = null, className: String? = null, noinline init: TabulatorRemote<T, E>.() -> Unit? = null): TabulatorRemote<T, E>

DSL builder extension function.

toJs

fun DownloadConfig.toJs(): Tabulator.AddditionalExportOptions

An extension function to convert download config class to JS object.

fun <T : Any> ColumnDefinition<T>.toJs(tabulator: Tabulator<T>, i18nTranslator: (String) -> String, kClass: KClass<T>?): Tabulator.ColumnDefinition

An extension function to convert column definition class to JS object.

fun <T : Any> TabulatorOptions<T>.toJs(tabulator: Tabulator<T>, i18nTranslator: (String) -> String, kClass: KClass<T>?): Tabulator.Options

An extension function to convert tabulator options class to JS object.