pandasx / Period
Class: Period
Defined in: src/core/time.ts:158
A span of time such as the month 2024-03, like pandas.Period.
Constructors
Constructor
new Period(
value,freq?):Period
Defined in: src/core/time.ts:162
Parameters
| Parameter | Type | Default value |
|---|---|---|
value | string | number | Date | undefined |
freq | string | 'D' |
Returns
Period
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
freq | readonly | PeriodFreq | src/core/time.ts:160 |
ordinal | readonly | number | src/core/time.ts:159 |
Accessors
endTime
Get Signature
get endTime():
Date
Defined in: src/core/time.ts:171
Last millisecond of the period.
Returns
Date
startTime
Get Signature
get startTime():
Date
Defined in: src/core/time.ts:169
Returns
Date
Methods
add()
add(
n):Period
Defined in: src/core/time.ts:173
Parameters
| Parameter | Type |
|---|---|
n | number |
Returns
Period
toJSON()
toJSON():
string
Defined in: src/core/time.ts:194
Returns
string
toString()
toString():
string
Defined in: src/core/time.ts:177
Returns
string
valueOf()
valueOf():
number
Defined in: src/core/time.ts:175
Returns
number