跳到主要内容

API参考

Table of Contents​

Chart​

通过绑定已存在的canvas元素生成K线图表的一个类库

Parameters​

isAvailable​

用于判读K线实例是否存在，通常用在异步调用K线方法的情况

Type: any

getOptions​

返回当前K线的配置信息

Returns any

mountMainAreaBox​

加载 主图里可放置自定义元素的区域

Examples​

见下述 Chart.prototype.getMainAreaBox();

unmountMainAreaBox​

卸载主图里的可放置自定义元素区域

Examples​

见下述 Chart.prototype.getMainAreaBox();

getMainAreaBox​

Description placeholder

Examples​

const chart = new Chart('#container');
chart.mountMainAreaBox();
ReactDOM.render(<Component />, chart.getMainAreaBox());

Returns HTMLDivElement

pushData​

实时trades数据

Parameters​

  • data any

Examples​

const [TX_PRICE, TX_AMOUNT, TX_TICK] = [0, 1, 2];
chart.pushData([
  {
   [TX_PRICE]: parseFloat(price), // 成交价格
   [TX_AMOUNT]: parseFloat(amount), // 成交量
   [TX_TICK]: parseInt(timestamp, 10), // timestamp
  }
])

updateExternalIndicSrcData​

Description placeholder

Parameters​

  • srcDataMap any

onLargeOrderDataWarn​

Description placeholder

onIndicatorWinningPercentageInfoBtnClick​

Description placeholder

Parameters​

onIndicatorSignalInfoBtnClick​

Description placeholder

Parameters​

updateGreatEventHideRangeIDs​

Description placeholder

Parameters​

Returns boolean

setGreatEventNewMessageFlag​

Description placeholder

Parameters​

Returns boolean

onIndicatorInfoTitleHover​

Description placeholder

Parameters​

onTradeRecordHover​

Description placeholder

Parameters​

onPositionCostLineFinishDrag​

Description placeholder

Parameters​

handlePositionCostLineClick​

Description placeholder

Parameters​

handlePositionCostLineFinishDrag​

Description placeholder

Parameters​

handlePositionCostLineDrag​

Description placeholder

Parameters​

onOrderLineFinishDrag​

Description placeholder

Parameters​

handleOrderLineClick​

Description placeholder

Parameters​

handleOrderLineFinishDrag​

Description placeholder

Parameters​

onAlertLineHover​

Description placeholder

Parameters​

onAlertLineClick​

Description placeholder

Parameters​

onAlertLineFinishDrag​

Description placeholder

Parameters​

handleAlertLineClick​

Description placeholder

Parameters​

handleAlertLineFinishDrag​

Description placeholder

Parameters​

onIndicatorsInfoButtonClick​

Description placeholder

Parameters​

onIndicatorsInfoButtonHover​

Description placeholder

Parameters​

addSubIndicator​

Description placeholder

Parameters​

removeSubIndicator​

Description placeholder

Parameters​

replaceSubIndicator​

Description placeholder

Parameters​

getSymbol​

Description placeholder

Returns string

getIndicatorsData​

Description placeholder

Parameters​

Returns any

setPeriodHistoryFrom​

Description placeholder

Parameters​

Returns void

goToStick​

Description placeholder

Parameters​

Returns any

highlightStick​

Description placeholder

Parameters​

getHighlightStick​

Description placeholder

Returns any

export​

Description placeholder

Parameters​

Returns any

setPositionCostLineOptions​

Description placeholder

Parameters​

  • options any

setOrderLineOptions​

Description placeholder

Parameters​

  • options any

setAlertLineOptions​

Description placeholder

Parameters​

  • options any

setDepthGraph​

Description placeholder

Parameters​

clearDepth​

Description placeholder

Parameters​

setDepthGroup​

Description placeholder

Parameters​

  • group any
  • renew boolean (optional, default true)

updateDepth​

Description placeholder

Parameters​

  • depth any
  • group any

setShouldShowOrderMarker​

Description placeholder

Parameters​

setShowOrderMarkerTooltip​

Description placeholder

Parameters​

setShowMainOrderMarkerTooltip​

Description placeholder

Parameters​

setOrderGraphLengths​

Description placeholder

Parameters​

getOrderGraphLengths​

Description placeholder

Returns any

setOrderLineLengths​

Description placeholder

