pandasx / Series

Class: Series

Defined in: src/series.ts:172

One-dimensional labeled array, the equivalent of pandas.Series.

Constructors

Constructor

new Series(data?, options?): Series

Defined in: src/series.ts:179

Parameters

Parameter	Type	Default value
data	SeriesInput	[]
options	SeriesOptions	{}

Returns

Series

Properties

Property	Type	Defined in
index	Index	src/series.ts:176
name	string | null	src/series.ts:177

Accessors

cat

Get Signature

get cat(): CategoricalMethods

Defined in: src/series.ts:623

Categorical helpers (series.cat).

Returns

CategoricalMethods

---

dt

Get Signature

get dt(): DatetimeMethods

Defined in: src/series.ts:241

Returns

DatetimeMethods

---

dtype

Get Signature

get dtype(): DType

Defined in: src/series.ts:212

Returns

DType

---

empty

Get Signature

get empty(): boolean

Defined in: src/series.ts:228

Returns

boolean

---

length

Get Signature

get length(): number

Defined in: src/series.ts:216

Returns

number

---

plot

Get Signature

get plot(): PlotAccessor

Defined in: src/series.ts:1105

SVG charts: plot({ kind }) or plot.line(), plot.bar(), plot.hist(), ...

Returns

PlotAccessor

---

shape

Get Signature

get shape(): [number]

Defined in: src/series.ts:224

Returns

[number]

---

size

Get Signature

get size(): number

Defined in: src/series.ts:220

Returns

number

---

str

Get Signature

get str(): StringMethods

Defined in: src/series.ts:237

Returns

StringMethods

---

values

Get Signature

get values(): unknown[]

Defined in: src/series.ts:233

Values as a JS array (a copy).

Returns

unknown[]

Methods

[iterator]()

[iterator](): IterableIterator<unknown>

Defined in: src/series.ts:276

Returns

IterableIterator<unknown>

---

abs()

abs(): Series

Defined in: src/series.ts:578

Returns

Series

---

add()

add(other, options?): Series

Defined in: src/series.ts:884

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

agg()

Call Signature

agg(func): unknown

Defined in: src/series.ts:415

Applies one aggregation, several (returns a Series) or a reducer function.

Parameters

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

Returns

unknown

Call Signature

agg(func): Series

Defined in: src/series.ts:416

Applies one aggregation, several (returns a Series) or a reducer function.

Parameters

Parameter	Type
func	readonly (AggName | ((s) => unknown))[]

Returns

Series

---

all()

all(): boolean

Defined in: src/series.ts:1029

Returns

boolean

---

and()

and(other): Series

Defined in: src/series.ts:967

Parameters

Parameter	Type
other	Operand

Returns

Series

---

any()

any(): boolean

Defined in: src/series.ts:1024

Returns

boolean

---

apply()

apply(fn): Series

Defined in: src/series.ts:607

