kvision/io.kvision.tabulator

Package-level declarations

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

Types

AddRowMode

enum AddRowMode : Enum<AddRowMode>

Add row modes.

AlertStyle

enum AlertStyle : Enum<AlertStyle>

Tabulator alert style options.

Align

enum Align : Enum<Align>

Column align.

Calc

enum Calc : Enum<Calc>

Built-in calc functions.

ColumnDefinition

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: (dynamic, dynamic, aRow: Tabulator.RowComponent, bRow: Tabulator.RowComponent, column: Tabulator.ColumnComponent, dir: SortingDir, dynamic) -> Number? = null, val sorterParams: dynamic = null, val formatter: Formatter? = null, val formatterFunction: (cell: Tabulator.CellComponent, dynamic, 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: (dynamic) -> Unit, cancel: (dynamic) -> Unit, dynamic) -> dynamic? = null, val editorComponentFunction: (cell: Tabulator.CellComponent, onRendered: (callback: () -> Unit) -> Unit, success: (dynamic) -> Unit, cancel: (dynamic) -> 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 topCalcParams: dynamic = null, val topCalcFormatter: Formatter? = null, val topCalcFormatterParams: dynamic = null, val bottomCalc: Calc? = 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: (dynamic, column: Tabulator.ColumnComponent) -> Unit? = null, val headerDblClick: (dynamic, column: Tabulator.ColumnComponent) -> Unit? = null, val headerContext: (dynamic, column: Tabulator.ColumnComponent) -> Unit? = null, val headerTap: (dynamic, column: Tabulator.ColumnComponent) -> Unit? = null, val headerDblTap: (dynamic, column: Tabulator.ColumnComponent) -> Unit? = null, val headerTapHold: (dynamic, 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, dynamic, 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: (dynamic) -> Unit, cancel: (dynamic) -> Unit, dynamic) -> dynamic? = null, val headerFilterPlaceholder: String? = null, val headerFilterEmptyCheck: (value: Any) -> Boolean? = null, val headerFilterFunc: Filter? = null, val headerFilterFuncCustom: (dynamic, dynamic, dynamic, dynamic) -> Boolean? = null, val headerFilterFuncParams: dynamic = null, val headerFilterLiveFilter: Boolean? = null, val htmlOutput: dynamic = null, val print: dynamic = null, val formatterPrint: (cell: Tabulator.CellComponent, dynamic, onRendered: (callback: () -> Unit) -> Unit) -> dynamic? = null, val formatterPrintParams: dynamic = null, val cellClick: (dynamic, cell: Tabulator.CellComponent) -> Unit? = null, val cellDblClick: (dynamic, cell: Tabulator.CellComponent) -> Unit? = null, val cellContext: (dynamic, cell: Tabulator.CellComponent) -> Unit? = null, val cellTap: (dynamic, cell: Tabulator.CellComponent) -> Unit? = null, val cellDblTap: (dynamic, cell: Tabulator.CellComponent) -> Unit? = null, val cellTapHold: (dynamic, cell: Tabulator.CellComponent) -> Unit? = null, val cellMouseEnter: (dynamic, cell: Tabulator.CellComponent) -> Unit? = null, val cellMouseLeave: (dynamic, cell: Tabulator.CellComponent) -> Unit? = null, val cellMouseOver: (dynamic, cell: Tabulator.CellComponent) -> Unit? = null, val cellMouseOut: (dynamic, cell: Tabulator.CellComponent) -> Unit? = null, val cellMouseMove: (dynamic, 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: (dynamic, dynamic, type: String, dynamic, cell: Tabulator.CellComponent) -> Any? = null, val mutatorDataParams: dynamic = null, val mutatorEdit: (dynamic, dynamic, type: String, dynamic, cell: Tabulator.CellComponent) -> Any? = null, val mutatorEditParams: dynamic = null, val mutatorClipboard: (dynamic, dynamic, type: String, dynamic, cell: Tabulator.CellComponent) -> Any? = null, val mutatorClipboardParams: dynamic = null, val mutator: (dynamic, dynamic, type: String, dynamic, 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)

Column definition options.

ColumnPosition

enum ColumnPosition : Enum<ColumnPosition>

Column positions.

DownloadConfig

data class DownloadConfig(val columnGroups: Boolean? = null, val rowGroups: Boolean? = null, val columnCalcs: Boolean? = null, val rowHeaders: Boolean? = null)

Download config options.

Editor

enum Editor : Enum<Editor>

Built-in editors.

EditTriggerEvent

enum EditTriggerEvent : Enum<EditTriggerEvent>

Possible edit trigger events.

Filter

enum Filter : Enum<Filter>

Filters.

FilterMode

enum FilterMode : Enum<FilterMode>

Filter modes.

Formatter

enum Formatter : Enum<Formatter>

Built-in formatters.

HeaderSortClickElement

enum HeaderSortClickElement : Enum<HeaderSortClickElement>

Possible header sort click elements.

ImportFormat

enum ImportFormat : Enum<ImportFormat>

Import formats.

ImportReader

enum ImportReader : Enum<ImportReader>

Import readers.

Layout

enum Layout : Enum<Layout>

Table layouts.

PaginationMode

enum PaginationMode : Enum<PaginationMode>

Pagination modes.

PaginationState

data class PaginationState(val currentPage: Int, val maxPages: Int, val buttonCount: Int = 5)

Pagination state.

ProgressiveMode

enum ProgressiveMode : Enum<ProgressiveMode>

Progressive modes.

RangeMode

enum RangeMode : Enum<RangeMode>

Range select modes.

RenderType

enum RenderType : Enum<RenderType>

Virtual DOM options.

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.

SortMode

enum SortMode : Enum<SortMode>

Sort modes.

TableType

enum TableType : Enum<TableType>

Tabulator table types.

Tabulator

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: <Error class: unknown class><T>? = null, module: <Error class: unknown class>? = null) : Widget

Tabulator component.

TabulatorOptions

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, dynamic, dynamic) -> String? = null, var ajaxRequestFunc: (url: String, dynamic, dynamic) -> <Error class: unknown class><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, dynamic) -> 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: (dynamic, dynamic) -> 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, dynamic) -> Boolean? = null, val ajaxResponse: (url: String, dynamic, dynamic) -> 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<dynamic>) -> <Error class: unknown class>? = 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: (dynamic) -> Boolean? = null)

