XCharts Namespace Reference

Classes
class	AddSerieEditor
class	AngleAxis
	Angle axis of Polar Coordinate. 极坐标系的角度轴。 More...
class	AngleAxisDrawer
class	AngleAxisTheme
class	AnimationDrawer
class	AreaStyle
	The style of area. 区域填充样式。 More...
class	AreaStyleDrawer
class	Arrow
class	ArrowDrawer
class	Axis
	The axis in rectangular coordinate. 直角坐标系的坐标轴组件。 More...
class	AxisDrawer
class	AxisHelper
class	AxisLabel
	Settings related to axis label. 坐标轴刻度标签的相关设置。 More...
class	AxisLabelDrawer
class	AxisLine
	Settings related to axis line. 坐标轴轴线。 More...
class	AxisLineDrawer
class	AxisName
	the name of axis. 坐标轴名称。 More...
class	AxisNameDrawer
class	AxisSplitArea
	Split area of axis in grid area, not shown by default. 坐标轴在 grid 区域中的分隔区域，默认不显示。 More...
class	AxisSplitAreaDrawer
class	AxisSplitLine
	Split line of axis in grid area. 坐标轴在 grid 区域中的分隔线。 More...
class	AxisSplitLineDrawer
class	AxisTheme
class	AxisThemeDrawer
class	AxisTick
	Settings related to axis tick. 坐标轴刻度相关设置。 More...
class	AxisTickDrawer
class	Background
	Background component. Due to the limitations of the framework, there are two limitations to the use of background component: 1: The parent node of chart cannot have a layout control class component. 2: The parent node of Chart can only have one child node of the current chart. More...
class	BackgroundDrawer
class	BarChart
class	BarChartEditor
	Editor class used to edit UI BarChart. More...
class	BaseAxisTheme
class	BaseAxisThemeDrawer
class	BaseChart
	The base class of all charts. 所有Chart的基类。 More...
class	BaseChartEditor
	Editor class used to edit UI BaseChart. More...
class	BaseGraph
	The base class of all graphs or components. 所有图形的基类。 More...
class	BaseLine
	Settings related to base line. 线条基础配置。 More...
class	BaseLineDrawer
class	BasePropertyDrawer
class	CandlestickChart
class	CandlestickChartEditor
	Editor class used to edit UI CandlestickChart. More...
class	ChartCached
class	ChartComponent
class	ChartConst
class	ChartDrawer
class	ChartEditorHelper
class	ChartHelper
class	ChartLabel
class	ChartObject
class	ChartText
class	ChartTheme
	Theme. 主题相关配置。 More...
class	CheckHelper
class	CheckVersionEditor
class	ColorUtil
class	ComponentTheme
class	ComponentThemeDrawer
class	CoordinateChart
	The basic class of rectangular coordinate chart，such as LineChart,BarChart and ScatterChart. 直角坐标系类型图表的基类，如折线图LineChart，柱状图BarChart，散点图ScatterChart都属于这类型的图表。 不可用直接将CoordinateChart绑定到GameObject上。 More...
class	CoordinateChartEditor
	Editor class used to edit UI CoordinateChart. More...
class	DataZoom
	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. More...
class	DataZoomDrawer
class	DataZoomHandler
class	DataZoomHelper
class	DataZoomTheme
class	DataZoomThemeDrawer
class	DateTimeUtil
class	DrawSerieGauge
class	DrawSerieLiquid
class	DrawSeriePie
class	DrawSerieRadar
class	DrawSerieRing
class	DrawSerieTemplate
class	Emphasis
	高亮的图形样式和文本标签样式。 More...
class	EmphasisDrawer
class	ExportThemeWindow
class	FormatterHelper
class	GaugeAxis
	Settings related to gauge axis line. 仪表盘轴线相关设置。 More...
class	GaugeAxisDrawer
class	GaugeAxisLine
class	GaugeAxisLineDrawer
class	GaugeAxisLineStageColorDrawer
class	GaugeAxisSplitDrawer
class	GaugeAxisSplitLine
	分割线 More...
class	GaugeAxisTheme
class	GaugeAxisThemeDrawer
class	GaugeAxisTick
	刻度 More...
class	GaugeAxisTickDrawer
class	GaugeChart
class	GaugeChartEditor
	Editor class used to edit UI GaugeChart. More...
class	GaugePointer
	Settings related to gauge pointer. 仪表盘指针相关设置。 More...
class	GaugePointerDrawer
class	Grid
	Grid component. Drawing grid in rectangular coordinate. In a single grid, at most two X and Y axes each is allowed. Line chart, bar chart, and scatter chart can be drawn in grid. There is only one single grid component at most in a single echarts instance. More...