Parameters​

getOrderLineLengths​

Description placeholder

Returns any

setLoadExternal​

Description placeholder

Parameters​

Returns boolean

toggleMainIndicators​

Description placeholder

toggleMainAreas​

Description placeholder

Returns any

onAreasFullscreen​

Description placeholder

Parameters​

setResolveExternalIndexInfo​

Description placeholder

Parameters​

Returns boolean

setLatestTradeTimestamp​

Description placeholder

Parameters​

Returns any

setAdjustOptions​

Description placeholder

Parameters​

  • options any

setDataTransformer​

Description placeholder

Parameters​

setDisableIndicators​

Description placeholder

Parameters​

  • obj any

destroy​

Description placeholder

resize​

Description placeholder

selectAtDateValue​

Description placeholder

Parameters​

Returns any

getFocusedObject​

Description placeholder

Returns any

bindMediator​

Description placeholder

Parameters​

  • mediator any

unbindMediator​

Description placeholder

sendMessage​

Description placeholder

Parameters​

  • message any

onMessage​

Description placeholder

Parameters​

  • message any

setStyles​

Description placeholder

Parameters​

resetStyles​

Description placeholder

Parameters​

getStyles​

Description placeholder

Returns any

enableContextMenu​

Description placeholder

onHiddenKeysChanged​

Description placeholder

Parameters​

setHiddenKeys​

Description placeholder

Parameters​

updateHiddenKeys​

Description placeholder

Parameters​

toggleHiddenKey​

Description placeholder

Parameters​

getHiddenKeys​

Description placeholder

Returns any

getIndicatorAreasInfo​

Description placeholder

Returns any

setIndicatorsCanAlert​

Description placeholder

Parameters​

getIndicatorsCanAlert​

Description placeholder

Returns any

setDisableWheelScale​

Description placeholder

Parameters​

getDisableWheelScale​

Description placeholder

Returns boolean

setShareDate​

Description placeholder

updateShareDateData​

Description placeholder

Parameters​

getShareDate​

Description placeholder

Returns any

getCurrentIndicExternalSource​

Description placeholder

Parameters​

  • returnType ("set" | "array" | "object")

Returns any

getAggDepthData​

Description placeholder

Returns any

getDrawingOnCurrentPeriodOnly​

Description placeholder

Returns any

setDrawingOnCurrentPeriodOnly​

Description placeholder

Parameters​

beginReplay​

Description placeholder

Parameters​

  • options any

getReplay​

Description placeholder

endReplay​

Description placeholder

selectReplayBeginDate​

Description placeholder

Returns any

handleReplaySelectDate​

Description placeholder

Parameters​

getReplayTradeData​

Description placeholder

Returns any

updateReplayTradeData​

Description placeholder

Parameters​

  • data any
  • action string (optional, default 'replace')
  • redraw boolean (optional, default true)

handleReplayTradeHover​

Description placeholder

Parameters​

handleReplayTradeDown​

Description placeholder

Parameters​

setPositionCostLineNoOverlap​

Description placeholder

Returns boolean

setOrderLineNoOverlap​

Description placeholder

Returns boolean

highlightCrosshairOnce​

Description placeholder

Parameters​

createScriptIndicator​

Description placeholder

Parameters​

  • scriptIndicator any

Returns any

readScriptIndicator​

Description placeholder

Parameters​

Returns any

updateScriptIndicator​

Description placeholder

Parameters​

  • scriptIndicator any

deleteScriptIndicator​

Description placeholder

Parameters​

Returns any

setScriptIndicators​

Description placeholder

Parameters​

  • scriptIndicators any

tempRefreshSubIndiator​

Description placeholder

setIndicAuthorize​

Description placeholder

Parameters​

Returns any

setPriceFormatter​

Description placeholder

Parameters​

setWatermark​

Description placeholder

Parameters​

  • watermark any

draw​

图表重绘

Parameters​

  • immediately 是否立即重绘 (optional, default false)

Examples​

chart.draw();

updateData​

Parameters​

  • data Array<number> [timestamp, O, H, L, C, VOL]
  • type ("init" | "unshift" | "push") init: 初始化， unshift: 队首插入，push：队尾插入 (optional, default 'init')
  • redraw boolean (optional, default true)

updateIndicatorData​

更新指定的外部指标数据

