telegram-charts | telegram-charts

Index

Modules

__global

Enumerations

Type aliases

Variables

Functions

Object literals

Type aliases

AnimationCallback

AnimationCallback: function

Type declaration

- (animations: AnimationState[]): void
- Parameters
  - animations: AnimationState[]
  Returns void

AnimationTarget

AnimationTarget: object

DomEventByName

DomEventByName: Record<DomEvent, string>

EasingFunction

EasingFunction: function

Type declaration

- (x: number): number
- Parameters
  - x: number
  Returns number

FormatLabel

FormatLabel: function

Type declaration

- (v: number, state: ChartState): string
- Parameters
  - v: number
  - state: ChartState
  Returns string

FormatNumber

FormatNumber: function

Type declaration

- (x: number): string
- Parameters
  - x: number
  Returns string

PointTuple

PointTuple: [number, number]

Variables

Const ACTIVE_CLASS

ACTIVE_CLASS: "active" = "active"

Const BOX_BORDER

BOX_BORDER: 2 = 2

Const DEFAULT_FONT_FAMILY

DEFAULT_FONT_FAMILY: "Lucida Console" = "Lucida Console"

Const DESIRED_LABELS_COUNT

DESIRED_LABELS_COUNT: 6 = 6

Const FPS_INTERVAL

FPS_INTERVAL: number = 1000 / 60

Const LINE_GAP

LINE_GAP: 10 = 10

Const LOCALES

LOCALES: string[] = ['en-GB', 'en-US', 'ru-RU']

Const LONG_PRESS_DURATION

LONG_PRESS_DURATION: 1000 = 1000

Const MOUSE_MOVE_THROTTLE

MOUSE_MOVE_THROTTLE: number = 1000 / 100

Let _canvas

_canvas: HTMLCanvasElement | undefined

Const chartAnimator

chartAnimator: ChartAnimator = new ChartAnimator()

Const dateDayMonthFormatter

dateDayMonthFormatter: DateTimeFormat = new Intl.DateTimeFormat(LOCALES, {day: 'numeric',month: 'short',})

Const dateFullFormatter

dateFullFormatter: DateTimeFormat = new Intl.DateTimeFormat(LOCALES, {day: '2-digit',month: 'short',year: 'numeric',weekday: 'short',})

Const halfBar

halfBar: 0.5 = 0.5

Let handleColor

handleColor: string = ""

Const numberLocalFormatter

numberLocalFormatter: NumberFormat = new Intl.NumberFormat(['ru-RU'], { useGrouping: true })

Const svg

svg: SVGSVGElement = document.createElementNS('http://www.w3.org/2000/svg', 'svg')

Functions

applyFillStyle

applyFillStyle(ctx: CanvasRenderingContext2D, style: FillStyle, skipOpacity?: boolean): void

- Defined in utils/CanvasUtils.ts:53
Parameters
- ctx: CanvasRenderingContext2D
- style: FillStyle
- Default value skipOpacity: boolean = false
Returns void

applyFontStyle

applyFontStyle(ctx: CanvasRenderingContext2D, style: FontStyle, skipOpacity?: boolean): void

- Defined in utils/CanvasUtils.ts:60
Parameters
- ctx: CanvasRenderingContext2D
- style: FontStyle
- Default value skipOpacity: boolean = false
Returns void

applyLineStyle

applyLineStyle(ctx: CanvasRenderingContext2D, style: LineStyle, skipOpacity?: boolean): void

- Defined in utils/CanvasUtils.ts:42
Parameters
- ctx: CanvasRenderingContext2D
- style: LineStyle
- Default value skipOpacity: boolean = false
Returns void

assignDeeply

assignDeeply<T>(to: T, from: DeepPartial<T>): T

- Defined in utils/Utils.ts:3
Type parameters
- T
Parameters
- to: T
- from: DeepPartial<T>
Returns T

buildMasterConfig

buildMasterConfig(config: ChartConfig): ChartConfig

- Defined in utils/MasterChartUtils.ts:38
Parameters
- config: ChartConfig
Returns ChartConfig

calcDataPerTick

calcDataPerTick(config: TickOptions, pixelSize: number, dataSize: number, direction: AxeDirection): number

- Defined in grid/TickUtils.ts:7
Parameters
- config: TickOptions
- pixelSize: number
- dataSize: number
- direction: AxeDirection
Returns number

canvasToData

canvasToData(__namedParameters: [number, number], state: ChartState): PointTuple

- Defined in utils/ProjectionUtils.ts:31
Parameters
- __namedParameters: [number, number]
- state: ChartState
Returns PointTuple

ceilToPrecision

ceilToPrecision(x: number, precision: number): number

- Defined in utils/Utils.ts:26
Parameters
- x: number
- precision: number
Returns number

clearBounds