class	GridDrawer
class	HeatmapChart
class	HeatmapChartEditor
	Editor class used to edit UI HeatmapChart. More...
interface	IComponentHandler
class	IconStyle
class	IconStyleDrawer
interface	IDrawSerie
interface	IPropertyChanged
	属性变更接口 More...
class	ItemStyle
	图形样式。 More...
class	ItemStyleDrawer
class	ItemStyleHelper
class	LayerHelper
class	Legend
	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. 图例组件。 图例组件展现了不同系列的标记，颜色和名字。可以通过点击图例控制哪些系列不显示。 More...
class	LegendDrawer
class	LegendHelper
class	LegendItem
class	LegendTheme
class	LegendThemeDrawer
class	LineArrow
class	LineArrowStyleDrawer
class	LineChart
class	LineChartEditor
	Editor class used to edit UI LineChart. More...
class	LineStyle
	The style of line. 线条样式。 注： 修改 lineStyle 中的颜色不会影响图例颜色，如果需要图例颜色和折线图颜色一致，需修改 itemStyle.color，线条颜色默认也会取该颜色。 toColor，toColor2可设置水平方向的渐变，如需要设置垂直方向的渐变，可使用VisualMap。 More...
class	LineStyleDrawer
class	LiquidChart
	水位图 More...
class	LiquidChartEditor
	Editor class used to edit UI LiquidChart. More...
class	ListPool
class	Location
	Location type. Quick to set the general location. 位置类型。通过Align快速设置大体位置，再通过left，right，top，bottom微调具体位置。 More...
class	LocationDrawer
class	MainComponent
class	MarkLine
	Use a line in the chart to illustrate. 图表标线。 More...
class	MarkLineData
	Data of marking line. 图表标线的数据。 More...
class	MarkLineDataDrawer
class	MarkLineDrawer
class	MarkLineHandler
class	MarkLineHelper
class	MathUtil
class	ObjectPool
class	Painter
class	PiecesDrawer
class	PieChart
class	PieChartEditor
	Editor class used to edit UI PieChart. More...
class	Polar
	Polar coordinate can be used in scatter and line chart. Every polar coordinate has an angleAxis and a radiusAxis. More...
class	PolarAxisTheme
class	PolarChart
class	PolarChartEditor
	Editor class used to edit UI PolarChart. More...
class	PolarDrawer
class	PolarHelper
class	PraseJsonDataEditor
class	PropertyUtil
class	Radar
	Radar coordinate conponnet for radar charts. 雷达图坐标系组件，只适用于雷达图。 More...
class	RadarAxisTheme
class	RadarChart
class	RadarChartEditor
	Editor class used to edit UI RadarChart. More...
class	RadarDrawer
class	RadarIndicatorDrawer
class	RadiusAxis
	Radial axis of polar coordinate. 极坐标系的径向轴。 More...
class	RadiusAxisDrawer
class	RadiusAxisTheme
class	RadiusAxisThemeDrawer
class	RingChart
class	RingChartEditor
	Editor class used to edit UI RingChart. More...
class	ScatterChart
class	ScatterChartEditor
	Editor class used to edit UI ScatterChart. More...
class	Serie
	系列。每个系列通过 type 决定自己的图表类型。 More...
class	SerieAnimation
	the animation of serie. 动画表现。 More...
class	SerieData
	A data item of serie. 系列中的一个数据项。可存储数据名和1-n维的数据。 More...
class	SerieDataPool
class	SerieDrawer
class	SerieHelper
class	SerieLabel
	Text label of chart, to explain some data information about graphic item like value, name and so on. 图形上的文本标签，可用于说明图形的一些数据信息，比如值，名称等。 More...
class	SerieLabelDrawer
class	SerieLabelHelper
class	SerieLabelPool
class	Series
	the list of series. 系列列表。每个系列通过 type 决定自己的图表类型。 More...
class	SeriesDrawer
class	SeriesHelper
class	SerieSymbol
	系列数据项的标记的图形 More...
class	SerieSymbolDrawer
class	SerieTemplate
class	SerieTheme
class	SerieThemeDrawer
class	Settings
	Global parameter setting component. The default value can be used in general, and can be adjusted when necessary. 全局参数设置组件。一般情况下可使用默认值，当有需要时可进行调整。 More...
class	SettingsDrawer
class	StageColor
class	SubComponent
class	SubTitleTheme
class	TextLimit
	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. 文本字符限制和自适应。当文本长度超过设定的长度时进行裁剪，并将后缀附加在最后。 只在类目轴中有效。 More...
