pandasx / DateOffset
Class: DateOffset
Defined in: src/core/offsets.ts:35
A calendar offset. n repeats it (negative goes backwards).
Constructors
Constructor
new DateOffset(
spec):DateOffset
Defined in: src/core/offsets.ts:46
Parameters
| Parameter | Type |
|---|---|
spec | { kind: OffsetKind; n?: number; name: string; onDay?: (day) => boolean; relative?: { months: number; ms: number; years: number; }; startAnchored?: boolean; tickMs?: number; } |
spec.kind | OffsetKind |
spec.n? | number |
spec.name | string |
spec.onDay? | (day) => boolean |
spec.relative? | { months: number; ms: number; years: number; } |
spec.relative.months | number |
spec.relative.ms | number |
spec.relative.years | number |
spec.startAnchored? | boolean |
spec.tickMs? | number |
Returns
DateOffset
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
kind | readonly | OffsetKind | - | src/core/offsets.ts:38 |
n | readonly | number | - | src/core/offsets.ts:36 |
name | readonly | string | - | src/core/offsets.ts:37 |
startAnchored | readonly | boolean | Whether results are anchored to period starts (MS, QS, YS, BMS) – used for resample defaults. | src/core/offsets.ts:42 |
tickMs | readonly | number | Fixed length for tick offsets (ms). | src/core/offsets.ts:40 |
Accessors
freqstr
Get Signature
get freqstr():
string
Defined in: src/core/offsets.ts:64
Returns
string
Methods
apply()
apply(
t,n?):number
Defined in: src/core/offsets.ts:79
t moved forward (n > 0) or backward (n < 0) by |n| offsets, keeping the time of day.
Parameters
| Parameter | Type |
|---|---|
t | number |
n | number |
Returns
number
isOnOffset()
isOnOffset(
t):boolean
Defined in: src/core/offsets.ts:73
Whether t lies on the offset (always true for ticks).
Parameters
| Parameter | Type |
|---|---|
t | number |
Returns
boolean
rollback()
rollback(
t):number
Defined in: src/core/offsets.ts:106
Closest on-offset time at or before t.
Parameters
| Parameter | Type |
|---|---|
t | number |
Returns
number
rollforward()
rollforward(
t):number
Defined in: src/core/offsets.ts:101
Closest on-offset time at or after t.
Parameters
| Parameter | Type |
|---|---|
t | number |
Returns
number
times()
times(
n):DateOffset
Defined in: src/core/offsets.ts:60
Same offset repeated n times.
Parameters
| Parameter | Type |
|---|---|
n | number |
Returns
DateOffset
toString()
toString():
string
Defined in: src/core/offsets.ts:68
Returns
string