Rows

interface Rows<out M : RowManager>

Properties

state

abstract val state: Live<RowState<M>>

Cached row state.

Functions

all

abstract fun all(): List<M>

Recomputes and returns all rows in order.

append

abstract fun append(defaultId: String? = null, origin: Origin = Origin.User, metadata: Map<String, Any?>? = null): M

Appends a new row at the end of the table. Logs a warning and throws IllegalStateException if the configured maxRows limit is reached.

appendAfter

abstract fun appendAfter(id: String, defaultId: String? = null, origin: Origin = Origin.User, metadata: Map<String, Any?>? = null): M?

Appends a new row after a specific row. Logs a warning and returns null if the configured maxRows limit is reached.

applyFilters

abstract fun applyFilters(editor: TableEditor): List<M>

create

abstract fun create(empty: Boolean = false, id: String? = null, metadata: Map<String, Any?>? = null): M

Creates a new row without inserting it into the table.

delete

abstract fun delete(keys: List<String>, origin: Origin = Origin.User): List<M>

disableFilters

abstract fun disableFilters()

down

abstract fun down(id: String, by: Int = 1, origin: Origin = Origin.User): RowResult<Row>

duplicate

fun <M : RowManager> Rows<M>.duplicate(id: String, quantity: Int = 1, includeChildren: Boolean = false, atEnd: Boolean = false, origin: Origin = Origin.User): List<M>

Inserts independent copies immediately after id, or at the end of the table when atEnd is true, preserving cell values and row metadata. Child tables are empty unless includeChildren is true. Emits one rowCreate for a single copy, or one field.value.bulkRowCreate changelog for multiple copies. Returns no rows for a missing source. quantity must be positive.

find

abstract fun find(id: String): M?

hide

abstract fun hide()

position

abstract fun position(id: String): Int

prepend

abstract fun prepend(defaultId: String? = null, origin: Origin = Origin.User, metadata: Map<String, Any?>? = null): M

Prepends a new row at the beginning of the table. Logs a warning and throws IllegalStateException if the configured maxRows limit is reached.

show

abstract fun show()

abstract fun up(id: String, by: Int = 1, origin: Origin = Origin.User): RowResult<Row>