Interface: IChartApi

Methods

addDraw

▸ addDraw<T>(options, type, paneId, priceAxisId?): ISourceApi<"draw">

绘制 drawCandleIf

Type parameters

Name	Type
T	extends keyof DrawOptionsMap

Parameters

Name	Type
options	DrawPartialOptionsMap[T]
type	T
paneId	string
priceAxisId?	string

Returns

ISourceApi<"draw">

Defined in

api/ichart-api.ts:82

---

addDrawBackground

▸ addDrawBackground(options, paneId, priceAxisId?): ISourceApi<"drawBackground">

绘制背景

Parameters

Name	Type
options	DeepPartial<PriceDataSourceCommonOptions & BackgroundStyleOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<"drawBackground">

Defined in

api/ichart-api.ts:151

---

addDrawBand

▸ addDrawBand(options, paneId, priceAxisId?): ISourceApi<keyof SourceOptionsMap>

绘制带状图

Parameters

Name	Type
options	DeepPartial<PriceDataSourceCommonOptions & BandStyleOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<keyof SourceOptionsMap>

Defined in

api/ichart-api.ts:162

---

addDrawBandIf

▸ addDrawBandIf(options, paneId, priceAxisId?): ISourceApi<keyof SourceOptionsMap>

绘制条件带状图

Parameters

Name	Type
options	DeepPartial<BandIfStyleOptions & PriceDataSourceCommonOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<keyof SourceOptionsMap>

Defined in

api/ichart-api.ts:168

---

addDrawBar

▸ addDrawBar<T>(options, type, paneId, priceAxisId?): ISourceApi<"drawBar">

绘制Bar

Type parameters

Name	Type
T	extends keyof BarStyleOptionsMap = keyof BarStyleOptionsMap

Parameters

Name	Type
options	DrawBarPartialOptionsMap[T]
type	T
paneId	string
priceAxisId?	string

Returns

ISourceApi<"drawBar">

Defined in

api/ichart-api.ts:52

---

addDrawCandle

▸ addDrawCandle(options, paneId, priceAxisId?): ISourceApi<"drawCandle">

绘制Draw 函数

Parameters

Name	Type
options	DeepPartial<DrawCandleOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<"drawCandle">

Defined in

api/ichart-api.ts:64

---

addDrawCandleIf

▸ addDrawCandleIf(options, paneId, priceAxisId?): ISourceApi<"drawCandleIf">

绘制 drawCandleIf

Parameters

Name	Type
options	DeepPartial<DrawCandleIfOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<"drawCandleIf">

Defined in

api/ichart-api.ts:71

---

addDrawHistogramBetween

▸ addDrawHistogramBetween(options, paneId, priceAxisId?): ISourceApi<keyof SourceOptionsMap>

绘制drawHistogramBetween

Parameters

Name	Type
options	DeepPartial<PriceDataSourceCommonOptions & HistogramBetweenStyleOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<keyof SourceOptionsMap>

Defined in

api/ichart-api.ts:101

---

addDrawHorizontalLine

▸ addDrawHorizontalLine(options, paneId, priceAxisId?): ISourceApi<keyof SourceOptionsMap>

绘制drawHline （画水平直线） draw( 800)

Parameters

Name	Type
options	DeepPartial<PriceDataSourceCommonOptions & HorizontalLineOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<keyof SourceOptionsMap>

Defined in

api/ichart-api.ts:94

---

addDrawRectangle

▸ addDrawRectangle(options, paneId, priceAxisId?): ISourceApi<keyof SourceOptionsMap>

绘制drawRectangle 绘制矩形

Parameters

Name	Type
options	DeepPartial<RectangleStyleOptions & PriceDataSourceCommonOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<keyof SourceOptionsMap>

Defined in

api/ichart-api.ts:130

---

addDrawSegmentLine

▸ addDrawSegmentLine(options, paneId, priceAxisId?): ISourceApi<keyof SourceOptionsMap>

绘制drawSegment 绘制线段

Parameters

Name	Type
options	DeepPartial<SegmentLineStyleOptions & PriceDataSourceCommonOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<keyof SourceOptionsMap>

Defined in

api/ichart-api.ts:123

---

addDrawStickBetween

▸ addDrawStickBetween(options, paneId, priceAxisId?): ISourceApi<"drawStickBetween">

绘制drawStickBetween

