From b102fed9fec9cee423d970193daf279070a7feb7 Mon Sep 17 00:00:00 2001 From: monitor1394 Date: Tue, 14 Feb 2023 13:18:39 +0800 Subject: [PATCH] update doc --- Documentation~/en/api.md | 129 +++++++++++++----- Documentation~/en/configuration.md | 204 +++++++++++++++++++++-------- Documentation~/zh/api.md | 127 +++++++++++++----- Documentation~/zh/configuration.md | 202 ++++++++++++++++++++-------- 4 files changed, 490 insertions(+), 172 deletions(-) diff --git a/Documentation~/en/api.md b/Documentation~/en/api.md index 599a6f46..c5aa7fd5 100644 --- a/Documentation~/en/api.md +++ b/Documentation~/en/api.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 41 slug: /api --- @@ -7,39 +7,98 @@ slug: /api ## All Class -|||| -|--|--|--| -|[AnimationStyleHelper](#animationstylehelper)|[AxisContext](#axiscontext)|[AxisHandler<T>](#axishandlert)| -|[AxisHelper](#axishelper)|[BarChart](#barchart)|[BaseChart](#basechart)| -|[BaseGraph](#basegraph)|[CandlestickChart](#candlestickchart)|[ChartCached](#chartcached)| -|[ChartConst](#chartconst)|[ChartDrawer](#chartdrawer)|[ChartHelper](#charthelper)| -|[ChartLabel](#chartlabel)|[ChartObject](#chartobject)|[CheckHelper](#checkhelper)| -|[ColorUtil](#colorutil)|[ComponentHandlerAttribute](#componenthandlerattribute)|[ComponentHelper](#componenthelper)| -|[CoordOptionsAttribute](#coordoptionsattribute)|[DataZoomContext](#datazoomcontext)|[DataZoomHelper](#datazoomhelper)| -|[DateTimeUtil](#datetimeutil)|[DefaultAnimationAttribute](#defaultanimationattribute)|[DefineSymbolsUtil](#definesymbolsutil)| -|[FormatterHelper](#formatterhelper)|[GridCoordContext](#gridcoordcontext)|[HeatmapChart](#heatmapchart)| -|[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)|[SerieComponentAttribute](#seriecomponentattribute)| -|[SerieContext](#seriecontext)|[SerieConvertAttribute](#serieconvertattribute)|[SerieDataComponentAttribute](#seriedatacomponentattribute)| -|[SerieDataContext](#seriedatacontext)|[SerieDataExtraFieldAttribute](#seriedataextrafieldattribute)|[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](#animationstylehelper) +- [AxisContext](#axiscontext) +- [AxisHandler<T>](#axishandlert) +- [AxisHelper](#axishelper) +- [BarChart](#barchart) +- [BaseChart](#basechart) +- [BaseGraph](#basegraph) +- [CandlestickChart](#candlestickchart) +- [ChartCached](#chartcached) +- [ChartConst](#chartconst) +- [ChartDrawer](#chartdrawer) +- [ChartHelper](#charthelper) +- [ChartLabel](#chartlabel) +- [ChartObject](#chartobject) +- [CheckHelper](#checkhelper) +- [ColorUtil](#colorutil) +- [ComponentHandlerAttribute](#componenthandlerattribute) +- [ComponentHelper](#componenthelper) +- [CoordOptionsAttribute](#coordoptionsattribute) +- [DataZoomContext](#datazoomcontext) +- [DataZoomHelper](#datazoomhelper) +- [DateTimeUtil](#datetimeutil) +- [DefaultAnimationAttribute](#defaultanimationattribute) +- [DefineSymbolsUtil](#definesymbolsutil) +- [FormatterHelper](#formatterhelper) +- [GridCoordContext](#gridcoordcontext) +- [HeatmapChart](#heatmapchart) +- [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) +- [SerieComponentAttribute](#seriecomponentattribute) +- [SerieContext](#seriecontext) +- [SerieConvertAttribute](#serieconvertattribute) +- [SerieDataComponentAttribute](#seriedatacomponentattribute) +- [SerieDataContext](#seriedatacontext) +- [SerieDataExtraFieldAttribute](#seriedataextrafieldattribute) +- [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 @@ -316,6 +375,8 @@ Inherits or Implemented: [BaseChart](#basechart) | DestoryGameObject() |public static void DestoryGameObject(Transform parent, string childName)| | DestoryGameObjectByMatch() |public static void DestoryGameObjectByMatch(Transform parent, string containString)| | DestroyAllChildren() |public static void DestroyAllChildren(Transform parent)| +| EnsureComponent<T>() |public static T EnsureComponent<T>(GameObject gameObject) where T : Component
Ensure that the game object has the specified component, add it if not. | +| EnsureComponent<T>() |public static T EnsureComponent<T>(Transform transform) where T : Component
Ensure that the transform has the specified component, add it if not. | | GetActualValue() |public static float GetActualValue(float valueOrRate, float total, float maxRate = 1.5f)| | GetAngle360() |public static float GetAngle360(Vector2 from, Vector2 to)
获得0-360的角度（12点钟方向为0度） | | GetBlurColor() |public static Color32 GetBlurColor(Color32 color, float a = 0.3f)| diff --git a/Documentation~/en/configuration.md b/Documentation~/en/configuration.md index 07e4b56b..193f0b19 100644 --- a/Documentation~/en/configuration.md +++ b/Documentation~/en/configuration.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 31 slug: /configuration --- @@ -7,76 +7,174 @@ slug: /configuration ## Serie -||||| -|--|--|--|--| -|[Bar](#bar)|[BaseScatter](#basescatter)|[Candlestick](#candlestick)|[EffectScatter](#effectscatter)| -|[Heatmap](#heatmap)|[Line](#line)|[Parallel](#parallel)|[Pie](#pie)| -|[Radar](#radar)|[Ring](#ring)|[Scatter](#scatter)|[Serie](#serie)| -|[SimplifiedBar](#simplifiedbar)|[SimplifiedCandlestick](#simplifiedcandlestick)|[SimplifiedLine](#simplifiedline)| +- [Bar](#bar) +- [BaseScatter](#basescatter) +- [Candlestick](#candlestick) +- [EffectScatter](#effectscatter) +- [Heatmap](#heatmap) +- [Line](#line) +- [Parallel](#parallel) +- [Pie](#pie) +- [Radar](#radar) +- [Ring](#ring) +- [Scatter](#scatter) +- [Serie](#serie) +- [SimplifiedBar](#simplifiedbar) +- [SimplifiedCandlestick](#simplifiedcandlestick) +- [SimplifiedLine](#simplifiedline) + ## Theme -||||| -|--|--|--|--| -|[AngleAxisTheme](#angleaxistheme)|[AxisTheme](#axistheme)|[BaseAxisTheme](#baseaxistheme)|[ComponentTheme](#componenttheme)| -|[DataZoomTheme](#datazoomtheme)|[LegendTheme](#legendtheme)|[PolarAxisTheme](#polaraxistheme)|[RadarAxisTheme](#radaraxistheme)| -|[RadiusAxisTheme](#radiusaxistheme)|[SerieTheme](#serietheme)|[SubTitleTheme](#subtitletheme)|[Theme](#theme)| -|[ThemeStyle](#themestyle)|[TitleTheme](#titletheme)|[TooltipTheme](#tooltiptheme)|[VisualMapTheme](#visualmaptheme)| +- [AngleAxisTheme](#angleaxistheme) +- [AxisTheme](#axistheme) +- [BaseAxisTheme](#baseaxistheme) +- [ComponentTheme](#componenttheme) +- [DataZoomTheme](#datazoomtheme) +- [LegendTheme](#legendtheme) +- [PolarAxisTheme](#polaraxistheme) +- [RadarAxisTheme](#radaraxistheme) +- [RadiusAxisTheme](#radiusaxistheme) +- [SerieTheme](#serietheme) +- [SubTitleTheme](#subtitletheme) +- [Theme](#theme) +- [ThemeStyle](#themestyle) +- [TitleTheme](#titletheme) +- [TooltipTheme](#tooltiptheme) +- [VisualMapTheme](#visualmaptheme) + ## MainComponent -||||| -|--|--|--|--| -|[AngleAxis](#angleaxis)|[Axis](#axis)|[Background](#background)|[CalendarCoord](#calendarcoord)| -|[Comment](#comment)|[CoordSystem](#coordsystem)|[DataZoom](#datazoom)|[GridCoord](#gridcoord)| -|[Legend](#legend)|[MarkArea](#markarea)|[MarkLine](#markline)|[ParallelAxis](#parallelaxis)| -|[ParallelCoord](#parallelcoord)|[PolarCoord](#polarcoord)|[RadarCoord](#radarcoord)|[RadiusAxis](#radiusaxis)| -|[Settings](#settings)|[SingleAxis](#singleaxis)|[SingleAxisCoord](#singleaxiscoord)|[Title](#title)| -|[Tooltip](#tooltip)|[VisualMap](#visualmap)|[XAxis](#xaxis)|[YAxis](#yaxis)| +- [AngleAxis](#angleaxis) +- [Axis](#axis) +- [Background](#background) +- [CalendarCoord](#calendarcoord) +- [Comment](#comment) +- [CoordSystem](#coordsystem) +- [DataZoom](#datazoom) +- [GridCoord](#gridcoord) +- [Legend](#legend) +- [MarkArea](#markarea) +- [MarkLine](#markline) +- [ParallelAxis](#parallelaxis) +- [ParallelCoord](#parallelcoord) +- [PolarCoord](#polarcoord) +- [RadarCoord](#radarcoord) +- [RadiusAxis](#radiusaxis) +- [Settings](#settings) +- [SingleAxis](#singleaxis) +- [SingleAxisCoord](#singleaxiscoord) +- [Title](#title) +- [Tooltip](#tooltip) +- [VisualMap](#visualmap) +- [XAxis](#xaxis) +- [YAxis](#yaxis) + ## ChildComponent -||||| -|--|--|--|--| -|[AngleAxisTheme](#angleaxistheme)|[AnimationStyle](#animationstyle)|[AreaStyle](#areastyle)|[ArrowStyle](#arrowstyle)| -|[AxisLabel](#axislabel)|[AxisLine](#axisline)|[AxisMinorSplitLine](#axisminorsplitline)|[AxisMinorTick](#axisminortick)| -|[AxisName](#axisname)|[AxisSplitArea](#axissplitarea)|[AxisSplitLine](#axissplitline)|[AxisTheme](#axistheme)| -|[AxisTick](#axistick)|[BaseAxisTheme](#baseaxistheme)|[BaseLine](#baseline)|[BlurStyle](#blurstyle)| -|[CommentItem](#commentitem)|[CommentMarkStyle](#commentmarkstyle)|[ComponentTheme](#componenttheme)|[DataZoomTheme](#datazoomtheme)| -|[EmphasisStyle](#emphasisstyle)|[EndLabelStyle](#endlabelstyle)|[IconStyle](#iconstyle)|[ImageStyle](#imagestyle)| -|[ItemStyle](#itemstyle)|[LabelLine](#labelline)|[LabelStyle](#labelstyle)|[LegendTheme](#legendtheme)| -|[Level](#level)|[LevelStyle](#levelstyle)|[LineArrow](#linearrow)|[LineStyle](#linestyle)| -|[Location](#location)|[MarkAreaData](#markareadata)|[MarkLineData](#marklinedata)|[MarqueeStyle](#marqueestyle)| -|[Padding](#padding)|[PolarAxisTheme](#polaraxistheme)|[RadarAxisTheme](#radaraxistheme)|[RadiusAxisTheme](#radiusaxistheme)| -|[SelectStyle](#selectstyle)|[SerieData](#seriedata)|[SerieSymbol](#seriesymbol)|[SerieTheme](#serietheme)| -|[StageColor](#stagecolor)|[StateStyle](#statestyle)|[SubTitleTheme](#subtitletheme)|[SymbolStyle](#symbolstyle)| -|[TextLimit](#textlimit)|[TextPadding](#textpadding)|[TextStyle](#textstyle)|[ThemeStyle](#themestyle)| -|[TitleStyle](#titlestyle)|[TitleTheme](#titletheme)|[TooltipTheme](#tooltiptheme)|[VisualMapRange](#visualmaprange)| -|[VisualMapTheme](#visualmaptheme)| +- [AngleAxisTheme](#angleaxistheme) +- [AnimationStyle](#animationstyle) +- [AreaStyle](#areastyle) +- [ArrowStyle](#arrowstyle) +- [AxisLabel](#axislabel) +- [AxisLine](#axisline) +- [AxisMinorSplitLine](#axisminorsplitline) +- [AxisMinorTick](#axisminortick) +- [AxisName](#axisname) +- [AxisSplitArea](#axissplitarea) +- [AxisSplitLine](#axissplitline) +- [AxisTheme](#axistheme) +- [AxisTick](#axistick) +- [BaseAxisTheme](#baseaxistheme) +- [BaseLine](#baseline) +- [BlurStyle](#blurstyle) +- [CommentItem](#commentitem) +- [CommentMarkStyle](#commentmarkstyle) +- [ComponentTheme](#componenttheme) +- [DataZoomTheme](#datazoomtheme) +- [EmphasisStyle](#emphasisstyle) +- [EndLabelStyle](#endlabelstyle) +- [IconStyle](#iconstyle) +- [ImageStyle](#imagestyle) +- [ItemStyle](#itemstyle) +- [LabelLine](#labelline) +- [LabelStyle](#labelstyle) +- [LegendTheme](#legendtheme) +- [Level](#level) +- [LevelStyle](#levelstyle) +- [LineArrow](#linearrow) +- [LineStyle](#linestyle) +- [Location](#location) +- [MarkAreaData](#markareadata) +- [MarkLineData](#marklinedata) +- [MarqueeStyle](#marqueestyle) +- [Padding](#padding) +- [PolarAxisTheme](#polaraxistheme) +- [RadarAxisTheme](#radaraxistheme) +- [RadiusAxisTheme](#radiusaxistheme) +- [SelectStyle](#selectstyle) +- [SerieData](#seriedata) +- [SerieSymbol](#seriesymbol) +- [SerieTheme](#serietheme) +- [StageColor](#stagecolor) +- [StateStyle](#statestyle) +- [SubTitleTheme](#subtitletheme) +- [SymbolStyle](#symbolstyle) +- [TextLimit](#textlimit) +- [TextPadding](#textpadding) +- [TextStyle](#textstyle) +- [ThemeStyle](#themestyle) +- [TitleStyle](#titlestyle) +- [TitleTheme](#titletheme) +- [TooltipTheme](#tooltiptheme) +- [VisualMapRange](#visualmaprange) +- [VisualMapTheme](#visualmaptheme) + ## ISerieComponent -||||| -|--|--|--|--| -|[AreaStyle](#areastyle)|[BlurStyle](#blurstyle)|[EmphasisStyle](#emphasisstyle)|[ImageStyle](#imagestyle)| -|[LabelLine](#labelline)|[LabelStyle](#labelstyle)|[LineArrow](#linearrow)|[SelectStyle](#selectstyle)| -|[TitleStyle](#titlestyle)| +- [AreaStyle](#areastyle) +- [BlurStyle](#blurstyle) +- [EmphasisStyle](#emphasisstyle) +- [ImageStyle](#imagestyle) +- [LabelLine](#labelline) +- [LabelStyle](#labelstyle) +- [LineArrow](#linearrow) +- [SelectStyle](#selectstyle) +- [TitleStyle](#titlestyle) + ## ISerieDataComponent -||||| -|--|--|--|--| -|[AreaStyle](#areastyle)|[BlurStyle](#blurstyle)|[EmphasisStyle](#emphasisstyle)|[ImageStyle](#imagestyle)| -|[ItemStyle](#itemstyle)|[LabelLine](#labelline)|[LabelStyle](#labelstyle)|[LineStyle](#linestyle)| -|[SelectStyle](#selectstyle)|[SerieSymbol](#seriesymbol)|[TitleStyle](#titlestyle)| +- [AreaStyle](#areastyle) +- [BlurStyle](#blurstyle) +- [EmphasisStyle](#emphasisstyle) +- [ImageStyle](#imagestyle) +- [ItemStyle](#itemstyle) +- [LabelLine](#labelline) +- [LabelStyle](#labelstyle) +- [LineStyle](#linestyle) +- [SelectStyle](#selectstyle) +- [SerieSymbol](#seriesymbol) +- [TitleStyle](#titlestyle) + ## Other Component -||||| -|--|--|--|--| -|[BaseSerie](#baseserie)|[ChartText](#charttext)|[ChildComponent](#childcomponent)|[DebugInfo](#debuginfo)| -|[Indicator](#indicator)|[Lang](#lang)|[LangCandlestick](#langcandlestick)|[LangTime](#langtime)| -|[MainComponent](#maincomponent)|[XCResourcesImporter](#xcresourcesimporter)|[XCSettings](#xcsettings)| +- [BaseSerie](#baseserie) +- [ChartText](#charttext) +- [ChildComponent](#childcomponent) +- [DebugInfo](#debuginfo) +- [Indicator](#indicator) +- [Lang](#lang) +- [LangCandlestick](#langcandlestick) +- [LangTime](#langtime) +- [MainComponent](#maincomponent) +- [XCResourcesImporter](#xcresourcesimporter) +- [XCSettings](#xcsettings) + ## AngleAxis diff --git a/Documentation~/zh/api.md b/Documentation~/zh/api.md index a7ec92fd..5a9f3078 100644 --- a/Documentation~/zh/api.md +++ b/Documentation~/zh/api.md @@ -7,39 +7,98 @@ slug: /api ## 所有类 -|||| -|--|--|--| -|[AnimationStyleHelper](#animationstylehelper)|[AxisContext](#axiscontext)|[AxisHandler<T>](#axishandlert)| -|[AxisHelper](#axishelper)|[BarChart](#barchart)|[BaseChart](#basechart)| -|[BaseGraph](#basegraph)|[CandlestickChart](#candlestickchart)|[ChartCached](#chartcached)| -|[ChartConst](#chartconst)|[ChartDrawer](#chartdrawer)|[ChartHelper](#charthelper)| -|[ChartLabel](#chartlabel)|[ChartObject](#chartobject)|[CheckHelper](#checkhelper)| -|[ColorUtil](#colorutil)|[ComponentHandlerAttribute](#componenthandlerattribute)|[ComponentHelper](#componenthelper)| -|[CoordOptionsAttribute](#coordoptionsattribute)|[DataZoomContext](#datazoomcontext)|[DataZoomHelper](#datazoomhelper)| -|[DateTimeUtil](#datetimeutil)|[DefaultAnimationAttribute](#defaultanimationattribute)|[DefineSymbolsUtil](#definesymbolsutil)| -|[FormatterHelper](#formatterhelper)|[GridCoordContext](#gridcoordcontext)|[HeatmapChart](#heatmapchart)| -|[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)|[SerieComponentAttribute](#seriecomponentattribute)| -|[SerieContext](#seriecontext)|[SerieConvertAttribute](#serieconvertattribute)|[SerieDataComponentAttribute](#seriedatacomponentattribute)| -|[SerieDataContext](#seriedatacontext)|[SerieDataExtraFieldAttribute](#seriedataextrafieldattribute)|[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](#animationstylehelper) +- [AxisContext](#axiscontext) +- [AxisHandler<T>](#axishandlert) +- [AxisHelper](#axishelper) +- [BarChart](#barchart) +- [BaseChart](#basechart) +- [BaseGraph](#basegraph) +- [CandlestickChart](#candlestickchart) +- [ChartCached](#chartcached) +- [ChartConst](#chartconst) +- [ChartDrawer](#chartdrawer) +- [ChartHelper](#charthelper) +- [ChartLabel](#chartlabel) +- [ChartObject](#chartobject) +- [CheckHelper](#checkhelper) +- [ColorUtil](#colorutil) +- [ComponentHandlerAttribute](#componenthandlerattribute) +- [ComponentHelper](#componenthelper) +- [CoordOptionsAttribute](#coordoptionsattribute) +- [DataZoomContext](#datazoomcontext) +- [DataZoomHelper](#datazoomhelper) +- [DateTimeUtil](#datetimeutil) +- [DefaultAnimationAttribute](#defaultanimationattribute) +- [DefineSymbolsUtil](#definesymbolsutil) +- [FormatterHelper](#formatterhelper) +- [GridCoordContext](#gridcoordcontext) +- [HeatmapChart](#heatmapchart) +- [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) +- [SerieComponentAttribute](#seriecomponentattribute) +- [SerieContext](#seriecontext) +- [SerieConvertAttribute](#serieconvertattribute) +- [SerieDataComponentAttribute](#seriedatacomponentattribute) +- [SerieDataContext](#seriedatacontext) +- [SerieDataExtraFieldAttribute](#seriedataextrafieldattribute) +- [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 @@ -316,6 +375,8 @@ Inherits or Implemented: [BaseChart](#basechart) | DestoryGameObject() |public static void DestoryGameObject(Transform parent, string childName)| | DestoryGameObjectByMatch() |public static void DestoryGameObjectByMatch(Transform parent, string containString)| | DestroyAllChildren() |public static void DestroyAllChildren(Transform parent)| +| EnsureComponent<T>() |public static T EnsureComponent<T>(GameObject gameObject) where T : Component
确保对象有指定的组件，如果没有则添加。 | +| EnsureComponent<T>() |public static T EnsureComponent<T>(Transform transform) where T : Component
确保对象有指定的组件，如果没有则添加。 | | GetActualValue() |public static float GetActualValue(float valueOrRate, float total, float maxRate = 1.5f)| | GetAngle360() |public static float GetAngle360(Vector2 from, Vector2 to)
获得0-360的角度（12点钟方向为0度） | | GetBlurColor() |public static Color32 GetBlurColor(Color32 color, float a = 0.3f)| diff --git a/Documentation~/zh/configuration.md b/Documentation~/zh/configuration.md index 6dd6b967..47faa9a4 100644 --- a/Documentation~/zh/configuration.md +++ b/Documentation~/zh/configuration.md @@ -7,76 +7,174 @@ slug: /configuration ## Serie 系列 -||||| -|--|--|--|--| -|[Bar](#bar)|[BaseScatter](#basescatter)|[Candlestick](#candlestick)|[EffectScatter](#effectscatter)| -|[Heatmap](#heatmap)|[Line](#line)|[Parallel](#parallel)|[Pie](#pie)| -|[Radar](#radar)|[Ring](#ring)|[Scatter](#scatter)|[Serie](#serie)| -|[SimplifiedBar](#simplifiedbar)|[SimplifiedCandlestick](#simplifiedcandlestick)|[SimplifiedLine](#simplifiedline)| +- [Bar](#bar) +- [BaseScatter](#basescatter) +- [Candlestick](#candlestick) +- [EffectScatter](#effectscatter) +- [Heatmap](#heatmap) +- [Line](#line) +- [Parallel](#parallel) +- [Pie](#pie) +- [Radar](#radar) +- [Ring](#ring) +- [Scatter](#scatter) +- [Serie](#serie) +- [SimplifiedBar](#simplifiedbar) +- [SimplifiedCandlestick](#simplifiedcandlestick) +- [SimplifiedLine](#simplifiedline) + ## Theme 主题 -||||| -|--|--|--|--| -|[AngleAxisTheme](#angleaxistheme)|[AxisTheme](#axistheme)|[BaseAxisTheme](#baseaxistheme)|[ComponentTheme](#componenttheme)| -|[DataZoomTheme](#datazoomtheme)|[LegendTheme](#legendtheme)|[PolarAxisTheme](#polaraxistheme)|[RadarAxisTheme](#radaraxistheme)| -|[RadiusAxisTheme](#radiusaxistheme)|[SerieTheme](#serietheme)|[SubTitleTheme](#subtitletheme)|[Theme](#theme)| -|[ThemeStyle](#themestyle)|[TitleTheme](#titletheme)|[TooltipTheme](#tooltiptheme)|[VisualMapTheme](#visualmaptheme)| +- [AngleAxisTheme](#angleaxistheme) +- [AxisTheme](#axistheme) +- [BaseAxisTheme](#baseaxistheme) +- [ComponentTheme](#componenttheme) +- [DataZoomTheme](#datazoomtheme) +- [LegendTheme](#legendtheme) +- [PolarAxisTheme](#polaraxistheme) +- [RadarAxisTheme](#radaraxistheme) +- [RadiusAxisTheme](#radiusaxistheme) +- [SerieTheme](#serietheme) +- [SubTitleTheme](#subtitletheme) +- [Theme](#theme) +- [ThemeStyle](#themestyle) +- [TitleTheme](#titletheme) +- [TooltipTheme](#tooltiptheme) +- [VisualMapTheme](#visualmaptheme) + ## MainComponent 主组件 -||||| -|--|--|--|--| -|[AngleAxis](#angleaxis)|[Axis](#axis)|[Background](#background)|[CalendarCoord](#calendarcoord)| -|[Comment](#comment)|[CoordSystem](#coordsystem)|[DataZoom](#datazoom)|[GridCoord](#gridcoord)| -|[Legend](#legend)|[MarkArea](#markarea)|[MarkLine](#markline)|[ParallelAxis](#parallelaxis)| -|[ParallelCoord](#parallelcoord)|[PolarCoord](#polarcoord)|[RadarCoord](#radarcoord)|[RadiusAxis](#radiusaxis)| -|[Settings](#settings)|[SingleAxis](#singleaxis)|[SingleAxisCoord](#singleaxiscoord)|[Title](#title)| -|[Tooltip](#tooltip)|[VisualMap](#visualmap)|[XAxis](#xaxis)|[YAxis](#yaxis)| +- [AngleAxis](#angleaxis) +- [Axis](#axis) +- [Background](#background) +- [CalendarCoord](#calendarcoord) +- [Comment](#comment) +- [CoordSystem](#coordsystem) +- [DataZoom](#datazoom) +- [GridCoord](#gridcoord) +- [Legend](#legend) +- [MarkArea](#markarea) +- [MarkLine](#markline) +- [ParallelAxis](#parallelaxis) +- [ParallelCoord](#parallelcoord) +- [PolarCoord](#polarcoord) +- [RadarCoord](#radarcoord) +- [RadiusAxis](#radiusaxis) +- [Settings](#settings) +- [SingleAxis](#singleaxis) +- [SingleAxisCoord](#singleaxiscoord) +- [Title](#title) +- [Tooltip](#tooltip) +- [VisualMap](#visualmap) +- [XAxis](#xaxis) +- [YAxis](#yaxis) + ## ChildComponent 子组件 -||||| -|--|--|--|--| -|[AngleAxisTheme](#angleaxistheme)|[AnimationStyle](#animationstyle)|[AreaStyle](#areastyle)|[ArrowStyle](#arrowstyle)| -|[AxisLabel](#axislabel)|[AxisLine](#axisline)|[AxisMinorSplitLine](#axisminorsplitline)|[AxisMinorTick](#axisminortick)| -|[AxisName](#axisname)|[AxisSplitArea](#axissplitarea)|[AxisSplitLine](#axissplitline)|[AxisTheme](#axistheme)| -|[AxisTick](#axistick)|[BaseAxisTheme](#baseaxistheme)|[BaseLine](#baseline)|[BlurStyle](#blurstyle)| -|[CommentItem](#commentitem)|[CommentMarkStyle](#commentmarkstyle)|[ComponentTheme](#componenttheme)|[DataZoomTheme](#datazoomtheme)| -|[EmphasisStyle](#emphasisstyle)|[EndLabelStyle](#endlabelstyle)|[IconStyle](#iconstyle)|[ImageStyle](#imagestyle)| -|[ItemStyle](#itemstyle)|[LabelLine](#labelline)|[LabelStyle](#labelstyle)|[LegendTheme](#legendtheme)| -|[Level](#level)|[LevelStyle](#levelstyle)|[LineArrow](#linearrow)|[LineStyle](#linestyle)| -|[Location](#location)|[MarkAreaData](#markareadata)|[MarkLineData](#marklinedata)|[MarqueeStyle](#marqueestyle)| -|[Padding](#padding)|[PolarAxisTheme](#polaraxistheme)|[RadarAxisTheme](#radaraxistheme)|[RadiusAxisTheme](#radiusaxistheme)| -|[SelectStyle](#selectstyle)|[SerieData](#seriedata)|[SerieSymbol](#seriesymbol)|[SerieTheme](#serietheme)| -|[StageColor](#stagecolor)|[StateStyle](#statestyle)|[SubTitleTheme](#subtitletheme)|[SymbolStyle](#symbolstyle)| -|[TextLimit](#textlimit)|[TextPadding](#textpadding)|[TextStyle](#textstyle)|[ThemeStyle](#themestyle)| -|[TitleStyle](#titlestyle)|[TitleTheme](#titletheme)|[TooltipTheme](#tooltiptheme)|[VisualMapRange](#visualmaprange)| -|[VisualMapTheme](#visualmaptheme)| +- [AngleAxisTheme](#angleaxistheme) +- [AnimationStyle](#animationstyle) +- [AreaStyle](#areastyle) +- [ArrowStyle](#arrowstyle) +- [AxisLabel](#axislabel) +- [AxisLine](#axisline) +- [AxisMinorSplitLine](#axisminorsplitline) +- [AxisMinorTick](#axisminortick) +- [AxisName](#axisname) +- [AxisSplitArea](#axissplitarea) +- [AxisSplitLine](#axissplitline) +- [AxisTheme](#axistheme) +- [AxisTick](#axistick) +- [BaseAxisTheme](#baseaxistheme) +- [BaseLine](#baseline) +- [BlurStyle](#blurstyle) +- [CommentItem](#commentitem) +- [CommentMarkStyle](#commentmarkstyle) +- [ComponentTheme](#componenttheme) +- [DataZoomTheme](#datazoomtheme) +- [EmphasisStyle](#emphasisstyle) +- [EndLabelStyle](#endlabelstyle) +- [IconStyle](#iconstyle) +- [ImageStyle](#imagestyle) +- [ItemStyle](#itemstyle) +- [LabelLine](#labelline) +- [LabelStyle](#labelstyle) +- [LegendTheme](#legendtheme) +- [Level](#level) +- [LevelStyle](#levelstyle) +- [LineArrow](#linearrow) +- [LineStyle](#linestyle) +- [Location](#location) +- [MarkAreaData](#markareadata) +- [MarkLineData](#marklinedata) +- [MarqueeStyle](#marqueestyle) +- [Padding](#padding) +- [PolarAxisTheme](#polaraxistheme) +- [RadarAxisTheme](#radaraxistheme) +- [RadiusAxisTheme](#radiusaxistheme) +- [SelectStyle](#selectstyle) +- [SerieData](#seriedata) +- [SerieSymbol](#seriesymbol) +- [SerieTheme](#serietheme) +- [StageColor](#stagecolor) +- [StateStyle](#statestyle) +- [SubTitleTheme](#subtitletheme) +- [SymbolStyle](#symbolstyle) +- [TextLimit](#textlimit) +- [TextPadding](#textpadding) +- [TextStyle](#textstyle) +- [ThemeStyle](#themestyle) +- [TitleStyle](#titlestyle) +- [TitleTheme](#titletheme) +- [TooltipTheme](#tooltiptheme) +- [VisualMapRange](#visualmaprange) +- [VisualMapTheme](#visualmaptheme) + ## ISerieComponent 可添加到Serie的组件 -||||| -|--|--|--|--| -|[AreaStyle](#areastyle)|[BlurStyle](#blurstyle)|[EmphasisStyle](#emphasisstyle)|[ImageStyle](#imagestyle)| -|[LabelLine](#labelline)|[LabelStyle](#labelstyle)|[LineArrow](#linearrow)|[SelectStyle](#selectstyle)| -|[TitleStyle](#titlestyle)| +- [AreaStyle](#areastyle) +- [BlurStyle](#blurstyle) +- [EmphasisStyle](#emphasisstyle) +- [ImageStyle](#imagestyle) +- [LabelLine](#labelline) +- [LabelStyle](#labelstyle) +- [LineArrow](#linearrow) +- [SelectStyle](#selectstyle) +- [TitleStyle](#titlestyle) + ## ISerieDataComponent 可添加到SerieData的组件 -||||| -|--|--|--|--| -|[AreaStyle](#areastyle)|[BlurStyle](#blurstyle)|[EmphasisStyle](#emphasisstyle)|[ImageStyle](#imagestyle)| -|[ItemStyle](#itemstyle)|[LabelLine](#labelline)|[LabelStyle](#labelstyle)|[LineStyle](#linestyle)| -|[SelectStyle](#selectstyle)|[SerieSymbol](#seriesymbol)|[TitleStyle](#titlestyle)| +- [AreaStyle](#areastyle) +- [BlurStyle](#blurstyle) +- [EmphasisStyle](#emphasisstyle) +- [ImageStyle](#imagestyle) +- [ItemStyle](#itemstyle) +- [LabelLine](#labelline) +- [LabelStyle](#labelstyle) +- [LineStyle](#linestyle) +- [SelectStyle](#selectstyle) +- [SerieSymbol](#seriesymbol) +- [TitleStyle](#titlestyle) + ## Other 其他组件 -||||| -|--|--|--|--| -|[BaseSerie](#baseserie)|[ChartText](#charttext)|[ChildComponent](#childcomponent)|[DebugInfo](#debuginfo)| -|[Indicator](#indicator)|[Lang](#lang)|[LangCandlestick](#langcandlestick)|[LangTime](#langtime)| -|[MainComponent](#maincomponent)|[XCResourcesImporter](#xcresourcesimporter)|[XCSettings](#xcsettings)| +- [BaseSerie](#baseserie) +- [ChartText](#charttext) +- [ChildComponent](#childcomponent) +- [DebugInfo](#debuginfo) +- [Indicator](#indicator) +- [Lang](#lang) +- [LangCandlestick](#langcandlestick) +- [LangTime](#langtime) +- [MainComponent](#maincomponent) +- [XCResourcesImporter](#xcresourcesimporter) +- [XCSettings](#xcsettings) + ## AngleAxis