clearBounds(ctx: CanvasRenderingContext2D, bounds: BoundingBox, border?: number, clearColor?: undefined | string): void

- Defined in utils/CanvasUtils.ts:14
Parameters
- ctx: CanvasRenderingContext2D
- bounds: BoundingBox
- Default value border: number = 0
- Optional clearColor: undefined | string
Returns void

clipArea

clipArea(ctx: CanvasRenderingContext2D, bounds: BoundingBox): void

- Defined in utils/CanvasUtils.ts:8
Parameters
- ctx: CanvasRenderingContext2D
- bounds: BoundingBox
Returns void

createCanvasOffscreen

createCanvasOffscreen(dimensions: Dimensions): HTMLCanvasElement

- Defined in utils/CanvasUtils.ts:110
Parameters
- dimensions: Dimensions
Returns HTMLCanvasElement

createDataSet

createDataSet(config: DataSetConfig, attributes: DataSetAttributes): DataSet

- Defined in dataset/dataSetFactory.ts:10
Parameters
- config: DataSetConfig
- attributes: DataSetAttributes
Returns DataSet

createElementFromString

createElementFromString<T>(html: string): T

- Defined in utils/DomUtils.ts:51
Type parameters
- T: HTMLElement
Parameters
- html: string
Returns T

createPathBuilder

createPathBuilder(type: DataSetType): BasePathBuilder

- Defined in path/pathBuilderFactory.ts:7
Parameters
- type: DataSetType
Returns BasePathBuilder

createSVGMatrix

createSVGMatrix(): DOMMatrix

- Defined in utils/CanvasUtils.ts:78
Returns DOMMatrix

debounce

debounce(cb: function, wait: number): function

- Defined in utils/Utils.ts:44
Parameters
- cb: function
  - - (): void
    - Returns void
- wait: number
Returns function
- - (): void
  - Returns void

drawBoxShape

drawBoxShape(path: CanvasRenderingContext2D | Path2D, bb: BoundingBox, cornerRadius: number | [number, number, number, number]): void

- Defined in utils/CanvasUtils.ts:82
Parameters
- path: CanvasRenderingContext2D | Path2D
- bb: BoundingBox
- cornerRadius: number | [number, number, number, number]
Returns void

drawHandle

drawHandle(ctx: CanvasRenderingContext2D, x: number, handleHeight: number, options: HandleOptions, isLeft: boolean): void

- Defined in curtain/CurtainUtils.ts:29
Parameters
- ctx: CanvasRenderingContext2D
- x: number
- handleHeight: number
- options: HandleOptions
- isLeft: boolean
Returns void

drawHandlesOffscreen

drawHandlesOffscreen(canvas: HTMLCanvasElement, options: HandleOptions, handleHeight: number): void

- Defined in curtain/CurtainUtils.ts:49
Parameters
- canvas: HTMLCanvasElement
- options: HandleOptions
- handleHeight: number
Returns void

drawLabels

drawLabels(state: ChartState, ctx: CanvasRenderingContext2D, v: number, p1: PointTuple, p2: PointTuple, index: number, ticks: TickOptions): void

- Defined in grid/GridLinesAndLabels.ts:44
Parameters
- state: ChartState
- ctx: CanvasRenderingContext2D
- v: number
- p1: PointTuple
- p2: PointTuple
- index: number
- ticks: TickOptions
Returns void

drawLabelsYScaled

drawLabelsYScaled(state: ChartState, ctx: CanvasRenderingContext2D, v: number, p1: PointTuple, p2: PointTuple, index: number, ticks: TickOptions, chart: Chart): void

- Defined in grid/GridLinesAndLabels.ts:71
Parameters
- state: ChartState
- ctx: CanvasRenderingContext2D
- v: number
- p1: PointTuple
- p2: PointTuple
- index: number
- ticks: TickOptions
- chart: Chart
Returns void

drawXLabels

drawXLabels(state: ChartState, ctx: CanvasRenderingContext2D, v: number, p1: PointTuple, p2: PointTuple, index: number, ticks: TickOptions): void

- Defined in grid/GridLinesAndLabels.ts:55
Parameters
- state: ChartState
- ctx: CanvasRenderingContext2D
- v: number
- p1: PointTuple
- p2: PointTuple
- index: number
- ticks: TickOptions
Returns void

floorToPrecision

floorToPrecision(x: number, precision: number): number

- Defined in utils/Utils.ts:22
Parameters
- x: number
- precision: number
Returns number

formatScientific

formatScientific(y: number): string

- Defined in grid/Formatters.ts:42
Parameters
- y: number
Returns string

getDeltaPerTick

getDeltaPerTick(dataSize: number): number

- Defined in grid/TickUtils.ts:22
Parameters
- dataSize: number
Returns number

getFontString

getFontString(fontStyle: FontStyle): string | undefined

