update doc

2026-05-18 22:40:10 +00:00 · 2022-10-11 07:00:35 +08:00
parent 0662f62cd1
commit ab8ced4aed
13 changed files with 3026 additions and 3026 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -59,8 +59,9 @@

 ## master

-* (2022.09.10) 增加`Line`的`SmoothLimit`可控制平滑曲线不同效果
-* (2022.09.05) 修复`Serie`隐藏时`Tooltip`还显示信息的问题
+* (2022.10.10) 调整文档格式
+* (2022.10.10) 增加`Line`的`SmoothLimit`可控制平滑曲线不同效果
+* (2022.10.05) 修复`Serie`隐藏时`Tooltip`还显示信息的问题
 * (2022.09.30) 修复`Chart`在很小尺寸时出现`DivideByZeroException`异常

 ## v3.3.0
@@ -76,6 +77,7 @@

 ### 日志详情

+* (2022.09.28) 发布`v3.3.0`版本
 * (2022.09.26) 优化`Axis`在类目轴时的默认分割段数
 * (2022.09.25) 修复`API`文档中部分接口没有导出的问题
 * (2022.09.24) 优化`FunnelChart`
--- a/Documentation/SUPPORT.md
+++ b/Documentation/SUPPORT.md
@@ -19,7 +19,7 @@

 | |免费用户|付费咨询|个人`VIP` | 个人`SVIP` | 企业`VIP` |
 | ----- |--|--|--|--|--|
-| 订阅费用 | --  | `98`¥   | `298`¥ | 首年`1298`¥</br>后续`298¥`* | `联系我们` |
+| 订阅费用 | --  | `98`¥   | `298`¥ | 首年`1298`¥<br/>后续`298¥`* | `联系我们` |
 | 订阅时长 | -- | `7`天* | `1`年 | `1`年* | `1`年
 | 订阅席位 | -- | `1`个席位 | `1`个席位  |`1`个席位|`5`个以上席位|
 | __`服务方式：`__|
--- a/Documentation/XChartsAPI-EN.md
+++ b/Documentation/XChartsAPI-EN.md
--- a/Documentation/XChartsAPI-ZH.md
+++ b/Documentation/XChartsAPI-ZH.md
--- a/Documentation/XChartsConfiguration-EN.md
+++ b/Documentation/XChartsConfiguration-EN.md
--- a/Documentation/XChartsConfiguration-ZH.md
+++ b/Documentation/XChartsConfiguration-ZH.md
--- a/Documentation/XChartsFAQ-EN.md
+++ b/Documentation/XChartsFAQ-EN.md
@@ -1,7 +1,7 @@
 # XCharts FAQ

