TabulatorRemote

open class TabulatorRemote<T : Any, E : Any>(serviceManager: <ERROR CLASS><E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?, String?) -> <ERROR CLASS><T>, stateFunction: () -> String?, options: TabulatorOptions<T>, types: Set<TableType>, classes: Set<String>, kClass: KClass<T>?) : Tabulator<T>

Tabulator component connected to the multiplatform service.

Parameters

type of row data

type of service manager

serviceManager

multiplatform service manager

function

multiplatform 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

classes

a set of CSS class names

Constructors

TabulatorRemote

fun <T : Any, E : Any> TabulatorRemote(serviceManager: <ERROR CLASS><E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?, String?) -> <ERROR CLASS><T>, stateFunction: () -> String? = null, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), kClass: KClass<T>? = null)

Functions

addAfterDestroyHook

open override fun addAfterDestroyHook(hook: () -> Unit): <ERROR CLASS>

The supplied function is called after the widget is removed from the DOM.

addAfterInsertHook

open override fun addAfterInsertHook(hook: (<ERROR CLASS>) -> Unit): <ERROR CLASS>

The supplied function is called after the widget is inserted into the DOM.

addBeforeDisposeHook

open override fun addBeforeDisposeHook(hook: () -> Unit): <ERROR CLASS>

The supplied function is called before the widget is disposed.

addColumn

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

Add new column to the tabulator.

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

Add new column to the tabulator.

addCssClass

open override fun addCssClass(css: String): Widget

Adds given value to the set of CSS classes generated in html code of current component.

addCssStyle

open override fun addCssStyle(css: Style): Widget

Adds given style object to the set of CSS classes generated in html code of current component.

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String): Widget

Adds given value to the set of CSS classes generated in html code of parent component.

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style): Widget

Adds given style object to the set of CSS classes generated in html code of parent component.

animate

open fun animate(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null, styles: StyledComponent.() -> Unit)

Animate the widget changing CSS properties.

applyFilter

open fun applyFilter()

Applies the current filter.

blur

open fun blur()

Makes the element blur.

clearData

open fun clearData(): Unit?

Clears the data in the table.

clearDragDropData

open fun clearDragDropData()

Clears D&D data for the current widget.

clearFilter

open fun clearFilter(includeHeaderFilters: Boolean = true)

Clears current filters.

clearHeaderFilter

open fun clearHeaderFilter()

Clears header filters.

clearSort

open fun clearSort()

Clears current sort.

deleteColumn

open fun deleteColumn(name: String)

Delete column by name.

deselectRow

open fun deselectRow(row: dynamic = undefined)

Deselect the row.

disablePopover

open fun disablePopover(): Widget

Disables popover for the current widget.

disableTooltip

open fun disableTooltip(): Widget

Disables tooltip for the current widget.

downloadCSV

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

downloadHTML

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

Download the table content as HTML

downloadJSON

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

Download the table content as JSON

enablePopover

open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget

Enables popover for the current widget.

enableTooltip

open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget

Enables tooltip for the current widget.

fadeIn

