pandasx / Index

Class: Index

Defined in: src/core/indexes.ts:44

Immutable sequence of row (or column) labels with hash lookup.

Labels may be tuples, which is how multi-key groupby results are indexed; names then holds one name per tuple level.

Constructors

Constructor

new Index(labels, options?): Index

Defined in: src/core/indexes.ts:54

Parameters

Parameter	Type
labels	readonly Label[]
options	{ isDefault?: boolean; name?: string | null; names?: readonly (string | null)[] | null; tz?: string | null; }
options.isDefault?	boolean
options.name?	string | null
options.names?	readonly (string | null)[] | null
options.tz?	string | null

Returns

Index

Properties

Property	Modifier	Type	Description	Defined in
isDefault	readonly	boolean	True for the default 0..n-1 index.	src/core/indexes.ts:49
labels	readonly	readonly Label[]	-	src/core/indexes.ts:45
name	readonly	string | null	-	src/core/indexes.ts:46
names	readonly	readonly (string | null)[] | null	-	src/core/indexes.ts:47
tz	readonly	string | null	Time zone in which datetime labels are displayed / binned (null = naive).	src/core/indexes.ts:51

Accessors

isDatetime

Get Signature

get isDatetime(): boolean

Defined in: src/core/indexes.ts:112

True for a flat index whose labels are all dates (or missing).

Returns

boolean

---

isMonotonicDecreasing

Get Signature

get isMonotonicDecreasing(): boolean

Defined in: src/core/indexes.ts:179

Returns

boolean

---

isMonotonicIncreasing

Get Signature

get isMonotonicIncreasing(): boolean

Defined in: src/core/indexes.ts:174

Whether labels never decrease.

Returns

boolean

---

isMulti

Get Signature

get isMulti(): boolean

Defined in: src/core/indexes.ts:190

Returns

boolean

---

isUnique

Get Signature

get isUnique(): boolean

Defined in: src/core/indexes.ts:122

Returns

boolean

---

length

Get Signature

get length(): number

Defined in: src/core/indexes.ts:71

Returns

number

---

levels

Get Signature

get levels(): Label[][]

Defined in: src/core/indexes.ts:216

Sorted unique values of each level.

Returns

Label[][]

---

nlevels

Get Signature

get nlevels(): number

Defined in: src/core/indexes.ts:76

Number of tuple levels (1 for a flat index).

Returns

number

Methods

droplevel()

droplevel(level): Index

Defined in: src/core/indexes.ts:232

Removes level(s).

Parameters

Parameter	Type
level	string | number | readonly (string | number)[]

Returns

Index

---

equals()

equals(other): boolean

Defined in: src/core/indexes.ts:135

Parameters

Parameter	Type
other	Index

Returns

boolean

---

fromArrays()

static fromArrays(arrays, options?): Index

Defined in: src/core/indexes.ts:278

MultiIndex from one array per level.

Parameters

Parameter	Type
arrays	readonly readonly Label[][]
options	{ names?: readonly (string | null)[]; }
options.names?	readonly (string | null)[]

Returns

Index

---

fromProduct()

static fromProduct(levels, options?): Index

Defined in: src/core/indexes.ts:285

Cartesian product of the levels, like pd.MultiIndex.from_product.

Parameters

Parameter	Type
levels	readonly readonly Label[][]
options	{ names?: readonly (string | null)[]; }
options.names?	readonly (string | null)[]

Returns

Index

---

fromTuples()

static fromTuples(tuples, options?): Index

Defined in: src/core/indexes.ts:272

MultiIndex from tuples, like pd.MultiIndex.from_tuples.

Parameters

Parameter	Type
tuples	readonly readonly Label[][]
options	{ names?: readonly (string | null)[]; }
options.names?	readonly (string | null)[]

Returns

Index

---

getIndexer()

getIndexer(labels): Int32Array

Defined in: src/core/indexes.ts:127

Position of each label in this index, -1 when missing. Requires a unique index.

Parameters

Parameter	Type
labels	readonly Label[]

Returns

Int32Array

---

getLevelValues()

getLevelValues(level): Index

Defined in: src/core/indexes.ts:209

Values of one level, in row order.

Parameters

Parameter	Type
level	string | number

Returns

Index

---

getLoc()

getLoc(label): readonly number[]

Defined in: src/core/indexes.ts:98

All positions holding label (empty when absent). On a datetime index a date string (or Date) also matches every label in the period it names.

Parameters

Parameter	Type
label	Label

Returns

readonly number[]

---

getLocPrefix()

getLocPrefix(prefix): number[]

Defined in: src/core/indexes.ts:260

Positions whose tuple label starts with prefix.

Parameters

Parameter	Type
prefix	readonly Label[]

Returns

number[]

---

has()

has(label): boolean

Defined in: src/core/indexes.ts:118

Parameters

Parameter	Type
label	Label

Returns

boolean

---

levelNumber()

levelNumber(level): number

Defined in: src/core/indexes.ts:195

Position of a level given by number (negative from the end) or name.

Parameters

Parameter	Type
level	string | number

Returns

number

---

range()

static range(n, start?): Index

Defined in: src/core/indexes.ts:65

Parameters

Parameter	Type	Default value
n	number	undefined
start	number	0

Returns

Index

---

rename()

rename(name): Index

Defined in: src/core/indexes.ts:163

Parameters

Parameter	Type
name	string | null

Returns

Index

---

reorderLevels()

reorderLevels(order): Index

Defined in: src/core/indexes.ts:247

Parameters

Parameter	Type
order	readonly (string | number)[]

Returns

Index

---

setNames()

setNames(names): Index

Defined in: src/core/indexes.ts:251

Parameters

Parameter	Type
names	string | readonly (string | null)[] | null

Returns

Index

---

swaplevel()

swaplevel(i?, j?): Index

Defined in: src/core/indexes.ts:240

Parameters

Parameter	Type	Default value
i	string | number	-2
j	string | number	-1

Returns

Index

---

take()

take(positions): Index

Defined in: src/core/indexes.ts:145

Parameters

Parameter	Type
positions	ArrayLike<number>

Returns

Index

---

toArray()

toArray(): Label[]

Defined in: src/core/indexes.ts:184

Returns

Label[]

---

toSeries()

toSeries(): Series

Defined in: src/core/indexes.ts:168

Labels as a Series (indexed by themselves), e.g. to use .dt on a datetime index.

Returns

Series

---

union()

union(other): Index

Defined in: src/core/indexes.ts:152

Sorted union of labels (order of appearance if labels cannot be sorted meaningfully).

Parameters

Parameter	Type
other	Index

Returns

Index