pandasx / DatetimeMethods

Class: DatetimeMethods

Defined in: src/accessors.ts:396

Datetime-like properties (series.dt) for datetime (in the series' time zone, UTC when naive), timedelta and period values.

Constructors

Constructor

new DatetimeMethods(s): DatetimeMethods

Defined in: src/accessors.ts:399

Parameters

Parameter	Type
s	Series

Returns

DatetimeMethods

Accessors

components

Get Signature

get components(): DataFrame

Defined in: src/accessors.ts:612

days / hours / minutes / seconds / milliseconds / microseconds / nanoseconds.

Returns

DataFrame

---

date

Get Signature

get date(): Series

Defined in: src/accessors.ts:491

Date part as 'YYYY-MM-DD' strings.

Returns

Series

---

day

Get Signature

get day(): Series

Defined in: src/accessors.ts:456

Returns

Series

---

dayofweek

Get Signature

get dayofweek(): Series

Defined in: src/accessors.ts:464

Monday = 0 … Sunday = 6, as in pandas.

Returns

Series

---

dayofyear

Get Signature

get dayofyear(): Series

Defined in: src/accessors.ts:466

Returns

Series

---

days

Get Signature

get days(): Series

Defined in: src/accessors.ts:600

Whole days (timedelta), floored like pandas.

Returns

Series

---

daysInMonth

Get Signature

get daysInMonth(): Series

Defined in: src/accessors.ts:471

Returns

Series

---

endTime

Get Signature

get endTime(): Series

Defined in: src/accessors.ts:560

Returns

Series

---

freq

Get Signature

get freq(): string | null

Defined in: src/accessors.ts:561

Returns

string | null

---

hour

Get Signature

get hour(): Series

Defined in: src/accessors.ts:457

Returns

Series

---

isLeapYear

Get Signature

get isLeapYear(): Series

Defined in: src/accessors.ts:481

Returns

Series

---

isMonthEnd

Get Signature

get isMonthEnd(): Series

Defined in: src/accessors.ts:476

Returns

Series

---

isMonthStart

Get Signature

get isMonthStart(): Series

Defined in: src/accessors.ts:475

Returns

Series

---

isQuarterEnd

Get Signature

get isQuarterEnd(): Series

Defined in: src/accessors.ts:478

Returns

Series

---

isQuarterStart

Get Signature

get isQuarterStart(): Series

Defined in: src/accessors.ts:477

Returns

Series

---

isYearEnd

Get Signature

get isYearEnd(): Series

Defined in: src/accessors.ts:480

Returns

Series

---

isYearStart

Get Signature

get isYearStart(): Series

Defined in: src/accessors.ts:479

Returns

Series

---

microsecond

Get Signature

get microsecond(): Series

Defined in: src/accessors.ts:461

Returns

Series

---

microseconds

Get Signature

get microseconds(): Series

Defined in: src/accessors.ts:603

Returns

Series

---

millisecond

Get Signature

get millisecond(): Series

Defined in: src/accessors.ts:460

Returns

Series

---

minute

Get Signature

get minute(): Series

Defined in: src/accessors.ts:458

Returns

Series

---

month

Get Signature

get month(): Series

Defined in: src/accessors.ts:455

Returns

Series

---

nanosecond

Get Signature

get nanosecond(): Series

Defined in: src/accessors.ts:462

Returns

Series

---

nanoseconds

Get Signature

get nanoseconds(): Series

Defined in: src/accessors.ts:604

Returns

Series

---

quarter

Get Signature

get quarter(): Series

Defined in: src/accessors.ts:470

Returns

Series

---

second

Get Signature

get second(): Series

Defined in: src/accessors.ts:459

Returns

Series

---

seconds

Get Signature

get seconds(): Series

Defined in: src/accessors.ts:602

Seconds within the day (timedelta).

Returns

Series

---

startTime

Get Signature

get startTime(): Series

Defined in: src/accessors.ts:559

Returns

Series

---

time

Get Signature

get time(): Series

Defined in: src/accessors.ts:493

Time part as 'HH:MM:SS' strings.

Returns

Series

---

tz

Get Signature

get tz(): string | null

Defined in: src/accessors.ts:570

Returns

string | null

---

weekday

Get Signature

get weekday(): Series

Defined in: src/accessors.ts:465

Returns

Series

---

year

Get Signature

get year(): Series

Defined in: src/accessors.ts:454

Returns

Series

Methods

ceil()

ceil(freq): Series

Defined in: src/accessors.ts:517

Parameters

Parameter	Type
freq	string

Returns

Series

---

dayName()

dayName(locale?): Series

Defined in: src/accessors.ts:495

Parameters

Parameter	Type	Default value
locale	string	'en-US'

Returns

Series

---

floor()

floor(freq): Series

Defined in: src/accessors.ts:516

Rounds down to a multiple of a fixed frequency ('h', '15min', 'D', ...).

Parameters

Parameter	Type
freq	string

Returns

Series

---

isocalendar()

isocalendar(): DataFrame

Defined in: src/accessors.ts:484

ISO calendar: DataFrame with year, week, day.

Returns

DataFrame

---

monthName()

monthName(locale?): Series

Defined in: src/accessors.ts:500

Parameters

Parameter	Type	Default value
locale	string	'en-US'

Returns

Series

---

normalize()

normalize(): Series

Defined in: src/accessors.ts:513

Truncates to midnight (wall clock).

Returns

Series

---

round()

round(freq): Series

Defined in: src/accessors.ts:518

Parameters

Parameter	Type
freq	string

Returns

Series

---

strftime()

strftime(format): Series

Defined in: src/accessors.ts:532

Formats with Python strftime directives (%Y %m %d %H %M %S %f %a %A %b %B %p %j %z %Z ...).

Parameters

Parameter	Type
format	string

Returns

Series

---

toDates()

toDates(): (Date | null)[]

Defined in: src/accessors.ts:564

Datetimes as JS Date objects (instants).

Returns

(Date | null)[]

---

toPeriod()

toPeriod(freq?): Series

Defined in: src/accessors.ts:544

Converts datetimes to periods of freq ('D', 'M', 'Q', 'Y', 'W', 'h', ...).

Parameters

Parameter	Type	Default value
freq	string	'D'

Returns

Series

---

totalSeconds()

totalSeconds(): Series

Defined in: src/accessors.ts:606

Returns

Series

---

toTimestamp()

toTimestamp(how?): Series

Defined in: src/accessors.ts:552

Periods → datetimes at the start (default) or end of each period.

Parameters

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

Returns

Series

---

tzConvert()

tzConvert(tz): Series

Defined in: src/accessors.ts:590

Views the same instants in another zone.

Parameters

Parameter	Type
tz	string | null

Returns

Series

---

tzLocalize()

tzLocalize(tz, options?): Series

Defined in: src/accessors.ts:576

Interprets naive wall times as local time in tz (or drops the zone with null, keeping wall times). DST ambiguities follow ambiguous / nonexistent.

Parameters

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

Returns

Series