pandasx / SeriesGroupBy

Class: SeriesGroupBy<R>

Defined in: src/groupby.ts:469

Result of groupby(...).get('col') or Series.groupby(...). Reductions return R: a Series by default, or a DataFrame (keys as columns) with { asIndex: false }.

Extends

• BaseGroupBy

Type Parameters

Type Parameter	Default type
R extends Series | DataFrame	Series

Constructors

Constructor

new SeriesGroupBy<R>(frame, by, column, options?, keyNames?, resultName?): SeriesGroupBy<R>

Defined in: src/groupby.ts:473

Parameters

Parameter	Type	Default value
frame	DataFrame	undefined
by	readonly string[]	undefined
column	string	undefined
options	GroupByOptions	{}
keyNames?	readonly (string | null)[]	undefined
resultName?	string | null	column

Returns

SeriesGroupBy<R>

Overrides

BaseGroupBy.constructor

Accessors

groups

Get Signature

get groups(): Map<Label, Label[]>

Defined in: src/groupby.ts:125

Group label → index labels of its rows (pandas .groups).

Returns

Map<Label, Label[]>

Inherited from

BaseGroupBy.groups

---

indices

Get Signature

get indices(): Map<Label, number[]>

Defined in: src/groupby.ts:187

Group label → row positions.

Returns

Map<Label, number[]>

Inherited from

BaseGroupBy.indices

---

ngroups

Get Signature

get ngroups(): number

Defined in: src/groupby.ts:109

Returns

number

Inherited from

BaseGroupBy.ngroups

Methods

[iterator]()

[iterator](): IterableIterator<[Label, Series]>

Defined in: src/groupby.ts:632

Returns

IterableIterator<[Label, Series]>

---

agg()

agg(func): DataFrame | Series

Defined in: src/groupby.ts:514

One func → Series; a list of funcs → DataFrame with one column per func.

Parameters

Parameter	Type
func	AggFunc | readonly AggFunc[] | Record<string, AggFunc>

Returns

DataFrame | Series

---

aggregate()

aggregate(func): DataFrame | Series

Defined in: src/groupby.ts:524

Parameters

Parameter	Type
func	AggFunc | readonly AggFunc[] | Record<string, AggFunc>

Returns

DataFrame | Series

---

all()

all(): R

Defined in: src/groupby.ts:572

Returns

R

---

any()

any(): R

Defined in: src/groupby.ts:571

Returns

R

---

apply()

apply(fn): Series | R

Defined in: src/groupby.ts:529

Calls fn(groupSeries, key) per group; scalars → Series indexed by group.

Parameters

Parameter	Type
fn	(group, key) => unknown

Returns

Series | R

---

bfill()

bfill(limit?): Series

Defined in: src/groupby.ts:582

Parameters

Parameter	Type
limit?	number

Returns

Series

---

count()

count(): R

Defined in: src/groupby.ts:508

Returns

R

---

cumcount()

cumcount(options?): Series

Defined in: src/groupby.ts:139

0-based position of each row within its group.

Parameters

Parameter	Type
options	{ ascending?: boolean; }
options.ascending?	boolean

Returns

Series

Inherited from

BaseGroupBy.cumcount

---

cummax()

cummax(): Series

Defined in: src/groupby.ts:575

Returns

Series

---

cummin()

cummin(): Series

Defined in: src/groupby.ts:576

Returns

Series

---

cumprod()

cumprod(): Series

Defined in: src/groupby.ts:574

Returns

Series

---

cumsum()

cumsum(): Series

Defined in: src/groupby.ts:573

Returns

Series

---

describe()

describe(): DataFrame

Defined in: src/groupby.ts:601

count/mean/std/min/25%/50%/75%/max per group.

Returns

DataFrame

---

diff()

diff(periods?): Series

Defined in: src/groupby.ts:578

Parameters

Parameter	Type	Default value
periods	number	1

Returns

Series

---

ewm()

ewm(options): GroupedOperation

Defined in: src/groupby.ts:157

Parameters

Parameter	Type
options	EwmOptions

Returns

GroupedOperation

Inherited from

BaseGroupBy.ewm

---

expanding()

expanding(options?): GroupedOperation

Defined in: src/groupby.ts:153

Parameters

Parameter	Type
options	{ minPeriods?: number; }
options.minPeriods?	number

Returns

GroupedOperation

Inherited from

BaseGroupBy.expanding

