8.2.0

kvision-tabulator-remote/io.kvision.tabulator/TabulatorRemote

TabulatorRemote

open class TabulatorRemote<T : Any, out E : Any>(serviceManager: KVServiceMgr<E>, function: suspend E.(Int?, Int?, List<RemoteFilter>?, List<RemoteSorter>?, String?) -> RemoteData<T>, stateFunction: () -> String? = null, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, kClass: KClass<T>? = null, serializer: KSerializer<T>? = null, module: SerializersModule? = null, requestFilter: suspend RequestInit.() -> Unit? = null) : Tabulator<T> (source)

Tabulator component connected to the fullstack service.

Parameters

T

type of row data

E

type of service manager

serviceManager

fullstack service manager

function

fullstack service method returning tabulator rows data

stateFunction

a function to generate the state object passed with the remote request

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

requestFilter

a request filtering function

Constructors

TabulatorRemote

constructor(serviceManager: KVServiceMgr<E>, function: suspend E.(Int?, Int?, List<RemoteFilter>?, List<RemoteSorter>?, String?) -> RemoteData<T>, stateFunction: () -> String? = null, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, kClass: KClass<T>? = null, serializer: KSerializer<T>? = null, module: SerializersModule? = null, requestFilter: suspend RequestInit.() -> Unit? = null)

Properties

open var alignContent: AlignContent?

open var alignItems: AlignItems?

open var alignSelf: AlignItems?

open var background: Background?

open var border: Border?

open var borderBottom: Border?

open var borderLeft: Border?

open var borderRadius: CssSize?

borderRadiusList

open var borderRadiusList: List<CssSize>?

open var borderRight: Border?

open var borderTop: Border?

open var bottom: CssSize?

open var boxShadow: BoxShadow?

open var boxShadowList: List<BoxShadow>?

open var clear: Clear?

open var color: Color?

open var colorHex: Int?

open var colorName: Col?

open var cursor: Cursor?

open var display: Display?

var draggable: Boolean?

var eventTarget: Widget?

open var flexBasis: CssSize?

open var flexDirection: FlexDirection?

open var flexGrow: Int?

open var flexShrink: Int?

open var flexWrap: FlexWrap?

open var float: PosFloat?

open var fontFamily: String?

open var fontSize: CssSize?

open var fontStyle: FontStyle?

open var fontVariant: FontVariant?

open var fontWeight: FontWeight?

open var gridArea: String?

gridAutoColumns

open var gridAutoColumns: String?

open var gridAutoFlow: GridAutoFlow?

open var gridAutoRows: String?

open var gridColumnEnd: String?

open var gridColumnGap: Int?

gridColumnStart

open var gridColumnStart: Int?

open var gridRowEnd: String?

open var gridRowGap: Int?

open var gridRowStart: Int?

gridTemplateAreas

open var gridTemplateAreas: List<String>?

gridTemplateColumns

open var gridTemplateColumns: String?

gridTemplateRows

open var gridTemplateRows: String?

open var height: CssSize?

var id: String?

var jsTabulator: Tabulator?

open var justifyContent: JustifyContent?

open var justifyItems: JustifyItems?

open var justifySelf: JustifyItems?

var kvscope: dynamic

open var left: CssSize?

open var letterSpacing: CssSize?

open var lineBreak: LineBreak?

open var lineHeight: CssSize?

open var listStyle: ListStyle?

open var margin: CssSize?

open var marginBottom: CssSize?

open var marginLeft: CssSize?

open var marginRight: CssSize?

open var marginTop: CssSize?

open var maxHeight: CssSize?

open var maxWidth: CssSize?

open var minHeight: CssSize?

open var minWidth: CssSize?

open var opacity: Double?

val options: TabulatorOptions<T>

open var order: Int?

open var outline: Outline?

open var overflow: Overflow?

open var overflowWrap: OverflowWrap?

open var overflowX: Overflow?

open var overflowY: Overflow?

open var padding: CssSize?

open var paddingBottom: CssSize?

open var paddingLeft: CssSize?

open var paddingRight: CssSize?

open var paddingTop: CssSize?

open override var parent: Container?

popoverHooksActive

var popoverHooksActive: Boolean

var popoverOptions: dynamic

open var position: Position?

open var resize: Resize?

open var right: CssSize?

var role: String?

var tabindex: Int?

open var textAlign: TextAlign?

open var textDecoration: TextDecoration?

open var textDirection: Direction?

open var textIndent: CssSize?

open var textOverflow: TextOverflow?

open var textShadow: TextShadow?

open var textTransform: TextTransform?

var title: String?

tooltipHooksActive

var tooltipHooksActive: Boolean

var tooltipOptions: dynamic

open var top: CssSize?

open var transition: Transition?

open var transitionList: List<Transition>?

var types: Set<TableType>

open var unicodeBidi: UnicodeBidi?

