using System.Collections.Generic; using UnityEngine; using UnityEngine.UI; namespace XCharts.Runtime { /// /// Tooltip component. /// ||提示框组件。 /// [System.Serializable] [ComponentHandler(typeof(TooltipHandler), true)] public class Tooltip : MainComponent { /// /// Indicator type. /// ||指示器类型。 /// public enum Type { /// /// line indicator. /// ||直线指示器 /// Line, /// /// shadow crosshair indicator. /// ||阴影指示器 /// Shadow, /// /// no indicator displayed. /// ||无指示器 /// None, /// /// crosshair indicator, which is actually the shortcut of enable two axisPointers of two orthometric axes. /// ||十字准星指示器。坐标轴显示Label和交叉线。 /// Corss, /// /// Auto select indicator according to serie type. /// ||根据serie的类型自动选择显示指示器。 /// Auto } /// /// Trigger strategy. /// ||触发类型。 /// public enum Trigger { /// /// Triggered by data item, which is mainly used for charts that don't have a category axis like scatter charts or pie charts. /// ||数据项图形触发,主要在散点图,饼图等无类目轴的图表中使用。 /// Item, /// /// Triggered by axes, which is mainly used for charts that have category axes, like bar charts or line charts. /// ||坐标轴触发,主要在柱状图,折线图等会使用类目轴的图表中使用。 /// Axis, /// /// Trigger nothing. /// ||什么都不触发。 /// None, /// /// Auto select trigger according to serie type. /// ||根据serie的类型自动选择触发类型。 /// Auto } /// /// Position type. /// ||坐标类型。 /// public enum Position { /// /// Auto. The mobile platform is displayed at the top, and the non-mobile platform follows the mouse position. /// ||自适应。移动平台靠顶部显示,非移动平台跟随鼠标位置。 /// Auto, /// /// Custom. Fully customize display position (x,y). /// ||自定义。完全自定义显示位置(x,y)。 /// Custom, /// /// Just fix the coordinate X. Y follows the mouse position. /// ||只固定坐标X。Y跟随鼠标位置。 /// FixedX, /// /// Just fix the coordinate Y. X follows the mouse position. /// ||只固定坐标Y。X跟随鼠标位置。 FixedY } [SerializeField] private bool m_Show = true; [SerializeField] private Type m_Type = Type.Auto; [SerializeField] private Trigger m_Trigger = Trigger.Auto; [SerializeField][Since("v3.3.0")] private Position m_Position = Position.Auto; [SerializeField] private string m_ItemFormatter; [SerializeField] private string m_TitleFormatter; [SerializeField] private string m_Marker = "●"; [SerializeField] private float m_FixedWidth = 0; [SerializeField] private float m_FixedHeight = 0; [SerializeField] private float m_MinWidth = 0; [SerializeField] private float m_MinHeight = 0; [SerializeField] private string m_NumericFormatter = ""; [SerializeField] private int m_PaddingLeftRight = 10; [SerializeField] private int m_PaddingTopBottom = 10; [SerializeField] private bool m_IgnoreDataShow = false; [SerializeField] private string m_IgnoreDataDefaultContent = "-"; [SerializeField] private bool m_ShowContent = true; [SerializeField] private bool m_AlwayShowContent = false; [SerializeField] private Vector2 m_Offset = new Vector2(18f, -25f); [SerializeField] private Sprite m_BackgroundImage; [SerializeField] private Image.Type m_BackgroundType = Image.Type.Simple; [SerializeField] private Color m_BackgroundColor; [SerializeField] private float m_BorderWidth = 2f; [SerializeField] private float m_FixedX = 0f; [SerializeField] private float m_FixedY = 0.7f; [SerializeField] private float m_TitleHeight = 25f; [SerializeField] private float m_ItemHeight = 25f; [SerializeField] private Color32 m_BorderColor = new Color32(230, 230, 230, 255); [SerializeField] private LineStyle m_LineStyle = new LineStyle(LineStyle.Type.None); [SerializeField] private LabelStyle m_TitleLabelStyle = new LabelStyle() { textStyle = new TextStyle() { alignment = TextAnchor.MiddleLeft } }; [SerializeField] private List m_ContentLabelStyles = new List() { new LabelStyle() { textPadding = new TextPadding(0, 5, 0, 0), textStyle = new TextStyle() { alignment = TextAnchor.MiddleLeft } }, new LabelStyle() { textPadding = new TextPadding(0, 20, 0, 0), textStyle = new TextStyle() { alignment = TextAnchor.MiddleLeft } }, new LabelStyle() { textPadding = new TextPadding(0, 0, 0, 0), textStyle = new TextStyle() { alignment = TextAnchor.MiddleRight } } }; public TooltipContext context = new TooltipContext(); public TooltipView view; /// /// Whether to show the tooltip component. /// ||是否显示提示框组件。 /// public bool show { get { return m_Show; } set { if (PropertyUtil.SetStruct(ref m_Show, value)) { SetAllDirty(); SetActive(value); } } } /// /// Indicator type. /// ||提示框指示器类型。 /// public Type type { get { return m_Type; } set { if (PropertyUtil.SetStruct(ref m_Type, value)) SetAllDirty(); } } /// /// Type of triggering. /// ||触发类型。 /// public Trigger trigger { get { return m_Trigger; } set { if (PropertyUtil.SetStruct(ref m_Trigger, value)) SetAllDirty(); } } /// /// Type of position. /// ||显示位置类型。 /// public Position position { get { return m_Position; } set { if (PropertyUtil.SetStruct(ref m_Position, value)) SetAllDirty(); } } /// /// String template formatter for tooltip title content. \n line wrapping is supported. The placeholder {i} can be set separately to indicate that title is ignored and not displayed. /// Template variables are {.}, {a}, {b}, {c}, {d}, {e}, {f}, and {g}.
/// {.} is the dot of the corresponding color of serie currently indicated or index 0.
/// {a} is the series name name of serie currently indicated or index 0.
/// {b} is the name of the serie data item serieData currently indicated or index 0, or the category value (such as the X-axis of a line chart).
/// {c} is the value of the serie y-dimension (dimesion is 1) currently indicated or index is 0.
/// {d} is the serie y-dimensional (dimesion 1) percentage value of the currently indicated or index 0, note without the % sign.
/// {e} is the name of the serie data item serieData currently indicated or whose index is 0.
/// {h} is the hexadecimal color value of serieData for the serie data item currently indicated or index 0.
/// {f} is the sum of data.
/// {g} indicates the total number of data.
/// {y} is category value of y axis.
/// {.1} represents a dot of the corresponding color with serie specified as index 1.
/// The 1 in {a1}, {b1}, {c1} represents serie where index is specified as 1.
/// {c1:2} represents the third data of the current indicator data item in serie with index 1 (one data item has multiple data, index 2 represents the third data).
/// {c1:2-2} represents the third data of serie third data item with index 1 (that is, the number of data items must be specified when specifying the number of data items).
/// {d1:2:f2} indicates that a format string with a single value is f2 (numericFormatter is used if no value is specified).
/// {d:0.##} indicates that the format string with a value specified alone is 0.## # (for percentages, preserving a 2-digit significant number while avoiding the "100.00%" situation with f2).
/// example: "{a}, {c}", "{a1}, {c1: f1}", "{a1}, {c1:0: f1}", "{a1}, {c1:1-1: f1}" /// ||提示框标题内容的字符串模版格式器。支持用 \n 换行。可以单独设置占位符{i}表示忽略不显示title。 /// 模板变量有{.}、{a}、{b}、{c}、{d}、{e}、{f}、{g}。
/// {.}为当前所指示或index为0的serie的对应颜色的圆点。
/// {a}为当前所指示或index为0的serie的系列名name。
/// {b}为当前所指示或index为0的serie的数据项serieData的name,或者类目值(如折线图的X轴)。
/// {c}为当前所指示或index为0的serie的y维(dimesion为1)的数值。
/// {d}为当前所指示或index为0的serie的y维(dimesion为1)百分比值,注意不带%号。
/// {e}为当前所指示或index为0的serie的数据项serieData的name。
/// {h}为当前所指示或index为0的serie的数据项serieData的十六进制颜色值。
/// {f}为数据总和。
/// {g}为数据总个数。
/// {f}为value所对应的y轴的类目值。
/// {.1}表示指定index为1的serie对应颜色的圆点。
/// {a1}、{b1}、{c1}中的1表示指定index为1的serie。
/// {c1:2}表示索引为1的serie的当前指示数据项的第3个数据(一个数据项有多个数据,index为2表示第3个数据)。
/// {c1:2-2}表示索引为1的serie的第3个数据项的第3个数据(也就是要指定第几个数据项时必须要指定第几个数据)。
/// {d1:2:f2}表示单独指定了数值的格式化字符串为f2(不指定时用numericFormatter)。
/// {d:0.##} 表示单独指定了数值的格式化字符串为 0.## (用于百分比,保留2位有效数同时又能避免使用 f2 而出现的类似于"100.00%"的情况 )。
/// 示例:"{a}:{c}"、"{a1}:{c1:f1}"、"{a1}:{c1:0:f1}"、"{a1}:{c1:1-1:f1}" ///
public string titleFormatter { get { return m_TitleFormatter; } set { m_TitleFormatter = value; } } /// /// a string template formatter for a single Serie or data item content. Support for wrapping lines with \n. /// Template variables are {.}, {a}, {b}, {c}, {d}.
/// {.} is the dot of the corresponding color of a Serie that is currently indicated or whose index is 0.
/// {a} is the series name of the serie that is currently indicated or whose index is 0.
/// {b} is the name of the data item serieData that is currently indicated or whose index is 0, or a category value (such as the X-axis of a line chart).
/// {c} is the value of a Y-dimension (dimesion is 1) from a Serie that is currently indicated or whose index is 0.
/// {d} is the percentage value of Y-dimensions (dimesion is 1) from serie that is currently indicated or whose index is 0, with no % sign.
/// {e} is the name of the data item serieData that is currently indicated or whose index is 0.
/// {f} is sum of data.
/// {y} is category value of y axis.
/// {.1} represents a dot from serie corresponding color that specifies index as 1.
/// 1 in {a1}, {b1}, {c1} represents a serie that specifies an index of 1.
/// {c1:2} represents the third data from serie's current indication data item indexed to 1 (a data item has multiple data, index 2 represents the third data).
/// {c1:2-2} represents the third data item from serie's third data item indexed to 1 (i.e., which data item must be specified to specify).
/// {d1:2: F2} indicates that a formatted string with a value specified separately is F2 (numericFormatter is used when numericFormatter is not specified).
/// {d:0.##} indicates that a formatted string with a value specified separately is 0.## (used for percentage, reserved 2 valid digits while avoiding the situation similar to "100.00%" when using f2 ).
/// Example: "{a}, {c}", "{a1}, {c1: f1}", "{a1}, {c1:0: f1}", "{a1} : {c1:1-1: f1}"
/// ||提示框单个serie或数据项内容的字符串模版格式器。支持用 \n 换行。用|来表示多个列的分隔。 /// 模板变量有{.}、{a}、{b}、{c}、{d}、{e}、{f}、{g}。
/// {i}或-表示忽略当前项。 /// {.}为当前所指示的serie或数据项的对应颜色的圆点。
/// {a}为当前所指示的serie或数据项的系列名name。
/// {b}为当前所指示的serie或数据项的数据项serieData的name,或者类目值(如折线图的X轴)。
/// {c}为当前所指示的serie或数据项的y维(dimesion为1)的数值。
/// {d}为当前所指示的serie或数据项的y维(dimesion为1)百分比值,注意不带%号。
/// {e}为当前所指示的serie或数据项的数据项serieData的name。
/// {f}为当前所指示的serie的默认维度的数据总和。
/// {g}为当前所指示的serie的数据总个数。
/// {h}为当前所指示的serie的十六进制颜色值。
/// {y}为当前所指示的serie的y轴的类目值。
/// {c0}表示当前数据项维度为0的数据。
/// {c1}表示当前数据项维度为1的数据。
/// {d3}表示维度3的数据的百分比。它的分母是默认维度(一般是1维度)数据。
/// |表示多个列的分隔。
/// 示例:"{i}", "{.}|{a}|{c}", "{.}|{b}|{c2:f2}", "{.}|{b}|{y}" ///
public string itemFormatter { get { return m_ItemFormatter; } set { m_ItemFormatter = value; } } /// /// Standard number and date format string. Used to format a Double value or a DateTime date as a string. numericFormatter is used as an argument to either `Double.ToString ()` or `DateTime.ToString()`.
/// The number format uses the Axx format: A is a single-character format specifier that supports C currency, D decimal, E exponent, F fixed-point number, G regular, N digit, P percentage, R round trip, and X hexadecimal. xx is precision specification, from 0-99. E.g. F1, E2
/// Date format Common date formats are: yyyy year, MM month, dd day, HH hour, mm minute, ss second, fff millisecond. For example: yyyy-MM-dd HH:mm:ss
/// number format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
/// date format reference: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings
/// ||标准数字和日期格式字符串。用于将Double数值或DateTime日期格式化显示为字符串。numericFormatter用来作为Double.ToString()或DateTime.ToString()的参数。
/// 数字格式使用Axx的形式:A是格式说明符的单字符,支持C货币、D十进制、E指数、F定点数、G常规、N数字、P百分比、R往返、X十六进制的。xx是精度说明,从0-99。如:F1, E2
/// 日期格式常见的格式:yyyy年,MM月,dd日,HH时,mm分,ss秒,fff毫秒。如:yyyy-MM-dd HH:mm:ss
/// 数值格式化参考:https://docs.microsoft.com/zh-cn/dotnet/standard/base-types/standard-numeric-format-strings
/// 日期格式化参考:https://learn.microsoft.com/zh-cn/dotnet/standard/base-types/standard-date-and-time-format-strings ///
public string numericFormatter { get { return m_NumericFormatter; } set { if (PropertyUtil.SetClass(ref m_NumericFormatter, value)) SetComponentDirty(); } } /// /// the marker of serie. /// ||serie的符号标志。 /// public string marker { get { return m_Marker; } set { m_Marker = value; } } /// /// Fixed width. Higher priority than minWidth. /// ||固定宽度。比 minWidth 优先。 /// public float fixedWidth { get { return m_FixedWidth; } set { m_FixedWidth = value; } } /// /// Fixed height. Higher priority than minHeight. /// ||固定高度。比 minHeight 优先。 /// public float fixedHeight { get { return m_FixedHeight; } set { m_FixedHeight = value; } } /// /// Minimum width. If fixedWidth has a value, get fixedWidth first. /// ||最小宽度。如若 fixedWidth 设有值,优先取 fixedWidth。 /// public float minWidth { get { return m_MinWidth; } set { m_MinWidth = value; } } /// /// Minimum height. If fixedHeight has a value, take priority over fixedHeight. /// ||最小高度。如若 fixedHeight 设有值,优先取 fixedHeight。 /// public float minHeight { get { return m_MinHeight; } set { m_MinHeight = value; } } /// /// the text padding of left and right. defaut:5. /// ||左右边距。 /// public int paddingLeftRight { get { return m_PaddingLeftRight; } set { m_PaddingLeftRight = value; } } /// /// the text padding of top and bottom. defaut:5. /// ||上下边距。 /// public int paddingTopBottom { get { return m_PaddingTopBottom; } set { m_PaddingTopBottom = value; } } /// /// Whether to show ignored data on tooltip. /// ||是否显示忽略数据在tooltip上。 /// public bool ignoreDataShow { get { return m_IgnoreDataShow; } set { m_IgnoreDataShow = value; } } /// /// The default display character information for ignored data. /// ||被忽略数据的默认显示字符信息。如果设置为空,则表示完全不显示忽略数据。 /// public string ignoreDataDefaultContent { get { return m_IgnoreDataDefaultContent; } set { m_IgnoreDataDefaultContent = value; } } /// /// The background image of tooltip. /// ||提示框的背景图片。 /// public Sprite backgroundImage { get { return m_BackgroundImage; } set { m_BackgroundImage = value; SetComponentDirty(); } } /// /// The background type of tooltip. /// ||提示框的背景图片显示类型。 /// public Image.Type backgroundType { get { return m_BackgroundType; } set { m_BackgroundType = value; SetComponentDirty(); } } /// /// The background color of tooltip. /// ||提示框的背景颜色。 /// public Color backgroundColor { get { return m_BackgroundColor; } set { m_BackgroundColor = value; SetComponentDirty(); } } /// /// Whether to trigger after always display. /// ||是否触发后一直显示提示框浮层。 /// public bool alwayShowContent { get { return m_AlwayShowContent; } set { m_AlwayShowContent = value; } } /// /// Whether to show the tooltip floating layer, whose default value is true. /// It should be configurated to be false, if you only need tooltip to trigger the event or show the axisPointer without content. /// ||是否显示提示框浮层,默认显示。只需tooltip触发事件或显示axisPointer而不需要显示内容时可配置该项为false。 /// public bool showContent { get { return m_ShowContent; } set { m_ShowContent = value; } } /// /// The position offset of tooltip relative to the mouse position. /// ||提示框相对于鼠标位置的偏移。 /// public Vector2 offset { get { return m_Offset; } set { m_Offset = value; } } /// /// the width of tooltip border. /// ||边框线宽。 /// public float borderWidth { get { return m_BorderWidth; } set { if (PropertyUtil.SetStruct(ref m_BorderWidth, value)) SetVerticesDirty(); } } /// /// the color of tooltip border. /// ||边框颜色。 /// public Color32 borderColor { get { return m_BorderColor; } set { if (PropertyUtil.SetColor(ref m_BorderColor, value)) SetVerticesDirty(); } } /// /// the x positionn of fixedX. /// ||固定X位置的坐标。 /// public float fixedX { get { return m_FixedX; } set { if (PropertyUtil.SetStruct(ref m_FixedX, value)) SetVerticesDirty(); } } /// /// the y position of fixedY. /// ||固定Y位置的坐标。 /// public float fixedY { get { return m_FixedY; } set { if (PropertyUtil.SetStruct(ref m_FixedY, value)) SetVerticesDirty(); } } /// /// height of title text. /// ||标题文本的高。 /// public float titleHeight { get { return m_TitleHeight; } set { if (PropertyUtil.SetStruct(ref m_TitleHeight, value)) SetComponentDirty(); } } /// /// height of content text. /// ||数据项文本的高。 /// public float itemHeight { get { return m_ItemHeight; } set { if (PropertyUtil.SetStruct(ref m_ItemHeight, value)) SetComponentDirty(); } } /// /// the textstyle of title. /// ||标题的文本样式。 /// public LabelStyle titleLabelStyle { get { return m_TitleLabelStyle; } set { if (value != null) { m_TitleLabelStyle = value; SetComponentDirty(); } } } /// /// the textstyle list of content. /// ||内容部分的文本样式列表。和列一一对应。 /// public List contentLabelStyles { get { return m_ContentLabelStyles; } set { if (value != null) { m_ContentLabelStyles = value; SetComponentDirty(); } } } /// /// the line style of indicator line. /// ||指示线样式。 /// public LineStyle lineStyle { get { return m_LineStyle; } set { if (value != null) m_LineStyle = value; SetComponentDirty(); } } /// /// 组件是否需要刷新 /// public override bool componentDirty { get { return m_ComponentDirty || lineStyle.componentDirty; } } public override void ClearComponentDirty() { base.ClearComponentDirty(); lineStyle.ClearComponentDirty(); } /// /// 当前提示框所指示的Serie索引(目前只对散点图有效)。 /// public Dictionary> runtimeSerieIndex = new Dictionary>(); /// /// The data index currently indicated by Tooltip. /// ||当前提示框所指示的数据项索引。 /// public List runtimeDataIndex { get { return m_RuntimeDateIndex; } internal set { m_RuntimeDateIndex = value; } } private List m_RuntimeDateIndex = new List() { -1, -1 }; /// /// Keep Tooltiop displayed at the top. /// ||保持Tooltiop显示在最顶上 /// public void KeepTop() { gameObject.transform.SetAsLastSibling(); } public override void ClearData() { ClearValue(); } /// /// 清除提示框指示数据 /// internal void ClearValue() { for (int i = 0; i < runtimeDataIndex.Count; i++) runtimeDataIndex[i] = -1; } /// /// 提示框是否显示 /// /// public bool IsActive() { return gameObject != null && gameObject.activeInHierarchy; } /// /// 设置Tooltip组件是否显示 /// /// public void SetActive(bool flag) { if (gameObject && gameObject.activeInHierarchy != flag) { gameObject.SetActive(alwayShowContent ? true : flag); } SetContentActive(flag); } /// /// 更新文本框位置 /// /// public void UpdateContentPos(Vector2 pos, float width, float height) { if (view != null) { switch (m_Position) { case Position.Auto: #if UNITY_ANDROID || UNITY_IOS if (m_FixedY == 0) pos.y = ChartHelper.GetActualValue(0.7f, height); else pos.y = ChartHelper.GetActualValue(m_FixedY, height); #endif break; case Position.Custom: pos.x = ChartHelper.GetActualValue(m_FixedX, width); pos.y = ChartHelper.GetActualValue(m_FixedY, height); break; case Position.FixedX: pos.x = ChartHelper.GetActualValue(m_FixedX, width); break; case Position.FixedY: pos.y = ChartHelper.GetActualValue(m_FixedY, height); break; } view.UpdatePosition(pos); } } /// /// 设置文本框是否显示 /// /// public void SetContentActive(bool flag) { if (view == null) return; view.SetActive(alwayShowContent ? true : flag); } /// /// 当前提示框是否选中数据项 /// /// public bool IsSelected() { foreach (var index in runtimeDataIndex) if (index >= 0) return true; return false; } /// /// 指定索引的数据项是否被提示框选中 /// /// /// public bool IsSelected(int index) { foreach (var temp in runtimeDataIndex) if (temp == index) return true; return false; } public void ClearSerieDataIndex() { foreach (var kv in runtimeSerieIndex) { kv.Value.Clear(); } } public void AddSerieDataIndex(int serieIndex, int dataIndex) { if (!runtimeSerieIndex.ContainsKey(serieIndex)) { runtimeSerieIndex[serieIndex] = new List(); } runtimeSerieIndex[serieIndex].Add(dataIndex); } public bool isAnySerieDataIndex() { foreach (var kv in runtimeSerieIndex) { if (kv.Value.Count > 0) return true; } return false; } public bool IsTriggerItem() { return trigger == Trigger.Auto ? context.trigger == Trigger.Item : trigger == Trigger.Item; } public bool IsTriggerAxis() { return trigger == Trigger.Auto ? context.trigger == Trigger.Axis : trigger == Trigger.Axis; } public LabelStyle GetContentLabelStyle(int index) { if (m_ContentLabelStyles.Count == 0) return null; if (index < 0) index = 0; else if (index > m_ContentLabelStyles.Count - 1) index = m_ContentLabelStyles.Count - 1; return m_ContentLabelStyles[index]; } } }