diff --git a/Documentation~/en/api.md b/Documentation~/en/api.md index cb306f17..0aba6982 100644 --- a/Documentation~/en/api.md +++ b/Documentation~/en/api.md @@ -35,8 +35,15 @@ slug: /api - [GridCoordContext](#gridcoordcontext) - [HeatmapChart](#heatmapchart) - [IgnoreDoc](#ignoredoc) +- [INeedSerieContainer](#ineedseriecontainer) - [InputHelper](#inputhelper) - [InteractData](#interactdata) +- [IPropertyChanged](#ipropertychanged) +- [ISerieComponent](#iseriecomponent) +- [ISerieContainer](#iseriecontainer) +- [ISerieDataComponent](#iseriedatacomponent) +- [ISimplifiedSerie](#isimplifiedserie) +- [IUpdateRuntimeData](#iupdateruntimedata) - [LayerHelper](#layerhelper) - [LegendContext](#legendcontext) - [LegendHelper](#legendhelper) @@ -63,6 +70,7 @@ slug: /api - [RingChart](#ringchart) - [RuntimeUtil](#runtimeutil) - [ScatterChart](#scatterchart) +- [ScriptableObject](#scriptableobject) - [SerieComponentAttribute](#seriecomponentattribute) - [SerieContext](#seriecontext) - [SerieConvertAttribute](#serieconvertattribute) @@ -106,6 +114,8 @@ slug: /api ## AnimationStyleHelper +Fullname: XCharts.Runtime.AnimationStyleHelper + |public method|since|description| |--|--|--| |CheckDataAnimation()||public static float CheckDataAnimation(BaseChart chart, Serie serie, int dataIndex, float destProgress, float startPorgress = 0)| @@ -115,14 +125,18 @@ slug: /api ## AxisContext +Fullname: XCharts.Runtime.AxisContext Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## AxisHandler<T> +Fullname: XCharts.AxisHandler Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) ## AxisHelper +Fullname: XCharts.Runtime.AxisHelper + |public method|since|description| |--|--|--| |AdjustCircleLabelPos()||public static void AdjustCircleLabelPos(ChartLabel txt, Vector3 pos, Vector3 cenPos, float txtHig, Vector3 offset)| @@ -149,11 +163,14 @@ Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) ## BarChart +Fullname: XCharts.Runtime.BarChart Inherits or Implemented: [BaseChart](#basechart) ## BaseChart -Inherits or Implemented: [BaseGraph](#basegraph),[ISerializationCallbackReceiver](#iserializationcallbackreceiver) +Fullname: XCharts.Runtime.BaseChart +Inherits or Implemented: [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) |public method|since|description| |--|--|--| @@ -344,7 +361,9 @@ Inherits or Implemented: [BaseGraph](#basegraph),[ISerializationCallbackReceiver ## BaseGraph -Inherits or Implemented: [MaskableGraphic](#maskablegraphic),[IPointerDownHandler](#ipointerdownhandler),[IPointerUpHandler](#ipointeruphandler),[](#) +Fullname: XCharts.Runtime.BaseGraph +Inherits or Implemented: [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) |public method|since|description| |--|--|--| @@ -379,10 +398,13 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic),[IPointerDownHandle ## CandlestickChart +Fullname: XCharts.Runtime.CandlestickChart Inherits or Implemented: [BaseChart](#basechart) ## ChartCached +Fullname: XCharts.Runtime.ChartCached + |public method|since|description| |--|--|--| |ColorToDotStr()||public static string ColorToDotStr(Color color)| @@ -394,10 +416,16 @@ Inherits or Implemented: [BaseChart](#basechart) ## ChartConst +Fullname: XCharts.Runtime.ChartConst + ## ChartDrawer +Fullname: XCharts.Runtime.ChartDrawer + ## ChartHelper +Fullname: XCharts.Runtime.ChartHelper + |public method|since|description| |--|--|--| |ActiveAllObject()||public static void ActiveAllObject(Transform parent, bool active, string match = null)| @@ -465,7 +493,8 @@ Inherits or Implemented: [BaseChart](#basechart) ## ChartLabel -Inherits or Implemented: [Image](#image) +Fullname: XCharts.Runtime.ChartLabel +Inherits or Implemented: [Image](https://docs.unity3d.com/ScriptReference/30_search.html?q=Image) |public method|since|description| |--|--|--| @@ -494,12 +523,16 @@ Inherits or Implemented: [Image](#image) ## ChartObject +Fullname: XCharts.Runtime.ChartObject + |public method|since|description| |--|--|--| |Destroy()||public virtual void Destroy()| ## CheckHelper +Fullname: XCharts.Runtime.CheckHelper + |public method|since|description| |--|--|--| |CheckChart()||public static string CheckChart(BaseChart chart)| @@ -507,13 +540,16 @@ Inherits or Implemented: [Image](#image) ## ColorUtil +Fullname: XCharts.Runtime.ColorUtil + |public method|since|description| |--|--|--| |GetColor()||public static Color32 GetColor(string hexColorStr)
Convert the html string to color. | ## ComponentHandlerAttribute -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.ComponentHandlerAttribute +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -522,6 +558,8 @@ Inherits or Implemented: [Attribute](#attribute) ## ComponentHelper +Fullname: XCharts.Runtime.ComponentHelper + |public method|since|description| |--|--|--| |GetAngleAxis()||public static AngleAxis GetAngleAxis(List<MainComponent> components, int polarIndex)| @@ -532,7 +570,8 @@ Inherits or Implemented: [Attribute](#attribute) ## CoordOptionsAttribute -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.CoordOptionsAttribute +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -544,10 +583,13 @@ Inherits or Implemented: [Attribute](#attribute) ## DataZoomContext +Fullname: XCharts.Runtime.DataZoomContext Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## DataZoomHelper +Fullname: XCharts.Runtime.DataZoomHelper + |public method|since|description| |--|--|--| |UpdateDataZoomRuntimeStartEndValue()||public static void UpdateDataZoomRuntimeStartEndValue(DataZoom dataZoom, Serie serie)| @@ -555,6 +597,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## DateTimeUtil +Fullname: XCharts.Runtime.DateTimeUtil + |public method|since|description| |--|--|--| |GetDateTime()||public static DateTime GetDateTime(int timestamp)| @@ -563,7 +607,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## DefaultAnimationAttribute -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.DefaultAnimationAttribute +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -571,6 +616,8 @@ Inherits or Implemented: [Attribute](#attribute) ## DefineSymbolsUtil +Fullname: XCharts.Runtime.DefineSymbolsUtil + |public method|since|description| |--|--|--| |AddGlobalDefine()||public static void AddGlobalDefine(string symbol)| @@ -578,6 +625,8 @@ Inherits or Implemented: [Attribute](#attribute) ## FormatterHelper +Fullname: XCharts.Runtime.FormatterHelper + |public method|since|description| |--|--|--| |NeedFormat()||public static bool NeedFormat(string content)| @@ -588,22 +637,32 @@ Inherits or Implemented: [Attribute](#attribute) ## GridCoordContext +Fullname: XCharts.Runtime.GridCoordContext Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## HeatmapChart +Fullname: XCharts.Runtime.HeatmapChart Inherits or Implemented: [BaseChart](#basechart) ## IgnoreDoc -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.IgnoreDoc +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| |IgnoreDoc()||public IgnoreDoc()| +## INeedSerieContainer + +Fullname: XCharts.Runtime.INeedSerieContainer +Subclasses: [Bar](#bar),[SimplifiedBar](#simplifiedbar),[Candlestick](#candlestick),[SimplifiedCandlestick](#simplifiedcandlestick),[Heatmap](#heatmap),[Line](#line),[SimplifiedLine](#simplifiedline),[Parallel](#parallel),[Radar](#radar),[BaseScatter](#basescatter) + ## InputHelper +Fullname: XCharts.Runtime.InputHelper + |public method|since|description| |--|--|--| |GetKeyDown()||public static bool GetKeyDown(KeyCode keyCode)| @@ -611,6 +670,8 @@ Inherits or Implemented: [Attribute](#attribute) ## InteractData +Fullname: XCharts.Runtime.InteractData + |public method|since|description| |--|--|--| |Reset()||public void Reset()| @@ -625,8 +686,40 @@ Inherits or Implemented: [Attribute](#attribute) |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)| +## IPropertyChanged + +Fullname: XCharts.Runtime.IPropertyChanged +Subclasses: [Location](#location),[Comment](#comment),[Legend](#legend),[Title](#title) + +## ISerieComponent + +Fullname: XCharts.Runtime.ISerieComponent +Subclasses: [AreaStyle](#areastyle),[ImageStyle](#imagestyle),[LineArrow](#linearrow),[LabelLine](#labelline),[LabelStyle](#labelstyle),[BlurStyle](#blurstyle),[EmphasisStyle](#emphasisstyle),[SelectStyle](#selectstyle),[TitleStyle](#titlestyle) + +## ISerieContainer + +Fullname: XCharts.Runtime.ISerieContainer +Subclasses: [RadarCoord](#radarcoord),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[ParallelCoord](#parallelcoord),[PolarCoord](#polarcoord) + +## ISerieDataComponent + +Fullname: XCharts.Runtime.ISerieDataComponent +Subclasses: [AreaStyle](#areastyle),[ImageStyle](#imagestyle),[ItemStyle](#itemstyle),[LineStyle](#linestyle),[SerieSymbol](#seriesymbol),[LabelLine](#labelline),[LabelStyle](#labelstyle),[BlurStyle](#blurstyle),[EmphasisStyle](#emphasisstyle),[SelectStyle](#selectstyle),[TitleStyle](#titlestyle) + +## ISimplifiedSerie + +Fullname: XCharts.Runtime.ISimplifiedSerie +Subclasses: [SimplifiedBar](#simplifiedbar),[SimplifiedCandlestick](#simplifiedcandlestick),[SimplifiedLine](#simplifiedline) + +## IUpdateRuntimeData + +Fullname: XCharts.Runtime.IUpdateRuntimeData +Subclasses: [SingleAxis](#singleaxis),[DataZoom](#datazoom),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[ParallelCoord](#parallelcoord) + ## LayerHelper +Fullname: XCharts.Runtime.LayerHelper + |public method|since|description| |--|--|--| |IsFixedWidthHeight()||public static bool IsFixedWidthHeight(RectTransform rt)| @@ -634,10 +727,13 @@ Inherits or Implemented: [Attribute](#attribute) ## LegendContext +Fullname: XCharts.Runtime.LegendContext Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## LegendHelper +Fullname: XCharts.Runtime.LegendHelper + |public method|since|description| |--|--|--| |CheckDataHighlighted()||public static bool CheckDataHighlighted(Serie serie, string legendName, bool heighlight)| @@ -649,6 +745,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## LegendItem +Fullname: XCharts.Runtime.LegendItem + |public method|since|description| |--|--|--| |GetIconColor()||public Color GetIconColor()| @@ -672,11 +770,14 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## LineChart +Fullname: XCharts.Runtime.LineChart Inherits or Implemented: [BaseChart](#basechart) ## ListFor -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.ListFor +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) +Subclasses: [ListForComponent](#listforcomponent),[ListForSerie](#listforserie) |public method|since|description| |--|--|--| @@ -684,6 +785,7 @@ Inherits or Implemented: [Attribute](#attribute) ## ListForComponent +Fullname: XCharts.Runtime.ListForComponent Inherits or Implemented: [ListFor](#listfor) |public method|since|description| @@ -692,6 +794,7 @@ Inherits or Implemented: [ListFor](#listfor) ## ListForSerie +Fullname: XCharts.Runtime.ListForSerie Inherits or Implemented: [ListFor](#listfor) |public method|since|description| @@ -700,8 +803,14 @@ Inherits or Implemented: [ListFor](#listfor) ## MainComponentContext +Fullname: XCharts.Runtime.MainComponentContext +Subclasses: [AxisContext](#axiscontext),[DataZoomContext](#datazoomcontext),[LegendContext](#legendcontext),[RadarCoordContext](#radarcoordcontext),[VisualMapContext](#visualmapcontext),[GridCoordContext](#gridcoordcontext),[ParallelCoordContext](#parallelcoordcontext),[PolarCoordContext](#polarcoordcontext) + ## MainComponentHandler +Fullname: XCharts.Runtime.MainComponentHandler +Subclasses: [AxisHandler](#axishandlert),[MainComponentHandler](#maincomponenthandlert) + |public method|since|description| |--|--|--| |CheckComponent()||public virtual void CheckComponent(StringBuilder sb) { }| @@ -724,10 +833,13 @@ Inherits or Implemented: [ListFor](#listfor) ## MainComponentHandler<T> +Fullname: XCharts.Runtime.MainComponentHandler Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) ## MathUtil +Fullname: XCharts.Runtime.MathUtil + |public method|since|description| |--|--|--| |Abs()||public static double Abs(double d)| @@ -740,6 +852,7 @@ Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) ## ObjectPool<T> where T +Fullname: XCharts.Runtime.ObjectPool where T Inherits or Implemented: [new()](#new()) |public method|since|description| @@ -752,7 +865,8 @@ Inherits or Implemented: [new()](#new()) ## Painter -Inherits or Implemented: [MaskableGraphic](#maskablegraphic) +Fullname: XCharts.Runtime.Painter +Inherits or Implemented: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=MaskableGraphic) |public method|since|description| |--|--|--| @@ -764,26 +878,33 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## ParallelChart +Fullname: XCharts.Runtime.ParallelChart Inherits or Implemented: [BaseChart](#basechart) ## ParallelCoordContext +Fullname: XCharts.Runtime.ParallelCoordContext Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## PieChart +Fullname: XCharts.Runtime.PieChart Inherits or Implemented: [BaseChart](#basechart) ## PolarChart +Fullname: XCharts.Runtime.PolarChart Inherits or Implemented: [BaseChart](#basechart) ## PolarCoordContext +Fullname: XCharts.Runtime.PolarCoordContext Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## PropertyUtil +Fullname: XCharts.Runtime.PropertyUtil + |public method|since|description| |--|--|--| |SetClass<T>()||public static bool SetClass<T>(ref T currentValue, T newValue, bool notNull = false) where T : class| @@ -793,14 +914,18 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## RadarChart +Fullname: XCharts.Runtime.RadarChart Inherits or Implemented: [BaseChart](#basechart) ## RadarCoordContext +Fullname: XCharts.Runtime.RadarCoordContext Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## ReflectionUtil +Fullname: XCharts.Runtime.ReflectionUtil + |public method|since|description| |--|--|--| |DeepCloneSerializeField()||public static object DeepCloneSerializeField(object obj)| @@ -812,7 +937,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## RequireChartComponentAttribute -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.RequireChartComponentAttribute +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -822,10 +948,13 @@ Inherits or Implemented: [Attribute](#attribute) ## RingChart +Fullname: XCharts.Runtime.RingChart Inherits or Implemented: [BaseChart](#basechart) ## RuntimeUtil +Fullname: XCharts.Runtime.RuntimeUtil + |public method|since|description| |--|--|--| |GetAllAssemblyTypes()||public static IEnumerable<Type> GetAllAssemblyTypes()| @@ -837,11 +966,18 @@ Inherits or Implemented: [BaseChart](#basechart) ## ScatterChart +Fullname: XCharts.Runtime.ScatterChart Inherits or Implemented: [BaseChart](#basechart) +## ScriptableObject + +Fullname: .ScriptableObject +Subclasses: [Lang](#lang),[XCSettings](#xcsettings),[Theme](#theme) + ## SerieComponentAttribute -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.SerieComponentAttribute +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -858,9 +994,12 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieContext +Fullname: XCharts.Runtime.SerieContext + ## SerieConvertAttribute -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.SerieConvertAttribute +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -873,7 +1012,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieDataComponentAttribute -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.SerieDataComponentAttribute +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -890,13 +1030,16 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieDataContext +Fullname: XCharts.Runtime.SerieDataContext + |public method|since|description| |--|--|--| |Reset()||public void Reset()| ## SerieDataExtraFieldAttribute -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.SerieDataExtraFieldAttribute +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -912,12 +1055,16 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieEventData +Fullname: XCharts.Runtime.SerieEventData + |public method|since|description| |--|--|--| |Reset()||public void Reset()| ## SerieEventDataPool +Fullname: XCharts.Runtime.SerieEventDataPool + |public method|since|description| |--|--|--| |Get()||public static SerieEventData Get(Vector3 pos, int serieIndex, int dataIndex, int dimension, double value)| @@ -925,6 +1072,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieHandler +Fullname: XCharts.Runtime.SerieHandler + |public method|since|description| |--|--|--| |CheckComponent()||public virtual void CheckComponent(StringBuilder sb) { }| @@ -951,8 +1100,14 @@ Inherits or Implemented: [Attribute](#attribute) |Update()||public virtual void Update() { }| |UpdateSerieContext()||public virtual void UpdateSerieContext() { }| +## SerieHandler where T + +Fullname: .SerieHandler where T +Subclasses: [SerieHandler](#seriehandlert) + ## SerieHandler<T> +Fullname: XCharts.Runtime.SerieHandler Inherits or Implemented: [SerieHandler where T](#seriehandler where t),[Serie](#serie) |public method|since|description| @@ -978,7 +1133,8 @@ Inherits or Implemented: [SerieHandler where T](#seriehandler where t),[Serie](# ## SerieHandlerAttribute -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.SerieHandlerAttribute +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -987,6 +1143,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieHelper +Fullname: XCharts.Runtime.SerieHelper + |public method|since|description| |--|--|--| |CloneSerie<T>()||public static T CloneSerie<T>(Serie serie) where T : Serie| @@ -1029,6 +1187,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieLabelHelper +Fullname: XCharts.Runtime.SerieLabelHelper + |public method|since|description| |--|--|--| |AvoidLabelOverlap()||public static void AvoidLabelOverlap(Serie serie, ComponentTheme theme)| @@ -1040,6 +1200,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieLabelPool +Fullname: XCharts.Runtime.SerieLabelPool + |public method|since|description| |--|--|--| |ClearAll()||public static void ClearAll()| @@ -1048,8 +1210,12 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieParams +Fullname: XCharts.Runtime.SerieParams + ## SeriesHelper +Fullname: XCharts.Runtime.SeriesHelper + |public method|since|description| |--|--|--| |GetLastStackSerie()||public static Serie GetLastStackSerie(List<Serie> series, Serie serie)
获得上一个同堆叠且显示的serie。 | @@ -1068,19 +1234,23 @@ Inherits or Implemented: [Attribute](#attribute) ## SimplifiedBarChart +Fullname: XCharts.Runtime.SimplifiedBarChart Inherits or Implemented: [BaseChart](#basechart) ## SimplifiedCandlestickChart +Fullname: XCharts.Runtime.SimplifiedCandlestickChart Inherits or Implemented: [BaseChart](#basechart) ## SimplifiedLineChart +Fullname: XCharts.Runtime.SimplifiedLineChart Inherits or Implemented: [BaseChart](#basechart) ## Since -Inherits or Implemented: [Attribute](#attribute) +Fullname: XCharts.Runtime.Since +Inherits or Implemented: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -1088,6 +1258,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SVG +Fullname: XUGL.SVG + |public method|since|description| |--|--|--| |DrawPath()||public static void DrawPath(VertexHelper vh, string path)| @@ -1096,10 +1268,13 @@ Inherits or Implemented: [Attribute](#attribute) ## SVGImage -Inherits or Implemented: [MaskableGraphic](#maskablegraphic) +Fullname: XCharts.Runtime.SVGImage +Inherits or Implemented: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=MaskableGraphic) ## SVGPath +Fullname: XUGL.SVGPath + |public method|since|description| |--|--|--| |AddSegment()||public void AddSegment(SVGPathSeg seg)| @@ -1108,16 +1283,24 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## SVGPathSeg +Fullname: XUGL.SVGPathSeg + |public method|since|description| |--|--|--| |SVGPathSeg()||public SVGPathSeg(SVGPathSegType type)| ## TooltipContext +Fullname: XCharts.Runtime.TooltipContext + ## TooltipData +Fullname: XCharts.Runtime.TooltipData + ## TooltipHelper +Fullname: XCharts.Runtime.TooltipHelper + |public method|since|description| |--|--|--| |GetItemNumericFormatter()||public static string GetItemNumericFormatter(Tooltip tooltip, Serie serie, SerieData serieData)| @@ -1127,6 +1310,8 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## TooltipView +Fullname: XCharts.Runtime.TooltipView + |public method|since|description| |--|--|--| |CreateView()||public static TooltipView CreateView(Tooltip tooltip, ThemeStyle theme, Transform parent)| @@ -1139,8 +1324,12 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## TooltipViewItem +Fullname: XCharts.Runtime.TooltipViewItem + ## UGL +Fullname: XUGL.UGL + |public method|since|description| |--|--|--| |DrawDiamond()||public static void DrawDiamond(VertexHelper vh, Vector3 center, float size, Color32 color)
Draw a diamond. 画菱形（钻石形状） | @@ -1162,10 +1351,13 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## UGLExample -Inherits or Implemented: [MaskableGraphic](#maskablegraphic) +Fullname: XUGL.UGLExample +Inherits or Implemented: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=MaskableGraphic) ## UGLHelper +Fullname: XUGL.UGLHelper + |public method|since|description| |--|--|--| |GetAngle360()||public static float GetAngle360(Vector2 from, Vector2 to)
获得0-360的角度（12点钟方向为0度） | @@ -1194,6 +1386,7 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## UIComponent +Fullname: XCharts.Runtime.UIComponent Inherits or Implemented: [BaseGraph](#basegraph) |public method|since|description| @@ -1202,16 +1395,21 @@ Inherits or Implemented: [BaseGraph](#basegraph) ## UIHelper +Fullname: XCharts.Runtime.UIHelper + |public method|since|description| |--|--|--| |GetBackgroundColor()||public static Color32 GetBackgroundColor(UIComponent component)| ## VisualMapContext +Fullname: XCharts.Runtime.VisualMapContext Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## VisualMapHelper +Fullname: XCharts.Runtime.VisualMapHelper + |public method|since|description| |--|--|--| |AutoSetLineMinMax()||public static void AutoSetLineMinMax(VisualMap visualMap, Serie serie, bool isY, Axis axis, Axis relativedAxis)| @@ -1223,6 +1421,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## XChartsMgr +Fullname: XCharts.Runtime.XChartsMgr + |public method|since|description| |--|--|--| |AddChart()||public static void AddChart(BaseChart chart)| @@ -1238,7 +1438,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## XCResourceImporterWindow -Inherits or Implemented: [UnityEditor.EditorWindow](#unityeditor.editorwindow) +Fullname: XCharts.Runtime.XCResourceImporterWindow +Inherits or Implemented: [UnityEditor.EditorWindow](https://docs.unity3d.com/ScriptReference/30_search.html?q=UnityEditor.EditorWindow) |public method|since|description| |--|--|--| @@ -1246,6 +1447,8 @@ Inherits or Implemented: [UnityEditor.EditorWindow](#unityeditor.editorwindow) ## XCThemeMgr +Fullname: XCharts.Runtime.XCThemeMgr + |public method|since|description| |--|--|--| |AddTheme()||public static void AddTheme(Theme theme)| diff --git a/Documentation~/en/configuration.md b/Documentation~/en/configuration.md index 13605c83..19ad1dc7 100644 --- a/Documentation~/en/configuration.md +++ b/Documentation~/en/configuration.md @@ -163,13 +163,20 @@ slug: /configuration - [TitleStyle](#titlestyle) -## Other Component +## Other - [BaseSerie](#baseserie) - [ChartText](#charttext) - [ChildComponent](#childcomponent) - [DebugInfo](#debuginfo) - [Indicator](#indicator) +- [INeedSerieContainer](#ineedseriecontainer) +- [IPropertyChanged](#ipropertychanged) +- [ISerieComponent](#iseriecomponent) +- [ISerieContainer](#iseriecontainer) +- [ISerieDataComponent](#iseriedatacomponent) +- [ISimplifiedSerie](#isimplifiedserie) +- [IUpdateRuntimeData](#iupdateruntimedata) - [Lang](#lang) - [LangCandlestick](#langcandlestick) - [LangTime](#langtime) @@ -180,25 +187,40 @@ slug: /configuration ## AngleAxis -Inherits or Implemented: [Axis](#axis) +> Fullname: XCharts.Runtime.AngleAxis +> Inherits: [Axis](#axis) Angle axis of Polar Coordinate. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |startAngle|0||Starting angle of axis. 0 degrees by default, standing for right position of center. +```mdx-code-block + +``` + ## AngleAxisTheme -Inherits or Implemented: [BaseAxisTheme](#baseaxistheme) +> Fullname: XCharts.Runtime.AngleAxisTheme +> Inherits: [BaseAxisTheme](#baseaxistheme) ## AnimationStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.AnimationStyle +> Inherits: [ChildComponent](#childcomponent) the animation of serie. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |enable|true||Whether to enable animation. @@ -214,12 +236,21 @@ the animation of serie. |actualDuration|||The milliseconds actual duration of the first animation. |unscaledTime||v3.4.0|Animation updates independently of Time.timeScale. +```mdx-code-block + +``` + ## AreaStyle -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> Fullname: XCharts.Runtime.AreaStyle +> Inherits: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) The style of area. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Set this to false to prevent the areafrom showing. @@ -230,9 +261,18 @@ The style of area. |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. +```mdx-code-block + +``` + ## ArrowStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.ArrowStyle +> Inherits: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -242,12 +282,22 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |dent|3||The dent of arrow. |color|Color.clear||the color of arrow. +```mdx-code-block + +``` + ## Axis -Inherits or Implemented: [MainComponent](#maincomponent) +> Fullname: XCharts.Runtime.Axis +> Inherits: [MainComponent](#maincomponent) +> Subclasses: [AngleAxis](#angleaxis), [ParallelAxis](#parallelaxis), [RadiusAxis](#radiusaxis), [SingleAxis](#singleaxis), [XAxis](#xaxis), [YAxis](#yaxis) The axis in rectangular coordinate. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether to show axis. @@ -282,12 +332,21 @@ The axis in rectangular coordinate. |minorSplitLine||v3.2.0|axis minor split line. [AxisMinorSplitLine](#axisminorsplitline)| |indicatorLabel||v3.4.0|Style of axis tooltip indicator label. [LabelStyle](#labelstyle)| +```mdx-code-block + +``` + ## AxisLabel -Inherits or Implemented: [LabelStyle](#labelstyle) +> Fullname: XCharts.Runtime.AxisLabel +> Inherits: [LabelStyle](#labelstyle) Settings related to axis label. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |interval|0||The display interval of the axis label. @@ -298,50 +357,86 @@ Settings related to axis label. |showEndLabel|true||Whether to display the last label. |textLimit|||文本限制。 [TextLimit](#textlimit)| +```mdx-code-block + +``` + ## AxisLine -Inherits or Implemented: [BaseLine](#baseline) +> Fullname: XCharts.Runtime.AxisLine +> Inherits: [BaseLine](#baseline) Settings related to axis line. +```mdx-code-block + +``` + |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)| +```mdx-code-block + +``` + ## AxisMinorSplitLine -Inherits or Implemented: [BaseLine](#baseline) +> Fullname: XCharts.Runtime.AxisMinorSplitLine +> Inherits: [BaseLine](#baseline) > Since `v3.2.0` Minor split line of axis in grid area. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |distance|||The distance between the split line and axis line. |autoColor|||auto color. +```mdx-code-block + +``` + ## AxisMinorTick -Inherits or Implemented: [BaseLine](#baseline) +> Fullname: XCharts.Runtime.AxisMinorTick +> Inherits: [BaseLine](#baseline) > Since `v3.2.0` Settings related to axis minor tick. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |splitNumber|5||Number of segments that the axis is split into. |autoColor||| +```mdx-code-block + +``` + ## AxisName -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.AxisName +> Inherits: [ChildComponent](#childcomponent) the name of axis. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|||Whether to show axis name. @@ -349,23 +444,41 @@ 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)| +```mdx-code-block + +``` + ## AxisSplitArea -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.AxisSplitArea +> Inherits: [ChildComponent](#childcomponent) Split area of axis in grid area, not shown by default. +```mdx-code-block + +``` + |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. +```mdx-code-block + +``` + ## AxisSplitLine -Inherits or Implemented: [BaseLine](#baseline) +> Fullname: XCharts.Runtime.AxisSplitLine +> Inherits: [BaseLine](#baseline) Split line of axis in grid area. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |interval|||Interval of Axis splitLine. @@ -374,17 +487,27 @@ Split line of axis in grid area. |showStartLine|true|v3.3.0|Whether to show the first split line. |showEndLine|true|v3.3.0|Whether to show the last split line. +```mdx-code-block + +``` + ## AxisTheme -Inherits or Implemented: [BaseAxisTheme](#baseaxistheme) +> Fullname: XCharts.Runtime.AxisTheme +> Inherits: [BaseAxisTheme](#baseaxistheme) ## AxisTick -Inherits or Implemented: [BaseLine](#baseline) +> Fullname: XCharts.Runtime.AxisTick +> Inherits: [BaseLine](#baseline) Settings related to axis tick. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |alignWithLabel|||Align axis tick with label, which is available only when boundaryGap is set to be true in category axis. @@ -395,12 +518,21 @@ Settings related to axis tick. |splitNumber|0||Number of segments that the axis is split into. |autoColor||| +```mdx-code-block + +``` + ## Background -Inherits or Implemented: [MainComponent](#maincomponent) +> Fullname: XCharts.Runtime.Background +> Inherits: [MainComponent](#maincomponent) Background component. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether to enable the background component. @@ -409,14 +541,25 @@ Background component. |imageColor|||背景图颜色。 |autoColor|true||Whether to use theme background color for component color when the background component is on. +```mdx-code-block + +``` + ## Bar -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> Fullname: XCharts.Runtime.Bar +> Inherits: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) ## BaseAxisTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> Fullname: XCharts.Runtime.BaseAxisTheme +> Inherits: [ComponentTheme](#componenttheme) +> Subclasses: [AxisTheme](#axistheme), [RadiusAxisTheme](#radiusaxistheme), [AngleAxisTheme](#angleaxistheme), [PolarAxisTheme](#polaraxistheme), [RadarAxisTheme](#radaraxistheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -434,28 +577,48 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |tickColor|||the color of tick. |splitAreaColors|||the colors of split area. +```mdx-code-block + +``` + ## BaseLine -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.BaseLine +> Inherits: [ChildComponent](#childcomponent) +> Subclasses: [AxisLine](#axisline), [AxisMinorSplitLine](#axisminorsplitline), [AxisMinorTick](#axisminortick), [AxisSplitLine](#axissplitline), [AxisTick](#axistick) Settings related to base line. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|||Set this to false to prevent the axis line from showing. |lineStyle|||线条样式 [LineStyle](#linestyle)| +```mdx-code-block + +``` + ## BaseScatter -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> Fullname: XCharts.Runtime.BaseScatter +> Inherits: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) +> Subclasses: [EffectScatter](#effectscatter), [Scatter](#scatter) ## BaseSerie +> Fullname: XCharts.Runtime.BaseSerie +> Subclasses: [Serie](#serie) + ## BlurStyle -Inherits or Implemented: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> Fullname: XCharts.Runtime.BlurStyle +> Inherits: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) > Since `v3.2.0` @@ -464,26 +627,37 @@ Configurations of blur state. ## CalendarCoord -Inherits or Implemented: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer) +> Fullname: XCharts.Runtime.CalendarCoord +> Inherits: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer) ## Candlestick -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> Fullname: XCharts.Runtime.Candlestick +> Inherits: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) ## ChartText +> Fullname: XCharts.Runtime.ChartText ## ChildComponent +> Fullname: XCharts.Runtime.ChildComponent +> Subclasses: [AnimationStyle](#animationstyle), [AxisName](#axisname), [AxisSplitArea](#axissplitarea), [AreaStyle](#areastyle), [ArrowStyle](#arrowstyle), [BaseLine](#baseline), [IconStyle](#iconstyle), [ImageStyle](#imagestyle), [ItemStyle](#itemstyle), [Level](#level), [LevelStyle](#levelstyle), [LineArrow](#linearrow), [LineStyle](#linestyle), [Location](#location), [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), [UIComponentTheme](#uicomponenttheme), [SerieData](#seriedata), [ComponentTheme](#componenttheme), [SerieTheme](#serietheme), [ThemeStyle](#themestyle) + ## Comment -Inherits or Implemented: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged) +> Fullname: XCharts.Runtime.Comment +> Inherits: [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged) comment of chart. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Set this to false to prevent the comment from showing. @@ -491,12 +665,21 @@ comment of chart. |markStyle|||The text style of all comments. [CommentMarkStyle](#commentmarkstyle)| |items|||The items of comment. +```mdx-code-block + +``` + ## CommentItem -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.CommentItem +> Inherits: [ChildComponent](#childcomponent) comment of chart. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Set this to false to prevent this comment item from showing. @@ -506,20 +689,39 @@ comment of chart. |labelStyle|||The text style of all comments. [LabelStyle](#labelstyle)| |location||v3.5.0|The location of comment. [Location](#location)| +```mdx-code-block + +``` + ## CommentMarkStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.CommentMarkStyle +> Inherits: [ChildComponent](#childcomponent) the comment mark style. +```mdx-code-block + +``` + |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)| +```mdx-code-block + +``` + ## ComponentTheme -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.ComponentTheme +> Inherits: [ChildComponent](#childcomponent) +> Subclasses: [BaseAxisTheme](#baseaxistheme), [DataZoomTheme](#datazoomtheme), [LegendTheme](#legendtheme), [SubTitleTheme](#subtitletheme), [TitleTheme](#titletheme), [TooltipTheme](#tooltiptheme), [VisualMapTheme](#visualmaptheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -529,19 +731,30 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |fontSize|18||the font size of text. |tMPFont|||the font of chart text。 +```mdx-code-block + +``` + ## CoordSystem -Inherits or Implemented: [MainComponent](#maincomponent) +> Fullname: XCharts.Runtime.CoordSystem +> Inherits: [MainComponent](#maincomponent) +> Subclasses: [RadarCoord](#radarcoord), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [ParallelCoord](#parallelcoord), [PolarCoord](#polarcoord), [SingleAxisCoord](#singleaxiscoord) Coordinate system component. ## DataZoom -Inherits or Implemented: [MainComponent](#maincomponent),[IUpdateRuntimeData](#iupdateruntimedata) +> Fullname: XCharts.Runtime.DataZoom +> Inherits: [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 + +``` + |field|default|since|comment| |--|--|--|--| |enable|true||Whether to show dataZoom. @@ -577,9 +790,18 @@ DataZoom component is used for zooming a specific area, which enables user to in |startLock||v3.6.0|Lock start value. |endLock||v3.6.0|Lock end value. +```mdx-code-block + +``` + ## DataZoomTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> Fullname: XCharts.Runtime.DataZoomTheme +> Inherits: [ComponentTheme](#componenttheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -591,8 +813,17 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |dataAreaColor|||the color of data area line. |backgroundColor|||the background color of datazoom. +```mdx-code-block + +``` + ## DebugInfo +> Fullname: XCharts.Runtime.DebugInfo +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether show debug component. @@ -601,36 +832,56 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |foldSeries|false||Whether to fold series in inspector view. |labelStyle||| [LabelStyle](#labelstyle)| +```mdx-code-block + +``` + ## EffectScatter -Inherits or Implemented: [BaseScatter](#basescatter) +> Fullname: XCharts.Runtime.EffectScatter +> Inherits: [BaseScatter](#basescatter) ## EmphasisStyle -Inherits or Implemented: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> Fullname: XCharts.Runtime.EmphasisStyle +> Inherits: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) > Since `v3.2.0` Configurations of emphasis state. +```mdx-code-block + +``` + |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.
| +```mdx-code-block + +``` + ## EndLabelStyle -Inherits or Implemented: [LabelStyle](#labelstyle) +> Fullname: XCharts.Runtime.EndLabelStyle +> Inherits: [LabelStyle](#labelstyle) ## GridCoord -Inherits or Implemented: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer) +> Fullname: XCharts.Runtime.GridCoord +> Inherits: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer) Grid component. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether to show the grid in rectangular coordinate. @@ -643,23 +894,41 @@ Grid component. |borderWidth|0f||Border width of grid. |borderColor|||The color of grid border. +```mdx-code-block + +``` + ## Heatmap -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> Fullname: XCharts.Runtime.Heatmap +> Inherits: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) + +```mdx-code-block + +``` |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.
| +```mdx-code-block + +``` + ## IconStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.IconStyle +> Inherits: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |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`: 对齐方式
- `Left`: 对齐方式
- `Right`: 对齐方式
| +|align|||水平方向对齐方式。
`Align`:
- `Center`: Alignment mode.
- `Left`: Alignment mode.
- `Right`: Alignment mode.
| |sprite|||The image of icon. |type|||How to display the icon. |color|||图标颜色。 @@ -668,9 +937,18 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |offset|||图标偏移。 |autoHideWhenLabelEmpty|false||当label内容为空时是否自动隐藏图标 +```mdx-code-block + +``` + ## ImageStyle -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> Fullname: XCharts.Runtime.ImageStyle +> Inherits: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -682,10 +960,19 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#is |width|0||图标宽。 |height|0||图标高。 +```mdx-code-block + +``` + ## Indicator +> Fullname: XCharts.Runtime.Indicator Indicator of radar chart, which is used to assign multiple variables(dimensions) in radar chart. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |name|||The name of indicator. @@ -712,12 +999,63 @@ Indicator of radar chart, which is used to assign multiple variables(dimensions) |startAngle||v3.4.0|起始角度。和时钟一样，12点钟位置是0度，顺时针到360度。 |indicatorList|||the indicator list. +```mdx-code-block + +``` + +## INeedSerieContainer + +> Fullname: XCharts.Runtime.INeedSerieContainer +> Subclasses: [Bar](#bar), [SimplifiedBar](#simplifiedbar), [Candlestick](#candlestick), [SimplifiedCandlestick](#simplifiedcandlestick), [Heatmap](#heatmap), [Line](#line), [SimplifiedLine](#simplifiedline), [Parallel](#parallel), [Radar](#radar), [BaseScatter](#basescatter) + + +## IPropertyChanged + +> Fullname: XCharts.Runtime.IPropertyChanged +> Subclasses: [Location](#location), [Comment](#comment), [Legend](#legend), [Title](#title) + +属性变更接口 + + +## ISerieComponent + +> Fullname: XCharts.Runtime.ISerieComponent +> 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 + +> Fullname: XCharts.Runtime.ISerieContainer +> Subclasses: [RadarCoord](#radarcoord), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [ParallelCoord](#parallelcoord), [PolarCoord](#polarcoord) + + +## ISerieDataComponent + +> Fullname: XCharts.Runtime.ISerieDataComponent +> 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 + +> Fullname: XCharts.Runtime.ISimplifiedSerie +> Subclasses: [SimplifiedBar](#simplifiedbar), [SimplifiedCandlestick](#simplifiedcandlestick), [SimplifiedLine](#simplifiedline) + + ## ItemStyle -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieDataComponent](#iseriedatacomponent) +> Fullname: XCharts.Runtime.ItemStyle +> Inherits: [ChildComponent](#childcomponent), [ISerieDataComponent](#iseriedatacomponent) 图形样式。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否启用。 @@ -741,17 +1079,32 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieDataComponent] |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 + +``` + +## IUpdateRuntimeData + +> Fullname: XCharts.Runtime.IUpdateRuntimeData +> Subclasses: [SingleAxis](#singleaxis), [DataZoom](#datazoom), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [ParallelCoord](#parallelcoord) + + ## LabelLine -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> Fullname: XCharts.Runtime.LabelLine +> Inherits: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) 标签的引导线 +```mdx-code-block + +``` + |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|ChartConst.clearColor32||the color of visual guild line. +|lineColor|Color32(0,0,0,0)||the color of visual guild line. |lineAngle|0||the angle of visual guild line. |lineWidth|1.0f||the width of visual guild line. |lineGap|1.0f||the gap of container and guild line. @@ -760,12 +1113,22 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#is |startSymbol|||The symbol of the start point of labelline. [SymbolStyle](#symbolstyle)| |endSymbol|||The symbol of the end point of labelline. [SymbolStyle](#symbolstyle)| +```mdx-code-block + +``` + ## LabelStyle -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> Fullname: XCharts.Runtime.LabelStyle +> Inherits: [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 + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether the label is showed. @@ -784,25 +1147,37 @@ Text label of chart, to explain some data information about graphic item like va |textPadding|||the text padding of label. [TextPadding](#textpadding)| |textStyle|||the sytle of text. [TextStyle](#textstyle)| +```mdx-code-block + +``` + ## Lang -Inherits or Implemented: [ScriptableObject](#scriptableobject) +> Fullname: XCharts.Runtime.Lang +> Inherits: [ScriptableObject](#scriptableobject) Language. ## LangCandlestick +> Fullname: XCharts.Runtime.LangCandlestick ## LangTime +> Fullname: XCharts.Runtime.LangTime ## Legend -Inherits or Implemented: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged) +> Fullname: XCharts.Runtime.Legend +> Inherits: [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 + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether to show legend component. @@ -825,17 +1200,35 @@ Legend component.The legend component shows different sets of tags, colors, and |padding||v3.1.0|the paddinng of item and background. [Padding](#padding)| |positions||v3.6.0|the custom positions of legend item. +```mdx-code-block + +``` + ## LegendTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> Fullname: XCharts.Runtime.LegendTheme +> Inherits: [ComponentTheme](#componenttheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| |unableColor|||the color of text. +```mdx-code-block + +``` + ## Level -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.Level +> Inherits: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -843,23 +1236,42 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |upperLabel|||上方的文本标签样式。 [LabelStyle](#labelstyle)| |itemStyle|||数据项样式。 [ItemStyle](#itemstyle)| +```mdx-code-block + +``` + ## LevelStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.LevelStyle +> Inherits: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| |show|false||是否启用LevelStyle |levels|||各层节点对应的配置。当enableLevels为true时生效，levels[0]对应的第一层的配置，levels[1]对应第二层，依次类推。当levels中没有对应层时用默认的设置。 +```mdx-code-block + +``` + ## Line -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> Fullname: XCharts.Runtime.Line +> Inherits: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) ## LineArrow -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent) +> Fullname: XCharts.Runtime.LineArrow +> Inherits: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -867,12 +1279,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#is |position|||The position of arrow.
`LineArrow.Position`:
- `End`: 末端箭头
- `Start`: 头端箭头
| |arrow|||the arrow of line. [ArrowStyle](#arrowstyle)| +```mdx-code-block + +``` + ## LineStyle -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieDataComponent](#iseriedatacomponent) +> Fullname: XCharts.Runtime.LineStyle +> Inherits: [ChildComponent](#childcomponent), [ISerieDataComponent](#iseriedatacomponent) The style of line. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether show line. @@ -884,12 +1305,21 @@ The style 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. +```mdx-code-block + +``` + ## Location -Inherits or Implemented: [ChildComponent](#childcomponent),[IPropertyChanged](#ipropertychanged) +> Fullname: XCharts.Runtime.Location +> Inherits: [ChildComponent](#childcomponent), [IPropertyChanged](#ipropertychanged) Location type. Quick to set the general location. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |align|||对齐方式。
`Location.Align`:
- `TopLeft`: 对齐方式
- `TopRight`: 对齐方式
- `TopCenter`: 对齐方式
- `BottomLeft`: 对齐方式
- `BottomRight`: 对齐方式
- `BottomCenter`: 对齐方式
- `Center`: 对齐方式
- `CenterLeft`: 对齐方式
- `CenterRight`: 对齐方式
| @@ -898,17 +1328,28 @@ Location type. Quick to set the general location. |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 + +``` + ## MainComponent -Inherits or Implemented: [IComparable](#icomparable) +> Fullname: XCharts.Runtime.MainComponent +> Inherits: [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), [CoordSystem](#coordsystem) ## MarkArea -Inherits or Implemented: [MainComponent](#maincomponent) +> Fullname: XCharts.Runtime.MarkArea +> Inherits: [MainComponent](#maincomponent) Used to mark an area in chart. For example, mark a time interval. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示标域。 @@ -919,12 +1360,21 @@ Used to mark an area in chart. For example, mark a time interval. |itemStyle|||标域样式。 [ItemStyle](#itemstyle)| |label|||标域文本样式。 [LabelStyle](#labelstyle)| +```mdx-code-block + +``` + ## MarkAreaData -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.MarkAreaData +> Inherits: [ChildComponent](#childcomponent) 标域的数据。 +```mdx-code-block + +``` + |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`: 中位数。
| @@ -935,12 +1385,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |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. +```mdx-code-block + +``` + ## MarkLine -Inherits or Implemented: [MainComponent](#maincomponent) +> Fullname: XCharts.Runtime.MarkLine +> Inherits: [MainComponent](#maincomponent) Use a line in the chart to illustrate. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether to display the marking line. @@ -948,12 +1407,21 @@ Use a line in the chart to illustrate. |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. +```mdx-code-block + +``` + ## MarkLineData -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.MarkLineData +> Inherits: [ChildComponent](#childcomponent) Data of marking line. +```mdx-code-block + +``` + |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`: 中位数。
| @@ -970,14 +1438,23 @@ Data of marking line. |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)| +```mdx-code-block + +``` + ## MarqueeStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.MarqueeStyle +> Inherits: [ChildComponent](#childcomponent) > Since `v3.5.0` Marquee style. It can be used for the DataZoom component. 选取框样式。可用于DataZoom组件。 +```mdx-code-block + +``` + |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. @@ -985,12 +1462,22 @@ Marquee style. It can be used for the DataZoom component. 选取框样式。可 |areaStyle||v3.5.0|The area style of marquee. [AreaStyle](#areastyle)| |lineStyle||v3.5.0|The line style of marquee border. [LineStyle](#linestyle)| +```mdx-code-block + +``` + ## Padding -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.Padding +> Inherits: [ChildComponent](#childcomponent) +> Subclasses: [TextPadding](#textpadding) padding setting of item or text. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||show padding. 是否显示。 @@ -999,22 +1486,33 @@ padding setting of item or text. |left|2f||padding of left. |bottom|0||padding of bottom. +```mdx-code-block + +``` + ## Parallel -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> Fullname: XCharts.Runtime.Parallel +> Inherits: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) ## ParallelAxis -Inherits or Implemented: [Axis](#axis) +> Fullname: XCharts.Runtime.ParallelAxis +> Inherits: [Axis](#axis) ## ParallelCoord -Inherits or Implemented: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer) +> Fullname: XCharts.Runtime.ParallelCoord +> Inherits: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer) Grid component. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether to show the grid in rectangular coordinate. @@ -1025,22 +1523,33 @@ Grid component. |bottom|0.12f||Distance between grid component and the bottom side of the container. |backgroundColor|||Background color of grid, which is transparent by default. +```mdx-code-block + +``` + ## Pie -Inherits or Implemented: [Serie](#serie) +> Fullname: XCharts.Runtime.Pie +> Inherits: [Serie](#serie) ## PolarAxisTheme -Inherits or Implemented: [BaseAxisTheme](#baseaxistheme) +> Fullname: XCharts.Runtime.PolarAxisTheme +> Inherits: [BaseAxisTheme](#baseaxistheme) ## PolarCoord -Inherits or Implemented: [CoordSystem](#coordsystem),[ISerieContainer](#iseriecontainer) +> Fullname: XCharts.Runtime.PolarCoord +> Inherits: [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 + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether to show the polor component. @@ -1048,51 +1557,71 @@ Polar coordinate can be used in scatter and line chart. Every polar coordinate h |radius|||the radius of polar. |backgroundColor|||Background color of polar, which is transparent by default. +```mdx-code-block + +``` + ## Radar -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> Fullname: XCharts.Runtime.Radar +> Inherits: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| |smooth|false|v3.2.0|Whether use smooth curve. +```mdx-code-block + +``` + ## RadarAxisTheme -Inherits or Implemented: [BaseAxisTheme](#baseaxistheme) +> Fullname: XCharts.Runtime.RadarAxisTheme +> Inherits: [BaseAxisTheme](#baseaxistheme) ## RadarCoord -Inherits or Implemented: [CoordSystem](#coordsystem),[ISerieContainer](#iseriecontainer) +> Fullname: XCharts.Runtime.RadarCoord +> Inherits: [CoordSystem](#coordsystem), [ISerieContainer](#iseriecontainer) Radar coordinate conponnet for radar charts. 雷达图坐标系组件，只适用于雷达图。 ## RadiusAxis -Inherits or Implemented: [Axis](#axis) +> Fullname: XCharts.Runtime.RadiusAxis +> Inherits: [Axis](#axis) Radial axis of polar coordinate. ## RadiusAxisTheme -Inherits or Implemented: [BaseAxisTheme](#baseaxistheme) +> Fullname: XCharts.Runtime.RadiusAxisTheme +> Inherits: [BaseAxisTheme](#baseaxistheme) ## Ring -Inherits or Implemented: [Serie](#serie) +> Fullname: XCharts.Runtime.Ring +> Inherits: [Serie](#serie) ## Scatter -Inherits or Implemented: [BaseScatter](#basescatter) +> Fullname: XCharts.Runtime.Scatter +> Inherits: [BaseScatter](#basescatter) ## SelectStyle -Inherits or Implemented: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> Fullname: XCharts.Runtime.SelectStyle +> Inherits: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) > Since `v3.2.0` @@ -1101,9 +1630,15 @@ Configurations of select state. ## Serie -Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable) +> Fullname: XCharts.Runtime.Serie +> Inherits: [BaseSerie](#baseserie), [IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=IComparable) +> Subclasses: [SerieHandler](#seriehandler), [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 + +``` |field|default|since|comment| |--|--|--|--| @@ -1113,7 +1648,7 @@ Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable) |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..
| +|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. @@ -1160,13 +1695,13 @@ Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable) |ignoreLineBreak|false||忽略数据时折线是断开还是连接。默认false为连接。 |showAsPositiveNumber|false||Show negative number as positive number. |large|true||是否开启大数据量优化，在数据图形特别多而出现卡顿时候可以开启。 开启后配合 largeThreshold 在数据量大于指定阈值的时候对绘制进行优化。 缺点：优化后不能自定义设置单个数据项的样式，不能显示Label。 -|largeThreshold|200||开启大数量优化的阈值。只有当开启了large并且数据量大于该阀值时才进入性能模式。 -|avoidLabelOverlap|false||在饼图且标签外部显示的情况下，是否启用防止标签重叠策略，默认关闭，在标签拥挤重叠的情况下会挪动各个标签的位置，防止标签间的重叠。 +|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`: 按 data 的顺序
- `Ascending`: 升序
- `Descending`: 降序
| +|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`: 对齐方式
- `Left`: 对齐方式
- `Right`: 对齐方式
| +|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. @@ -1178,12 +1713,21 @@ Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable) |itemStyle|||The style of data item. [ItemStyle](#itemstyle)| |data|||系列中的数据内容数组。SerieData可以设置1到n维数据。 +```mdx-code-block + +``` + ## SerieData -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.SerieData +> Inherits: [ChildComponent](#childcomponent) A data item of serie. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |index|||the index of SerieData. @@ -1196,12 +1740,21 @@ A data item of serie. |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. +```mdx-code-block + +``` + ## SerieSymbol -Inherits or Implemented: [SymbolStyle](#symbolstyle),[ISerieDataComponent](#iseriedatacomponent) +> Fullname: XCharts.Runtime.SerieSymbol +> Inherits: [SymbolStyle](#symbolstyle), [ISerieDataComponent](#iseriedatacomponent) 系列数据项的标记的图形 +```mdx-code-block + +``` + |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.
| @@ -1215,9 +1768,18 @@ Inherits or Implemented: [SymbolStyle](#symbolstyle),[ISerieDataComponent](#iser |minSize|0f|v3.3.0|Minimum symbol size. |maxSize|0f|v3.3.0|Maximum symbol size. +```mdx-code-block + +``` + ## SerieTheme -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.SerieTheme +> Inherits: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1233,12 +1795,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |candlestickBorderColor|Color32(235, 84, 84, 255)||K线图阳线（跌）边框色 |candlestickBorderColor0|Color32(71, 178, 98, 255)||K线图阴线（跌）边框色 +```mdx-code-block + +``` + ## Settings -Inherits or Implemented: [MainComponent](#maincomponent) +> Fullname: XCharts.Runtime.Settings +> Inherits: [MainComponent](#maincomponent) Global parameter setting component. The default value can be used in general, and can be adjusted when necessary. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true|| @@ -1256,27 +1827,39 @@ Global parameter setting component. The default value can be used in general, an |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. +```mdx-code-block + +``` + ## SimplifiedBar -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie) +> Fullname: XCharts.Runtime.SimplifiedBar +> Inherits: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie) ## SimplifiedCandlestick -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie) +> Fullname: XCharts.Runtime.SimplifiedCandlestick +> Inherits: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie) ## SimplifiedLine -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie) +> Fullname: XCharts.Runtime.SimplifiedLine +> Inherits: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie) ## SingleAxis -Inherits or Implemented: [Axis](#axis),[IUpdateRuntimeData](#iupdateruntimedata) +> Fullname: XCharts.Runtime.SingleAxis +> Inherits: [Axis](#axis), [IUpdateRuntimeData](#iupdateruntimedata) Single axis. +```mdx-code-block + +``` + |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`: 垂直
| @@ -1287,28 +1870,48 @@ Single axis. |width|0||width of axis. |height|50||height of axis. +```mdx-code-block + +``` + ## SingleAxisCoord -Inherits or Implemented: [CoordSystem](#coordsystem) +> Fullname: XCharts.Runtime.SingleAxisCoord +> Inherits: [CoordSystem](#coordsystem) ## StageColor -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.StageColor +> Inherits: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| |percent|||结束位置百分比。 |color|||颜色。 +```mdx-code-block + +``` + ## StateStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.StateStyle +> Inherits: [ChildComponent](#childcomponent) +> Subclasses: [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle) > Since `v3.2.0` the state style of serie. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否启用高亮样式。 @@ -1319,17 +1922,28 @@ the state style of serie. |areaStyle|||区域样式。 [AreaStyle](#areastyle)| |symbol|||标记样式。 [SerieSymbol](#seriesymbol)| +```mdx-code-block + +``` + ## SubTitleTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> Fullname: XCharts.Runtime.SubTitleTheme +> Inherits: [ComponentTheme](#componenttheme) ## SymbolStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.SymbolStyle +> Inherits: [ChildComponent](#childcomponent) +> Subclasses: [SerieSymbol](#seriesymbol) 系列数据项的标记的图形 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether the symbol is showed. @@ -1343,12 +1957,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |imageType|||the fill type of image. |color|||图形的颜色。 +```mdx-code-block + +``` + ## TextLimit -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.TextLimit +> Inherits: [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 + +``` + |field|default|since|comment| |--|--|--|--| |enable|false||Whether to enable text limit. @@ -1356,19 +1979,29 @@ Text character limitation and adaptation component. When the length of the text |gap|1||White pixel distance at both ends. |suffix|||Suffixes when the length exceeds. +```mdx-code-block + +``` + ## TextPadding -Inherits or Implemented: [Padding](#padding) +> Fullname: XCharts.Runtime.TextPadding +> Inherits: [Padding](#padding) Settings related to text. ## TextStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.TextStyle +> Inherits: [ChildComponent](#childcomponent) Settings related to text. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Settings related to text. @@ -1387,12 +2020,21 @@ Settings related to text. |tMPAlignment||| |tMPSpriteAsset||v3.1.0| +```mdx-code-block + +``` + ## Theme -Inherits or Implemented: [ScriptableObject](#scriptableobject) +> Fullname: XCharts.Runtime.Theme +> Inherits: [ScriptableObject](#scriptableobject) Theme. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |themeType|||the theme of chart.
`ThemeType`:
- `Default`: 默认主题。
- `Light`: 亮主题。
- `Dark`: 暗主题。
- `Custom`: 自定义主题。
| @@ -1412,12 +2054,21 @@ Theme. |visualMap||| [VisualMapTheme](#visualmaptheme)| |serie||| [SerieTheme](#serietheme)| +```mdx-code-block + +``` + ## ThemeStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.ThemeStyle +> Inherits: [ChildComponent](#childcomponent) Theme. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true|| @@ -1428,12 +2079,21 @@ Theme. |customBackgroundColor|||the custom background color of chart. |customColorPalette||| +```mdx-code-block + +``` + ## Title -Inherits or Implemented: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged) +> Fullname: XCharts.Runtime.Title +> Inherits: [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged) Title component, including main title and subtitle. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||[default:true] Set this to false to prevent the title from showing. @@ -1444,24 +2104,35 @@ Title component, including main title and subtitle. |itemGap|0||[default:8] The gap between the main title and subtitle. |location|||The location of title component. [Location](#location)| +```mdx-code-block + +``` + ## TitleStyle -Inherits or Implemented: [LabelStyle](#labelstyle),[ISerieDataComponent](#iseriedatacomponent),[ISerieComponent](#iseriecomponent) +> Fullname: XCharts.Runtime.TitleStyle +> Inherits: [LabelStyle](#labelstyle), [ISerieDataComponent](#iseriedatacomponent), [ISerieComponent](#iseriecomponent) the title of serie. ## TitleTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> Fullname: XCharts.Runtime.TitleTheme +> Inherits: [ComponentTheme](#componenttheme) ## Tooltip -Inherits or Implemented: [MainComponent](#maincomponent) +> Fullname: XCharts.Runtime.Tooltip +> Inherits: [MainComponent](#maincomponent) Tooltip component. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether to show the tooltip component. @@ -1496,9 +2167,18 @@ Tooltip component. |titleLabelStyle|||the textstyle of title. [LabelStyle](#labelstyle)| |contentLabelStyles|||the textstyle list of content. +```mdx-code-block + +``` + ## TooltipTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> Fullname: XCharts.Runtime.TooltipTheme +> Inherits: [ComponentTheme](#componenttheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1509,9 +2189,18 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |labelTextColor|||the text color of tooltip cross indicator's axis label. |labelBackgroundColor|||the background color of tooltip cross indicator's axis label. +```mdx-code-block + +``` + ## UIComponentTheme -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.UIComponentTheme +> Inherits: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1519,12 +2208,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |sharedTheme|||the asset of theme. [Theme](#theme)| |transparentBackground|false|| +```mdx-code-block + +``` + ## VisualMap -Inherits or Implemented: [MainComponent](#maincomponent) +> Fullname: XCharts.Runtime.VisualMap +> Inherits: [MainComponent](#maincomponent) VisualMap component. Mapping data to visual elements such as colors. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||Whether to enable components. @@ -1554,9 +2252,18 @@ VisualMap component. Mapping data to visual elements such as colors. |outOfRange|||Defines a visual color outside of the selected range. |inRange|||分段式每一段的相关配置。 +```mdx-code-block + +``` + ## VisualMapRange -Inherits or Implemented: [ChildComponent](#childcomponent) +> Fullname: XCharts.Runtime.VisualMapRange +> Inherits: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1565,9 +2272,18 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |label|||文字描述 |color|||颜色 +```mdx-code-block + +``` + ## VisualMapTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> Fullname: XCharts.Runtime.VisualMapTheme +> Inherits: [ComponentTheme](#componenttheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1576,19 +2292,30 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |backgroundColor|||the background color of visualmap. |triangeLen|20f||可视化组件的调节三角形边长。 +```mdx-code-block + +``` + ## XAxis -Inherits or Implemented: [Axis](#axis) +> Fullname: XCharts.Runtime.XAxis +> Inherits: [Axis](#axis) The x axis in cartesian(rectangular) coordinate. ## XCResourcesImporter +> Fullname: XCharts.Runtime.XCResourcesImporter ## XCSettings -Inherits or Implemented: [ScriptableObject](#scriptableobject) +> Fullname: XCharts.Runtime.XCSettings +> Inherits: [ScriptableObject](#scriptableobject) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1630,9 +2357,14 @@ Inherits or Implemented: [ScriptableObject](#scriptableobject) |pieSelectedOffset|8f|| |customThemes||| +```mdx-code-block + +``` + ## YAxis -Inherits or Implemented: [Axis](#axis) +> Fullname: XCharts.Runtime.YAxis +> Inherits: [Axis](#axis) The x axis in cartesian(rectangular) coordinate. diff --git a/Documentation~/zh/api.md b/Documentation~/zh/api.md index 5bdde57f..dfb0de94 100644 --- a/Documentation~/zh/api.md +++ b/Documentation~/zh/api.md @@ -35,8 +35,15 @@ slug: /api - [GridCoordContext](#gridcoordcontext) - [HeatmapChart](#heatmapchart) - [IgnoreDoc](#ignoredoc) +- [INeedSerieContainer](#ineedseriecontainer) - [InputHelper](#inputhelper) - [InteractData](#interactdata) +- [IPropertyChanged](#ipropertychanged) +- [ISerieComponent](#iseriecomponent) +- [ISerieContainer](#iseriecontainer) +- [ISerieDataComponent](#iseriedatacomponent) +- [ISimplifiedSerie](#isimplifiedserie) +- [IUpdateRuntimeData](#iupdateruntimedata) - [LayerHelper](#layerhelper) - [LegendContext](#legendcontext) - [LegendHelper](#legendhelper) @@ -63,6 +70,7 @@ slug: /api - [RingChart](#ringchart) - [RuntimeUtil](#runtimeutil) - [ScatterChart](#scatterchart) +- [ScriptableObject](#scriptableobject) - [SerieComponentAttribute](#seriecomponentattribute) - [SerieContext](#seriecontext) - [SerieConvertAttribute](#serieconvertattribute) @@ -106,6 +114,8 @@ slug: /api ## AnimationStyleHelper +全名: XCharts.Runtime.AnimationStyleHelper + |public method|since|description| |--|--|--| |CheckDataAnimation()||public static float CheckDataAnimation(BaseChart chart, Serie serie, int dataIndex, float destProgress, float startPorgress = 0)| @@ -115,14 +125,18 @@ slug: /api ## AxisContext -Inherits or Implemented: [MainComponentContext](#maincomponentcontext) +全名: XCharts.Runtime.AxisContext +继承: [MainComponentContext](#maincomponentcontext) ## AxisHandler<T> -Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) +全名: XCharts.AxisHandler +继承: [MainComponentHandler](#maincomponenthandler) ## AxisHelper +全名: XCharts.Runtime.AxisHelper + |public method|since|description| |--|--|--| |AdjustCircleLabelPos()||public static void AdjustCircleLabelPos(ChartLabel txt, Vector3 pos, Vector3 cenPos, float txtHig, Vector3 offset)| @@ -149,11 +163,14 @@ Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) ## BarChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.BarChart +继承: [BaseChart](#basechart) ## BaseChart -Inherits or Implemented: [BaseGraph](#basegraph),[ISerializationCallbackReceiver](#iserializationcallbackreceiver) +全名: XCharts.Runtime.BaseChart +继承: [BaseGraph](#basegraph),[ISerializationCallbackReceiver](https://docs.unity3d.com/ScriptReference/30_search.html?q=ISerializationCallbackReceiver) +子类: [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) |public method|since|description| |--|--|--| @@ -344,7 +361,9 @@ Inherits or Implemented: [BaseGraph](#basegraph),[ISerializationCallbackReceiver ## BaseGraph -Inherits or Implemented: [MaskableGraphic](#maskablegraphic),[IPointerDownHandler](#ipointerdownhandler),[IPointerUpHandler](#ipointeruphandler),[](#) +全名: XCharts.Runtime.BaseGraph +继承: [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),[](#) +子类: [BaseChart](#basechart),[UIComponent](#uicomponent) |public method|since|description| |--|--|--| @@ -379,10 +398,13 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic),[IPointerDownHandle ## CandlestickChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.CandlestickChart +继承: [BaseChart](#basechart) ## ChartCached +全名: XCharts.Runtime.ChartCached + |public method|since|description| |--|--|--| |ColorToDotStr()||public static string ColorToDotStr(Color color)| @@ -394,10 +416,16 @@ Inherits or Implemented: [BaseChart](#basechart) ## ChartConst +全名: XCharts.Runtime.ChartConst + ## ChartDrawer +全名: XCharts.Runtime.ChartDrawer + ## ChartHelper +全名: XCharts.Runtime.ChartHelper + |public method|since|description| |--|--|--| |ActiveAllObject()||public static void ActiveAllObject(Transform parent, bool active, string match = null)| @@ -465,7 +493,8 @@ Inherits or Implemented: [BaseChart](#basechart) ## ChartLabel -Inherits or Implemented: [Image](#image) +全名: XCharts.Runtime.ChartLabel +继承: [Image](https://docs.unity3d.com/ScriptReference/30_search.html?q=Image) |public method|since|description| |--|--|--| @@ -494,12 +523,16 @@ Inherits or Implemented: [Image](#image) ## ChartObject +全名: XCharts.Runtime.ChartObject + |public method|since|description| |--|--|--| |Destroy()||public virtual void Destroy()| ## CheckHelper +全名: XCharts.Runtime.CheckHelper + |public method|since|description| |--|--|--| |CheckChart()||public static string CheckChart(BaseChart chart)| @@ -507,13 +540,16 @@ Inherits or Implemented: [Image](#image) ## ColorUtil +全名: XCharts.Runtime.ColorUtil + |public method|since|description| |--|--|--| |GetColor()||public static Color32 GetColor(string hexColorStr)
将字符串颜色值转成Color。 | ## ComponentHandlerAttribute -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.ComponentHandlerAttribute +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -522,6 +558,8 @@ Inherits or Implemented: [Attribute](#attribute) ## ComponentHelper +全名: XCharts.Runtime.ComponentHelper + |public method|since|description| |--|--|--| |GetAngleAxis()||public static AngleAxis GetAngleAxis(List<MainComponent> components, int polarIndex)| @@ -532,7 +570,8 @@ Inherits or Implemented: [Attribute](#attribute) ## CoordOptionsAttribute -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.CoordOptionsAttribute +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -544,10 +583,13 @@ Inherits or Implemented: [Attribute](#attribute) ## DataZoomContext -Inherits or Implemented: [MainComponentContext](#maincomponentcontext) +全名: XCharts.Runtime.DataZoomContext +继承: [MainComponentContext](#maincomponentcontext) ## DataZoomHelper +全名: XCharts.Runtime.DataZoomHelper + |public method|since|description| |--|--|--| |UpdateDataZoomRuntimeStartEndValue()||public static void UpdateDataZoomRuntimeStartEndValue(DataZoom dataZoom, Serie serie)| @@ -555,6 +597,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## DateTimeUtil +全名: XCharts.Runtime.DateTimeUtil + |public method|since|description| |--|--|--| |GetDateTime()||public static DateTime GetDateTime(int timestamp)| @@ -563,7 +607,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## DefaultAnimationAttribute -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.DefaultAnimationAttribute +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -571,6 +616,8 @@ Inherits or Implemented: [Attribute](#attribute) ## DefineSymbolsUtil +全名: XCharts.Runtime.DefineSymbolsUtil + |public method|since|description| |--|--|--| |AddGlobalDefine()||public static void AddGlobalDefine(string symbol)| @@ -578,6 +625,8 @@ Inherits or Implemented: [Attribute](#attribute) ## FormatterHelper +全名: XCharts.Runtime.FormatterHelper + |public method|since|description| |--|--|--| |NeedFormat()||public static bool NeedFormat(string content)| @@ -588,22 +637,32 @@ Inherits or Implemented: [Attribute](#attribute) ## GridCoordContext -Inherits or Implemented: [MainComponentContext](#maincomponentcontext) +全名: XCharts.Runtime.GridCoordContext +继承: [MainComponentContext](#maincomponentcontext) ## HeatmapChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.HeatmapChart +继承: [BaseChart](#basechart) ## IgnoreDoc -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.IgnoreDoc +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| |IgnoreDoc()||public IgnoreDoc()| +## INeedSerieContainer + +全名: XCharts.Runtime.INeedSerieContainer +子类: [Bar](#bar),[SimplifiedBar](#simplifiedbar),[Candlestick](#candlestick),[SimplifiedCandlestick](#simplifiedcandlestick),[Heatmap](#heatmap),[Line](#line),[SimplifiedLine](#simplifiedline),[Parallel](#parallel),[Radar](#radar),[BaseScatter](#basescatter) + ## InputHelper +全名: XCharts.Runtime.InputHelper + |public method|since|description| |--|--|--| |GetKeyDown()||public static bool GetKeyDown(KeyCode keyCode)| @@ -611,6 +670,8 @@ Inherits or Implemented: [Attribute](#attribute) ## InteractData +全名: XCharts.Runtime.InteractData + |public method|since|description| |--|--|--| |Reset()||public void Reset()| @@ -625,8 +686,40 @@ Inherits or Implemented: [Attribute](#attribute) |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)| +## IPropertyChanged + +全名: XCharts.Runtime.IPropertyChanged +子类: [Location](#location),[Comment](#comment),[Legend](#legend),[Title](#title) + +## ISerieComponent + +全名: XCharts.Runtime.ISerieComponent +子类: [AreaStyle](#areastyle),[ImageStyle](#imagestyle),[LineArrow](#linearrow),[LabelLine](#labelline),[LabelStyle](#labelstyle),[BlurStyle](#blurstyle),[EmphasisStyle](#emphasisstyle),[SelectStyle](#selectstyle),[TitleStyle](#titlestyle) + +## ISerieContainer + +全名: XCharts.Runtime.ISerieContainer +子类: [RadarCoord](#radarcoord),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[ParallelCoord](#parallelcoord),[PolarCoord](#polarcoord) + +## ISerieDataComponent + +全名: XCharts.Runtime.ISerieDataComponent +子类: [AreaStyle](#areastyle),[ImageStyle](#imagestyle),[ItemStyle](#itemstyle),[LineStyle](#linestyle),[SerieSymbol](#seriesymbol),[LabelLine](#labelline),[LabelStyle](#labelstyle),[BlurStyle](#blurstyle),[EmphasisStyle](#emphasisstyle),[SelectStyle](#selectstyle),[TitleStyle](#titlestyle) + +## ISimplifiedSerie + +全名: XCharts.Runtime.ISimplifiedSerie +子类: [SimplifiedBar](#simplifiedbar),[SimplifiedCandlestick](#simplifiedcandlestick),[SimplifiedLine](#simplifiedline) + +## IUpdateRuntimeData + +全名: XCharts.Runtime.IUpdateRuntimeData +子类: [SingleAxis](#singleaxis),[DataZoom](#datazoom),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[ParallelCoord](#parallelcoord) + ## LayerHelper +全名: XCharts.Runtime.LayerHelper + |public method|since|description| |--|--|--| |IsFixedWidthHeight()||public static bool IsFixedWidthHeight(RectTransform rt)| @@ -634,10 +727,13 @@ Inherits or Implemented: [Attribute](#attribute) ## LegendContext -Inherits or Implemented: [MainComponentContext](#maincomponentcontext) +全名: XCharts.Runtime.LegendContext +继承: [MainComponentContext](#maincomponentcontext) ## LegendHelper +全名: XCharts.Runtime.LegendHelper + |public method|since|description| |--|--|--| |CheckDataHighlighted()||public static bool CheckDataHighlighted(Serie serie, string legendName, bool heighlight)| @@ -649,6 +745,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## LegendItem +全名: XCharts.Runtime.LegendItem + |public method|since|description| |--|--|--| |GetIconColor()||public Color GetIconColor()| @@ -672,11 +770,14 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## LineChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.LineChart +继承: [BaseChart](#basechart) ## ListFor -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.ListFor +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) +子类: [ListForComponent](#listforcomponent),[ListForSerie](#listforserie) |public method|since|description| |--|--|--| @@ -684,7 +785,8 @@ Inherits or Implemented: [Attribute](#attribute) ## ListForComponent -Inherits or Implemented: [ListFor](#listfor) +全名: XCharts.Runtime.ListForComponent +继承: [ListFor](#listfor) |public method|since|description| |--|--|--| @@ -692,7 +794,8 @@ Inherits or Implemented: [ListFor](#listfor) ## ListForSerie -Inherits or Implemented: [ListFor](#listfor) +全名: XCharts.Runtime.ListForSerie +继承: [ListFor](#listfor) |public method|since|description| |--|--|--| @@ -700,8 +803,14 @@ Inherits or Implemented: [ListFor](#listfor) ## MainComponentContext +全名: XCharts.Runtime.MainComponentContext +子类: [AxisContext](#axiscontext),[DataZoomContext](#datazoomcontext),[LegendContext](#legendcontext),[RadarCoordContext](#radarcoordcontext),[VisualMapContext](#visualmapcontext),[GridCoordContext](#gridcoordcontext),[ParallelCoordContext](#parallelcoordcontext),[PolarCoordContext](#polarcoordcontext) + ## MainComponentHandler +全名: XCharts.Runtime.MainComponentHandler +子类: [AxisHandler](#axishandlert),[MainComponentHandler](#maincomponenthandlert) + |public method|since|description| |--|--|--| |CheckComponent()||public virtual void CheckComponent(StringBuilder sb) { }| @@ -724,10 +833,13 @@ Inherits or Implemented: [ListFor](#listfor) ## MainComponentHandler<T> -Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) +全名: XCharts.Runtime.MainComponentHandler +继承: [MainComponentHandler](#maincomponenthandler) ## MathUtil +全名: XCharts.Runtime.MathUtil + |public method|since|description| |--|--|--| |Abs()||public static double Abs(double d)| @@ -740,7 +852,8 @@ Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) ## ObjectPool<T> where T -Inherits or Implemented: [new()](#new()) +全名: XCharts.Runtime.ObjectPool where T +继承: [new()](#new()) |public method|since|description| |--|--|--| @@ -752,7 +865,8 @@ Inherits or Implemented: [new()](#new()) ## Painter -Inherits or Implemented: [MaskableGraphic](#maskablegraphic) +全名: XCharts.Runtime.Painter +继承: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=MaskableGraphic) |public method|since|description| |--|--|--| @@ -764,26 +878,33 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## ParallelChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.ParallelChart +继承: [BaseChart](#basechart) ## ParallelCoordContext -Inherits or Implemented: [MainComponentContext](#maincomponentcontext) +全名: XCharts.Runtime.ParallelCoordContext +继承: [MainComponentContext](#maincomponentcontext) ## PieChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.PieChart +继承: [BaseChart](#basechart) ## PolarChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.PolarChart +继承: [BaseChart](#basechart) ## PolarCoordContext -Inherits or Implemented: [MainComponentContext](#maincomponentcontext) +全名: XCharts.Runtime.PolarCoordContext +继承: [MainComponentContext](#maincomponentcontext) ## PropertyUtil +全名: XCharts.Runtime.PropertyUtil + |public method|since|description| |--|--|--| |SetClass<T>()||public static bool SetClass<T>(ref T currentValue, T newValue, bool notNull = false) where T : class| @@ -793,14 +914,18 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## RadarChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.RadarChart +继承: [BaseChart](#basechart) ## RadarCoordContext -Inherits or Implemented: [MainComponentContext](#maincomponentcontext) +全名: XCharts.Runtime.RadarCoordContext +继承: [MainComponentContext](#maincomponentcontext) ## ReflectionUtil +全名: XCharts.Runtime.ReflectionUtil + |public method|since|description| |--|--|--| |DeepCloneSerializeField()||public static object DeepCloneSerializeField(object obj)| @@ -812,7 +937,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## RequireChartComponentAttribute -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.RequireChartComponentAttribute +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -822,10 +948,13 @@ Inherits or Implemented: [Attribute](#attribute) ## RingChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.RingChart +继承: [BaseChart](#basechart) ## RuntimeUtil +全名: XCharts.Runtime.RuntimeUtil + |public method|since|description| |--|--|--| |GetAllAssemblyTypes()||public static IEnumerable<Type> GetAllAssemblyTypes()| @@ -837,11 +966,18 @@ Inherits or Implemented: [BaseChart](#basechart) ## ScatterChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.ScatterChart +继承: [BaseChart](#basechart) + +## ScriptableObject + +全名: .ScriptableObject +子类: [Lang](#lang),[XCSettings](#xcsettings),[Theme](#theme) ## SerieComponentAttribute -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.SerieComponentAttribute +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -858,9 +994,12 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieContext +全名: XCharts.Runtime.SerieContext + ## SerieConvertAttribute -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.SerieConvertAttribute +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -873,7 +1012,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieDataComponentAttribute -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.SerieDataComponentAttribute +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -890,13 +1030,16 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieDataContext +全名: XCharts.Runtime.SerieDataContext + |public method|since|description| |--|--|--| |Reset()||public void Reset()| ## SerieDataExtraFieldAttribute -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.SerieDataExtraFieldAttribute +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -912,12 +1055,16 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieEventData +全名: XCharts.Runtime.SerieEventData + |public method|since|description| |--|--|--| |Reset()||public void Reset()| ## SerieEventDataPool +全名: XCharts.Runtime.SerieEventDataPool + |public method|since|description| |--|--|--| |Get()||public static SerieEventData Get(Vector3 pos, int serieIndex, int dataIndex, int dimension, double value)| @@ -925,6 +1072,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieHandler +全名: XCharts.Runtime.SerieHandler + |public method|since|description| |--|--|--| |CheckComponent()||public virtual void CheckComponent(StringBuilder sb) { }| @@ -951,9 +1100,15 @@ Inherits or Implemented: [Attribute](#attribute) |Update()||public virtual void Update() { }| |UpdateSerieContext()||public virtual void UpdateSerieContext() { }| +## SerieHandler where T + +全名: .SerieHandler where T +子类: [SerieHandler](#seriehandlert) + ## SerieHandler<T> -Inherits or Implemented: [SerieHandler where T](#seriehandler where t),[Serie](#serie) +全名: XCharts.Runtime.SerieHandler +继承: [SerieHandler where T](#seriehandler where t),[Serie](#serie) |public method|since|description| |--|--|--| @@ -978,7 +1133,8 @@ Inherits or Implemented: [SerieHandler where T](#seriehandler where t),[Serie](# ## SerieHandlerAttribute -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.SerieHandlerAttribute +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -987,6 +1143,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieHelper +全名: XCharts.Runtime.SerieHelper + |public method|since|description| |--|--|--| |CloneSerie<T>()||public static T CloneSerie<T>(Serie serie) where T : Serie| @@ -1029,6 +1187,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieLabelHelper +全名: XCharts.Runtime.SerieLabelHelper + |public method|since|description| |--|--|--| |AvoidLabelOverlap()||public static void AvoidLabelOverlap(Serie serie, ComponentTheme theme)| @@ -1040,6 +1200,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieLabelPool +全名: XCharts.Runtime.SerieLabelPool + |public method|since|description| |--|--|--| |ClearAll()||public static void ClearAll()| @@ -1048,8 +1210,12 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieParams +全名: XCharts.Runtime.SerieParams + ## SeriesHelper +全名: XCharts.Runtime.SeriesHelper + |public method|since|description| |--|--|--| |GetLastStackSerie()||public static Serie GetLastStackSerie(List<Serie> series, Serie serie)
获得上一个同堆叠且显示的serie。 | @@ -1068,19 +1234,23 @@ Inherits or Implemented: [Attribute](#attribute) ## SimplifiedBarChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.SimplifiedBarChart +继承: [BaseChart](#basechart) ## SimplifiedCandlestickChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.SimplifiedCandlestickChart +继承: [BaseChart](#basechart) ## SimplifiedLineChart -Inherits or Implemented: [BaseChart](#basechart) +全名: XCharts.Runtime.SimplifiedLineChart +继承: [BaseChart](#basechart) ## Since -Inherits or Implemented: [Attribute](#attribute) +全名: XCharts.Runtime.Since +继承: [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=Attribute) |public method|since|description| |--|--|--| @@ -1088,6 +1258,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SVG +全名: XUGL.SVG + |public method|since|description| |--|--|--| |DrawPath()||public static void DrawPath(VertexHelper vh, string path)| @@ -1096,10 +1268,13 @@ Inherits or Implemented: [Attribute](#attribute) ## SVGImage -Inherits or Implemented: [MaskableGraphic](#maskablegraphic) +全名: XCharts.Runtime.SVGImage +继承: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=MaskableGraphic) ## SVGPath +全名: XUGL.SVGPath + |public method|since|description| |--|--|--| |AddSegment()||public void AddSegment(SVGPathSeg seg)| @@ -1108,16 +1283,24 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## SVGPathSeg +全名: XUGL.SVGPathSeg + |public method|since|description| |--|--|--| |SVGPathSeg()||public SVGPathSeg(SVGPathSegType type)| ## TooltipContext +全名: XCharts.Runtime.TooltipContext + ## TooltipData +全名: XCharts.Runtime.TooltipData + ## TooltipHelper +全名: XCharts.Runtime.TooltipHelper + |public method|since|description| |--|--|--| |GetItemNumericFormatter()||public static string GetItemNumericFormatter(Tooltip tooltip, Serie serie, SerieData serieData)| @@ -1127,6 +1310,8 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## TooltipView +全名: XCharts.Runtime.TooltipView + |public method|since|description| |--|--|--| |CreateView()||public static TooltipView CreateView(Tooltip tooltip, ThemeStyle theme, Transform parent)| @@ -1139,8 +1324,12 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## TooltipViewItem +全名: XCharts.Runtime.TooltipViewItem + ## UGL +全名: XUGL.UGL + |public method|since|description| |--|--|--| |DrawDiamond()||public static void DrawDiamond(VertexHelper vh, Vector3 center, float size, Color32 color)
Draw a diamond. 画菱形（钻石形状） | @@ -1162,10 +1351,13 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## UGLExample -Inherits or Implemented: [MaskableGraphic](#maskablegraphic) +全名: XUGL.UGLExample +继承: [MaskableGraphic](https://docs.unity3d.com/ScriptReference/30_search.html?q=MaskableGraphic) ## UGLHelper +全名: XUGL.UGLHelper + |public method|since|description| |--|--|--| |GetAngle360()||public static float GetAngle360(Vector2 from, Vector2 to)
获得0-360的角度（12点钟方向为0度） | @@ -1194,7 +1386,8 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## UIComponent -Inherits or Implemented: [BaseGraph](#basegraph) +全名: XCharts.Runtime.UIComponent +继承: [BaseGraph](#basegraph) |public method|since|description| |--|--|--| @@ -1202,16 +1395,21 @@ Inherits or Implemented: [BaseGraph](#basegraph) ## UIHelper +全名: XCharts.Runtime.UIHelper + |public method|since|description| |--|--|--| |GetBackgroundColor()||public static Color32 GetBackgroundColor(UIComponent component)| ## VisualMapContext -Inherits or Implemented: [MainComponentContext](#maincomponentcontext) +全名: XCharts.Runtime.VisualMapContext +继承: [MainComponentContext](#maincomponentcontext) ## VisualMapHelper +全名: XCharts.Runtime.VisualMapHelper + |public method|since|description| |--|--|--| |AutoSetLineMinMax()||public static void AutoSetLineMinMax(VisualMap visualMap, Serie serie, bool isY, Axis axis, Axis relativedAxis)| @@ -1223,6 +1421,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## XChartsMgr +全名: XCharts.Runtime.XChartsMgr + |public method|since|description| |--|--|--| |AddChart()||public static void AddChart(BaseChart chart)| @@ -1238,7 +1438,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## XCResourceImporterWindow -Inherits or Implemented: [UnityEditor.EditorWindow](#unityeditor.editorwindow) +全名: XCharts.Runtime.XCResourceImporterWindow +继承: [UnityEditor.EditorWindow](https://docs.unity3d.com/ScriptReference/30_search.html?q=UnityEditor.EditorWindow) |public method|since|description| |--|--|--| @@ -1246,6 +1447,8 @@ Inherits or Implemented: [UnityEditor.EditorWindow](#unityeditor.editorwindow) ## XCThemeMgr +全名: XCharts.Runtime.XCThemeMgr + |public method|since|description| |--|--|--| |AddTheme()||public static void AddTheme(Theme theme)| diff --git a/Documentation~/zh/configuration.md b/Documentation~/zh/configuration.md index 32aabb41..2c2ab9ff 100644 --- a/Documentation~/zh/configuration.md +++ b/Documentation~/zh/configuration.md @@ -163,13 +163,20 @@ slug: /configuration - [TitleStyle](#titlestyle) -## Other 其他组件 +## Other 其他 - [BaseSerie](#baseserie) - [ChartText](#charttext) - [ChildComponent](#childcomponent) - [DebugInfo](#debuginfo) - [Indicator](#indicator) +- [INeedSerieContainer](#ineedseriecontainer) +- [IPropertyChanged](#ipropertychanged) +- [ISerieComponent](#iseriecomponent) +- [ISerieContainer](#iseriecontainer) +- [ISerieDataComponent](#iseriedatacomponent) +- [ISimplifiedSerie](#isimplifiedserie) +- [IUpdateRuntimeData](#iupdateruntimedata) - [Lang](#lang) - [LangCandlestick](#langcandlestick) - [LangTime](#langtime) @@ -180,25 +187,40 @@ slug: /configuration ## AngleAxis -Inherits or Implemented: [Axis](#axis) +> 全名: XCharts.Runtime.AngleAxis +> 继承: [Axis](#axis) 极坐标系的角度轴。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |startAngle|0||起始刻度的角度，默认为 0 度，即圆心的正右方。 +```mdx-code-block + +``` + ## AngleAxisTheme -Inherits or Implemented: [BaseAxisTheme](#baseaxistheme) +> 全名: XCharts.Runtime.AngleAxisTheme +> 继承: [BaseAxisTheme](#baseaxistheme) ## AnimationStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.AnimationStyle +> 继承: [ChildComponent](#childcomponent) 动画表现。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |enable|true||是否开启动画效果。 @@ -214,12 +236,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |actualDuration|||实际的动画时长（毫秒）。 |unscaledTime||v3.4.0|动画是否受TimeScaled的影响。默认为 false 受TimeScaled的影响。 +```mdx-code-block + +``` + ## AreaStyle -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> 全名: XCharts.Runtime.AreaStyle +> 继承: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) 区域填充样式。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示区域填充。 @@ -230,9 +261,18 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#is |innerFill||v3.2.0|是否只填充多边形区域。目前只支持凸多边形。 |toTop|true|v3.6.0|渐变色是到顶部还是到实际位置。默认为true到顶部。 +```mdx-code-block + +``` + ## ArrowStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.ArrowStyle +> 继承: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -242,12 +282,22 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |dent|3||箭头的凹度。 |color|Color.clear||箭头颜色。 +```mdx-code-block + +``` + ## Axis -Inherits or Implemented: [MainComponent](#maincomponent) +> 全名: XCharts.Runtime.Axis +> 继承: [MainComponent](#maincomponent) +> 子类: [AngleAxis](#angleaxis), [ParallelAxis](#parallelaxis), [RadiusAxis](#radiusaxis), [SingleAxis](#singleaxis), [XAxis](#xaxis), [YAxis](#yaxis) 直角坐标系的坐标轴组件。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示坐标轴。 @@ -282,12 +332,21 @@ Inherits or Implemented: [MainComponent](#maincomponent) |minorSplitLine||v3.2.0|坐标轴次分割线。 [AxisMinorSplitLine](#axisminorsplitline)| |indicatorLabel||v3.4.0|指示器文本的样式。Tooltip为Cross时使用。 [LabelStyle](#labelstyle)| +```mdx-code-block + +``` + ## AxisLabel -Inherits or Implemented: [LabelStyle](#labelstyle) +> 全名: XCharts.Runtime.AxisLabel +> 继承: [LabelStyle](#labelstyle) 坐标轴刻度标签的相关设置。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |interval|0||坐标轴刻度标签的显示间隔，在类目轴中有效。0表示显示所有标签，1表示隔一个隔显示一个标签，以此类推。 @@ -298,50 +357,86 @@ Inherits or Implemented: [LabelStyle](#labelstyle) |showEndLabel|true||是否显示最后一个文本。 |textLimit|||文本限制。 [TextLimit](#textlimit)| +```mdx-code-block + +``` + ## AxisLine -Inherits or Implemented: [BaseLine](#baseline) +> 全名: XCharts.Runtime.AxisLine +> 继承: [BaseLine](#baseline) 坐标轴轴线。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |onZero|||X 轴或者 Y 轴的轴线是否在另一个轴的 0 刻度上，只有在另一个轴为数值轴且包含 0 刻度时有效。 |showArrow|||是否显示箭头。 |arrow|||轴线箭头。 [ArrowStyle](#arrowstyle)| +```mdx-code-block + +``` + ## AxisMinorSplitLine -Inherits or Implemented: [BaseLine](#baseline) +> 全名: XCharts.Runtime.AxisMinorSplitLine +> 继承: [BaseLine](#baseline) > 从 `v3.2.0` 开始支持 坐标轴在 grid 区域中的次分隔线。次分割线会对齐次刻度线 minorTick。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |distance|||刻度线与轴线的距离。 |autoColor|||自动设置颜色。 +```mdx-code-block + +``` + ## AxisMinorTick -Inherits or Implemented: [BaseLine](#baseline) +> 全名: XCharts.Runtime.AxisMinorTick +> 继承: [BaseLine](#baseline) > 从 `v3.2.0` 开始支持 坐标轴次刻度相关设置。注意：次刻度无法在类目轴中使用。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |splitNumber|5||分隔线之间分割的刻度数。 |autoColor||| +```mdx-code-block + +``` + ## AxisName -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.AxisName +> 继承: [ChildComponent](#childcomponent) 坐标轴名称。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|||是否显示坐标轴名称。 @@ -349,23 +444,41 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |onZero||v3.1.0|坐标轴名称的位置是否保持和Y轴0刻度一致。 |labelStyle|||文本样式。 [LabelStyle](#labelstyle)| +```mdx-code-block + +``` + ## AxisSplitArea -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.AxisSplitArea +> 继承: [ChildComponent](#childcomponent) 坐标轴在 grid 区域中的分隔区域，默认不显示。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|||是否显示分隔区域。 |color|||分隔区域颜色。分隔区域会按数组中颜色的顺序依次循环设置颜色。默认是一个深浅的间隔色。 +```mdx-code-block + +``` + ## AxisSplitLine -Inherits or Implemented: [BaseLine](#baseline) +> 全名: XCharts.Runtime.AxisSplitLine +> 继承: [BaseLine](#baseline) 坐标轴在 grid 区域中的分隔线。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |interval|||坐标轴分隔线的显示间隔。 @@ -374,17 +487,27 @@ Inherits or Implemented: [BaseLine](#baseline) |showStartLine|true|v3.3.0|是否显示第一条分割线。 |showEndLine|true|v3.3.0|是否显示最后一条分割线。 +```mdx-code-block + +``` + ## AxisTheme -Inherits or Implemented: [BaseAxisTheme](#baseaxistheme) +> 全名: XCharts.Runtime.AxisTheme +> 继承: [BaseAxisTheme](#baseaxistheme) ## AxisTick -Inherits or Implemented: [BaseLine](#baseline) +> 全名: XCharts.Runtime.AxisTick +> 继承: [BaseLine](#baseline) 坐标轴刻度相关设置。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |alignWithLabel|||类目轴中在 boundaryGap 为 true 的时候有效，可以保证刻度线和标签对齐。 @@ -395,12 +518,21 @@ Inherits or Implemented: [BaseLine](#baseline) |splitNumber|0||分隔线之间分割的刻度数。 |autoColor||| +```mdx-code-block + +``` + ## Background -Inherits or Implemented: [MainComponent](#maincomponent) +> 全名: XCharts.Runtime.Background +> 继承: [MainComponent](#maincomponent) 背景组件。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否启用背景组件。 @@ -409,14 +541,25 @@ Inherits or Implemented: [MainComponent](#maincomponent) |imageColor|||背景图颜色。 |autoColor|true||当background组件开启时，是否自动使用主题背景色作为backgrounnd组件的颜色。当设置为false时，用imageColor作为颜色。 +```mdx-code-block + +``` + ## Bar -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> 全名: XCharts.Runtime.Bar +> 继承: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) ## BaseAxisTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> 全名: XCharts.Runtime.BaseAxisTheme +> 继承: [ComponentTheme](#componenttheme) +> 子类: [AxisTheme](#axistheme), [RadiusAxisTheme](#radiusaxistheme), [AngleAxisTheme](#angleaxistheme), [PolarAxisTheme](#polaraxistheme), [RadarAxisTheme](#radaraxistheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -434,28 +577,48 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |tickColor|||坐标轴线颜色。 |splitAreaColors|||坐标轴分隔区域的颜色。 +```mdx-code-block + +``` + ## BaseLine -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.BaseLine +> 继承: [ChildComponent](#childcomponent) +> 子类: [AxisLine](#axisline), [AxisMinorSplitLine](#axisminorsplitline), [AxisMinorTick](#axisminortick), [AxisSplitLine](#axissplitline), [AxisTick](#axistick) 线条基础配置。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|||是否显示坐标轴轴线。 |lineStyle|||线条样式 [LineStyle](#linestyle)| +```mdx-code-block + +``` + ## BaseScatter -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> 全名: XCharts.Runtime.BaseScatter +> 继承: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) +> 子类: [EffectScatter](#effectscatter), [Scatter](#scatter) ## BaseSerie +> 全名: XCharts.Runtime.BaseSerie +> 子类: [Serie](#serie) + ## BlurStyle -Inherits or Implemented: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> 全名: XCharts.Runtime.BlurStyle +> 继承: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) > 从 `v3.2.0` 开始支持 @@ -464,26 +627,37 @@ Inherits or Implemented: [StateStyle](#statestyle),[ISerieComponent](#iseriecomp ## CalendarCoord -Inherits or Implemented: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer) +> 全名: XCharts.Runtime.CalendarCoord +> 继承: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer) ## Candlestick -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> 全名: XCharts.Runtime.Candlestick +> 继承: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) ## ChartText +> 全名: XCharts.Runtime.ChartText ## ChildComponent +> 全名: XCharts.Runtime.ChildComponent +> 子类: [AnimationStyle](#animationstyle), [AxisName](#axisname), [AxisSplitArea](#axissplitarea), [AreaStyle](#areastyle), [ArrowStyle](#arrowstyle), [BaseLine](#baseline), [IconStyle](#iconstyle), [ImageStyle](#imagestyle), [ItemStyle](#itemstyle), [Level](#level), [LevelStyle](#levelstyle), [LineArrow](#linearrow), [LineStyle](#linestyle), [Location](#location), [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), [UIComponentTheme](#uicomponenttheme), [SerieData](#seriedata), [ComponentTheme](#componenttheme), [SerieTheme](#serietheme), [ThemeStyle](#themestyle) + ## Comment -Inherits or Implemented: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged) +> 全名: XCharts.Runtime.Comment +> 继承: [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged) 图表注解组件。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示注解组件。 @@ -491,12 +665,21 @@ Inherits or Implemented: [MainComponent](#maincomponent),[IPropertyChanged](#ipr |markStyle|||所有组件的文本样式。 [CommentMarkStyle](#commentmarkstyle)| |items|||注解项。每个注解组件可以设置多个注解项。 +```mdx-code-block + +``` + ## CommentItem -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.CommentItem +> 继承: [ChildComponent](#childcomponent) 注解项。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示当前注解项。 @@ -506,20 +689,39 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |labelStyle|||注解项的文本样式。 [LabelStyle](#labelstyle)| |location||v3.5.0|Comment显示的位置。 [Location](#location)| +```mdx-code-block + +``` + ## CommentMarkStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.CommentMarkStyle +> 继承: [ChildComponent](#childcomponent) 注解项区域样式。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示当前注解项。 |lineStyle|||线条样式。 [LineStyle](#linestyle)| +```mdx-code-block + +``` + ## ComponentTheme -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.ComponentTheme +> 继承: [ChildComponent](#childcomponent) +> 子类: [BaseAxisTheme](#baseaxistheme), [DataZoomTheme](#datazoomtheme), [LegendTheme](#legendtheme), [SubTitleTheme](#subtitletheme), [TitleTheme](#titletheme), [TooltipTheme](#tooltiptheme), [VisualMapTheme](#visualmaptheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -529,19 +731,30 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |fontSize|18||文本字体大小。 |tMPFont|||字体。 +```mdx-code-block + +``` + ## CoordSystem -Inherits or Implemented: [MainComponent](#maincomponent) +> 全名: XCharts.Runtime.CoordSystem +> 继承: [MainComponent](#maincomponent) +> 子类: [RadarCoord](#radarcoord), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [ParallelCoord](#parallelcoord), [PolarCoord](#polarcoord), [SingleAxisCoord](#singleaxiscoord) 坐标系系统。 ## DataZoom -Inherits or Implemented: [MainComponent](#maincomponent),[IUpdateRuntimeData](#iupdateruntimedata) +> 全名: XCharts.Runtime.DataZoom +> 继承: [MainComponent](#maincomponent), [IUpdateRuntimeData](#iupdateruntimedata) DataZoom 组件 用于区域缩放，从而能自由关注细节的数据信息，或者概览数据整体，或者去除离群点的影响。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |enable|true||是否显示缩放区域。 @@ -577,9 +790,18 @@ DataZoom 组件 用于区域缩放，从而能自由关注细节的数据信息 |startLock||v3.6.0|固定起始值，不让改变。 |endLock||v3.6.0|固定结束值，不让改变。 +```mdx-code-block + +``` + ## DataZoomTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> 全名: XCharts.Runtime.DataZoomTheme +> 继承: [ComponentTheme](#componenttheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -591,8 +813,17 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |dataAreaColor|||数据阴影的填充颜色。 |backgroundColor|||背景颜色。 +```mdx-code-block + +``` + ## DebugInfo +> 全名: XCharts.Runtime.DebugInfo +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示Debug组件。 @@ -601,36 +832,56 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |foldSeries|false||是否在Inspector上折叠Serie。 |labelStyle||| [LabelStyle](#labelstyle)| +```mdx-code-block + +``` + ## EffectScatter -Inherits or Implemented: [BaseScatter](#basescatter) +> 全名: XCharts.Runtime.EffectScatter +> 继承: [BaseScatter](#basescatter) ## EmphasisStyle -Inherits or Implemented: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> 全名: XCharts.Runtime.EmphasisStyle +> 继承: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) > 从 `v3.2.0` 开始支持 高亮状态样式。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |scale|1.1f||高亮时的缩放倍数。 |focus|||在高亮图形时，是否淡出其它数据的图形已达到聚焦的效果。
`EmphasisStyle.FocusType`:
- `None`: 不淡出其它图形，默认使用该配置。
- `Self`: 只聚焦（不淡出）当前高亮的数据的图形。
- `Series`: 聚焦当前高亮的数据所在的系列的所有图形。
| |blurScope|||在开启focus的时候，可以通过blurScope配置淡出的范围。
`EmphasisStyle.BlurScope`:
- `GridCoord`: 淡出范围为坐标系，默认使用该配置。
- `Series`: 淡出范围为系列。
- `Global`: 淡出范围为全局。
| +```mdx-code-block + +``` + ## EndLabelStyle -Inherits or Implemented: [LabelStyle](#labelstyle) +> 全名: XCharts.Runtime.EndLabelStyle +> 继承: [LabelStyle](#labelstyle) ## GridCoord -Inherits or Implemented: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer) +> 全名: XCharts.Runtime.GridCoord +> 继承: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer) Drawing grid in rectangular coordinate. Line chart, bar chart, and scatter chart can be drawn in grid. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示直角坐标系网格。 @@ -643,23 +894,41 @@ Drawing grid in rectangular coordinate. Line chart, bar chart, and scatter chart |borderWidth|0f||网格边框宽。 |borderColor|||网格边框颜色。 +```mdx-code-block + +``` + ## Heatmap -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> 全名: XCharts.Runtime.Heatmap +> 继承: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| |heatmapType||v3.3.0|热力图类型。通过颜色映射划分。
`HeatmapType`:
- `Data`: 数据映射型。默认用第2维数据作为颜色映射。要求数据至少有3个维度数据。
- `Count`: 个数映射型。统计数据在划分的格子中出现的次数，作为颜色映射。要求数据至少有2个维度数据。
| +```mdx-code-block + +``` + ## IconStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.IconStyle +> 继承: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| |show|false||是否显示图标。 |layer|||显示在上层还是在下层。
`IconStyle.Layer`:
- `UnderText`: The icon is display under the label text. 图标在标签文字下
- `AboveText`: The icon is display above the label text. 图标在标签文字上
| -|align|||水平方向对齐方式。
`Align`:
- `Center`: 对齐方式
- `Left`: 对齐方式
- `Right`: 对齐方式
| +|align|||水平方向对齐方式。
`Align`:
- `Center`: 对齐方式。文本，图标，图形等的对齐方式。
- `Left`: 对齐方式。文本，图标，图形等的对齐方式。
- `Right`: 对齐方式。文本，图标，图形等的对齐方式。
| |sprite|||图标的图片。 |type|||图片的显示类型。 |color|||图标颜色。 @@ -668,9 +937,18 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |offset|||图标偏移。 |autoHideWhenLabelEmpty|false||当label内容为空时是否自动隐藏图标 +```mdx-code-block + +``` + ## ImageStyle -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> 全名: XCharts.Runtime.ImageStyle +> 继承: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -682,10 +960,19 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#is |width|0||图标宽。 |height|0||图标高。 +```mdx-code-block + +``` + ## Indicator +> 全名: XCharts.Runtime.Indicator 雷达图的指示器，用来指定雷达图中的多个变量（维度）。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |name|||指示器名称。 @@ -712,12 +999,63 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#is |startAngle||v3.4.0|起始角度。和时钟一样，12点钟位置是0度，顺时针到360度。 |indicatorList|||指示器列表。 +```mdx-code-block + +``` + +## INeedSerieContainer + +> 全名: XCharts.Runtime.INeedSerieContainer +> 子类: [Bar](#bar), [SimplifiedBar](#simplifiedbar), [Candlestick](#candlestick), [SimplifiedCandlestick](#simplifiedcandlestick), [Heatmap](#heatmap), [Line](#line), [SimplifiedLine](#simplifiedline), [Parallel](#parallel), [Radar](#radar), [BaseScatter](#basescatter) + + +## IPropertyChanged + +> 全名: XCharts.Runtime.IPropertyChanged +> 子类: [Location](#location), [Comment](#comment), [Legend](#legend), [Title](#title) + +属性变更接口 + + +## ISerieComponent + +> 全名: XCharts.Runtime.ISerieComponent +> 子类: [AreaStyle](#areastyle), [ImageStyle](#imagestyle), [LineArrow](#linearrow), [LabelLine](#labelline), [LabelStyle](#labelstyle), [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle), [TitleStyle](#titlestyle) + +可用于Serie的组件。 + + +## ISerieContainer + +> 全名: XCharts.Runtime.ISerieContainer +> 子类: [RadarCoord](#radarcoord), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [ParallelCoord](#parallelcoord), [PolarCoord](#polarcoord) + + +## ISerieDataComponent + +> 全名: XCharts.Runtime.ISerieDataComponent +> 子类: [AreaStyle](#areastyle), [ImageStyle](#imagestyle), [ItemStyle](#itemstyle), [LineStyle](#linestyle), [SerieSymbol](#seriesymbol), [LabelLine](#labelline), [LabelStyle](#labelstyle), [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle), [TitleStyle](#titlestyle) + +可用于SerieData的组件。 + + +## ISimplifiedSerie + +> 全名: XCharts.Runtime.ISimplifiedSerie +> 子类: [SimplifiedBar](#simplifiedbar), [SimplifiedCandlestick](#simplifiedcandlestick), [SimplifiedLine](#simplifiedline) + + ## ItemStyle -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieDataComponent](#iseriedatacomponent) +> 全名: XCharts.Runtime.ItemStyle +> 继承: [ChildComponent](#childcomponent), [ISerieDataComponent](#iseriedatacomponent) 图形样式。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否启用。 @@ -741,17 +1079,32 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieDataComponent] |numericFormatter|||标准数字格式字符串。用于将数值格式化显示为字符串。 使用Axx的形式：A是格式说明符的单字符，支持C货币、D十进制、E指数、F定点数、G常规、N数字、P百分比、R往返、X十六进制的。xx是精度说明，从0-99。 参考：https://docs.microsoft.com/zh-cn/dotnet/standard/base-types/standard-numeric-format-strings |cornerRadius|||圆角半径。用数组分别指定4个圆角半径（顺时针左上，右上，右下，左下）。 +```mdx-code-block + +``` + +## IUpdateRuntimeData + +> 全名: XCharts.Runtime.IUpdateRuntimeData +> 子类: [SingleAxis](#singleaxis), [DataZoom](#datazoom), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [ParallelCoord](#parallelcoord) + + ## LabelLine -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> 全名: XCharts.Runtime.LabelLine +> 继承: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) 标签的引导线 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示视觉引导线。 |lineType|||视觉引导线类型。
`LabelLine.LineType`:
- `BrokenLine`: 折线
- `Curves`: 曲线
- `HorizontalLine`: 水平线
| -|lineColor|ChartConst.clearColor32||视觉引导线颜色。默认和serie一致取自调色板。 +|lineColor|Color32(0,0,0,0)||视觉引导线颜色。默认和serie一致取自调色板。 |lineAngle|0||视觉引导线的固定角度。对折线和曲线有效。 |lineWidth|1.0f||视觉引导线的宽度。 |lineGap|1.0f||视觉引导线和容器的间距。 @@ -760,12 +1113,22 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#is |startSymbol|||起始点的图形标记。 [SymbolStyle](#symbolstyle)| |endSymbol|||结束点的图形标记。 [SymbolStyle](#symbolstyle)| +```mdx-code-block + +``` + ## LabelStyle -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> 全名: XCharts.Runtime.LabelStyle +> 继承: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) +> 子类: [AxisLabel](#axislabel), [EndLabelStyle](#endlabelstyle), [TitleStyle](#titlestyle) 图形上的文本标签，可用于说明图形的一些数据信息，比如值，名称等。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示文本标签。 @@ -784,25 +1147,37 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#is |textPadding|||文本的边距。 [TextPadding](#textpadding)| |textStyle|||文本样式。 [TextStyle](#textstyle)| +```mdx-code-block + +``` + ## Lang -Inherits or Implemented: [ScriptableObject](#scriptableobject) +> 全名: XCharts.Runtime.Lang +> 继承: [ScriptableObject](#scriptableobject) 国际化语言表。 ## LangCandlestick +> 全名: XCharts.Runtime.LangCandlestick ## LangTime +> 全名: XCharts.Runtime.LangTime ## Legend -Inherits or Implemented: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged) +> 全名: XCharts.Runtime.Legend +> 继承: [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged) 图例组件。 图例组件展现了不同系列的标记，颜色和名字。可以通过点击图例控制哪些系列不显示。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示图例组件。 @@ -825,17 +1200,35 @@ Inherits or Implemented: [MainComponent](#maincomponent),[IPropertyChanged](#ipr |padding||v3.1.0|图例标记和背景的间距。 [Padding](#padding)| |positions||v3.6.0|图例标记的自定义位置列表。 +```mdx-code-block + +``` + ## LegendTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> 全名: XCharts.Runtime.LegendTheme +> 继承: [ComponentTheme](#componenttheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| |unableColor|||文本颜色。 +```mdx-code-block + +``` + ## Level -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.Level +> 继承: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -843,23 +1236,42 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |upperLabel|||上方的文本标签样式。 [LabelStyle](#labelstyle)| |itemStyle|||数据项样式。 [ItemStyle](#itemstyle)| +```mdx-code-block + +``` + ## LevelStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.LevelStyle +> 继承: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| |show|false||是否启用LevelStyle |levels|||各层节点对应的配置。当enableLevels为true时生效，levels[0]对应的第一层的配置，levels[1]对应第二层，依次类推。当levels中没有对应层时用默认的设置。 +```mdx-code-block + +``` + ## Line -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> 全名: XCharts.Runtime.Line +> 继承: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) ## LineArrow -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#iseriecomponent) +> 全名: XCharts.Runtime.LineArrow +> 继承: [ChildComponent](#childcomponent), [ISerieComponent](#iseriecomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -867,12 +1279,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#is |position|||箭头位置。
`LineArrow.Position`:
- `End`: 末端箭头
- `Start`: 头端箭头
| |arrow|||箭头。 [ArrowStyle](#arrowstyle)| +```mdx-code-block + +``` + ## LineStyle -Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieDataComponent](#iseriedatacomponent) +> 全名: XCharts.Runtime.LineStyle +> 继承: [ChildComponent](#childcomponent), [ISerieDataComponent](#iseriedatacomponent) 线条样式。 注： 修改 lineStyle 中的颜色不会影响图例颜色，如果需要图例颜色和折线图颜色一致，需修改 itemStyle.color，线条颜色默认也会取该颜色。 toColor，toColor2可设置水平方向的渐变，如需要设置垂直方向的渐变，可使用VisualMap。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示线条。当作为子组件，它的父组件有参数控制是否显示时，改参数无效。 @@ -884,12 +1305,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieDataComponent] |length|0||线长。 |opacity|1||线的透明度。支持从 0 到 1 的数字，为 0 时不绘制该图形。 +```mdx-code-block + +``` + ## Location -Inherits or Implemented: [ChildComponent](#childcomponent),[IPropertyChanged](#ipropertychanged) +> 全名: XCharts.Runtime.Location +> 继承: [ChildComponent](#childcomponent), [IPropertyChanged](#ipropertychanged) 位置类型。通过Align快速设置大体位置，再通过left，right，top，bottom微调具体位置。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |align|||对齐方式。
`Location.Align`:
- `TopLeft`: 对齐方式
- `TopRight`: 对齐方式
- `TopCenter`: 对齐方式
- `BottomLeft`: 对齐方式
- `BottomRight`: 对齐方式
- `BottomCenter`: 对齐方式
- `Center`: 对齐方式
- `CenterLeft`: 对齐方式
- `CenterRight`: 对齐方式
| @@ -898,17 +1328,28 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[IPropertyChanged](#i |top|||离容器上侧的距离。 |bottom|||离容器下侧的距离。 +```mdx-code-block + +``` + ## MainComponent -Inherits or Implemented: [IComparable](#icomparable) +> 全名: XCharts.Runtime.MainComponent +> 继承: [IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=IComparable) +> 子类: [Axis](#axis), [Background](#background), [Comment](#comment), [DataZoom](#datazoom), [Legend](#legend), [MarkArea](#markarea), [MarkLine](#markline), [Settings](#settings), [Title](#title), [Tooltip](#tooltip), [VisualMap](#visualmap), [CoordSystem](#coordsystem) ## MarkArea -Inherits or Implemented: [MainComponent](#maincomponent) +> 全名: XCharts.Runtime.MarkArea +> 继承: [MainComponent](#maincomponent) 图表标域，常用于标记图表中某个范围的数据。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示标域。 @@ -919,12 +1360,21 @@ Inherits or Implemented: [MainComponent](#maincomponent) |itemStyle|||标域样式。 [ItemStyle](#itemstyle)| |label|||标域文本样式。 [LabelStyle](#labelstyle)| +```mdx-code-block + +``` + ## MarkAreaData -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.MarkAreaData +> 继承: [ChildComponent](#childcomponent) 标域的数据。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |type|||特殊的标域类型，用于标注最大值最小值等。
`MarkAreaType`:
- `None`: 标域类型
- `Min`: 最小值。
- `Max`: 最大值。
- `Average`: 平均值。
- `Median`: 中位数。
| @@ -935,12 +1385,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |xValue|||X轴上的指定值。当X轴为类目轴时指定值表示类目轴数据的索引，否则为具体的值。当type为None时有效。 |yValue|||Y轴上的指定值。当Y轴为类目轴时指定值表示类目轴数据的索引，否则为具体的值。当type为None时有效。 +```mdx-code-block + +``` + ## MarkLine -Inherits or Implemented: [MainComponent](#maincomponent) +> 全名: XCharts.Runtime.MarkLine +> 继承: [MainComponent](#maincomponent) 图表标线。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示标线。 @@ -948,12 +1407,21 @@ Inherits or Implemented: [MainComponent](#maincomponent) |animation|||标线的动画样式。 [AnimationStyle](#animationstyle)| |data|||标线的数据列表。当数据项的group为0时，每个数据项表示一条标线；当group不为0时，相同group的两个数据项分别表 示标线的起始点和终止点来组成一条标线，此时标线的相关样式参数取起始点的参数。 +```mdx-code-block + +``` + ## MarkLineData -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.MarkLineData +> 继承: [ChildComponent](#childcomponent) 图表标线的数据。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |type|||特殊的标线类型，用于标注最大值最小值等。
`MarkLineType`:
- `None`: 标线类型
- `Min`: 最小值。
- `Max`: 最大值。
- `Average`: 平均值。
- `Median`: 中位数。
| @@ -970,14 +1438,23 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |lineStyle|||标线样式。 [LineStyle](#linestyle)| |label|||文本样式。可设置position为Start、Middle和End在不同的位置显示文本。 [LabelStyle](#labelstyle)| +```mdx-code-block + +``` + ## MarqueeStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.MarqueeStyle +> 继承: [ChildComponent](#childcomponent) > 从 `v3.5.0` 开始支持 Marquee style. It can be used for the DataZoom component. 选取框样式。可用于DataZoom组件。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |apply|false|v3.5.0|选取框范围是否应用到DataZoom上。当为true时，框选结束后的范围即为DataZoom的选择范围。 @@ -985,12 +1462,22 @@ Marquee style. It can be used for the DataZoom component. 选取框样式。可 |areaStyle||v3.5.0|选取框区域填充样式。 [AreaStyle](#areastyle)| |lineStyle||v3.5.0|选取框区域边框样式。 [LineStyle](#linestyle)| +```mdx-code-block + +``` + ## Padding -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.Padding +> 继承: [ChildComponent](#childcomponent) +> 子类: [TextPadding](#textpadding) 边距设置。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||show padding. 是否显示。 @@ -999,22 +1486,33 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |left|2f||左边间距。 |bottom|0||底部间距。 +```mdx-code-block + +``` + ## Parallel -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> 全名: XCharts.Runtime.Parallel +> 继承: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) ## ParallelAxis -Inherits or Implemented: [Axis](#axis) +> 全名: XCharts.Runtime.ParallelAxis +> 继承: [Axis](#axis) ## ParallelCoord -Inherits or Implemented: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer) +> 全名: XCharts.Runtime.ParallelCoord +> 继承: [CoordSystem](#coordsystem), [IUpdateRuntimeData](#iupdateruntimedata), [ISerieContainer](#iseriecontainer) Drawing grid in rectangular coordinate. Line chart, bar chart, and scatter chart can be drawn in grid. +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示直角坐标系网格。 @@ -1025,22 +1523,33 @@ Drawing grid in rectangular coordinate. Line chart, bar chart, and scatter chart |bottom|0.12f||grid 组件离容器下侧的距离。 |backgroundColor|||网格背景色，默认透明。 +```mdx-code-block + +``` + ## Pie -Inherits or Implemented: [Serie](#serie) +> 全名: XCharts.Runtime.Pie +> 继承: [Serie](#serie) ## PolarAxisTheme -Inherits or Implemented: [BaseAxisTheme](#baseaxistheme) +> 全名: XCharts.Runtime.PolarAxisTheme +> 继承: [BaseAxisTheme](#baseaxistheme) ## PolarCoord -Inherits or Implemented: [CoordSystem](#coordsystem),[ISerieContainer](#iseriecontainer) +> 全名: XCharts.Runtime.PolarCoord +> 继承: [CoordSystem](#coordsystem), [ISerieContainer](#iseriecontainer) 极坐标系组件。 极坐标系，可以用于散点图和折线图。每个极坐标系拥有一个角度轴和一个半径轴。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示极坐标。 @@ -1048,51 +1557,71 @@ Inherits or Implemented: [CoordSystem](#coordsystem),[ISerieContainer](#iserieco |radius|||半径。radius[0]表示内径，radius[1]表示外径。 |backgroundColor|||极坐标的背景色，默认透明。 +```mdx-code-block + +``` + ## Radar -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer) +> 全名: XCharts.Runtime.Radar +> 继承: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| |smooth|false|v3.2.0|是否平滑曲线。平滑曲线时不支持区域填充颜色。 +```mdx-code-block + +``` + ## RadarAxisTheme -Inherits or Implemented: [BaseAxisTheme](#baseaxistheme) +> 全名: XCharts.Runtime.RadarAxisTheme +> 继承: [BaseAxisTheme](#baseaxistheme) ## RadarCoord -Inherits or Implemented: [CoordSystem](#coordsystem),[ISerieContainer](#iseriecontainer) +> 全名: XCharts.Runtime.RadarCoord +> 继承: [CoordSystem](#coordsystem), [ISerieContainer](#iseriecontainer) Radar coordinate conponnet for radar charts. 雷达图坐标系组件，只适用于雷达图。 ## RadiusAxis -Inherits or Implemented: [Axis](#axis) +> 全名: XCharts.Runtime.RadiusAxis +> 继承: [Axis](#axis) 极坐标系的径向轴。 ## RadiusAxisTheme -Inherits or Implemented: [BaseAxisTheme](#baseaxistheme) +> 全名: XCharts.Runtime.RadiusAxisTheme +> 继承: [BaseAxisTheme](#baseaxistheme) ## Ring -Inherits or Implemented: [Serie](#serie) +> 全名: XCharts.Runtime.Ring +> 继承: [Serie](#serie) ## Scatter -Inherits or Implemented: [BaseScatter](#basescatter) +> 全名: XCharts.Runtime.Scatter +> 继承: [BaseScatter](#basescatter) ## SelectStyle -Inherits or Implemented: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> 全名: XCharts.Runtime.SelectStyle +> 继承: [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) > 从 `v3.2.0` 开始支持 @@ -1101,9 +1630,15 @@ Inherits or Implemented: [StateStyle](#statestyle),[ISerieComponent](#iseriecomp ## Serie -Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable) +> 全名: XCharts.Runtime.Serie +> 继承: [BaseSerie](#baseserie), [IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=IComparable) +> 子类: [SerieHandler](#seriehandler), [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 + +``` |field|default|since|comment| |--|--|--|--| @@ -1113,7 +1648,7 @@ Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable) |serieType|||系列类型。 |serieName|||系列名称，用于 tooltip 的显示，legend 的图例筛选。 |state||v3.2.0|系列的默认状态。
`SerieState`:
- `Normal`: 正常状态。
- `Emphasis`: 高亮状态。
- `Blur`: 淡出状态。
- `Select`: 选中状态。
- `Auto`: 自动保持和父节点一致。一般用在SerieData。
| -|colorBy||v3.2.0|从主题中取色的策略。
`SerieColorBy`:
- `Default`: 默认策略。每种Serie都有自己的默认的取颜色策略。比如Line默认是Series策略，Pie默认是Data策略
- `Serie`: 按照系列分配调色盘中的颜色，同一系列中的所有数据都是用相同的颜色。
- `Data`: 按照数据项分配调色盘中的颜色，每个数据项都使用不同的颜色。
| +|colorBy||v3.2.0|从主题中取色的策略。
`SerieColorBy`:
- `Default`: 默认策略。每种Serie都有自己的默认的取颜色策略。比如Line默认是Series策略，Pie默认是Data策略。
- `Serie`: 按照系列分配调色盘中的颜色，同一系列中的所有数据都是用相同的颜色。
- `Data`: 按照数据项分配调色盘中的颜色，每个数据项都使用不同的颜色。
| |stack|||数据堆叠，同个类目轴上系列配置相同的stack值后，后一个系列的值会在前一个系列的值上相加。 |xAxisIndex|0||使用X轴的index。 |yAxisIndex|0||使用Y轴的index。 @@ -1164,9 +1699,9 @@ Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable) |avoidLabelOverlap|false||在饼图且标签外部显示的情况下，是否启用防止标签重叠策略，默认关闭，在标签拥挤重叠的情况下会挪动各个标签的位置，防止标签间的重叠。 |radarType|||雷达图类型。
`RadarType`:
- `Multiple`: 多圈雷达图。此时可一个雷达里绘制多个圈，一个serieData就可组成一个圈（多维数据）。
- `Single`: 单圈雷达图。此时一个雷达只能绘制一个圈，多个serieData组成一个圈，数据取自`data[1]`。
| |placeHolder|false||占位模式。占位模式时，数据有效但不参与渲染和显示。 -|dataSortType|||组件的数据排序。
`SerieDataSortType`:
- `None`: 按 data 的顺序
- `Ascending`: 升序
- `Descending`: 降序
| +|dataSortType|||组件的数据排序。
`SerieDataSortType`:
- `None`: 按数据的顺序。
- `Ascending`: 升序。
- `Descending`: 降序。
| |orient|||组件的朝向。
`Orient`:
- `Horizonal`: 水平
- `Vertical`: 垂直
| -|align|||组件水平方向对齐方式。
`Align`:
- `Center`: 对齐方式
- `Left`: 对齐方式
- `Right`: 对齐方式
| +|align|||组件水平方向对齐方式。
`Align`:
- `Center`: 对齐方式。文本，图标，图形等的对齐方式。
- `Left`: 对齐方式。文本，图标，图形等的对齐方式。
- `Right`: 对齐方式。文本，图标，图形等的对齐方式。
| |left|||组件离容器左侧的距离。 |right|||组件离容器右侧的距离。 |top|||组件离容器上侧的距离。 @@ -1178,12 +1713,21 @@ Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable) |itemStyle|||图形样式。 [ItemStyle](#itemstyle)| |data|||系列中的数据内容数组。SerieData可以设置1到n维数据。 +```mdx-code-block + +``` + ## SerieData -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.SerieData +> 继承: [ChildComponent](#childcomponent) 系列中的一个数据项。可存储数据名和1-n维个数据。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |index|||数据项索引。 @@ -1196,12 +1740,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |state||v3.2.0|数据项的默认状态。
`SerieState`:
- `Normal`: 正常状态。
- `Emphasis`: 高亮状态。
- `Blur`: 淡出状态。
- `Select`: 选中状态。
- `Auto`: 自动保持和父节点一致。一般用在SerieData。
| |data|||可指定任意维数的数值列表。 +```mdx-code-block + +``` + ## SerieSymbol -Inherits or Implemented: [SymbolStyle](#symbolstyle),[ISerieDataComponent](#iseriedatacomponent) +> 全名: XCharts.Runtime.SerieSymbol +> 继承: [SymbolStyle](#symbolstyle), [ISerieDataComponent](#iseriedatacomponent) 系列数据项的标记的图形 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |sizeType|||标记图形的大小获取方式。
`SymbolSizeType`:
- `Custom`: 自定义大小。
- `FromData`: 通过 dataIndex 从数据中获取，再乘以一个比例系数 dataScale 。
- `Function`: 通过委托函数获取。
| @@ -1215,9 +1768,18 @@ Inherits or Implemented: [SymbolStyle](#symbolstyle),[ISerieDataComponent](#iser |minSize|0f|v3.3.0|图形最小尺寸。只在sizeType为SymbolSizeType.FromData时有效。 |maxSize|0f|v3.3.0|图形最大尺寸。只在sizeType为SymbolSizeType.FromData时有效。 +```mdx-code-block + +``` + ## SerieTheme -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.SerieTheme +> 继承: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1233,12 +1795,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |candlestickBorderColor|Color32(235, 84, 84, 255)||K线图阳线（跌）边框色 |candlestickBorderColor0|Color32(71, 178, 98, 255)||K线图阴线（跌）边框色 +```mdx-code-block + +``` + ## Settings -Inherits or Implemented: [MainComponent](#maincomponent) +> 全名: XCharts.Runtime.Settings +> 继承: [MainComponent](#maincomponent) 全局参数设置组件。一般情况下可使用默认值，当有需要时可进行调整。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true|| @@ -1256,27 +1827,39 @@ Inherits or Implemented: [MainComponent](#maincomponent) |legendIconCornerRadius|||图例圆角半径。用数组分别指定4个圆角半径（顺时针左上，右上，右下，左下）。 |axisMaxSplitNumber|50|v3.1.0|坐标轴最大分隔段数。段数过大时可能会生成较多的label节点。 +```mdx-code-block + +``` + ## SimplifiedBar -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie) +> 全名: XCharts.Runtime.SimplifiedBar +> 继承: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie) ## SimplifiedCandlestick -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie) +> 全名: XCharts.Runtime.SimplifiedCandlestick +> 继承: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie) ## SimplifiedLine -Inherits or Implemented: [Serie](#serie),[INeedSerieContainer](#ineedseriecontainer),[ISimplifiedSerie](#isimplifiedserie) +> 全名: XCharts.Runtime.SimplifiedLine +> 继承: [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer), [ISimplifiedSerie](#isimplifiedserie) ## SingleAxis -Inherits or Implemented: [Axis](#axis),[IUpdateRuntimeData](#iupdateruntimedata) +> 全名: XCharts.Runtime.SingleAxis +> 继承: [Axis](#axis), [IUpdateRuntimeData](#iupdateruntimedata) 单轴。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |orient|||坐标轴朝向。默认为水平朝向。
`Orient`:
- `Horizonal`: 水平
- `Vertical`: 垂直
| @@ -1287,28 +1870,48 @@ Inherits or Implemented: [Axis](#axis),[IUpdateRuntimeData](#iupdateruntimedata) |width|0||坐标轴宽。 |height|50||坐标轴高。 +```mdx-code-block + +``` + ## SingleAxisCoord -Inherits or Implemented: [CoordSystem](#coordsystem) +> 全名: XCharts.Runtime.SingleAxisCoord +> 继承: [CoordSystem](#coordsystem) ## StageColor -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.StageColor +> 继承: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| |percent|||结束位置百分比。 |color|||颜色。 +```mdx-code-block + +``` + ## StateStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.StateStyle +> 继承: [ChildComponent](#childcomponent) +> 子类: [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle) > 从 `v3.2.0` 开始支持 Serie的状态样式。Serie的状态有正常，高亮，淡出，选中四种状态。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否启用高亮样式。 @@ -1319,17 +1922,28 @@ Serie的状态样式。Serie的状态有正常，高亮，淡出，选中四种 |areaStyle|||区域样式。 [AreaStyle](#areastyle)| |symbol|||标记样式。 [SerieSymbol](#seriesymbol)| +```mdx-code-block + +``` + ## SubTitleTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> 全名: XCharts.Runtime.SubTitleTheme +> 继承: [ComponentTheme](#componenttheme) ## SymbolStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.SymbolStyle +> 继承: [ChildComponent](#childcomponent) +> 子类: [SerieSymbol](#seriesymbol) 系列数据项的标记的图形 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示标记。 @@ -1343,12 +1957,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |imageType|||图形填充类型。 |color|||图形的颜色。 +```mdx-code-block + +``` + ## TextLimit -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.TextLimit +> 继承: [ChildComponent](#childcomponent) 文本字符限制和自适应。当文本长度超过设定的长度时进行裁剪，并将后缀附加在最后。 只在类目轴中有效。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |enable|false||是否启用文本自适应。 [default:true] @@ -1356,19 +1979,29 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |gap|1||两边留白像素距离。 [default:10f] |suffix|||长度超出时的后缀。 [default: "..."] +```mdx-code-block + +``` + ## TextPadding -Inherits or Implemented: [Padding](#padding) +> 全名: XCharts.Runtime.TextPadding +> 继承: [Padding](#padding) 文本的内边距设置。 ## TextStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.TextStyle +> 继承: [ChildComponent](#childcomponent) 文本的相关设置。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||文本的相关设置。 @@ -1387,12 +2020,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |tMPAlignment||| |tMPSpriteAsset||v3.1.0| +```mdx-code-block + +``` + ## Theme -Inherits or Implemented: [ScriptableObject](#scriptableobject) +> 全名: XCharts.Runtime.Theme +> 继承: [ScriptableObject](#scriptableobject) 主题相关配置。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |themeType|||主题类型。
`ThemeType`:
- `Default`: 默认主题。
- `Light`: 亮主题。
- `Dark`: 暗主题。
- `Custom`: 自定义主题。
| @@ -1412,12 +2054,21 @@ Inherits or Implemented: [ScriptableObject](#scriptableobject) |visualMap||| [VisualMapTheme](#visualmaptheme)| |serie||| [SerieTheme](#serietheme)| +```mdx-code-block + +``` + ## ThemeStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.ThemeStyle +> 继承: [ChildComponent](#childcomponent) 主题相关配置。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true|| @@ -1428,12 +2079,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |customBackgroundColor|||自定义的背景颜色。 |customColorPalette||| +```mdx-code-block + +``` + ## Title -Inherits or Implemented: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged) +> 全名: XCharts.Runtime.Title +> 继承: [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged) 标题组件，包含主标题和副标题。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示标题组件。 @@ -1444,24 +2104,35 @@ Inherits or Implemented: [MainComponent](#maincomponent),[IPropertyChanged](#ipr |itemGap|0||主副标题之间的间距。 |location|||标题显示位置。 [Location](#location)| +```mdx-code-block + +``` + ## TitleStyle -Inherits or Implemented: [LabelStyle](#labelstyle),[ISerieDataComponent](#iseriedatacomponent),[ISerieComponent](#iseriecomponent) +> 全名: XCharts.Runtime.TitleStyle +> 继承: [LabelStyle](#labelstyle), [ISerieDataComponent](#iseriedatacomponent), [ISerieComponent](#iseriecomponent) 标题相关设置。 ## TitleTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> 全名: XCharts.Runtime.TitleTheme +> 继承: [ComponentTheme](#componenttheme) ## Tooltip -Inherits or Implemented: [MainComponent](#maincomponent) +> 全名: XCharts.Runtime.Tooltip +> 继承: [MainComponent](#maincomponent) 提示框组件。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||是否显示提示框组件。 @@ -1496,9 +2167,18 @@ Inherits or Implemented: [MainComponent](#maincomponent) |titleLabelStyle|||标题的文本样式。 [LabelStyle](#labelstyle)| |contentLabelStyles|||内容部分的文本样式列表。和列一一对应。 +```mdx-code-block + +``` + ## TooltipTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> 全名: XCharts.Runtime.TooltipTheme +> 继承: [ComponentTheme](#componenttheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1509,9 +2189,18 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |labelTextColor|||十字指示器坐标轴标签的文本颜色。 |labelBackgroundColor|||十字指示器坐标轴标签的背景颜色。 +```mdx-code-block + +``` + ## UIComponentTheme -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.UIComponentTheme +> 继承: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1519,12 +2208,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |sharedTheme|||主题配置。 [Theme](#theme)| |transparentBackground|false|| +```mdx-code-block + +``` + ## VisualMap -Inherits or Implemented: [MainComponent](#maincomponent) +> 全名: XCharts.Runtime.VisualMap +> 继承: [MainComponent](#maincomponent) 视觉映射组件。用于进行『视觉编码』，也就是将数据映射到视觉元素（视觉通道）。 +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |show|true||组件是否生效。 @@ -1554,9 +2252,18 @@ Inherits or Implemented: [MainComponent](#maincomponent) |outOfRange|||定义 在选中范围外 的视觉颜色。 |inRange|||分段式每一段的相关配置。 +```mdx-code-block + +``` + ## VisualMapRange -Inherits or Implemented: [ChildComponent](#childcomponent) +> 全名: XCharts.Runtime.VisualMapRange +> 继承: [ChildComponent](#childcomponent) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1565,9 +2272,18 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |label|||文字描述 |color|||颜色 +```mdx-code-block + +``` + ## VisualMapTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> 全名: XCharts.Runtime.VisualMapTheme +> 继承: [ComponentTheme](#componenttheme) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1576,19 +2292,30 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |backgroundColor|||背景颜色。 |triangeLen|20f||可视化组件的调节三角形边长。 +```mdx-code-block + +``` + ## XAxis -Inherits or Implemented: [Axis](#axis) +> 全名: XCharts.Runtime.XAxis +> 继承: [Axis](#axis) 直角坐标系 grid 中的 x 轴。 ## XCResourcesImporter +> 全名: XCharts.Runtime.XCResourcesImporter ## XCSettings -Inherits or Implemented: [ScriptableObject](#scriptableobject) +> 全名: XCharts.Runtime.XCSettings +> 继承: [ScriptableObject](#scriptableobject) + +```mdx-code-block + +``` |field|default|since|comment| |--|--|--|--| @@ -1630,9 +2357,14 @@ Inherits or Implemented: [ScriptableObject](#scriptableobject) |pieSelectedOffset|8f|| |customThemes||| +```mdx-code-block + +``` + ## YAxis -Inherits or Implemented: [Axis](#axis) +> 全名: XCharts.Runtime.YAxis +> 继承: [Axis](#axis) 直角坐标系 grid 中的 y 轴。 diff --git a/Runtime/Serie/Serie.cs b/Runtime/Serie/Serie.cs index 986f82bc..2b73a87a 100644 --- a/Runtime/Serie/Serie.cs +++ b/Runtime/Serie/Serie.cs @@ -6,7 +6,7 @@ namespace XCharts.Runtime { /// /// Whether to show as Nightingale chart, which distinguishs data through radius. - /// 是否展示成南丁格尔图，通过半径区分数据大小。 + /// |是否展示成南丁格尔图，通过半径区分数据大小。 /// public enum RoseType { @@ -61,7 +61,8 @@ namespace XCharts.Runtime } /// - /// the type of bar. |柱状图类型。 + /// the type of bar. + /// |柱状图类型。 /// public enum BarType { @@ -83,7 +84,8 @@ namespace XCharts.Runtime } /// - /// the type of radar. |雷达图类型。 + /// the type of radar. + /// |雷达图类型。 /// public enum RadarType { @@ -100,7 +102,8 @@ namespace XCharts.Runtime } /// - /// 采样类型 + /// sample type of line chart. + /// |采样类型，一般用于折线图。 /// public enum SampleType { @@ -133,26 +136,31 @@ namespace XCharts.Runtime } /// - /// 数据排序方式 + /// the sort type of serie data. + /// |数据排序方式。 /// public enum SerieDataSortType { /// - /// 按 data 的顺序 + /// In the order of data. + /// |按数据的顺序。 /// None, /// - /// 升序 + /// Sort data in ascending order. + /// |升序。 /// Ascending, /// - /// 降序 + /// Sort data in descending order. + /// |降序。 /// Descending, } /// - /// 对齐方式 + /// Alignment mode. + /// |对齐方式。文本，图标，图形等的对齐方式。 /// public enum Align { @@ -202,23 +210,23 @@ namespace XCharts.Runtime { /// /// Select state. - /// |默认策略。每种Serie都有自己的默认的取颜色策略。比如Line默认是Series策略，Pie默认是Data策略 + /// |默认策略。每种Serie都有自己的默认的取颜色策略。比如Line默认是Series策略，Pie默认是Data策略。 /// Default, /// - /// assigns the colors in the palette by serie, so that all data in the same series are in the same color;. + /// assigns the colors in the palette by serie, so that all data in the same series are in the same color. /// |按照系列分配调色盘中的颜色，同一系列中的所有数据都是用相同的颜色。 /// Serie, /// - /// assigns colors in the palette according to data items, with each data item using a different color.. + /// assigns colors in the palette according to data items, with each data item using a different color. /// |按照数据项分配调色盘中的颜色，每个数据项都使用不同的颜色。 /// Data } /// - /// 系列。 + /// 系列。系列一般由数据和配置组成，用来表示具体的图表图形，如折线图的一条折线，柱图的一组柱子等。一个图表中可以包含多个不同类型的系列。 /// [System.Serializable] public partial class Serie : BaseSerie, IComparable