From 8449ff519f3d853ca82c792dccf12d06fb09b627 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Wed, 24 Apr 2019 23:12:48 +0200 Subject: API documentation for KVision 0.0.35 --- .../-tabulator/-init-.html | 27 + .../-tabulator/after-destroy.html | 16 + .../-tabulator/after-insert.html | 16 + .../-tabulator/apply-filter.html | 15 + .../-tabulator/clear-data.html | 15 + .../-tabulator/clear-filter.html | 18 + .../-tabulator/clear-header-filter.html | 15 + .../-tabulator/clear-sort.html | 15 + .../-tabulator/create-js-tabulator.html | 15 + .../-tabulator/create.html | 21 + .../-tabulator/data-serializer.html | 15 + .../-tabulator/data-to-native.html | 15 + .../-tabulator/data.html | 15 + .../-tabulator/deselect-row.html | 18 + .../-tabulator/filter.html | 14 + .../-tabulator/get-data-count.html | 20 + .../-tabulator/get-data.html | 20 + .../-tabulator/get-history-redo-size.html | 15 + .../-tabulator/get-history-undo-size.html | 15 + .../-tabulator/get-html.html | 20 + .../-tabulator/get-page-max.html | 15 + .../-tabulator/get-page-size.html | 15 + .../-tabulator/get-page.html | 15 + .../-tabulator/get-selected-data.html | 17 + .../-tabulator/get-selected-rows.html | 15 + .../-tabulator/get-sn-class.html | 18 + .../-tabulator/index.html | 953 +++++++++++++++++++++ .../-tabulator/js-tabulator.html | 14 + .../-tabulator/native-to-data.html | 15 + .../-tabulator/navigate-down.html | 15 + .../-tabulator/navigate-left.html | 15 + .../-tabulator/navigate-next.html | 15 + .../-tabulator/navigate-prev.html | 15 + .../-tabulator/navigate-right.html | 15 + .../-tabulator/navigate-up.html | 15 + .../-tabulator/next-page.html | 15 + .../-tabulator/options.html | 15 + .../-tabulator/previous-page.html | 15 + .../-tabulator/redo.html | 15 + .../-tabulator/redraw.html | 18 + .../-tabulator/render.html | 18 + .../-tabulator/replace-data.html | 18 + .../-tabulator/scroll-to-row.html | 22 + .../-tabulator/select-row.html | 18 + .../-tabulator/set-data.html | 18 + .../-tabulator/set-filter.html | 18 + .../-tabulator/set-height.html | 18 + .../-tabulator/set-page-size.html | 18 + .../-tabulator/set-page-to-row.html | 18 + .../-tabulator/set-page.html | 18 + .../-tabulator/tabulator.html | 25 + .../-tabulator/toggle-select-row.html | 18 + .../-tabulator/types.html | 21 + .../-tabulator/undo.html | 15 + 54 files changed, 1848 insertions(+) create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/-init-.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/after-destroy.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/after-insert.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/apply-filter.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/clear-data.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/clear-filter.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/clear-header-filter.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/clear-sort.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/create-js-tabulator.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/create.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/data-serializer.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/data-to-native.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/data.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/deselect-row.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/filter.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/get-data-count.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/get-data.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/get-history-redo-size.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/get-history-undo-size.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/get-html.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/get-page-max.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/get-page-size.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/get-page.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/get-selected-data.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/get-selected-rows.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/index.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/js-tabulator.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/native-to-data.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/navigate-down.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/navigate-left.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/navigate-next.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/navigate-prev.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/navigate-right.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/navigate-up.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/next-page.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/options.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/previous-page.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/redo.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/redraw.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/render.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/replace-data.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/scroll-to-row.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/select-row.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/set-data.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/set-filter.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/set-height.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/set-page-size.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/set-page-to-row.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/set-page.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/tabulator.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/toggle-select-row.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/types.html create mode 100644 api/pl.treksoft.kvision.tabulator/-tabulator/undo.html (limited to 'api/pl.treksoft.kvision.tabulator/-tabulator') diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/-init-.html b/api/pl.treksoft.kvision.tabulator/-tabulator/-init-.html new file mode 100644 index 00000000..f361047c --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/-init-.html @@ -0,0 +1,27 @@ + + + +Tabulator.<init> - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / <init>
+
+

<init>

+ +Tabulator(data: List<T>? = null, options: Options = Options(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), dataSerializer: KSerializer<T>? = null) +

Parameters

+

+T - serializable type

+

+data - a list of serializable objects

+

+options - tabulator options

+

+classes - a set of CSS class names

+

+dataSerializer - a serializer for class T

+

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/after-destroy.html b/api/pl.treksoft.kvision.tabulator/-tabulator/after-destroy.html new file mode 100644 index 00000000..3423eae5 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/after-destroy.html @@ -0,0 +1,16 @@ + + + +Tabulator.afterDestroy - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / afterDestroy
+
+

afterDestroy

+ +protected open fun afterDestroy(): Unit +

Overrides Widget.afterDestroy

+