open fun fadeIn(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Shows current widget with fade in effect.

fadeOut

open fun fadeOut(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Hides current widget with fade out effect.

focus

open fun focus()

Makes the element focused.

getAttribute

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

Returns the value of an additional attribute.

getColumn

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

Get column component by name.

getData

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

Returns the current data in the table.

getDataCount

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

Get the number of data rows.

getElement

open override fun getElement(): <ERROR CLASS>?

Returns DOM element bound to the current component.

getElementJQuery

open override fun getElementJQuery(): <ERROR CLASS>?

Returns JQuery element bound to the current component.

getElementJQueryD

open override fun getElementJQueryD(): dynamic

Returns JQuery element bound to the current component as a dynamic type.

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(rowRangeLookup: RowRangeLookup, 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.

getSnStyle

open fun getSnStyle(): List<<ERROR CLASS><String, String>>

Returns the list of String pairs defining CSS style attributes and their values.

getStyle

fun getStyle(name: String): String?

Returns the value of a custom CSS style.

hasCssClass

open override fun hasCssClass(css: String): Boolean

Checks whether the given value is present in the set of CSS classes.

hide

open fun hide(): Widget

Makes current widget invisible.

hideAnim

open fun hideAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Hides current widget with animation effect.

hidePopover

open fun hidePopover(): Widget

Hides popover for the current widget.

hideTooltip

open fun hideTooltip(): Widget

Hides tooltip for the current widget.

navigateDown

open fun navigateDown()

Navigate to the same cell in the row below.

navigateLeft

open fun navigateLeft()

Navigate to the cell on the left.

navigateNext

open fun navigateNext()

Navigate to the next cell.

navigatePrev

open fun navigatePrev()

Navigate to the previous cell.

navigateRight

open fun navigateRight()

Navigate to the cell on the right.

navigateUp

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.

redo

open fun redo(): Boolean

Redo the last undone user action.

redraw

open fun redraw(force: Boolean = false)

Redraw the table (e.g.

reload

open fun reload()

Reload table data.

removeAttribute

open override fun removeAttribute(name: String): Widget

Removes the value of additional attribute.

removeCssClass

open override fun removeCssClass(css: String): Widget

Removes given value from the set of CSS classes generated in html code of current component.

removeCssStyle

open override fun removeCssStyle(css: Style): Widget

Removes given style object from the set of CSS classes generated in html code of current component.

removeEventListener

open fun removeEventListener(id: Int): Widget

Removes event listener from current widget.

removeEventListeners

open fun removeEventListeners(): Widget

Removes all event listeners from current widget.

removeStyle

fun removeStyle(name: String): StyledComponent

Removes the value of a custom CSS style.

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String): Widget

Removes given value from the set of CSS classes generated in html code of parent component.

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style): Widget

Removes given style object from the set of CSS classes generated in html code of parent component.

replaceData

open fun replaceData(data: Array<T>)

Silently replaces the data in a table.

scrollToRow

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

Scroll to the row given by id.

selectRow

open fun selectRow(row: dynamic = undefined)

Select the row.

setAttribute

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

Sets the value of additional attribute.

setData

open fun setData(data: Array<T>)

Sets new data in a table.

setDragDropData

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

Sets D&D data for the current widget.

setDropTarget

open fun setDropTarget(format: String, callback: (<ERROR CLASS>) -> Unit)

Sets the current widget as a D&D drop target.

open fun setDropTarget(formats: Set<String>? = null, callback: (<ERROR CLASS>) -> Unit)

Sets the current widget as a D&D drop target.

setDropTargetData

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

Sets the current widget as a D&D drop target with helper callback accepting String data.

setEventListener

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

Sets an event listener for current widget, keeping the actual type of component.

setFilter

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

Sets the external filter for the data.

setHeight

open fun setHeight(height: Int)

Change the height of the table.

setPage

open fun setPage(page: Int)

Shows given page.

setPageSize

open fun setPageSize(size: Int)

Set the size of a page.

setPageToRow

open fun setPageToRow(row: Int)

Shows page with a row given by id.

setStyle

fun setStyle(name: String, value: String): StyledComponent

Sets the value of a custom CSS style.

show

open fun show(): Widget

Makes current widget visible.

showAnim

open fun showAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Shows current widget with animation effect.

showPopover

open fun showPopover(): Widget

Shows popover for the current widget.

showTooltip

open fun showTooltip(): Widget

Shows tooltip for the current widget.

singleRender

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

Executes given function within a single rendering process.

singleRenderAsync

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

Executes given function within a single rendering process asynchronously.

slideDown

open fun slideDown(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Shows current widget with slide down effect.

slideUp

open fun slideUp(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Hides current widget with slide up effect.

toggleSelectRow

open fun toggleSelectRow(row: dynamic = undefined)

Toggle selection status of the row.

toggleVisible

open fun toggleVisible(): Widget

Toggles visibility of current widget.

undo

open fun undo(): Boolean

Undo the last user action.

Properties

alignContent

open var alignContent: AlignContent?

CSS flexbox/grid content alignment.

alignItems

open var alignItems: AlignItems?

CSS flexbox/grid items alignment.

alignSelf

open var alignSelf: AlignItems?

CSS flexbox items self-alignment.

background

open var background: Background?

Background of the current component.

border

open var border: Border?

Border of the current component.

borderBottom

open var borderBottom: Border?

Bottom border of the current component.

borderLeft

open var borderLeft: Border?

Left border of the current component.

borderRadius

open var borderRadius: <ERROR CLASS><Number, UNIT>?

CSS border radius.

borderRadiusList

open var borderRadiusList: List<<ERROR CLASS><Number, UNIT>>?

List of CSS border radius values.

borderRight

open var borderRight: Border?

Right border of the current component.

borderTop

open var borderTop: Border?

Top border of the current component.

bottom

open var bottom: <ERROR CLASS><Number, UNIT>?

Bottom edge of the current component.

boxShadow

open var boxShadow: BoxShadow?

Box shadow of the current component.

boxShadowList

open var boxShadowList: List<BoxShadow>?

List of box shadows of the current component.

clear

open var clear: Clear?

CSS clear float of the current component.

color

open var color: Color?

Text color for the current component.

colorHex

open var colorHex: Int?

Text color for the current component given in hex format (write only).

colorName

open var colorName: Col?

Text color for the current component given with named constant (write only).

cursor

open var cursor: Cursor?

CSS cursor shape over the current component.

display

open var display: Display?

CSS display of the current component.

draggable

var draggable: Boolean?

Determines if the current widget is draggable.

eventTarget

var eventTarget: Widget?

flexBasis

open var flexBasis: <ERROR CLASS><Number, UNIT>?

CSS flexbox item basis.

flexDirection

open var flexDirection: FlexDirection?

CSS flexbox direction.

flexGrow

open var flexGrow: Int?

CSS flexbox item grow.

flexShrink

open var flexShrink: Int?

CSS flexbox item shrink.

flexWrap

open var flexWrap: FlexWrap?

CSS flexbox wrap mode.

float

open var float: PosFloat?

CSS position float of the current component.

fontFamily

open var fontFamily: String?

CSS font family of the current component.

fontSize

open var fontSize: <ERROR CLASS><Number, UNIT>?

CSS font size of the current component.

fontStyle

open var fontStyle: FontStyle?

CSS font style of the current component.

fontVariant

open var fontVariant: FontVariant?

CSS font variant of the current component.

fontWeight

open var fontWeight: FontWeight?

CSS font weight of the current component.

gridArea

open var gridArea: String?

CSS grid area.

gridAutoColumns

open var gridAutoColumns: String?

CSS grid auto columns.

gridAutoFlow

open var gridAutoFlow: GridAutoFlow?

CSS grid auto flow.

gridAutoRows

open var gridAutoRows: String?

CSS grid auto rows.

gridColumnEnd

open var gridColumnEnd: String?

CSS grid column end.

gridColumnGap

open var gridColumnGap: Int?

CSS grid column gap.

gridColumnStart

open var gridColumnStart: Int?

CSS grid column start.

gridRowEnd

open var gridRowEnd: String?

CSS grid row end.

gridRowGap

open var gridRowGap: Int?

CSS grid row gap.

gridRowStart

open var gridRowStart: Int?

CSS grid row start.

gridTemplateAreas

open var gridTemplateAreas: List<String>?

CSS grid areas template.

gridTemplateColumns

open var gridTemplateColumns: String?

CSS grid columns template.

gridTemplateRows

open var gridTemplateRows: String?

CSS grid rows template.

height

open var height: <ERROR CLASS><Number, UNIT>?

Height of the current component.

var id: String?

An ID attribute of generated HTML element.

jsTabulator

var jsTabulator: Tabulator?

Native Tabulator object.

justifyContent

open var justifyContent: JustifyContent?

CSS flexbox/grid content justification.

justifyItems

open var justifyItems: JustifyItems?

CSS grid items justification.

justifySelf

open var justifySelf: JustifyItems?

CSS grid items self-justification.

left

open var left: <ERROR CLASS><Number, UNIT>?

Left edge of the current component.

letterSpacing

open var letterSpacing: <ERROR CLASS><Number, UNIT>?

CSS Text letter spacing of the current component.

lineBreak

open var lineBreak: LineBreak?

CSS line break of the current component.

lineHeight

open var lineHeight: <ERROR CLASS><Number, UNIT>?

CSS Text line height of the current component.

margin

open var margin: <ERROR CLASS><Number, UNIT>?

Margin of the current component.

marginBottom

open var marginBottom: <ERROR CLASS><Number, UNIT>?

Bottom margin of the current component.

marginLeft

open var marginLeft: <ERROR CLASS><Number, UNIT>?

Left margin of the current component.

marginRight

open var marginRight: <ERROR CLASS><Number, UNIT>?

Right margin of the current component.

marginTop

open var marginTop: <ERROR CLASS><Number, UNIT>?

Top margin of the current component.

maxHeight

open var maxHeight: <ERROR CLASS><Number, UNIT>?

Maximal height of the current component.

maxWidth

open var maxWidth: <ERROR CLASS><Number, UNIT>?

Maximal width of the current component.

minHeight

open var minHeight: <ERROR CLASS><Number, UNIT>?

Minimal height of the current component.

minWidth

open var minWidth: <ERROR CLASS><Number, UNIT>?

Minimal width of the current component.

opacity

open var opacity: Double?

Opacity of the current component.

options

val options: TabulatorOptions<T>

tabulator options

order

open var order: Int?

CSS flexbox item order.

outline

open var outline: Outline?

Outline of the current component.

overflow

open var overflow: Overflow?

CSS overflow of the current component.

overflowWrap

open var overflowWrap: OverflowWrap?

CSS overflow-wrap of the current component.

padding

open var padding: <ERROR CLASS><Number, UNIT>?

Padding of the current component.

paddingBottom

open var paddingBottom: <ERROR CLASS><Number, UNIT>?

Bottom padding of the current component.

paddingLeft

open var paddingLeft: <ERROR CLASS><Number, UNIT>?

Left padding of the current component.

paddingRight

open var paddingRight: <ERROR CLASS><Number, UNIT>?

Right padding of the current component.

paddingTop

open var paddingTop: <ERROR CLASS><Number, UNIT>?

Top padding of the current component.

parent

open override var parent: Container?

Parent of the current component.

position

open var position: Position?

CSS position of the current component.

resize

open var resize: Resize?

CSS resize of the current component.

right

open var right: <ERROR CLASS><Number, UNIT>?

Right edge of the current component.

role

var role: String?

A role attribute of generated HTML element.

tabindex

var tabindex: Int?

A tabindex attribute of generated HTML element.

textAlign

open var textAlign: TextAlign?

CSS Text align of the current component.

textDecoration

open var textDecoration: TextDecoration?

CSS Text decoration of the current component.

textDirection

open var textDirection: Direction?

CSS Text direction of the current component.

textIndent

open var textIndent: <ERROR CLASS><Number, UNIT>?

CSS Text indent of the current component.

textOverflow

open var textOverflow: TextOverflow?

CSS Text overflow of the current component.

textShadow

open var textShadow: TextShadow?

CSS Text shadow of the current component.

textTransform

open var textTransform: TextTransform?

CSS Text transform of the current component.

title

var title: String?

A title attribute of generated HTML element.

top

open var top: <ERROR CLASS><Number, UNIT>?

Top edge of the current component.

transition

open var transition: Transition?

CSS transition effect for the current component.

transitionList

open var transitionList: List<Transition>?

List of CSS transition effects for the current component.

types

var types: Set<TableType>

Table types.

unicodeBidi

open var unicodeBidi: UnicodeBidi?

CSS Text unicode-bidi of the current component.

verticalAlign

open var verticalAlign: VerticalAlign?

CSS Text vertical align of the current component.

visible

open override var visible: Boolean

Visibility state of the current component.

whiteSpace

open var whiteSpace: WhiteSpace?

CSS Text white space of the current component.

width

open var width: <ERROR CLASS><Number, UNIT>?

Width of the current component.

wordBreak

open var wordBreak: WordBreak?

CSS word break of the current component.

wordSpacing

open var wordSpacing: <ERROR CLASS><Number, UNIT>?

CSS Text word spacing of the current component.

zIndex

open var zIndex: Int?

Z-index of the current component.