- Defined in utils/ConfigUtils.ts:3
Parameters
- fontStyle: FontStyle
Returns string | undefined

getRestrictedMovementForBounds

getRestrictedMovementForBounds(bounds: HorizontalBounds, movementX: number, restriction: HorizontalBounds): number

- Defined in curtain/CurtainUtils.ts:6
Parameters
- bounds: HorizontalBounds
- movementX: number
- restriction: HorizontalBounds
Returns number

getTheme

getTheme(name: ThemeName): DeepPartial<ChartTheme>

- Defined in theme/ChartTheme.ts:115
Parameters
- name: ThemeName
Returns DeepPartial<ChartTheme>

mouseEventToChartCanvas

mouseEventToChartCanvas(event: NormalizedEvent, state: ChartState): PointTuple

- Defined in utils/ProjectionUtils.ts:8
Parameters
- event: NormalizedEvent
- state: ChartState
Returns PointTuple

mouseEventToData

mouseEventToData(event: NormalizedEvent, state: ChartState): PointTuple

- Defined in utils/ProjectionUtils.ts:43
Parameters
- event: NormalizedEvent
- state: ChartState
Returns PointTuple

Const noop

noop(): void

- Defined in utils/Utils.ts:42
Returns void

normalizeEvent

normalizeEvent(event: Event, rect: ClientRect): NormalizedEvent

- Defined in utils/DomUtils.ts:57
Parameters
- event: Event
- rect: ClientRect
Returns NormalizedEvent

round

round(x: number): number

- Defined in utils/Utils.ts:38
Parameters
- x: number
Returns number

setCanvasSize

setCanvasSize(container: HTMLCanvasElement, size: Dimensions): number

- Defined in utils/CanvasUtils.ts:31
Parameters
- container: HTMLCanvasElement
- size: Dimensions
Returns number

subscribeToTouchEvents

subscribeToTouchEvents(domInteraction: DomInteraction, downTarget: HTMLElement): void

- Defined in utils/DomUtils.ts:37
Parameters
- domInteraction: DomInteraction
- downTarget: HTMLElement
Returns void

throttle

throttle<T>(cb: function, wait: number): function

- Defined in utils/Utils.ts:52
Type parameters
- T
Parameters
- cb: function
  - - (...args: T[]): void
    - Parameters
      - Rest ...args: T[]
      Returns void
- wait: number
Returns function
- - (...args: T[]): void
  - Parameters
    - Rest ...args: T[]
    Returns void

without

without<T>(arr1: T[], arr2: T[]): T[]

- Defined in utils/Utils.ts:30
Type parameters
- T
Parameters
- arr1: T[]
- arr2: T[]
Returns T[]

xCanvasToData

xCanvasToData(x: number, state: ChartState): number

- Defined in utils/ProjectionUtils.ts:23
Parameters
- x: number
- state: ChartState
Returns number

xDataToCanvas

xDataToCanvas(x: number, state: object): number

- Defined in utils/ProjectionUtils.ts:15
Parameters
- x: number
- state: object
  - dataBounds: Bounds
  - scaleX: number
Returns number

xVirtualToReal

xVirtualToReal(x: number, initialBounds: object): number

- Defined in utils/ProjectionUtils.ts:39
Parameters
- x: number
- initialBounds: object
  - deltaX: number
  - xFrom: number
Returns number

yCanvasToData

yCanvasToData(y: number, state: ChartState): number

- Defined in utils/ProjectionUtils.ts:27
Parameters
- y: number
- state: ChartState
Returns number

yDataToCanvas

yDataToCanvas(y: number, state: object): number

- Defined in utils/ProjectionUtils.ts:19
Parameters
- y: number
- state: object
  - dataBounds: Bounds
  - scaleY: number
Returns number

Object literals

Const DEFAULTS

DEFAULTS: object

color

color: string = "blue"

lineWidth

lineWidth: number = 1

opacity

opacity: number = 1

Const defaultConfig

defaultConfig: object

options

options: object

legend

legend: object

container

container: undefined = undefined

padding

padding: object

bottom

bottom: number = 0

top

top: number = 0

tooltip

tooltip: object

enabled

enabled: false = false

xAxis

xAxis: object

gridLines

gridLines: object

display

display: false = false

ticks

ticks: object

display

display: false = false

yAxis

yAxis: object

gridLines

gridLines: object

display

display: false = false

ticks

ticks: object

display

display: false = false

Const easingFunctions

easingFunctions: object

cubicIn

cubicIn(x: number): number

- Defined in animation/easingFunctions.ts:16
Parameters
- x: number
Returns number

cubicOut

cubicOut(x: number): number

- Defined in animation/easingFunctions.ts:17
Parameters
- x: number
Returns number

linear

linear(x: number): number

