core/org.jetbrains.kotlinx.dataframe.api/ColumnSelectionDsl/invoke

invoke

open operator fun <C> ColumnReference<C>.invoke(): DataColumn<C>

Retrieves the value of this ColumnReference or -Accessor from the DataFrame.

This is a shorthand for get(myColumn).

Return

The DataColumn this Column Reference or -Accessor points to.

Throws

IllegalArgumentException

if the column is not found.

open operator fun <T> ColumnReference<DataRow<T>>.invoke(): ColumnGroup<T>

Retrieves the value of this ColumnReference or -Accessor from the DataFrame.

This is a shorthand for get(myColumn).

Return

The ColumnGroup this Column Reference or -Accessor points to.

Throws

IllegalArgumentException

if the column is not found.

open operator fun <T> ColumnReference<DataFrame<T>>.invoke(): FrameColumn<T>

Retrieves the value of this ColumnReference or -Accessor from the DataFrame.

This is a shorthand for get(myColumn).

Return

The FrameColumn this Column Reference or -Accessor points to.

Throws

IllegalArgumentException

if the column is not found.

open operator fun <C> ColumnPath.invoke(): DataColumn<C>

Retrieves the value of this ColumnPath from the DataFrame. This is a shorthand for getColumn(myColumnPath) and is most often used in combination with operator fun String.get(column: String), for instance:

"myColumn"["myNestedColumn"]<NestedColumnType>()

For more information: See Invoked String API on the documentation website.

Return

The DataColumn this ColumnPath points to.

Throws

IllegalArgumentException

if the column is not found.

@JvmName(name = "stringInvokeTyped")

open operator fun <C> String.invoke(): DataColumn<C>

Retrieves the value of the column with this name from the DataFrame. This can be both typed and untyped. This is a shorthand for get("myColumnName") and can be written as "myColumnName"<MyColumnType>() instead.

For more information: See Invoked String API on the documentation website.

Return

The DataColumn with this name.

Throws

IllegalArgumentException

if there is no column with this name.

@JvmName(name = "stringInvokeUntyped")

open operator fun String.invoke(): DataColumn<*>

Retrieves the value of the column with this name from the DataFrame. This can be both typed and untyped. This is a shorthand for get("myColumnName") and can be written as "myColumnName"() instead.

For more information: See Invoked String API on the documentation website.

Return

The DataColumn with this name.

Throws

IllegalArgumentException

if there is no column with this name.

open operator fun <T> KProperty<T>.~~invoke~~(): DataColumn<T>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Retrieves the value of this KProperty Accessor from the DataFrame.

This is a shorthand for get(MyType::myColumn).

Return

The DataColumn this KProperty Accessor points to.

Throws

IllegalArgumentException

if the column is not found.

open operator fun <T> KProperty<DataRow<T>>.~~invoke~~(): ColumnGroup<T>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Retrieves the value of this KProperty Accessor from the DataFrame.

This is a shorthand for get(MyType::myColumn).

Return

The ColumnGroup this KProperty Accessor points to.

Throws

IllegalArgumentException

if the column is not found.

open operator fun <T> KProperty<DataFrame<T>>.~~invoke~~(): FrameColumn<T>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Retrieves the value of this KProperty Accessor from the DataFrame.

This is a shorthand for get(MyType::myColumn).

Return

The FrameColumn this KProperty Accessor points to.

Throws

IllegalArgumentException

if the column is not found.