mirror of
https://github.com/XCharts-Team/XCharts.git
synced 2026-05-20 15:30:09 +00:00
update doc
This commit is contained in:
monitor1394
@@ -37,7 +37,8 @@ slug: /faq
|
||||
[FAQ 30：导入或更新XCharts时TMP报错如何处理？](#导入或更新xcharts时tmp报错怎么办)
|
||||
[FAQ 31：支持空数据吗？如何实现折线图断开的效果?](#支持空数据吗如何实现折线图断开的效果)
|
||||
[FAQ 32：2.x版本升级3.x版本时常见的问题有哪些？](#xcharts2升级xcharts3时常见的问题有哪些)
|
||||
[FAQ 33：折线图如何两边不留空白而从0坐标开始显示？](#折线图如何两边不留空白而从0坐标开始显示)
|
||||
[FAQ 33：折线图如何两边不留空白而从0坐标开始显示？](#折线图如何两边不留空白而从0坐标开始显示)
|
||||
[FAQ 34：如何设置部分Serie不显示Tooltip？](#如何设置部分serie不显示tooltip)
|
||||
|
||||
## 如何调整坐标轴与背景的边距
|
||||
|
||||
@@ -180,3 +181,7 @@ XCharts默认时不开启TMP，所以asmdef上没有TMP的引用。当本地开
|
||||
## 折线图如何两边不留空白而从0坐标开始显示
|
||||
|
||||
设置X轴的`boundaryGap`参数。
|
||||
|
||||
## 如何设置部分serie不显示tooltip
|
||||
|
||||
`serie`的`itemStyle`的`itemFormatter`设置为`-`可以忽略`tooltip`。
|
||||
|
||||
88
README.md
88
README.md
@@ -85,6 +85,38 @@
|
||||
|
||||
|
||||
|
||||
## 仓库
|
||||
|
||||
| 相关仓库 | 仓库介绍 |
|
||||
| -- | --|
|
||||
| [XCharts](https://github.com/XCharts-Team/XCharts) | XCharts核心功能，完全免费。 |
|
||||
| [XCharts-Daemon](https://github.com/XCharts-Team/XCharts-Daemon) | XCharts的守护程序，用于确保XCharts更新时的编译正常。非必须，但建议使用。 |
|
||||
| [XCharts-Demo](https://github.com/XCharts-Team/XCharts-Demo) | XCharts的官方示例，不包含扩展图表部分。订阅VIP的用户购买扩展图表后，可加入对应图表的示例。 |
|
||||
| [XCharts-Pro](https://github.com/XCharts-Team/XCharts-Pro) | XCharts完全版，包含所有扩展图表和扩展组件。订阅SVIP后可访问使用。 |
|
||||
| [XCharts-Pro-Demo](https://github.com/XCharts-Team/XCharts-Pro-Demo) | XCharts完全版官方示例，包含所有扩展图表和扩展组件的示例。订阅SVIP后可访问使用。 |
|
||||
| [XCharts-UI](https://github.com/XCharts-Team/XCharts-UI) | XCharts的扩展UI组件。订阅VIP后可访问使用。 |
|
||||
| [XCharts-Bar3DChart](https://github.com/XCharts-Team/XCharts-Bar3DChart) | XCharts扩展图表：3D柱图。订阅购买后可访问使用。 |
|
||||
| [XCharts-FunnelChart](https://github.com/XCharts-Team/XCharts-FunnelChart) | XCharts扩展图表：漏斗图。订阅购买后可访问使用。 |
|
||||
| [XCharts-GanttChart](https://github.com/XCharts-Team/XCharts-GanttChart) | XCharts扩展图表：甘特图。订阅购买后可访问使用。 |
|
||||
| [XCharts-GaugeChart](https://github.com/XCharts-Team/XCharts-GaugeChart) | XCharts扩展图表：仪表盘。订阅购买后可访问使用。 |
|
||||
| [XCharts-LiquidChart](https://github.com/XCharts-Team/XCharts-LiquidChart) | XCharts扩展图表：水位图。订阅购买后可访问使用。 |
|
||||
| [XCharts-PictorialBarChart](https://github.com/XCharts-Team/XCharts-PictorialBarChart) | XCharts扩展图表：象形住图。订阅购买后可访问使用。 |
|
||||
| [XCharts-Pie3DChart](https://github.com/XCharts-Team/XCharts-Pie3DChart) | XCharts扩展图表：3D饼图。订阅购买后可访问使用。 |
|
||||
| [XCharts-PyramidChart](https://github.com/XCharts-Team/XCharts-PyramidChart) | XCharts扩展图表：3D金字塔。订阅购买后可访问使用。 |
|
||||
| [XCharts-TreemapChart](https://github.com/XCharts-Team/XCharts-TreemapChart) | XCharts扩展图表：矩形树图。订阅购买后可访问使用。 |
|
||||
| [XCharts-SankeyChart](https://github.com/XCharts-Team/XCharts-SankeyChart) | XCharts扩展图表：桑基图。订阅购买后可访问使用。 |
|
||||
|
||||
## 分支
|
||||
|
||||
| 分支 | 分支介绍|
|
||||
|--|--|
|
||||
| `master` | XCharts3.0的开发分支。最新的修改和新功能都先提交到`master`分支，一定时间后再从`master`分支`merge`到`3.0`分支，并发布`release`版本。|
|
||||
| `3.0` | XCharts3.0的稳定分支。一般一个月一发布，`master`分支稳定后，`merge`到`3.0`分支，并发布`release`版本。|
|
||||
| `2.0` | XCharts2.0的稳定分支。带Demo，目前基本不再维护，仅修改严重bug。|
|
||||
| `2.0-upm` | XCharts2.0的稳定UMP分支。不带Demo，只包含Package部分，不再维护。|
|
||||
| `1.0` | XCharts1.0的稳定分支。带Demo，不再维护。|
|
||||
| `1.0-upm` | XCharts1.0的稳定UMP分支。不带Demo，不再维护。|
|
||||
|
||||
## 注意
|
||||
|
||||
- `XCharts3.0` 不完全兼容 `XCharts2.0` 版本，升级`3.0`时，部分代码和配置可能需要重新调整。建议旧项目可以继续使用`XCharts2.0`，新项目推荐使用`XCharts3.0`。
|
||||
@@ -92,51 +124,15 @@
|
||||
- `XCharts` 理论上支持`Unity 5.6`及以上版本，但由于版本测试有限难免疏漏，发现版本兼容问题可提`Issue`。
|
||||
- 本仓库只包含`XCharts`源码，不包含`Demo`示例部分。需要查看`Demo`示例源码请到[XCharts-Demo](https://github.com/XCharts-Team/XCharts-Demo)仓库。也可以在浏览器查看`WebGL`下的运行效果 [在线Demo](https://xcharts-team.github.io/examples/) 。
|
||||
|
||||
## 仓库
|
||||
|
||||
- [XCharts](https://github.com/XCharts-Team/XCharts)：XCharts核心功能，完全免费。
|
||||
- [XCharts-Daemon](https://github.com/XCharts-Team/XCharts-Daemon)：XCharts的守护程序，用于确保XCharts更新时的编译正常。非必须，但建议使用。
|
||||
- [XCharts-Demo](https://github.com/XCharts-Team/XCharts-Demo)：XCharts的官方示例，不包含扩展图表部分。订阅VIP的用户购买扩展图表后，可加入对应图表的示例。
|
||||
- [XCharts-Pro](https://github.com/XCharts-Team/XCharts-Pro)：XCharts完全版，包含所有扩展图表和扩展组件。订阅SVIP可访问。
|
||||
- [XCharts-Pro-Demo](https://github.com/XCharts-Team/XCharts-Pro-Demo)：XCharts完全版官方示例，包含所有扩展图表和扩展组件的示例。订阅SVIP可访问。
|
||||
- [XCharts-UI](https://github.com/XCharts-Team/XCharts-UI)：XCharts的扩展UI组件。订阅VIP可访问。
|
||||
- [XCharts-Bar3DChart](https://github.com/XCharts-Team/XCharts-Bar3DChart)：XCharts扩展图表：3D柱图。订阅VIP后可单独购买。
|
||||
- [XCharts-FunnelChart](https://github.com/XCharts-Team/XCharts-FunnelChart)：XCharts扩展图表：漏斗图。订阅VIP后可单独购买。
|
||||
- [XCharts-GanttChart](https://github.com/XCharts-Team/XCharts-GanttChart)：XCharts扩展图表：甘特图。订阅VIP后可单独购买。
|
||||
- [XCharts-GaugeChart](https://github.com/XCharts-Team/XCharts-GaugeChart)：XCharts扩展图表：仪表盘。订阅VIP后可单独购买。
|
||||
- [XCharts-LiquidChart](https://github.com/XCharts-Team/XCharts-LiquidChart)：XCharts扩展图表：水位图。订阅VIP后可单独购买。
|
||||
- [XCharts-PictorialBarChart](https://github.com/XCharts-Team/XCharts-PictorialBarChart)：XCharts扩展图表：象形住图。订阅VIP后可单独购买。
|
||||
- [XCharts-Pie3DChart](https://github.com/XCharts-Team/XCharts-Pie3DChart)：XCharts扩展图表：3D饼图。订阅VIP后可单独购买。
|
||||
- [XCharts-PyramidChart](https://github.com/XCharts-Team/XCharts-PyramidChart)：XCharts扩展图表：3D金字塔。订阅VIP后可单独购买。
|
||||
- [XCharts-TreemapChart](https://github.com/XCharts-Team/XCharts-TreemapChart)：XCharts扩展图表：矩形树图。订阅VIP后可单独购买。
|
||||
- [XCharts-Bar3DChart-Demo](https://github.com/XCharts-Team/XCharts-Bar3DChart-Demo)：3D柱图的示例。订阅VIP可访问，可导入XCharts-Demo使用。
|
||||
- [XCharts-FunnelChart-Demo](https://github.com/XCharts-Team/XCharts-FunnelChart-Demo)：漏斗图的示例。订阅VIP可访问，可导入XCharts-Demo使用。
|
||||
- [XCharts-GanttChart-Demo](https://github.com/XCharts-Team/XCharts-GanttChart-Demo)：甘特图的示例。订阅VIP可访问，可导入XCharts-Demo使用。
|
||||
- [XCharts-GaugeChart-Demo](https://github.com/XCharts-Team/XCharts-GaugeChart-Demo)：仪表盘的示例。订阅VIP可访问，可导入XCharts-Demo使用。
|
||||
- [XCharts-LiquidChart-Demo](https://github.com/XCharts-Team/XCharts-LiquidChart-Demo)：水位图的示例。订阅VIP可访问，可导入XCharts-Demo使用。
|
||||
- [XCharts-PictorialBarChart-Demo](https://github.com/XCharts-Team/XCharts-PictorialBarChart-Demo)：象形住图的示例。订阅VIP可访问，可导入XCharts-Demo使用。
|
||||
- [XCharts-Pie3DChart-Demo](https://github.com/XCharts-Team/XCharts-Pie3DChart-Demo)：3D饼图的示例。订阅VIP可访问，可导入XCharts-Demo使用。
|
||||
- [XCharts-PyramidChart-Demo](https://github.com/XCharts-Team/XCharts-PyramidChart-Demo)：3D金字塔的示例。订阅VIP可访问，可导入XCharts-Demo使用。
|
||||
- [XCharts-TreemapChart-Demo](https://github.com/XCharts-Team/XCharts-TreemapChart-Demo)：矩形树图的示例。订阅VIP可访问，可导入XCharts-Demo使用。
|
||||
|
||||
## 使用
|
||||
|
||||
- 导入`XCharts`的`unitypackage`或者源码到项目。建议也导入`XCharts`守护程序[XCharts-Daemon](https://github.com/XCharts-Team/XCharts-Daemon)。
|
||||
- 导入`XCharts`的`unitypackage`或者源码到项目。建议也导入`XCharts`守护程序 [XCharts-Daemon](https://github.com/XCharts-Team/XCharts-Daemon)。
|
||||
- 在`Hierarchy`视图下右键选择`XCharts->LineChart`，即可创建一个默认的折线图。
|
||||
- 用`Inspector`视图下的`Add Serie`和`Add Main Component`按钮可以添加`Serie`和`组件`。
|
||||
- 在`Inspector`视图可以调整各个组件的参数，`Game`视图可看到实时效果。
|
||||
- 更多细节，请看[【XCharts教程：5分钟上手教程】](Documentation~/zh/tutorial01.md)
|
||||
- 在`Inspector`视图下可以调整各个组件的参数，`Game`视图可看到实时效果。
|
||||
- 更多细节，请看[【XCharts教程：5分钟上手教程】](Documentation~/zh/tutorial01.md)。
|
||||
- 首次使用，建议先认真看一遍教程。
|
||||
|
||||
## 分支
|
||||
|
||||
- `master`：开发分支。最新的修改和新功能都先提交到`master`分支，一段时间后再从`master`分支`merge`到`3.0`分支，并发布`release`版本。
|
||||
- `3.0`：XCharts 3.0的稳定分支。一般一个月一更新，从`master`分支`merge`最新改动过来，并发布`release`版本。
|
||||
- `2.0`：XCharts 2.0的稳定分支。带Demo，目前基本不再维护，仅修改严重bug。
|
||||
- `2.0-upm`：XCharts 2.0的稳定UMP分支。不带Demo，只包含Package部分，专门给UMP用，不再维护。
|
||||
- `1.0`：XCharts 1.0的稳定分支。带Demo，不再维护。
|
||||
- `1.0-upm`：XCharts 1.0的稳定UMP分支。不带Demo，不再维护。
|
||||
|
||||
## FAQ
|
||||
|
||||
- `XCharts`可以免费使用吗？
|
||||
@@ -152,25 +148,25 @@
|
||||
答：`XCharts`是基于`UGUI`实现的，所以`UGUI`中碰到的问题，在`XCharts`中也会存在。比如锯齿问题，比如`Mesh`顶点数超`65535`的问题。这两个问题的解决可参考[问答16](Documentation~/zh/faq.md)和[问答27](Documentation~/zh/faq.md)。
|
||||
由于`Mesh`的`65535`顶点数的限制，目前`XCharts`的单条`Line`支持约`2万`的数据量，当然开启采样可以支持更多数据的绘制，但同时也会更消耗CPU。
|
||||
|
||||
## 日志
|
||||
|
||||
- [更新日志](Documentation~/zh/changelog.md)
|
||||
|
||||
## Licenses
|
||||
|
||||
- [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`
|
||||
- QQ群：XCharts交流群（`202030963`）
|
||||
- VIP群：XCharts VIP群（`867291970`）
|
||||
- 捐助、合作、订阅和技术支持：[☞ 看这里](Documentation~/zh/support.md)
|
||||
- 捐助、合作、订阅和技术支持：[☞ 请看这里](Documentation~/zh/support.md)
|
||||
|
||||
Reference in New Issue
Block a user