Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
@liihuu
liihuu committed Dec 1, 2024
1 parent 0bee312 commit 0db73aa
Show file tree
Hide file tree
Showing 10 changed files with 110 additions and 597 deletions.
6 changes: 3 additions & 3 deletions docs/.vitepress/config/en-US.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ export default defineConfig({
{
text: 'Next',
items: [
{ text: 'V9 Docs', link: 'https://v9.klinecharts.com/en-US' },
{ text: 'V8 Docs', link: 'https://v8.klinecharts.com' }
{ text: '9.x Docs', link: 'https://v9.klinecharts.com/en-US' },
{ text: '8.x Docs', link: 'https://v8.klinecharts.com' }
]
},
],
Expand Down Expand Up @@ -63,7 +63,7 @@ export default defineConfig({
text: 'Others',
collapsed: false,
items: [
{ text: 'V8 to V9', link: '/en-US/guide/v8-to-v9' },
{ text: '9.x to 10.x', link: '/en-US/guide/v9-to-v10' },
{ text: 'FAQ', link: '/en-US/guide/faq' },
{ text: 'Feedback', link: '/en-US/guide/feedback' },
{ text: 'Changelog', link: '/en-US/guide/changelog' }
Expand Down
6 changes: 3 additions & 3 deletions docs/.vitepress/config/zh-CN.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ export default defineConfig({
{
text: 'Next',
items: [
{ text: 'V9 文档', link: 'https://v9.klinecharts.com' },
{ text: 'V8 文档', link: 'https://v8.klinecharts.com/zh-CN' }
{ text: '9.x 文档', link: 'https://v9.klinecharts.com' },
{ text: '8.x 文档', link: 'https://v8.klinecharts.com/zh-CN' }
]
},
],
Expand Down Expand Up @@ -68,7 +68,7 @@ export default defineConfig({
text: '其它',
collapsed: false,
items: [
{ text: '从v8到v9', link: '/guide/v8-to-v9' },
{ text: '从 9.x 到 10.x', link: '/guide/v9-to-v10' },
{ text: '常见问题', link: '/guide/faq' },
{ text: '反馈和共建', link: '/guide/feedback' },
{ text: '更新日志', link: '/guide/changelog' }
Expand Down
2 changes: 1 addition & 1 deletion docs/@views/api/references/chart/registerYAxis.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
```typescript
(
xAxis: {
yAxis: {
name: string
reverse?: boolean
inside?: boolean
Expand Down
265 changes: 25 additions & 240 deletions docs/en-US/guide/changelog.md
View file
Original file line number Diff line number Diff line change
@@ -1,249 +1,34 @@
# 📠 Change Log

## 9.8.10
`2024-06-06`
+ 🐞 Fix the issue of blurry drawing of basic graphics `rect`, `line`.
+ 🐞 Fix the inaccurate zooming issue of instance methods `zoomAtCoordinate`, `zoomAtDataIndex` and `zoomAtTimestamp`.
+ 🐞 Fix the issue of possible error in x-axis zooming.
+ 💄 Optimize the instance method `subscribeAction`. When `type` is 'onScroll' and 'onZoom', the callback method adds a new parameter.
+ 💄 Optimize the sub-item `attrs` in the indicator attribute `figures`. Add callback parameter `data`.

## 9.8.9
`2024-05-28`
+ 🐞 Fix style configuration `yAxis.type: 'percentage'` error.
+ 🐞 Fix declaration issue in typescript.

## 9.8.8
`2024-05-14`
+ 🐞 Fix the issue that the style configuration `candle.tooltip.custom` cannot be overridden when it is an array.
+ 🐞 Fix the issue of decimal folding.
+ 💄 Optimize the parameter `precision` in the overlay callback method.

## 9.8.7
`2024-05-10`
+ 🐞 Fix the issue of unsynchronized price and volume precision in indicator precision.

## 9.8.6
`2024-05-07`
+ 🐞 Fix an issue that chart API `registerIndicator` and `registerOverlay` parameters `extendData` cannot take effect.
+ 🐞 Fix an issue of incorrect decimal folding when specifying `.` as the thousandth character.
+ 🐞 Fix an issue where overlays may not be moved after being created.

## 9.8.5
`2024-04-14`
+ 💄 Optimize the default right offset distance of the chart.
+ 🐞 Fix area chart display issue.
+ 🐞 Fix occasional blank spaces in chart.

## 9.8.3
`2024-04-12`
+ 💄 Optimize styles by adding `offsetLeft`, `offsetTop`, `offsetRight` and `offsetBottom` to `candle.tooltip` and `indicator.tooltip`.
+ 💄 Optimize figure and support array for attrs.
+ 💄 Optimize y-axis render.
+ 💄 Optimize default display, change the default candle width to 8.
+ 🐞 Fix `applyMoreData` add duplicate data issue. [@cryptotooltop](https://github.com/cryptotooltop)

## 9.8.2
`2024-03-26`
+ 💄 Optimize the display of the area chart.
+ 💄 Optimize smooth line drawing.
+ 🐞 Fix the overlay and drawing it to future time may not be an issue.

## 9.8.1
`2024-03-13`
+ 🐞 Fix an issue where initialize only `xAxis` in `layout` caused the chart to fail to initialize.
+ 🐞 Fix an issue when modify the built-in indicator `VOL` to `calcParams`.
+ 💄 Optimize the accuracy of width calculation when display decimal fold on the y-axis.
+ 💄 Optimize wheel event trigger.

## 9.8.0
`2024-03-04`
+ 🆕 Support custom coordinate axis.
+ 🆕 Support indicator mapping to future time.
+ 🆕 Support folding long decimals.
+ 🆕 Support adding data forward and backward.
+ 🐞 Fix formatting time issue for different browsers.

`2024-01-12`
+ 🐞 Fix the issue of ineffective indicator attributes `minValue` and `maxValue`.
+ 🐞 Fix the display issue on the x-axis of the overlay.
+ 💄 Optimize the display of style `candle.type: 'ohlc'`.
+ 💄 Optimize drawing clarity.

## 9.7.1
`2023-12-18`
+ 🐞 Fix indicators and overlays methods not effect error.
+ 🐞 Fix package manager download node version dependency error.

## 9.7.0
`2023-12-12`
+ 🆕 Add instance apis`setMaxOffsetLeftDistance` and `setMaxOffsetRightDistance`.
+ 🆕 Add indicator attribute `zLevel`.
+ 💄 Optimize the rendering of the ohlc candle bar.
+ 🐞 Fix the blurry issue with the candle bar.
+ 🐞 Fix the rendering rules for the `zLevel` overlay.

## 9.6.0
`2023-11-14`
+ 🖋️ Refactor the separator module.
+ 🆕 Chart api `init(ds, options)`, parameter `options` add `layout`.
+ 🆕 Instance api `createIndicator(value, isStack, paneOptions, callback)`, parameter `PaneOptions` add `position`.
+ 🆕 Style `candle.tooltip.custom` adds `turnover` string template.
+ 💄 Optimize the style `overlay.text` configuration.
+ 💄 Optimize the implementation of `utils.clone` and `utils.merge`.
+ 🐞 Fix the issue of multiple overlay styles display error.
+ 🐞 Fix the issue of multiple indicator styles display error.

## 9.5.4
`2023-09-22`
+ 🐞 Fix the issue of not display the latest price line when the style `candle.type` is `area`.
+ 🐞 Fix the issue of incorrect display of the style `crosshair.vertical.text.paddingLeft`.

## 9.5.3
`2023-09-19`
+ 🐞 Fix typescript import error.

## 9.5.2
`2023-09-18`
+ 💄 Optimize the figure `text`.
+ 💄 Optimize built-in overlays `simpleAnnotation` and `simpleTag`.
+ 💄 Optimize the free style of technical indicators and support increment.
+ 🐞 Fix typescript declaration issue.

## 9.5.1
`2023-08-14`
+ 🆕 Add chart api `getOverlayClass`.
+ 🆕 Style configuration `candle.tooltip.custom` add built-in support `change`.
+ 💄 Optimize figure `rect` event trigger.
+ ↩️ Separator event trigger optimization rollback.

## 9.5.0
`2023-06-15`
+ 🆕 `Overlay` add event `onDoubleClick`, add property `modeSensitivity`.
+ 🆕 Style configuration `candle.tooltip.custom` supports string templates.
+ 🐞 Optimize the scrolling frame drop issue on the mobile side.
+ 🐞 Fix pane id naming typo.
+ 💄 Optimize the response sensitivity of dividing line events.
+ 💄 Optimize the attrs type declaration in OverlayFigure under typescript.

## 9.4.0
`2023-05-25`
+ 🆕 Instance API 'createOverlay' supports arrays.
+ 🆕 `overlay` add attributes `paneId`, `defaultZLevel` and `zLevel`.
+ 🆕 `xAxis` add methods `convertTimestampFromPixel` and `convertTimestampToPixel`.
+ 💄 Optimize the display of candle.

## 9.3.0
`2023-05-13`
+ 🆕 Add chart API `utils.calcTextWidth`.
+ 🆕 The instance APIs `createIndicator(value, isStack, options)` and `setPaneOptions(options)` have added `options. axisOptions`.
+ 🆕 The indicator graphic configuration supports customization.
+ 💄 Optimize the bar width ratio.
+ 💄 Optimize internal acquisition of screen pixel ratio.
+ 💄 Optimize internal ID generation.


## 9.2.2
`2023-05-04`
+ 🐞 Fix figure `line` check event error.
+ 💄 Optimize type check.

## 9.2.1
`2023-04-27`
+ 💄 Optimize the default style by changing `#EF5350` to `#F92855` and `#26A69A` to `#2DC08E`.
+ 💄 Optimize typescript declarations.

## 9.2.0
`2023-04-24`
+ 🆕 Add instance API `getOffsetRightDistance` and `executeAction`.
+ 🆕 Add success callback for instance API `applyNewData`, `applyMoreData` and `updateData`.
+ 🆕 Support the display of thousands.
+ 🆕 Add style configuration `candle.bar.upBorderColor`, `candle.bar.downBorderColor`, `candle.bar.noChangeBorderColor`, `candle.bar.upWickColor`, `candle.bar.downWickColor`, `candle.bar.noChangeWickColor`, `candle.tooltip.rect.position` and `candle.tooltip.rect.offsetBottom`.
+ 🆕 Add `realFrom` and `realTo` to all `visibleRange`.
+ 💄 Optimize API, `klinecharts.utils.isValid` and `klinecharts.utils.formatBigNumber`.
+ 💄 Optimize the log output in the development environment.

## 9.1.3
`2023-04-15`
+ 🐞 Fix the issue of not refreshing when the input parameter of the chart API `applyNewData` is an empty array.
+ 🐞 Fix the issue of cross cursor text not displaying on the y-axis when there is no data.
+ 💄 Optimize the display of area chart.
+ 💄 Optimize coverage event callback parameters and add `figureKey` and `figureIndex`.
+ 💄 Optimize typescript overlay style types, as well as base types `DeepPartial` and `DeepRequired`.

## 9.1.2
`2023-04-10`
+ 🐞 Fix the issue of inaccurate triggering events for the built-in figure `line`.
+ 🐞 Fix the issue of triggering events for the first time after the `simpleAnnotation` and `simpleTag` built-in overlays are drawn.
+ 💄 Optimize overlay figure to ignore events and support event selection.

## 9.1.1
`2023-03-14`
+ 🐞 Fix the invalidity of the built-in figure `arc`.
+ 💄 Optimize rendering updates.

## 9.1.0
`2023-02-23`
+ 🆕 The chart instance method `subscribeAction` and `unsubscribeAction` types add `onCandleBarClick`.
+ 🆕 The overlay supports double-clicking to force the end of drawing.
+ 💄 Optimize event handling.


## 9.0.1
`2023-02-17`
🐞 Fix the introduction of typescript.

## 9.0.0
`2023-02-16`
+ 🛠 Typescript refactoring.
## 10.0.0-alpha1
`2024-12-01`
+ 🆕 New features
+ Add Y axis direction zoom and scroll.
+ API
+ New chart methods `registerFigure`, `getSupportFigures`, `getFigureClass`, `rigiderOverlay`, `getSupportOverlays`, `registerLocale`, `getSupportLocales`, `registerStyles` are added.
+ New instance methods, `getSize`, `setLocale`, `getLocal`, `setCustomApi`, `getVisibleRange`, `createOverlay`, `getOverlayById`, `overrideOverlay`, `removeOverlay`.
+ Style Configuration
+ Add `candle.priceMark.last.text.borderStyle`, `candle.tooltip.icons`, `indicator.lastValueMark.text.borderStyle`, `indicator.tooltip.icons`, `crosshair.horizontal. text.borderStyle`, `crosshair.vertical.text.borderStyle`.
+ 👉 Change
+ API
+ Chart method `extension.addTechnicalIndicatorTemplate` is changed to `registerIndicator`.
+ Chart method `extension.addShapeTemplate` is changed to `registerOverlay`.
+ Instance method `setStyleOptions` is changed to `setStyles`.
+ Instance method `getStyleOptions` is changed to `getStyles`.
+ Instance method `setPaneOptions(options)`, `options` add new attribute `gap`.
+ Instance method `setOffsetRightSpace` is changed to `setOffsetRightDistance`.
+ Instance method `createTechnicalIndicator` is changed to `createIndicator`
+ Instance method `overlayTechnicalIndicator` is changed to `overrideIndicator`.
+ Instance method `getTechnicalIndicatorByPaneId` is changed to `getIndicatorByPaneId`.
+ Instance method `removeTechnicalIndicator` is changed to `removeIndicator`.
+ Style Configuration
+ All `line.style` options are changed to `solid` and `dashed`.
+ All `dashValue` is changed to `dashedValue`.
+ `xAxis.height` is changed to `xAxis.size`, `xAxis.tickeText.paddingTop` is changed to `xAxis.tickeText.marinStart`, and `xAxis.tickeText.paddingBottom` is changed to `xAxis.tickeText.marinEnd`.
+ `yAxis.height` is changed to `yAxis.size`, `yAxis.tickeText.paddingTop` is changed to `yAxis.tickeText.marinStart`, and `yAxis.tickeText.paddingBottom` is changed to `yAxis.tickeText.marinEnd`.
+ `technicalIndicator.bar` is changed to `indicator.bars`, `technicalIndicator.line` is changed to `indicator.lines`，`technicalIndicator.circle` is changed to `indicator.circles`
+ Custom Extension
+ The technical indicator attribute `calcParams` has been changed to support any type.
+ The technical indicator attribute `plots` is changed to `figures`.
+ The technical indicator attribute `regeneratePlots` is changed to' regeneratefigures'.
+ The technical indicator attribute `calcTechnicalIndicator` is changed to `calc`.
+ The technical indicator attribute `render` is changed to 'draw'.
+ 🗑 Abandonment
+ API
+ Delete instance methods `getWidth`, `getHeight`, and use `getSize` instead.
+ Delete instance methods `createShape`, `createAnnotation`, `createTag`, and use `createOverlay` instead.
+ Delete instance methods `removeShape`, `removeAnnotation`, `removeTag`. Use `removeOverlay` instead.
+ Delete the instance method `setShapeOptions` and use `overrideOverlay` instead.
+ Delete instance methods `createHtml`, `removeHtml`, `addTechnicalIndicatorTemplate`, `getTechnicalIndicatorTemplate`, `addShapeTemplate`.
+ Style Configuration
+ Delete `shape`, `annotation`, `tag` and use `overlay` instead.
+ Delete `candle.margin`，`technicalIndicator.margin`。
+ Custom Extension
+ The related attributes are no longer saved in the technical indicator template.
+ Delete `Shape` and use `Overlay` instead.
+ Support thousand separators and custom decimal folding.
+ Rewrite the axis module, and customize the y-axis to support setting ranges.
+ Add instance methods `setPrecision(precision)` , `getPrecision()` , `setThousandsSeparator(thousandsSeparator)` , `getThousandsSeparator()` , `setDecimalFold(decimalFold)` , `getDecimalFold()` and `setLoadMoreDataCallback(cb)` .
+ 👉 Changes
+ 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` .
+ Instance api `applyNewData(dataList, more, callback)` changed to `applyNewData(dataList, more)` .
+ Instance api `updateData(data, callback)` changed to `updateData(data)` .
+ Instance api `getBarSpace()` return value changed to object.
+ The return value of the custom indicator `createTooltipDataSource` method `values` is changed to `legends` .
+ 🗑 Deprecated
+ 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.
+ Remove instance api `setPriceVolumePrecision(pricePrecision, volumePrecision)`, please use `setPrecision(precision)` instead.
+ Remove instance api `applyMoreData(dataList, more, callback)`, `setLoadDataCallback(cb)` and `loadMore(cb)`, please use `setLoadMoreDataCallback(cb)` instead.
+ Remove instance api `getIndicatorByPaneId(paneId, name)`, please use `getIndicators(filter)` instead.
+ Remove instance api `getOverlayById(id)`, please use `getOverlays(filter)` instead.
+ 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).
+ Remove `overlay.rectText` from style configuration.
+ Remove `rectText` from built-in basic graphics, please use `text` instead.

## 9.x

Go to [https://v9.klinecharts.com](https://v9.klinecharts.com) to check the change log for 9.x.

## 8.x

Go to [Github](https://github.com/liihuu/KLineChart/blob/v8.6.3/docs/en/changelog.md) to check the change log for 8.x.
Go to [https://v8.klinecharts.com](https://v8.klinecharts.com) to check the change log for 9.x.

## 7.x

Expand Down
Loading

0 comments on commit 0db73aa

Please sign in to comment.