kvision / pl.treksoft.kvision.tabulator / TabulatorRemote

TabulatorRemote

open class TabulatorRemote<T : Any, E : Any> : Tabulator<T>

Tabulator component connected to the multiplatform service.

Constructors

TabulatorRemote(serviceManager: KVServiceManager<E>, function: E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?) -> <ERROR CLASS><T>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf())

Inherited Properties

data	`val data: List<T>?` a list of objects
dataUpdateOnEdit	`val dataUpdateOnEdit: Boolean` determines if the data model is automatically updated after tabulator edit action
filter	`var filter: ((T) -> Boolean)?`
jsTabulator	`var jsTabulator: Tabulator?` Native Tabulator object.
options	`val options: TabulatorOptions<T>` tabulator options
types	`var types: Set<TableType>` Table types.

Inherited Functions

addColumn	`open fun addColumn(columnDefinition: ColumnDefinition<T>, insertRightOfTarget: Boolean? = null, positionTarget: String? = null): Unit` `open fun addColumn(columnDefinition: Tabulator.ColumnDefinition, insertRightOfTarget: Boolean? = null, positionTarget: String? = null): Unit` Add new column to the tabulator.
afterDestroy	`open fun afterDestroy(): Unit` Method called after destroying Snabbdom vnode.
afterInsert	`open fun afterInsert(node: VNode): Unit` Method called after inserting Snabbdom vnode into the DOM.
applyFilter	`open fun applyFilter(): Unit` Applies the current filter.
clearData	`open fun clearData(): Unit?` Clears the data in the table.
clearFilter	`open fun clearFilter(includeHeaderFilters: Boolean = true): Unit` Clears current filters.
clearHeaderFilter	`open fun clearHeaderFilter(): Unit` Clears header filters.
clearSort	`open fun clearSort(): Unit` Clears current sort.
createJsTabulator	`fun createJsTabulator(): Unit` Creates internal JS Tabulator object
deleteColumn	`open fun deleteColumn(name: String): Unit` Delete column by name.
deselectRow	`open fun deselectRow(row: Int): Unit` Deselect the row given by id.
getColumn	`open fun getColumn(name: String): Tabulator.ColumnComponent?` Get column component by name.
getData	`open fun getData(active: Boolean): List<T>?` Returns the current data in the table.
getDataCount	`open fun getDataCount(activeOnly: Boolean = false): 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.
getHtml	`open fun getHtml(activeOnly: Boolean = false, isStyled: Boolean = false, htmlOutputConfig: dynamic = null): String?` Get the HTML code of the table.
getPage	`open fun getPage(): Int` Returns current page number.
getPageMax	`open fun getPageMax(): Int` Returns number of pages.
getPageSize	`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.
getSnClass	`open fun getSnClass(): List<StringBoolPair>` Returns list of CSS class names for current widget in the form of a List.
navigateDown	`open fun navigateDown(): Unit` Navigate to the same cell in the row below.
navigateLeft	`open fun navigateLeft(): Unit` Navigate to the cell on the left.
navigateNext	`open fun navigateNext(): Unit` Navigate to the next cell.
navigatePrev	`open fun navigatePrev(): Unit` Navigate to the previous cell.
navigateRight	`open fun navigateRight(): Unit` Navigate to the cell on the right.
navigateUp	`open fun navigateUp(): Unit` Navigate to the same cell in the row above.
nextPage	`open fun nextPage(): Unit` Navigate to the next page.
previousPage	`open fun previousPage(): Unit` Navigate to the previous page.
print	`open fun print(activeOnly: Boolean = false, isStyled: Boolean = false, printConfig: dynamic = null): Unit?` Print the table.
redo	`open fun redo(): Boolean` Redo the last undone user action.
redraw	`open fun redraw(force: Boolean = false): Unit` Redraw the table (e.g. after a resize).
render	`open fun render(): VNode` Renders current component as a Snabbdom vnode.
replaceData	`open fun replaceData(data: Array<T>): Unit` Silently replaces the data in a table.
scrollToRow	`open fun scrollToRow(row: Int, position: RowPosition? = null, ifVisible: Boolean? = null): Unit` Scroll to the row given by id.
selectRow	`open fun selectRow(row: Int): Unit` Select the row given by id.
setData	`open fun setData(data: Array<T>): Unit` Sets new data in a table.
setFilter	`open fun setFilter(filter: (T) -> Boolean): Unit` Sets the external filter for the data.
setHeight	`open fun setHeight(height: Int): Unit` Change the height of the table.
setPage	`open fun setPage(page: Int): Unit` Shows given page.
setPageSize	`open fun setPageSize(size: Int): Unit` Set the size of a page.
setPageToRow	`open fun setPageToRow(row: Int): Unit` Shows page with a row given by id.
toggleSelectRow	`open fun toggleSelectRow(row: Int): Unit` Toggle selection status of the row given by id.
undo	`open fun undo(): Boolean` Undo the last user action.

Companion Object Functions

tabulatorRemote

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

DSL builder extension function.

Extension Functions

createInstance

fun <T> Any?.createInstance(vararg args: dynamic): T

Helper function for creating JavaScript objects from dynamic constructors.