update doc

Assets/XCharts/CHANGELOG-EN.md

@@ -32,6 +32,10 @@
 
 ## Latest
 
+* (2021.03.06) Added `PieChart`'s `minAngle` parameter to support setting minimum sector angle #117
+* (2021.03.05) Added support for `Legend` for several built-in ICONS #90
+* (2021.03.02) Added `DataRoom` support for value axes #71
+* (2021.03.02) Optimized `TextMeshPro` compatibility issue #125
 * (2021.03.01) Fixed display exception of hidden gameObjects when enabling and disabling a chart #125
 
 ## v2.0.1

Assets/XCharts/CHANGELOG.md

@@ -32,7 +32,11 @@
 
 ## Latest
 
-* (2021.03.01) 修复隐藏和显示chart时部分已隐藏的节点显示异常的问题 #125
+* (2021.03.06) 增加`PieChart`的`minAngle`参数支持设置最小扇区角度 #117
+* (2021.03.05) 增加`Legend`几种内置图标的支持 #90
+* (2021.03.02) 增加`DataZoom`对数值轴的支持 #71
+* (2021.03.02) 优化`TextMeshPro`兼容问题 #125
+* (2021.03.01) 修复隐藏和显示图表时部分已隐藏的节点显示异常的问题 #125
 
 ## v2.0.1
 

Assets/XCharts/Documentation/XCharts配置项手册.md

@@ -115,6 +115,14 @@
 相关参数：
 
 * `show`：是否显示图例组件。
+* `iconType`：图例图标类型。有以下几种类型：
+  * `Auto`：自动匹配。
+  * `Custom`：自定义图标。
+  * `EmptyCircle`：空心圆。
+  * `Circle`：实心圆。
+  * `Rect`：正方形。可通过`Setting`的`legendIconCornerRadius`参数调整圆角。
+  * `Triangle`：三角形。
+  * `Diamond`：菱形。
 * `selectedMode`：选择模式。控制是否可以通过点击图例改变系列的显示状态。默认开启图例选择，可以设成 `None` 关闭。有以下三种选择方式：
   * `Multiple`：多选。
   * `Single`：单选。
@@ -619,6 +627,7 @@
 * `space`：扇区间隙。
 * `center`：中心点坐标。当值为`0-1`的浮点数时表示百分比。
 * `radius`：半径。`radius[0]`为内径，`radius[1]`为外径。当内径大于0时即为圆环图。
+* `minAngle`：最小的扇区角度（0-360）。用于防止某个值过小导致扇区太小影响交互。
 * `roundCap`：是否启用圆弧效果。
 * `ignore`：是否开启忽略数据。当为 `true` 时，数据值为 `ignoreValue` 时不进行绘制，对应的`Label`和`Legend`也不会显示。
 * `ignoreValue`：忽略数据的默认值。默认值默认为0，当 `ignore` 为 `true` 才有效。

Assets/XCharts/Documentation/xcharts-configuration-EN.md

@@ -113,6 +113,14 @@ Legend component.The legend component shows different sets of symbol, colors, an
 Parameters:
 
 * `show`: Whether show legend component.
+* `iconType`: the legend icon symbol type:
+  * `Auto` : Auto match.
+  * `Custom` : Custom icon.
+  * `EmptyCircle` : hollow circle.
+  * `Circle` : solid Circle.
+  * `Rect` : square.
+  * `Triangle` :
+  * `Diamond` :
 * `selectedMode`: Selected mode of legend, which controls whether series can be toggled displaying by clicking legends:
   * `Multiple`: multi-select.
   * `Single`: single select.