Parameters​

  • type number 指标类型：import { PERIOD_POSITION } from 'xxx'
  • data array
  • refresh boolean 是否重刷数组 (optional, default false)
  • redraw boolean 是否重绘 (optional, default true)

Examples​

chart.updateIndicatorData(PERIOD_POSITION, [[1364774400000, 1234567], ...]);

updateVPVRData​

更新VPVR数据

Parameters​

Examples​

chart.updateVPVRData([]);

getVPVRData​

获取VPVR数据

getLargeOrderData​

获取当前渲染的大单数据

Returns any dataList

updateLargeOrderData​

更新大额委单跟踪数据

Parameters​

  • data any
  • action string action可以为'update','replace', 'unshift' (optional, default 'replace')
  • redraw boolean 重绘 (optional, default true)

onLargeOrderHover​

大额委单hover

Parameters​

  • cb function 回调函数，回传参数：大额委单的数据和位置

Examples​

chart.onLargeOrderHover((data) => console.log(data)); // {
   data, // 数据
   pos., // 位置
};

highlightLargeOrderById​

高亮指定大单

Parameters​

Returns any

updateAggTradeData​

更新聚合成交数据

Parameters​

  • data any
  • action string action可以为'replace', 'unshift', 'append' (optional, default 'replace')
  • redraw boolean 重绘 (optional, default true)

onAggTradeHover​

聚合成交hover

Parameters​

  • cb function 回调函数，回传参数：聚合成交的数据

Examples​

chart.onAggTradeHover((data) => console.log(data)); // {
   data, // 数据
};

getAggTradeData​

获取聚合成交的数据

Returns any

updateLIBSData​

更新LIBS数据

Parameters​

  • data any
  • action string action可以为'replace', 'unshift', 'append' (optional, default 'replace')
  • redraw boolean 重绘 (optional, default true)

onLIBSHover​

LIBS hover

Parameters​

  • cb function 回调函数，回传参数：LIBS 的数据

Examples​

chart.onLIBSHover((data) => console.log(data)); // {
   data, // 数据
};

updateRIBSData​

更新RIBS数据

Parameters​

  • data any
  • action string action可以为'replace', 'unshift', 'append' (optional, default 'replace')
  • redraw boolean 重绘 (optional, default true)

onRIBSHover​

RIBS hover

Parameters​

  • cb function 回调函数，回传参数：RIBS 的数据

Examples​

chart.onRIBSHover((data) => console.log(data)); // {
   data, // 数据
};

setShowIndicatorWinningPercentage​

显示指标胜率

Parameters​

Examples​

chart.setShowIndicatorWinningPercentage(true);

updateIndicatorWinningPercentageData​

更新指标胜率数据

Parameters​

  • data any
  • action string action可以为'replace', 'unshift', 'append' (optional, default 'replace')
  • redraw boolean 重绘 (optional, default true)

onIndicatorWinningPercentageHover​

指标胜率 hover

Parameters​

  • cb function 回调函数，回传参数：指标胜率 的数据

Examples​

chart.onIndicatorWinningPercentageHover((data) => console.log(data)); // {
   data, // 数据
};

onIndicatorWinningPercentageDown​

指标胜率 clicked

Parameters​

  • cb function 回调函数，回传参数：指标胜率 的数据

Examples​

chart.onIndicatorWinningPercentageDown((data) => console.log(data)); // {
   data, // 数据
};

setShowIndicatorSignal​

显示指标胜率

Parameters​

Examples​

chart.setShowIndicatorSignal(true);

updateIndicatorSignalData​

更新指标胜率数据

Parameters​

  • data any
  • action string action可以为'replace', 'unshift', 'append' (optional, default 'replace')
  • redraw boolean 重绘 (optional, default true)

getIndicatorSignalData​

获取指标胜率数据

onIndicatorSignalHover​

指标胜率 hover

Parameters​

  • cb function 回调函数，回传参数：指标胜率 的数据

Examples​

chart.onIndicatorSignalHover((data) => console.log(data)); // {
   data, // 数据
};

onIndicatorSignalDown​

指标胜率 clicked

Parameters​

  • cb function 回调函数，回传参数：指标胜率 的数据

Examples​

chart.onIndicatorSignalDown((data) => console.log(data)); // {
   data, // 数据
};

