pandasx / CategoricalMethods

Class: CategoricalMethods

Defined in: src/accessors.ts:636

Categorical helpers (series.cat), like pandas' .cat accessor.

Constructors

Constructor

new CategoricalMethods(s): CategoricalMethods

Defined in: src/accessors.ts:639

Parameters

Parameter	Type
s	Series

Returns

CategoricalMethods

Accessors

categories

Get Signature

get categories(): unknown[]

Defined in: src/accessors.ts:644

Returns

unknown[]

---

codes

Get Signature

get codes(): Series

Defined in: src/accessors.ts:648

Integer codes (-1 for missing).

Returns

Series

---

ordered

Get Signature

get ordered(): boolean

Defined in: src/accessors.ts:645

Returns

boolean

Methods

addCategories()

addCategories(categories): Series

Defined in: src/accessors.ts:679

Parameters

Parameter	Type
categories	readonly unknown[]

Returns

Series

---

asOrdered()

asOrdered(): Series

Defined in: src/accessors.ts:701

Returns

Series

---

asUnordered()

asUnordered(): Series

Defined in: src/accessors.ts:702

Returns

Series

---

removeCategories()

removeCategories(categories): Series

Defined in: src/accessors.ts:686

Removes categories; values in them become NA.

Parameters

Parameter	Type
categories	readonly unknown[]

Returns

Series

---

removeUnusedCategories()

removeUnusedCategories(): Series

Defined in: src/accessors.ts:691

Returns

Series

---

renameCategories()

renameCategories(names): Series

Defined in: src/accessors.ts:659

New names for the categories, by position (array), mapping, or function.

Parameters

Parameter	Type
names	readonly unknown[] | Record<string, unknown> | ((c) => unknown)

Returns

Series

---

reorderCategories()

reorderCategories(categories, options?): Series

Defined in: src/accessors.ts:671

Parameters

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

Returns

Series

---

setCategories()

setCategories(categories, options?): Series

Defined in: src/accessors.ts:697

Replaces the categories; values not in the new set become NA.

Parameters

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

Returns

Series