foldcc/XCharts
1
0
Fork 0
mirror of https://github.com/XCharts-Team/XCharts.git synced 2026-05-24 09:50:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

完善LabelStyle的formatter的注释和文档(#291)

Browse Source
This commit is contained in:
monitor1394
2023-11-14 13:18:31 +08:00
parent c9ac0daed9
commit b959b15c71
6 changed files with 89 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation~/en/api.md
View File

@@ -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()<br/>whether the label is inside. |
|Reset()||public void Reset()|
## Lang

8
Documentation~/en/configuration.md
View File

@@ -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. <br /> Template placeholder have the following, some of which apply only to fixed components: <br /> '{.}' : indicates the dot mark. <br /> '{a}' : indicates the series name. <br /> '{b}' : category value or data name. <br /> '{c}' : data value. <br /> '{d}' : percentage. <br /> '{e}' : indicates the data name. <br /> '{f}' : data sum. <br /> '{g}' : indicates the total number of data. <br /> '{h}' : hexadecimal color value. <br /> '{value}' : The value of the axis or legend. <br /> The following placeholder apply to `UITable` components: <br /> '{name}' : indicates the row name of the table. <br /> '{index}' : indicates the row number of the table. <br /> The following placeholder apply to `UIStatistc` components: <br /> '{title}' : title text. <br /> '{dd}' : day. <br /> '{hh}' : hours. <br /> '{mm}' : minutes. <br /> '{ss}' : second. <br /> '{fff}' : milliseconds. <br /> '{d}' : day. <br /> '{h}' : hours. <br /> '{m}' : minutes. <br /> '{s}' : second. <br /> '{f}' : milliseconds. <br /> Example :{b}:{c}<br />
|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)|

2
Documentation~/zh/api.md
View File

@@ -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()<br/>是否在内部。 |
|Reset()||public void Reset()|
## Lang

1
Documentation~/zh/changelog.md
View File

@@ -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)

2
Documentation~/zh/configuration.md
View File