class	TextLimitDrawer
class	TextStyle
	Settings related to text. 文本的相关设置。 More...
class	TextStyleDrawer
class	ThemeCheck
class	ThemeDrawer
class	ThemeHelper
class	Title
	Title component, including main title and subtitle. 标题组件，包含主标题和副标题。 More...
class	TitleDrawer
class	TitleStyle
	the title of serie. 标题相关设置。 More...
class	TitleStyleDrawer
class	TitleStyleHelper
class	TitleTheme
class	Tooltip
	Tooltip component. 提示框组件。 More...
class	TooltipDrawer
class	TooltipHelper
class	TooltipTheme
class	TooltipThemeDrawer
class	Vessel
	Vessel component for liquid chart. There can be multiple vessels in a Chart, which can be matched by vesselIndex in Serie. More...
class	VesselDrawer
class	VesselHelper
class	VisualMap
	VisualMap component. Mapping data to visual elements such as colors. 视觉映射组件。用于进行『视觉编码』，也就是将数据映射到视觉元素（视觉通道）。 More...
class	VisualMapDrawer
class	VisualMapHandler
class	VisualMapHelper
class	VisualMapTheme
class	VisualMapThemeDrawer
class	XAxis
	The x axis in cartesian(rectangular) coordinate. a grid component can place at most 2 x axis, one on the bottom and another on the top. More...
class	XAxisDrawer
class	XAxisPool
class	XChartEditor
class	XChartsBuild
class	XChartsMgr
class	XChartsMgrEditor
	Editor class used to edit UI XChartsMgr. More...
class	XChartsSettings
class	XChartsSettingsEditor
class	XChartsVersion
class	XThemeMgr
class	YAxis
	The x axis in cartesian(rectangular) coordinate. a grid component can place at most 2 x axis, one on the bottom and another on the top. More...
class	YAxisDrawer
class	YAxisPool

Enumerations
enum	SerieType {   SerieType.Line, SerieType.Bar, SerieType.Pie, SerieType.Radar,   SerieType.Scatter, SerieType.EffectScatter, SerieType.Heatmap, SerieType.Gauge,   SerieType.Ring, SerieType.Liquid, SerieType.Candlestick, SerieType.Custom }
	the type of serie. 系列类型。 More...
enum	RoseType { RoseType.None, RoseType.Radius, RoseType.Area }
	Whether to show as Nightingale chart, which distinguishs data through radius. 是否展示成南丁格尔图，通过半径区分数据大小。 More...
enum	LineType {   LineType.Normal, LineType.Smooth, LineType.SmoothDash, LineType.StepStart,   LineType.StepMiddle, LineType.StepEnd, LineType.Dash, LineType.Dot,   LineType.DashDot, LineType.DashDotDot }
	the type of line chart. 折线图样式类型 More...
enum	BarType { BarType.Normal, BarType.Zebra, BarType.Capsule }
enum	GaugeType { GaugeType.Pointer, GaugeType.ProgressBar }
	仪表盘类型 More...
enum	RadarType { RadarType.Multiple, RadarType.Single }
	雷达图类型 More...
enum	SampleType {   SampleType.Peak, SampleType.Average, SampleType.Max, SampleType.Min,   SampleType.Sum }
	采样类型 More...
enum	SerieDataSortType { SerieDataSortType.None, SerieDataSortType.Ascending, SerieDataSortType.Descending }
	数据排序方式 More...
enum	Align { Center, Left, Right }
	对齐方式 More...
enum	MarkLineType {   None, MarkLineType.Min, MarkLineType.Max, MarkLineType.Average,   MarkLineType.Median }
	标线类型 More...
enum	SerieSymbolType {   SerieSymbolType.EmptyCircle, SerieSymbolType.Circle, SerieSymbolType.Rect, SerieSymbolType.Triangle,   SerieSymbolType.Diamond, SerieSymbolType.None, SerieSymbolType.Arrow, SerieSymbolType.Custom,   EmptyRect, EmptyTriangle, EmptyDiamond }
	the type of symbol. 标记图形的类型。 More...
enum	SerieSymbolSizeType { SerieSymbolSizeType.Custom, SerieSymbolSizeType.FromData, SerieSymbolSizeType.Callback }
	The way to get serie symbol size. 获取标记图形大小的方式。 More...
enum	Theme { Theme.Default, Theme.Light, Theme.Dark, Theme.Custom }
	主题 More...
enum	Orient { Orient.Horizonal, Orient.Vertical }
	the layout is horizontal or vertical. 垂直还是水平布局方式。 More...

