foldcc/XCharts
1
0
Fork 0
mirror of https://github.com/XCharts-Team/XCharts.git synced 2026-05-15 21:00:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
monitor1394
2023-02-08 08:28:21 +08:00
parent 5e3bc3ff15
commit d6630ef5bf
6 changed files with 73 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
Documentation~/en/api.md
View File

@@ -18,27 +18,28 @@ slug: /api
|[CoordOptionsAttribute](#coordoptionsattribute)|[DataZoomContext](#datazoomcontext)|[DataZoomHelper](#datazoomhelper)|
|[DateTimeUtil](#datetimeutil)|[DefaultAnimationAttribute](#defaultanimationattribute)|[DefineSymbolsUtil](#definesymbolsutil)|
|[FormatterHelper](#formatterhelper)|[GridCoordContext](#gridcoordcontext)|[HeatmapChart](#heatmapchart)|
|[IgnoreDoc](#ignoredoc)|[InteractData](#interactdata)|[LayerHelper](#layerhelper)|
|[LegendContext](#legendcontext)|[LegendHelper](#legendhelper)|[LegendItem](#legenditem)|
|[LineChart](#linechart)|[ListFor](#listfor)|[ListForComponent](#listforcomponent)|
|[ListForSerie](#listforserie)|[MainComponentContext](#maincomponentcontext)|[MainComponentHandler](#maincomponenthandler)|
|[MainComponentHandler<T>](#maincomponenthandlert)|[MathUtil](#mathutil)|[Painter](#painter)|
|[ParallelChart](#parallelchart)|[ParallelCoordContext](#parallelcoordcontext)|[PieChart](#piechart)|
|[PolarChart](#polarchart)|[PolarCoordContext](#polarcoordcontext)|[PropertyUtil](#propertyutil)|
|[RadarChart](#radarchart)|[RadarCoordContext](#radarcoordcontext)|[ReflectionUtil](#reflectionutil)|
|[RequireChartComponentAttribute](#requirechartcomponentattribute)|[RingChart](#ringchart)|[RuntimeUtil](#runtimeutil)|
|[ScatterChart](#scatterchart)|[SerieContext](#seriecontext)|[SerieConvertAttribute](#serieconvertattribute)|
|[SerieDataContext](#seriedatacontext)|[SerieDataExtraComponentAttribute](#seriedataextracomponentattribute)|[SerieDataExtraFieldAttribute](#seriedataextrafieldattribute)|
|[SerieExtraComponentAttribute](#serieextracomponentattribute)|[SerieHandler](#seriehandler)|[SerieHandler<T>](#seriehandlert)|
|[SerieHandlerAttribute](#seriehandlerattribute)|[SerieHelper](#seriehelper)|[SerieLabelHelper](#serielabelhelper)|
|[SerieLabelPool](#serielabelpool)|[SerieParams](#serieparams)|[SeriesHelper](#serieshelper)|
|[SimplifiedBarChart](#simplifiedbarchart)|[SimplifiedCandlestickChart](#simplifiedcandlestickchart)|[SimplifiedLineChart](#simplifiedlinechart)|
|[Since](#since)|[SVG](#svg)|[SVGImage](#svgimage)|
|[SVGPath](#svgpath)|[SVGPathSeg](#svgpathseg)|[TooltipContext](#tooltipcontext)|
|[TooltipData](#tooltipdata)|[TooltipHelper](#tooltiphelper)|[TooltipView](#tooltipview)|
|[TooltipViewItem](#tooltipviewitem)|[UGL](#ugl)|[UGLExample](#uglexample)|
|[UGLHelper](#uglhelper)|[VisualMapContext](#visualmapcontext)|[VisualMapHelper](#visualmaphelper)|
|[XChartsMgr](#xchartsmgr)|[XCResourceImporterWindow](#xcresourceimporterwindow)|[XCThemeMgr](#xcthememgr)|
|[IgnoreDoc](#ignoredoc)|[InputHelper](#inputhelper)|[InteractData](#interactdata)|
|[LayerHelper](#layerhelper)|[LegendContext](#legendcontext)|[LegendHelper](#legendhelper)|
|[LegendItem](#legenditem)|[LineChart](#linechart)|[ListFor](#listfor)|
|[ListForComponent](#listforcomponent)|[ListForSerie](#listforserie)|[MainComponentContext](#maincomponentcontext)|
|[MainComponentHandler](#maincomponenthandler)|[MainComponentHandler<T>](#maincomponenthandlert)|[MathUtil](#mathutil)|
|[Painter](#painter)|[ParallelChart](#parallelchart)|[ParallelCoordContext](#parallelcoordcontext)|
|[PieChart](#piechart)|[PolarChart](#polarchart)|[PolarCoordContext](#polarcoordcontext)|
|[PropertyUtil](#propertyutil)|[RadarChart](#radarchart)|[RadarCoordContext](#radarcoordcontext)|
|[ReflectionUtil](#reflectionutil)|[RequireChartComponentAttribute](#requirechartcomponentattribute)|[RingChart](#ringchart)|
|[RuntimeUtil](#runtimeutil)|[ScatterChart](#scatterchart)|[SerieContext](#seriecontext)|
|[SerieConvertAttribute](#serieconvertattribute)|[SerieDataContext](#seriedatacontext)|[SerieDataExtraComponentAttribute](#seriedataextracomponentattribute)|
|[SerieDataExtraFieldAttribute](#seriedataextrafieldattribute)|[SerieExtraComponentAttribute](#serieextracomponentattribute)|[SerieHandler](#seriehandler)|
|[SerieHandler<T>](#seriehandlert)|[SerieHandlerAttribute](#seriehandlerattribute)|[SerieHelper](#seriehelper)|
|[SerieLabelHelper](#serielabelhelper)|[SerieLabelPool](#serielabelpool)|[SerieParams](#serieparams)|
|[SeriesHelper](#serieshelper)|[SimplifiedBarChart](#simplifiedbarchart)|[SimplifiedCandlestickChart](#simplifiedcandlestickchart)|
|[SimplifiedLineChart](#simplifiedlinechart)|[Since](#since)|[SVG](#svg)|
|[SVGImage](#svgimage)|[SVGPath](#svgpath)|[SVGPathSeg](#svgpathseg)|
|[TooltipContext](#tooltipcontext)|[TooltipData](#tooltipdata)|[TooltipHelper](#tooltiphelper)|
|[TooltipView](#tooltipview)|[TooltipViewItem](#tooltipviewitem)|[UGL](#ugl)|
|[UGLExample](#uglexample)|[UGLHelper](#uglhelper)|[VisualMapContext](#visualmapcontext)|
|[VisualMapHelper](#visualmaphelper)|[XChartsMgr](#xchartsmgr)|[XCResourceImporterWindow](#xcresourceimporterwindow)|
|[XCThemeMgr](#xcthememgr)|
## AnimationStyleHelper
@@ -132,6 +133,7 @@ Inherits or Implemented: [BaseGraph](#basegraph),[ISerializationCallbackReceiver
| ConvertSerie() |public bool ConvertSerie(Serie serie, Type type)|
| ConvertSerie<T>() |public bool ConvertSerie<T>(Serie serie) where T : Serie|
| ConvertXYAxis() |public void ConvertXYAxis(int index)<br/>转换X轴和Y轴的配置 |
| EnsureChartComponent&lt;T&gt;() |public T EnsureChartComponent&lt;T&gt;() where T : MainComponent|
| GenerateDefaultSerieName() |public string GenerateDefaultSerieName()|
| GetAllSerieDataCount() |public int GetAllSerieDataCount()|
| GetChartBackgroundColor() |public Color32 GetChartBackgroundColor()|
@@ -374,6 +376,7 @@ Inherits or Implemented: [Image](#image)
| GetTextHeight() |public float GetTextHeight()|
| GetTextWidth() |public float GetTextWidth()|
| GetWidth() |public float GetWidth()|
| IsActive() |public override bool IsActive()|
| SetActive() |public void SetActive(bool flag)|
| SetIcon() |public void SetIcon(Image image)|
| SetIconActive() |public void SetIconActive(bool flag)|
@@ -500,6 +503,13 @@ Inherits or Implemented: [Attribute](#attribute)
|--|--|
| IgnoreDoc() |public IgnoreDoc()|
## InputHelper
|public method|description|
|--|--|
| GetKeyDown() |public static bool GetKeyDown(KeyCode keyCode)|
| GetTouch() |public static Touch GetTouch(int v)|
## InteractData
|public method|description|
@@ -1083,15 +1093,11 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext)
| AddChart() |public static void AddChart(BaseChart chart)|
| ContainsChart() |public static bool ContainsChart(BaseChart chart)|
| ContainsChart() |public static bool ContainsChart(string chartName)|
| DisableTextMeshPro() |public static void DisableTextMeshPro()|
| EnableTextMeshPro() |public static void EnableTextMeshPro()|
| GetChart() |public static BaseChart GetChart(string chartName)|
| GetCharts() |public static List&lt;BaseChart&gt; GetCharts(string chartName)|
| GetPackageFullPath() |public static string GetPackageFullPath()|
| GetRepeatChartNameInfo() |public static string GetRepeatChartNameInfo(BaseChart chart, string chartName)|
| IsExistTMPAssembly() |public static bool IsExistTMPAssembly()|
| IsRepeatChartName() |public static bool IsRepeatChartName(BaseChart chart, string chartName = null)|
| ModifyTMPRefence() |public static bool ModifyTMPRefence(bool removeTMP = false)|
| RemoveAllChartObject() |public static void RemoveAllChartObject()|
| RemoveChart() |public static void RemoveChart(string chartName)|

4
Documentation~/en/configuration.md
View File

@@ -474,6 +474,8 @@ DataZoom component is used for zooming a specific area, which enables user to in
|lineStyle|||阴影线条样式。 [LineStyle](#linestyle)|
|areaStyle|||阴影填充样式。 [AreaStyle](#areastyle)|
|marqueeStyle||v3.5.0|选取框样式。 [MarqueeStyle](#marqueestyle)|
|startLock||v3.6.0|Lock start value.
|endLock||v3.6.0|Lock end value.
## DataZoomTheme
@@ -623,6 +625,7 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieDataComponent]
|color0|||数据项颜色。
|toColor|||Gradient color1.
|toColor2|||Gradient color2.Only valid in line diagrams.
|markColor||v3.6.0|Serie's mark color. It is only used to display Legend and Tooltip, and does not affect the drawing color. The default value is clear.
|backgroundColor|||数据项背景颜色。
|backgroundWidth|||数据项背景宽度。
|centerColor|||中心区域颜色。
@@ -1009,7 +1012,6 @@ Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable)
|serieName|||Series name used for displaying in tooltip and filtering with legend.
|state||v3.2.0|The default state of a serie.<br/>`SerieState`:<br/>- `Normal`: Normal state.<br/>- `Emphasis`: Emphasis state.<br/>- `Blur`: Blur state.<br/>- `Select`: Select state.<br/>- `Auto`: Auto state.<br/>|
|colorBy||v3.2.0|The policy to take color from theme.<br/>`SerieColorBy`:<br/>- `Default`: Select state.<br/>- `Serie`: assigns the colors in the palette by serie, so that all data in the same series are in the same color;.<br/>- `Data`: assigns colors in the palette according to data items, with each data item using a different color..<br/>|
|markColor||v3.4.0|Serie's mark color. It is only used to display Legend and Tooltip, and does not affect the drawing color. The default value is clear.
|stack|||If stack the value. On the same category axis, the series with the same stack name would be put on top of each other.
|xAxisIndex|0||the index of XAxis.
|yAxisIndex|0||the index of YAxis.

56
Documentation~/zh/api.md
View File

@@ -18,27 +18,28 @@ slug: /api
|[CoordOptionsAttribute](#coordoptionsattribute)|[DataZoomContext](#datazoomcontext)|[DataZoomHelper](#datazoomhelper)|
|[DateTimeUtil](#datetimeutil)|[DefaultAnimationAttribute](#defaultanimationattribute)|[DefineSymbolsUtil](#definesymbolsutil)|
|[FormatterHelper](#formatterhelper)|[GridCoordContext](#gridcoordcontext)|[HeatmapChart](#heatmapchart)|
|[IgnoreDoc](#ignoredoc)|[InteractData](#interactdata)|[LayerHelper](#layerhelper)|
|[LegendContext](#legendcontext)|[LegendHelper](#legendhelper)|[LegendItem](#legenditem)|
|[LineChart](#linechart)|[ListFor](#listfor)|[ListForComponent](#listforcomponent)|
|[ListForSerie](#listforserie)|[MainComponentContext](#maincomponentcontext)|[MainComponentHandler](#maincomponenthandler)|
|[MainComponentHandler&lt;T&gt;](#maincomponenthandlert)|[MathUtil](#mathutil)|[Painter](#painter)|
|[ParallelChart](#parallelchart)|[ParallelCoordContext](#parallelcoordcontext)|[PieChart](#piechart)|
|[PolarChart](#polarchart)|[PolarCoordContext](#polarcoordcontext)|[PropertyUtil](#propertyutil)|
|[RadarChart](#radarchart)|[RadarCoordContext](#radarcoordcontext)|[ReflectionUtil](#reflectionutil)|
|[RequireChartComponentAttribute](#requirechartcomponentattribute)|[RingChart](#ringchart)|[RuntimeUtil](#runtimeutil)|
|[ScatterChart](#scatterchart)|[SerieContext](#seriecontext)|[SerieConvertAttribute](#serieconvertattribute)|
|[SerieDataContext](#seriedatacontext)|[SerieDataExtraComponentAttribute](#seriedataextracomponentattribute)|[SerieDataExtraFieldAttribute](#seriedataextrafieldattribute)|
|[SerieExtraComponentAttribute](#serieextracomponentattribute)|[SerieHandler](#seriehandler)|[SerieHandler&lt;T&gt;](#seriehandlert)|
|[SerieHandlerAttribute](#seriehandlerattribute)|[SerieHelper](#seriehelper)|[SerieLabelHelper](#serielabelhelper)|
|[SerieLabelPool](#serielabelpool)|[SerieParams](#serieparams)|[SeriesHelper](#serieshelper)|
|[SimplifiedBarChart](#simplifiedbarchart)|[SimplifiedCandlestickChart](#simplifiedcandlestickchart)|[SimplifiedLineChart](#simplifiedlinechart)|
|[Since](#since)|[SVG](#svg)|[SVGImage](#svgimage)|
|[SVGPath](#svgpath)|[SVGPathSeg](#svgpathseg)|[TooltipContext](#tooltipcontext)|
|[TooltipData](#tooltipdata)|[TooltipHelper](#tooltiphelper)|[TooltipView](#tooltipview)|
|[TooltipViewItem](#tooltipviewitem)|[UGL](#ugl)|[UGLExample](#uglexample)|
|[UGLHelper](#uglhelper)|[VisualMapContext](#visualmapcontext)|[VisualMapHelper](#visualmaphelper)|
|[XChartsMgr](#xchartsmgr)|[XCResourceImporterWindow](#xcresourceimporterwindow)|[XCThemeMgr](#xcthememgr)|
|[IgnoreDoc](#ignoredoc)|[InputHelper](#inputhelper)|[InteractData](#interactdata)|
|[LayerHelper](#layerhelper)|[LegendContext](#legendcontext)|[LegendHelper](#legendhelper)|
|[LegendItem](#legenditem)|[LineChart](#linechart)|[ListFor](#listfor)|
|[ListForComponent](#listforcomponent)|[ListForSerie](#listforserie)|[MainComponentContext](#maincomponentcontext)|
|[MainComponentHandler](#maincomponenthandler)|[MainComponentHandler&lt;T&gt;](#maincomponenthandlert)|[MathUtil](#mathutil)|
|[Painter](#painter)|[ParallelChart](#parallelchart)|[ParallelCoordContext](#parallelcoordcontext)|
|[PieChart](#piechart)|[PolarChart](#polarchart)|[PolarCoordContext](#polarcoordcontext)|
|[PropertyUtil](#propertyutil)|[RadarChart](#radarchart)|[RadarCoordContext](#radarcoordcontext)|
|[ReflectionUtil](#reflectionutil)|[RequireChartComponentAttribute](#requirechartcomponentattribute)|[RingChart](#ringchart)|
|[RuntimeUtil](#runtimeutil)|[ScatterChart](#scatterchart)|[SerieContext](#seriecontext)|
|[SerieConvertAttribute](#serieconvertattribute)|[SerieDataContext](#seriedatacontext)|[SerieDataExtraComponentAttribute](#seriedataextracomponentattribute)|
|[SerieDataExtraFieldAttribute](#seriedataextrafieldattribute)|[SerieExtraComponentAttribute](#serieextracomponentattribute)|[SerieHandler](#seriehandler)|
|[SerieHandler&lt;T&gt;](#seriehandlert)|[SerieHandlerAttribute](#seriehandlerattribute)|[SerieHelper](#seriehelper)|
|[SerieLabelHelper](#serielabelhelper)|[SerieLabelPool](#serielabelpool)|[SerieParams](#serieparams)|
|[SeriesHelper](#serieshelper)|[SimplifiedBarChart](#simplifiedbarchart)|[SimplifiedCandlestickChart](#simplifiedcandlestickchart)|
|[SimplifiedLineChart](#simplifiedlinechart)|[Since](#since)|[SVG](#svg)|
|[SVGImage](#svgimage)|[SVGPath](#svgpath)|[SVGPathSeg](#svgpathseg)|
|[TooltipContext](#tooltipcontext)|[TooltipData](#tooltipdata)|[TooltipHelper](#tooltiphelper)|
|[TooltipView](#tooltipview)|[TooltipViewItem](#tooltipviewitem)|[UGL](#ugl)|
|[UGLExample](#uglexample)|[UGLHelper](#uglhelper)|[VisualMapContext](#visualmapcontext)|
|[VisualMapHelper](#visualmaphelper)|[XChartsMgr](#xchartsmgr)|[XCResourceImporterWindow](#xcresourceimporterwindow)|
|[XCThemeMgr](#xcthememgr)|
## AnimationStyleHelper
@@ -132,6 +133,7 @@ Inherits or Implemented: [BaseGraph](#basegraph),[ISerializationCallbackReceiver
| ConvertSerie() |public bool ConvertSerie(Serie serie, Type type)|
| ConvertSerie&lt;T&gt;() |public bool ConvertSerie&lt;T&gt;(Serie serie) where T : Serie|
| ConvertXYAxis() |public void ConvertXYAxis(int index)<br/>转换X轴和Y轴的配置 |
| EnsureChartComponent&lt;T&gt;() |public T EnsureChartComponent&lt;T&gt;() where T : MainComponent|
| GenerateDefaultSerieName() |public string GenerateDefaultSerieName()|
| GetAllSerieDataCount() |public int GetAllSerieDataCount()|
| GetChartBackgroundColor() |public Color32 GetChartBackgroundColor()|
@@ -374,6 +376,7 @@ Inherits or Implemented: [Image](#image)
| GetTextHeight() |public float GetTextHeight()|
| GetTextWidth() |public float GetTextWidth()|
| GetWidth() |public float GetWidth()|
| IsActive() |public override bool IsActive()|
| SetActive() |public void SetActive(bool flag)|
| SetIcon() |public void SetIcon(Image image)|
| SetIconActive() |public void SetIconActive(bool flag)|
@@ -500,6 +503,13 @@ Inherits or Implemented: [Attribute](#attribute)
|--|--|
| IgnoreDoc() |public IgnoreDoc()|
## InputHelper
|public method|description|
|--|--|
| GetKeyDown() |public static bool GetKeyDown(KeyCode keyCode)|
| GetTouch() |public static Touch GetTouch(int v)|
## InteractData
|public method|description|
@@ -1083,15 +1093,11 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext)
| AddChart() |public static void AddChart(BaseChart chart)|
| ContainsChart() |public static bool ContainsChart(BaseChart chart)|
| ContainsChart() |public static bool ContainsChart(string chartName)|
| DisableTextMeshPro() |public static void DisableTextMeshPro()|
| EnableTextMeshPro() |public static void EnableTextMeshPro()|
| GetChart() |public static BaseChart GetChart(string chartName)|
| GetCharts() |public static List&lt;BaseChart&gt; GetCharts(string chartName)|
| GetPackageFullPath() |public static string GetPackageFullPath()|
| GetRepeatChartNameInfo() |public static string GetRepeatChartNameInfo(BaseChart chart, string chartName)|
| IsExistTMPAssembly() |public static bool IsExistTMPAssembly()|
| IsRepeatChartName() |public static bool IsRepeatChartName(BaseChart chart, string chartName = null)|
| ModifyTMPRefence() |public static bool ModifyTMPRefence(bool removeTMP = false)|
| RemoveAllChartObject() |public static void RemoveAllChartObject()|
| RemoveChart() |public static void RemoveChart(string chartName)|

1
Documentation~/zh/changelog.md
View File

@@ -65,6 +65,7 @@ slug: /changelog
## master
* (2023.02.08) 增加`DataZoom`的`startLock`和`endLock`参数支持锁定
* (2023.02.02) 修复`DataZoom`开启时`X轴`的`Label`可能会显示在图表外的问题
* (2023.02.02) 优化`SerieData`的`ignore`设置时的忽略数据判断
* (2023.02.01) 修复`XChartsMgr.ContainsChart()`接口异常

4
Documentation~/zh/configuration.md
View File

@@ -474,6 +474,8 @@ DataZoom 组件 用于区域缩放，从而能自由关注细节的数据信息
|lineStyle|||阴影线条样式。 [LineStyle](#linestyle)|
|areaStyle|||阴影填充样式。 [AreaStyle](#areastyle)|
|marqueeStyle||v3.5.0|选取框样式。 [MarqueeStyle](#marqueestyle)|
|startLock||v3.6.0|固定起始值，不让改变。
|endLock||v3.6.0|固定结束值，不让改变。
## DataZoomTheme
@@ -623,6 +625,7 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieDataComponent]
|color0|||数据项颜色。
|toColor|||渐变色的颜色1。
|toColor2|||渐变色的颜色2。只在折线图中有效。
|markColor||v3.6.0|Serie的标识颜色。仅用于Legend和Tooltip的展示，不影响绘制颜色，默认为clear。
|backgroundColor|||数据项背景颜色。
|backgroundWidth|||数据项背景宽度。
|centerColor|||中心区域颜色。
@@ -1009,7 +1012,6 @@ Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable)
|serieName|||系列名称，用于 tooltip 的显示，legend 的图例筛选。
|state||v3.2.0|系列的默认状态。<br/>`SerieState`:<br/>- `Normal`: 正常状态。<br/>- `Emphasis`: 高亮状态。<br/>- `Blur`: 淡出状态。<br/>- `Select`: 选中状态。<br/>- `Auto`: 自动保持和父节点一致。一般用在SerieData。<br/>|
|colorBy||v3.2.0|从主题中取色的策略。<br/>`SerieColorBy`:<br/>- `Default`: 默认策略。每种Serie都有自己的默认的取颜色策略。比如Line默认是Series策略，Pie默认是Data策略<br/>- `Serie`: 按照系列分配调色盘中的颜色，同一系列中的所有数据都是用相同的颜色。<br/>- `Data`: 按照数据项分配调色盘中的颜色，每个数据项都使用不同的颜色。<br/>|
|markColor||v3.4.0|Serie的标识颜色。仅用于Legend和Tooltip的展示，不影响绘制颜色，默认为clear。
|stack|||数据堆叠，同个类目轴上系列配置相同的stack值后，后一个系列的值会在前一个系列的值上相加。
|xAxisIndex|0||使用X轴的index。
|yAxisIndex|0||使用Y轴的index。

4
Documentation~/zh/support.md
View File

@@ -78,5 +78,9 @@ slug: /support
如果这个项目对您有帮助，请右上方点 `Star` 予以支持！也欢迎任意金额的捐助，非常您的支持！
## 二维码
如果看不到二维码图片，可以加QQ`XCharts技术支持:3525422251`或邮件`monitor1394@gmail.com`咨询。
![alipay-qrcode](img/support_alipay.png)
![wechat-qrcode](img/support_wechat.png)