Method called after destroying Snabbdom vnode.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/after-insert.html b/api/pl.treksoft.kvision.tabulator/-tabulator/after-insert.html new file mode 100644 index 00000000..15504bc1 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/after-insert.html @@ -0,0 +1,16 @@ + + + +Tabulator.afterInsert - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / afterInsert
+
+

afterInsert

+ +protected open fun afterInsert(node: VNode): Unit +

Overrides Widget.afterInsert

+

Method called after inserting Snabbdom vnode into the DOM.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/apply-filter.html b/api/pl.treksoft.kvision.tabulator/-tabulator/apply-filter.html new file mode 100644 index 00000000..a3b2ad41 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/apply-filter.html @@ -0,0 +1,15 @@ + + + +Tabulator.applyFilter - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / applyFilter
+
+

applyFilter

+ +open fun applyFilter(): Unit +

Applies the current filter.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/clear-data.html b/api/pl.treksoft.kvision.tabulator/-tabulator/clear-data.html new file mode 100644 index 00000000..5116e69f --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/clear-data.html @@ -0,0 +1,15 @@ + + + +Tabulator.clearData - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / clearData
+
+

clearData

+ +open fun clearData(): Unit? +

Clears the data in the table.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/clear-filter.html b/api/pl.treksoft.kvision.tabulator/-tabulator/clear-filter.html new file mode 100644 index 00000000..86472c20 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/clear-filter.html @@ -0,0 +1,18 @@ + + + +Tabulator.clearFilter - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / clearFilter
+
+

clearFilter

+ +open fun clearFilter(includeHeaderFilters: Boolean = true): Unit +

Clears current filters.

+

Parameters

+

+includeHeaderFilters - clear also the header filters

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/clear-header-filter.html b/api/pl.treksoft.kvision.tabulator/-tabulator/clear-header-filter.html new file mode 100644 index 00000000..b3c5c8b2 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/clear-header-filter.html @@ -0,0 +1,15 @@ + + + +Tabulator.clearHeaderFilter - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / clearHeaderFilter
+
+

clearHeaderFilter

+ +open fun clearHeaderFilter(): Unit +

Clears header filters.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/clear-sort.html b/api/pl.treksoft.kvision.tabulator/-tabulator/clear-sort.html new file mode 100644 index 00000000..27a0665d --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/clear-sort.html @@ -0,0 +1,15 @@ + + + +Tabulator.clearSort - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / clearSort
+
+

clearSort

+ +open fun clearSort(): Unit +

Clears current sort.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/create-js-tabulator.html b/api/pl.treksoft.kvision.tabulator/-tabulator/create-js-tabulator.html new file mode 100644 index 00000000..d33898c4 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/create-js-tabulator.html @@ -0,0 +1,15 @@ + + + +Tabulator.createJsTabulator - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / createJsTabulator
+
+

createJsTabulator

+ +protected fun createJsTabulator(): Unit +

Creates internal JS Tabulator object

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/create.html b/api/pl.treksoft.kvision.tabulator/-tabulator/create.html new file mode 100644 index 00000000..916db7fc --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/create.html @@ -0,0 +1,21 @@ + + + +Tabulator.create - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / create
+
+

create

+ +inline fun <reified T : Any> create(data: List<T>? = null, options: Options = Options(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), noinline init: (Tabulator<T>.() -> Unit)? = null): Tabulator<T> +

A helper function to create a Tabulator object with correct serializer.

+ +inline fun <reified T : Any, S : Any, A> create(store: ReduxStore<S, A>, noinline dataFactory: (S) -> List<T>, options: Options = Options(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), noinline init: (Tabulator<T>.() -> Unit)? = null): Tabulator<T> +

A helper function to create a Tabulator object with correct serializer and general redux store.

+ +inline fun <reified T : Any, A> create(store: ReduxStore<List<T>, A>, options: Options = Options(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), noinline init: (Tabulator<T>.() -> Unit)? = null): Tabulator<T> +

A helper function to create a Tabulator object with correct serializer and dedicated redux store.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/data-serializer.html b/api/pl.treksoft.kvision.tabulator/-tabulator/data-serializer.html new file mode 100644 index 00000000..fcbe6516 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/data-serializer.html @@ -0,0 +1,15 @@ + + + +Tabulator.dataSerializer - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / dataSerializer
+
+

dataSerializer

+ +protected val dataSerializer: KSerializer<T>? +

a serializer for class T

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/data-to-native.html b/api/pl.treksoft.kvision.tabulator/-tabulator/data-to-native.html new file mode 100644 index 00000000..9676744a --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/data-to-native.html @@ -0,0 +1,15 @@ + + + +Tabulator.dataToNative - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / dataToNative
+
+

dataToNative

+ +protected fun dataToNative(data: List<T>, dataSerializer: KSerializer<T>): dynamic +

Converts a list of objects of type T to native JS array

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/data.html b/api/pl.treksoft.kvision.tabulator/-tabulator/data.html new file mode 100644 index 00000000..a30117bd --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/data.html @@ -0,0 +1,15 @@ + + + +Tabulator.data - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / data
+
+

data