Functions
delegate float	CustomAnimationDelay (int dataIndex)
delegate float	CustomAnimationDuration (int dataIndex)
delegate float	SymbolSizeCallback (List< double > data)
	获取标记大小的回调。 More...
delegate string	DelegateAxisLabelFormatter (int labelIndex, double value, string category)
	The delegate function for AxisLabel's formatter. | AxisLabel的formatter自定义委托函数。 More...
delegate string	DelegateSerieLabelFormatter (int dataIndex, double value)
	The delegate function for SerieLabel‘s formatter. SerieLabel的formatter自定义委托函数。 More...
delegate Vector3	DelegateTooltipPosition (Vector3 pos)
	Tooltip的position自定义委托函数。 More...

Enumeration Type Documentation

Align

enum XCharts.Align

strong

对齐方式

Definition at line 250 of file Serie.cs.

    {
        Center,
        Left,
        Right
    }

BarType

enum XCharts.BarType

strong

Enumerator
Normal	普通柱形图
Zebra	斑马柱形图
Capsule	胶囊柱形图

Definition at line 149 of file Serie.cs.

    {
        Normal,
        Zebra,
        Capsule
    }

GaugeType

enum XCharts.GaugeType

strong

仪表盘类型

Enumerator
Pointer	指针型
ProgressBar	进度条型

Definition at line 168 of file Serie.cs.

    {
        Pointer,
        ProgressBar
    }

LineType

enum XCharts.LineType

strong

the type of line chart. 折线图样式类型

Enumerator
Normal	the normal line chart， 普通折线图。
Smooth	the smooth line chart， 平滑曲线。
SmoothDash	the smooth-dash line chart， 平滑虚线。
StepStart	step line. 阶梯线图：当前点。
StepMiddle	step line. 阶梯线图：当前点和下一个点的中间。
StepEnd	step line. 阶梯线图：下一个拐点。
Dash	虚线
Dot	点线
DashDot	点划线
DashDotDot	双点划线

Definition at line 99 of file Serie.cs.

    {
        Normal,
        Smooth,
        SmoothDash,
        StepStart,
        StepMiddle,
        StepEnd,
        Dash,
        Dot,
        DashDot,
        DashDotDot
    }

MarkLineType

enum XCharts.MarkLineType

strong

标线类型

Enumerator
Min	最小值。
Max	最大值。
Average	平均值。
Median	中位数。

Definition at line 18 of file MarkLine.cs.

    {
        None,
        Min,
        Max,
        Average,
        Median
    }

Orient

enum XCharts.Orient

strong

the layout is horizontal or vertical. 垂直还是水平布局方式。

Enumerator
Horizonal	水平
Vertical	垂直

Definition at line 22 of file BaseChart.cs.

    {
        Horizonal,
        Vertical
    }

RadarType

enum XCharts.RadarType

strong

雷达图类型

Enumerator
Multiple	多圈雷达图。此时可一个雷达里绘制多个圈，一个serieData就可组成一个圈（多维数据）。
Single	单圈雷达图。此时一个雷达只能绘制一个圈，多个serieData组成一个圈，数据取自data[1]。

Definition at line 183 of file Serie.cs.

    {
        Multiple,
        Single
    }

RoseType

enum XCharts.RoseType

strong

Whether to show as Nightingale chart, which distinguishs data through radius. 是否展示成南丁格尔图，通过半径区分数据大小。

Enumerator
None	Don't show as Nightingale chart.不展示成南丁格尔玫瑰图
Radius	Use central angle to show the percentage of data, radius to show data size. 扇区圆心角展现数据的百分比，半径展现数据的大小。
Area	All the sectors will share the same central angle, the data size is shown only through radiuses. 所有扇区圆心角相同，仅通过半径展现数据大小。

Definition at line 77 of file Serie.cs.

    {
        None,
        Radius,
        Area
    }

SampleType

enum XCharts.SampleType

strong

采样类型

Enumerator
Peak	Take a peak. When the average value of the filter point is greater than or equal to 'sampleAverage', take the maximum value; If you do it the other way around, you get the minimum. 取峰值。
Average	Take the average of the filter points. 取过滤点的平均值。
Max	Take the maximum value of the filter point. 取过滤点的最大值。
Min	Take the minimum value of the filter point. 取过滤点的最小值。
Sum	Take the sum of the filter points. 取过滤点的和。

Definition at line 198 of file Serie.cs.

    {
        Peak,
        Average,
        Max,
        Min,
        Sum
    }

SerieDataSortType

enum XCharts.SerieDataSortType

strong

数据排序方式

