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

完善文档

Browse Source
This commit is contained in:
monitor1394
2020-07-15 09:11:35 +08:00
parent 57f9416c54
commit cc6452f7ce
5 changed files with 159 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Runtime/Component/Main/DataZoom.cs
View File

@@ -14,6 +14,7 @@ namespace XCharts
/// 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.
///
/// <para>DataZoom 组件 用于区域缩放，从而能自由关注细节的数据信息，或者概览数据整体，或者去除离群点的影响。</para>
/// </summary>
[System.Serializable]
@@ -23,6 +24,7 @@ namespace XCharts
/// Generally dataZoom component zoom or roam coordinate system through data filtering
/// and set the windows of axes internally.
/// Its behaviours vary according to filtering mode settings.
///
/// dataZoom 的运行原理是通过 数据过滤 来达到 数据窗口缩放 的效果。数据过滤模式的设置不同，效果也不同。
/// </summary>
public enum FilterMode
@@ -30,17 +32,20 @@ namespace XCharts
/// <summary>
/// data that outside the window will be filtered, which may lead to some changes of windows of other axes.
/// For each data item, it will be filtered if one of the relevant dimensions is out of the window.
///
/// 当前数据窗口外的数据，被 过滤掉。即 会 影响其他轴的数据范围。每个数据项，只要有一个维度在数据窗口外，整个数据项就会被过滤掉。
/// </summary>
Filter,
/// <summary>
/// data that outside the window will be filtered, which may lead to some changes of windows of other axes.
/// For each data item, it will be filtered only if all of the relevant dimensions are out of the same side of the window.
///
/// 当前数据窗口外的数据，被 过滤掉。即 会 影响其他轴的数据范围。每个数据项，只有当全部维度都在数据窗口同侧外部，整个数据项才会被过滤掉。
/// </summary>
WeakFilter,
/// <summary>
/// data that outside the window will be set to NaN, which will not lead to changes of windows of other axes.
///
/// 当前数据窗口外的数据，被 设置为空。即 不会 影响其他轴的数据范围。
/// </summary>
Empty,
@@ -123,6 +128,10 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_YAxisIndex, value)) SetVerticesDirty(); }
}
/// <summary>
/// Whether built-in support is supported.
/// Built into the coordinate system to allow the user to zoom in and out of the coordinate system by mouse dragging,
/// mouse wheel, finger swiping (on the touch screen).
///
/// 是否支持内置。内置于坐标系中，使用户可以在坐标系上通过鼠标拖拽、鼠标滚轮、手指滑动（触屏上）来缩放或漫游坐标系。
/// </summary>
public bool supportInside
@@ -131,6 +140,7 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_SupportInside, value)) SetVerticesDirty(); }
}
/// <summary>
/// Whether a slider is supported. There are separate sliders on which the user zooms or roams.
/// 是否支持滑动条。有单独的滑动条，用户在滑动条上进行缩放或漫游。
/// </summary>
public bool supportSlider
@@ -159,6 +169,7 @@ namespace XCharts
/// <summary>
/// Whether to show detail, that is, show the detailed data information when dragging.
/// 是否显示detail，即拖拽时候显示详细数值信息。
/// [default: false]
/// </summary>
public bool showDetail
{
@@ -225,7 +236,7 @@ namespace XCharts
}
/// <summary>
/// The start percentage of the window out of the data extent, in the range of 0 ~ 100.
/// default:30
/// [default:30].
/// 数据窗口范围的起始百分比。范围是：0 ~ 100。
/// </summary>
public float start
@@ -244,6 +255,7 @@ namespace XCharts
set { m_End = value; if (m_End < 0) m_End = 0; if (m_End > 100) m_End = 100; SetVerticesDirty(); }
}
/// <summary>
/// Minimum number of display data. Minimum number of data displayed when DataZoom is enlarged to maximum.
/// 最小显示数据个数。当DataZoom放大到最大时，最小显示的数据个数。
/// </summary>
public int minShowNum

9
Runtime/Component/Main/Tooltip.cs
View File