@@ -227,7 +235,7 @@ Tooltip component.
   * Example: `"{a}, {c}"`, `"{a1}, {c1: f1}"`, `"{a1}, {c1:0: f1}"`, `"{a1} : {c1:1-1: f1}"`
 * `titleFormatter`: The string template formatter for the tooltip title content. Support for wrapping lines with `\n`. This is only valid if the `itemFormatter` is in effect. The placeholder `{I}` can be set separately to indicate that the title is ignored and not displayed.
 * `itemFormatter`: a string template formatter for a single Serie or data item content. Support for wrapping lines with `\n`. When `formatter` is not null, use `formatter` first, otherwise use `itemFormatter`.
-* `numericFormatter`: Standard numeric format string. Used to format numeric values to display as strings. Using 'Axx' form: 'A' is the single character of the format specifier, supporting 'C' currency, 'D' decimal, 'E' exponent, 'F' number of vertices, 'G' regular, 'N' digits, 'P' percentage, 'R' round tripping, 'X' hex etc. 'XX' is the precision specification, from '0' - '99'. see: <https://docs.microsoft.com/zh-cn/dotnet/standard/base-types/standard-numeric-format-strings>
+* `numericFormatter`: Standard numeric format string. Used to format numeric values to display as strings. Using `Axx` form: `A` is the single character of the format specifier, supporting `C` currency, `D` decimal, `E` exponent, `F` number of vertices, `G` regular, `N` digits, `P` percentage, `R` round tripping, `X` hex etc. `XX` is the precision specification, from `0` - `99`. see: <https://docs.microsoft.com/zh-cn/dotnet/standard/base-types/standard-numeric-format-strings>
 * `fixedWidth`: Fixed width. Higher priority than `minWidth`.
 * `fixedHeight`: Fixed height. Higher priority than `minHeight`.
 * `minWidth`: Minimum width. If `fixedWidth` has a value, get `fixedWidth` first.
@@ -260,7 +268,7 @@ Vessel component for liquid chart. There can be multiple vessels in a Chart, whi
 ## `DataZoom`
 
 DataZoom component is used for zooming a specific area, which enables user to investigate data in detail, or get an overview of the data, or get rid of outlier points.  
-Currently only the control 'X' axis is supported.
+Currently only the control `X` axis is supported.
 
 * `enable`: Whether to show dataZoom.
 * `supportInside`: Whether built-in support is supported. Built into the coordinate system to allow the user to zoom in and out of the coordinate system by mouse dragging, mouse wheel, finger swiping (on the touch screen).
@@ -308,7 +316,7 @@ VisualMap component. mapping data to visual elements such as colors.
 * `min`: The minimum allowed. `min` must be user specified. `[min, max]` forms the domain of the visualMap.
 * `max`: The maximum allowed. `max` must be user specified. `[min, max]` forms the domain of the visualMap.
 * `range`: Specifies the position of the numeric value corresponding to the handle. Range should be within the range of [min,max].
-* ~~`text`: Text on both ends. such as ['High', 'Low'].~~
+* ~~`text`: Text on both ends. such as [`High`, `Low`].~~
 * ~~`textGap`: The distance between the two text bodies.~~
 * `splitNumber`: For continuous data, it is automatically evenly divided into several segments and automatically matches the size of inRange color list when the default is 0.
 * `calculable`: Whether the handle used for dragging is displayed (the handle can be dragged to adjust the selected range).
@@ -512,6 +520,7 @@ Line chart serie.
 * `space`: 扇区间隙。
 * `center`: 中心点坐标。当值为`0-1`的浮点数时表示百分比。
 * `radius`: 半径。`radius[0]`为内径，`radius[1]`为外径。当内径大于0时即为圆环图。
+* `minAngle`: The minimum angle of sector(0-360). It prevents some sector from being too small when value is small.
 * `roundCap`: 是否启用圆弧效果。
 * `ignore`: 是否开启忽略数据。当为 `true` 时，数据值为 `ignoreValue` 时不进行绘制，对应的`Label`和`Legend`也不会显示。
 * `ignoreValue`: 忽略数据的默认值。默认值默认为0，当 `ignore` 为 `true` 才有效。