@@ -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 换行。部分组件的格式器会不生效。<br/> 模板通配符有以下这些，部分只适用于固定的组件：<br/> `{.}`：圆点标记。<br/> `{a}`：系列名。<br/> `{b}`：类目值或数据名。<br/> `{c}`：数据值。<br/> `{d}`：百分比。<br/> `{e}`：数据名。<br/> `{f}`：数据和。<br/> `{g}`：数据总个数。<br/> `{h}`：十六进制颜色值。<br/> `{value}`：坐标轴或图例的值。<br/> 以下通配符适用UITable组件：<br/> `{name}`： 表格的行名。<br/> `{index}`：表格的行号。<br/> 以下通配符适用UIStatistc组件：<br/> `{title}`：标题文本。<br/> `{dd}`：天。<br/> `{hh}`：小时。<br/> `{mm}`：分钟。<br/> `{ss}`：秒。<br/> `{fff}`：毫秒。<br/> `{d}`：天。<br/> `{h}`：小时。<br/> `{m}`：分钟。<br/> `{s}`：秒。<br/> `{f}`：毫秒。<br/> 示例：“{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||标签的高度。一般不用指定，不指定时则自动是文字的高度。

107
Runtime/Component/Label/LabelStyle.cs
View File

@@ -119,17 +119,61 @@ namespace XCharts.Runtime
set { if (PropertyUtil.SetStruct(ref m_Position, value)) SetAllDirty(); }
}
/// <summary>
/// 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. <br />
/// Template placeholder have the following, some of which apply only to fixed components: <br />
/// '{.}' : indicates the dot mark. <br />
/// '{a}' : indicates the series name. <br />
/// '{b}' : category value or data name. <br />
/// '{c}' : data value. <br />
/// '{d}' : percentage. <br />
/// '{e}' : indicates the data name. <br />
/// '{f}' : data sum. <br />
/// '{g}' : indicates the total number of data. <br />
/// '{h}' : hexadecimal color value. <br />
/// '{value}' : The value of the axis or legend. <br />
/// The following placeholder apply to `UITable` components: <br />
/// '{name}' : indicates the row name of the table. <br />
/// '{index}' : indicates the row number of the table. <br />
/// The following placeholder apply to `UIStatistc` components: <br />
/// '{title}' : title text. <br />
/// '{dd}' : day. <br />
/// '{hh}' : hours. <br />
/// '{mm}' : minutes. <br />
/// '{ss}' : second. <br />
/// '{fff}' : milliseconds. <br />
/// '{d}' : day. <br />
/// '{h}' : hours. <br />
/// '{m}' : minutes. <br />
/// '{s}' : second. <br />
/// '{f}' : milliseconds. <br />
/// Example :{b}:{c}<br />
/// ||标签内容字符串模版格式器。支持用 \n 换行。部分组件的格式器会不生效。<br/>
/// 模板通配符有以下这些，部分只适用于固定的组件：<br/>
/// `{.}`：圆点标记。<br/>
/// `{a}`：系列名。<br/>
/// `{b}`：类目值或数据名。<br/>
/// `{c}`：数据值。<br/>
/// `{d}`：百分比。<br/>
/// `{e}`：数据名。<br/>
/// `{f}`：数据和。<br/>
/// `{g}`：数据总个数。<br/>
/// `{h}`：十六进制颜色值。<br/>
/// `{value}`：坐标轴或图例的值。<br/>
/// 以下通配符适用UITable组件：<br/>
/// `{name}`： 表格的行名。<br/>
/// `{index}`：表格的行号。<br/>
/// 以下通配符适用UIStatistc组件：<br/>
/// `{title}`：标题文本。<br/>
/// `{dd}`：天。<br/>
/// `{hh}`：小时。<br/>
/// `{mm}`：分钟。<br/>
/// `{ss}`：秒。<br/>
/// `{fff}`：毫秒。<br/>
/// `{d}`：天。<br/>
/// `{h}`：小时。<br/>
/// `{m}`：分钟。<br/>
/// `{s}`：秒。<br/>
/// `{f}`：毫秒。<br/>
/// 示例：“{b}:{c}”
/// </summary>
public string formatter
@@ -138,6 +182,20 @@ namespace XCharts.Runtime
set { if (PropertyUtil.SetClass(ref m_Formatter, value)) SetComponentDirty(); }
}
/// <summary>
/// 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
/// </summary>
/// <value></value>
public string numericFormatter
{
get { return m_NumericFormatter; }
set { if (PropertyUtil.SetClass(ref m_NumericFormatter, value)) SetComponentDirty(); }
}
/// <summary>
/// offset to the host graphic element.
/// ||距离图形元素的偏移
/// </summary>
@@ -165,7 +223,8 @@ namespace XCharts.Runtime
set { if (PropertyUtil.SetStruct(ref m_AutoRotate, value)) SetComponentDirty(); }
}
/// <summary>
/// 距离轴线的距离。
/// the distance of label to axis line.
/// ||距离轴线的距离。
/// </summary>
public float distance
{
@@ -202,19 +261,8 @@ namespace XCharts.Runtime
set { if (PropertyUtil.SetClass(ref m_TextPadding, value)) SetComponentDirty(); }
}
/// <summary>
/// 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
/// </summary>
/// <value></value>
public string numericFormatter
{
get { return m_NumericFormatter; }
set { if (PropertyUtil.SetClass(ref m_NumericFormatter, value)) SetComponentDirty(); }
}
/// <summary>
/// 是否开启自动偏移。当开启时，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的偏移会自动判断曲线的开口来决定向上还是向下偏移。
/// </summary>
public bool autoOffset
{
@@ -248,12 +296,19 @@ namespace XCharts.Runtime
get { return m_TextStyle; }
set { if (PropertyUtil.SetClass(ref m_TextStyle, value)) SetAllDirty(); }
}
/// <summary>
/// the formatter function of label, which supports string template and callback function.
/// ||标签的文本格式化函数，支持字符串模版和回调函数。
/// </summary>
public LabelFormatterFunction formatterFunction
{
get { return m_FormatterFunction; }
set { m_FormatterFunction = value; }
}
/// <summary>
/// whether the label is inside.
/// ||是否在内部。
/// </summary>
public bool IsInside()
{
return m_Position == Position.Inside || m_Position == Position.Center;