Same as map with a function (pandas' Series.apply is element-wise).

Parameters

Parameter	Type
fn	(value, label) => unknown

Returns

Series

---

argsort()

argsort(): Series

Defined in: src/series.ts:739

Returns

Series

---

asfreq()

asfreq(freq, options?): Series

Defined in: src/series.ts:1147

Conforms a datetime index to freq, optionally filling ('ffill' / 'bfill').

Parameters

Parameter	Type
freq	string | DateOffset
options	{ fillValue?: unknown; method?: "pad" | "ffill" | "bfill" | "backfill"; }
options.fillValue?	unknown
options.method?	"pad" | "ffill" | "bfill" | "backfill"

Returns

Series

---

astype()

astype(dtype, options?): Series

Defined in: src/series.ts:612

Casts to dtype; category accepts {categories, ordered}, period accepts {freq}.

Parameters

Parameter	Type
dtype	DType
options	{ categories?: readonly unknown[]; freq?: string; ordered?: boolean; }
options.categories?	readonly unknown[]
options.freq?	string
options.ordered?	boolean

Returns

Series

---

at()

at(label): unknown

Defined in: src/series.ts:293

Parameters

Parameter	Type
label	Label

Returns

unknown

---

atTime()

atTime(time): Series

Defined in: src/series.ts:1162

Rows at a time of day, e.g. atTime('09:30').

Parameters

Parameter	Type
time	string

Returns

Series

---

autocorr()

autocorr(lag?): number

Defined in: src/series.ts:773

Correlation of the series with itself shifted by lag.

Parameters

Parameter	Type	Default value
lag	number	1

Returns

number

---

between()

between(left, right, inclusive?): Series

Defined in: src/series.ts:796

Parameters

Parameter	Type	Default value
left	Operand	undefined
right	Operand	undefined
inclusive	"both" | "neither" | "left" | "right"	'both'

Returns

Series

---

betweenTime()

betweenTime(start, end, options?): Series

Defined in: src/series.ts:1167

Rows between two times of day, e.g. betweenTime('09:00', '17:00').

Parameters

Parameter	Type
start	string
end	string
options	{ inclusive?: "both" | "neither" | "left" | "right"; }
options.inclusive?	"both" | "neither" | "left" | "right"

Returns

Series

---

bfill()

bfill(limit?): Series

Defined in: src/series.ts:684

Propagates the next valid value backward.

Parameters

Parameter	Type	Default value
limit	number	Infinity

Returns

Series

---

clip()

clip(lower?, upper?): Series

Defined in: src/series.ts:587

Parameters

Parameter	Type
lower?	number | null
upper?	number | null

Returns

Series

---

combineFirst()

combineFirst(other): Series

Defined in: src/series.ts:1070

Parameters

Parameter	Type
other	Series

Returns

Series

---

compare()

compare(other, options?): DataFrame

Defined in: src/series.ts:1081

Differences with other as self/other columns.

Parameters

Parameter	Type
other	Series
options	{ keepEqual?: boolean; keepShape?: boolean; resultNames?: [string, string]; }
options.keepEqual?	boolean
options.keepShape?	boolean
options.resultNames?	[string, string]

Returns

DataFrame

---

convertDtypes()

convertDtypes(): Series

Defined in: src/series.ts:618

Converts to the best nullable dtypes: Int64, Float64, boolean, string (pandas convert_dtypes).

Returns

Series

---

copy()

copy(): Series

Defined in: src/series.ts:264

Returns

Series

---

corr()

corr(other, options?): number

Defined in: src/series.ts:761

Correlation with another Series (aligned on the index).

Parameters

Parameter	Type
other	Series
options	{ method?: CorrMethod; minPeriods?: number; }
options.method?	CorrMethod
options.minPeriods?	number

Returns

number

---

count()

count(): number

Defined in: src/series.ts:397

Number of non-missing values.

Returns

number

---

cov()

cov(other, options?): number

Defined in: src/series.ts:767

Sample covariance with another Series (aligned on the index).

Parameters

Parameter	Type
other	Series
options	{ ddof?: number; minPeriods?: number; }
options.ddof?	number
options.minPeriods?	number

Returns

number

---

cummax()

cummax(): Series

Defined in: src/series.ts:527

Returns

Series

---

cummin()

cummin(): Series

Defined in: src/series.ts:528

Returns

Series

---

cumprod()

cumprod(): Series

Defined in: src/series.ts:526

Returns

Series

---

cumsum()

cumsum(): Series

Defined in: src/series.ts:525

Returns

Series

---

describe()

describe(): Series

Defined in: src/series.ts:446

Summary statistics (numeric: count/mean/std/min/quartiles/max; otherwise count/unique/top/freq).

Returns

Series

---

diff()

diff(periods?): Series

Defined in: src/series.ts:560

Parameters

Parameter	Type	Default value
periods	number	1

Returns

Series

---

div()

div(other, options?): Series

Defined in: src/series.ts:887

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

dropDuplicates()

dropDuplicates(keep?): Series

Defined in: src/series.ts:783

Parameters

Parameter	Type	Default value
keep	false | "first" | "last"	'first'

Returns

Series

---

droplevel()

droplevel(level, options?): Series

Defined in: src/series.ts:1117

Removes index level(s) (or column levels with axis: 1).

Parameters

Parameter	Type
level	string | number | readonly (string | number)[]
options	{ axis?: 0 | 1 | "columns" | "index"; }
options.axis?	0 | 1 | "columns" | "index"

Returns

Series

---

dropna()

dropna(): Series

Defined in: src/series.ts:701

Returns

Series

---

duplicated()

duplicated(keep?): Series

Defined in: src/series.ts:779

Parameters

Parameter	Type	Default value
keep	false | "first" | "last"	'first'

Returns

Series

---

eq()

eq(other): Series

Defined in: src/series.ts:932

Parameters

Parameter	Type
other	Operand

Returns

Series

---

equals()

equals(other): boolean

Defined in: src/series.ts:1035

True when both series have the same index, dtype-compatible values and NAs in the same places.

Parameters

Parameter	Type
other	Series

Returns

boolean

---

ewm()

ewm(options): EWM<Series>

Defined in: src/series.ts:390

Exponentially weighted window; pass one of com, span, halflife or alpha.

Parameters

Parameter	Type
options	EwmOptions

Returns

EWM<Series>

---

expanding()

expanding(options?): Expanding<Series>

Defined in: src/series.ts:385

Expanding window (all rows up to the current one).

Parameters

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

Returns

Expanding<Series>

---

explode()

explode(options?): Series

Defined in: src/series.ts:1066

One row per element of list-like values.

Parameters

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

Returns

Series

---

ffill()

ffill(limit?): Series

Defined in: src/series.ts:679

Propagates the last valid value forward.

Parameters

Parameter	Type	Default value
limit	number	Infinity

Returns

Series

---

fillna()

fillna(value): Series

Defined in: src/series.ts:672

Parameters

Parameter	Type
value	unknown

Returns

Series

---

filter()

filter(predicate): Series

Defined in: src/series.ts:347

Parameters

Parameter	Type
predicate	(value, label) => boolean

Returns

Series

---

firstValidIndex()

firstValidIndex(): Label

Defined in: src/series.ts:550

Label of the first non-missing value (null when none).

Returns

Label

---

floordiv()

floordiv(other, options?): Series

Defined in: src/series.ts:891

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

ge()

ge(other): Series

Defined in: src/series.ts:937

Parameters

Parameter	Type
other	Operand

Returns

Series

---

get()

get(label, defaultValue?): unknown

Defined in: src/series.ts:287

Value for label, or defaultValue when absent (like Series.get).

Parameters

Parameter	Type	Default value
label	Label	undefined
defaultValue	unknown	undefined

Returns

unknown

---

groupby()

groupby(by, options?): SeriesGroupBy

Defined in: src/series.ts:1055

Groups values by Series, arrays of keys, functions of the index label, and/or index levels.

Parameters

Parameter	Type
by	GroupKey | readonly GroupKey[] | null
options	GroupByOptions

Returns

SeriesGroupBy

---

gt()

gt(other): Series

Defined in: src/series.ts:936

Parameters

Parameter	Type
other	Operand

Returns

Series

---

head()

head(n?): Series

Defined in: src/series.ts:328

Parameters

Parameter	Type	Default value
n	number	5

Returns

Series

---

iat()

iat(position): unknown

Defined in: src/series.ts:299

Parameters

Parameter	Type
position	number

Returns

unknown

---

idxmax()

idxmax(): Label

Defined in: src/series.ts:425

Returns

Label

---

idxmin()

idxmin(): Label

Defined in: src/series.ts:429

Returns

Label

---

iloc()

Call Signature

iloc(key): unknown

Defined in: src/series.ts:315

Position-based selection: integer, integers, boolean mask, slice (exclusive) or callable.

Parameters

Parameter	Type
key	number

Returns

unknown

Call Signature

iloc(key): Series

Defined in: src/series.ts:316

Position-based selection: integer, integers, boolean mask, slice (exclusive) or callable.

Parameters

Parameter	Type
key	Mask | Slice | readonly number[] | ((s) => Mask)

Returns

Series

---

interpolate()

interpolate(options?): Series

Defined in: src/series.ts:711

Fills NaN by interpolation. Methods: linear (default), time, index/values, nearest, zero/pad/ffill, bfill, quadratic, cubic, spline, polynomial, pchip, akima.

Parameters

Parameter	Type
options	InterpolateOptions

Returns

Series

---

isin()

isin(values): Series

Defined in: src/series.ts:788

True where the value is contained in values.

Parameters

Parameter	Type
values	Iterable<unknown>

Returns

Series

---

isna()

isna(): Series

Defined in: src/series.ts:659

Returns

Series

---

isnull()

isnull(): Series

Defined in: src/series.ts:669

Returns

Series

---

items()

items(): IterableIterator<[Label, unknown]>

Defined in: src/series.ts:280

Returns

IterableIterator<[Label, unknown]>

---

kurt()

kurt(): number

Defined in: src/series.ts:374

Excess kurtosis (bias corrected).

Returns

number

---

kurtosis()

kurtosis(): number

Defined in: src/series.ts:375

Returns

number

---

lastValidIndex()

lastValidIndex(): Label

Defined in: src/series.ts:555

Returns

Label

---

le()

le(other): Series

Defined in: src/series.ts:935

Parameters

Parameter	Type
other	Operand

Returns

Series

---

loc()

Call Signature

loc(key): Series

Defined in: src/series.ts:304

Label-based selection: label, labels, boolean mask, slice (inclusive) or callable.

Parameters

Parameter	Type
key	readonly Label[] | Mask | Slice | ((s) => Mask)

Returns

Series

Call Signature

loc(key): unknown

Defined in: src/series.ts:305

Label-based selection: label, labels, boolean mask, slice (inclusive) or callable.

Parameters

Parameter	Type
key	Label

Returns

unknown

---

lt()

lt(other): Series

Defined in: src/series.ts:934

Parameters

Parameter	Type
other	Operand

Returns

Series

---

map()

map(mapper, options?): Series

Defined in: src/series.ts:594

Element-wise transform with a function, or substitution via a lookup object / Map.

Parameters

Parameter	Type
mapper	Record<string, unknown> | ((value, label) => unknown) | Map<unknown, unknown>
options	{ naAction?: "ignore"; }
options.naAction?	"ignore"

Returns

Series

---

mask()

mask(cond, other?): Series

Defined in: src/series.ts:645

Opposite of where: replaces values where cond is true.

Parameters

Parameter	Type	Default value
cond	Mask | ((s) => Mask)	undefined
other	unknown	null

Returns

Series

---

max()

max(opts?): unknown

Defined in: src/series.ts:370

Parameters

Parameter	Type
opts?	AggOptions

Returns

unknown

---

mean()

mean(opts?): number

Defined in: src/series.ts:365

Parameters

Parameter	Type
opts?	AggOptions

Returns

number

---

median()

median(opts?): number

Defined in: src/series.ts:366

Parameters

Parameter	Type
opts?	AggOptions

Returns

number

---

memoryUsage()

memoryUsage(options?): number

Defined in: src/series.ts:1086

Bytes used by the values (and index), like memory_usage.

Parameters

Parameter	Type
options	{ deep?: boolean; index?: boolean; }
options.deep?	boolean
options.index?	boolean

Returns

number

---

min()

min(opts?): unknown

Defined in: src/series.ts:369

Parameters

Parameter	Type
opts?	AggOptions

Returns

unknown

---

mod()

mod(other, options?): Series

Defined in: src/series.ts:889

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

mode()

mode(): Series

Defined in: src/series.ts:504

Returns

Series

---

mul()

mul(other, options?): Series

Defined in: src/series.ts:886

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

ne()

ne(other): Series

Defined in: src/series.ts:933

Parameters

Parameter	Type
other	Operand

Returns

Series

---

neg()

neg(): Series

Defined in: src/series.ts:899

Returns

Series

---

nlargest()

nlargest(n?): Series

Defined in: src/series.ts:744

Parameters

Parameter	Type	Default value
n	number	5

Returns

Series

---

not()

not(): Series

Defined in: src/series.ts:971

Returns

Series

---

notna()

notna(): Series

Defined in: src/series.ts:665

Returns

Series

---

notnull()

notnull(): Series

Defined in: src/series.ts:670

Returns

Series

---

nsmallest()

nsmallest(n?): Series

Defined in: src/series.ts:748

Parameters

Parameter	Type	Default value
n	number	5

Returns

Series

---

nunique()

nunique(): number

Defined in: src/series.ts:398

Returns

number

---

or()

or(other): Series

Defined in: src/series.ts:968

Parameters

Parameter	Type
other	Operand

Returns

Series

---

pctChange()

pctChange(periods?): Series

Defined in: src/series.ts:564

Parameters

Parameter	Type	Default value
periods	number	1

Returns

Series

---

pipe()

pipe<T, A>(fn, ...args): T

Defined in: src/series.ts:410

Calls fn(this, ...args), for chaining custom steps: s.pipe(clean).pipe(scale, 10).

Type Parameters

Type Parameter
T
A extends unknown[]

Parameters

Parameter	Type
fn	(s, ...args) => T
...args	A

Returns

T

---

pow()

pow(other, options?): Series

Defined in: src/series.ts:890

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

prod()

prod(opts?): number

Defined in: src/series.ts:364

Parameters

Parameter	Type
opts?	AggOptions

Returns

number

---

quantile()

Call Signature

quantile(q, options?): number

Defined in: src/series.ts:401

Quantile(s) of the non-missing values; interpolation as in pandas (default 'linear').

Parameters

Parameter	Type
q	number
options?	{ interpolation?: QuantileInterpolation; }
options.interpolation?	QuantileInterpolation

Returns

number

Call Signature

quantile(q, options?): Series

Defined in: src/series.ts:402

Quantile(s) of the non-missing values; interpolation as in pandas (default 'linear').

Parameters

Parameter	Type
q	readonly number[]
options?	{ interpolation?: QuantileInterpolation; }
options.interpolation?	QuantileInterpolation

Returns

Series

---

radd()

radd(other, options?): Series

Defined in: src/series.ts:892

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

rank()

rank(options?): Series

Defined in: src/series.ts:753

Ranks (1-based); method: average (default), min, max, first, dense.

Parameters

Parameter	Type
options	RankOptions

Returns

Series

---

rdiv()

rdiv(other, options?): Series

Defined in: src/series.ts:895

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

reindex()

reindex(labels, fillValue?): Series

Defined in: src/series.ts:337

Conforms to new labels; missing labels get fillValue (NA by default).

Parameters

Parameter	Type	Default value
labels	Index | readonly Label[]	undefined
fillValue	unknown	null

Returns

Series

---

rename()

rename(name): Series

Defined in: src/series.ts:268

Parameters

Parameter	Type
name	string | null

Returns

Series

---

reorderLevels()

reorderLevels(order, options?): Series

Defined in: src/series.ts:1125

Parameters

Parameter	Type
order	readonly (string | number)[]
options	{ axis?: 0 | 1 | "columns" | "index"; }
options.axis?	0 | 1 | "columns" | "index"

Returns

Series

---

replace()

replace(from, to?): Series

Defined in: src/series.ts:628

Replaces values equal to from (or every key of a mapping) with to.

Parameters

Parameter	Type
from	unknown
to?	unknown

Returns

Series

---

resample()

resample(rule, options?): Resampler<Series>

Defined in: src/series.ts:1142

Groups by time bins, like resample('ME') / resample('15min').

Parameters

Parameter	Type
rule	string | DateOffset
options	ResampleOptions

Returns

Resampler<Series>

---

resetIndex()

Call Signature

resetIndex(options?): DataFrame

Defined in: src/series.ts:1046

Parameters

Parameter	Type
options?	{ drop?: false; name?: string; }
options.drop?	false
options.name?	string

Returns

DataFrame

Call Signature

resetIndex(options): Series

Defined in: src/series.ts:1047

Parameters

Parameter	Type
options	{ drop: true; }
options.drop	true

Returns

Series

Call Signature

resetIndex(options?): DataFrame | Series

Defined in: src/series.ts:1048

Parameters

Parameter	Type
options?	{ drop?: boolean; name?: string; }
options.drop?	boolean
options.name?	string

Returns

DataFrame | Series

---

rfloordiv()

rfloordiv(other, options?): Series

Defined in: src/series.ts:898

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

rmod()

rmod(other, options?): Series

Defined in: src/series.ts:896

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

rmul()

rmul(other, options?): Series

Defined in: src/series.ts:894

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

rolling()

rolling(window, options?): Rolling<Series>

Defined in: src/series.ts:380

Rolling window of window rows, or a time span ('3D', '2h') over a datetime index.

Parameters

Parameter	Type
window	string | number | Timedelta
options	RollingOptions

Returns

Rolling<Series>

---

round()

round(decimals?): Series

Defined in: src/series.ts:581

Rounds like NumPy / pandas: rint(v * 10^d) / 10^d, ties to even (2.5 → 2, 0.125 → 0.12).

Parameters

Parameter	Type	Default value
decimals	number	0

Returns

Series

---

rpow()

rpow(other, options?): Series

Defined in: src/series.ts:897

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

rsub()

rsub(other, options?): Series

Defined in: src/series.ts:893

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

sample()

sample(n?, options?): Series

Defined in: src/series.ts:353

Parameters

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

Returns

Series

---

sem()

sem(opts?): number

Defined in: src/series.ts:395

Standard error of the mean.

Parameters

Parameter	Type
opts?	AggOptions

Returns

number

---

setAt()

setAt(label, value): this

Defined in: src/series.ts:1004

Parameters

Parameter	Type
label	Label
value	unknown

Returns

this

---

setIat()

setIat(position, value): this

Defined in: src/series.ts:1008

Parameters

Parameter	Type
position	number
value	unknown

Returns

this

---

setIloc()

setIloc(key, value): this

Defined in: src/series.ts:999

In-place assignment by position, like s.iloc[key] = value.

Parameters

Parameter	Type
key	number | Mask | Slice | readonly number[] | ((s) => Mask)
value	unknown

Returns

this

---

setIndex()

setIndex(index): Series

Defined in: src/series.ts:272

Parameters

Parameter	Type
index	Index | readonly Label[]

Returns

Series

---

setLoc()

setLoc(key, value): this

Defined in: src/series.ts:988

In-place assignment by label, like s.loc[key] = value. A new scalar label appends a row. value may be a scalar, an array (one per selected row) or a Series (aligned by label).

Parameters

Parameter	Type
key	RowSelector | ((s) => Mask)
value	unknown

Returns

this

---

shift()

shift(periods?, options?): Series

Defined in: src/series.ts:534

Shifts values by periods positions (filling with NA or fillValue), or with { freq } shifts the datetime index instead of the data.

Parameters

Parameter	Type	Default value
periods	number	1
options	unknown	{}

Returns

Series

---

skew()

skew(): number

Defined in: src/series.ts:372

Sample skewness (bias corrected).

Returns

number

---

sortIndex()

sortIndex(options?): Series

Defined in: src/series.ts:734

Parameters

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

Returns

Series

---

sortValues()

sortValues(options?): Series

Defined in: src/series.ts:729

Parameters

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

Returns

Series

---

std()

std(opts?): number

Defined in: src/series.ts:367

Parameters

Parameter	Type
opts?	AggOptions

Returns

number

---

sub()

sub(other, options?): Series

Defined in: src/series.ts:885

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

sum()

sum(opts?): number

Defined in: src/series.ts:363

Parameters

Parameter	Type
opts?	AggOptions

Returns

number

---

swaplevel()

swaplevel(i?, j?, options?): Series

Defined in: src/series.ts:1121

Parameters

Parameter	Type	Default value
i	string | number	-2
j	string | number	-1
options	{ axis?: 0 | 1 | "columns" | "index"; }	{}
options.axis?	0 | 1 | "columns" | "index"	undefined

Returns

Series

---

tail()

tail(n?): Series

Defined in: src/series.ts:332

Parameters

Parameter	Type	Default value
n	number	5

Returns

Series

---

toArray()

toArray(): unknown[]

Defined in: src/series.ts:245

Returns

unknown[]

---

toCsv()

toCsv(path?, options?): string

Defined in: src/series.ts:1091

CSV text of the series (with its index); writes to path when given.

Parameters

Parameter	Type
path?	string
options?	ToCsvOptions | undefined

Returns

string

---

toDict()

toDict(): Record<string, unknown>

Defined in: src/series.ts:250

{label: value}; tuple labels are joined with commas.

Returns

Record<string, unknown>

---

toFrame()

toFrame(name?): DataFrame

Defined in: src/series.ts:260

Parameters

Parameter	Type
name?	string

Returns

DataFrame

---

toHdf()

toHdf(path, key, options?): Promise<void>

Defined in: src/series.ts:1100

Writes HDF5 in pandas' 'table' format (requires the optional h5wasm).

Parameters

Parameter	Type
path	string
key	string
options	{ mode?: "a" | "w"; }
options.mode?	"a" | "w"

Returns

Promise<void>

---

toJson()

toJson(path?, options?): string

Defined in: src/series.ts:1095

Parameters

Parameter	Type
path?	string
options?	{ compression?: Compression; dateFormat?: "iso" | "epoch"; indent?: number; lines?: boolean; orient?: JsonOrient; } | undefined

Returns

string

---

toJSON()

toJSON(): Record<string, unknown>

Defined in: src/series.ts:256

Returns

Record<string, unknown>

---

toPeriod()

toPeriod(freq?): Series

Defined in: src/series.ts:1177

Converts a datetime index to a period index.

Parameters

Parameter	Type	Default value
freq	string	'D'

Returns

Series

---

toString()

toString(): string

Defined in: src/series.ts:1188

Returns

string

---

toTimestamp()

toTimestamp(how?): Series

Defined in: src/series.ts:1182

Converts a period index to datetimes at the start (or end) of each period.

Parameters

Parameter	Type	Default value
how	"start" | "end"	'start'

Returns

Series

---

truediv()

truediv(other, options?): Series

Defined in: src/series.ts:888

Parameters

Parameter	Type
other	Operand
options	ArithOptions

Returns

Series

---

truncate()

truncate(options?): Series

Defined in: src/series.ts:1172

Rows with index labels between before and after (inclusive).

Parameters

Parameter	Type
options	{ after?: Label; before?: Label; }
options.after?	Label
options.before?	Label

Returns

Series

---

tzConvert()

tzConvert(tz): Series

Defined in: src/series.ts:1157

Converts a tz-aware datetime index to another zone.

Parameters

Parameter	Type
tz	string | null

Returns

Series

---

tzLocalize()

tzLocalize(tz, options?): Series

Defined in: src/series.ts:1152

Localizes a naive datetime index to tz (or removes the zone with null).

Parameters

Parameter	Type
tz	string | null
options	{ ambiguous?: Ambiguous; nonexistent?: Nonexistent; }
options.ambiguous?	Ambiguous
options.nonexistent?	Nonexistent

Returns

Series

---

unique()

unique(): unknown[]

Defined in: src/series.ts:494

Unique values in order of appearance (includes a single NA if present).

Returns

unknown[]

---

unstack()

unstack(options?): DataFrame

Defined in: src/series.ts:1130

Pivots an index level into columns.

Parameters

Parameter	Type
options	{ fillValue?: unknown; level?: string | number | readonly (string | number)[]; }
options.fillValue?	unknown
options.level?	string | number | readonly (string | number)[]

Returns

DataFrame

---

update()

update(other, options?): this

Defined in: src/series.ts:1075

In-place update with the non-missing values of other.

Parameters

Parameter	Type
other	Series
options	{ overwrite?: boolean; }
options.overwrite?	boolean

Returns

this

---

valueCounts()

valueCounts(options?): Series

Defined in: src/series.ts:463

Counts of unique values, most frequent first.

Parameters

Parameter	Type
options	{ ascending?: boolean; dropna?: boolean; normalize?: boolean; sort?: boolean; }
options.ascending?	boolean
options.dropna?	boolean
options.normalize?	boolean
options.sort?	boolean

Returns

Series

---

var()

var(opts?): number

Defined in: src/series.ts:368

Parameters

Parameter	Type
opts?	AggOptions

Returns

number

---

where()

where(cond, other?): Series

Defined in: src/series.ts:640

Keeps values where cond is true; replaces the rest with other.

Parameters

Parameter	Type	Default value
cond	Mask | ((s) => Mask)	undefined
other	unknown	null

Returns

Series

---

xor()

xor(other): Series

Defined in: src/series.ts:969

Parameters

Parameter	Type
other	Operand

Returns

Series

---

xs()

xs(key, options?): unknown

Defined in: src/series.ts:1112

Cross-section at key of an index level (or of the columns with axis: 1).

Parameters

Parameter	Type
key	Label
options	{ axis?: 0 | 1 | "columns" | "index"; dropLevel?: boolean; level?: string | number | readonly (string | number)[]; }
options.axis?	0 | 1 | "columns" | "index"
options.dropLevel?	boolean
options.level?	string | number | readonly (string | number)[]

Returns

unknown