Skip to content

Commit 47a01cc

Browse files
committed
docs: update
1 parent c40d96c commit 47a01cc

File tree

3 files changed

+51
-153
lines changed

3 files changed

+51
-153
lines changed

docs/en-US/guide/changelog.md

Lines changed: 30 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,37 @@
11
# 📠 Change Log
22

3-
## 10.0.0-alpha9
4-
`2025-09-02`
5-
+ 👉 Change the return value of the indicator method `calc` from an array to an object keyed by a timestamp.
6-
+ 💄 Optimize indicator calculation task execution.
7-
+ 🐞 Fix an issue where the instance APIs `setSymbol`, `setPeriod`, and `setDataLoader` did not reset the Y axis.
8-
9-
## 10.0.0-alpha8
10-
`2025-06-14`
11-
+ 🐞 Fix typescript reference error.
12-
13-
## 10.0.0-alpha7
14-
`2025-06-14`
15-
+ 👉 Chart api `init(ds, options)` , `options.customApi` changed to `options.formatter` , `formatDate` parameter changed to object.
16-
+ 👉 Instance api `setCustomApi` changed to `setFormatter` , `getCustomApi` changed to `getFormatter`.
17-
+ 🆕 Style configuration add `candle.priceMark.last.extendTexts` , `candle.tooltip.title` , `candle.tooltip.legend` , `indicator.tooltip.title` , `indicator.tooltip.legend` and `crosshair.horizontal.features` .
18-
+ 🆕 Instance api add `setDataLoader` , `setSymbol` , `getSymbol` , `setPeriod` , `getPeriod` and `resetData` .
19-
+ 🆕 Instance api `subscribeAction` and `unsubscribeAction` params add `onIndicatorTooltipFeatureClick` and `onCrosshairFeatureClick` .
20-
+ 🗑 Remove `candle.tooltip.defaultValue` in style configuration, replace `candle.tooltip.custom` with `candle.tooltip.legend`, remove `candle.tooltip.text`, remove `indicator.tooltip.showName`, `indicator.tooltip.showParams`, use `indicator.tooltip.title`, remove `indicator.tooltip.defaultValue`, replace with `indicator.tooltip.legend`, remove `indicator.tooltip.text`.
21-
+ 🗑 Remove `setLoadMoreData` , `applyNewData` , `updateData` in instance api, replace with `setDataLoader`, remove `clearData`, `setPrecision` and `getPrecision` .
22-
+ 🐞 Fix the confusion of overlay `onSelected` and `onDeselected` responses.
23-
+ 🐞 Fix the display problem when the style configuration `candle.type` is `ohlc` .
24-
+ 💄 Optimize the default event response of overlay events.
25-
+ 💄 Optimize the x-axis display.
26-
27-
## 10.0.0-alpha6
28-
`2025-06-12`
29-
+ Error publish.
30-
31-
## 10.0.0-alpha5
32-
`2025-03-09`
33-
+ 👉 Style configuration `candle.tooltip.icons` changed to `candle.tooltip.features`, `indicator.tooltip.icons` changed to `indicator.tooltip.features`.
34-
+ 👉 `icons` in the return value of the `createTooltipDataSource` method in the indicator changed to `features`.
35-
+ 👉 The instance api `subscribeAction` and `unsubscribeAction` input parameter `onTooltipIconClick` changed to `onCandleTooltipFeatureClick`, and the indicator event is replaced by `indicator.onClick`.
36-
+ 🐞 Fixed the problem that scrolling cannot be performed in certain situations on mobile terminals.
37-
+ 💄 Optimize the display of overlay event response.
38-
39-
## 10.0.0-alpha4
40-
`2025-02-23`
41-
+ 🐞 Fix the issue that the parameter `more.backward` of `applyNewData` instance method is incorrect.
42-
+ 🐞 Fix the issue that a single piece of data causes a chart error.
43-
44-
## 10.0.0-alpha3
45-
`2025-02-19`
46-
+ 👉 The return value of the instance api `createIndicator` is changed to return the indicator id.
47-
+ 👉 The input parameter `paneId` of the instance api `overlayIndicator` is merged into the input parameter `indicator`.
48-
+ 👉 The return value of the instance api `getIndicators` is changed to return an array.
49-
+ 👉 The return value of the instance api `getOverlays` is changed to return an array.
50-
+ 🆕 The style configuration adds `candle.bar.compareRule`, `indicator.ohlc.compareRule` and `candle.priceMark.last.compareRule`.
51-
+ 🆕 Supports dragging the y-axis on mobile devices.
52-
+ 🆕 Supports creating multiple indicators with the same name on the same window.
53-
+ 💄 Optimize `figure` in `overlay` template to ignore event type, and the event name is consistent with the event name in `overlay`.
54-
+ 🐞 Fix the problem that the indicator custom prompt information may be wrong.
55-
+ 🐞 Fix the problem that the overlay being drawn may not be deleted correctly.
56-
+ 🐞 Fix the problem that the api `createOverlay` may not be created correctly when `points` is specified.
57-
+ 🐞 Fix the problem that the api `executeAction` may cause the `subscribeAction` to trigger infinitely.
58-
59-
## 10.0.0-alpha2
60-
`2024-12-20`
61-
+ 🆕 The x-axis supports displaying future time.
62-
+ 🐞 Fix the issue that `subscribeAction` type is `ActionType.OnCandleBarClick` and it does not work.
63-
64-
## 10.0.0-alpha1
65-
`2024-12-01`
66-
+ 🆕 New features
67-
+ Support thousand separators and custom decimal folding.
68-
+ Rewrite the axis module, and customize the y-axis to support setting ranges.
69-
+ Add instance methods `setPrecision(precision)` , `getPrecision()` , `setThousandsSeparator(thousandsSeparator)` , `getThousandsSeparator()` , `setDecimalFold(decimalFold)` , `getDecimalFold()` and `setLoadMoreDataCallback(cb)` .
3+
## 10.0.0-beta1
4+
`2025-11-21`
5+
+ 🆕 New Features
6+
+ Support thousands separators and custom decimal collapse.
7+
+ Support displaying future time on the x-axis.
8+
+ Support dragging the y-axis on mobile devices.
9+
+ Support creating multiple metrics with the same name on the same window.
10+
+ Rewrote the axis module; custom y-axis supports setting the range.
11+
+ Add `zoomAnchor` to the `options` method of the chart method `init(dom, options)`.
12+
+ New instance methods `setZoomAnchor(anchor)`, `getZoomAnchor()`, `setDataLoader(loader)`, `setSymbol(symbol)`, `getSymbol()`, `setPeriod(period)`, `getPeriod()`, `resetData()`, `setThousandsSeparator(thousandsSeparator)` , `getThousandsSeparator()` , `setDecimalFold(decimalFold)` , `getDecimalFold()` , `getIndicators()` and `getOverlays()` .
13+
+ Add style configurations: `candle.priceMark.last.extendTexts`, `candle.tooltip.title`, `candle.tooltip.legend`, `indicator.tooltip.title`, `indicator.tooltip.legend`, `crosshair.horizontal.features`, `candle.bar.compareRule`, `indicator.ohlc.compareRule`, and `candle.priceMark.last.compareRule`.
14+
+ Add `onIndicatorTooltipFeatureClick` and `onCrosshairFeatureClick` to the `type` parameter in the instance methods `subscribeAction` and `unsubscribeAction`.
7015
+ 👉 Changes
71-
+ Chart api `init(dcs, options)`, `position` in `options.layout` child changed to `order` , `formatDate(dateTimeFormat, timestamp, format, type)` in `options.customApi` changed to `formatDate(timestamp, format, type)` , `options.thousandsSeparator` changed to object `{ sign, format }` , `options.decimalFoldThreshold` changed to `options.decimalFold` .
72-
+ Instance api `applyNewData(dataList, more, callback)` changed to `applyNewData(dataList, more)` .
73-
+ Instance api `updateData(data, callback)` changed to `updateData(data)` .
74-
+ Instance api `getBarSpace()` return value changed to object.
75-
+ The return value of the custom indicator `createTooltipDataSource` method `values` is changed to `legends` .
16+
+ In the chart method `init(dcs, options)`, the `position` sub-item of `options.layout` has been changed to `order`, `options.thousandsSeparator` has been changed to the object `{ sign, format }`, `options.decimalFoldThreshold` has been changed to `options.decimalFold`, `options.customApi` has been changed to `options.formatter`, and the parameter of `formatDate` has been changed to an object.
17+
+ In the instance methods `setCustomApi` and `getCustomApi` have been changed to `getFormatter`, the return value of `getBarSpace()` has been changed to an object, the return value of `createIndicator` has been changed to return the indicator ID, and the input parameter `paneId` of `overlayIndicator` has been merged into the input parameter `indicator`.
18+
+ The return value of the custom metric `createTooltipDataSource` method has been changed from `values` to `legends`, and `icons` to `features`.
19+
+ The style configurations `candle.tooltip.icons` and `indicator.tooltip.icons` have been changed to `indicator.tooltip.features`.
20+
+ 💄 Optimizations
21+
+ Optimized the `figure` element in the overlay template to ignore event types, ensuring the event name matches the event name in `overlay`.
22+
+ Optimized the execution of metric calculation tasks.
23+
+ Optimized the triggering of scroll events on mobile devices.
24+
7625
+ 🗑 Deprecated
77-
+ Remove chart api `utils.drawArc(ctx, arc, styles)`, `utils.drawCircle(ctx, circle, styles)`, `utils.drawLine(ctx, line, styles)`, `utils.drawPolygon(ctx, polygon, styles)`, `utils.drawRect(ctx, rect, styles)`, `utils.drawText(ctx, text, styles)`, `utils.drawRectText(ctx, rectText, styles)`, please use `getFigureClass(name)` instead.
78-
+ Remove instance api `setPriceVolumePrecision(pricePrecision, volumePrecision)`, please use `setPrecision(precision)` instead.
79-
+ Remove instance api `applyMoreData(dataList, more, callback)`, `setLoadDataCallback(cb)` and `loadMore(cb)`, please use `setLoadMoreDataCallback(cb)` instead.
80-
+ Remove instance api `getIndicatorByPaneId(paneId, name)`, please use `getIndicators(filter)` instead.
81-
+ Remove instance api `getOverlayById(id)`, please use `getOverlays(filter)` instead.
82-
+ Remove style configuration `yAxis.position` , `yAxis.type` , `yAxis.inside` and `yAxis.inside` , please use the properties in the window configuration `axis` instead. For details, refer to the chart API [init(dcs, options)](/api/chart/init#parameters), the instance API [createIndicator(value, isStack, paneOptions)](/api/instance/createIndicator#parameters) and [setPaneOptions(options)](/api/instance/setPaneOptions#parameters).
83-
+ Remove `overlay.rectText` from style configuration.
84-
+ Remove `rectText` from built-in basic graphics, please use `text` instead.
26+
+ The following chart methods have been removed: `utils.drawArc(ctx, arc, styles)`, `utils.drawCircle(ctx, circle, styles)`, `utils.drawLine(ctx, line, styles)`, `utils.drawPolygon(ctx, polygon, styles)`, `utils.drawRect(ctx, rect, styles)`, `utils.drawText(ctx, text, styles)`, `utils.drawRectText(ctx, rectText, styles)`. Please use `getFigureClass(name)` instead.
27+
+ The following instance method has been removed: `setPriceVolumePrecision(pricePrecision, volumePrecision)`. Please use `setPrecision(precision)` instead.
28+
+ In the instance API, remove `setLoadMoreData`, `applyNewData`, and `updateData`. Replace them with `setDataLoader`. Remove `clearData`, `setPrecision`, and `getPrecision`.
29+
+ In the instance method, remove `getIndicatorByPaneId(paneId, name)`. Replace it with `getIndicators(filter)`.
30+
+ In the instance method, remove `getOverlayById(id)`. Replace it with `getOverlays(filter)`.
31+
+ In the instance methods `subscribeAction` and `unsubscribeAction`, remove the parameter `onTooltipIconClick`. Replace it with `onCandleTooltipFeatureClick` and `onIndicatorTooltipFeatureClick`.
32+
+ The style configuration removes `yAxis.position`, `yAxis.type`, `yAxis.inside`, and `yAxis.inside`. Please use the properties in the `axis` section of the window configuration instead. For details, see the chart API `[init(dcs, options)](/api/chart/init#parameters)`, the instance APIs `[createIndicator(value, isStack, paneOptions)](/api/instance/createIndicator#parameters)`, and `[setPaneOptions(options)](/api/instance/setPaneOptions#parameters)`.
33+
+ In style configuration, remove `candle.tooltip.defaultValue` and replace `candle.tooltip.custom` with `candle.tooltip.legend`. Also remove `candle.tooltip.text`, `indicator.tooltip.showName`, and `indicator.tooltip.showParams`; use `indicator.tooltip.title` instead. Remove `indicator.tooltip.defaultValue` and replace it with `indicator.tooltip.legend`. Also remove `indicator.tooltip.text` and `overlay.rectText`.
34+
+ In built-in basic graphics, remove `rectText` and replace it with `text`.
8535

8636
## 9.x
8737

0 commit comments

Comments
 (0)