Interface: TimeScale<O>

Type parameters

NameTypeDefault
OTimeScaleOptionsTimeScaleOptions

Hierarchy

Properties

active

Readonly active: boolean

Inherited from: Scale.active

Defined in: element.d.ts:6TimeScale - 图1 (opens new window)


axis

axis: string

Inherited from: Scale.axis

Defined in: index.esm.d.ts:1160TimeScale - 图2 (opens new window)


bottom

bottom: number

Bottom edge of the item. Set by layout system and cannot be used in update

Inherited from: Scale.bottom

Defined in: layout.d.ts:41TimeScale - 图3 (opens new window)


chart

Readonly chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>

Inherited from: Scale.chart

Defined in: index.esm.d.ts:1150TimeScale - 图4 (opens new window)


ctx

Readonly ctx: CanvasRenderingContext2D

Inherited from: Scale.ctx

Defined in: index.esm.d.ts:1149TimeScale - 图5 (opens new window)


fullSize

fullSize: boolean

if true, and the item is horizontal, then push vertical boxes down

Inherited from: Scale.fullSize

Defined in: layout.d.ts:17TimeScale - 图6 (opens new window)


height

height: number

Height of item. Must be valid after update()

Inherited from: Scale.height

Defined in: layout.d.ts:25TimeScale - 图7 (opens new window)


id

Readonly id: string

Inherited from: Scale.id

Defined in: index.esm.d.ts:1147TimeScale - 图8 (opens new window)


labelRotation

labelRotation: number

Inherited from: Scale.labelRotation

Defined in: index.esm.d.ts:1161TimeScale - 图9 (opens new window)


left

left: number

Left edge of the item. Set by layout system and cannot be used in update

Inherited from: Scale.left

Defined in: layout.d.ts:29TimeScale - 图10 (opens new window)


max

max: number

Inherited from: Scale.max

Defined in: index.esm.d.ts:1163TimeScale - 图11 (opens new window)


maxHeight

maxHeight: number

Inherited from: Scale.maxHeight

Defined in: index.esm.d.ts:1153TimeScale - 图12 (opens new window)


maxWidth

maxWidth: number

Inherited from: Scale.maxWidth

Defined in: index.esm.d.ts:1152TimeScale - 图13 (opens new window)


min

min: number

Inherited from: Scale.min

Defined in: index.esm.d.ts:1162TimeScale - 图14 (opens new window)


options

Readonly options: O

Inherited from: Scale.options

Defined in: element.d.ts:7TimeScale - 图15 (opens new window)


paddingBottom

paddingBottom: number

Inherited from: Scale.paddingBottom

Defined in: index.esm.d.ts:1156TimeScale - 图16 (opens new window)


paddingLeft

paddingLeft: number

Inherited from: Scale.paddingLeft

Defined in: index.esm.d.ts:1157TimeScale - 图17 (opens new window)


paddingRight

paddingRight: number

Inherited from: Scale.paddingRight

Defined in: index.esm.d.ts:1158TimeScale - 图18 (opens new window)


paddingTop

paddingTop: number

Inherited from: Scale.paddingTop

Defined in: index.esm.d.ts:1155TimeScale - 图19 (opens new window)


position

position: LayoutPosition

The position of the item in the chart layout. Possible values are

Inherited from: Scale.position

Defined in: layout.d.ts:9TimeScale - 图20 (opens new window)


right

right: number

Right edge of the item. Set by layout system and cannot be used in update

Inherited from: Scale.right

Defined in: layout.d.ts:37TimeScale - 图21 (opens new window)


ticks

ticks: Tick[]

Inherited from: Scale.ticks

Defined in: index.esm.d.ts:1164TimeScale - 图22 (opens new window)


top

top: number

Top edge of the item. Set by layout system and cannot be used in update

Inherited from: Scale.top

Defined in: layout.d.ts:33TimeScale - 图23 (opens new window)


type

Readonly type: string

Inherited from: Scale.type

Defined in: index.esm.d.ts:1148TimeScale - 图24 (opens new window)