@@ -140,18 +140,22 @@ namespace XCharts
public string itemFormatter { get { return m_ItemFormatter; } set { m_ItemFormatter = value; } }
/// <summary>
/// Fixed width. Higher priority than minWidth.
/// 固定宽度。比 minWidth 优先。
/// </summary>
public float fixedWidth { get { return m_FixedWidth; } set { m_FixedWidth = value; } }
/// <summary>
/// Fixed height. Higher priority than minHeight.
/// 固定高度。比 minHeight 优先。
/// </summary>
public float fixedHeight { get { return m_FixedHeight; } set { m_FixedHeight = value; } }
/// <summary>
/// Minimum width. If fixedWidth has a value, get fixedWidth first.
/// 最小宽度。如若 fixedWidth 设有值，优先取 fixedWidth。
/// </summary>
public float minWidth { get { return m_MinWidth; } set { m_MinWidth = value; } }
/// <summary>
/// Minimum height. If fixedHeight has a value, take priority over fixedHeight.
/// 最小高度。如若 fixedHeight 设有值，优先取 fixedHeight。
/// </summary>
public float minHeight { get { return m_MinHeight; } set { m_MinHeight = value; } }
@@ -185,6 +189,7 @@ namespace XCharts
/// </summary>
public float paddingTopBottom { get { return m_PaddingTopBottom; } set { m_PaddingTopBottom = value; } }
/// <summary>
/// The default display character information for ignored data.
/// 被忽略数据的默认显示字符信息。
/// </summary>
public string ignoreDataDefaultContent { get { return m_IgnoreDataDefaultContent; } set { m_IgnoreDataDefaultContent = value; } }
@@ -194,14 +199,17 @@ namespace XCharts
/// </summary>
public Sprite backgroundImage { get { return m_BackgroundImage; } set { m_BackgroundImage = value; SetBackground(m_BackgroundImage); } }
/// <summary>
/// Whether to trigger after always display.
/// 是否触发后一直显示。
/// </summary>
public bool alwayShow { get { return m_AlwayShow; } set { m_AlwayShow = value; } }
/// <summary>
/// The position offset of tooltip relative to the mouse position.
/// 提示框相对于鼠标位置的偏移。
/// </summary>
public Vector2 offset { get { return m_Offset; } set { m_Offset = value; } }
/// <summary>
/// the text style of content.
/// 提示框内容文本样式。
/// </summary>
public TextStyle textStyle
@@ -210,6 +218,7 @@ namespace XCharts
set { if (value != null) { m_TextStyle = value; SetComponentDirty(); } }
}
/// <summary>
/// the line style of indicator line.
/// 指示线样式。
/// </summary>
public LineStyle lineStyle

18
Runtime/Component/Main/Vessel.cs
View File

