Function Series

Series<T>(values): pl.Series<JsToDtype<T>, string>
Creates a new Series from a set of values.
Type Parameters
- T extends JsType
Parameters
- values: ArrayLike<null | T>
  — A set of values to include in the new Series object.
Returns pl.Series<JsToDtype<T>, string>
Example
```
>  pl.Series([1, 2, 3])
shape: (3,)
Series: '' [f64]
[
        1
        2
        3
]
```
- Defined in series/index.ts:34
- Defined in series/index.ts:1997
Series(values): pl.Series<any, string>
Parameters
- values: any
Returns pl.Series<any, string>
- Defined in series/index.ts:34
- Defined in series/index.ts:1997
Series<T1, Name>(name, values): pl.Series<JsToDtype<T1>, Name>
Create a new named series
Type Parameters
- T1 extends JsType
- Name extends string
Parameters
- name: Name
  The name of the series
- values: ArrayLike<null | T1>
  A set of values to include in the new Series object.
Returns pl.Series<JsToDtype<T1>, Name>
Example
```
>  pl.Series('foo', [1, 2, 3])
shape: (3,)
Series: 'foo' [f64]
[
        1
        2
        3
]
```
- Defined in series/index.ts:34
- Defined in series/index.ts:1997
Series<T2, Name>(name, values, dtype?): pl.Series<T2, Name>
Type Parameters
- T2 extends DataType
- Name extends string
Parameters
- name: Name
- values: ArrayLike<DTypeToJs<T2>>
- Optionaldtype: T2
Returns pl.Series<T2, Name>
- Defined in series/index.ts:34
- Defined in series/index.ts:1997
Series(name, values, dtype?): pl.Series<any, string>
Parameters
- name: string
- values: any[]
- Optionaldtype: any
Returns pl.Series<any, string>
- Defined in series/index.ts:34
- Defined in series/index.ts:1997

Index

Methods

deserialize from isSeries of

Methods

deserialize

deserialize(buf, format): pl.Series<any, string>
De-serializes buffer via serde
Parameters
- buf: Buffer
  buffer to deserialize
- format: "json" | "bincode"
  json | bincode
Returns pl.Series<any, string>
- Defined in shared_traits.ts:1022

from

from<T1>(arrayLike): pl.Series<JsToDtype<T1>, string>
Creates an array from an array-like object.
Type Parameters
- T1 extends JsType
Parameters
- arrayLike: ArrayLike<T1>
  — An array-like object to convert to an array.
Returns pl.Series<JsToDtype<T1>, string>
- Defined in series/index.ts:1945
from<T1>(arrayLike): pl.Series<any, string>
Type Parameters
- T1
Parameters
- arrayLike: ArrayLike<T1>
Returns pl.Series<any, string>
- Defined in series/index.ts:1946
from<T2, Name>(name, arrayLike): pl.Series<JsToDtype<T2>, Name>
Type Parameters
- T2 extends JsType
- Name extends string
Parameters
- name: Name
- arrayLike: ArrayLike<T2>
Returns pl.Series<JsToDtype<T2>, Name>
- Defined in series/index.ts:1947
from<T2>(name, arrayLike): pl.Series<any, string>
Type Parameters
- T2
Parameters
- name: string
- arrayLike: ArrayLike<T2>
Returns pl.Series<any, string>
- Defined in series/index.ts:1951

isSeries

isSeries(arg): arg is pl.Series<any, string>
Parameters
- arg: any
Returns arg is pl.Series<any, string>
- Defined in series/index.ts:1958

of

of<T3>(...items): pl.Series<JsToDtype<T3>, string>
Returns a new Series from a set of elements.
Type Parameters
- T3 extends JsType
Parameters
- Rest...items: T3[]
  — A set of elements to include in the new Series object.
Returns pl.Series<JsToDtype<T3>, string>
- Defined in series/index.ts:1956
of<T3>(...items): pl.Series<any, string>
Type Parameters
- T3
Parameters
- Rest...items: T3[]
Returns pl.Series<any, string>
- Defined in series/index.ts:1957

Function Series

Type Parameters

Parameters

Returns pl.Series<JsToDtype<T>, string>

Example

Parameters

Returns pl.Series<any, string>

Type Parameters

Parameters

Returns pl.Series<JsToDtype<T1>, Name>

Example

Type Parameters

Parameters

Returns pl.Series<T2, Name>

Parameters

Returns pl.Series<any, string>

Index

Methods

Methods

deserialize

Parameters

Returns pl.Series<any, string>

from

Type Parameters

Parameters

Returns pl.Series<JsToDtype<T1>, string>

Type Parameters

Parameters

Returns pl.Series<any, string>

Type Parameters

Parameters

Returns pl.Series<JsToDtype<T2>, Name>

Type Parameters

Parameters

Returns pl.Series<any, string>

isSeries

Parameters

Returns arg is pl.Series<any, string>

of

Type Parameters

Parameters

Returns pl.Series<JsToDtype<T3>, string>

Type Parameters

Parameters

Returns pl.Series<any, string>

Settings

On This Page