Class: TimeAxis

Constructors

constructor

• new TimeAxis(model, options, localizationOptions)

Parameters

Name	Type
model	ChartModel
options	TimeAxisOptions
localizationOptions	LocalizationOptions

Defined in

model/time-axis.ts:95

Properties

_barSpacing

• Private _barSpacing: number

Defined in

model/time-axis.ts:80

---

_baseIndexOrNull

• Private _baseIndexOrNull: TimePointIndex = null

Defined in

model/time-axis.ts:76

---

_commonTransitionStartState

• Private _commonTransitionStartState: TransitionState = null

Defined in

model/time-axis.ts:91

---

_dateTimeFormatter

• Private _dateTimeFormatter: DateFormatter | DateTimeFormatter

Defined in

model/time-axis.ts:73

---

_formattedByWeight

• Private _formattedByWeight: Map<number, FormattedLabelsCache>

Defined in

model/time-axis.ts:84

---

_labels

• Private _labels: TimeMark[] = []

Defined in

model/time-axis.ts:93

---

_localizationOptions

• Private Readonly _localizationOptions: LocalizationOptions

Defined in

model/time-axis.ts:71

---

_logicalRangeChanged

• Private Readonly _logicalRangeChanged: Subscription<void, void>

Defined in

model/time-axis.ts:89

---

_model

• Private Readonly _model: ChartModel

Defined in

model/time-axis.ts:70

---

_options

• Private Readonly _options: TimeAxisOptions

Defined in

model/time-axis.ts:69

---

_points

• Private _points: readonly TimeScalePoint[] = []

Defined in

model/time-axis.ts:79

---

_rightOffset

• Private _rightOffset: number

Defined in

model/time-axis.ts:78

---

_scaleStartPoint

• Private _scaleStartPoint: Coordinate = null

Defined in

model/time-axis.ts:82

---

_scrollStartPoint

• Private _scrollStartPoint: Coordinate = null

Defined in

model/time-axis.ts:81

---

_tickMarks

• Private Readonly _tickMarks: TickMarks

Defined in

model/time-axis.ts:83

---

_timeMarksCache

• Private _timeMarksCache: TimeMark[] = null

Defined in

model/time-axis.ts:92

---

_visibleBarsChanged

• Private Readonly _visibleBarsChanged: Subscription<void, void>

Defined in

model/time-axis.ts:88

---

_visibleRange

• Private _visibleRange: TimeScaleVisibleRange

Defined in

model/time-axis.ts:86

---

_visibleRangeInvalidated

• Private _visibleRangeInvalidated: boolean = true

Defined in

model/time-axis.ts:87

---

_width

• Private _width: number = 0

Defined in

model/time-axis.ts:75

Methods

_clearCommonTransitionsStartState

▸ Private _clearCommonTransitionsStartState(): void

Returns

void

Defined in

model/time-axis.ts:687

---

_coordinateToFloatIndex

▸ Private _coordinateToFloatIndex(x): number

Parameters

Name	Type
x	Coordinate

Returns

number

Defined in

model/time-axis.ts:604

---

_correctBarSpacing

▸ Private _correctBarSpacing(): void

Returns

void

Defined in

model/time-axis.ts:626

---

_correctOffset

▸ Private _correctOffset(): void

Returns

void

Defined in

model/time-axis.ts:648

---

_doFixRightEdge

▸ Private _doFixRightEdge(): void

Returns

void

Defined in

model/time-axis.ts:737

---

_firstIndex

▸ Private _firstIndex(): TimePointIndex

Returns

TimePointIndex

Defined in

model/time-axis.ts:592

---

_formatLabel

▸ Private _formatLabel(tickMark): string

Parameters

Name	Type
tickMark	TickMark

Returns

string

Defined in

model/time-axis.ts:691

---

_formatLabelImpl

▸ Private _formatLabelImpl(tickMark): string

Parameters

Name	Type
tickMark	TickMark

Returns

string

Defined in

model/time-axis.ts:704

---

_invalidateTickMarks

▸ Private _invalidateTickMarks(): void

Returns

void

Defined in

model/time-axis.ts:573

---

_isAllScalingAndScrollingDisabled

▸ Private _isAllScalingAndScrollingDisabled(): boolean

Returns

boolean

Defined in