setShowGreatEvent​

显示大事件

Parameters​

Examples​

chart.setShowGreatEvent(0b001);

updateGreatEventData​

更新大事件数据

Parameters​

  • data any
  • action string action可以为'append', 'update', 'replace' (optional, default 'replace')
  • redraw boolean 重绘 (optional, default true)

onGreatEventHover​

大事件 hover

Parameters​

  • cb function 回调函数，回传参数大事件 的数据

Examples​

chart.onGreatEventHover((data) => console.log(data)); // {
   data, // 数据
};

onGreatEventDown​

大事件 clicked

Parameters​

  • cb function 回调函数，回传参数：大事件 的数据

Examples​

chart.onGreatEventDown((data) => console.log(data)); // {
   data, // 数据
};

onGreatEventNewMessageBtnDown​

大事件新消息 clicked

Parameters​

Examples​

chart.onGreatEventNewMessageBtnDown(() => console.log('clicked'));

moveTimeline​

移动视图

Parameters​

  • direction string 方向：right 或者 left
  • candlesNum number 每次移动的蜡烛数量 (optional, default 1)

Examples​

chart.moveTimeline('right', 2);

Returns boolean

resetChart​

重置柱子大小和最新柱子和Y轴位置

Examples​

chart.resetChart();

Returns boolean

moveTimelineToLatest​

重置最新柱子

Examples​

chart.moveTimelineToLatest();

Returns boolean

scaleTimeline​

缩放视图

Parameters​

  • direction (string | number) 放大： up，缩小： down , 数字：[0, 36];

Examples​

chart.scaleTimeline('up');

setPeriod​

Parameters​

Returns any

onDistinctiveIndicatorsChanged​

特色指标变更监听

Parameters​

  • cb function 回调函数，回传参数：特色指标，array

Examples​

chart.onDistinctiveIndicatorsChanged((indicators, prevIndicators) => console.log(indicartors)); // ['AI-LargeOrder'], [];

onMainIndicatorsChanged​

主指标变更监听

Parameters​

  • cb function 回调函数，回传参数：主指标，array

Examples​

chart.onMainIndicatorsChanged((indicators, prevIndicators) => console.log(indicartors, prevIndicators)); // ['ma'],['ma, ema'];

onSubIndicatorsChanged​

副指标变更监听

Parameters​

  • cb function 回调函数，回传参数：副指标，array

Examples​

chart.onSubIndicatorsChanged((indicators, prevIndicators) => console.log(indicartors, prevIndicators)); // ['smi'], ['volume, smi'];

onToolChanged​

工具变化监听

Parameters​

  • cb function 回调函数，回传参数：当前工具，string

Examples​

chart.onToolChanged((tool) => console.log(tool)); // ['volume, smi'];

onToolFocused​

焦点工具变化监听

Parameters​

  • cb function 回调函数，回传参数：当前工具，string

Examples​

chart.onToolFocused((toolObject) => console.log(toolObject)); // ['volume, smi'];

onFinishDrawingTool​

绘画完成监听

Parameters​

  • cb function 回调函数，回传参数：画画的信息，object

Examples​

chart.onFinishDrawingTool((tool) => console.log(tool)); // TOOL_CURSOR;

onDeleteDrawnTool​

画线删除监听

Parameters​

  • cb function 回调函数，回传参数：object：删除的绘画id和symbol

Examples​

chart.onDeleteDrawnTool((tool) => console.log(tool)); // {id: 1, symbol: 'btcusdt:okex'};

onDeleteDrawnTools​

批量删除监听

Parameters​

  • cb any

onShouldLoadHistory​

加载历史数据监听

Parameters​

Examples​

chart.onShouldLoadHistory(() => chart.updateData([], true)); // ['volume, smi'];

onAreaHeightChanged​

区域高度变化监听

Parameters​

  • cb function 回调函数，回调参数：高度数组，array

Examples​

chart.onAreaHeightChanged((heights) => console.log(heights)); // [123,123,3];

onScaleChanged​

缩放变化监听

Parameters​

  • cb function 回调函数，回调参数：缩放程度，number，[1,36]

Examples​

chart.onScaleChanged((scale) => console.log(scale)); // 6;

onSettingBtnClick​

指标info设置按钮监听

Parameters​

  • cb function 回调函数，回传参数：当前指标，string，