@@ -11,10 +11,10 @@ using UnityEngine;
namespace XCharts
{
/// <summary>
/// Vessel component for liquid chart.
/// Vessel component for liquid chart. There can be multiple vessels in a Chart, which can be matched by vesselIndex in Serie.
/// <para>
/// 容器组件。
/// 一般用于LiquidChart。可以有多个Vessel，Serie中用vesselIndex来对应。
/// 一般用于LiquidChart。一个Chart中可以有多个Vessel，Serie中用vesselIndex来对应。
/// </para>
/// </summary>
[Serializable]
@@ -57,6 +57,7 @@ namespace XCharts
/// <summary>
/// Whether to show the vessel.
/// 是否显示容器组件。
/// [defaut: true]
/// </summary>
public bool show
{
@@ -66,6 +67,7 @@ namespace XCharts
/// <summary>
/// The shape of vessel.
/// 容器形状。
/// [default: Shape.Circle]
/// </summary>
public Shape shape
{
@@ -75,6 +77,7 @@ namespace XCharts
/// <summary>
/// Thickness of vessel.
/// 容器厚度。
/// [defaut: 5f]
/// </summary>
public float shapeWidth
{
@@ -84,6 +87,7 @@ namespace XCharts
/// <summary>
/// The gap between the vessel and the liquid.
/// 间隙。容器和液体的间隙。
/// [defaut: 10f]
/// </summary>
public float gap
{
@@ -91,8 +95,11 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_Gap, value)) SetVerticesDirty(); }
}
/// <summary>
/// The center of vesselß. The center[0] is the x-coordinate, and the center[1] is the y-coordinate.
/// When value between 0 and 1 represents a percentage relative to the chart.
/// 中心点。数组的第一项是横坐标，第二项是纵坐标。
/// 当值为0-1之间时表示百分比，设置成百分比时表示图表宽高最小值的百分比。
/// [default:[0.5f,0.45f]]
/// </summary>
public float[] center
{
@@ -101,7 +108,9 @@ namespace XCharts
}
/// <summary>
/// The radius of vessel.
/// When value between 0 and 1 represents a percentage relative to the chart.
/// 半径。
/// [default: 0.35f]
/// </summary>
public float radius
{
@@ -111,6 +120,7 @@ namespace XCharts
/// <summary>
/// The smoothness of wave.
/// 水波平滑度。
/// [default: 1f]
/// </summary>
public float smoothness
{
@@ -120,6 +130,7 @@ namespace XCharts
/// <summary>
/// Background color of polar, which is transparent by default.
/// 背景色，默认透明。
/// [default: `Color.clear`]
/// </summary>
public Color backgroundColor
{
@@ -127,6 +138,7 @@ namespace XCharts
set { if (PropertyUtility.SetColor(ref m_BackgroundColor, value)) SetVerticesDirty(); }
}
/// <summary>
/// Vessel color. The default is consistent with Serie.
/// 容器颜色。默认和serie一致。
/// </summary>
public Color color
@@ -135,7 +147,9 @@ namespace XCharts
set { if (PropertyUtility.SetColor(ref m_Color, value)) SetVerticesDirty(); }
}
/// <summary>
/// Whether automatic color. If true, the color matches serie.
/// 是否自动颜色。为true时颜色会和serie一致。
/// [default: true]
/// </summary>
public bool autoColor
{

46
Runtime/Component/Main/VisualMap.cs
View File

@@ -11,7 +11,7 @@ using UnityEngine;
namespace XCharts
{
/// <summary>
/// VisualMap component.
/// VisualMap component. Mapping data to visual elements such as colors.
/// 视觉映射组件。用于进行『视觉编码』，也就是将数据映射到视觉元素（视觉通道）。
/// </summary>
[System.Serializable]
@@ -71,7 +71,11 @@ namespace XCharts
[SerializeField] private List<Color> m_OutOfRange = new List<Color>();
/// <summary>
/// Whether enable visualMap component.
///
/// 是否开启组件功能。
///
/// [default: false]
/// </summary>
public bool enable
{
@@ -79,7 +83,11 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_Enable, value)) SetVerticesDirty(); }
}
/// <summary>
/// Whether to display components. If set to false, it will not show up, but the data mapping function still exists.
///
/// 是否显示组件。如果设置为 false，不会显示，但是数据映射的功能还存在。
///
/// [default: true]
/// </summary>
public bool show
{
@@ -87,6 +95,7 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_Enable, value)) SetVerticesDirty(); }
}
/// <summary>
/// the type of visualmap component.
/// 组件类型。
/// </summary>
public Type type
@@ -95,6 +104,7 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_Type, value)) SetVerticesDirty(); }
}
/// <summary>
/// the selected mode for Piecewise visualMap.
/// 选择模式。
/// </summary>
public SelectedMode selectedMode
@@ -103,6 +113,8 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_SelectedMode, value)) SetVerticesDirty(); }
}
/// <summary>
/// The minimum allowed. 'min' must be user specified. [visualmap.min, visualmap.max] forms the "domain" of the visualMap.
///
/// 允许的最小值。'min' 必须用户指定。[visualMap.min, visualMap.max] 形成了视觉映射的『定义域』。
/// </summary>
public float min
@@ -111,6 +123,8 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_Min, value)) SetVerticesDirty(); }
}
/// <summary>
/// The maximum allowed. 'max' must be user specified. [visualmap.min, visualmap.max] forms the "domain" of the visualMap.
///
/// 允许的最大值。'max' 必须用户指定。[visualMap.min, visualMax.max] 形成了视觉映射的『定义域』。
/// </summary>
public float max
@@ -119,18 +133,25 @@ namespace XCharts
set { m_Max = value < min ? min + 1 : value; SetVerticesDirty(); }
}
/// <summary>
/// 指定手柄对应数值的位置。range 应在 min max 范围内。
/// Specifies the position of the numeric value corresponding to the handle. Range should be within the range of [min,max].
///
/// 指定手柄对应数值的位置。range 应在[min,max]范围内。
/// </summary>
public float[] range { get { return m_Range; } }
/// <summary>
/// Text on both ends.
/// 两端的文本，如 ['High', 'Low']。
/// </summary>
public string[] text { get { return m_Text; } }
/// <summary>
/// The distance between the two text bodies.
/// 两端文字主体之间的距离，单位为px。
/// </summary>
public float[] textGap { get { return m_TextGap; } }
/// <summary>
/// For continuous data, it is automatically evenly divided into several segments
/// and automatically matches the size of inRange color list when the default is 0.
///
/// 对于连续型数据，自动平均切分成几段，默认为0时自动匹配inRange颜色列表大小。
/// </summary>
/// <value></value>
@@ -140,6 +161,8 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_SplitNumber, value)) SetVerticesDirty(); }
}
/// <summary>
/// Whether the handle used for dragging is displayed (the handle can be dragged to adjust the selected range).
///
/// 是否显示拖拽用的手柄（手柄能拖拽调整选中范围）。
/// </summary>
public bool calculable
@@ -148,6 +171,8 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_Calculable, value)) SetVerticesDirty(); }
}
/// <summary>
/// Whether to update in real time while dragging.
///
/// 拖拽时，是否实时更新。
/// </summary>
public bool realtime
@@ -156,6 +181,8 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_Realtime, value)) SetVerticesDirty(); }
}
/// <summary>
/// The width of the figure, that is, the width of the color bar.
///
/// 图形的宽度，即颜色条的宽度。
/// </summary>
public float itemWidth
@@ -164,6 +191,8 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_ItemWidth, value)) SetVerticesDirty(); }
}
/// <summary>
/// The height of the figure, that is, the height of the color bar.
///
/// 图形的高度，即颜色条的高度。
/// </summary>
public float itemHeight
@@ -172,6 +201,8 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_ItemHeight, value)) SetVerticesDirty(); }
}
/// <summary>
/// Border line width.
///
/// 边框线宽，单位px。
/// </summary>
public float borderWidth
@@ -180,6 +211,9 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_BorderWidth, value)) SetVerticesDirty(); }
}
/// <summary>
/// Specifies "which dimension" of the data to map to the visual element. "Data" is series.data.
/// Starting at 1, the default is 0 to take the last dimension in data.
///
/// 指定用数据的『哪个维度』，映射到视觉元素上。『数据』即 series.data。从1开始，默认为0取 data 中最后一个维度。
/// </summary>
public int dimension
@@ -188,6 +222,11 @@ namespace XCharts
set { if (PropertyUtility.SetStruct(ref m_Dimension, value)) SetVerticesDirty(); }
}
/// <summary>
/// When the hoverLink function is turned on, when the mouse hovers over the visualMap component,
/// the corresponding value of the mouse position is highlighted in the corresponding graphic element in the diagram.
/// Conversely, when the mouse hovers over a graphic element in a diagram,
/// the corresponding value of the visualMap component is triangulated in the corresponding position.
///
/// 打开 hoverLink 功能时，鼠标悬浮到 visualMap 组件上时，鼠标位置对应的数值 在 图表中对应的图形元素，会高亮。
/// 反之，鼠标悬浮到图表中的图形元素上时，在 visualMap 组件的相应位置会有三角提示其所对应的数值。
/// </summary>
@@ -199,6 +238,7 @@ namespace XCharts
}
/// <summary>
/// Specify whether the layout of component is horizontal or vertical.
///
/// 布局方式是横还是竖。
/// </summary>
public Orient orient
@@ -216,6 +256,7 @@ namespace XCharts
set { if (PropertyUtility.SetClass(ref m_Location, value)) SetVerticesDirty(); }
}
/// <summary>
/// Defines the visual color in the selected range.
/// 定义 在选中范围中 的视觉颜色。
/// </summary>
public List<Color> inRange
@@ -224,6 +265,7 @@ namespace XCharts
set { if (value != null) { m_InRange = value; SetVerticesDirty(); } }
}
/// <summary>
/// Defines a visual color outside of the selected range.
/// 定义 在选中范围外 的视觉颜色。
/// </summary>
public List<Color> outOfRange