isFrameColumn

Returns true if this column is a FrameColumn, i.e., its kind is ColumnKind.Frame.

This function has a contract: when it returns true, the compiler smart-casts this column to FrameColumn<*>.

See also isColumnGroup, isValueColumn.

Use asFrameColumn to cast a column to FrameColumn<*> without the check.

Examples

val group: AnyCol = df.groupBy("city").toDataFrame()["group"]
if (group.isFrameColumn()) {
// `group` is smart-cast to `FrameColumn<*>` here
group.schema.value.columns.keys // returns [name, age, city, weight, isHappy]
}

Return

true if this column is a FrameColumn, false otherwise.