Parameters

Name	Type
options	DeepPartial<PriceDataSourceCommonOptions & StickBetweenStyleOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<"drawStickBetween">

Defined in

api/ichart-api.ts:112

---

addDrawTextIf

▸ addDrawTextIf(options, paneId, priceAxisId?): ISourceApi<keyof SourceOptionsMap>

绘制文字 drawText

Parameters

Name	Type
options	DeepPartial<PriceDataSourceCommonOptions & TextIfStyleOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<keyof SourceOptionsMap>

Defined in

api/ichart-api.ts:137

---

addDrawVPVR

▸ addDrawVPVR(options, paneId, priceAxisId?): ISourceApi<keyof SourceOptionsMap>

绘制VPVR drawVPVR

Parameters

Name	Type
options	DeepPartial<PriceDataSourceCommonOptions & VPVRStyleOptions>
paneId	string
priceAxisId?	string

Returns

ISourceApi<keyof SourceOptionsMap>

Defined in

api/ichart-api.ts:144

---

addPane

▸ addPane(option): Pane

Parameters

Name	Type
option	PaneOptions

Returns

Pane

Defined in

api/ichart-api.ts:44

---

addShape

▸ addShape(options): Shape<keyof ShapeOptionsMap>

Parameters

Name	Type
options	ShapeOptions<keyof ShapeOptionsMap>

Returns

Shape<keyof ShapeOptionsMap>

Defined in

api/ichart-api.ts:173

---

getShape

▸ getShape(id, paneId): Shape<keyof ShapeOptionsMap>

Parameters

Name	Type
id	string
paneId	string

Returns

Shape<keyof ShapeOptionsMap>

Defined in

api/ichart-api.ts:175

---

loadShapes

▸ loadShapes(options): void

Parameters

Name	Type
options	ShapeOptions<keyof ShapeOptionsMap>[]

Returns

void

Defined in

api/ichart-api.ts:174

---

options

▸ options(): Readonly<ChartOptions>

Returns

Readonly<ChartOptions>

Defined in

api/ichart-api.ts:42

---

paneApi

▸ paneApi(id): IPaneApi

Parameters

Name	Type
id	string

Returns

IPaneApi

Defined in

api/ichart-api.ts:188

---

priceAxisApi

▸ priceAxisApi(paneId, priceAxisId): IPriceAxisApi

Parameters

Name	Type
paneId	string
priceAxisId	string

Returns

IPriceAxisApi

Defined in

api/ichart-api.ts:189

---

removeDataSource

▸ removeDataSource(source): void

Parameters

Name	Type
source	IDataSource

Returns

void

Defined in

api/ichart-api.ts:171

---

removePane

▸ removePane(paneId): void

Parameters

Name	Type
paneId	string

Returns

void

Defined in

api/ichart-api.ts:45

---

removeShapes

▸ removeShapes(shapes): void

Parameters

Name	Type
shapes	{ id: string ; location: string }[]

Returns

void

Defined in

api/ichart-api.ts:176

---

resize

▸ resize(width, height, forceRepaint?): void

Parameters

Name	Type
width	number
height	number
forceRepaint?	boolean

Returns

void

Defined in

api/ichart-api.ts:43

---

setOptions

▸ setOptions(options): void

Parameters

Name	Type
options	DeepPartial<ChartOptions>

Returns

void

Defined in

api/ichart-api.ts:41

---

subscribeClick

▸ subscribeClick(handler): void

Parameters

Name	Type
handler	MouseEventHandler

Returns

void

Defined in

api/ichart-api.ts:178

---

subscribeCrosshairMove

▸ subscribeCrosshairMove(handler): void

Parameters

Name	Type
handler	MouseEventHandler

Returns

void

Defined in

api/ichart-api.ts:184

---

timeAxisApi

▸ timeAxisApi(): ITimeAxisApi

Returns

ITimeAxisApi

Defined in

api/ichart-api.ts:187

---

unsubscribeClick

▸ unsubscribeClick(handler): void

Parameters

Name	Type
handler	MouseEventHandler

Returns

void

Defined in

api/ichart-api.ts:179

---

unsubscribeCrosshairMove

▸ unsubscribeCrosshairMove(handler): void

Parameters

Name	Type
handler	MouseEventHandler

Returns

void

Defined in

api/ichart-api.ts:185