From 12757eb4db442fa6f8c31eed8c39190d44ffe7cb Mon Sep 17 00:00:00 2001 From: monitor1394 Date: Thu, 7 Jul 2022 07:42:53 +0800 Subject: [PATCH] [doc] update doc --- ...CHANGELOG-EN.md.meta => CHANGELOG.md.meta} | 2 +- .../{README-EN.md.meta => README.md.meta} | 2 +- Documentation/XChartsFAQ-ZH.md | 24 +++++- Documentation/res/xcharts3.0.png.meta | 76 +++++++++++++++++++ README.md | 24 +++--- 5 files changed, 113 insertions(+), 15 deletions(-) rename Documentation/{CHANGELOG-EN.md.meta => CHANGELOG.md.meta} (75%) rename Documentation/{README-EN.md.meta => README.md.meta} (75%) create mode 100644 Documentation/res/xcharts3.0.png.meta diff --git a/Documentation/CHANGELOG-EN.md.meta b/Documentation/CHANGELOG.md.meta similarity index 75% rename from Documentation/CHANGELOG-EN.md.meta rename to Documentation/CHANGELOG.md.meta index 979167cf..eea74aad 100644 --- a/Documentation/CHANGELOG-EN.md.meta +++ b/Documentation/CHANGELOG.md.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 01f7eaa065d094f1f8955111a9bc447b +guid: 7425bc5c378354c95bb116c36dc1b5f8 TextScriptImporter: externalObjects: {} userData: diff --git a/Documentation/README-EN.md.meta b/Documentation/README.md.meta similarity index 75% rename from Documentation/README-EN.md.meta rename to Documentation/README.md.meta index 9f886566..5ec956c4 100644 --- a/Documentation/README-EN.md.meta +++ b/Documentation/README.md.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 29f30ecf23bb44bc5b0820dc5ee7a23e +guid: 56516e67d6e88401e949d4e63792c638 TextScriptImporter: externalObjects: {} userData: diff --git a/Documentation/XChartsFAQ-ZH.md b/Documentation/XChartsFAQ-ZH.md index f9d051c0..532f3811 100644 --- a/Documentation/XChartsFAQ-ZH.md +++ b/Documentation/XChartsFAQ-ZH.md @@ -32,6 +32,9 @@ [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：支持空数据吗？如何实现折线图断开的效果?](#支持空数据吗_如何实现折线图断开的效果) ## 如何调整坐标轴与背景的边距 @@ -67,7 +70,7 @@ ## 如何调整图表的对齐方式 -答：默认为左下角对齐，暂不支持调整。可以通过包一层parent来辅助控制。（最新版本`1.5.0`及以上已支持任意锚点，可和做UI一样任意调整对其方式）。 +答：调整RectTransform的锚点，和UGUI的其他组件的用法一致。 ## 可以显示超过1000以上的大数据吗 @@ -87,7 +90,7 @@ ## 如何在数据项顶上显示文本 -答：通过设置`Serie`下的`Label`。 +答：通过设置`Serie`下的`Label`。3.0版本需要先添加`LabelStyle`组件。 ## 如何给数据项自定义图标 @@ -123,7 +126,7 @@ ## 如何做成预设 -答：请删除chart下所有的子组件再拖成预设。 +答：做成prefab前，执行一下`Rebuild Chart Object`重新刷新节点，避免有冗余的节点存在。 ## 如何在图表上画点画线等自定义内容 @@ -149,6 +152,21 @@ 答：检测下代码里是否调用了`RemoveData()`并重新添加`Serie`了。如果想保留`Serie`的配置可以只`ClearData()`，然后重新添加数据。 +## 如何修改Serie的Symbol的颜色 + +答：`Symbol` 的颜色是使用的 `ItemStyle` 的 `color`。 + +## 导入或更新XCharts时TMP报错怎么办 + +答：XCharts默认时不开启TMP，所以asmdef上没有TMP的引用。当本地开启TMP后再更新XCharts可能会出现这个问题。可通过以下两种方式解决： + +1. 找到`XCharts.Runtime.asmdef`和`XCharts.Editor.asmdef`，手动加上 `TextMeshPro`的引用 +2. 移除`PlayerSetting`中`Scripting Define Symbols`的`dUI_TextMeshPro`宏 + +## 支持空数据吗_如何实现折线图断开的效果 + +答：`Serie`的`data`是`double`类型，所以无法表示空数据。可通过开启`Serie`的`ignore`和指定`ignoreValue`来达到空数据的效果。也可以每个`SerieData`设置`ignore`参数。忽略数据后断开还是连接可设置`ignoreLineBreak`参数。 + [XCharts主页](https://github.com/XCharts-Team/XCharts) [XChartsAPI](XChartsAPI-ZH.md) [XCharts配置项手册](XChartsConfiguration-ZH.md) diff --git a/Documentation/res/xcharts3.0.png.meta b/Documentation/res/xcharts3.0.png.meta new file mode 100644 index 00000000..0fdb2fec --- /dev/null +++ b/Documentation/res/xcharts3.0.png.meta @@ -0,0 +1,76 @@ +fileFormatVersion: 2 +guid: d824662da0d024d1f95c8d10c870e3ca +TextureImporter: + fileIDToRecycleName: {} + externalObjects: {} + serializedVersion: 4 + mipmaps: + mipMapMode: 0 + enableMipMap: 1 + sRGBTexture: 1 + linearTexture: 0 + fadeOut: 0 + borderMipMap: 0 + mipMapsPreserveCoverage: 0 + alphaTestReferenceValue: 0.5 + mipMapFadeDistanceStart: 1 + mipMapFadeDistanceEnd: 3 + bumpmap: + convertToNormalMap: 0 + externalNormalMap: 0 + heightScale: 0.25 + normalMapFilter: 0 + isReadable: 0 + grayScaleToAlpha: 0 + generateCubemap: 6 + cubemapConvolution: 0 + seamlessCubemap: 0 + textureFormat: 1 + maxTextureSize: 2048 + textureSettings: + serializedVersion: 2 + filterMode: -1 + aniso: -1 + mipBias: -1 + wrapU: -1 + wrapV: -1 + wrapW: -1 + nPOTScale: 1 + lightmap: 0 + compressionQuality: 50 + spriteMode: 0 + spriteExtrude: 1 + spriteMeshType: 1 + alignment: 0 + spritePivot: {x: 0.5, y: 0.5} + spritePixelsToUnits: 100 + spriteBorder: {x: 0, y: 0, z: 0, w: 0} + spriteGenerateFallbackPhysicsShape: 1 + alphaUsage: 1 + alphaIsTransparency: 0 + spriteTessellationDetail: -1 + textureType: 0 + textureShape: 1 + maxTextureSizeSet: 0 + compressionQualitySet: 0 + textureFormatSet: 0 + platformSettings: + - buildTarget: DefaultTexturePlatform + maxTextureSize: 2048 + resizeAlgorithm: 0 + textureFormat: -1 + textureCompression: 1 + compressionQuality: 50 + crunchedCompression: 0 + allowsAlphaSplitting: 0 + overridden: 0 + androidETC2FallbackOverride: 0 + spriteSheet: + serializedVersion: 2 + sprites: [] + outline: [] + physicsShape: [] + spritePackingTag: + userData: + assetBundleName: + assetBundleVariant: diff --git a/README.md b/README.md index 7e6acefc..22371843 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ 更多示例请看 [XCharts-Demo](https://github.com/XCharts-Team/XCharts-Demo) 仓库，也可以在浏览器查看`WebGL`下的运行效果 [在线Demo](https://xcharts-team.github.io/demo/) 。 -## `XCharts3.0` 新功能 +## `XCharts3.0` - 增加`Time`时间轴。 - 增加`SingleAxis`单轴。 @@ -87,7 +87,7 @@ - 增加`Widgets`小组件。 - 增加多种扩展图表。 -## `XCharts3.0` 相比 `XCharts2.0` 的改进 +## `XCharts3.0` 相比 `XCharts2.0` - 更健壮的底层框架。 - 更强大的性能。 @@ -111,12 +111,14 @@ ## 使用 -1. 导入`XCharts`的`unitypackage`或者源码到项目 -2. 在`Hierarchy`视图下右键选择`XCharts->LineChart`，即可创建一个默认的折线图 -3. 在`Inspector`试图可以调整各个组件的参数，并在`Game`视图看到实时效果 +1. 导入`XCharts`的`unitypackage`或者源码到项目。 +2. 在`Hierarchy`视图下右键选择`XCharts->LineChart`，即可创建一个默认的折线图。 +3. 在`Inspector`视图可以调整各个组件的参数，并在`Game`视图看到实时效果。 更多教程请看：[XCharts教程：5分钟上手教程](Documentation/XChartsTutorial01-ZH.md) +首次使用，建议认真看一遍教程。 + ## FAQ 1. `XCharts`可以免费使用吗？ @@ -128,17 +130,19 @@ 3. 这个插件除了用在`Unity`，还能用在其他平台（如`Winform`或`WPF`）吗？ 答：目前只支持在`Unity`平台使用。理论上任何支持`UGUI`的`Unity`版本都能运行`XCharts`。 -## 日志 - -[更新日志](CHANGELOG.md) - ## Licenses [MIT License](LICENSE.md) +可免费商用，可二次开发 + +## 日志 + +[更新日志](CHANGELOG.md) + ## 其他 邮箱：`monitor1394@gmail.com` QQ群：XCharts交流群（`202030963`） VIP群：XCharts技术支持VIP群（`867291970`） -捐助和技术支持：[☞ 看这里](Documentation/SUPPORT.md) +捐助、合作和技术支持：[☞ 看这里](Documentation/SUPPORT.md)