Examples​

chart.onSettingBtnClick((indicator, type) => console.log(indicator, type)); // INDICATOR_VOLUME;

onSeriesInfoBtnClick​

指标info按钮监听

Parameters​

  • cb function 回调函数，回传参数, 指标类型，指标位置，指标来源，等

Examples​

chart.onInfoBtnClick((payload) => console.log(payload)); // INDICATOR_VOLUME;

onSeriesInfoBtnClick​

series info 按钮监听

Parameters​

  • cb function 回调函数，回传参数：当前series info相关信息

Examples​

chart.onSeriesInfoBtnClick((indicator, type) => console.log(indicator, type)); // INDICATOR_VOLUME;

onIndicatorInfoTitleClick​

指标info，下拉监听

Parameters​

  • cb function 回调函数，回传参数：位置和指标的key

Examples​

chart.onIndicatorInfoTitleClick((payload) => console.log(payload));

onToolLimited​

画线上限监听

Parameters​

  • cb function 回调函数，回传参数：上限条数，number，

Examples​

chart.onToolLimited((num) => console.log(num)); // 100;

onYaxisLocked​

画线锁定状态监听

Parameters​

  • cb function 回调函数，回传参数：锁定状态，boolean，

Examples​

chart.onYaxisLocked((bool) => console.log(bool)); // true;

onTimelineChanged​

timeline更新监听

Parameters​

  • cb function 回调函数，回传参数：锁定状态，boolean，

Examples​

chart.onTimelineChanged((bool) => console.log(bool)); // true;

onTradeRecordClick​

买卖点击监听

Parameters​

  • cb function 回调函数，回传参数：成交点击对象，object，

Examples​

chart.onTradeRecordClick((TradeRecordItem) => console.log(TradeRecordItem)); // TradeRecordItem.getPosXY()和TradeRecordItem#width属性可以计算出弹窗的位置;

onToolDoubleClick​

画线双击监听

Parameters​

  • cb function 回调函数，回传参数：成交点击对象，object，

Examples​

chart.onToolDoubleClick(() => console.log());

onPositionCostLineClick​

持仓成本线点击监听

Parameters​

  • cb function 回调函数，回传参数：成本线位置，点击按钮等对象，object，

Examples​

chart.onPositionCostLineClick((info) => console.log(info)); // {
   x,
   y,
   clickedBtn, // 点击的btn名字，[profitBtn, closeBtn, mktCloseAllBtn];
   data, // 原始数据
};

setPositionCostLineDraggingText​

Parameters​

  • cb function (): void

onOrderLineClick​

委单线点击监听

Parameters​

  • cb function 回调函数，回传参数：委单线位置，点击按钮等对象，object，

Examples​

chart.onOrderLineClick((info) => console.log(info)); // {
   x,
   y,
   clickedBtn, // 点击的btn名字，[infoBtn, amountBtn, cancelBtn];
   data, // 原始数据
};

setOrderLineDraggingText​

Parameters​

  • cb function (): void

onSelectionButtonsClick​

十字线下单按钮点击监听

Parameters​

  • cb function 回调函数，回传参数：委单线位置，点击按钮等对象，object，

Examples​

chart.onSelectionButtonsClick((info) => console.log(info)); // {
   x,
   y,
   clickedBtn, // 点击的btn名字，[infoBtn, amountBtn, cancelBtn];
   data, // 原始数据
};

setMainIndicators​

设置主指标

Parameters​

Examples​

chart.setMainIndicators([INDICATOR.BOLL, INDICATOR.MA]);

setSubIndicators​

设置副指标

Parameters​

  • indicators array 副指标

Examples​

chart.setSubIndicators(['volume, smi']);

setIndicatorNav​

设置是否显示副指标上的切换按钮

Parameters​

Examples​

chart.setIndicatorNav(true);

setPriceLine​

设置是否显示价格线

Parameters​

  • show (boolean | number) 显示值 (optional, default LATEST_PRICE_BOTH)

Examples​

chart.setPriceLine(true | false | 0 | 1 | 2 | 3);

setChartStyle​

设置蜡烛形状

Parameters​

  • style string 蜡烛形状 (optional, default STICK_STYLE.CANDLE)

Examples​

chart.setChartStyle(STICK_STYLE.CANDLE);