model/time-axis.ts:530

---

_lastIndex

▸ Private _lastIndex(): TimePointIndex

Returns

TimePointIndex

Defined in

model/time-axis.ts:596

---

_maxRightOffset

▸ Private _maxRightOffset(): number

Returns

number

Defined in

model/time-axis.ts:677

---

_minBarSpacing

▸ Private _minBarSpacing(): number

Returns

number

Defined in

model/time-axis.ts:644

---

_minRightOffset

▸ Private _minRightOffset(): number

Returns

number

Defined in

model/time-axis.ts:665

---

_resetTimeMarksCache

▸ Private _resetTimeMarksCache(): void

Returns

void

Defined in

model/time-axis.ts:570

---

_rightOffsetForCoordinate

▸ Private _rightOffsetForCoordinate(x): number

Parameters

Name	Type
x	Coordinate

Returns

number

Defined in

model/time-axis.ts:600

---

_saveCommonTransitionsStartState

▸ Private _saveCommonTransitionsStartState(): void

Returns

void

Defined in

model/time-axis.ts:680

---

_setBarSpacing

▸ Private _setBarSpacing(newBarSpacing): void

Parameters

Name	Type
newBarSpacing	number

Returns

void

Defined in

model/time-axis.ts:614

---

_setVisibleRange

▸ Private _setVisibleRange(newVisibleRange): void

Parameters

Name	Type
newVisibleRange	TimeScaleVisibleRange

Returns

void

Defined in

model/time-axis.ts:555

---

_updateDateTimeFormatter

▸ Private _updateDateTimeFormatter(): void

Returns

void

Defined in

model/time-axis.ts:577

---

_updateVisibleRange

▸ Private _updateVisibleRange(): void

Returns

void

Defined in

model/time-axis.ts:534

---

barSpacing

▸ barSpacing(): number

Returns

number

Defined in

model/time-axis.ts:255

---

baseIndex

▸ baseIndex(): TimePointIndex

Returns

TimePointIndex

Defined in

model/time-axis.ts:275

---

coordinateToIndex

▸ coordinateToIndex(x): TimePointIndex

Parameters

Name	Type
x	Coordinate

Returns

TimePointIndex

Defined in

model/time-axis.ts:240

---

endScale

▸ endScale(): void

Returns

void

Defined in

model/time-axis.ts:407

---

endScroll

▸ endScroll(): void

Returns

void

Defined in

model/time-axis.ts:442

---

fitContent

▸ fitContent(): void

Returns

void

Defined in

model/time-axis.ts:507

---

formatDateTime

▸ formatDateTime(timeScalePoint): string

Parameters

Name	Type
timeScalePoint	TimeScalePoint

Returns

string

Defined in

model/time-axis.ts:522

---

getTimePoints

▸ getTimePoints(): readonly TimeScalePoint[]

Returns

readonly TimeScalePoint[]

Defined in

model/time-axis.ts:485

---

indexToCoordinate

▸ indexToCoordinate(index): Coordinate

Parameters

Name	Type
index	TimePointIndex

Returns

Coordinate

Defined in

model/time-axis.ts:230

---

indexToTime

▸ indexToTime(index): UTCTimestamp

Parameters

Name	Type
index	TimePointIndex

Returns

UTCTimestamp

Defined in

model/time-axis.ts:130

---

indexToTimeScalePoint

▸ indexToTimeScalePoint(index): TimeScalePoint

Parameters

Name	Type
index	TimePointIndex

Returns

TimeScalePoint

Defined in

model/time-axis.ts:133

---

isEmpty

▸ isEmpty(): boolean

Returns

boolean

Defined in

model/time-axis.ts:160

---

logicalRangeChanged

▸ logicalRangeChanged(): ISubscription<void, void>

Returns

ISubscription<void, void>

Defined in

model/time-axis.ts:493

---

marks

▸ marks(): TimeMark[]

Returns

TimeMark[]

Defined in

model/time-axis.ts:286

---

options

▸ options(): Readonly<TimeAxisOptions>

Returns

Readonly<TimeAxisOptions>

Defined in

model/time-axis.ts:105

---

restoreDefault

▸ restoreDefault(): void

Returns

void

Defined in

model/time-axis.ts:268

---

rightOffset

▸ rightOffset(): number

