From 1cb84e3cc6266ebaf83df1bf7224795a1f67c5d6 Mon Sep 17 00:00:00 2001 From: liihuu Date: Sat, 27 May 2023 03:36:49 +0800 Subject: [PATCH] docs: update --- docs/en-US/guide/figure.md | 28 ++++++++++++++-------------- docs/guide/changelog.md | 1 - docs/guide/figure.md | 30 +++++++++++++++--------------- 3 files changed, 29 insertions(+), 30 deletions(-) diff --git a/docs/en-US/guide/figure.md b/docs/en-US/guide/figure.md index a86a15d4..4a4bcf52 100644 --- a/docs/en-US/guide/figure.md +++ b/docs/en-US/guide/figure.md @@ -21,7 +21,7 @@ new Figure(attrs, styles).draw(ctx) These figures are built into the chart, `arc`, `circle`, `line`, `polygon`, `rect`, `text`, `rectText`. ### arc ```typescript -new ( +new ({ attrs: { // The x-axis coordinate value of the center of the circle x: number @@ -44,12 +44,12 @@ new ( // dotted line parameter dashedValue?: number[] } -) => Figure +}) => Figure ``` ### circle ```typescript -new ( +new ({ attrs: { // The x-axis coordinate value of the center of the circle x: number @@ -72,12 +72,12 @@ new ( // border dotted line parameters borderDashedValue?: number[] } -) => Figure +}) => Figure ``` ### line ```typescript -new ( +new ({ attrs: { // set of coordinates coordinates: Array<{ @@ -95,12 +95,12 @@ new ( // dotted line parameter dashedValue?: number[] } -) => Figure +}) => Figure ``` ###polygon ```typescript -new ( +new ({ attrs: { // set of coordinates coordinates: Array<{ @@ -122,12 +122,12 @@ new ( // border dotted line parameter borderDashedValue?: number[] } -) => Figure +}) => Figure ``` ### rect ```typescript -new ( +new ({ attrs: { // The x-axis coordinate value of the starting point x: number @@ -154,12 +154,12 @@ new ( // Border fillet value borderRadius?: number } -) => Figure +}) => Figure ``` ### text ```typescript -new ( +new ({ attrs: { // The x-axis coordinate value of the starting point x: number @@ -182,12 +182,12 @@ new ( // thickness weight?: string | number } -) => Figure +}) => Figure ``` ### rectText ```typescript -new ( +new ({ attrs: { // The x-axis coordinate value of the starting point x: number @@ -232,7 +232,7 @@ new ( // background color backgroundColor?: string | CanvasGradient } -) => Figure +}) => Figure ``` ## Customize figure diff --git a/docs/guide/changelog.md b/docs/guide/changelog.md index 37198fd7..ef648ca3 100644 --- a/docs/guide/changelog.md +++ b/docs/guide/changelog.md @@ -7,7 +7,6 @@ + 🆕 `xAxis`新增方法`convertTimestampFromPixel`和`convertTimestampToPixel`。 + 💄 优化蜡烛柱显示。 - ## 9.3.0 `2023-05-13` + 🆕 新增图表API `utils.calcTextWidth`。 diff --git a/docs/guide/figure.md b/docs/guide/figure.md index 1b8218e6..3c5eb959 100644 --- a/docs/guide/figure.md +++ b/docs/guide/figure.md @@ -14,14 +14,14 @@ const Figure = klinecharts.getFigureClass(name) // attrs 属性 // styles 样式 // ctx 画布上下文 -new Figure(attrs, styles).draw(ctx) +new Figure({ attrs, styles }).draw(ctx) ``` ## 内置基础图形 图表内置了这些基础图形,`arc`,`circle`,`line`,`polygon`,`rect`,`text`,`rectText`。 ### arc ```typescript -new ( +new ({ attrs: { // 圆心x轴坐标值 x: number @@ -44,12 +44,12 @@ new ( // 虚线参数 dashedValue?: number[] } -) => Figure +}) => Figure ``` ### circle ```typescript -new ( +new ({ attrs: { // 圆心x轴坐标值 x: number @@ -72,12 +72,12 @@ new ( // 边框虚线参数 borderDashedValue?: number[] } -) => Figure +}) => Figure ``` ### line ```typescript -new ( +new ({ attrs: { // 坐标集合 coordinates: Array<{ @@ -95,12 +95,12 @@ new ( // 虚线参数 dashedValue?: number[] } -) => Figure +}) => Figure ``` ### polygon ```typescript -new ( +new ({ attrs: { // 坐标集合 coordinates: Array<{ @@ -122,12 +122,12 @@ new ( // 边框虚线参数 borderDashedValue?: number[] } -) => Figure +}) => Figure ``` ### rect ```typescript -new ( +new ({ attrs: { // 起始点x轴坐标值 x: number @@ -154,12 +154,12 @@ new ( // 边框圆角值 borderRadius?: number } -) => Figure +}) => Figure ``` ### text ```typescript -new ( +new ({ attrs: { // 起始点x轴坐标值 x: number @@ -182,12 +182,12 @@ new ( // 粗细 weight?: string | number } -) => Figure +}) => Figure ``` ### rectText ```typescript -new ( +new ({ attrs: { // 起始点x轴坐标值 x: number @@ -232,7 +232,7 @@ new ( // 背景色 backgroundColor?: string | CanvasGradient } -) => Figure +}) => Figure ``` ## 自定义基础图形