diff --git a/Documentation~/en/api.md b/Documentation~/en/api.md index e939a50c..74f9845f 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) @@ -106,6 +113,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 +124,16 @@ slug: /api ## AxisContext -Inherits or Implemented: [MainComponentContext](#maincomponentcontext) +> XCharts.Runtime.AxisContext : [MainComponentContext](#maincomponentcontext) ## AxisHandler<T> -Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) +> XCharts.AxisHandler<T> : [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 +160,11 @@ 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) / 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| |--|--|--| @@ -204,6 +215,7 @@ Inherits or Implemented: [BaseGraph](#basegraph),[ISerializationCallbackReceiver |CanAddChartComponent()||public bool CanAddChartComponent(Type type)| |CanAddSerie()||public bool CanAddSerie(Type type)| |CanAddSerie<T>()||public bool CanAddSerie<T>() where T : Serie| +|CancelTooltip()|v3.7.0|public void CancelTooltip()
cancel tooltip. | |CanMultipleComponent()||public bool CanMultipleComponent(Type type)| |ClampInChart()||public void ClampInChart(ref Vector3 pos)| |ClampInGrid()||public Vector3 ClampInGrid(GridCoord grid, Vector3 pos)| @@ -319,6 +331,8 @@ Inherits or Implemented: [BaseGraph](#basegraph),[ISerializationCallbackReceiver |SetSeriePainterMaterial()||public void SetSeriePainterMaterial(Material material)
设置Serie Painter的材质球 | |SetTopPainterMaterial()||public void SetTopPainterMaterial(Material material)
设置Top Painter的材质球 | |SetUpperPainterMaterial()||public void SetUpperPainterMaterial(Material material)
设置Upper Painter的材质球 | +|TriggerTooltip()|v3.7.0|public bool TriggerTooltip(int dataIndex)
trigger tooltip by data index. | +|TriggerTooltip()|v3.7.0|public bool TriggerTooltip(Vector3 localPosition)
trigger tooltip by chart local position. | |TryAddChartComponent()||public bool TryAddChartComponent(Type type)| |TryAddChartComponent<T>()||public bool TryAddChartComponent<T>() where T : MainComponent| |TryAddChartComponent<T>()||public bool TryAddChartComponent<T>(out T component) where T : MainComponent| @@ -341,7 +355,7 @@ 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),[](#) / Subclasses: [BaseChart](#basechart),[UIComponent](#uicomponent) |public method|since|description| |--|--|--| @@ -355,6 +369,8 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic),[IPointerDownHandle |onPointerUp||public Action<PointerEventData, BaseGraph> onPointerUp
鼠标弹起回调。 | |onScroll||public Action<PointerEventData, BaseGraph> onScroll
鼠标滚动回调。 | |CheckWarning()||public string CheckWarning()
检测警告信息。 | +|LocalPointToScreenPoint()|v3.7.0|public Vector2 LocalPointToScreenPoint(Vector2 localPoint)
chart local point to screen point. | +|LocalPointToWorldPoint()|v3.7.0|public Vector2 LocalPointToWorldPoint(Vector2 localPoint)
chart local point to world point. | |OnBeginDrag()||public virtual void OnBeginDrag(PointerEventData eventData)| |OnDrag()||public virtual void OnDrag(PointerEventData eventData)| |OnEndDrag()||public virtual void OnEndDrag(PointerEventData eventData)| @@ -374,10 +390,12 @@ 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)| @@ -389,10 +407,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)| @@ -416,8 +440,10 @@ Inherits or Implemented: [BaseChart](#basechart) |GetFullName()||public static string GetFullName(Transform transform)| |GetHighlightColor()||public static Color32 GetHighlightColor(Color32 color, float rate = 0.8f)| |GetLastValue()||public static Vector3 GetLastValue(List<Vector3> list)| +|GetMaxCeilRate()||public static double GetMaxCeilRate(double value, double ceilRate)| |GetMaxDivisibleValue()||public static double GetMaxDivisibleValue(double max, double ceilRate)| |GetMaxLogValue()||public static double GetMaxLogValue(double value, float logBase, bool isLogBaseE, out int splitNumber)| +|GetMinCeilRate()||public static double GetMinCeilRate(double value, double ceilRate)| |GetMinDivisibleValue()||public static double GetMinDivisibleValue(double min, double ceilRate)| |GetMinLogValue()||public static double GetMinLogValue(double value, float logBase, bool isLogBaseE, out int splitNumber)| |GetOrAddComponent<T>()||public static T GetOrAddComponent<T>(GameObject gameObject) where T : Component| @@ -458,7 +484,7 @@ 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| |--|--|--| @@ -487,12 +513,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)| @@ -500,13 +530,15 @@ Inherits or Implemented: [Image](#image) ## ColorUtil +> 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) +> XCharts.Runtime.ComponentHandlerAttribute : [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute) |public method|since|description| |--|--|--| @@ -515,6 +547,8 @@ Inherits or Implemented: [Attribute](#attribute) ## ComponentHelper +> XCharts.Runtime.ComponentHelper + |public method|since|description| |--|--|--| |GetAngleAxis()||public static AngleAxis GetAngleAxis(List<MainComponent> components, int polarIndex)| @@ -525,7 +559,7 @@ 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| |--|--|--| @@ -537,10 +571,12 @@ 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)| @@ -548,6 +584,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## DateTimeUtil +> XCharts.Runtime.DateTimeUtil + |public method|since|description| |--|--|--| |GetDateTime()||public static DateTime GetDateTime(int timestamp)| @@ -556,7 +594,7 @@ 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| |--|--|--| @@ -564,6 +602,8 @@ Inherits or Implemented: [Attribute](#attribute) ## DefineSymbolsUtil +> XCharts.Runtime.DefineSymbolsUtil + |public method|since|description| |--|--|--| |AddGlobalDefine()||public static void AddGlobalDefine(string symbol)| @@ -571,6 +611,8 @@ Inherits or Implemented: [Attribute](#attribute) ## FormatterHelper +> XCharts.Runtime.FormatterHelper + |public method|since|description| |--|--|--| |NeedFormat()||public static bool NeedFormat(string content)| @@ -581,22 +623,28 @@ 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 / Subclasses: [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)| @@ -604,6 +652,8 @@ Inherits or Implemented: [Attribute](#attribute) ## InteractData +> XCharts.Runtime.InteractData + |public method|since|description| |--|--|--| |Reset()||public void Reset()| @@ -618,8 +668,37 @@ 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 / Subclasses: [Location](#location),[Comment](#comment),[Legend](#legend),[Title](#title) +属性变更接口 + +## ISerieComponent + +> 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 + +> XCharts.Runtime.ISerieContainer / Subclasses: [RadarCoord](#radarcoord),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[ParallelCoord](#parallelcoord),[PolarCoord](#polarcoord) + +## ISerieDataComponent + +> 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 + +> XCharts.Runtime.ISimplifiedSerie / Subclasses: [SimplifiedBar](#simplifiedbar),[SimplifiedCandlestick](#simplifiedcandlestick),[SimplifiedLine](#simplifiedline) + +## IUpdateRuntimeData + +> XCharts.Runtime.IUpdateRuntimeData / Subclasses: [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)| @@ -627,10 +706,12 @@ 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)| @@ -642,6 +723,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## LegendItem +> XCharts.Runtime.LegendItem + |public method|since|description| |--|--|--| |GetIconColor()||public Color GetIconColor()| @@ -665,11 +748,11 @@ 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) / Subclasses: [ListForComponent](#listforcomponent),[ListForSerie](#listforserie) |public method|since|description| |--|--|--| @@ -677,7 +760,7 @@ Inherits or Implemented: [Attribute](#attribute) ## ListForComponent -Inherits or Implemented: [ListFor](#listfor) +> XCharts.Runtime.ListForComponent : [ListFor](#listfor) |public method|since|description| |--|--|--| @@ -685,7 +768,7 @@ Inherits or Implemented: [ListFor](#listfor) ## ListForSerie -Inherits or Implemented: [ListFor](#listfor) +> XCharts.Runtime.ListForSerie : [ListFor](#listfor) |public method|since|description| |--|--|--| @@ -693,8 +776,12 @@ Inherits or Implemented: [ListFor](#listfor) ## MainComponentContext +> XCharts.Runtime.MainComponentContext / Subclasses: [AxisContext](#axiscontext),[DataZoomContext](#datazoomcontext),[LegendContext](#legendcontext),[RadarCoordContext](#radarcoordcontext),[VisualMapContext](#visualmapcontext),[GridCoordContext](#gridcoordcontext),[ParallelCoordContext](#parallelcoordcontext),[PolarCoordContext](#polarcoordcontext) + ## MainComponentHandler +> XCharts.Runtime.MainComponentHandler / Subclasses: [AxisHandler<T>](#axishandlert),[MainComponentHandler<T>](#maincomponenthandlert) + |public method|since|description| |--|--|--| |CheckComponent()||public virtual void CheckComponent(StringBuilder sb) { }| @@ -717,10 +804,12 @@ Inherits or Implemented: [ListFor](#listfor) ## MainComponentHandler<T> -Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) +> XCharts.Runtime.MainComponentHandler<T> : [MainComponentHandler](#maincomponenthandler) ## MathUtil +> XCharts.Runtime.MathUtil + |public method|since|description| |--|--|--| |Abs()||public static double Abs(double d)| @@ -733,7 +822,7 @@ Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) ## ObjectPool<T> where T -Inherits or Implemented: [new()](#new()) +> XCharts.Runtime.ObjectPool<T> where T : [new()](#new()) |public method|since|description| |--|--|--| @@ -745,7 +834,7 @@ 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| |--|--|--| @@ -757,26 +846,28 @@ 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| @@ -786,14 +877,16 @@ 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)| @@ -805,7 +898,7 @@ 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| |--|--|--| @@ -815,10 +908,12 @@ 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()| @@ -830,11 +925,12 @@ Inherits or Implemented: [BaseChart](#basechart) ## ScatterChart -Inherits or Implemented: [BaseChart](#basechart) +> XCharts.Runtime.ScatterChart : [BaseChart](#basechart) ## SerieComponentAttribute -Inherits or Implemented: [Attribute](#attribute) +> XCharts.Runtime.SerieComponentAttribute : [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute) +The attribute for serie component. |public method|since|description| |--|--|--| @@ -851,9 +947,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) +The attribute for which serie types can be converted to. |public method|since|description| |--|--|--| @@ -866,7 +965,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) +The attribute for serie data component. |public method|since|description| |--|--|--| @@ -883,13 +983,15 @@ 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| |--|--|--| @@ -905,12 +1007,17 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieEventData +> XCharts.Runtime.SerieEventData +the data of serie event. + |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)| @@ -918,6 +1025,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieHandler +> XCharts.Runtime.SerieHandler + |public method|since|description| |--|--|--| |CheckComponent()||public virtual void CheckComponent(StringBuilder sb) { }| @@ -944,9 +1053,13 @@ Inherits or Implemented: [Attribute](#attribute) |Update()||public virtual void Update() { }| |UpdateSerieContext()||public virtual void UpdateSerieContext() { }| +## SerieHandler where T + +> .SerieHandler where T / Subclasses: [SerieHandler<T>](#seriehandlert) + ## SerieHandler<T> -Inherits or Implemented: [SerieHandler where T](#seriehandler where t),[Serie](#serie) +> XCharts.Runtime.SerieHandler<T> : [SerieHandler where T](#seriehandler where t),[Serie](#serie) |public method|since|description| |--|--|--| @@ -971,7 +1084,7 @@ 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| |--|--|--| @@ -980,6 +1093,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| @@ -1022,6 +1137,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieLabelHelper +> XCharts.Runtime.SerieLabelHelper + |public method|since|description| |--|--|--| |AvoidLabelOverlap()||public static void AvoidLabelOverlap(Serie serie, ComponentTheme theme)| @@ -1033,6 +1150,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieLabelPool +> XCharts.Runtime.SerieLabelPool + |public method|since|description| |--|--|--| |ClearAll()||public static void ClearAll()| @@ -1041,8 +1160,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。 | @@ -1061,19 +1184,19 @@ 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| |--|--|--| @@ -1081,6 +1204,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SVG +> XUGL.SVG + |public method|since|description| |--|--|--| |DrawPath()||public static void DrawPath(VertexHelper vh, string path)| @@ -1089,10 +1214,12 @@ 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)| @@ -1101,16 +1228,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)| @@ -1120,6 +1255,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)| @@ -1132,8 +1269,13 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## TooltipViewItem +> XCharts.Runtime.TooltipViewItem + ## UGL +> XUGL.UGL +UGUI Graphics Library. + |public method|since|description| |--|--|--| |DrawDiamond()||public static void DrawDiamond(VertexHelper vh, Vector3 center, float size, Color32 color)
Draw a diamond. 画菱形（钻石形状） | @@ -1155,10 +1297,12 @@ 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度） | @@ -1166,6 +1310,7 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) |GetBezier2()||public static Vector3 GetBezier2(float t, Vector3 sp, Vector3 p1, Vector3 p2, Vector3 ep)| |GetBezierList()||public static List<Vector3> GetBezierList(Vector3 sp, Vector3 ep, int segment, Vector3 cp)| |GetDire()||public static Vector3 GetDire(float angle, bool isDegree = false)| +|GetIntersection()||public static bool GetIntersection(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4, ref List<Vector3> intersection)
获得两直线的交点 | |GetIntersection()||public static bool GetIntersection(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4, ref Vector3 intersection)
获得两直线的交点 | |GetPos()||public static Vector3 GetPos(Vector3 center, float radius, float angle, bool isDegree = false)| |GetVertialDire()||public static Vector3 GetVertialDire(Vector3 dire)| @@ -1186,7 +1331,8 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## UIComponent -Inherits or Implemented: [BaseGraph](#basegraph) +> XCharts.Runtime.UIComponent : [BaseGraph](#basegraph) +UI组件基类。 |public method|since|description| |--|--|--| @@ -1194,16 +1340,21 @@ Inherits or Implemented: [BaseGraph](#basegraph) ## UIHelper +> XCharts.Runtime.UIHelper +UI帮助类。 + |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)| @@ -1215,6 +1366,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## XChartsMgr +> XCharts.Runtime.XChartsMgr + |public method|since|description| |--|--|--| |AddChart()||public static void AddChart(BaseChart chart)| @@ -1230,7 +1383,7 @@ 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| |--|--|--| @@ -1238,6 +1391,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~/en/changelog.md b/Documentation~/en/changelog.md index 89ae3019..f3efe7ea 100644 --- a/Documentation~/en/changelog.md +++ b/Documentation~/en/changelog.md @@ -2,6 +2,7 @@ # 更新日志 [master](#master) +[v3.7.0](#v370) [v3.6.0](#v360) [v3.5.0](#v350) [v3.4.0](#v340) @@ -61,6 +62,34 @@ ## master +## v3.7.0 + +Highlights: + +* Added `HelpDoc` official website help document redirection +* Added support for `Clip` for `Line` +* Optimize the range Settings of `Axis` +* Other optimizations and fixes + +Log details: + +* (2022.06.08) Release v3.7.0 +* (2023.06.04) Added `HelpDoc` help document skip +* (2023.05.30) Fix to Serie name with `_` line causing `Legend` to not fire (#252) (by __svr2kos2__) +* (2023.05.10) Added `MinMaxAuto` range type for `Axis` +* (2023.05.10) Added support for `Clip` for `Line` +* (2023.05.04) Fixed `Axis` setting` CeilRate `not taking effect in range -1 to 1 +* (2023.05.04) Optimizes MinMax type range calculations for Axis +* (2023.05.04) Fix to AxisLabel displaying `Label` formatting incorrectly when the data is all floating point numbers less than 1 +* (2023.05.04) Fix to `Theme` being reset after modifying default theme parameters +* (2023.05.04) Added `Warning` when `Symbol` selects `Custom` type +* (2023.04.15) Fix to `DataZoom` may be abnormal in multiple charts (#252) +* (2023.04.14) Fix to `Tooltip` may be abnormal when there is only one data +* (2023.04.14) added `BaseChart`s `TriggerTooltip()` interface to try to trigger `ToolTip` +* (2023.04.12) Optimizes` RadarCood `setting` startAngle `with text following the adjustment position +* (2023.04.12) Added `Radar` support for wildcard `{b}` +* (2023.04.11) Fixed an issue where Inspector could be abnormal when dynamically adding components + ## v3.6.0 * (2023.04.01) Release `v3.6.0` version diff --git a/Documentation~/en/configuration.md b/Documentation~/en/configuration.md index 450da862..ddf8328e 100644 --- a/Documentation~/en/configuration.md +++ b/Documentation~/en/configuration.md @@ -2,6 +2,7 @@ sidebar_position: 31 slug: /configuration --- +import APITable from '@site/src/components/APITable'; # Chart Configuration @@ -163,13 +164,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 +188,38 @@ slug: /configuration ## AngleAxis -Inherits or Implemented: [Axis](#axis) +> XCharts.Runtime.AngleAxis : [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) - +> XCharts.Runtime.AngleAxisTheme : [BaseAxisTheme](#baseaxistheme) ## AnimationStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> XCharts.Runtime.AnimationStyle : [ChildComponent](#childcomponent) the animation of serie. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |enable|true||Whether to enable animation. @@ -214,12 +235,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) +> XCharts.Runtime.AreaStyle : [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 +260,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) +> XCharts.Runtime.ArrowStyle : [ChildComponent](#childcomponent) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -242,17 +281,26 @@ 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) +> XCharts.Runtime.Axis : [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. |type|||the type of axis.
`Axis.AxisType`:
- `Value`: Numerical axis, suitable for continuous data.
- `Category`: Category axis, suitable for discrete category data. Data should only be set via data for this type.
- `Log`: Log axis, suitable for log data.
- `Time`: Time axis, suitable for continuous time series data.
| -|minMaxType|||the type of axis minmax.
`Axis.AxisMinMaxType`:
- `Default`: 0 - maximum.
- `MinMax`: minimum - maximum.
- `Custom`: Customize the minimum and maximum.
| +|minMaxType|||the type of axis minmax.
`Axis.AxisMinMaxType`:
- `Default`: 0 - maximum.
- `MinMax`: minimum - maximum.
- `Custom`: Customize the minimum and maximum.
- `MinMaxAuto`: [since("v3.7.0")]minimum - maximum, automatically calculate the appropriate values.
| |gridIndex|||The index of the grid on which the axis are located, by default, is in the first grid. |polarIndex|||The index of the polar on which the axis are located, by default, is in the first polar. |parallelIndex|||The index of the parallel on which the axis are located, by default, is in the first parallel. @@ -282,12 +330,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) +> XCharts.Runtime.AxisLabel : [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 +355,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) +> XCharts.Runtime.AxisLine : [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) +> XCharts.Runtime.AxisMinorSplitLine : [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) +> XCharts.Runtime.AxisMinorTick : [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) +> XCharts.Runtime.AxisName : [ChildComponent](#childcomponent) the name of axis. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|||Whether to show axis name. @@ -349,23 +442,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) +> XCharts.Runtime.AxisSplitArea : [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) +> XCharts.Runtime.AxisSplitLine : [BaseLine](#baseline) Split line of axis in grid area. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |interval|||Interval of Axis splitLine. @@ -374,17 +485,25 @@ 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) - +> XCharts.Runtime.AxisTheme : [BaseAxisTheme](#baseaxistheme) ## AxisTick -Inherits or Implemented: [BaseLine](#baseline) +> XCharts.Runtime.AxisTick : [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 +514,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) +> XCharts.Runtime.Background : [MainComponent](#maincomponent) Background component. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||Whether to enable the background component. @@ -409,14 +537,22 @@ 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) - +> XCharts.Runtime.Bar : [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) ## BaseAxisTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) +> XCharts.Runtime.BaseAxisTheme : [ComponentTheme](#componenttheme) / Subclasses: [AxisTheme](#axistheme), [RadiusAxisTheme](#radiusaxistheme), [AngleAxisTheme](#angleaxistheme), [PolarAxisTheme](#polaraxistheme), [RadarAxisTheme](#radaraxistheme) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -434,56 +570,73 @@ 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) +> XCharts.Runtime.BaseLine : [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) - +> XCharts.Runtime.BaseScatter : [Serie](#serie), [INeedSerieContainer](#ineedseriecontainer) / Subclasses: [EffectScatter](#effectscatter), [Scatter](#scatter) ## BaseSerie +> XCharts.Runtime.BaseSerie / Subclasses: [Serie](#serie) ## BlurStyle -Inherits or Implemented: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> XCharts.Runtime.BlurStyle : [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) > Since `v3.2.0` Configurations of blur state. - ## 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 / 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) +> XCharts.Runtime.Comment : [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 +644,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) +> XCharts.Runtime.CommentItem : [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 +668,38 @@ 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) +> XCharts.Runtime.CommentMarkStyle : [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) +> XCharts.Runtime.ComponentTheme : [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 +709,27 @@ 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) +> XCharts.Runtime.CoordSystem : [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) +> XCharts.Runtime.DataZoom : [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. @@ -567,7 +755,7 @@ DataZoom component is used for zooming a specific area, which enables user to in |rangeMode|||Use absolute value or percent value in DataZoom.start and DataZoom.end.
`DataZoom.RangeMode`:
- `//Value`: The value type of start and end.取值类型
- `Percent`: percent value.
| |start|||The start percentage of the window out of the data extent, in the range of 0 ~ 100. |end|||The end percentage of the window out of the data extent, in the range of 0 ~ 100. -|minShowNum|1||Minimum number of display data. Minimum number of data displayed when DataZoom is enlarged to maximum. +|minShowNum|2||Minimum number of display data. Minimum number of data displayed when DataZoom is enlarged to maximum. |scrollSensitivity|1.1f||The sensitivity of dataZoom scroll. The larger the number, the more sensitive it is. |orient|||Specify whether the layout of dataZoom component is horizontal or vertical. What's more, it indicates whether the horizontal axis or vertical axis is controlled by default in catesian coordinate system.
`Orient`:
- `Horizonal`: 水平
- `Vertical`: 垂直
| |labelStyle|||label style. [LabelStyle](#labelstyle)| @@ -577,9 +765,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) +> XCharts.Runtime.DataZoomTheme : [ComponentTheme](#componenttheme) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -591,8 +788,19 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |dataAreaColor|||the color of data area line. |backgroundColor|||the background color of datazoom. +```mdx-code-block + +``` + ## DebugInfo +> XCharts.Runtime.DebugInfo + +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||Whether show debug component. @@ -601,36 +809,52 @@ 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) - +> XCharts.Runtime.EffectScatter : [BaseScatter](#basescatter) ## EmphasisStyle -Inherits or Implemented: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> XCharts.Runtime.EmphasisStyle : [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) - +> XCharts.Runtime.EndLabelStyle : [LabelStyle](#labelstyle) ## GridCoord -Inherits or Implemented: [CoordSystem](#coordsystem),[IUpdateRuntimeData](#iupdateruntimedata),[ISerieContainer](#iseriecontainer) +> XCharts.Runtime.GridCoord : [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 +867,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) +> XCharts.Runtime.Heatmap : [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) +> XCharts.Runtime.IconStyle : [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 +910,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 +933,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#is |width|0||图标宽。 |height|0||图标高。 +```mdx-code-block + +``` + ## Indicator +> 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 +974,51 @@ 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 + +> 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 + +> XCharts.Runtime.IPropertyChanged / Subclasses: [Location](#location), [Comment](#comment), [Legend](#legend), [Title](#title) + +属性变更接口 + +## ISerieComponent + +> 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 + +> XCharts.Runtime.ISerieContainer / Subclasses: [RadarCoord](#radarcoord), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [ParallelCoord](#parallelcoord), [PolarCoord](#polarcoord) + +## ISerieDataComponent + +> 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 + +> XCharts.Runtime.ISimplifiedSerie / Subclasses: [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 +1042,30 @@ 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 + +> XCharts.Runtime.IUpdateRuntimeData / Subclasses: [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||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 +1074,21 @@ 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) +> XCharts.Runtime.LabelStyle : [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 +1107,35 @@ 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) +> XCharts.Runtime.Lang : [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=ScriptableObject) Language. - ## LangCandlestick +> XCharts.Runtime.LangCandlestick ## LangTime +> XCharts.Runtime.LangTime ## Legend -Inherits or Implemented: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged) +> XCharts.Runtime.Legend : [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 +1158,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) +> XCharts.Runtime.LegendTheme : [ComponentTheme](#componenttheme) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| |unableColor|||the color of text. +```mdx-code-block + +``` + ## Level -Inherits or Implemented: [ChildComponent](#childcomponent) +> XCharts.Runtime.Level : [ChildComponent](#childcomponent) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -843,23 +1194,40 @@ 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 +1235,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) +> XCharts.Runtime.LineStyle : [ChildComponent](#childcomponent), [ISerieDataComponent](#iseriedatacomponent) The style of line. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||Whether show line. @@ -884,12 +1261,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) +> XCharts.Runtime.Location : [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 +1284,25 @@ 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) - +> XCharts.Runtime.MainComponent : [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) +> XCharts.Runtime.MarkArea : [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 +1313,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) +> XCharts.Runtime.MarkAreaData : [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 +1338,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) +> XCharts.Runtime.MarkLine : [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 +1360,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) +> XCharts.Runtime.MarkLineData : [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 +1391,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) +> XCharts.Runtime.MarqueeStyle : [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 +1415,21 @@ 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) +> XCharts.Runtime.Padding : [ChildComponent](#childcomponent) / Subclasses: [TextPadding](#textpadding) padding setting of item or text. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||show padding. 是否显示。 @@ -999,22 +1438,29 @@ 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) - +> 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) Grid component. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||Whether to show the grid in rectangular coordinate. @@ -1025,22 +1471,29 @@ 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) - +> 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) 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,62 +1501,73 @@ 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) +> XCharts.Runtime.Radar : [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) - +> 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) Radial axis of polar coordinate. - ## 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) > Since `v3.2.0` Configurations of select state. - ## Serie -Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable) +> XCharts.Runtime.Serie : [BaseSerie](#baseserie), [IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=IComparable) / Subclasses: [SerieHandler<T>](#seriehandlert), [Bar](#bar), [SimplifiedBar](#simplifiedbar), [Candlestick](#candlestick), [SimplifiedCandlestick](#simplifiedcandlestick), [Heatmap](#heatmap), [Line](#line), [SimplifiedLine](#simplifiedline), [Parallel](#parallel), [Pie](#pie), [Radar](#radar), [Ring](#ring), [BaseScatter](#basescatter) + +系列。系列一般由数据和配置组成，用来表示具体的图表图形，如折线图的一条折线，柱图的一组柱子等。一个图表中可以包含多个不同类型的系列。 + +```mdx-code-block + +``` -系列。 |field|default|since|comment| |--|--|--|--| @@ -1113,7 +1577,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 +1624,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 +1642,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) +> XCharts.Runtime.SerieData : [ChildComponent](#childcomponent) A data item of serie. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |index|||the index of SerieData. @@ -1196,12 +1669,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) +> XCharts.Runtime.SerieSymbol : [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 +1697,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) +> XCharts.Runtime.SerieTheme : [ChildComponent](#childcomponent) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -1233,12 +1724,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) 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 +1756,33 @@ 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) - +> 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) 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 +1793,45 @@ Single axis. |width|0||width of axis. |height|50||height of axis. +```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) / 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 +1842,25 @@ the state style of 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) / Subclasses: [SerieSymbol](#seriesymbol) 系列数据项的标记的图形 +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||Whether the symbol is showed. @@ -1343,12 +1874,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |imageType|||the fill type of image. |color|||图形的颜色。 +```mdx-code-block + +``` + ## TextLimit -Inherits or Implemented: [ChildComponent](#childcomponent) +> XCharts.Runtime.TextLimit : [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 +1896,27 @@ 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) +> XCharts.Runtime.TextPadding : [Padding](#padding) Settings related to text. - ## TextStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> XCharts.Runtime.TextStyle : [ChildComponent](#childcomponent) Settings related to text. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||Settings related to text. @@ -1387,12 +1935,21 @@ Settings related to text. |tMPAlignment||| |tMPSpriteAsset||v3.1.0| +```mdx-code-block + +``` + ## Theme -Inherits or Implemented: [ScriptableObject](#scriptableobject) +> XCharts.Runtime.Theme : [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=ScriptableObject) Theme. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |themeType|||the theme of chart.
`ThemeType`:
- `Default`: 默认主题。
- `Light`: 亮主题。
- `Dark`: 暗主题。
- `Custom`: 自定义主题。
| @@ -1412,12 +1969,21 @@ Theme. |visualMap||| [VisualMapTheme](#visualmaptheme)| |serie||| [SerieTheme](#serietheme)| +```mdx-code-block + +``` + ## ThemeStyle -Inherits or Implemented: [ChildComponent](#childcomponent) +> XCharts.Runtime.ThemeStyle : [ChildComponent](#childcomponent) Theme. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true|| @@ -1428,12 +1994,21 @@ Theme. |customBackgroundColor|||the custom background color of chart. |customColorPalette||| +```mdx-code-block + +``` + ## Title -Inherits or Implemented: [MainComponent](#maincomponent),[IPropertyChanged](#ipropertychanged) +> XCharts.Runtime.Title : [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 +2019,31 @@ 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) +> XCharts.Runtime.TitleStyle : [LabelStyle](#labelstyle), [ISerieDataComponent](#iseriedatacomponent), [ISerieComponent](#iseriecomponent) the title of serie. - ## TitleTheme -Inherits or Implemented: [ComponentTheme](#componenttheme) - +> XCharts.Runtime.TitleTheme : [ComponentTheme](#componenttheme) ## Tooltip -Inherits or Implemented: [MainComponent](#maincomponent) +> XCharts.Runtime.Tooltip : [MainComponent](#maincomponent) Tooltip component. +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||Whether to show the tooltip component. @@ -1496,9 +2078,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) +> XCharts.Runtime.TooltipTheme : [ComponentTheme](#componenttheme) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -1509,9 +2100,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) +> XCharts.Runtime.UIComponentTheme : [ChildComponent](#childcomponent) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -1519,12 +2119,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |sharedTheme|||the asset of theme. [Theme](#theme)| |transparentBackground|false|| +```mdx-code-block + +``` + ## VisualMap -Inherits or Implemented: [MainComponent](#maincomponent) +> XCharts.Runtime.VisualMap : [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 +2163,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) +> XCharts.Runtime.VisualMapRange : [ChildComponent](#childcomponent) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -1565,9 +2183,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 +2203,28 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |backgroundColor|||the background color of visualmap. |triangeLen|20f||可视化组件的调节三角形边长。 +```mdx-code-block + +``` + ## XAxis -Inherits or Implemented: [Axis](#axis) +> XCharts.Runtime.XAxis : [Axis](#axis) The x axis in cartesian(rectangular) coordinate. - ## XCResourcesImporter +> XCharts.Runtime.XCResourcesImporter ## XCSettings -Inherits or Implemented: [ScriptableObject](#scriptableobject) +> XCharts.Runtime.XCSettings : [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=ScriptableObject) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -1630,10 +2266,13 @@ Inherits or Implemented: [ScriptableObject](#scriptableobject) |pieSelectedOffset|8f|| |customThemes||| +```mdx-code-block + +``` + ## YAxis -Inherits or Implemented: [Axis](#axis) +> XCharts.Runtime.YAxis : [Axis](#axis) The x axis in cartesian(rectangular) coordinate. - diff --git a/Documentation~/zh/api.md b/Documentation~/zh/api.md index 0b1b60b7..78faadc1 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) @@ -106,6 +113,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 +124,16 @@ slug: /api ## AxisContext -Inherits or Implemented: [MainComponentContext](#maincomponentcontext) +> XCharts.Runtime.AxisContext : [MainComponentContext](#maincomponentcontext) ## AxisHandler<T> -Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) +> XCharts.AxisHandler<T> : [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 +160,11 @@ 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) / 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| |--|--|--| @@ -204,6 +215,7 @@ Inherits or Implemented: [BaseGraph](#basegraph),[ISerializationCallbackReceiver |CanAddChartComponent()||public bool CanAddChartComponent(Type type)| |CanAddSerie()||public bool CanAddSerie(Type type)| |CanAddSerie<T>()||public bool CanAddSerie<T>() where T : Serie| +|CancelTooltip()|v3.7.0|public void CancelTooltip()
取消Tooltip. | |CanMultipleComponent()||public bool CanMultipleComponent(Type type)| |ClampInChart()||public void ClampInChart(ref Vector3 pos)| |ClampInGrid()||public Vector3 ClampInGrid(GridCoord grid, Vector3 pos)| @@ -319,6 +331,8 @@ Inherits or Implemented: [BaseGraph](#basegraph),[ISerializationCallbackReceiver |SetSeriePainterMaterial()||public void SetSeriePainterMaterial(Material material)
设置Serie Painter的材质球 | |SetTopPainterMaterial()||public void SetTopPainterMaterial(Material material)
设置Top Painter的材质球 | |SetUpperPainterMaterial()||public void SetUpperPainterMaterial(Material material)
设置Upper Painter的材质球 | +|TriggerTooltip()|v3.7.0|public bool TriggerTooltip(int dataIndex)
尝试触发指定数据项的Tooltip. | +|TriggerTooltip()|v3.7.0|public bool TriggerTooltip(Vector3 localPosition)
在指定的位置尝试触发Tooltip. | |TryAddChartComponent()||public bool TryAddChartComponent(Type type)| |TryAddChartComponent<T>()||public bool TryAddChartComponent<T>() where T : MainComponent| |TryAddChartComponent<T>()||public bool TryAddChartComponent<T>(out T component) where T : MainComponent| @@ -341,7 +355,7 @@ 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),[](#) / Subclasses: [BaseChart](#basechart),[UIComponent](#uicomponent) |public method|since|description| |--|--|--| @@ -355,6 +369,8 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic),[IPointerDownHandle |onPointerUp||public Action<PointerEventData, BaseGraph> onPointerUp
鼠标弹起回调。 | |onScroll||public Action<PointerEventData, BaseGraph> onScroll
鼠标滚动回调。 | |CheckWarning()||public string CheckWarning()
检测警告信息。 | +|LocalPointToScreenPoint()|v3.7.0|public Vector2 LocalPointToScreenPoint(Vector2 localPoint)
图表内坐标转屏幕坐标。 | +|LocalPointToWorldPoint()|v3.7.0|public Vector2 LocalPointToWorldPoint(Vector2 localPoint)
图表内坐标转世界坐标。 | |OnBeginDrag()||public virtual void OnBeginDrag(PointerEventData eventData)| |OnDrag()||public virtual void OnDrag(PointerEventData eventData)| |OnEndDrag()||public virtual void OnEndDrag(PointerEventData eventData)| @@ -374,10 +390,12 @@ 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)| @@ -389,10 +407,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)| @@ -416,8 +440,10 @@ Inherits or Implemented: [BaseChart](#basechart) |GetFullName()||public static string GetFullName(Transform transform)| |GetHighlightColor()||public static Color32 GetHighlightColor(Color32 color, float rate = 0.8f)| |GetLastValue()||public static Vector3 GetLastValue(List<Vector3> list)| +|GetMaxCeilRate()||public static double GetMaxCeilRate(double value, double ceilRate)| |GetMaxDivisibleValue()||public static double GetMaxDivisibleValue(double max, double ceilRate)| |GetMaxLogValue()||public static double GetMaxLogValue(double value, float logBase, bool isLogBaseE, out int splitNumber)| +|GetMinCeilRate()||public static double GetMinCeilRate(double value, double ceilRate)| |GetMinDivisibleValue()||public static double GetMinDivisibleValue(double min, double ceilRate)| |GetMinLogValue()||public static double GetMinLogValue(double value, float logBase, bool isLogBaseE, out int splitNumber)| |GetOrAddComponent<T>()||public static T GetOrAddComponent<T>(GameObject gameObject) where T : Component| @@ -458,7 +484,7 @@ 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| |--|--|--| @@ -487,12 +513,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)| @@ -500,13 +530,15 @@ 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| |--|--|--| @@ -515,6 +547,8 @@ Inherits or Implemented: [Attribute](#attribute) ## ComponentHelper +> XCharts.Runtime.ComponentHelper + |public method|since|description| |--|--|--| |GetAngleAxis()||public static AngleAxis GetAngleAxis(List<MainComponent> components, int polarIndex)| @@ -525,7 +559,7 @@ 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| |--|--|--| @@ -537,10 +571,12 @@ 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)| @@ -548,6 +584,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## DateTimeUtil +> XCharts.Runtime.DateTimeUtil + |public method|since|description| |--|--|--| |GetDateTime()||public static DateTime GetDateTime(int timestamp)| @@ -556,7 +594,7 @@ 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| |--|--|--| @@ -564,6 +602,8 @@ Inherits or Implemented: [Attribute](#attribute) ## DefineSymbolsUtil +> XCharts.Runtime.DefineSymbolsUtil + |public method|since|description| |--|--|--| |AddGlobalDefine()||public static void AddGlobalDefine(string symbol)| @@ -571,6 +611,8 @@ Inherits or Implemented: [Attribute](#attribute) ## FormatterHelper +> XCharts.Runtime.FormatterHelper + |public method|since|description| |--|--|--| |NeedFormat()||public static bool NeedFormat(string content)| @@ -581,22 +623,28 @@ 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 / Subclasses: [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)| @@ -604,6 +652,8 @@ Inherits or Implemented: [Attribute](#attribute) ## InteractData +> XCharts.Runtime.InteractData + |public method|since|description| |--|--|--| |Reset()||public void Reset()| @@ -618,8 +668,37 @@ 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 / Subclasses: [Location](#location),[Comment](#comment),[Legend](#legend),[Title](#title) +属性变更接口 + +## ISerieComponent + +> XCharts.Runtime.ISerieComponent / Subclasses: [AreaStyle](#areastyle),[ImageStyle](#imagestyle),[LineArrow](#linearrow),[LabelLine](#labelline),[LabelStyle](#labelstyle),[BlurStyle](#blurstyle),[EmphasisStyle](#emphasisstyle),[SelectStyle](#selectstyle),[TitleStyle](#titlestyle) +可用于Serie的组件。 + +## ISerieContainer + +> XCharts.Runtime.ISerieContainer / Subclasses: [RadarCoord](#radarcoord),[CalendarCoord](#calendarcoord),[GridCoord](#gridcoord),[ParallelCoord](#parallelcoord),[PolarCoord](#polarcoord) + +## ISerieDataComponent + +> 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) +可用于SerieData的组件。 + +## ISimplifiedSerie + +> XCharts.Runtime.ISimplifiedSerie / Subclasses: [SimplifiedBar](#simplifiedbar),[SimplifiedCandlestick](#simplifiedcandlestick),[SimplifiedLine](#simplifiedline) + +## IUpdateRuntimeData + +> XCharts.Runtime.IUpdateRuntimeData / Subclasses: [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)| @@ -627,10 +706,12 @@ 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)| @@ -642,6 +723,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## LegendItem +> XCharts.Runtime.LegendItem + |public method|since|description| |--|--|--| |GetIconColor()||public Color GetIconColor()| @@ -665,11 +748,11 @@ 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) / Subclasses: [ListForComponent](#listforcomponent),[ListForSerie](#listforserie) |public method|since|description| |--|--|--| @@ -677,7 +760,7 @@ Inherits or Implemented: [Attribute](#attribute) ## ListForComponent -Inherits or Implemented: [ListFor](#listfor) +> XCharts.Runtime.ListForComponent : [ListFor](#listfor) |public method|since|description| |--|--|--| @@ -685,7 +768,7 @@ Inherits or Implemented: [ListFor](#listfor) ## ListForSerie -Inherits or Implemented: [ListFor](#listfor) +> XCharts.Runtime.ListForSerie : [ListFor](#listfor) |public method|since|description| |--|--|--| @@ -693,8 +776,12 @@ Inherits or Implemented: [ListFor](#listfor) ## MainComponentContext +> XCharts.Runtime.MainComponentContext / Subclasses: [AxisContext](#axiscontext),[DataZoomContext](#datazoomcontext),[LegendContext](#legendcontext),[RadarCoordContext](#radarcoordcontext),[VisualMapContext](#visualmapcontext),[GridCoordContext](#gridcoordcontext),[ParallelCoordContext](#parallelcoordcontext),[PolarCoordContext](#polarcoordcontext) + ## MainComponentHandler +> XCharts.Runtime.MainComponentHandler / Subclasses: [AxisHandler<T>](#axishandlert),[MainComponentHandler<T>](#maincomponenthandlert) + |public method|since|description| |--|--|--| |CheckComponent()||public virtual void CheckComponent(StringBuilder sb) { }| @@ -717,10 +804,12 @@ Inherits or Implemented: [ListFor](#listfor) ## MainComponentHandler<T> -Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) +> XCharts.Runtime.MainComponentHandler<T> : [MainComponentHandler](#maincomponenthandler) ## MathUtil +> XCharts.Runtime.MathUtil + |public method|since|description| |--|--|--| |Abs()||public static double Abs(double d)| @@ -733,7 +822,7 @@ Inherits or Implemented: [MainComponentHandler](#maincomponenthandler) ## ObjectPool<T> where T -Inherits or Implemented: [new()](#new()) +> XCharts.Runtime.ObjectPool<T> where T : [new()](#new()) |public method|since|description| |--|--|--| @@ -745,7 +834,7 @@ 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| |--|--|--| @@ -757,26 +846,28 @@ 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| @@ -786,14 +877,16 @@ 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)| @@ -805,7 +898,7 @@ 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| |--|--|--| @@ -815,10 +908,12 @@ 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()| @@ -830,11 +925,12 @@ Inherits or Implemented: [BaseChart](#basechart) ## ScatterChart -Inherits or Implemented: [BaseChart](#basechart) +> XCharts.Runtime.ScatterChart : [BaseChart](#basechart) ## SerieComponentAttribute -Inherits or Implemented: [Attribute](#attribute) +> XCharts.Runtime.SerieComponentAttribute : [Attribute](https://docs.unity3d.com/ScriptReference/30_search.html?q=attribute) +可添加到Serie的组件。 |public method|since|description| |--|--|--| @@ -851,9 +947,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) +可转化为哪些Serie类型。 |public method|since|description| |--|--|--| @@ -866,7 +965,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) +可添加到SerieData的组件。 |public method|since|description| |--|--|--| @@ -883,13 +983,15 @@ 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| |--|--|--| @@ -905,12 +1007,17 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieEventData +> XCharts.Runtime.SerieEventData +serie事件的数据。 + |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)| @@ -918,6 +1025,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieHandler +> XCharts.Runtime.SerieHandler + |public method|since|description| |--|--|--| |CheckComponent()||public virtual void CheckComponent(StringBuilder sb) { }| @@ -944,9 +1053,13 @@ Inherits or Implemented: [Attribute](#attribute) |Update()||public virtual void Update() { }| |UpdateSerieContext()||public virtual void UpdateSerieContext() { }| +## SerieHandler where T + +> .SerieHandler where T / Subclasses: [SerieHandler<T>](#seriehandlert) + ## SerieHandler<T> -Inherits or Implemented: [SerieHandler where T](#seriehandler where t),[Serie](#serie) +> XCharts.Runtime.SerieHandler<T> : [SerieHandler where T](#seriehandler where t),[Serie](#serie) |public method|since|description| |--|--|--| @@ -971,7 +1084,7 @@ 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| |--|--|--| @@ -980,6 +1093,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| @@ -1022,6 +1137,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieLabelHelper +> XCharts.Runtime.SerieLabelHelper + |public method|since|description| |--|--|--| |AvoidLabelOverlap()||public static void AvoidLabelOverlap(Serie serie, ComponentTheme theme)| @@ -1033,6 +1150,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SerieLabelPool +> XCharts.Runtime.SerieLabelPool + |public method|since|description| |--|--|--| |ClearAll()||public static void ClearAll()| @@ -1041,8 +1160,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。 | @@ -1061,19 +1184,19 @@ 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| |--|--|--| @@ -1081,6 +1204,8 @@ Inherits or Implemented: [Attribute](#attribute) ## SVG +> XUGL.SVG + |public method|since|description| |--|--|--| |DrawPath()||public static void DrawPath(VertexHelper vh, string path)| @@ -1089,10 +1214,12 @@ 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)| @@ -1101,16 +1228,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)| @@ -1120,6 +1255,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)| @@ -1132,8 +1269,13 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## TooltipViewItem +> XCharts.Runtime.TooltipViewItem + ## UGL +> XUGL.UGL +UGUI 图形库 + |public method|since|description| |--|--|--| |DrawDiamond()||public static void DrawDiamond(VertexHelper vh, Vector3 center, float size, Color32 color)
Draw a diamond. 画菱形（钻石形状） | @@ -1155,10 +1297,12 @@ 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度） | @@ -1166,6 +1310,7 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) |GetBezier2()||public static Vector3 GetBezier2(float t, Vector3 sp, Vector3 p1, Vector3 p2, Vector3 ep)| |GetBezierList()||public static List<Vector3> GetBezierList(Vector3 sp, Vector3 ep, int segment, Vector3 cp)| |GetDire()||public static Vector3 GetDire(float angle, bool isDegree = false)| +|GetIntersection()||public static bool GetIntersection(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4, ref List<Vector3> intersection)
获得两直线的交点 | |GetIntersection()||public static bool GetIntersection(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4, ref Vector3 intersection)
获得两直线的交点 | |GetPos()||public static Vector3 GetPos(Vector3 center, float radius, float angle, bool isDegree = false)| |GetVertialDire()||public static Vector3 GetVertialDire(Vector3 dire)| @@ -1186,7 +1331,8 @@ Inherits or Implemented: [MaskableGraphic](#maskablegraphic) ## UIComponent -Inherits or Implemented: [BaseGraph](#basegraph) +> XCharts.Runtime.UIComponent : [BaseGraph](#basegraph) +UI组件基类。 |public method|since|description| |--|--|--| @@ -1194,16 +1340,21 @@ Inherits or Implemented: [BaseGraph](#basegraph) ## UIHelper +> XCharts.Runtime.UIHelper +UI帮助类。 + |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)| @@ -1215,6 +1366,8 @@ Inherits or Implemented: [MainComponentContext](#maincomponentcontext) ## XChartsMgr +> XCharts.Runtime.XChartsMgr + |public method|since|description| |--|--|--| |AddChart()||public static void AddChart(BaseChart chart)| @@ -1230,7 +1383,7 @@ 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| |--|--|--| @@ -1238,6 +1391,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/changelog.md b/Documentation~/zh/changelog.md index 7df3f802..06875db3 100644 --- a/Documentation~/zh/changelog.md +++ b/Documentation~/zh/changelog.md @@ -6,7 +6,7 @@ slug: /changelog # 更新日志 [master](#master) -[v3.6.0](#v360) +[v3.7.0](#v370) [v3.5.0](#v350) [v3.4.0](#v340) [v3.3.0](#v330) @@ -66,6 +66,34 @@ slug: /changelog ## master +## v3.7.0 + +版本要点： + +* 增加`HelpDoc`官网帮助文档跳转 +* 增加`Line`对`Clip`的支持 +* 优化`Axis`的范围设置 +* 其他优化和修复 + +日志详情： + +* (2023.06.08) 发布`v3.7.0`版本 +* (2023.06.04) 增加`HelpDoc`帮助文档跳转 +* (2023.05.30) 修复`Serie`的名字带`_`线导致`Legend`无法触发的问题 (#259) (by __svr2kos2__) +* (2023.05.10) 增加`Axis`的`MinMaxAuto`范围类型 +* (2023.05.10) 增加`Line`对`Clip`的支持 +* (2023.05.04) 优化`Axis`在-1到1范围时设置`CeilRate`不生效的问题 +* (2023.05.04) 优化`Axis`的`MinMax`类型范围计算 +* (2023.05.04) 修复`AxisLabel`在数据都是小于1的浮点数时显示`Label`格式不对的问题 +* (2023.05.04) 修复`Theme`在修改默认主题的参数后运行被重置的问题 +* (2023.05.04) 增加`Symbol`选择`Custom`类型时的`Warning`提示 +* (2023.04.15) 修复`DataZoom`在多个图表时可能异常的问题 (#252) +* (2023.04.14) 修复`Tooltip`在只有一个数据时可能异常的问题 +* (2023.04.14) 增加`BaseChart`的`TriggerTooltip()`接口尝试触发`ToolTip` +* (2023.04.12) 优化`RadarCood`设置`startAngle`时文本也跟随调整位置 +* (2023.04.12) 增加`Radar`对通配符`{b}`的支持 +* (2023.04.11) 修复`Inspector`在动态添加组件时可能异常的问题 + ## v3.6.0 版本要点： diff --git a/Documentation~/zh/configuration.md b/Documentation~/zh/configuration.md index 959eb8ad..13874920 100644 --- a/Documentation~/zh/configuration.md +++ b/Documentation~/zh/configuration.md @@ -2,6 +2,7 @@ sidebar_position: 31 slug: /configuration --- +import APITable from '@site/src/components/APITable'; # 配置项手册 @@ -163,13 +164,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 +188,38 @@ 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 +235,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 +260,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,17 +281,26 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |dent|3||箭头的凹度。 |color|Color.clear||箭头颜色。 +```mdx-code-block + +``` + ## Axis -Inherits or Implemented: [MainComponent](#maincomponent) +> XCharts.Runtime.Axis : [MainComponent](#maincomponent) / Subclasses: [AngleAxis](#angleaxis), [ParallelAxis](#parallelaxis), [RadiusAxis](#radiusaxis), [SingleAxis](#singleaxis), [XAxis](#xaxis), [YAxis](#yaxis) 直角坐标系的坐标轴组件。 +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||是否显示坐标轴。 |type|||坐标轴类型。
`Axis.AxisType`:
- `Value`: 数值轴。适用于连续数据。
- `Category`: 类目轴。适用于离散的类目数据，为该类型时必须通过 data 设置类目数据。serie的数据第0维数据对应坐标轴data的index。
- `Log`: 对数轴。适用于对数数据。
- `Time`: 时间轴。适用于连续的时序数据。
| -|minMaxType|||坐标轴刻度最大最小值显示类型。
`Axis.AxisMinMaxType`:
- `Default`: 0-最大值。
- `MinMax`: 最小值-最大值。
- `Custom`: 自定义最小值最大值。
| +|minMaxType|||坐标轴刻度最大最小值显示类型。
`Axis.AxisMinMaxType`:
- `Default`: 0-最大值。
- `MinMax`: 最小值-最大值。
- `Custom`: 自定义最小值最大值。
- `MinMaxAuto`: [since("v3.7.0")]最小值-最大值。自动计算合适的值。
| |gridIndex|||坐标轴所在的 grid 的索引，默认位于第一个 grid。 |polarIndex|||坐标轴所在的 ploar 的索引，默认位于第一个 polar。 |parallelIndex|||坐标轴所在的 parallel 的索引，默认位于第一个 parallel。 @@ -282,12 +330,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 +355,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 +442,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 +485,25 @@ 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 +514,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 +537,22 @@ 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) / Subclasses: [AxisTheme](#axistheme), [RadiusAxisTheme](#radiusaxistheme), [AngleAxisTheme](#angleaxistheme), [PolarAxisTheme](#polaraxistheme), [RadarAxisTheme](#radaraxistheme) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -434,56 +570,73 @@ Inherits or Implemented: [ComponentTheme](#componenttheme) |tickColor|||坐标轴线颜色。 |splitAreaColors|||坐标轴分隔区域的颜色。 +```mdx-code-block + +``` + ## BaseLine -Inherits or Implemented: [ChildComponent](#childcomponent) +> XCharts.Runtime.BaseLine : [ChildComponent](#childcomponent) / Subclasses: [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) / Subclasses: [EffectScatter](#effectscatter), [Scatter](#scatter) ## BaseSerie +> XCharts.Runtime.BaseSerie / Subclasses: [Serie](#serie) ## BlurStyle -Inherits or Implemented: [StateStyle](#statestyle),[ISerieComponent](#iseriecomponent),[ISerieDataComponent](#iseriedatacomponent) +> XCharts.Runtime.BlurStyle : [StateStyle](#statestyle), [ISerieComponent](#iseriecomponent), [ISerieDataComponent](#iseriedatacomponent) > 从 `v3.2.0` 开始支持 淡出状态样式。 - ## 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 / 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) +> XCharts.Runtime.Comment : [MainComponent](#maincomponent), [IPropertyChanged](#ipropertychanged) 图表注解组件。 +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||是否显示注解组件。 @@ -491,12 +644,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 +668,38 @@ 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) / Subclasses: [BaseAxisTheme](#baseaxistheme), [DataZoomTheme](#datazoomtheme), [LegendTheme](#legendtheme), [SubTitleTheme](#subtitletheme), [TitleTheme](#titletheme), [TooltipTheme](#tooltiptheme), [VisualMapTheme](#visualmaptheme) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -529,19 +709,27 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |fontSize|18||文本字体大小。 |tMPFont|||字体。 +```mdx-code-block + +``` + ## CoordSystem -Inherits or Implemented: [MainComponent](#maincomponent) +> XCharts.Runtime.CoordSystem : [MainComponent](#maincomponent) / Subclasses: [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||是否显示缩放区域。 @@ -567,7 +755,7 @@ DataZoom 组件 用于区域缩放，从而能自由关注细节的数据信息 |rangeMode|||取绝对值还是百分比。
`DataZoom.RangeMode`:
- `//Value`: The value type of start and end.取值类型
- `Percent`: 百分比。
| |start|||数据窗口范围的起始百分比。范围是：0 ~ 100。 |end|||数据窗口范围的结束百分比。范围是：0 ~ 100。 -|minShowNum|1||最小显示数据个数。当DataZoom放大到最大时，最小显示的数据个数。 +|minShowNum|2||最小显示数据个数。当DataZoom放大到最大时，最小显示的数据个数。 |scrollSensitivity|1.1f||缩放区域组件的敏感度。值越高每次缩放所代表的数据越多。 |orient|||布局方式是横还是竖。不仅是布局方式，对于直角坐标系而言，也决定了，缺省情况控制横向数轴还是纵向数轴。
`Orient`:
- `Horizonal`: 水平
- `Vertical`: 垂直
| |labelStyle|||文本标签格式。 [LabelStyle](#labelstyle)| @@ -577,9 +765,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 +788,19 @@ 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 +809,52 @@ 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 +867,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 +910,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 +933,21 @@ 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 +974,51 @@ Inherits or Implemented: [ChildComponent](#childcomponent),[ISerieComponent](#is |startAngle||v3.4.0|起始角度。和时钟一样，12点钟位置是0度，顺时针到360度。 |indicatorList|||指示器列表。 +```mdx-code-block + +``` + +## INeedSerieContainer + +> 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 + +> XCharts.Runtime.IPropertyChanged / Subclasses: [Location](#location), [Comment](#comment), [Legend](#legend), [Title](#title) + +属性变更接口 + +## ISerieComponent + +> XCharts.Runtime.ISerieComponent / Subclasses: [AreaStyle](#areastyle), [ImageStyle](#imagestyle), [LineArrow](#linearrow), [LabelLine](#labelline), [LabelStyle](#labelstyle), [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle), [TitleStyle](#titlestyle) + +可用于Serie的组件。 + +## ISerieContainer + +> XCharts.Runtime.ISerieContainer / Subclasses: [RadarCoord](#radarcoord), [CalendarCoord](#calendarcoord), [GridCoord](#gridcoord), [ParallelCoord](#parallelcoord), [PolarCoord](#polarcoord) + +## ISerieDataComponent + +> 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) + +可用于SerieData的组件。 + +## ISimplifiedSerie + +> XCharts.Runtime.ISimplifiedSerie / Subclasses: [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 +1042,30 @@ 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 / Subclasses: [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 +1074,21 @@ 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) / Subclasses: [AxisLabel](#axislabel), [EndLabelStyle](#endlabelstyle), [TitleStyle](#titlestyle) 图形上的文本标签，可用于说明图形的一些数据信息，比如值，名称等。 +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||是否显示文本标签。 @@ -784,25 +1107,35 @@ 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](https://docs.unity3d.com/ScriptReference/30_search.html?q=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 +1158,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 +1194,40 @@ 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 +1235,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 +1261,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 +1284,25 @@ 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) / 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) +> XCharts.Runtime.MarkArea : [MainComponent](#maincomponent) 图表标域，常用于标记图表中某个范围的数据。 +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||是否显示标域。 @@ -919,12 +1313,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 +1338,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 +1360,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 +1391,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 +1415,21 @@ 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) / Subclasses: [TextPadding](#textpadding) 边距设置。 +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||show padding. 是否显示。 @@ -999,22 +1438,29 @@ 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 +1471,29 @@ 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,62 +1501,73 @@ 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` 开始支持 选中状态样式。 - ## Serie -Inherits or Implemented: [BaseSerie](#baseserie),[IComparable](#icomparable) +> XCharts.Runtime.Serie : [BaseSerie](#baseserie), [IComparable](https://docs.unity3d.com/ScriptReference/30_search.html?q=IComparable) / Subclasses: [SerieHandler<T>](#seriehandlert), [Bar](#bar), [SimplifiedBar](#simplifiedbar), [Candlestick](#candlestick), [SimplifiedCandlestick](#simplifiedcandlestick), [Heatmap](#heatmap), [Line](#line), [SimplifiedLine](#simplifiedline), [Parallel](#parallel), [Pie](#pie), [Radar](#radar), [Ring](#ring), [BaseScatter](#basescatter) + +系列。系列一般由数据和配置组成，用来表示具体的图表图形，如折线图的一条折线，柱图的一组柱子等。一个图表中可以包含多个不同类型的系列。 + +```mdx-code-block + +``` -系列。 |field|default|since|comment| |--|--|--|--| @@ -1113,7 +1577,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 +1628,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 +1642,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 +1669,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 +1697,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 +1724,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 +1756,33 @@ 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 +1793,45 @@ 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) / Subclasses: [BlurStyle](#blurstyle), [EmphasisStyle](#emphasisstyle), [SelectStyle](#selectstyle) > 从 `v3.2.0` 开始支持 Serie的状态样式。Serie的状态有正常，高亮，淡出，选中四种状态。 +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||是否启用高亮样式。 @@ -1319,17 +1842,25 @@ 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) / Subclasses: [SerieSymbol](#seriesymbol) 系列数据项的标记的图形 +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |show|true||是否显示标记。 @@ -1343,12 +1874,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 +1896,27 @@ 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 +1935,21 @@ Inherits or Implemented: [ChildComponent](#childcomponent) |tMPAlignment||| |tMPSpriteAsset||v3.1.0| +```mdx-code-block + +``` + ## Theme -Inherits or Implemented: [ScriptableObject](#scriptableobject) +> XCharts.Runtime.Theme : [ScriptableObject](https://docs.unity3d.com/ScriptReference/30_search.html?q=ScriptableObject) 主题相关配置。 +```mdx-code-block + +``` + + |field|default|since|comment| |--|--|--|--| |themeType|||主题类型。
`ThemeType`:
- `Default`: 默认主题。
- `Light`: 亮主题。
- `Dark`: 暗主题。
- `Custom`: 自定义主题。
| @@ -1412,12 +1969,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 +1994,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 +2019,31 @@ 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 +2078,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 +2100,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 +2119,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 +2163,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 +2183,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 +2203,28 @@ 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](https://docs.unity3d.com/ScriptReference/30_search.html?q=ScriptableObject) + +```mdx-code-block + +``` + |field|default|since|comment| |--|--|--|--| @@ -1630,10 +2266,13 @@ 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/Documentation~/zh/tutorial01.md b/Documentation~/zh/tutorial01.md index 855cac94..2d0732d8 100644 --- a/Documentation~/zh/tutorial01.md +++ b/Documentation~/zh/tutorial01.md @@ -6,6 +6,14 @@ slug: /tutorial01 # 教程：5分钟上手 XCharts 3.0 +> 注：本教程适用XCharts 3.x版本，2.x版本请看 [教程：5分钟上手XCharts 2.0](https://github.com/XCharts-Team/XCharts/blob/2.0/Doc/教程：5分钟上手XCharts.md) + +## 使用 XCharts 前需要掌握什么 + +- 会简单使用Unity +- 了解UGUI，会使用UGUI +- 了解Unity的MonoBehavior脚本用法，知道怎么挂脚本，用代码操作脚本 + ## 获取和导入 XCharts XCharts可通过以下任意一种方式导入到项目： @@ -211,6 +219,8 @@ xAxis.boundaryGap = true; xAxis.type = Axis.AxisType.Category; ``` +> 注：低版本没有`EnsureChartComponent()`接口时，用`GetOrAddChartComponent()` + ### 改Serie的参数 对于新添加的Serie： diff --git a/Editor/ChildComponents/BasePropertyDrawer.cs b/Editor/ChildComponents/BasePropertyDrawer.cs index 77ae7b08..e5574085 100644 --- a/Editor/ChildComponents/BasePropertyDrawer.cs +++ b/Editor/ChildComponents/BasePropertyDrawer.cs @@ -73,6 +73,14 @@ namespace XCharts.Editor return prop.propertyPath + "_" + index; } + protected void AddHelpBox(string message, MessageType type = MessageType.Warning, int line = 2) + { + var offset = EditorGUI.indentLevel * ChartEditorHelper.INDENT_WIDTH; + EditorGUI.HelpBox(new Rect(m_DrawRect.x + offset, m_DrawRect.y, m_DrawRect.width - offset, EditorGUIUtility.singleLineHeight * line), message, type); + for (int i = 0; i < line; i++) + AddSingleLineHeight(); + } + protected void AddSingleLineHeight() { m_Heights[m_KeyName] += EditorGUIUtility.singleLineHeight + EditorGUIUtility.standardVerticalSpacing; diff --git a/Editor/ChildComponents/SerieSymbolDrawer.cs b/Editor/ChildComponents/SerieSymbolDrawer.cs index 31a132e4..47fa5db0 100644 --- a/Editor/ChildComponents/SerieSymbolDrawer.cs +++ b/Editor/ChildComponents/SerieSymbolDrawer.cs @@ -15,10 +15,11 @@ namespace XCharts.Editor if (MakeComponentFoldout(prop, "m_Show", true)) { ++EditorGUI.indentLevel; - var type = (SymbolType) prop.FindPropertyRelative("m_Type").enumValueIndex; + var type = (SymbolType)prop.FindPropertyRelative("m_Type").enumValueIndex; PropertyField(prop, "m_Type"); if (type == SymbolType.Custom) { + AddHelpBox("Custom symbol only work in PictorialBar serie", MessageType.Warning); PropertyField(prop, "m_Image"); PropertyField(prop, "m_ImageType"); PropertyField(prop, "m_Width"); @@ -27,7 +28,7 @@ namespace XCharts.Editor } PropertyField(prop, "m_Gap"); PropertyField(prop, "m_SizeType"); - switch ((SymbolSizeType) prop.FindPropertyRelative("m_SizeType").enumValueIndex) + switch ((SymbolSizeType)prop.FindPropertyRelative("m_SizeType").enumValueIndex) { case SymbolSizeType.Custom: PropertyField(prop, "m_Size"); diff --git a/Editor/ChildComponents/SymbolStyleDrawer.cs b/Editor/ChildComponents/SymbolStyleDrawer.cs index 1ae59e29..edd66978 100644 --- a/Editor/ChildComponents/SymbolStyleDrawer.cs +++ b/Editor/ChildComponents/SymbolStyleDrawer.cs @@ -15,10 +15,11 @@ namespace XCharts.Editor if (MakeComponentFoldout(prop, "m_Show", true)) { ++EditorGUI.indentLevel; - var type = (SymbolType) prop.FindPropertyRelative("m_Type").enumValueIndex; + var type = (SymbolType)prop.FindPropertyRelative("m_Type").enumValueIndex; PropertyField(prop, "m_Type"); if (type == SymbolType.Custom) { + AddHelpBox("Custom Symbol only work in PictorialBar serie", MessageType.Warning); PropertyField(prop, "m_Image"); PropertyField(prop, "m_ImageType"); PropertyField(prop, "m_Width"); diff --git a/Editor/MainComponents/MainComponentListEditor.cs b/Editor/MainComponents/MainComponentListEditor.cs index 97ca4c14..751904d7 100644 --- a/Editor/MainComponents/MainComponentListEditor.cs +++ b/Editor/MainComponents/MainComponentListEditor.cs @@ -2,6 +2,7 @@ using System; using System.Collections.Generic; using System.Linq; using UnityEditor; +using UnityEngine; using UnityEngine.Assertions; using XCharts.Runtime; @@ -81,8 +82,9 @@ namespace XCharts.Editor title, editor.baseProperty, editor.showProperty, - () => { ResetComponentEditor(id); }, - () => { RemoveComponentEditor(id); } + () => { if (EditorUtility.DisplayDialog("", "Sure reset " + editor.component.GetType().Name + "?", "Yes", "Cancel")) ResetComponentEditor(id); }, + () => { if (EditorUtility.DisplayDialog("", "Sure remove " + editor.component.GetType().Name + "?", "Yes", "Cancel")) RemoveComponentEditor(id); }, + () => { Application.OpenURL("https://xcharts-team.github.io/docs/configuration/#" + editor.component.GetType().Name.ToLower()); } ); if (displayContent) { @@ -102,7 +104,8 @@ namespace XCharts.Editor editor.OnDisable(); m_Editors.Clear(); - for (int i = 0; i < chart.components.Count; i++) + var count = Mathf.Min(chart.components.Count, m_ComponentsProperty.Count); + for (int i = 0; i < count; i++) { if (chart.components[i] != null) { @@ -119,7 +122,7 @@ namespace XCharts.Editor if (!m_EditorTypes.TryGetValue(settingsType, out editorType)) editorType = typeof(MainComponentBaseEditor); - var editor = (MainComponentBaseEditor) Activator.CreateInstance(editorType); + var editor = (MainComponentBaseEditor)Activator.CreateInstance(editorType); editor.Init(chart, component, property, m_BaseEditor); if (index < 0) diff --git a/Editor/Series/LineEditor.cs b/Editor/Series/LineEditor.cs index 95b2e67c..a68b6f4f 100644 --- a/Editor/Series/LineEditor.cs +++ b/Editor/Series/LineEditor.cs @@ -22,7 +22,7 @@ namespace XCharts.Editor { PropertyField("m_SmoothLimit"); } - //PropertyField("m_Clip"); + PropertyField("m_Clip"); PropertyFiledMore(() => { PropertyFieldLimitMin("m_MinShow", 0); diff --git a/Editor/Utilities/ChartEditorHelper.cs b/Editor/Utilities/ChartEditorHelper.cs index 0c0aeb64..3d59a66b 100644 --- a/Editor/Utilities/ChartEditorHelper.cs +++ b/Editor/Utilities/ChartEditorHelper.cs @@ -52,7 +52,7 @@ namespace XCharts.Editor public static void SecondField(Rect drawRect, SerializedProperty prop) { - RectOffset offset = new RectOffset(-(int) EditorGUIUtility.labelWidth, 0, 0, 0); + RectOffset offset = new RectOffset(-(int)EditorGUIUtility.labelWidth, 0, 0, 0); drawRect = offset.Add(drawRect); EditorGUI.PropertyField(drawRect, prop, GUIContent.none); drawRect = offset.Remove(drawRect); @@ -180,8 +180,8 @@ namespace XCharts.Editor if (prop.propertyType == SerializedPropertyType.Boolean) { if (!propEnable) - using(new EditorGUI.DisabledScope(true)) - MakeBool(drawRect, prop); + using (new EditorGUI.DisabledScope(true)) + MakeBool(drawRect, prop); else MakeBool(drawRect, prop); if (prop2 != null && !moduleToggle[key]) @@ -444,7 +444,7 @@ namespace XCharts.Editor if (prop.propertyType == SerializedPropertyType.Float && prop.floatValue < minValue) prop.floatValue = minValue; if (prop.propertyType == SerializedPropertyType.Integer && prop.intValue < minValue) - prop.intValue = (int) minValue; + prop.intValue = (int)minValue; var hig = EditorGUI.GetPropertyHeight(prop); drawRect.y += hig; heights[key] += hig; @@ -459,7 +459,7 @@ namespace XCharts.Editor if (prop.propertyType == SerializedPropertyType.Float && prop.floatValue > maxValue) prop.floatValue = maxValue; if (prop.propertyType == SerializedPropertyType.Integer && prop.intValue > maxValue) - prop.intValue = (int) maxValue; + prop.intValue = (int)maxValue; var hig = EditorGUI.GetPropertyHeight(prop); drawRect.y += hig; heights[key] += hig; @@ -635,11 +635,13 @@ namespace XCharts.Editor } internal static bool DrawHeader(string title, SerializedProperty group, SerializedProperty activeField, - Action resetAction, Action removeAction) + Action resetAction, Action removeAction, Action docAction) { if (group == null) return false; group.isExpanded = DrawHeader(title, group.isExpanded, false, activeField, null, - new HeaderMenuInfo("Reset", resetAction), new HeaderMenuInfo("Remove", removeAction)); + new HeaderMenuInfo("Reset", resetAction), + new HeaderMenuInfo("Remove", removeAction), + new HeaderMenuInfo("HelpDoc", docAction)); return group.isExpanded; } diff --git a/README.md b/README.md index 53fc5420..15f9b36e 100644 --- a/README.md +++ b/README.md @@ -45,15 +45,15 @@ 一款基于`UGUI`的功能强大、简单易用的数据可视化图表插件。支持`折线图`、`柱状图`、`饼图`、`雷达图`、`散点图`、`热力图`、`环形图`、`K线图`、`极坐标`、`平行坐标`等十多种内置图表，以及`3D饼图`、`3D柱图`、`3D金字塔`、`漏斗图`、`仪表盘`、`水位图`、`象形柱图`、`甘特图`、`矩形树图`等扩展图表。 -[XCharts3.0 官方主页](https://xcharts-team.github.io) -[XCharts3.0 在线示例](https://xcharts-team.github.io/examples) +[XCharts3.0 官方主页](https://xcharts-team.github.io) +[XCharts3.0 在线示例](https://xcharts-team.github.io/examples) -[XCharts3.0 教程](Documentation~/zh/tutorial01.md) -[XCharts3.0 API](Documentation~/zh/api.md) -[XCharts3.0 问答](Documentation~/zh/faq.md) -[XCharts3.0 配置项手册](Documentation~/zh/configuration.md) -[XCharts3.0 更新日志](Documentation~/zh/changelog.md) -[XCharts3.0 订阅服务](Documentation~/zh/support.md) +[XCharts3.0 教程：5分钟上手 XCharts](Documentation~/zh/tutorial01.md) +[XCharts3.0 API](Documentation~/zh/api.md) +[XCharts3.0 问答](Documentation~/zh/faq.md) +[XCharts3.0 配置项手册](Documentation~/zh/configuration.md) +[XCharts3.0 更新日志](Documentation~/zh/changelog.md) +[XCharts3.0 订阅服务](Documentation~/zh/support.md) ## 特性 diff --git a/Runtime/Chart/BarChart.cs b/Runtime/Chart/BarChart.cs index a8284f86..77a6aa67 100644 --- a/Runtime/Chart/BarChart.cs +++ b/Runtime/Chart/BarChart.cs @@ -6,6 +6,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class BarChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/CandlestickChart.cs b/Runtime/Chart/CandlestickChart.cs index 62bf4666..34672fc8 100644 --- a/Runtime/Chart/CandlestickChart.cs +++ b/Runtime/Chart/CandlestickChart.cs @@ -6,6 +6,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class CandlestickChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/HeatmapChart.cs b/Runtime/Chart/HeatmapChart.cs index 3bdcda09..d7e4533e 100644 --- a/Runtime/Chart/HeatmapChart.cs +++ b/Runtime/Chart/HeatmapChart.cs @@ -7,6 +7,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class HeatmapChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/LineChart.cs b/Runtime/Chart/LineChart.cs index bc1dc084..d1185871 100644 --- a/Runtime/Chart/LineChart.cs +++ b/Runtime/Chart/LineChart.cs @@ -6,6 +6,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class LineChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/ParallelChart.cs b/Runtime/Chart/ParallelChart.cs index 63abdf69..7552546b 100644 --- a/Runtime/Chart/ParallelChart.cs +++ b/Runtime/Chart/ParallelChart.cs @@ -7,6 +7,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class ParallelChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/PieChart.cs b/Runtime/Chart/PieChart.cs index 0cee6a3a..02779cd6 100644 --- a/Runtime/Chart/PieChart.cs +++ b/Runtime/Chart/PieChart.cs @@ -6,6 +6,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class PieChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/PolarChart.cs b/Runtime/Chart/PolarChart.cs index 580efb92..95b268b2 100644 --- a/Runtime/Chart/PolarChart.cs +++ b/Runtime/Chart/PolarChart.cs @@ -6,6 +6,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class PolarChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/RadarChart.cs b/Runtime/Chart/RadarChart.cs index ca01353b..e256b182 100644 --- a/Runtime/Chart/RadarChart.cs +++ b/Runtime/Chart/RadarChart.cs @@ -6,6 +6,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class RadarChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/RingChart.cs b/Runtime/Chart/RingChart.cs index ae04dd2a..33c351e6 100644 --- a/Runtime/Chart/RingChart.cs +++ b/Runtime/Chart/RingChart.cs @@ -6,6 +6,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class RingChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/ScatterChart.cs b/Runtime/Chart/ScatterChart.cs index 9f44c902..de04423e 100644 --- a/Runtime/Chart/ScatterChart.cs +++ b/Runtime/Chart/ScatterChart.cs @@ -6,6 +6,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class ScatterChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/SimplifiedBarChart.cs b/Runtime/Chart/SimplifiedBarChart.cs index f2079b3a..0fef9ccd 100644 --- a/Runtime/Chart/SimplifiedBarChart.cs +++ b/Runtime/Chart/SimplifiedBarChart.cs @@ -6,6 +6,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class SimplifiedBarChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/SimplifiedCandlestickChart.cs b/Runtime/Chart/SimplifiedCandlestickChart.cs index 0d2d8ef5..e8d90aa1 100644 --- a/Runtime/Chart/SimplifiedCandlestickChart.cs +++ b/Runtime/Chart/SimplifiedCandlestickChart.cs @@ -6,6 +6,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class SimplifiedCandlestickChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Chart/SimplifiedLineChart.cs b/Runtime/Chart/SimplifiedLineChart.cs index 4553cbbe..bf023dc6 100644 --- a/Runtime/Chart/SimplifiedLineChart.cs +++ b/Runtime/Chart/SimplifiedLineChart.cs @@ -6,6 +6,7 @@ namespace XCharts.Runtime [ExecuteInEditMode] [RequireComponent(typeof(RectTransform))] [DisallowMultipleComponent] + [HelpURL("https://xcharts-team.github.io/docs/configuration")] public class SimplifiedLineChart : BaseChart { protected override void DefaultChart() diff --git a/Runtime/Component/Axis/Axis.cs b/Runtime/Component/Axis/Axis.cs index 2c4ca54d..710e50b2 100644 --- a/Runtime/Component/Axis/Axis.cs +++ b/Runtime/Component/Axis/Axis.cs @@ -59,7 +59,12 @@ namespace XCharts.Runtime /// Customize the minimum and maximum. /// |自定义最小值最大值。 /// - Custom + Custom, + /// + /// [since("v3.7.0")]minimum - maximum, automatically calculate the appropriate values. + /// |[since("v3.7.0")]最小值-最大值。自动计算合适的值。 + /// + MinMaxAuto, } /// /// the position of axis in grid. diff --git a/Runtime/Component/Axis/AxisHelper.cs b/Runtime/Component/Axis/AxisHelper.cs index cf6e5896..7d750607 100644 --- a/Runtime/Component/Axis/AxisHelper.cs +++ b/Runtime/Component/Axis/AxisHelper.cs @@ -393,9 +393,16 @@ namespace XCharts.Runtime break; case Axis.AxisMinMaxType.MinMax: + if (ceilRate != 0) + { + minValue = ChartHelper.GetMinCeilRate(minValue, ceilRate); + maxValue = ChartHelper.GetMaxCeilRate(maxValue, ceilRate); + } + break; - minValue = ceilRate != 0 ? ChartHelper.GetMinDivisibleValue(minValue, ceilRate) : minValue; - maxValue = ceilRate != 0 ? ChartHelper.GetMaxDivisibleValue(maxValue, ceilRate) : maxValue; + case Axis.AxisMinMaxType.MinMaxAuto: + minValue = needFormat ? ChartHelper.GetMinDivisibleValue(minValue, ceilRate) : minValue; + maxValue = needFormat ? ChartHelper.GetMaxDivisibleValue(maxValue, ceilRate) : maxValue; break; } } diff --git a/Runtime/Component/DataZoom/DataZoom.cs b/Runtime/Component/DataZoom/DataZoom.cs index 84cf83ad..f6ae0547 100644 --- a/Runtime/Component/DataZoom/DataZoom.cs +++ b/Runtime/Component/DataZoom/DataZoom.cs @@ -81,7 +81,7 @@ namespace XCharts.Runtime [SerializeField] private RangeMode m_RangeMode; [SerializeField] private float m_Start; [SerializeField] private float m_End; - [SerializeField] private int m_MinShowNum = 1; + [SerializeField] private int m_MinShowNum = 2; [Range(1f, 20f)] [SerializeField] private float m_ScrollSensitivity = 1.1f; [SerializeField] private Orient m_Orient = Orient.Horizonal; diff --git a/Runtime/Component/Label/LabelStyle.cs b/Runtime/Component/Label/LabelStyle.cs index 762c6c24..a97e5ae4 100644 --- a/Runtime/Component/Label/LabelStyle.cs +++ b/Runtime/Component/Label/LabelStyle.cs @@ -347,9 +347,13 @@ namespace XCharts.Runtime public virtual string GetFormatterContent(int labelIndex, double value, double minValue, double maxValue, bool isLog = false) { var newNumericFormatter = numericFormatter; - if (string.IsNullOrEmpty(newNumericFormatter) && !isLog) + if (value == 0) { - newNumericFormatter = MathUtil.IsInteger(maxValue) ? "0" : "f" + MathUtil.GetPrecision(maxValue); + newNumericFormatter = "f0"; + } + else if (string.IsNullOrEmpty(newNumericFormatter) && !isLog) + { + newNumericFormatter = MathUtil.IsInteger(maxValue) ? "f0" : "f" + MathUtil.GetPrecision(maxValue); } if (string.IsNullOrEmpty(m_Formatter)) { diff --git a/Runtime/Component/Legend/LegendHandler.cs b/Runtime/Component/Legend/LegendHandler.cs index 21f0e81f..e2a0bd48 100644 --- a/Runtime/Component/Legend/LegendHandler.cs +++ b/Runtime/Component/Legend/LegendHandler.cs @@ -11,6 +11,7 @@ namespace XCharts.Runtime internal sealed class LegendHandler : MainComponentHandler { private static readonly string s_LegendObjectName = "legend"; + private static readonly char[] s_NameSplit = new char[] { '_' }; public override void InitComponent() { @@ -48,7 +49,7 @@ namespace XCharts.Runtime private void InitLegend(Legend legend) { legend.painter = null; - legend.refreshComponent = delegate() + legend.refreshComponent = delegate () { legend.OnChanged(); var legendObject = ChartHelper.AddObject(s_LegendObjectName + legend.index, chart.transform, chart.chartMinAnchor, @@ -99,7 +100,7 @@ namespace XCharts.Runtime ChartHelper.AddEventListener(item.button.gameObject, EventTriggerType.PointerDown, (data) => { if (data.selectedObject == null || legend.selectedMode == Legend.SelectedMode.None) return; - var temp = data.selectedObject.name.Split('_'); + var temp = data.selectedObject.name.Split(s_NameSplit, 2); string selectedName = temp[1]; int clickedIndex = int.Parse(temp[0]); if (legend.selectedMode == Legend.SelectedMode.Multiple) @@ -117,7 +118,7 @@ namespace XCharts.Runtime { for (int n = 0; n < btnList.Length; n++) { - temp = btnList[n].name.Split('_'); + temp = btnList[n].name.Split(s_NameSplit, 2); selectedName = btnList[n].legendName; var index = btnList[n].index; OnLegendButtonClick(legend, n, selectedName, index == clickedIndex ? true : false); @@ -128,7 +129,7 @@ namespace XCharts.Runtime ChartHelper.AddEventListener(item.button.gameObject, EventTriggerType.PointerEnter, (data) => { if (item.button == null) return; - var temp = item.button.name.Split('_'); + var temp = item.button.name.Split(s_NameSplit, 2); string selectedName = temp[1]; int index = int.Parse(temp[0]); OnLegendButtonEnter(legend, index, selectedName); @@ -136,7 +137,7 @@ namespace XCharts.Runtime ChartHelper.AddEventListener(item.button.gameObject, EventTriggerType.PointerExit, (data) => { if (item.button == null) return; - var temp = item.button.name.Split('_'); + var temp = item.button.name.Split(s_NameSplit, 2); string selectedName = temp[1]; int index = int.Parse(temp[0]); OnLegendButtonExit(legend, index, selectedName); @@ -268,4 +269,4 @@ namespace XCharts.Runtime } } } -} \ No newline at end of file +} diff --git a/Runtime/Component/Radar/RadarCoord.cs b/Runtime/Component/Radar/RadarCoord.cs index 8bcbe78c..250659af 100644 --- a/Runtime/Component/Radar/RadarCoord.cs +++ b/Runtime/Component/Radar/RadarCoord.cs @@ -383,6 +383,7 @@ namespace XCharts.Runtime angle = 2 * Mathf.PI / indicatorNum * (index + 0.5f); break; } + angle += startAngle * Mathf.PI / 180; var x = context.center.x + (context.radius + indicatorGap) * Mathf.Sin(angle); var y = context.center.y + (context.radius + indicatorGap) * Mathf.Cos(angle); return new Vector3(x, y); @@ -429,6 +430,13 @@ namespace XCharts.Runtime return indicatorList[indicatorIndex]; } + public string GetIndicatorName(int indicatorIndex) + { + var indicator = GetIndicator(indicatorIndex); + if (indicator == null) return string.Empty; + return indicator.name; + } + public override void ClearData() { indicatorList.Clear(); diff --git a/Runtime/Component/Tooltip/TooltipHandler.cs b/Runtime/Component/Tooltip/TooltipHandler.cs index b927fe61..c730a820 100644 --- a/Runtime/Component/Tooltip/TooltipHandler.cs +++ b/Runtime/Component/Tooltip/TooltipHandler.cs @@ -34,7 +34,7 @@ namespace XCharts.Runtime private void InitTooltip(Tooltip tooltip) { tooltip.painter = chart.m_PainterUpper; - tooltip.refreshComponent = delegate() + tooltip.refreshComponent = delegate () { var objName = ChartCached.GetComponentObjectName(tooltip); tooltip.gameObject = ChartHelper.AddObject(objName, chart.transform, chart.chartMinAnchor, @@ -193,7 +193,7 @@ namespace XCharts.Runtime if (axis.IsCategory()) { - var index = (int) axis.context.pointerValue; + var index = (int)axis.context.pointerValue; var category = axis.GetData(index); label.SetText(axis.indicatorLabel.GetFormatterContent(index, category)); } @@ -241,7 +241,7 @@ namespace XCharts.Runtime else if (container is PolarCoord) { var m_AngleAxis = ComponentHelper.GetAngleAxis(chart.components, container.index); - tooltip.context.angle = (float) m_AngleAxis.context.pointerValue; + tooltip.context.angle = (float)m_AngleAxis.context.pointerValue; } list.Add(serie); if (!isTriggerAxis) @@ -267,7 +267,7 @@ namespace XCharts.Runtime if (isTriggerAxis) { serie.context.pointerEnter = true; - serie.context.pointerAxisDataIndexs.Add((int) yAxis.context.pointerValue); + serie.context.pointerAxisDataIndexs.Add((int)yAxis.context.pointerValue); yAxis.context.axisTooltipValue = yAxis.context.pointerValue; } } @@ -283,7 +283,7 @@ namespace XCharts.Runtime { if (isTriggerAxis) { - var index = serie.context.dataZoomStartIndex + (int) xAxis.context.pointerValue; + var index = serie.context.dataZoomStartIndex + (int)xAxis.context.pointerValue; serie.context.pointerEnter = true; serie.context.pointerAxisDataIndexs.Add(index); serie.context.pointerItemDataIndex = index; @@ -344,7 +344,7 @@ namespace XCharts.Runtime var serieData = serie.data[i]; serie.context.sortedData.Add(serieData); } - serie.context.sortedData.Sort(delegate(SerieData a, SerieData b) + serie.context.sortedData.Sort(delegate (SerieData a, SerieData b) { return a.GetData(dimension).CompareTo(b.GetData(dimension)); }); @@ -355,7 +355,7 @@ namespace XCharts.Runtime { var serieData = data[i]; currValue = serieData.GetData(dimension); - if (i == 0) + if (i == 0 && i + 1 < dataCount) { nextValue = data[i + 1].GetData(dimension); if (axisValue <= currValue + (nextValue - currValue) / 2) @@ -372,7 +372,7 @@ namespace XCharts.Runtime break; } } - else + else if (i + 1 < dataCount) { nextValue = data[i + 1].GetData(dimension); if (axisValue > (currValue - (currValue - lastValue) / 2) && axisValue <= currValue + (nextValue - currValue) / 2) @@ -497,7 +497,7 @@ namespace XCharts.Runtime var axis = component as Axis; if (axis.gridIndex == gridIndex && axis.IsCategory()) { - dataIndex = axis.context.dataZoomStartIndex + (int) axis.context.pointerValue; + dataIndex = axis.context.dataZoomStartIndex + (int)axis.context.pointerValue; category = axis.GetData(dataIndex); return true; } @@ -558,7 +558,7 @@ namespace XCharts.Runtime case Tooltip.Type.Line: float pX = grid.context.x; pX += xAxis.IsCategory() ? - (float) (xAxis.context.pointerValue * splitWidth + (xAxis.boundaryGap ? splitWidth / 2 : 0)) : + (float)(xAxis.context.pointerValue * splitWidth + (xAxis.boundaryGap ? splitWidth / 2 : 0)) : xAxis.GetDistance(xAxis.context.axisTooltipValue, grid.context.width); if (pX < grid.context.x) break; @@ -577,15 +577,15 @@ namespace XCharts.Runtime if (xAxis.IsCategory() && !double.IsInfinity(xAxis.context.pointerValue)) { float tooltipSplitWid = splitWidth < 1 ? 1 : splitWidth; - pX = (float) (grid.context.x + splitWidth * xAxis.context.pointerValue - + pX = (float)(grid.context.x + splitWidth * xAxis.context.pointerValue - (xAxis.boundaryGap ? 0 : splitWidth / 2)); if (pX < grid.context.x) break; float pY = grid.context.y + grid.context.height; - Vector3 p1 = chart.ClampInGrid(grid,new Vector3(pX, grid.context.y)); - Vector3 p2 = chart.ClampInGrid(grid,new Vector3(pX, pY)); - Vector3 p3 = chart.ClampInGrid(grid,new Vector3(pX + tooltipSplitWid, pY)); - Vector3 p4 = chart.ClampInGrid(grid,new Vector3(pX + tooltipSplitWid, grid.context.y)); + Vector3 p1 = chart.ClampInGrid(grid, new Vector3(pX, grid.context.y)); + Vector3 p2 = chart.ClampInGrid(grid, new Vector3(pX, pY)); + Vector3 p3 = chart.ClampInGrid(grid, new Vector3(pX + tooltipSplitWid, pY)); + Vector3 p4 = chart.ClampInGrid(grid, new Vector3(pX + tooltipSplitWid, grid.context.y)); var areaColor = TooltipHelper.GetLineColor(tooltip, chart.theme.tooltip.areaColor); UGL.DrawQuadrilateral(vh, p1, p2, p3, p4, areaColor); } @@ -622,7 +622,7 @@ namespace XCharts.Runtime { case Tooltip.Type.Corss: case Tooltip.Type.Line: - float pY = (float) (grid.context.y + yAxis.context.pointerValue * splitWidth + + float pY = (float)(grid.context.y + yAxis.context.pointerValue * splitWidth + (yAxis.boundaryGap ? splitWidth / 2 : 0)); if (pY < grid.context.y) break; @@ -642,7 +642,7 @@ namespace XCharts.Runtime { float tooltipSplitWid = splitWidth < 1 ? 1 : splitWidth; float pX = grid.context.x + grid.context.width; - pY = (float) (grid.context.y + splitWidth * yAxis.context.pointerValue - + pY = (float)(grid.context.y + splitWidth * yAxis.context.pointerValue - (yAxis.boundaryGap ? 0 : splitWidth / 2)); if (pY < grid.context.y) break; diff --git a/Runtime/Coord/Grid/GridCoord.cs b/Runtime/Coord/Grid/GridCoord.cs index f279faa9..9d4fe754 100644 --- a/Runtime/Coord/Grid/GridCoord.cs +++ b/Runtime/Coord/Grid/GridCoord.cs @@ -1,4 +1,5 @@ using System; +using System.Collections.Generic; using UnityEngine; using XUGL; @@ -132,14 +133,48 @@ namespace XCharts.Runtime return Contains(pos.x, pos.y); } + [Since("v3.7.0")] + public bool Contains(Vector3 pos, bool isYAxis) + { + return isYAxis ? ContainsY(pos.y) : ContainsX(pos.x); + } + public bool Contains(float x, float y) { - if (x < context.x - 1 || x > context.x + context.width + 1 || - y < context.y - 1 || y > context.y + context.height + 1) - { - return false; - } - return true; + return ContainsX(x) && ContainsY(y); + } + + [Since("v3.7.0")] + public bool ContainsX(float x) + { + return x >= context.x && x <= context.x + context.width; + } + + [Since("v3.7.0")] + public bool ContainsY(float y) + { + return y >= context.y && y <= context.y + context.height; + } + + [Since("v3.7.0")] + public void Clamp(ref Vector3 pos) + { + ClampX(ref pos); + ClampY(ref pos); + } + + [Since("v3.7.0")] + public void ClampX(ref Vector3 pos) + { + if (pos.x < context.x) pos.x = context.x; + else if (pos.x > context.x + context.width) pos.x = context.x + context.width; + } + + [Since("v3.7.0")] + public void ClampY(ref Vector3 pos) + { + if (pos.y < context.y) pos.y = context.y; + else if (pos.y > context.y + context.height) pos.y = context.y + context.height; } /// @@ -151,10 +186,15 @@ namespace XCharts.Runtime public bool BoundaryPoint(Vector3 sp, Vector3 ep, ref Vector3 point) { if (Contains(sp) && Contains(ep)) - { - point = ep; return false; - } + if (sp.x < context.x && ep.x < context.x) + return false; + if (sp.x > context.x + context.width && ep.x > context.x + context.width) + return false; + if (sp.y < context.y && ep.y < context.y) + return false; + if (sp.y > context.y + context.height && ep.y > context.y + context.height) + return false; var lb = new Vector3(context.x, context.y); var lt = new Vector3(context.x, context.y + context.height); var rt = new Vector3(context.x + context.width, context.y + context.height); @@ -169,5 +209,31 @@ namespace XCharts.Runtime return true; return false; } + + /// + /// 给定的线段和Grid边界的交点 + /// + /// + /// + /// + public bool BoundaryPoint(Vector3 sp, Vector3 ep, ref List point) + { + if (Contains(sp) && Contains(ep)) + return false; + var lb = new Vector3(context.x, context.y); + var lt = new Vector3(context.x, context.y + context.height); + var rt = new Vector3(context.x + context.width, context.y + context.height); + var rb = new Vector3(context.x + context.width, context.y); + var flag = false; + if (UGLHelper.GetIntersection(sp, ep, lb, lt, ref point)) + flag = true; + if (UGLHelper.GetIntersection(sp, ep, lt, rt, ref point)) + flag = true; + if (UGLHelper.GetIntersection(sp, ep, lb, rb, ref point)) + flag = true; + if (UGLHelper.GetIntersection(sp, ep, rb, rt, ref point)) + flag = true; + return flag; + } } } \ No newline at end of file diff --git a/Runtime/Internal/BaseChart.API.cs b/Runtime/Internal/BaseChart.API.cs index fb8cf4d0..e999614b 100644 --- a/Runtime/Internal/BaseChart.API.cs +++ b/Runtime/Internal/BaseChart.API.cs @@ -667,5 +667,64 @@ namespace XCharts.Runtime SerieHelper.GetItemColor(out color, out toColor, serie, null, m_Theme); return color; } + + /// + /// trigger tooltip by data index. + /// |尝试触发指定数据项的Tooltip. + /// + /// 数据项索引 + /// + [Since("v3.7.0")] + public bool TriggerTooltip(int dataIndex) + { + var serie = GetSerie(0); + if (serie == null) return false; + var dataPoints = serie.context.dataPoints; + var dataPoint = Vector3.zero; + if (dataPoints.Count == 0) + { + if (serie.dataCount == 0) return false; + dataIndex = dataIndex % serie.dataCount; + var serieData = serie.GetSerieData(dataIndex); + if (serieData == null) return false; + dataPoint = serie.GetSerieData(dataIndex).context.position; + } + else + { + dataIndex = dataIndex % dataPoints.Count; + dataPoint = dataPoints[dataIndex]; + } + return TriggerTooltip(dataPoint); + } + + /// + /// trigger tooltip by chart local position. + /// |在指定的位置尝试触发Tooltip. + /// + /// + /// + [Since("v3.7.0")] + public bool TriggerTooltip(Vector3 localPosition) + { + var screenPoint = LocalPointToScreenPoint(localPosition); + var eventData = new PointerEventData(EventSystem.current); + eventData.position = screenPoint; + OnPointerEnter(eventData); + return true; + } + + /// + /// cancel tooltip. + /// |取消Tooltip. + /// + [Since("v3.7.0")] + public void CancelTooltip() + { + var tooltip = GetChartComponent(); + if (tooltip != null) + { + tooltip.SetActive(false); + } + } } } \ No newline at end of file diff --git a/Runtime/Internal/BaseChart.Component.cs b/Runtime/Internal/BaseChart.Component.cs index dd57e897..1d009716 100644 --- a/Runtime/Internal/BaseChart.Component.cs +++ b/Runtime/Internal/BaseChart.Component.cs @@ -72,6 +72,7 @@ namespace XCharts.Runtime CreateComponentHandler(component); #if UNITY_EDITOR && UNITY_2019_1_OR_NEWER UnityEditor.EditorUtility.SetDirty(this); + OnBeforeSerialize(); #endif return component; } @@ -88,6 +89,7 @@ namespace XCharts.Runtime } component.index = list.Count; list.Add(component); + m_Components.Sort((a, b) => { return a.GetType().Name.CompareTo(b.GetType().Name); }); } private void CheckAddRequireChartComponent(Type type) @@ -179,6 +181,10 @@ namespace XCharts.Runtime { if (component.gameObject != null) ChartHelper.SetActive(component.gameObject, false); +#if UNITY_EDITOR && UNITY_2019_1_OR_NEWER + UnityEditor.EditorUtility.SetDirty(this); + OnBeforeSerialize(); +#endif InitComponentHandlers(); RefreshChart(); return true; diff --git a/Runtime/Internal/BaseChart.cs b/Runtime/Internal/BaseChart.cs index 46b3d4f9..80964be9 100644 --- a/Runtime/Internal/BaseChart.cs +++ b/Runtime/Internal/BaseChart.cs @@ -11,7 +11,7 @@ namespace XCharts.Runtime { [AddComponentMenu("XCharts/EmptyChart", 10)] [ExecuteInEditMode] - [RequireComponent(typeof(RectTransform),typeof(CanvasRenderer))] + [RequireComponent(typeof(RectTransform), typeof(CanvasRenderer))] [DisallowMultipleComponent] public partial class BaseChart : BaseGraph, ISerializationCallbackReceiver { @@ -131,7 +131,7 @@ namespace XCharts.Runtime { if (m_Settings == null) m_Settings = Settings.DefaultSettings; - CheckTheme(); + CheckTheme(true); base.Awake(); InitComponentHandlers(); InitSerieHandlers(); @@ -244,12 +244,16 @@ namespace XCharts.Runtime painter.SetActive(flag, m_DebugInfo.showAllChartObject); } - protected virtual void CheckTheme() + protected virtual void CheckTheme(bool firstInit = false) { if (m_Theme.sharedTheme == null) { m_Theme.sharedTheme = XCThemeMgr.GetTheme(ThemeType.Default); } + if (firstInit) + { + m_CheckTheme = m_Theme.themeType; + } if (m_Theme.sharedTheme != null && m_CheckTheme != m_Theme.themeType) { m_CheckTheme = m_Theme.themeType; diff --git a/Runtime/Internal/BaseGraph.API.cs b/Runtime/Internal/BaseGraph.API.cs index 499c24b1..553249f9 100644 --- a/Runtime/Internal/BaseGraph.API.cs +++ b/Runtime/Internal/BaseGraph.API.cs @@ -173,6 +173,32 @@ namespace XCharts.Runtime return true; } + /// + /// chart local point to screen point. + /// |图表内坐标转屏幕坐标。 + /// + /// 图表内的坐标 + /// 屏幕坐标 + [Since("v3.7.0")] + public Vector2 LocalPointToScreenPoint(Vector2 localPoint) + { + var cam = canvas.renderMode == RenderMode.ScreenSpaceOverlay ? null : canvas.worldCamera; + var wordPoint = rectTransform.TransformPoint(localPoint); + return RectTransformUtility.WorldToScreenPoint(cam, wordPoint); + } + + /// + /// chart local point to world point. + /// |图表内坐标转世界坐标。 + /// + /// 图表内的坐标 + /// 世界坐标 + [Since("v3.7.0")] + public Vector2 LocalPointToWorldPoint(Vector2 localPoint) + { + return rectTransform.TransformPoint(localPoint); + } + /// /// 保存图表为图片。 /// diff --git a/Runtime/Internal/Utilities/ChartHelper.cs b/Runtime/Internal/Utilities/ChartHelper.cs index d98ffa12..da84ae41 100644 --- a/Runtime/Internal/Utilities/ChartHelper.cs +++ b/Runtime/Internal/Utilities/ChartHelper.cs @@ -521,7 +521,7 @@ namespace XCharts.Runtime { Vector3 dir = (ep - sp).normalized; float dist = Vector3.Distance(sp, ep); - int segment = (int) (dist / k); + int segment = (int)(dist / k); posList.Clear(); posList.Add(sp); for (int i = 1; i < segment; i++) @@ -676,7 +676,7 @@ namespace XCharts.Runtime { Color color; ColorUtility.TryParseHtmlString(hexColorStr, out color); - return (Color32) color; + return (Color32)color; } public static double GetMaxDivisibleValue(double max, double ceilRate) @@ -685,15 +685,16 @@ namespace XCharts.Runtime if (max > -1 && max < 1) { int count = 1; - int intvalue = (int) (max * Mathf.Pow(10, count)); + int intvalue = (int)(max * Mathf.Pow(10, count)); while (intvalue == 0 && count < 12) { count++; - intvalue = (int) (max * Mathf.Pow(10, count)); + intvalue = (int)(max * Mathf.Pow(10, count)); } var pow = Mathf.Pow(10, count); - if (max > 0) return (int) ((max * pow + 1)) / pow; - else return (int) ((max * pow - 1)) / pow; + var value = max > 0 ? (int)((max * (pow + 1))) / pow : + (int)((max * (pow - 1))) / pow; + return GetMaxCeilRate(value, ceilRate); } if (ceilRate == 0) { @@ -723,27 +724,42 @@ namespace XCharts.Runtime } else { - var mod = max % ceilRate; - int rate = (int) (max / ceilRate); - return mod == 0 ? max : (max < 0 ? rate : rate + 1) * ceilRate; + return GetMaxCeilRate(max, ceilRate); } } + public static double GetMaxCeilRate(double value, double ceilRate) + { + if (ceilRate == 0) return value; + var mod = value % ceilRate; + int rate = (int)(value / ceilRate); + return mod == 0 ? value : (value < 0 ? rate : rate + 1) * ceilRate; + } + + public static double GetMinCeilRate(double value, double ceilRate) + { + if (ceilRate == 0) return value; + var mod = value % ceilRate; + int rate = (int)(value / ceilRate); + return mod == 0 ? value : (value < 0 ? rate - 1 : rate) * ceilRate; + } + public static double GetMinDivisibleValue(double min, double ceilRate) { if (min == 0) return 0; if (min > -1 && min < 1) { int count = 1; - int intvalue = (int) (min * Mathf.Pow(10, count)); + int intvalue = (int)(min * Mathf.Pow(10, count)); while (intvalue == 0 && count < 12) { count++; - intvalue = (int) (min * Mathf.Pow(10, count)); + intvalue = (int)(min * Mathf.Pow(10, count)); } var pow = Mathf.Pow(10, count); - if (min > 0) return (int) ((min * pow + 1)) / pow; - else return (int) ((min * pow - 1)) / pow; + var value = min > 0 ? ((int)(min * (pow - 1))) / pow : + ((int)(min * (pow + 1))) / pow; + return GetMinCeilRate(value, ceilRate); } if (ceilRate == 0) { @@ -764,9 +780,7 @@ namespace XCharts.Runtime } else { - var mod = min % ceilRate; - int rate = (int) (min / ceilRate); - return mod == 0 ? min : (min < 0 ? rate - 1 : rate) * ceilRate; + return GetMinCeilRate(min, ceilRate); } } @@ -810,8 +824,6 @@ namespace XCharts.Runtime return min; } - - public static void AddEventListener(GameObject obj, EventTriggerType type, UnityEngine.Events.UnityAction call) { @@ -902,32 +914,32 @@ namespace XCharts.Runtime { if (color.a != 0 && opacity != 1) { - color.a = (byte) (color.a * opacity); + color.a = (byte)(color.a * opacity); } } public static Color32 GetHighlightColor(Color32 color, float rate = 0.8f) { var newColor = color; - newColor.r = (byte) (color.r * rate); - newColor.g = (byte) (color.g * rate); - newColor.b = (byte) (color.b * rate); + newColor.r = (byte)(color.r * rate); + newColor.g = (byte)(color.g * rate); + newColor.b = (byte)(color.b * rate); return newColor; } public static Color32 GetBlurColor(Color32 color, float a = 0.3f) { var newColor = color; - newColor.a = (byte) (a * 255); + newColor.a = (byte)(a * 255); return newColor; } public static Color32 GetSelectColor(Color32 color, float rate = 0.8f) { var newColor = color; - newColor.r = (byte) (color.r * rate); - newColor.g = (byte) (color.g * rate); - newColor.b = (byte) (color.b * rate); + newColor.r = (byte)(color.r * rate); + newColor.g = (byte)(color.g * rate); + newColor.b = (byte)(color.b * rate); return newColor; } @@ -977,7 +989,7 @@ namespace XCharts.Runtime var posX = pos.x + rectTransform.rect.xMin * canvas.scaleFactor; var posY = pos.y + rectTransform.rect.yMin * canvas.scaleFactor; var rect = new Rect(posX, posY, width, height); - var tex = new Texture2D((int) width, (int) height, TextureFormat.RGBA32, false); + var tex = new Texture2D((int)width, (int)height, TextureFormat.RGBA32, false); tex.ReadPixels(rect, 0, 0); tex.Apply(); byte[] bytes; diff --git a/Runtime/Internal/Utilities/MathUtil.cs b/Runtime/Internal/Utilities/MathUtil.cs index 443d3f97..fed7cfbe 100644 --- a/Runtime/Internal/Utilities/MathUtil.cs +++ b/Runtime/Internal/Utilities/MathUtil.cs @@ -39,6 +39,8 @@ namespace XCharts.Runtime public static bool IsInteger(double value) { + if (value == 0) return true; + if (value >= -1 && value <= 1) return false; return Math.Abs(value % 1) <= (Double.Epsilon * 100); } diff --git a/Runtime/Internal/XChartsMgr.cs b/Runtime/Internal/XChartsMgr.cs index 661e35b7..5a03cfc5 100644 --- a/Runtime/Internal/XChartsMgr.cs +++ b/Runtime/Internal/XChartsMgr.cs @@ -21,8 +21,8 @@ namespace XCharts.Runtime [ExecuteInEditMode] public static class XChartsMgr { - public static readonly string version = "3.6.0"; - public static readonly int versionDate = 20230401; + public static readonly string version = "3.7.0"; + public static readonly int versionDate = 20230601; public static string fullVersion { get { return version + "-" + versionDate; } } internal static List chartList = new List(); diff --git a/Runtime/Serie/Line/LineHandler.GridCoord.cs b/Runtime/Serie/Line/LineHandler.GridCoord.cs index d5699de2..07b56738 100644 --- a/Runtime/Serie/Line/LineHandler.GridCoord.cs +++ b/Runtime/Serie/Line/LineHandler.GridCoord.cs @@ -276,11 +276,13 @@ namespace XCharts.Runtime return; var axisLength = isY ? m_SerieGrid.context.height : m_SerieGrid.context.width; - var scaleWid = AxisHelper.GetDataWidth(axis, axisLength, showData.Count, dataZoom); + int maxCount = serie.maxShow > 0 ? (serie.maxShow > showData.Count ? showData.Count : serie.maxShow) : showData.Count; + maxCount -= serie.context.dataZoomStartIndexOffset; + var scaleWid = AxisHelper.GetDataWidth(axis, axisLength, maxCount, dataZoom); int rate = LineHelper.GetDataAverageRate(serie, m_SerieGrid, maxCount, false); var totalAverage = serie.sampleAverage > 0 ? serie.sampleAverage : @@ -304,9 +306,10 @@ namespace XCharts.Runtime SeriesHelper.UpdateStackDataList(chart.series, serie, dataZoom, m_StackSerieData); } var lp = Vector3.zero; - for (int i = serie.minShow; i < maxCount; i += rate) + for (int i = serie.minShow; i < showData.Count; i += rate) { var serieData = showData[i]; + var realIndex = i - serie.context.dataZoomStartIndexOffset; var isIgnore = serie.IsIgnoreValue(serieData); if (isIgnore) { @@ -320,7 +323,7 @@ namespace XCharts.Runtime else { var np = Vector3.zero; - var xValue = axis.IsCategory() ? i : serieData.GetData(0, axis.inverse); + var xValue = axis.IsCategory() ? realIndex : serieData.GetData(0, axis.inverse); var relativedValue = DataHelper.SampleValue(ref showData, serie.sampleType, rate, serie.minShow, maxCount, totalAverage, i, dataChangeDuration, ref dataChanging, relativedAxis, unscaledTime); @@ -329,7 +332,7 @@ namespace XCharts.Runtime serieData.context.isClip = false; if (serie.clip && !m_SerieGrid.Contains(np)) { - if (m_SerieGrid.BoundaryPoint(lp, np, ref np)) + //if (m_SerieGrid.BoundaryPoint(lp, np, ref np)) { serieData.context.isClip = true; } diff --git a/Runtime/Serie/Line/LineHelper.cs b/Runtime/Serie/Line/LineHelper.cs index 45871a0e..4e99f640 100644 --- a/Runtime/Serie/Line/LineHelper.cs +++ b/Runtime/Serie/Line/LineHelper.cs @@ -15,7 +15,7 @@ namespace XCharts.Runtime var rate = 0; var width = isYAxis ? grid.context.height : grid.context.width; if (sampleDist > 0) - rate = (int) ((maxCount - serie.minShow) / (width / sampleDist)); + rate = (int)((maxCount - serie.minShow) / (width / sampleDist)); if (rate < 1) rate = 1; return rate; @@ -86,8 +86,13 @@ namespace XCharts.Runtime var lastDataIsIgnore = false; for (int i = 0; i < points.Count; i++) { - var tp = points[i].position; - var isIgnore = points[i].isIgnoreBreak; + var pdata = points[i]; + var tp = pdata.position; + if (serie.clip) + { + grid.Clamp(ref tp); + } + var isIgnore = pdata.isIgnoreBreak; var color = areaColor; var toColor = areaToColor; var lerp = areaLerp; @@ -281,6 +286,7 @@ namespace XCharts.Runtime var lastDataIsIgnore = datas[0].isIgnoreBreak; var smooth = serie.lineType == LineType.Smooth; + var firstInGridPointIndex = serie.clip ? -1 : 1; for (int i = 1; i < dataCount; i++) { var cdata = datas[i]; @@ -299,8 +305,16 @@ namespace XCharts.Runtime } serie.context.lineEndPostion = cp; serie.context.lineEndValue = AxisHelper.GetAxisPositionValue(grid, relativedAxis, cp); - var handled = false; + var isClip = false; + if (serie.clip) + { + if (!grid.Contains(cp)) + isClip = true; + else if (firstInGridPointIndex <= 0) + firstInGridPointIndex = i; + if (isClip) isIgnore = true; + } if (!smooth) { switch (serie.lineStyle.type) @@ -341,8 +355,10 @@ namespace XCharts.Runtime ref itp, ref ibp, ref clp, ref crp, ref bitp, ref bibp, i); + if (i == 1) { + if (isClip) lastDataIsIgnore = true; AddLineVertToVertexHelper(vh, ltp, lbp, lineColor, isVisualMapGradient, isLineStyleGradient, visualMap, serie.lineStyle, grid, axis, relativedAxis, false, lastDataIsIgnore, isIgnore); if (dataCount == 2 || isBreak) @@ -460,7 +476,7 @@ namespace XCharts.Runtime private static void UpdateNormalLineDrawPoints(Serie serie, Settings setting, VisualMap visualMap) { var isVisualMapGradient = VisualMapHelper.IsNeedGradient(visualMap); - if (isVisualMapGradient) + if (isVisualMapGradient || serie.clip) { var dataPoints = serie.context.dataPoints; if (dataPoints.Count > 1) @@ -473,7 +489,7 @@ namespace XCharts.Runtime var dir = (ep - sp).normalized; var dist = Vector3.Distance(sp, ep); - var segment = (int) (dist / setting.lineSegmentDistance); + var segment = (int)(dist / setting.lineSegmentDistance); serie.context.drawPoints.Add(new PointInfo(sp, ignore)); for (int j = 1; j < segment; j++) { diff --git a/Runtime/Serie/Pie/PieHandler.cs b/Runtime/Serie/Pie/PieHandler.cs index 45bf20cf..c568a1e6 100644 --- a/Runtime/Serie/Pie/PieHandler.cs +++ b/Runtime/Serie/Pie/PieHandler.cs @@ -233,10 +233,12 @@ namespace XCharts.Runtime serieData.context.currentAngle = serieData.context.toAngle; } var halfDegree = (serieData.context.toAngle - startDegree) / 2; + var halfRadius = serie.context.insideRadius + (serieData.context.outsideRadius - serie.context.insideRadius) / 2; serieData.context.halfAngle = startDegree + halfDegree; serieData.context.angle = startDegree + halfDegree; serieData.context.offsetCenter = serie.context.center; serieData.context.insideRadius = serie.context.insideRadius; + serieData.context.position = ChartHelper.GetPosition(serie.context.center, serieData.context.halfAngle, halfRadius); if (offset > 0) { var currRad = serieData.context.halfAngle * Mathf.Deg2Rad; diff --git a/Runtime/Serie/Radar/RadarHandler.cs b/Runtime/Serie/Radar/RadarHandler.cs index d43a6667..87f11e8b 100644 --- a/Runtime/Serie/Radar/RadarHandler.cs +++ b/Runtime/Serie/Radar/RadarHandler.cs @@ -38,18 +38,19 @@ namespace XCharts.Runtime if (dataIndex < 0) return; + var radar = chart.GetChartComponent(serie.radarIndex); + if (radar == null) + return; + if (serie.radarType == RadarType.Single) { var colorIndex1 = serie.colorByData ? dataIndex : serie.context.colorIndex; + category = radar.GetIndicatorName(dataIndex); UpdateItemSerieParams(ref paramList, ref title, dataIndex, category, marker, itemFormatter, numericFormatter, ignoreDataDefaultContent, 1, colorIndex1); return; } - var radar = chart.GetChartComponent(serie.radarIndex); - if (radar == null) - return; - var serieData = serie.GetSerieData(dataIndex); if (serieData == null) return; @@ -72,6 +73,7 @@ namespace XCharts.Runtime param.value = serieData.GetData(i); param.total = indicator.max; param.color = color; + param.category = radar.GetIndicatorName(i); param.marker = SerieHelper.GetItemMarker(serie, serieData, marker); param.itemFormatter = SerieHelper.GetItemFormatter(serie, serieData, itemFormatter); param.numericFormatter = SerieHelper.GetNumericFormatter(serie, serieData, numericFormatter); diff --git a/Runtime/Serie/Serie.cs b/Runtime/Serie/Serie.cs index 2f5e9ec4..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 @@ -839,7 +847,8 @@ namespace XCharts.Runtime set { if (PropertyUtil.SetStruct(ref m_Large, value)) SetAllDirty(); } } /// - /// 开启大数量优化的阈值。只有当开启了large并且数据量大于该阀值时才进入性能模式。 + /// 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. + /// |开启大数量优化的阈值。只有当开启了large并且数据量大于该阀值时才进入性能模式。 /// public int largeThreshold { @@ -847,7 +856,8 @@ namespace XCharts.Runtime set { if (PropertyUtil.SetStruct(ref m_LargeThreshold, value)) SetAllDirty(); } } /// - /// 在饼图且标签外部显示的情况下，是否启用防止标签重叠策略，默认关闭，在标签拥挤重叠的情况下会挪动各个标签的位置，防止标签间的重叠。 + /// 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. + /// |在饼图且标签外部显示的情况下，是否启用防止标签重叠策略，默认关闭，在标签拥挤重叠的情况下会挪动各个标签的位置，防止标签间的重叠。 /// public bool avoidLabelOverlap { diff --git a/Runtime/Serie/SerieContext.cs b/Runtime/Serie/SerieContext.cs index 12b98f0d..1f7c2348 100644 --- a/Runtime/Serie/SerieContext.cs +++ b/Runtime/Serie/SerieContext.cs @@ -35,6 +35,7 @@ namespace XCharts.Runtime public List pointerAxisDataIndexs = new List(); public bool isTriggerByAxis = false; public int dataZoomStartIndex = 0; + public int dataZoomStartIndexOffset = 0; /// /// 中心点 diff --git a/Runtime/Serie/SerieHandler.cs b/Runtime/Serie/SerieHandler.cs index 37d39b04..4e67ca40 100644 --- a/Runtime/Serie/SerieHandler.cs +++ b/Runtime/Serie/SerieHandler.cs @@ -421,6 +421,7 @@ namespace XCharts.Runtime currLabel != null && currLabel.show && serieData.context.canShowLabel && + !serieData.context.isClip && !isIgnore) { if (serie.multiDimensionLabel) diff --git a/Runtime/Serie/SerieHelper.cs b/Runtime/Serie/SerieHelper.cs index aae27558..b8bb2f9d 100644 --- a/Runtime/Serie/SerieHelper.cs +++ b/Runtime/Serie/SerieHelper.cs @@ -760,14 +760,19 @@ namespace XCharts.Runtime } } - private static List emptyFilter = new List(); /// /// 根据dataZoom更新数据列表缓存 /// /// public static void UpdateFilterData(Serie serie, DataZoom dataZoom) { - if (dataZoom == null || !dataZoom.enable) return; + if (dataZoom == null || !dataZoom.enable) + { + serie.m_NeedUpdateFilterData = true; + serie.context.dataZoomStartIndex = 0; + serie.context.dataZoomStartIndexOffset = 0; + return; + } if (dataZoom.IsContainsXAxis(serie.xAxisIndex)) { if (dataZoom.IsXAxisIndexValue(serie.xAxisIndex)) @@ -822,7 +827,10 @@ namespace XCharts.Runtime } else if (endValue == 0) { - serie.m_FilterData = emptyFilter; + if (serie.m_FilterData == null) + serie.m_FilterData = new List(); + else if (serie.m_FilterData.Count > 0) + serie.m_FilterData.Clear(); } } @@ -863,24 +871,54 @@ namespace XCharts.Runtime if (start >= 0) { serie.context.dataZoomStartIndex = start; + serie.context.dataZoomStartIndexOffset = 0; serie.m_FilterData = data.GetRange(start, range); + var nowCount = serie.m_FilterData.Count; + if (nowCount > 0) + { + if (serie.IsIgnoreValue(serie.m_FilterData[nowCount - 1])) + { + for (int i = start + range; i < data.Count; i++) + { + serie.m_FilterData.Add(data[i]); + if (!serie.IsIgnoreValue(data[i])) + break; + } + } + if (serie.IsIgnoreValue(serie.m_FilterData[0])) + { + for (int i = start - 1; i >= 0; i--) + { + serie.m_FilterData.Insert(0, data[i]); + serie.context.dataZoomStartIndexOffset++; + if (!serie.IsIgnoreValue(data[i])) + break; + } + } + } } else { serie.context.dataZoomStartIndex = 0; + serie.context.dataZoomStartIndexOffset = 0; serie.m_FilterData = data; } } else { serie.context.dataZoomStartIndex = 0; + serie.context.dataZoomStartIndexOffset = 0; serie.m_FilterData = data; } } else if (end == 0) { serie.context.dataZoomStartIndex = 0; - serie.m_FilterData = emptyFilter; + serie.context.dataZoomStartIndexOffset = 0; + if (serie.m_FilterData == null) + serie.m_FilterData = new List(); + else if (serie.m_FilterData.Count > 0) + serie.m_FilterData.Clear(); } } diff --git a/Runtime/XUGL/UGLHelper.cs b/Runtime/XUGL/UGLHelper.cs index a16c831e..c695cb45 100644 --- a/Runtime/XUGL/UGLHelper.cs +++ b/Runtime/XUGL/UGLHelper.cs @@ -133,8 +133,8 @@ namespace XUGL cp2 = ep - (nep - sp).normalized * diff; if (limit) cp2.y = ep.y; } - int segment = (int) (dist / (smoothness <= 0 ? 2f : smoothness)); - if (segment < 1) segment = (int) (dist / 0.5f); + int segment = (int)(dist / (smoothness <= 0 ? 2f : smoothness)); + if (segment < 1) segment = (int)(dist / 0.5f); if (segment < 4) segment = 4; GetBezierList2(ref posList, sp, ep, segment, cp1, cp2); if (posList.Count < 2) @@ -154,7 +154,7 @@ namespace XUGL Vector3 cp2 = sp + dist / k * dir * (k - 1); cp1.x = sp.x; cp2.x = ep.x; - int segment = (int) (dist / (smoothness <= 0 ? 2f : smoothness)); + int segment = (int)(dist / (smoothness <= 0 ? 2f : smoothness)); GetBezierList2(ref posList, sp, ep, segment, cp1, cp2); if (posList.Count < 2) { @@ -169,7 +169,7 @@ namespace XUGL List list = new List(); for (int i = 0; i < segment; i++) { - list.Add(GetBezier(i / (float) segment, sp, cp, ep)); + list.Add(GetBezier(i / (float)segment, sp, cp, ep)); } list.Add(ep); return list; @@ -185,7 +185,7 @@ namespace XUGL } for (int i = 0; i < segment; i++) { - posList.Add((GetBezier2(i / (float) segment, sp, cp, cp2, ep))); + posList.Add((GetBezier2(i / (float)segment, sp, cp, cp2, ep))); } posList.Add(ep); } @@ -255,12 +255,10 @@ namespace XUGL /// 线段1终点 /// 线段2起点 /// 线段2终点 - /// 相交点。当不想交时默认为 Vector3.zero + /// 相交点。当不相交时为初始值 /// 相交则返回 true, 否则返回 false public static bool GetIntersection(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4, ref Vector3 intersection) { - intersection = Vector3.zero; - var d = (p2.x - p1.x) * (p4.y - p3.y) - (p2.y - p1.y) * (p4.x - p3.x); if (d == 0) return false; @@ -275,6 +273,30 @@ namespace XUGL return true; } + /// + /// 获得两直线的交点 + /// + /// 线段1起点 + /// 线段1终点 + /// 线段2起点 + /// 线段2终点 + /// 相交点。当不相交时为初始值 + /// 相交则返回 true, 否则返回 false + public static bool GetIntersection(Vector3 p1, Vector3 p2, Vector3 p3, Vector3 p4, ref List intersection) + { + var d = (p2.x - p1.x) * (p4.y - p3.y) - (p2.y - p1.y) * (p4.x - p3.x); + if (d == 0) + return false; + + var u = ((p3.x - p1.x) * (p4.y - p3.y) - (p3.y - p1.y) * (p4.x - p3.x)) / d; + var v = ((p3.x - p1.x) * (p2.y - p1.y) - (p3.y - p1.y) * (p2.x - p1.x)) / d; + if (u < 0 || u > 1 || v < 0 || v > 1) + return false; + + intersection.Add(new Vector3(p1.x + u * (p2.x - p1.x), p1.y + u * (p2.y - p1.y))); + return true; + } + /// /// 三个点画线段所需要的六个关键点 /// @@ -317,8 +339,8 @@ namespace XUGL if (Vector3.Cross(dir1, dir2) == Vector3.zero && np != cp) { - itp = ntp; - ibp = nbp; + itp = clp; + ibp = crp; return; } diff --git a/package.json b/package.json index 967bd128..14c8d4b9 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,9 @@ { "name": "com.monitor1394.xcharts", "displayName": "XCharts", - "version": "3.6.0", - "date": "20230401", - "checkdate": "20230401", + "version": "3.7.0", + "date": "20230601", + "checkdate": "20230601", "desc": "如果 XCharts 对您有帮助，希望您能在 Github 上点 Star 支持，非常感谢！", "unity": "2018.3", "description": "A charting and data visualization library for Unity.",