Returns

number

Defined in

model/time-axis.ts:243

---

scaleTo

▸ scaleTo(x): void

Parameters

Name	Type
x	Coordinate

Returns

void

Defined in

model/time-axis.ts:393

---

scrollTo

▸ scrollTo(x): void

Parameters

Name	Type
x	Coordinate

Returns

void

Defined in

model/time-axis.ts:429

---

scrollToOffsetAnimated

▸ scrollToOffsetAnimated(offset, animationDuration?): void

Parameters

Name	Type	Default value
offset	number	undefined
animationDuration	number	Constants.DefaultAnimationDuration

Returns

void

Defined in

model/time-axis.ts:455

---

scrollToRealTime

▸ scrollToRealTime(): void

Returns

void

Defined in

model/time-axis.ts:451

---

setBarSpacing

▸ setBarSpacing(newBarSpacing): void

Parameters

Name	Type
newBarSpacing	number

Returns

void

Defined in

model/time-axis.ts:259

---

setBaseIndex

▸ setBaseIndex(baseIndex): void

Parameters

Name	Type
baseIndex	TimePointIndex

Returns

void

Defined in

model/time-axis.ts:278

---

setLocalizationOptions

▸ setLocalizationOptions(localizationOptions): void

Parameters

Name	Type
localizationOptions	DeepPartial<LocalizationOptions>

Returns

void

Defined in

model/time-axis.ts:123

---

setLogicalRange

▸ setLogicalRange(range): void

Parameters

Name	Type
range	LogicalRange

Returns

void

Defined in

model/time-axis.ts:517

---

setOptions

▸ setOptions(options): void

Parameters

Name	Type
options	DeepPartial<TimeAxisOptions>

Returns

void

Defined in

model/time-axis.ts:108

---

setRightOffset

▸ setRightOffset(offset): void

Parameters

Name	Type
offset	number

Returns

void

Defined in

model/time-axis.ts:246

---

setVisibleRange

▸ setVisibleRange(range): void

Parameters

Name	Type
range	RangeImpl<TimePointIndex>

Returns

void

Defined in

model/time-axis.ts:497

---

setWidth

▸ setWidth(newWidth): void

Parameters

Name	Type
newWidth	number

Returns

void

Defined in

model/time-axis.ts:201

---

startScale

▸ startScale(x): void

Parameters

Name	Type
x	Coordinate

Returns

void

Defined in

model/time-axis.ts:376

---

startScroll

▸ startScroll(x): void

Parameters

Name	Type
x	Coordinate

Returns

void

Defined in

model/time-axis.ts:416

---

timeRangeForLogicalRange

▸ timeRangeForLogicalRange(range): TimePointsRange

Parameters

Name	Type
range	LogicalRange

Returns

TimePointsRange

Defined in

model/time-axis.ts:186

---

timeToIndex

▸ timeToIndex(ts, findNearest): TimePointIndex

Parameters

Name	Type
ts	UTCTimestamp
findNearest	boolean

Returns

TimePointIndex

Defined in

model/time-axis.ts:136

---

update

▸ update(newPoints, firstChangedPointIndex): void

Parameters

Name	Type
newPoints	readonly TimeScalePoint[]
firstChangedPointIndex	number

Returns

void

Defined in

model/time-axis.ts:477

---

visibleBarsChanged

▸ visibleBarsChanged(): ISubscription<void, void>

Returns

ISubscription<void, void>

Defined in

model/time-axis.ts:489

---

visibleLogicalRange

▸ visibleLogicalRange(): RangeImpl<Logical>

Returns

RangeImpl<Logical>

Defined in

model/time-axis.ts:169

---

visibleStrictRange

▸ visibleStrictRange(): RangeImpl<TimePointIndex>

Returns

RangeImpl<TimePointIndex>

Defined in

model/time-axis.ts:164

---

visibleTimeRange

▸ visibleTimeRange(): TimePointsRange

Returns

TimePointsRange

Defined in

model/time-axis.ts:173

---

width

▸ width(): number

Returns

number

Defined in

model/time-axis.ts:198

---

zoom

▸ zoom(zoomPoint, scale): void

Parameters

Name	Type
zoomPoint	Coordinate
scale	number

Returns

void

Defined in

model/time-axis.ts:361