-[XCharts Homepage](https://github.com/XCharts-Team/XCharts)</br>
-[XCharts API](XChartsAPI-EN.md)</br>
+[XCharts Homepage](https://github.com/XCharts-Team/XCharts)<br/>
+[XCharts API](XChartsAPI-EN.md)<br/>
 [XCharts Configuration](XChartsConfiguration-EN.md)

 [QA 1: How to adjust the margin between the axis and the background?](#How-to-adjust-the-margin-between-the-axis-and-the=-background)  
@@ -145,6 +145,6 @@ A: This is the limit of `UGUI` on the number of vertices for a single `Graphic`.

 A: Check whether `RemoveData()` and add new `Serie` in the code. If you want to keep the configuration of `Serie`, you can only `ClearData()` which just clear data and then readd the data to the old serie.

-[XCharts Homepage](https://github.com/XCharts-Team/XCharts)</br>
-[XCharts API](XChartsAPI-EN.md)</br>
+[XCharts Homepage](https://github.com/XCharts-Team/XCharts)<br/>
+[XCharts API](XChartsAPI-EN.md)<br/>
 [XCharts Configuration](XChartsConfiguration-EN.md)
--- a/Documentation/XChartsFAQ-ZH.md
+++ b/Documentation/XChartsFAQ-ZH.md
@@ -1,4 +1,4 @@
-# XCharts问答
+# 问答

 [XCharts主页](https://github.com/XCharts-Team/XCharts)  
 [XChartsAPI](XChartsAPI-ZH.md)  
--- a/Documentation/XChartsTutorial01-EN.md
+++ b/Documentation/XChartsTutorial01-EN.md
@@ -1,8 +1,8 @@
 # 教程：5分钟上手 XCharts 3.0

-[XCharts主页](https://github.com/XCharts-Team/XCharts)</br>
-[XCharts问答](XChartsFAQ-ZH.md)</br>
-[XChartsAPI接口](XChartsAPI-ZH.md)</br>
+[XCharts主页](https://github.com/XCharts-Team/XCharts)<br/>
+[XCharts问答](XChartsFAQ-ZH.md)<br/>
+[XChartsAPI接口](XChartsAPI-ZH.md)<br/>
 [XCharts配置项手册](XChartsConfiguration-ZH.md)

 ## 获取和导入 XCharts
@@ -257,7 +257,7 @@ itemStyle.color = Color.blue;

 ```

-[XCharts主页](https://github.com/XCharts-Team/XCharts)</br>
-[XCharts问答](XChartsFAQ-ZH.md)</br>
-[XChartsAPI接口](XChartsAPI-ZH.md)</br>
+[XCharts主页](https://github.com/XCharts-Team/XCharts)<br/>
+[XCharts问答](XChartsFAQ-ZH.md)<br/>
+[XChartsAPI接口](XChartsAPI-ZH.md)<br/>
 [XCharts配置项手册](XChartsConfiguration-ZH.md)
--- a/Documentation/XChartsTutorial01-ZH.md
+++ b/Documentation/XChartsTutorial01-ZH.md
@@ -1,8 +1,8 @@
 # 教程：5分钟上手 XCharts 3.0

-[XCharts主页](https://github.com/XCharts-Team/XCharts)</br>
-[XCharts问答](XChartsFAQ-ZH.md)</br>
-[XChartsAPI接口](XChartsAPI-ZH.md)</br>
+[XCharts主页](https://github.com/XCharts-Team/XCharts)<br/>
+[XCharts问答](XChartsFAQ-ZH.md)<br/>
+[XChartsAPI接口](XChartsAPI-ZH.md)<br/>
 [XCharts配置项手册](XChartsConfiguration-ZH.md)

 ## 获取和导入 XCharts
@@ -257,7 +257,7 @@ itemStyle.color = Color.blue;

 ```

-[XCharts主页](https://github.com/XCharts-Team/XCharts)</br>
-[XCharts问答](XChartsFAQ-ZH.md)</br>
-[XChartsAPI接口](XChartsAPI-ZH.md)</br>
+[XCharts主页](https://github.com/XCharts-Team/XCharts)<br/>
+[XCharts问答](XChartsFAQ-ZH.md)<br/>
+[XChartsAPI接口](XChartsAPI-ZH.md)<br/>
 [XCharts配置项手册](XChartsConfiguration-ZH.md)
--- a/Runtime/Component/Tooltip/Tooltip.cs
+++ b/Runtime/Component/Tooltip/Tooltip.cs
@@ -178,56 +178,56 @@ namespace XCharts.Runtime
        /// The placeholder {I} can be set separately to indicate that the title is ignored and not displayed.
        /// Template see itemFormatter.
        /// |提示框标题内容的字符串模版格式器。支持用 \n 换行。可以单独设置占位符{i}表示忽略不显示title。
-        /// 模板变量有{.}、{a}、{b}、{c}、{d}、{e}、{f}、{g}。</br>
-        /// {.}为当前所指示或index为0的serie的对应颜色的圆点。</br>
-        /// {a}为当前所指示或index为0的serie的系列名name。</br>
-        /// {b}为当前所指示或index为0的serie的数据项serieData的name，或者类目值（如折线图的X轴）。</br>
-        /// {c}为当前所指示或index为0的serie的y维（dimesion为1）的数值。</br>
-        /// {d}为当前所指示或index为0的serie的y维（dimesion为1）百分比值，注意不带%号。</br>
-        /// {e}为当前所指示或index为0的serie的数据项serieData的name。</br>
-        /// {f}为数据总和。</br>
-        /// {g}为数据总个数。</br>
-        /// {.1}表示指定index为1的serie对应颜色的圆点。</br>
-        /// {a1}、{b1}、{c1}中的1表示指定index为1的serie。</br>
-        /// {c1:2}表示索引为1的serie的当前指示数据项的第3个数据（一个数据项有多个数据，index为2表示第3个数据）。</br>
-        /// {c1:2-2}表示索引为1的serie的第3个数据项的第3个数据（也就是要指定第几个数据项时必须要指定第几个数据）。</br>
-        /// {d1:2:f2}表示单独指定了数值的格式化字符串为f2（不指定时用numericFormatter）。</br>
-        /// {d:0.##} 表示单独指定了数值的格式化字符串为 0.## （用于百分比，保留2位有效数同时又能避免使用 f2 而出现的类似于"100.00%"的情况 ）。</br>
+        /// 模板变量有{.}、{a}、{b}、{c}、{d}、{e}、{f}、{g}。<br/>
+        /// {.}为当前所指示或index为0的serie的对应颜色的圆点。<br/>
+        /// {a}为当前所指示或index为0的serie的系列名name。<br/>
+        /// {b}为当前所指示或index为0的serie的数据项serieData的name，或者类目值（如折线图的X轴）。<br/>
+        /// {c}为当前所指示或index为0的serie的y维（dimesion为1）的数值。<br/>
+        /// {d}为当前所指示或index为0的serie的y维（dimesion为1）百分比值，注意不带%号。<br/>
+        /// {e}为当前所指示或index为0的serie的数据项serieData的name。<br/>
+        /// {f}为数据总和。<br/>
+        /// {g}为数据总个数。<br/>
+        /// {.1}表示指定index为1的serie对应颜色的圆点。<br/>
+        /// {a1}、{b1}、{c1}中的1表示指定index为1的serie。<br/>
+        /// {c1:2}表示索引为1的serie的当前指示数据项的第3个数据（一个数据项有多个数据，index为2表示第3个数据）。<br/>
+        /// {c1:2-2}表示索引为1的serie的第3个数据项的第3个数据（也就是要指定第几个数据项时必须要指定第几个数据）。<br/>
+        /// {d1:2:f2}表示单独指定了数值的格式化字符串为f2（不指定时用numericFormatter）。<br/>
+        /// {d:0.##} 表示单独指定了数值的格式化字符串为 0.## （用于百分比，保留2位有效数同时又能避免使用 f2 而出现的类似于"100.00%"的情况 ）。<br/>
        /// 示例："{a}:{c}"、"{a1}:{c1:f1}"、"{a1}:{c1:0:f1}"、"{a1}:{c1:1-1:f1}"
        /// </summary>
        /// </summary>
        public string titleFormatter { get { return m_TitleFormatter; } set { m_TitleFormatter = value; } }
        /// <summary>
        /// a string template formatter for a single Serie or data item content. Support for wrapping lines with \n.
-        /// Template variables are {.}, {a}, {b}, {c}, {d}.</br>
-        /// {.} is the dot of the corresponding color of a Serie that is currently indicated or whose index is 0.</br>
-        /// {a} is the series name of the serie that is currently indicated or whose index is 0.</br>
-        /// {b} is the name of the data item serieData that is currently indicated or whose index is 0, or a category value (such as the X-axis of a line chart).</br>
-        /// {c} is the value of a Y-dimension (dimesion is 1) from a Serie that is currently indicated or whose index is 0.</br>
-        /// {d} is the percentage value of Y-dimensions (dimesion is 1) from serie that is currently indicated or whose index is 0, with no % sign.</br>
-        /// {e} is the name of the data item serieData that is currently indicated or whose index is 0.</br>
-        /// {f} is sum of data.</br>
-        /// {.1} represents a dot from serie corresponding color that specifies index as 1.</br>
-        /// 1 in {a1}, {b1}, {c1} represents a serie that specifies an index of 1.</br>
-        /// {c1:2} represents the third data from serie's current indication data item indexed to 1 (a data item has multiple data, index 2 represents the third data).</br>
-        /// {c1:2-2} represents the third data item from serie's third data item indexed to 1 (i.e., which data item must be specified to specify).</br>
-        /// {d1:2: F2} indicates that a formatted string with a value specified separately is F2 (numericFormatter is used when numericFormatter is not specified).</br>
-        /// {d:0.##} indicates that a formatted string with a value specified separately is 0.##   (used for percentage, reserved 2 valid digits while avoiding the situation similar to "100.00%" when using f2 ).</br>
-        /// Example: "{a}, {c}", "{a1}, {c1: f1}", "{a1}, {c1:0: f1}", "{a1} : {c1:1-1: f1}"</br>
+        /// Template variables are {.}, {a}, {b}, {c}, {d}.<br/>
+        /// {.} is the dot of the corresponding color of a Serie that is currently indicated or whose index is 0.<br/>
+        /// {a} is the series name of the serie that is currently indicated or whose index is 0.<br/>
+        /// {b} is the name of the data item serieData that is currently indicated or whose index is 0, or a category value (such as the X-axis of a line chart).<br/>
+        /// {c} is the value of a Y-dimension (dimesion is 1) from a Serie that is currently indicated or whose index is 0.<br/>
+        /// {d} is the percentage value of Y-dimensions (dimesion is 1) from serie that is currently indicated or whose index is 0, with no % sign.<br/>
+        /// {e} is the name of the data item serieData that is currently indicated or whose index is 0.<br/>
+        /// {f} is sum of data.<br/>
+        /// {.1} represents a dot from serie corresponding color that specifies index as 1.<br/>
+        /// 1 in {a1}, {b1}, {c1} represents a serie that specifies an index of 1.<br/>
+        /// {c1:2} represents the third data from serie's current indication data item indexed to 1 (a data item has multiple data, index 2 represents the third data).<br/>
+        /// {c1:2-2} represents the third data item from serie's third data item indexed to 1 (i.e., which data item must be specified to specify).<br/>
+        /// {d1:2: F2} indicates that a formatted string with a value specified separately is F2 (numericFormatter is used when numericFormatter is not specified).<br/>
+        /// {d:0.##} indicates that a formatted string with a value specified separately is 0.##   (used for percentage, reserved 2 valid digits while avoiding the situation similar to "100.00%" when using f2 ).<br/>
+        /// Example: "{a}, {c}", "{a1}, {c1: f1}", "{a1}, {c1:0: f1}", "{a1} : {c1:1-1: f1}"<br/>
        /// |提示框单个serie或数据项内容的字符串模版格式器。支持用 \n 换行。用|来表示多个列的分隔。
-        /// 模板变量有{.}、{a}、{b}、{c}、{d}、{e}、{f}、{g}。</br>
+        /// 模板变量有{.}、{a}、{b}、{c}、{d}、{e}、{f}、{g}。<br/>
        /// {i}或-表示忽略当前项。
-        /// {.}为当前所指示的serie或数据项的对应颜色的圆点。</br>
-        /// {a}为当前所指示的serie或数据项的系列名name。</br>
-        /// {b}为当前所指示的serie或数据项的数据项serieData的name，或者类目值（如折线图的X轴）。</br>
-        /// {c}为当前所指示的serie或数据项的y维（dimesion为1）的数值。</br>
-        /// {d}为当前所指示的serie或数据项的y维（dimesion为1）百分比值，注意不带%号。</br>
-        /// {e}为当前所指示的serie或数据项的数据项serieData的name。</br>
-        /// {f}为当前所指示的serie的默认维度的数据总和。</br>
-        /// {g}为当前所指示的serie的数据总个数。</br>
-        /// {c0}表示当前数据项维度为0的数据。</br>
-        /// {c1}表示当前数据项维度为1的数据。</br>
-        /// {d3}表示维度3的数据的百分比。它的分母是默认维度（一般是1维度）数据。</br>
+        /// {.}为当前所指示的serie或数据项的对应颜色的圆点。<br/>
+        /// {a}为当前所指示的serie或数据项的系列名name。<br/>
+        /// {b}为当前所指示的serie或数据项的数据项serieData的name，或者类目值（如折线图的X轴）。<br/>
+        /// {c}为当前所指示的serie或数据项的y维（dimesion为1）的数值。<br/>
+        /// {d}为当前所指示的serie或数据项的y维（dimesion为1）百分比值，注意不带%号。<br/>
+        /// {e}为当前所指示的serie或数据项的数据项serieData的name。<br/>
+        /// {f}为当前所指示的serie的默认维度的数据总和。<br/>
+        /// {g}为当前所指示的serie的数据总个数。<br/>
+        /// {c0}表示当前数据项维度为0的数据。<br/>
+        /// {c1}表示当前数据项维度为1的数据。<br/>
+        /// {d3}表示维度3的数据的百分比。它的分母是默认维度（一般是1维度）数据。<br/>
        /// |表示多个列的分隔。<br>
        /// 示例："{i}", "{.}|{a}|{c}", "{.}|{b}|{c2:f2}"
        /// </summary>
--- a/Runtime/Serie/Heatmap/Heatmap.cs
+++ b/Runtime/Serie/Heatmap/Heatmap.cs
@@ -30,7 +30,7 @@ namespace XCharts.Runtime
    [SerieDataExtraField()]
    public class Heatmap : Serie, INeedSerieContainer
    {
-        [SerializeField][Since("3.3.0")] private HeatmapType m_HeatmapType = HeatmapType.Data;
+        [SerializeField][Since("v3.3.0")] private HeatmapType m_HeatmapType = HeatmapType.Data;

        /// <summary>
        /// The mapping type of heatmap.
--- a/Runtime/Serie/Radar/Radar.cs
+++ b/Runtime/Serie/Radar/Radar.cs
@@ -11,7 +11,7 @@ namespace XCharts.Runtime
    [SerieDataExtraField()]
    public class Radar : Serie, INeedSerieContainer
    {
-        [SerializeField][Since("3.2.0")] private bool m_Smooth = false;
+        [SerializeField][Since("v3.2.0")] private bool m_Smooth = false;

        /// <summary>
        /// Whether use smooth curve.