diff --git a/Documentation~/en/api.md b/Documentation~/en/api.md
index 30e48d6a..7759c74e 100644
--- a/Documentation~/en/api.md
+++ b/Documentation~/en/api.md
@@ -7,10 +7,12 @@ slug: /api
## All Class
+- [Align](#align)
- [AngleAxis](#angleaxis)
- [AngleAxisTheme](#angleaxistheme)
- [AnimationAddition](#animationaddition)
- [AnimationChange](#animationchange)
+- [AnimationEasing](#animationeasing)
- [AnimationFadeIn](#animationfadein)
- [AnimationFadeOut](#animationfadeout)
- [AnimationHiding](#animationhiding)
@@ -19,9 +21,14 @@ slug: /api
- [AnimationInteraction](#animationinteraction)
- [AnimationStyle](#animationstyle)
- [AnimationStyleHelper](#animationstylehelper)
+- [AnimationType](#animationtype)
- [AreaStyle](#areastyle)
+- [AreaStyle.AreaOrigin](#areastyleareaorigin)
- [ArrowStyle](#arrowstyle)
- [Axis](#axis)
+- [Axis.AxisMinMaxType](#axisaxisminmaxtype)
+- [Axis.AxisPosition](#axisaxisposition)
+- [Axis.AxisType](#axisaxistype)
- [Axis3DHelper](#axis3dhelper)
- [AxisAnimation](#axisanimation)
- [AxisContext](#axiscontext)
@@ -39,6 +46,7 @@ slug: /api
- [Background](#background)
- [Bar](#bar)
- [BarChart](#barchart)
+- [BarType](#bartype)
- [BaseAxisTheme](#baseaxistheme)
- [BaseChart](#basechart)
- [BaseGraph](#basegraph)
@@ -70,6 +78,8 @@ slug: /api
- [CoordSystem](#coordsystem)
- [DataHelper](#datahelper)
- [DataZoom](#datazoom)
+- [DataZoom.FilterMode](#datazoomfiltermode)
+- [DataZoom.RangeMode](#datazoomrangemode)
- [DataZoomContext](#datazoomcontext)
- [DataZoomHelper](#datazoomhelper)
- [DataZoomTheme](#datazoomtheme)
@@ -80,6 +90,8 @@ slug: /api
- [DefineSymbolsUtil](#definesymbolsutil)
- [EffectScatter](#effectscatter)
- [EmphasisStyle](#emphasisstyle)
+- [EmphasisStyle.BlurScope](#emphasisstyleblurscope)
+- [EmphasisStyle.FocusType](#emphasisstylefocustype)
- [EndLabelStyle](#endlabelstyle)
- [FormatterHelper](#formatterhelper)
- [GraphData](#graphdata)
@@ -93,7 +105,9 @@ slug: /api
- [GridLayoutContext](#gridlayoutcontext)
- [Heatmap](#heatmap)
- [HeatmapChart](#heatmapchart)
+- [HeatmapType](#heatmaptype)
- [IconStyle](#iconstyle)
+- [IconStyle.Layer](#iconstylelayer)
- [IgnoreDoc](#ignoredoc)
- [ImageStyle](#imagestyle)
- [Indicator](#indicator)
@@ -109,12 +123,16 @@ slug: /api
- [IUpdateRuntimeData](#iupdateruntimedata)
- [JsonUtil](#jsonutil)
- [LabelLine](#labelline)
+- [LabelLine.LineType](#labellinelinetype)
- [LabelStyle](#labelstyle)
+- [LabelStyle.Position](#labelstyleposition)
- [Lang](#lang)
- [LangCandlestick](#langcandlestick)
- [LangTime](#langtime)
- [LayerHelper](#layerhelper)
- [Legend](#legend)
+- [Legend.SelectedMode](#legendselectedmode)
+- [Legend.Type](#legendtype)
- [LegendContext](#legendcontext)
- [LegendHelper](#legendhelper)
- [LegendItem](#legenditem)
@@ -123,28 +141,37 @@ slug: /api
- [LevelStyle](#levelstyle)
- [Line](#line)
- [LineArrow](#linearrow)
+- [LineArrow.Position](#linearrowposition)
- [LineChart](#linechart)
- [LineHelper](#linehelper)
- [LineStyle](#linestyle)
+- [LineStyle.Type](#linestyletype)
+- [LineType](#linetype)
- [ListFor](#listfor)
- [ListForComponent](#listforcomponent)
- [ListForSerie](#listforserie)
- [ListPool<T>](#listpoolt)
- [Location](#location)
+- [Location.Align](#locationalign)
- [MainComponent](#maincomponent)
- [MainComponentContext](#maincomponentcontext)
- [MainComponentHandler](#maincomponenthandler)
- [MainComponentHandler<T>](#maincomponenthandlert)
- [MarkArea](#markarea)
- [MarkAreaData](#markareadata)
+- [MarkAreaType](#markareatype)
- [MarkLine](#markline)
- [MarkLineData](#marklinedata)
+- [MarkLineType](#marklinetype)
- [MarqueeStyle](#marqueestyle)
- [MathUtil](#mathutil)
- [MLValue](#mlvalue)
+- [MLValue.Type](#mlvaluetype)
- [MonoBehaviour](#monobehaviour)
+- [Orient](#orient)
- [Padding](#padding)
- [Painter](#painter)
+- [Painter.Type](#paintertype)
- [Parallel](#parallel)
- [ParallelAxis](#parallelaxis)
- [ParallelChart](#parallelchart)
@@ -161,18 +188,24 @@ slug: /api
- [RadarAxisTheme](#radaraxistheme)
- [RadarChart](#radarchart)
- [RadarCoord](#radarcoord)
+- [RadarCoord.PositionType](#radarcoordpositiontype)
+- [RadarCoord.Shape](#radarcoordshape)
- [RadarCoordContext](#radarcoordcontext)
+- [RadarType](#radartype)
- [RadiusAxis](#radiusaxis)
- [RadiusAxisTheme](#radiusaxistheme)
- [ReflectionUtil](#reflectionutil)
- [RequireChartComponentAttribute](#requirechartcomponentattribute)
- [Ring](#ring)
- [RingChart](#ringchart)
+- [RoseType](#rosetype)
- [RuntimeUtil](#runtimeutil)
+- [SampleType](#sampletype)
- [Scatter](#scatter)
- [ScatterChart](#scatterchart)
- [SelectStyle](#selectstyle)
- [Serie](#serie)
+- [SerieColorBy](#seriecolorby)
- [SerieComponentAttribute](#seriecomponentattribute)
- [SerieContext](#seriecontext)
- [SerieConvertAttribute](#serieconvertattribute)
@@ -181,6 +214,7 @@ slug: /api
- [SerieDataContext](#seriedatacontext)
- [SerieDataExtraFieldAttribute](#seriedataextrafieldattribute)
- [SerieDataLink](#seriedatalink)
+- [SerieDataSortType](#seriedatasorttype)
- [SerieEventData](#serieeventdata)
- [SerieEventDataPool](#serieeventdatapool)
- [SerieHandler](#seriehandler)
@@ -191,6 +225,7 @@ slug: /api
- [SerieLabelPool](#serielabelpool)
- [SerieParams](#serieparams)
- [SeriesHelper](#serieshelper)
+- [SerieState](#seriestate)
- [SerieSymbol](#seriesymbol)
- [SerieTheme](#serietheme)
- [Settings](#settings)
@@ -209,16 +244,24 @@ slug: /api
- [SVG](#svg)
- [SVGPath](#svgpath)
- [SVGPathSeg](#svgpathseg)
+- [SVGPathSegType](#svgpathsegtype)
+- [SymbolSizeType](#symbolsizetype)
- [SymbolStyle](#symbolstyle)
+- [SymbolType](#symboltype)
- [TextLimit](#textlimit)
- [TextPadding](#textpadding)
- [TextStyle](#textstyle)
- [Theme](#theme)
- [ThemeStyle](#themestyle)
+- [ThemeType](#themetype)
- [Title](#title)
- [TitleStyle](#titlestyle)
- [TitleTheme](#titletheme)
- [Tooltip](#tooltip)
+- [Tooltip.Position](#tooltipposition)
+- [Tooltip.Trigger](#tooltiptrigger)
+- [Tooltip.TriggerOn](#tooltiptriggeron)
+- [Tooltip.Type](#tooltiptype)
- [TooltipContext](#tooltipcontext)
- [TooltipData](#tooltipdata)
- [TooltipHelper](#tooltiphelper)
@@ -226,6 +269,7 @@ slug: /api
- [TooltipView](#tooltipview)
- [TooltipViewItem](#tooltipviewitem)
- [UGL](#ugl)
+- [UGL.Direction](#ugldirection)
- [UGLExample](#uglexample)
- [UGLHelper](#uglhelper)
- [UIComponent](#uicomponent)
@@ -233,6 +277,8 @@ slug: /api
- [UIHelper](#uihelper)
- [ViewControl](#viewcontrol)
- [VisualMap](#visualmap)
+- [VisualMap.SelectedMode](#visualmapselectedmode)
+- [VisualMap.Type](#visualmaptype)
- [VisualMapContext](#visualmapcontext)
- [VisualMapHelper](#visualmaphelper)
- [VisualMapRange](#visualmaprange)
@@ -251,30 +297,48 @@ slug: /api
- [ZAxis3D](#zaxis3d)
+## Align
+
+class in XCharts.Runtime
+
+Alignment mode.
+
+Options:
+
+- `Center`: Alignment mode.
+- `Left`: Alignment mode.
+- `Right`: Alignment mode.
+
## AngleAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
Angle axis of Polar Coordinate.
-|public method|since|description|
-|--|--|--|
-|GetValueAngle()||public float GetValueAngle(double value)|
-|GetValueAngle()||public float GetValueAngle(float value)|
-|SetDefaultValue()||public override void SetDefaultValue()|
+### AngleAxis.GetValueAngle
+
+public float GetValueAngle(double value)
+
+
+### AngleAxis.SetDefaultValue
+
+public override void SetDefaultValue()
## AngleAxisTheme
-> class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+### AngleAxisTheme.base(theme)
-|public method|since|description|
-|--|--|--|
-|AngleAxisTheme()||public AngleAxisTheme(ThemeType theme) : base(theme) { }|
+public AngleAxisTheme(ThemeType theme) : base(theme)
+
+### AngleAxisTheme.AngleAxisTheme
+
+public AngleAxisTheme(ThemeType theme) : base(theme) { }
## AnimationAddition
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
@@ -282,15 +346,23 @@ Data addition animation.
## AnimationChange
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
Data change animation.
+## AnimationEasing
+
+class in XCharts.Runtime
+
+Options:
+
+- `Linear`:
+
## AnimationFadeIn
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
@@ -298,7 +370,7 @@ Fade in animation.
## AnimationFadeOut
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
@@ -306,7 +378,7 @@ Fade out animation.
## AnimationHiding
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
@@ -314,666 +386,2354 @@ Data hiding animation.
## AnimationInfo
-> class in XCharts.Runtime / Subclasses: [AnimationFadeIn](#animationfadein),[AnimationFadeOut](#animationfadeout),[AnimationChange](#animationchange),[AnimationAddition](#animationaddition),[AnimationHiding](#animationhiding),[AnimationInteraction](#animationinteraction)
+class in XCharts.Runtime / Subclasses: [AnimationFadeIn](#animationfadein),[AnimationFadeOut](#animationfadeout),[AnimationChange](#animationchange),[AnimationAddition](#animationaddition),[AnimationHiding](#animationhiding),[AnimationInteraction](#animationinteraction)
> Since `v3.8.0`
the animation info.
-|public method|since|description|
-|--|--|--|
-|End()||public void End()
End animation. |
-|GetIndexDelay()||public float GetIndexDelay(int dataIndex)
Get animation delay. |
-|Init()||public bool Init(float curr, float dest, int totalPointIndex)
Initialize animation. |
-|IsFinish()||public bool IsFinish()
Whether animation is finish. |
-|IsInDelay()||public bool IsInDelay()
Whether animation is in delay. |
-|IsInIndexDelay()||public bool IsInIndexDelay(int dataIndex)
Whether animation is in index delay. |
-|Pause()||public void Pause()
Pause animation. |
-|Reset()||public void Reset()
Reset animation. |
-|Resume()||public void Resume()
Resume animation. |
-|Start()||public void Start(bool reset = true)
Start animation. |
+### AnimationInfo.delay
+
+public float delay
+the delay time before animation start.
+
+### AnimationInfo.delayFunction
+
+public AnimationDelayFunction delayFunction
+the delegate function of animation delay.
+
+### AnimationInfo.duration
+
+public float duration
+the duration of animation.
+
+### AnimationInfo.durationFunction
+
+public AnimationDurationFunction durationFunction
+the delegate function of animation duration.
+
+### AnimationInfo.enable
+
+public bool enable
+whether enable animation.
+
+### AnimationInfo.OnAnimationEnd
+
+public Action OnAnimationEnd
+the callback function of animation end.
+
+### AnimationInfo.OnAnimationStart
+
+public Action OnAnimationStart
+the callback function of animation start.
+
+### AnimationInfo.reverse
+
+public bool reverse
+whether enable reverse animation.
+
+### AnimationInfo.End
+
+public void End()
+End animation.
+
+### AnimationInfo.GetIndexDelay
+
+public float GetIndexDelay(int dataIndex)
+Get animation delay.
+
+### AnimationInfo.Init
+
+public bool Init(float curr, float dest, int totalPointIndex)
+Initialize animation.
+
+### AnimationInfo.IsFinish
+
+public bool IsFinish()
+Whether animation is finish.
+
+### AnimationInfo.IsInDelay
+
+public bool IsInDelay()
+Whether animation is in delay.
+
+### AnimationInfo.IsInIndexDelay
+
+public bool IsInIndexDelay(int dataIndex)
+Whether animation is in index delay.
+
+### AnimationInfo.Pause
+
+public void Pause()
+Pause animation.
+
+### AnimationInfo.Reset
+
+public void Reset()
+Reset animation.
+
+### AnimationInfo.Resume
+
+public void Resume()
+Resume animation.
+
+### AnimationInfo.Start
+
+public void Start(bool reset = true)
+Start animation.
## AnimationInfoContext
-> class in XCharts.Runtime
-
+class in XCharts.Runtime
## AnimationInteraction
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
Interactive animation of charts.
-|public method|since|description|
-|--|--|--|
-|GetOffset()||public float GetOffset()|
-|GetOffset()||public float GetOffset(float total)|
-|GetRadius()||public float GetRadius(float radius)|
-|GetWidth()||public float GetWidth(float width)|
+### AnimationInteraction.offset
+
+public MLValue offset
+the mlvalue of offset. Such as the offset of the pie chart when the sector is selected.
+
+### AnimationInteraction.radius
+
+public MLValue radius
+the mlvalue of radius.
+
+### AnimationInteraction.width
+
+public MLValue width
+the mlvalue of width.
+
+### AnimationInteraction.GetOffset
+
+public float GetOffset()
+
+
+### AnimationInteraction.GetRadius
+
+public float GetRadius(float radius)
+
+### AnimationInteraction.GetWidth
+
+public float GetWidth(float width)
## AnimationStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
the animation of serie. support animation type: fadeIn, fadeOut, change, addition.
-|public method|since|description|
-|--|--|--|
-|Addition()||public void Addition()
Start additon animation. |
-|CanCheckInteract()||public bool CanCheckInteract()|
-|CheckDetailBreak()||public bool CheckDetailBreak(float detail)|
-|CheckDetailBreak()||public bool CheckDetailBreak(Vector3 pos, bool isYAxis)|
-|CheckProgress()||public void CheckProgress()|
-|CheckProgress()||public void CheckProgress(double total)|
-|CheckSymbol()||public void CheckSymbol(float dest)|
-|FadeIn()||public void FadeIn()
Start fadein animation. |
-|FadeOut()||public void FadeOut()
Start fadeout animation. |
-|GetAdditionDuration()||public float GetAdditionDuration()|
-|GetChangeDuration()||public float GetChangeDuration()|
-|GetCurrDetail()||public float GetCurrDetail()|
-|GetCurrIndex()||public int GetCurrIndex()|
-|GetCurrRate()||public float GetCurrRate()|
-|GetInteractionDuration()||public float GetInteractionDuration()|
-|GetInteractionRadius()||public float GetInteractionRadius(float radius)|
-|GetSysmbolSize()||public float GetSysmbolSize(float dest)|
-|HasFadeOut()||public bool HasFadeOut()|
-|InitProgress()||public void InitProgress(float curr, float dest)
Initialize animation configuration. |
-|InitProgress()||public void InitProgress(List<Vector3> paths, bool isY)
Initialize animation configuration. |
-|IsDataAnimation()||public bool IsDataAnimation()
whther animaiton is data animation. BottomToTop and InsideOut are data animation. |
-|IsEnd()||public bool IsEnd()|
-|IsFadeIn()||public bool IsFadeIn()|
-|IsFadeOut()||public bool IsFadeOut()|
-|IsFinish()||public bool IsFinish()|
-|IsInDelay()||public bool IsInDelay()|
-|IsSerieAnimation()||public bool IsSerieAnimation()
whther animaiton is serie animation. LeftToRight, AlongPath and Clockwise are serie animation. |
-|Pause()||public void Pause()
Pause all animations. |
-|Reset()||public void Reset()
Reset all animations. |
-|Restart()||public void Restart()
Restart the actived animation. |
-|Resume()||public void Resume()
Resume all animations. |
+### AnimationStyle.addition
+
+public AnimationAddition addition
+Add data animation configuration.
+
+### AnimationStyle.change
+
+public AnimationChange change
+Update data animation configuration.
+
+### AnimationStyle.enable
+
+public bool enable
+Whether to enable animation.
+
+### AnimationStyle.fadeIn
+
+public AnimationFadeIn fadeIn
+Fade in animation configuration.
+
+### AnimationStyle.fadeInFinishCallback
+
+public Action fadeInFinishCallback
+
+### AnimationStyle.fadeOut
+
+public AnimationFadeOut fadeOut
+Fade out animation configuration.
+
+### AnimationStyle.fadeOutFinishCallback
+
+public Action fadeOutFinishCallback
+
+### AnimationStyle.hiding
+
+public AnimationHiding hiding
+Data hiding animation configuration.
+
+### AnimationStyle.interaction
+
+public AnimationInteraction interaction
+Interaction animation configuration.
+
+### AnimationStyle.threshold
+
+public int threshold
+Whether to set graphic number threshold to animation. Animation will be disabled when graphic number is larger than threshold.
+
+### AnimationStyle.unscaledTime
+
+public bool unscaledTime
+Animation updates independently of Time.timeScale.
+
+### AnimationStyle.Addition
+
+public void Addition()
+Start additon animation.
+
+### AnimationStyle.CanCheckInteract
+
+public bool CanCheckInteract()
+
+### AnimationStyle.CheckDetailBreak
+
+public bool CheckDetailBreak(Vector3 pos, bool isYAxis)
+
+
+### AnimationStyle.CheckProgress
+
+public void CheckProgress(double total)
+
+
+### AnimationStyle.CheckSymbol
+
+public void CheckSymbol(float dest)
+
+### AnimationStyle.FadeIn
+
+public void FadeIn()
+Start fadein animation.
+
+### AnimationStyle.FadeOut
+
+public void FadeOut()
+Start fadeout animation.
+
+### AnimationStyle.GetAdditionDuration
+
+public float GetAdditionDuration()
+
+### AnimationStyle.GetChangeDuration
+
+public float GetChangeDuration()
+
+### AnimationStyle.GetCurrDetail
+
+public float GetCurrDetail()
+
+### AnimationStyle.GetCurrIndex
+
+public int GetCurrIndex()
+
+### AnimationStyle.GetCurrRate
+
+public float GetCurrRate()
+
+### AnimationStyle.GetInteractionDuration
+
+public float GetInteractionDuration()
+
+### AnimationStyle.GetInteractionRadius
+
+public float GetInteractionRadius(float radius)
+
+### AnimationStyle.GetSysmbolSize
+
+public float GetSysmbolSize(float dest)
+
+### AnimationStyle.HasFadeOut
+
+public bool HasFadeOut()
+
+### AnimationStyle.InitProgress
+
+public void InitProgress(List<Vector3> paths, bool isY)
+Initialize animation configuration.
+
+
+### AnimationStyle.IsDataAnimation
+
+public bool IsDataAnimation()
+whther animaiton is data animation. BottomToTop and InsideOut are data animation.
+
+### AnimationStyle.IsEnd
+
+public bool IsEnd()
+
+### AnimationStyle.IsFadeIn
+
+public bool IsFadeIn()
+
+### AnimationStyle.IsFadeOut
+
+public bool IsFadeOut()
+
+### AnimationStyle.IsFinish
+
+public bool IsFinish()
+
+### AnimationStyle.IsInDelay
+
+public bool IsInDelay()
+
+### AnimationStyle.IsSerieAnimation
+
+public bool IsSerieAnimation()
+whther animaiton is serie animation. LeftToRight, AlongPath and Clockwise are serie animation.
+
+### AnimationStyle.Pause
+
+public void Pause()
+Pause all animations.
+
+### AnimationStyle.Reset
+
+public void Reset()
+Reset all animations.
+
+### AnimationStyle.Restart
+
+public void Restart()
+Restart the actived animation.
+
+### AnimationStyle.Resume
+
+public void Resume()
+Resume all animations.
## AnimationStyleHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### AnimationStyleHelper.CheckDataAnimation
-|public method|since|description|
-|--|--|--|
-|CheckDataAnimation()||public static float CheckDataAnimation(BaseChart chart, Serie serie, int dataIndex, float destProgress, float startPorgress = 0)|
-|GetAnimationPosition()||public static bool GetAnimationPosition(AnimationStyle animation, bool isY, Vector3 lp, Vector3 cp, float progress, ref Vector3 ip, ref float rate)|
-|UpdateAnimationType()||public static void UpdateAnimationType(AnimationStyle animation, AnimationType defaultType, bool enableSerieDataAnimation)|
-|UpdateSerieAnimation()||public static void UpdateSerieAnimation(Serie serie)|
+public static float CheckDataAnimation(BaseChart chart, Serie serie, int dataIndex, float destProgress, float startPorgress = 0)
+
+### AnimationStyleHelper.GetAnimationPosition
+
+public static bool GetAnimationPosition(AnimationStyle animation, bool isY, Vector3 lp, Vector3 cp, float progress, ref Vector3 ip, ref float rate)
+
+### AnimationStyleHelper.UpdateAnimationType
+
+public static void UpdateAnimationType(AnimationStyle animation, AnimationType defaultType, bool enableSerieDataAnimation)
+
+### AnimationStyleHelper.UpdateSerieAnimation
+
+public static void UpdateSerieAnimation(Serie serie)
+
+## AnimationType
+
+class in XCharts.Runtime
+
+Options:
+
+- `Default`: he default. An animation playback mode will be selected according to the actual situation.
+- `LeftToRight`: Play the animation from left to right.
+- `BottomToTop`: Play the animation from bottom to top.
+- `InsideOut`: Play animations from the inside out.
+- `AlongPath`: Play the animation along the path.
+- `Clockwise`: Play the animation clockwise.
## AreaStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
The style of area.
-|public method|since|description|
-|--|--|--|
-|GetColor()||public Color32 GetColor()|
-|GetColor()||public Color32 GetColor(Color32 themeColor)|
+### AreaStyle.GetColor
+
+public Color32 GetColor(Color32 themeColor)
+
+
+## AreaStyle.AreaOrigin
+
+class in XCharts.Runtime
+
+Origin position of area.
+
+Options:
+
+- `Auto`: to fill between axis line to data.
+- `Start`: to fill between min axis value (when not inverse) to data.
+- `End`: to fill between max axis value (when not inverse) to data.
## ArrowStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+### ArrowStyle.Clone
-|public method|since|description|
-|--|--|--|
-|Clone()||public ArrowStyle Clone()|
-|Copy()||public void Copy(ArrowStyle arrow)|
-|GetColor()||public Color32 GetColor(Color32 defaultColor)|
+public ArrowStyle Clone()
+
+### ArrowStyle.Copy
+
+public void Copy(ArrowStyle arrow)
+
+### ArrowStyle.GetColor
+
+public Color32 GetColor(Color32 defaultColor)
## Axis
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent) / Subclasses: [AngleAxis](#angleaxis),[ParallelAxis](#parallelaxis),[RadiusAxis](#radiusaxis),[SingleAxis](#singleaxis),[XAxis](#xaxis),[XAxis3D](#xaxis3d),[YAxis](#yaxis),[YAxis3D](#yaxis3d),[ZAxis3D](#zaxis3d)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent) / Subclasses: [AngleAxis](#angleaxis),[ParallelAxis](#parallelaxis),[RadiusAxis](#radiusaxis),[SingleAxis](#singleaxis),[XAxis](#xaxis),[XAxis3D](#xaxis3d),[YAxis](#yaxis),[YAxis3D](#yaxis3d),[ZAxis3D](#zaxis3d)
The axis in rectangular coordinate.
-|public method|since|description|
-|--|--|--|
-|AddData()||public void AddData(string category)
添加一个类目到类目数据列表 |
-|AddIcon()||public void AddIcon(Sprite icon)
添加图标 |
-|ClearComponentDirty()||public override void ClearComponentDirty()|
-|ClearData()||public override void ClearData()
清空类目数据 |
-|ClearVerticesDirty()||public override void ClearVerticesDirty()|
-|Clone()||public Axis Clone()|
-|Copy()||public void Copy(Axis axis)|
-|GetAddedDataCount()||public int GetAddedDataCount()
get the history data count. |
-|GetCategoryPosition()||public Vector3 GetCategoryPosition(int categoryIndex, int dataCount = 0)|
-|GetData()||public string GetData(int index)
获得指定索引的类目数据 |
-|GetData()||public string GetData(int index, DataZoom dataZoom)
获得在dataZoom范围内指定索引的类目数据 |
-|GetDistance()||public float GetDistance(double value, float axisLength = 0)
获得值在坐标轴上的距离 |
-|GetIcon()||public Sprite GetIcon(int index)|
-|GetLabelValue()||public double GetLabelValue(int index)|
-|GetLastLabelValue()||public double GetLastLabelValue()|
-|GetLogMaxIndex()||public double GetLogMaxIndex()|
-|GetLogMinIndex()||public double GetLogMinIndex()|
-|GetLogValue()||public float GetLogValue(double value)|
-|GetValueLength()||public float GetValueLength(double value, float axisLength)|
-|IsBottom()||public bool IsBottom()|
-|IsCategory()||public bool IsCategory()
是否为类目轴。 |
-|IsLeft()||public bool IsLeft()|
-|IsLog()||public bool IsLog()
是否为对数轴。 |
-|IsNeedShowLabel()||public bool IsNeedShowLabel(int index, int total = 0)|
-|IsRight()||public bool IsRight()|
-|IsTime()||public bool IsTime()
是否为时间轴。 |
-|IsTop()||public bool IsTop()|
-|IsValue()||public bool IsValue()
是否为数值轴。 |
-|RemoveData()||public void RemoveData(int dataIndex)|
-|ResetStatus()||public override void ResetStatus()
重置状态。 |
-|SetComponentDirty()||public override void SetComponentDirty()|
-|SetNeedUpdateFilterData()||public void SetNeedUpdateFilterData()|
-|UpdateData()||public void UpdateData(int index, string category)
更新类目数据 |
-|UpdateIcon()||public void UpdateIcon(int index, Sprite icon)
更新图标 |
-|UpdateZeroOffset()||public void UpdateZeroOffset(float axisLength)|
+### Axis.AddData
+
+public void AddData(string category)
+添加一个类目到类目数据列表
+
+### Axis.AddIcon
+
+public void AddIcon(Sprite icon)
+添加图标
+
+### Axis.ClearComponentDirty
+
+public override void ClearComponentDirty()
+
+### Axis.ClearData
+
+public override void ClearData()
+清空类目数据
+
+### Axis.ClearVerticesDirty
+
+public override void ClearVerticesDirty()
+
+### Axis.Clone
+
+public Axis Clone()
+
+### Axis.Copy
+
+public void Copy(Axis axis)
+
+### Axis.GetAddedDataCount
+
+public int GetAddedDataCount()
+get the history data count.
+
+### Axis.GetCategoryPosition
+
+public Vector3 GetCategoryPosition(int categoryIndex, int dataCount = 0)
+
+### Axis.GetData
+
+public string GetData(int index, DataZoom dataZoom)
+获得在dataZoom范围内指定索引的类目数据
+
+
+### Axis.GetDistance
+
+public float GetDistance(double value, float axisLength = 0)
+获得值在坐标轴上的距离
+
+### Axis.GetIcon
+
+public Sprite GetIcon(int index)
+
+### Axis.GetLabelValue
+
+public double GetLabelValue(int index)
+
+### Axis.GetLastLabelValue
+
+public double GetLastLabelValue()
+
+### Axis.GetLogMaxIndex
+
+public double GetLogMaxIndex()
+
+### Axis.GetLogMinIndex
+
+public double GetLogMinIndex()
+
+### Axis.GetLogValue
+
+public float GetLogValue(double value)
+
+### Axis.GetValueLength
+
+public float GetValueLength(double value, float axisLength)
+
+### Axis.IsBottom
+
+public bool IsBottom()
+
+### Axis.IsCategory
+
+public bool IsCategory()
+是否为类目轴。
+
+### Axis.IsLeft
+
+public bool IsLeft()
+
+### Axis.IsLog
+
+public bool IsLog()
+是否为对数轴。
+
+### Axis.IsNeedShowLabel
+
+public bool IsNeedShowLabel(int index, int total = 0)
+
+### Axis.IsRight
+
+public bool IsRight()
+
+### Axis.IsTime
+
+public bool IsTime()
+是否为时间轴。
+
+### Axis.IsTop
+
+public bool IsTop()
+
+### Axis.IsValue
+
+public bool IsValue()
+是否为数值轴。
+
+### Axis.RemoveData
+
+public void RemoveData(int dataIndex)
+
+### Axis.ResetStatus
+
+public override void ResetStatus()
+重置状态。
+
+### Axis.SetComponentDirty
+
+public override void SetComponentDirty()
+
+### Axis.SetNeedUpdateFilterData
+
+public void SetNeedUpdateFilterData()
+
+### Axis.UpdateData
+
+public void UpdateData(int index, string category)
+更新类目数据
+
+### Axis.UpdateIcon
+
+public void UpdateIcon(int index, Sprite icon)
+更新图标
+
+### Axis.UpdateZeroOffset
+
+public void UpdateZeroOffset(float axisLength)
+
+## Axis.AxisMinMaxType
+
+class in XCharts.Runtime
+
+the type of axis min and max value.
+
+Options:
+
+- `Default`: 0 - maximum.
+- `MinMax`: minimum - maximum.
+- `Custom`: Customize the minimum and maximum.
+- `MinMaxAuto`: [since("v3.7.0")]minimum - maximum, automatically calculate the appropriate values.
+
+## Axis.AxisPosition
+
+class in XCharts.Runtime
+
+the position of axis in grid.
+
+Options:
+
+- `Left`: the position of axis in grid.
+- `Right`: the position of axis in grid.
+- `Bottom`: the position of axis in grid.
+- `Top`: the position of axis in grid.
+- `Center`: the position of axis in grid.
+
+## Axis.AxisType
+
+class in XCharts.Runtime
+
+the type of axis.
+
+Options:
+
+- `Value`: Numerical axis, suitable for continuous data.
+- `Category`: Category axis, suitable for discrete category data. Data should only be set via data for this type.
+- `Log`: Log axis, suitable for log data.
+- `Time`: Time axis, suitable for continuous time series data.
## Axis3DHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### Axis3DHelper.Get3DGridPosition
+
+public static Vector3 Get3DGridPosition(GridCoord3D grid, XAxis3D xAxis, YAxis3D yAxis, double xValue, double yValue)
-|public method|since|description|
-|--|--|--|
-|Get3DGridPosition()||public static Vector3 Get3DGridPosition(GridCoord3D grid, XAxis3D xAxis, YAxis3D yAxis, double xValue, double yValue)|
-|Get3DGridPosition()||public static Vector3 Get3DGridPosition(GridCoord3D grid, XAxis3D xAxis, YAxis3D yAxis, ZAxis3D zAxis, double xValue, double yValue, double zValue)|
-|GetLabelPosition()||public static Vector3 GetLabelPosition(int i, Axis axis, Axis relativedAxis, AxisTheme theme, float scaleWid)|
+### Axis3DHelper.GetLabelPosition
+
+public static Vector3 GetLabelPosition(int i, Axis axis, Axis relativedAxis, AxisTheme theme, float scaleWid)
## AxisAnimation
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.9.0`
animation style of axis.
-|public method|since|description|
-|--|--|--|
-|Clone()||public AxisAnimation Clone()|
-|Copy()||public void Copy(AxisAnimation animation)|
+### AxisAnimation.Clone
+
+public AxisAnimation Clone()
+
+### AxisAnimation.Copy
+
+public void Copy(AxisAnimation animation)
## AxisContext
-> class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
+class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
+### AxisContext.destMaxValue
+
+public double destMaxValue
+
+### AxisContext.destMinValue
+
+public double destMinValue
+
+### AxisContext.labelObjectList
+
+public List<ChartLabel> labelObjectList
+
+### AxisContext.labelValueList
+
+public List<double> labelValueList
+
+### AxisContext.lastMaxValue
+
+public double lastMaxValue
+the current maximum value.
+
+### AxisContext.lastMinValue
+
+public double lastMinValue
+the current minimun value.
+
+### AxisContext.needAnimation
+
+public bool needAnimation
+
+### AxisContext.runtimeData
+
+public List<string> runtimeData
+the tick value of value axis.
## AxisHandler<T>
-> class in XCharts / Inherits from: [MainComponentHandler](#maincomponenthandler)
+class in XCharts / Inherits from: [MainComponentHandler](#maincomponenthandler)
+### AxisHandler<T>.component
+
+public T component
## AxisHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### AxisHelper.AdjustCircleLabelPos
+
+public static void AdjustCircleLabelPos(ChartLabel txt, Vector3 pos, Vector3 cenPos, float txtHig, Vector3 offset)
+
+### AxisHelper.AdjustMinMaxValue
+
+public static void AdjustMinMaxValue(Axis axis, ref double minValue, ref double maxValue, bool needFormat, double ceilRate = 0)
+调整最大最小值
+
+### AxisHelper.AdjustRadiusAxisLabelPos
+
+public static void AdjustRadiusAxisLabelPos(ChartLabel txt, Vector3 pos, Vector3 cenPos, float txtHig, Vector3 offset)
+
+### AxisHelper.GetAxisLineArrowOffset
+
+public static float GetAxisLineArrowOffset(Axis axis)
+包含箭头偏移的轴线长度
+
+### AxisHelper.GetAxisPosition
+
+public static float GetAxisPosition(GridCoord grid, Axis axis, double value, int dataCount = 0, DataZoom dataZoom = null)
+
+### AxisHelper.GetAxisPositionValue
+
+public static double GetAxisPositionValue(float xy, float axisLength, double axisRange, float axisStart, float axisOffset)
-|public method|since|description|
-|--|--|--|
-|AdjustCircleLabelPos()||public static void AdjustCircleLabelPos(ChartLabel txt, Vector3 pos, Vector3 cenPos, float txtHig, Vector3 offset)|
-|AdjustMinMaxValue()||public static void AdjustMinMaxValue(Axis axis, ref double minValue, ref double maxValue, bool needFormat, double ceilRate = 0)
调整最大最小值 |
-|AdjustRadiusAxisLabelPos()||public static void AdjustRadiusAxisLabelPos(ChartLabel txt, Vector3 pos, Vector3 cenPos, float txtHig, Vector3 offset)|
-|GetAxisLineArrowOffset()||public static float GetAxisLineArrowOffset(Axis axis)
包含箭头偏移的轴线长度 |
-|GetAxisPosition()||public static float GetAxisPosition(GridCoord grid, Axis axis, double value, int dataCount = 0, DataZoom dataZoom = null)|
-|GetAxisPositionValue()||public static double GetAxisPositionValue(float xy, float axisLength, double axisRange, float axisStart, float axisOffset)|
-|GetAxisPositionValue()||public static double GetAxisPositionValue(GridCoord grid, Axis axis, Vector3 pos)|
-|GetAxisValueDistance()||public static float GetAxisValueDistance(GridCoord grid, Axis axis, float scaleWidth, double value)
获得数值value在坐标轴上相对起点的距离 |
-|GetAxisValueLength()||public static float GetAxisValueLength(GridCoord grid, Axis axis, float scaleWidth, double value)
获得数值value在坐标轴上对应的长度 |
-|GetAxisValuePosition()||public static float GetAxisValuePosition(GridCoord grid, Axis axis, float scaleWidth, double value)
获得数值value在坐标轴上的坐标位置 |
-|GetAxisValueSplitIndex()||public static int GetAxisValueSplitIndex(Axis axis, double value, bool checkMaxCache, int totalSplitNumber = -1)
获得数值value在坐标轴上对应的split索引 |
-|GetAxisXOrY()||public static float GetAxisXOrY(GridCoord grid, Axis axis, Axis relativedAxis)|
-|GetDataWidth()||public static float GetDataWidth(Axis axis, float coordinateWidth, int dataCount, DataZoom dataZoom)
获得一个类目数据在坐标系中代表的宽度 |
-|GetEachWidth()||public static float GetEachWidth(Axis axis, float coordinateWidth, DataZoom dataZoom = null)|
-|GetScaleNumber()||public static int GetScaleNumber(Axis axis, float coordinateWidth, DataZoom dataZoom = null)
获得分割线条数 |
-|GetScaleWidth()||public static float GetScaleWidth(Axis axis, float coordinateWidth, int index, DataZoom dataZoom = null)
获得分割段宽度 |
-|GetSplitNumber()||public static int GetSplitNumber(Axis axis, float coordinateWid, DataZoom dataZoom)
获得分割段数 |
-|GetTotalSplitGridNum()||public static int GetTotalSplitGridNum(Axis axis)
获得分割网格个数,包含次刻度 |
-|GetXAxisXOrY()||public static float GetXAxisXOrY(GridCoord grid, Axis xAxis, Axis relativedAxis)|
-|GetYAxisXOrY()||public static float GetYAxisXOrY(GridCoord grid, Axis yAxis, Axis relativedAxis)|
-|NeedShowSplit()||public static bool NeedShowSplit(Axis axis)|
+### AxisHelper.GetAxisValueDistance
+
+public static float GetAxisValueDistance(GridCoord grid, Axis axis, float scaleWidth, double value)
+获得数值value在坐标轴上相对起点的距离
+
+### AxisHelper.GetAxisValueLength
+
+public static float GetAxisValueLength(GridCoord grid, Axis axis, float scaleWidth, double value)
+获得数值value在坐标轴上对应的长度
+
+### AxisHelper.GetAxisValuePosition
+
+public static float GetAxisValuePosition(GridCoord grid, Axis axis, float scaleWidth, double value)
+获得数值value在坐标轴上的坐标位置
+
+### AxisHelper.GetAxisValueSplitIndex
+
+public static int GetAxisValueSplitIndex(Axis axis, double value, bool checkMaxCache, int totalSplitNumber = -1)
+获得数值value在坐标轴上对应的split索引
+
+### AxisHelper.GetAxisXOrY
+
+public static float GetAxisXOrY(GridCoord grid, Axis axis, Axis relativedAxis)
+
+### AxisHelper.GetDataWidth
+
+public static float GetDataWidth(Axis axis, float coordinateWidth, int dataCount, DataZoom dataZoom)
+获得一个类目数据在坐标系中代表的宽度
+
+### AxisHelper.GetEachWidth
+
+public static float GetEachWidth(Axis axis, float coordinateWidth, DataZoom dataZoom = null)
+
+### AxisHelper.GetScaleNumber
+
+public static int GetScaleNumber(Axis axis, float coordinateWidth, DataZoom dataZoom = null)
+获得分割线条数
+
+### AxisHelper.GetScaleWidth
+
+public static float GetScaleWidth(Axis axis, float coordinateWidth, int index, DataZoom dataZoom = null)
+获得分割段宽度
+
+### AxisHelper.GetSplitNumber
+
+public static int GetSplitNumber(Axis axis, float coordinateWid, DataZoom dataZoom)
+获得分割段数
+
+### AxisHelper.GetTotalSplitGridNum
+
+public static int GetTotalSplitGridNum(Axis axis)
+获得分割网格个数,包含次刻度
+
+### AxisHelper.GetXAxisXOrY
+
+public static float GetXAxisXOrY(GridCoord grid, Axis xAxis, Axis relativedAxis)
+
+### AxisHelper.GetYAxisXOrY
+
+public static float GetYAxisXOrY(GridCoord grid, Axis yAxis, Axis relativedAxis)
+
+### AxisHelper.NeedShowSplit
+
+public static bool NeedShowSplit(Axis axis)
## AxisLabel
-> class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle)
+class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle)
Settings related to axis label.
-|public method|since|description|
-|--|--|--|
-|ClearComponentDirty()||public override void ClearComponentDirty()|
-|Clone()||public new AxisLabel Clone()|
-|Copy()||public void Copy(AxisLabel axisLabel)|
-|GetFormatterContent()||public override string GetFormatterContent(int labelIndex, double value, double minValue, double maxValue, bool isLog = false)|
-|GetFormatterContent()||public override string GetFormatterContent(int labelIndex, string category)|
-|IsNeedShowLabel()||public bool IsNeedShowLabel(int index, int total)|
-|SetRelatedText()||public void SetRelatedText(ChartText txt, float labelWidth)|
+### AxisLabel.componentDirty
+
+public override bool componentDirty
+
+### AxisLabel.ClearComponentDirty
+
+public override void ClearComponentDirty()
+
+### AxisLabel.Clone
+
+public new AxisLabel Clone()
+
+### AxisLabel.Copy
+
+public void Copy(AxisLabel axisLabel)
+
+### AxisLabel.GetFormatterContent
+
+public override string GetFormatterContent(int labelIndex, double value, double minValue, double maxValue, bool isLog = false)
+
+
+### AxisLabel.IsNeedShowLabel
+
+public bool IsNeedShowLabel(int index, int total)
+
+### AxisLabel.SetRelatedText
+
+public void SetRelatedText(ChartText txt, float labelWidth)
## AxisLine
-> class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
+class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
Settings related to axis line.
-|public method|since|description|
-|--|--|--|
-|Clone()||public AxisLine Clone()|
-|Copy()||public void Copy(AxisLine axisLine)|
+### AxisLine.Clone
+
+public AxisLine Clone()
+
+### AxisLine.Copy
+
+public void Copy(AxisLine axisLine)
## AxisMinorSplitLine
-> class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
+class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
> Since `v3.2.0`
Minor split line of axis in grid area.
-|public method|since|description|
-|--|--|--|
-|ClearVerticesDirty()||public override void ClearVerticesDirty()|
-|Clone()||public AxisMinorSplitLine Clone()|
-|Copy()||public void Copy(AxisMinorSplitLine splitLine)|
+### AxisMinorSplitLine.autoColor
+
+public bool autoColor
+auto color.
+
+### AxisMinorSplitLine.distance
+
+public float distance
+The distance between the split line and axis line.
+
+### AxisMinorSplitLine.vertsDirty
+
+public override bool vertsDirty
+
+### AxisMinorSplitLine.ClearVerticesDirty
+
+public override void ClearVerticesDirty()
+
+### AxisMinorSplitLine.Clone
+
+public AxisMinorSplitLine Clone()
+
+### AxisMinorSplitLine.Copy
+
+public void Copy(AxisMinorSplitLine splitLine)
## AxisMinorTick
-> class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
+class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
> Since `v3.2.0`
Settings related to axis minor tick.
-|public method|since|description|
-|--|--|--|
-|ClearVerticesDirty()||public override void ClearVerticesDirty()|
-|Clone()||public AxisMinorTick Clone()|
-|Copy()||public void Copy(AxisMinorTick axisTick)|
+### AxisMinorTick.autoColor
+
+public bool autoColor
+
+### AxisMinorTick.vertsDirty
+
+public override bool vertsDirty
+
+### AxisMinorTick.ClearVerticesDirty
+
+public override void ClearVerticesDirty()
+
+### AxisMinorTick.Clone
+
+public AxisMinorTick Clone()
+
+### AxisMinorTick.Copy
+
+public void Copy(AxisMinorTick axisTick)
## AxisName
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
the name of axis.
-|public method|since|description|
-|--|--|--|
-|Clone()||public AxisName Clone()|
-|Copy()||public void Copy(AxisName axisName)|
+### AxisName.Clone
+
+public AxisName Clone()
+
+### AxisName.Copy
+
+public void Copy(AxisName axisName)
## AxisSplitArea
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
Split area of axis in grid area, not shown by default.
-|public method|since|description|
-|--|--|--|
-|Clone()||public AxisSplitArea Clone()|
-|Copy()||public void Copy(AxisSplitArea splitArea)|
-|GetColor()||public Color32 GetColor(int index, BaseAxisTheme theme)|
+### AxisSplitArea.Clone
+
+public AxisSplitArea Clone()
+
+### AxisSplitArea.Copy
+
+public void Copy(AxisSplitArea splitArea)
+
+### AxisSplitArea.GetColor
+
+public Color32 GetColor(int index, BaseAxisTheme theme)
## AxisSplitLine
-> class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
+class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
Split line of axis in grid area.
-|public method|since|description|
-|--|--|--|
-|ClearVerticesDirty()||public override void ClearVerticesDirty()|
-|Clone()||public AxisSplitLine Clone()|
-|Copy()||public void Copy(AxisSplitLine splitLine)|
+### AxisSplitLine.autoColor
+
+public bool autoColor
+auto color.
+
+### AxisSplitLine.distance
+
+public float distance
+The distance between the split line and axis line.
+
+### AxisSplitLine.vertsDirty
+
+public override bool vertsDirty
+
+### AxisSplitLine.ClearVerticesDirty
+
+public override void ClearVerticesDirty()
+
+### AxisSplitLine.Clone
+
+public AxisSplitLine Clone()
+
+### AxisSplitLine.Copy
+
+public void Copy(AxisSplitLine splitLine)
## AxisTheme
-> class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+### AxisTheme.base(theme)
-|public method|since|description|
-|--|--|--|
-|AxisTheme()||public AxisTheme(ThemeType theme) : base(theme) { }|
+public AxisTheme(ThemeType theme) : base(theme)
+
+### AxisTheme.AxisTheme
+
+public AxisTheme(ThemeType theme) : base(theme) { }
## AxisTick
-> class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
+class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
Settings related to axis tick.
-|public method|since|description|
-|--|--|--|
-|Clone()||public AxisTick Clone()|
-|Copy()||public void Copy(AxisTick axisTick)|
+### AxisTick.autoColor
+
+public bool autoColor
+
+### AxisTick.distance
+
+public float distance
+The distance between the tick line and axis line.
+
+### AxisTick.Clone
+
+public AxisTick Clone()
+
+### AxisTick.Copy
+
+public void Copy(AxisTick axisTick)
## Background
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
Background component.
-|public method|since|description|
-|--|--|--|
-|SetDefaultValue()||public override void SetDefaultValue()|
+### Background.SetDefaultValue
+
+public override void SetDefaultValue()
## Bar
-> class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+### Bar.containerIndex
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
-|ConvertSerie()||public static Bar ConvertSerie(Serie serie)|
+public int containerIndex
+
+### Bar.containterInstanceId
+
+public int containterInstanceId
+
+### Bar.AddDefaultSerie
+
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
+
+### Bar.ConvertSerie
+
+public static Bar ConvertSerie(Serie serie)
## BarChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
Bar chart shows different data through the height of a bar, which is used in rectangular coordinate with at least 1 category axis.
-|public method|since|description|
-|--|--|--|
-|DefaultBarChart()||public void DefaultBarChart()
default bar chart. |
-|DefaultCapsuleBarChart()||public void DefaultCapsuleBarChart()
default capsule bar chart. |
-|DefaultCapsuleColumnChart()||public void DefaultCapsuleColumnChart()
default capsule column chart. |
-|DefaultGroupedBarChart()||public void DefaultGroupedBarChart()
default grouped bar chart. |
-|DefaultGroupedColumnChart()||public void DefaultGroupedColumnChart()
default grouped column chart. |
-|DefaultPercentBarChart()||public void DefaultPercentBarChart()
default percent bar chart. |
-|DefaultPercentColumnChart()||public void DefaultPercentColumnChart()
default percent column chart. |
-|DefaultStackedBarChart()||public void DefaultStackedBarChart()
default stacked bar chart. |
-|DefaultStackedColumnChart()||public void DefaultStackedColumnChart()
default stacked column chart. |
-|DefaultZebraBarChart()||public void DefaultZebraBarChart()
default zebra bar chart. |
-|DefaultZebraColumnChart()||public void DefaultZebraColumnChart()
default zebra column chart. |
+### BarChart.DefaultBarChart
+
+public void DefaultBarChart()
+default bar chart.
+
+### BarChart.DefaultCapsuleBarChart
+
+public void DefaultCapsuleBarChart()
+default capsule bar chart.
+
+### BarChart.DefaultCapsuleColumnChart
+
+public void DefaultCapsuleColumnChart()
+default capsule column chart.
+
+### BarChart.DefaultGroupedBarChart
+
+public void DefaultGroupedBarChart()
+default grouped bar chart.
+
+### BarChart.DefaultGroupedColumnChart
+
+public void DefaultGroupedColumnChart()
+default grouped column chart.
+
+### BarChart.DefaultPercentBarChart
+
+public void DefaultPercentBarChart()
+default percent bar chart.
+
+### BarChart.DefaultPercentColumnChart
+
+public void DefaultPercentColumnChart()
+default percent column chart.
+
+### BarChart.DefaultStackedBarChart
+
+public void DefaultStackedBarChart()
+default stacked bar chart.
+
+### BarChart.DefaultStackedColumnChart
+
+public void DefaultStackedColumnChart()
+default stacked column chart.
+
+### BarChart.DefaultZebraBarChart
+
+public void DefaultZebraBarChart()
+default zebra bar chart.
+
+### BarChart.DefaultZebraColumnChart
+
+public void DefaultZebraColumnChart()
+default zebra column chart.
+
+## BarType
+
+class in XCharts.Runtime
+
+the type of bar.
+
+Options:
+
+- `Normal`: normal bar.
+- `Zebra`: zebra bar.
+- `Capsule`: capsule bar.
## BaseAxisTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme) / Subclasses: [AxisTheme](#axistheme),[RadiusAxisTheme](#radiusaxistheme),[AngleAxisTheme](#angleaxistheme),[PolarAxisTheme](#polaraxistheme),[RadarAxisTheme](#radaraxistheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme) / Subclasses: [AxisTheme](#axistheme),[RadiusAxisTheme](#radiusaxistheme),[AngleAxisTheme](#angleaxistheme),[PolarAxisTheme](#polaraxistheme),[RadarAxisTheme](#radaraxistheme)
+### BaseAxisTheme.BaseAxisTheme
-|public method|since|description|
-|--|--|--|
-|BaseAxisTheme()||public BaseAxisTheme(ThemeType theme) : base(theme)|
-|Copy()||public void Copy(BaseAxisTheme theme)|
+public BaseAxisTheme(ThemeType theme) : base(theme)
+
+### BaseAxisTheme.Copy
+
+public void Copy(BaseAxisTheme theme)
## BaseChart
-> class in XCharts.Runtime / Inherits from: [BaseGraph](#basegraph),[ISerializationCallbackReceiver](https://docs.unity3d.com/ScriptReference/30_search.html?q=iserializationcallbackreceiver) / Subclasses: [BarChart](#barchart),[CandlestickChart](#candlestickchart),[HeatmapChart](#heatmapchart),[LineChart](#linechart),[ParallelChart](#parallelchart),[PieChart](#piechart),[PolarChart](#polarchart),[RadarChart](#radarchart),[RingChart](#ringchart),[ScatterChart](#scatterchart),[SimplifiedBarChart](#simplifiedbarchart),[SimplifiedCandlestickChart](#simplifiedcandlestickchart),[SimplifiedLineChart](#simplifiedlinechart)
+class in XCharts.Runtime / Inherits from: [BaseGraph](#basegraph),[ISerializationCallbackReceiver](https://docs.unity3d.com/ScriptReference/30_search.html?q=iserializationcallbackreceiver) / Subclasses: [BarChart](#barchart),[CandlestickChart](#candlestickchart),[HeatmapChart](#heatmapchart),[LineChart](#linechart),[ParallelChart](#parallelchart),[PieChart](#piechart),[PolarChart](#polarchart),[RadarChart](#radarchart),[RingChart](#ringchart),[ScatterChart](#scatterchart),[SimplifiedBarChart](#simplifiedbarchart),[SimplifiedCandlestickChart](#simplifiedcandlestickchart),[SimplifiedLineChart](#simplifiedlinechart)
+
+### BaseChart.axis)
+
+public virtual void InitAxisRuntimeData(Axis axis)
+
+### BaseChart.chartHeight
+
+public float chartHeight
+The height of chart.
+
+### BaseChart.chartHideFlags
+
+public override HideFlags chartHideFlags
+
+### BaseChart.chartMaxAnchor
+
+public Vector2 chartMaxAnchor
+
+### BaseChart.chartMinAnchor
+
+public Vector2 chartMinAnchor
+
+### BaseChart.chartPivot
+
+public Vector2 chartPivot
+
+### BaseChart.chartPosition
+
+public Vector3 chartPosition
+The position of chart.
+
+### BaseChart.chartRect
+
+public Rect chartRect
+
+### BaseChart.chartSizeDelta
+
+public Vector2 chartSizeDelta
+
+### BaseChart.chartWidth
+
+public float chartWidth
+The width of chart.
+
+### BaseChart.chartX
+
+public float chartX
+The x of chart.
+
+### BaseChart.chartY
+
+public float chartY
+The y of chart.
+
+### BaseChart.components
+
+public List<MainComponent> components
+
+### BaseChart.customDrawGaugePointerFunction
+
+public CustomDrawGaugePointerFunction customDrawGaugePointerFunction
+自定义仪表盘指针绘制委托。
+
+### BaseChart.debug
+
+public DebugInfo debug
+
+### BaseChart.onAxisPointerValueChanged
+
+public Action<Axis, double> onAxisPointerValueChanged
+坐标轴变更数据索引时回调。参数:axis, dataIndex/dataValue
+
+### BaseChart.onDraw
+
+public Action<VertexHelper> onDraw
+自定义绘制回调。在绘制Serie前调用。
+
+### BaseChart.onDrawAfterSerie
+
+public Action<VertexHelper, Serie> onDrawAfterSerie
+自定义Serie绘制回调。在每个Serie绘制完后调用。
+
+### BaseChart.onDrawBeforeSerie
+
+public Action<VertexHelper, Serie> onDrawBeforeSerie
+自定义Serie绘制回调。在每个Serie绘制完前调用。
+
+### BaseChart.onDrawTop
+
+public Action<VertexHelper> onDrawTop
+自定义Top层绘制回调。在绘制Tooltip前调用。
+
+### BaseChart.onDrawUpper
+
+public Action<VertexHelper> onDrawUpper
+自定义Upper层绘制回调。在绘制Tooltip前调用。
+
+### BaseChart.onInit
+
+public Action onInit
+The callback function of chart init.
+
+### BaseChart.onLegendClick
+
+public Action<Legend, int, string, bool> onLegendClick
+the callback function of click legend.
+
+### BaseChart.onLegendEnter
+
+public Action<Legend, int, string> onLegendEnter
+the callback function of enter legend.
+
+### BaseChart.onLegendExit
+
+public Action<Legend, int, string> onLegendExit
+the callback function of exit legend.
+
+### BaseChart.onPointerClickBar
+
+public Action<PointerEventData, int> onPointerClickBar
+the callback function of click bar.
+
+### BaseChart.onPointerClickPie
+
+public Action<PointerEventData, int, int> onPointerClickPie
+the callback function of pointer click pie area.
+
+### BaseChart.onPointerEnterPie
+
+public Action<int, int> onPointerEnterPie
+the callback function of pointer enter pie area.
+
+### BaseChart.onSerieClick
+
+public Action<SerieEventData> onSerieClick
+
+> Since `v3.6.0`
+
+the callback function of pointer click serie.
+
+### BaseChart.onSerieDown
+
+public Action<SerieEventData> onSerieDown
+
+> Since `v3.6.0`
+
+the callback function of pointer down serie.
+
+### BaseChart.onSerieEnter
+
+public Action<SerieEventData> onSerieEnter
+
+> Since `v3.6.0`
+
+the callback function of pointer enter serie.
+
+### BaseChart.onSerieExit
+
+public Action<SerieEventData> onSerieExit
+
+> Since `v3.6.0`
+
+the callback function of pointer exit serie.
+
+### BaseChart.onUpdate
+
+public Action onUpdate
+The callback function of chart update.
+
+### BaseChart.series
+
+public List<Serie> series
+
+### BaseChart.settings
+
+public Settings settings
+Global parameter setting component.
+
+### BaseChart.theme
+
+public ThemeStyle theme
+
+### BaseChart.typeListForComponent
+
+public Dictionary<Type, FieldInfo> typeListForComponent
+
+### BaseChart.typeListForSerie
+
+public Dictionary<Type, FieldInfo> typeListForSerie
+
+### BaseChart.AddChartComponent
+
+public MainComponent AddChartComponent(Type type)
+
+### BaseChart.AddChartComponent<T>
+
+public T AddChartComponent<T>() where T : MainComponent
+
+### BaseChart.AddChartComponentWhenNoExist<T>
+
+public T AddChartComponentWhenNoExist<T>() where T : MainComponent
+
+### BaseChart.AddData
+
+public SerieData AddData(int serieIndex, DateTime time, double yValue, string dataName = null, string dataId = null)
+Add a (time,y) data to serie.
+
+public SerieData AddData(int serieIndex, double data, string dataName = null, string dataId = null)
+Add a data to serie.
+
+public SerieData AddData(int serieIndex, double indexOrTimestamp, double open, double close, double lowest, double heighest, string dataName = null, string dataId = null)
+
+public SerieData AddData(int serieIndex, double xValue, double yValue, string dataName = null, string dataId = null)
+Add a (x,y) data to serie.
+
+public SerieData AddData(int serieIndex, List<double> multidimensionalData, string dataName = null, string dataId = null)
+Add an arbitray dimension data to serie,such as (x,y,z,...).
+
+public SerieData AddData(int serieIndex, params double[] multidimensionalData)
+Add an arbitray dimension data to serie,such as (x,y,z,...).
+
+public SerieData AddData(string serieName, DateTime time, double yValue, string dataName = null, string dataId = null)
+Add a (time,y) data to serie.
+
+public SerieData AddData(string serieName, double indexOrTimestamp, double open, double close, double lowest, double heighest, string dataName = null, string dataId = null)
+
+public SerieData AddData(string serieName, double xValue, double yValue, string dataName = null, string dataId = null)
+Add a (x,y) data to serie.
+
+public SerieData AddData(string serieName, List<double> multidimensionalData, string dataName = null, string dataId = null)
+Add an arbitray dimension data to serie,such as (x,y,z,...).
+
+public SerieData AddData(string serieName, params double[] multidimensionalData)
+Add an arbitray dimension data to serie,such as (x,y,z,...).
-|public method|since|description|
-|--|--|--|
-|onAxisPointerValueChanged||public Action<Axis, double> onAxisPointerValueChanged
坐标轴变更数据索引时回调。参数:axis, dataIndex/dataValue |
-|onDraw||public Action<VertexHelper> onDraw
自定义绘制回调。在绘制Serie前调用。 |
-|onDrawAfterSerie||public Action<VertexHelper, Serie> onDrawAfterSerie
自定义Serie绘制回调。在每个Serie绘制完后调用。 |
-|onDrawBeforeSerie||public Action<VertexHelper, Serie> onDrawBeforeSerie
自定义Serie绘制回调。在每个Serie绘制完前调用。 |
-|onDrawTop||public Action<VertexHelper> onDrawTop
自定义Top层绘制回调。在绘制Tooltip前调用。 |
-|onDrawUpper||public Action<VertexHelper> onDrawUpper
自定义Upper层绘制回调。在绘制Tooltip前调用。 |
-|onInit||public Action onInit
The callback function of chart init. |
-|onLegendClick||public Action<Legend, int, string, bool> onLegendClick
the callback function of click legend. |
-|onLegendEnter||public Action<Legend, int, string> onLegendEnter
the callback function of enter legend. |
-|onLegendExit||public Action<Legend, int, string> onLegendExit
the callback function of exit legend. |
-|onPointerClickBar||public Action<PointerEventData, int> onPointerClickBar
the callback function of click bar. |
-|onPointerClickPie||public Action<PointerEventData, int, int> onPointerClickPie
the callback function of pointer click pie area. |
-|onPointerEnterPie||public Action<int, int> onPointerEnterPie
the callback function of pointer enter pie area. |
-|onSerieClick|v3.6.0|public Action<SerieEventData> onSerieClick
the callback function of pointer click serie. |
-|onSerieDown|v3.6.0|public Action<SerieEventData> onSerieDown
the callback function of pointer down serie. |
-|onSerieEnter|v3.6.0|public Action<SerieEventData> onSerieEnter
the callback function of pointer enter serie. |
-|onSerieExit|v3.6.0|public Action<SerieEventData> onSerieExit
the callback function of pointer exit serie. |
-|onUpdate||public Action onUpdate
The callback function of chart update. |
-|AddChartComponent()||public MainComponent AddChartComponent(Type type)|
-|AddChartComponent<T>()||public T AddChartComponent<T>() where T : MainComponent|
-|AddChartComponentWhenNoExist<T>()||public T AddChartComponentWhenNoExist<T>() where T : MainComponent|
-|AddData()||public SerieData AddData(int serieIndex, DateTime time, double yValue, string dataName = null, string dataId = null)
Add a (time,y) data to serie. |
-|AddData()||public SerieData AddData(int serieIndex, double data, string dataName = null, string dataId = null)
Add a data to serie. |
-|AddData()||public SerieData AddData(int serieIndex, double indexOrTimestamp, double open, double close, double lowest, double heighest, string dataName = null, string dataId = null)|
-|AddData()||public SerieData AddData(int serieIndex, double xValue, double yValue, string dataName = null, string dataId = null)
Add a (x,y) data to serie. |
-|AddData()||public SerieData AddData(int serieIndex, List<double> multidimensionalData, string dataName = null, string dataId = null)
Add an arbitray dimension data to serie,such as (x,y,z,...). |
-|AddData()||public SerieData AddData(int serieIndex, params double[] multidimensionalData)
Add an arbitray dimension data to serie,such as (x,y,z,...). |
-|AddData()||public SerieData AddData(string serieName, DateTime time, double yValue, string dataName = null, string dataId = null)
Add a (time,y) data to serie. |
-|AddData()||public SerieData AddData(string serieName, double data, string dataName = null, string dataId = null)
Add a data to serie. |
-|AddData()||public SerieData AddData(string serieName, double indexOrTimestamp, double open, double close, double lowest, double heighest, string dataName = null, string dataId = null)|
-|AddData()||public SerieData AddData(string serieName, double xValue, double yValue, string dataName = null, string dataId = null)
Add a (x,y) data to serie. |
-|AddData()||public SerieData AddData(string serieName, List<double> multidimensionalData, string dataName = null, string dataId = null)
Add an arbitray dimension data to serie,such as (x,y,z,...). |
-|AddData()||public SerieData AddData(string serieName, params double[] multidimensionalData)
Add an arbitray dimension data to serie,such as (x,y,z,...). |
-|AddLink()||public SerieDataLink AddLink(int serieIndex, string sourceId, string targetId, double value = 0)
Add a link data to serie. |
-|AddSerie<T>()||public T AddSerie<T>(string serieName = null, bool show = true, bool addToHead = false) where T : Serie|
-|AddXAxisData()||public void AddXAxisData(string category, int xAxisIndex = 0)
Add a category data to xAxis. |
-|AddXAxisIcon()||public void AddXAxisIcon(Sprite icon, int xAxisIndex = 0)
Add an icon to xAxis. |
-|AddYAxisData()||public void AddYAxisData(string category, int yAxisIndex = 0)
Add a category data to yAxis. |
-|AddYAxisIcon()||public void AddYAxisIcon(Sprite icon, int yAxisIndex = 0)
Add an icon to yAxis. |
-|AnimationEnable()||public void AnimationEnable(bool flag)
Whether enable serie animations. |
-|AnimationFadeIn()||public void AnimationFadeIn(bool reset = true)
Start all serie fadein animations. |
-|AnimationFadeOut()||public void AnimationFadeOut()
Start all serie fadeout animations. |
-|AnimationPause()||public void AnimationPause()
Pause all animations. |
-|AnimationReset()||public void AnimationReset()
Reset all animations. |
-|AnimationResume()||public void AnimationResume()
Resume all animations. |
-|CanAddChartComponent()||public bool CanAddChartComponent(Type type)|
-|CanAddSerie()||public bool CanAddSerie(Type type)|
-|CanAddSerie<T>()||public bool CanAddSerie<T>() where T : Serie|
-|CancelTooltip()|v3.7.0|public void CancelTooltip()
cancel tooltip. |
-|CanMultipleComponent()||public bool CanMultipleComponent(Type type)|
-|ClampInChart()||public void ClampInChart(ref Vector3 pos)|
-|ClampInGrid()||public Vector3 ClampInGrid(GridCoord grid, Vector3 pos)|
-|ClearComponentData()|v3.4.0|public virtual void ClearComponentData()
Clear the data of all components. |
-|ClearData()||public virtual void ClearData()
Clear all components and series data. Note: serie only empties the data and does not remove serie. |
-|ClearSerieData()|v3.4.0|public virtual void ClearSerieData()
Clear the data of all series. |
-|ClearSerieLinks()|v3.10.0|public virtual void ClearSerieLinks()
Clear the link data of all series. |
-|ClickLegendButton()||public void ClickLegendButton(int legendIndex, string legendName, bool show)
点击图例按钮 |
-|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)
转换X轴和Y轴的配置 |
-|EnsureChartComponent<T>()|v3.6.0|public T EnsureChartComponent<T>() where T : MainComponent
Ensure the chart has the component, if not, add it. Note: it may fail to add. |
-|GenerateDefaultSerieName()||public string GenerateDefaultSerieName()|
-|GetAllSerieDataCount()||public int GetAllSerieDataCount()|
-|GetChartBackgroundColor()||public Color32 GetChartBackgroundColor()|
-|GetChartComponent<T>()||public T GetChartComponent<T>(int index = 0) where T : MainComponent|
-|GetChartComponentNum()||public int GetChartComponentNum(Type type)|
-|GetChartComponentNum<T>()||public int GetChartComponentNum<T>() where T : MainComponent|
-|GetChartComponents<T>()||public List<MainComponent> GetChartComponents<T>() where T : MainComponent|
-|GetData()||public double GetData(int serieIndex, int dataIndex, int dimension = 1)|
-|GetData()||public double GetData(string serieName, int dataIndex, int dimension = 1)|
-|GetDataZoomOfAxis()||public DataZoom GetDataZoomOfAxis(Axis axis)|
-|GetDataZoomOfSerie()||public void GetDataZoomOfSerie(Serie serie, out DataZoom xDataZoom, out DataZoom yDataZoom)|
-|GetGrid()||public GridCoord GetGrid(Vector2 local)|
-|GetGridOfDataZoom()||public GridCoord GetGridOfDataZoom(DataZoom dataZoom)|
-|GetItemColor()||public Color32 GetItemColor(Serie serie)|
-|GetItemColor()||public Color32 GetItemColor(Serie serie, SerieData serieData)|
-|GetItemColor()||public Color32 GetItemColor(Serie serie, SerieData serieData, int colorIndex)|
-|GetLegendRealShowNameColor()||public Color32 GetLegendRealShowNameColor(string name)|
-|GetLegendRealShowNameIndex()||public int GetLegendRealShowNameIndex(string name)|
-|GetMarkColor()|v3.4.0|public Color32 GetMarkColor(Serie serie, SerieData serieData)
获得Serie的标识颜色。 |
-|GetOrAddChartComponent<T>()||public T GetOrAddChartComponent<T>() where T : MainComponent|
-|GetPainter()||public Painter GetPainter(int index)|
-|GetSerie()||public Serie GetSerie(int serieIndex)|
-|GetSerie()||public Serie GetSerie(string serieName)|
-|GetSerie<T>()||public T GetSerie<T>() where T : Serie|
-|GetSerie<T>()||public T GetSerie<T>(int serieIndex) where T : Serie|
-|GetSerieBarGap<T>()||public float GetSerieBarGap<T>() where T : Serie|
-|GetSerieBarRealCount<T>()||public int GetSerieBarRealCount<T>() where T : Serie|
-|GetSerieIndexIfStack<T>()||public int GetSerieIndexIfStack<T>(Serie currSerie) where T : Serie|
-|GetSerieSameStackTotalValue<T>()||public double GetSerieSameStackTotalValue<T>(string stack, int dataIndex) where T : Serie|
-|GetSeriesMinMaxValue()||public virtual void GetSeriesMinMaxValue(Axis axis, int axisIndex, out double tempMinValue, out double tempMaxValue)|
-|GetSerieTotalGap<T>()||public float GetSerieTotalGap<T>(float categoryWidth, float gap, int index) where T : Serie|
-|GetSerieTotalWidth<T>()||public float GetSerieTotalWidth<T>(float categoryWidth, float gap, int realBarCount) where T : Serie|
-|GetTitlePosition()||public Vector3 GetTitlePosition(Title title)|
-|GetVisualMapOfSerie()||public VisualMap GetVisualMapOfSerie(Serie serie)|
-|GetXDataZoomOfSerie()||public DataZoom GetXDataZoomOfSerie(Serie serie)|
-|GetXLerpColor()||public Color32 GetXLerpColor(Color32 areaColor, Color32 areaToColor, Vector3 pos, GridCoord grid)|
-|GetYLerpColor()||public Color32 GetYLerpColor(Color32 areaColor, Color32 areaToColor, Vector3 pos, GridCoord grid)|
-|HasChartComponent()||public bool HasChartComponent(Type type)|
-|HasChartComponent<T>()||public bool HasChartComponent<T>()|
-|HasSerie()||public bool HasSerie(Type type)|
-|HasSerie<T>()||public bool HasSerie<T>() where T : Serie|
-|Init()||public void Init(bool defaultChart = true)|
-|InitAxisRuntimeData()||public virtual void InitAxisRuntimeData(Axis axis) { }|
-|InsertSerie()||public void InsertSerie(Serie serie, int index = -1, bool addToHead = false)|
-|InsertSerie<T>()||public T InsertSerie<T>(int index, string serieName = null, bool show = true) where T : Serie|
-|Internal_CheckAnimation()||public void Internal_CheckAnimation()|
-|IsActiveByLegend()||public virtual bool IsActiveByLegend(string legendName)
Whether serie is activated. |
-|IsAllAxisCategory()||public bool IsAllAxisCategory()
纯类目轴。 |
-|IsAllAxisValue()||public bool IsAllAxisValue()
reutrn true when all the show axis is `Value` type. |
-|IsInAnyGrid()||public bool IsInAnyGrid(Vector2 local)|
-|IsInChart()||public bool IsInChart(float x, float y)|
-|IsInChart()||public bool IsInChart(Vector2 local)
坐标是否在图表范围内 |
-|IsSerieName()||public bool IsSerieName(string name)|
-|MoveDownSerie()||public bool MoveDownSerie(int serieIndex)|
-|MoveUpSerie()||public bool MoveUpSerie(int serieIndex)|
-|OnAfterDeserialize()||public void OnAfterDeserialize()|
-|OnBeforeSerialize()||public void OnBeforeSerialize()|
-|OnBeginDrag()||public override void OnBeginDrag(PointerEventData eventData)|
-|OnDataZoomRangeChanged()||public virtual void OnDataZoomRangeChanged(DataZoom dataZoom)|
-|OnDrag()||public override void OnDrag(PointerEventData eventData)|
-|OnEndDrag()||public override void OnEndDrag(PointerEventData eventData)|
-|OnLegendButtonClick()||public virtual void OnLegendButtonClick(int index, string legendName, bool show)|
-|OnLegendButtonEnter()||public virtual void OnLegendButtonEnter(int index, string legendName)|
-|OnLegendButtonExit()||public virtual void OnLegendButtonExit(int index, string legendName)|
-|OnPointerClick()||public override void OnPointerClick(PointerEventData eventData)|
-|OnPointerDown()||public override void OnPointerDown(PointerEventData eventData)|
-|OnPointerEnter()||public override void OnPointerEnter(PointerEventData eventData)|
-|OnPointerExit()||public override void OnPointerExit(PointerEventData eventData)|
-|OnPointerUp()||public override void OnPointerUp(PointerEventData eventData)|
-|OnScroll()||public override void OnScroll(PointerEventData eventData)|
-|RefreshBasePainter()||public void RefreshBasePainter()|
-|RefreshChart()||public void RefreshChart()
Redraw chart in next frame. |
-|RefreshChart()||public void RefreshChart(int serieIndex)
Redraw chart serie in next frame. |
-|RefreshChart()||public void RefreshChart(Serie serie)
Redraw chart serie in next frame. |
-|RefreshDataZoom()||public void RefreshDataZoom()
在下一帧刷新DataZoom |
-|RefreshGraph()||public override void RefreshGraph()|
-|RefreshPainter()||public void RefreshPainter(int index)|
-|RefreshPainter()||public void RefreshPainter(Serie serie)|
-|RefreshTopPainter()||public void RefreshTopPainter()|
-|RefreshUpperPainter()||public void RefreshUpperPainter()|
-|RemoveAllChartComponent()||public void RemoveAllChartComponent()|
-|RemoveAllSerie()|v3.2.0|public virtual void RemoveAllSerie()
Remove all of them Serie. This interface is used when Serie needs to be removed only, and RemoveData() is generally used in other cases. |
-|RemoveChartComponent()||public bool RemoveChartComponent(MainComponent component)|
-|RemoveChartComponent()||public bool RemoveChartComponent(Type type, int index = 0)|
-|RemoveChartComponent<T>()||public bool RemoveChartComponent<T>(int index = 0)|
-|RemoveChartComponents()||public int RemoveChartComponents(Type type)|
-|RemoveChartComponents<T>()||public int RemoveChartComponents<T>()|
-|RemoveData()||public virtual void RemoveData()
Empty all component data and remove all series. Use the chart again and again to tell the truth. Note: The component only clears the data part, and the parameters are retained and not reset. |
-|RemoveData()||public virtual void RemoveData(string serieName)
Remove legend and serie by name. |
-|RemoveSerie()||public void RemoveSerie(int serieIndex)|
-|RemoveSerie()||public void RemoveSerie(Serie serie)|
-|RemoveSerie()||public void RemoveSerie(string serieName)|
-|RemoveSerie<T>()||public void RemoveSerie<T>() where T : Serie|
-|ReplaceSerie()||public bool ReplaceSerie(Serie oldSerie, Serie newSerie)|
-|ResetChartStatus()|v3.10.0|public void ResetChartStatus()
reset chart status. When some parameters are set, due to the animation effect, the chart status may not be correct. |
-|ResetDataIndex()||public bool ResetDataIndex(int serieIndex)
重置serie的数据项索引。避免数据项索引异常。 |
-|SetBasePainterMaterial()||public void SetBasePainterMaterial(Material material)
设置Base Painter的材质球 |
-|SetInsertDataToHead()|v3.11.0|public void SetInsertDataToHead(bool insertDataToHead)
set insert data to head. |
-|SetMaxCache()||public void SetMaxCache(int maxCache)
设置可缓存的最大数据量。当数据量超过该值时,会自动删除第一个值再加入最新值。 |
-|SetPainterActive()||public void SetPainterActive(int index, bool flag)|
-|SetSerieActive()||public void SetSerieActive(int serieIndex, bool active)
Whether to show serie. |
-|SetSerieActive()||public void SetSerieActive(Serie serie, bool active)|
-|SetSerieActive()||public void SetSerieActive(string serieName, bool active)
Whether to show serie. |
-|SetSeriePainterMaterial()||public void SetSeriePainterMaterial(Material material)
设置Serie Painter的材质球 |
-|SetTopPainterMaterial()||public void SetTopPainterMaterial(Material material)
设置Top Painter的材质球 |
-|SetUpperPainterMaterial()||public void SetUpperPainterMaterial(Material material)
设置Upper Painter的材质球 |
-|TriggerTooltip()|v3.7.0|public bool TriggerTooltip(int dataIndex, int serieIndex = 0)
trigger tooltip by data index. |
-|TriggerTooltip()|v3.7.0|public bool TriggerTooltip(Vector3 localPosition)
trigger tooltip by chart local position. |
-|TryAddChartComponent()||public bool TryAddChartComponent(Type type)|
-|TryAddChartComponent<T>()||public bool TryAddChartComponent<T>() where T : MainComponent|
-|TryAddChartComponent<T>()||public bool TryAddChartComponent<T>(out T component) where T : MainComponent|
-|TryGetChartComponent<T>()||public bool TryGetChartComponent<T>(out T component, int index = 0)|
-|UpdateData()||public bool UpdateData(int serieIndex, int dataIndex, double value)
Update serie data by serie index. |
-|UpdateData()||public bool UpdateData(int serieIndex, int dataIndex, int dimension, double value)
更新指定系列指定索引指定维数的数据。维数从0开始。 |
-|UpdateData()||public bool UpdateData(int serieIndex, int dataIndex, List<double> multidimensionalData)
更新指定系列指定索引的数据项的多维数据。 |
-|UpdateData()||public bool UpdateData(string serieName, int dataIndex, double value)
Update serie data by serie name. |
-|UpdateData()||public bool UpdateData(string serieName, int dataIndex, int dimension, double value)
更新指定系列指定索引指定维数的数据。维数从0开始。 |
-|UpdateData()||public bool UpdateData(string serieName, int dataIndex, List<double> multidimensionalData)
更新指定系列指定索引的数据项的多维数据。 |
-|UpdateDataName()||public bool UpdateDataName(int serieIndex, int dataIndex, string dataName)
Update serie data name. |
-|UpdateDataName()||public bool UpdateDataName(string serieName, int dataIndex, string dataName)
Update serie data name. |
-|UpdateLegendColor()||public virtual void UpdateLegendColor(string legendName, bool active)|
-|UpdateTheme()||public bool UpdateTheme(ThemeType theme)
Update chart theme. |
-|UpdateTheme()||public void UpdateTheme(Theme theme)
Update chart theme info. |
-|UpdateXAxisData()||public void UpdateXAxisData(int index, string category, int xAxisIndex = 0)
Update category data. |
-|UpdateXAxisIcon()||public void UpdateXAxisIcon(int index, Sprite icon, int xAxisIndex = 0)
Update xAxis icon. |
-|UpdateYAxisData()||public void UpdateYAxisData(int index, string category, int yAxisIndex = 0)
Update category data. |
-|UpdateYAxisIcon()||public void UpdateYAxisIcon(int index, Sprite icon, int yAxisIndex = 0)
更新Y轴图标。 |
+### BaseChart.AddLink
+
+public SerieDataLink AddLink(int serieIndex, string sourceId, string targetId, double value = 0)
+Add a link data to serie.
+
+### BaseChart.AddSerie<T>
+
+public T AddSerie<T>(string serieName = null, bool show = true, bool addToHead = false) where T : Serie
+
+### BaseChart.AddXAxisData
+
+public void AddXAxisData(string category, int xAxisIndex = 0)
+Add a category data to xAxis.
+
+### BaseChart.AddXAxisIcon
+
+public void AddXAxisIcon(Sprite icon, int xAxisIndex = 0)
+Add an icon to xAxis.
+
+### BaseChart.AddYAxisData
+
+public void AddYAxisData(string category, int yAxisIndex = 0)
+Add a category data to yAxis.
+
+### BaseChart.AddYAxisIcon
+
+public void AddYAxisIcon(Sprite icon, int yAxisIndex = 0)
+Add an icon to yAxis.
+
+### BaseChart.AnimationEnable
+
+public void AnimationEnable(bool flag)
+Whether enable serie animations.
+
+### BaseChart.AnimationFadeIn
+
+public void AnimationFadeIn(bool reset = true)
+Start all serie fadein animations.
+
+### BaseChart.AnimationFadeOut
+
+public void AnimationFadeOut()
+Start all serie fadeout animations.
+
+### BaseChart.AnimationPause
+
+public void AnimationPause()
+Pause all animations.
+
+### BaseChart.AnimationReset
+
+public void AnimationReset()
+Reset all animations.
+
+### BaseChart.AnimationResume
+
+public void AnimationResume()
+Resume all animations.
+
+### BaseChart.CanAddChartComponent
+
+public bool CanAddChartComponent(Type type)
+
+### BaseChart.CanAddSerie
+
+public bool CanAddSerie(Type type)
+
+### BaseChart.CanAddSerie<T>
+
+public bool CanAddSerie<T>() where T : Serie
+
+### BaseChart.CancelTooltip
+
+public void CancelTooltip()
+
+> Since `v3.7.0`
+
+cancel tooltip.
+
+### BaseChart.CanMultipleComponent
+
+public bool CanMultipleComponent(Type type)
+
+### BaseChart.ClampInChart
+
+public void ClampInChart(ref Vector3 pos)
+
+### BaseChart.ClampInGrid
+
+public Vector3 ClampInGrid(GridCoord grid, Vector3 pos)
+
+### BaseChart.ClearComponentData
+
+public virtual void ClearComponentData()
+
+> Since `v3.4.0`
+
+Clear the data of all components.
+
+### BaseChart.ClearData
+
+public virtual void ClearData()
+Clear all components and series data. Note: serie only empties the data and does not remove serie.
+
+### BaseChart.ClearSerieData
+
+public virtual void ClearSerieData()
+
+> Since `v3.4.0`
+
+Clear the data of all series.
+
+### BaseChart.ClearSerieLinks
+
+public virtual void ClearSerieLinks()
+
+> Since `v3.10.0`
+
+Clear the link data of all series.
+
+### BaseChart.ClickLegendButton
+
+public void ClickLegendButton(int legendIndex, string legendName, bool show)
+点击图例按钮
+
+### BaseChart.ConvertSerie
+
+public bool ConvertSerie(Serie serie, Type type)
+
+### BaseChart.ConvertSerie<T>
+
+public bool ConvertSerie<T>(Serie serie) where T : Serie
+
+### BaseChart.ConvertXYAxis
+
+public void ConvertXYAxis(int index)
+转换X轴和Y轴的配置
+
+### BaseChart.EnsureChartComponent<T>
+
+public T EnsureChartComponent<T>() where T : MainComponent
+
+> Since `v3.6.0`
+
+Ensure the chart has the component, if not, add it. Note: it may fail to add.
+
+### BaseChart.GenerateDefaultSerieName
+
+public string GenerateDefaultSerieName()
+
+### BaseChart.GetAllSerieDataCount
+
+public int GetAllSerieDataCount()
+
+### BaseChart.GetChartBackgroundColor
+
+public Color32 GetChartBackgroundColor()
+
+### BaseChart.GetChartComponent<T>
+
+public T GetChartComponent<T>(int index = 0) where T : MainComponent
+
+### BaseChart.GetChartComponentNum
+
+public int GetChartComponentNum(Type type)
+
+### BaseChart.GetChartComponentNum<T>
+
+public int GetChartComponentNum<T>() where T : MainComponent
+
+### BaseChart.GetChartComponents<T>
+
+public List<MainComponent> GetChartComponents<T>() where T : MainComponent
+
+### BaseChart.GetData
+
+public double GetData(int serieIndex, int dataIndex, int dimension = 1)
+
+
+### BaseChart.GetDataZoomOfAxis
+
+public DataZoom GetDataZoomOfAxis(Axis axis)
+
+### BaseChart.GetDataZoomOfSerie
+
+public void GetDataZoomOfSerie(Serie serie, out DataZoom xDataZoom, out DataZoom yDataZoom)
+
+### BaseChart.GetGrid
+
+public GridCoord GetGrid(Vector2 local)
+
+### BaseChart.GetGridOfDataZoom
+
+public GridCoord GetGridOfDataZoom(DataZoom dataZoom)
+
+### BaseChart.GetItemColor
+
+public Color32 GetItemColor(Serie serie)
+
+public Color32 GetItemColor(Serie serie, SerieData serieData, int colorIndex)
+
+
+### BaseChart.GetLegendRealShowNameColor
+
+public Color32 GetLegendRealShowNameColor(string name)
+
+### BaseChart.GetLegendRealShowNameIndex
+
+public int GetLegendRealShowNameIndex(string name)
+
+### BaseChart.GetMarkColor
+
+public Color32 GetMarkColor(Serie serie, SerieData serieData)
+
+> Since `v3.4.0`
+
+获得Serie的标识颜色。
+
+### BaseChart.GetOrAddChartComponent<T>
+
+public T GetOrAddChartComponent<T>() where T : MainComponent
+
+### BaseChart.GetPainter
+
+public Painter GetPainter(int index)
+
+### BaseChart.GetSerie
+
+public Serie GetSerie(int serieIndex)
+
+
+### BaseChart.GetSerie<T>
+
+public T GetSerie<T>(int serieIndex) where T : Serie
+
+
+### BaseChart.GetSerieBarGap<T>
+
+public float GetSerieBarGap<T>() where T : Serie
+
+### BaseChart.GetSerieBarRealCount<T>
+
+public int GetSerieBarRealCount<T>() where T : Serie
+
+### BaseChart.GetSerieIndexIfStack<T>
+
+public int GetSerieIndexIfStack<T>(Serie currSerie) where T : Serie
+
+### BaseChart.GetSerieSameStackTotalValue<T>
+
+public double GetSerieSameStackTotalValue<T>(string stack, int dataIndex) where T : Serie
+
+### BaseChart.GetSeriesMinMaxValue
+
+public virtual void GetSeriesMinMaxValue(Axis axis, int axisIndex, out double tempMinValue, out double tempMaxValue)
+
+### BaseChart.GetSerieTotalGap<T>
+
+public float GetSerieTotalGap<T>(float categoryWidth, float gap, int index) where T : Serie
+
+### BaseChart.GetSerieTotalWidth<T>
+
+public float GetSerieTotalWidth<T>(float categoryWidth, float gap, int realBarCount) where T : Serie
+
+### BaseChart.GetTitlePosition
+
+public Vector3 GetTitlePosition(Title title)
+
+### BaseChart.GetVisualMapOfSerie
+
+public VisualMap GetVisualMapOfSerie(Serie serie)
+
+### BaseChart.GetXDataZoomOfSerie
+
+public DataZoom GetXDataZoomOfSerie(Serie serie)
+
+### BaseChart.GetXLerpColor
+
+public Color32 GetXLerpColor(Color32 areaColor, Color32 areaToColor, Vector3 pos, GridCoord grid)
+
+### BaseChart.GetYLerpColor
+
+public Color32 GetYLerpColor(Color32 areaColor, Color32 areaToColor, Vector3 pos, GridCoord grid)
+
+### BaseChart.HasChartComponent
+
+public bool HasChartComponent(Type type)
+
+### BaseChart.HasChartComponent<T>
+
+public bool HasChartComponent<T>()
+
+### BaseChart.HasSerie
+
+public bool HasSerie(Type type)
+
+### BaseChart.HasSerie<T>
+
+public bool HasSerie<T>() where T : Serie
+
+### BaseChart.Init
+
+public void Init(bool defaultChart = true)
+
+### BaseChart.InitAxisRuntimeData
+
+public virtual void InitAxisRuntimeData(Axis axis) { }
+
+### BaseChart.InsertSerie
+
+public void InsertSerie(Serie serie, int index = -1, bool addToHead = false)
+
+### BaseChart.InsertSerie<T>
+
+public T InsertSerie<T>(int index, string serieName = null, bool show = true) where T : Serie
+
+### BaseChart.Internal_CheckAnimation
+
+public void Internal_CheckAnimation()
+
+### BaseChart.IsActiveByLegend
+
+public virtual bool IsActiveByLegend(string legendName)
+Whether serie is activated.
+
+### BaseChart.IsAllAxisCategory
+
+public bool IsAllAxisCategory()
+纯类目轴。
+
+### BaseChart.IsAllAxisValue
+
+public bool IsAllAxisValue()
+reutrn true when all the show axis is `Value` type.
+
+### BaseChart.IsInAnyGrid
+
+public bool IsInAnyGrid(Vector2 local)
+
+### BaseChart.IsInChart
+
+public bool IsInChart(float x, float y)
+
+
+### BaseChart.IsSerieName
+
+public bool IsSerieName(string name)
+
+### BaseChart.MoveDownSerie
+
+public bool MoveDownSerie(int serieIndex)
+
+### BaseChart.MoveUpSerie
+
+public bool MoveUpSerie(int serieIndex)
+
+### BaseChart.OnAfterDeserialize
+
+public void OnAfterDeserialize()
+
+### BaseChart.OnBeforeSerialize
+
+public void OnBeforeSerialize()
+
+### BaseChart.OnBeginDrag
+
+public override void OnBeginDrag(PointerEventData eventData)
+
+### BaseChart.OnDataZoomRangeChanged
+
+public virtual void OnDataZoomRangeChanged(DataZoom dataZoom)
+
+### BaseChart.OnDrag
+
+public override void OnDrag(PointerEventData eventData)
+
+### BaseChart.OnEndDrag
+
+public override void OnEndDrag(PointerEventData eventData)
+
+### BaseChart.OnLegendButtonClick
+
+public virtual void OnLegendButtonClick(int index, string legendName, bool show)
+
+### BaseChart.OnLegendButtonEnter
+
+public virtual void OnLegendButtonEnter(int index, string legendName)
+
+### BaseChart.OnLegendButtonExit
+
+public virtual void OnLegendButtonExit(int index, string legendName)
+
+### BaseChart.OnPointerClick
+
+public override void OnPointerClick(PointerEventData eventData)
+
+### BaseChart.OnPointerDown
+
+public override void OnPointerDown(PointerEventData eventData)
+
+### BaseChart.OnPointerEnter
+
+public override void OnPointerEnter(PointerEventData eventData)
+
+### BaseChart.OnPointerExit
+
+public override void OnPointerExit(PointerEventData eventData)
+
+### BaseChart.OnPointerUp
+
+public override void OnPointerUp(PointerEventData eventData)
+
+### BaseChart.OnScroll
+
+public override void OnScroll(PointerEventData eventData)
+
+### BaseChart.RefreshBasePainter
+
+public void RefreshBasePainter()
+
+### BaseChart.RefreshChart
+
+public void RefreshChart(int serieIndex)
+Redraw chart serie in next frame.
+
+public void RefreshChart(Serie serie)
+Redraw chart serie in next frame.
+
+
+### BaseChart.RefreshDataZoom
+
+public void RefreshDataZoom()
+在下一帧刷新DataZoom
+
+### BaseChart.RefreshGraph
+
+public override void RefreshGraph()
+
+### BaseChart.RefreshPainter
+
+public void RefreshPainter(Serie serie)
+
+
+### BaseChart.RefreshTopPainter
+
+public void RefreshTopPainter()
+
+### BaseChart.RefreshUpperPainter
+
+public void RefreshUpperPainter()
+
+### BaseChart.RemoveAllChartComponent
+
+public void RemoveAllChartComponent()
+
+### BaseChart.RemoveAllSerie
+
+public virtual void RemoveAllSerie()
+
+> Since `v3.2.0`
+
+Remove all of them Serie. This interface is used when Serie needs to be removed only, and RemoveData() is generally used in other cases.
+
+### BaseChart.RemoveChartComponent
+
+public bool RemoveChartComponent(MainComponent component)
+
+
+### BaseChart.RemoveChartComponent<T>
+
+public bool RemoveChartComponent<T>(int index = 0)
+
+### BaseChart.RemoveChartComponents
+
+public int RemoveChartComponents(Type type)
+
+### BaseChart.RemoveChartComponents<T>
+
+public int RemoveChartComponents<T>()
+
+### BaseChart.RemoveData
+
+public virtual void RemoveData(string serieName)
+Remove legend and serie by name.
+
+
+### BaseChart.RemoveSerie
+
+public void RemoveSerie(int serieIndex)
+
+public void RemoveSerie(Serie serie)
+
+
+### BaseChart.RemoveSerie<T>
+
+public void RemoveSerie<T>() where T : Serie
+
+### BaseChart.ReplaceSerie
+
+public bool ReplaceSerie(Serie oldSerie, Serie newSerie)
+
+### BaseChart.ResetChartStatus
+
+public void ResetChartStatus()
+
+> Since `v3.10.0`
+
+reset chart status. When some parameters are set, due to the animation effect, the chart status may not be correct.
+
+### BaseChart.ResetDataIndex
+
+public bool ResetDataIndex(int serieIndex)
+重置serie的数据项索引。避免数据项索引异常。
+
+### BaseChart.SetBasePainterMaterial
+
+public void SetBasePainterMaterial(Material material)
+设置Base Painter的材质球
+
+### BaseChart.SetInsertDataToHead
+
+public void SetInsertDataToHead(bool insertDataToHead)
+
+> Since `v3.11.0`
+
+set insert data to head.
+
+### BaseChart.SetMaxCache
+
+public void SetMaxCache(int maxCache)
+设置可缓存的最大数据量。当数据量超过该值时,会自动删除第一个值再加入最新值。
+
+### BaseChart.SetPainterActive
+
+public void SetPainterActive(int index, bool flag)
+
+### BaseChart.SetSerieActive
+
+public void SetSerieActive(int serieIndex, bool active)
+Whether to show serie.
+
+public void SetSerieActive(Serie serie, bool active)
+
+
+### BaseChart.SetSeriePainterMaterial
+
+public void SetSeriePainterMaterial(Material material)
+设置Serie Painter的材质球
+
+### BaseChart.SetTopPainterMaterial
+
+public void SetTopPainterMaterial(Material material)
+设置Top Painter的材质球
+
+### BaseChart.SetUpperPainterMaterial
+
+public void SetUpperPainterMaterial(Material material)
+设置Upper Painter的材质球
+
+### BaseChart.TriggerTooltip
+
+public bool TriggerTooltip(Vector3 localPosition)
+
+> Since `v3.7.0`
+
+trigger tooltip by chart local position.
+
+
+### BaseChart.TryAddChartComponent
+
+public bool TryAddChartComponent(Type type)
+
+### BaseChart.TryAddChartComponent<T>
+
+public bool TryAddChartComponent<T>(out T component) where T : MainComponent
+
+
+### BaseChart.TryGetChartComponent<T>
+
+public bool TryGetChartComponent<T>(out T component, int index = 0)
+
+### BaseChart.UpdateData
+
+public bool UpdateData(int serieIndex, int dataIndex, double value)
+Update serie data by serie index.
+
+public bool UpdateData(int serieIndex, int dataIndex, int dimension, double value)
+更新指定系列指定索引指定维数的数据。维数从0开始。
+
+public bool UpdateData(int serieIndex, int dataIndex, List<double> multidimensionalData)
+更新指定系列指定索引的数据项的多维数据。
+
+public bool UpdateData(string serieName, int dataIndex, int dimension, double value)
+更新指定系列指定索引指定维数的数据。维数从0开始。
+
+public bool UpdateData(string serieName, int dataIndex, List<double> multidimensionalData)
+更新指定系列指定索引的数据项的多维数据。
+
+
+### BaseChart.UpdateDataName
+
+public bool UpdateDataName(int serieIndex, int dataIndex, string dataName)
+Update serie data name.
+
+
+### BaseChart.UpdateLegendColor
+
+public virtual void UpdateLegendColor(string legendName, bool active)
+
+### BaseChart.UpdateTheme
+
+public void UpdateTheme(Theme theme)
+Update chart theme info.
+
+
+### BaseChart.UpdateXAxisData
+
+public void UpdateXAxisData(int index, string category, int xAxisIndex = 0)
+Update category data.
+
+### BaseChart.UpdateXAxisIcon
+
+public void UpdateXAxisIcon(int index, Sprite icon, int xAxisIndex = 0)
+Update xAxis icon.
+
+### BaseChart.UpdateYAxisData
+
+public void UpdateYAxisData(int index, string category, int yAxisIndex = 0)
+Update category data.
+
+### BaseChart.UpdateYAxisIcon
+
+public void UpdateYAxisIcon(int index, Sprite icon, int yAxisIndex = 0)
+更新Y轴图标。
## BaseGraph
-> class in XCharts.Runtime / Inherits from: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=maskablegraphic),[IPointerDownHandler](https://docs.unity3d.com/ScriptReference/30_search.html?q=ipointerdownhandler),[IPointerUpHandler](https://docs.unity3d.com/ScriptReference/30_search.html?q=ipointeruphandler),[](#) / Subclasses: [BaseChart](#basechart),[UIComponent](#uicomponent)
+class in XCharts.Runtime / Inherits from: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=maskablegraphic),[IPointerDownHandler](https://docs.unity3d.com/ScriptReference/30_search.html?q=ipointerdownhandler),[IPointerUpHandler](https://docs.unity3d.com/ScriptReference/30_search.html?q=ipointeruphandler),[](#) / Subclasses: [BaseChart](#basechart),[UIComponent](#uicomponent)
+### BaseGraph.chartHideFlags
-|public method|since|description|
-|--|--|--|
-|onBeginDrag||public Action<PointerEventData, BaseGraph> onBeginDrag
鼠标开始拖拽回调。 |
-|onDrag||public Action<PointerEventData, BaseGraph> onDrag
鼠标拖拽回调。 |
-|onEndDrag||public Action<PointerEventData, BaseGraph> onEndDrag
鼠标结束拖拽回调。 |
-|onPointerClick||public Action<PointerEventData, BaseGraph> onPointerClick
鼠标点击回调。 |
-|onPointerDown||public Action<PointerEventData, BaseGraph> onPointerDown
鼠标按下回调。 |
-|onPointerEnter||public Action<PointerEventData, BaseGraph> onPointerEnter
鼠标进入回调。 |
-|onPointerExit||public Action<PointerEventData, BaseGraph> onPointerExit
鼠标退出回调。 |
-|onPointerUp||public Action<PointerEventData, BaseGraph> onPointerUp
鼠标弹起回调。 |
-|onScroll||public Action<PointerEventData, BaseGraph> onScroll
鼠标滚动回调。 |
-|CheckWarning()||public string CheckWarning()
检测警告信息。 |
-|LocalPointToScreenPoint()|v3.7.0|public Vector2 LocalPointToScreenPoint(Vector2 localPoint)
chart local point to screen point. |
-|LocalPointToWorldPoint()|v3.7.0|public Vector2 LocalPointToWorldPoint(Vector2 localPoint)
chart local point to world point. |
-|OnBeginDrag()||public virtual void OnBeginDrag(PointerEventData eventData)|
-|OnDrag()||public virtual void OnDrag(PointerEventData eventData)|
-|OnEndDrag()||public virtual void OnEndDrag(PointerEventData eventData)|
-|OnPointerClick()||public virtual void OnPointerClick(PointerEventData eventData)|
-|OnPointerDown()||public virtual void OnPointerDown(PointerEventData eventData)|
-|OnPointerEnter()||public virtual void OnPointerEnter(PointerEventData eventData)|
-|OnPointerExit()||public virtual void OnPointerExit(PointerEventData eventData)|
-|OnPointerUp()||public virtual void OnPointerUp(PointerEventData eventData)|
-|OnScroll()||public virtual void OnScroll(PointerEventData eventData)|
-|RebuildChartObject()||public void RebuildChartObject()
移除并重新创建所有图表的Object。 |
-|RefreshAllComponent()||public void RefreshAllComponent()|
-|RefreshGraph()||public virtual void RefreshGraph()
Redraw graph in next frame. |
-|SaveAsImage()||public void SaveAsImage(string imageType = "png", string savePath = "")
保存图表为图片。 |
-|ScreenPointToChartPoint()||public bool ScreenPointToChartPoint(Vector2 screenPoint, out Vector2 chartPoint)|
-|SetPainterDirty()||public void SetPainterDirty()
重新初始化Painter |
-|SetSize()||public virtual void SetSize(float width, float height)
设置图形的宽高(在非stretch pivot下才有效,其他情况需要自己调整RectTransform) |
+public virtual HideFlags chartHideFlags
+
+### BaseGraph.clickPos
+
+public Vector2 clickPos
+
+### BaseGraph.forceOpenRaycastTarget
+
+public bool forceOpenRaycastTarget
+强制开启鼠标事件检测。
+
+### BaseGraph.graphAnchoredPosition
+
+public Vector2 graphAnchoredPosition
+
+### BaseGraph.graphHeight
+
+public float graphHeight
+The height of graph.
+
+### BaseGraph.graphMaxAnchor
+
+public Vector2 graphMaxAnchor
+
+### BaseGraph.graphMinAnchor
+
+public Vector2 graphMinAnchor
+
+### BaseGraph.graphPivot
+
+public Vector2 graphPivot
+
+### BaseGraph.graphPosition
+
+public Vector3 graphPosition
+The position of graph.
+
+### BaseGraph.graphRect
+
+public Rect graphRect
+
+### BaseGraph.graphSizeDelta
+
+public Vector2 graphSizeDelta
+
+### BaseGraph.graphWidth
+
+public float graphWidth
+The width of graph.
+
+### BaseGraph.graphX
+
+public float graphX
+The x of graph.
+
+### BaseGraph.graphY
+
+public float graphY
+The y of graph.
+
+### BaseGraph.isPointerClick
+
+public bool isPointerClick
+Whether the mouse click the chart.
+
+### BaseGraph.isPointerInChart
+
+public bool isPointerInChart
+Whether the mouse pointer is in the chart.
+
+### BaseGraph.onBeginDrag
+
+public Action<PointerEventData, BaseGraph> onBeginDrag
+鼠标开始拖拽回调。
+
+### BaseGraph.onDrag
+
+public Action<PointerEventData, BaseGraph> onDrag
+鼠标拖拽回调。
+
+### BaseGraph.onEndDrag
+
+public Action<PointerEventData, BaseGraph> onEndDrag
+鼠标结束拖拽回调。
+
+### BaseGraph.onPointerClick
+
+public Action<PointerEventData, BaseGraph> onPointerClick
+鼠标点击回调。
+
+### BaseGraph.onPointerDown
+
+public Action<PointerEventData, BaseGraph> onPointerDown
+鼠标按下回调。
+
+### BaseGraph.onPointerEnter
+
+public Action<PointerEventData, BaseGraph> onPointerEnter
+鼠标进入回调。
+
+### BaseGraph.onPointerExit
+
+public Action<PointerEventData, BaseGraph> onPointerExit
+鼠标退出回调。
+
+### BaseGraph.onPointerUp
+
+public Action<PointerEventData, BaseGraph> onPointerUp
+鼠标弹起回调。
+
+### BaseGraph.onScroll
+
+public Action<PointerEventData, BaseGraph> onScroll
+鼠标滚动回调。
+
+### BaseGraph.painter
+
+public Painter painter
+
+### BaseGraph.pointerPos
+
+public Vector2 pointerPos
+The postion of pointer move.
+
+### BaseGraph.warningInfo
+
+public string warningInfo
+警告信息。
+
+### BaseGraph.CheckWarning
+
+public string CheckWarning()
+检测警告信息。
+
+### BaseGraph.LocalPointToScreenPoint
+
+public Vector2 LocalPointToScreenPoint(Vector2 localPoint)
+
+> Since `v3.7.0`
+
+chart local point to screen point.
+
+### BaseGraph.LocalPointToWorldPoint
+
+public Vector2 LocalPointToWorldPoint(Vector2 localPoint)
+
+> Since `v3.7.0`
+
+chart local point to world point.
+
+### BaseGraph.OnBeginDrag
+
+public virtual void OnBeginDrag(PointerEventData eventData)
+
+### BaseGraph.OnDrag
+
+public virtual void OnDrag(PointerEventData eventData)
+
+### BaseGraph.OnEndDrag
+
+public virtual void OnEndDrag(PointerEventData eventData)
+
+### BaseGraph.OnPointerClick
+
+public virtual void OnPointerClick(PointerEventData eventData)
+
+### BaseGraph.OnPointerDown
+
+public virtual void OnPointerDown(PointerEventData eventData)
+
+### BaseGraph.OnPointerEnter
+
+public virtual void OnPointerEnter(PointerEventData eventData)
+
+### BaseGraph.OnPointerExit
+
+public virtual void OnPointerExit(PointerEventData eventData)
+
+### BaseGraph.OnPointerUp
+
+public virtual void OnPointerUp(PointerEventData eventData)
+
+### BaseGraph.OnScroll
+
+public virtual void OnScroll(PointerEventData eventData)
+
+### BaseGraph.RebuildChartObject
+
+public void RebuildChartObject()
+移除并重新创建所有图表的Object。
+
+### BaseGraph.RefreshAllComponent
+
+public void RefreshAllComponent()
+
+### BaseGraph.RefreshGraph
+
+public virtual void RefreshGraph()
+Redraw graph in next frame.
+
+### BaseGraph.SaveAsImage
+
+public void SaveAsImage(string imageType = "png", string savePath = "")
+保存图表为图片。
+
+### BaseGraph.ScreenPointToChartPoint
+
+public bool ScreenPointToChartPoint(Vector2 screenPoint, out Vector2 chartPoint)
+
+### BaseGraph.SetPainterDirty
+
+public void SetPainterDirty()
+重新初始化Painter
+
+### BaseGraph.SetSize
+
+public virtual void SetSize(float width, float height)
+设置图形的宽高(在非stretch pivot下才有效,其他情况需要自己调整RectTransform)
## BaseLine
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [AxisLine](#axisline),[AxisMinorSplitLine](#axisminorsplitline),[AxisMinorTick](#axisminortick),[AxisSplitLine](#axissplitline),[AxisTick](#axistick)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [AxisLine](#axisline),[AxisMinorSplitLine](#axisminorsplitline),[AxisMinorTick](#axisminortick),[AxisSplitLine](#axissplitline),[AxisTick](#axistick)
Settings related to base line.
-|public method|since|description|
-|--|--|--|
-|BaseLine()||public BaseLine()|
-|BaseLine()||public BaseLine(bool show) : base()|
-|Copy()||public void Copy(BaseLine axisLine)|
-|GetColor()||public Color32 GetColor(Color32 themeColor)|
-|GetLength()||public float GetLength(float themeLength)|
-|GetType()||public LineStyle.Type GetType(LineStyle.Type themeType)|
-|GetWidth()||public float GetWidth(float themeWidth)|
+### BaseLine.BaseLine
+
+public BaseLine(bool show) : base()
+
+
+### BaseLine.Copy
+
+public void Copy(BaseLine axisLine)
+
+### BaseLine.GetColor
+
+public Color32 GetColor(Color32 themeColor)
+
+### BaseLine.GetLength
+
+public float GetLength(float themeLength)
+
+### BaseLine.GetType
+
+public LineStyle.Type GetType(LineStyle.Type themeType)
+
+### BaseLine.GetWidth
+
+public float GetWidth(float themeWidth)
## BaseScatter
-> class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) / Subclasses: [EffectScatter](#effectscatter),[Scatter](#scatter)
+class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) / Subclasses: [EffectScatter](#effectscatter),[Scatter](#scatter)
+### BaseScatter.containerIndex
+
+public int containerIndex
+
+### BaseScatter.containterInstanceId
+
+public int containterInstanceId
## BaseSerie
-> class in XCharts.Runtime / Subclasses: [Serie](#serie)
+class in XCharts.Runtime / Subclasses: [Serie](#serie)
+
+### BaseSerie.anyDirty
+
+public bool anyDirty
+
+### BaseSerie.ClearData()
+
+public virtual void ClearData()
+
+### BaseSerie.componentDirty
+
+public virtual bool componentDirty
+
+### BaseSerie.defaultColorBy
+
+public virtual SerieColorBy defaultColorBy
+
+### BaseSerie.gameObject
+
+public GameObject gameObject
+
+### BaseSerie.handler
+
+public SerieHandler handler
+
+### BaseSerie.multiDimensionLabel
+
+public virtual bool multiDimensionLabel
+
+### BaseSerie.OnBeforeSerialize()
+
+public virtual void OnBeforeSerialize()
+
+### BaseSerie.OnDataUpdate()
+
+public virtual void OnDataUpdate()
+
+### BaseSerie.painter
+
+public Painter painter
+
+### BaseSerie.refreshComponent
+
+public Action refreshComponent
+
+### BaseSerie.titleJustForSerie
+
+public virtual bool titleJustForSerie
+
+### BaseSerie.useSortData
+
+public virtual bool useSortData
+
+### BaseSerie.vertsDirty
+
+public virtual bool vertsDirty
+
+### BaseSerie.ClearComponentDirty
+
+public virtual void ClearComponentDirty()
-|public method|since|description|
-|--|--|--|
-|ClearComponentDirty()||public static void ClearComponentDirty(ChildComponent component)|
-|ClearComponentDirty()||public virtual void ClearComponentDirty()|
-|ClearData()||public virtual void ClearData() { }|
-|ClearDirty()||public virtual void ClearDirty()|
-|ClearVerticesDirty()||public static void ClearVerticesDirty(ChildComponent component)|
-|ClearVerticesDirty()||public virtual void ClearVerticesDirty()|
-|IsComponentDirty()||public static bool IsComponentDirty(ChildComponent component)|
-|IsVertsDirty()||public static bool IsVertsDirty(ChildComponent component)|
-|OnAfterDeserialize()||public virtual void OnAfterDeserialize()|
-|OnBeforeSerialize()||public virtual void OnBeforeSerialize() { }|
-|OnDataUpdate()||public virtual void OnDataUpdate() { }|
-|OnRemove()||public virtual void OnRemove()|
-|RefreshLabel()||public void RefreshLabel()|
-|SetAllDirty()||public virtual void SetAllDirty()|
-|SetComponentDirty()||public virtual void SetComponentDirty()|
-|SetVerticesDirty()||public virtual void SetVerticesDirty()|
+### BaseSerie.ClearData
+
+public virtual void ClearData() { }
+
+### BaseSerie.ClearDirty
+
+public virtual void ClearDirty()
+
+### BaseSerie.ClearVerticesDirty
+
+public virtual void ClearVerticesDirty()
+
+
+### BaseSerie.IsComponentDirty
+
+public static bool IsComponentDirty(ChildComponent component)
+
+### BaseSerie.IsVertsDirty
+
+public static bool IsVertsDirty(ChildComponent component)
+
+### BaseSerie.OnAfterDeserialize
+
+public virtual void OnAfterDeserialize()
+
+### BaseSerie.OnBeforeSerialize
+
+public virtual void OnBeforeSerialize() { }
+
+### BaseSerie.OnDataUpdate
+
+public virtual void OnDataUpdate() { }
+
+### BaseSerie.OnRemove
+
+public virtual void OnRemove()
+
+### BaseSerie.RefreshLabel
+
+public void RefreshLabel()
+
+### BaseSerie.SetAllDirty
+
+public virtual void SetAllDirty()
+
+### BaseSerie.SetComponentDirty
+
+public virtual void SetComponentDirty()
+
+### BaseSerie.SetVerticesDirty
+
+public virtual void SetVerticesDirty()
## BlurStyle
-> class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
> Since `v3.2.0`
@@ -981,1478 +2741,3667 @@ Configurations of blur state.
## BorderStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.10.0`
The style of border.
-|public method|since|description|
-|--|--|--|
-|GetRuntimeBorderColor()||public Color32 GetRuntimeBorderColor()|
-|GetRuntimeBorderWidth()||public float GetRuntimeBorderWidth()|
-|GetRuntimeCornerRadius()||public float[] GetRuntimeCornerRadius()|
+### BorderStyle.GetRuntimeBorderColor
+
+public Color32 GetRuntimeBorderColor()
+
+### BorderStyle.GetRuntimeBorderWidth
+
+public float GetRuntimeBorderWidth()
+
+### BorderStyle.GetRuntimeCornerRadius
+
+public float[] GetRuntimeCornerRadius()
## CalendarCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer)
+### CalendarCoord.IsPointerEnter
-|public method|since|description|
-|--|--|--|
-|IsPointerEnter()||public bool IsPointerEnter()|
-|UpdateRuntimeData()||public void UpdateRuntimeData(BaseChart chart)|
+public bool IsPointerEnter()
+
+### CalendarCoord.UpdateRuntimeData
+
+public void UpdateRuntimeData(BaseChart chart)
## Candlestick
-> class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+### Candlestick.containerIndex
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
+public int containerIndex
+
+### Candlestick.containterInstanceId
+
+public int containterInstanceId
+
+### Candlestick.AddDefaultSerie
+
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
## CandlestickChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
A candlestick chart is a style of financial chart used to describe price movements of a security, derivative, or currency.
## ChartCached
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### ChartCached.ColorToDotStr
-|public method|since|description|
-|--|--|--|
-|ColorToDotStr()||public static string ColorToDotStr(Color color)|
-|ColorToStr()||public static string ColorToStr(Color color)|
-|FloatToStr()||public static string FloatToStr(double value, string numericFormatter = "F", int precision = 0)|
-|GetSerieLabelName()||public static string GetSerieLabelName(string prefix, int i, int j)|
-|GetString()||public static string GetString(string prefix, int suffix)|
-|IntToStr()||public static string IntToStr(int value, string numericFormatter = "")|
-|NumberToStr()||public static string NumberToStr(double value, string formatter)|
+public static string ColorToDotStr(Color color)
+
+### ChartCached.ColorToStr
+
+public static string ColorToStr(Color color)
+
+### ChartCached.FloatToStr
+
+public static string FloatToStr(double value, string numericFormatter = "F", int precision = 0)
+
+### ChartCached.GetSerieLabelName
+
+public static string GetSerieLabelName(string prefix, int i, int j)
+
+### ChartCached.GetString
+
+public static string GetString(string prefix, int suffix)
+
+### ChartCached.IntToStr
+
+public static string IntToStr(int value, string numericFormatter = "")
+
+### ChartCached.NumberToDateStr
+
+public static string NumberToDateStr(double timestamp, string formatter)
+
+### ChartCached.NumberToDateTime
+
+public static DateTime NumberToDateTime(double timestamp)
+
+### ChartCached.NumberToStr
+
+public static string NumberToStr(double value, string formatter)
+
+### ChartCached.NumberToTimeSpan
+
+public static TimeSpan NumberToTimeSpan(double timestamp)
+
+### ChartCached.NumberToTimeStr
+
+public static string NumberToTimeStr(double timestamp, string formatter)
## ChartConst
-> class in XCharts.Runtime
-
+class in XCharts.Runtime
## ChartDrawer
-> class in XCharts.Runtime
-
+class in XCharts.Runtime
## ChartHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### ChartHelper.ignoreVector3
+
+public static Vector3 ignoreVector3
+
+### ChartHelper.sb
+
+public static StringBuilder sb
+
+### ChartHelper.ActiveAllObject
+
+public static void ActiveAllObject(Transform parent, bool active, string match = null)
+
+### ChartHelper.AddIcon
+
+public static Image AddIcon(string name, Transform parent, IconStyle iconStyle)
+
+### ChartHelper.Cancat
+
+public static string Cancat(string str1, int i)
-|public method|since|description|
-|--|--|--|
-|ActiveAllObject()||public static void ActiveAllObject(Transform parent, bool active, string match = null)|
-|AddIcon()||public static Image AddIcon(string name, Transform parent, IconStyle iconStyle)|
-|Cancat()||public static string Cancat(string str1, int i)|
-|Cancat()||public static string Cancat(string str1, string str2)|
-|ClearEventListener()||public static void ClearEventListener(GameObject obj)|
-|CopyArray<T>()||public static bool CopyArray<T>(T[] toList, T[] fromList)|
-|CopyList<T>()||public static bool CopyList<T>(List<T> toList, List<T> fromList)|
-|DestoryGameObject()||public static void DestoryGameObject(GameObject go)|
-|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)|
-|GetColor()||public static Color32 GetColor(string hexColorStr)|
-|GetDire()||public static Vector3 GetDire(float angle, bool isDegree = false)|
-|GetFullName()||public static string GetFullName(Transform transform)|
-|GetHighlightColor()||public static Color32 GetHighlightColor(Color32 color, float rate = 0.8f)|
-|GetLastValue()||public static Vector3 GetLastValue(List<Vector3> list)|
-|GetMaxCeilRate()||public static double GetMaxCeilRate(double value, double ceilRate)|
-|GetMaxDivisibleValue()||public static double GetMaxDivisibleValue(double max, double ceilRate)|
-|GetMaxLogValue()||public static double GetMaxLogValue(double value, float logBase, bool isLogBaseE, out int splitNumber)|
-|GetMinCeilRate()||public static double GetMinCeilRate(double value, double ceilRate)|
-|GetMinDivisibleValue()||public static double GetMinDivisibleValue(double min, double ceilRate)|
-|GetMinLogValue()||public static double GetMinLogValue(double value, float logBase, bool isLogBaseE, out int splitNumber)|
-|GetOrAddComponent<T>()||public static T GetOrAddComponent<T>(GameObject gameObject) where T : Component|
-|GetOrAddComponent<T>()||public static T GetOrAddComponent<T>(Transform transform) where T : Component|
-|GetPointList()||public static void GetPointList(ref List<Vector3> posList, Vector3 sp, Vector3 ep, float k = 30f)|
-|GetPos()||public static Vector3 GetPos(Vector3 center, float radius, float angle, bool isDegree = false)|
-|GetPosition()||public static Vector3 GetPosition(Vector3 center, float angle, float radius)|
-|GetSelectColor()||public static Color32 GetSelectColor(Color32 color, float rate = 0.8f)|
-|GetVertialDire()||public static Vector3 GetVertialDire(Vector3 dire)|
-|HideAllObject()||public static void HideAllObject(GameObject obj, string match = null)|
-|HideAllObject()||public static void HideAllObject(Transform parent, string match = null)|
-|IsClearColor()||public static bool IsClearColor(Color color)|
-|IsClearColor()||public static bool IsClearColor(Color32 color)|
-|IsColorAlphaZero()||public static bool IsColorAlphaZero(Color color)|
-|IsEquals()||public static bool IsEquals(double d1, double d2)|
-|IsEquals()||public static bool IsEquals(float d1, float d2)|
-|IsIngore()||public static bool IsIngore(Vector3 pos)|
-|IsInRect()||public static bool IsInRect(Vector3 pos, float xMin, float xMax, float yMin, float yMax)|
-|IsPointInQuadrilateral()||public static bool IsPointInQuadrilateral(Vector3 P, Vector3 A, Vector3 B, Vector3 C, Vector3 D)|
-|IsValueEqualsColor()||public static bool IsValueEqualsColor(Color color1, Color color2)|
-|IsValueEqualsColor()||public static bool IsValueEqualsColor(Color32 color1, Color32 color2)|
-|IsValueEqualsList<T>()||public static bool IsValueEqualsList<T>(List<T> list1, List<T> list2)|
-|IsValueEqualsString()||public static bool IsValueEqualsString(string str1, string str2)|
-|IsValueEqualsVector2()||public static bool IsValueEqualsVector2(Vector2 v1, Vector2 v2)|
-|IsValueEqualsVector3()||public static bool IsValueEqualsVector3(Vector3 v1, Vector3 v2)|
-|IsZeroVector()||public static bool IsZeroVector(Vector3 pos)|
-|ParseFloatFromString()||public static List<float> ParseFloatFromString(string jsonData)|
-|ParseStringFromString()||public static List<string> ParseStringFromString(string jsonData)|
-|RemoveComponent<T>()||public static void RemoveComponent<T>(GameObject gameObject)|
-|RotateRound()||public static Vector3 RotateRound(Vector3 position, Vector3 center, Vector3 axis, float angle)|
-|SaveAsImage()||public static Texture2D SaveAsImage(RectTransform rectTransform, Canvas canvas, string imageType = "png", string path = "")|
-|SetActive()||public static void SetActive(GameObject gameObject, bool active)|
-|SetActive()||public static void SetActive(Image image, bool active)|
-|SetActive()||public static void SetActive(Text text, bool active)|
-|SetActive()||public static void SetActive(Transform transform, bool active)
通过设置scale实现是否显示,优化性能,减少GC |
-|SetBackground()||public static void SetBackground(Image background, Background imageStyle)|
-|SetBackground()||public static void SetBackground(Image background, ImageStyle imageStyle)|
-|SetColorOpacity()||public static void SetColorOpacity(ref Color32 color, float opacity)|
+### ChartHelper.ClearEventListener
+
+public static void ClearEventListener(GameObject obj)
+
+### ChartHelper.CopyArray<T>
+
+public static bool CopyArray<T>(T[] toList, T[] fromList)
+
+### ChartHelper.CopyList<T>
+
+public static bool CopyList<T>(List<T> toList, List<T> fromList)
+
+### ChartHelper.DestoryGameObject
+
+public static void DestoryGameObject(GameObject go)
+
+
+### ChartHelper.DestoryGameObjectByMatch
+
+public static void DestoryGameObjectByMatch(Transform parent, string containString)
+
+### ChartHelper.DestroyAllChildren
+
+public static void DestroyAllChildren(Transform parent)
+
+### ChartHelper.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.
+
+
+### ChartHelper.GetActualValue
+
+public static float GetActualValue(float valueOrRate, float total, float maxRate = 1.5f)
+
+### ChartHelper.GetAngle360
+
+public static float GetAngle360(Vector2 from, Vector2 to)
+获得0-360的角度(12点钟方向为0度)
+
+### ChartHelper.GetBlurColor
+
+public static Color32 GetBlurColor(Color32 color, float a = 0.3f)
+
+### ChartHelper.GetColor
+
+public static Color32 GetColor(string hexColorStr)
+
+### ChartHelper.GetDire
+
+public static Vector3 GetDire(float angle, bool isDegree = false)
+
+### ChartHelper.GetFullName
+
+public static string GetFullName(Transform transform)
+
+### ChartHelper.GetHighlightColor
+
+public static Color32 GetHighlightColor(Color32 color, float rate = 0.8f)
+
+### ChartHelper.GetLastValue
+
+public static Vector3 GetLastValue(List<Vector3> list)
+
+### ChartHelper.GetMaxCeilRate
+
+public static double GetMaxCeilRate(double value, double ceilRate)
+
+### ChartHelper.GetMaxDivisibleValue
+
+public static double GetMaxDivisibleValue(double max, double ceilRate)
+
+### ChartHelper.GetMaxLogValue
+
+public static double GetMaxLogValue(double value, float logBase, bool isLogBaseE, out int splitNumber)
+
+### ChartHelper.GetMinCeilRate
+
+public static double GetMinCeilRate(double value, double ceilRate)
+
+### ChartHelper.GetMinDivisibleValue
+
+public static double GetMinDivisibleValue(double min, double ceilRate)
+
+### ChartHelper.GetMinLogValue
+
+public static double GetMinLogValue(double value, float logBase, bool isLogBaseE, out int splitNumber)
+
+### ChartHelper.GetOrAddComponent<T>
+
+public static T GetOrAddComponent<T>(GameObject gameObject) where T : Component
+
+
+### ChartHelper.GetPointList
+
+public static void GetPointList(ref List<Vector3> posList, Vector3 sp, Vector3 ep, float k = 30f)
+
+### ChartHelper.GetPos
+
+public static Vector3 GetPos(Vector3 center, float radius, float angle, bool isDegree = false)
+
+### ChartHelper.GetPosition
+
+public static Vector3 GetPosition(Vector3 center, float angle, float radius)
+
+### ChartHelper.GetSelectColor
+
+public static Color32 GetSelectColor(Color32 color, float rate = 0.8f)
+
+### ChartHelper.GetVertialDire
+
+public static Vector3 GetVertialDire(Vector3 dire)
+
+### ChartHelper.HideAllObject
+
+public static void HideAllObject(Transform parent, string match = null)
+
+
+### ChartHelper.IsActiveByScale
+
+public static bool IsActiveByScale(Image image)
+
+public static bool IsActiveByScale(Transform transform)
+
+
+### ChartHelper.IsClearColor
+
+public static bool IsClearColor(Color color)
+
+
+### ChartHelper.IsColorAlphaZero
+
+public static bool IsColorAlphaZero(Color color)
+
+### ChartHelper.IsEquals
+
+public static bool IsEquals(float d1, float d2)
+
+
+### ChartHelper.IsIngore
+
+public static bool IsIngore(Vector3 pos)
+
+### ChartHelper.IsInRect
+
+public static bool IsInRect(Vector3 pos, float xMin, float xMax, float yMin, float yMax)
+
+### ChartHelper.IsPointInQuadrilateral
+
+public static bool IsPointInQuadrilateral(Vector3 P, Vector3 A, Vector3 B, Vector3 C, Vector3 D)
+
+### ChartHelper.IsValueEqualsColor
+
+public static bool IsValueEqualsColor(Color color1, Color color2)
+
+
+### ChartHelper.IsValueEqualsList<T>
+
+public static bool IsValueEqualsList<T>(List<T> list1, List<T> list2)
+
+### ChartHelper.IsValueEqualsString
+
+public static bool IsValueEqualsString(string str1, string str2)
+
+### ChartHelper.IsValueEqualsVector2
+
+public static bool IsValueEqualsVector2(Vector2 v1, Vector2 v2)
+
+### ChartHelper.IsValueEqualsVector3
+
+public static bool IsValueEqualsVector3(Vector3 v1, Vector3 v2)
+
+### ChartHelper.IsZeroVector
+
+public static bool IsZeroVector(Vector3 pos)
+
+### ChartHelper.ParseFloatFromString
+
+public static List<float> ParseFloatFromString(string jsonData)
+
+### ChartHelper.ParseStringFromString
+
+public static List<string> ParseStringFromString(string jsonData)
+
+### ChartHelper.RemoveComponent<T>
+
+public static void RemoveComponent<T>(GameObject gameObject)
+
+### ChartHelper.RotateRound
+
+public static Vector3 RotateRound(Vector3 position, Vector3 center, Vector3 axis, float angle)
+
+### ChartHelper.SaveAsImage
+
+public static Texture2D SaveAsImage(RectTransform rectTransform, Canvas canvas, string imageType = "png", string path = "")
+
+### ChartHelper.SetActive
+
+public static bool SetActive(Image image, bool active)
+
+public static bool SetActive(Text text, bool active)
+
+public static bool SetActive(Transform transform, bool active)
+通过设置scale实现是否显示,优化性能,减少GC
+
+
+### ChartHelper.SetBackground
+
+public static void SetBackground(Image background, Background imageStyle)
+
+
+### ChartHelper.SetColorOpacity
+
+public static void SetColorOpacity(ref Color32 color, float opacity)
## ChartLabel
-> class in XCharts.Runtime / Inherits from: [Image](https://docs.unity3d.com/ScriptReference/30_search.html?q=image)
+class in XCharts.Runtime / Inherits from: [Image](https://docs.unity3d.com/ScriptReference/30_search.html?q=image)
+### ChartLabel.hideIconIfTextEmpty
-|public method|since|description|
-|--|--|--|
-|GetHeight()||public float GetHeight()|
-|GetPosition()||public Vector3 GetPosition()|
-|GetTextHeight()||public float GetTextHeight()|
-|GetTextWidth()||public float GetTextWidth()|
-|GetWidth()||public float GetWidth()|
-|IsActiveByScale()||public bool IsActiveByScale()|
-|SetActive()||public void SetActive(bool flag)|
-|SetIcon()||public void SetIcon(Image image)|
-|SetIconActive()||public void SetIconActive(bool flag)|
-|SetIconSize()||public void SetIconSize(float width, float height)|
-|SetIconSprite()||public void SetIconSprite(Sprite sprite)|
-|SetPadding()||public void SetPadding(float[] padding)|
-|SetPosition()||public void SetPosition(Vector3 position)|
-|SetRectPosition()||public void SetRectPosition(Vector3 position)|
-|SetRotate()||public void SetRotate(float rotate)|
-|SetSize()||public void SetSize(float width, float height)|
-|SetText()||public bool SetText(string text)|
-|SetTextActive()||public void SetTextActive(bool flag)|
-|SetTextColor()||public void SetTextColor(Color color)|
-|SetTextPadding()||public void SetTextPadding(TextPadding padding)|
-|SetTextRotate()||public void SetTextRotate(float rotate)|
-|UpdateIcon()||public void UpdateIcon(IconStyle iconStyle, Sprite sprite = null, Color color = default(Color))|
+public bool hideIconIfTextEmpty
+
+### ChartLabel.isAnimationEnd
+
+public bool isAnimationEnd
+
+### ChartLabel.isIconActive
+
+public bool isIconActive
+
+### ChartLabel.rect
+
+public Rect rect
+
+### ChartLabel.GetHeight
+
+public float GetHeight()
+
+### ChartLabel.GetPosition
+
+public Vector3 GetPosition()
+
+### ChartLabel.GetTextHeight
+
+public float GetTextHeight()
+
+### ChartLabel.GetTextWidth
+
+public float GetTextWidth()
+
+### ChartLabel.GetWidth
+
+public float GetWidth()
+
+### ChartLabel.IsActiveByScale
+
+public bool IsActiveByScale()
+
+### ChartLabel.SetActive
+
+public void SetActive(bool flag, bool force = false)
+
+### ChartLabel.SetIcon
+
+public void SetIcon(Image image)
+
+### ChartLabel.SetIconActive
+
+public void SetIconActive(bool flag)
+
+### ChartLabel.SetIconSize
+
+public void SetIconSize(float width, float height)
+
+### ChartLabel.SetIconSprite
+
+public void SetIconSprite(Sprite sprite)
+
+### ChartLabel.SetPadding
+
+public void SetPadding(float[] padding)
+
+### ChartLabel.SetPosition
+
+public void SetPosition(Vector3 position)
+
+### ChartLabel.SetRectPosition
+
+public void SetRectPosition(Vector3 position)
+
+### ChartLabel.SetRotate
+
+public void SetRotate(float rotate)
+
+### ChartLabel.SetSize
+
+public void SetSize(float width, float height)
+
+### ChartLabel.SetText
+
+public bool SetText(string text)
+
+### ChartLabel.SetTextActive
+
+public void SetTextActive(bool flag)
+
+### ChartLabel.SetTextColor
+
+public void SetTextColor(Color color)
+
+### ChartLabel.SetTextPadding
+
+public void SetTextPadding(TextPadding padding)
+
+### ChartLabel.SetTextRotate
+
+public void SetTextRotate(float rotate)
+
+### ChartLabel.UpdateIcon
+
+public void UpdateIcon(IconStyle iconStyle, Sprite sprite = null, Color color = default(Color))
## ChartObject
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### ChartObject.Destroy
-|public method|since|description|
-|--|--|--|
-|Destroy()||public virtual void Destroy()|
+public virtual void Destroy()
## ChartText
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### ChartText.tmpText
+
+public TextMeshProUGUI tmpText
+
+### ChartText.ChartText
+
+public ChartText(GameObject textParent)
-|public method|since|description|
-|--|--|--|
-|ChartText()||public ChartText()|
-|ChartText()||public ChartText(GameObject textParent)|
-|GetColor()||public Color GetColor()|
-|GetPreferredHeight()||public float GetPreferredHeight()|
-|GetPreferredText()||public string GetPreferredText(string content, string suffix, float maxWidth)|
-|GetPreferredWidth()||public float GetPreferredWidth()|
-|GetPreferredWidth()||public float GetPreferredWidth(string content)|
-|GetText()||public string GetText()|
-|SetActive()||public void SetActive(bool flag)|
-|SetAlignment()||public void SetAlignment(TextAnchor alignment)|
-|SetColor()||public void SetColor(Color color)|
-|SetFont()||public void SetFont(Font font)|
-|SetFont()||public void SetFont(TMP_FontAsset font)|
-|SetFontAndSizeAndStyle()||public void SetFontAndSizeAndStyle(TextStyle textStyle, ComponentTheme theme)|
-|SetFontSize()||public void SetFontSize(float fontSize)|
-|SetFontStyle()||public void SetFontStyle(FontStyle fontStyle)|
-|SetLineSpacing()||public void SetLineSpacing(float lineSpacing)|
-|SetLocalEulerAngles()||public void SetLocalEulerAngles(Vector3 position)|
-|SetLocalPosition()||public void SetLocalPosition(Vector3 position)|
-|SetRectPosition()||public void SetRectPosition(Vector3 position)|
-|SetSizeDelta()||public void SetSizeDelta(Vector2 sizeDelta)|
-|SetText()||public void SetText(string text)|
+### ChartText.GetColor
+
+public Color GetColor()
+
+### ChartText.GetPreferredHeight
+
+public float GetPreferredHeight()
+
+### ChartText.GetPreferredText
+
+public string GetPreferredText(string content, string suffix, float maxWidth)
+
+### ChartText.GetPreferredWidth
+
+public float GetPreferredWidth()
+
+
+### ChartText.GetText
+
+public string GetText()
+
+### ChartText.SetActive
+
+public void SetActive(bool flag)
+
+### ChartText.SetAlignment
+
+public void SetAlignment(TextAnchor alignment)
+
+### ChartText.SetColor
+
+public void SetColor(Color color)
+
+### ChartText.SetFont
+
+public void SetFont(TMP_FontAsset font)
+
+
+### ChartText.SetFontAndSizeAndStyle
+
+public void SetFontAndSizeAndStyle(TextStyle textStyle, ComponentTheme theme)
+
+### ChartText.SetFontSize
+
+public void SetFontSize(float fontSize)
+
+### ChartText.SetFontStyle
+
+public void SetFontStyle(FontStyle fontStyle)
+
+### ChartText.SetLineSpacing
+
+public void SetLineSpacing(float lineSpacing)
+
+### ChartText.SetLocalEulerAngles
+
+public void SetLocalEulerAngles(Vector3 position)
+
+### ChartText.SetLocalPosition
+
+public void SetLocalPosition(Vector3 position)
+
+### ChartText.SetRectPosition
+
+public void SetRectPosition(Vector3 position)
+
+### ChartText.SetSizeDelta
+
+public void SetSizeDelta(Vector2 sizeDelta)
+
+### ChartText.SetText
+
+public void SetText(string text)
## CheckHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### CheckHelper.CheckChart
+
+public static string CheckChart(BaseChart chart)
-|public method|since|description|
-|--|--|--|
-|CheckChart()||public static string CheckChart(BaseChart chart)|
-|CheckChart()||public static string CheckChart(BaseGraph chart)|
## ChildComponent
-> class in XCharts.Runtime / Subclasses: [AnimationStyle](#animationstyle),[AxisAnimation](#axisanimation),[AxisName](#axisname),[AxisSplitArea](#axissplitarea),[AreaStyle](#areastyle),[ArrowStyle](#arrowstyle),[BaseLine](#baseline),[BorderStyle](#borderstyle),[IconStyle](#iconstyle),[ImageStyle](#imagestyle),[ItemStyle](#itemstyle),[Level](#level),[LevelStyle](#levelstyle),[LineArrow](#linearrow),[LineStyle](#linestyle),[Location](#location),[MLValue](#mlvalue),[MarqueeStyle](#marqueestyle),[Padding](#padding),[StageColor](#stagecolor),[SymbolStyle](#symbolstyle),[TextLimit](#textlimit),[TextStyle](#textstyle),[CommentItem](#commentitem),[CommentMarkStyle](#commentmarkstyle),[LabelLine](#labelline),[LabelStyle](#labelstyle),[MarkAreaData](#markareadata),[MarkLineData](#marklinedata),[StateStyle](#statestyle),[VisualMapRange](#visualmaprange),[ViewControl](#viewcontrol),[UIComponentTheme](#uicomponenttheme),[SerieData](#seriedata),[SerieDataLink](#seriedatalink),[ComponentTheme](#componenttheme),[SerieTheme](#serietheme),[ThemeStyle](#themestyle)
+class in XCharts.Runtime / Subclasses: [AnimationStyle](#animationstyle),[AxisAnimation](#axisanimation),[AxisName](#axisname),[AxisSplitArea](#axissplitarea),[AreaStyle](#areastyle),[ArrowStyle](#arrowstyle),[BaseLine](#baseline),[BorderStyle](#borderstyle),[IconStyle](#iconstyle),[ImageStyle](#imagestyle),[ItemStyle](#itemstyle),[Level](#level),[LevelStyle](#levelstyle),[LineArrow](#linearrow),[LineStyle](#linestyle),[Location](#location),[MLValue](#mlvalue),[MarqueeStyle](#marqueestyle),[Padding](#padding),[StageColor](#stagecolor),[SymbolStyle](#symbolstyle),[TextLimit](#textlimit),[TextStyle](#textstyle),[CommentItem](#commentitem),[CommentMarkStyle](#commentmarkstyle),[LabelLine](#labelline),[LabelStyle](#labelstyle),[MarkAreaData](#markareadata),[MarkLineData](#marklinedata),[StateStyle](#statestyle),[VisualMapRange](#visualmaprange),[ViewControl](#viewcontrol),[UIComponentTheme](#uicomponenttheme),[SerieData](#seriedata),[SerieDataLink](#seriedatalink),[ComponentTheme](#componenttheme),[SerieTheme](#serietheme),[ThemeStyle](#themestyle)
+
+### ChildComponent.anyDirty
+
+public bool anyDirty
+需要重绘图表或重新初始化组件。
+
+### ChildComponent.componentDirty
+
+public virtual bool componentDirty
+组件重新初始化标记。
+
+### ChildComponent.gameObject
+
+public GameObject gameObject
+
+### ChildComponent.index
+
+public virtual int index
+
+### ChildComponent.painter
+
+public Painter painter
+
+### ChildComponent.refreshComponent
+
+public Action refreshComponent
+
+### ChildComponent.vertsDirty
+
+public virtual bool vertsDirty
+图表重绘标记。
+
+### ChildComponent.ClearComponentDirty
+
+public virtual void ClearComponentDirty()
-|public method|since|description|
-|--|--|--|
-|ClearComponentDirty()||public static void ClearComponentDirty(ChildComponent component)|
-|ClearComponentDirty()||public virtual void ClearComponentDirty()|
-|ClearDirty()||public virtual void ClearDirty()|
-|ClearVerticesDirty()||public static void ClearVerticesDirty(ChildComponent component)|
-|ClearVerticesDirty()||public virtual void ClearVerticesDirty()|
-|IsComponentDirty()||public static bool IsComponentDirty(ChildComponent component)|
-|IsVertsDirty()||public static bool IsVertsDirty(ChildComponent component)|
-|SetAllDirty()||public virtual void SetAllDirty()|
-|SetComponentDirty()||public virtual void SetComponentDirty()|
-|SetVerticesDirty()||public virtual void SetVerticesDirty()|
+### ChildComponent.ClearDirty
+
+public virtual void ClearDirty()
+
+### ChildComponent.ClearVerticesDirty
+
+public virtual void ClearVerticesDirty()
+
+
+### ChildComponent.IsComponentDirty
+
+public static bool IsComponentDirty(ChildComponent component)
+
+### ChildComponent.IsVertsDirty
+
+public static bool IsVertsDirty(ChildComponent component)
+
+### ChildComponent.SetAllDirty
+
+public virtual void SetAllDirty()
+
+### ChildComponent.SetComponentDirty
+
+public virtual void SetComponentDirty()
+
+### ChildComponent.SetVerticesDirty
+
+public virtual void SetVerticesDirty()
## ColorUtil
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### ColorUtil.GetColor
-|public method|since|description|
-|--|--|--|
-|GetColor()||public static Color32 GetColor(string hexColorStr)
Convert the html string to color. |
+public static Color32 GetColor(string hexColorStr)
+Convert the html string to color.
## Comment
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged)
comment of chart.
-|public method|since|description|
-|--|--|--|
-|GetLabelStyle()||public LabelStyle GetLabelStyle(int index)|
-|GetMarkStyle()||public CommentMarkStyle GetMarkStyle(int index)|
-|OnChanged()||public void OnChanged()
Callback handling when parameters change. |
+### Comment.items
+
+public List<CommentItem> items
+The items of comment.
+
+### Comment.show
+
+public bool show
+Set this to false to prevent the comment from showing.
+
+### Comment.GetLabelStyle
+
+public LabelStyle GetLabelStyle(int index)
+
+### Comment.GetMarkStyle
+
+public CommentMarkStyle GetMarkStyle(int index)
+
+### Comment.OnChanged
+
+public void OnChanged()
+Callback handling when parameters change.
## CommentItem
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
comment of chart.
+### CommentItem.content
+
+public string content
+content of comment.
+
+### CommentItem.markRect
+
+public Rect markRect
+the mark rect of comment.
+
+### CommentItem.markStyle
+
+public CommentMarkStyle markStyle
+the mark rect style.
+
+### CommentItem.show
+
+public bool show
+Set this to false to prevent this comment item from showing.
+
## CommentMarkStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
the comment mark style.
+### CommentMarkStyle.lineStyle
+
+public LineStyle lineStyle
+line style of comment mark area.
+
+### CommentMarkStyle.show
+
+public bool show
+Set this to false to prevent this comment item from showing.
+
## ComponentHandlerAttribute
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+### ComponentHandlerAttribute.ComponentHandlerAttribute
+
+public ComponentHandlerAttribute(Type handler, bool allowMultiple, int order = 3)
-|public method|since|description|
-|--|--|--|
-|ComponentHandlerAttribute()||public ComponentHandlerAttribute(Type handler, bool allowMultiple, int order = 3)|
-|ComponentHandlerAttribute()||public ComponentHandlerAttribute(Type handler, int order = 3)|
## ComponentHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### ComponentHelper.GetAngleAxis
-|public method|since|description|
-|--|--|--|
-|GetAngleAxis()||public static AngleAxis GetAngleAxis(List<MainComponent> components, int polarIndex)|
-|GetRadiusAxis()||public static RadiusAxis GetRadiusAxis(List<MainComponent> components, int polarIndex)|
-|GetXAxisOnZeroOffset()||public static float GetXAxisOnZeroOffset(List<MainComponent> components, XAxis axis)|
-|GetYAxisOnZeroOffset()||public static float GetYAxisOnZeroOffset(List<MainComponent> components, YAxis axis)|
-|IsAnyCategoryOfYAxis()||public static bool IsAnyCategoryOfYAxis(List<MainComponent> components)|
+public static AngleAxis GetAngleAxis(List<MainComponent> components, int polarIndex)
+
+### ComponentHelper.GetRadiusAxis
+
+public static RadiusAxis GetRadiusAxis(List<MainComponent> components, int polarIndex)
+
+### ComponentHelper.GetXAxisOnZeroOffset
+
+public static float GetXAxisOnZeroOffset(List<MainComponent> components, XAxis axis)
+
+### ComponentHelper.GetYAxisOnZeroOffset
+
+public static float GetYAxisOnZeroOffset(List<MainComponent> components, YAxis axis)
+
+### ComponentHelper.IsAnyCategoryOfYAxis
+
+public static bool IsAnyCategoryOfYAxis(List<MainComponent> components)
## ComponentTheme
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [BaseAxisTheme](#baseaxistheme),[DataZoomTheme](#datazoomtheme),[LegendTheme](#legendtheme),[SubTitleTheme](#subtitletheme),[TitleTheme](#titletheme),[TooltipTheme](#tooltiptheme),[VisualMapTheme](#visualmaptheme)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [BaseAxisTheme](#baseaxistheme),[DataZoomTheme](#datazoomtheme),[LegendTheme](#legendtheme),[SubTitleTheme](#subtitletheme),[TitleTheme](#titletheme),[TooltipTheme](#tooltiptheme),[VisualMapTheme](#visualmaptheme)
+### ComponentTheme.ComponentTheme
-|public method|since|description|
-|--|--|--|
-|ComponentTheme()||public ComponentTheme(ThemeType theme)|
-|Copy()||public virtual void Copy(ComponentTheme theme)|
-|Reset()||public virtual void Reset(ComponentTheme defaultTheme)|
+public ComponentTheme(ThemeType theme)
+
+### ComponentTheme.Copy
+
+public virtual void Copy(ComponentTheme theme)
+
+### ComponentTheme.Reset
+
+public virtual void Reset(ComponentTheme defaultTheme)
## CoordOptionsAttribute
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+### CoordOptionsAttribute.Contains<T>
+
+public bool Contains<T>() where T : CoordSystem
+
+### CoordOptionsAttribute.CoordOptionsAttribute
+
+public CoordOptionsAttribute(Type coord, Type coord2)
+
+public CoordOptionsAttribute(Type coord, Type coord2, Type coord3)
+
+public CoordOptionsAttribute(Type coord, Type coord2, Type coord3, Type coord4)
-|public method|since|description|
-|--|--|--|
-|Contains<T>()||public bool Contains<T>() where T : CoordSystem|
-|CoordOptionsAttribute()||public CoordOptionsAttribute(Type coord)|
-|CoordOptionsAttribute()||public CoordOptionsAttribute(Type coord, Type coord2)|
-|CoordOptionsAttribute()||public CoordOptionsAttribute(Type coord, Type coord2, Type coord3)|
-|CoordOptionsAttribute()||public CoordOptionsAttribute(Type coord, Type coord2, Type coord3, Type coord4)|
## CoordSystem
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent) / Subclasses: [RadarCoord](#radarcoord),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[GridCoord3D](#gridcoord3d),[ParallelCoord](#parallelcoord),[PolarCoord](#polarcoord),[SingleAxisCoord](#singleaxiscoord)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent) / Subclasses: [RadarCoord](#radarcoord),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[GridCoord3D](#gridcoord3d),[ParallelCoord](#parallelcoord),[PolarCoord](#polarcoord),[SingleAxisCoord](#singleaxiscoord)
Coordinate system component.
## DataHelper
-> class in XCharts.Runtime
-
+class in XCharts.Runtime
## DataZoom
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent),[IUpdateRuntimeData](#iupdateruntimedata)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent),[IUpdateRuntimeData](#iupdateruntimedata)
DataZoom component is used for zooming a specific area, which enables user to investigate data in detail, or get an overview of the data, or get rid of outlier points.
-|public method|since|description|
-|--|--|--|
-|GetBackgroundColor()||public Color32 GetBackgroundColor(Color32 themeColor)|
-|GetBorderColor()||public Color32 GetBorderColor(Color32 themeColor)|
-|GetFillerColor()||public Color32 GetFillerColor(Color32 themeColor)|
-|IsContainsAxis()||public bool IsContainsAxis(Axis axis)|
-|IsContainsXAxis()||public bool IsContainsXAxis(int index)|
-|IsContainsYAxis()||public bool IsContainsYAxis(int index)|
-|IsInEndZoom()||public bool IsInEndZoom(Vector2 pos)
给定的坐标是否在结束活动条触发区域内 |
-|IsInMarqueeArea()||public bool IsInMarqueeArea(SerieData serieData)|
-|IsInMarqueeArea()||public bool IsInMarqueeArea(Vector2 pos)|
-|IsInSelectedZoom()||public bool IsInSelectedZoom(int totalIndex, int index, bool invert)|
-|IsInSelectedZoom()||public bool IsInSelectedZoom(Vector2 pos)
给定的坐标是否在选中区域内 |
-|IsInStartZoom()||public bool IsInStartZoom(Vector2 pos)
给定的坐标是否在开始活动条触发区域内 |
-|IsInZoom()||public bool IsInZoom(Vector2 pos)
给定的坐标是否在缩放区域内 |
-|SetDefaultValue()||public override void SetDefaultValue()|
-|UpdateRuntimeData()||public void UpdateRuntimeData(BaseChart chart)|
+### DataZoom.realtime
+
+public bool realtime
+Whether to show data shadow in dataZoom-silder component, to indicate the data tendency in brief.
+
+### DataZoom.startEndFunction
+
+public CustomDataZoomStartEndFunction startEndFunction
+start和end变更委托。
+
+### DataZoom.GetBackgroundColor
+
+public Color32 GetBackgroundColor(Color32 themeColor)
+
+### DataZoom.GetBorderColor
+
+public Color32 GetBorderColor(Color32 themeColor)
+
+### DataZoom.GetFillerColor
+
+public Color32 GetFillerColor(Color32 themeColor)
+
+### DataZoom.IsContainsAxis
+
+public bool IsContainsAxis(Axis axis)
+
+### DataZoom.IsContainsXAxis
+
+public bool IsContainsXAxis(int index)
+
+### DataZoom.IsContainsYAxis
+
+public bool IsContainsYAxis(int index)
+
+### DataZoom.IsInEndZoom
+
+public bool IsInEndZoom(Vector2 pos)
+给定的坐标是否在结束活动条触发区域内
+
+### DataZoom.IsInMarqueeArea
+
+public bool IsInMarqueeArea(Vector2 pos)
+
+
+### DataZoom.IsInSelectedZoom
+
+public bool IsInSelectedZoom(int totalIndex, int index, bool invert)
+
+
+### DataZoom.IsInStartZoom
+
+public bool IsInStartZoom(Vector2 pos)
+给定的坐标是否在开始活动条触发区域内
+
+### DataZoom.IsInZoom
+
+public bool IsInZoom(Vector2 pos)
+给定的坐标是否在缩放区域内
+
+### DataZoom.SetDefaultValue
+
+public override void SetDefaultValue()
+
+### DataZoom.UpdateRuntimeData
+
+public void UpdateRuntimeData(BaseChart chart)
+
+## DataZoom.FilterMode
+
+class in XCharts.Runtime
+
+Generally dataZoom component zoom or roam coordinate system through data filtering and set the windows of axes internally. Its behaviours vary according to filtering mode settings.
+
+Options:
+
+- `Filter`: data that outside the window will be filtered, which may lead to some changes of windows of other axes. For each data item, it will be filtered if one of the relevant dimensions is out of the window.
+- `WeakFilter`: data that outside the window will be filtered, which may lead to some changes of windows of other axes. For each data item, it will be filtered only if all of the relevant dimensions are out of the same side of the window.
+- `Empty`: data that outside the window will be set to NaN, which will not lead to changes of windows of other axes.
+- `None`: Do not filter data.
+
+## DataZoom.RangeMode
+
+class in XCharts.Runtime
+
+The value type of start and end.取值类型
+
+Options:
+
+- `//Value`: The value type of start and end.取值类型
+- `Percent`: percent value.
## DataZoomContext
-> class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
+class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
+### DataZoomContext.endValue
+
+public double endValue
+运行时实际范围的结束值
+
+### DataZoomContext.height
+
+public float height
+
+### DataZoomContext.invert
+
+public bool invert
+
+### DataZoomContext.isCoordinateDrag
+
+public bool isCoordinateDrag
+
+### DataZoomContext.isDrag
+
+public bool isDrag
+
+### DataZoomContext.isEndDrag
+
+public bool isEndDrag
+
+### DataZoomContext.isMarqueeDrag
+
+public bool isMarqueeDrag
+
+### DataZoomContext.isStartDrag
+
+public bool isStartDrag
+
+### DataZoomContext.marqueeEndPos
+
+public Vector3 marqueeEndPos
+
+### DataZoomContext.marqueeRect
+
+public Rect marqueeRect
+
+### DataZoomContext.marqueeStartPos
+
+public Vector3 marqueeStartPos
+
+### DataZoomContext.startValue
+
+public double startValue
+运行时实际范围的开始值
+
+### DataZoomContext.width
+
+public float width
+
+### DataZoomContext.x
+
+public float x
+
+### DataZoomContext.y
+
+public float y
## DataZoomHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### DataZoomHelper.UpdateDataZoomRuntimeStartEndValue
-|public method|since|description|
-|--|--|--|
-|UpdateDataZoomRuntimeStartEndValue()||public static void UpdateDataZoomRuntimeStartEndValue(DataZoom dataZoom, Serie serie)|
-|UpdateDataZoomRuntimeStartEndValue<T>()||public static void UpdateDataZoomRuntimeStartEndValue<T>(BaseChart chart) where T : Serie|
+public static void UpdateDataZoomRuntimeStartEndValue(DataZoom dataZoom, Serie serie)
+
+### DataZoomHelper.UpdateDataZoomRuntimeStartEndValue<T>
+
+public static void UpdateDataZoomRuntimeStartEndValue<T>(BaseChart chart) where T : Serie
## DataZoomTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+### DataZoomTheme.Copy
-|public method|since|description|
-|--|--|--|
-|Copy()||public void Copy(DataZoomTheme theme)|
-|DataZoomTheme()||public DataZoomTheme(ThemeType theme) : base(theme)|
+public void Copy(DataZoomTheme theme)
+
+### DataZoomTheme.DataZoomTheme
+
+public DataZoomTheme(ThemeType theme) : base(theme)
## DateTimeUtil
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### DateTimeUtil.GetDateTime
+
+public static DateTime GetDateTime(double timestamp, bool local = true)
+
+### DateTimeUtil.GetDefaultDateTimeString
+
+public static string GetDefaultDateTimeString(int timestamp, double range = 0)
+
+### DateTimeUtil.GetTimestamp
+
+public static int GetTimestamp(DateTime time, bool local = false)
+
+public static int GetTimestamp(string dateTime, bool local = false)
-|public method|since|description|
-|--|--|--|
-|GetDateTime()||public static DateTime GetDateTime(int timestamp)|
-|GetTimestamp()||public static int GetTimestamp()|
-|GetTimestamp()||public static int GetTimestamp(DateTime time)|
-|GetTimestamp()||public static int GetTimestamp(string dateTime)|
+### DateTimeUtil.IsDateOrTimeRegex
+
+public static bool IsDateOrTimeRegex(string regex, ref bool date, ref string formatter)
+
## DebugInfo
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### DebugInfo.avgFps
-|public method|since|description|
-|--|--|--|
-|Init()||public void Init(BaseChart chart)|
-|Update()||public void Update()|
+public float avgFps
+The average frame rate.
+
+### DebugInfo.foldSeries
+
+public bool foldSeries
+Whether to fold series in inspector view.
+
+### DebugInfo.fps
+
+public float fps
+frame rate.
+
+### DebugInfo.refreshCount
+
+public int refreshCount
+The fefresh count of chart per second.
+
+### DebugInfo.show
+
+public bool show
+Whether show debug component.
+
+### DebugInfo.showAllChartObject
+
+public bool showAllChartObject
+Whether show children components of chart in hierarchy view.
+
+### DebugInfo.Init
+
+public void Init(BaseChart chart)
+
+### DebugInfo.Update
+
+public void Update()
## DefaultAnimationAttribute
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+### DefaultAnimationAttribute.DefaultAnimationAttribute
+
+public DefaultAnimationAttribute(AnimationType handler, bool enableSerieDataAddedAnimation)
-|public method|since|description|
-|--|--|--|
-|DefaultAnimationAttribute()||public DefaultAnimationAttribute(AnimationType handler)|
-|DefaultAnimationAttribute()||public DefaultAnimationAttribute(AnimationType handler, bool enableSerieDataAddedAnimation)|
## DefaultTooltipAttribute
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+### DefaultTooltipAttribute.DefaultTooltipAttribute
-|public method|since|description|
-|--|--|--|
-|DefaultTooltipAttribute()||public DefaultTooltipAttribute(Tooltip.Type type, Tooltip.Trigger trigger)|
+public DefaultTooltipAttribute(Tooltip.Type type, Tooltip.Trigger trigger)
## DefineSymbolsUtil
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### DefineSymbolsUtil.AddGlobalDefine
-|public method|since|description|
-|--|--|--|
-|AddGlobalDefine()||public static void AddGlobalDefine(string symbol)|
-|RemoveGlobalDefine()||public static void RemoveGlobalDefine(string symbol)|
+public static void AddGlobalDefine(string symbol)
+
+### DefineSymbolsUtil.RemoveGlobalDefine
+
+public static void RemoveGlobalDefine(string symbol)
## EffectScatter
-> class in XCharts.Runtime / Inherits from: [BaseScatter](#basescatter)
+class in XCharts.Runtime / Inherits from: [BaseScatter](#basescatter)
+### EffectScatter.AddDefaultSerie
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
## EmphasisStyle
-> class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
> Since `v3.2.0`
Configurations of emphasis state.
+## EmphasisStyle.BlurScope
+
+class in XCharts.Runtime
+
+blur scope.
+
+Options:
+
+- `GridCoord`: coordinate system.
+- `Series`: series.
+- `Global`: global.
+
+## EmphasisStyle.FocusType
+
+class in XCharts.Runtime
+
+focus type.
+
+Options:
+
+- `None`: Do not fade out other data, it's by default.
+- `Self`: Only focus (not fade out) the element of the currently highlighted data.
+- `Series`: Focus on all elements of the series which the currently highlighted data belongs to.
+
## EndLabelStyle
-> class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle)
+class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle)
+### EndLabelStyle.EndLabelStyle
-|public method|since|description|
-|--|--|--|
-|EndLabelStyle()||public EndLabelStyle()|
+public EndLabelStyle()
## FormatterHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### FormatterHelper.NeedFormat
+
+public static bool NeedFormat(string content)
+
+### FormatterHelper.ReplaceAxisLabelContent
+
+public static void ReplaceAxisLabelContent(ref string content, string value)
-|public method|since|description|
-|--|--|--|
-|NeedFormat()||public static bool NeedFormat(string content)|
-|ReplaceAxisLabelContent()||public static void ReplaceAxisLabelContent(ref string content, string numericFormatter, double value)|
-|ReplaceAxisLabelContent()||public static void ReplaceAxisLabelContent(ref string content, string value)|
-|TrimAndReplaceLine()||public static string TrimAndReplaceLine(string content)|
-|TrimAndReplaceLine()||public static string TrimAndReplaceLine(StringBuilder sb)|
+### FormatterHelper.TrimAndReplaceLine
+
+public static string TrimAndReplaceLine(string content)
+
## GraphData
-> class in XCharts.Runtime
+class in XCharts.Runtime
the data struct of graph.
-|public method|since|description|
-|--|--|--|
-|AddEdge()||public GraphEdge AddEdge(string nodeId1, string nodeId2, double value)|
-|AddNode()||public GraphNode AddNode(string nodeId, string nodeName, int dataIndex, double value)|
-|BreadthFirstTraverse()||public void BreadthFirstTraverse(GraphNode startNode, System.Action<GraphNode> onTraverse)|
-|Clear()||public void Clear()|
-|DeepFirstTraverse()||public void DeepFirstTraverse(GraphNode startNode, System.Action<GraphNode> onTraverse)|
-|EachNode()||public void EachNode(System.Action<GraphNode> onEach)|
-|ExpandAllNodes()||public void ExpandAllNodes(bool flag, int level = -1)|
-|ExpandNode()||public void ExpandNode(string nodeId, bool flag)|
-|GetDepthNodes()||public List<List<GraphNode>> GetDepthNodes()|
-|GetEdge()||public GraphEdge GetEdge(string nodeId1, string nodeId2)|
-|GetExpandedNodesCount()||public static int GetExpandedNodesCount(List<GraphNode> nodes)|
-|GetMaxDepth()||public int GetMaxDepth()|
-|GetNode()||public GraphNode GetNode(string nodeId)|
-|GetNodeDepth()||// public int GetNodeDepth(GraphNode node)|
-|GetNodeDepth()||// public void GetNodeDepth(GraphNode node, ref int depth, int recursiveCount = 0)|
-|GetNodeDepth()||public int GetNodeDepth(GraphNode node, int recursiveCount = 0)|
-|GetNodesTotalValue()||public static double GetNodesTotalValue(List<GraphNode> nodes)|
-|GetRootNodes()||public List<GraphNode> GetRootNodes()|
-|GraphData()||public GraphData(bool directed)|
-|IsAllNodeInZeroPosition()||public bool IsAllNodeInZeroPosition()|
-|Refresh()||public void Refresh()|
+### GraphData.AddEdge
+
+public GraphEdge AddEdge(string nodeId1, string nodeId2, double value)
+
+### GraphData.AddNode
+
+public GraphNode AddNode(string nodeId, string nodeName, int dataIndex, double value)
+
+### GraphData.BreadthFirstTraverse
+
+public void BreadthFirstTraverse(GraphNode startNode, System.Action<GraphNode> onTraverse)
+
+### GraphData.Clear
+
+public void Clear()
+
+### GraphData.DeepFirstTraverse
+
+public void DeepFirstTraverse(GraphNode startNode, System.Action<GraphNode> onTraverse)
+
+### GraphData.EachNode
+
+public void EachNode(System.Action<GraphNode> onEach)
+
+### GraphData.ExpandAllNodes
+
+public void ExpandAllNodes(bool flag, int level = -1)
+
+### GraphData.ExpandNode
+
+public void ExpandNode(string nodeId, bool flag)
+
+### GraphData.GetDepthNodes
+
+public List<List<GraphNode>> GetDepthNodes()
+
+### GraphData.GetEdge
+
+public GraphEdge GetEdge(string nodeId1, string nodeId2)
+
+### GraphData.GetExpandedNodesCount
+
+public static int GetExpandedNodesCount(List<GraphNode> nodes)
+
+### GraphData.GetMaxDepth
+
+public int GetMaxDepth()
+
+### GraphData.GetNode
+
+public GraphNode GetNode(string nodeId)
+
+### GraphData.GetNodeDepth
+
+// public void GetNodeDepth(GraphNode node, ref int depth, int recursiveCount = 0)
+
+public int GetNodeDepth(GraphNode node, int recursiveCount = 0)
+
+
+### GraphData.GetNodesTotalValue
+
+public static double GetNodesTotalValue(List<GraphNode> nodes)
+
+### GraphData.GetRootNodes
+
+public List<GraphNode> GetRootNodes()
+
+### GraphData.GraphData
+
+public GraphData(bool directed)
+
+### GraphData.IsAllNodeInZeroPosition
+
+public bool IsAllNodeInZeroPosition()
+
+### GraphData.Refresh
+
+public void Refresh()
## GraphEdge
-> class in XCharts.Runtime
+class in XCharts.Runtime
The edge of graph.
-|public method|since|description|
-|--|--|--|
-|GraphEdge()||public GraphEdge(GraphNode node1, GraphNode node2, double value)|
-|IsPointInEdge()||public bool IsPointInEdge(Vector2 point)|
+### GraphEdge.GraphEdge
+
+public GraphEdge(GraphNode node1, GraphNode node2, double value)
+
+### GraphEdge.IsPointInEdge
+
+public bool IsPointInEdge(Vector2 point)
## GraphNode
-> class in XCharts.Runtime
+class in XCharts.Runtime
The node of graph.
-|public method|since|description|
-|--|--|--|
-|Expand()||public void Expand(bool flag)|
-|GraphNode()||public GraphNode(string id, string name, int dataIndex)|
-|IsAllInEdgesCollapsed()||public bool IsAllInEdgesCollapsed()|
-|IsAnyInEdgesExpanded()||public bool IsAnyInEdgesExpanded()|
-|ToString()||public override string ToString()|
+### GraphNode.degree
+
+public int degree
+
+### GraphNode.inDegree
+
+public int inDegree
+
+### GraphNode.outDegree
+
+public int outDegree
+
+### GraphNode.Expand
+
+public void Expand(bool flag)
+
+### GraphNode.GraphNode
+
+public GraphNode(string id, string name, int dataIndex)
+
+### GraphNode.IsAllInEdgesCollapsed
+
+public bool IsAllInEdgesCollapsed()
+
+### GraphNode.IsAnyInEdgesExpanded
+
+public bool IsAnyInEdgesExpanded()
+
+### GraphNode.ToString
+
+public override string ToString()
## GridCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer)
Grid component.
-|public method|since|description|
-|--|--|--|
-|BoundaryPoint()||public bool BoundaryPoint(Vector3 sp, Vector3 ep, ref List<Vector3> point)
给定的线段和Grid边界的交点 |
-|BoundaryPoint()||public bool BoundaryPoint(Vector3 sp, Vector3 ep, ref Vector3 point)
给定的线段和Grid边界的交点 |
-|Clamp()|v3.7.0|public void Clamp(ref Vector3 pos)
Clamp the position of pos to the grid. |
-|ClampX()|v3.7.0|public void ClampX(ref Vector3 pos)
Clamp the x position of pos to the grid. |
-|ClampY()|v3.7.0|public void ClampY(ref Vector3 pos)
Clamp the y position of pos to the grid. |
-|Contains()||public bool Contains(float x, float y)
Whether the given position is in the grid. |
-|Contains()||public bool Contains(Vector3 pos)
Whether the given position is in the grid. |
-|Contains()|v3.7.0|public bool Contains(Vector3 pos, bool isYAxis)
Whether the given position is in the grid. |
-|ContainsX()|v3.7.0|public bool ContainsX(float x)
Whether the given x is in the grid. |
-|ContainsY()|v3.7.0|public bool ContainsY(float y)
Whether the given y is in the grid. |
-|IsPointerEnter()||public bool IsPointerEnter()
Whether the pointer is in the grid. |
-|NotAnyIntersect()|v3.10.0|public bool NotAnyIntersect(Vector3 sp, Vector3 ep)
Determines whether a given line segment will not intersect the Grid boundary at all. |
-|UpdateRuntimeData()||public void UpdateRuntimeData(BaseChart chart)|
+### GridCoord.BoundaryPoint
+
+public bool BoundaryPoint(Vector3 sp, Vector3 ep, ref List<Vector3> point)
+给定的线段和Grid边界的交点
+
+
+### GridCoord.Clamp
+
+public void Clamp(ref Vector3 pos)
+
+> Since `v3.7.0`
+
+Clamp the position of pos to the grid.
+
+### GridCoord.ClampX
+
+public void ClampX(ref Vector3 pos)
+
+> Since `v3.7.0`
+
+Clamp the x position of pos to the grid.
+
+### GridCoord.ClampY
+
+public void ClampY(ref Vector3 pos)
+
+> Since `v3.7.0`
+
+Clamp the y position of pos to the grid.
+
+### GridCoord.Contains
+
+public bool Contains(float x, float y)
+Whether the given position is in the grid.
+
+public bool Contains(Vector3 pos, bool isYAxis)
+
+> Since `v3.7.0`
+
+Whether the given position is in the grid.
+
+
+### GridCoord.ContainsX
+
+public bool ContainsX(float x)
+
+> Since `v3.7.0`
+
+Whether the given x is in the grid.
+
+### GridCoord.ContainsY
+
+public bool ContainsY(float y)
+
+> Since `v3.7.0`
+
+Whether the given y is in the grid.
+
+### GridCoord.IsPointerEnter
+
+public bool IsPointerEnter()
+Whether the pointer is in the grid.
+
+### GridCoord.NotAnyIntersect
+
+public bool NotAnyIntersect(Vector3 sp, Vector3 ep)
+
+> Since `v3.10.0`
+
+Determines whether a given line segment will not intersect the Grid boundary at all.
+
+### GridCoord.UpdateRuntimeData
+
+public void UpdateRuntimeData(BaseChart chart)
## GridCoord3D
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer)
> Since `v3.11.0`
Grid component.
-|public method|since|description|
-|--|--|--|
-|Clamp()||public void Clamp(ref Vector3 pos)
Clamp the position of pos to the grid. |
-|Contains()||public bool Contains(Vector3 pos)
Whether the given position is in the grid. |
-|IsLeft()||public bool IsLeft()
The opening of the coordinate system faces to the left. 坐标系开口朝向左边。 |
-|IsPointerEnter()||public bool IsPointerEnter()
Whether the pointer is in the grid. |
-|NotAnyIntersect()||public bool NotAnyIntersect(Vector3 sp, Vector3 ep)
Determines whether a given line segment will not intersect the Grid boundary at all. |
-|UpdateRuntimeData()||public void UpdateRuntimeData(BaseChart chart)|
+### GridCoord3D.Clamp
+
+public void Clamp(ref Vector3 pos)
+Clamp the position of pos to the grid.
+
+### GridCoord3D.Contains
+
+public bool Contains(Vector3 pos)
+Whether the given position is in the grid.
+
+### GridCoord3D.IsLeft
+
+public bool IsLeft()
+The opening of the coordinate system faces to the left. 坐标系开口朝向左边。
+
+### GridCoord3D.IsPointerEnter
+
+public bool IsPointerEnter()
+Whether the pointer is in the grid.
+
+### GridCoord3D.NotAnyIntersect
+
+public bool NotAnyIntersect(Vector3 sp, Vector3 ep)
+Determines whether a given line segment will not intersect the Grid boundary at all.
+
+### GridCoord3D.UpdateRuntimeData
+
+public void UpdateRuntimeData(BaseChart chart)
## GridCoord3DContext
-> class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
-
+class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
## GridCoordContext
-> class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
-
+class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
## GridLayout
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent),[IUpdateRuntimeData](#iupdateruntimedata)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent),[IUpdateRuntimeData](#iupdateruntimedata)
> Since `v3.8.0`
Grid layout component. Used to manage the layout of multiple `GridCoord`, and the number of rows and columns of the grid can be controlled by `row` and `column`.
-|public method|since|description|
-|--|--|--|
-|UpdateRuntimeData()||public void UpdateRuntimeData(BaseChart chart)|
+### GridLayout.UpdateRuntimeData
+
+public void UpdateRuntimeData(BaseChart chart)
## GridLayoutContext
-> class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
-
+class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
## Heatmap
-> class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+### Heatmap.containerIndex
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
+public int containerIndex
+
+### Heatmap.containterInstanceId
+
+public int containterInstanceId
+
+### Heatmap.AddDefaultSerie
+
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
## HeatmapChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
Heat map mainly use colors to represent values, which must be used along with visualMap component. It can be used in either rectangular coordinate or geographic coordinate. But the behaviour on them are quite different. Rectangular coordinate must have two categories to use it.
-|public method|since|description|
-|--|--|--|
-|DefaultCountHeatmapChart()||public void DefaultCountHeatmapChart()
default count heatmap chart. |
+### HeatmapChart.DefaultCountHeatmapChart
+
+public void DefaultCountHeatmapChart()
+default count heatmap chart.
+
+## HeatmapType
+
+class in XCharts.Runtime
+
+The mapping type of heatmap.
+
+Options:
+
+- `Data`: Data mapping type.By default, the second dimension data is used as the color map.
+- `Count`: Number mapping type.The number of occurrences of a statistic in a divided grid, as a color map.
## IconStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+### IconStyle.align
-|public method|since|description|
-|--|--|--|
-|Clone()||public IconStyle Clone()|
-|Copy()||public void Copy(IconStyle iconStyle)|
-|Reset()||public void Reset()|
+public Align align
+水平方向对齐方式。
+
+### IconStyle.autoHideWhenLabelEmpty
+
+public bool autoHideWhenLabelEmpty
+当label内容为空时是否自动隐藏图标
+
+### IconStyle.color
+
+public Color color
+图标颜色。
+
+### IconStyle.height
+
+public float height
+图标高。
+
+### IconStyle.layer
+
+public Layer layer
+显示在上层还是在下层。
+
+### IconStyle.offset
+
+public Vector3 offset
+图标偏移。
+
+### IconStyle.show
+
+public bool show
+Whether the data icon is show.
+
+### IconStyle.sprite
+
+public Sprite sprite
+The image of icon.
+
+### IconStyle.type
+
+public Image.Type type
+How to display the icon.
+
+### IconStyle.width
+
+public float width
+图标宽。
+
+### IconStyle.Clone
+
+public IconStyle Clone()
+
+### IconStyle.Copy
+
+public void Copy(IconStyle iconStyle)
+
+### IconStyle.Reset
+
+public void Reset()
+
+## IconStyle.Layer
+
+class in XCharts.Runtime
+
+Options:
+
+- `UnderText`: The icon is display under the label text. 图标在标签文字下
+- `AboveText`: The icon is display above the label text. 图标在标签文字上
## IgnoreDoc
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+### IgnoreDoc.IgnoreDoc
-|public method|since|description|
-|--|--|--|
-|IgnoreDoc()||public IgnoreDoc()|
+public IgnoreDoc()
## ImageStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
+### ImageStyle.autoColor
-|public method|since|description|
-|--|--|--|
-|Clone()||public ImageStyle Clone()|
-|Copy()||public void Copy(ImageStyle imageStyle)|
-|Reset()||public void Reset()|
+public bool autoColor
+是否自动颜色。
+
+### ImageStyle.color
+
+public Color color
+图标颜色。
+
+### ImageStyle.height
+
+public float height
+图标高。
+
+### ImageStyle.show
+
+public bool show
+Whether the data icon is show.
+
+### ImageStyle.sprite
+
+public Sprite sprite
+The image of icon.
+
+### ImageStyle.type
+
+public Image.Type type
+How to display the image.
+
+### ImageStyle.width
+
+public float width
+图标宽。
+
+### ImageStyle.Clone
+
+public ImageStyle Clone()
+
+### ImageStyle.Copy
+
+public void Copy(ImageStyle imageStyle)
+
+### ImageStyle.Reset
+
+public void Reset()
## Indicator
-> class in XCharts.Runtime
+class in XCharts.Runtime
Indicator of radar chart, which is used to assign multiple variables(dimensions) in radar chart.
-|public method|since|description|
-|--|--|--|
-|AddIndicator()||public RadarCoord.Indicator AddIndicator(string name, double min, double max)|
-|AddIndicator()||public void AddIndicator(RadarCoord.Indicator indicator)|
-|AddIndicatorList()|v3.3.0|public void AddIndicatorList(List<string> nameList, double min = 0, double max = 0)|
-|ClearData()||public override void ClearData()|
-|GetFormatterIndicatorContent()||public string GetFormatterIndicatorContent(int indicatorIndex)|
-|GetFormatterIndicatorContent()||public string GetFormatterIndicatorContent(string indicatorName)|
-|GetIndicator()||public RadarCoord.Indicator GetIndicator(int indicatorIndex)|
-|GetIndicatorMax()||public double GetIndicatorMax(int index)|
-|GetIndicatorMin()||public double GetIndicatorMin(int index)|
-|GetIndicatorName()||public string GetIndicatorName(int indicatorIndex)|
-|GetIndicatorPosition()||public Vector3 GetIndicatorPosition(int index)|
-|IsInIndicatorRange()||public bool IsInIndicatorRange(int index, double value)|
-|IsInRange()||public bool IsInRange(double value)|
-|IsPointerEnter()||public bool IsPointerEnter()|
-|SetDefaultValue()||public override void SetDefaultValue()|
-|UpdateIndicator()||public bool UpdateIndicator(int indicatorIndex, string name, double min, double max)|
+### Indicator.indicatorList
+
+public List<Indicator> indicatorList
+the indicator list.
+
+### Indicator.max
+
+public double max
+The maximum value of indicator, with default value of 0, but we recommend to set it manually.
+
+### Indicator.min
+
+public double min
+The minimum value of indicator, with default value of 0.
+
+### Indicator.name
+
+public string name
+The name of indicator.
+
+### Indicator.show
+
+public bool show
+[default:true] Set this to false to prevent the radar from showing.
+
+### Indicator.text
+
+public Text text
+the text conponent of indicator.
+
+### Indicator.AddIndicator
+
+public RadarCoord.Indicator AddIndicator(string name, double min, double max)
+
+
+### Indicator.AddIndicatorList
+
+public void AddIndicatorList(List<string> nameList, double min = 0, double max = 0)
+
+> Since `v3.3.0`
+
+
+### Indicator.ClearData
+
+public override void ClearData()
+
+### Indicator.GetFormatterIndicatorContent
+
+public string GetFormatterIndicatorContent(string indicatorName)
+
+
+### Indicator.GetIndicator
+
+public RadarCoord.Indicator GetIndicator(int indicatorIndex)
+
+### Indicator.GetIndicatorMax
+
+public double GetIndicatorMax(int index)
+
+### Indicator.GetIndicatorMin
+
+public double GetIndicatorMin(int index)
+
+### Indicator.GetIndicatorName
+
+public string GetIndicatorName(int indicatorIndex)
+
+### Indicator.GetIndicatorPosition
+
+public Vector3 GetIndicatorPosition(int index)
+
+### Indicator.IsInIndicatorRange
+
+public bool IsInIndicatorRange(int index, double value)
+
+### Indicator.IsInRange
+
+public bool IsInRange(double value)
+
+### Indicator.IsPointerEnter
+
+public bool IsPointerEnter()
+
+### Indicator.SetDefaultValue
+
+public override void SetDefaultValue()
+
+### Indicator.UpdateIndicator
+
+public bool UpdateIndicator(int indicatorIndex, string name, double min, double max)
## INeedSerieContainer
-> class in XCharts.Runtime / Subclasses: [Bar](#bar),[SimplifiedBar](#simplifiedbar),[Candlestick](#candlestick),[SimplifiedCandlestick](#simplifiedcandlestick),[Heatmap](#heatmap),[Line](#line),[SimplifiedLine](#simplifiedline),[Parallel](#parallel),[Radar](#radar),[BaseScatter](#basescatter)
-
+class in XCharts.Runtime / Subclasses: [Bar](#bar),[SimplifiedBar](#simplifiedbar),[Candlestick](#candlestick),[SimplifiedCandlestick](#simplifiedcandlestick),[Heatmap](#heatmap),[Line](#line),[SimplifiedLine](#simplifiedline),[Parallel](#parallel),[Radar](#radar),[BaseScatter](#basescatter)
## InputHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### InputHelper.GetKeyDown
-|public method|since|description|
-|--|--|--|
-|GetKeyDown()||public static bool GetKeyDown(KeyCode keyCode)|
-|GetTouch()||public static Touch GetTouch(int v)|
+public static bool GetKeyDown(KeyCode keyCode)
+
+### InputHelper.GetTouch
+
+public static Touch GetTouch(int v)
## InteractData
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### InteractData.Reset
+
+public void Reset()
+
+### InteractData.SetColor
+
+public void SetColor(ref bool needInteract, Color32 color, Color32 toColor)
-|public method|since|description|
-|--|--|--|
-|Reset()||public void Reset()|
-|SetColor()||public void SetColor(ref bool needInteract, Color32 color)|
-|SetColor()||public void SetColor(ref bool needInteract, Color32 color, Color32 toColor)|
-|SetPosition()||public void SetPosition(ref bool needInteract, Vector3 pos)|
-|SetValue()||public void SetValue(ref bool needInteract, float value, bool highlight, float rate = 1.3f)|
-|SetValue()||public void SetValue(ref bool needInteract, float value, bool previousValueZero = false)|
-|SetValueAndColor()||public void SetValueAndColor(ref bool needInteract, float value, Color32 color)|
-|SetValueAndColor()||public void SetValueAndColor(ref bool needInteract, float value, Color32 color, Color32 toColor)|
-|ToString()||public override string ToString()|
-|TryGetColor()||public bool TryGetColor(ref Color32 color, ref bool interacting, float animationDuration = 250)|
-|TryGetColor()||public bool TryGetColor(ref Color32 color, ref Color32 toColor, ref bool interacting, float animationDuration = 250)|
-|TryGetPosition()||public bool TryGetPosition(ref Vector3 pos, ref bool interacting, float animationDuration = 250)|
-|TryGetValue()||public bool TryGetValue(ref float value, ref bool interacting, float animationDuration = 250)|
-|TryGetValueAndColor()||public bool TryGetValueAndColor(ref float value, ref Color32 color, ref Color32 toColor, ref bool interacting, float animationDuration = 250)|
-|TryGetValueAndColor()||public bool TryGetValueAndColor(ref float value, ref Vector3 pos, ref bool interacting, float animationDuration = 250)|
-|TryGetValueAndColor()||public bool TryGetValueAndColor(ref float value, ref Vector3 pos, ref Color32 color, ref Color32 toColor, ref bool interacting, float animationDuration = 250)|
+### InteractData.SetPosition
+
+public void SetPosition(ref bool needInteract, Vector3 pos)
+
+### InteractData.SetValue
+
+public void SetValue(ref bool needInteract, float value, bool previousValueZero = false)
+
+
+### InteractData.SetValueAndColor
+
+public void SetValueAndColor(ref bool needInteract, float value, Color32 color, Color32 toColor)
+
+
+### InteractData.ToString
+
+public override string ToString()
+
+### InteractData.TryGetColor
+
+public bool TryGetColor(ref Color32 color, ref Color32 toColor, ref bool interacting, float animationDuration = 250)
+
+
+### InteractData.TryGetPosition
+
+public bool TryGetPosition(ref Vector3 pos, ref bool interacting, float animationDuration = 250)
+
+### InteractData.TryGetValue
+
+public bool TryGetValue(ref float value, ref bool interacting, float animationDuration = 250)
+
+### InteractData.TryGetValueAndColor
+
+public bool TryGetValueAndColor(ref float value, ref Vector3 pos, ref bool interacting, float animationDuration = 250)
+
+public bool TryGetValueAndColor(ref float value, ref Vector3 pos, ref Color32 color, ref Color32 toColor, ref bool interacting, float animationDuration = 250)
+
## IPropertyChanged
-> class in XCharts.Runtime / Subclasses: [Location](#location),[Comment](#comment),[Legend](#legend),[Title](#title)
+class in XCharts.Runtime / Subclasses: [Location](#location),[Comment](#comment),[Legend](#legend),[Title](#title)
属性变更接口
## ISerieComponent
-> class in XCharts.Runtime / Subclasses: [AreaStyle](#areastyle),[ImageStyle](#imagestyle),[LineArrow](#linearrow),[LabelLine](#labelline),[LabelStyle](#labelstyle),[BlurStyle](#blurstyle),[EmphasisStyle](#emphasisstyle),[SelectStyle](#selectstyle),[TitleStyle](#titlestyle)
+class in XCharts.Runtime / Subclasses: [AreaStyle](#areastyle),[ImageStyle](#imagestyle),[LineArrow](#linearrow),[LabelLine](#labelline),[LabelStyle](#labelstyle),[BlurStyle](#blurstyle),[EmphasisStyle](#emphasisstyle),[SelectStyle](#selectstyle),[TitleStyle](#titlestyle)
The interface for serie component.
## ISerieContainer
-> class in XCharts.Runtime / Subclasses: [RadarCoord](#radarcoord),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[GridCoord3D](#gridcoord3d),[ParallelCoord](#parallelcoord),[PolarCoord](#polarcoord)
-
+class in XCharts.Runtime / Subclasses: [RadarCoord](#radarcoord),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[GridCoord3D](#gridcoord3d),[ParallelCoord](#parallelcoord),[PolarCoord](#polarcoord)
## ISerieDataComponent
-> class in XCharts.Runtime / Subclasses: [AreaStyle](#areastyle),[ImageStyle](#imagestyle),[ItemStyle](#itemstyle),[LineStyle](#linestyle),[SerieSymbol](#seriesymbol),[LabelLine](#labelline),[LabelStyle](#labelstyle),[BlurStyle](#blurstyle),[EmphasisStyle](#emphasisstyle),[SelectStyle](#selectstyle),[TitleStyle](#titlestyle)
+class in XCharts.Runtime / Subclasses: [AreaStyle](#areastyle),[ImageStyle](#imagestyle),[ItemStyle](#itemstyle),[LineStyle](#linestyle),[SerieSymbol](#seriesymbol),[LabelLine](#labelline),[LabelStyle](#labelstyle),[BlurStyle](#blurstyle),[EmphasisStyle](#emphasisstyle),[SelectStyle](#selectstyle),[TitleStyle](#titlestyle)
The interface for serie data component.
## ISimplifiedSerie
-> class in XCharts.Runtime / Subclasses: [SimplifiedBar](#simplifiedbar),[SimplifiedCandlestick](#simplifiedcandlestick),[SimplifiedLine](#simplifiedline)
-
+class in XCharts.Runtime / Subclasses: [SimplifiedBar](#simplifiedbar),[SimplifiedCandlestick](#simplifiedcandlestick),[SimplifiedLine](#simplifiedline)
## ItemStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieDataComponent](#iseriedatacomponent)
图形样式。
-|public method|since|description|
-|--|--|--|
-|GetBorderColor()||public Color32 GetBorderColor(Color32 defaultColor)|
-|GetBorderColor0()||public Color32 GetBorderColor0(Color32 defaultColor)|
-|GetColor()||public Color32 GetColor()|
-|GetColor()||public Color32 GetColor(Color32 defaultColor)|
-|GetColor0()||public Color32 GetColor0()|
-|GetColor0()||public Color32 GetColor0(Color32 defaultColor)|
-|GetGradientColor()||public Color32 GetGradientColor(float value, Color32 defaultColor)|
-|GetToColor()||public Color32 GetToColor()|
-|IsNeedCorner()||public bool IsNeedCorner()|
-|IsNeedGradient()||public bool IsNeedGradient()|
-|Reset()||public void Reset()|
+### ItemStyle.GetBorderColor
+
+public Color32 GetBorderColor(Color32 defaultColor)
+
+### ItemStyle.GetBorderColor0
+
+public Color32 GetBorderColor0(Color32 defaultColor)
+
+### ItemStyle.GetColor
+
+public Color32 GetColor(Color32 defaultColor)
+
+
+### ItemStyle.GetColor0
+
+public Color32 GetColor0(Color32 defaultColor)
+
+
+### ItemStyle.GetGradientColor
+
+public Color32 GetGradientColor(float value, Color32 defaultColor)
+
+### ItemStyle.GetToColor
+
+public Color32 GetToColor()
+
+### ItemStyle.IsNeedCorner
+
+public bool IsNeedCorner()
+
+### ItemStyle.IsNeedGradient
+
+public bool IsNeedGradient()
+
+### ItemStyle.Reset
+
+public void Reset()
## IUpdateRuntimeData
-> class in XCharts.Runtime / Subclasses: [SingleAxis](#singleaxis),[DataZoom](#datazoom),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[GridLayout](#gridlayout),[GridCoord3D](#gridcoord3d),[ParallelCoord](#parallelcoord)
-
+class in XCharts.Runtime / Subclasses: [SingleAxis](#singleaxis),[DataZoom](#datazoom),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[GridLayout](#gridlayout),[GridCoord3D](#gridcoord3d),[ParallelCoord](#parallelcoord)
## JsonUtil
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### JsonUtil.GetJsonArray<T>
+
+public static T[] GetJsonArray<T>(string json)
+
+### JsonUtil.GetJsonObject<T>
+
+public static T GetJsonObject<T>(string json)
+
+### JsonUtil.GetWebJson<T>
+
+public static IEnumerator GetWebJson<T>(string url, Action<T> callback)
-|public method|since|description|
-|--|--|--|
-|GetJsonArray<T>()||public static T[] GetJsonArray<T>(string json)|
-|GetJsonObject<T>()||public static T GetJsonObject<T>(string json)|
-|GetWebJson<T>()||public static IEnumerator GetWebJson<T>(string url, Action<T[]> callback)|
-|GetWebJson<T>()||public static IEnumerator GetWebJson<T>(string url, Action<T> callback)|
## LabelLine
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
标签的引导线
-|public method|since|description|
-|--|--|--|
-|GetEndSymbolOffset()||public Vector3 GetEndSymbolOffset()|
-|GetStartSymbolOffset()||public Vector3 GetStartSymbolOffset()|
-|Reset()||public void Reset()|
+### LabelLine.GetEndSymbolOffset
+
+public Vector3 GetEndSymbolOffset()
+
+### LabelLine.GetStartSymbolOffset
+
+public Vector3 GetStartSymbolOffset()
+
+### LabelLine.Reset
+
+public void Reset()
+
+## LabelLine.LineType
+
+class in XCharts.Runtime
+
+标签视觉引导线类型
+
+Options:
+
+- `BrokenLine`: 折线
+- `Curves`: 曲线
+- `HorizontalLine`: 水平线
## LabelStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) / Subclasses: [AxisLabel](#axislabel),[EndLabelStyle](#endlabelstyle),[TitleStyle](#titlestyle)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) / Subclasses: [AxisLabel](#axislabel),[EndLabelStyle](#endlabelstyle),[TitleStyle](#titlestyle)
Text label of chart, to explain some data information about graphic item like value, name and so on.
-|public method|since|description|
-|--|--|--|
-|Clone()||public virtual LabelStyle Clone()|
-|Copy()||public virtual void Copy(LabelStyle label)|
-|GetColor()||public Color GetColor(Color defaultColor)|
-|GetFormatterContent()||public virtual string GetFormatterContent(int labelIndex, double value, double minValue, double maxValue, bool isLog = false)|
-|GetFormatterContent()||public virtual string GetFormatterContent(int labelIndex, string category)|
-|GetFormatterDateTime()||public string GetFormatterDateTime(int labelIndex, double value, double minValue, double maxValue)|
-|GetOffset()||public Vector3 GetOffset(float radius)|
-|IsAutoSize()||public bool IsAutoSize()|
-|IsDefaultPosition()||public bool IsDefaultPosition(Position position)|
-|IsInside()||public bool IsInside()
whether the label is inside. |
-|Reset()||public void Reset()|
+### LabelStyle.Clone
+
+public virtual LabelStyle Clone()
+
+### LabelStyle.Copy
+
+public virtual void Copy(LabelStyle label)
+
+### LabelStyle.GetColor
+
+public Color GetColor(Color defaultColor)
+
+### LabelStyle.GetFormatterContent
+
+public virtual string GetFormatterContent(int labelIndex, double value, double minValue, double maxValue, bool isLog = false)
+
+
+### LabelStyle.GetFormatterDateTime
+
+public string GetFormatterDateTime(int labelIndex, double value, double minValue, double maxValue)
+
+### LabelStyle.GetOffset
+
+public Vector3 GetOffset(float radius)
+
+### LabelStyle.IsAutoSize
+
+public bool IsAutoSize()
+
+### LabelStyle.IsDefaultPosition
+
+public bool IsDefaultPosition(Position position)
+
+### LabelStyle.IsInside
+
+public bool IsInside()
+whether the label is inside.
+
+### LabelStyle.Reset
+
+public void Reset()
+
+## LabelStyle.Position
+
+class in XCharts.Runtime
+
+The position of label.
+
+Options:
+
+- `Default`: The position of label.
+- `Outside`: Outside of sectors of pie chart, which relates to corresponding sector through visual guide line.
+- `Inside`: Inside the sectors of pie chart.
+- `Center`: In the center of pie chart.
+- `Top`: top of symbol.
+- `Bottom`: the bottom of symbol.
+- `Left`: the left of symbol.
+- `Right`: the right of symbol.
+- `Start`: the start of line.
+- `Middle`: the middle of line.
+- `End`: the end of line.
## Lang
-> class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=scriptableobject)
+class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=scriptableobject)
Language.
-|public method|since|description|
-|--|--|--|
-|GetCandlestickDimensionName()||public string GetCandlestickDimensionName(int i)|
-|GetDay()||public string GetDay(int day)|
-|GetMonthAbbr()||public string GetMonthAbbr(int month)|
+### Lang.GetCandlestickDimensionName
+
+public string GetCandlestickDimensionName(int i)
+
+### Lang.GetDay
+
+public string GetDay(int day)
+
+### Lang.GetMonthAbbr
+
+public string GetMonthAbbr(int month)
## LangCandlestick
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### LangCandlestick.List<string>()
+
+public List<string> dimensionNames = new List<string>()
## LangTime
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### LangTime.List<string>
+
+public List<string> dayOfMonth = new List<string>()
+
+public List<string> dayOfWeek = new List<string>()
+
+public List<string> dayOfWeekAbbr = new List<string>()
+
+public List<string> monthAbbr = new List<string>()
-|public method|since|description|
-|--|--|--|
-|List<string>()||public List<string> dayOfMonth = new List<string>()|
-|List<string>()||public List<string> dayOfWeek = new List<string>()|
-|List<string>()||public List<string> dayOfWeekAbbr = new List<string>()|
-|List<string>()||public List<string> monthAbbr = new List<string>()|
-|List<string>()||public List<string> months = new List<string>()|
## LayerHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### LayerHelper.IsFixedWidthHeight
-|public method|since|description|
-|--|--|--|
-|IsFixedWidthHeight()||public static bool IsFixedWidthHeight(RectTransform rt)|
-|IsStretchPivot()||public static bool IsStretchPivot(RectTransform rt)|
+public static bool IsFixedWidthHeight(RectTransform rt)
+
+### LayerHelper.IsStretchPivot
+
+public static bool IsStretchPivot(RectTransform rt)
## Legend
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged)
Legend component.The legend component shows different sets of tags, colors, and names. You can control which series are not displayed by clicking on the legend.
-|public method|since|description|
-|--|--|--|
-|AddData()||public void AddData(string name)
Add legend data. |
-|ClearComponentDirty()||public override void ClearComponentDirty()|
-|ClearData()||public override void ClearData()
Clear legend data. |
-|ContainsData()||public bool ContainsData(string name)
Whether include in legend data by the specified name. |
-|GetColor()||public Color GetColor(int index)|
-|GetData()||public string GetData(int index)
Gets the legend for the specified index. |
-|GetIcon()||public Sprite GetIcon(int index)
Gets the legend button for the specified index. |
-|GetIndex()||public int GetIndex(string legendName)
Gets the index of the specified legend. |
-|GetPosition()||public Vector3 GetPosition(int index, Vector3 defaultPos)|
-|OnChanged()||public void OnChanged()
Callback handling when parameters change. |
-|RemoveButton()||public void RemoveButton()
Remove all legend buttons. |
-|RemoveData()||public void RemoveData(string name)
Removes the legend with the specified name. |
-|SetButton()||public void SetButton(string name, LegendItem item, int total)
Bind buttons to legends. |
-|UpdateButtonColor()||public void UpdateButtonColor(string name, Color color)
Update the legend button color. |
-|UpdateContentColor()||public void UpdateContentColor(string name, Color color)
Update the text color of legend. |
+### Legend.vertsDirty
+
+public override bool vertsDirty
+图表是否需要刷新(图例组件不需要刷新图表)
+
+### Legend.AddData
+
+public void AddData(string name)
+Add legend data.
+
+### Legend.ClearComponentDirty
+
+public override void ClearComponentDirty()
+
+### Legend.ClearData
+
+public override void ClearData()
+Clear legend data.
+
+### Legend.ContainsData
+
+public bool ContainsData(string name)
+Whether include in legend data by the specified name.
+
+### Legend.GetColor
+
+public Color GetColor(int index)
+
+### Legend.GetData
+
+public string GetData(int index)
+Gets the legend for the specified index.
+
+### Legend.GetIcon
+
+public Sprite GetIcon(int index)
+Gets the legend button for the specified index.
+
+### Legend.GetIndex
+
+public int GetIndex(string legendName)
+Gets the index of the specified legend.
+
+### Legend.GetPosition
+
+public Vector3 GetPosition(int index, Vector3 defaultPos)
+
+### Legend.OnChanged
+
+public void OnChanged()
+Callback handling when parameters change.
+
+### Legend.RemoveButton
+
+public void RemoveButton()
+Remove all legend buttons.
+
+### Legend.RemoveData
+
+public void RemoveData(string name)
+Removes the legend with the specified name.
+
+### Legend.SetButton
+
+public void SetButton(string name, LegendItem item, int total)
+Bind buttons to legends.
+
+### Legend.UpdateButtonColor
+
+public void UpdateButtonColor(string name, Color color)
+Update the legend button color.
+
+### Legend.UpdateContentColor
+
+public void UpdateContentColor(string name, Color color)
+Update the text color of legend.
+
+## Legend.SelectedMode
+
+class in XCharts.Runtime
+
+Selected mode of legend, which controls whether series can be toggled displaying by clicking legends.
+
+Options:
+
+- `Multiple`: 多选。
+- `Single`: 单选。
+- `None`: 无法选择。
+
+## Legend.Type
+
+class in XCharts.Runtime
+
+Legend component.The legend component shows different sets of tags, colors, and names. You can control which series are not displayed by clicking on the legend.
+
+Options:
+
+- `Auto`: 自动匹配。
+- `Custom`: 自定义图标。
+- `EmptyCircle`: 空心圆。
+- `Circle`: 圆形。
+- `Rect`: 正方形。可通过Setting的legendIconCornerRadius参数调整圆角。
+- `Triangle`: 三角形。
+- `Diamond`: 菱形。
+- `Candlestick`: 烛台(可用于K线图)。
## LegendContext
-> class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
+class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
+### LegendContext.background
+
+public Image background
+
+### LegendContext.center
+
+public Vector2 center
+
+### LegendContext.height
+
+public float height
+运行时图例的总高度
+
+### LegendContext.width
+
+public float width
+运行时图例的总宽度
## LegendHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### LegendHelper.CheckDataHighlighted
-|public method|since|description|
-|--|--|--|
-|CheckDataHighlighted()||public static int CheckDataHighlighted(Serie serie, string legendName, bool heighlight)|
-|CheckDataShow()||public static bool CheckDataShow(Serie serie, string legendName, bool show)|
-|GetContentColor()||public static Color GetContentColor(BaseChart chart, int legendIndex, string legendName, Legend legend, ThemeStyle theme, bool active)|
-|GetIconColor()||public static Color GetIconColor(BaseChart chart, Legend legend, int readIndex, string legendName, bool active)|
-|ResetItemPosition()||public static void ResetItemPosition(Legend legend, Vector3 chartPos, float chartWidth, float chartHeight)|
-|SetLegendBackground()||public static void SetLegendBackground(Legend legend, ImageStyle style)|
+public static int CheckDataHighlighted(Serie serie, string legendName, bool heighlight)
+
+### LegendHelper.CheckDataShow
+
+public static bool CheckDataShow(Serie serie, string legendName, bool show)
+
+### LegendHelper.GetContentColor
+
+public static Color GetContentColor(BaseChart chart, int legendIndex, string legendName, Legend legend, ThemeStyle theme, bool active)
+
+### LegendHelper.GetIconColor
+
+public static Color GetIconColor(BaseChart chart, Legend legend, int readIndex, string legendName, bool active)
+
+### LegendHelper.ResetItemPosition
+
+public static void ResetItemPosition(Legend legend, Vector3 chartPos, float chartWidth, float chartHeight)
+
+### LegendHelper.SetLegendBackground
+
+public static void SetLegendBackground(Legend legend, ImageStyle style)
## LegendItem
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### LegendItem.button
-|public method|since|description|
-|--|--|--|
-|GetIconColor()||public Color GetIconColor()|
-|GetIconRect()||public Rect GetIconRect()|
-|SetActive()||public void SetActive(bool active)|
-|SetBackground()||public void SetBackground(ImageStyle imageStyle)|
-|SetButton()||public void SetButton(Button button)|
-|SetContent()||public bool SetContent(string content)|
-|SetContentBackgroundColor()||public void SetContentBackgroundColor(Color color)|
-|SetContentColor()||public void SetContentColor(Color color)|
-|SetContentPosition()||public void SetContentPosition(Vector3 offset)|
-|SetIcon()||public void SetIcon(Image icon)|
-|SetIconActive()||public void SetIconActive(bool active)|
-|SetIconColor()||public void SetIconColor(Color color)|
-|SetIconImage()||public void SetIconImage(Sprite image)|
-|SetIconSize()||public void SetIconSize(float width, float height)|
-|SetObject()||public void SetObject(GameObject obj)|
-|SetPosition()||public void SetPosition(Vector3 position)|
-|SetText()||public void SetText(ChartText text)|
-|SetTextBackground()||public void SetTextBackground(Image image)|
+public Button button
+
+### LegendItem.gameObject
+
+public GameObject gameObject
+
+### LegendItem.index
+
+public int index
+
+### LegendItem.legendName
+
+public string legendName
+
+### LegendItem.name
+
+public string name
+
+### LegendItem.text
+
+public ChartText text
+
+### LegendItem.GetIconColor
+
+public Color GetIconColor()
+
+### LegendItem.GetIconRect
+
+public Rect GetIconRect()
+
+### LegendItem.SetActive
+
+public void SetActive(bool active)
+
+### LegendItem.SetBackground
+
+public void SetBackground(ImageStyle imageStyle)
+
+### LegendItem.SetButton
+
+public void SetButton(Button button)
+
+### LegendItem.SetContent
+
+public bool SetContent(string content)
+
+### LegendItem.SetContentBackgroundColor
+
+public void SetContentBackgroundColor(Color color)
+
+### LegendItem.SetContentColor
+
+public void SetContentColor(Color color)
+
+### LegendItem.SetContentPosition
+
+public void SetContentPosition(Vector3 offset)
+
+### LegendItem.SetIcon
+
+public void SetIcon(Image icon)
+
+### LegendItem.SetIconActive
+
+public void SetIconActive(bool active)
+
+### LegendItem.SetIconColor
+
+public void SetIconColor(Color color)
+
+### LegendItem.SetIconImage
+
+public void SetIconImage(Sprite image)
+
+### LegendItem.SetIconSize
+
+public void SetIconSize(float width, float height)
+
+### LegendItem.SetObject
+
+public void SetObject(GameObject obj)
+
+### LegendItem.SetPosition
+
+public void SetPosition(Vector3 position)
+
+### LegendItem.SetText
+
+public void SetText(ChartText text)
+
+### LegendItem.SetTextBackground
+
+public void SetTextBackground(Image image)
## LegendTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+### LegendTheme.Copy
-|public method|since|description|
-|--|--|--|
-|Copy()||public void Copy(LegendTheme theme)|
-|LegendTheme()||public LegendTheme(ThemeType theme) : base(theme)|
+public void Copy(LegendTheme theme)
+
+### LegendTheme.LegendTheme
+
+public LegendTheme(ThemeType theme) : base(theme)
## Level
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+### Level.depth
+
+public int depth
+the depth of level.
+
+### Level.itemStyle
+
+public ItemStyle itemStyle
+the item style of level.
+
+### Level.label
+
+public LabelStyle label
+the label style of level.
+
+### Level.lineStyle
+
+public LineStyle lineStyle
+the line style of level.
+
+### Level.upperLabel
+
+public LabelStyle upperLabel
+the upper label style of level.
## LevelStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.10.0`
+### LevelStyle.levels
+
+public List<Level> levels
+各层节点对应的配置。当enableLevels为true时生效,levels[0]对应的第一层的配置,levels[1]对应第二层,依次类推。当levels中没有对应层时用默认的设置。
+
+### LevelStyle.show
+
+public bool show
+是否启用LevelStyle
## Line
-> class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+### Line.containerIndex
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
-|ConvertSerie()||public static Line ConvertSerie(Serie serie)|
+public int containerIndex
+
+### Line.containterInstanceId
+
+public int containterInstanceId
+
+### Line.AddDefaultSerie
+
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
+
+### Line.ConvertSerie
+
+public static Line ConvertSerie(Serie serie)
## LineArrow
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent)
+## LineArrow.Position
+
+class in XCharts.Runtime
+
+Options:
+
+- `End`: 末端箭头
+- `Start`: 头端箭头
## LineChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
Line chart relates all the data points symbol by broken lines, which is used to show the trend of data changing. It could be used in both rectangular coordinate andpolar coordinate.
-|public method|since|description|
-|--|--|--|
-|DefaultAreaLineChart()||public void DefaultAreaLineChart()
default area line chart. |
-|DefaultDashLineChart()||public void DefaultDashLineChart()
default dash line chart. |
-|DefaultLogLineChart()||public void DefaultLogLineChart()
default logarithmic line chart. |
-|DefaultSmoothAreaLineChart()||public void DefaultSmoothAreaLineChart()
default smooth area line chart. |
-|DefaultSmoothLineChart()||public void DefaultSmoothLineChart()
default smooth line chart. |
-|DefaultStackAreaLineChart()||public void DefaultStackAreaLineChart()
default stack area line chart. |
-|DefaultStackLineChart()||public void DefaultStackLineChart()
default stack line chart. |
-|DefaultStepLineChart()||public void DefaultStepLineChart()
default step line chart. |
-|DefaultTimeLineChart()||public void DefaultTimeLineChart()
default time line chart. |
+### LineChart.DefaultAreaLineChart
+
+public void DefaultAreaLineChart()
+default area line chart.
+
+### LineChart.DefaultDashLineChart
+
+public void DefaultDashLineChart()
+default dash line chart.
+
+### LineChart.DefaultLogLineChart
+
+public void DefaultLogLineChart()
+default logarithmic line chart.
+
+### LineChart.DefaultSmoothAreaLineChart
+
+public void DefaultSmoothAreaLineChart()
+default smooth area line chart.
+
+### LineChart.DefaultSmoothLineChart
+
+public void DefaultSmoothLineChart()
+default smooth line chart.
+
+### LineChart.DefaultStackAreaLineChart
+
+public void DefaultStackAreaLineChart()
+default stack area line chart.
+
+### LineChart.DefaultStackLineChart
+
+public void DefaultStackLineChart()
+default stack line chart.
+
+### LineChart.DefaultStepLineChart
+
+public void DefaultStepLineChart()
+default step line chart.
+
+### LineChart.DefaultTimeLineChart
+
+public void DefaultTimeLineChart()
+default time line chart.
## LineHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### LineHelper.GetDataAverageRate
-|public method|since|description|
-|--|--|--|
-|GetDataAverageRate()||public static int GetDataAverageRate(Serie serie, float axisLength, int maxCount, bool isYAxis)|
-|GetLineWidth()||public static float GetLineWidth(ref bool interacting, Serie serie, float defaultWidth)|
+public static int GetDataAverageRate(Serie serie, float axisLength, int maxCount, bool isYAxis)
+
+### LineHelper.GetLineWidth
+
+public static float GetLineWidth(ref bool interacting, Serie serie, float defaultWidth)
## LineStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[ISerieDataComponent](#iseriedatacomponent)
The style of line.
-|public method|since|description|
-|--|--|--|
-|Clone()||public LineStyle Clone()|
-|Copy()||public void Copy(LineStyle lineStyle)|
-|GetColor()||public Color32 GetColor()|
-|GetColor()||public Color32 GetColor(Color32 themeColor)|
-|GetGradientColor()||public Color32 GetGradientColor(float value, Color32 defaultColor)|
-|GetLength()||public float GetLength(float themeLength)|
-|GetType()||public Type GetType(Type themeType)|
-|GetWidth()||public float GetWidth(float themeWidth)|
-|IsNeedGradient()||public bool IsNeedGradient()|
-|IsNotSolidLine()||public bool IsNotSolidLine()|
-|LineStyle()||public LineStyle()|
-|LineStyle()||public LineStyle(float width)|
-|LineStyle()||public LineStyle(LineStyle.Type type)|
-|LineStyle()||public LineStyle(LineStyle.Type type, float width)|
+### LineStyle.Clone
+
+public LineStyle Clone()
+
+### LineStyle.Copy
+
+public void Copy(LineStyle lineStyle)
+
+### LineStyle.GetColor
+
+public Color32 GetColor(Color32 themeColor)
+
+
+### LineStyle.GetGradientColor
+
+public Color32 GetGradientColor(float value, Color32 defaultColor)
+
+### LineStyle.GetLength
+
+public float GetLength(float themeLength)
+
+### LineStyle.GetType
+
+public Type GetType(Type themeType)
+
+### LineStyle.GetWidth
+
+public float GetWidth(float themeWidth)
+
+### LineStyle.IsNeedGradient
+
+public bool IsNeedGradient()
+
+### LineStyle.IsNotSolidLine
+
+public bool IsNotSolidLine()
+
+### LineStyle.LineStyle
+
+public LineStyle(float width)
+
+public LineStyle(LineStyle.Type type)
+
+public LineStyle(LineStyle.Type type, float width)
+
+
+## LineStyle.Type
+
+class in XCharts.Runtime
+
+线的类型。
+
+Options:
+
+- `Solid`: 实线
+- `Dashed`: 虚线
+- `Dotted`: 点线
+- `DashDot`: 点划线
+- `DashDotDot`: 双点划线
+- `None`: 双点划线
+
+## LineType
+
+class in XCharts.Runtime
+
+the type of line chart.
+
+Options:
+
+- `Normal`: the normal line chart,
+- `Smooth`: the smooth line chart,
+- `StepStart`: step line.
+- `StepMiddle`: step line.
+- `StepEnd`: step line.
## ListFor
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute) / Subclasses: [ListForComponent](#listforcomponent),[ListForSerie](#listforserie)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute) / Subclasses: [ListForComponent](#listforcomponent),[ListForSerie](#listforserie)
+### ListFor.ListFor
-|public method|since|description|
-|--|--|--|
-|ListFor()||public ListFor(Type type)|
+public ListFor(Type type)
## ListForComponent
-> class in XCharts.Runtime / Inherits from: [ListFor](#listfor)
+class in XCharts.Runtime / Inherits from: [ListFor](#listfor)
+### ListForComponent.ListForComponent
-|public method|since|description|
-|--|--|--|
-|ListForComponent()||public ListForComponent(Type type) : base(type)|
+public ListForComponent(Type type) : base(type)
## ListForSerie
-> class in XCharts.Runtime / Inherits from: [ListFor](#listfor)
+class in XCharts.Runtime / Inherits from: [ListFor](#listfor)
+### ListForSerie.ListForSerie
-|public method|since|description|
-|--|--|--|
-|ListForSerie()||public ListForSerie(Type type) : base(type)|
+public ListForSerie(Type type) : base(type)
## ListPool<T>
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### ListPool<T>.ClearAll
-|public method|since|description|
-|--|--|--|
-|ClearAll()||public static void ClearAll()|
-|Get()||public static List<T> Get()|
-|Release()||public static void Release(List<T> toRelease)|
+public static void ClearAll()
+
+### ListPool<T>.Get
+
+public static List<T> Get()
+
+### ListPool<T>.Release
+
+public static void Release(List<T> toRelease)
## Location
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[IPropertyChanged](#ipropertychanged)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent),[IPropertyChanged](#ipropertychanged)
Location type. Quick to set the general location.
-|public method|since|description|
-|--|--|--|
-|GetPosition()||public Vector3 GetPosition(float chartWidth, float chartHeight)
返回在坐标系中的具体位置 |
-|IsBottom()||public bool IsBottom()|
-|IsCenter()||public bool IsCenter()|
-|IsTop()||public bool IsTop()|
-|OnChanged()||public void OnChanged()
属性变更时更新textAnchor,minAnchor,maxAnchor,pivot |
-|UpdateRuntimeData()||public void UpdateRuntimeData(float chartWidth, float chartHeight)|
+### Location.runtimeAnchorMax
+
+public Vector2 runtimeAnchorMax
+
+### Location.runtimeAnchorMin
+
+public Vector2 runtimeAnchorMin
+the minimum achor.
+
+### Location.runtimeBottom
+
+public float runtimeBottom
+
+### Location.runtimeLeft
+
+public float runtimeLeft
+
+### Location.runtimePivot
+
+public Vector2 runtimePivot
+the povot.
+
+### Location.runtimeRight
+
+public float runtimeRight
+
+### Location.runtimeTextAlignment
+
+public TextAnchor runtimeTextAlignment
+the anchor of text.
+
+### Location.runtimeTMPTextAlignment
+
+public TextAlignmentOptions runtimeTMPTextAlignment
+
+### Location.runtimeTop
+
+public float runtimeTop
+
+### Location.GetPosition
+
+public Vector3 GetPosition(float chartWidth, float chartHeight)
+返回在坐标系中的具体位置
+
+### Location.IsBottom
+
+public bool IsBottom()
+
+### Location.IsCenter
+
+public bool IsCenter()
+
+### Location.IsTop
+
+public bool IsTop()
+
+### Location.OnChanged
+
+public void OnChanged()
+属性变更时更新textAnchor,minAnchor,maxAnchor,pivot
+
+### Location.UpdateRuntimeData
+
+public void UpdateRuntimeData(float chartWidth, float chartHeight)
+
+## Location.Align
+
+class in XCharts.Runtime
+
+对齐方式
+
+Options:
+
+- `TopLeft`: 对齐方式
+- `TopRight`: 对齐方式
+- `TopCenter`: 对齐方式
+- `BottomLeft`: 对齐方式
+- `BottomRight`: 对齐方式
+- `BottomCenter`: 对齐方式
+- `Center`: 对齐方式
+- `CenterLeft`: 对齐方式
+- `CenterRight`: 对齐方式
## MainComponent
-> class in XCharts.Runtime / Inherits from: [IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=icomparable) / Subclasses: [Axis](#axis),[Background](#background),[Comment](#comment),[DataZoom](#datazoom),[Legend](#legend),[MarkArea](#markarea),[MarkLine](#markline),[Settings](#settings),[Title](#title),[Tooltip](#tooltip),[VisualMap](#visualmap),[GridLayout](#gridlayout),[CoordSystem](#coordsystem)
+class in XCharts.Runtime / Inherits from: [IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=icomparable) / Subclasses: [Axis](#axis),[Background](#background),[Comment](#comment),[DataZoom](#datazoom),[Legend](#legend),[MarkArea](#markarea),[MarkLine](#markline),[Settings](#settings),[Title](#title),[Tooltip](#tooltip),[VisualMap](#visualmap),[GridLayout](#gridlayout),[CoordSystem](#coordsystem)
+### MainComponent.anyDirty
-|public method|since|description|
-|--|--|--|
-|ClearComponentDirty()||public virtual void ClearComponentDirty()|
-|ClearData()||public virtual void ClearData() { }|
-|ClearDirty()||public virtual void ClearDirty()|
-|ClearVerticesDirty()||public virtual void ClearVerticesDirty()|
-|CompareTo()||public int CompareTo(object obj)|
-|OnRemove()||public virtual void OnRemove()|
-|Reset()||public virtual void Reset() { }|
-|ResetStatus()||public virtual void ResetStatus() { }|
-|SetAllDirty()||public virtual void SetAllDirty()|
-|SetComponentDirty()||public virtual void SetComponentDirty()|
-|SetDefaultValue()||public virtual void SetDefaultValue() { }|
-|SetVerticesDirty()||public virtual void SetVerticesDirty()|
+public bool anyDirty
+需要重绘图表或重新初始化组件。
+
+### MainComponent.ClearData()
+
+public virtual void ClearData()
+
+### MainComponent.componentDirty
+
+public virtual bool componentDirty
+组件重新初始化标记。
+
+### MainComponent.gameObject
+
+public GameObject gameObject
+
+### MainComponent.index
+
+public int index
+
+### MainComponent.instanceId
+
+public int instanceId
+
+### MainComponent.painter
+
+public Painter painter
+
+### MainComponent.refreshComponent
+
+public Action refreshComponent
+
+### MainComponent.Reset()
+
+public virtual void Reset()
+
+### MainComponent.ResetStatus()
+
+public virtual void ResetStatus()
+
+### MainComponent.SetDefaultValue()
+
+public virtual void SetDefaultValue()
+
+### MainComponent.vertsDirty
+
+public virtual bool vertsDirty
+图表重绘标记。
+
+### MainComponent.ClearComponentDirty
+
+public virtual void ClearComponentDirty()
+
+### MainComponent.ClearData
+
+public virtual void ClearData() { }
+
+### MainComponent.ClearDirty
+
+public virtual void ClearDirty()
+
+### MainComponent.ClearVerticesDirty
+
+public virtual void ClearVerticesDirty()
+
+### MainComponent.CompareTo
+
+public int CompareTo(object obj)
+
+### MainComponent.OnRemove
+
+public virtual void OnRemove()
+
+### MainComponent.Reset
+
+public virtual void Reset() { }
+
+### MainComponent.ResetStatus
+
+public virtual void ResetStatus() { }
+
+### MainComponent.SetAllDirty
+
+public virtual void SetAllDirty()
+
+### MainComponent.SetComponentDirty
+
+public virtual void SetComponentDirty()
+
+### MainComponent.SetDefaultValue
+
+public virtual void SetDefaultValue() { }
+
+### MainComponent.SetVerticesDirty
+
+public virtual void SetVerticesDirty()
## MainComponentContext
-> class in XCharts.Runtime / Subclasses: [AxisContext](#axiscontext),[DataZoomContext](#datazoomcontext),[LegendContext](#legendcontext),[RadarCoordContext](#radarcoordcontext),[VisualMapContext](#visualmapcontext),[GridCoordContext](#gridcoordcontext),[GridLayoutContext](#gridlayoutcontext),[GridCoord3DContext](#gridcoord3dcontext),[ParallelCoordContext](#parallelcoordcontext),[PolarCoordContext](#polarcoordcontext)
-
+class in XCharts.Runtime / Subclasses: [AxisContext](#axiscontext),[DataZoomContext](#datazoomcontext),[LegendContext](#legendcontext),[RadarCoordContext](#radarcoordcontext),[VisualMapContext](#visualmapcontext),[GridCoordContext](#gridcoordcontext),[GridLayoutContext](#gridlayoutcontext),[GridCoord3DContext](#gridcoord3dcontext),[ParallelCoordContext](#parallelcoordcontext),[PolarCoordContext](#polarcoordcontext)
## MainComponentHandler
-> class in XCharts.Runtime / Subclasses: [AxisHandler<T>](#axishandlert),[MainComponentHandler<T>](#maincomponenthandlert)
+class in XCharts.Runtime / Subclasses: [AxisHandler<T>](#axishandlert),[MainComponentHandler<T>](#maincomponenthandlert)
+### MainComponentHandler.attribute
-|public method|since|description|
-|--|--|--|
-|BeforceSerieUpdate()||public virtual void BeforceSerieUpdate() { }|
-|CheckComponent()||public virtual void CheckComponent(StringBuilder sb) { }|
-|DrawBase()||public virtual void DrawBase(VertexHelper vh) { }|
-|DrawTop()||public virtual void DrawTop(VertexHelper vh) { }|
-|DrawUpper()||public virtual void DrawUpper(VertexHelper vh) { }|
-|InitComponent()||public virtual void InitComponent() { }|
-|OnBeginDrag()||public virtual void OnBeginDrag(PointerEventData eventData) { }|
-|OnDrag()||public virtual void OnDrag(PointerEventData eventData) { }|
-|OnEndDrag()||public virtual void OnEndDrag(PointerEventData eventData) { }|
-|OnPointerClick()||public virtual void OnPointerClick(PointerEventData eventData) { }|
-|OnPointerDown()||public virtual void OnPointerDown(PointerEventData eventData) { }|
-|OnPointerEnter()||public virtual void OnPointerEnter(PointerEventData eventData) { }|
-|OnPointerExit()||public virtual void OnPointerExit(PointerEventData eventData) { }|
-|OnPointerUp()||public virtual void OnPointerUp(PointerEventData eventData) { }|
-|OnScroll()||public virtual void OnScroll(PointerEventData eventData) { }|
-|OnSerieDataUpdate()||public virtual void OnSerieDataUpdate(int serieIndex) { }|
-|RemoveComponent()||public virtual void RemoveComponent() { }|
-|Update()||public virtual void Update() { }|
+public ComponentHandlerAttribute attribute
+
+### MainComponentHandler.BeforceSerieUpdate()
+
+public virtual void BeforceSerieUpdate()
+
+### MainComponentHandler.chart
+
+public BaseChart chart
+
+### MainComponentHandler.eventData)
+
+public virtual void OnBeginDrag(PointerEventData eventData)
+
+### MainComponentHandler.eventData)
+
+public virtual void OnDrag(PointerEventData eventData)
+
+### MainComponentHandler.eventData)
+
+public virtual void OnEndDrag(PointerEventData eventData)
+
+### MainComponentHandler.eventData)
+
+public virtual void OnPointerClick(PointerEventData eventData)
+
+### MainComponentHandler.eventData)
+
+public virtual void OnPointerDown(PointerEventData eventData)
+
+### MainComponentHandler.eventData)
+
+public virtual void OnPointerEnter(PointerEventData eventData)
+
+### MainComponentHandler.eventData)
+
+public virtual void OnPointerExit(PointerEventData eventData)
+
+### MainComponentHandler.eventData)
+
+public virtual void OnPointerUp(PointerEventData eventData)
+
+### MainComponentHandler.eventData)
+
+public virtual void OnScroll(PointerEventData eventData)
+
+### MainComponentHandler.InitComponent()
+
+public virtual void InitComponent()
+
+### MainComponentHandler.inited
+
+public bool inited
+
+### MainComponentHandler.order
+
+public int order
+
+### MainComponentHandler.RemoveComponent()
+
+public virtual void RemoveComponent()
+
+### MainComponentHandler.sb)
+
+public virtual void CheckComponent(StringBuilder sb)
+
+### MainComponentHandler.serieIndex)
+
+public virtual void OnSerieDataUpdate(int serieIndex)
+
+### MainComponentHandler.Update()
+
+public virtual void Update()
+
+### MainComponentHandler.vh)
+
+public virtual void DrawBase(VertexHelper vh)
+
+### MainComponentHandler.vh)
+
+public virtual void DrawTop(VertexHelper vh)
+
+### MainComponentHandler.vh)
+
+public virtual void DrawUpper(VertexHelper vh)
+
+### MainComponentHandler.BeforceSerieUpdate
+
+public virtual void BeforceSerieUpdate() { }
+
+### MainComponentHandler.CheckComponent
+
+public virtual void CheckComponent(StringBuilder sb) { }
+
+### MainComponentHandler.DrawBase
+
+public virtual void DrawBase(VertexHelper vh) { }
+
+### MainComponentHandler.DrawTop
+
+public virtual void DrawTop(VertexHelper vh) { }
+
+### MainComponentHandler.DrawUpper
+
+public virtual void DrawUpper(VertexHelper vh) { }
+
+### MainComponentHandler.InitComponent
+
+public virtual void InitComponent() { }
+
+### MainComponentHandler.OnBeginDrag
+
+public virtual void OnBeginDrag(PointerEventData eventData) { }
+
+### MainComponentHandler.OnDrag
+
+public virtual void OnDrag(PointerEventData eventData) { }
+
+### MainComponentHandler.OnEndDrag
+
+public virtual void OnEndDrag(PointerEventData eventData) { }
+
+### MainComponentHandler.OnPointerClick
+
+public virtual void OnPointerClick(PointerEventData eventData) { }
+
+### MainComponentHandler.OnPointerDown
+
+public virtual void OnPointerDown(PointerEventData eventData) { }
+
+### MainComponentHandler.OnPointerEnter
+
+public virtual void OnPointerEnter(PointerEventData eventData) { }
+
+### MainComponentHandler.OnPointerExit
+
+public virtual void OnPointerExit(PointerEventData eventData) { }
+
+### MainComponentHandler.OnPointerUp
+
+public virtual void OnPointerUp(PointerEventData eventData) { }
+
+### MainComponentHandler.OnScroll
+
+public virtual void OnScroll(PointerEventData eventData) { }
+
+### MainComponentHandler.OnSerieDataUpdate
+
+public virtual void OnSerieDataUpdate(int serieIndex) { }
+
+### MainComponentHandler.RemoveComponent
+
+public virtual void RemoveComponent() { }
+
+### MainComponentHandler.Update
+
+public virtual void Update() { }
## MainComponentHandler<T>
-> class in XCharts.Runtime / Inherits from: [MainComponentHandler](#maincomponenthandler)
+class in XCharts.Runtime / Inherits from: [MainComponentHandler](#maincomponenthandler)
+### MainComponentHandler<T>.component
+
+public T component
## MarkArea
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
Used to mark an area in chart. For example, mark a time interval.
-|public method|since|description|
-|--|--|--|
-|SetDefaultValue()||public override void SetDefaultValue()|
+### MarkArea.runtimeLabel
+
+public ChartLabel runtimeLabel
+Used to mark an area in chart. For example, mark a time interval.
+
+### MarkArea.runtimeLabelPosition
+
+public Vector3 runtimeLabelPosition
+
+### MarkArea.runtimeRect
+
+public Rect runtimeRect
+
+### MarkArea.SetDefaultValue
+
+public override void SetDefaultValue()
## MarkAreaData
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
标域的数据。
+### MarkAreaData.runtimeValue
+
+public double runtimeValue
+标域的数据。
+
+## MarkAreaType
+
+class in XCharts.Runtime
+
+标域类型
+
+Options:
+
+- `None`: 标域类型
+- `Min`: 最小值。
+- `Max`: 最大值。
+- `Average`: 平均值。
+- `Median`: 中位数。
+
## MarkLine
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
Use a line in the chart to illustrate.
-|public method|since|description|
-|--|--|--|
-|SetDefaultValue()||public override void SetDefaultValue()|
+### MarkLine.SetDefaultValue
+
+public override void SetDefaultValue()
## MarkLineData
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.9.0`
Data of marking line.
+### MarkLineData.runtimeCurrentEndPosition
+
+public Vector3 runtimeCurrentEndPosition
+
+### MarkLineData.runtimeEndPosition
+
+public Vector3 runtimeEndPosition
+
+### MarkLineData.runtimeInGrid
+
+public bool runtimeInGrid
+
+### MarkLineData.runtimeLabel
+
+public ChartLabel runtimeLabel
+
+### MarkLineData.runtimeStartPosition
+
+public Vector3 runtimeStartPosition
+
+### MarkLineData.runtimeValue
+
+public double runtimeValue
+
+## MarkLineType
+
+class in XCharts.Runtime
+
+标线类型
+
+Options:
+
+- `None`: 标线类型
+- `Min`: 最小值。
+- `Max`: 最大值。
+- `Average`: 平均值。
+- `Median`: 中位数。
+
## MarqueeStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.5.0`
Marquee style. It can be used for the DataZoom component. 选取框样式。可用于DataZoom组件。
-|public method|since|description|
-|--|--|--|
-|onEnd||public Action<DataZoom> onEnd
Customize the callback at the end of the selection. |
-|onGoing||public Action<DataZoom> onGoing
Custom checkboxes select ongoing callbacks. |
-|onStart||public Action<DataZoom> onStart
Customize the callback to the start of the selection of the checkbox. |
+### MarqueeStyle.apply
+
+public bool apply
+Check whether the scope is applied to the DataZoom. If this parameter is set to true, the range after the selection is complete is the DataZoom selection range.
+
+### MarqueeStyle.areaStyle
+
+public AreaStyle areaStyle
+The area style of marquee.
+
+### MarqueeStyle.lineStyle
+
+public LineStyle lineStyle
+The line style of marquee border.
+
+### MarqueeStyle.onEnd
+
+public Action<DataZoom> onEnd
+Customize the callback at the end of the selection.
+
+### MarqueeStyle.onGoing
+
+public Action<DataZoom> onGoing
+Custom checkboxes select ongoing callbacks.
+
+### MarqueeStyle.onStart
+
+public Action<DataZoom> onStart
+Customize the callback to the start of the selection of the checkbox.
+
+### MarqueeStyle.realRect
+
+public bool realRect
+Whether to select the actual box selection area. When true, the actual range between the mouse's actual point and the end point is used as the box selection area.
## MathUtil
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### MathUtil.Abs
-|public method|since|description|
-|--|--|--|
-|Abs()||public static double Abs(double d)|
-|Approximately()||public static bool Approximately(double a, double b)|
-|Clamp()||public static double Clamp(double d, double min, double max)|
-|Clamp01()||public static double Clamp01(double value)|
-|GetPrecision()||public static int GetPrecision(double value)|
-|IsInteger()||public static bool IsInteger(double value)|
-|Lerp()||public static double Lerp(double a, double b, double t)|
+public static double Abs(double d)
+
+### MathUtil.Approximately
+
+public static bool Approximately(double a, double b)
+
+### MathUtil.Clamp
+
+public static double Clamp(double d, double min, double max)
+
+### MathUtil.Clamp01
+
+public static double Clamp01(double value)
+
+### MathUtil.GetPrecision
+
+public static int GetPrecision(double value)
+
+### MathUtil.IsInteger
+
+public static bool IsInteger(double value)
+
+### MathUtil.Lerp
+
+public static double Lerp(double a, double b, double t)
## MLValue
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.8.0`
多样式数值。
-|public method|since|description|
-|--|--|--|
-|GetValue()||public float GetValue(float total)
Get the value by type. |
-|MLValue()||public MLValue(float value)|
-|MLValue()||public MLValue(Type type, float value)|
+### MLValue.type
+
+public Type type
+
+### MLValue.value
+
+public float value
+
+### MLValue.GetValue
+
+public float GetValue(float total)
+Get the value by type.
+
+### MLValue.MLValue
+
+public MLValue(Type type, float value)
+
+
+## MLValue.Type
+
+class in XCharts.Runtime
+
+the type of value.
+
+Options:
+
+- `Percent`: Percent value form.
+- `Absolute`: Absolute value form.
+- `Extra`: Extra value form.
## MonoBehaviour
-> class in / Subclasses: [XLog](#xlog)
-
+class in / Subclasses: [XLog](#xlog)
## ObjectPool<T> where T
-> class in XCharts.Runtime / Inherits from: [new()](#new())
+class in XCharts.Runtime / Inherits from: [new()](#new())
+### ObjectPool<T> where T.countActive
-|public method|since|description|
-|--|--|--|
-|ClearAll()||public void ClearAll()|
-|Get()||public T Get()|
-|new()||public class ObjectPool<T> where T : new()|
-|ObjectPool()||public ObjectPool(UnityAction<T> actionOnGet, UnityAction<T> actionOnRelease, bool newIfEmpty = true)|
-|Release()||public void Release(T element)|
+public int countActive
+
+### ObjectPool<T> where T.countAll
+
+public int countAll
+
+### ObjectPool<T> where T.countInactive
+
+public int countInactive
+
+### ObjectPool<T> where T.ClearAll
+
+public void ClearAll()
+
+### ObjectPool<T> where T.Get
+
+public T Get()
+
+### ObjectPool<T> where T.new
+
+public class ObjectPool<T> where T : new()
+
+### ObjectPool<T> where T.ObjectPool
+
+public ObjectPool(UnityAction<T> actionOnGet, UnityAction<T> actionOnRelease, bool newIfEmpty = true)
+
+### ObjectPool<T> where T.Release
+
+public void Release(T element)
+
+## Orient
+
+class in XCharts.Runtime
+
+the layout is horizontal or vertical.
+
+Options:
+
+- `Horizonal`: 水平
+- `Vertical`: 垂直
## Padding
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [TextPadding](#textpadding)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [TextPadding](#textpadding)
padding setting of item or text.
-|public method|since|description|
-|--|--|--|
-|Padding()||public Padding() { }|
-|Padding()||public Padding(float top, float right, float bottom, float left)|
-|SetPadding()||public void SetPadding(float top, float right, float bottom, float left)|
+### Padding.Padding()
+
+public Padding()
+
+### Padding.Padding
+
+public Padding(float top, float right, float bottom, float left)
+
+
+### Padding.SetPadding
+
+public void SetPadding(float top, float right, float bottom, float left)
## Painter
-> class in XCharts.Runtime / Inherits from: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=maskablegraphic)
+class in XCharts.Runtime / Inherits from: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=maskablegraphic)
+### Painter.index
-|public method|since|description|
-|--|--|--|
-|onPopulateMesh||public Action<VertexHelper, Painter> onPopulateMesh|
-|CheckRefresh()||public void CheckRefresh()|
-|Init()||public void Init()|
-|Refresh()||public void Refresh()|
-|SetActive()||public void SetActive(bool flag, bool isDebugMode = false)|
+public int index
+
+### Painter.onPopulateMesh
+
+public Action<VertexHelper, Painter> onPopulateMesh
+
+### Painter.type
+
+public Type type
+
+### Painter.CheckRefresh
+
+public void CheckRefresh()
+
+### Painter.Init
+
+public void Init()
+
+### Painter.Refresh
+
+public void Refresh()
+
+### Painter.SetActive
+
+public void SetActive(bool flag, bool isDebugMode = false)
+
+## Painter.Type
+
+class in XCharts.Runtime
+
+Options:
+
+- `Base`:
+- `Serie`:
+- `Top`:
## Parallel
-> class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+### Parallel.containerIndex
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
+public int containerIndex
+
+### Parallel.containterInstanceId
+
+public int containterInstanceId
+
+### Parallel.AddDefaultSerie
+
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
## ParallelAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
+### ParallelAxis.SetDefaultValue
-|public method|since|description|
-|--|--|--|
-|SetDefaultValue()||public override void SetDefaultValue()|
+public override void SetDefaultValue()
## ParallelChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
Parallel Coordinates is a common way of visualizing high-dimensional geometry and analyzing multivariate data.
## ParallelCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer)
Grid component.
-|public method|since|description|
-|--|--|--|
-|Contains()||public bool Contains(float x, float y)|
-|Contains()||public bool Contains(Vector3 pos)|
-|IsPointerEnter()||public bool IsPointerEnter()|
-|UpdateRuntimeData()||public void UpdateRuntimeData(BaseChart chart)|
+### ParallelCoord.Contains
+
+public bool Contains(float x, float y)
+
+
+### ParallelCoord.IsPointerEnter
+
+public bool IsPointerEnter()
+
+### ParallelCoord.UpdateRuntimeData
+
+public void UpdateRuntimeData(BaseChart chart)
## ParallelCoordContext
-> class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
-
+class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
## Pie
-> class in XCharts.Runtime / Inherits from: [Serie](#serie)
+class in XCharts.Runtime / Inherits from: [Serie](#serie)
+### Pie.defaultColorBy
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
-|ConvertSerie()||public static Pie ConvertSerie(Serie serie)|
+public override SerieColorBy defaultColorBy
+
+### Pie.titleJustForSerie
+
+public override bool titleJustForSerie
+
+### Pie.AddDefaultSerie
+
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
+
+### Pie.ConvertSerie
+
+public static Pie ConvertSerie(Serie serie)
## PieChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
The pie chart is mainly used for showing proportion of different categories. Each arc length represents the proportion of data quantity.
-|public method|since|description|
-|--|--|--|
-|DefaultAreaRosePieChart()||public void DefaultAreaRosePieChart()
default area rose pie chart. |
-|DefaultDonutPieChart()||public void DefaultDonutPieChart()
default donut pie chart. |
-|DefaultLabelDonutPieChart()||public void DefaultLabelDonutPieChart()
default label donut pie chart. |
-|DefaultLabelPieChart()||public void DefaultLabelPieChart()
default label pie chart. |
-|DefaultRadiusRosePieChart()||public void DefaultRadiusRosePieChart()
default rose pie chart. |
+### PieChart.DefaultAreaRosePieChart
+
+public void DefaultAreaRosePieChart()
+default area rose pie chart.
+
+### PieChart.DefaultDonutPieChart
+
+public void DefaultDonutPieChart()
+default donut pie chart.
+
+### PieChart.DefaultLabelDonutPieChart
+
+public void DefaultLabelDonutPieChart()
+default label donut pie chart.
+
+### PieChart.DefaultLabelPieChart
+
+public void DefaultLabelPieChart()
+default label pie chart.
+
+### PieChart.DefaultRadiusRosePieChart
+
+public void DefaultRadiusRosePieChart()
+default rose pie chart.
## PolarAxisTheme
-> class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+### PolarAxisTheme.base(theme)
-|public method|since|description|
-|--|--|--|
-|PolarAxisTheme()||public PolarAxisTheme(ThemeType theme) : base(theme) { }|
+public PolarAxisTheme(ThemeType theme) : base(theme)
+
+### PolarAxisTheme.PolarAxisTheme
+
+public PolarAxisTheme(ThemeType theme) : base(theme) { }
## PolarChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
Polar coordinates are usually used in a circular layout.
-|public method|since|description|
-|--|--|--|
-|DefaultHeatmapPolarChart()||public void DefaultHeatmapPolarChart()
default heatmap polar chart. |
-|DefaultRadialBarPolarChart()||public void DefaultRadialBarPolarChart()
default radial bar polar chart. |
-|DefaultTangentialBarPolarChart()||public void DefaultTangentialBarPolarChart()
default tangential bar polar chart. |
+### PolarChart.DefaultHeatmapPolarChart
+
+public void DefaultHeatmapPolarChart()
+default heatmap polar chart.
+
+### PolarChart.DefaultRadialBarPolarChart
+
+public void DefaultRadialBarPolarChart()
+default radial bar polar chart.
+
+### PolarChart.DefaultTangentialBarPolarChart
+
+public void DefaultTangentialBarPolarChart()
+default tangential bar polar chart.
## PolarCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[ISerieContainer](#iseriecontainer)
Polar coordinate can be used in scatter and line chart. Every polar coordinate has an angleAxis and a radiusAxis.
-|public method|since|description|
-|--|--|--|
-|Contains()||public bool Contains(Vector3 pos)|
-|IsPointerEnter()||public bool IsPointerEnter()|
+### PolarCoord.Contains
+
+public bool Contains(Vector3 pos)
+
+### PolarCoord.IsPointerEnter
+
+public bool IsPointerEnter()
## PolarCoordContext
-> class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
-
+class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
## PropertyUtil
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### PropertyUtil.SetClass<T>
+
+public static bool SetClass<T>(ref T currentValue, T newValue, bool notNull = false) where T : class
+
+### PropertyUtil.SetColor
+
+public static bool SetColor(ref Color32 currentValue, Color32 newValue)
-|public method|since|description|
-|--|--|--|
-|SetClass<T>()||public static bool SetClass<T>(ref T currentValue, T newValue, bool notNull = false) where T : class|
-|SetColor()||public static bool SetColor(ref Color currentValue, Color newValue)|
-|SetColor()||public static bool SetColor(ref Color32 currentValue, Color32 newValue)|
-|SetStruct<T>()||public static bool SetStruct<T>(ref T currentValue, T newValue) where T : struct|
+### PropertyUtil.SetStruct<T>
+
+public static bool SetStruct<T>(ref T currentValue, T newValue) where T : struct
## Radar
-> class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer)
+### Radar.containerIndex
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
+public int containerIndex
+
+### Radar.containterInstanceId
+
+public int containterInstanceId
+
+### Radar.defaultColorBy
+
+public override SerieColorBy defaultColorBy
+
+### Radar.multiDimensionLabel
+
+public override bool multiDimensionLabel
+
+### Radar.AddDefaultSerie
+
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
## RadarAxisTheme
-> class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+### RadarAxisTheme.RadarAxisTheme
-|public method|since|description|
-|--|--|--|
-|RadarAxisTheme()||public RadarAxisTheme(ThemeType theme) : base(theme)|
+public RadarAxisTheme(ThemeType theme) : base(theme)
## RadarChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
Radar chart is mainly used to show multi-variable data, such as the analysis of a football player's varied attributes. It relies radar component.
-|public method|since|description|
-|--|--|--|
-|DefaultCircleRadarChart()||public void DefaultCircleRadarChart()
default circle radar chart. |
+### RadarChart.DefaultCircleRadarChart
+
+public void DefaultCircleRadarChart()
+default circle radar chart.
## RadarCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem),[ISerieContainer](#iseriecontainer)
Radar coordinate conponnet for radar charts. 雷达图坐标系组件,只适用于雷达图。
+## RadarCoord.PositionType
+
+class in XCharts.Runtime
+
+The position type of radar.
+
+Options:
+
+- `Vertice`: Display at the vertex.
+- `Between`: Display at the middle of line.
+
+## RadarCoord.Shape
+
+class in XCharts.Runtime
+
+Radar render type, in which 'Polygon' and 'Circle' are supported.
+
+Options:
+
+- `Polygon`: Radar render type, in which 'Polygon' and 'Circle' are supported.
+- `Circle`: Radar render type, in which 'Polygon' and 'Circle' are supported.
+
## RadarCoordContext
-> class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
+class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
+### RadarCoordContext.center
+
+public Vector3 center
+the center position of radar in container.
+
+### RadarCoordContext.dataRadius
+
+public float dataRadius
+
+### RadarCoordContext.isPointerEnter
+
+public bool isPointerEnter
+
+### RadarCoordContext.radius
+
+public float radius
+the true radius of radar.
+
+## RadarType
+
+class in XCharts.Runtime
+
+the type of radar.
+
+Options:
+
+- `Multiple`: multiple radar.
+- `Single`: single radar.
## RadiusAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
Radial axis of polar coordinate.
-|public method|since|description|
-|--|--|--|
-|SetDefaultValue()||public override void SetDefaultValue()
Radial axis of polar coordinate. |
+### RadiusAxis.SetDefaultValue
+
+public override void SetDefaultValue()
+Radial axis of polar coordinate.
## RadiusAxisTheme
-> class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+### RadiusAxisTheme.base(theme)
-|public method|since|description|
-|--|--|--|
-|RadiusAxisTheme()||public RadiusAxisTheme(ThemeType theme) : base(theme) { }|
+public RadiusAxisTheme(ThemeType theme) : base(theme)
+
+### RadiusAxisTheme.RadiusAxisTheme
+
+public RadiusAxisTheme(ThemeType theme) : base(theme) { }
## ReflectionUtil
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### ReflectionUtil.DeepCloneSerializeField
-|public method|since|description|
-|--|--|--|
-|DeepCloneSerializeField()||public static object DeepCloneSerializeField(object obj)|
-|InvokeListAdd()||public static void InvokeListAdd(object obj, FieldInfo field, object item)|
-|InvokeListAddTo<T>()||public static void InvokeListAddTo<T>(object obj, FieldInfo field, Action<T> callback)|
-|InvokeListClear()||public static void InvokeListClear(object obj, FieldInfo field)|
-|InvokeListCount()||public static int InvokeListCount(object obj, FieldInfo field)|
-|InvokeListGet<T>()||public static T InvokeListGet<T>(object obj, FieldInfo field, int i)|
+public static object DeepCloneSerializeField(object obj)
+
+### ReflectionUtil.InvokeListAdd
+
+public static void InvokeListAdd(object obj, FieldInfo field, object item)
+
+### ReflectionUtil.InvokeListAddTo<T>
+
+public static void InvokeListAddTo<T>(object obj, FieldInfo field, Action<T> callback)
+
+### ReflectionUtil.InvokeListClear
+
+public static void InvokeListClear(object obj, FieldInfo field)
+
+### ReflectionUtil.InvokeListCount
+
+public static int InvokeListCount(object obj, FieldInfo field)
+
+### ReflectionUtil.InvokeListGet<T>
+
+public static T InvokeListGet<T>(object obj, FieldInfo field, int i)
## RequireChartComponentAttribute
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+### RequireChartComponentAttribute.RequireChartComponentAttribute
+
+public RequireChartComponentAttribute(Type requiredComponent, Type requiredComponent2)
+
+public RequireChartComponentAttribute(Type requiredComponent, Type requiredComponent2, Type requiredComponent3)
-|public method|since|description|
-|--|--|--|
-|RequireChartComponentAttribute()||public RequireChartComponentAttribute(Type requiredComponent)|
-|RequireChartComponentAttribute()||public RequireChartComponentAttribute(Type requiredComponent, Type requiredComponent2)|
-|RequireChartComponentAttribute()||public RequireChartComponentAttribute(Type requiredComponent, Type requiredComponent2, Type requiredComponent3)|
## Ring
-> class in XCharts.Runtime / Inherits from: [Serie](#serie)
+class in XCharts.Runtime / Inherits from: [Serie](#serie)
+### Ring.defaultColorBy
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
-|GetDataTotal()||public override double GetDataTotal(int dimension, SerieData serieData = null)|
+public override SerieColorBy defaultColorBy
+
+### Ring.AddDefaultSerie
+
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
+
+### Ring.GetDataTotal
+
+public override double GetDataTotal(int dimension, SerieData serieData = null)
## RingChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
Ring chart is mainly used to show the proportion of each item and the relationship between the items.
-|public method|since|description|
-|--|--|--|
-|DefaultMultipleRingChart()||public void DefaultMultipleRingChart()
default multiple ring chart. |
+### RingChart.DefaultMultipleRingChart
+
+public void DefaultMultipleRingChart()
+default multiple ring chart.
+
+## RoseType
+
+class in XCharts.Runtime
+
+Whether to show as Nightingale chart, which distinguishs data through radius.
+
+Options:
+
+- `None`: Don't show as Nightingale chart.
+- `Radius`: Use central angle to show the percentage of data, radius to show data size.
+- `Area`: All the sectors will share the same central angle, the data size is shown only through radiuses.
## RuntimeUtil
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### RuntimeUtil.GetAllAssemblyTypes
+
+public static IEnumerable<Type> GetAllAssemblyTypes()
+
+### RuntimeUtil.GetAllTypesDerivedFrom
+
+public static IEnumerable<Type> GetAllTypesDerivedFrom(Type type)
+
+### RuntimeUtil.GetAllTypesDerivedFrom<T>
+
+public static IEnumerable<Type> GetAllTypesDerivedFrom<T>()
+
+### RuntimeUtil.GetAttribute<T>
+
+public static T GetAttribute<T>(this MemberInfo type, bool check = true) where T : Attribute
-|public method|since|description|
-|--|--|--|
-|GetAllAssemblyTypes()||public static IEnumerable<Type> GetAllAssemblyTypes()|
-|GetAllTypesDerivedFrom()||public static IEnumerable<Type> GetAllTypesDerivedFrom(Type type)|
-|GetAllTypesDerivedFrom<T>()||public static IEnumerable<Type> GetAllTypesDerivedFrom<T>()|
-|GetAttribute<T>()||public static T GetAttribute<T>(this MemberInfo type, bool check = true) where T : Attribute|
-|GetAttribute<T>()||public static T GetAttribute<T>(this Type type, bool check = true) where T : Attribute|
-|HasSubclass()||public static bool HasSubclass(Type type)|
+### RuntimeUtil.HasSubclass
+
+public static bool HasSubclass(Type type)
+
+## SampleType
+
+class in XCharts.Runtime
+
+sample type of line chart.
+
+Options:
+
+- `Peak`: Take a peak. When the average value of the filter point is greater than or equal to 'sampleAverage', take the maximum value; If you do it the other way around, you get the minimum.
+- `Average`: Take the average of the filter points.
+- `Max`: Take the maximum value of the filter point.
+- `Min`: Take the minimum value of the filter point.
+- `Sum`: Take the sum of the filter points.
## Scatter
-> class in XCharts.Runtime / Inherits from: [BaseScatter](#basescatter)
+class in XCharts.Runtime / Inherits from: [BaseScatter](#basescatter)
+### Scatter.AddDefaultSerie
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
## ScatterChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
Scatter chart is mainly used to show the relationship between two data dimensions.
-|public method|since|description|
-|--|--|--|
-|DefaultBubbleChart()||public void DefaultBubbleChart()
default bubble chart. |
+### ScatterChart.DefaultBubbleChart
+
+public void DefaultBubbleChart()
+default bubble chart.
## SelectStyle
-> class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent)
> Since `v3.2.0`
@@ -2460,887 +6409,2688 @@ Configurations of select state.
## Serie
-> class in XCharts.Runtime / Inherits from: [BaseSerie](#baseserie),[IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=icomparable) / Subclasses: [SerieHandler<T>](#seriehandlert),[Bar](#bar),[SimplifiedBar](#simplifiedbar),[Candlestick](#candlestick),[SimplifiedCandlestick](#simplifiedcandlestick),[Heatmap](#heatmap),[Line](#line),[SimplifiedLine](#simplifiedline),[Parallel](#parallel),[Pie](#pie),[Radar](#radar),[Ring](#ring),[BaseScatter](#basescatter)
+class in XCharts.Runtime / Inherits from: [BaseSerie](#baseserie),[IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=icomparable) / Subclasses: [SerieHandler<T>](#seriehandlert),[Bar](#bar),[SimplifiedBar](#simplifiedbar),[Candlestick](#candlestick),[SimplifiedCandlestick](#simplifiedcandlestick),[Heatmap](#heatmap),[Line](#line),[SimplifiedLine](#simplifiedline),[Parallel](#parallel),[Pie](#pie),[Radar](#radar),[Ring](#ring),[BaseScatter](#basescatter)
系列。系列一般由数据和配置组成,用来表示具体的图表图形,如折线图的一条折线,柱图的一组柱子等。一个图表中可以包含多个不同类型的系列。
-|public method|since|description|
-|--|--|--|
-|onClick||public Action<SerieEventData> onClick
event callback when click serie. |
-|onDown||public Action<SerieEventData> onDown
event callback when mouse down on serie. |
-|onEnter||public Action<SerieEventData> onEnter
event callback when mouse enter serie. |
-|onExit||public Action<SerieEventData> onExit
event callback when mouse leave serie. |
-|AddChildData()||public SerieData AddChildData(SerieData parent, double value, string name, string id)|
-|AddChildData()||public SerieData AddChildData(SerieData parent, List<double> value, string name, string id)|
-|AddChildData()||public void AddChildData(SerieData parent, SerieData serieData)|
-|AddData()||public SerieData AddData(double indexOrTimestamp, double open, double close, double lowest, double heighest, string dataName = null, string dataId = null)
添加 (open, close, lowest, heighest) 数据 |
-|AddData()||public SerieData AddData(List<double> valueList, string dataName = null, string dataId = null)
将一组数据添加到系列中。 如果数据只有一个,默认添加到维度Y中。 |
-|AddData()||public SerieData AddData(params double[] values)
添加任意维数据到系列中。 |
-|AddExtraComponent<T>()||public T AddExtraComponent<T>() where T : ChildComponent, ISerieComponent|
-|AddLink()||public virtual SerieDataLink AddLink(string sourceId, string targetId, double value = 0)
Add a link data. |
-|AddSerieData()||public virtual void AddSerieData(SerieData serieData)|
-|AddXYData()||public SerieData AddXYData(double xValue, double yValue, string dataName = null, string dataId = null)
添加(x,y)数据到维度X和维度Y |
-|AddYData()||public SerieData AddYData(double value, string dataName = null, string dataId = null)
添加一个数据到维度Y(此时维度X对应的数据是索引) |
-|AnimationEnable()||public void AnimationEnable(bool flag)
启用或取消初始动画 |
-|AnimationFadeIn()||public void AnimationFadeIn()
渐入动画 |
-|AnimationFadeOut()||public void AnimationFadeOut()
渐出动画 |
-|AnimationPause()||public void AnimationPause()
暂停动画 |
-|AnimationReset()||public void AnimationReset()
重置动画 |
-|AnimationRestart()||public void AnimationRestart()
重置动画 |
-|AnimationResume()||public void AnimationResume()
继续动画 |
-|CanAddComponent()||public bool CanAddComponent(Type type)|
-|CanAddComponent<T>()||public bool CanAddComponent<T>() where T : ChildComponent, ISerieComponent|
-|ClearComponentDirty()||public override void ClearComponentDirty()|
-|ClearData()||public override void ClearData()
清空所有数据 |
-|ClearDirty()||public override void ClearDirty()|
-|ClearHighlight()||public void ClearHighlight()
清除所有数据的高亮标志 |
-|ClearLinks()||public void ClearLinks()
清空所有Link数据 |
-|ClearSerieNameDirty()||public void ClearSerieNameDirty()|
-|ClearVerticesDirty()||public override void ClearVerticesDirty()|
-|Clone()||public Serie Clone()|
-|Clone<T>()||public T Clone<T>() where T : Serie|
-|CompareTo()||public int CompareTo(object obj)|
-|EnsureComponent()||public ISerieComponent EnsureComponent(Type type)|
-|EnsureComponent<T>()||public T EnsureComponent<T>() where T : ChildComponent, ISerieComponent
Ensure the serie has the component. If not, add it. |
-|GetBarWidth()||public float GetBarWidth(float categoryWidth, int barCount = 0, float defaultRate = 0.6f)|
-|GetComponent()||public ISerieComponent GetComponent(Type type)|
-|GetComponent<T>()||public T GetComponent<T>() where T : ChildComponent, ISerieComponent|
-|GetData()||public double GetData(int index, int dimension, DataZoom dataZoom = null)
获得指定index指定维数的数据 |
-|GetDataList()||public List<SerieData> GetDataList(DataZoom dataZoom = null)
获得系列的数据列表 |
-|GetDataTotal()||public virtual double GetDataTotal(int dimension, SerieData serieData = null)|
-|GetSerieData()||public SerieData GetSerieData(int index, DataZoom dataZoom = null)
获得指定索引的数据项 |
-|GetSerieData()||public SerieData GetSerieData(SerieData parent, string id)|
-|GetSerieData()||public SerieData GetSerieData(string id, DataZoom dataZoom = null)|
-|GetXYData()||public void GetXYData(int index, DataZoom dataZoom, out double xValue, out double yVlaue)
获得指定索引的维度X和维度Y的数据 |
-|GetYCurrData()||public double GetYCurrData(int index, DataZoom dataZoom = null)|
-|GetYData()||public double GetYData(int index, DataZoom dataZoom = null)
获得维度Y索引对应的数据 |
-|GetYData()||public void GetYData(int index, out double yData, out string dataName, DataZoom dataZoom = null)
获得维度Y索引对应的数据和数据名 |
-|IsIgnoreIndex()||public bool IsIgnoreIndex(int index, int dimension = 1)|
-|IsIgnorePoint()||public bool IsIgnorePoint(int index)|
-|IsIgnoreValue()||public bool IsIgnoreValue(double value)|
-|IsIgnoreValue()||public bool IsIgnoreValue(SerieData serieData, double value)|
-|IsIgnoreValue()||public bool IsIgnoreValue(SerieData serieData, int dimension = 1)|
-|IsLegendName()||public bool IsLegendName(string legendName)|
-|IsMinShowLabelValue()||public bool IsMinShowLabelValue(double value)|
-|IsMinShowLabelValue()||public bool IsMinShowLabelValue(int index, int dimension = 1)|
-|IsMinShowLabelValue()||public bool IsMinShowLabelValue(SerieData serieData, int dimension = 1)|
-|IsPerformanceMode()||public bool IsPerformanceMode()
是否为性能模式。性能模式下不绘制Symbol,不刷新Label,不单独设置数据项配置。 |
-|IsSerie<T>()||public bool IsSerie<T>() where T : Serie|
-|IsSerieDataLegendName()||public bool IsSerieDataLegendName(string legendName)|
-|IsSerieLegendName()||public bool IsSerieLegendName(string legendName)|
-|IsUseCoord<T>()||public bool IsUseCoord<T>() where T : CoordSystem|
-|RemoveAllComponents()||public void RemoveAllComponents()
Remove all extra components. |
-|RemoveComponent()||public void RemoveComponent(Type type)|
-|RemoveComponent<T>()||public void RemoveComponent<T>() where T : ISerieComponent|
-|RemoveData()||public void RemoveData(int index)
移除指定索引的数据 |
-|ResetDataIndex()||public bool ResetDataIndex()
重置数据项索引。避免部分数据项的索引异常。 |
-|ResetInteract()||public void ResetInteract()|
-|SetAllDirty()||public override void SetAllDirty()|
-|SetCoord<T>()||public bool SetCoord<T>() where T : CoordSystem|
-|SetHighlight()||public void SetHighlight(int index, bool flag)
设置指定索引的数据为高亮状态 |
-|SetVerticesDirty()||public override void SetVerticesDirty()|
-|UpdateData()||public bool UpdateData(int index, int dimension, double value)
更新指定索引指定维数的数据 |
-|UpdateData()||public bool UpdateData(int index, List<double> values)
更新指定索引的数据项数据列表 |
-|UpdateDataName()||public bool UpdateDataName(int index, string name)|
-|UpdateXYData()||public bool UpdateXYData(int index, double xValue, double yValue)
更新指定索引的维度X和维度Y的数据 |
-|UpdateYData()||public bool UpdateYData(int index, double value)
更新指定索引的维度Y数据 |
+### Serie.areaStyle
+
+public AreaStyle areaStyle
+The style of area.
+
+### Serie.blurStyle
+
+public BlurStyle blurStyle
+style of blur state.
+
+### Serie.colorByData
+
+public bool colorByData
+取色策略是否为按数据项分配。
+
+### Serie.data
+
+public List<SerieData> data
+系列中的数据内容数组。SerieData可以设置1到n维数据。
+
+### Serie.dataCount
+
+public int dataCount
+the count of data list.
+
+### Serie.dataDirty
+
+public bool dataDirty
+
+### Serie.emphasisStyle
+
+public EmphasisStyle emphasisStyle
+style of emphasis state.
+
+### Serie.endLabel
+
+public LabelStyle endLabel
+
+### Serie.highlight
+
+public bool highlight
+Whether the serie is highlighted.
+
+### Serie.index
+
+public int index
+The index of serie.
+
+### Serie.interactDirty
+
+public bool interactDirty
+
+### Serie.label
+
+public LabelStyle label
+Text label of graphic element,to explain some data information about graphic item like value, name and so on.
+
+### Serie.labelDirty
+
+public bool labelDirty
+
+### Serie.labelLine
+
+public LabelLine labelLine
+The line of label.
+
+### Serie.legendName
+
+public string legendName
+Legend name. When the serie name is not empty, the legend name is the series name; Otherwise, it is index.
+
+### Serie.lineArrow
+
+public LineArrow lineArrow
+The arrow of line.
+
+### Serie.links
+
+public List<SerieDataLink> links
+数据节点的边。
+
+### Serie.nameDirty
+
+public bool nameDirty
+
+### Serie.onClick
+
+public Action<SerieEventData> onClick
+event callback when click serie.
+
+### Serie.onDown
+
+public Action<SerieEventData> onDown
+event callback when mouse down on serie.
+
+### Serie.onEnter
+
+public Action<SerieEventData> onEnter
+event callback when mouse enter serie.
+
+### Serie.onExit
+
+public Action<SerieEventData> onExit
+event callback when mouse leave serie.
+
+### Serie.selectStyle
+
+public SelectStyle selectStyle
+style of select state.
+
+### Serie.showDataDimension
+
+public int showDataDimension
+数据项里的数据维数。
+
+### Serie.showDataName
+
+public bool showDataName
+在Editor的inpsector上是否显示name参数
+
+### Serie.titleDirty
+
+public bool titleDirty
+
+### Serie.titleStyle
+
+public TitleStyle titleStyle
+the icon of data.
+
+### Serie.AddChildData
+
+public SerieData AddChildData(SerieData parent, List<double> value, string name, string id)
+
+public void AddChildData(SerieData parent, SerieData serieData)
+
+
+### Serie.AddData
+
+public SerieData AddData(List<double> valueList, string dataName = null, string dataId = null)
+将一组数据添加到系列中。 如果数据只有一个,默认添加到维度Y中。
+
+public SerieData AddData(params double[] values)
+添加任意维数据到系列中。
+
+
+### Serie.AddExtraComponent<T>
+
+public T AddExtraComponent<T>() where T : ChildComponent, ISerieComponent
+
+### Serie.AddLink
+
+public virtual SerieDataLink AddLink(string sourceId, string targetId, double value = 0)
+Add a link data.
+
+### Serie.AddSerieData
+
+public virtual void AddSerieData(SerieData serieData)
+
+### Serie.AddXYData
+
+public SerieData AddXYData(double xValue, double yValue, string dataName = null, string dataId = null)
+添加(x,y)数据到维度X和维度Y
+
+### Serie.AddYData
+
+public SerieData AddYData(double value, string dataName = null, string dataId = null)
+添加一个数据到维度Y(此时维度X对应的数据是索引)
+
+### Serie.AnimationEnable
+
+public void AnimationEnable(bool flag)
+启用或取消初始动画
+
+### Serie.AnimationFadeIn
+
+public void AnimationFadeIn()
+渐入动画
+
+### Serie.AnimationFadeOut
+
+public void AnimationFadeOut()
+渐出动画
+
+### Serie.AnimationPause
+
+public void AnimationPause()
+暂停动画
+
+### Serie.AnimationReset
+
+public void AnimationReset()
+重置动画
+
+### Serie.AnimationRestart
+
+public void AnimationRestart()
+重置动画
+
+### Serie.AnimationResume
+
+public void AnimationResume()
+继续动画
+
+### Serie.CanAddComponent
+
+public bool CanAddComponent(Type type)
+
+### Serie.CanAddComponent<T>
+
+public bool CanAddComponent<T>() where T : ChildComponent, ISerieComponent
+
+### Serie.ClearComponentDirty
+
+public override void ClearComponentDirty()
+
+### Serie.ClearData
+
+public override void ClearData()
+清空所有数据
+
+### Serie.ClearDirty
+
+public override void ClearDirty()
+
+### Serie.ClearHighlight
+
+public void ClearHighlight()
+清除所有数据的高亮标志
+
+### Serie.ClearLinks
+
+public void ClearLinks()
+清空所有Link数据
+
+### Serie.ClearSerieNameDirty
+
+public void ClearSerieNameDirty()
+
+### Serie.ClearVerticesDirty
+
+public override void ClearVerticesDirty()
+
+### Serie.Clone
+
+public Serie Clone()
+
+### Serie.Clone<T>
+
+public T Clone<T>() where T : Serie
+
+### Serie.CompareTo
+
+public int CompareTo(object obj)
+
+### Serie.EnsureComponent
+
+public ISerieComponent EnsureComponent(Type type)
+
+### Serie.EnsureComponent<T>
+
+public T EnsureComponent<T>() where T : ChildComponent, ISerieComponent
+Ensure the serie has the component. If not, add it.
+
+### Serie.GetBarWidth
+
+public float GetBarWidth(float categoryWidth, int barCount = 0, float defaultRate = 0.6f)
+
+### Serie.GetComponent
+
+public ISerieComponent GetComponent(Type type)
+
+### Serie.GetComponent<T>
+
+public T GetComponent<T>() where T : ChildComponent, ISerieComponent
+
+### Serie.GetData
+
+public double GetData(int index, int dimension, DataZoom dataZoom = null)
+获得指定index指定维数的数据
+
+### Serie.GetDataList
+
+public List<SerieData> GetDataList(DataZoom dataZoom = null)
+获得系列的数据列表
+
+### Serie.GetDataTotal
+
+public virtual double GetDataTotal(int dimension, SerieData serieData = null)
+
+### Serie.GetSerieData
+
+public SerieData GetSerieData(SerieData parent, string id)
+
+public SerieData GetSerieData(string id, DataZoom dataZoom = null)
+
+
+### Serie.GetXYData
+
+public void GetXYData(int index, DataZoom dataZoom, out double xValue, out double yVlaue)
+获得指定索引的维度X和维度Y的数据
+
+### Serie.GetYCurrData
+
+public double GetYCurrData(int index, DataZoom dataZoom = null)
+
+### Serie.GetYData
+
+public void GetYData(int index, out double yData, out string dataName, DataZoom dataZoom = null)
+获得维度Y索引对应的数据和数据名
+
+
+### Serie.IsIgnoreIndex
+
+public bool IsIgnoreIndex(int index, int dimension = 1)
+
+### Serie.IsIgnorePoint
+
+public bool IsIgnorePoint(int index)
+
+### Serie.IsIgnoreValue
+
+public bool IsIgnoreValue(double value)
+
+public bool IsIgnoreValue(SerieData serieData, double value)
+
+
+### Serie.IsLegendName
+
+public bool IsLegendName(string legendName)
+
+### Serie.IsMinShowLabelValue
+
+public bool IsMinShowLabelValue(double value)
+
+public bool IsMinShowLabelValue(SerieData serieData, int dimension = 1)
+
+
+### Serie.IsPerformanceMode
+
+public bool IsPerformanceMode()
+是否为性能模式。性能模式下不绘制Symbol,不刷新Label,不单独设置数据项配置。
+
+### Serie.IsSerie<T>
+
+public bool IsSerie<T>() where T : Serie
+
+### Serie.IsSerieDataLegendName
+
+public bool IsSerieDataLegendName(string legendName)
+
+### Serie.IsSerieLegendName
+
+public bool IsSerieLegendName(string legendName)
+
+### Serie.IsUseCoord<T>
+
+public bool IsUseCoord<T>() where T : CoordSystem
+
+### Serie.RemoveAllComponents
+
+public void RemoveAllComponents()
+Remove all extra components.
+
+### Serie.RemoveComponent
+
+public void RemoveComponent(Type type)
+
+### Serie.RemoveComponent<T>
+
+public void RemoveComponent<T>() where T : ISerieComponent
+
+### Serie.RemoveData
+
+public void RemoveData(int index)
+移除指定索引的数据
+
+### Serie.ResetDataIndex
+
+public bool ResetDataIndex()
+重置数据项索引。避免部分数据项的索引异常。
+
+### Serie.ResetInteract
+
+public void ResetInteract()
+
+### Serie.SetAllDirty
+
+public override void SetAllDirty()
+
+### Serie.SetCoord<T>
+
+public bool SetCoord<T>() where T : CoordSystem
+
+### Serie.SetHighlight
+
+public void SetHighlight(int index, bool flag)
+设置指定索引的数据为高亮状态
+
+### Serie.SetVerticesDirty
+
+public override void SetVerticesDirty()
+
+### Serie.UpdateData
+
+public bool UpdateData(int index, List<double> values)
+更新指定索引的数据项数据列表
+
+
+### Serie.UpdateDataName
+
+public bool UpdateDataName(int index, string name)
+
+### Serie.UpdateXYData
+
+public bool UpdateXYData(int index, double xValue, double yValue)
+更新指定索引的维度X和维度Y的数据
+
+### Serie.UpdateYData
+
+public bool UpdateYData(int index, double value)
+更新指定索引的维度Y数据
+
+## SerieColorBy
+
+class in XCharts.Runtime
+
+The policy to take color from theme.
+
+Options:
+
+- `Default`: Select state.
+- `Serie`: assigns the colors in the palette by serie, so that all data in the same series are in the same color.
+- `Data`: assigns colors in the palette according to data items, with each data item using a different color.
## SerieComponentAttribute
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
The attribute for serie component.
-|public method|since|description|
-|--|--|--|
-|Contains()||public bool Contains(Type type)|
-|Contains<T>()||public bool Contains<T>() where T : ISerieComponent|
-|SerieComponentAttribute()||public SerieComponentAttribute()|
-|SerieComponentAttribute()||public SerieComponentAttribute(Type type1)|
-|SerieComponentAttribute()||public SerieComponentAttribute(Type type1, Type type2)|
-|SerieComponentAttribute()||public SerieComponentAttribute(Type type1, Type type2, Type type3)|
-|SerieComponentAttribute()||public SerieComponentAttribute(Type type1, Type type2, Type type3, Type type4)|
-|SerieComponentAttribute()||public SerieComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5)|
-|SerieComponentAttribute()||public SerieComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5, Type type6)|
-|SerieComponentAttribute()||public SerieComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5, Type type6, Type type7)|
+### SerieComponentAttribute.Contains
+
+public bool Contains(Type type)
+
+### SerieComponentAttribute.Contains<T>
+
+public bool Contains<T>() where T : ISerieComponent
+
+### SerieComponentAttribute.SerieComponentAttribute
+
+public SerieComponentAttribute(Type type1)
+
+public SerieComponentAttribute(Type type1, Type type2)
+
+public SerieComponentAttribute(Type type1, Type type2, Type type3)
+
+public SerieComponentAttribute(Type type1, Type type2, Type type3, Type type4)
+
+public SerieComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5)
+
+public SerieComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5, Type type6)
+
+public SerieComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5, Type type6, Type type7)
+
## SerieContext
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### SerieContext.titleObject
+
+public ChartLabel titleObject
+绘制点
## SerieConvertAttribute
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
The attribute for which serie types can be converted to.
-|public method|since|description|
-|--|--|--|
-|Contains()||public bool Contains(Type type)|
-|Contains<T>()||public bool Contains<T>() where T : Serie|
-|SerieConvertAttribute()||public SerieConvertAttribute(Type serie)|
-|SerieConvertAttribute()||public SerieConvertAttribute(Type serie, Type serie2)|
-|SerieConvertAttribute()||public SerieConvertAttribute(Type serie, Type serie2, Type serie3)|
-|SerieConvertAttribute()||public SerieConvertAttribute(Type serie, Type serie2, Type serie3, Type serie4)|
+### SerieConvertAttribute.Contains
+
+public bool Contains(Type type)
+
+### SerieConvertAttribute.Contains<T>
+
+public bool Contains<T>() where T : Serie
+
+### SerieConvertAttribute.SerieConvertAttribute
+
+public SerieConvertAttribute(Type serie, Type serie2)
+
+public SerieConvertAttribute(Type serie, Type serie2, Type serie3)
+
+public SerieConvertAttribute(Type serie, Type serie2, Type serie3, Type serie4)
+
## SerieData
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
A data item of serie.
-|public method|since|description|
-|--|--|--|
-|ClearComponentDirty()||public override void ClearComponentDirty()|
-|ClearVerticesDirty()||public override void ClearVerticesDirty()|
-|EnsureComponent()|v3.6.0|public ISerieDataComponent EnsureComponent(Type type)
Ensure the serie data has the component, if not, add it. |
-|EnsureComponent<T>()|v3.6.0|public T EnsureComponent<T>() where T : ChildComponent, ISerieDataComponent
Ensure the serie data has the component, if not, add it. |
-|GetAddAnimationData()||public double GetAddAnimationData(double min, double max, float animationDuration = 500f, bool unscaledTime = false)|
-|GetComponent<T>()||public T GetComponent<T>() where T : ChildComponent, ISerieDataComponent
Get the component of the serie data. return null if not exist. |
-|GetCurrData()||public double GetCurrData(int index, AnimationStyle animation, bool inverse = false, bool loop = false)|
-|GetCurrData()||public double GetCurrData(int index, AnimationStyle animation, bool inverse, double min, double max, bool loop = false)|
-|GetCurrData()||public double GetCurrData(int index, float dataAddDuration = 500f, float animationDuration = 500f, bool unscaledTime = false, bool inverse = false)|
-|GetCurrData()||public double GetCurrData(int index, float dataAddDuration, float animationDuration, bool inverse, double min, double max, bool unscaledTime, bool loop = false)|
-|GetData()||public double GetData(int index, bool inverse = false)|
-|GetData()||public double GetData(int index, double min, double max)|
-|GetFirstData()||public double GetFirstData(bool unscaledTime, float animationDuration = 500f)|
-|GetLabelHeight()||public float GetLabelHeight()|
-|GetLabelWidth()||public float GetLabelWidth()|
-|GetLastData()||public double GetLastData()|
-|GetMaxData()||public double GetMaxData(bool inverse = false)
the maxinum value. |
-|GetMinData()||public double GetMinData(bool inverse = false)
the mininum value. |
-|GetMinMaxData()||public void GetMinMaxData(int startDimensionIndex, bool inverse, out double min, out double max)|
-|GetOrAddComponent<T>()||public T GetOrAddComponent<T>() where T : ChildComponent, ISerieDataComponent|
-|GetPreviousData()||public double GetPreviousData(int index, bool inverse = false)|
-|GetTotalData()||public double GetTotalData()|
-|IsDataChanged()||public bool IsDataChanged()|
-|IsInPolygon()||public bool IsInPolygon(Vector2 p)|
-|List<string>()||public static List<string> extraFieldList = new List<string>()
A data item of serie. |
-|OnAdd()||public void OnAdd(AnimationStyle animation, double startValue = 0)|
-|RemoveAllComponent()||public void RemoveAllComponent()|
-|RemoveComponent()||public void RemoveComponent(Type type)|
-|RemoveComponent<T>()||public void RemoveComponent<T>() where T : ISerieDataComponent|
-|Reset()||public void Reset()|
-|SetIconActive()||public void SetIconActive(bool flag)|
-|SetLabelActive()||public void SetLabelActive(bool flag)|
-|SetPolygon()||public void SetPolygon(params Vector2[] points)|
-|SetPolygon()||public void SetPolygon(Vector2 p1, Vector2 p2, Vector2 p3, Vector2 p4)|
-|SetPolygon()||public void SetPolygon(Vector2 p1, Vector2 p2, Vector2 p3, Vector2 p4, Vector2 p5)|
-|UpdateData()||public bool UpdateData(int dimension, double value)|
-|UpdateData()||public bool UpdateData(int dimension, double value, bool updateAnimation, bool unscaledTime, float animationDuration = 500f)|
+### SerieData.areaStyle
+
+public AreaStyle areaStyle
+
+### SerieData.blurStyle
+
+public BlurStyle blurStyle
+淡出状态的样式。
+
+### SerieData.data
+
+public List<double> data
+An arbitrary dimension data list of data item.
+
+### SerieData.emphasisStyle
+
+public EmphasisStyle emphasisStyle
+高亮状态的样式
+
+### SerieData.id
+
+public string id
+the id of data.
+
+### SerieData.index
+
+public override int index
+the index of SerieData.
+
+### SerieData.itemStyle
+
+public ItemStyle itemStyle
+单个数据项的样式设置。
+
+### SerieData.labelLine
+
+public LabelLine labelLine
+
+### SerieData.labelObject
+
+public ChartLabel labelObject
+
+### SerieData.labelStyle
+
+public LabelStyle labelStyle
+单个数据项的标签设置。
+
+### SerieData.legendName
+
+public string legendName
+数据项图例名称。当数据项名称不为空时,图例名称即为系列名称;反之则为索引index。
+
+### SerieData.lineStyle
+
+public LineStyle lineStyle
+
+### SerieData.name
+
+public string name
+the name of data item.
+
+### SerieData.parentId
+
+public string parentId
+the id of parent SerieData.
+
+### SerieData.radius
+
+public float radius
+自定义半径。可用在饼图中自定义某个数据项的半径。
+
+### SerieData.selected
+
+public bool selected
+Whether the data item is selected.
+
+### SerieData.selectStyle
+
+public SelectStyle selectStyle
+选中状态的样式。
+
+### SerieData.show
+
+public bool show
+[default:true] Whether the data item is showed.
+
+### SerieData.state
+
+public SerieState state
+the state of serie data.
+
+### SerieData.symbol
+
+public SerieSymbol symbol
+单个数据项的标记设置。
+
+### SerieData.titleObject
+
+public ChartLabel titleObject
+
+### SerieData.titleStyle
+
+public TitleStyle titleStyle
+
+### SerieData.ClearComponentDirty
+
+public override void ClearComponentDirty()
+
+### SerieData.ClearVerticesDirty
+
+public override void ClearVerticesDirty()
+
+### SerieData.EnsureComponent
+
+public ISerieDataComponent EnsureComponent(Type type)
+
+> Since `v3.6.0`
+
+Ensure the serie data has the component, if not, add it.
+
+### SerieData.EnsureComponent<T>
+
+public T EnsureComponent<T>() where T : ChildComponent, ISerieDataComponent
+
+> Since `v3.6.0`
+
+Ensure the serie data has the component, if not, add it.
+
+### SerieData.GetAddAnimationData
+
+public double GetAddAnimationData(double min, double max, float animationDuration = 500f, bool unscaledTime = false)
+
+### SerieData.GetComponent<T>
+
+public T GetComponent<T>() where T : ChildComponent, ISerieDataComponent
+Get the component of the serie data. return null if not exist.
+
+### SerieData.GetCurrData
+
+public double GetCurrData(int index, AnimationStyle animation, bool inverse, double min, double max, bool loop = false)
+
+public double GetCurrData(int index, float dataAddDuration = 500f, float animationDuration = 500f, bool unscaledTime = false, bool inverse = false)
+
+public double GetCurrData(int index, float dataAddDuration, float animationDuration, bool inverse, double min, double max, bool unscaledTime, bool loop = false)
+
+
+### SerieData.GetData
+
+public double GetData(int index, double min, double max)
+
+
+### SerieData.GetFirstData
+
+public double GetFirstData(bool unscaledTime, float animationDuration = 500f)
+
+### SerieData.GetLabelHeight
+
+public float GetLabelHeight()
+
+### SerieData.GetLabelWidth
+
+public float GetLabelWidth()
+
+### SerieData.GetLastData
+
+public double GetLastData()
+
+### SerieData.GetMaxData
+
+public double GetMaxData(bool inverse = false)
+the maxinum value.
+
+### SerieData.GetMinData
+
+public double GetMinData(bool inverse = false)
+the mininum value.
+
+### SerieData.GetMinMaxData
+
+public void GetMinMaxData(int startDimensionIndex, bool inverse, out double min, out double max)
+
+### SerieData.GetOrAddComponent<T>
+
+public T GetOrAddComponent<T>() where T : ChildComponent, ISerieDataComponent
+
+### SerieData.GetPreviousData
+
+public double GetPreviousData(int index, bool inverse = false)
+
+### SerieData.GetTotalData
+
+public double GetTotalData()
+
+### SerieData.IsDataChanged
+
+public bool IsDataChanged()
+
+### SerieData.IsInPolygon
+
+public bool IsInPolygon(Vector2 p)
+
+### SerieData.List<string>
+
+public static List<string> extraFieldList = new List<string>()
+A data item of serie.
+
+### SerieData.OnAdd
+
+public void OnAdd(AnimationStyle animation, double startValue = 0)
+
+### SerieData.RemoveAllComponent
+
+public void RemoveAllComponent()
+
+### SerieData.RemoveComponent
+
+public void RemoveComponent(Type type)
+
+### SerieData.RemoveComponent<T>
+
+public void RemoveComponent<T>() where T : ISerieDataComponent
+
+### SerieData.Reset
+
+public void Reset()
+
+### SerieData.SetIconActive
+
+public void SetIconActive(bool flag)
+
+### SerieData.SetLabelActive
+
+public void SetLabelActive(bool flag)
+
+### SerieData.SetPolygon
+
+public void SetPolygon(Vector2 p1, Vector2 p2, Vector2 p3, Vector2 p4)
+
+public void SetPolygon(Vector2 p1, Vector2 p2, Vector2 p3, Vector2 p4, Vector2 p5)
+
+
+### SerieData.UpdateData
+
+public bool UpdateData(int dimension, double value)
+
## SerieDataComponentAttribute
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
The attribute for serie data component.
-|public method|since|description|
-|--|--|--|
-|Contains()||public bool Contains(Type type)|
-|Contains<T>()||public bool Contains<T>() where T : ISerieComponent|
-|SerieDataComponentAttribute()||public SerieDataComponentAttribute()|
-|SerieDataComponentAttribute()||public SerieDataComponentAttribute(Type type1)|
-|SerieDataComponentAttribute()||public SerieDataComponentAttribute(Type type1, Type type2)|
-|SerieDataComponentAttribute()||public SerieDataComponentAttribute(Type type1, Type type2, Type type3)|
-|SerieDataComponentAttribute()||public SerieDataComponentAttribute(Type type1, Type type2, Type type3, Type type4)|
-|SerieDataComponentAttribute()||public SerieDataComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5)|
-|SerieDataComponentAttribute()||public SerieDataComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5, Type type6)|
-|SerieDataComponentAttribute()||public SerieDataComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5, Type type6, Type type7)|
+### SerieDataComponentAttribute.Contains
+
+public bool Contains(Type type)
+
+### SerieDataComponentAttribute.Contains<T>
+
+public bool Contains<T>() where T : ISerieComponent
+
+### SerieDataComponentAttribute.SerieDataComponentAttribute
+
+public SerieDataComponentAttribute(Type type1)
+
+public SerieDataComponentAttribute(Type type1, Type type2)
+
+public SerieDataComponentAttribute(Type type1, Type type2, Type type3)
+
+public SerieDataComponentAttribute(Type type1, Type type2, Type type3, Type type4)
+
+public SerieDataComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5)
+
+public SerieDataComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5, Type type6)
+
+public SerieDataComponentAttribute(Type type1, Type type2, Type type3, Type type4, Type type5, Type type6, Type type7)
+
## SerieDataContext
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### SerieDataContext.Reset
-|public method|since|description|
-|--|--|--|
-|Reset()||public void Reset()|
+public void Reset()
## SerieDataExtraFieldAttribute
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+### SerieDataExtraFieldAttribute.Contains
+
+public bool Contains(string field)
+
+### SerieDataExtraFieldAttribute.SerieDataExtraFieldAttribute
+
+public SerieDataExtraFieldAttribute(string field1)
+
+public SerieDataExtraFieldAttribute(string field1, string field2)
+
+public SerieDataExtraFieldAttribute(string field1, string field2, string field3)
+
+public SerieDataExtraFieldAttribute(string field1, string field2, string field3, string field4)
+
+public SerieDataExtraFieldAttribute(string field1, string field2, string field3, string field4, string field5)
+
+public SerieDataExtraFieldAttribute(string field1, string field2, string field3, string field4, string field5, string field6)
+
+public SerieDataExtraFieldAttribute(string field1, string field2, string field3, string field4, string field5, string field6, string field7)
-|public method|since|description|
-|--|--|--|
-|Contains()||public bool Contains(string field)|
-|SerieDataExtraFieldAttribute()||public SerieDataExtraFieldAttribute()|
-|SerieDataExtraFieldAttribute()||public SerieDataExtraFieldAttribute(string field1)|
-|SerieDataExtraFieldAttribute()||public SerieDataExtraFieldAttribute(string field1, string field2)|
-|SerieDataExtraFieldAttribute()||public SerieDataExtraFieldAttribute(string field1, string field2, string field3)|
-|SerieDataExtraFieldAttribute()||public SerieDataExtraFieldAttribute(string field1, string field2, string field3, string field4)|
-|SerieDataExtraFieldAttribute()||public SerieDataExtraFieldAttribute(string field1, string field2, string field3, string field4, string field5)|
-|SerieDataExtraFieldAttribute()||public SerieDataExtraFieldAttribute(string field1, string field2, string field3, string field4, string field5, string field6)|
-|SerieDataExtraFieldAttribute()||public SerieDataExtraFieldAttribute(string field1, string field2, string field3, string field4, string field5, string field6, string field7)|
## SerieDataLink
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.10.0`
the link of serie data. Used for sankey chart. Sankey chart only supports directed acyclic graph. make sure the data link is directed acyclic graph.
+## SerieDataSortType
+
+class in XCharts.Runtime
+
+the sort type of serie data.
+
+Options:
+
+- `None`: In the order of data.
+- `Ascending`: Sort data in ascending order.
+- `Descending`: Sort data in descending order.
+
## SerieEventData
-> class in XCharts.Runtime
+class in XCharts.Runtime
the data of serie event.
-|public method|since|description|
-|--|--|--|
-|Reset()||public void Reset()|
+### SerieEventData.dataIndex
+
+public int dataIndex
+the index of data in serie.data.
+
+### SerieEventData.dimension
+
+public int dimension
+the dimension of data.
+
+### SerieEventData.pointerPos
+
+public Vector3 pointerPos
+the position of pointer in chart.
+
+### SerieEventData.serieIndex
+
+public int serieIndex
+the index of serie in chart.series.
+
+### SerieEventData.value
+
+public double value
+the value of data.
+
+### SerieEventData.Reset
+
+public void Reset()
## SerieEventDataPool
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### SerieEventDataPool.Get
-|public method|since|description|
-|--|--|--|
-|Get()||public static SerieEventData Get(Vector3 pos, int serieIndex, int dataIndex, int dimension, double value)|
-|Release()||public static void Release(SerieEventData toRelease)|
+public static SerieEventData Get(Vector3 pos, int serieIndex, int dataIndex, int dimension, double value)
+
+### SerieEventDataPool.Release
+
+public static void Release(SerieEventData toRelease)
## SerieHandler
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### SerieHandler.AfterUpdate()
-|public method|since|description|
-|--|--|--|
-|AfterUpdate()||public virtual void AfterUpdate() { }|
-|BeforeUpdate()||public virtual void BeforeUpdate() { }|
-|CheckComponent()||public virtual void CheckComponent(StringBuilder sb) { }|
-|DrawBase()||public virtual void DrawBase(VertexHelper vh) { }|
-|DrawSerie()||public virtual void DrawSerie(VertexHelper vh) { }|
-|DrawTop()||public virtual void DrawTop(VertexHelper vh) { }|
-|DrawUpper()||public virtual void DrawUpper(VertexHelper vh) { }|
-|ForceUpdateSerieContext()||public virtual void ForceUpdateSerieContext() { }|
-|InitComponent()||public virtual void InitComponent() { }|
-|OnBeginDrag()||public virtual void OnBeginDrag(PointerEventData eventData) { }|
-|OnDataUpdate()||public virtual void OnDataUpdate() { }|
-|OnDrag()||public virtual void OnDrag(PointerEventData eventData) { }|
-|OnEndDrag()||public virtual void OnEndDrag(PointerEventData eventData) { }|
-|OnLegendButtonClick()||public virtual void OnLegendButtonClick(int index, string legendName, bool show) { }|
-|OnLegendButtonEnter()||public virtual void OnLegendButtonEnter(int index, string legendName) { }|
-|OnLegendButtonExit()||public virtual void OnLegendButtonExit(int index, string legendName) { }|
-|OnPointerClick()||public virtual void OnPointerClick(PointerEventData eventData) { }|
-|OnPointerDown()||public virtual void OnPointerDown(PointerEventData eventData) { }|
-|OnPointerEnter()||public virtual void OnPointerEnter(PointerEventData eventData) { }|
-|OnPointerExit()||public virtual void OnPointerExit(PointerEventData eventData) { }|
-|OnPointerUp()||public virtual void OnPointerUp(PointerEventData eventData) { }|
-|OnScroll()||public virtual void OnScroll(PointerEventData eventData) { }|
-|RefreshLabelInternal()||public virtual void RefreshLabelInternal() { }|
-|RefreshLabelNextFrame()||public virtual void RefreshLabelNextFrame() { }|
-|RemoveComponent()||public virtual void RemoveComponent() { }|
-|Update()||public virtual void Update() { }|
-|UpdateSerieContext()||public virtual void UpdateSerieContext() { }|
+public virtual void AfterUpdate()
+
+### SerieHandler.attribute
+
+public SerieHandlerAttribute attribute
+
+### SerieHandler.BeforeUpdate()
+
+public virtual void BeforeUpdate()
+
+### SerieHandler.chart
+
+public BaseChart chart
+
+### SerieHandler.defaultDimension
+
+public virtual int defaultDimension
+
+### SerieHandler.eventData)
+
+public virtual void OnBeginDrag(PointerEventData eventData)
+
+### SerieHandler.eventData)
+
+public virtual void OnDrag(PointerEventData eventData)
+
+### SerieHandler.eventData)
+
+public virtual void OnEndDrag(PointerEventData eventData)
+
+### SerieHandler.eventData)
+
+public virtual void OnPointerClick(PointerEventData eventData)
+
+### SerieHandler.eventData)
+
+public virtual void OnPointerDown(PointerEventData eventData)
+
+### SerieHandler.eventData)
+
+public virtual void OnPointerEnter(PointerEventData eventData)
+
+### SerieHandler.eventData)
+
+public virtual void OnPointerExit(PointerEventData eventData)
+
+### SerieHandler.eventData)
+
+public virtual void OnPointerUp(PointerEventData eventData)
+
+### SerieHandler.eventData)
+
+public virtual void OnScroll(PointerEventData eventData)
+
+### SerieHandler.ForceUpdateSerieContext()
+
+public virtual void ForceUpdateSerieContext()
+
+### SerieHandler.GetPointerItemDataDimension()
+
+public virtual int GetPointerItemDataDimension()
+
+### SerieHandler.GetPointerItemDataIndex()
+
+public virtual int GetPointerItemDataIndex()
+
+### SerieHandler.InitComponent()
+
+public virtual void InitComponent()
+
+### SerieHandler.inited
+
+public bool inited
+
+### SerieHandler.legendName)
+
+public virtual void OnLegendButtonEnter(int index, string legendName)
+
+### SerieHandler.legendName)
+
+public virtual void OnLegendButtonExit(int index, string legendName)
+
+### SerieHandler.OnDataUpdate()
+
+public virtual void OnDataUpdate()
+
+### SerieHandler.RefreshLabelInternal()
+
+public virtual void RefreshLabelInternal()
+
+### SerieHandler.RefreshLabelNextFrame()
+
+public virtual void RefreshLabelNextFrame()
+
+### SerieHandler.RemoveComponent()
+
+public virtual void RemoveComponent()
+
+### SerieHandler.sb)
+
+public virtual void CheckComponent(StringBuilder sb)
+
+### SerieHandler.show)
+
+public virtual void OnLegendButtonClick(int index, string legendName, bool show)
+
+### SerieHandler.Update()
+
+public virtual void Update()
+
+### SerieHandler.UpdateSerieContext()
+
+public virtual void UpdateSerieContext()
+
+### SerieHandler.vh)
+
+public virtual void DrawBase(VertexHelper vh)
+
+### SerieHandler.vh)
+
+public virtual void DrawSerie(VertexHelper vh)
+
+### SerieHandler.vh)
+
+public virtual void DrawTop(VertexHelper vh)
+
+### SerieHandler.vh)
+
+public virtual void DrawUpper(VertexHelper vh)
+
+### SerieHandler.AfterUpdate
+
+public virtual void AfterUpdate() { }
+
+### SerieHandler.BeforeUpdate
+
+public virtual void BeforeUpdate() { }
+
+### SerieHandler.CheckComponent
+
+public virtual void CheckComponent(StringBuilder sb) { }
+
+### SerieHandler.DrawBase
+
+public virtual void DrawBase(VertexHelper vh) { }
+
+### SerieHandler.DrawSerie
+
+public virtual void DrawSerie(VertexHelper vh) { }
+
+### SerieHandler.DrawTop
+
+public virtual void DrawTop(VertexHelper vh) { }
+
+### SerieHandler.DrawUpper
+
+public virtual void DrawUpper(VertexHelper vh) { }
+
+### SerieHandler.ForceUpdateSerieContext
+
+public virtual void ForceUpdateSerieContext() { }
+
+### SerieHandler.InitComponent
+
+public virtual void InitComponent() { }
+
+### SerieHandler.OnBeginDrag
+
+public virtual void OnBeginDrag(PointerEventData eventData) { }
+
+### SerieHandler.OnDataUpdate
+
+public virtual void OnDataUpdate() { }
+
+### SerieHandler.OnDrag
+
+public virtual void OnDrag(PointerEventData eventData) { }
+
+### SerieHandler.OnEndDrag
+
+public virtual void OnEndDrag(PointerEventData eventData) { }
+
+### SerieHandler.OnLegendButtonClick
+
+public virtual void OnLegendButtonClick(int index, string legendName, bool show) { }
+
+### SerieHandler.OnLegendButtonEnter
+
+public virtual void OnLegendButtonEnter(int index, string legendName) { }
+
+### SerieHandler.OnLegendButtonExit
+
+public virtual void OnLegendButtonExit(int index, string legendName) { }
+
+### SerieHandler.OnPointerClick
+
+public virtual void OnPointerClick(PointerEventData eventData) { }
+
+### SerieHandler.OnPointerDown
+
+public virtual void OnPointerDown(PointerEventData eventData) { }
+
+### SerieHandler.OnPointerEnter
+
+public virtual void OnPointerEnter(PointerEventData eventData) { }
+
+### SerieHandler.OnPointerExit
+
+public virtual void OnPointerExit(PointerEventData eventData) { }
+
+### SerieHandler.OnPointerUp
+
+public virtual void OnPointerUp(PointerEventData eventData) { }
+
+### SerieHandler.OnScroll
+
+public virtual void OnScroll(PointerEventData eventData) { }
+
+### SerieHandler.RefreshLabelInternal
+
+public virtual void RefreshLabelInternal() { }
+
+### SerieHandler.RefreshLabelNextFrame
+
+public virtual void RefreshLabelNextFrame() { }
+
+### SerieHandler.RemoveComponent
+
+public virtual void RemoveComponent() { }
+
+### SerieHandler.Update
+
+public virtual void Update() { }
+
+### SerieHandler.UpdateSerieContext
+
+public virtual void UpdateSerieContext() { }
## SerieHandler where T
-> class in / Subclasses: [SerieHandler<T>](#seriehandlert)
-
+class in / Subclasses: [SerieHandler<T>](#seriehandlert)
## SerieHandler<T>
-> class in XCharts.Runtime / Inherits from: [SerieHandler where T](#seriehandler where t),[Serie](#serie)
+class in XCharts.Runtime / Inherits from: [SerieHandler where T](#seriehandler where t),[Serie](#serie)
+### SerieHandler<T>.labelObject
-|public method|since|description|
-|--|--|--|
-|AfterUpdate()||public override void AfterUpdate()|
-|BeforeUpdate()||public override void BeforeUpdate()|
-|DrawLabelLineSymbol()||public void DrawLabelLineSymbol(VertexHelper vh, LabelLine labelLine, Vector3 startPos, Vector3 endPos, Color32 defaultColor)|
-|ForceUpdateSerieContext()||public override void ForceUpdateSerieContext()|
-|GetPointerItemDataDimension()||public override int GetPointerItemDataDimension()|
-|GetPointerItemDataIndex()||public override int GetPointerItemDataIndex()|
-|GetSerieDataAutoColor()||public virtual Color GetSerieDataAutoColor(SerieData serieData)|
-|GetSerieDataLabelOffset()||public virtual Vector3 GetSerieDataLabelOffset(SerieData serieData, LabelStyle label)|
-|GetSerieDataLabelPosition()||public virtual Vector3 GetSerieDataLabelPosition(SerieData serieData, LabelStyle label)|
-|GetSerieDataTitlePosition()||public virtual Vector3 GetSerieDataTitlePosition(SerieData serieData, TitleStyle titleStyle)|
-|InitComponent()||public override void InitComponent()|
-|OnLegendButtonClick()||public override void OnLegendButtonClick(int index, string legendName, bool show)|
-|OnLegendButtonEnter()||public override void OnLegendButtonEnter(int index, string legendName)|
-|OnLegendButtonExit()||public override void OnLegendButtonExit(int index, string legendName)|
-|OnPointerClick()||public override void OnPointerClick(PointerEventData eventData)|
-|OnPointerDown()||public override void OnPointerDown(PointerEventData eventData)|
-|RefreshEndLabelInternal()||public virtual void RefreshEndLabelInternal()|
-|RefreshLabelInternal()||public override void RefreshLabelInternal()|
-|RefreshLabelNextFrame()||public override void RefreshLabelNextFrame()|
-|RemoveComponent()||public override void RemoveComponent()|
-|Update()||public override void Update()|
+public GameObject labelObject
+
+### SerieHandler<T>.serie
+
+public T serie
+
+### SerieHandler<T>.AfterUpdate
+
+public override void AfterUpdate()
+
+### SerieHandler<T>.BeforeUpdate
+
+public override void BeforeUpdate()
+
+### SerieHandler<T>.DrawLabelLineSymbol
+
+public void DrawLabelLineSymbol(VertexHelper vh, LabelLine labelLine, Vector3 startPos, Vector3 endPos, Color32 defaultColor)
+
+### SerieHandler<T>.ForceUpdateSerieContext
+
+public override void ForceUpdateSerieContext()
+
+### SerieHandler<T>.GetPointerItemDataDimension
+
+public override int GetPointerItemDataDimension()
+
+### SerieHandler<T>.GetPointerItemDataIndex
+
+public override int GetPointerItemDataIndex()
+
+### SerieHandler<T>.GetSerieDataAutoColor
+
+public virtual Color GetSerieDataAutoColor(SerieData serieData)
+
+### SerieHandler<T>.GetSerieDataLabelOffset
+
+public virtual Vector3 GetSerieDataLabelOffset(SerieData serieData, LabelStyle label)
+
+### SerieHandler<T>.GetSerieDataLabelPosition
+
+public virtual Vector3 GetSerieDataLabelPosition(SerieData serieData, LabelStyle label)
+
+### SerieHandler<T>.GetSerieDataTitlePosition
+
+public virtual Vector3 GetSerieDataTitlePosition(SerieData serieData, TitleStyle titleStyle)
+
+### SerieHandler<T>.InitComponent
+
+public override void InitComponent()
+
+### SerieHandler<T>.OnLegendButtonClick
+
+public override void OnLegendButtonClick(int index, string legendName, bool show)
+
+### SerieHandler<T>.OnLegendButtonEnter
+
+public override void OnLegendButtonEnter(int index, string legendName)
+
+### SerieHandler<T>.OnLegendButtonExit
+
+public override void OnLegendButtonExit(int index, string legendName)
+
+### SerieHandler<T>.OnPointerClick
+
+public override void OnPointerClick(PointerEventData eventData)
+
+### SerieHandler<T>.OnPointerDown
+
+public override void OnPointerDown(PointerEventData eventData)
+
+### SerieHandler<T>.RefreshEndLabelInternal
+
+public virtual void RefreshEndLabelInternal()
+
+### SerieHandler<T>.RefreshLabelInternal
+
+public override void RefreshLabelInternal()
+
+### SerieHandler<T>.RefreshLabelNextFrame
+
+public override void RefreshLabelNextFrame()
+
+### SerieHandler<T>.RemoveComponent
+
+public override void RemoveComponent()
+
+### SerieHandler<T>.Update
+
+public override void Update()
## SerieHandlerAttribute
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+### SerieHandlerAttribute.SerieHandlerAttribute
+
+public SerieHandlerAttribute(Type handler, bool allowMultiple)
-|public method|since|description|
-|--|--|--|
-|SerieHandlerAttribute()||public SerieHandlerAttribute(Type handler)|
-|SerieHandlerAttribute()||public SerieHandlerAttribute(Type handler, bool allowMultiple)|
## SerieHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### SerieHelper.CloneSerie<T>
+
+public static T CloneSerie<T>(Serie serie) where T : Serie
+
+### SerieHelper.CopySerie
+
+public static void CopySerie(Serie oldSerie, Serie newSerie)
+
+### SerieHelper.GetAllMinMaxData
+
+public static void GetAllMinMaxData(Serie serie, double ceilRate = 0, DataZoom dataZoom = null)
+
+### SerieHelper.GetAreaStyle
+
+public static AreaStyle GetAreaStyle(Serie serie, SerieData serieData)
+
+### SerieHelper.GetAverageData
+
+public static double GetAverageData(Serie serie, int dimension = 1, DataZoom dataZoom = null)
+
+### SerieHelper.GetBlurStyle
+
+public static BlurStyle GetBlurStyle(Serie serie, SerieData serieData)
+
+### SerieHelper.GetEmphasisStyle
+
+public static EmphasisStyle GetEmphasisStyle(Serie serie, SerieData serieData)
+
+### SerieHelper.GetItemColor
+
+public static Color32 GetItemColor(Serie serie, SerieData serieData, ThemeStyle theme, int index, SerieState state = SerieState.Auto, bool opacity = true)
+
+### SerieHelper.GetItemFormatter
+
+public static string GetItemFormatter(Serie serie, SerieData serieData, string defaultFormatter = null)
+
+### SerieHelper.GetItemMarker
+
+public static string GetItemMarker(Serie serie, SerieData serieData, string defaultMarker = null)
+
+### SerieHelper.GetItemStyle
+
+public static ItemStyle GetItemStyle(Serie serie, SerieData serieData, SerieState state = SerieState.Auto)
+
+### SerieHelper.GetLineColor
+
+public static Color32 GetLineColor(Serie serie, SerieData serieData, ThemeStyle theme, int index, SerieState state = SerieState.Auto)
+
+### SerieHelper.GetLineStyle
+
+public static LineStyle GetLineStyle(Serie serie, SerieData serieData)
+
+### SerieHelper.GetMaxData
+
+public static double GetMaxData(Serie serie, int dimension = 1, DataZoom dataZoom = null)
+
+### SerieHelper.GetMaxSerieData
+
+public static SerieData GetMaxSerieData(Serie serie, int dimension = 1, DataZoom dataZoom = null)
+
+### SerieHelper.GetMedianData
+
+public static double GetMedianData(Serie serie, int dimension = 1, DataZoom dataZoom = null)
+
+### SerieHelper.GetMinData
+
+public static double GetMinData(Serie serie, int dimension = 1, DataZoom dataZoom = null)
+
+### SerieHelper.GetMinMaxData
+
+public static void GetMinMaxData(Serie serie, out double min, out double max, DataZoom dataZoom = null, int dimension = 0)
+Gets the maximum and minimum values of all data in the serie.
+
+### SerieHelper.GetMinSerieData
+
+public static SerieData GetMinSerieData(Serie serie, int dimension = 1, DataZoom dataZoom = null)
+
+### SerieHelper.GetNumericFormatter
+
+public static string GetNumericFormatter(Serie serie, SerieData serieData, string defaultFormatter = null)
+
+### SerieHelper.GetSelectStyle
+
+public static SelectStyle GetSelectStyle(Serie serie, SerieData serieData)
+
+### SerieHelper.GetSerieLabel
+
+public static LabelStyle GetSerieLabel(Serie serie, SerieData serieData, SerieState state = SerieState.Auto)
+
+### SerieHelper.GetSerieLabelLine
+
+public static LabelLine GetSerieLabelLine(Serie serie, SerieData serieData, SerieState state = SerieState.Auto)
+
+### SerieHelper.GetSerieState
+
+public static SerieState GetSerieState(Serie serie, SerieData serieData, bool defaultSerieState = false)
+
+public static SerieState GetSerieState(SerieData serieData)
-|public method|since|description|
-|--|--|--|
-|CloneSerie<T>()||public static T CloneSerie<T>(Serie serie) where T : Serie|
-|CopySerie()||public static void CopySerie(Serie oldSerie, Serie newSerie)|
-|GetAllMinMaxData()||public static void GetAllMinMaxData(Serie serie, double ceilRate = 0, DataZoom dataZoom = null)|
-|GetAreaStyle()||public static AreaStyle GetAreaStyle(Serie serie, SerieData serieData)|
-|GetAverageData()||public static double GetAverageData(Serie serie, int dimension = 1, DataZoom dataZoom = null)|
-|GetBlurStyle()||public static BlurStyle GetBlurStyle(Serie serie, SerieData serieData)|
-|GetEmphasisStyle()||public static EmphasisStyle GetEmphasisStyle(Serie serie, SerieData serieData)|
-|GetItemColor()||public static Color32 GetItemColor(Serie serie, SerieData serieData, ThemeStyle theme, int index, SerieState state = SerieState.Auto, bool opacity = true)|
-|GetItemFormatter()||public static string GetItemFormatter(Serie serie, SerieData serieData, string defaultFormatter = null)|
-|GetItemMarker()||public static string GetItemMarker(Serie serie, SerieData serieData, string defaultMarker = null)|
-|GetItemStyle()||public static ItemStyle GetItemStyle(Serie serie, SerieData serieData, SerieState state = SerieState.Auto)|
-|GetLineColor()||public static Color32 GetLineColor(Serie serie, SerieData serieData, ThemeStyle theme, int index, SerieState state = SerieState.Auto)|
-|GetLineStyle()||public static LineStyle GetLineStyle(Serie serie, SerieData serieData)|
-|GetMaxData()||public static double GetMaxData(Serie serie, int dimension = 1, DataZoom dataZoom = null)|
-|GetMaxSerieData()||public static SerieData GetMaxSerieData(Serie serie, int dimension = 1, DataZoom dataZoom = null)|
-|GetMedianData()||public static double GetMedianData(Serie serie, int dimension = 1, DataZoom dataZoom = null)|
-|GetMinData()||public static double GetMinData(Serie serie, int dimension = 1, DataZoom dataZoom = null)|
-|GetMinMaxData()||public static void GetMinMaxData(Serie serie, out double min, out double max, DataZoom dataZoom = null, int dimension = 0)
Gets the maximum and minimum values of all data in the serie. |
-|GetMinSerieData()||public static SerieData GetMinSerieData(Serie serie, int dimension = 1, DataZoom dataZoom = null)|
-|GetNumericFormatter()||public static string GetNumericFormatter(Serie serie, SerieData serieData, string defaultFormatter = null)|
-|GetSelectStyle()||public static SelectStyle GetSelectStyle(Serie serie, SerieData serieData)|
-|GetSerieLabel()||public static LabelStyle GetSerieLabel(Serie serie, SerieData serieData, SerieState state = SerieState.Auto)|
-|GetSerieLabelLine()||public static LabelLine GetSerieLabelLine(Serie serie, SerieData serieData, SerieState state = SerieState.Auto)|
-|GetSerieState()||public static SerieState GetSerieState(Serie serie)|
-|GetSerieState()||public static SerieState GetSerieState(Serie serie, SerieData serieData, bool defaultSerieState = false)|
-|GetSerieState()||public static SerieState GetSerieState(SerieData serieData)|
-|GetSerieSymbol()||public static SerieSymbol GetSerieSymbol(Serie serie, SerieData serieData, SerieState state = SerieState.Auto)|
-|GetStateStyle()||public static StateStyle GetStateStyle(Serie serie, SerieData serieData, SerieState state)|
-|GetSysmbolSize()||public static float GetSysmbolSize(Serie serie, SerieData serieData, float defaultSize, SerieState state = SerieState.Auto, bool checkAnimation = false)|
-|GetTitleStyle()||public static TitleStyle GetTitleStyle(Serie serie, SerieData serieData)|
-|IsAllZeroValue()||public static bool IsAllZeroValue(Serie serie, int dimension = 1)
Whether the data for the specified dimension of serie are all 0. |
-|IsDownPoint()||public static bool IsDownPoint(Serie serie, int index)|
-|UpdateCenter()||public static void UpdateCenter(Serie serie, BaseChart chart)
更新运行时中心点和半径 |
-|UpdateFilterData()||public static void UpdateFilterData(Serie serie, DataZoom dataZoom)
根据dataZoom更新数据列表缓存 |
-|UpdateMinMaxData()||public static void UpdateMinMaxData(Serie serie, int dimension, double ceilRate = 0, DataZoom dataZoom = null)
获得指定维数的最大最小值 |
-|UpdateRect()||public static void UpdateRect(Serie serie, Vector3 chartPosition, float chartWidth, float chartHeight)|
-|UpdateSerieRuntimeFilterData()||public static void UpdateSerieRuntimeFilterData(Serie serie, bool filterInvisible = true)|
+### SerieHelper.GetSerieSymbol
+
+public static SerieSymbol GetSerieSymbol(Serie serie, SerieData serieData, SerieState state = SerieState.Auto)
+
+### SerieHelper.GetStateStyle
+
+public static StateStyle GetStateStyle(Serie serie, SerieData serieData, SerieState state)
+
+### SerieHelper.GetSysmbolSize
+
+public static float GetSysmbolSize(Serie serie, SerieData serieData, float defaultSize, SerieState state = SerieState.Auto, bool checkAnimation = false)
+
+### SerieHelper.GetTitleStyle
+
+public static TitleStyle GetTitleStyle(Serie serie, SerieData serieData)
+
+### SerieHelper.IsAllZeroValue
+
+public static bool IsAllZeroValue(Serie serie, int dimension = 1)
+Whether the data for the specified dimension of serie are all 0.
+
+### SerieHelper.IsDownPoint
+
+public static bool IsDownPoint(Serie serie, int index)
+
+### SerieHelper.UpdateCenter
+
+public static void UpdateCenter(Serie serie, BaseChart chart)
+更新运行时中心点和半径
+
+### SerieHelper.UpdateFilterData
+
+public static void UpdateFilterData(Serie serie, DataZoom dataZoom)
+根据dataZoom更新数据列表缓存
+
+### SerieHelper.UpdateMinMaxData
+
+public static void UpdateMinMaxData(Serie serie, int dimension, double ceilRate = 0, DataZoom dataZoom = null)
+获得指定维数的最大最小值
+
+### SerieHelper.UpdateRect
+
+public static void UpdateRect(Serie serie, Vector3 chartPosition, float chartWidth, float chartHeight)
+
+### SerieHelper.UpdateSerieRuntimeFilterData
+
+public static void UpdateSerieRuntimeFilterData(Serie serie, bool filterInvisible = true)
## SerieLabelHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### SerieLabelHelper.CanShowLabel
-|public method|since|description|
-|--|--|--|
-|CanShowLabel()||public static bool CanShowLabel(Serie serie, SerieData serieData, LabelStyle label, int dimesion)|
-|GetLabelColor()||public static Color GetLabelColor(Serie serie, ThemeStyle theme, int index)|
-|SetGaugeLabelText()||public static void SetGaugeLabelText(Serie serie)|
+public static bool CanShowLabel(Serie serie, SerieData serieData, LabelStyle label, int dimesion)
+
+### SerieLabelHelper.GetLabelColor
+
+public static Color GetLabelColor(Serie serie, ThemeStyle theme, int index)
+
+### SerieLabelHelper.SetGaugeLabelText
+
+public static void SetGaugeLabelText(Serie serie)
## SerieLabelPool
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### SerieLabelPool.ClearAll
-|public method|since|description|
-|--|--|--|
-|ClearAll()||public static void ClearAll()|
-|Release()||public static void Release(GameObject element)|
-|ReleaseAll()||public static void ReleaseAll(Transform parent)|
+public static void ClearAll()
+
+### SerieLabelPool.Release
+
+public static void Release(GameObject element)
+
+### SerieLabelPool.ReleaseAll
+
+public static void ReleaseAll(Transform parent)
## SerieParams
-> class in XCharts.Runtime
-
+class in XCharts.Runtime
## SeriesHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### SeriesHelper.GetLastStackSerie
+
+public static Serie GetLastStackSerie(List<Serie> series, Serie serie)
+获得上一个同堆叠且显示的serie。
+
+### SeriesHelper.GetLegalSerieNameList
+
+public static List<string> GetLegalSerieNameList(List<Serie> series)
+
+### SeriesHelper.GetMaxSerieDataCount
+
+public static int GetMaxSerieDataCount(List<Serie> series)
+
+### SeriesHelper.GetMinAnimationDuration
+
+public static float GetMinAnimationDuration(List<Serie> series)
+
+### SeriesHelper.GetNameColor
+
+public static Color GetNameColor(BaseChart chart, int index, string name)
+
+### SeriesHelper.GetStackSeries
+
+public static void GetStackSeries(List<Serie> series, ref Dictionary<int, List<Serie>> stackSeries)
+获得堆叠系列列表
+
+### SeriesHelper.IsAnyClipSerie
+
+public static bool IsAnyClipSerie(List<Serie> series)
+是否有需裁剪的serie。
+
+### SeriesHelper.IsAnyColorByDataSerie
+
+public static bool IsAnyColorByDataSerie(List<Serie> series)
+check if series has any serie which is color by data.
+
+### SeriesHelper.IsLegalLegendName
+
+public static bool IsLegalLegendName(string name)
+
+### SeriesHelper.IsPercentStack<T>
+
+public static bool IsPercentStack<T>(List<Serie> series, string stackName) where T : Serie
+是否时百分比堆叠
-|public method|since|description|
-|--|--|--|
-|GetLastStackSerie()||public static Serie GetLastStackSerie(List<Serie> series, Serie serie)
获得上一个同堆叠且显示的serie。 |
-|GetLegalSerieNameList()||public static List<string> GetLegalSerieNameList(List<Serie> series)|
-|GetMaxSerieDataCount()||public static int GetMaxSerieDataCount(List<Serie> series)|
-|GetMinAnimationDuration()||public static float GetMinAnimationDuration(List<Serie> series)|
-|GetNameColor()||public static Color GetNameColor(BaseChart chart, int index, string name)|
-|GetStackSeries()||public static void GetStackSeries(List<Serie> series, ref Dictionary<int, List<Serie>> stackSeries)
获得堆叠系列列表 |
-|IsAnyClipSerie()||public static bool IsAnyClipSerie(List<Serie> series)
是否有需裁剪的serie。 |
-|IsLegalLegendName()||public static bool IsLegalLegendName(string name)|
-|IsPercentStack<T>()||public static bool IsPercentStack<T>(List<Serie> series) where T : Serie
是否时百分比堆叠 |
-|IsPercentStack<T>()||public static bool IsPercentStack<T>(List<Serie> series, string stackName) where T : Serie
是否时百分比堆叠 |
-|IsStack()||public static bool IsStack(List<Serie> series)
是否由数据堆叠 |
-|IsStack<T>()||public static bool IsStack<T>(List<Serie> series, string stackName) where T : Serie
是否堆叠 |
-|UpdateSerieNameList()||public static void UpdateSerieNameList(BaseChart chart, ref List<string> serieNameList)
获得所有系列名,不包含空名字。 |
-|UpdateStackDataList()||public static void UpdateStackDataList(List<Serie> series, Serie currSerie, DataZoom dataZoom, List<List<SerieData>> dataList)|
+### SeriesHelper.IsStack
+
+public static bool IsStack(List<Serie> series)
+是否由数据堆叠
+
+### SeriesHelper.IsStack<T>
+
+public static bool IsStack<T>(List<Serie> series, string stackName) where T : Serie
+是否堆叠
+
+### SeriesHelper.UpdateSerieNameList
+
+public static void UpdateSerieNameList(BaseChart chart, ref List<string> serieNameList)
+获得所有系列名,不包含空名字。
+
+### SeriesHelper.UpdateStackDataList
+
+public static void UpdateStackDataList(List<Serie> series, Serie currSerie, DataZoom dataZoom, List<List<SerieData>> dataList)
+
+## SerieState
+
+class in XCharts.Runtime
+
+Serie state. Supports normal, emphasis, blur, and select states.
+
+Options:
+
+- `Normal`: Normal state.
+- `Emphasis`: Emphasis state.
+- `Blur`: Blur state.
+- `Select`: Select state.
+- `Auto`: Auto state.
## SerieSymbol
-> class in XCharts.Runtime / Inherits from: [SymbolStyle](#symbolstyle),[ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [SymbolStyle](#symbolstyle),[ISerieDataComponent](#iseriedatacomponent)
系列数据项的标记的图形
-|public method|since|description|
-|--|--|--|
-|GetSize()||public float GetSize(List<double> data, float themeSize)
根据指定的sizeType获得标记的大小 |
-|Reset()||public override void Reset()|
-|ShowSymbol()||public bool ShowSymbol(int dataIndex, int dataCount)|
+### SerieSymbol.GetSize
+
+public float GetSize(List<double> data, float themeSize)
+根据指定的sizeType获得标记的大小
+
+### SerieSymbol.Reset
+
+public override void Reset()
+
+### SerieSymbol.ShowSymbol
+
+public bool ShowSymbol(int dataIndex, int dataCount)
## SerieTheme
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+### SerieTheme.Copy
-|public method|since|description|
-|--|--|--|
-|Copy()||public void Copy(SerieTheme theme)|
-|SerieTheme()||public SerieTheme(ThemeType theme)|
+public void Copy(SerieTheme theme)
+
+### SerieTheme.SerieTheme
+
+public SerieTheme(ThemeType theme)
## Settings
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
Global parameter setting component. The default value can be used in general, and can be adjusted when necessary.
-|public method|since|description|
-|--|--|--|
-|Copy()||public void Copy(Settings settings)|
-|Reset()||public override void Reset()|
+### Settings.show
+
+public bool show
+
+### Settings.Copy
+
+public void Copy(Settings settings)
+
+### Settings.Reset
+
+public override void Reset()
## SimplifiedBar
-> class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie)
+class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie)
+### SimplifiedBar.containerIndex
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
-|ConvertSerie()||public static SimplifiedBar ConvertSerie(Serie serie)|
+public int containerIndex
+
+### SimplifiedBar.containterInstanceId
+
+public int containterInstanceId
+
+### SimplifiedBar.AddDefaultSerie
+
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
+
+### SimplifiedBar.ConvertSerie
+
+public static SimplifiedBar ConvertSerie(Serie serie)
## SimplifiedBarChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
A simplified bar chart is a simplified mode of a bar chart that provides better performance by simplifying components and configurations.
## SimplifiedCandlestick
-> class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie)
+class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie)
+### SimplifiedCandlestick.containerIndex
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
-|ConvertSerie()||public static SimplifiedCandlestick ConvertSerie(Serie serie)|
+public int containerIndex
+
+### SimplifiedCandlestick.containterInstanceId
+
+public int containterInstanceId
+
+### SimplifiedCandlestick.AddDefaultSerie
+
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
+
+### SimplifiedCandlestick.ConvertSerie
+
+public static SimplifiedCandlestick ConvertSerie(Serie serie)
## SimplifiedCandlestickChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
A simplified candlestick chart is a simplified mode of a bar chart that provides better performance by simplifying components and configurations.
## SimplifiedLine
-> class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie)
+class in XCharts.Runtime / Inherits from: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie)
+### SimplifiedLine.containerIndex
-|public method|since|description|
-|--|--|--|
-|AddDefaultSerie()||public static Serie AddDefaultSerie(BaseChart chart, string serieName)|
-|ConvertSerie()||public static SimplifiedLine ConvertSerie(Serie serie)|
+public int containerIndex
+
+### SimplifiedLine.containterInstanceId
+
+public int containterInstanceId
+
+### SimplifiedLine.AddDefaultSerie
+
+public static Serie AddDefaultSerie(BaseChart chart, string serieName)
+
+### SimplifiedLine.ConvertSerie
+
+public static SimplifiedLine ConvertSerie(Serie serie)
## SimplifiedLineChart
-> class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
+class in XCharts.Runtime / Inherits from: [BaseChart](#basechart)
A simplified line chart is a simplified mode of a bar chart that provides better performance by simplifying components and configurations.
## Since
-> class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+class in XCharts.Runtime / Inherits from: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute)
+### Since.Since
-|public method|since|description|
-|--|--|--|
-|Since()||public Since(string version)|
+public Since(string version)
## SingleAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis),[IUpdateRuntimeData](#iupdateruntimedata)
+class in XCharts.Runtime / Inherits from: [Axis](#axis),[IUpdateRuntimeData](#iupdateruntimedata)
Single axis.
-|public method|since|description|
-|--|--|--|
-|SetDefaultValue()||public override void SetDefaultValue()|
-|UpdateRuntimeData()||public void UpdateRuntimeData(BaseChart chart)|
+### SingleAxis.SetDefaultValue
+
+public override void SetDefaultValue()
+
+### SingleAxis.UpdateRuntimeData
+
+public void UpdateRuntimeData(BaseChart chart)
## SingleAxisCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem)
-
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem)
## StageColor
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+### StageColor.color
-|public method|since|description|
-|--|--|--|
-|StageColor()||public StageColor(float percent, Color32 color)|
+public Color32 color
+颜色。
+
+### StageColor.percent
+
+public float percent
+结束位置百分比。
+
+### StageColor.StageColor
+
+public StageColor(float percent, Color32 color)
## StateStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [BlurStyle](#blurstyle),[EmphasisStyle](#emphasisstyle),[SelectStyle](#selectstyle)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [BlurStyle](#blurstyle),[EmphasisStyle](#emphasisstyle),[SelectStyle](#selectstyle)
> Since `v3.2.0`
the state style of serie.
-|public method|since|description|
-|--|--|--|
-|ClearComponentDirty()||public override void ClearComponentDirty()|
-|ClearVerticesDirty()||public override void ClearVerticesDirty()|
-|Reset()||public void Reset()|
+### StateStyle.ClearComponentDirty
+
+public override void ClearComponentDirty()
+
+### StateStyle.ClearVerticesDirty
+
+public override void ClearVerticesDirty()
+
+### StateStyle.Reset
+
+public void Reset()
## SubTitleTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+### SubTitleTheme.SubTitleTheme
-|public method|since|description|
-|--|--|--|
-|SubTitleTheme()||public SubTitleTheme(ThemeType theme) : base(theme)|
+public SubTitleTheme(ThemeType theme) : base(theme)
## SVG
-> class in XUGL
+class in XUGL
+
+### SVG.DrawPath
+
+public static void DrawPath(VertexHelper vh, SVGPath path)
-|public method|since|description|
-|--|--|--|
-|DrawPath()||public static void DrawPath(VertexHelper vh, string path)|
-|DrawPath()||public static void DrawPath(VertexHelper vh, SVGPath path)|
-|Test()||public static void Test(VertexHelper vh)|
+### SVG.Test
+
+public static void Test(VertexHelper vh)
## SVGPath
-> class in XUGL
+class in XUGL
+### SVGPath.AddSegment
-|public method|since|description|
-|--|--|--|
-|AddSegment()||public void AddSegment(SVGPathSeg seg)|
-|Draw()||public void Draw(VertexHelper vh)|
-|Parse()||public static SVGPath Parse(string path)|
+public void AddSegment(SVGPathSeg seg)
+
+### SVGPath.Draw
+
+public void Draw(VertexHelper vh)
+
+### SVGPath.Parse
+
+public static SVGPath Parse(string path)
## SVGPathSeg
-> class in XUGL
+class in XUGL
+### SVGPathSeg.p1
-|public method|since|description|
-|--|--|--|
-|SVGPathSeg()||public SVGPathSeg(SVGPathSegType type)|
+public Vector2 p1
+
+### SVGPathSeg.p2
+
+public Vector2 p2
+
+### SVGPathSeg.p3
+
+public Vector2 p3
+
+### SVGPathSeg.x
+
+public float x
+
+### SVGPathSeg.y
+
+public float y
+
+### SVGPathSeg.SVGPathSeg
+
+public SVGPathSeg(SVGPathSegType type)
+
+## SVGPathSegType
+
+class in XUGL
+
+Options:
+
+- `M`: move to
+- `L`: line to
+- `H`: horizontal line to
+- `V`: vertial line to
+- `C`: curve to
+- `S`: smooth curve to
+- `Q`: quadratic bezier curve
+- `T`: smooth quadratic bezier curve to
+- `A`: elliptical Arc
+- `Z`: close path
+
+## SymbolSizeType
+
+class in XCharts.Runtime
+
+The way to get serie symbol size.
+
+Options:
+
+- `Custom`: Specify constant for symbol size.
+- `FromData`: Specify the dataIndex and dataScale to calculate symbol size.
+- `Function`: Specify function for symbol size.
## SymbolStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [SerieSymbol](#seriesymbol)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [SerieSymbol](#seriesymbol)
系列数据项的标记的图形
-|public method|since|description|
-|--|--|--|
-|GetColor()||public Color32 GetColor(Color32 defaultColor)|
-|Reset()||public virtual void Reset()|
+### SymbolStyle.animationSize
+
+public List<float> animationSize
+the setting for effect scatter.
+
+### SymbolStyle.offset3
+
+public Vector3 offset3
+
+### SymbolStyle.GetColor
+
+public Color32 GetColor(Color32 defaultColor)
+
+### SymbolStyle.Reset
+
+public virtual void Reset()
+
+## SymbolType
+
+class in XCharts.Runtime
+
+the type of symbol.
+
+Options:
+
+- `None`: 不显示标记。
+- `Custom`: 自定义标记。
+- `Circle`: 圆形。
+- `EmptyCircle`: 空心圆。
+- `Rect`: 正方形。可通过设置`itemStyle`的`cornerRadius`变成圆角矩形。
+- `EmptyRect`: 空心正方形。
+- `Triangle`: 三角形。
+- `EmptyTriangle`: 空心三角形。
+- `Diamond`: 菱形。
+- `EmptyDiamond`: 空心菱形。
+- `Arrow`: 箭头。
+- `EmptyArrow`: 空心箭头。
+- `Plus`: 加号。
+- `Minus`: 减号。
## TextLimit
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
Text character limitation and adaptation component. When the length of the text exceeds the set length, it is cropped and suffixes are appended to the end.Only valid in the category axis.
-|public method|since|description|
-|--|--|--|
-|Clone()||public TextLimit Clone()|
-|Copy()||public void Copy(TextLimit textLimit)|
-|GetLimitContent()||public string GetLimitContent(string content)|
-|SetRelatedText()||public void SetRelatedText(ChartText txt, float labelWidth)|
+### TextLimit.Clone
+
+public TextLimit Clone()
+
+### TextLimit.Copy
+
+public void Copy(TextLimit textLimit)
+
+### TextLimit.GetLimitContent
+
+public string GetLimitContent(string content)
+
+### TextLimit.SetRelatedText
+
+public void SetRelatedText(ChartText txt, float labelWidth)
## TextPadding
-> class in XCharts.Runtime / Inherits from: [Padding](#padding)
+class in XCharts.Runtime / Inherits from: [Padding](#padding)
Settings related to text.
-|public method|since|description|
-|--|--|--|
-|TextPadding()||public TextPadding() { }|
-|TextPadding()||public TextPadding(float top, float right, float bottom, float left)|
+### TextPadding.TextPadding()
+
+public TextPadding()
+Settings related to text.
+
+### TextPadding.TextPadding
+
+public TextPadding(float top, float right, float bottom, float left)
+
## TextStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
Settings related to text.
-|public method|since|description|
-|--|--|--|
-|Copy()||public void Copy(TextStyle textStyle)|
-|GetAlignment()||public TextAnchor GetAlignment(TextAnchor defaultAlignment)|
-|GetColor()||public Color GetColor(Color defaultColor)|
-|GetFontSize()||public int GetFontSize(ComponentTheme defaultTheme)|
-|TextStyle()||public TextStyle() { }|
-|TextStyle()||public TextStyle(int fontSize)|
-|TextStyle()||public TextStyle(int fontSize, FontStyle fontStyle)|
-|TextStyle()||public TextStyle(int fontSize, FontStyle fontStyle, Color color)|
-|TextStyle()||public TextStyle(int fontSize, FontStyle fontStyle, Color color, int rorate)|
-|UpdateAlignmentByLocation()||public void UpdateAlignmentByLocation(Location location)|
+### TextStyle.TextStyle()
+
+public TextStyle()
+
+### TextStyle.Copy
+
+public void Copy(TextStyle textStyle)
+
+### TextStyle.GetAlignment
+
+public TextAnchor GetAlignment(TextAnchor defaultAlignment)
+
+### TextStyle.GetColor
+
+public Color GetColor(Color defaultColor)
+
+### TextStyle.GetFontSize
+
+public int GetFontSize(ComponentTheme defaultTheme)
+
+### TextStyle.TextStyle
+
+public TextStyle(int fontSize)
+
+public TextStyle(int fontSize, FontStyle fontStyle)
+
+public TextStyle(int fontSize, FontStyle fontStyle, Color color)
+
+public TextStyle(int fontSize, FontStyle fontStyle, Color color, int rorate)
+
+
+### TextStyle.UpdateAlignmentByLocation
+
+public void UpdateAlignmentByLocation(Location location)
## Theme
-> class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=scriptableobject)
+class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=scriptableobject)
Theme.
-|public method|since|description|
-|--|--|--|
-|CheckWarning()||public void CheckWarning(StringBuilder sb)|
-|CloneTheme()||public Theme CloneTheme()
克隆主题。 |
-|CopyTheme()||public bool CopyTheme(ThemeType theme)|
-|CopyTheme()||public void CopyTheme(Theme theme)
copy all configurations from theme. |
-|GetColor()||public Color32 GetColor(int index)
Gets the color of the specified index from the palette. |
-|GetColor()||public static Color32 GetColor(string hexColorStr)
Convert the html string to color. |
-|GetColorStr()||public string GetColorStr(int index)
Gets the hexadecimal color string of the specified index from the palette. |
-|GetHashCode()||public override int GetHashCode()|
-|ResetTheme()||public bool ResetTheme()
Clear all custom configurations. |
-|ResetToDarkTheme()||public static void ResetToDarkTheme(Theme theme)
dark theme. |
-|ResetToDefaultTheme()||public static void ResetToDefaultTheme(Theme theme)
default theme. |
-|SetColorPalette()||public void SetColorPalette(List<string> hexColorStringList)|
-|SetDefaultFont()||public void SetDefaultFont()|
-|SyncFontToSubComponent()||public void SyncFontToSubComponent()|
-|SyncTMPFontToSubComponent()||public void SyncTMPFontToSubComponent()|
+### Theme.axis
+
+public AxisTheme axis
+
+### Theme.colorPalette
+
+public List<Color32> colorPalette
+The color list of palette. If no color is set in series, the colors would be adopted sequentially and circularly from this list as the colors of series.
+
+### Theme.common
+
+public ComponentTheme common
+
+### Theme.dataZoom
+
+public DataZoomTheme dataZoom
+
+### Theme.legend
+
+public LegendTheme legend
+
+### Theme.serie
+
+public SerieTheme serie
+
+### Theme.subTitle
+
+public SubTitleTheme subTitle
+
+### Theme.title
+
+public TitleTheme title
+
+### Theme.tooltip
+
+public TooltipTheme tooltip
+
+### Theme.visualMap
+
+public VisualMapTheme visualMap
+
+### Theme.CheckWarning
+
+public void CheckWarning(StringBuilder sb)
+
+### Theme.CloneTheme
+
+public Theme CloneTheme()
+克隆主题。
+
+### Theme.CopyTheme
+
+public void CopyTheme(Theme theme)
+copy all configurations from theme.
+
+
+### Theme.GetColor
+
+public static Color32 GetColor(string hexColorStr)
+Convert the html string to color.
+
+
+### Theme.GetColorStr
+
+public string GetColorStr(int index)
+Gets the hexadecimal color string of the specified index from the palette.
+
+### Theme.GetHashCode
+
+public override int GetHashCode()
+
+### Theme.ResetTheme
+
+public bool ResetTheme()
+Clear all custom configurations.
+
+### Theme.ResetToDarkTheme
+
+public static void ResetToDarkTheme(Theme theme)
+dark theme.
+
+### Theme.ResetToDefaultTheme
+
+public static void ResetToDefaultTheme(Theme theme)
+default theme.
+
+### Theme.SetColorPalette
+
+public void SetColorPalette(List<string> hexColorStringList)
+
+### Theme.SetDefaultFont
+
+public void SetDefaultFont()
+
+### Theme.SyncFontToSubComponent
+
+public void SyncFontToSubComponent()
+
+### Theme.SyncTMPFontToSubComponent
+
+public void SyncTMPFontToSubComponent()
## ThemeStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
Theme.
-|public method|since|description|
-|--|--|--|
-|CheckWarning()||public void CheckWarning(StringBuilder sb)|
-|GetBackgroundColor()||public Color32 GetBackgroundColor(Background background)|
-|GetColor()||public Color32 GetColor(int index)
Gets the color of the specified index from the palette. |
-|GetColor()||public static Color32 GetColor(string hexColorStr)
Convert the html string to color. |
-|GetColorStr()||public string GetColorStr(int index)
Gets the hexadecimal color string of the specified index from the palette. |
-|SyncSharedThemeColorToCustom()||public void SyncSharedThemeColorToCustom()|
+### ThemeStyle.axis
+
+public AxisTheme axis
+
+### ThemeStyle.common
+
+public ComponentTheme common
+
+### ThemeStyle.customColorPalette
+
+public List<Color32> customColorPalette
+
+### ThemeStyle.dataZoom
+
+public DataZoomTheme dataZoom
+
+### ThemeStyle.legend
+
+public LegendTheme legend
+
+### ThemeStyle.serie
+
+public SerieTheme serie
+
+### ThemeStyle.show
+
+public bool show
+
+### ThemeStyle.subTitle
+
+public SubTitleTheme subTitle
+
+### ThemeStyle.title
+
+public TitleTheme title
+
+### ThemeStyle.tooltip
+
+public TooltipTheme tooltip
+
+### ThemeStyle.visualMap
+
+public VisualMapTheme visualMap
+
+### ThemeStyle.CheckWarning
+
+public void CheckWarning(StringBuilder sb)
+
+### ThemeStyle.GetBackgroundColor
+
+public Color32 GetBackgroundColor(Background background)
+
+### ThemeStyle.GetColor
+
+public static Color32 GetColor(string hexColorStr)
+Convert the html string to color.
+
+
+### ThemeStyle.GetColorStr
+
+public string GetColorStr(int index)
+Gets the hexadecimal color string of the specified index from the palette.
+
+### ThemeStyle.SyncSharedThemeColorToCustom
+
+public void SyncSharedThemeColorToCustom()
+
+## ThemeType
+
+class in XCharts.Runtime
+
+主题
+
+Options:
+
+- `Default`: 默认主题。
+- `Light`: 亮主题。
+- `Dark`: 暗主题。
+- `Custom`: 自定义主题。
## Title
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged)
Title component, including main title and subtitle.
-|public method|since|description|
-|--|--|--|
-|ClearComponentDirty()||public override void ClearComponentDirty()|
-|OnChanged()||public void OnChanged()|
+### Title.show
+
+public bool show
+[default:true] Set this to false to prevent the title from showing.
+
+### Title.text
+
+public string text
+The main title text, supporting \n for newlines.
+
+### Title.vertsDirty
+
+public override bool vertsDirty
+
+### Title.ClearComponentDirty
+
+public override void ClearComponentDirty()
+
+### Title.OnChanged
+
+public void OnChanged()
## TitleStyle
-> class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle),[ISerieDataComponent](#iseriedatacomponent),[ISerieComponent](#iseriecomponent)
+class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle),[ISerieDataComponent](#iseriedatacomponent),[ISerieComponent](#iseriecomponent)
the title of serie.
## TitleTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+### TitleTheme.TitleTheme
-|public method|since|description|
-|--|--|--|
-|TitleTheme()||public TitleTheme(ThemeType theme) : base(theme)|
+public TitleTheme(ThemeType theme) : base(theme)
## Tooltip
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
Tooltip component.
-|public method|since|description|
-|--|--|--|
-|onClickIndex||public System.Action<int> onClickIndex
the callback of tooltip click index. |
-|AddSerieDataIndex()||public void AddSerieDataIndex(int serieIndex, int dataIndex)|
-|ClearComponentDirty()||public override void ClearComponentDirty()|
-|ClearData()||public override void ClearData()|
-|ClearSerieDataIndex()||public void ClearSerieDataIndex()|
-|GetContentLabelStyle()||public LabelStyle GetContentLabelStyle(int index)|
-|IsActive()||public bool IsActive()
提示框是否显示 |
-|isAnySerieDataIndex()||public bool isAnySerieDataIndex()|
-|IsSelected()||public bool IsSelected()
当前提示框是否选中数据项 |
-|IsSelected()||public bool IsSelected(int index)
指定索引的数据项是否被提示框选中 |
-|IsTriggerAxis()||public bool IsTriggerAxis()|
-|IsTriggerItem()||public bool IsTriggerItem()|
-|KeepTop()||public void KeepTop()
Keep Tooltiop displayed at the top. |
-|SetActive()||public void SetActive(bool flag)
设置Tooltip组件是否显示 |
-|SetContentActive()||public void SetContentActive(bool flag)
设置文本框是否显示 |
-|UpdateContentPos()||public void UpdateContentPos(Vector2 pos, float width, float height)
更新文本框位置 |
+### Tooltip.alwayShowContent
+
+public bool alwayShowContent
+Whether to trigger after always display.
+
+### Tooltip.backgroundColor
+
+public Color backgroundColor
+The background color of tooltip.
+
+### Tooltip.backgroundImage
+
+public Sprite backgroundImage
+The background image of tooltip.
+
+### Tooltip.backgroundType
+
+public Image.Type backgroundType
+The background type of tooltip.
+
+### Tooltip.fixedHeight
+
+public float fixedHeight
+Fixed height. Higher priority than minHeight.
+
+### Tooltip.fixedWidth
+
+public float fixedWidth
+Fixed width. Higher priority than minWidth.
+
+### Tooltip.ignoreDataDefaultContent
+
+public string ignoreDataDefaultContent
+The default display character information for ignored data.
+
+### Tooltip.ignoreDataShow
+
+public bool ignoreDataShow
+Whether to show ignored data on tooltip.
+
+### Tooltip.itemFormatter
+
+public string itemFormatter
+a string template formatter for a single Serie or data item content. Support for wrapping lines with \n. Template variables are {.}, {a}, {b}, {c}, {d}.
{.} is the dot of the corresponding color of a Serie that is currently indicated or whose index is 0.
{a} is the series name of the serie that is currently indicated or whose index is 0.
{b} is the name of the data item serieData that is currently indicated or whose index is 0, or a category value (such as the X-axis of a line chart).
{c} is the value of a Y-dimension (dimesion is 1) from a Serie that is currently indicated or whose index is 0.
{d} is the percentage value of Y-dimensions (dimesion is 1) from serie that is currently indicated or whose index is 0, with no % sign.
{e} is the name of the data item serieData that is currently indicated or whose index is 0.
{f} is sum of data.
{y} is category value of y axis.
{.1} represents a dot from serie corresponding color that specifies index as 1.
1 in {a1}, {b1}, {c1} represents a serie that specifies an index of 1.
{c1:2} represents the third data from serie's current indication data item indexed to 1 (a data item has multiple data, index 2 represents the third data).
{c1:2-2} represents the third data item from serie's third data item indexed to 1 (i.e., which data item must be specified to specify).
{d1:2: F2} indicates that a formatted string with a value specified separately is F2 (numericFormatter is used when numericFormatter is not specified).
{d:0.##} indicates that a formatted string with a value specified separately is 0.## (used for percentage, reserved 2 valid digits while avoiding the situation similar to "100.00%" when using f2 ).
Example: "{a}, {c}", "{a1}, {c1: f1}", "{a1}, {c1:0: f1}", "{a1} : {c1:1-1: f1}"
+
+### Tooltip.marker
+
+public string marker
+the marker of serie.
+
+### Tooltip.minHeight
+
+public float minHeight
+Minimum height. If fixedHeight has a value, take priority over fixedHeight.
+
+### Tooltip.minWidth
+
+public float minWidth
+Minimum width. If fixedWidth has a value, get fixedWidth first.
+
+### Tooltip.offset
+
+public Vector2 offset
+The position offset of tooltip relative to the mouse position.
+
+### Tooltip.onClickIndex
+
+public System.Action<int> onClickIndex
+the callback of tooltip click index.
+
+### Tooltip.paddingLeftRight
+
+public int paddingLeftRight
+the text padding of left and right. defaut:5.
+
+### Tooltip.paddingTopBottom
+
+public int paddingTopBottom
+the text padding of top and bottom. defaut:5.
+
+### Tooltip.runtimeDataIndex
+
+public List<int> runtimeDataIndex
+The data index currently indicated by Tooltip.
+
+### Tooltip.showContent
+
+public bool showContent
+Whether to show the tooltip floating layer, whose default value is true. It should be configurated to be false, if you only need tooltip to trigger the event or show the axisPointer without content.
+
+### Tooltip.titleFormatter
+
+public string titleFormatter
+String template formatter for tooltip title content. \n line wrapping is supported. The placeholder {i} can be set separately to indicate that title is ignored and not displayed. Template variables are {.}, {a}, {b}, {c}, {d}, {e}, {f}, and {g}.
{.} is the dot of the corresponding color of serie currently indicated or index 0.
{a} is the series name name of serie currently indicated or index 0.
{b} is the name of the serie data item serieData currently indicated or index 0, or the category value (such as the X-axis of a line chart).
{c} is the value of the serie y-dimension (dimesion is 1) currently indicated or index is 0.
{d} is the serie y-dimensional (dimesion 1) percentage value of the currently indicated or index 0, note without the % sign.
{e} is the name of the serie data item serieData currently indicated or whose index is 0.
{h} is the hexadecimal color value of serieData for the serie data item currently indicated or index 0.
{f} is the sum of data.
{g} indicates the total number of data.
{y} is category value of y axis.
{.1} represents a dot of the corresponding color with serie specified as index 1.
The 1 in {a1}, {b1}, {c1} represents serie where index is specified as 1.
{c1:2} represents the third data of the current indicator data item in serie with index 1 (one data item has multiple data, index 2 represents the third data).
{c1:2-2} represents the third data of serie third data item with index 1 (that is, the number of data items must be specified when specifying the number of data items).
{d1:2:f2} indicates that a format string with a single value is f2 (numericFormatter is used if no value is specified).
{d:0.##} indicates that the format string with a value specified alone is 0.## # (for percentages, preserving a 2-digit significant number while avoiding the "100.00%" situation with f2).
example: "{a}, {c}", "{a1}, {c1: f1}", "{a1}, {c1:0: f1}", "{a1}, {c1:1-1: f1}"
+
+### Tooltip.AddSerieDataIndex
+
+public void AddSerieDataIndex(int serieIndex, int dataIndex)
+
+### Tooltip.ClearComponentDirty
+
+public override void ClearComponentDirty()
+
+### Tooltip.ClearData
+
+public override void ClearData()
+
+### Tooltip.ClearSerieDataIndex
+
+public void ClearSerieDataIndex()
+
+### Tooltip.GetContentLabelStyle
+
+public LabelStyle GetContentLabelStyle(int index)
+
+### Tooltip.IsActive
+
+public bool IsActive()
+提示框是否显示
+
+### Tooltip.isAnySerieDataIndex
+
+public bool isAnySerieDataIndex()
+
+### Tooltip.IsSelected
+
+public bool IsSelected(int index)
+指定索引的数据项是否被提示框选中
+
+
+### Tooltip.IsTriggerAxis
+
+public bool IsTriggerAxis()
+
+### Tooltip.IsTriggerItem
+
+public bool IsTriggerItem()
+
+### Tooltip.KeepTop
+
+public void KeepTop()
+Keep Tooltiop displayed at the top.
+
+### Tooltip.SetActive
+
+public void SetActive(bool flag)
+设置Tooltip组件是否显示
+
+### Tooltip.SetContentActive
+
+public void SetContentActive(bool flag)
+设置文本框是否显示
+
+### Tooltip.UpdateContentPos
+
+public void UpdateContentPos(Vector2 pos, float width, float height)
+更新文本框位置
+
+## Tooltip.Position
+
+class in XCharts.Runtime
+
+Position type.
+
+Options:
+
+- `Auto`: Auto. The mobile platform is displayed at the top, and the non-mobile platform follows the mouse position.
+- `Custom`: Custom. Fully customize display position (x,y).
+- `FixedX`: Just fix the coordinate X. Y follows the mouse position.
+- `FixedY`:
+
+## Tooltip.Trigger
+
+class in XCharts.Runtime
+
+Trigger strategy.
+
+Options:
+
+- `Item`: Triggered by data item, which is mainly used for charts that don't have a category axis like scatter charts or pie charts.
+- `Axis`: Triggered by axes, which is mainly used for charts that have category axes, like bar charts or line charts.
+- `None`: Trigger nothing.
+- `Auto`: Auto select trigger according to serie type.
+
+## Tooltip.TriggerOn
+
+class in XCharts.Runtime
+
+the condition of trigger tooltip.
+
+Options:
+
+- `MouseMove`: Trigger when mouse move.
+- `Click`: Trigger when mouse click.
+
+## Tooltip.Type
+
+class in XCharts.Runtime
+
+Indicator type.
+
+Options:
+
+- `Line`: line indicator.
+- `Shadow`: shadow crosshair indicator.
+- `None`: no indicator displayed.
+- `Cross`: crosshair indicator, which is actually the shortcut of enable two axisPointers of two orthometric axes.
+- `Auto`: Auto select indicator according to serie type.
## TooltipContext
-> class in XCharts.Runtime
-
+class in XCharts.Runtime
## TooltipData
-> class in XCharts.Runtime
-
+class in XCharts.Runtime
## TooltipHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### TooltipHelper.GetItemNumericFormatter
-|public method|since|description|
-|--|--|--|
-|GetItemNumericFormatter()||public static string GetItemNumericFormatter(Tooltip tooltip, Serie serie, SerieData serieData)|
-|GetLineColor()||public static Color32 GetLineColor(Tooltip tooltip, Color32 defaultColor)|
-|IsIgnoreFormatter()||public static bool IsIgnoreFormatter(string itemFormatter)|
-|LimitInRect()||public static void LimitInRect(Tooltip tooltip, Rect chartRect)|
+public static string GetItemNumericFormatter(Tooltip tooltip, Serie serie, SerieData serieData)
+
+### TooltipHelper.GetLineColor
+
+public static Color32 GetLineColor(Tooltip tooltip, Color32 defaultColor)
+
+### TooltipHelper.IsIgnoreFormatter
+
+public static bool IsIgnoreFormatter(string itemFormatter)
+
+### TooltipHelper.LimitInRect
+
+public static void LimitInRect(Tooltip tooltip, Rect chartRect)
## TooltipTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+### TooltipTheme.Copy
-|public method|since|description|
-|--|--|--|
-|Copy()||public void Copy(TooltipTheme theme)|
-|TooltipTheme()||public TooltipTheme(ThemeType theme) : base(theme)|
+public void Copy(TooltipTheme theme)
+
+### TooltipTheme.TooltipTheme
+
+public TooltipTheme(ThemeType theme) : base(theme)
## TooltipView
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### TooltipView.CreateView
-|public method|since|description|
-|--|--|--|
-|CreateView()||public static TooltipView CreateView(Tooltip tooltip, ThemeStyle theme, Transform parent)|
-|GetCurrentPos()||public Vector3 GetCurrentPos()|
-|GetTargetPos()||public Vector3 GetTargetPos()|
-|Refresh()||public void Refresh()|
-|SetActive()||public void SetActive(bool flag)|
-|Update()||public void Update()|
-|UpdatePosition()||public void UpdatePosition(Vector3 pos)|
+public static TooltipView CreateView(Tooltip tooltip, ThemeStyle theme, Transform parent)
+
+### TooltipView.GetCurrentPos
+
+public Vector3 GetCurrentPos()
+
+### TooltipView.GetTargetPos
+
+public Vector3 GetTargetPos()
+
+### TooltipView.Refresh
+
+public void Refresh()
+
+### TooltipView.SetActive
+
+public void SetActive(bool flag)
+
+### TooltipView.Update
+
+public void Update()
+
+### TooltipView.UpdatePosition
+
+public void UpdatePosition(Vector3 pos)
## TooltipViewItem
-> class in XCharts.Runtime
-
+class in XCharts.Runtime
## UGL
-> class in XUGL
+class in XUGL
UGUI Graphics Library.
-|public method|since|description|
-|--|--|--|
-|DrawDiamond()||public static void DrawDiamond(VertexHelper vh, Vector3 center, float size, Color32 color)
Draw a diamond. 画菱形(钻石形状) |
-|DrawDiamond()||public static void DrawDiamond(VertexHelper vh, Vector3 center, float size, Color32 color, Color32 toColor)
Draw a diamond. 画菱形(钻石形状) |
-|DrawDiamond()||public static void DrawDiamond(VertexHelper vh, Vector3 center, float xRadius, float yRadius, Color32 color, Color32 toColor)|
-|DrawEllipse()||public static void DrawEllipse(VertexHelper vh, Vector3 center, float w, float h, Color32 color, float smoothness = 1)|
-|DrawEmptyDiamond()||public static void DrawEmptyDiamond(VertexHelper vh, Vector3 center, float xRadius, float yRadius, float tickness, Color32 color)|
-|DrawEmptyDiamond()||public static void DrawEmptyDiamond(VertexHelper vh, Vector3 center, float xRadius, float yRadius, float tickness, Color32 color, Color32 emptyColor)|
-|DrawEmptyTriangle()||public static void DrawEmptyTriangle(VertexHelper vh, Vector3 pos, float size, float tickness, Color32 color)|
-|DrawEmptyTriangle()||public static void DrawEmptyTriangle(VertexHelper vh, Vector3 pos, float size, float tickness, Color32 color, Color32 backgroundColor)|
-|DrawLine()||public static void DrawLine(VertexHelper vh, List<Vector3> points, float width, Color32 color, bool smooth, bool closepath = false)|
-|DrawLine()||public static void DrawLine(VertexHelper vh, Vector3 startPoint, Vector3 endPoint, float width, Color32 color)
Draw a line. 画直线 |
-|DrawLine()||public static void DrawLine(VertexHelper vh, Vector3 startPoint, Vector3 endPoint, float width, Color32 color, Color32 toColor)
Draw a line. 画直线 |
-|DrawMinus()||public static void DrawMinus(VertexHelper vh, Vector3 center, float radius, float tickness, Color32 color)
Draw minus sign. |
-|DrawPlus()||public static void DrawPlus(VertexHelper vh, Vector3 center, float radius, float tickness, Color32 color)
Draw plus sign. |
-|DrawPolygon()||public static void DrawPolygon(VertexHelper vh, List<Vector3> points, Color32 color)
填充任意多边形(目前只支持凸多边形) |
-|DrawRectangle()||public static void DrawRectangle(VertexHelper vh, Rect rect, Color32 color)|
-|DrawRectangle()||public static void DrawRectangle(VertexHelper vh, Rect rect, Color32 color, Color32 toColor)|
-|DrawRectangle()||public static void DrawRectangle(VertexHelper vh, Rect rect, float border, Color32 color)|
-|DrawRectangle()||public static void DrawRectangle(VertexHelper vh, Rect rect, float border, Color32 color, Color32 toColor)|
-|DrawRectangle()||public static void DrawRectangle(VertexHelper vh, Vector3 p1, Vector3 p2, float radius, Color32 color)
Draw a rectangle. 画带长方形 |
-|DrawSquare()||public static void DrawSquare(VertexHelper vh, Vector3 center, float radius, Color32 color)
Draw a square. 画正方形 |
-|DrawSvgPath()||public static void DrawSvgPath(VertexHelper vh, string path)|
-|DrawTriangle()||public static void DrawTriangle(VertexHelper vh, Vector3 pos, float size, Color32 color)|
-|DrawTriangle()||public static void DrawTriangle(VertexHelper vh, Vector3 pos, float size, Color32 color, Color32 toColor)|
+### UGL.DrawDiamond
+
+public static void DrawDiamond(VertexHelper vh, Vector3 center, float size, Color32 color, Color32 toColor)
+Draw a diamond. 画菱形(钻石形状)
+
+public static void DrawDiamond(VertexHelper vh, Vector3 center, float xRadius, float yRadius, Color32 color, Color32 toColor)
+
+
+### UGL.DrawEllipse
+
+public static void DrawEllipse(VertexHelper vh, Vector3 center, float w, float h, Color32 color, float smoothness = 1)
+
+### UGL.DrawEmptyDiamond
+
+public static void DrawEmptyDiamond(VertexHelper vh, Vector3 center, float xRadius, float yRadius, float tickness, Color32 color, Color32 emptyColor)
+
+
+### UGL.DrawEmptyTriangle
+
+public static void DrawEmptyTriangle(VertexHelper vh, Vector3 pos, float size, float tickness, Color32 color, Color32 backgroundColor)
+
+
+### UGL.DrawLine
+
+public static void DrawLine(VertexHelper vh, List<Vector3> points, float width, Color32 color, bool smooth, bool closepath = false)
+
+public static void DrawLine(VertexHelper vh, Vector3 startPoint, Vector3 endPoint, float width, Color32 color, Color32 toColor)
+Draw a line. 画直线
+
+
+### UGL.DrawMinus
+
+public static void DrawMinus(VertexHelper vh, Vector3 center, float radius, float tickness, Color32 color)
+Draw minus sign.
+
+### UGL.DrawPlus
+
+public static void DrawPlus(VertexHelper vh, Vector3 center, float radius, float tickness, Color32 color)
+Draw plus sign.
+
+### UGL.DrawPolygon
+
+public static void DrawPolygon(VertexHelper vh, List<Vector3> points, Color32 color)
+填充任意多边形(目前只支持凸多边形)
+
+### UGL.DrawRectangle
+
+public static void DrawRectangle(VertexHelper vh, Rect rect, Color32 color)
+
+public static void DrawRectangle(VertexHelper vh, Rect rect, Color32 color, Color32 toColor)
+
+public static void DrawRectangle(VertexHelper vh, Rect rect, float border, Color32 color)
+
+public static void DrawRectangle(VertexHelper vh, Rect rect, float border, Color32 color, Color32 toColor)
+
+
+### UGL.DrawSquare
+
+public static void DrawSquare(VertexHelper vh, Vector3 center, float radius, Color32 color)
+Draw a square. 画正方形
+
+### UGL.DrawSvgPath
+
+public static void DrawSvgPath(VertexHelper vh, string path)
+
+### UGL.DrawTriangle
+
+public static void DrawTriangle(VertexHelper vh, Vector3 pos, float size, Color32 color, Color32 toColor)
+
+
+## UGL.Direction
+
+class in XUGL
+
+曲线方向
+
+Options:
+
+- `XAxis`: 沿X轴方向
+- `YAxis`: 沿Y轴方向
+- `Random`: 随机无序的。如一个闭合的环状曲线。
## UGLExample
-> class in XUGL / Inherits from: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=maskablegraphic)
-
+class in XUGL / Inherits from: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=maskablegraphic)
## UGLHelper
-> class in XUGL
+class in XUGL
+
+### UGLHelper.GetAngle360
+
+public static float GetAngle360(Vector2 from, Vector2 to)
+获得0-360的角度(12点钟方向为0度)
+
+### UGLHelper.GetBezier
+
+public static Vector3 GetBezier(float t, Vector3 sp, Vector3 cp, Vector3 ep)
+
+### UGLHelper.GetBezier2
+
+public static Vector3 GetBezier2(float t, Vector3 sp, Vector3 p1, Vector3 p2, Vector3 ep)
+
+### UGLHelper.GetBezierList
+
+public static List<Vector3> GetBezierList(Vector3 sp, Vector3 ep, int segment, Vector3 cp)
+
+### UGLHelper.GetDire
+
+public static Vector3 GetDire(float angle, bool isDegree = false)
+
+### UGLHelper.GetIntersection
+
+public static bool GetIntersection(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4, ref List<Vector3> intersection)
+获得两直线的交点
-|public method|since|description|
-|--|--|--|
-|GetAngle360()||public static float GetAngle360(Vector2 from, Vector2 to)
获得0-360的角度(12点钟方向为0度) |
-|GetBezier()||public static Vector3 GetBezier(float t, Vector3 sp, Vector3 cp, Vector3 ep)|
-|GetBezier2()||public static Vector3 GetBezier2(float t, Vector3 sp, Vector3 p1, Vector3 p2, Vector3 ep)|
-|GetBezierList()||public static List<Vector3> GetBezierList(Vector3 sp, Vector3 ep, int segment, Vector3 cp)|
-|GetDire()||public static Vector3 GetDire(float angle, bool isDegree = false)|
-|GetIntersection()||public static bool GetIntersection(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4, ref List<Vector3> intersection)
获得两直线的交点 |
-|GetIntersection()||public static bool GetIntersection(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4, ref Vector3 intersection)
获得两直线的交点 |
-|GetPos()||public static Vector3 GetPos(Vector3 center, float radius, float angle, bool isDegree = false)|
-|GetVertialDire()||public static Vector3 GetVertialDire(Vector3 dire)|
-|IsClearColor()||public static bool IsClearColor(Color color)|
-|IsClearColor()||public static bool IsClearColor(Color32 color)|
-|IsPointInPolygon()||public static bool IsPointInPolygon(Vector3 p, List<Vector2> polyons)|
-|IsPointInPolygon()||public static bool IsPointInPolygon(Vector3 p, List<Vector3> polyons)|
-|IsPointInPolygon()||public static bool IsPointInPolygon(Vector3 p, params Vector3[] polyons)|
-|IsPointInTriangle()||public static bool IsPointInTriangle(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 check)|
-|IsValueEqualsColor()||public static bool IsValueEqualsColor(Color color1, Color color2)|
-|IsValueEqualsColor()||public static bool IsValueEqualsColor(Color32 color1, Color32 color2)|
-|IsValueEqualsList<T>()||public static bool IsValueEqualsList<T>(List<T> list1, List<T> list2)|
-|IsValueEqualsString()||public static bool IsValueEqualsString(string str1, string str2)|
-|IsValueEqualsVector2()||public static bool IsValueEqualsVector2(Vector2 v1, Vector2 v2)|
-|IsValueEqualsVector3()||public static bool IsValueEqualsVector3(Vector3 v1, Vector2 v2)|
-|IsValueEqualsVector3()||public static bool IsValueEqualsVector3(Vector3 v1, Vector3 v2)|
-|IsZeroVector()||public static bool IsZeroVector(Vector3 pos)|
-|RotateRound()||public static Vector3 RotateRound(Vector3 position, Vector3 center, Vector3 axis, float angle)|
+### UGLHelper.GetPos
+
+public static Vector3 GetPos(Vector3 center, float radius, float angle, bool isDegree = false)
+
+### UGLHelper.GetVertialDire
+
+public static Vector3 GetVertialDire(Vector3 dire)
+
+### UGLHelper.IsClearColor
+
+public static bool IsClearColor(Color color)
+
+
+### UGLHelper.IsPointInPolygon
+
+public static bool IsPointInPolygon(Vector3 p, List<Vector2> polyons)
+
+public static bool IsPointInPolygon(Vector3 p, params Vector3[] polyons)
+
+
+### UGLHelper.IsPointInTriangle
+
+public static bool IsPointInTriangle(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 check)
+
+### UGLHelper.IsValueEqualsColor
+
+public static bool IsValueEqualsColor(Color color1, Color color2)
+
+
+### UGLHelper.IsValueEqualsList<T>
+
+public static bool IsValueEqualsList<T>(List<T> list1, List<T> list2)
+
+### UGLHelper.IsValueEqualsString
+
+public static bool IsValueEqualsString(string str1, string str2)
+
+### UGLHelper.IsValueEqualsVector2
+
+public static bool IsValueEqualsVector2(Vector2 v1, Vector2 v2)
+
+### UGLHelper.IsValueEqualsVector3
+
+public static bool IsValueEqualsVector3(Vector3 v1, Vector2 v2)
+
+
+### UGLHelper.IsZeroVector
+
+public static bool IsZeroVector(Vector3 pos)
+
+### UGLHelper.RotateRound
+
+public static Vector3 RotateRound(Vector3 position, Vector3 center, Vector3 axis, float angle)
## UIComponent
-> class in XCharts.Runtime / Inherits from: [BaseGraph](#basegraph)
+class in XCharts.Runtime / Inherits from: [BaseGraph](#basegraph)
UI组件基类。
-|public method|since|description|
-|--|--|--|
-|SetAllDirty()||public override void SetAllDirty()|
-|SetDataDirty()|v3.9.0|public void SetDataDirty()|
-|SetVerticesDirty()||public override void SetVerticesDirty()|
-|UpdateTheme()||public bool UpdateTheme(ThemeType theme)
Update chart theme. |
+### UIComponent.background
+
+public Background background
+背景样式。
+
+### UIComponent.chartHideFlags
+
+public override HideFlags chartHideFlags
+
+### UIComponent.theme
+
+public UIComponentTheme theme
+
+### UIComponent.SetAllDirty
+
+public override void SetAllDirty()
+
+### UIComponent.SetDataDirty
+
+public void SetDataDirty()
+
+> Since `v3.9.0`
+
+
+### UIComponent.SetVerticesDirty
+
+public override void SetVerticesDirty()
+
+### UIComponent.UpdateTheme
+
+public bool UpdateTheme(ThemeType theme)
+Update chart theme.
## UIComponentTheme
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+### UIComponentTheme.show
-|public method|since|description|
-|--|--|--|
-|GetBackgroundColor()||public Color32 GetBackgroundColor(Background background)|
+public bool show
+
+### UIComponentTheme.GetBackgroundColor
+
+public Color32 GetBackgroundColor(Background background)
## UIHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
UI帮助类。
## ViewControl
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.11.0`
@@ -3348,218 +9098,620 @@ View control component in 3D coordinate system.
## VisualMap
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
VisualMap component. Mapping data to visual elements such as colors.
-|public method|since|description|
-|--|--|--|
-|AddColors()||public void AddColors(List<Color32> colors)|
-|AddColors()||public void AddColors(List<string> colors)|
-|ClearComponentDirty()||public override void ClearComponentDirty()|
-|ClearVerticesDirty()||public override void ClearVerticesDirty()|
-|GetColor()||public Color32 GetColor(double value)|
-|GetColor()||public Color32 GetColor(double xValue, double yValue, double zValue, byte alpha = 255)|
-|GetIndex()||public int GetIndex(double value)|
-|GetValue()||public double GetValue(Vector3 pos, Rect chartRect)|
-|IsInRangeMaxRect()||public bool IsInRangeMaxRect(Vector3 local, Rect chartRect, float triangleLen)|
-|IsInRangeMinRect()||public bool IsInRangeMinRect(Vector3 local, Rect chartRect, float triangleLen)|
-|IsInRangeRect()||public bool IsInRangeRect(Vector3 local, Rect chartRect)|
-|IsInRect()||public bool IsInRect(Vector3 local, Rect chartRect, float triangleLen = 20)|
-|IsInSelectedValue()||public bool IsInSelectedValue(double value)|
-|IsPiecewise()||public bool IsPiecewise()|
+### VisualMap.range
+
+public double[] range
+Specifies the position of the numeric value corresponding to the handle. Range should be within the range of [min,max].
+
+### VisualMap.runtimeRangeMaxHeight
+
+public float runtimeRangeMaxHeight
+
+### VisualMap.runtimeRangeMinHeight
+
+public float runtimeRangeMinHeight
+
+### VisualMap.text
+
+public string[] text
+Text on both ends.
+
+### VisualMap.textGap
+
+public float[] textGap
+The distance between the two text bodies.
+
+### VisualMap.vertsDirty
+
+public override bool vertsDirty
+
+### VisualMap.AddColors
+
+public void AddColors(List<string> colors)
+
+
+### VisualMap.ClearComponentDirty
+
+public override void ClearComponentDirty()
+
+### VisualMap.ClearVerticesDirty
+
+public override void ClearVerticesDirty()
+
+### VisualMap.GetColor
+
+public Color32 GetColor(double value)
+
+
+### VisualMap.GetIndex
+
+public int GetIndex(double value)
+
+### VisualMap.GetValue
+
+public double GetValue(Vector3 pos, Rect chartRect)
+
+### VisualMap.IsInRangeMaxRect
+
+public bool IsInRangeMaxRect(Vector3 local, Rect chartRect, float triangleLen)
+
+### VisualMap.IsInRangeMinRect
+
+public bool IsInRangeMinRect(Vector3 local, Rect chartRect, float triangleLen)
+
+### VisualMap.IsInRangeRect
+
+public bool IsInRangeRect(Vector3 local, Rect chartRect)
+
+### VisualMap.IsInRect
+
+public bool IsInRect(Vector3 local, Rect chartRect, float triangleLen = 20)
+
+### VisualMap.IsInSelectedValue
+
+public bool IsInSelectedValue(double value)
+
+### VisualMap.IsPiecewise
+
+public bool IsPiecewise()
+
+## VisualMap.SelectedMode
+
+class in XCharts.Runtime
+
+选择模式
+
+Options:
+
+- `Multiple`: 多选。
+- `Single`: 单选。
+
+## VisualMap.Type
+
+class in XCharts.Runtime
+
+类型。分为连续型和分段型。
+
+Options:
+
+- `Continuous`: 连续型。
+- `Piecewise`: 分段型。
## VisualMapContext
-> class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
+class in XCharts.Runtime / Inherits from: [MainComponentContext](#maincomponentcontext)
+### VisualMapContext.max
+
+public double max
+
+### VisualMapContext.maxDrag
+
+public bool maxDrag
+
+### VisualMapContext.min
+
+public double min
+
+### VisualMapContext.minDrag
+
+public bool minDrag
+
+### VisualMapContext.pointerIndex
+
+public int pointerIndex
+鼠标悬停选中的index
+
+### VisualMapContext.pointerValue
+
+public double pointerValue
## VisualMapHelper
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### VisualMapHelper.AutoSetLineMinMax
-|public method|since|description|
-|--|--|--|
-|AutoSetLineMinMax()||public static void AutoSetLineMinMax(VisualMap visualMap, Serie serie, bool isY, Axis axis, Axis relativedAxis)|
-|GetDimension()||public static int GetDimension(VisualMap visualMap, int defaultDimension)|
-|IsNeedAreaGradient()||public static bool IsNeedAreaGradient(VisualMap visualMap)|
-|IsNeedGradient()||public static bool IsNeedGradient(VisualMap visualMap)|
-|IsNeedLineGradient()||public static bool IsNeedLineGradient(VisualMap visualMap)|
-|SetMinMax()||public static void SetMinMax(VisualMap visualMap, double min, double max)|
+public static void AutoSetLineMinMax(VisualMap visualMap, Serie serie, bool isY, Axis axis, Axis relativedAxis)
+
+### VisualMapHelper.GetDimension
+
+public static int GetDimension(VisualMap visualMap, int defaultDimension)
+
+### VisualMapHelper.IsNeedAreaGradient
+
+public static bool IsNeedAreaGradient(VisualMap visualMap)
+
+### VisualMapHelper.IsNeedGradient
+
+public static bool IsNeedGradient(VisualMap visualMap)
+
+### VisualMapHelper.IsNeedLineGradient
+
+public static bool IsNeedLineGradient(VisualMap visualMap)
+
+### VisualMapHelper.SetMinMax
+
+public static void SetMinMax(VisualMap visualMap, double min, double max)
## VisualMapRange
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+### VisualMapRange.color
-|public method|since|description|
-|--|--|--|
-|Contains()||public bool Contains(double value, double minMaxRange)|
+public Color32 color
+颜色
+
+### VisualMapRange.label
+
+public string label
+文字描述
+
+### VisualMapRange.max
+
+public double max
+范围最大值
+
+### VisualMapRange.min
+
+public double min
+范围最小值
+
+### VisualMapRange.Contains
+
+public bool Contains(double value, double minMaxRange)
## VisualMapTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+### VisualMapTheme.Copy
-|public method|since|description|
-|--|--|--|
-|Copy()||public void Copy(VisualMapTheme theme)|
-|VisualMapTheme()||public VisualMapTheme(ThemeType theme) : base(theme)|
+public void Copy(VisualMapTheme theme)
+
+### VisualMapTheme.VisualMapTheme
+
+public VisualMapTheme(ThemeType theme) : base(theme)
## Wrapper<T>
-> class in XCharts.Runtime
-
+class in XCharts.Runtime
## XAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
The x axis in cartesian(rectangular) coordinate.
-|public method|since|description|
-|--|--|--|
-|SetDefaultValue()||public override void SetDefaultValue()
The x axis in cartesian(rectangular) coordinate. |
+### XAxis.SetDefaultValue
+
+public override void SetDefaultValue()
+The x axis in cartesian(rectangular) coordinate.
## XAxis3D
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
> Since `v3.11.0`
The x axis in cartesian(rectangular) coordinate.
-|public method|since|description|
-|--|--|--|
-|SetDefaultValue()||public override void SetDefaultValue()
The x axis in cartesian(rectangular) coordinate. |
+### XAxis3D.SetDefaultValue
+
+public override void SetDefaultValue()
+The x axis in cartesian(rectangular) coordinate.
## XChartsMgr
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### XChartsMgr.fullVersion
+
+public static string fullVersion
+
+### XChartsMgr.AddChart
+
+public static void AddChart(BaseChart chart)
+
+### XChartsMgr.ContainsChart
+
+public static bool ContainsChart(BaseChart chart)
-|public method|since|description|
-|--|--|--|
-|AddChart()||public static void AddChart(BaseChart chart)|
-|ContainsChart()||public static bool ContainsChart(BaseChart chart)|
-|ContainsChart()||public static bool ContainsChart(string chartName)|
-|GetChart()||public static BaseChart GetChart(string chartName)|
-|GetCharts()||public static List<BaseChart> GetCharts(string chartName)|
-|GetPackageFullPath()||public static string GetPackageFullPath()|
-|GetRepeatChartNameInfo()||public static string GetRepeatChartNameInfo(BaseChart chart, string chartName)|
-|IsRepeatChartName()||public static bool IsRepeatChartName(BaseChart chart, string chartName = null)|
-|RemoveAllChartObject()||public static void RemoveAllChartObject()|
-|RemoveChart()||public static void RemoveChart(string chartName)|
+### XChartsMgr.GetChart
+
+public static BaseChart GetChart(string chartName)
+
+### XChartsMgr.GetCharts
+
+public static List<BaseChart> GetCharts(string chartName)
+
+### XChartsMgr.GetPackageFullPath
+
+public static string GetPackageFullPath()
+
+### XChartsMgr.GetRepeatChartNameInfo
+
+public static string GetRepeatChartNameInfo(BaseChart chart, string chartName)
+
+### XChartsMgr.IsRepeatChartName
+
+public static bool IsRepeatChartName(BaseChart chart, string chartName = null)
+
+### XChartsMgr.RemoveAllChartObject
+
+public static void RemoveAllChartObject()
+
+### XChartsMgr.RemoveChart
+
+public static void RemoveChart(string chartName)
## XCResourceImporterWindow
-> class in XCharts.Runtime / Inherits from: [UnityEditor.EditorWindow](https://docs.unity3d.com/ScriptReference/30_search.html?q=unityeditor.editorwindow)
+class in XCharts.Runtime / Inherits from: [UnityEditor.EditorWindow](https://docs.unity3d.com/ScriptReference/30_search.html?q=unityeditoreditorwindow)
+### XCResourceImporterWindow.ShowPackageImporterWindow
-|public method|since|description|
-|--|--|--|
-|ShowPackageImporterWindow()||public static void ShowPackageImporterWindow()|
+public static void ShowPackageImporterWindow()
## XCResourcesImporter
-> class in XCharts.Runtime
+class in XCharts.Runtime
+### XCResourcesImporter.OnDestroy()
-|public method|since|description|
-|--|--|--|
-|OnDestroy()||public void OnDestroy() { }|
-|OnGUI()||public void OnGUI()|
-|XCResourcesImporter()||public XCResourcesImporter() { }|
+public void OnDestroy()
+
+### XCResourcesImporter.XCResourcesImporter()
+
+public XCResourcesImporter()
+
+### XCResourcesImporter.OnDestroy
+
+public void OnDestroy() { }
+
+### XCResourcesImporter.OnGUI
+
+public void OnGUI()
+
+### XCResourcesImporter.XCResourcesImporter
+
+public XCResourcesImporter() { }
## XCSettings
-> class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=scriptableobject)
+class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=scriptableobject)
+### XCSettings.axisLineType
-|public method|since|description|
-|--|--|--|
-|AddCustomTheme()||public static bool AddCustomTheme(Theme theme)|
-|ExistAssetFile()||public static bool ExistAssetFile()|
-|GetSettingAssetPath()||public static string GetSettingAssetPath()|
+public static LineStyle.Type axisLineType
+
+### XCSettings.axisLineWidth
+
+public static float axisLineWidth
+
+### XCSettings.axisSplitLineType
+
+public static LineStyle.Type axisSplitLineType
+
+### XCSettings.axisSplitLineWidth
+
+public static float axisSplitLineWidth
+
+### XCSettings.axisTickLength
+
+public static float axisTickLength
+
+### XCSettings.axisTickWidth
+
+public static float axisTickWidth
+
+### XCSettings.cicleSmoothness
+
+public static float cicleSmoothness
+
+### XCSettings.customThemes
+
+public static List<Theme> customThemes
+
+### XCSettings.dataZoomBorderWidth
+
+public static float dataZoomBorderWidth
+
+### XCSettings.dataZoomDataLineWidth
+
+public static float dataZoomDataLineWidth
+
+### XCSettings.editorShowAllListData
+
+public static bool editorShowAllListData
+
+### XCSettings.font
+
+public static Font font
+
+### XCSettings.fontSizeLv1
+
+public static int fontSizeLv1
+一级字体大小。
+
+### XCSettings.fontSizeLv2
+
+public static int fontSizeLv2
+
+### XCSettings.fontSizeLv3
+
+public static int fontSizeLv3
+
+### XCSettings.fontSizeLv4
+
+public static int fontSizeLv4
+
+### XCSettings.gaugeAxisLineWidth
+
+public static float gaugeAxisLineWidth
+
+### XCSettings.gaugeAxisSplitLineLength
+
+public static float gaugeAxisSplitLineLength
+
+### XCSettings.gaugeAxisSplitLineWidth
+
+public static float gaugeAxisSplitLineWidth
+
+### XCSettings.gaugeAxisTickLength
+
+public static float gaugeAxisTickLength
+
+### XCSettings.gaugeAxisTickWidth
+
+public static float gaugeAxisTickWidth
+
+### XCSettings.lang
+
+public static Lang lang
+
+### XCSettings.lineSegmentDistance
+
+public static float lineSegmentDistance
+
+### XCSettings.lineSmoothness
+
+public static float lineSmoothness
+
+### XCSettings.lineSmoothStyle
+
+public static float lineSmoothStyle
+
+### XCSettings.maxPainter
+
+public static int maxPainter
+
+### XCSettings.serieCandlestickBorderWidth
+
+public static float serieCandlestickBorderWidth
+
+### XCSettings.serieLineSymbolSize
+
+public static float serieLineSymbolSize
+
+### XCSettings.serieLineWidth
+
+public static float serieLineWidth
+
+### XCSettings.serieScatterSymbolSize
+
+public static float serieScatterSymbolSize
+
+### XCSettings.serieSelectedRate
+
+public static float serieSelectedRate
+
+### XCSettings.tmpFont
+
+public static TMP_FontAsset tmpFont
+
+### XCSettings.tootipLineWidth
+
+public static float tootipLineWidth
+
+### XCSettings.visualMapBorderWidth
+
+public static float visualMapBorderWidth
+
+### XCSettings.visualMapTriangeLen
+
+public static float visualMapTriangeLen
+
+### XCSettings.AddCustomTheme
+
+public static bool AddCustomTheme(Theme theme)
+
+### XCSettings.ExistAssetFile
+
+public static bool ExistAssetFile()
+
+### XCSettings.GetSettingAssetPath
+
+public static string GetSettingAssetPath()
## XCThemeMgr
-> class in XCharts.Runtime
+class in XCharts.Runtime
+
+### XCThemeMgr.AddTheme
+
+public static void AddTheme(Theme theme)
+
+### XCThemeMgr.CheckReloadTheme
+
+public static void CheckReloadTheme()
+
+### XCThemeMgr.ContainsTheme
+
+public static bool ContainsTheme(string themeName)
+
+### XCThemeMgr.ExportTheme
+
+public static bool ExportTheme(Theme theme)
-|public method|since|description|
-|--|--|--|
-|AddTheme()||public static void AddTheme(Theme theme)|
-|CheckReloadTheme()||public static void CheckReloadTheme()|
-|ContainsTheme()||public static bool ContainsTheme(string themeName)|
-|ExportTheme()||public static bool ExportTheme(Theme theme)|
-|ExportTheme()||public static bool ExportTheme(Theme theme, string themeNewName)|
-|GetAllThemeNames()||public static List<string> GetAllThemeNames()|
-|GetTheme()||public static Theme GetTheme(string themeName)|
-|GetTheme()||public static Theme GetTheme(ThemeType type)|
-|GetThemeAssetPath()||public static string GetThemeAssetPath(string themeName)|
-|GetThemeList()||public static List<Theme> GetThemeList()|
-|LoadTheme()||public static Theme LoadTheme(string themeName)|
-|LoadTheme()||public static Theme LoadTheme(ThemeType type)|
-|ReloadThemeList()||public static void ReloadThemeList()
重新加载主题列表 |
-|SwitchTheme()||public static void SwitchTheme(BaseChart chart, string themeName)|
+### XCThemeMgr.GetAllThemeNames
+
+public static List<string> GetAllThemeNames()
+
+### XCThemeMgr.GetTheme
+
+public static Theme GetTheme(string themeName)
+
+
+### XCThemeMgr.GetThemeAssetPath
+
+public static string GetThemeAssetPath(string themeName)
+
+### XCThemeMgr.GetThemeList
+
+public static List<Theme> GetThemeList()
+
+### XCThemeMgr.LoadTheme
+
+public static Theme LoadTheme(string themeName)
+
+
+### XCThemeMgr.ReloadThemeList
+
+public static void ReloadThemeList()
+重新加载主题列表
+
+### XCThemeMgr.SwitchTheme
+
+public static void SwitchTheme(BaseChart chart, string themeName)
## XLog
-> class in XCharts.Runtime / Inherits from: [MonoBehaviour](#monobehaviour)
+class in XCharts.Runtime / Inherits from: [MonoBehaviour](#monobehaviour)
Log system. Used to output logs with date and log type, support output to file, support custom output log type.
-|public method|since|description|
-|--|--|--|
-|CanLog()||public static bool CanLog(int level)|
-|ClearAllLog()||public static void ClearAllLog()|
-|Debug()||public static void Debug(string log)|
-|EnableLog()||public static void EnableLog(int logType)|
-|Error()||public static void Error(string log)|
-|FlushLog()||public static void FlushLog()|
-|GetNowTime()||public static string GetNowTime(string formatter = null)|
-|GetTimestamp()||public static ulong GetTimestamp()|
-|Info()||public static void Info(string log)|
-|Log()||public static void Log(string log)|
-|LogError()||public static void LogError(string log)|
-|LogWarning()||public static void LogWarning(string log)|
-|Proto()||public static void Proto(string log)|
-|Vital()||public static void Vital(string log)|
-|Warning()||public static void Warning(string log)|
+### XLog.CanLog
+
+public static bool CanLog(int level)
+
+### XLog.ClearAllLog
+
+public static void ClearAllLog()
+
+### XLog.Debug
+
+public static void Debug(string log)
+
+### XLog.EnableLog
+
+public static void EnableLog(int logType)
+
+### XLog.Error
+
+public static void Error(string log)
+
+### XLog.FlushLog
+
+public static void FlushLog()
+
+### XLog.GetNowTime
+
+public static string GetNowTime(string formatter = null)
+
+### XLog.GetTimestamp
+
+public static ulong GetTimestamp()
+
+### XLog.Info
+
+public static void Info(string log)
+
+### XLog.Log
+
+public static void Log(string log)
+
+### XLog.LogError
+
+public static void LogError(string log)
+
+### XLog.LogWarning
+
+public static void LogWarning(string log)
+
+### XLog.Proto
+
+public static void Proto(string log)
+
+### XLog.Vital
+
+public static void Vital(string log)
+
+### XLog.Warning
+
+public static void Warning(string log)
## YAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
The x axis in cartesian(rectangular) coordinate.
-|public method|since|description|
-|--|--|--|
-|SetDefaultValue()||public override void SetDefaultValue()
The x axis in cartesian(rectangular) coordinate. |
+### YAxis.SetDefaultValue
+
+public override void SetDefaultValue()
+The x axis in cartesian(rectangular) coordinate.
## YAxis3D
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
> Since `v3.11.0`
The x axis in cartesian(rectangular) coordinate.
-|public method|since|description|
-|--|--|--|
-|SetDefaultValue()||public override void SetDefaultValue()
The x axis in cartesian(rectangular) coordinate. |
+### YAxis3D.SetDefaultValue
+
+public override void SetDefaultValue()
+The x axis in cartesian(rectangular) coordinate.
## ZAxis3D
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
> Since `v3.11.0`
The x axis in cartesian(rectangular) coordinate.
-|public method|since|description|
-|--|--|--|
-|SetDefaultValue()||public override void SetDefaultValue()
The x axis in cartesian(rectangular) coordinate. |
+### ZAxis3D.SetDefaultValue
+
+public override void SetDefaultValue()
+The x axis in cartesian(rectangular) coordinate.
diff --git a/Documentation~/en/changelog.md b/Documentation~/en/changelog.md
index c1591083..aa270236 100644
--- a/Documentation~/en/changelog.md
+++ b/Documentation~/en/changelog.md
@@ -2,6 +2,9 @@
# 更新日志
[master](#master)
+[v3.12.0](#v3120)
+[v3.11.2](#v3112)
+[v3.11.1](#v3111)
[v3.11.0](#v3110)
[v3.10.2](#v3102)
[v3.10.1](#v3101)
@@ -69,6 +72,48 @@
## master
+## v3.12.0
+
+Version Highlights:
+
+* Added `radiusGradient` parameter for `Ring` to set the gradient direction
+* Added support for `date` and `time` in `numericFormatter`
+* Improved `origin` parameter setting for `AreaStyle` to define the starting position of area filling
+* Adjusted and perfected the documentation
+* Other optimizations and fixes
+
+Log Details:
+
+* (2024.09.30) Released version `v3.12.0`
+* (2024.09.27) Improved the `5-minute tutorial`
+* (2024.09.24) Improved support for multiple Series in `Legend`'s `formatter` (#332)
+* (2024.09.22) Adjusted the display style of the `Documentation`
+* (2024.09.09) Added support for `date` and `time` in `numericFormatter`
+* (2024.09.03) Improved the setting of the `origin` parameter for `AreaStyle` to define the starting position of area filling
+* (2024.09.01) Added `radiusGradient` parameter for `Ring` to set the gradient direction
+* (2024.09.01) Optimized the position of the first Label when `Axis` is used as a time axis
+
+
+## v3.11.2
+
+* (2024.08.01) Release `v3.11.2`
+* (2024.07.29) Fixed compatibility issue with `Tooltip` reporting error on wechat mini game platform (#326)
+* (2024.07.27) Adjust the default position of `AxisName` for `Axis`
+* (2024.07.22) Improved the behavior of `Pie`'s `Label` when `Tooltip` is triggered
+* (2024.07.21) Fix to `Tooltip` indicating inaccurate content when opening `DataZoom`
+* (2024.07.17) Fixed an issue where `Label` of `MarkLine` could flash during initialization
+* (2024.07.16) Optimized the default effect of `Tooltip` when `Axis` is `Time` timeline
+* (2024.07.15) Optimized segmentation when Axis is Time
+* (2024.07.14) Improved movement performance when `Axis` is `Time`
+* (2024.07.12) Optimized the initial display effect of `Label`
+* (2024.07.06) Fix to `Chart` background not adaptive when dynamically created (#323)
+
+## v3.11.1
+
+* (2024.07.01) Release `v3.11.1`
+* (2024.07.01) Fixed an issue where `Serie` has multiple abnormal colors
+* (2024.06.23) Fixed an issue where `labels` would pile up during initialization
+
## v3.11.0
Release Highlights:
diff --git a/Documentation~/en/configuration.md b/Documentation~/en/configuration.md
index 12ed0d9e..085b558f 100644
--- a/Documentation~/en/configuration.md
+++ b/Documentation~/en/configuration.md
@@ -206,30 +206,23 @@ import APITable from '@site/src/components/APITable';
## AngleAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
Angle axis of Polar Coordinate.
-```mdx-code-block
-
-```
+### AngleAxis.startAngle
+`float` `0`
-|field|default|since|comment|
-|--|--|--|--|
-|startAngle|0||Starting angle of axis. 0 degrees by default, standing for right position of center.
-
-```mdx-code-block
-
-```
+Starting angle of axis. 0 degrees by default, standing for right position of center.
## AngleAxisTheme
-> class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
## AnimationAddition
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
@@ -237,7 +230,7 @@ Data addition animation.
## AnimationChange
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
@@ -245,7 +238,7 @@ Data change animation.
## AnimationFadeIn
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
@@ -253,7 +246,7 @@ Fade in animation.
## AnimationFadeOut
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
@@ -261,7 +254,7 @@ Fade out animation.
## AnimationHiding
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
@@ -269,475 +262,924 @@ Data hiding animation.
## AnimationInfo
-> class in XCharts.Runtime / Subclasses: [AnimationFadeIn](#animationfadein), [AnimationFadeOut](#animationfadeout), [AnimationChange](#animationchange), [AnimationAddition](#animationaddition), [AnimationHiding](#animationhiding), [AnimationInteraction](#animationinteraction)
+class in XCharts.Runtime / Subclasses: [AnimationFadeIn](#animationfadein), [AnimationFadeOut](#animationfadeout), [AnimationChange](#animationchange), [AnimationAddition](#animationaddition), [AnimationHiding](#animationhiding), [AnimationInteraction](#animationinteraction)
> Since `v3.8.0`
the animation info.
-```mdx-code-block
-
-```
+### AnimationInfo.delay
+`float` `0` `v3.8.0`
-|field|default|since|comment|
-|--|--|--|--|
-|enable|true|v3.8.0|whether enable animation.
-|reverse|false|v3.8.0|whether enable reverse animation.
-|delay|0|v3.8.0|the delay time before animation start.
-|duration|1000|v3.8.0|the duration of animation.
+the delay time before animation start.
-```mdx-code-block
-
-```
+### AnimationInfo.duration
+
+`float` `1000` `v3.8.0`
+
+the duration of animation.
+
+### AnimationInfo.enable
+
+`bool` `true` `v3.8.0`
+
+whether enable animation.
+
+### AnimationInfo.reverse
+
+`bool` `false` `v3.8.0`
+
+whether enable reverse animation.
## AnimationInteraction
-> class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
+class in XCharts.Runtime / Inherits from: [AnimationInfo](#animationinfo)
> Since `v3.8.0`
Interactive animation of charts.
-```mdx-code-block
-
-```
+### AnimationInteraction.offset
+[MLValue](#mlvalue) `v3.8.0`
-|field|default|since|comment|
-|--|--|--|--|
-|width||v3.8.0|the mlvalue of width. [MLValue](#mlvalue)|
-|radius||v3.8.0|the mlvalue of radius. [MLValue](#mlvalue)|
-|offset||v3.8.0|the mlvalue of offset. Such as the offset of the pie chart when the sector is selected. [MLValue](#mlvalue)|
+the mlvalue of offset. Such as the offset of the pie chart when the sector is selected.
-```mdx-code-block
-
-```
+### AnimationInteraction.radius
+
+[MLValue](#mlvalue) `v3.8.0`
+
+the mlvalue of radius.
+
+### AnimationInteraction.width
+
+[MLValue](#mlvalue) `v3.8.0`
+
+the mlvalue of width.
## AnimationStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
the animation of serie. support animation type: fadeIn, fadeOut, change, addition.
-```mdx-code-block
-
-```
+### AnimationStyle.addition
+
+[AnimationAddition](#animationaddition) `v3.8.0`
+
+Add data animation configuration.
+
+### AnimationStyle.change
+
+[AnimationChange](#animationchange) `v3.8.0`
+
+Update data animation configuration.
+
+### AnimationStyle.easting
+
+[AnimationEasing](#animationeasing)
-|field|default|since|comment|
-|--|--|--|--|
-|enable|true||Whether to enable animation.
-|type|||The type of animation.
`AnimationType`:
- `Default`: he default. An animation playback mode will be selected according to the actual situation.
- `LeftToRight`: Play the animation from left to right.
- `BottomToTop`: Play the animation from bottom to top.
- `InsideOut`: Play animations from the inside out.
- `AlongPath`: Play the animation along the path.
- `Clockwise`: Play the animation clockwise.
|
-|easting|||
`AnimationEasing`:
- `Linear`:
|
-|threshold|2000||Whether to set graphic number threshold to animation. Animation will be disabled when graphic number is larger than threshold.
-|unscaledTime||v3.4.0|Animation updates independently of Time.timeScale.
-|fadeIn||v3.8.0|Fade in animation configuration. [AnimationFadeIn](#animationfadein)|
-|fadeOut||v3.8.0|Fade out animation configuration. [AnimationFadeOut](#animationfadeout)|
-|change||v3.8.0|Update data animation configuration. [AnimationChange](#animationchange)|
-|addition||v3.8.0|Add data animation configuration. [AnimationAddition](#animationaddition)|
-|hiding||v3.8.0|Data hiding animation configuration. [AnimationHiding](#animationhiding)|
-|interaction||v3.8.0|Interaction animation configuration. [AnimationInteraction](#animationinteraction)|
-```mdx-code-block
-
-```
+Options:
+
+- `Linear`:
+
+### AnimationStyle.enable
+
+`bool` `true`
+
+Whether to enable animation.
+
+### AnimationStyle.fadeIn
+
+[AnimationFadeIn](#animationfadein) `v3.8.0`
+
+Fade in animation configuration.
+
+### AnimationStyle.fadeOut
+
+[AnimationFadeOut](#animationfadeout) `v3.8.0`
+
+Fade out animation configuration.
+
+### AnimationStyle.hiding
+
+[AnimationHiding](#animationhiding) `v3.8.0`
+
+Data hiding animation configuration.
+
+### AnimationStyle.interaction
+
+[AnimationInteraction](#animationinteraction) `v3.8.0`
+
+Interaction animation configuration.
+
+### AnimationStyle.threshold
+
+`int` `2000`
+
+Whether to set graphic number threshold to animation. Animation will be disabled when graphic number is larger than threshold.
+
+### AnimationStyle.type
+
+[AnimationType](#animationtype)
+
+The type of animation.
+
+Options:
+
+- `Default`: he default. An animation playback mode will be selected according to the actual situation.
+- `LeftToRight`: Play the animation from left to right.
+- `BottomToTop`: Play the animation from bottom to top.
+- `InsideOut`: Play animations from the inside out.
+- `AlongPath`: Play the animation along the path.
+- `Clockwise`: Play the animation clockwise.
+
+### AnimationStyle.unscaledTime
+
+`bool` `v3.4.0`
+
+Animation updates independently of Time.timeScale.
## AreaStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
The style of area.
-```mdx-code-block
-
-```
+### AreaStyle.color
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Set this to false to prevent the areafrom showing.
-|origin|||the origin of area.
`AreaStyle.AreaOrigin`:
- `Auto`: to fill between axis line to data.
- `Start`: to fill between min axis value (when not inverse) to data.
- `End`: to fill between max axis value (when not inverse) to data.
|
-|color|||the color of area,default use serie color.
-|toColor|||Gradient color, start color to toColor.
-|opacity|0.6f||Opacity of the component. Supports value from 0 to 1, and the component will not be drawn when set to 0.
-|innerFill||v3.2.0|Whether to fill only polygonal areas. Currently, only convex polygons are supported.
-|toTop|true|v3.6.0|Whether to fill the gradient color to the top. The default is true, which means that the gradient color is filled to the top. If it is false, the gradient color is filled to the actual position.
+the color of area,default use serie color.
-```mdx-code-block
-
-```
+### AreaStyle.innerFill
+
+`bool` `v3.2.0`
+
+Whether to fill only polygonal areas. Currently, only convex polygons are supported.
+
+### AreaStyle.opacity
+
+`float` `0.6f`
+
+Opacity of the component. Supports value from 0 to 1, and the component will not be drawn when set to 0.
+
+### AreaStyle.origin
+
+[AreaStyle.AreaOrigin](#areastyleareaorigin)
+
+the origin of area.
+
+Options:
+
+- `Auto`: to fill between axis line to data.
+- `Start`: to fill between min axis value (when not inverse) to data.
+- `End`: to fill between max axis value (when not inverse) to data.
+
+### AreaStyle.show
+
+`bool` `true`
+
+Set this to false to prevent the areafrom showing.
+
+### AreaStyle.toColor
+
+`Color32`
+
+Gradient color, start color to toColor.
+
+### AreaStyle.toTop
+
+`bool` `true` `v3.6.0`
+
+Whether to fill the gradient color to the top. The default is true, which means that the gradient color is filled to the top. If it is false, the gradient color is filled to the actual position.
## ArrowStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
-```mdx-code-block
-
-```
+### ArrowStyle.color
+`Color32` `Color.clear`
-|field|default|since|comment|
-|--|--|--|--|
-|width|10||The widht of arrow.
-|height|15||The height of arrow.
-|offset|0||The offset of arrow.
-|dent|3||The dent of arrow.
-|color|Color.clear||the color of arrow.
+the color of arrow.
-```mdx-code-block
-
-```
+### ArrowStyle.dent
+
+`float` `3`
+
+The dent of arrow.
+
+### ArrowStyle.height
+
+`float` `15`
+
+The height of arrow.
+
+### ArrowStyle.offset
+
+`float` `0`
+
+The offset of arrow.
+
+### ArrowStyle.width
+
+`float` `10`
+
+The widht of arrow.
## Axis
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent) / Subclasses: [AngleAxis](#angleaxis), [ParallelAxis](#parallelaxis), [RadiusAxis](#radiusaxis), [SingleAxis](#singleaxis), [XAxis](#xaxis), [XAxis3D](#xaxis3d), [YAxis](#yaxis), [YAxis3D](#yaxis3d), [ZAxis3D](#zaxis3d)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent) / Subclasses: [AngleAxis](#angleaxis), [ParallelAxis](#parallelaxis), [RadiusAxis](#radiusaxis), [SingleAxis](#singleaxis), [XAxis](#xaxis), [XAxis3D](#xaxis3d), [YAxis](#yaxis), [YAxis3D](#yaxis3d), [ZAxis3D](#zaxis3d)
The axis in rectangular coordinate.
-```mdx-code-block
-
-```
+### Axis.animation
+[AxisAnimation](#axisanimation)
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether to show axis.
-|type|||the type of axis.
`Axis.AxisType`:
- `Value`: Numerical axis, suitable for continuous data.
- `Category`: Category axis, suitable for discrete category data. Data should only be set via data for this type.
- `Log`: Log axis, suitable for log data.
- `Time`: Time axis, suitable for continuous time series data.
|
-|minMaxType|||the type of axis minmax.
`Axis.AxisMinMaxType`:
- `Default`: 0 - maximum.
- `MinMax`: minimum - maximum.
- `Custom`: Customize the minimum and maximum.
- `MinMaxAuto`: [since("v3.7.0")]minimum - maximum, automatically calculate the appropriate values.
|
-|gridIndex|||The index of the grid on which the axis are located, by default, is in the first grid.
-|polarIndex|||The index of the polar on which the axis are located, by default, is in the first polar.
-|parallelIndex|||The index of the parallel on which the axis are located, by default, is in the first parallel.
-|position|||the position of axis in grid.
`Axis.AxisPosition`:
- `Left`: the position of axis in grid.
- `Right`: the position of axis in grid.
- `Bottom`: the position of axis in grid.
- `Top`: the position of axis in grid.
- `Center`: the position of axis in grid.
|
-|offset|||the offset of axis from the default position. Useful when the same position has multiple axes.
-|min|||The minimun value of axis.Valid when `minMaxType` is `Custom`
-|max|||The maximum value of axis.Valid when `minMaxType` is `Custom`
-|splitNumber|0||Number of segments that the axis is split into.
-|interval|0||Compulsively set segmentation interval for axis.This is unavailable for category axis.
-|boundaryGap|true||The boundary gap on both sides of a coordinate axis, which is valid only for category axis with type: 'Category'.
-|maxCache|0||The max number of axis data cache.
-|logBase|10||Base of logarithm, which is valid only for numeric axes with type: 'Log'.
-|logBaseE|false||On the log axis, if base e is the natural number, and is true, logBase fails.
-|ceilRate|0||The ratio of maximum and minimum values rounded upward. The default is 0, which is automatically calculated.
-|inverse|false||Whether the axis are reversed or not. Invalid in `Category` axis.
-|clockwise|true||Whether the positive position of axis is in clockwise. True for clockwise by default.
-|insertDataToHead|||Whether to add new data at the head or at the end of the list.
-|minCategorySpacing|0|v3.11.0|The minimum spacing between categories.
-|icons|||类目数据对应的图标。
-|data|||Category data, available in type: 'Category' axis.
-|axisLine|||axis Line. [AxisLine](#axisline)|
-|axisName|||axis name. [AxisName](#axisname)|
-|axisTick|||axis tick. [AxisTick](#axistick)|
-|axisLabel|||axis label. [AxisLabel](#axislabel)|
-|splitLine|||axis split line. [AxisSplitLine](#axissplitline)|
-|splitArea|||axis split area. [AxisSplitArea](#axissplitarea)|
-|animation|||animation of axis. [AxisAnimation](#axisanimation)|
-|minorTick||v3.2.0|axis minor tick. [AxisMinorTick](#axisminortick)|
-|minorSplitLine||v3.2.0|axis minor split line. [AxisMinorSplitLine](#axisminorsplitline)|
-|indicatorLabel||v3.4.0|Style of axis tooltip indicator label. [LabelStyle](#labelstyle)|
+animation of axis.
-```mdx-code-block
-
-```
+### Axis.axisLabel
+
+[AxisLabel](#axislabel)
+
+axis label.
+
+### Axis.axisLine
+
+[AxisLine](#axisline)
+
+axis Line.
+
+### Axis.axisName
+
+[AxisName](#axisname)
+
+axis name.
+
+### Axis.axisTick
+
+[AxisTick](#axistick)
+
+axis tick.
+
+### Axis.boundaryGap
+
+`bool` `true`
+
+The boundary gap on both sides of a coordinate axis, which is valid only for category axis with type: 'Category'.
+
+### Axis.ceilRate
+
+`double` `0`
+
+The ratio of maximum and minimum values rounded upward. The default is 0, which is automatically calculated.
+
+### Axis.clockwise
+
+`bool` `true`
+
+Whether the positive position of axis is in clockwise. True for clockwise by default.
+
+### Axis.data
+
+`List`
+
+Category data, available in type: 'Category' axis.
+
+### Axis.gridIndex
+
+`int`
+
+The index of the grid on which the axis are located, by default, is in the first grid.
+
+### Axis.icons
+
+`List`
+
+类目数据对应的图标。
+
+### Axis.indicatorLabel
+
+[LabelStyle](#labelstyle) `v3.4.0`
+
+Style of axis tooltip indicator label.
+
+### Axis.insertDataToHead
+
+`bool`
+
+Whether to add new data at the head or at the end of the list.
+
+### Axis.interval
+
+`double` `0`
+
+Compulsively set segmentation interval for axis.This is unavailable for category axis.
+
+### Axis.inverse
+
+`bool` `false`
+
+Whether the axis are reversed or not. Invalid in `Category` axis.
+
+### Axis.logBase
+
+`float` `10`
+
+Base of logarithm, which is valid only for numeric axes with type: 'Log'.
+
+### Axis.logBaseE
+
+`bool` `false`
+
+On the log axis, if base e is the natural number, and is true, logBase fails.
+
+### Axis.max
+
+`double`
+
+The maximum value of axis.Valid when `minMaxType` is `Custom`
+
+### Axis.maxCache
+
+`int` `0`
+
+The max number of axis data cache.
+
+### Axis.min
+
+`double`
+
+The minimun value of axis.Valid when `minMaxType` is `Custom`
+
+### Axis.minCategorySpacing
+
+`float` `0` `v3.11.0`
+
+The minimum spacing between categories.
+
+### Axis.minMaxType
+
+[Axis.AxisMinMaxType](#axisaxisminmaxtype)
+
+the type of axis minmax.
+
+Options:
+
+- `Default`: 0 - maximum.
+- `MinMax`: minimum - maximum.
+- `Custom`: Customize the minimum and maximum.
+- `MinMaxAuto`: [since("v3.7.0")]minimum - maximum, automatically calculate the appropriate values.
+
+### Axis.minorSplitLine
+
+[AxisMinorSplitLine](#axisminorsplitline) `v3.2.0`
+
+axis minor split line.
+
+### Axis.minorTick
+
+[AxisMinorTick](#axisminortick) `v3.2.0`
+
+axis minor tick.
+
+### Axis.offset
+
+`float`
+
+the offset of axis from the default position. Useful when the same position has multiple axes.
+
+### Axis.parallelIndex
+
+`int`
+
+The index of the parallel on which the axis are located, by default, is in the first parallel.
+
+### Axis.polarIndex
+
+`int`
+
+The index of the polar on which the axis are located, by default, is in the first polar.
+
+### Axis.position
+
+[Axis.AxisPosition](#axisaxisposition)
+
+the position of axis in grid.
+
+Options:
+
+- `Left`: the position of axis in grid.
+- `Right`: the position of axis in grid.
+- `Bottom`: the position of axis in grid.
+- `Top`: the position of axis in grid.
+- `Center`: the position of axis in grid.
+
+### Axis.show
+
+`bool` `true`
+
+Whether to show axis.
+
+### Axis.splitArea
+
+[AxisSplitArea](#axissplitarea)
+
+axis split area.
+
+### Axis.splitLine
+
+[AxisSplitLine](#axissplitline)
+
+axis split line.
+
+### Axis.splitNumber
+
+`int` `0`
+
+Number of segments that the axis is split into.
+
+### Axis.type
+
+[Axis.AxisType](#axisaxistype)
+
+the type of axis.
+
+Options:
+
+- `Value`: Numerical axis, suitable for continuous data.
+- `Category`: Category axis, suitable for discrete category data. Data should only be set via data for this type.
+- `Log`: Log axis, suitable for log data.
+- `Time`: Time axis, suitable for continuous time series data.
## AxisAnimation
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.9.0`
animation style of axis.
-```mdx-code-block
-
-```
+### AxisAnimation.duration
+`float`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||whether to enable animation.
-|duration|||the duration of animation (ms). When it is set to 0, the animation duration will be automatically calculated according to the serie.
-|unscaledTime|||Animation updates independently of Time.timeScale.
+the duration of animation (ms). When it is set to 0, the animation duration will be automatically calculated according to the serie.
-```mdx-code-block
-
-```
+### AxisAnimation.show
+
+`bool` `true`
+
+whether to enable animation.
+
+### AxisAnimation.unscaledTime
+
+`bool`
+
+Animation updates independently of Time.timeScale.
## AxisLabel
-> class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle)
+class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle)
Settings related to axis label.
-```mdx-code-block
-
-```
+### AxisLabel.inside
+`bool` `false`
-|field|default|since|comment|
-|--|--|--|--|
-|interval|0||The display interval of the axis label.
-|inside|false||Set this to true so the axis labels face the inside direction.
-|showAsPositiveNumber|false||Show negative number as positive number.
-|onZero|false||刻度标签显示在0刻度上。
-|showStartLabel|true||Whether to display the first label.
-|showEndLabel|true||Whether to display the last label.
-|textLimit|||文本限制。 [TextLimit](#textlimit)|
+Set this to true so the axis labels face the inside direction.
-```mdx-code-block
-
-```
+### AxisLabel.interval
+
+`int` `0`
+
+The display interval of the axis label.
+
+### AxisLabel.onZero
+
+`bool` `false`
+
+刻度标签显示在0刻度上。
+
+### AxisLabel.showAsPositiveNumber
+
+`bool` `false`
+
+Show negative number as positive number.
+
+### AxisLabel.showEndLabel
+
+`bool` `true`
+
+Whether to display the last label.
+
+### AxisLabel.showStartLabel
+
+`bool` `true`
+
+Whether to display the first label.
+
+### AxisLabel.textLimit
+
+[TextLimit](#textlimit)
+
+文本限制。
## AxisLine
-> class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
+class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
Settings related to axis line.
-```mdx-code-block
-
-```
+### AxisLine.arrow
+[ArrowStyle](#arrowstyle)
-|field|default|since|comment|
-|--|--|--|--|
-|onZero|||When mutiple axes exists, this option can be used to specify which axis can be "onZero" to.
-|showArrow|||Whether to show the arrow symbol of axis.
-|arrow|||the arrow of line. [ArrowStyle](#arrowstyle)|
+the arrow of line.
-```mdx-code-block
-
-```
+### AxisLine.onZero
+
+`bool`
+
+When mutiple axes exists, this option can be used to specify which axis can be "onZero" to.
+
+### AxisLine.showArrow
+
+`bool`
+
+Whether to show the arrow symbol of axis.
## AxisMinorSplitLine
-> class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
+class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
> Since `v3.2.0`
Minor split line of axis in grid area.
-```mdx-code-block
-
-```
+### AxisMinorSplitLine.autoColor
+`bool`
-|field|default|since|comment|
-|--|--|--|--|
-|distance|||The distance between the split line and axis line.
-|autoColor|||auto color.
+auto color.
-```mdx-code-block
-
-```
+### AxisMinorSplitLine.distance
+
+`float`
+
+The distance between the split line and axis line.
## AxisMinorTick
-> class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
+class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
> Since `v3.2.0`
Settings related to axis minor tick.
-```mdx-code-block
-
-```
+### AxisMinorTick.autoColor
+`bool`
-|field|default|since|comment|
-|--|--|--|--|
-|splitNumber|5||Number of segments that the axis is split into.
-|autoColor|||
+### AxisMinorTick.splitNumber
-```mdx-code-block
-
-```
+`int` `5`
+
+Number of segments that the axis is split into.
## AxisName
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
the name of axis.
-```mdx-code-block
-
-```
+### AxisName.labelStyle
+[LabelStyle](#labelstyle)
-|field|default|since|comment|
-|--|--|--|--|
-|show|||Whether to show axis name.
-|name|||the name of axis.
-|onZero||v3.1.0|Whether the axis name position are the same with 0 position of YAxis.
-|labelStyle|||The text style of axis name. [LabelStyle](#labelstyle)|
+The text style of axis name.
-```mdx-code-block
-
-```
+### AxisName.name
+
+`string`
+
+the name of axis.
+
+### AxisName.onZero
+
+`bool` `v3.1.0`
+
+Whether the axis name position are the same with 0 position of YAxis.
+
+### AxisName.show
+
+`bool`
+
+Whether to show axis name.
## AxisSplitArea
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
Split area of axis in grid area, not shown by default.
-```mdx-code-block
-
-```
+### AxisSplitArea.color
+`List`
-|field|default|since|comment|
-|--|--|--|--|
-|show|||Set this to true to show the splitArea.
-|color|||Color of split area. SplitArea color could also be set in color array, which the split lines would take as their colors in turns. Dark and light colors in turns are used by default.
+Color of split area. SplitArea color could also be set in color array, which the split lines would take as their colors in turns. Dark and light colors in turns are used by default.
-```mdx-code-block
-
-```
+### AxisSplitArea.show
+
+`bool`
+
+Set this to true to show the splitArea.
## AxisSplitLine
-> class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
+class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
Split line of axis in grid area.
-```mdx-code-block
-
-```
+### AxisSplitLine.autoColor
+`bool`
-|field|default|since|comment|
-|--|--|--|--|
-|interval|||Interval of Axis splitLine.
-|distance|||The distance between the split line and axis line.
-|autoColor|||auto color.
-|showStartLine|true|v3.3.0|Whether to show the first split line.
-|showEndLine|true|v3.3.0|Whether to show the last split line.
-|showZLine|true|v3.11.0|Whether to show the Z axis part of the split line. Generally used for 3D coordinate systems.
+auto color.
-```mdx-code-block
-
-```
+### AxisSplitLine.distance
+
+`float`
+
+The distance between the split line and axis line.
+
+### AxisSplitLine.interval
+
+`int`
+
+Interval of Axis splitLine.
+
+### AxisSplitLine.showEndLine
+
+`bool` `true` `v3.3.0`
+
+Whether to show the last split line.
+
+### AxisSplitLine.showStartLine
+
+`bool` `true` `v3.3.0`
+
+Whether to show the first split line.
+
+### AxisSplitLine.showZLine
+
+`bool` `true` `v3.11.0`
+
+Whether to show the Z axis part of the split line. Generally used for 3D coordinate systems.
## AxisTheme
-> class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
## AxisTick
-> class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
+class in XCharts.Runtime / Inherits from: [BaseLine](#baseline)
Settings related to axis tick.
-```mdx-code-block
-
-```
+### AxisTick.alignWithLabel
+`bool`
-|field|default|since|comment|
-|--|--|--|--|
-|alignWithLabel|||Align axis tick with label, which is available only when boundaryGap is set to be true in category axis.
-|inside|||Set this to true so the axis labels face the inside direction.
-|showStartTick|||Whether to display the first tick.
-|showEndTick|||Whether to display the last tick.
-|distance|||The distance between the tick line and axis line.
-|splitNumber|0||Number of segments that the axis is split into.
-|autoColor|||
+Align axis tick with label, which is available only when boundaryGap is set to be true in category axis.
-```mdx-code-block
-
-```
+### AxisTick.autoColor
+
+`bool`
+
+### AxisTick.distance
+
+`float`
+
+The distance between the tick line and axis line.
+
+### AxisTick.inside
+
+`bool`
+
+Set this to true so the axis labels face the inside direction.
+
+### AxisTick.showEndTick
+
+`bool`
+
+Whether to display the last tick.
+
+### AxisTick.showStartTick
+
+`bool`
+
+Whether to display the first tick.
+
+### AxisTick.splitNumber
+
+`int` `0`
+
+Number of segments that the axis is split into.
## Background
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
Background component.
-```mdx-code-block
-
-```
+### Background.autoColor
+`bool` `true`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether to enable the background component.
-|image|||the image of background.
-|imageType|||the fill type of background image.
-|imageColor|||背景图颜色。
-|imageWidth|0|v3.10.0|the width of background image.
-|imageHeight|0|v3.10.0|the height of background image.
-|autoColor|true||Whether to use theme background color for component color when the background component is on.
-|borderStyle||v3.10.0|the border style of background. [BorderStyle](#borderstyle)|
+Whether to use theme background color for component color when the background component is on.
-```mdx-code-block
-
-```
+### Background.borderStyle
+
+[BorderStyle](#borderstyle) `v3.10.0`
+
+the border style of background.
+
+### Background.image
+
+`Sprite`
+
+the image of background.
+
+### Background.imageColor
+
+`Color`
+
+背景图颜色。
+
+### Background.imageHeight
+
+`float` `0` `v3.10.0`
+
+the height of background image.
+
+### Background.imageType
+
+`Image.Type`
+
+the fill type of background image.
+
+### Background.imageWidth
+
+`float` `0` `v3.10.0`
+
+the width of background image.
+
+### Background.show
+
+`bool` `true`
+
+Whether to enable the background component.
## Bar
-> class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
## BaseAxisTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme) / Subclasses: [AxisTheme](#axistheme), [RadiusAxisTheme](#radiusaxistheme), [AngleAxisTheme](#angleaxistheme), [PolarAxisTheme](#polaraxistheme), [RadarAxisTheme](#radaraxistheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme) / Subclasses: [AxisTheme](#axistheme), [RadiusAxisTheme](#radiusaxistheme), [AngleAxisTheme](#angleaxistheme), [PolarAxisTheme](#polaraxistheme), [RadarAxisTheme](#radaraxistheme)
-```mdx-code-block
-
-```
+### BaseAxisTheme.lineColor
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|lineType|||the type of line.
`LineStyle.Type`:
- `Solid`: 实线
- `Dashed`: 虚线
- `Dotted`: 点线
- `DashDot`: 点划线
- `DashDotDot`: 双点划线
- `None`: 双点划线
|
-|lineWidth|1f||the width of line.
-|lineLength|0f||the length of line.
-|lineColor|||the color of line.
-|splitLineType|||the type of split line.
`LineStyle.Type`:
- `Solid`: 实线
- `Dashed`: 虚线
- `Dotted`: 点线
- `DashDot`: 点划线
- `DashDotDot`: 双点划线
- `None`: 双点划线
|
-|splitLineWidth|1f||the width of split line.
-|splitLineLength|0f||the length of split line.
-|splitLineColor|||the color of split line.
-|minorSplitLineColor|||the color of minor split line.
-|tickWidth|1f||the width of tick.
-|tickLength|5f||the length of tick.
-|tickColor|||the color of tick.
-|splitAreaColors|||the colors of split area.
+the color of line.
-```mdx-code-block
-
-```
+### BaseAxisTheme.lineLength
+
+`float` `0f`
+
+the length of line.
+
+### BaseAxisTheme.lineType
+
+[LineStyle.Type](#linestyletype)
+
+the type of line.
+
+Options:
+
+- `Solid`: 实线
+- `Dashed`: 虚线
+- `Dotted`: 点线
+- `DashDot`: 点划线
+- `DashDotDot`: 双点划线
+- `None`: 双点划线
+
+### BaseAxisTheme.lineWidth
+
+`float` `1f`
+
+the width of line.
+
+### BaseAxisTheme.minorSplitLineColor
+
+`Color32`
+
+the color of minor split line.
+
+### BaseAxisTheme.splitAreaColors
+
+`List`
+
+the colors of split area.
+
+### BaseAxisTheme.splitLineColor
+
+`Color32`
+
+the color of split line.
+
+### BaseAxisTheme.splitLineLength
+
+`float` `0f`
+
+the length of split line.
+
+### BaseAxisTheme.splitLineType
+
+[LineStyle.Type](#linestyletype)
+
+the type of split line.
+
+Options:
+
+- `Solid`: 实线
+- `Dashed`: 虚线
+- `Dotted`: 点线
+- `DashDot`: 点划线
+- `DashDotDot`: 双点划线
+- `None`: 双点划线
+
+### BaseAxisTheme.splitLineWidth
+
+`float` `1f`
+
+the width of split line.
+
+### BaseAxisTheme.tickColor
+
+`Color32`
+
+the color of tick.
+
+### BaseAxisTheme.tickLength
+
+`float` `5f`
+
+the length of tick.
+
+### BaseAxisTheme.tickWidth
+
+`float` `1f`
+
+the width of tick.
## BaseLine
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [AxisLine](#axisline), [AxisMinorSplitLine](#axisminorsplitline), [AxisMinorTick](#axisminortick), [AxisSplitLine](#axissplitline), [AxisTick](#axistick)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [AxisLine](#axisline), [AxisMinorSplitLine](#axisminorsplitline), [AxisMinorTick](#axisminortick), [AxisSplitLine](#axissplitline), [AxisTick](#axistick)
Settings related to base line.
-```mdx-code-block
-
-```
+### BaseLine.lineStyle
+[LineStyle](#linestyle)
-|field|default|since|comment|
-|--|--|--|--|
-|show|||Set this to false to prevent the axis line from showing.
-|lineStyle|||线条样式 [LineStyle](#linestyle)|
+线条样式
-```mdx-code-block
-
-```
+### BaseLine.show
+
+`bool`
+
+Set this to false to prevent the axis line from showing.
## BaseScatter
-> class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) / Subclasses: [EffectScatter](#effectscatter), [Scatter](#scatter)
+class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) / Subclasses: [EffectScatter](#effectscatter), [Scatter](#scatter)
## BaseSerie
-> class in XCharts.Runtime / Subclasses: [Serie](#serie)
+class in XCharts.Runtime / Subclasses: [Serie](#serie)
## BlurStyle
-> class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
> Since `v3.2.0`
@@ -745,1081 +1187,2211 @@ Configurations of blur state.
## BorderStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.10.0`
The style of border.
-```mdx-code-block
-
-```
+### BorderStyle.borderColor
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|show|false||whether the border is visible.
-|borderWidth|||the width of border.
-|borderColor|||the color of border.
-|roundedCorner|true||whether the border is rounded corner.
-|cornerRadius|||The radius of rounded corner. Its unit is px. Use array to respectively specify the 4 corner radiuses((clockwise upper left, upper right, bottom right and bottom left)). When is set to (1,1,1,1), all corners are rounded.
+the color of border.
-```mdx-code-block
-
-```
+### BorderStyle.borderWidth
+
+`float`
+
+the width of border.
+
+### BorderStyle.cornerRadius
+
+`float[]`
+
+The radius of rounded corner. Its unit is px. Use array to respectively specify the 4 corner radiuses((clockwise upper left, upper right, bottom right and bottom left)). When is set to (1,1,1,1), all corners are rounded.
+
+### BorderStyle.roundedCorner
+
+`bool` `true`
+
+whether the border is rounded corner.
+
+### BorderStyle.show
+
+`bool` `false`
+
+whether the border is visible.
## CalendarCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer)
## Candlestick
-> class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
## ChartText
-> class in XCharts.Runtime
+class in XCharts.Runtime
## ChildComponent
-> class in XCharts.Runtime / Subclasses: [AnimationStyle](#animationstyle), [AxisAnimation](#axisanimation), [AxisName](#axisname), [AxisSplitArea](#axissplitarea), [AreaStyle](#areastyle), [ArrowStyle](#arrowstyle), [BaseLine](#baseline), [BorderStyle](#borderstyle), [IconStyle](#iconstyle), [ImageStyle](#imagestyle), [ItemStyle](#itemstyle), [Level](#level), [LevelStyle](#levelstyle), [LineArrow](#linearrow), [LineStyle](#linestyle), [Location](#location), [MLValue](#mlvalue), [MarqueeStyle](#marqueestyle), [Padding](#padding), [StageColor](#stagecolor), [SymbolStyle](#symbolstyle), [TextLimit](#textlimit), [TextStyle](#textstyle), [CommentItem](#commentitem), [CommentMarkStyle](#commentmarkstyle), [LabelLine](#labelline), [LabelStyle](#labelstyle), [MarkAreaData](#markareadata), [MarkLineData](#marklinedata), [StateStyle](#statestyle), [VisualMapRange](#visualmaprange), [ViewControl](#viewcontrol), [UIComponentTheme](#uicomponenttheme), [SerieData](#seriedata), [SerieDataLink](#seriedatalink), [ComponentTheme](#componenttheme), [SerieTheme](#serietheme), [ThemeStyle](#themestyle)
+class in XCharts.Runtime / Subclasses: [AnimationStyle](#animationstyle), [AxisAnimation](#axisanimation), [AxisName](#axisname), [AxisSplitArea](#axissplitarea), [AreaStyle](#areastyle), [ArrowStyle](#arrowstyle), [BaseLine](#baseline), [BorderStyle](#borderstyle), [IconStyle](#iconstyle), [ImageStyle](#imagestyle), [ItemStyle](#itemstyle), [Level](#level), [LevelStyle](#levelstyle), [LineArrow](#linearrow), [LineStyle](#linestyle), [Location](#location), [MLValue](#mlvalue), [MarqueeStyle](#marqueestyle), [Padding](#padding), [StageColor](#stagecolor), [SymbolStyle](#symbolstyle), [TextLimit](#textlimit), [TextStyle](#textstyle), [CommentItem](#commentitem), [CommentMarkStyle](#commentmarkstyle), [LabelLine](#labelline), [LabelStyle](#labelstyle), [MarkAreaData](#markareadata), [MarkLineData](#marklinedata), [StateStyle](#statestyle), [VisualMapRange](#visualmaprange), [ViewControl](#viewcontrol), [UIComponentTheme](#uicomponenttheme), [SerieData](#seriedata), [SerieDataLink](#seriedatalink), [ComponentTheme](#componenttheme), [SerieTheme](#serietheme), [ThemeStyle](#themestyle)
## Comment
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged)
comment of chart.
-```mdx-code-block
-
-```
+### Comment.items
+`List`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Set this to false to prevent the comment from showing.
-|labelStyle|||The text style of all comments. [LabelStyle](#labelstyle)|
-|markStyle|||The text style of all comments. [CommentMarkStyle](#commentmarkstyle)|
-|items|||The items of comment.
+The items of comment.
-```mdx-code-block
-
-```
+### Comment.labelStyle
+
+[LabelStyle](#labelstyle)
+
+The text style of all comments.
+
+### Comment.markStyle
+
+[CommentMarkStyle](#commentmarkstyle)
+
+The text style of all comments.
+
+### Comment.show
+
+`bool` `true`
+
+Set this to false to prevent the comment from showing.
## CommentItem
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
comment of chart.
-```mdx-code-block
-
-```
+### CommentItem.content
+`string`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Set this to false to prevent this comment item from showing.
-|content|||content of comment.
-|markRect|||the mark rect of comment.
-|markStyle|||the mark rect style. [CommentMarkStyle](#commentmarkstyle)|
-|labelStyle|||The text style of all comments. [LabelStyle](#labelstyle)|
-|location||v3.5.0|The location of comment. [Location](#location)|
+content of comment.
-```mdx-code-block
-
-```
+### CommentItem.labelStyle
+
+[LabelStyle](#labelstyle)
+
+The text style of all comments.
+
+### CommentItem.location
+
+[Location](#location) `v3.5.0`
+
+The location of comment.
+
+### CommentItem.markRect
+
+`Rect`
+
+the mark rect of comment.
+
+### CommentItem.markStyle
+
+[CommentMarkStyle](#commentmarkstyle)
+
+the mark rect style.
+
+### CommentItem.show
+
+`bool` `true`
+
+Set this to false to prevent this comment item from showing.
## CommentMarkStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
the comment mark style.
-```mdx-code-block
-
-```
+### CommentMarkStyle.lineStyle
+[LineStyle](#linestyle)
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Set this to false to prevent this comment item from showing.
-|lineStyle|||line style of comment mark area. [LineStyle](#linestyle)|
+line style of comment mark area.
-```mdx-code-block
-
-```
+### CommentMarkStyle.show
+
+`bool` `true`
+
+Set this to false to prevent this comment item from showing.
## ComponentTheme
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [BaseAxisTheme](#baseaxistheme), [DataZoomTheme](#datazoomtheme), [LegendTheme](#legendtheme), [SubTitleTheme](#subtitletheme), [TitleTheme](#titletheme), [TooltipTheme](#tooltiptheme), [VisualMapTheme](#visualmaptheme)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [BaseAxisTheme](#baseaxistheme), [DataZoomTheme](#datazoomtheme), [LegendTheme](#legendtheme), [SubTitleTheme](#subtitletheme), [TitleTheme](#titletheme), [TooltipTheme](#tooltiptheme), [VisualMapTheme](#visualmaptheme)
-```mdx-code-block
-
-```
+### ComponentTheme.font
+`Font`
-|field|default|since|comment|
-|--|--|--|--|
-|font|||the font of text.
-|textColor|||the color of text.
-|textBackgroundColor|||the color of text.
-|fontSize|18||the font size of text.
-|tMPFont|||the font of chart text。
+the font of text.
-```mdx-code-block
-
-```
+### ComponentTheme.fontSize
+
+`int` `18`
+
+the font size of text.
+
+### ComponentTheme.textBackgroundColor
+
+`Color`
+
+the color of text.
+
+### ComponentTheme.textColor
+
+`Color`
+
+the color of text.
+
+### ComponentTheme.tMPFont
+
+`TMP_FontAsset`
+
+the font of chart text。
## CoordSystem
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent) / Subclasses: [RadarCoord](#radarcoord), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [GridCoord3D](#gridcoord3d), [ParallelCoord](#parallelcoord), [PolarCoord](#polarcoord), [SingleAxisCoord](#singleaxiscoord)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent) / Subclasses: [RadarCoord](#radarcoord), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [GridCoord3D](#gridcoord3d), [ParallelCoord](#parallelcoord), [PolarCoord](#polarcoord), [SingleAxisCoord](#singleaxiscoord)
Coordinate system component.
## DataZoom
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent), [IUpdateRuntimeData](#iupdateruntimedata)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent), [IUpdateRuntimeData](#iupdateruntimedata)
DataZoom component is used for zooming a specific area, which enables user to investigate data in detail, or get an overview of the data, or get rid of outlier points.
-```mdx-code-block
-
-```
+### DataZoom.areaStyle
+[AreaStyle](#areastyle)
-|field|default|since|comment|
-|--|--|--|--|
-|enable|true||Whether to show dataZoom.
-|filterMode|||The mode of data filter.
`DataZoom.FilterMode`:
- `Filter`: data that outside the window will be filtered, which may lead to some changes of windows of other axes. For each data item, it will be filtered if one of the relevant dimensions is out of the window.
- `WeakFilter`: data that outside the window will be filtered, which may lead to some changes of windows of other axes. For each data item, it will be filtered only if all of the relevant dimensions are out of the same side of the window.
- `Empty`: data that outside the window will be set to NaN, which will not lead to changes of windows of other axes.
- `None`: Do not filter data.
|
-|xAxisIndexs|||Specify which xAxis is controlled by the dataZoom.
-|yAxisIndexs|||Specify which yAxis is controlled by the dataZoom.
-|supportInside|||Whether built-in support is supported. Built into the coordinate system to allow the user to zoom in and out of the coordinate system by mouse dragging, mouse wheel, finger swiping (on the touch screen).
-|supportInsideScroll|true||Whether inside scrolling is supported.
-|supportInsideDrag|true||Whether insde drag is supported.
-|supportSlider|||Whether a slider is supported. There are separate sliders on which the user zooms or roams.
-|supportMarquee|||Supported Box Selected. Provides a marquee for scaling the data area.
-|showDataShadow|||Whether to show data shadow, to indicate the data tendency in brief.
-|showDetail|||Whether to show detail, that is, show the detailed data information when dragging.
-|zoomLock|||Specify whether to lock the size of window (selected area).
-|fillerColor|||the color of dataZoom data area.
-|borderColor|||the color of dataZoom border.
-|borderWidth|||边框宽。
-|backgroundColor|||The background color of the component.
-|left|||Distance between dataZoom component and the left side of the container. left value is a instant pixel value like 10 or float value [0-1].
-|right|||Distance between dataZoom component and the right side of the container. right value is a instant pixel value like 10 or float value [0-1].
-|top|||Distance between dataZoom component and the top side of the container. top value is a instant pixel value like 10 or float value [0-1].
-|bottom|||Distance between dataZoom component and the bottom side of the container. bottom value is a instant pixel value like 10 or float value [0-1].
-|rangeMode|||Use absolute value or percent value in DataZoom.start and DataZoom.end.
`DataZoom.RangeMode`:
- `//Value`: The value type of start and end.取值类型
- `Percent`: percent value.
|
-|start|||The start percentage of the window out of the data extent, in the range of 0 ~ 100.
-|end|||The end percentage of the window out of the data extent, in the range of 0 ~ 100.
-|minShowNum|2||Minimum number of display data. Minimum number of data displayed when DataZoom is enlarged to maximum.
-|scrollSensitivity|1.1f||The sensitivity of dataZoom scroll. The larger the number, the more sensitive it is.
-|orient|||Specify whether the layout of dataZoom component is horizontal or vertical. What's more, it indicates whether the horizontal axis or vertical axis is controlled by default in catesian coordinate system.
`Orient`:
- `Horizonal`: 水平
- `Vertical`: 垂直
|
-|labelStyle|||label style. [LabelStyle](#labelstyle)|
-|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.
+阴影填充样式。
-```mdx-code-block
-
-```
+### DataZoom.backgroundColor
+
+`Color32`
+
+The background color of the component.
+
+### DataZoom.borderColor
+
+`Color32`
+
+the color of dataZoom border.
+
+### DataZoom.borderWidth
+
+`float`
+
+边框宽。
+
+### DataZoom.bottom
+
+`float`
+
+Distance between dataZoom component and the bottom side of the container. bottom value is a instant pixel value like 10 or float value [0-1].
+
+### DataZoom.enable
+
+`bool` `true`
+
+Whether to show dataZoom.
+
+### DataZoom.end
+
+`float`
+
+The end percentage of the window out of the data extent, in the range of 0 ~ 100.
+
+### DataZoom.endLock
+
+`bool` `v3.6.0`
+
+Lock end value.
+
+### DataZoom.fillerColor
+
+`Color32`
+
+the color of dataZoom data area.
+
+### DataZoom.filterMode
+
+[DataZoom.FilterMode](#datazoomfiltermode)
+
+The mode of data filter.
+
+Options:
+
+- `Filter`: data that outside the window will be filtered, which may lead to some changes of windows of other axes. For each data item, it will be filtered if one of the relevant dimensions is out of the window.
+- `WeakFilter`: data that outside the window will be filtered, which may lead to some changes of windows of other axes. For each data item, it will be filtered only if all of the relevant dimensions are out of the same side of the window.
+- `Empty`: data that outside the window will be set to NaN, which will not lead to changes of windows of other axes.
+- `None`: Do not filter data.
+
+### DataZoom.labelStyle
+
+[LabelStyle](#labelstyle)
+
+label style.
+
+### DataZoom.left
+
+`float`
+
+Distance between dataZoom component and the left side of the container. left value is a instant pixel value like 10 or float value [0-1].
+
+### DataZoom.lineStyle
+
+[LineStyle](#linestyle)
+
+阴影线条样式。
+
+### DataZoom.marqueeStyle
+
+[MarqueeStyle](#marqueestyle) `v3.5.0`
+
+选取框样式。
+
+### DataZoom.minShowNum
+
+`int` `2`
+
+Minimum number of display data. Minimum number of data displayed when DataZoom is enlarged to maximum.
+
+### DataZoom.orient
+
+[Orient](#orient)
+
+Specify whether the layout of dataZoom component is horizontal or vertical. What's more, it indicates whether the horizontal axis or vertical axis is controlled by default in catesian coordinate system.
+
+Options:
+
+- `Horizonal`: 水平
+- `Vertical`: 垂直
+
+### DataZoom.rangeMode
+
+[DataZoom.RangeMode](#datazoomrangemode)
+
+Use absolute value or percent value in DataZoom.start and DataZoom.end.
+
+Options:
+
+- `//Value`: The value type of start and end.取值类型
+- `Percent`: percent value.
+
+### DataZoom.right
+
+`float`
+
+Distance between dataZoom component and the right side of the container. right value is a instant pixel value like 10 or float value [0-1].
+
+### DataZoom.scrollSensitivity
+
+`float` `1.1f`
+
+The sensitivity of dataZoom scroll. The larger the number, the more sensitive it is.
+
+### DataZoom.showDataShadow
+
+`bool`
+
+Whether to show data shadow, to indicate the data tendency in brief.
+
+### DataZoom.showDetail
+
+`bool`
+
+Whether to show detail, that is, show the detailed data information when dragging.
+
+### DataZoom.start
+
+`float`
+
+The start percentage of the window out of the data extent, in the range of 0 ~ 100.
+
+### DataZoom.startLock
+
+`bool` `v3.6.0`
+
+Lock start value.
+
+### DataZoom.supportInside
+
+`bool`
+
+Whether built-in support is supported. Built into the coordinate system to allow the user to zoom in and out of the coordinate system by mouse dragging, mouse wheel, finger swiping (on the touch screen).
+
+### DataZoom.supportInsideDrag
+
+`bool` `true`
+
+Whether insde drag is supported.
+
+### DataZoom.supportInsideScroll
+
+`bool` `true`
+
+Whether inside scrolling is supported.
+
+### DataZoom.supportMarquee
+
+`bool`
+
+Supported Box Selected. Provides a marquee for scaling the data area.
+
+### DataZoom.supportSlider
+
+`bool`
+
+Whether a slider is supported. There are separate sliders on which the user zooms or roams.
+
+### DataZoom.top
+
+`float`
+
+Distance between dataZoom component and the top side of the container. top value is a instant pixel value like 10 or float value [0-1].
+
+### DataZoom.xAxisIndexs
+
+`List`
+
+Specify which xAxis is controlled by the dataZoom.
+
+### DataZoom.yAxisIndexs
+
+`List`
+
+Specify which yAxis is controlled by the dataZoom.
+
+### DataZoom.zoomLock
+
+`bool`
+
+Specify whether to lock the size of window (selected area).
## DataZoomTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
-```mdx-code-block
-
-```
+### DataZoomTheme.backgroundColor
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|borderWidth|||the width of border line.
-|dataLineWidth|||the width of data line.
-|fillerColor|||the color of dataZoom data area.
-|borderColor|||the color of dataZoom border.
-|dataLineColor|||the color of data area line.
-|dataAreaColor|||the color of data area line.
-|backgroundColor|||the background color of datazoom.
+the background color of datazoom.
-```mdx-code-block
-
-```
+### DataZoomTheme.borderColor
+
+`Color32`
+
+the color of dataZoom border.
+
+### DataZoomTheme.borderWidth
+
+`float`
+
+the width of border line.
+
+### DataZoomTheme.dataAreaColor
+
+`Color32`
+
+the color of data area line.
+
+### DataZoomTheme.dataLineColor
+
+`Color32`
+
+the color of data area line.
+
+### DataZoomTheme.dataLineWidth
+
+`float`
+
+the width of data line.
+
+### DataZoomTheme.fillerColor
+
+`Color32`
+
+the color of dataZoom data area.
## DebugInfo
-> class in XCharts.Runtime
+class in XCharts.Runtime
-```mdx-code-block
-
-```
+### DebugInfo.foldSeries
+`bool` `false`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether show debug component.
-|showDebugInfo|false||
-|showAllChartObject|false||Whether show children components of chart in hierarchy view.
-|foldSeries|false||Whether to fold series in inspector view.
-|labelStyle||| [LabelStyle](#labelstyle)|
+Whether to fold series in inspector view.
-```mdx-code-block
-
-```
+### DebugInfo.labelStyle
+
+[LabelStyle](#labelstyle)
+
+### DebugInfo.show
+
+`bool` `true`
+
+Whether show debug component.
+
+### DebugInfo.showAllChartObject
+
+`bool` `false`
+
+Whether show children components of chart in hierarchy view.
+
+### DebugInfo.showDebugInfo
+
+`bool` `false`
## EffectScatter
-> class in XCharts.Runtime / Inherits from: [BaseScatter](#basescatter)
+class in XCharts.Runtime / Inherits from: [BaseScatter](#basescatter)
## EmphasisStyle
-> class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
> Since `v3.2.0`
Configurations of emphasis state.
-```mdx-code-block
-
-```
+### EmphasisStyle.blurScope
+[EmphasisStyle.BlurScope](#emphasisstyleblurscope)
-|field|default|since|comment|
-|--|--|--|--|
-|scale|1.1f||Whether to scale to highlight the data in emphasis state.
-|focus|||When the data is highlighted, whether to fade out of other data to focus the highlighted.
`EmphasisStyle.FocusType`:
- `None`: Do not fade out other data, it's by default.
- `Self`: Only focus (not fade out) the element of the currently highlighted data.
- `Series`: Focus on all elements of the series which the currently highlighted data belongs to.
|
-|blurScope|||The range of fade out when focus is enabled.
`EmphasisStyle.BlurScope`:
- `GridCoord`: coordinate system.
- `Series`: series.
- `Global`: global.
|
+The range of fade out when focus is enabled.
-```mdx-code-block
-
-```
+Options:
+
+- `GridCoord`: coordinate system.
+- `Series`: series.
+- `Global`: global.
+
+### EmphasisStyle.focus
+
+[EmphasisStyle.FocusType](#emphasisstylefocustype)
+
+When the data is highlighted, whether to fade out of other data to focus the highlighted.
+
+Options:
+
+- `None`: Do not fade out other data, it's by default.
+- `Self`: Only focus (not fade out) the element of the currently highlighted data.
+- `Series`: Focus on all elements of the series which the currently highlighted data belongs to.
+
+### EmphasisStyle.scale
+
+`float` `1.1f`
+
+Whether to scale to highlight the data in emphasis state.
## EndLabelStyle
-> class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle)
+class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle)
## GridCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer)
Grid component.
-```mdx-code-block
-
-```
+### GridCoord.backgroundColor
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether to show the grid in rectangular coordinate.
-|layoutIndex|-1|v3.8.0|The index of the grid layout component to which the grid belongs. The default is -1, which means that it does not belong to any grid layout component. When this value is set, the left, right, top, and bottom properties will be invalid.
-|left|0.11f||Distance between grid component and the left side of the container.
-|right|0.08f||Distance between grid component and the right side of the container.
-|top|0.22f||Distance between grid component and the top side of the container.
-|bottom|0.14f||Distance between grid component and the bottom side of the container.
-|backgroundColor|||Background color of grid, which is transparent by default.
-|showBorder|false||Whether to show the grid border.
-|borderWidth|0f||Border width of grid.
-|borderColor|||The color of grid border.
+Background color of grid, which is transparent by default.
-```mdx-code-block
-
-```
+### GridCoord.borderColor
+
+`Color32`
+
+The color of grid border.
+
+### GridCoord.borderWidth
+
+`float` `0f`
+
+Border width of grid.
+
+### GridCoord.bottom
+
+`float` `0.14f`
+
+Distance between grid component and the bottom side of the container.
+
+### GridCoord.layoutIndex
+
+`int` `-1` `v3.8.0`
+
+The index of the grid layout component to which the grid belongs. The default is -1, which means that it does not belong to any grid layout component. When this value is set, the left, right, top, and bottom properties will be invalid.
+
+### GridCoord.left
+
+`float` `0.11f`
+
+Distance between grid component and the left side of the container.
+
+### GridCoord.right
+
+`float` `0.08f`
+
+Distance between grid component and the right side of the container.
+
+### GridCoord.show
+
+`bool` `true`
+
+Whether to show the grid in rectangular coordinate.
+
+### GridCoord.showBorder
+
+`bool` `false`
+
+Whether to show the grid border.
+
+### GridCoord.top
+
+`float` `0.22f`
+
+Distance between grid component and the top side of the container.
## GridCoord3D
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer)
> Since `v3.11.0`
Grid component.
-```mdx-code-block
-
-```
+### GridCoord3D.bottom
+`float` `0.15f`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether to show the grid in rectangular coordinate.
-|left|0.15f||Distance between grid component and the left side of the container.
-|right|0.2f||Distance between grid component and the right side of the container.
-|top|0.3f||Distance between grid component and the top side of the container.
-|bottom|0.15f||Distance between grid component and the bottom side of the container.
-|showBorder|false||Whether to show the grid border.
-|boxWidth|0.55f||The width of the box in the coordinate system.
-|boxHeight|0.4f||The height of the box in the coordinate system.
-|boxDepth|0.2f||The depth of the box in the coordinate system.
-|xYExchanged|false||
-|viewControl|||View control component in 3D coordinate system. [ViewControl](#viewcontrol)|
+Distance between grid component and the bottom side of the container.
-```mdx-code-block
-
-```
+### GridCoord3D.boxDepth
+
+`float` `0.2f`
+
+The depth of the box in the coordinate system.
+
+### GridCoord3D.boxHeight
+
+`float` `0.4f`
+
+The height of the box in the coordinate system.
+
+### GridCoord3D.boxWidth
+
+`float` `0.55f`
+
+The width of the box in the coordinate system.
+
+### GridCoord3D.left
+
+`float` `0.15f`
+
+Distance between grid component and the left side of the container.
+
+### GridCoord3D.right
+
+`float` `0.2f`
+
+Distance between grid component and the right side of the container.
+
+### GridCoord3D.show
+
+`bool` `true`
+
+Whether to show the grid in rectangular coordinate.
+
+### GridCoord3D.showBorder
+
+`bool` `false`
+
+Whether to show the grid border.
+
+### GridCoord3D.top
+
+`float` `0.3f`
+
+Distance between grid component and the top side of the container.
+
+### GridCoord3D.viewControl
+
+[ViewControl](#viewcontrol)
+
+View control component in 3D coordinate system.
+
+### GridCoord3D.xYExchanged
+
+`bool` `false`
## GridLayout
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent), [IUpdateRuntimeData](#iupdateruntimedata)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent), [IUpdateRuntimeData](#iupdateruntimedata)
> Since `v3.8.0`
Grid layout component. Used to manage the layout of multiple `GridCoord`, and the number of rows and columns of the grid can be controlled by `row` and `column`.
-```mdx-code-block
-
-```
+### GridLayout.bottom
+`float` `0.12f`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether to show the grid in rectangular coordinate.
-|left|0.1f||Distance between grid component and the left side of the container.
-|right|0.08f||Distance between grid component and the right side of the container.
-|top|0.22f||Distance between grid component and the top side of the container.
-|bottom|0.12f||Distance between grid component and the bottom side of the container.
-|row|2||the row count of grid layout.
-|column|2||the column count of grid layout.
-|spacing|Vector2.zero||the spacing of grid layout.
-|inverse|false||Whether to inverse the grid layout.
+Distance between grid component and the bottom side of the container.
-```mdx-code-block
-
-```
+### GridLayout.column
+
+`int` `2`
+
+the column count of grid layout.
+
+### GridLayout.inverse
+
+`bool` `false`
+
+Whether to inverse the grid layout.
+
+### GridLayout.left
+
+`float` `0.1f`
+
+Distance between grid component and the left side of the container.
+
+### GridLayout.right
+
+`float` `0.08f`
+
+Distance between grid component and the right side of the container.
+
+### GridLayout.row
+
+`int` `2`
+
+the row count of grid layout.
+
+### GridLayout.show
+
+`bool` `true`
+
+Whether to show the grid in rectangular coordinate.
+
+### GridLayout.spacing
+
+`Vector2` `Vector2.zero`
+
+the spacing of grid layout.
+
+### GridLayout.top
+
+`float` `0.22f`
+
+Distance between grid component and the top side of the container.
## Heatmap
-> class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
-```mdx-code-block
-
-```
+### Heatmap.heatmapType
+[HeatmapType](#heatmaptype) `v3.3.0`
-|field|default|since|comment|
-|--|--|--|--|
-|heatmapType||v3.3.0|The mapping type of heatmap.
`HeatmapType`:
- `Data`: Data mapping type.By default, the second dimension data is used as the color map.
- `Count`: Number mapping type.The number of occurrences of a statistic in a divided grid, as a color map.
|
+The mapping type of heatmap.
-```mdx-code-block
-
-```
+Options:
+
+- `Data`: Data mapping type.By default, the second dimension data is used as the color map.
+- `Count`: Number mapping type.The number of occurrences of a statistic in a divided grid, as a color map.
## IconStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
-```mdx-code-block
-
-```
+### IconStyle.align
+[Align](#align)
-|field|default|since|comment|
-|--|--|--|--|
-|show|false||Whether the data icon is show.
-|layer|||显示在上层还是在下层。
`IconStyle.Layer`:
- `UnderText`: The icon is display under the label text. 图标在标签文字下
- `AboveText`: The icon is display above the label text. 图标在标签文字上
|
-|align|||水平方向对齐方式。
`Align`:
- `Center`: Alignment mode.
- `Left`: Alignment mode.
- `Right`: Alignment mode.
|
-|sprite|||The image of icon.
-|type|||How to display the icon.
-|color|||图标颜色。
-|width|20||图标宽。
-|height|20||图标高。
-|offset|||图标偏移。
-|autoHideWhenLabelEmpty|false||当label内容为空时是否自动隐藏图标
+水平方向对齐方式。
-```mdx-code-block
-
-```
+Options:
+
+- `Center`: Alignment mode.
+- `Left`: Alignment mode.
+- `Right`: Alignment mode.
+
+### IconStyle.autoHideWhenLabelEmpty
+
+`bool` `false`
+
+当label内容为空时是否自动隐藏图标
+
+### IconStyle.color
+
+`Color`
+
+图标颜色。
+
+### IconStyle.height
+
+`float` `20`
+
+图标高。
+
+### IconStyle.layer
+
+[IconStyle.Layer](#iconstylelayer)
+
+显示在上层还是在下层。
+
+Options:
+
+- `UnderText`: The icon is display under the label text. 图标在标签文字下
+- `AboveText`: The icon is display above the label text. 图标在标签文字上
+
+### IconStyle.offset
+
+`Vector3`
+
+图标偏移。
+
+### IconStyle.show
+
+`bool` `false`
+
+Whether the data icon is show.
+
+### IconStyle.sprite
+
+`Sprite`
+
+The image of icon.
+
+### IconStyle.type
+
+`Image.Type`
+
+How to display the icon.
+
+### IconStyle.width
+
+`float` `20`
+
+图标宽。
## ImageStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
-```mdx-code-block
-
-```
+### ImageStyle.autoColor
+`bool`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether the data icon is show.
-|sprite|||The image of icon.
-|type|||How to display the image.
-|autoColor|||是否自动颜色。
-|color|||图标颜色。
-|width|0||图标宽。
-|height|0||图标高。
+是否自动颜色。
-```mdx-code-block
-
-```
+### ImageStyle.color
+
+`Color`
+
+图标颜色。
+
+### ImageStyle.height
+
+`float` `0`
+
+图标高。
+
+### ImageStyle.show
+
+`bool` `true`
+
+Whether the data icon is show.
+
+### ImageStyle.sprite
+
+`Sprite`
+
+The image of icon.
+
+### ImageStyle.type
+
+`Image.Type`
+
+How to display the image.
+
+### ImageStyle.width
+
+`float` `0`
+
+图标宽。
## Indicator
-> class in XCharts.Runtime
+class in XCharts.Runtime
Indicator of radar chart, which is used to assign multiple variables(dimensions) in radar chart.
-```mdx-code-block
-
-```
+### Indicator.axisLine
+[AxisLine](#axisline)
-|field|default|since|comment|
-|--|--|--|--|
-|name|||The name of indicator.
-|max|||The maximum value of indicator, with default value of 0, but we recommend to set it manually.
-|min|||The minimum value of indicator, with default value of 0.
-|range|||Normal range. When the value is outside this range, the display color is automatically changed.
-|show|||[default:true] Set this to false to prevent the radar from showing.
-|shape|||Radar render type, in which 'Polygon' and 'Circle' are supported.
-|radius|100||the radius of radar.
-|splitNumber|5||Segments of indicator axis.
-|center|||the center of radar chart.
-|axisLine|||axis line. [AxisLine](#axisline)|
-|axisName|||Name options for radar indicators. [AxisName](#axisname)|
-|splitLine|||split line. [AxisSplitLine](#axissplitline)|
-|splitArea|||Split area of axis in grid area. [AxisSplitArea](#axissplitarea)|
-|indicator|true||Whether to show indicator.
-|positionType|||The position type of indicator.
-|indicatorGap|10||The gap of indicator and radar.
-|ceilRate|0||The ratio of maximum and minimum values rounded upward. The default is 0, which is automatically calculated.
-|isAxisTooltip|||是否Tooltip显示轴线上的所有数据。
-|outRangeColor|Color.red||The color displayed when data out of range.
-|connectCenter|false||Whether serie data connect to radar center with line.
-|lineGradient|true||Whether need gradient for data line.
-|startAngle||v3.4.0|起始角度。和时钟一样,12点钟位置是0度,顺时针到360度。
-|gridIndex|-1|v3.8.0|Index of layout component that serie uses. Default is -1 means not use layout, otherwise use the first layout component.
-|indicatorList|||the indicator list.
+axis line.
-```mdx-code-block
-
-```
+### Indicator.axisName
+
+[AxisName](#axisname)
+
+Name options for radar indicators.
+
+### Indicator.ceilRate
+
+`double` `0`
+
+The ratio of maximum and minimum values rounded upward. The default is 0, which is automatically calculated.
+
+### Indicator.center
+
+`float[]`
+
+the center of radar chart.
+
+### Indicator.connectCenter
+
+`bool` `false`
+
+Whether serie data connect to radar center with line.
+
+### Indicator.gridIndex
+
+`int` `-1` `v3.8.0`
+
+Index of layout component that serie uses. Default is -1 means not use layout, otherwise use the first layout component.
+
+### Indicator.indicator
+
+`bool` `true`
+
+Whether to show indicator.
+
+### Indicator.indicatorGap
+
+`float` `10`
+
+The gap of indicator and radar.
+
+### Indicator.indicatorList
+
+`List`
+
+the indicator list.
+
+### Indicator.isAxisTooltip
+
+`bool`
+
+是否Tooltip显示轴线上的所有数据。
+
+### Indicator.lineGradient
+
+`bool` `true`
+
+Whether need gradient for data line.
+
+### Indicator.max
+
+`double`
+
+The maximum value of indicator, with default value of 0, but we recommend to set it manually.
+
+### Indicator.min
+
+`double`
+
+The minimum value of indicator, with default value of 0.
+
+### Indicator.name
+
+`string`
+
+The name of indicator.
+
+### Indicator.outRangeColor
+
+`Color32` `Color.red`
+
+The color displayed when data out of range.
+
+### Indicator.positionType
+
+`PositionType`
+
+The position type of indicator.
+
+### Indicator.radius
+
+`float` `100`
+
+the radius of radar.
+
+### Indicator.range
+
+`double[]`
+
+Normal range. When the value is outside this range, the display color is automatically changed.
+
+### Indicator.shape
+
+`Shape`
+
+Radar render type, in which 'Polygon' and 'Circle' are supported.
+
+### Indicator.show
+
+`bool`
+
+[default:true] Set this to false to prevent the radar from showing.
+
+### Indicator.splitArea
+
+[AxisSplitArea](#axissplitarea)
+
+Split area of axis in grid area.
+
+### Indicator.splitLine
+
+[AxisSplitLine](#axissplitline)
+
+split line.
+
+### Indicator.splitNumber
+
+`int` `5`
+
+Segments of indicator axis.
+
+### Indicator.startAngle
+
+`float` `v3.4.0`
+
+起始角度。和时钟一样,12点钟位置是0度,顺时针到360度。
## INeedSerieContainer
-> class in XCharts.Runtime / Subclasses: [Bar](#bar), [SimplifiedBar](#simplifiedbar), [Candlestick](#candlestick), [SimplifiedCandlestick](#simplifiedcandlestick), [Heatmap](#heatmap), [Line](#line), [SimplifiedLine](#simplifiedline), [Parallel](#parallel), [Radar](#radar), [BaseScatter](#basescatter)
+class in XCharts.Runtime / Subclasses: [Bar](#bar), [SimplifiedBar](#simplifiedbar), [Candlestick](#candlestick), [SimplifiedCandlestick](#simplifiedcandlestick), [Heatmap](#heatmap), [Line](#line), [SimplifiedLine](#simplifiedline), [Parallel](#parallel), [Radar](#radar), [BaseScatter](#basescatter)
## IPropertyChanged
-> class in XCharts.Runtime / Subclasses: [Location](#location), [Comment](#comment), [Legend](#legend), [Title](#title)
+class in XCharts.Runtime / Subclasses: [Location](#location), [Comment](#comment), [Legend](#legend), [Title](#title)
属性变更接口
## ISerieComponent
-> class in XCharts.Runtime / Subclasses: [AreaStyle](#areastyle), [ImageStyle](#imagestyle), [LineArrow](#linearrow), [LabelLine](#labelline), [LabelStyle](#labelstyle), [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle), [TitleStyle](#titlestyle)
+class in XCharts.Runtime / Subclasses: [AreaStyle](#areastyle), [ImageStyle](#imagestyle), [LineArrow](#linearrow), [LabelLine](#labelline), [LabelStyle](#labelstyle), [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle), [TitleStyle](#titlestyle)
The interface for serie component.
## ISerieContainer
-> class in XCharts.Runtime / Subclasses: [RadarCoord](#radarcoord), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [GridCoord3D](#gridcoord3d), [ParallelCoord](#parallelcoord), [PolarCoord](#polarcoord)
+class in XCharts.Runtime / Subclasses: [RadarCoord](#radarcoord), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [GridCoord3D](#gridcoord3d), [ParallelCoord](#parallelcoord), [PolarCoord](#polarcoord)
## ISerieDataComponent
-> class in XCharts.Runtime / Subclasses: [AreaStyle](#areastyle), [ImageStyle](#imagestyle), [ItemStyle](#itemstyle), [LineStyle](#linestyle), [SerieSymbol](#seriesymbol), [LabelLine](#labelline), [LabelStyle](#labelstyle), [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle), [TitleStyle](#titlestyle)
+class in XCharts.Runtime / Subclasses: [AreaStyle](#areastyle), [ImageStyle](#imagestyle), [ItemStyle](#itemstyle), [LineStyle](#linestyle), [SerieSymbol](#seriesymbol), [LabelLine](#labelline), [LabelStyle](#labelstyle), [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle), [TitleStyle](#titlestyle)
The interface for serie data component.
## ISimplifiedSerie
-> class in XCharts.Runtime / Subclasses: [SimplifiedBar](#simplifiedbar), [SimplifiedCandlestick](#simplifiedcandlestick), [SimplifiedLine](#simplifiedline)
+class in XCharts.Runtime / Subclasses: [SimplifiedBar](#simplifiedbar), [SimplifiedCandlestick](#simplifiedcandlestick), [SimplifiedLine](#simplifiedline)
## ItemStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieDataComponent](#iseriedatacomponent)
图形样式。
-```mdx-code-block
-
-```
+### ItemStyle.backgroundColor
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||是否启用。
-|color|||数据项颜色。
-|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|||中心区域颜色。
-|centerGap|||中心区域间隙。
-|borderWidth|0||边框宽。
-|borderGap|0||边框间隙。
-|borderColor|||边框的颜色。
-|borderColor0|||边框的颜色。
-|borderToColor|||边框的渐变色。
-|opacity|1||透明度。支持从 0 到 1 的数字,为 0 时不绘制该图形。
-|itemMarker|||提示框单项的字符标志。用在Tooltip中。
-|itemFormatter|||提示框单项的字符串模版格式器。具体配置参考`Tooltip`的`formatter`
-|numericFormatter|||Standard numeric format strings.
-|cornerRadius|||The radius of rounded corner. Its unit is px. Use array to respectively specify the 4 corner radiuses((clockwise upper left, upper right, bottom right and bottom left)).
+数据项背景颜色。
-```mdx-code-block
-
-```
+### ItemStyle.backgroundWidth
+
+`float`
+
+数据项背景宽度。
+
+### ItemStyle.borderColor
+
+`Color32`
+
+边框的颜色。
+
+### ItemStyle.borderColor0
+
+`Color32`
+
+边框的颜色。
+
+### ItemStyle.borderGap
+
+`float` `0`
+
+边框间隙。
+
+### ItemStyle.borderToColor
+
+`Color32`
+
+边框的渐变色。
+
+### ItemStyle.borderWidth
+
+`float` `0`
+
+边框宽。
+
+### ItemStyle.centerColor
+
+`Color32`
+
+中心区域颜色。
+
+### ItemStyle.centerGap
+
+`float`
+
+中心区域间隙。
+
+### ItemStyle.color
+
+`Color32`
+
+数据项颜色。
+
+### ItemStyle.color0
+
+`Color32`
+
+数据项颜色。
+
+### ItemStyle.cornerRadius
+
+`float[]`
+
+The radius of rounded corner. Its unit is px. Use array to respectively specify the 4 corner radiuses((clockwise upper left, upper right, bottom right and bottom left)).
+
+### ItemStyle.itemFormatter
+
+`string`
+
+提示框单项的字符串模版格式器。具体配置参考`Tooltip`的`formatter`
+
+### ItemStyle.itemMarker
+
+`string`
+
+提示框单项的字符标志。用在Tooltip中。
+
+### ItemStyle.markColor
+
+`Color32` `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.
+
+### ItemStyle.numericFormatter
+
+`string`
+
+Standard number and date format string. Used to format a Double value or a DateTime date as a string. numericFormatter is used as an argument to either `Double.ToString ()` or `DateTime.ToString()`.
The number format uses the Axx format: A is a single-character format specifier that supports C currency, D decimal, E exponent, F fixed-point number, G regular, N digit, P percentage, R round trip, and X hexadecimal. xx is precision specification, from 0-99. E.g. F1, E2
Date format: Starts with `date`, which is used to format DateTime. Common date formats are: yyyy year, MM month, dd day, HH hour, mm minute, ss second, fff millisecond. For example: date:yyyy-MM-dd HH:mm:ss
Time format: Starts with `time`, which is used to format TimeSpan. Common time formats are: d day, HH hour, mm minute, ss second, fffffff fractional part. Only the version of Unity2018 or later can support formatting, and the characters inside should be escaped. For example: time:HH\:mm\:ss
number format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
date format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
Note: The date and time formats are only supported by 'v3.12.0' or later.
+
+### ItemStyle.opacity
+
+`float` `1`
+
+透明度。支持从 0 到 1 的数字,为 0 时不绘制该图形。
+
+### ItemStyle.show
+
+`bool` `true`
+
+是否启用。
+
+### ItemStyle.toColor
+
+`Color32`
+
+Gradient color1.
+
+### ItemStyle.toColor2
+
+`Color32`
+
+Gradient color2.Only valid in line diagrams.
## IUpdateRuntimeData
-> class in XCharts.Runtime / Subclasses: [SingleAxis](#singleaxis), [DataZoom](#datazoom), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [GridLayout](#gridlayout), [GridCoord3D](#gridcoord3d), [ParallelCoord](#parallelcoord)
+class in XCharts.Runtime / Subclasses: [SingleAxis](#singleaxis), [DataZoom](#datazoom), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [GridLayout](#gridlayout), [GridCoord3D](#gridcoord3d), [ParallelCoord](#parallelcoord)
## LabelLine
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
标签的引导线
-```mdx-code-block
-
-```
+### LabelLine.endSymbol
+[SymbolStyle](#symbolstyle)
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether the label line is showed.
-|lineType|||the type of visual guide line.
`LabelLine.LineType`:
- `BrokenLine`: 折线
- `Curves`: 曲线
- `HorizontalLine`: 水平线
|
-|lineColor|Color32(0,0,0,0)||the color of visual guild line.
-|lineAngle|60||the angle of visual guild line. Valid for broken line and curve line. Invalid in Pie.
-|lineWidth|1.0f||the width of visual guild line.
-|lineGap|1.0f||the gap of container and guild line.
-|lineLength1|25f||The length of the first segment of visual guide line.
-|lineLength2|15f||The length of the second segment of visual guide line.
-|lineEndX|0f|v3.8.0|The fixed x position of the end point of visual guide line.
-|startSymbol|||The symbol of the start point of labelline. [SymbolStyle](#symbolstyle)|
-|endSymbol|||The symbol of the end point of labelline. [SymbolStyle](#symbolstyle)|
+The symbol of the end point of labelline.
-```mdx-code-block
-
-```
+### LabelLine.lineAngle
+
+`float` `60`
+
+the angle of visual guild line. Valid for broken line and curve line. Invalid in Pie.
+
+### LabelLine.lineColor
+
+`Color32` `Color32(0,0,0,0)`
+
+the color of visual guild line.
+
+### LabelLine.lineEndX
+
+`float` `0f` `v3.8.0`
+
+The fixed x position of the end point of visual guide line.
+
+### LabelLine.lineGap
+
+`float` `1.0f`
+
+the gap of container and guild line.
+
+### LabelLine.lineLength1
+
+`float` `25f`
+
+The length of the first segment of visual guide line.
+
+### LabelLine.lineLength2
+
+`float` `15f`
+
+The length of the second segment of visual guide line.
+
+### LabelLine.lineType
+
+[LabelLine.LineType](#labellinelinetype)
+
+the type of visual guide line.
+
+Options:
+
+- `BrokenLine`: 折线
+- `Curves`: 曲线
+- `HorizontalLine`: 水平线
+
+### LabelLine.lineWidth
+
+`float` `1.0f`
+
+the width of visual guild line.
+
+### LabelLine.show
+
+`bool` `true`
+
+Whether the label line is showed.
+
+### LabelLine.startSymbol
+
+[SymbolStyle](#symbolstyle)
+
+The symbol of the start point of labelline.
## LabelStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) / Subclasses: [AxisLabel](#axislabel), [EndLabelStyle](#endlabelstyle), [TitleStyle](#titlestyle)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) / Subclasses: [AxisLabel](#axislabel), [EndLabelStyle](#endlabelstyle), [TitleStyle](#titlestyle)
Text label of chart, to explain some data information about graphic item like value, name and so on.
-```mdx-code-block
-
-```
+### LabelStyle.autoOffset
+`bool` `false`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether the label is showed.
-|Position|||The position of label.
-|autoOffset|false||Whether to automatically offset. When turned on, the Y offset will automatically determine the opening of the curve to determine whether to offset up or down.
-|offset|||offset to the host graphic element.
-|rotate|||Rotation of label.
-|autoRotate|false|v3.6.0|auto rotate of label.
-|distance|||the distance of label to axis line.
-|formatter|||label content string template formatter. \n line wrapping is supported. Formatters for some components will not take effect.
Template placeholder have the following, some of which apply only to fixed components:
`{.}` : indicates the dot mark.
`{a}` : indicates the series name.
`{b}` : category value of x axis or data name.
`{c}` : data value.
`{d}` : percentage.
`{e}` : indicates the data name.
`{f}` : data sum.
`{g}` : indicates the total number of data.
`{h}` : hexadecimal color value.
`{y}` : category value of y axis.
`{value}` : The value of the axis or legend.
The following placeholder apply to `UITable` components:
`{name}` : indicates the row name of the table.
`{index}` : indicates the row number of the table.
The following placeholder apply to `UIStatistc` components:
`{title}` : title text.
`{dd}` : day.
`{hh}` : hours.
`{mm}` : minutes.
`{ss}` : second.
`{fff}` : milliseconds.
`{d}` : day.
`{h}` : hours.
`{m}` : minutes.
`{s}` : second.
`{f}` : milliseconds.
Example :{b}:{c}
-|numericFormatter|||Standard number and date format string. Used to format a Double value or a DateTime date as a string. numericFormatter is used as an argument to either `Double.ToString ()` or `DateTime.ToString()`.
The number format uses the Axx format: A is a single-character format specifier that supports C currency, D decimal, E exponent, F fixed-point number, G regular, N digit, P percentage, R round trip, and X hexadecimal. xx is precision specification, from 0-99. E.g. F1, E2
Date format Common date formats are: yyyy year, MM month, dd day, HH hour, mm minute, ss second, fff millisecond. For example: yyyy-MM-dd HH:mm:ss
number format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
date format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
-|width|0||the width of label. If set as default value 0, it means than the label width auto set as the text width.
-|height|0||the height of label. If set as default value 0, it means than the label height auto set as the text height.
-|icon|||the sytle of icon. [IconStyle](#iconstyle)|
-|background|||the sytle of background. [ImageStyle](#imagestyle)|
-|textPadding|||the text padding of label. [TextPadding](#textpadding)|
-|textStyle|||the sytle of text. [TextStyle](#textstyle)|
+Whether to automatically offset. When turned on, the Y offset will automatically determine the opening of the curve to determine whether to offset up or down.
-```mdx-code-block
-
-```
+### LabelStyle.autoRotate
+
+`bool` `false` `v3.6.0`
+
+auto rotate of label.
+
+### LabelStyle.background
+
+[ImageStyle](#imagestyle)
+
+the sytle of background.
+
+### LabelStyle.distance
+
+`float`
+
+the distance of label to axis line.
+
+### LabelStyle.formatter
+
+`string`
+
+label content string template formatter. \n line wrapping is supported. Formatters for some components will not take effect.
Template placeholder have the following, some of which apply only to fixed components:
`{.}` : indicates the dot mark.
`{a}` : indicates the series name.
`{b}` : category value of x axis or data name.
`{c}` : data value.
`{d}` : percentage.
`{e}` : indicates the data name.
`{f}` : data sum.
`{g}` : indicates the total number of data.
`{h}` : hexadecimal color value.
`{y}` : category value of y axis.
`{value}` : The value of the axis or legend.
The following placeholder apply to `UITable` components:
`{name}` : indicates the row name of the table.
`{index}` : indicates the row number of the table.
The following placeholder apply to `UIStatistc` components:
`{title}` : title text.
`{dd}` : day.
`{hh}` : hours.
`{mm}` : minutes.
`{ss}` : second.
`{fff}` : milliseconds.
`{d}` : day.
`{h}` : hours.
`{m}` : minutes.
`{s}` : second.
`{f}` : milliseconds.
Example :{b}:{c}
+
+### LabelStyle.height
+
+`float` `0`
+
+the height of label. If set as default value 0, it means than the label height auto set as the text height.
+
+### LabelStyle.icon
+
+[IconStyle](#iconstyle)
+
+the sytle of icon.
+
+### LabelStyle.numericFormatter
+
+`string`
+
+Standard number and date format string. Used to format a Double value or a DateTime date as a string. numericFormatter is used as an argument to either `Double.ToString ()` or `DateTime.ToString()`.
The number format uses the Axx format: A is a single-character format specifier that supports C currency, D decimal, E exponent, F fixed-point number, G regular, N digit, P percentage, R round trip, and X hexadecimal. xx is precision specification, from 0-99. E.g. F1, E2
Date format: Starts with `date`, which is used to format DateTime. Common date formats are: yyyy year, MM month, dd day, HH hour, mm minute, ss second, fff millisecond. For example: date:yyyy-MM-dd HH:mm:ss
Time format: Starts with `time`, which is used to format TimeSpan. Common time formats are: d day, HH hour, mm minute, ss second, fffffff fractional part. Only the version of Unity2018 or later can support formatting, and the characters inside should be escaped. For example: time:HH\:mm\:ss
number format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
date format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
Note: The date and time formats are only supported by 'v3.12.0' or later.
+
+### LabelStyle.offset
+
+`Vector3`
+
+offset to the host graphic element.
+
+### LabelStyle.Position
+
+`[SerializeField]`
+
+The position of label.
+
+### LabelStyle.rotate
+
+`float`
+
+Rotation of label.
+
+### LabelStyle.show
+
+`bool` `true`
+
+Whether the label is showed.
+
+### LabelStyle.textPadding
+
+[TextPadding](#textpadding)
+
+the text padding of label.
+
+### LabelStyle.textStyle
+
+[TextStyle](#textstyle)
+
+the sytle of text.
+
+### LabelStyle.width
+
+`float` `0`
+
+the width of label. If set as default value 0, it means than the label width auto set as the text width.
## Lang
-> class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=ScriptableObject)
+class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=ScriptableObject)
Language.
## LangCandlestick
-> class in XCharts.Runtime
+class in XCharts.Runtime
## LangTime
-> class in XCharts.Runtime
+class in XCharts.Runtime
## Legend
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged)
Legend component.The legend component shows different sets of tags, colors, and names. You can control which series are not displayed by clicking on the legend.
-```mdx-code-block
-
-```
+### Legend.background
+[ImageStyle](#imagestyle) `v3.1.0`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether to show legend component.
-|iconType|||Type of legend.
`Legend.Type`:
- `Auto`: 自动匹配。
- `Custom`: 自定义图标。
- `EmptyCircle`: 空心圆。
- `Circle`: 圆形。
- `Rect`: 正方形。可通过Setting的legendIconCornerRadius参数调整圆角。
- `Triangle`: 三角形。
- `Diamond`: 菱形。
- `Candlestick`: 烛台(可用于K线图)。
|
-|selectedMode|||Selected mode of legend, which controls whether series can be toggled displaying by clicking legends.
`Legend.SelectedMode`:
- `Multiple`: 多选。
- `Single`: 单选。
- `None`: 无法选择。
|
-|orient|||Specify whether the layout of legend component is horizontal or vertical.
`Orient`:
- `Horizonal`: 水平
- `Vertical`: 垂直
|
-|location|||The location of legend. [Location](#location)|
-|itemWidth|25.0f||Image width of legend symbol.
-|itemHeight|12.0f||Image height of legend symbol.
-|itemGap|10f||The distance between each legend, horizontal distance in horizontal layout, and vertical distance in vertical layout.
-|itemAutoColor|true||Whether the legend symbol matches the color automatically.
-|itemOpacity|1||the opacity of item color.
-|formatter|||No longer used, the use of LabelStyle.formatter instead.
-|labelStyle|||the style of text. [LabelStyle](#labelstyle)|
-|textLimit||v3.10.0|the limit of text. [TextLimit](#textlimit)|
-|data|||Data array of legend. An array item is usually a name representing string. (If it is a pie chart, it could also be the name of a single data in the pie chart) of a series. If data is not specified, it will be auto collected from series.
-|icons|||自定义的图例标记图形。
-|colors|||the colors of legend item.
-|background||v3.1.0|the sytle of background. [ImageStyle](#imagestyle)|
-|padding||v3.1.0|the paddinng of item and background. [Padding](#padding)|
-|positions||v3.6.0|the custom positions of legend item.
+the sytle of background.
-```mdx-code-block
-
-```
+### Legend.colors
+
+`List`
+
+the colors of legend item.
+
+### Legend.data
+
+`List`
+
+Data array of legend. An array item is usually a name representing string. (If it is a pie chart, it could also be the name of a single data in the pie chart) of a series. If data is not specified, it will be auto collected from series.
+
+### Legend.formatter
+
+`string`
+
+No longer used, the use of LabelStyle.formatter instead.
+
+### Legend.icons
+
+`List`
+
+自定义的图例标记图形。
+
+### Legend.iconType
+
+[Legend.Type](#legendtype)
+
+Type of legend.
+
+Options:
+
+- `Auto`: 自动匹配。
+- `Custom`: 自定义图标。
+- `EmptyCircle`: 空心圆。
+- `Circle`: 圆形。
+- `Rect`: 正方形。可通过Setting的legendIconCornerRadius参数调整圆角。
+- `Triangle`: 三角形。
+- `Diamond`: 菱形。
+- `Candlestick`: 烛台(可用于K线图)。
+
+### Legend.itemAutoColor
+
+`bool` `true`
+
+Whether the legend symbol matches the color automatically.
+
+### Legend.itemGap
+
+`float` `10f`
+
+The distance between each legend, horizontal distance in horizontal layout, and vertical distance in vertical layout.
+
+### Legend.itemHeight
+
+`float` `12.0f`
+
+Image height of legend symbol.
+
+### Legend.itemOpacity
+
+`float` `1`
+
+the opacity of item color.
+
+### Legend.itemWidth
+
+`float` `25.0f`
+
+Image width of legend symbol.
+
+### Legend.labelStyle
+
+[LabelStyle](#labelstyle)
+
+the style of text.
+
+### Legend.location
+
+[Location](#location)
+
+The location of legend.
+
+### Legend.orient
+
+[Orient](#orient)
+
+Specify whether the layout of legend component is horizontal or vertical.
+
+Options:
+
+- `Horizonal`: 水平
+- `Vertical`: 垂直
+
+### Legend.padding
+
+[Padding](#padding) `v3.1.0`
+
+the paddinng of item and background.
+
+### Legend.positions
+
+`List` `v3.6.0`
+
+the custom positions of legend item.
+
+### Legend.selectedMode
+
+[Legend.SelectedMode](#legendselectedmode)
+
+Selected mode of legend, which controls whether series can be toggled displaying by clicking legends.
+
+Options:
+
+- `Multiple`: 多选。
+- `Single`: 单选。
+- `None`: 无法选择。
+
+### Legend.show
+
+`bool` `true`
+
+Whether to show legend component.
+
+### Legend.textLimit
+
+[TextLimit](#textlimit) `v3.10.0`
+
+the limit of text.
## LegendTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
-```mdx-code-block
-
-```
+### LegendTheme.unableColor
+`Color`
-|field|default|since|comment|
-|--|--|--|--|
-|unableColor|||the color of text.
-
-```mdx-code-block
-
-```
+the color of text.
## Level
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
-```mdx-code-block
-
-```
+### Level.depth
+`int` `0` `v3.10.0`
-|field|default|since|comment|
-|--|--|--|--|
-|depth|0|v3.10.0|the depth of level.
-|label|||the label style of level. [LabelStyle](#labelstyle)|
-|upperLabel|||the upper label style of level. [LabelStyle](#labelstyle)|
-|lineStyle||v3.10.0|the line style of level. [LineStyle](#linestyle)|
-|itemStyle|||the item style of level. [ItemStyle](#itemstyle)|
+the depth of level.
-```mdx-code-block
-
-```
+### Level.itemStyle
+
+[ItemStyle](#itemstyle)
+
+the item style of level.
+
+### Level.label
+
+[LabelStyle](#labelstyle)
+
+the label style of level.
+
+### Level.lineStyle
+
+[LineStyle](#linestyle) `v3.10.0`
+
+the line style of level.
+
+### Level.upperLabel
+
+[LabelStyle](#labelstyle)
+
+the upper label style of level.
## LevelStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.10.0`
-```mdx-code-block
-
-```
+### LevelStyle.levels
+`List`
-|field|default|since|comment|
-|--|--|--|--|
-|show|false||是否启用LevelStyle
-|levels|||各层节点对应的配置。当enableLevels为true时生效,levels[0]对应的第一层的配置,levels[1]对应第二层,依次类推。当levels中没有对应层时用默认的设置。
+各层节点对应的配置。当enableLevels为true时生效,levels[0]对应的第一层的配置,levels[1]对应第二层,依次类推。当levels中没有对应层时用默认的设置。
-```mdx-code-block
-
-```
+### LevelStyle.show
+
+`bool` `false`
+
+是否启用LevelStyle
## Line
-> class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
## LineArrow
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent)
-```mdx-code-block
-
-```
+### LineArrow.arrow
+[ArrowStyle](#arrowstyle)
-|field|default|since|comment|
-|--|--|--|--|
-|show|||Whether to show the arrow.
-|position|||The position of arrow.
`LineArrow.Position`:
- `End`: 末端箭头
- `Start`: 头端箭头
|
-|arrow|||the arrow of line. [ArrowStyle](#arrowstyle)|
+the arrow of line.
-```mdx-code-block
-
-```
+### LineArrow.position
+
+[LineArrow.Position](#linearrowposition)
+
+The position of arrow.
+
+Options:
+
+- `End`: 末端箭头
+- `Start`: 头端箭头
+
+### LineArrow.show
+
+`bool`
+
+Whether to show the arrow.
## LineStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [ISerieDataComponent](#iseriedatacomponent)
The style of line.
-```mdx-code-block
-
-```
+### LineStyle.color
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether show line.
-|type|||the type of line.
`LineStyle.Type`:
- `Solid`: 实线
- `Dashed`: 虚线
- `Dotted`: 点线
- `DashDot`: 点划线
- `DashDotDot`: 双点划线
- `None`: 双点划线
|
-|color|||the color of line, default use serie color.
-|toColor|||the middle color of line, default use serie color.
-|toColor2|||the end color of line, default use serie color.
-|width|0||the width of line.
-|length|0||the length of line.
-|opacity|1||Opacity of the line. Supports value from 0 to 1, and the line will not be drawn when set to 0.
-|dashLength|4|v3.8.1|the length of dash line. default value is 0, which means the length of dash line is 12 times of line width. Represents a multiple of the number of segments in a line chart.
-|dotLength|2|v3.8.1|the length of dot line. default value is 0, which means the length of dot line is 2 times of line width. Represents a multiple of the number of segments in a line chart.
-|gapLength|2|v3.8.1|the length of gap line. default value is 0, which means the length of gap line is 3 times of line width. Represents a multiple of the number of segments in a line chart.
+the color of line, default use serie color.
-```mdx-code-block
-
-```
+### LineStyle.dashLength
+
+`float` `4` `v3.8.1`
+
+the length of dash line. default value is 0, which means the length of dash line is 12 times of line width. Represents a multiple of the number of segments in a line chart.
+
+### LineStyle.dotLength
+
+`float` `2` `v3.8.1`
+
+the length of dot line. default value is 0, which means the length of dot line is 2 times of line width. Represents a multiple of the number of segments in a line chart.
+
+### LineStyle.gapLength
+
+`float` `2` `v3.8.1`
+
+the length of gap line. default value is 0, which means the length of gap line is 3 times of line width. Represents a multiple of the number of segments in a line chart.
+
+### LineStyle.length
+
+`float` `0`
+
+the length of line.
+
+### LineStyle.opacity
+
+`float` `1`
+
+Opacity of the line. Supports value from 0 to 1, and the line will not be drawn when set to 0.
+
+### LineStyle.show
+
+`bool` `true`
+
+Whether show line.
+
+### LineStyle.toColor
+
+`Color32`
+
+the middle color of line, default use serie color.
+
+### LineStyle.toColor2
+
+`Color32`
+
+the end color of line, default use serie color.
+
+### LineStyle.type
+
+[LineStyle.Type](#linestyletype)
+
+the type of line.
+
+Options:
+
+- `Solid`: 实线
+- `Dashed`: 虚线
+- `Dotted`: 点线
+- `DashDot`: 点划线
+- `DashDotDot`: 双点划线
+- `None`: 双点划线
+
+### LineStyle.width
+
+`float` `0`
+
+the width of line.
## Location
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [IPropertyChanged](#ipropertychanged)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent), [IPropertyChanged](#ipropertychanged)
Location type. Quick to set the general location.
-```mdx-code-block
-
-```
+### Location.align
+[Location.Align](#locationalign)
-|field|default|since|comment|
-|--|--|--|--|
-|align|||对齐方式。
`Location.Align`:
- `TopLeft`: 对齐方式
- `TopRight`: 对齐方式
- `TopCenter`: 对齐方式
- `BottomLeft`: 对齐方式
- `BottomRight`: 对齐方式
- `BottomCenter`: 对齐方式
- `Center`: 对齐方式
- `CenterLeft`: 对齐方式
- `CenterRight`: 对齐方式
|
-|left|||Distance between component and the left side of the container.
-|right|||Distance between component and the left side of the container.
-|top|||Distance between component and the left side of the container.
-|bottom|||Distance between component and the left side of the container.
+对齐方式。
-```mdx-code-block
-
-```
+Options:
+
+- `TopLeft`: 对齐方式
+- `TopRight`: 对齐方式
+- `TopCenter`: 对齐方式
+- `BottomLeft`: 对齐方式
+- `BottomRight`: 对齐方式
+- `BottomCenter`: 对齐方式
+- `Center`: 对齐方式
+- `CenterLeft`: 对齐方式
+- `CenterRight`: 对齐方式
+
+### Location.bottom
+
+`float`
+
+Distance between component and the left side of the container.
+
+### Location.left
+
+`float`
+
+Distance between component and the left side of the container.
+
+### Location.right
+
+`float`
+
+Distance between component and the left side of the container.
+
+### Location.top
+
+`float`
+
+Distance between component and the left side of the container.
## MainComponent
-> class in XCharts.Runtime / Inherits from: [IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=IComparable) / Subclasses: [Axis](#axis), [Background](#background), [Comment](#comment), [DataZoom](#datazoom), [Legend](#legend), [MarkArea](#markarea), [MarkLine](#markline), [Settings](#settings), [Title](#title), [Tooltip](#tooltip), [VisualMap](#visualmap), [GridLayout](#gridlayout), [CoordSystem](#coordsystem)
+class in XCharts.Runtime / Inherits from: [IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=IComparable) / Subclasses: [Axis](#axis), [Background](#background), [Comment](#comment), [DataZoom](#datazoom), [Legend](#legend), [MarkArea](#markarea), [MarkLine](#markline), [Settings](#settings), [Title](#title), [Tooltip](#tooltip), [VisualMap](#visualmap), [GridLayout](#gridlayout), [CoordSystem](#coordsystem)
## MarkArea
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
Used to mark an area in chart. For example, mark a time interval.
-```mdx-code-block
-
-```
+### MarkArea.end
+[MarkAreaData](#markareadata)
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||是否显示标域。
-|text|||The text of markArea. 标域显示的文本。
-|serieIndex|0||Serie index of markArea. 标域影响的Serie索引。
-|start|||标域范围的起始数据。 [MarkAreaData](#markareadata)|
-|end|||标域范围的结束数据。 [MarkAreaData](#markareadata)|
-|itemStyle|||标域样式。 [ItemStyle](#itemstyle)|
-|label|||标域文本样式。 [LabelStyle](#labelstyle)|
+标域范围的结束数据。
-```mdx-code-block
-
-```
+### MarkArea.itemStyle
+
+[ItemStyle](#itemstyle)
+
+标域样式。
+
+### MarkArea.label
+
+[LabelStyle](#labelstyle)
+
+标域文本样式。
+
+### MarkArea.serieIndex
+
+`int` `0`
+
+Serie index of markArea. 标域影响的Serie索引。
+
+### MarkArea.show
+
+`bool` `true`
+
+是否显示标域。
+
+### MarkArea.start
+
+[MarkAreaData](#markareadata)
+
+标域范围的起始数据。
+
+### MarkArea.text
+
+`string`
+
+The text of markArea. 标域显示的文本。
## MarkAreaData
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
标域的数据。
-```mdx-code-block
-
-```
+### MarkAreaData.dimension
+`int` `1`
-|field|default|since|comment|
-|--|--|--|--|
-|type|||Special markArea types, are used to label maximum value, minimum value and so on.
`MarkAreaType`:
- `None`: 标域类型
- `Min`: 最小值。
- `Max`: 最大值。
- `Average`: 平均值。
- `Median`: 中位数。
|
-|name|||Name of the marker, which will display as a label.
-|dimension|1||From which dimension of data to calculate the maximum and minimum value and so on.
-|xPosition|||The x coordinate relative to the origin, in pixels.
-|yPosition|||The y coordinate relative to the origin, in pixels.
-|xValue|||The value specified on the X-axis. A value specified when the X-axis is the category axis represents the index of the category axis data, otherwise a specific value.
-|yValue|||That's the value on the Y-axis. The value specified when the Y axis is the category axis represents the index of the category axis data, otherwise the specific value.
+From which dimension of data to calculate the maximum and minimum value and so on.
-```mdx-code-block
-
-```
+### MarkAreaData.name
+
+`string`
+
+Name of the marker, which will display as a label.
+
+### MarkAreaData.type
+
+[MarkAreaType](#markareatype)
+
+Special markArea types, are used to label maximum value, minimum value and so on.
+
+Options:
+
+- `None`: 标域类型
+- `Min`: 最小值。
+- `Max`: 最大值。
+- `Average`: 平均值。
+- `Median`: 中位数。
+
+### MarkAreaData.xPosition
+
+`float`
+
+The x coordinate relative to the origin, in pixels.
+
+### MarkAreaData.xValue
+
+`double`
+
+The value specified on the X-axis. A value specified when the X-axis is the category axis represents the index of the category axis data, otherwise a specific value.
+
+### MarkAreaData.yPosition
+
+`float`
+
+The y coordinate relative to the origin, in pixels.
+
+### MarkAreaData.yValue
+
+`double`
+
+That's the value on the Y-axis. The value specified when the Y axis is the category axis represents the index of the category axis data, otherwise the specific value.
## MarkLine
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
Use a line in the chart to illustrate.
-```mdx-code-block
-
-```
+### MarkLine.animation
+[AnimationStyle](#animationstyle)
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether to display the marking line.
-|serieIndex|0||The serie index of markLine.
-|onTop|true|v3.9.0|whether the markline is on top.
-|animation|||The animation of markline. [AnimationStyle](#animationstyle)|
-|data|||A list of marked data. When the group of data item is 0, each data item represents a line; When the group is not 0, two data items of the same group represent the starting point and the ending point of the line respectively to form a line. In this case, the relevant style parameters of the line are the parameters of the starting point.
+The animation of markline.
-```mdx-code-block
-
-```
+### MarkLine.data
+
+`List`
+
+A list of marked data. When the group of data item is 0, each data item represents a line; When the group is not 0, two data items of the same group represent the starting point and the ending point of the line respectively to form a line. In this case, the relevant style parameters of the line are the parameters of the starting point.
+
+### MarkLine.onTop
+
+`bool` `true` `v3.9.0`
+
+whether the markline is on top.
+
+### MarkLine.serieIndex
+
+`int` `0`
+
+The serie index of markLine.
+
+### MarkLine.show
+
+`bool` `true`
+
+Whether to display the marking line.
## MarkLineData
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.9.0`
Data of marking line.
-```mdx-code-block
-
-```
+### MarkLineData.dimension
+`int` `1`
-|field|default|since|comment|
-|--|--|--|--|
-|type|||Special label types, are used to label maximum value, minimum value and so on.
`MarkLineType`:
- `None`: 标线类型
- `Min`: 最小值。
- `Max`: 最大值。
- `Average`: 平均值。
- `Median`: 中位数。
|
-|name|||Name of the marker, which will display as a label.
-|dimension|1||From which dimension of data to calculate the maximum and minimum value and so on.
-|xPosition|||The x coordinate relative to the origin, in pixels.
-|yPosition|||The y coordinate relative to the origin, in pixels.
-|xValue|||The value specified on the X-axis. A value specified when the X-axis is the category axis represents the index of the category axis data, otherwise a specific value.
-|yValue|||That's the value on the Y-axis. The value specified when the Y axis is the category axis represents the index of the category axis data, otherwise the specific value.
-|group|0||Grouping. When the group is not 0, it means that this data is the starting point or end point of the marking line. Data consistent with the group form a marking line.
-|zeroPosition|false||Is the origin of the coordinate system.
-|startSymbol|||The symbol of the start point of markline. [SymbolStyle](#symbolstyle)|
-|endSymbol|||The symbol of the end point of markline. [SymbolStyle](#symbolstyle)|
-|lineStyle|||The line style of markline. [LineStyle](#linestyle)|
-|label|||Text styles of label. You can set position to Start, Middle, and End to display text in different locations. [LabelStyle](#labelstyle)|
+From which dimension of data to calculate the maximum and minimum value and so on.
-```mdx-code-block
-
-```
+### MarkLineData.endSymbol
+
+[SymbolStyle](#symbolstyle)
+
+The symbol of the end point of markline.
+
+### MarkLineData.group
+
+`int` `0`
+
+Grouping. When the group is not 0, it means that this data is the starting point or end point of the marking line. Data consistent with the group form a marking line.
+
+### MarkLineData.label
+
+[LabelStyle](#labelstyle)
+
+Text styles of label. You can set position to Start, Middle, and End to display text in different locations.
+
+### MarkLineData.lineStyle
+
+[LineStyle](#linestyle)
+
+The line style of markline.
+
+### MarkLineData.name
+
+`string`
+
+Name of the marker, which will display as a label.
+
+### MarkLineData.startSymbol
+
+[SymbolStyle](#symbolstyle)
+
+The symbol of the start point of markline.
+
+### MarkLineData.type
+
+[MarkLineType](#marklinetype)
+
+Special label types, are used to label maximum value, minimum value and so on.
+
+Options:
+
+- `None`: 标线类型
+- `Min`: 最小值。
+- `Max`: 最大值。
+- `Average`: 平均值。
+- `Median`: 中位数。
+
+### MarkLineData.xPosition
+
+`float`
+
+The x coordinate relative to the origin, in pixels.
+
+### MarkLineData.xValue
+
+`double`
+
+The value specified on the X-axis. A value specified when the X-axis is the category axis represents the index of the category axis data, otherwise a specific value.
+
+### MarkLineData.yPosition
+
+`float`
+
+The y coordinate relative to the origin, in pixels.
+
+### MarkLineData.yValue
+
+`double`
+
+That's the value on the Y-axis. The value specified when the Y axis is the category axis represents the index of the category axis data, otherwise the specific value.
+
+### MarkLineData.zeroPosition
+
+`bool` `false`
+
+Is the origin of the coordinate system.
## MarqueeStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.5.0`
Marquee style. It can be used for the DataZoom component. 选取框样式。可用于DataZoom组件。
-```mdx-code-block
-
-```
+### MarqueeStyle.apply
+`bool` `false` `v3.5.0`
-|field|default|since|comment|
-|--|--|--|--|
-|apply|false|v3.5.0|Check whether the scope is applied to the DataZoom. If this parameter is set to true, the range after the selection is complete is the DataZoom selection range.
-|realRect|false|v3.5.0|Whether to select the actual box selection area. When true, the actual range between the mouse's actual point and the end point is used as the box selection area.
-|areaStyle||v3.5.0|The area style of marquee. [AreaStyle](#areastyle)|
-|lineStyle||v3.5.0|The line style of marquee border. [LineStyle](#linestyle)|
+Check whether the scope is applied to the DataZoom. If this parameter is set to true, the range after the selection is complete is the DataZoom selection range.
-```mdx-code-block
-
-```
+### MarqueeStyle.areaStyle
+
+[AreaStyle](#areastyle) `v3.5.0`
+
+The area style of marquee.
+
+### MarqueeStyle.lineStyle
+
+[LineStyle](#linestyle) `v3.5.0`
+
+The line style of marquee border.
+
+### MarqueeStyle.realRect
+
+`bool` `false` `v3.5.0`
+
+Whether to select the actual box selection area. When true, the actual range between the mouse's actual point and the end point is used as the box selection area.
## MLValue
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.8.0`
多样式数值。
-```mdx-code-block
-
-```
+### MLValue.type
+
+[MLValue.Type](#mlvaluetype)
-|field|default|since|comment|
-|--|--|--|--|
-|type|||
`MLValue.Type`:
- `Percent`: Percent value form.
- `Absolute`: Absolute value form.
- `Extra`: Extra value form.
|
-|value|||
-```mdx-code-block
-
-```
+Options:
+
+- `Percent`: Percent value form.
+- `Absolute`: Absolute value form.
+- `Extra`: Extra value form.
+
+### MLValue.value
+
+`float`
## Padding
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [TextPadding](#textpadding)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [TextPadding](#textpadding)
padding setting of item or text.
-```mdx-code-block
-
-```
+### Padding.bottom
+`float` `0`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||show padding. 是否显示。
-|top|0||padding of top.
-|right|2f||padding of right.
-|left|2f||padding of left.
-|bottom|0||padding of bottom.
+padding of bottom.
-```mdx-code-block
-
-```
+### Padding.left
+
+`float` `2f`
+
+padding of left.
+
+### Padding.right
+
+`float` `2f`
+
+padding of right.
+
+### Padding.show
+
+`bool` `true`
+
+show padding. 是否显示。
+
+### Padding.top
+
+`float` `0`
+
+padding of top.
## Parallel
-> class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
## ParallelAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
## ParallelCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer)
Grid component.
-```mdx-code-block
-
-```
+### ParallelCoord.backgroundColor
+`Color`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether to show the grid in rectangular coordinate.
-|orient|||Orientation of the axis. By default, it's 'Vertical'. You can set it to be 'Horizonal' to make a vertical axis.
`Orient`:
- `Horizonal`: 水平
- `Vertical`: 垂直
|
-|left|0.1f||Distance between grid component and the left side of the container.
-|right|0.08f||Distance between grid component and the right side of the container.
-|top|0.22f||Distance between grid component and the top side of the container.
-|bottom|0.12f||Distance between grid component and the bottom side of the container.
-|backgroundColor|||Background color of grid, which is transparent by default.
+Background color of grid, which is transparent by default.
-```mdx-code-block
-
-```
+### ParallelCoord.bottom
+
+`float` `0.12f`
+
+Distance between grid component and the bottom side of the container.
+
+### ParallelCoord.left
+
+`float` `0.1f`
+
+Distance between grid component and the left side of the container.
+
+### ParallelCoord.orient
+
+[Orient](#orient)
+
+Orientation of the axis. By default, it's 'Vertical'. You can set it to be 'Horizonal' to make a vertical axis.
+
+Options:
+
+- `Horizonal`: 水平
+- `Vertical`: 垂直
+
+### ParallelCoord.right
+
+`float` `0.08f`
+
+Distance between grid component and the right side of the container.
+
+### ParallelCoord.show
+
+`bool` `true`
+
+Whether to show the grid in rectangular coordinate.
+
+### ParallelCoord.top
+
+`float` `0.22f`
+
+Distance between grid component and the top side of the container.
## Pie
-> class in XCharts.Runtime / Inherits from: [Serie](#serie)
+class in XCharts.Runtime / Inherits from: [Serie](#serie)
-```mdx-code-block
-
-```
+### Pie.radiusGradient
+`bool` `false` `v3.8.1`
-|field|default|since|comment|
-|--|--|--|--|
-|radiusGradient|false|v3.8.1|Whether to use gradient color in pie chart.
-
-```mdx-code-block
-
-```
+Whether to use gradient color in pie chart.
## PolarAxisTheme
-> class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
## PolarCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [ISerieContainer](#iseriecontainer)
Polar coordinate can be used in scatter and line chart. Every polar coordinate has an angleAxis and a radiusAxis.
-```mdx-code-block
-
-```
+### PolarCoord.backgroundColor
+`Color`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether to show the polor component.
-|center|||The center of ploar. The center[0] is the x-coordinate, and the center[1] is the y-coordinate. When value between 0 and 1 represents a percentage relative to the chart.
-|radius|||the radius of polar.
-|backgroundColor|||Background color of polar, which is transparent by default.
-|indicatorLabelOffset|30f|v3.8.0|The offset of indicator label.
+Background color of polar, which is transparent by default.
-```mdx-code-block
-
-```
+### PolarCoord.center
+
+`float[]`
+
+The center of ploar. The center[0] is the x-coordinate, and the center[1] is the y-coordinate. When value between 0 and 1 represents a percentage relative to the chart.
+
+### PolarCoord.indicatorLabelOffset
+
+`float` `30f` `v3.8.0`
+
+The offset of indicator label.
+
+### PolarCoord.radius
+
+`float[]`
+
+the radius of polar.
+
+### PolarCoord.show
+
+`bool` `true`
+
+Whether to show the polor component.
## Radar
-> class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
+class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer)
-```mdx-code-block
-
-```
+### Radar.smooth
+`bool` `false` `v3.2.0`
-|field|default|since|comment|
-|--|--|--|--|
-|smooth|false|v3.2.0|Whether use smooth curve.
-
-```mdx-code-block
-
-```
+Whether use smooth curve.
## RadarAxisTheme
-> class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
## RadarCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [ISerieContainer](#iseriecontainer)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem), [ISerieContainer](#iseriecontainer)
Radar coordinate conponnet for radar charts. 雷达图坐标系组件,只适用于雷达图。
## RadiusAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
Radial axis of polar coordinate.
## RadiusAxisTheme
-> class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
+class in XCharts.Runtime / Inherits from: [BaseAxisTheme](#baseaxistheme)
## Ring
-> class in XCharts.Runtime / Inherits from: [Serie](#serie)
+class in XCharts.Runtime / Inherits from: [Serie](#serie)
+
+### Ring.radiusGradient
+
+`bool` `false` `v3.12.0`
+
+Whether to use gradient color in pie chart.
## Scatter
-> class in XCharts.Runtime / Inherits from: [BaseScatter](#basescatter)
+class in XCharts.Runtime / Inherits from: [BaseScatter](#basescatter)
## SelectStyle
-> class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent)
> Since `v3.2.0`
@@ -1827,714 +3399,1927 @@ Configurations of select state.
## Serie
-> class in XCharts.Runtime / Inherits from: [BaseSerie](#baseserie), [IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=IComparable) / Subclasses: [SerieHandler<T>](#seriehandlert), [Bar](#bar), [SimplifiedBar](#simplifiedbar), [Candlestick](#candlestick), [SimplifiedCandlestick](#simplifiedcandlestick), [Heatmap](#heatmap), [Line](#line), [SimplifiedLine](#simplifiedline), [Parallel](#parallel), [Pie](#pie), [Radar](#radar), [Ring](#ring), [BaseScatter](#basescatter)
+class in XCharts.Runtime / Inherits from: [BaseSerie](#baseserie), [IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=IComparable) / Subclasses: [SerieHandler<T>](#seriehandlert), [Bar](#bar), [SimplifiedBar](#simplifiedbar), [Candlestick](#candlestick), [SimplifiedCandlestick](#simplifiedcandlestick), [Heatmap](#heatmap), [Line](#line), [SimplifiedLine](#simplifiedline), [Parallel](#parallel), [Pie](#pie), [Radar](#radar), [Ring](#ring), [BaseScatter](#basescatter)
系列。系列一般由数据和配置组成,用来表示具体的图表图形,如折线图的一条折线,柱图的一组柱子等。一个图表中可以包含多个不同类型的系列。
-```mdx-code-block
-
-```
+### Serie.align
+[Align](#align)
-|field|default|since|comment|
-|--|--|--|--|
-|index|||The index of serie.
-|show|true||Whether to show serie in chart.
-|coordSystem|||the chart coord system of serie.
-|serieType|||the type of serie.
-|serieName|||Series name used for displaying in tooltip and filtering with legend.
-|state||v3.2.0|The default state of a serie.
`SerieState`:
- `Normal`: Normal state.
- `Emphasis`: Emphasis state.
- `Blur`: Blur state.
- `Select`: Select state.
- `Auto`: Auto state.
|
-|colorBy||v3.2.0|The policy to take color from theme.
`SerieColorBy`:
- `Default`: Select state.
- `Serie`: assigns the colors in the palette by serie, so that all data in the same series are in the same color.
- `Data`: assigns colors in the palette according to data items, with each data item using a different color.
|
-|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.
-|radarIndex|0||Index of radar component that radar chart uses.
-|vesselIndex|0||Index of vesel component that liquid chart uses.
-|polarIndex|0||Index of polar component that serie uses.
-|singleAxisIndex|0||Index of single axis component that serie uses.
-|parallelIndex|0||Index of parallel coord component that serie uses.
-|gridIndex|-1|v3.8.0|Index of layout component that serie uses. Default is -1 means not use layout, otherwise use the first layout component.
-|minShow|||The min number of data to show in chart.
-|maxShow|||The max number of data to show in chart.
-|maxCache|||The max number of serie data cache. The first data will be remove when the size of serie data is larger then maxCache.
-|sampleDist|0||the min pixel dist of sample.
-|sampleType|||the type of sample.
`SampleType`:
- `Peak`: Take a peak. When the average value of the filter point is greater than or equal to 'sampleAverage', take the maximum value; If you do it the other way around, you get the minimum.
- `Average`: Take the average of the filter points.
- `Max`: Take the maximum value of the filter point.
- `Min`: Take the minimum value of the filter point.
- `Sum`: Take the sum of the filter points.
|
-|sampleAverage|0||设定的采样平均值。当sampleType 为 Peak 时,用于和过滤数据的平均值做对比是取最大值还是最小值。默认为0时会实时计算所有数据的平均值。
-|lineType|||The type of line chart.
`LineType`:
- `Normal`: the normal line chart,
- `Smooth`: the smooth line chart,
- `StepStart`: step line.
- `StepMiddle`: step line.
- `StepEnd`: step line.
|
-|smoothLimit|false|v3.4.0|Whether to restrict the curve. When true, the curve between two continuous data of the same value is restricted to not exceed the data point, and is flat to the data point.
-|barType|||柱形图类型。
`BarType`:
- `Normal`: normal bar.
- `Zebra`: zebra bar.
- `Capsule`: capsule bar.
|
-|barPercentStack|false||柱形图是否为百分比堆积。相同stack的serie只要有一个barPercentStack为true,则就显示成百分比堆叠柱状图。
-|barWidth|0||The width of the bar. Adaptive when default 0.
-|barMaxWidth|0|v3.5.0|The max width of the bar. Adaptive when default 0.
-|barGap|0.1f||The gap between bars between different series, is a percent value like '0.3f' , which means 30% of the bar width, can be set as a fixed value. Set barGap as '-1' can overlap bars that belong to different series, which is useful when making a series of bar be background. In a single coodinate system, this attribute is shared by multiple 'bar' series. This attribute should be set on the last 'bar' series in the coodinate system, then it will be adopted by all 'bar' series in the coordinate system.
-|barZebraWidth|4f||斑马线的粗细。
-|barZebraGap|2f||斑马线的间距。
-|min|||最小值。
-|max|||最大值。
-|minSize|0f||数据最小值 min 映射的宽度。
-|maxSize|1f||数据最大值 max 映射的宽度。
-|startAngle|||起始角度。和时钟一样,12点钟位置是0度,顺时针到360度。
-|endAngle|||结束角度。和时钟一样,12点钟位置是0度,顺时针到360度。
-|minAngle|||The minimum angle of sector(0-360). It prevents some sector from being too small when value is small.
-|clockwise|true||是否顺时针。
-|roundCap|||是否开启圆弧效果。
-|splitNumber|||刻度分割段数。最大可设置36。
-|clickOffset|true||Whether offset when mouse click pie chart item.
-|roseType|||Whether to show as Nightingale chart.
`RoseType`:
- `None`: Don't show as Nightingale chart.
- `Radius`: Use central angle to show the percentage of data, radius to show data size.
- `Area`: All the sectors will share the same central angle, the data size is shown only through radiuses.
|
-|gap|||gap of item.
-|center|||the center of chart.
-|radius|||the radius of chart.
-|minRadius|0f|v3.8.0|the min radius of chart. It can be used to limit the minimum radius of the rose chart.
-|minShowLabel|false|v3.10.0|Whether the label is not displayed when the enabled value is less than the specified value.
-|minShowLabelValue|0|v3.10.0|When 'minShowLabel' is enabled, labels are not displayed if the value is less than this value.
-|showDataDimension|||数据项里的数据维数。
-|showDataName|||在Editor的inpsector上是否显示name参数
-|clip|false||If clip the overflow on the coordinate system.
-|ignore|false||是否开启忽略数据。当为 true 时,数据值为 ignoreValue 时不进行绘制。
-|ignoreValue|0||忽略数据的默认值。当ignore为true才有效。
-|ignoreLineBreak|false||忽略数据时折线是断开还是连接。默认false为连接。
-|showAsPositiveNumber|false||Show negative number as positive number.
-|large|true||是否开启大数据量优化,在数据图形特别多而出现卡顿时候可以开启。 开启后配合 largeThreshold 在数据量大于指定阈值的时候对绘制进行优化。 缺点:优化后不能自定义设置单个数据项的样式,不能显示Label。
-|largeThreshold|200||Turn on the threshold for mass optimization. Enter performance mode only when large is enabled and the amount of data is greater than the threshold.
-|avoidLabelOverlap|false||If the pie chart and labels are displayed externally, whether to enable the label overlap prevention policy is disabled by default. If labels are crowded and overlapped, the positions of labels are moved to prevent label overlap.
-|radarType|||雷达图类型。
`RadarType`:
- `Multiple`: multiple radar.
- `Single`: single radar.
|
-|placeHolder|false||占位模式。占位模式时,数据有效但不参与渲染和显示。
-|dataSortType|||组件的数据排序。
`SerieDataSortType`:
- `None`: In the order of data.
- `Ascending`: Sort data in ascending order.
- `Descending`: Sort data in descending order.
|
-|orient|||组件的朝向。
`Orient`:
- `Horizonal`: 水平
- `Vertical`: 垂直
|
-|align|||组件水平方向对齐方式。
`Align`:
- `Center`: Alignment mode.
- `Left`: Alignment mode.
- `Right`: Alignment mode.
|
-|left|||Distance between component and the left side of the container.
-|right|||Distance between component and the right side of the container.
-|top|||Distance between component and the top side of the container.
-|bottom|||Distance between component and the bottom side of the container.
-|insertDataToHead|||Whether to add new data at the head or at the end of the list.
-|lineStyle|||The style of line. [LineStyle](#linestyle)|
-|symbol|||the symbol of serie data item. [SerieSymbol](#seriesymbol)|
-|animation|||The start animation. [AnimationStyle](#animationstyle)|
-|itemStyle|||The style of data item. [ItemStyle](#itemstyle)|
-|data|||系列中的数据内容数组。SerieData可以设置1到n维数据。
-|links|||数据节点的边。
+组件水平方向对齐方式。
-```mdx-code-block
-
-```
+Options:
+
+- `Center`: Alignment mode.
+- `Left`: Alignment mode.
+- `Right`: Alignment mode.
+
+### Serie.animation
+
+[AnimationStyle](#animationstyle)
+
+The start animation.
+
+### Serie.avoidLabelOverlap
+
+`bool` `false`
+
+If the pie chart and labels are displayed externally, whether to enable the label overlap prevention policy is disabled by default. If labels are crowded and overlapped, the positions of labels are moved to prevent label overlap.
+
+### Serie.barGap
+
+`float` `0.1f`
+
+The gap between bars between different series, is a percent value like '0.3f' , which means 30% of the bar width, can be set as a fixed value. Set barGap as '-1' can overlap bars that belong to different series, which is useful when making a series of bar be background. In a single coodinate system, this attribute is shared by multiple 'bar' series. This attribute should be set on the last 'bar' series in the coodinate system, then it will be adopted by all 'bar' series in the coordinate system.
+
+### Serie.barMaxWidth
+
+`float` `0` `v3.5.0`
+
+The max width of the bar. Adaptive when default 0.
+
+### Serie.barPercentStack
+
+`bool` `false`
+
+柱形图是否为百分比堆积。相同stack的serie只要有一个barPercentStack为true,则就显示成百分比堆叠柱状图。
+
+### Serie.barType
+
+[BarType](#bartype)
+
+柱形图类型。
+
+Options:
+
+- `Normal`: normal bar.
+- `Zebra`: zebra bar.
+- `Capsule`: capsule bar.
+
+### Serie.barWidth
+
+`float` `0`
+
+The width of the bar. Adaptive when default 0.
+
+### Serie.barZebraGap
+
+`float` `2f`
+
+斑马线的间距。
+
+### Serie.barZebraWidth
+
+`float` `4f`
+
+斑马线的粗细。
+
+### Serie.bottom
+
+`float`
+
+Distance between component and the bottom side of the container.
+
+### Serie.center
+
+`float[]`
+
+the center of chart.
+
+### Serie.clickOffset
+
+`bool` `true`
+
+Whether offset when mouse click pie chart item.
+
+### Serie.clip
+
+`bool` `false`
+
+If clip the overflow on the coordinate system.
+
+### Serie.clockwise
+
+`bool` `true`
+
+是否顺时针。
+
+### Serie.colorBy
+
+[SerieColorBy](#seriecolorby) `v3.2.0`
+
+The policy to take color from theme.
+
+Options:
+
+- `Default`: Select state.
+- `Serie`: assigns the colors in the palette by serie, so that all data in the same series are in the same color.
+- `Data`: assigns colors in the palette according to data items, with each data item using a different color.
+
+### Serie.coordSystem
+
+`string`
+
+the chart coord system of serie.
+
+### Serie.data
+
+`List`
+
+系列中的数据内容数组。SerieData可以设置1到n维数据。
+
+### Serie.dataSortType
+
+[SerieDataSortType](#seriedatasorttype)
+
+组件的数据排序。
+
+Options:
+
+- `None`: In the order of data.
+- `Ascending`: Sort data in ascending order.
+- `Descending`: Sort data in descending order.
+
+### Serie.endAngle
+
+`float`
+
+结束角度。和时钟一样,12点钟位置是0度,顺时针到360度。
+
+### Serie.gap
+
+`float`
+
+gap of item.
+
+### Serie.gridIndex
+
+`int` `-1` `v3.8.0`
+
+Index of layout component that serie uses. Default is -1 means not use layout, otherwise use the first layout component.
+
+### Serie.ignore
+
+`bool` `false`
+
+是否开启忽略数据。当为 true 时,数据值为 ignoreValue 时不进行绘制。
+
+### Serie.ignoreLineBreak
+
+`bool` `false`
+
+忽略数据时折线是断开还是连接。默认false为连接。
+
+### Serie.ignoreValue
+
+`double` `0`
+
+忽略数据的默认值。当ignore为true才有效。
+
+### Serie.index
+
+`int`
+
+The index of serie.
+
+### Serie.insertDataToHead
+
+`bool`
+
+Whether to add new data at the head or at the end of the list.
+
+### Serie.itemStyle
+
+[ItemStyle](#itemstyle)
+
+The style of data item.
+
+### Serie.large
+
+`bool` `true`
+
+是否开启大数据量优化,在数据图形特别多而出现卡顿时候可以开启。 开启后配合 largeThreshold 在数据量大于指定阈值的时候对绘制进行优化。 缺点:优化后不能自定义设置单个数据项的样式,不能显示Label。
+
+### Serie.largeThreshold
+
+`int` `200`
+
+Turn on the threshold for mass optimization. Enter performance mode only when large is enabled and the amount of data is greater than the threshold.
+
+### Serie.left
+
+`float`
+
+Distance between component and the left side of the container.
+
+### Serie.lineStyle
+
+[LineStyle](#linestyle)
+
+The style of line.
+
+### Serie.lineType
+
+[LineType](#linetype)
+
+The type of line chart.
+
+Options:
+
+- `Normal`: the normal line chart,
+- `Smooth`: the smooth line chart,
+- `StepStart`: step line.
+- `StepMiddle`: step line.
+- `StepEnd`: step line.
+
+### Serie.links
+
+`List`
+
+数据节点的边。
+
+### Serie.max
+
+`float`
+
+最大值。
+
+### Serie.maxCache
+
+`int`
+
+The max number of serie data cache. The first data will be remove when the size of serie data is larger then maxCache.
+
+### Serie.maxShow
+
+`int`
+
+The max number of data to show in chart.
+
+### Serie.maxSize
+
+`float` `1f`
+
+数据最大值 max 映射的宽度。
+
+### Serie.min
+
+`float`
+
+最小值。
+
+### Serie.minAngle
+
+`float`
+
+The minimum angle of sector(0-360). It prevents some sector from being too small when value is small.
+
+### Serie.minRadius
+
+`float` `0f` `v3.8.0`
+
+the min radius of chart. It can be used to limit the minimum radius of the rose chart.
+
+### Serie.minShow
+
+`int`
+
+The min number of data to show in chart.
+
+### Serie.minShowLabel
+
+`bool` `false` `v3.10.0`
+
+Whether the label is not displayed when the enabled value is less than the specified value.
+
+### Serie.minShowLabelValue
+
+`double` `0` `v3.10.0`
+
+When 'minShowLabel' is enabled, labels are not displayed if the value is less than this value.
+
+### Serie.minSize
+
+`float` `0f`
+
+数据最小值 min 映射的宽度。
+
+### Serie.orient
+
+[Orient](#orient)
+
+组件的朝向。
+
+Options:
+
+- `Horizonal`: 水平
+- `Vertical`: 垂直
+
+### Serie.parallelIndex
+
+`int` `0`
+
+Index of parallel coord component that serie uses.
+
+### Serie.placeHolder
+
+`bool` `false`
+
+占位模式。占位模式时,数据有效但不参与渲染和显示。
+
+### Serie.polarIndex
+
+`int` `0`
+
+Index of polar component that serie uses.
+
+### Serie.radarIndex
+
+`int` `0`
+
+Index of radar component that radar chart uses.
+
+### Serie.radarType
+
+[RadarType](#radartype)
+
+雷达图类型。
+
+Options:
+
+- `Multiple`: multiple radar.
+- `Single`: single radar.
+
+### Serie.radius
+
+`float[]`
+
+the radius of chart.
+
+### Serie.right
+
+`float`
+
+Distance between component and the right side of the container.
+
+### Serie.roseType
+
+[RoseType](#rosetype)
+
+Whether to show as Nightingale chart.
+
+Options:
+
+- `None`: Don't show as Nightingale chart.
+- `Radius`: Use central angle to show the percentage of data, radius to show data size.
+- `Area`: All the sectors will share the same central angle, the data size is shown only through radiuses.
+
+### Serie.roundCap
+
+`bool`
+
+是否开启圆弧效果。
+
+### Serie.sampleAverage
+
+`float` `0`
+
+设定的采样平均值。当sampleType 为 Peak 时,用于和过滤数据的平均值做对比是取最大值还是最小值。默认为0时会实时计算所有数据的平均值。
+
+### Serie.sampleDist
+
+`float` `0`
+
+the min pixel dist of sample.
+
+### Serie.sampleType
+
+[SampleType](#sampletype)
+
+the type of sample.
+
+Options:
+
+- `Peak`: Take a peak. When the average value of the filter point is greater than or equal to 'sampleAverage', take the maximum value; If you do it the other way around, you get the minimum.
+- `Average`: Take the average of the filter points.
+- `Max`: Take the maximum value of the filter point.
+- `Min`: Take the minimum value of the filter point.
+- `Sum`: Take the sum of the filter points.
+
+### Serie.serieName
+
+`string`
+
+Series name used for displaying in tooltip and filtering with legend.
+
+### Serie.serieType
+
+`string`
+
+the type of serie.
+
+### Serie.show
+
+`bool` `true`
+
+Whether to show serie in chart.
+
+### Serie.showAsPositiveNumber
+
+`bool` `false`
+
+Show negative number as positive number.
+
+### Serie.showDataDimension
+
+`int`
+
+数据项里的数据维数。
+
+### Serie.showDataName
+
+`bool`
+
+在Editor的inpsector上是否显示name参数
+
+### Serie.singleAxisIndex
+
+`int` `0`
+
+Index of single axis component that serie uses.
+
+### Serie.smoothLimit
+
+`bool` `false` `v3.4.0`
+
+Whether to restrict the curve. When true, the curve between two continuous data of the same value is restricted to not exceed the data point, and is flat to the data point.
+
+### Serie.splitNumber
+
+`int`
+
+刻度分割段数。最大可设置36。
+
+### Serie.stack
+
+`string`
+
+If stack the value. On the same category axis, the series with the same stack name would be put on top of each other.
+
+### Serie.startAngle
+
+`float`
+
+起始角度。和时钟一样,12点钟位置是0度,顺时针到360度。
+
+### Serie.state
+
+[SerieState](#seriestate) `v3.2.0`
+
+The default state of a serie.
+
+Options:
+
+- `Normal`: Normal state.
+- `Emphasis`: Emphasis state.
+- `Blur`: Blur state.
+- `Select`: Select state.
+- `Auto`: Auto state.
+
+### Serie.symbol
+
+[SerieSymbol](#seriesymbol)
+
+the symbol of serie data item.
+
+### Serie.top
+
+`float`
+
+Distance between component and the top side of the container.
+
+### Serie.vesselIndex
+
+`int` `0`
+
+Index of vesel component that liquid chart uses.
+
+### Serie.xAxisIndex
+
+`int` `0`
+
+the index of XAxis.
+
+### Serie.yAxisIndex
+
+`int` `0`
+
+the index of YAxis.
## SerieData
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
A data item of serie.
-```mdx-code-block
-
-```
+### SerieData.data
+`List`
-|field|default|since|comment|
-|--|--|--|--|
-|index|||the index of SerieData.
-|name|||the name of data item.
-|id|||the id of data.
-|parentId|||the id of parent SerieData.
-|ignore|||是否忽略数据。当为 true 时,数据不进行绘制。
-|selected|||Whether the data item is selected.
-|radius|||自定义半径。可用在饼图中自定义某个数据项的半径。
-|state||v3.2.0|the state of serie data.
`SerieState`:
- `Normal`: Normal state.
- `Emphasis`: Emphasis state.
- `Blur`: Blur state.
- `Select`: Select state.
- `Auto`: Auto state.
|
-|data|||An arbitrary dimension data list of data item.
+An arbitrary dimension data list of data item.
-```mdx-code-block
-
-```
+### SerieData.id
+
+`string`
+
+the id of data.
+
+### SerieData.ignore
+
+`bool`
+
+是否忽略数据。当为 true 时,数据不进行绘制。
+
+### SerieData.index
+
+`int`
+
+the index of SerieData.
+
+### SerieData.name
+
+`string`
+
+the name of data item.
+
+### SerieData.parentId
+
+`string`
+
+the id of parent SerieData.
+
+### SerieData.radius
+
+`float`
+
+自定义半径。可用在饼图中自定义某个数据项的半径。
+
+### SerieData.selected
+
+`bool`
+
+Whether the data item is selected.
+
+### SerieData.state
+
+[SerieState](#seriestate) `v3.2.0`
+
+the state of serie data.
+
+Options:
+
+- `Normal`: Normal state.
+- `Emphasis`: Emphasis state.
+- `Blur`: Blur state.
+- `Select`: Select state.
+- `Auto`: Auto state.
## SerieDataLink
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.10.0`
the link of serie data. Used for sankey chart. Sankey chart only supports directed acyclic graph. make sure the data link is directed acyclic graph.
-```mdx-code-block
-
-```
+### SerieDataLink.source
+`string`
-|field|default|since|comment|
-|--|--|--|--|
-|source|||the source node name.
-|target|||the target node name.
-|value|||the value of link. decide the width of link.
+the source node name.
-```mdx-code-block
-
-```
+### SerieDataLink.target
+
+`string`
+
+the target node name.
+
+### SerieDataLink.value
+
+`double`
+
+the value of link. decide the width of link.
## SerieSymbol
-> class in XCharts.Runtime / Inherits from: [SymbolStyle](#symbolstyle), [ISerieDataComponent](#iseriedatacomponent)
+class in XCharts.Runtime / Inherits from: [SymbolStyle](#symbolstyle), [ISerieDataComponent](#iseriedatacomponent)
系列数据项的标记的图形
-```mdx-code-block
-
-```
+### SerieSymbol.dataIndex
+`int` `1`
-|field|default|since|comment|
-|--|--|--|--|
-|sizeType|||the type of symbol size.
`SymbolSizeType`:
- `Custom`: Specify constant for symbol size.
- `FromData`: Specify the dataIndex and dataScale to calculate symbol size.
- `Function`: Specify function for symbol size.
|
-|dataIndex|1||whitch data index is when the sizeType assined as FromData.
-|dataScale|1||the scale of data when sizeType assined as FromData.
-|sizeFunction|||the function of size when sizeType assined as Function.
-|startIndex|||the index start to show symbol.
-|interval|||the interval of show symbol.
-|forceShowLast|false||whether to show the last symbol.
-|repeat|false||图形是否重复。
-|minSize|0f|v3.3.0|Minimum symbol size.
-|maxSize|0f|v3.3.0|Maximum symbol size.
+whitch data index is when the sizeType assined as FromData.
-```mdx-code-block
-
-```
+### SerieSymbol.dataScale
+
+`float` `1`
+
+the scale of data when sizeType assined as FromData.
+
+### SerieSymbol.forceShowLast
+
+`bool` `false`
+
+whether to show the last symbol.
+
+### SerieSymbol.interval
+
+`int`
+
+the interval of show symbol.
+
+### SerieSymbol.maxSize
+
+`float` `0f` `v3.3.0`
+
+Maximum symbol size.
+
+### SerieSymbol.minSize
+
+`float` `0f` `v3.3.0`
+
+Minimum symbol size.
+
+### SerieSymbol.repeat
+
+`bool` `false`
+
+图形是否重复。
+
+### SerieSymbol.sizeFunction
+
+`SymbolSizeFunction`
+
+the function of size when sizeType assined as Function.
+
+### SerieSymbol.sizeType
+
+[SymbolSizeType](#symbolsizetype)
+
+the type of symbol size.
+
+Options:
+
+- `Custom`: Specify constant for symbol size.
+- `FromData`: Specify the dataIndex and dataScale to calculate symbol size.
+- `Function`: Specify function for symbol size.
+
+### SerieSymbol.startIndex
+
+`int`
+
+the index start to show symbol.
## SerieTheme
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
-```mdx-code-block
-
-```
+### SerieTheme.candlestickBorderColor
+`Color32` `Color32(235, 84, 84, 255)`
-|field|default|since|comment|
-|--|--|--|--|
-|lineWidth|||the color of text.
-|lineSymbolSize|||the symbol size of line serie.
-|scatterSymbolSize|||the symbol size of scatter serie.
-|candlestickColor|Color32(235, 84, 84, 255)||K线图阳线(涨)填充色
-|candlestickColor0|Color32(71, 178, 98, 255)||K线图阴线(跌)填充色
-|candlestickBorderWidth|1||K线图边框宽度
-|candlestickBorderColor|Color32(235, 84, 84, 255)||K线图阳线(跌)边框色
-|candlestickBorderColor0|Color32(71, 178, 98, 255)||K线图阴线(跌)边框色
+K线图阳线(跌)边框色
-```mdx-code-block
-
-```
+### SerieTheme.candlestickBorderColor0
+
+`Color32` `Color32(71, 178, 98, 255)`
+
+K线图阴线(跌)边框色
+
+### SerieTheme.candlestickBorderWidth
+
+`float` `1`
+
+K线图边框宽度
+
+### SerieTheme.candlestickColor
+
+`Color32` `Color32(235, 84, 84, 255)`
+
+K线图阳线(涨)填充色
+
+### SerieTheme.candlestickColor0
+
+`Color32` `Color32(71, 178, 98, 255)`
+
+K线图阴线(跌)填充色
+
+### SerieTheme.lineSymbolSize
+
+`float`
+
+the symbol size of line serie.
+
+### SerieTheme.lineWidth
+
+`float`
+
+the color of text.
+
+### SerieTheme.scatterSymbolSize
+
+`float`
+
+the symbol size of scatter serie.
## Settings
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
Global parameter setting component. The default value can be used in general, and can be adjusted when necessary.
-```mdx-code-block
-
-```
+### Settings.axisMaxSplitNumber
+`float` `50` `v3.1.0`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||
-|maxPainter|10||max painter.
-|reversePainter|false||Painter是否逆序。逆序时index大的serie最先绘制。
-|basePainterMaterial|||Base Pointer 材质球,设置后会影响Axis等。
-|seriePainterMaterial|||Serie Pointer 材质球,设置后会影响所有Serie。
-|upperPainterMaterial|||Upper Pointer 材质球。
-|topPainterMaterial|||Top Pointer 材质球。
-|lineSmoothStyle|2.5f||Curve smoothing factor. By adjusting the smoothing coefficient, the curvature of the curve can be changed, and different curves with slightly different appearance can be obtained.
-|lineSmoothness|2f||Smoothness of curve. The smaller the value, the smoother the curve, but the number of vertices will increase.
-|lineSegmentDistance|3f||The partition distance of a line segment. A line in a normal line chart is made up of many segments, the number of which is determined by the change in value. The smaller the number of segments, the higher the number of vertices. When the area with gradient is filled, the larger the value, the worse the transition effect.
-|cicleSmoothness|2f||the smoothess of cricle.
-|legendIconLineWidth|2||the width of line serie legend.
-|legendIconCornerRadius|||The radius of rounded corner. Its unit is px. Use array to respectively specify the 4 corner radiuses((clockwise upper left, upper right, bottom right and bottom left)).
-|axisMaxSplitNumber|50|v3.1.0|the max splitnumber of axis.
+the max splitnumber of axis.
-```mdx-code-block
-
-```
+### Settings.basePainterMaterial
+
+`Material`
+
+Base Pointer 材质球,设置后会影响Axis等。
+
+### Settings.cicleSmoothness
+
+`float` `2f`
+
+the smoothess of cricle.
+
+### Settings.legendIconCornerRadius
+
+`float[]`
+
+The radius of rounded corner. Its unit is px. Use array to respectively specify the 4 corner radiuses((clockwise upper left, upper right, bottom right and bottom left)).
+
+### Settings.legendIconLineWidth
+
+`float` `2`
+
+the width of line serie legend.
+
+### Settings.lineSegmentDistance
+
+`float` `3f`
+
+The partition distance of a line segment. A line in a normal line chart is made up of many segments, the number of which is determined by the change in value. The smaller the number of segments, the higher the number of vertices. When the area with gradient is filled, the larger the value, the worse the transition effect.
+
+### Settings.lineSmoothness
+
+`float` `2f`
+
+Smoothness of curve. The smaller the value, the smoother the curve, but the number of vertices will increase.
+
+### Settings.lineSmoothStyle
+
+`float` `2.5f`
+
+Curve smoothing factor. By adjusting the smoothing coefficient, the curvature of the curve can be changed, and different curves with slightly different appearance can be obtained.
+
+### Settings.maxPainter
+
+`int` `10`
+
+max painter.
+
+### Settings.reversePainter
+
+`bool` `false`
+
+Painter是否逆序。逆序时index大的serie最先绘制。
+
+### Settings.seriePainterMaterial
+
+`Material`
+
+Serie Pointer 材质球,设置后会影响所有Serie。
+
+### Settings.show
+
+`bool` `true`
+
+### Settings.topPainterMaterial
+
+`Material`
+
+Top Pointer 材质球。
+
+### Settings.upperPainterMaterial
+
+`Material`
+
+Upper Pointer 材质球。
## SimplifiedBar
-> class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie)
+class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie)
## SimplifiedCandlestick
-> class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie)
+class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie)
## SimplifiedLine
-> class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie)
+class in XCharts.Runtime / Inherits from: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie)
## SingleAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis), [IUpdateRuntimeData](#iupdateruntimedata)
+class in XCharts.Runtime / Inherits from: [Axis](#axis), [IUpdateRuntimeData](#iupdateruntimedata)
Single axis.
-```mdx-code-block
-
-```
+### SingleAxis.bottom
+`float` `0.2f`
-|field|default|since|comment|
-|--|--|--|--|
-|orient|||Orientation of the axis. By default, it's 'Horizontal'. You can set it to be 'Vertical' to make a vertical axis.
`Orient`:
- `Horizonal`: 水平
- `Vertical`: 垂直
|
-|left|0.1f||Distance between component and the left side of the container.
-|right|0.1f||Distance between component and the right side of the container.
-|top|0f||Distance between component and the top side of the container.
-|bottom|0.2f||Distance between component and the bottom side of the container.
-|width|0||width of axis.
-|height|50||height of axis.
+Distance between component and the bottom side of the container.
-```mdx-code-block
-
-```
+### SingleAxis.height
+
+`float` `50`
+
+height of axis.
+
+### SingleAxis.left
+
+`float` `0.1f`
+
+Distance between component and the left side of the container.
+
+### SingleAxis.orient
+
+[Orient](#orient)
+
+Orientation of the axis. By default, it's 'Horizontal'. You can set it to be 'Vertical' to make a vertical axis.
+
+Options:
+
+- `Horizonal`: 水平
+- `Vertical`: 垂直
+
+### SingleAxis.right
+
+`float` `0.1f`
+
+Distance between component and the right side of the container.
+
+### SingleAxis.top
+
+`float` `0f`
+
+Distance between component and the top side of the container.
+
+### SingleAxis.width
+
+`float` `0`
+
+width of axis.
## SingleAxisCoord
-> class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem)
+class in XCharts.Runtime / Inherits from: [CoordSystem](#coordsystem)
## StageColor
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
-```mdx-code-block
-
-```
+### StageColor.color
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|percent|||结束位置百分比。
-|color|||颜色。
+颜色。
-```mdx-code-block
-
-```
+### StageColor.percent
+
+`float`
+
+结束位置百分比。
## StateStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle)
> Since `v3.2.0`
the state style of serie.
-```mdx-code-block
-
-```
+### StateStyle.areaStyle
+[AreaStyle](#areastyle)
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||是否启用高亮样式。
-|label|||图形文本标签。 [LabelStyle](#labelstyle)|
-|labelLine|||图形文本引导线样式。 [LabelLine](#labelline)|
-|itemStyle|||图形样式。 [ItemStyle](#itemstyle)|
-|lineStyle|||折线样式。 [LineStyle](#linestyle)|
-|areaStyle|||区域样式。 [AreaStyle](#areastyle)|
-|symbol|||标记样式。 [SerieSymbol](#seriesymbol)|
+区域样式。
-```mdx-code-block
-
-```
+### StateStyle.itemStyle
+
+[ItemStyle](#itemstyle)
+
+图形样式。
+
+### StateStyle.label
+
+[LabelStyle](#labelstyle)
+
+图形文本标签。
+
+### StateStyle.labelLine
+
+[LabelLine](#labelline)
+
+图形文本引导线样式。
+
+### StateStyle.lineStyle
+
+[LineStyle](#linestyle)
+
+折线样式。
+
+### StateStyle.show
+
+`bool` `true`
+
+是否启用高亮样式。
+
+### StateStyle.symbol
+
+[SerieSymbol](#seriesymbol)
+
+标记样式。
## SubTitleTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
## SymbolStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [SerieSymbol](#seriesymbol)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent) / Subclasses: [SerieSymbol](#seriesymbol)
系列数据项的标记的图形
-```mdx-code-block
-
-```
+### SymbolStyle.color
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether the symbol is showed.
-|type|||the type of symbol.
`SymbolType`:
- `None`: 不显示标记。
- `Custom`: 自定义标记。
- `Circle`: 圆形。
- `EmptyCircle`: 空心圆。
- `Rect`: 正方形。可通过设置`itemStyle`的`cornerRadius`变成圆角矩形。
- `EmptyRect`: 空心正方形。
- `Triangle`: 三角形。
- `EmptyTriangle`: 空心三角形。
- `Diamond`: 菱形。
- `EmptyDiamond`: 空心菱形。
- `Arrow`: 箭头。
- `EmptyArrow`: 空心箭头。
- `Plus`: 加号。
- `Minus`: 减号。
|
-|size|0f||the size of symbol.
-|gap|0||the gap of symbol and line segment.
-|width|0f||图形的宽。
-|height|0f||图形的高。
-|offset|Vector2.zero||图形的偏移。
-|image|||自定义的标记图形。
-|imageType|||the fill type of image.
-|color|||图形的颜色。
+图形的颜色。
-```mdx-code-block
-
-```
+### SymbolStyle.gap
+
+`float` `0`
+
+the gap of symbol and line segment.
+
+### SymbolStyle.height
+
+`float` `0f`
+
+图形的高。
+
+### SymbolStyle.image
+
+`Sprite`
+
+自定义的标记图形。
+
+### SymbolStyle.imageType
+
+`Image.Type`
+
+the fill type of image.
+
+### SymbolStyle.offset
+
+`Vector2` `Vector2.zero`
+
+图形的偏移。
+
+### SymbolStyle.show
+
+`bool` `true`
+
+Whether the symbol is showed.
+
+### SymbolStyle.size
+
+`float` `0f`
+
+the size of symbol.
+
+### SymbolStyle.type
+
+[SymbolType](#symboltype)
+
+the type of symbol.
+
+Options:
+
+- `None`: 不显示标记。
+- `Custom`: 自定义标记。
+- `Circle`: 圆形。
+- `EmptyCircle`: 空心圆。
+- `Rect`: 正方形。可通过设置`itemStyle`的`cornerRadius`变成圆角矩形。
+- `EmptyRect`: 空心正方形。
+- `Triangle`: 三角形。
+- `EmptyTriangle`: 空心三角形。
+- `Diamond`: 菱形。
+- `EmptyDiamond`: 空心菱形。
+- `Arrow`: 箭头。
+- `EmptyArrow`: 空心箭头。
+- `Plus`: 加号。
+- `Minus`: 减号。
+
+### SymbolStyle.width
+
+`float` `0f`
+
+图形的宽。
## TextLimit
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
Text character limitation and adaptation component. When the length of the text exceeds the set length, it is cropped and suffixes are appended to the end.Only valid in the category axis.
-```mdx-code-block
-
-```
+### TextLimit.enable
+`bool` `false`
-|field|default|since|comment|
-|--|--|--|--|
-|enable|false||Whether to enable text limit.
-|maxWidth|0||Set the maximum width. A default of 0 indicates automatic fetch; otherwise, custom.
-|gap|1||White pixel distance at both ends.
-|suffix|||Suffixes when the length exceeds.
+Whether to enable text limit.
-```mdx-code-block
-
-```
+### TextLimit.gap
+
+`float` `1`
+
+White pixel distance at both ends.
+
+### TextLimit.maxWidth
+
+`float` `0`
+
+Set the maximum width. A default of 0 indicates automatic fetch; otherwise, custom.
+
+### TextLimit.suffix
+
+`string`
+
+Suffixes when the length exceeds.
## TextPadding
-> class in XCharts.Runtime / Inherits from: [Padding](#padding)
+class in XCharts.Runtime / Inherits from: [Padding](#padding)
Settings related to text.
## TextStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
Settings related to text.
-```mdx-code-block
-
-```
+### TextStyle.alignment
+`TextAnchor`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Settings related to text.
-|font|||the font of text. When `null`, the theme's font is used by default.
-|autoWrap|false||是否自动换行。
-|autoAlign|true||文本是否让系统自动选对齐方式。为false时才会用alignment。
-|rotate|0||Rotation of text.
-|autoColor|false||是否开启自动颜色。当开启时,会自动设置颜色。
-|color|||the color of text.
-|fontSize|0||font size.
-|fontStyle|||font style.
-|lineSpacing|1f||text line spacing.
-|alignment|||对齐方式。
-|tMPFont|||the font of textmeshpro.
-|tMPFontStyle|||
-|tMPAlignment|||
-|tMPSpriteAsset||v3.1.0|
+对齐方式。
-```mdx-code-block
-
-```
+### TextStyle.autoAlign
+
+`bool` `true`
+
+文本是否让系统自动选对齐方式。为false时才会用alignment。
+
+### TextStyle.autoColor
+
+`bool` `false`
+
+是否开启自动颜色。当开启时,会自动设置颜色。
+
+### TextStyle.autoWrap
+
+`bool` `false`
+
+是否自动换行。
+
+### TextStyle.color
+
+`Color`
+
+the color of text.
+
+### TextStyle.font
+
+`Font`
+
+the font of text. When `null`, the theme's font is used by default.
+
+### TextStyle.fontSize
+
+`int` `0`
+
+font size.
+
+### TextStyle.fontStyle
+
+`FontStyle`
+
+font style.
+
+### TextStyle.lineSpacing
+
+`float` `1f`
+
+text line spacing.
+
+### TextStyle.rotate
+
+`float` `0`
+
+Rotation of text.
+
+### TextStyle.show
+
+`bool` `true`
+
+Settings related to text.
+
+### TextStyle.tMPAlignment
+
+`TextAlignmentOptions`
+
+### TextStyle.tMPFont
+
+`TMP_FontAsset`
+
+the font of textmeshpro.
+
+### TextStyle.tMPFontStyle
+
+`FontStyles`
+
+### TextStyle.tMPSpriteAsset
+
+`TMP_SpriteAsset` `v3.1.0`
## Theme
-> class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=ScriptableObject)
+class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=ScriptableObject)
Theme.
-```mdx-code-block
-
-```
+### Theme.axis
+[AxisTheme](#axistheme)
-|field|default|since|comment|
-|--|--|--|--|
-|themeType|||the theme of chart.
`ThemeType`:
- `Default`: 默认主题。
- `Light`: 亮主题。
- `Dark`: 暗主题。
- `Custom`: 自定义主题。
|
-|themeName|||the name of theme.
-|font|||the font of chart text。
-|tMPFont|||the font of chart text。
-|contrastColor|||the contrast color of chart.
-|backgroundColor|||the background color of chart.
-|colorPalette|||The color list of palette. If no color is set in series, the colors would be adopted sequentially and circularly from this list as the colors of series.
-|common||| [ComponentTheme](#componenttheme)|
-|title||| [TitleTheme](#titletheme)|
-|subTitle||| [SubTitleTheme](#subtitletheme)|
-|legend||| [LegendTheme](#legendtheme)|
-|axis||| [AxisTheme](#axistheme)|
-|tooltip||| [TooltipTheme](#tooltiptheme)|
-|dataZoom||| [DataZoomTheme](#datazoomtheme)|
-|visualMap||| [VisualMapTheme](#visualmaptheme)|
-|serie||| [SerieTheme](#serietheme)|
+### Theme.backgroundColor
-```mdx-code-block
-
-```
+`Color32`
+
+the background color of chart.
+
+### Theme.colorPalette
+
+`List`
+
+The color list of palette. If no color is set in series, the colors would be adopted sequentially and circularly from this list as the colors of series.
+
+### Theme.common
+
+[ComponentTheme](#componenttheme)
+
+### Theme.contrastColor
+
+`Color32`
+
+the contrast color of chart.
+
+### Theme.dataZoom
+
+[DataZoomTheme](#datazoomtheme)
+
+### Theme.font
+
+`Font`
+
+the font of chart text。
+
+### Theme.legend
+
+[LegendTheme](#legendtheme)
+
+### Theme.serie
+
+[SerieTheme](#serietheme)
+
+### Theme.subTitle
+
+[SubTitleTheme](#subtitletheme)
+
+### Theme.themeName
+
+`string`
+
+the name of theme.
+
+### Theme.themeType
+
+[ThemeType](#themetype)
+
+the theme of chart.
+
+Options:
+
+- `Default`: 默认主题。
+- `Light`: 亮主题。
+- `Dark`: 暗主题。
+- `Custom`: 自定义主题。
+
+### Theme.title
+
+[TitleTheme](#titletheme)
+
+### Theme.tMPFont
+
+`TMP_FontAsset`
+
+the font of chart text。
+
+### Theme.tooltip
+
+[TooltipTheme](#tooltiptheme)
+
+### Theme.visualMap
+
+[VisualMapTheme](#visualmaptheme)
## ThemeStyle
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
Theme.
-```mdx-code-block
-
-```
+### ThemeStyle.customBackgroundColor
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||
-|sharedTheme|||the asset of theme. [Theme](#theme)|
-|transparentBackground|false||Whether the background color is transparent. When true, the background color is not drawn.
-|enableCustomTheme|false||Whether to customize theme colors. When set to true, you can use 'sync color to custom' to synchronize the theme color to the custom color. It can also be set manually.
-|customFont|||
-|customBackgroundColor|||the custom background color of chart.
-|customColorPalette|||
+the custom background color of chart.
-```mdx-code-block
-
-```
+### ThemeStyle.customColorPalette
+
+`List`
+
+### ThemeStyle.customFont
+
+`Font`
+
+### ThemeStyle.enableCustomTheme
+
+`bool` `false`
+
+Whether to customize theme colors. When set to true, you can use 'sync color to custom' to synchronize the theme color to the custom color. It can also be set manually.
+
+### ThemeStyle.sharedTheme
+
+[Theme](#theme)
+
+the asset of theme.
+
+### ThemeStyle.show
+
+`bool` `true`
+
+### ThemeStyle.transparentBackground
+
+`bool` `false`
+
+Whether the background color is transparent. When true, the background color is not drawn.
## Title
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged)
Title component, including main title and subtitle.
-```mdx-code-block
-
-```
+### Title.itemGap
+`float` `0`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||[default:true] Set this to false to prevent the title from showing.
-|text|||The main title text, supporting \n for newlines.
-|subText|||Subtitle text, supporting for \n for newlines.
-|labelStyle|||The text style of main title. [LabelStyle](#labelstyle)|
-|subLabelStyle|||The text style of sub title. [LabelStyle](#labelstyle)|
-|itemGap|0||[default:8] The gap between the main title and subtitle.
-|location|||The location of title component. [Location](#location)|
+[default:8] The gap between the main title and subtitle.
-```mdx-code-block
-
-```
+### Title.labelStyle
+
+[LabelStyle](#labelstyle)
+
+The text style of main title.
+
+### Title.location
+
+[Location](#location)
+
+The location of title component.
+
+### Title.show
+
+`bool` `true`
+
+[default:true] Set this to false to prevent the title from showing.
+
+### Title.subLabelStyle
+
+[LabelStyle](#labelstyle)
+
+The text style of sub title.
+
+### Title.subText
+
+`string`
+
+Subtitle text, supporting for \n for newlines.
+
+### Title.text
+
+`string`
+
+The main title text, supporting \n for newlines.
## TitleStyle
-> class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle), [ISerieDataComponent](#iseriedatacomponent), [ISerieComponent](#iseriecomponent)
+class in XCharts.Runtime / Inherits from: [LabelStyle](#labelstyle), [ISerieDataComponent](#iseriedatacomponent), [ISerieComponent](#iseriecomponent)
the title of serie.
## TitleTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
## Tooltip
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
Tooltip component.
-```mdx-code-block
-
-```
+### Tooltip.alwayShowContent
+`bool` `false`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether to show the tooltip component.
-|type|||Indicator type.
`Tooltip.Type`:
- `Line`: line indicator.
- `Shadow`: shadow crosshair indicator.
- `None`: no indicator displayed.
- `Cross`: crosshair indicator, which is actually the shortcut of enable two axisPointers of two orthometric axes.
- `Auto`: Auto select indicator according to serie type.
|
-|trigger|||Type of triggering.
`Tooltip.Trigger`:
- `Item`: Triggered by data item, which is mainly used for charts that don't have a category axis like scatter charts or pie charts.
- `Axis`: Triggered by axes, which is mainly used for charts that have category axes, like bar charts or line charts.
- `None`: Trigger nothing.
- `Auto`: Auto select trigger according to serie type.
|
-|triggerOn||v3.11.0|Condition of trigger tooltip.
`Tooltip.TriggerOn`:
- `MouseMove`: Trigger when mouse move.
- `Click`: Trigger when mouse click.
|
-|position||v3.3.0|Type of position.
`Tooltip.Position`:
- `Auto`: Auto. The mobile platform is displayed at the top, and the non-mobile platform follows the mouse position.
- `Custom`: Custom. Fully customize display position (x,y).
- `FixedX`: Just fix the coordinate X. Y follows the mouse position.
- `FixedY`:
|
-|itemFormatter|||a string template formatter for a single Serie or data item content. Support for wrapping lines with \n. Template variables are {.}, {a}, {b}, {c}, {d}.
{.} is the dot of the corresponding color of a Serie that is currently indicated or whose index is 0.
{a} is the series name of the serie that is currently indicated or whose index is 0.
{b} is the name of the data item serieData that is currently indicated or whose index is 0, or a category value (such as the X-axis of a line chart).
{c} is the value of a Y-dimension (dimesion is 1) from a Serie that is currently indicated or whose index is 0.
{d} is the percentage value of Y-dimensions (dimesion is 1) from serie that is currently indicated or whose index is 0, with no % sign.
{e} is the name of the data item serieData that is currently indicated or whose index is 0.
{f} is sum of data.
{y} is category value of y axis.
{.1} represents a dot from serie corresponding color that specifies index as 1.
1 in {a1}, {b1}, {c1} represents a serie that specifies an index of 1.
{c1:2} represents the third data from serie's current indication data item indexed to 1 (a data item has multiple data, index 2 represents the third data).
{c1:2-2} represents the third data item from serie's third data item indexed to 1 (i.e., which data item must be specified to specify).
{d1:2: F2} indicates that a formatted string with a value specified separately is F2 (numericFormatter is used when numericFormatter is not specified).
{d:0.##} indicates that a formatted string with a value specified separately is 0.## (used for percentage, reserved 2 valid digits while avoiding the situation similar to "100.00%" when using f2 ).
Example: "{a}, {c}", "{a1}, {c1: f1}", "{a1}, {c1:0: f1}", "{a1} : {c1:1-1: f1}"
-|titleFormatter|||String template formatter for tooltip title content. \n line wrapping is supported. The placeholder {i} can be set separately to indicate that title is ignored and not displayed. Template variables are {.}, {a}, {b}, {c}, {d}, {e}, {f}, and {g}.
{.} is the dot of the corresponding color of serie currently indicated or index 0.
{a} is the series name name of serie currently indicated or index 0.
{b} is the name of the serie data item serieData currently indicated or index 0, or the category value (such as the X-axis of a line chart).
{c} is the value of the serie y-dimension (dimesion is 1) currently indicated or index is 0.
{d} is the serie y-dimensional (dimesion 1) percentage value of the currently indicated or index 0, note without the % sign.
{e} is the name of the serie data item serieData currently indicated or whose index is 0.
{h} is the hexadecimal color value of serieData for the serie data item currently indicated or index 0.
{f} is the sum of data.
{g} indicates the total number of data.
{y} is category value of y axis.
{.1} represents a dot of the corresponding color with serie specified as index 1.
The 1 in {a1}, {b1}, {c1} represents serie where index is specified as 1.
{c1:2} represents the third data of the current indicator data item in serie with index 1 (one data item has multiple data, index 2 represents the third data).
{c1:2-2} represents the third data of serie third data item with index 1 (that is, the number of data items must be specified when specifying the number of data items).
{d1:2:f2} indicates that a format string with a single value is f2 (numericFormatter is used if no value is specified).
{d:0.##} indicates that the format string with a value specified alone is 0.## # (for percentages, preserving a 2-digit significant number while avoiding the "100.00%" situation with f2).
example: "{a}, {c}", "{a1}, {c1: f1}", "{a1}, {c1:0: f1}", "{a1}, {c1:1-1: f1}"
-|marker|||the marker of serie.
-|fixedWidth|0||Fixed width. Higher priority than minWidth.
-|fixedHeight|0||Fixed height. Higher priority than minHeight.
-|minWidth|0||Minimum width. If fixedWidth has a value, get fixedWidth first.
-|minHeight|0||Minimum height. If fixedHeight has a value, take priority over fixedHeight.
-|numericFormatter|||Standard number and date format string. Used to format a Double value or a DateTime date as a string. numericFormatter is used as an argument to either `Double.ToString ()` or `DateTime.ToString()`.
The number format uses the Axx format: A is a single-character format specifier that supports C currency, D decimal, E exponent, F fixed-point number, G regular, N digit, P percentage, R round trip, and X hexadecimal. xx is precision specification, from 0-99. E.g. F1, E2
Date format Common date formats are: yyyy year, MM month, dd day, HH hour, mm minute, ss second, fff millisecond. For example: yyyy-MM-dd HH:mm:ss
number format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
date format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
-|paddingLeftRight|10||the text padding of left and right. defaut:5.
-|paddingTopBottom|10||the text padding of top and bottom. defaut:5.
-|ignoreDataShow|false||Whether to show ignored data on tooltip.
-|ignoreDataDefaultContent|||The default display character information for ignored data.
-|showContent|true||Whether to show the tooltip floating layer, whose default value is true. It should be configurated to be false, if you only need tooltip to trigger the event or show the axisPointer without content.
-|alwayShowContent|false||Whether to trigger after always display.
-|offset|Vector2(18f, -25f)||The position offset of tooltip relative to the mouse position.
-|backgroundImage|||The background image of tooltip.
-|backgroundType|||The background type of tooltip.
-|backgroundColor|||The background color of tooltip.
-|borderWidth|2f||the width of tooltip border.
-|fixedX|0f||the x positionn of fixedX.
-|fixedY|0.7f||the y position of fixedY.
-|titleHeight|25f||height of title text.
-|itemHeight|25f||height of content text.
-|borderColor|Color32(230, 230, 230, 255)||the color of tooltip border.
-|lineStyle|||the line style of indicator line. [LineStyle](#linestyle)|
-|titleLabelStyle|||the textstyle of title. [LabelStyle](#labelstyle)|
-|contentLabelStyles|||the textstyle list of content.
+Whether to trigger after always display.
-```mdx-code-block
-
-```
+### Tooltip.backgroundColor
+
+`Color`
+
+The background color of tooltip.
+
+### Tooltip.backgroundImage
+
+`Sprite`
+
+The background image of tooltip.
+
+### Tooltip.backgroundType
+
+`Image.Type`
+
+The background type of tooltip.
+
+### Tooltip.borderColor
+
+`Color32` `Color32(230, 230, 230, 255)`
+
+the color of tooltip border.
+
+### Tooltip.borderWidth
+
+`float` `2f`
+
+the width of tooltip border.
+
+### Tooltip.contentLabelStyles
+
+`List`
+
+the textstyle list of content.
+
+### Tooltip.fixedHeight
+
+`float` `0`
+
+Fixed height. Higher priority than minHeight.
+
+### Tooltip.fixedWidth
+
+`float` `0`
+
+Fixed width. Higher priority than minWidth.
+
+### Tooltip.fixedX
+
+`float` `0f`
+
+the x positionn of fixedX.
+
+### Tooltip.fixedY
+
+`float` `0.7f`
+
+the y position of fixedY.
+
+### Tooltip.ignoreDataDefaultContent
+
+`string`
+
+The default display character information for ignored data.
+
+### Tooltip.ignoreDataShow
+
+`bool` `false`
+
+Whether to show ignored data on tooltip.
+
+### Tooltip.itemFormatter
+
+`string`
+
+a string template formatter for a single Serie or data item content. Support for wrapping lines with \n. Template variables are {.}, {a}, {b}, {c}, {d}.
{.} is the dot of the corresponding color of a Serie that is currently indicated or whose index is 0.
{a} is the series name of the serie that is currently indicated or whose index is 0.
{b} is the name of the data item serieData that is currently indicated or whose index is 0, or a category value (such as the X-axis of a line chart).
{c} is the value of a Y-dimension (dimesion is 1) from a Serie that is currently indicated or whose index is 0.
{d} is the percentage value of Y-dimensions (dimesion is 1) from serie that is currently indicated or whose index is 0, with no % sign.
{e} is the name of the data item serieData that is currently indicated or whose index is 0.
{f} is sum of data.
{y} is category value of y axis.
{.1} represents a dot from serie corresponding color that specifies index as 1.
1 in {a1}, {b1}, {c1} represents a serie that specifies an index of 1.
{c1:2} represents the third data from serie's current indication data item indexed to 1 (a data item has multiple data, index 2 represents the third data).
{c1:2-2} represents the third data item from serie's third data item indexed to 1 (i.e., which data item must be specified to specify).
{d1:2: F2} indicates that a formatted string with a value specified separately is F2 (numericFormatter is used when numericFormatter is not specified).
{d:0.##} indicates that a formatted string with a value specified separately is 0.## (used for percentage, reserved 2 valid digits while avoiding the situation similar to "100.00%" when using f2 ).
Example: "{a}, {c}", "{a1}, {c1: f1}", "{a1}, {c1:0: f1}", "{a1} : {c1:1-1: f1}"
+
+### Tooltip.itemHeight
+
+`float` `25f`
+
+height of content text.
+
+### Tooltip.lineStyle
+
+[LineStyle](#linestyle)
+
+the line style of indicator line.
+
+### Tooltip.marker
+
+`string`
+
+the marker of serie.
+
+### Tooltip.minHeight
+
+`float` `0`
+
+Minimum height. If fixedHeight has a value, take priority over fixedHeight.
+
+### Tooltip.minWidth
+
+`float` `0`
+
+Minimum width. If fixedWidth has a value, get fixedWidth first.
+
+### Tooltip.numericFormatter
+
+`string`
+
+Standard number and date format string. Used to format a Double value or a DateTime date as a string. numericFormatter is used as an argument to either `Double.ToString ()` or `DateTime.ToString()`.
The number format uses the Axx format: A is a single-character format specifier that supports C currency, D decimal, E exponent, F fixed-point number, G regular, N digit, P percentage, R round trip, and X hexadecimal. xx is precision specification, from 0-99. E.g. F1, E2
Date format: Starts with `date`, which is used to format DateTime. Common date formats are: yyyy year, MM month, dd day, HH hour, mm minute, ss second, fff millisecond. For example: date:yyyy-MM-dd HH:mm:ss
Time format: Starts with `time`, which is used to format TimeSpan. Common time formats are: d day, HH hour, mm minute, ss second, fffffff fractional part. Only the version of Unity2018 or later can support formatting, and the characters inside should be escaped. For example: time:HH\:mm\:ss
number format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
date format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
Note: The date and time formats are only supported by 'v3.12.0' or later.
+
+### Tooltip.offset
+
+`Vector2` `Vector2(18f, -25f)`
+
+The position offset of tooltip relative to the mouse position.
+
+### Tooltip.paddingLeftRight
+
+`int` `10`
+
+the text padding of left and right. defaut:5.
+
+### Tooltip.paddingTopBottom
+
+`int` `10`
+
+the text padding of top and bottom. defaut:5.
+
+### Tooltip.position
+
+[Tooltip.Position](#tooltipposition) `v3.3.0`
+
+Type of position.
+
+Options:
+
+- `Auto`: Auto. The mobile platform is displayed at the top, and the non-mobile platform follows the mouse position.
+- `Custom`: Custom. Fully customize display position (x,y).
+- `FixedX`: Just fix the coordinate X. Y follows the mouse position.
+- `FixedY`:
+
+### Tooltip.show
+
+`bool` `true`
+
+Whether to show the tooltip component.
+
+### Tooltip.showContent
+
+`bool` `true`
+
+Whether to show the tooltip floating layer, whose default value is true. It should be configurated to be false, if you only need tooltip to trigger the event or show the axisPointer without content.
+
+### Tooltip.titleFormatter
+
+`string`
+
+String template formatter for tooltip title content. \n line wrapping is supported. The placeholder {i} can be set separately to indicate that title is ignored and not displayed. Template variables are {.}, {a}, {b}, {c}, {d}, {e}, {f}, and {g}.
{.} is the dot of the corresponding color of serie currently indicated or index 0.
{a} is the series name name of serie currently indicated or index 0.
{b} is the name of the serie data item serieData currently indicated or index 0, or the category value (such as the X-axis of a line chart).
{c} is the value of the serie y-dimension (dimesion is 1) currently indicated or index is 0.
{d} is the serie y-dimensional (dimesion 1) percentage value of the currently indicated or index 0, note without the % sign.
{e} is the name of the serie data item serieData currently indicated or whose index is 0.
{h} is the hexadecimal color value of serieData for the serie data item currently indicated or index 0.
{f} is the sum of data.
{g} indicates the total number of data.
{y} is category value of y axis.
{.1} represents a dot of the corresponding color with serie specified as index 1.
The 1 in {a1}, {b1}, {c1} represents serie where index is specified as 1.
{c1:2} represents the third data of the current indicator data item in serie with index 1 (one data item has multiple data, index 2 represents the third data).
{c1:2-2} represents the third data of serie third data item with index 1 (that is, the number of data items must be specified when specifying the number of data items).
{d1:2:f2} indicates that a format string with a single value is f2 (numericFormatter is used if no value is specified).
{d:0.##} indicates that the format string with a value specified alone is 0.## # (for percentages, preserving a 2-digit significant number while avoiding the "100.00%" situation with f2).
example: "{a}, {c}", "{a1}, {c1: f1}", "{a1}, {c1:0: f1}", "{a1}, {c1:1-1: f1}"
+
+### Tooltip.titleHeight
+
+`float` `25f`
+
+height of title text.
+
+### Tooltip.titleLabelStyle
+
+[LabelStyle](#labelstyle)
+
+the textstyle of title.
+
+### Tooltip.trigger
+
+[Tooltip.Trigger](#tooltiptrigger)
+
+Type of triggering.
+
+Options:
+
+- `Item`: Triggered by data item, which is mainly used for charts that don't have a category axis like scatter charts or pie charts.
+- `Axis`: Triggered by axes, which is mainly used for charts that have category axes, like bar charts or line charts.
+- `None`: Trigger nothing.
+- `Auto`: Auto select trigger according to serie type.
+
+### Tooltip.triggerOn
+
+[Tooltip.TriggerOn](#tooltiptriggeron) `v3.11.0`
+
+Condition of trigger tooltip.
+
+Options:
+
+- `MouseMove`: Trigger when mouse move.
+- `Click`: Trigger when mouse click.
+
+### Tooltip.type
+
+[Tooltip.Type](#tooltiptype)
+
+Indicator type.
+
+Options:
+
+- `Line`: line indicator.
+- `Shadow`: shadow crosshair indicator.
+- `None`: no indicator displayed.
+- `Cross`: crosshair indicator, which is actually the shortcut of enable two axisPointers of two orthometric axes.
+- `Auto`: Auto select indicator according to serie type.
## TooltipTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
-```mdx-code-block
-
-```
+### TooltipTheme.areaColor
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|lineType|||the type of line.
`LineStyle.Type`:
- `Solid`: 实线
- `Dashed`: 虚线
- `Dotted`: 点线
- `DashDot`: 点划线
- `DashDotDot`: 双点划线
- `None`: 双点划线
|
-|lineWidth|1f||the width of line.
-|lineColor|||the color of line.
-|areaColor|||the color of line.
-|labelTextColor|||the text color of tooltip cross indicator's axis label.
-|labelBackgroundColor|||the background color of tooltip cross indicator's axis label.
+the color of line.
-```mdx-code-block
-
-```
+### TooltipTheme.labelBackgroundColor
+
+`Color32`
+
+the background color of tooltip cross indicator's axis label.
+
+### TooltipTheme.labelTextColor
+
+`Color32`
+
+the text color of tooltip cross indicator's axis label.
+
+### TooltipTheme.lineColor
+
+`Color32`
+
+the color of line.
+
+### TooltipTheme.lineType
+
+[LineStyle.Type](#linestyletype)
+
+the type of line.
+
+Options:
+
+- `Solid`: 实线
+- `Dashed`: 虚线
+- `Dotted`: 点线
+- `DashDot`: 点划线
+- `DashDotDot`: 双点划线
+- `None`: 双点划线
+
+### TooltipTheme.lineWidth
+
+`float` `1f`
+
+the width of line.
## UIComponentTheme
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
-```mdx-code-block
-
-```
+### UIComponentTheme.sharedTheme
+[Theme](#theme)
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||
-|sharedTheme|||the asset of theme. [Theme](#theme)|
-|transparentBackground|false||
+the asset of theme.
-```mdx-code-block
-
-```
+### UIComponentTheme.show
+
+`bool` `true`
+
+### UIComponentTheme.transparentBackground
+
+`bool` `false`
## ViewControl
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
> Since `v3.11.0`
View control component in 3D coordinate system.
-```mdx-code-block
-
-```
+### ViewControl.alpha
+`float` `90f`
-|field|default|since|comment|
-|--|--|--|--|
-|alpha|90f||The angle of the view in the x-z plane.
-|beta|55f||The angle of the view in the y-z plane.
+The angle of the view in the x-z plane.
-```mdx-code-block
-
-```
+### ViewControl.beta
+
+`float` `55f`
+
+The angle of the view in the y-z plane.
## VisualMap
-> class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
+class in XCharts.Runtime / Inherits from: [MainComponent](#maincomponent)
VisualMap component. Mapping data to visual elements such as colors.
-```mdx-code-block
-
-```
+### VisualMap.autoMinMax
+`bool` `true`
-|field|default|since|comment|
-|--|--|--|--|
-|show|true||Whether to enable components.
-|showUI|false||Whether to display components. If set to false, it will not show up, but the data mapping function still exists.
-|type|||the type of visualmap component.
`VisualMap.Type`:
- `Continuous`: 连续型。
- `Piecewise`: 分段型。
|
-|selectedMode|||the selected mode for Piecewise visualMap.
`VisualMap.SelectedMode`:
- `Multiple`: 多选。
- `Single`: 单选。
|
-|serieIndex|0||the serie index of visualMap.
-|min|0||范围最小值
-|max|0||范围最大值
-|range|||Specifies the position of the numeric value corresponding to the handle. Range should be within the range of [min,max].
-|text|||Text on both ends.
-|textGap|||The distance between the two text bodies.
-|splitNumber|5||For continuous data, it is automatically evenly divided into several segments and automatically matches the size of inRange color list when the default is 0.
-|calculable|false||Whether the handle used for dragging is displayed (the handle can be dragged to adjust the selected range).
-|realtime|true||Whether to update in real time while dragging.
-|itemWidth|20f||The width of the figure, that is, the width of the color bar.
-|itemHeight|140f||The height of the figure, that is, the height of the color bar.
-|itemGap|10f||每个图元之间的间隔距离。
-|borderWidth|0||Border line width.
-|dimension|-1||Specifies "which dimension" of the data to map to the visual element. "Data" is series.data.
-|hoverLink|true||When the hoverLink function is turned on, when the mouse hovers over the visualMap component, the corresponding value of the mouse position is highlighted in the corresponding graphic element in the diagram.
-|autoMinMax|true||Automatically set min, Max value 自动设置min,max的值
-|orient|||Specify whether the layout of component is horizontal or vertical.
`Orient`:
- `Horizonal`: 水平
- `Vertical`: 垂直
|
-|location|||The location of component. [Location](#location)|
-|workOnLine|true||Whether the visualmap is work on linestyle of linechart.
-|workOnArea|false||Whether the visualmap is work on areaStyle of linechart.
-|outOfRange|||Defines a visual color outside of the selected range.
-|inRange|||分段式每一段的相关配置。
+Automatically set min, Max value 自动设置min,max的值
-```mdx-code-block
-
-```
+### VisualMap.borderWidth
+
+`float` `0`
+
+Border line width.
+
+### VisualMap.calculable
+
+`bool` `false`
+
+Whether the handle used for dragging is displayed (the handle can be dragged to adjust the selected range).
+
+### VisualMap.dimension
+
+`int` `-1`
+
+Specifies "which dimension" of the data to map to the visual element. "Data" is series.data.
+
+### VisualMap.hoverLink
+
+`bool` `true`
+
+When the hoverLink function is turned on, when the mouse hovers over the visualMap component, the corresponding value of the mouse position is highlighted in the corresponding graphic element in the diagram.
+
+### VisualMap.inRange
+
+`List`
+
+分段式每一段的相关配置。
+
+### VisualMap.itemGap
+
+`float` `10f`
+
+每个图元之间的间隔距离。
+
+### VisualMap.itemHeight
+
+`float` `140f`
+
+The height of the figure, that is, the height of the color bar.
+
+### VisualMap.itemWidth
+
+`float` `20f`
+
+The width of the figure, that is, the width of the color bar.
+
+### VisualMap.location
+
+[Location](#location)
+
+The location of component.
+
+### VisualMap.max
+
+`double` `0`
+
+范围最大值
+
+### VisualMap.min
+
+`double` `0`
+
+范围最小值
+
+### VisualMap.orient
+
+[Orient](#orient)
+
+Specify whether the layout of component is horizontal or vertical.
+
+Options:
+
+- `Horizonal`: 水平
+- `Vertical`: 垂直
+
+### VisualMap.outOfRange
+
+`List`
+
+Defines a visual color outside of the selected range.
+
+### VisualMap.range
+
+`double[]`
+
+Specifies the position of the numeric value corresponding to the handle. Range should be within the range of [min,max].
+
+### VisualMap.realtime
+
+`bool` `true`
+
+Whether to update in real time while dragging.
+
+### VisualMap.selectedMode
+
+[VisualMap.SelectedMode](#visualmapselectedmode)
+
+the selected mode for Piecewise visualMap.
+
+Options:
+
+- `Multiple`: 多选。
+- `Single`: 单选。
+
+### VisualMap.serieIndex
+
+`int` `0`
+
+the serie index of visualMap.
+
+### VisualMap.show
+
+`bool` `true`
+
+Whether to enable components.
+
+### VisualMap.showUI
+
+`bool` `false`
+
+Whether to display components. If set to false, it will not show up, but the data mapping function still exists.
+
+### VisualMap.splitNumber
+
+`int` `5`
+
+For continuous data, it is automatically evenly divided into several segments and automatically matches the size of inRange color list when the default is 0.
+
+### VisualMap.text
+
+`string[]`
+
+Text on both ends.
+
+### VisualMap.textGap
+
+`float[]`
+
+The distance between the two text bodies.
+
+### VisualMap.type
+
+[VisualMap.Type](#visualmaptype)
+
+the type of visualmap component.
+
+Options:
+
+- `Continuous`: 连续型。
+- `Piecewise`: 分段型。
+
+### VisualMap.workOnArea
+
+`bool` `false`
+
+Whether the visualmap is work on areaStyle of linechart.
+
+### VisualMap.workOnLine
+
+`bool` `true`
+
+Whether the visualmap is work on linestyle of linechart.
## VisualMapRange
-> class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
+class in XCharts.Runtime / Inherits from: [ChildComponent](#childcomponent)
-```mdx-code-block
-
-```
+### VisualMapRange.color
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|min|||范围最小值
-|max|||范围最大值
-|label|||文字描述
-|color|||颜色
+颜色
-```mdx-code-block
-
-```
+### VisualMapRange.label
+
+`string`
+
+文字描述
+
+### VisualMapRange.max
+
+`double`
+
+范围最大值
+
+### VisualMapRange.min
+
+`double`
+
+范围最小值
## VisualMapTheme
-> class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
+class in XCharts.Runtime / Inherits from: [ComponentTheme](#componenttheme)
-```mdx-code-block
-
-```
+### VisualMapTheme.backgroundColor
+`Color32`
-|field|default|since|comment|
-|--|--|--|--|
-|borderWidth|||the width of border.
-|borderColor|||the color of dataZoom border.
-|backgroundColor|||the background color of visualmap.
-|triangeLen|20f||可视化组件的调节三角形边长。
+the background color of visualmap.
-```mdx-code-block
-
-```
+### VisualMapTheme.borderColor
+
+`Color32`
+
+the color of dataZoom border.
+
+### VisualMapTheme.borderWidth
+
+`float`
+
+the width of border.
+
+### VisualMapTheme.triangeLen
+
+`float` `20f`
+
+可视化组件的调节三角形边长。
## Wrapper<T>
-> class in XCharts.Runtime
+class in XCharts.Runtime
## XAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
The x axis in cartesian(rectangular) coordinate.
## XAxis3D
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
> Since `v3.11.0`
@@ -2542,68 +5327,185 @@ The x axis in cartesian(rectangular) coordinate.
## XCResourcesImporter
-> class in XCharts.Runtime
+class in XCharts.Runtime
## XCSettings
-> class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=ScriptableObject)
+class in XCharts.Runtime / Inherits from: [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=ScriptableObject)
-```mdx-code-block
-
-```
+### XCSettings.axisLineType
+
+[LineStyle.Type](#linestyletype)
-|field|default|since|comment|
-|--|--|--|--|
-|lang||| [Lang](#lang)|
-|font|||
-|tMPFont|||
-|fontSizeLv1|28||一级字体大小。
-|fontSizeLv2|24||
-|fontSizeLv3|20||
-|fontSizeLv4|18||
-|axisLineType|||
`LineStyle.Type`:
- `Solid`: 实线
- `Dashed`: 虚线
- `Dotted`: 点线
- `DashDot`: 点划线
- `DashDotDot`: 双点划线
- `None`: 双点划线
|
-|axisLineWidth|0.8f||
-|axisSplitLineType|||
`LineStyle.Type`:
- `Solid`: 实线
- `Dashed`: 虚线
- `Dotted`: 点线
- `DashDot`: 点划线
- `DashDotDot`: 双点划线
- `None`: 双点划线
|
-|axisSplitLineWidth|0.8f||
-|axisTickWidth|0.8f||
-|axisTickLength|5f||
-|gaugeAxisLineWidth|15f||
-|gaugeAxisSplitLineWidth|0.8f||
-|gaugeAxisSplitLineLength|15f||
-|gaugeAxisTickWidth|0.8f||
-|gaugeAxisTickLength|5f||
-|tootipLineWidth|0.8f||
-|dataZoomBorderWidth|0.5f||
-|dataZoomDataLineWidth|0.5f||
-|visualMapBorderWidth|0f||
-|serieLineWidth|1.8f||
-|serieLineSymbolSize|5f||
-|serieScatterSymbolSize|20f||
-|serieSelectedRate|1.3f||
-|serieCandlestickBorderWidth|1f||
-|editorShowAllListData|false||
-|maxPainter|10||
-|lineSmoothStyle|3f||
-|lineSmoothness|2f||
-|lineSegmentDistance|3f||
-|cicleSmoothness|2f||
-|visualMapTriangeLen|20f||
-|customThemes|||
-```mdx-code-block
-
-```
+Options:
+
+- `Solid`: 实线
+- `Dashed`: 虚线
+- `Dotted`: 点线
+- `DashDot`: 点划线
+- `DashDotDot`: 双点划线
+- `None`: 双点划线
+
+### XCSettings.axisLineWidth
+
+`float` `0.8f`
+
+### XCSettings.axisSplitLineType
+
+[LineStyle.Type](#linestyletype)
+
+
+
+Options:
+
+- `Solid`: 实线
+- `Dashed`: 虚线
+- `Dotted`: 点线
+- `DashDot`: 点划线
+- `DashDotDot`: 双点划线
+- `None`: 双点划线
+
+### XCSettings.axisSplitLineWidth
+
+`float` `0.8f`
+
+### XCSettings.axisTickLength
+
+`float` `5f`
+
+### XCSettings.axisTickWidth
+
+`float` `0.8f`
+
+### XCSettings.cicleSmoothness
+
+`float` `2f`
+
+### XCSettings.customThemes
+
+`List`
+
+### XCSettings.dataZoomBorderWidth
+
+`float` `0.5f`
+
+### XCSettings.dataZoomDataLineWidth
+
+`float` `0.5f`
+
+### XCSettings.editorShowAllListData
+
+`bool` `false`
+
+### XCSettings.font
+
+`Font`
+
+### XCSettings.fontSizeLv1
+
+`int` `28`
+
+一级字体大小。
+
+### XCSettings.fontSizeLv2
+
+`int` `24`
+
+### XCSettings.fontSizeLv3
+
+`int` `20`
+
+### XCSettings.fontSizeLv4
+
+`int` `18`
+
+### XCSettings.gaugeAxisLineWidth
+
+`float` `15f`
+
+### XCSettings.gaugeAxisSplitLineLength
+
+`float` `15f`
+
+### XCSettings.gaugeAxisSplitLineWidth
+
+`float` `0.8f`
+
+### XCSettings.gaugeAxisTickLength
+
+`float` `5f`
+
+### XCSettings.gaugeAxisTickWidth
+
+`float` `0.8f`
+
+### XCSettings.lang
+
+[Lang](#lang)
+
+### XCSettings.lineSegmentDistance
+
+`float` `3f`
+
+### XCSettings.lineSmoothness
+
+`float` `2f`
+
+### XCSettings.lineSmoothStyle
+
+`float` `3f`
+
+### XCSettings.maxPainter
+
+`int` `10`
+
+### XCSettings.serieCandlestickBorderWidth
+
+`float` `1f`
+
+### XCSettings.serieLineSymbolSize
+
+`float` `5f`
+
+### XCSettings.serieLineWidth
+
+`float` `1.8f`
+
+### XCSettings.serieScatterSymbolSize
+
+`float` `20f`
+
+### XCSettings.serieSelectedRate
+
+`float` `1.3f`
+
+### XCSettings.tMPFont
+
+`TMP_FontAsset`
+
+### XCSettings.tootipLineWidth
+
+`float` `0.8f`
+
+### XCSettings.visualMapBorderWidth
+
+`float` `0f`
+
+### XCSettings.visualMapTriangeLen
+
+`float` `20f`
## YAxis
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
The x axis in cartesian(rectangular) coordinate.
## YAxis3D
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
> Since `v3.11.0`
@@ -2611,9 +5513,8 @@ The x axis in cartesian(rectangular) coordinate.
## ZAxis3D
-> class in XCharts.Runtime / Inherits from: [Axis](#axis)
+class in XCharts.Runtime / Inherits from: [Axis](#axis)
> Since `v3.11.0`
The x axis in cartesian(rectangular) coordinate.
-
diff --git a/Documentation~/en/img/tutorial01_axisdata.png b/Documentation~/en/img/tutorial01_axisdata.png
new file mode 100644
index 00000000..8c4910af
Binary files /dev/null and b/Documentation~/en/img/tutorial01_axisdata.png differ
diff --git a/Documentation~/en/img/tutorial01_seriedata.png b/Documentation~/en/img/tutorial01_seriedata.png
new file mode 100644
index 00000000..167d02ac
Binary files /dev/null and b/Documentation~/en/img/tutorial01_seriedata.png differ
diff --git a/Documentation~/en/tutorial01.md b/Documentation~/en/tutorial01.md
index 9dd66ef8..782f33b5 100644
--- a/Documentation~/en/tutorial01.md
+++ b/Documentation~/en/tutorial01.md
@@ -1,103 +1,143 @@
---
-title: Introductory tutorial: Get started with XCharts 3.0 in 5 minutes
+title: Tutorial: Getting Started with XCharts 3.0 in 5 Minutes
sidebar_position: 11
slug: /tutorial01
---
-# Tutorial: Get started with XCharts 3.0 in 5 minutes
+# Tutorial: Getting Started with XCharts 3.0 in 5 Minutes
-> Note: This tutorial is for XCharts 3.x version only
-## What do I need to know before using XCharts
+> Note: This tutorial is only applicable to the XCharts 3.x version. For the 2.x version, please refer to [Tutorial: Mastering XCharts 2.0](https://github.com/XCharts-Team/XCharts/blob/2.0/Doc/Tutorial%3A5-Minute-Start-to-XCharts.md)
-- Have used Unity, know the basic operation of Unity.
-- Understand UGUI and can use UGUI.
-- Understand MonoBehavior script usage in Unity, know how to hang scripts, manipulate scripts with code.
+## Prerequisites for XCharts
-## Get and import XCharts
+XCharts is a Unity chart plugin, currently only available for use on the Unity platform.
-XCharts can be imported into a project in any of the following ways:
+Before using XCharts, you need to:
-- Source XCharts directly into the project
+- Have a basic understanding of how to use Unity.
+- Understand the basic usage of UGUI for making UI.
+- Know how to use Unity's MonoBehavior scripts, how to attach scripts, and how to manipulate scripts with code.
- After downloading the XCharts source code, copy the XCharts directory directly to the Assets directory of the Unity project.
+If you are new to Unity, it is recommended to learn some basic Unity tutorials before using XCharts.
-- Import XCharts through `Assets/Import Package`
+## Obtaining and Importing XCharts
- After downloading the.unitypackage file for XCharts, open Unity and go to the menu bar Assets--> Import Package--> Select.unitypackage import to start using XCharts.
+XCharts is primarily maintained and released through Github. You can download the source code and Package from the [Github Homepage](https://github.com/XCharts-Team).
-- Import XCharts through the Package Manager
+XCharts can be imported into your project in any of the following ways:
- For Unity 2018.3 and later, XCharts can be imported through the Package Manager. After opening the Package Manager, run the `Add package form git URL...`, input XCharts dead simple URL: ` https://github.com/XCharts-Team/XCharts.git use XCharts after ` wait a moment.
+### Copying the XCharts Source Code Directly into the Project
- You can also add the package directly to the manifest.json file: Open the manifest.json file in the Packages directory and add it under dependencies:
+After downloading the XCharts source code, simply copy the XCharts directory into the Assets directory of your Unity project. Once compiled, it is ready to use.
- ``` json
- "com.monitor1394.xcharts" : "https://github.com/XCharts-Team/XCharts.git",
- ```
+### Importing XCharts through Import Package
- To update XCharts, remove com.monitor1394.xcharts from the manifest.json file under lock (some versions of Unity may be packages-lock.json) and re-download and compile.
+After downloading the .unitypackage file of XCharts, open Unity, go to the menu bar Assets-->Import Package-->select the downloaded .unitypackage to import. After the import is complete and compiled, you can start using XCharts.
-- Recommended daemon into XCharts (not required)
+### Importing XCharts through Package Manager
- [XCharts Daemon](https://github.com/XCharts-Team/XCharts-Daemon) can ensure update compilation is normal, when the local open TextMeshPro or NewInputSystem would be very useful. After importing Xchart-daemon into a project, when updating XCharts, the Daemon will automatically refresh asmdef according to the status of local TMP, etc., to ensure normal compilation and facilitate the execution of automated processes such as CI-CD.
+For Unity versions above 2018.3, you can import XCharts through the Package Manager. Open the Package Manager, then use `Add package from git URL...`, enter the GitHub URL of XCharts: `https://github.com/XCharts-Team/XCharts.git`. After compiling, you can use XCharts.
-## Add a simple chart
+For some Unity versions, you can also directly add the package to the `manifest.json` file: Open the `manifest.json` file under the `Packages` directory, and add the following under `dependencies`:
-Right-click in `Hierarchy` view or menu bar `GameObject` drop down and select `XCharts->LineChart`, can quickly create a default line chart out:
+>"com.monitor1394.xcharts": "https://github.com/XCharts-Team/XCharts.git",
+
+If you need to update `XCharts`, delete the relevant content of `com.monitor1394.xcharts` under the `lock` of the `manifest.json` file (some Unity versions may be the packages-lock.json file), and it will re-download and compile.
+
+### Recommended Import of XCharts Daemon
+
+The daemon [XCharts-Daemon](https://github.com/XCharts-Team/XCharts-Daemon) ensures that the compilation is normal when updating. It is very useful when TextMeshPro or NewInputSystem is turned on locally. After importing XCharts-Daemon into the project, the daemon will automatically refresh XCharts' asmdef according to the local situation of TMP when updating XCharts, ensuring that the compilation is normal without manual intervention, which is convenient for automated processes such as CI/CD.
+
+The import method of XCharts-Daemon can refer to the previous import method of XCharts. It can be imported into the project through source code or Package. The GitHub URL of XCharts-Daemon: https://github.com/XCharts-Team/XCharts-Daemon.git
+
+## Basic Usage of XCharts
+
+After importing XCharts and compiling, the XCharts menu will appear in the Unity editor's menu bar, and you can start using XCharts.
+
+>Note: The XCharts menu in the Unity menu bar indicates that XCharts is available.
+
+### Adding a Simple Chart
+
+In the `Hierarchy` view, right-click `UI->XCharts->LineChart` or select `LineChart` from the menu bar `XCharts` to quickly create a default line chart:

-## Add multiple Seire
+If you need to create a chart under a certain node, you can select the node and right-click `UI->XCharts->LineChart` to create a chart under the node.
-In the Inspector view, locate LineChart's panel, and with the `Add Serie` button, you can add a second Line line:
+### Modifying Chart Data
+
+For the newly created chart, its data can be modified on the Inspector panel.
+
+For X-axis data, you can add, delete, and modify by expanding: `XAxis->Data`:
+
+
+
+For Serie data, you can add, delete, and modify by expanding: `Serie->Data`:
+
+
+
+Serie supports multi-dimensional data, and generally, a line chart only uses two-dimensional data: the first dimension represents the ID of the X-axis category data, and the second dimension represents the corresponding value.
+
+### Adding Multiple Series
+
+In the `Inspector` view, find the `LineChart` panel, and click the `Add Serie` button to add a second `Line` line:


-## Add other components
+>Note: Series are added through the `Add Serie` button. Different types of Series can be added. [What kinds of Series does XCharts have?](https://xcharts-team.github.io/docs/configuration#serie-系列)
-The default chart does not have a `Legend`, and a `Legend` Component can be added via the `Add Component` button:
+### Adding Other Main Components
+
+By default, the chart does not have a `Legend`. If you need a `Legend` component, you can add it through the `Add Component` button:

-## Add Serie components
+>Note: Main components are added through the `Add Component` button. [What main components does XCharts have?](https://xcharts-team.github.io/docs/configuration/#maincomponent-主组件)
-Serie comes with only a few common components, and others are added as needed. For example, if you need to fill a line chart area with color, you can add a separate `AreaStyle` component to Serie:
+### Adding Serie Components
+
+Serie only comes with a few common components, and other components need to be added when used. For example, if you need to fill the area color for the line chart, you can add an `AreaStyle` component to `Serie` separately:


-## Add the SerieData component
+>Note: Serie components are added through the button on the right side of Serie. [What components can be added to Serie in XCharts?](https://xcharts-team.github.io/docs/configuration/#iseriecomponent-可添加到serie的组件)
-If you need to personalize the configuration of each data item, you can add a Component to each SerieData separately. For example, we give the second data of the line chart a separate display `Label`:
+### Adding SerieData Components
+
+If you need to customize the configuration of each data item individually, you can add components to each `SerieData` separately. For example, we can display `Label` for the second data of the line chart individually:


-## More components and configuration parameters
+>Note: SerieData components are added through the button on the right side of SerieData after expanding. [What components can be added to SerieData in XCharts?](https://xcharts-team.github.io/docs/configuration/#iseriedatacomponent-可添加到seriedata的组件)
-XCharts has been iteratively optimized and now has dozens of main and sub-components, each with a few to dozens of configurable parameters to support a variety of flexible and complex functions.
+### More Components and Configuration Parameters
-Using XCharts for the first time, you can add various charts in the `Inspector` view, add or adjust the components in the chart, and the `Game` view gives real-time feedback on the effects of adjustments to familiarize yourself with the use of various components. Detailed parameter descriptions of each component can be found in the [XCharts Configuration](Configuration.md).
+XCharts has been continuously iterated and optimized, and now has dozens of main components and sub-components, each with several to dozens of configurable parameters to support a variety of functions.
-## How to adjust parameters quickly
+When using XCharts for the first time, it is recommended to personally test the actual effects of each chart, each component. The `Inspector` view can directly add various charts, components, and adjust various configuration parameters, and the `Game` view will provide real-time feedback on the adjustments. A detailed description of each component's parameters can be found in the [XCharts Configuration Manual](configuration.md).
-XCharts is configuration and data driven. Want what effect, only need to adjust the configuration parameters under the corresponding component can be, do not need to change the nodes under the `Hierarchy` view, because those nodes are generated by the `XCharts` internal according to the configuration and data, even if changed will be restored in the refresh.
+### How to Quickly Adjust Parameters
-How to quickly locate the component corresponding to the effect you want to change requires a certain understanding of the component. For example, if we want to show an arrow at the end of the X-axis, how do we position it? First, position the X-axis to `XAxis0`; Second, locate the axis to `AxisLine`; Finally, check to see if there are any parameters in the AxisLine component that can achieve this effect, and check [XCharts configuration](Configuration.md) for uncertain parameters.
+XCharts is driven by data and parameters. To achieve the desired effect, simply adjust the configuration parameters under the corresponding component. Do not modify the nodes under the `Hierarchy` view, as those nodes are generated by XCharts internally based on configuration and data, and will be restored upon refresh.
-`XCharts` provides a full range of parameter configuration from the global` Theme `, series` Serie `, and single data item `SerieData`. The priority in descending order is: `SerieData` -> `Serie` -> `Theme`. Take the color of `ItemStyle` for example:
+To quickly locate the component corresponding to the effect you want to change, you need to have a certain understanding of the components. For example, we want to display an arrow at the end of the X-axis line. How to locate it? The first step, the X-axis is located at `XAxis0`; the second step, the axis line is located at `AxisLine`; finally, check if there is such a parameter under the `AxisLine` component to achieve this effect. If you are not sure about the parameters, you can refer to the [XCharts Configuration Manual](configuration.md).
-1. If the `ItemStyle` of `SerieData` has a color value other than `0000`, this color value is preferred.
-2. If the ItemStyle of `Serie` is configured with a color value other than `0000`, this color value takes precedence.
-3. Otherwise, the Color value is taken from the Color Palette of the Theme.
+`XCharts` provides comprehensive parameter configuration from the global `Theme`, series `Serie`, and individual data items `SerieData`. The priority order from high to low is: `SerieData`->`Serie`->`Theme`. Take the color of `ItemStyle` as
+ an example:
-Usually, `0000` indicates the theme default color, and 0 or null indicates the theme default.
+1. If the `ItemStyle` of `SerieData` has a color value other than `0000`, this color value is used first.
+2. If the `ItemStyle` of `Serie` has a color value other than `0000`, this color value is used.
+3. Otherwise, the color value is taken from the `Color Palette` of the theme `Theme`.
-## Add line charts with code
+>Note: The color value is usually `0000` when using the default color of the theme; other parameters are `0` or null when using the default configuration of the theme; pay attention to transparency when setting colors.
-Attach the `LineChart` script to the gameObject:
+### Adding a Line Chart with Code
+
+Attach the `LineChart` script to `gameObject`:
```csharp
var chart = gameObject.GetComponent();
@@ -108,10 +148,10 @@ if (chart == null)
}
```
-Resize:
+Adjust the size:
```csharp
-chart.SetSize(580, 300);//代码动态设置尺寸,或直接操作chart.rectTransform,或直接在Inspector上改
+chart.SetSize(580, 300);//Dynamically set the size with code, or directly operate chart.rectTransform, or directly change it in the Inspector
```
Set the title:
@@ -121,7 +161,7 @@ var title = chart.EnsureChartComponent();
title.text = "Simple Line";
```
-Set whether prompt boxes and legends are displayed:
+Set whether to display the tooltip and legend:
```csharp
var tooltip = chart.EnsureChartComponent();
@@ -131,7 +171,7 @@ var legend = chart.EnsureChartComponent