kvision-tabulator4/io.kvision.tabulator/Tabulator

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)

Tabulator component.

Parameters

T

type

data

a list of objects

dataUpdateOnEdit

determines if the data model is automatically updated after tabulator edit action

options

tabulator options

types

a set of table types

className

CSS class names

kClass

Kotlin class

serializer

the serializer for type T

module

optional serialization module with custom serializers

Constructors

fun <T : Any> Tabulator( data: List<T>? = null, dataUpdateOnEdit: Boolean = true, 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)

Types

object Companion

Functions

open fun addColumn( columnDefinition: ColumnDefinition<T>, insertRightOfTarget: Boolean? = null, positionTarget: String? = null)

open fun addColumn( columnDefinition: Tabulator.ColumnDefinition, insertRightOfTarget: Boolean? = null, positionTarget: String? = null)

Add new column to the tabulator.

open fun afterDestroy()

open fun afterInsert(node: <Error class: unknown class>)

open fun applyFilter()

Applies the current filter.

open fun buildClassSet(classSetBuilder: <Error class: unknown class>)

open fun clearData(): Unit?

Clears the data in the table.

open fun clearFilter(includeHeaderFilters: Boolean = true)

Clears current filters.

clearHeaderFilter

open fun clearHeaderFilter()

Clears header filters.

open fun clearSort()

Clears current sort.

open fun deleteColumn(name: String)

Delete column by name.

open fun deselectRow(row: dynamic = undefined)

Deselect the row.

open fun dispose()

open fun downloadCSV( fileName: String? = null, dataSet: RowRangeLookup = RowRangeLookup.ACTIVE, delimiter: Char = ',', includeBOM: Boolean = false, newTab: Boolean = false): Unit?

Download the table content as CSV

open fun downloadHTML( fileName: String? = null, dataSet: RowRangeLookup = RowRangeLookup.ACTIVE, style: Boolean = false, newTab: Boolean = false): Unit?

Download the table content as HTML

open fun downloadJSON( fileName: String? = null, dataSet: RowRangeLookup = RowRangeLookup.ACTIVE, newTab: Boolean = false): Unit?

Download the table content as JSON

open fun getColumn(name: String): Tabulator.ColumnComponent?

Get column component by name.

open fun getData(rowRangeLookup: RowRangeLookup? = null): List<T>?

Returns the current data in the table.

open fun getDataCount(rowRangeLookup: RowRangeLookup? = null): Int

Get the number of data rows.

getHistoryRedoSize

open fun getHistoryRedoSize(): Int

Get the number of history redo actions available.

getHistoryUndoSize

open fun getHistoryUndoSize(): Int

Get the number of history undo actions available.

open fun getHtml( rowRangeLookup: RowRangeLookup, isStyled: Boolean = false, htmlOutputConfig: dynamic = null): String?

Get the HTML code of the table.

open fun getPage(): Int

Returns current page number.

open fun getPageMax(): Int

Returns number of pages.

open fun getPageSize(): Int

Returns the size of a page.

getSelectedData

open fun getSelectedData(): List<T>

Returns the selected data in the table.

getSelectedRows

open fun getSelectedRows(): List<Tabulator.RowComponent>

Returns the selected rows.

open fun navigateDown()

Navigate to the same cell in the row below.

open fun navigateLeft()

Navigate to the cell on the left.

open fun navigateNext()

Navigate to the next cell.

open fun navigatePrev()

Navigate to the previous cell.

open fun navigateRight()

Navigate to the cell on the right.

open fun navigateUp()

Navigate to the same cell in the row above.

open fun nextPage()

Navigate to the next page.

open fun previousPage()

Navigate to the previous page.

open fun print( rowRangeLookup: RowRangeLookup, isStyled: Boolean = false, printConfig: dynamic = null): Unit?

Print the table.

open fun redo(): Boolean

Redo the last undone user action.

open fun redraw(force: Boolean = false)

Redraw the table (e.g. after a resize).

open fun reload()

Reload table data.

open fun render(): <Error class: unknown class>

open fun replaceData(data: Array<T>)

Silently replaces the data in a table.

open fun scrollToRow( row: Int, position: RowPosition? = null, ifVisible: Boolean? = null)

Scroll to the row given by id.

open fun selectRow(row: dynamic = undefined)

Select the row.

open fun setData(data: Array<T>)

Sets new data in a table.

open fun setFilter(filter: (T) -> Boolean)

Sets the external filter for the data.

open fun setHeight(height: Int)

Change the height of the table.

open fun setPage(page: Int)

Shows given page.

open fun setPageSize(size: Int)

Set the size of a page.

open fun setPageToRow(row: Int)

Shows page with a row given by id.

toggleSelectRow

open fun toggleSelectRow(row: dynamic = undefined)

Toggle selection status of the row.

open fun undo(): Boolean

Undo the last user action.

Properties

var jsTabulator: Tabulator? = null

Native Tabulator object.

val options: TabulatorOptions<T>

var types: <Error class: unknown class>

Table types.