Tabulator options.

TabulatorPagination

open class TabulatorPagination<T : Any>(className: String? = null, init: TabulatorPagination<T>.() -> Unit? = null) : SimplePanel

External tabulator pagination component.

TabulatorRemote

open class TabulatorRemote<T : Any, out E : Any>(serviceManager: <Error class: unknown class><E>, function: suspend E.(Int?, Int?, List<<Error class: unknown class>>?, List<<Error class: unknown class>>?, String?) -> <Error class: unknown class><T>, stateFunction: () -> String? = null, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, kClass: KClass<T>? = null, serializer: <Error class: unknown class><T>? = null, module: <Error class: unknown class>? = null, requestFilter: suspend <Error class: unknown class>.() -> Unit? = null) : Tabulator<T>

Tabulator component connected to the fullstack service.

TextDirection

enum TextDirection : Enum<TextDirection>

Text direction.

Validator

enum Validator : Enum<Validator>

Built-in validators.

VAlign

enum VAlign : Enum<VAlign>

Column align.

Functions

tabulator

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: <Error class: unknown class><T> = serializer(), serializersModule: <Error class: unknown class>? = 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: <Error class: unknown class><T> = serializer(), serializersModule: <Error class: unknown class>? = null, noinline init: Tabulator<T>.() -> Unit? = null): Tabulator<T>

DSL builder extension function.

tabulatorPagination

fun <T : Any> Container.tabulatorPagination(className: String? = null, init: TabulatorPagination<T>.() -> Unit? = null): TabulatorPagination<T>

DSL builder extension function.

tabulatorRemote

inline fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: <Error class: unknown class><E>, noinline function: suspend E.(Int?, Int?, List<<Error class: unknown class>>?, List<<Error class: unknown class>>?, String?) -> <Error class: unknown class><T>, noinline stateFunction: () -> String? = null, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, serializer: <Error class: unknown class><T>? = null, module: <Error class: unknown class>? = null, noinline requestFilter: suspend <Error class: unknown class>.() -> Unit? = 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.