- Defined in animation/easingFunctions.ts:13
Parameters
- x: number
Returns number

quadraticIn

quadraticIn(x: number): number

- Defined in animation/easingFunctions.ts:14
Parameters
- x: number
Returns number

quadraticOut

quadraticOut(x: number): number

- Defined in animation/easingFunctions.ts:15
Parameters
- x: number
Returns number

Const formatByName

formatByName: object

dateDayMonth

dateDayMonth(y: number): string

- Defined in grid/Formatters.ts:29
Parameters
- y: number
Returns string

dateFull

dateFull(y: number): string

- Defined in grid/Formatters.ts:30
Parameters
- y: number
Returns string

numberLocal

numberLocal(y: number): string

- Defined in grid/Formatters.ts:32
Parameters
- y: number
Returns string

numberScientific

numberScientific(y: number): string

- Defined in grid/Formatters.ts:31
Parameters
- y: number
Returns string

Const labelByPowOf10

labelByPowOf10: object

12

12: string = "T"

3

3: string = "K"

6

6: string = "M"

9

9: string = "G"

Const mouseEventByName

mouseEventByName: object

__computed

__computed: string = "mouseleave"

Const themeByName

themeByName: object

day

day: object

backgroundColor

backgroundColor: string = "white"

masterChart

masterChart: object

curtain

curtain: object

coveredArea

coveredArea: object

color

color: string = "#E2EEF9"

opacity

opacity: number = 0.6

handle

handle: object

color

color: string = "#C0D1E1"

tooltip

tooltip: object

boxColor

boxColor: string = "white"

dataSetNameStyle

dataSetNameStyle: object

fontColor

fontColor: string = "black"

headerStyle

headerStyle: object

fontColor

fontColor: string = "black"

xAxis

xAxis: object

gridLines

gridLines: object

color

color: string = "#182D3B"

opacity

opacity: number = 0.1

ticks

ticks: object

fontColor

fontColor: string = "#8E8E93"

yAxis

yAxis: object

gridLines

gridLines: object

color

color: string = "#182D3B"

opacity

opacity: number = 0.1

ticks

ticks: object

fontColor

fontColor: string = "#8E8E93"

night

night: object

backgroundColor

backgroundColor: string = "#242F3E"

masterChart

masterChart: object

curtain

curtain: object

coveredArea

coveredArea: object

color

color: string = "#304259"

opacity

opacity: number = 0.6

handle

handle: object

color

color: string = "#56626D"

tooltip

tooltip: object

boxColor

boxColor: string = "#253241"

dataSetNameStyle

dataSetNameStyle: object

fontColor

fontColor: string = "white"

headerStyle

headerStyle: object

fontColor

fontColor: string = "white"

xAxis

xAxis: object

gridLines

gridLines: object

color

color: string = "#FFFFFF"

opacity

opacity: number = 0.1

ticks

ticks: object

fontColor

fontColor: string = "#A3B1C2"

opacity

opacity: number = 0.6

yAxis

yAxis: object

gridLines

gridLines: object

color

color: string = "#FFFFFF"

opacity

opacity: number = 0.1

ticks

ticks: object

fontColor

fontColor: string = "#A3B1C2"

opacity

opacity: number = 0.6

Const touchEventByName

touchEventByName: object

__computed

__computed: string = "touchend"

Generated using TypeDoc

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AnimationCallback

Type declaration

Parameters

animations: AnimationState[]

Returns void

AnimationTarget

BoundingBox

DataSet

DataSetConfig

DomEventByName

EasingFunction

Type declaration

Parameters

x: number

Returns number

FormatLabel

Type declaration

Parameters

v: number

state: ChartState

Returns string

FormatNumber

Type declaration

Parameters

x: number

Returns string

PointTuple

Variables

Const ACTIVE_CLASS

Const BOX_BORDER

Const DEFAULT_FONT_FAMILY

Const DESIRED_LABELS_COUNT

Const FPS_INTERVAL

Const LINE_GAP

Const LOCALES

Const LONG_PRESS_DURATION

Const MOUSE_MOVE_THROTTLE

Let _canvas

Const chartAnimator

Const dateDayMonthFormatter

Const dateFullFormatter

Const halfBar

Let handleColor

Const numberLocalFormatter

Const svg

Functions

applyFillStyle

Parameters

ctx: CanvasRenderingContext2D

style: FillStyle

Default value skipOpacity: boolean = false

Returns void

applyFontStyle

Parameters

ctx: CanvasRenderingContext2D

style: FontStyle

Default value skipOpacity: boolean = false

Returns void

applyLineStyle

Parameters

ctx: CanvasRenderingContext2D

style: LineStyle

Default value skipOpacity: boolean = false

Returns void

assignDeeply

Type parameters

T

Parameters

to: T

from: DeepPartial<T>