kvision-tabulator/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: KSerializer<T>? = null, module: SerializersModule? = null) : Widget(source)

Tabulator component.

Parameters

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

Tabulator

constructor(data: List<T>? = null, dataUpdateOnEdit: Boolean = true, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, kClass: KClass<T>? = null, serializer: KSerializer<T>? = null, module: SerializersModule? = null)

Types

Companion

object Companion

Properties

alignContent

open var alignContent: AlignContent?

alignItems

open var alignItems: AlignItems?

alignSelf

open var alignSelf: AlignItems?

background

open var background: Background?

border

open var border: Border?

borderBottom

open var borderBottom: Border?

borderLeft

open var borderLeft: Border?

borderRadius

open var borderRadius: CssSize?

borderRadiusList

open var borderRadiusList: List<CssSize>?

borderRight

open var borderRight: Border?

borderTop

open var borderTop: Border?

bottom

open var bottom: CssSize?

boxShadow

open var boxShadow: BoxShadow?

boxShadowList

open var boxShadowList: List<BoxShadow>?

clear

open var clear: Clear?

color

open var color: Color?

colorHex

open var colorHex: Int?

colorName

open var colorName: Col?

cursor

open var cursor: Cursor?

display

open var display: Display?

draggable

var draggable: Boolean?

eventTarget

var eventTarget: Widget?

flexBasis

open var flexBasis: CssSize?

flexDirection

open var flexDirection: FlexDirection?

flexGrow

open var flexGrow: Int?

flexShrink

open var flexShrink: Int?

flexWrap

open var flexWrap: FlexWrap?

float

open var float: PosFloat?

fontFamily

open var fontFamily: String?

fontSize

open var fontSize: CssSize?

fontStyle

open var fontStyle: FontStyle?

fontVariant

open var fontVariant: FontVariant?

fontWeight

open var fontWeight: FontWeight?

gridArea

open var gridArea: String?

gridAutoColumns

open var gridAutoColumns: String?

gridAutoFlow

open var gridAutoFlow: GridAutoFlow?

gridAutoRows

open var gridAutoRows: String?

gridColumnEnd

open var gridColumnEnd: String?

gridColumnGap

open var gridColumnGap: Int?

gridColumnStart

open var gridColumnStart: Int?

gridRowEnd

open var gridRowEnd: String?

gridRowGap

open var gridRowGap: Int?

gridRowStart

open var gridRowStart: Int?

gridTemplateAreas

open var gridTemplateAreas: List<String>?

gridTemplateColumns

open var gridTemplateColumns: String?

gridTemplateRows

open var gridTemplateRows: String?

height

open var height: CssSize?

var id: String?

jsTabulator

var jsTabulator: Tabulator?

Native Tabulator object.

justifyContent

open var justifyContent: JustifyContent?

justifyItems

open var justifyItems: JustifyItems?

justifySelf

open var justifySelf: JustifyItems?

kvscope

var kvscope: dynamic

left

open var left: CssSize?

letterSpacing

open var letterSpacing: CssSize?

lineBreak

open var lineBreak: LineBreak?

lineHeight

open var lineHeight: CssSize?

listStyle

open var listStyle: ListStyle?

margin

open var margin: CssSize?

marginBottom

open var marginBottom: CssSize?

marginLeft

open var marginLeft: CssSize?

marginRight

open var marginRight: CssSize?

marginTop

open var marginTop: CssSize?

maxHeight

open var maxHeight: CssSize?

maxWidth

open var maxWidth: CssSize?

minHeight

open var minHeight: CssSize?

minWidth

open var minWidth: CssSize?

opacity

open var opacity: Double?

options

val options: TabulatorOptions<T>

order

open var order: Int?

outline

open var outline: Outline?

overflow

open var overflow: Overflow?

overflowWrap

open var overflowWrap: OverflowWrap?

overflowX

open var overflowX: Overflow?

overflowY

open var overflowY: Overflow?

padding

open var padding: CssSize?

paddingBottom

open var paddingBottom: CssSize?

paddingLeft

open var paddingLeft: CssSize?

paddingRight

open var paddingRight: CssSize?

paddingTop

open var paddingTop: CssSize?

parent

open override var parent: Container?

popoverHooksActive

var popoverHooksActive: Boolean

popoverOptions

var popoverOptions: dynamic

position

open var position: Position?

resize

open var resize: Resize?

right

open var right: CssSize?

role

var role: String?

tabindex

var tabindex: Int?

textAlign

open var textAlign: TextAlign?

textDecoration

open var textDecoration: TextDecoration?

textDirection

open var textDirection: Direction?

textIndent

open var textIndent: CssSize?

textOverflow

open var textOverflow: TextOverflow?

textShadow

open var textShadow: TextShadow?

textTransform

open var textTransform: TextTransform?

title

var title: String?

tooltipHooksActive

var tooltipHooksActive: Boolean

tooltipOptions

var tooltipOptions: dynamic

top

open var top: CssSize?

transition

open var transition: Transition?

transitionList

open var transitionList: List<Transition>?

types

var types: Set<TableType>

Table types.

unicodeBidi

open var unicodeBidi: UnicodeBidi?

verticalAlign

open var verticalAlign: VerticalAlign?

visible

open override var visible: Boolean

whiteSpace

open var whiteSpace: WhiteSpace?

width

open var width: CssSize?

wordBreak

open var wordBreak: WordBreak?

wordSpacing

open var wordSpacing: CssSize?

zIndex

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

addColumn

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.

addCssClass

open override fun addCssClass(css: String)

addCssStyle

open override fun addCssStyle(css: Style)

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String)

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style)

alert

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

Show an alert message.

applyFilter

open fun applyFilter()

Applies the current filter.

blur

open fun blur()

clearAfterCreateHooks

open override fun clearAfterCreateHooks()

clearAfterDestroyHooks

open override fun clearAfterDestroyHooks()

clearAfterInsertHooks

open override fun clearAfterInsertHooks()

clearAlert

open fun clearAlert()

Clear an alert message.

clearBeforeDisposeHooks

open override fun clearBeforeDisposeHooks()

clearData

open fun clearData(): Unit?

Clears the data in the table.

clearDragDropData

open fun clearDragDropData()

clearFilter

open fun clearFilter(includeHeaderFilters: Boolean = true)

Clears current filters.

clearHeaderFilter

open fun clearHeaderFilter()

Clears header filters.

clearParent

open override fun clearParent()

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.

dispatchEvent

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

dispose

open override fun dispose()

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