weight

weight: number

The weight used to sort the item. Higher weights are further away from the chart area

Inherited from: Scale.weight

Defined in: layout.d.ts:13TimeScale - 图25 (opens new window)


width

width: number

Width of item. Must be valid after update()

Inherited from: Scale.width

Defined in: layout.d.ts:21TimeScale - 图26 (opens new window)


x

Readonly x: number

Inherited from: Scale.x

Defined in: element.d.ts:4TimeScale - 图27 (opens new window)


y

Readonly y: number

Inherited from: Scale.y

Defined in: element.d.ts:5TimeScale - 图28 (opens new window)

Methods

afterBuildTicks

afterBuildTicks(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1244TimeScale - 图29 (opens new window)


afterCalculateLabelRotation

afterCalculateLabelRotation(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1250TimeScale - 图30 (opens new window)


afterDataLimits

afterDataLimits(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1241TimeScale - 图31 (opens new window)


afterFit

afterFit(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1253TimeScale - 图32 (opens new window)


afterSetDimensions

afterSetDimensions(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1238TimeScale - 图33 (opens new window)


afterTickToLabelConversion

afterTickToLabelConversion(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1247TimeScale - 图34 (opens new window)


afterUpdate

afterUpdate(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1235TimeScale - 图35 (opens new window)


beforeBuildTicks

beforeBuildTicks(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1242TimeScale - 图36 (opens new window)


beforeCalculateLabelRotation

beforeCalculateLabelRotation(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1248TimeScale - 图37 (opens new window)


beforeDataLimits

beforeDataLimits(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1239TimeScale - 图38 (opens new window)


beforeFit

beforeFit(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1251TimeScale - 图39 (opens new window)


beforeLayout

OptionalbeforeLayout(): void

Called before the layout process starts

Returns: void

Inherited from: Scale

Defined in: layout.d.ts:46TimeScale - 图40 (opens new window)


beforeSetDimensions

beforeSetDimensions(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1236TimeScale - 图41 (opens new window)


beforeTickToLabelConversion

beforeTickToLabelConversion(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1245TimeScale - 图42 (opens new window)


beforeUpdate

beforeUpdate(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1233TimeScale - 图43 (opens new window)


buildTicks

buildTicks(): Tick[]

Returns: Tick[]

Inherited from: Scale

Defined in: index.esm.d.ts:1243TimeScale - 图44 (opens new window)


calculateLabelRotation

calculateLabelRotation(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1249TimeScale - 图45 (opens new window)


configure

configure(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1234TimeScale - 图46 (opens new window)


determineDataLimits

determineDataLimits(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1240TimeScale - 图47 (opens new window)


draw

draw(chartArea: ChartArea): void

Draws the element

Parameters:

NameType
chartAreaChartArea

Returns: void

Inherited from: Scale

Defined in: layout.d.ts:50TimeScale - 图48 (opens new window)


drawGrid

drawGrid(chartArea: ChartArea): void

Parameters:

NameType
chartAreaChartArea

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1169TimeScale - 图49 (opens new window)


drawLabels

drawLabels(chartArea: ChartArea): void

Parameters:

NameType
chartAreaChartArea

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1168TimeScale - 图50 (opens new window)


drawTitle

drawTitle(chartArea: ChartArea): void

Parameters:

NameType
chartAreaChartArea

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1167TimeScale - 图51 (opens new window)


fit

fit(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1252TimeScale - 图52 (opens new window)


generateTickLabels

generateTickLabels(ticks: Tick[]): void

Parameters:

NameType
ticksTick[]

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1246TimeScale - 图53 (opens new window)


getBasePixel

getBasePixel(): number

Returns the pixel for the minimum chart value The coordinate (0, 0) is at the upper-left corner of the canvas

Returns: number

Inherited from: Scale

Defined in: index.esm.d.ts:1225TimeScale - 图54 (opens new window)


getBaseValue

getBaseValue(): number

Returns: number

Inherited from: Scale

Defined in: index.esm.d.ts:1219TimeScale - 图55 (opens new window)


getDataTimestamps

getDataTimestamps(): number[]

Returns: number[]

Defined in: index.esm.d.ts:3013TimeScale - 图56 (opens new window)


getDecimalForPixel

getDecimalForPixel(pixel: number): number

Parameters:

NameType
pixelnumber

Returns: number

Inherited from: Scale

Defined in: index.esm.d.ts:1175TimeScale - 图57 (opens new window)


getLabelForValue

getLabelForValue(value: number): string

Used to get the label to display in the tooltip for the given value

Parameters:

NameType
valuenumber

Returns: string

Inherited from: Scale

Defined in: index.esm.d.ts:1195TimeScale - 图58 (opens new window)


getLabelTimestamps

getLabelTimestamps(): string[]

Returns: string[]

Defined in: index.esm.d.ts:3014TimeScale - 图59 (opens new window)


getLabels

getLabels(): string[]

Returns: string[]

Inherited from: Scale

Defined in: index.esm.d.ts:1232TimeScale - 图60 (opens new window)


getLineWidthForValue

getLineWidthForValue(value: number): number

Returns the grid line width at given value

Parameters:

NameType
valuenumber

Returns: number

Inherited from: Scale

Defined in: index.esm.d.ts:1200TimeScale - 图61 (opens new window)


getMatchingVisibleMetas

getMatchingVisibleMetas(type?: string): ChartMeta<Element<{}, {}>, Element<{}, {}>>[]

Parameters:

NameType
type?string

Returns: ChartMeta<Element<{}, {}>, Element<{}, {}>>[]

Inherited from: Scale

Defined in: index.esm.d.ts:1165TimeScale - 图62 (opens new window)


getMinMax

getMinMax(canStack: boolean): object

Parameters:

NameType
canStackboolean

Returns: object

NameType
maxnumber
minnumber

Inherited from: Scale

Defined in: index.esm.d.ts:1230TimeScale - 图63 (opens new window)


getPadding

OptionalgetPadding(): ChartArea

Returns an object with padding on the edges

Returns: ChartArea

Inherited from: Scale

Defined in: layout.d.ts:54TimeScale - 图64 (opens new window)


getPixelForDecimal

getPixelForDecimal(decimal: number): number

Utility for getting the pixel location of a percentage of scale The coordinate (0, 0) is at the upper-left corner of the canvas

Parameters:

NameType
decimalnumber

Returns: number

Inherited from: Scale

Defined in: index.esm.d.ts:1182TimeScale - 图65 (opens new window)


getPixelForTick

getPixelForTick(index: number): number

Returns the location of the tick at the given index The coordinate (0, 0) is at the upper-left corner of the canvas

Parameters:

NameType
indexnumber

Returns: number

Inherited from: Scale

Defined in: index.esm.d.ts:1189TimeScale - 图66 (opens new window)


getPixelForValue

getPixelForValue(value: number, index: number): number

Returns the location of the given data point. Value can either be an index or a numerical value The coordinate (0, 0) is at the upper-left corner of the canvas

Parameters:

NameType
valuenumber
indexnumber

Returns: number

Inherited from: Scale

Defined in: index.esm.d.ts:1209TimeScale - 图67 (opens new window)


getProps

getProps<P>(props: [P], final?: boolean): Pick<{}, P>

Type parameters:

NameType
Pnever

Parameters:

NameType
props[P]
final?boolean

Returns: Pick<{}, P>

Inherited from: Scale

Defined in: element.d.ts:11TimeScale - 图68 (opens new window)

getProps<P, P2>(props: [P, P2], final?: boolean): Pick<{}, P | P2>

Type parameters:

NameType
Pnever
P2never

Parameters:

NameType
props[P, P2]
final?boolean

Returns: Pick<{}, P | P2>

Inherited from: Scale

Defined in: element.d.ts:12TimeScale - 图69 (opens new window)

getProps<P, P2, P3>(props: [P, P2, P3], final?: boolean): Pick<{}, P | P2 | P3>

Type parameters:

NameType
Pnever
P2never
P3never

Parameters:

NameType
props[P, P2, P3]
final?boolean

Returns: Pick<{}, P | P2 | P3>

Inherited from: Scale

Defined in: element.d.ts:13TimeScale - 图70 (opens new window)

getProps<P, P2, P3, P4>(props: [P, P2, P3, P4], final?: boolean): Pick<{}, P | P2 | P3 | P4>

Type parameters:

NameType
Pnever
P2never
P3never
P4never

Parameters:

NameType
props[P, P2, P3, P4]
final?boolean

Returns: Pick<{}, P | P2 | P3 | P4>

Inherited from: Scale

Defined in: element.d.ts:17TimeScale - 图71 (opens new window)

getProps<P, P2, P3, P4, P5>(props: [P, P2, P3, P4, P5], final?: boolean): Pick<{}, P | P2 | P3 | P4 | P5>

Type parameters:

NameType
Pnever
P2never
P3never
P4never
P5never

Parameters:

NameType
props[P, P2, P3, P4, P5]
final?boolean

Returns: Pick<{}, P | P2 | P3 | P4 | P5>

Inherited from: Scale

Defined in: element.d.ts:21TimeScale - 图72 (opens new window)

getProps(props: never[], final?: boolean): object

Parameters:

NameType
propsnever[]
final?boolean

Returns: object

Inherited from: Scale

Defined in: element.d.ts:25TimeScale - 图73 (opens new window)


getTicks

getTicks(): Tick[]

Returns: Tick[]

Inherited from: Scale

Defined in: index.esm.d.ts:1231TimeScale - 图74 (opens new window)


getUserBounds

getUserBounds(): object

Returns: object

NameType
maxnumber
maxDefinedboolean
minnumber
minDefinedboolean

Inherited from: Scale

Defined in: index.esm.d.ts:1229TimeScale - 图75 (opens new window)


getValueForPixel

getValueForPixel(pixel: number): number

Used to get the data value from a given pixel. This is the inverse of getPixelForValue The coordinate (0, 0) is at the upper-left corner of the canvas

Parameters:

NameType
pixelnumber

Returns: number

Inherited from: Scale

Defined in: index.esm.d.ts:1217TimeScale - 图76 (opens new window)


hasValue

hasValue(): boolean

Returns: boolean

Inherited from: Scale

Defined in: element.d.ts:10TimeScale - 图77 (opens new window)


init

init(options: O): void

Parameters:

NameType
optionsO

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1227TimeScale - 图78 (opens new window)


isFullSize

isFullSize(): boolean

Returns: boolean

Inherited from: Scale

Defined in: index.esm.d.ts:1255TimeScale - 图79 (opens new window)


isHorizontal

isHorizontal(): boolean

returns true if the layout item is horizontal (ie. top or bottom)

Returns: boolean

Inherited from: Scale

Defined in: layout.d.ts:58TimeScale - 图80 (opens new window)


normalize

normalize(values: number[]): number[]

Parameters:

NameType
valuesnumber[]

Returns: number[]

Defined in: index.esm.d.ts:3015TimeScale - 图81 (opens new window)


parse

parse(raw: unknown, index: number): unknown

Parameters:

NameType
rawunknown
indexnumber

Returns: unknown

Inherited from: Scale

Defined in: index.esm.d.ts:1228TimeScale - 图82 (opens new window)


setDimensions

setDimensions(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1237TimeScale - 图83 (opens new window)


tooltipPosition

tooltipPosition(useFinalPosition?: boolean): Point

Parameters:

NameType
useFinalPosition?boolean

Returns: Point

Inherited from: Scale

Defined in: element.d.ts:9TimeScale - 图84 (opens new window)


update

update(width: number, height: number, margins?: ChartArea): void

Takes two parameters: width and height.

Parameters:

NameType
widthnumber
heightnumber
margins?ChartArea

Returns: void

Inherited from: Scale

Defined in: layout.d.ts:64TimeScale - 图85 (opens new window)