Enumerator
None	按 data 的顺序
Ascending	升序
Descending	降序

Definition at line 231 of file Serie.cs.

    {
        None,
        Ascending,
        Descending,
    }

SerieSymbolSizeType

enum XCharts.SerieSymbolSizeType

strong

The way to get serie symbol size. 获取标记图形大小的方式。

Enumerator
Custom	Specify constant for symbol size. 自定义大小。
FromData	Specify the dataIndex and dataScale to calculate symbol size. 通过 dataIndex 从数据中获取，再乘以一个比例系数 dataScale 。
Callback	Specify callback function for symbol size. 通过回调函数获取。

Definition at line 61 of file SerieSymbol.cs.

    {
        Custom,
        FromData,
        Callback,
    }

SerieSymbolType

enum XCharts.SerieSymbolType

strong

the type of symbol. 标记图形的类型。

Enumerator
EmptyCircle	空心圆。
Circle	圆形。
Rect	正方形。可通过设置itemStyle的cornerRadius变成圆角矩形。
Triangle	三角形。
Diamond	菱形。
None	不显示标记。
Arrow	箭头。
Custom	自定义标记。

Definition at line 18 of file SerieSymbol.cs.

    {
        EmptyCircle,
        Circle,
        Rect,
        Triangle,
        Diamond,
        None,
        Arrow,
        Custom,
        EmptyRect,
        EmptyTriangle,
        EmptyDiamond
    }

SerieType

enum XCharts.SerieType

strong

the type of serie. 系列类型。

Enumerator
Line	折线图。折线图是用折线将各个数据点标志连接起来的图表，用于展现数据的变化趋势。可用于直角坐标系和极坐标系上。
Bar	柱状图。柱状/条形图 通过 柱形的高度/条形的宽度 来表现数据的大小，用于有至少一个类目轴或时间轴的直角坐标系上。
Pie	饼图。饼图主要用于表现不同类目的数据在总和中的占比。每个的弧度表示数据数量的比例。 饼图更适合表现数据相对于总数的百分比等关系。
Radar	雷达图。雷达图主要用于表现多变量的数据，例如球员的各个属性分析。依赖 radar 组件。
Scatter	散点图。直角坐标系上的散点图可以用来展现数据的 x，y 之间的关系，如果数据项有多个维度， 其它维度的值可以通过不同大小的 symbol 展现成气泡图，也可以用颜色来表现。
EffectScatter	带有涟漪特效动画的散点图。利用动画特效可以将某些想要突出的数据进行视觉突出。
Heatmap	热力图。主要通过颜色去表现数值的大小，必须要配合 visualMap 组件使用。
Gauge	仪表盘。
Ring	环形图。只支持一个数据的环形图。
Liquid	水位图。
Candlestick	K线图。K线图的data至少包含四个数据：[open, close, lowest, highest]
Custom	自定义。

Definition at line 19 of file Serie.cs.

    {
        Line,
        Bar,
        Pie,
        Radar,
        Scatter,
        EffectScatter,
        Heatmap,
        Gauge,
        Ring,
        Liquid,
        Candlestick,
        Custom,
    }

Theme

enum XCharts.Theme

strong

主题

Enumerator
Default	默认主题。
Light	亮主题。
Dark	暗主题。
Custom	自定义主题。

Definition at line 21 of file ChartTheme.cs.

    {
        Default,
        Light,
        Dark,
        Custom,
    }

Function Documentation

DelegateAxisLabelFormatter()

delegate string XCharts.DelegateAxisLabelFormatter	(	int	labelIndex,
		double	value,
		string	category
	)

The delegate function for AxisLabel's formatter. | AxisLabel的formatter自定义委托函数。

Parameters

labelIndex	label索引
value	当前label对应的数值数据，Value轴或Time轴有效
category	当前label对应的类目数据，Category轴有效

Returns

最终显示的文本内容

DelegateSerieLabelFormatter()

delegate string XCharts.DelegateSerieLabelFormatter	(	int	dataIndex,
		double	value
	)

The delegate function for SerieLabel‘s formatter. SerieLabel的formatter自定义委托函数。

Parameters

dataIndex	数据索引
value	数值

Returns

最终显示的文本内容

DelegateTooltipPosition()

delegate Vector3 XCharts.DelegateTooltipPosition

(

Vector3

pos

)

Tooltip的position自定义委托函数。

Parameters

pos	Tooltip的当前坐标

Returns

Tooltip的最终坐标

SymbolSizeCallback()

delegate float XCharts.SymbolSizeCallback

(

List< double >

data

)

获取标记大小的回调。

Parameters

data

Returns