README.md 12 KB
XCharts
A powerful, easy-to-use, configurable charting and data visualization library for Unity.
Unity数据可视化图表插件。
English README
一款基于UGUI的功能强大、简单易用的数据可视化图表插件。支持折线图、柱状图、饼图、雷达图、散点图、热力图、环形图、K线图、极坐标、平行坐标等十多种内置图表，以及3D饼图、3D柱图、3D金字塔、漏斗图、仪表盘、水位图、象形柱图、甘特图、矩形树图、桑基图等多种扩展图表。
XCharts 教程：5分钟上手 XCharts
XCharts API文档
XCharts 常见问题
XCharts 配置项手册
XCharts 更新日志
XCharts 订阅服务
特性
- 纯代码绘制：图表纯代码绘制，无需额外的贴图和Shader资源。
- 可视化配置：参数可视化配置，效果实时预览，支持运行时代码动态修改配置和数据。
- 高自由定制：支持从主题和配置参数上任意调整；支持代码自定义绘制，自定义回调以及自定义实现图表。
- 多内置图表：支持线图、柱状图、饼图、雷达图、散点图、热力图、环形图、K线图、极坐标、平行坐标等多种内置图表。
- 多扩展图表：支持3D柱图、3D饼图、漏斗图、金字塔、仪表盘、水位图、象形柱图、甘特图、矩形树图、桑基图等多种扩展图表。
- 多扩展组件：支持表格、统计数值等多种扩展UI组件。
- 多图表组合：支持内置图表的任意组合，同一图中可同时显示多个相同或不同类型的图表。
- 多种坐标系：支持直角坐标系、极坐标系、单轴等多种坐标系。
- 丰富的组件：支持标题、图例、提示框、标线、标域、数据区域缩放、视觉映射等常用组件。
- 多样式线图：支持直线图、曲线图、虚线图、面积图、阶梯线图等多种线图。
- 多样式柱图：支持并列柱图、堆叠柱图、堆积百分比柱图、斑马柱图、胶囊柱图等多种柱状图。
- 多样式饼图：支持环形图、玫瑰图、环形玫瑰图等多种饼图。
- 丰富的线条：支持实线、曲线、阶梯线、虚线、点线、点划线、双点划线等线条。
- 自定义绘制：支持自定义图表内容绘制，提供绘制点、线、面等其他图形的强大的绘图API。
- 大数据绘制：支持万级大数据量绘制；支持采样绘制；特殊的简化图表支持更优的性能。
- 自定义主题：支持主题定制、导入和导出，内置明暗两种默认主题。
- 动画和交互：支持渐入动画、渐出动画、变更动画、新增动画、交互动画等多种动画；支持多平台的数据筛选、视图缩放、细节展示等交互操作。
- 第三方扩展：支持无缝接入
TexMeshPro和New Input System。 - 版本和兼容：支持所有
5.6以上的Unity版本；支持全平台运行。
截图
仓库
| 相关仓库 | 仓库介绍 | | -- | --| | XCharts | XCharts核心功能，完全免费。 | | XCharts-Daemon | XCharts的守护程序，用于确保XCharts更新时的编译正常。非必须，但建议使用。 | | XCharts-Demo | XCharts的官方示例，不包含扩展图表部分。订阅VIP的用户购买扩展图表后，可加入对应图表的示例。 | | XCharts-Pro | XCharts完全版，包含所有扩展图表和扩展组件。订阅SVIP后可访问使用。 | | XCharts-Pro-Demo | XCharts完全版官方示例，包含所有扩展图表和扩展组件的示例。订阅SVIP后可访问使用。 | | XCharts-UI | XCharts的扩展UI组件。订阅VIP后可访问使用。 | | XCharts-Bar3DChart | XCharts扩展图表：3D柱图。订阅购买后可访问使用。 | | XCharts-FunnelChart | XCharts扩展图表：漏斗图。订阅购买后可访问使用。 | | XCharts-GanttChart | XCharts扩展图表：甘特图。订阅购买后可访问使用。 | | XCharts-GaugeChart | XCharts扩展图表：仪表盘。订阅购买后可访问使用。 | | XCharts-LiquidChart | XCharts扩展图表：水位图。订阅购买后可访问使用。 | | XCharts-PictorialBarChart | XCharts扩展图表：象形住图。订阅购买后可访问使用。 | | XCharts-Pie3DChart | XCharts扩展图表：3D饼图。订阅购买后可访问使用。 | | XCharts-PyramidChart | XCharts扩展图表：3D金字塔。订阅购买后可访问使用。 | | XCharts-TreemapChart | XCharts扩展图表：矩形树图。订阅购买后可访问使用。 | | 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。XCharts2.0进入维护阶段，后续只修复严重bug，原则上不再加新功能。XCharts理论上支持Unity 5.6及以上版本，但由于版本测试有限难免疏漏，发现问题可提Issue。- 本仓库只包含
XCharts源码，不包含Demo示例部分。需要查看Demo示例源码请到XCharts-Demo仓库。也可以在浏览器查看WebGL下的运行效果 在线Demo 。
使用
- 导入
XCharts的unitypackage或者源码到项目。建议也导入XCharts守护程序 XCharts-Daemon。 - 在
Hierarchy视图下右键选择XCharts->LineChart，即可创建一个默认的折线图。 - 用
Inspector视图下的Add Serie和Add Main Component按钮可以添加Serie和组件。 - 在
Inspector视图下可以调整各个组件的参数，Game视图可看到实时效果。 - 更多细节，请看【XCharts教程：5分钟上手教程】。
- 首次使用，建议先认真看一遍教程。
FAQ
XCharts可以免费使用吗？
答：XCharts使用MIT协议，可以免费使用。也可以订阅VIP享受更多增值服务。XCharts支持代码动态添加和修改数据吗？支持从Excel或数据库中获取数据吗？
答：XCharts提供了各种数据操作的接口，支持代码动态修改配置，添加和修改数据，但数据来源需要自己解析和获取，再调用XCharts的接口添加到图表。XCharts除了用在Unity平台，还能用在Winform或WPF等平台吗？
答：XCharts只支持在Unity平台使用。理论上任何支持UGUI的Unity版本都能运行XCharts。锯齿怎么解决？支持多大量级的数据？
答：XCharts是基于UGUI实现的，所以UGUI中碰到的问题，在XCharts中也会存在。比如锯齿问题，比如Mesh顶点数超65535的问题。这两个问题的解决可参考问答16和问答27。
由于Mesh的65535顶点数的限制，目前XCharts的单条Line支持约2万的数据量，当然开启采样可以支持更多数据的绘制，但同时也会更消耗CPU。
日志
Licenses
- MIT License
- 可免费商用，可二次开发。
- 扩展图表和高级功能部分需购买使用授权。
订阅
XCharts核心库是开源的，可免费使用的。在此基础上，我们也提供多种订阅服务以满足不同用户的需求，订阅详情☞ 请看这里。- 订阅不是必须的，不影响
XCharts的核心功能使用。 - 订阅是按年付费，订阅到期后，不要求必须续订，但中断订阅期间无法享受技术更新和支持等服务。
其他
- 邮箱：
monitor1394@gmail.com - QQ群：XCharts交流群（
202030963） - VIP群：XCharts VIP群（
867291970） - 捐助、合作、订阅和技术支持：☞ 请看这里