Package-level declarations
Full-featured grid/table component based on the Tabulator library.
Types
Link copied to clipboard
Add row modes.
Link copied to clipboard
Tabulator alert style options.
Link copied to clipboard
data class ColumnDefinition<T : Any>(val title: String, val field: String? = null, val columns: List<ColumnDefinition<T>>? = null, val visible: Boolean? = null, val align: Align? = null, val width: String? = null, val minWidth: Int? = null, val widthGrow: Int? = null, val widthShrink: Int? = null, val resizable: dynamic = null, val frozen: Boolean? = null, val responsive: Int? = null, val tooltip: dynamic = null, val cssClass: String? = null, val rowHandle: Boolean? = null, val hideInHtml: Boolean? = null, val sorter: Sorter? = null, val sorterFunction: (a: Any?, b: Any?, aRow: Tabulator.RowComponent, bRow: Tabulator.RowComponent, column: Tabulator.ColumnComponent, dir: SortingDir, sorterParams: Any?) -> Number? = null, val sorterParams: dynamic = null, val formatter: Formatter? = null, val formatterFunction: (cell: Tabulator.CellComponent, formatterParams: Any?, onRendered: (callback: () -> Unit) -> Unit) -> dynamic? = null, val formatterComponentFunction: (cell: Tabulator.CellComponent, onRendered: (callback: () -> Unit) -> Unit, data: T) -> Component? = null, val formatterParams: dynamic = null, val variableHeight: Boolean? = null, val editable: (cell: Tabulator.CellComponent) -> Boolean? = null, val editor: Editor? = null, val editorFunction: (cell: Tabulator.CellComponent, onRendered: (callback: () -> Unit) -> Unit, success: (value: Any?) -> Unit, cancel: (value: Any?) -> Unit, editorParams: Any?) -> dynamic? = null, val editorComponentFunction: (cell: Tabulator.CellComponent, onRendered: (callback: () -> Unit) -> Unit, success: (value: Any?) -> Unit, cancel: (value: Any?) -> Unit, data: T) -> Component? = null, val editorParams: dynamic = null, val validator: Validator? = null, val validatorFunction: dynamic = null, val validatorParams: String? = null, val download: dynamic = null, val titleDownload: String? = null, val topCalc: Calc? = null, val topCalcFunc: (dynamic, dynamic, dynamic) -> dynamic? = null, val topCalcParams: dynamic = null, val topCalcFormatter: Formatter? = null, val topCalcFormatterParams: dynamic = null, val bottomCalc: Calc? = null, val bottomCalcFunc: (dynamic, dynamic, dynamic) -> dynamic? = null, val bottomCalcParams: dynamic = null, val bottomCalcFormatter: Formatter? = null, val bottomCalcFormatterParams: dynamic = null, val headerSort: Boolean? = null, val headerSortStartingDir: SortingDir? = null, val headerSortTristate: Boolean? = null, val headerClick: (e: Any?, column: Tabulator.ColumnComponent) -> Unit? = null, val headerDblClick: (e: Any?, column: Tabulator.ColumnComponent) -> Unit? = null, val headerContext: (e: Any?, column: Tabulator.ColumnComponent) -> Unit? = null, val headerTap: (e: Any?, column: Tabulator.ColumnComponent) -> Unit? = null, val headerDblTap: (e: Any?, column: Tabulator.ColumnComponent) -> Unit? = null, val headerTapHold: (e: Any?, column: Tabulator.ColumnComponent) -> Unit? = null, val headerTooltip: dynamic = null, val headerVertical: Boolean? = null, val editableTitle: Boolean? = null, val titleFormatter: Formatter? = null, val titleFormatterFunction: (cell: Tabulator.CellComponent, formatterParams: Any?, onRendered: (callback: () -> Unit) -> Unit) -> dynamic? = null, val titleFormatterComponentFunction: (cell: Tabulator.CellComponent, onRendered: (callback: () -> Unit) -> Unit) -> Component? = null, val titleFormatterParams: dynamic = null, val headerFilter: Editor? = null, val headerFilterParams: dynamic = null, val headerFilterCustom: (cell: Tabulator.CellComponent, onRendered: (callback: () -> Unit) -> Unit, success: (value: Any?) -> Unit, cancel: (value: Any?) -> Unit, editorParams: Any?) -> dynamic? = null, val headerFilterPlaceholder: String? = null, val headerFilterEmptyCheck: (value: Any) -> Boolean? = null, val headerFilterFunc: Filter? = null, val headerFilterFuncCustom: (headerValue: Any?, rowValue: Any?, rowData: Any?, filterParams: Any?) -> Boolean? = null, val headerFilterFuncParams: dynamic = null, val headerFilterLiveFilter: Boolean? = null, val htmlOutput: dynamic = null, val print: dynamic = null, val formatterPrint: (cell: Tabulator.CellComponent, formatterParams: Any?, onRendered: (callback: () -> Unit) -> Unit) -> dynamic? = null, val formatterPrintParams: dynamic = null, val cellClick: (e: Any?, cell: Tabulator.CellComponent) -> Unit? = null, val cellDblClick: (e: Any?, cell: Tabulator.CellComponent) -> Unit? = null, val cellContext: (e: Any?, cell: Tabulator.CellComponent) -> Unit? = null, val cellTap: (e: Any?, cell: Tabulator.CellComponent) -> Unit? = null, val cellDblTap: (e: Any?, cell: Tabulator.CellComponent) -> Unit? = null, val cellTapHold: (e: Any?, cell: Tabulator.CellComponent) -> Unit? = null, val cellMouseEnter: (e: Any?, cell: Tabulator.CellComponent) -> Unit? = null, val cellMouseLeave: (e: Any?, cell: Tabulator.CellComponent) -> Unit? = null, val cellMouseOver: (e: Any?, cell: Tabulator.CellComponent) -> Unit? = null, val cellMouseOut: (e: Any?, cell: Tabulator.CellComponent) -> Unit? = null, val cellMouseMove: (e: Any?, cell: Tabulator.CellComponent) -> Unit? = null, val cellEditing: (cell: Tabulator.CellComponent) -> Unit? = null, val cellEdited: (cell: Tabulator.CellComponent) -> Unit? = null, val cellEditCancelled: (cell: Tabulator.CellComponent) -> Unit? = null, val headerMenu: dynamic = null, val headerContextMenu: dynamic = null, val contextMenu: dynamic = null, val hozAlign: Align? = null, val vertAlign: VAlign? = null, val clickMenu: dynamic = null, val headerHozAlign: Align? = null, val accessor: dynamic = null, val accessorParams: dynamic = null, val maxWidth: Int? = null, val mutatorData: (value: Any?, data: Any?, type: String, params: Any?, cell: Tabulator.CellComponent) -> Any? = null, val mutatorDataParams: dynamic = null, val mutatorEdit: (value: Any?, data: Any?, type: String, params: Any?, cell: Tabulator.CellComponent) -> Any? = null, val mutatorEditParams: dynamic = null, val mutatorClipboard: (value: Any?, data: Any?, type: String, params: Any?, cell: Tabulator.CellComponent) -> Any? = null, val mutatorClipboardParams: dynamic = null, val mutator: (value: Any?, data: Any?, type: String, params: Any?, cell: Tabulator.CellComponent) -> Any? = null, val mutatorParams: dynamic = null, val maxInitialWidth: Int? = null, val cellPopup: dynamic = null, val headerPopup: dynamic = null, val headerPopupIcon: dynamic = null, val headerContextPopup: dynamic = null, val clickPopup: dynamic = null, val contextPopup: dynamic = null, val headerMenuIcon: dynamic = null, val headerWordWrap: Boolean? = null, val dblClickPopup: dynamic = null, val headerClickPopup: dynamic = null, val headerDblClickPopup: dynamic = null, val headerClickMenu: dynamic = null, val headerDblClickMenu: dynamic = null, val dblClickMenu: dynamic = null, val headerColumnsMenu: Boolean? = null, val headerColumnsMenuTitle: String? = null, val headerColumnsMenuResetTitle: String? = null, val mutatorImport: dynamic = null, val mutatorImportParams: dynamic = null, val accessorDownload: dynamic = null, val accessorDownloadParams: dynamic = null)
Column definition options.
Link copied to clipboard
Column positions.
Link copied to clipboard
Link copied to clipboard
Possible edit trigger events.
Link copied to clipboard
Filter modes.
Link copied to clipboard
Possible header sort click elements.
Link copied to clipboard
Import formats.
Link copied to clipboard
Import readers.
Link copied to clipboard
Pagination modes.
Link copied to clipboard
Pagination state.
Link copied to clipboard
Progressive modes.
Link copied to clipboard
Virtual DOM options.
Link copied to clipboard
Responsive layout modes.
Link copied to clipboard
Row scroll positions .
Link copied to clipboard
Tabulator row range lookup set option.
Link copied to clipboard
Sorting directions.
Link copied to clipboard
open class Tabulator<T : Any>(data: List<T>? = null, dataUpdateOnEdit: Boolean = true, val options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, kClass: KClass<T>? = null, serializer: KSerializer<T>? = null, module: SerializersModule? = null) : Widget
Tabulator component.
Link copied to clipboard
data class TabulatorOptions<T : Any>(val height: String? = null, val placeholder: String? = null, val placeholderFunc: () -> String?? = null, val placeholderHeaderFilter: String? = null, val footerElement: String? = null, val history: Boolean? = null, val keybindings: dynamic = null, val downloadDataFormatter: dynamic = null, val downloadConfig: DownloadConfig? = null, val reactiveData: Boolean? = null, val autoResize: Boolean? = null, val columns: List<ColumnDefinition<T>>? = null, val autoColumns: Boolean? = null, val autoColumnsFull: Boolean? = null, val layout: Layout? = null, val layoutColumnsOnNewData: Boolean? = null, val responsiveLayout: ResponsiveLayout? = null, val responsiveLayoutCollapseStartOpen: Boolean? = null, val responsiveLayoutCollapseUseFormatters: Boolean? = null, val movableColumns: Boolean? = null, val scrollToColumnPosition: ColumnPosition? = null, val scrollToColumnIfVisible: Boolean? = null, val rowFormatter: (row: Tabulator.RowComponent) -> Unit? = null, val addRowPos: RowPos? = null, val selectableRows: dynamic = null, val selectableRowsRangeMode: RangeMode? = null, val selectableRowsRollingSelection: Boolean? = null, val selectableRowsPersistence: Boolean? = null, val selectableRowsCheck: (row: Tabulator.RowComponent) -> Boolean? = null, val movableRows: Boolean? = null, val movableRowsConnectedTables: dynamic = null, val movableRowsSender: dynamic = null, val movableRowsReceiver: dynamic = null, val resizableRows: Boolean? = null, val scrollToRowPosition: RowPosition? = null, val scrollToRowIfVisible: Boolean? = null, val index: String? = null, var data: Array<T>? = null, var ajaxURL: String? = null, val ajaxParams: dynamic = null, val ajaxConfig: dynamic = null, val ajaxContentType: dynamic = null, val ajaxURLGenerator: (url: String, config: Any?, params: Any?) -> String? = null, var ajaxRequestFunc: (url: String, config: Any?, params: Any?) -> Promise<Any>? = null, val progressiveLoad: ProgressiveMode? = null, val progressiveLoadDelay: Int? = null, val progressiveLoadScrollMargin: Int? = null, val dataLoader: Boolean? = null, val dataLoaderLoading: String? = null, val dataLoaderError: String? = null, val initialSort: List<Tabulator.Sorter>? = null, val sortOrderReverse: Boolean? = null, val initialFilter: List<Tabulator.Filter>? = null, val initialHeaderFilter: List<Any?>? = null, val pagination: Boolean? = null, val paginationMode: PaginationMode? = null, val paginationSize: Int? = null, val paginationSizeSelector: dynamic = null, val paginationElement: dynamic = null, val dataReceiveParams: dynamic = null, val dataSendParams: dynamic = null, val paginationAddRow: AddRowMode? = null, val paginationButtonCount: Int? = null, val persistenceID: String? = null, val persistenceMode: Boolean? = null, val persistentLayout: Boolean? = null, val persistentSort: Boolean? = null, val persistentFilter: Boolean? = null, val locale: String? = null, var langs: dynamic = null, val localized: (locale: String, lang: Any?) -> Unit? = null, val headerVisible: Boolean? = null, val htmlOutputConfig: dynamic = null, val printAsHtml: Boolean? = null, val printConfig: dynamic = null, val printCopyStyle: Boolean? = null, val printVisibleRows: Boolean? = null, val printHeader: String? = null, val printFooter: String? = null, val printFormatter: (tableHolder: Any?, table: Any?) -> Unit? = null, val tabEndNewRow: dynamic = null, val invalidOptionWarnings: Boolean? = null, val dataTree: Boolean? = null, val dataTreeChildField: String? = null, val dataTreeCollapseElement: dynamic = null, val dataTreeExpandElement: dynamic = null, val dataTreeElementColumn: String? = null, val dataTreeBranchElement: dynamic = null, val dataTreeChildIndent: Number? = null, val dataTreeStartExpanded: (row: Tabulator.RowComponent, level: Number) -> Boolean? = null, val ajaxRequesting: (url: String, params: Any?) -> Boolean? = null, val ajaxResponse: (url: String, params: Any?, response: Any?) -> Any? = null, val persistence: dynamic = null, val persistenceReaderFunc: dynamic = null, val persistenceWriterFunc: dynamic = null, val paginationInitialPage: Int? = null, val columnHeaderVertAlign: VAlign? = null, val maxHeight: String? = null, val minHeight: String? = null, val rowContextMenu: dynamic = null, val dataTreeChildColumnCalcs: Boolean? = null, val dataTreeSelectPropagate: Boolean? = null, val headerFilterLiveFilterDelay: Int? = null, val textDirection: TextDirection? = null, val autoColumnsDefinitions: dynamic = null, val rowClickMenu: dynamic = null, val headerSortElement: dynamic = null, val dataTreeFilter: Boolean? = null, val dataTreeSort: Boolean? = null, val renderVertical: RenderType? = null, val renderVerticalBuffer: Int? = null, val renderHorizontal: RenderType? = null, val columnDefaults: ColumnDefinition<T>? = null, val sortMode: SortMode? = null, val filterMode: FilterMode? = null, val importFormat: ImportFormat? = null, val importReader: ImportReader? = null, val dataLoaderErrorTimeout: Int? = null, val popupContainer: dynamic = null, val paginationCounter: dynamic = null, val paginationCounterElement: dynamic = null, val rowClickPopup: dynamic = null, val rowContextPopup: dynamic = null, val resizableColumnFit: Boolean? = null, val rowHeight: Int? = null, val frozenRows: dynamic = null, val frozenRowsField: String? = null, val headerSortClickElement: HeaderSortClickElement? = null, val rowDblClickPopup: dynamic = null, val rowDblClickMenu: dynamic = null, val responsiveLayoutCollapseFormatter: (data: Array<Any?>) -> Element? = null, val selectableRange: dynamic = null, val selectableRangeColumns: Boolean? = null, val selectableRangeRows: Boolean? = null, val selectableRangeClearCells: Boolean? = null, val selectableRangeClearCellsValue: String? = null, val editTriggerEvent: EditTriggerEvent? = null, val rowHeader: dynamic = null, val spreadsheet: Boolean? = null, val spreadsheetColumns: Int? = null, val spreadsheetRows: Int? = null, val spreadsheetData: dynamic = null, val spreadsheetColumnDefinition: dynamic = null, val spreadsheetOutputFull: Boolean? = null, val spreadsheetSheets: dynamic = null, val spreadsheetSheetTabs: Boolean? = null, val resizableColumnGuide: Boolean? = null, val resizableRowGuide: Boolean? = null, val editorEmptyValue: dynamic = null, val editorEmptyValueFunc: (Any?) -> Boolean? = null, val importHeaderTransform: (header: String, headers: Array<String>) -> String? = null, val importValueTransform: (dynamic, headers: Array<dynamic>) -> dynamic? = null, val importFileValidator: (dynamic) -> dynamic? = null, val importDataValidator: (dynamic) -> dynamic? = null, val paginationOutOfRange: dynamic = null, val selectableRangeAutoFocus: Boolean? = null, val groupBy: dynamic = null, val groupHeader: dynamic = null, val groupHeaderPrint: dynamic = null, val groupHeaderClipboard: dynamic = null, val groupHeaderDownload: dynamic = null, val groupHeaderHtmlOutput: dynamic = null, val groupStartOpen: dynamic = null, val groupToggleElement: dynamic = null, val groupValues: dynamic = null, val groupUpdateOnCellEdit: Boolean? = null, val groupClosedShowCalcs: Boolean? = null, val columnCalcs: dynamic = null, val downloadEncoder: dynamic = null)
Tabulator options.
Link copied to clipboard
open class TabulatorPagination<T : Any>(className: String? = null, init: TabulatorPagination<T>.() -> Unit? = null) : SimplePanel
External tabulator pagination component.
Link copied to clipboard
Text direction.
Functions
Link copied to clipboard
fun Container.tabulator(options: TabulatorOptions<dynamic> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, init: Tabulator<dynamic>.() -> Unit? = null): Tabulator<dynamic>
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(), className: String? = null, serializer: KSerializer<T> = serializer(), serializersModule: SerializersModule? = 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(), className: String? = null, serializer: KSerializer<T> = serializer(), serializersModule: SerializersModule? = null, noinline init: Tabulator<T>.() -> Unit? = null): Tabulator<T>
DSL builder extension function.
Link copied to clipboard
fun <T : Any> Container.tabulatorPagination(className: String? = null, init: TabulatorPagination<T>.() -> Unit? = null): TabulatorPagination<T>
DSL builder extension function.
Link copied to clipboard
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.