Interface: ITimeAxisApi
Methods
coordinateToTime
▸ coordinateToTime(x): UTCTimestamp
Parameters
| Name | Type |
|---|---|
x | number |
Returns
UTCTimestamp
Defined in
api/itime-axis-api.ts:36
firstPoint
▸ firstPoint(): TimeScalePoint
Returns
TimeScalePoint
Defined in
api/itime-axis-api.ts:39
fitContent
▸ fitContent(): void
Automatically calculates the visible range to fit all data from all series.
Returns
void
Defined in
api/itime-axis-api.ts:32
getVisibleLogicalRange
▸ getVisibleLogicalRange(): LogicalRange
Returns
LogicalRange
Defined in
api/itime-axis-api.ts:21
getVisibleRange
▸ getVisibleRange(): TimeRange
Returns
Defined in
api/itime-axis-api.ts:19
height
▸ height(): number
Returns
number
Defined in
api/itime-axis-api.ts:38
lastPoint
▸ lastPoint(): TimeScalePoint
Returns
TimeScalePoint
Defined in
api/itime-axis-api.ts:40
options
▸ options(): Readonly<TimeAxisOptions>
Returns
Readonly<TimeAxisOptions>
Defined in
api/itime-axis-api.ts:12
resetTimeAxis
▸ resetTimeAxis(): void
Restores default zoom level and scroll position of the time scale.
Returns
void
Defined in
api/itime-axis-api.ts:27
scrollPosition
▸ scrollPosition(): number
Returns
number
Defined in
api/itime-axis-api.ts:16
scrollToPosition
▸ scrollToPosition(position, animated): void
Parameters
| Name | Type |
|---|---|
position | number |
animated | boolean |
Returns
void
Defined in
api/itime-axis-api.ts:17
scrollToRealTime
▸ scrollToRealTime(): void
Returns
void
Defined in
api/itime-axis-api.ts:18
setOptions
▸ setOptions(options): void
Parameters
| Name | Type |
|---|---|
options | DeepPartial<TimeAxisOptions> |
Returns
void
Defined in
api/itime-axis-api.ts:11
setTimePoints
▸ setTimePoints(points): void
Parameters
| Name | Type |
|---|---|
points | number[] |
Returns
void
Defined in
api/itime-axis-api.ts:13
setVisibleLogicalRange
▸ setVisibleLogicalRange(range): void
Parameters
| Name | Type |
|---|---|
range | Range<number> |
Returns
void
Defined in
api/itime-axis-api.ts:22
setVisibleRange
▸ setVisibleRange(range): void
Parameters
| Name | Type |
|---|---|
range | TimeRange |
Returns
void
Defined in
api/itime-axis-api.ts:20
subscribeVisibleLogicalRangeChange
▸ subscribeVisibleLogicalRangeChange(handler): void
Parameters
| Name | Type |
|---|---|
handler | LogicalRangeChangeEventHandler |
Returns
void
Defined in
api/itime-axis-api.ts:44
subscribeVisibleTimeRangeChange
▸ subscribeVisibleTimeRangeChange(handler): void
Parameters
| Name | Type |
|---|---|
handler | TimeRangeChangeEventHandler |
Returns
void
Defined in
api/itime-axis-api.ts:42
timeToCoordinate
▸ timeToCoordinate(ts): Coordinate
Parameters
| Name | Type |
|---|---|
ts | UTCTimestamp |
Returns
Defined in
api/itime-axis-api.ts:35
unsubscribeVisibleLogicalRangeChange
▸ unsubscribeVisibleLogicalRangeChange(handler): void
Parameters
| Name | Type |
|---|---|
handler | LogicalRangeChangeEventHandler |
Returns
void
Defined in
api/itime-axis-api.ts:45
unsubscribeVisibleTimeRangeChange
▸ unsubscribeVisibleTimeRangeChange(handler): void
Parameters
| Name | Type |
|---|---|
handler | TimeRangeChangeEventHandler |
Returns
void
Defined in
api/itime-axis-api.ts:43
updateTimePoints
▸ updateTimePoints(points, direction): void
Parameters
| Name | Type |
|---|---|
points | number[] |
direction | 1 | -1 |
Returns
void
Defined in
api/itime-axis-api.ts:14
width
▸ width(): number
Returns
number
Defined in
api/itime-axis-api.ts:37