valueCol

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ myColumnGroup.valueCol(valueColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> String.valueCol(valueCol: ColumnAccessor<C>): ColumnAccessor<C>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".valueCol(valueColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].valueCol(valueColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


@JvmName(name = "valueColUnTyped")
open fun valueCol(name: String): ColumnAccessor<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ valueCol("valueColumnName") }

df.select{ valueCol<String>("valueColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> valueCol(name: String): ColumnAccessor<C>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ valueCol("valueColumnName") }

df.select{ valueCol<String>("valueColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


@JvmName(name = "valueColUnTyped")
open fun SingleColumn<DataRow<*>>.valueCol(name: String): SingleColumn<*>
@JvmName(name = "valueColUnTyped")
open fun ColumnAccessor<DataRow<*>>.valueCol(name: String): ColumnAccessor<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ myColumnGroup.valueCol("valueColumnName") }

df.select{ myColumnGroup.valueCol<String>("valueColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ myColumnGroup.valueCol("valueColumnName") }

df.select{ myColumnGroup.valueCol<String>("valueColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


@JvmName(name = "valueColUnTyped")
open fun String.valueCol(name: String): ColumnAccessor<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".valueCol("valueColumnName") }

df.select{ "myColumnGroup".valueCol<String>("valueColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> String.valueCol(name: String): ColumnAccessor<C>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".valueCol("valueColumnName") }

df.select{ "myColumnGroup".valueCol<String>("valueColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


@JvmName(name = "valueColUnTyped")
open fun ColumnPath.valueCol(name: String): ColumnAccessor<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].valueCol("valueColumnName") }

df.select{ "pathTo"["myColumnGroup"].valueCol<String>("valueColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].valueCol("valueColumnName") }

df.select{ "pathTo"["myColumnGroup"].valueCol<String>("valueColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


@JvmName(name = "valueColUnTyped")
open fun valueCol(path: ColumnPath): ColumnAccessor<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ valueCol("pathTo"["valueColumnName"] ) }

df.select{ valueCol<String>("pathTo"["valueColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> valueCol(path: ColumnPath): ColumnAccessor<C>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ valueCol("pathTo"["valueColumnName"] ) }

df.select{ valueCol<String>("pathTo"["valueColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


@JvmName(name = "valueColUnTyped")
open fun SingleColumn<DataRow<*>>.valueCol(path: ColumnPath): SingleColumn<*>
@JvmName(name = "valueColUnTyped")
open fun ColumnAccessor<DataRow<*>>.valueCol(path: ColumnPath): ColumnAccessor<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ myColumnGroup.valueCol("pathTo"["valueColumnName"] ) }

df.select{ myColumnGroup.valueCol<String>("pathTo"["valueColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ myColumnGroup.valueCol("pathTo"["valueColumnName"] ) }

df.select{ myColumnGroup.valueCol<String>("pathTo"["valueColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


@JvmName(name = "valueColUnTyped")
open fun String.valueCol(path: ColumnPath): ColumnAccessor<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".valueCol("pathTo"["valueColumnName"] ) }

df.select{ "myColumnGroup".valueCol<String>("pathTo"["valueColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".valueCol("pathTo"["valueColumnName"] ) }

df.select{ "myColumnGroup".valueCol<String>("pathTo"["valueColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


@JvmName(name = "valueColUnTyped")
open fun ColumnPath.valueCol(path: ColumnPath): ColumnAccessor<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].valueCol("pathTo"["valueColumnName"] ) }

df.select{ "pathTo"["myColumnGroup"].valueCol<String>("pathTo"["valueColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].valueCol("pathTo"["valueColumnName"] ) }

df.select{ "pathTo"["myColumnGroup"].valueCol<String>("pathTo"["valueColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> ColumnSet<C>.valueCol(index: Int): SingleColumn<C>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ colsOf<Int>().valueCol(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.

if the index is out of bounds.


@JvmName(name = "valueColUnTyped")
open fun ColumnsSelectionDsl<*>.valueCol(index: Int): SingleColumn<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ valueCol(0) }

df.select{ valueCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.

if the index is out of bounds.


Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ valueCol(0) }

df.select{ valueCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.

if the index is out of bounds.


@JvmName(name = "valueColUnTyped")
open fun SingleColumn<DataRow<*>>.valueCol(index: Int): SingleColumn<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ myColumnGroup.valueCol(0) }

df.select{ myColumnGroup.valueCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.

if the index is out of bounds.


open fun <C> SingleColumn<DataRow<*>>.valueCol(index: Int): SingleColumn<C>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ myColumnGroup.valueCol(0) }

df.select{ myColumnGroup.valueCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.

if the index is out of bounds.


@JvmName(name = "valueColUnTyped")
open fun String.valueCol(index: Int): SingleColumn<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".valueCol(0) }

df.select{ "myColumnGroup".valueCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.

if the index is out of bounds.


open fun <C> String.valueCol(index: Int): SingleColumn<C>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".valueCol(0) }

df.select{ "myColumnGroup".valueCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.

if the index is out of bounds.


@JvmName(name = "valueColUnTyped")
open fun ColumnPath.valueCol(index: Int): SingleColumn<*>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].valueCol(0) }

df.select{ "pathTo"["myColumnGroup"].valueCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.

if the index is out of bounds.


open fun <C> ColumnPath.valueCol(index: Int): SingleColumn<C>

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].valueCol(0) }

df.select{ "pathTo"["myColumnGroup"].valueCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.

if the index is out of bounds.


open fun <C> valueCol(valueCol: ColumnAccessor<C>): ColumnAccessor<C>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ valueCol(valueColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> KProperty<*>.valueCol(valueCol: ColumnAccessor<C>): ColumnAccessor<C>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.valueCol(valueColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


@JvmName(name = "valueColUnTyped")
open fun KProperty<*>.valueCol(name: String): ColumnAccessor<*>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.valueCol("valueColumnName") }

df.select{ Type::myColumnGroup.valueCol<String>("valueColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> KProperty<*>.valueCol(name: String): ColumnAccessor<C>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.valueCol("valueColumnName") }

df.select{ Type::myColumnGroup.valueCol<String>("valueColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


@JvmName(name = "valueColUnTyped")
open fun KProperty<*>.valueCol(path: ColumnPath): ColumnAccessor<*>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.valueCol("pathTo"["valueColumnName"] ) }

df.select{ Type::myColumnGroup.valueCol<String>("pathTo"["valueColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.valueCol("pathTo"["valueColumnName"] ) }

df.select{ Type::myColumnGroup.valueCol<String>("pathTo"["valueColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> valueCol(property: KProperty<C>): SingleColumn<C>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ valueCol(Type::valueColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> SingleColumn<DataRow<*>>.valueCol(property: KProperty<C>): SingleColumn<C>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ myColumnGroup.valueCol(Type::valueColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> String.valueCol(property: KProperty<C>): ColumnAccessor<C>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".valueCol(Type::valueColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> KProperty<*>.valueCol(property: KProperty<C>): ColumnAccessor<C>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.valueCol(Type::valueColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


open fun <C> ColumnPath.valueCol(property: KProperty<C>): ColumnAccessor<C>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].valueCol(Type::valueColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.


@JvmName(name = "valueColUnTyped")
open fun KProperty<*>.valueCol(index: Int): SingleColumn<*>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.valueCol(0) }

df.select{ Type::myColumnGroup.valueCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.

if the index is out of bounds.


open fun <C> KProperty<*>.valueCol(index: Int): SingleColumn<C>

Deprecated

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

Value Col

Creates a ColumnAccessor (or SingleColumn) for a value column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for valueColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a value column. The function can also be called on ColumnGroups to create an accessor for a value column inside a ColumnGroup.

    

For more information: See valueCol on the documentation website.

Check out: Grammar

For example:

df.select{ valueCol<String>("valueColA") }

df.select{ valueCol(SomeType::valueColB) }

df.select{ myColumnGroup.valueCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.valueCol(0) }

df.select{ Type::myColumnGroup.valueCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and frameCol.

Return

A ColumnAccessor for the value column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a value column.

if the index is out of bounds.