open var verticalAlign: VerticalAlign?

open override var visible: Boolean

open var whiteSpace: WhiteSpace?

open var width: CssSize?

open var wordBreak: WordBreak?

open var wordSpacing: CssSize?

open var zIndex: Int?

Functions

addAfterCreateHook

open override fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean

addAfterDestroyHook

open override fun addAfterDestroyHook(hook: () -> Unit): Boolean

addAfterInsertHook

open override fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

addBeforeDisposeHook

open override fun addBeforeDisposeHook(hook: () -> Unit): Boolean

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

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

open override fun addCssClass(css: String)

open override fun addCssStyle(css: Style)

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String)

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style)

open fun alert(message: String, style: AlertStyle?)

open fun applyFilter()

open fun blur()

clearAfterCreateHooks

open override fun clearAfterCreateHooks()

clearAfterDestroyHooks

open override fun clearAfterDestroyHooks()

clearAfterInsertHooks

open override fun clearAfterInsertHooks()

open fun clearAlert()

clearBeforeDisposeHooks

open override fun clearBeforeDisposeHooks()

open fun clearData(): Unit?

clearDragDropData

open fun clearDragDropData()

open fun clearFilter(includeHeaderFilters: Boolean)

clearHeaderFilter

open fun clearHeaderFilter()

open override fun clearParent()

open fun clearSort()

open fun deleteColumn(name: String)

open fun deselectRow(row: dynamic)

open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?

open override fun dispose()

open fun downloadCSV(fileName: String?, dataSet: RowRangeLookup, delimiter: Char, includeBOM: Boolean, newTab: Boolean): Unit?

open fun downloadHTML(fileName: String?, dataSet: RowRangeLookup, style: Boolean, newTab: Boolean): Unit?

open fun downloadJSON(fileName: String?, dataSet: RowRangeLookup, newTab: Boolean): Unit?

open fun focus()

open override fun getAttribute(name: String): String?

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

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

open fun getDataCount(rowRangeLookup: RowRangeLookup?): Int

open override fun getElement(): HTMLElement?

open override fun getElementD(): dynamic

getHistoryRedoSize

open fun getHistoryRedoSize(): Int

getHistoryUndoSize

open fun getHistoryUndoSize(): Int

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

open fun getPage(): Int

open fun getPageMax(): Int

open fun getPageSize(): Int

open override fun getRoot(): Root?

getSelectedData

open fun getSelectedData(): List<T>

getSelectedRows

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

open fun getSnStyle(): dynamic

fun getStyle(name: String): String?

open override fun hasCssClass(css: String): Boolean

open fun hide()

open fun navigateDown()

open fun navigateLeft()

open fun navigateNext()

open fun navigatePrev()

open fun navigateRight()

open fun navigateUp()

open fun nextPage()

open fun previousPage()

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

open fun redo(): Boolean

open fun redraw(force: Boolean)

open override fun refresh()

registerPagination

open fun registerPagination(tabulatorPagination: TabulatorPagination<T>): () -> Unit

open fun reload()

removeAfterCreateHook

open override fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean

removeAfterDestroyHook

open override fun removeAfterDestroyHook(hook: () -> Unit): Boolean

removeAfterInsertHook

open override fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean

removeAttribute

open override fun removeAttribute(name: String)

removeBeforeDisposeHook

open override fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

open override fun removeCssClass(css: String)

open override fun removeCssStyle(css: Style)

removeEventListener

open fun removeEventListener(id: Int)

removeEventListeners

open fun removeEventListeners()

fun removeStyle(name: String)

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String)

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style)

open override fun renderVNode(): VNode

open fun replaceData(data: Array<T>)

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

open fun selectRow(row: dynamic)

open override fun setAttribute(name: String, value: String)

open fun setData(data: Array<T>)

setDragDropData

open fun setDragDropData(format: String, data: String)

open fun setDropTarget(format: String, callback: (DragEvent) -> Unit)

open fun setDropTarget(formats: Set<String>?, callback: (DragEvent) -> Unit)

setDropTargetData

open fun setDropTargetData(format: String, callback: (String?) -> Unit)

setEventListener

open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int

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

open fun setHeight(height: Int)

open fun setPage(page: Int)

open fun setPageSize(size: Int)

open fun setPageToRow(row: Int)

fun setStyle(name: String, value: String)

open fun show()

open override fun <T> singleRender(block: () -> T): T

singleRenderAsync

open override fun singleRenderAsync(block: () -> Unit)

toggleSelectRow

open fun toggleSelectRow(row: dynamic)

open fun toggleVisible()

fun toKotlinObj(data: dynamic): T

fun toPlainObj(data: T): dynamic

open fun translate(text: String): String

open fun translate(text: String?): String?

open fun undo(): Boolean

useSnabbdomDistinctKey

open fun useSnabbdomDistinctKey()