Interface StructSeries

Struct Functions for Series

interface StructSeries {
    field(name: string): pl.Series;
    fields: string[];
    nth(index: number): pl.Series;
    renameFields(names: string[]): pl.Series;
    toFrame(): pl.DataFrame;
}

Index

Properties

Methods

field nth renameFields toFrame

Properties

fields

fields: string[]

List of fields of the struct

Returns

Array of field names

Methods

field

field(name: string): pl.Series
Access a field by name
Parameters
- name: string
  name of the field
Returns pl.Series
A new series containing the values of struct's field
- Defined in polars/series/struct.ts:25

nth

nth(index: number): pl.Series
Access a field by index (zero based index)
Parameters
- index: number
  index of the field (starts at 0)
Returns pl.Series
A new series containing the values of struct's field index
- Defined in polars/series/struct.ts:37

renameFields

renameFields(names: string[]): pl.Series
Rename the fields of a struct
Parameters
- names: string[]
  new names of the fields
Returns pl.Series
A new series containing the struct with new field names
- Defined in polars/series/struct.ts:31

toFrame

toFrame(): pl.DataFrame
Convert series of struct into dataframe

Returns pl.DataFrame
A new dataframe
- Defined in polars/series/struct.ts:19