core/org.jetbrains.kotlinx.dataframe.api/MoveClause

MoveClause

class MoveClause<T, C>(val df: DataFrame<T>, val columns: ColumnsSelector<T, C>)

An intermediate class used in the move operation.

This class itself does nothing—it is just a transitional step before specifying where to move the selected columns. It must be followed by one of the positioning methods to produce a new DataFrame with the updated column structure.

Use the following methods to finalize the move:

to – moves columns to a specific index.
toStart – moves columns to the beginning.
toEnd – moves columns to the end.
into / intoIndexed – moves columns to a new position.
toTop – moves columns to the top-level.
after – places columns after a specific column.
under – nests columns under a column group.

See Grammar for more details.

Constructors

MoveClause

constructor(df: DataFrame<T>, columns: ColumnsSelector<T, C>)

Properties

columns

internal val columns: ColumnsSelector<T, C>

internal val df: DataFrame<T>

Functions

after

fun <T, C> MoveClause<T, C>.after(column: ColumnSelector<T, *>): DataFrame<T>

fun <T, C> MoveClause<T, C>.after(column: String): DataFrame<T>

Moves columns, previously selected with move to the position after the specified column within the DataFrame.

fun <T, C> MoveClause<T, C>.~~after~~(column: KProperty<*>): DataFrame<T>

fun <T, C> MoveClause<T, C>.~~after~~(column: ColumnReference<*>): DataFrame<T>

afterOrBefore

internal fun <T, C> MoveClause<T, C>.afterOrBefore(column: ColumnSelector<T, *>, isAfter: Boolean): DataFrame<T>

before

fun <T, C> MoveClause<T, C>.before(column: ColumnSelector<T, *>): DataFrame<T>

fun <T, C> MoveClause<T, C>.before(column: String): DataFrame<T>

Moves columns, previously selected with move to the position before the specified column within the DataFrame.

into

fun <T, C> MoveClause<T, C>.into(column: ColumnsSelectionDsl<T>.(ColumnWithPath<C>) -> ColumnReference<*>): DataFrame<T>

Moves columns, previously selected with move into a new position specified by a given column path within the DataFrame.

fun <T, C> MoveClause<T, C>.into(column: String): DataFrame<T>

Moves the selected column, previously specified with move, to the top level of the DataFrame and assigns it a new name.

intoIndexed

fun <T, C> MoveClause<T, C>.intoIndexed(newPathExpression: ColumnsSelectionDsl<T>.(ColumnWithPath<C>, Int) -> ColumnReference<*>): DataFrame<T>

Moves columns, previously selected with move into a new position specified by a given column path within the DataFrame. Provides selected column indices.

moveImpl

internal fun <T, C> MoveClause<T, C>.moveImpl(under: Boolean = false, newPathExpression: ColumnsSelectionDsl<T>.(ColumnWithPath<C>) -> AnyColumnReference): DataFrame<T>

moveTo

internal fun <T, C> MoveClause<T, C>.moveTo(columnIndex: Int): DataFrame<T>

moveToImpl

internal fun <T, C> MoveClause<T, C>.moveToImpl(columnIndex: Int, insideGroup: Boolean): DataFrame<T>

fun <T, C> MoveClause<T, C>.to(columnIndex: Int): DataFrame<T>

Moves columns, previously selected with move to a new position specified by columnIndex within the DataFrame.

fun <T, C> MoveClause<T, C>.to(columnIndex: Int, insideGroup: Boolean): DataFrame<T>

Moves columns, previously selected with move to a new position specified by columnIndex. If insideGroup is true, selected columns will be moved remaining within their ColumnGroup, else they will be moved to the top level.

toEnd

fun <T, C> MoveClause<T, C>.toEnd(): DataFrame<T>

Moves columns, previously selected with move to the DataFrame end.

fun <T, C> MoveClause<T, C>.toEnd(insideGroup: Boolean): DataFrame<T>

If insideGroup is true, moves columns previously selected with move to the end of their ColumnGroup. Else, selected columns will be moved to the end of their DataFrame (to the top-level).

toLeft

fun <T, C> MoveClause<T, C>.~~toLeft~~(): DataFrame<T>

toRight

fun <T, C> MoveClause<T, C>.~~toRight~~(): DataFrame<T>

toStart

fun <T, C> MoveClause<T, C>.toStart(): DataFrame<T>

Moves columns, previously selected with move to the DataFrame start (on top-level).

fun <T, C> MoveClause<T, C>.toStart(insideGroup: Boolean): DataFrame<T>

If insideGroup is true, moves columns previously selected with move to the start of their ColumnGroup. Else, selected columns will be moved to the start of their DataFrame (to the top-level).

toString

open override fun toString(): String

toTop

fun <T, C> MoveClause<T, C>.toTop(newColumnName: ColumnsSelectionDsl<T>.(ColumnWithPath<C>) -> String = { it.name() }): DataFrame<T>

Moves columns, previously selected with move to the top-level within the DataFrame. Moved columns name can be specified via special ColumnSelectionDsl.

under

fun <T, C> MoveClause<T, C>.under(column: ColumnsSelectionDsl<T>.(ColumnWithPath<C>) -> ColumnReference<*>): DataFrame<T>

Moves columns, previously selected with move under a new or an existing column group specified by a column path within the DataFrame.

fun <T, C> MoveClause<T, C>.under(column: String): DataFrame<T>

Moves columns, previously selected with move under a new or an existing column group within the DataFrame. If the column group doesn't exist, it will be created.

fun <T, C> MoveClause<T, C>.~~under~~(column: ColumnAccessor<DataRow<*>>): DataFrame<T>