---

ffill()

ffill(limit?): Series

Defined in: src/groupby.ts:581

Parameters

Parameter	Type
limit?	number

Returns

Series

---

fillna()

fillna(value): Series

Defined in: src/groupby.ts:583

Parameters

Parameter	Type
value	unknown

Returns

Series

---

filter()

filter(fn): Series

Defined in: src/groupby.ts:563

Parameters

Parameter	Type
fn	(group, key) => boolean

Returns

Series

---

first()

first(): R

Defined in: src/groupby.ts:509

Returns

R

---

idxmax()

idxmax(): R

Defined in: src/groupby.ts:586

Returns

R

---

idxmin()

idxmin(): R

Defined in: src/groupby.ts:587

Returns

R

---

last()

last(): R

Defined in: src/groupby.ts:510

Returns

R

---

max()

max(): R

Defined in: src/groupby.ts:507

Returns

R

---

mean()

mean(): R

Defined in: src/groupby.ts:502

Returns

R

---

median()

median(): R

Defined in: src/groupby.ts:503

Returns

R

---

min()

min(): R

Defined in: src/groupby.ts:506

Returns

R

---

ngroup()

ngroup(options?): Series

Defined in: src/groupby.ts:131

Group number of each row (NaN for rows whose key was dropped).

Parameters

Parameter	Type
options	{ ascending?: boolean; }
options.ascending?	boolean

Returns

Series

Inherited from

BaseGroupBy.ngroup

---

nth()

nth(n): Series

Defined in: src/groupby.ts:590

n-th value(s) of each group, keeping the original index.

Parameters

Parameter	Type
n	number | readonly number[]

Returns

Series

---

nunique()

nunique(): R

Defined in: src/groupby.ts:511

Returns

R

---

ohlc()

ohlc(): DataFrame

Defined in: src/groupby.ts:612

open/high/low/close per group.

Returns

DataFrame

---

pctChange()

pctChange(periods?): Series

Defined in: src/groupby.ts:579

Parameters

Parameter	Type	Default value
periods	number	1

Returns

Series

---

pipe()

pipe<T>(fn): T

Defined in: src/groupby.ts:167

Calls fn(this), for method chaining.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	(g) => T

Returns

T

Inherited from

BaseGroupBy.pipe

---

prod()

prod(): R

Defined in: src/groupby.ts:501

Returns

R

---

quantile()

quantile(q?): R

Defined in: src/groupby.ts:585

Parameters

Parameter	Type	Default value
q	number	0.5

Returns

R

---

rank()

rank(options?): Series

Defined in: src/groupby.ts:580

Parameters

Parameter	Type
options	RankOptions

Returns

Series

---

resample()

resample(rule, options?): GroupedOperation

Defined in: src/groupby.ts:162

Time resampling within each group.

Parameters

Parameter	Type
rule	string
options	ResampleOptions

Returns

GroupedOperation

Inherited from

BaseGroupBy.resample

---

rolling()

rolling(window, options?): GroupedOperation

Defined in: src/groupby.ts:149

Rolling window within each group; results are indexed by (group key, original label).

Parameters

Parameter	Type
window	string | number
options	RollingOptions

Returns

GroupedOperation

Inherited from

BaseGroupBy.rolling

---

sample()

sample(n?, options?): Series

Defined in: src/groupby.ts:595

Parameters

Parameter	Type	Default value
n	number	1
options	{ seed?: number; }	{}
options.seed?	number	undefined

Returns

Series

---

sem()

sem(): R

Defined in: src/groupby.ts:570

Returns

R

---

shift()

shift(periods?): Series

Defined in: src/groupby.ts:577

Parameters

Parameter	Type	Default value
periods	number	1

Returns

Series

---

size()

size(): R

Defined in: src/groupby.ts:492

Returns

R

---

std()

std(): R

Defined in: src/groupby.ts:504

Returns

R

---

sum()

sum(): R

Defined in: src/groupby.ts:500

Returns

R

---

transform()

transform(func): Series

Defined in: src/groupby.ts:546

Same length as the input: each value replaced by its group's aggregate or fn(group).

Parameters

Parameter	Type
func	AggName | ((s) => unknown)

Returns

Series

---

valueCounts()

valueCounts(): Series

Defined in: src/groupby.ts:620

Returns

Series

---

var()

var(): R

Defined in: src/groupby.ts:505

Returns

R