From 3aa6daf97c08b1a4d10f83afa2c0bd21ff8d1a27 Mon Sep 17 00:00:00 2001 From: monitor1394 Date: Wed, 16 Aug 2023 08:23:56 +0800 Subject: [PATCH] update doc --- Documentation~/zh/changelog.md | 2 ++ Documentation~/zh/faq.md | 43 +++++++++++++++++---------------- Documentation~/zh/tutorial01.md | 6 +++++ 3 files changed, 30 insertions(+), 21 deletions(-) diff --git a/Documentation~/zh/changelog.md b/Documentation~/zh/changelog.md index ee84a156..cdb39b30 100644 --- a/Documentation~/zh/changelog.md +++ b/Documentation~/zh/changelog.md @@ -78,6 +78,8 @@ slug: /changelog 日志详情： +* (2023.08.16) 增加`Daemon`守护程序，解决本地开启TMP后更新版本报错问题 +* (2023.08.15) 修复`Data`数据在-1到1之间时坐标轴显示错误的问题 (#273) (by __Ambitroc__) * (2023.08.14) 修复`XCharts`本地开启`TextMeshPro`和 `NewInputSystem`后更新版本会报错的问题 (#272) * (2023.08.12) 修复`Chart`在运行时被删除时会异常报错的问题 (#269) * (2023.08.11) 修复`DataZoom`开启时可能会导致无法添加数据的问题 diff --git a/Documentation~/zh/faq.md b/Documentation~/zh/faq.md index 51054ce8..98b42f71 100644 --- a/Documentation~/zh/faq.md +++ b/Documentation~/zh/faq.md @@ -7,49 +7,49 @@ slug: /faq [QA 1：如何调整坐标轴与背景的边距？](#如何调整坐标轴与背景的边距) [QA 2：如何让初始动画重新播放？](#如何让初始动画重新播放) -[QA 3：如何自定义折线图、饼图等数据项的颜色？](#如何自定义折线图_饼图等数据项的颜色) -[QA 4：如何格式化文字，如我想给坐标轴标签加上单位？](#如何格式化文字_如我想给坐标轴标签加上单位) +[QA 3：如何自定义折线图饼图的颜色？](#如何自定义折线图饼图的颜色) +[QA 4：如何给坐标轴上的文本加上单位？](#如何给坐标轴上的文本加上单位) [QA 5：如何让柱形图的柱子堆叠显示？](#如何让柱形图的柱子堆叠显示) [QA 6：如何让柱形图的柱子同柱但不重叠？](#如何让柱形图的柱子同柱但不重叠) [QA 7：如何调整柱形图的柱子宽度和间距？](#如何调整柱形图的柱子宽度和间距) [QA 8：如何调整柱形图单个柱子的颜色？](#如何调整柱形图单个柱子的颜色) [QA 9：如何调整图表的对齐方式？](#如何调整图表的对齐方式) [QA 10：可以显示超过1000以上的大数据吗？](#可以显示超过1000以上的大数据吗) -[QA 11：折线图可以画虚线、点线、点划线吗？](#折线图可以画虚线_点线_点划线吗) -[QA 12：如何限定Y轴（Value轴）的值范围？](#如何限定Y轴的值范围) +[QA 11：折线图可以画虚线、点线、点划线吗？](#折线图可以画虚线点线点划线吗) +[QA 12：如何限定Y轴的值范围？](#如何限定Y轴的值范围) [QA 13：如何自定义数值轴刻度大小？](#如何自定义数值轴刻度大小) [QA 14：如何在数据项顶上显示文本？](#如何在数据项顶上显示文本) [QA 15：如何给数据项自定义图标？](#如何给数据项自定义图标) -[QA 16：锯齿太严重，如何让图表更顺滑？](#锯齿太严重_如何让图表更顺滑) +[QA 16：锯齿太严重，如何让图表更顺滑？](#锯齿太严重如何让图表更顺滑) [QA 17：为什么鼠标移上图表 Tooltip 不显示？](#为什么鼠标移上图表Tooltip不显示) [QA 18：如何取消 Tooltip 的竖线？](#如何取消Tooltip的竖线) [QA 19：如何自定义 Tooltip 的显示内容？](#如何自定义Tooltip的显示内容) -[QA 20：如何让Y轴（数值轴）显示多位小数？](#如何让Y轴显示多位小数) +[QA 20：如何让Y轴显示多位小数？](#如何让Y轴显示多位小数) [QA 21：如何用代码动态更新数据？](#如何用代码动态更新数据) -[QA 22：如何显示图例？为什么有时候图例无法显示？](#如何显示图例_为什么有时候图例无法显示) +[QA 22：如何显示图例？为什么有时候图例无法显示？](#如何显示图例为什么有时候图例无法显示) [QA 23：如何做成预设？](#如何做成预设) [QA 24：如何在图表上画点画线等自定义内容？](#如何在图表上画点画线等自定义内容) [QA 25：如何实现心电图类似的数据移动效果？](#如何实现心电图类似的数据移动效果) -[QA 26：如何使用背景组件？有什么条件限制？](#如何使用背景组件_有什么条件限制) +[QA 26：如何使用背景组件？有什么条件限制？](#如何使用背景组件有什么条件限制) [QA 27：Mesh can not have more than 65000 vertices?](#Mesh_cannot_have_more_than_65000_vertices) [QA 28：为什么serie里设置的参数运行后又被重置了?](#为什么serie里设置的参数运行后又被重置了) [QA 29：如何修改Serie的Symbol的颜色?](#如何修改Serie的Symbol的颜色) -[QA 30：导入或更新XCharts时TMP报错怎么办?](#导入或更新XCharts时TMP报错怎么办) -[QA 31：支持空数据吗？如何实现折线图断开的效果?](#支持空数据吗_如何实现折线图断开的效果) +[QA 30：导入或更新XCharts时TMP报错如何处理?](#导入或更新XCharts时TMP报错怎么办) +[QA 31：支持空数据吗？如何实现折线图断开的效果?](#支持空数据吗如何实现折线图断开的效果) ## 如何调整坐标轴与背景的边距 -答：`Grid`组件，可调整上下左右边距。 +答：调整`Grid`组件，可调整上下左右边距。 ## 如何让初始动画重新播放 -答：调用`AnimationReset()`接口。 +答：调用`chart.AnimationReset()`接口。 -## 如何自定义折线图_饼图等数据项的颜色 +## 如何自定义折线图饼图的颜色 答：通过`Theme`的`colorPalette`调整，或者部分`Serie`下的`LineStyle`和`ItemStyle`。 -## 如何格式化文字_如我想给坐标轴标签加上单位 +## 如何给坐标轴上的文本加上单位 答：通过`formatter`和`numericFormatter`参数，在`Legend`、`Axis`的`AxisLabel`、`Tooltop`、`Serie`的`Label`都提供该参数的配置。 @@ -77,7 +77,7 @@ slug: /faq 答：可以。但`UGUI`对单个`Graphic`限制`65000`个顶点，所以太多的数据不一定能显示完全。可通过设置采样距离`sampleDist`开启采样简化过密曲线。也可以通过设置一些参数来减少图表的顶点数有助于显示更多数据。如缩小图表的尺寸，关闭或减少坐标轴的客户端绘制，关闭`Serie`的`symbol`和`label`显示等。折线图的普通线图`Normal`比平滑线图`Smooth`占用顶点数更少。`1.5.0`以上版本可以设置`large`和`largeThreshold`参数来开启性能模式。 -## 折线图可以画虚线_点线_点划线吗 +## 折线图可以画虚线点线点划线吗 答：可以。通过`Serie`下的`lineType`选择线条样式。当要显示的数据过多（成千以上）数据间过密时建议使用`Normal`或者`Step`样式。 @@ -97,7 +97,7 @@ slug: /faq 答：通过设置`Serie`的`data`下的数据项可单独设置`icon`相关参数。 -## 锯齿太严重_如何让图表更顺滑 +## 锯齿太严重如何让图表更顺滑 答：开启抗锯齿设置（在`Unity`里设置）。调整UI渲染模式为`Camera`模式，开启`MSAA`，设置`4`倍或更高抗锯齿。 @@ -111,7 +111,7 @@ slug: /faq ## 如何自定义Tooltip的显示内容 -答：自定义总的内容可以通过`Tooltip`的`formatter`。如果只是想调整所有的`serie`的显示格式可以用`itemFormatter`和`titleFormatter`结合。如果想每个`serie`的显示格式不一样，可以定制`serie`的`itemStyle`里的`tooltipFormatter`。具体的用法请查阅[XCharts配置项手册](configuration.md)。 +答：自定义总的内容可以通过`Tooltip`的`formatter`。如果只是想调整所有的`serie`的显示格式可以用`itemFormatter`和`titleFormatter`结合。如果想每个`serie`的显示格式不一样，可以定制`serie`的`itemStyle`里的`tooltipFormatter`。具体的用法请查阅[XCharts配置项手册](https://xcharts-team.github.io/docs/configuration#Tooltip-itemFormatter)。 ## 如何让Y轴显示多位小数 @@ -121,7 +121,7 @@ slug: /faq 答：请查阅`Example`下的代码，`Example13_LineSimple.cs`就是一个简单添加数据构建折线图的例子，其他`Demo`也都是通过代码控制不同的组件实现不同的功能，相关API请查看文档：[XChartsAPI接口](api.md) 。 -## 如何显示图例_为什么有时候图例无法显示 +## 如何显示图例为什么有时候图例无法显示 答：首先，你的`serie`里的`name`需有值不为空。然后开启`Legend`显示，里面的`data`可以默认为空，表示显示所有的图例。如果你只想显示部分`serie`的图例，在`data`中填入要显示的图例的`name`即可。如果`data`中的值都不是系列的`name`，那图例就不会显示。 @@ -137,7 +137,7 @@ slug: /faq 答：参考`Example`目录下的`Example_Dynamic.cs`。主要通过设置`maxCache`参数实现。`axis`和`serie`都设置相同的`maxCache`。`maxCache`可固定数据个数，当数据超过设定时会先删除第一个在添加新数据，实现数据移动效果。 -## 如何使用背景组件_有什么条件限制 +## 如何使用背景组件有什么条件限制 答：设置`background`组件的`show`为`true`。 @@ -164,7 +164,8 @@ slug: /faq 1. 找到`XCharts.Runtime.asmdef`和`XCharts.Editor.asmdef`，手动加上 `TextMeshPro`的引用 2. 移除`PlayerSetting`中`Scripting Define Symbols`的`dUI_TextMeshPro`宏 -## 支持空数据吗_如何实现折线图断开的效果 +`3.8.0`版本后增加[XCharts-Daemon](https://github.com/XCharts-Team/XCharts-Daemon)守护程序，将XCharts-Daemon导入项目后，在更新XCharts时守护程序会自动根据本地开启的TMP情况刷新asmdef，确保编译正常。 + +## 支持空数据吗如何实现折线图断开的效果 答：`Serie`的`data`是`double`类型，所以无法表示空数据。可通过开启`Serie`的`ignore`和指定`ignoreValue`来达到空数据的效果。也可以每个`SerieData`设置`ignore`参数。忽略数据后断开还是连接可设置`ignoreLineBreak`参数。 - diff --git a/Documentation~/zh/tutorial01.md b/Documentation~/zh/tutorial01.md index 2d0732d8..46a74d05 100644 --- a/Documentation~/zh/tutorial01.md +++ b/Documentation~/zh/tutorial01.md @@ -38,6 +38,10 @@ XCharts可通过以下任意一种方式导入到项目： 如需更新`XCharts`，删除`manifest.json`文件（部分Unity版本可能是packages-lock.json文件）的`lock`下的`com.monitor1394.xcharts`相关内容即会重新下载编译。 +- 建议先导入XCharts的守护程序（非必须） + + 守护程序[XCharts-Daemon](https://github.com/XCharts-Team/XCharts-Daemon)可以确保更新时编译正常，当本地开启TextMeshPro或NewInputSystem时将会非常有用。将XCharts-Daemon导入项目后，在更新XCharts时守护程序会自动根据本地TMP等的开启情况刷新asmdef，确保编译正常，不用手动去解决，方便CI-CD等自动化流程执行。 + ## 添加一个简单图表 在`Hierarchy`视图下右键或菜单栏`GameObject`下拉选择`XCharts->LineChart`，即可快速创建一个默认的折线图出来： @@ -200,6 +204,8 @@ XCharts支持TextMeshPro，但默认是不开启的，需要自己手动切换 1. 找到`XCharts.Runtime.asmdef`和`XCharts.Editor.asmdef`，手动加上 `TextMeshPro`的引用 2. 移除`PlayerSetting`中`Scripting Define Symbols`的`dUI_TextMeshPro`宏 +`3.8.0`版本后增加[XCharts-Daemon](https://github.com/XCharts-Team/XCharts-Daemon)守护程序，将XCharts-Daemon导入项目后，在更新XCharts时守护程序会自动根据本地开启的TMP情况刷新asmdef，确保编译正常。 + ## 用代码改图表参数 `Inspector`上看到的所有参数都可以用代码来修改，关键是要定位好你要改的参数是在组件上、还是Serie上、还是在具体的数据项SerieData上。