foldcc/XCharts
1
0
Fork 0
mirror of https://github.com/XCharts-Team/XCharts.git synced 2026-05-20 23:40:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

[doc] update doc

Browse Source
This commit is contained in:
monitor1394
2022-04-13 22:04:45 +08:00
parent d44bf55a87
commit 84cf39df4d
4 changed files with 24 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/XChartsAPI-EN.md
View File

@@ -482,7 +482,7 @@ Inherits or Implemented: [Attribute](#Attribute)
## `GridCoordContext`
Inherits or Implemented: [MainComponentContext](#MainComponentContext),[IRectContext](#IRectContext)
Inherits or Implemented: [MainComponentContext](#MainComponentContext)
## `HeatmapChart`
@@ -703,6 +703,10 @@ Inherits or Implemented: [Attribute](#Attribute)
## `SerieDataContext`
|public method|description|
|--|--|
| `Reset` |public void Reset()</br> |
## `SerieExtraComponentAttribute`
Inherits or Implemented: [Attribute](#Attribute)
@@ -931,6 +935,7 @@ Inherits or Implemented: [MaskableGraphic](#MaskableGraphic)
| `GetVertialDire` |public static Vector3 GetVertialDire(Vector3 dire)</br> |
| `IsClearColor` |public static bool IsClearColor(Color color)</br> |
| `IsClearColor` |public static bool IsClearColor(Color32 color)</br> |
| `IsPointInTriangle` |public static bool IsPointInTriangle(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 check)</br> |
| `IsValueEqualsColor` |public static bool IsValueEqualsColor(Color color1, Color color2)</br> |
| `IsValueEqualsColor` |public static bool IsValueEqualsColor(Color32 color1, Color32 color2)</br> |
| `IsValueEqualsList<T>` |public static bool IsValueEqualsList<T>(List<T> list1, List<T> list2)</br> |
@@ -951,7 +956,9 @@ Inherits or Implemented: [MainComponentContext](#MainComponentContext)
|--|--|
| `AutoSetLineMinMax` |public static void AutoSetLineMinMax(VisualMap visualMap, Serie serie, bool isY, Axis axis, Axis relativedAxis)</br> |
| `GetDimension` |public static int GetDimension(VisualMap visualMap, int serieDataCount)</br> |
| `IsNeedAreaGradient` |public static bool IsNeedAreaGradient(VisualMap visualMap)</br> |
| `IsNeedGradient` |public static bool IsNeedGradient(VisualMap visualMap)</br> |
| `IsNeedLineGradient` |public static bool IsNeedLineGradient(VisualMap visualMap)</br> |
| `SetMinMax` |public static void SetMinMax(VisualMap visualMap, double min, double max)</br> |
## `XChartsMgr`

9
Documentation/XChartsAPI-ZH.md
View File

@@ -482,7 +482,7 @@ Inherits or Implemented: [Attribute](#Attribute)
## `GridCoordContext`
Inherits or Implemented: [MainComponentContext](#MainComponentContext),[IRectContext](#IRectContext)
Inherits or Implemented: [MainComponentContext](#MainComponentContext)
## `HeatmapChart`
@@ -703,6 +703,10 @@ Inherits or Implemented: [Attribute](#Attribute)
## `SerieDataContext`
|public method|description|
|--|--|
| `Reset` |public void Reset()</br> |
## `SerieExtraComponentAttribute`
Inherits or Implemented: [Attribute](#Attribute)
@@ -931,6 +935,7 @@ Inherits or Implemented: [MaskableGraphic](#MaskableGraphic)
| `GetVertialDire` |public static Vector3 GetVertialDire(Vector3 dire)</br> |
| `IsClearColor` |public static bool IsClearColor(Color color)</br> |
| `IsClearColor` |public static bool IsClearColor(Color32 color)</br> |
| `IsPointInTriangle` |public static bool IsPointInTriangle(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 check)</br> |
| `IsValueEqualsColor` |public static bool IsValueEqualsColor(Color color1, Color color2)</br> |
| `IsValueEqualsColor` |public static bool IsValueEqualsColor(Color32 color1, Color32 color2)</br> |
| `IsValueEqualsList<T>` |public static bool IsValueEqualsList<T>(List<T> list1, List<T> list2)</br> |
@@ -951,7 +956,9 @@ Inherits or Implemented: [MainComponentContext](#MainComponentContext)
|--|--|
| `AutoSetLineMinMax` |public static void AutoSetLineMinMax(VisualMap visualMap, Serie serie, bool isY, Axis axis, Axis relativedAxis)</br> |
| `GetDimension` |public static int GetDimension(VisualMap visualMap, int serieDataCount)</br> |
| `IsNeedAreaGradient` |public static bool IsNeedAreaGradient(VisualMap visualMap)</br> |
| `IsNeedGradient` |public static bool IsNeedGradient(VisualMap visualMap)</br> |
| `IsNeedLineGradient` |public static bool IsNeedLineGradient(VisualMap visualMap)</br> |
| `SetMinMax` |public static void SetMinMax(VisualMap visualMap, double min, double max)</br> |
## `XChartsMgr`

5
Documentation/XChartsConfiguration-EN.md
View File

@@ -1307,7 +1307,8 @@ VisualMap component. Mapping data to visual elements such as colors.
|field|default|comment|
|--|--|--|
| `show` |true | Whether to display components. If set to false, it will not show up, but the data mapping function still exists. |
| `show` |true | Whether to enable components. |
| `showUI` |false | Whether to display components. If set to false, it will not show up, but the data mapping function still exists. |
| `type` | | the type of visualmap component.</br>`Painter.Type`:</br>- `Base`: </br>- `Serie`: </br>- `Top`: </br>|
| `selectedMode` | | the selected mode for Piecewise visualMap.</br>`VisualMap.SelectedMode`:</br>- `Multiple`: 多选。</br>- `Single`: 单选。</br>|
| `serieIndex` |0 | the serie index of visualMap. |
@@ -1328,6 +1329,8 @@ VisualMap component. Mapping data to visual elements such as colors.
| `autoMinMax` |true | Automatically set min, Max value 自动设置min，max的值 |
| `orient` | | Specify whether the layout of component is horizontal or vertical.</br>`Orient`:</br>- `Horizonal`: 水平</br>- `Vertical`: 垂直</br>|
| `location` | | The location of component.</br>`AxisName.Location`:</br>- `Start`: the location of axis name.</br>- `Middle`: the location of axis name.</br>- `End`: the location of axis name.</br>- `align`: 对齐方式。</br>- `left`: Distance between component and the left side of the container.</br>- `right`: Distance between component and the left side of the container.</br>- `top`: Distance between component and the left side of the container.</br>- `bottom`: Distance between component and the left side of the container.</br>|
| `workOnLine` |true | Whether the visualmap is work on linestyle of linechart. |
| `workOnArea` |false | Whether the visualmap is work on areaStyle of linechart. |
| `inRange` | | Defines the visual color in the selected range. |
| `outOfRange` | | Defines a visual color outside of the selected range. |
| `pieces` | | 分段式每一段的相关配置。 |

5
Documentation/XChartsConfiguration-ZH.md
View File

@@ -1307,7 +1307,8 @@ Inherits or Implemented: [MainComponent](#MainComponent)
|field|default|comment|
|--|--|--|
| `show` |true | 是否显示组件。如果设置为 false，不会显示，但是数据映射的功能还存在。 [default: true] |
| `show` |true | 组件是否生效。 |
| `showUI` |false | 是否显示组件。如果设置为 false，不会显示，但是数据映射的功能还存在。 |
| `type` | | 组件类型。</br>`Painter.Type`:</br>- `Base`: </br>- `Serie`: </br>- `Top`: </br>|
| `selectedMode` | | 选择模式。</br>`VisualMap.SelectedMode`:</br>- `Multiple`: 多选。</br>- `Single`: 单选。</br>|
| `serieIndex` |0 | 影响的serie索引。 |
@@ -1328,6 +1329,8 @@ Inherits or Implemented: [MainComponent](#MainComponent)
| `autoMinMax` |true | Automatically set min, Max value 自动设置min，max的值 |
| `orient` | | 布局方式是横还是竖。</br>`Orient`:</br>- `Horizonal`: 水平</br>- `Vertical`: 垂直</br>|
| `location` | | 组件显示的位置。</br>`AxisName.Location`:</br>- `Start`: 坐标轴名称显示位置。</br>- `Middle`: 坐标轴名称显示位置。</br>- `End`: 坐标轴名称显示位置。</br>- `align`: 对齐方式。</br>- `left`: 离容器左侧的距离。</br>- `right`: 离容器右侧的距离。</br>- `top`: 离容器上侧的距离。</br>- `bottom`: 离容器下侧的距离。</br>|
| `workOnLine` |true | 组件是否对LineChart的LineStyle有效。 |
| `workOnArea` |false | 组件是否对LineChart的AreaStyle有效。 |
| `inRange` | | 定义 在选中范围中 的视觉颜色。 |
| `outOfRange` | | 定义 在选中范围外 的视觉颜色。 |
| `pieces` | | 分段式每一段的相关配置。 |