From 9fab42a9e7c50452e3698b6ee928b8c471413b27 Mon Sep 17 00:00:00 2001 From: monitor1394 Date: Mon, 21 Aug 2023 23:16:05 +0800 Subject: [PATCH] update readme --- README.md | 86 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 46 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 15f9b36e..204076f5 100644 --- a/README.md +++ b/README.md @@ -45,33 +45,38 @@ 一款基于`UGUI`的功能强大、简单易用的数据可视化图表插件。支持`折线图`、`柱状图`、`饼图`、`雷达图`、`散点图`、`热力图`、`环形图`、`K线图`、`极坐标`、`平行坐标`等十多种内置图表，以及`3D饼图`、`3D柱图`、`3D金字塔`、`漏斗图`、`仪表盘`、`水位图`、`象形柱图`、`甘特图`、`矩形树图`等扩展图表。 -[XCharts3.0 官方主页](https://xcharts-team.github.io) -[XCharts3.0 在线示例](https://xcharts-team.github.io/examples) +[XCharts 官方主页](https://xcharts-team.github.io) +[XCharts 在线示例](https://xcharts-team.github.io/examples) -[XCharts3.0 教程：5分钟上手 XCharts](Documentation~/zh/tutorial01.md) -[XCharts3.0 API](Documentation~/zh/api.md) -[XCharts3.0 问答](Documentation~/zh/faq.md) -[XCharts3.0 配置项手册](Documentation~/zh/configuration.md) -[XCharts3.0 更新日志](Documentation~/zh/changelog.md) -[XCharts3.0 订阅服务](Documentation~/zh/support.md) +[XCharts 教程：5分钟上手 XCharts](Documentation~/zh/tutorial01.md) +[XCharts API文档](Documentation~/zh/api.md) +[XCharts 问答](Documentation~/zh/faq.md) +[XCharts 配置项手册](Documentation~/zh/configuration.md) +[XCharts 更新日志](Documentation~/zh/changelog.md) +[XCharts 订阅服务](Documentation~/zh/support.md) ## 特性 -- 参数可视化配置，效果实时预览，纯代码绘制，无需额外资源。 -- 支持折线图、柱状图、饼图、雷达图、散点图、热力图、环形图、K线图、极坐标、平行坐标等十种内置图表。 -- 支持3D柱图、漏斗图、金字塔、仪表盘、水位图、象形柱图、甘特图、矩形树图等多种扩展图表。 -- 支持直线图、曲线图、面积图、阶梯线图等折线图。 -- 支持并列柱图、堆叠柱图、堆积百分比柱图、斑马柱图等柱状图。 -- 支持环形图、玫瑰图等饼图。 -- 支持内置图表的任意组合，同一图中可同时显示多个相同或不同类型的图表。 -- 支持实线、曲线、阶梯线、虚线、点线、点划线、双点划线等线条。 -- 支持主题定制、导入和导出，内置明暗两种默认主题。 -- 支持自定义图表内容绘制，提供绘制点、线、面等其他图形的强大的绘图API。 -- 支持PC端和手机端上的数据筛选、视图缩放、细节展示等交互操作。 -- 支持万级大数据量绘制，支持采样绘制。 -- 支持`TexMeshPro`。 -- 支持所有`5.6`以上的`Unity`版本。 -- 支持 Input System （[如何从 Input Manager 转 Input System](https://xcharts-team.github.io/docs/inputsystem)）。 +- __纯代码绘制__：图表完全纯代码绘制，无需额外的贴图和Shader资源。 +- __可视化配置__：参数可视化配置，效果实时预览，也支持运行时代码动态修改配置和数据。 +- __高自由定制__：支持从主题和配置参数上任意调整；支持代码自定义绘制，自定义回调以及自定义实现图表。 +- __多内置图表__：支持线图、状图、饼图、雷达图、散点图、热力图、环形图、K线图、极坐标、平行坐标等多种内置图表。 +- __多扩展图表__：支持3D柱图、漏斗图、金字塔、仪表盘、水位图、象形柱图、甘特图、矩形树图等多种扩展图表。 +- __多扩展功能__：支持表格、统计数值等扩展UI组件。 +- __多图表组合__：支持内置图表的任意组合，同一图中可同时显示多个相同或不同类型的图表。 +- __多种坐标系__：支持直角坐标系、极坐标系、单轴等多种坐标系。 +- __丰富的组件__：支持标题、图例、提示框、标线、标域、数据区域缩放、视觉映射等常用组件。 +- __丰富的线图__：支持直线图、曲线图、虚线图、面积图、阶梯线图等多种线图。 +- __丰富的柱图__：支持并列柱图、堆叠柱图、堆积百分比柱图、斑马柱图、胶囊柱图等多种柱状图。 +- __丰富的饼图__：支持环形图、玫瑰图、环形玫瑰图等多种饼图。 +- __丰富的线条__：支持实线、曲线、阶梯线、虚线、点线、点划线、双点划线等线条。 +- __自定义绘制__：支持自定义图表内容绘制，提供绘制点、线、面等其他图形的强大的绘图API。 +- __大数据绘制__：支持万级大数据量绘制；支持采样绘制；特殊的简化图表支持更优的性能。 +- __自定义主题__：支持主题定制、导入和导出，内置明暗两种默认主题。 + +- __动画和交互__：支持渐入、渐出、变更、新增、交互等动画；支持多平台的数据筛选、视图缩放、细节展示等交互操作。 +- __第三方扩展__：支持接入`TexMeshPro`和`New Input System`。 +- __版本和兼容__：支持所有`5.6`以上的`Unity`版本；支持全平台运行。 ## 截图 @@ -79,8 +84,6 @@ ![扩展图表](Documentation~/zh/img/readme_extendchart.png) -![XCharts 3.0和2.0的对比](Documentation~/zh/img/readme_xcharts3.png) - ## 注意 - `XCharts3.0` 不完全兼容 `XCharts2.0` 版本，升级`3.0`可能需要调整部分代码，图表部分配置需要重新调整。建议旧项目可以继续使用`XCharts2.0`，新项目推荐使用`XCharts3.0`。 @@ -90,11 +93,11 @@ ## 使用 -1. 导入`XCharts`的`unitypackage`或者源码到项目。 -2. 在`Hierarchy`视图下右键选择`XCharts->LineChart`，即可创建一个默认的折线图。 -3. 在`Inspector`视图可以调整各个组件的参数，`Game`视图可看到实时效果。 +- 导入`XCharts`的`unitypackage`或者源码到项目。 +- 在`Hierarchy`视图下右键选择`XCharts->LineChart`，即可创建一个默认的折线图。 +- 在`Inspector`视图可以调整各个组件的参数，`Game`视图可看到实时效果。 -- 更多细节，请看：[XCharts教程：5分钟上手教程](Documentation~/zh/tutorial01.md) +- 更多细节，请看[【XCharts教程：5分钟上手教程】](Documentation~/zh/tutorial01.md) - 首次使用，建议先认真看一遍教程。 ## 分支 @@ -106,23 +109,18 @@ - `1.0`：XCharts 1.0的稳定分支。带Demo，不再维护。 - `1.0-upm`：XCharts 1.0的稳定UMP分支。不带Demo，不再维护。 -## 扩展 - -- [扩展图表](https://xcharts-team.github.io/docs/extra) 扩展图表订阅`VIP`后再按需购买，订阅详情请查看[☞ 看这里](Documentation~/zh/support.md) -- [扩展组件](https://xcharts-team.github.io/docs/ui) 扩展组件订阅`VIP`后即可免费使用。 - ## FAQ -1. `XCharts`可以免费使用吗？ +- `XCharts`可以免费使用吗？ 答：`XCharts`使用`MIT`协议，可以免费使用。也可以订阅`VIP`享受更多增值服务。 -2. `XCharts`支持代码动态添加和修改数据吗？支持从`Excel`或数据库中获取数据吗？ +- `XCharts`支持代码动态添加和修改数据吗？支持从`Excel`或数据库中获取数据吗？ 答：`XCharts`提供了各种数据操作的接口，支持代码动态修改配置，添加和修改数据，但数据来源需要自己解析和获取，再调用`XCharts`的接口添加到图表。 -3. 这个插件除了用在`Unity`，还能用在其他平台（如`Winform`或`WPF`）吗？ - 答：目前只支持在`Unity`平台使用。理论上任何支持`UGUI`的`Unity`版本都能运行`XCharts`。 +- `XCharts`除了用在`Unity`平台，还能用在`Winform`或`WPF`等平台吗？ + 答：`XCharts`只支持在`Unity`平台使用。理论上任何支持`UGUI`的`Unity`版本都能运行`XCharts`。 -4. 锯齿怎么解决？支持多大量级的数据？ +- 锯齿怎么解决？支持多大量级的数据？ 答：`XCharts`是基于`UGUI`实现的，所以`UGUI`中碰到的问题，在`XCharts`中也会存在。比如锯齿问题，比如`Mesh`顶点数超`65535`的问题。这两个问题的解决可参考[问答16](Documentation~/zh/faq.md)和[问答27](Documentation~/zh/faq.md)。 由于`Mesh`的`65535`顶点数的限制，目前`XCharts`的单条`Line`支持约`2万`的数据量，当然开启采样可以支持更多数据的绘制，但同时也会更消耗CPU。 @@ -130,12 +128,20 @@ - [MIT License](https://github.com/XCharts-Team/XCharts/blob/master/LICENSE.md) - 可免费商用，可二次开发 -- 扩展图表需单独购买授权 +- 扩展图表和高级功能部分需单独购买授权 ## 日志 - [更新日志](Documentation~/zh/changelog.md) +## 订阅 + +- `XCharts`核心库是开源的，可免费使用的。在此基础上，我们也提供多种订阅服务以满足不同用户的需求，订阅详情[☞ 请看这里](Documentation~/zh/support.md) +- 订阅不是必须的，不影响`XCharts`的常用功能使用。 +- 订阅是按年付费制，部分订阅服务的首年费用比次年要高，是因为包含了购买部分源码。次年的费用基本都是服务费。 +- 订阅到期后，不要求必须续订，但中断订阅期间无法享受技术支持等服务。如需继续服务，可从当日继续续订即可。 + + ## 其他 - 邮箱：`monitor1394@gmail.com`