toggleYAxisLocked​

设置是否锁定Y轴

Parameters​

Examples​

chart.toggleYAxisLocked(true);

setMainRangePaddingRatio​

设置主图上下内边距

Parameters​

  • v number (0,0.2] (optional, default 0.05)

Examples​

chart.setMainRangePaddingRatio(0.2);

setXAxisPaddingRatio​

设置时间轴右边距

Parameters​

  • v number (optional, default 0.2)

setYAxisType​

设置Y轴坐标

Parameters​

  • scale string 线性或者是对数 (optional, default AXIS_SCALE_LINEAR)

Examples​

chart.setYAxisType(AXIS_SCALE_LOGARITHMIC);

selectTool​

选择工具

Parameters​

  • tool string -工具名称
  • meta object -元数据（id之类）
  • options object -配置（样式之类）
  • isSelfAction boolean -是否是自身派发的事件 (optional, default true)

Examples​

chart.selectTool(TOOL_CURSOR, isKeepDrawing);

setSymbol​

设置当前symbol

Parameters​

Examples​

chart.setSymbol({
 symbol: 'okexbtcusdt'
});

setDecimal​

设置小数点

Parameters​

Examples​

chart.setDecimal(3);

Returns any this

setCloseLineWhenMinScale​

设置是否在缩放到最小时变为趋势线

Parameters​

Examples​

chart.setCloseLineWhenMinScale(true);

getLastStickDate​

获取最后一条柱子的日期

Examples​

chart.getLastStickDate(); // timestamp

Returns number timestamp

getLastStickItem​

获取最后一条柱子的信息

Examples​

chart.getLastStickItem(); // timestamp

Returns any timestamp

getFirstStickDate​

获取最后一条柱子的日期

Examples​

chart.getLastStickDate(); // timestamp

Returns number timestamp

setRatio​

设置屏幕倍数

Parameters​

Examples​

chart.setRatio(2);

setTools​

加载线段

Parameters​

  • arr number 画线信息数组
  • action boolean 动作 (optional, default 'replace')
  • idMap any

Examples​

chart.setTools([{
"points": [
{
"x": "1536214200000",
"y": "6331.08768276043",
},
{
"x": "1536219240000",
"y": "6331.08768276043",
}
],
"name": "CHoriRayLineObject",
"symbol": "btcusdt:okex",
"id": 17
},]);

getTools​

获取线段

Parameters​

  • raw bool 是否原对象

clearTools​

清空所有画线

Examples​

chart.clearTools();

deleteFocusedDrawnTool​

删除focus的画线

Parameters​

  • show bool

Examples​

chart.deleteFocusedDrawnTool();

deleteDrawnToolById​

根据ID删除画线

Parameters​

deleteDrawnToolsByIds​

批量删除画线

Parameters​

  • ids any

getToolsLength​

获取画线数组的长度

Returns number length

setFocusedToolById​

手动设置focusedTool，通过ID

Parameters​

  • id any

Returns boolean true设置成功，false设置不成功

toggleIndicatorBtns​

设置是否显示指标们的设置和删除按钮

Parameters​

Examples​

chart.toggleIndicatorBtns(false);

getImageData​

获取K线图片数据

Examples​

chart.getImageData();

Returns string base64

setIntl​

多语言设置

Parameters​

Examples​

chart.setIntl({
 time: '时间',
 O: '开',
 H: '高',
 L: '低',
 C: '收',
 chg: '涨幅',
 ampl: '振幅',
 month: ['1月', '2月', '3月', '4月', '5月', '6月', '7月', '8月', '9月', '10月', '11月', '12月'],
 week: ['周日', '周一', '周二', '周三', '周四', '周五', '周六'],
});

invertRange​

反转Y轴

Examples​

chart.invertRange();

setOpenTime​

设置开盘时间

Parameters​

  • openTime (0 | 8)

Examples​

chart.setOpenTime(0); // [0, 8]

Returns boolean

setDistinctiveIndicators​

设置特色指标

Parameters​

  • indicators string 特色指标
  • redraw (optional, default true)

Examples​

chart.setDistinctiveIndicators([INDICATOR.VRAR, INDICATOR.LARGEORDER]);

toggleTradeRecord​

设置是否显示买卖记录

Parameters​

Examples​

chart.toggleTradeRecord(false);

