Series.Struct (SeriesStructNameSpace)

Namespace: Polars.FSharp

Properties & Indexers

Property	Type	Description
.[index: int] / .[name: string] / .[names: string[]]	Series	Access the fields of the struct by index. Access the fields of the struct by name. Access the fields of the struct by multiple names.

Instance Methods

Drop

Drop one or more fields from the struct.

member Drop(names: seq<string>, ?strict: bool) : Series

Parameters

Name	Type	Description
names	seq<string>	Names of the fields to drop.
strict	bool (optional)	If True, raise an error if any of the specified fields do not exist in the struct.

---

Field

Retrieve a field from the struct by name.

Retrieve a field from the struct by index.

member Field([<ParamArray>] names: string[]) : Series
member Field(index: int) : Series

Parameters

Name	Type	Description
names	string[]	-
index	int	-

---

JsonEncode

Convert struct to JSON string.

member JsonEncode : unit -> Series

---

RenameFields

Rename the fields of the struct.

member RenameFields([<ParamArray>] names: string[]) : Series

Parameters

Name	Type	Description
names	string[]	-

---

Unnest

Unnest the struct column into a DataFrame. Each field of the struct becomes a separate column.

member Unnest : unit -> DataFrame

---

WithFields

Add or overwrite fields of this struct.This is similar to with_columns on DataFrame.

member WithFields([<ParamArray>] fields: Expr[]) : Series

Parameters

Name	Type	Description
fields	Expr[]	Field(s) to add, specified as positional arguments.

---