+ +protected val data: List<T>? +

a list of serializable objects

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/deselect-row.html b/api/pl.treksoft.kvision.tabulator/-tabulator/deselect-row.html new file mode 100644 index 00000000..a12a8fa7 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/deselect-row.html @@ -0,0 +1,18 @@ + + + +Tabulator.deselectRow - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / deselectRow
+
+

deselectRow

+ +open fun deselectRow(row: Int): Unit +

Deselect the row given by id.

+

Parameters

+

+row - row id

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/filter.html b/api/pl.treksoft.kvision.tabulator/-tabulator/filter.html new file mode 100644 index 00000000..4ff46784 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/filter.html @@ -0,0 +1,14 @@ + + + +Tabulator.filter - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / filter
+
+

filter

+ +protected var filter: ((T) -> Boolean)? + + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/get-data-count.html b/api/pl.treksoft.kvision.tabulator/-tabulator/get-data-count.html new file mode 100644 index 00000000..8034c618 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/get-data-count.html @@ -0,0 +1,20 @@ + + + +Tabulator.getDataCount - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / getDataCount
+
+

getDataCount

+ +open fun getDataCount(activeOnly: Boolean = false): Int +

Get the number of data rows.

+

Parameters

+

+activeOnly - return only the number of visible rows

+

Return
+the number of data rows

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/get-data.html b/api/pl.treksoft.kvision.tabulator/-tabulator/get-data.html new file mode 100644 index 00000000..19018393 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/get-data.html @@ -0,0 +1,20 @@ + + + +Tabulator.getData - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / getData
+
+

getData

+ +open fun getData(active: Boolean): List<T>? +

Returns the current data in the table.

+

Parameters

+

+active - return only visible data

+

Return
+current data

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/get-history-redo-size.html b/api/pl.treksoft.kvision.tabulator/-tabulator/get-history-redo-size.html new file mode 100644 index 00000000..deb4d872 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/get-history-redo-size.html @@ -0,0 +1,15 @@ + + + +Tabulator.getHistoryRedoSize - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / getHistoryRedoSize
+
+

getHistoryRedoSize

+ +open fun getHistoryRedoSize(): Int +

Get the number of history redo actions available.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/get-history-undo-size.html b/api/pl.treksoft.kvision.tabulator/-tabulator/get-history-undo-size.html new file mode 100644 index 00000000..363d58a6 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/get-history-undo-size.html @@ -0,0 +1,15 @@ + + + +Tabulator.getHistoryUndoSize - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / getHistoryUndoSize
+
+

getHistoryUndoSize

+ +open fun getHistoryUndoSize(): Int +

Get the number of history undo actions available.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/get-html.html b/api/pl.treksoft.kvision.tabulator/-tabulator/get-html.html new file mode 100644 index 00000000..c8a00072 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/get-html.html @@ -0,0 +1,20 @@ + + + +Tabulator.getHtml - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / getHtml
+
+

getHtml

+ +open fun getHtml(activeOnly: Boolean = false): String? +

Get the HTML code of the table.

+

Parameters

+

+activeOnly - include only visible rows

+

Return
+the HTML code of the table

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/get-page-max.html b/api/pl.treksoft.kvision.tabulator/-tabulator/get-page-max.html new file mode 100644 index 00000000..50cb1f4b --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/get-page-max.html @@ -0,0 +1,15 @@ + + + +Tabulator.getPageMax - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / getPageMax
+
+

getPageMax

+ +open fun getPageMax(): Int +

Returns number of pages.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/get-page-size.html b/api/pl.treksoft.kvision.tabulator/-tabulator/get-page-size.html new file mode 100644 index 00000000..39eaaea3 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/get-page-size.html @@ -0,0 +1,15 @@ + + + +Tabulator.getPageSize - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / getPageSize
+
+

getPageSize

+ +open fun getPageSize(): Int +

Returns the size of a page.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/get-page.html b/api/pl.treksoft.kvision.tabulator/-tabulator/get-page.html new file mode 100644 index 00000000..f96fdfe5 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/get-page.html @@ -0,0 +1,15 @@ + + + +Tabulator.getPage - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / getPage
+
+

getPage

+ +open fun getPage(): Int +

Returns current page number.

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/get-selected-data.html b/api/pl.treksoft.kvision.tabulator/-tabulator/get-selected-data.html new file mode 100644 index 00000000..fbe9e476 --- /dev/null +++ b/api/pl.treksoft.kvision.tabulator/-tabulator/get-selected-data.html @@ -0,0 +1,17 @@ + + + +Tabulator.getSelectedData - kvision + + + +kvision / pl.treksoft.kvision.tabulator / Tabulator / getSelectedData
+
+

getSelectedData

+ +open fun getSelectedData(): List<T> +

Returns the selected data in the table.

+

Return
+selected data

+ + diff --git a/api/pl.treksoft.kvision.tabulator/-tabulator/get-selected-rows.html b/api/pl.treksoft.kvision.tabulator/-tabulator/get-selected-rows.html new file mode 100644 index 00000000..3d043f16 --- /dev/