updateTradeRecordData​

设置是否显示买卖记录

Parameters​

  • data any

Examples​

chart.updateTradeRecordData([
   {
     type: 'ask' or 'bid',
     price: 8300,
     tick: Date.now(),
   }
]);

getIndicatorParameters​

设置指标的参数

Parameters​

  • indicName INDICATOR 指标名称
  • level string 获取类别， all: “全部参数”，current: “当前已设置的简化参数”，simple: "简化参数" (optional, default 'all')

Returns any paramsStorage

setIndicatorParameters​

获取指标的参数

Parameters​

  • indicName INDICATOR 指标名称

  • params object 简化参数

  • options object 选项 (optional, default {})

    • options.level string 设置类别， mix: “混合到当前已设置的参数对象中”， replace: “替换已设置的参数对象” (optional, default 'mix')
    • options.isOnlyStored boolean 是否仅保存不应用 (optional, default false)

Returns boolean

getAllIndicatorsSimpleParameters​

获取全部指标的参数

Returns any ParamsStorage

setAllIndicatorsSimpleParameters​

设置全部指标的参数

Parameters​

  • paramsGroup object 所有指标的参数对象

resetIndicatorParameters​

重置参数

Parameters​

  • indicName INDICATOR 参数名称

Returns boolean

onContextMenu​

右键点击监听

Parameters​

  • cb function 回调函数，回传参数：当前位置信息，object

Examples​

chart.onContextMenu((info) => console.log(info)); // {
   x,
   y,
   area,
   date,
   value,
};

togglePositionCostLine​

设置是否显示持仓成本线

Parameters​

  • bool any
  • options any

updatePositionCostLineData​

设置持仓成本线数据数组

Parameters​

  • data any

Examples​

chart.updatePositionCostLineData([{
  profit: -100.0018, // 持仓收益
  profitRatio: -100.42, // 收益率（即10%）
  pos: 1000, // 持仓数量
  unit: '张', // 持仓数量单位
  side: 'long', // 多空方向（long 多仓，short 空仓）
  price: 9000, // 开仓价格
}, {
  profit: 0.0018, // 持仓收益
  profitRatio: 0.42, // 收益率（即10%）
  pos: 2, // 持仓数量
  unit: '张', // 持仓数量单位
  side: 'short', // 多空方向（long 多仓，short 空仓）
  price: 10000, // 开仓价格
}]]);

toggleOrderLine​

设置是否显示委单线

Parameters​

  • bool any
  • options any

updateOrderLineData​

设置委单线数据数组

Parameters​

  • data any

Examples​

chart.updateOrderLineData([{
 oid: 'xxxxx', // 订单ID
  name: '限价',
  price: 9000,
  trigger: 'Trigger >= 9500', // 可能会为空
  amount: '100', // 数量
  type: 'Limit', // 限价Limit、止损Stop
  side: 'buy', // 买入buy、卖出sell
 }, {
   oid: 'xxxxx', // 订单ID
   name: '限价',
   price: 9000,
   trigger: 'Trigger >= 9500', // 可能会为空
   amount: '100', // 数量
   type: 'Limit', // 限价Limit、止损Stop
   side: 'buy', // 买入buy、卖出sell
 }]]);

toggleAlertLine​

设置是否显示预警线

Parameters​

  • bool any
  • options any

updateAlertLineData​

设置预警线数据数组

Parameters​

  • data any

Examples​

chart.updateAlertLineData([{
 oid: 'xxxxx', // 订单ID
  name: '限价',
  price: 9000,
  trigger: 'Trigger >= 9500', // 可能会为空
  amount: '100', // 数量
  type: 'Limit', // 限价Limit、止损Stop
  side: 'buy', // 买入buy、卖出sell
 }, {
   oid: 'xxxxx', // 订单ID
   name: '限价',
   price: 9000,
   trigger: 'Trigger >= 9500', // 可能会为空
   amount: '100', // 数量
   type: 'Limit', // 限价Limit、止损Stop
   side: 'buy', // 买入buy、卖出sell
 }]]);

toggleSelectionButtons​

设置是否显示十字线下单按钮

Parameters​

  • bool any

addCandlestickSeries​

增加蜡烛序列

Parameters​

Returns object series

removeSeries​

删除序列

Parameters​

  • series any

Returns boolean