diff --git a/Documentation~/en/api.md b/Documentation~/en/api.md
index 78b775c5..b66f8ebd 100644
--- a/Documentation~/en/api.md
+++ b/Documentation~/en/api.md
@@ -1472,7 +1472,7 @@ Text label of chart, to explain some data information about graphic item like va
|GetOffset()||public Vector3 GetOffset(float radius)|
|IsAutoSize()||public bool IsAutoSize()|
|IsDefaultPosition()||public bool IsDefaultPosition(Position position)|
-|IsInside()||public bool IsInside()|
+|IsInside()||public bool IsInside()
whether the label is inside. |
|Reset()||public void Reset()|
## Lang
diff --git a/Documentation~/en/configuration.md b/Documentation~/en/configuration.md
index 3ced2a6c..d98b5929 100644
--- a/Documentation~/en/configuration.md
+++ b/Documentation~/en/configuration.md
@@ -1220,13 +1220,13 @@ Text label of chart, to explain some data information about graphic item like va
|--|--|--|--|
|show|true||Whether the label is showed.
|Position|||The position of label.
-|autoOffset|false||是否开启自动偏移。当开启时，Y的偏移会自动判断曲线的开口来决定向上还是向下偏移。
+|autoOffset|false||Whether to automatically offset. When turned on, the Y offset will automatically determine the opening of the curve to determine whether to offset up or down.
|offset|||offset to the host graphic element.
|rotate|||Rotation of label.
|autoRotate|false|v3.6.0|auto rotate of label.
-|distance|||距离轴线的距离。
-|formatter|||formatter of label.
-|numericFormatter|||Standard numeric format strings.
+|distance|||the distance of label to axis line.
+|formatter|||label content string template formatter. \n line wrapping is supported. Formatters for some components will not take effect.
Template placeholder have the following, some of which apply only to fixed components:
'{.}' : indicates the dot mark.
'{a}' : indicates the series name.
'{b}' : category value or data name.
'{c}' : data value.
'{d}' : percentage.
'{e}' : indicates the data name.
'{f}' : data sum.
'{g}' : indicates the total number of data.
'{h}' : hexadecimal color value.
'{value}' : The value of the axis or legend.
The following placeholder apply to `UITable` components:
'{name}' : indicates the row name of the table.
'{index}' : indicates the row number of the table.
The following placeholder apply to `UIStatistc` components:
'{title}' : title text.
'{dd}' : day.
'{hh}' : hours.
'{mm}' : minutes.
'{ss}' : second.
'{fff}' : milliseconds.
'{d}' : day.
'{h}' : hours.
'{m}' : minutes.
'{s}' : second.
'{f}' : milliseconds.
Example :{b}:{c}
+|numericFormatter|||Standard numeric format string. Used to format numeric values and display them as strings. Use 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 number, P percentage, R round trip, and X hexadecimal. xx is precision specification, from 0-99. reference: https://docs.microsoft.com/zh-cn/dotnet/standard/base-types/standard-numeric-format-strings
|width|0||the width of label. If set as default value 0, it means than the label width auto set as the text width.
|height|0||the height of label. If set as default value 0, it means than the label height auto set as the text height.
|icon|||the sytle of icon. [IconStyle](#iconstyle)|
diff --git a/Documentation~/zh/api.md b/Documentation~/zh/api.md
index d46985de..bc0c6791 100644
--- a/Documentation~/zh/api.md
+++ b/Documentation~/zh/api.md
@@ -1472,7 +1472,7 @@ Drawing grid in rectangular coordinate. Line chart, bar chart, and scatter chart
|GetOffset()||public Vector3 GetOffset(float radius)|
|IsAutoSize()||public bool IsAutoSize()|
|IsDefaultPosition()||public bool IsDefaultPosition(Position position)|
-|IsInside()||public bool IsInside()|
+|IsInside()||public bool IsInside()
是否在内部。 |
|Reset()||public void Reset()|
## Lang
diff --git a/Documentation~/zh/changelog.md b/Documentation~/zh/changelog.md
index c0dde964..a742bd99 100644
--- a/Documentation~/zh/changelog.md
+++ b/Documentation~/zh/changelog.md
@@ -69,6 +69,7 @@ slug: /changelog
## master
+* (2023.11.14) 完善`LabelStyle`的`formatter`的注释和文档(#291)
* (2023.11.11) 修复`Documentation`部分注释生成文档不完整的问题 (#290)
* (2023.11.11) 修复`Legend`的`formatter`在数据变更时没有自动刷新的问题
* (2023.11.05) 修复`SerieEventData`的`value`一直是0的问题 (#287)
diff --git a/Documentation~/zh/configuration.md b/Documentation~/zh/configuration.md
index aa9d521e..5180b785 100644
--- a/Documentation~/zh/configuration.md
+++ b/Documentation~/zh/configuration.md
@@ -1225,7 +1225,7 @@ Drawing grid in rectangular coordinate. Line chart, bar chart, and scatter chart
|rotate|||文本的旋转。
|autoRotate|false|v3.6.0|是否自动旋转。
|distance|||距离轴线的距离。
-|formatter|||标签内容字符串模版格式器。支持用 \n 换行。 模板变量有： {.}：圆点标记。 {a}：系列名。 {a}：系列名。 {b}：类目值或数据名。 {c}：数据值。 {d}：百分比。 {e}：数据名。 {f}：数据和。 示例：“{b}:{c}”
+|formatter|||标签内容字符串模版格式器。支持用 \n 换行。部分组件的格式器会不生效。
模板通配符有以下这些，部分只适用于固定的组件：
`{.}`：圆点标记。
`{a}`：系列名。
`{b}`：类目值或数据名。
`{c}`：数据值。
`{d}`：百分比。
`{e}`：数据名。
`{f}`：数据和。
`{g}`：数据总个数。
`{h}`：十六进制颜色值。
`{value}`：坐标轴或图例的值。
以下通配符适用UITable组件：
`{name}`： 表格的行名。
`{index}`：表格的行号。
以下通配符适用UIStatistc组件：
`{title}`：标题文本。
`{dd}`：天。
`{hh}`：小时。
`{mm}`：分钟。
`{ss}`：秒。
`{fff}`：毫秒。
`{d}`：天。
`{h}`：小时。
`{m}`：分钟。
`{s}`：秒。
`{f}`：毫秒。
示例：“{b}:{c}”
|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
|width|0||标签的宽度。一般不用指定，不指定时则自动是文字的宽度。
|height|0||标签的高度。一般不用指定，不指定时则自动是文字的高度。
diff --git a/Runtime/Component/Label/LabelStyle.cs b/Runtime/Component/Label/LabelStyle.cs
index 21c1e7c8..d5058eac 100644
--- a/Runtime/Component/Label/LabelStyle.cs
+++ b/Runtime/Component/Label/LabelStyle.cs
@@ -119,17 +119,61 @@ namespace XCharts.Runtime
set { if (PropertyUtil.SetStruct(ref m_Position, value)) SetAllDirty(); }
}
///
- /// formatter of label.
- /// ||标签内容字符串模版格式器。支持用 \n 换行。
- /// 模板变量有：
- /// {.}：圆点标记。
- /// {a}：系列名。
- /// {a}：系列名。
- /// {b}：类目值或数据名。
- /// {c}：数据值。
- /// {d}：百分比。
- /// {e}：数据名。
- /// {f}：数据和。
+ /// label content string template formatter. \n line wrapping is supported. Formatters for some components will not take effect.
+ /// Template placeholder have the following, some of which apply only to fixed components:
+ /// '{.}' : indicates the dot mark.
+ /// '{a}' : indicates the series name.
+ /// '{b}' : category value or data name.
+ /// '{c}' : data value.
+ /// '{d}' : percentage.
+ /// '{e}' : indicates the data name.
+ /// '{f}' : data sum.
+ /// '{g}' : indicates the total number of data.
+ /// '{h}' : hexadecimal color value.
+ /// '{value}' : The value of the axis or legend.
+ /// The following placeholder apply to `UITable` components:
+ /// '{name}' : indicates the row name of the table.
+ /// '{index}' : indicates the row number of the table.
+ /// The following placeholder apply to `UIStatistc` components:
+ /// '{title}' : title text.
+ /// '{dd}' : day.
+ /// '{hh}' : hours.
+ /// '{mm}' : minutes.
+ /// '{ss}' : second.
+ /// '{fff}' : milliseconds.
+ /// '{d}' : day.
+ /// '{h}' : hours.
+ /// '{m}' : minutes.
+ /// '{s}' : second.
+ /// '{f}' : milliseconds.
+ /// Example :{b}:{c}
+ /// ||标签内容字符串模版格式器。支持用 \n 换行。部分组件的格式器会不生效。
+ /// 模板通配符有以下这些，部分只适用于固定的组件：
+ /// `{.}`：圆点标记。
+ /// `{a}`：系列名。
+ /// `{b}`：类目值或数据名。
+ /// `{c}`：数据值。
+ /// `{d}`：百分比。
+ /// `{e}`：数据名。
+ /// `{f}`：数据和。
+ /// `{g}`：数据总个数。
+ /// `{h}`：十六进制颜色值。
+ /// `{value}`：坐标轴或图例的值。
+ /// 以下通配符适用UITable组件：
+ /// `{name}`： 表格的行名。
+ /// `{index}`：表格的行号。
+ /// 以下通配符适用UIStatistc组件：
+ /// `{title}`：标题文本。
+ /// `{dd}`：天。
+ /// `{hh}`：小时。
+ /// `{mm}`：分钟。
+ /// `{ss}`：秒。
+ /// `{fff}`：毫秒。
+ /// `{d}`：天。
+ /// `{h}`：小时。
+ /// `{m}`：分钟。
+ /// `{s}`：秒。
+ /// `{f}`：毫秒。
/// 示例：“{b}:{c}”
///
public string formatter
@@ -138,6 +182,20 @@ namespace XCharts.Runtime
set { if (PropertyUtil.SetClass(ref m_Formatter, value)) SetComponentDirty(); }
}
///
+ /// Standard numeric format string. Used to format numeric values and display them as strings.
+ /// Use 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 number, P percentage, R round trip, and X hexadecimal. xx is precision specification, from 0-99.
+ /// reference: https://docs.microsoft.com/zh-cn/dotnet/standard/base-types/standard-numeric-format-strings
+ /// ||标准数字格式字符串。用于将数值格式化显示为字符串。
+ /// 使用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
+ ///
+ ///
+ public string numericFormatter
+ {
+ get { return m_NumericFormatter; }
+ set { if (PropertyUtil.SetClass(ref m_NumericFormatter, value)) SetComponentDirty(); }
+ }
+ ///
/// offset to the host graphic element.
/// ||距离图形元素的偏移
///
@@ -165,7 +223,8 @@ namespace XCharts.Runtime
set { if (PropertyUtil.SetStruct(ref m_AutoRotate, value)) SetComponentDirty(); }
}
///
- /// 距离轴线的距离。
+ /// the distance of label to axis line.
+ /// ||距离轴线的距离。
///
public float distance
{
@@ -202,19 +261,8 @@ namespace XCharts.Runtime
set { if (PropertyUtil.SetClass(ref m_TextPadding, value)) SetComponentDirty(); }
}
///
- /// Standard numeric format strings.
- /// ||标准数字格式字符串。用于将数值格式化显示为字符串。
- /// 使用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
- ///
- ///
- public string numericFormatter
- {
- get { return m_NumericFormatter; }
- set { if (PropertyUtil.SetClass(ref m_NumericFormatter, value)) SetComponentDirty(); }
- }
- ///
- /// 是否开启自动偏移。当开启时，Y的偏移会自动判断曲线的开口来决定向上还是向下偏移。
+ /// Whether to automatically offset. When turned on, the Y offset will automatically determine the opening of the curve to determine whether to offset up or down.
+ /// ||是否开启自动偏移。当开启时，Y的偏移会自动判断曲线的开口来决定向上还是向下偏移。
///
public bool autoOffset
{
@@ -248,12 +296,19 @@ namespace XCharts.Runtime
get { return m_TextStyle; }
set { if (PropertyUtil.SetClass(ref m_TextStyle, value)) SetAllDirty(); }
}
+ ///
+ /// the formatter function of label, which supports string template and callback function.
+ /// ||标签的文本格式化函数，支持字符串模版和回调函数。
+ ///
public LabelFormatterFunction formatterFunction
{
get { return m_FormatterFunction; }
set { m_FormatterFunction = value; }
}
-
+ ///
+ /// whether the label is inside.
+ /// ||是否在内部。
+ ///
public bool IsInside()
{
return m_Position == Position.Inside || m_Position == Position.Center;