Skip to content

Latest commit

 

History

History
1549 lines (1176 loc) · 66.1 KB

XChartsConfiguration-EN.md

File metadata and controls

1549 lines (1176 loc) · 66.1 KB

Chart Configuration

XCharts Homepage
XCharts API
XCharts FAQ

Serie

Theme

MainComponent

ChildComponent

ISerieExtraComponent

ISerieDataComponent

Other

AngleAxis

Inherits or Implemented: Axis

Angle axis of Polar Coordinate.

field default comment
startAngle 0 Starting angle of axis. 0 degrees by default, standing for right position of center.

AngleAxisTheme

Inherits or Implemented: BaseAxisTheme

AnimationStyle

Inherits or Implemented: ChildComponent

the animation of serie.

field default comment
enable true Whether to enable animation.
type The type of animation.
AnimationType:
- Default: he default. An animation playback mode will be selected according to the actual situation.
- LeftToRight: Play the animation from left to right.
- BottomToTop: Play the animation from bottom to top.
- InsideOut: Play animations from the inside out.
- AlongPath: Play the animation along the path.
- Clockwise: Play the animation clockwise.
easting Easing method used for the first animation.
AnimationEasing:
- Linear:
threshold 2000 Whether to set graphic number threshold to animation. Animation will be disabled when graphic number is larger than threshold.
fadeInDuration 1000 The milliseconds duration of the fadeIn animation.
fadeInDelay 0 The milliseconds delay before updating the first animation.
fadeOutDuration 1000f The milliseconds duration of the fadeOut animation.
fadeOutDelay 0 渐出动画延时（毫秒）。如果要设置单个数据项的延时，可以用代码定制：customFadeOutDelay。
dataChangeEnable true 是否开启数据变更动画。
dataChangeDuration 500 The milliseconds duration of the data change animation.
actualDuration The milliseconds actual duration of the first animation.
alongWithLinePath

AreaStyle

Inherits or Implemented: ChildComponent,ISerieExtraComponent,ISerieDataComponent

The style of area.

field default comment
show true Set this to false to prevent the areafrom showing.
origin the origin of area.
AreaStyle.AreaOrigin:
- Auto: to fill between axis line to data.
- Start: to fill between min axis value (when not inverse) to data.
- End: to fill between max axis value (when not inverse) to data.
color the color of area,default use serie color.
toColor Gradient color, start color to toColor.
opacity 0.6f Opacity of the component. Supports value from 0 to 1, and the component will not be drawn when set to 0.
highlightColor the color of area,default use serie color.
highlightToColor Gradient color, start highlightColor to highlightToColor.

ArrowStyle

Inherits or Implemented: ChildComponent

field default comment
width 10 The widht of arrow.
height 15 The height of arrow.
offset 0 The offset of arrow.
dent 3 The dent of arrow.
color Color.clear the color of arrow.

Axis

Inherits or Implemented: MainComponent

The axis in rectangular coordinate.

field default comment
show true Whether to show axis.
type the type of axis.
Axis.AxisType:
- Value: Numerical axis, suitable for continuous data.
- Category: Category axis, suitable for discrete category data. Data should only be set via data for this type.
- Log: Log axis, suitable for log data.
- Time: Time axis, suitable for continuous time series data.
minMaxType the type of axis minmax.
Axis.AxisMinMaxType:
- Default: 0 - maximum.
- MinMax: minimum - maximum.
- Custom: Customize the minimum and maximum.
gridIndex The index of the grid on which the axis are located, by default, is in the first grid.
polarIndex The index of the polar on which the axis are located, by default, is in the first polar.
parallelIndex The index of the parallel on which the axis are located, by default, is in the first parallel.
position the position of axis in grid.
Axis.AxisPosition:
- Left: the position of axis in grid.
- Right: the position of axis in grid.
- Bottom: the position of axis in grid.
- Top: the position of axis in grid.
offset the offset of axis from the default position. Useful when the same position has multiple axes.
min The minimun value of axis.Valid when minMaxType is Custom
max The maximum value of axis.Valid when minMaxType is Custom
splitNumber 0 Number of segments that the axis is split into.
interval 0 Compulsively set segmentation interval for axis.This is unavailable for category axis.
boundaryGap true
maxCache 0 The max number of axis data cache.
logBase 10 Base of logarithm, which is valid only for numeric axes with type: 'Log'.
logBaseE false On the log axis, if base e is the natural number, and is true, logBase fails.
ceilRate 0 The ratio of maximum and minimum values rounded upward. The default is 0, which is automatically calculated.
inverse false Whether the axis are reversed or not. Invalid in Category axis.
clockwise true Whether the positive position of axis is in clockwise. True for clockwise by default.
insertDataToHead Whether to add new data at the head or at the end of the list.
icons 类目数据对应的图标。
data Category data, available in type: 'Category' axis.
axisLine AxisLine
axisName axis name. AxisName
axisTick axis tick. AxisTick
axisLabel axis label. AxisLabel
splitLine axis split line. AxisSplitLine
splitArea axis split area. AxisSplitArea

AxisLabel

Inherits or Implemented: LabelStyle

Settings related to axis label.

field default comment
interval 0 The display interval of the axis label.
inside false Set this to true so the axis labels face the inside direction.
showAsPositiveNumber false Show negative number as positive number.
onZero false 刻度标签显示在0刻度上。
showStartLabel true Whether to display the first label.
showEndLabel true Whether to display the last label.
textLimit 文本限制。 TextLimit

AxisLine

Inherits or Implemented: BaseLine

Settings related to axis line.

field default comment
onZero When mutiple axes exists, this option can be used to specify which axis can be "onZero" to.
showArrow Whether to show the arrow symbol of axis.
arrow the arrow of line. ArrowStyle

AxisName

Inherits or Implemented: ChildComponent

the name of axis.

field default comment
show Whether to show axis name.
name the name of axis.
labelStyle The text style of axis name. LabelStyle

AxisSplitArea

Inherits or Implemented: ChildComponent

Split area of axis in grid area, not shown by default.

field default comment
show Set this to true to show the splitArea.
color Color of split area. SplitArea color could also be set in color array, which the split lines would take as their colors in turns.

AxisSplitLine

Inherits or Implemented: BaseLine

Split line of axis in grid area.

field default comment
interval
distance The distance between the split line and axis line.
autoColor

AxisTheme

Inherits or Implemented: BaseAxisTheme

AxisTick

Inherits or Implemented: BaseLine

Settings related to axis tick.

field default comment
alignWithLabel Align axis tick with label, which is available only when boundaryGap is set to be true in category axis.
inside Set this to true so the axis labels face the inside direction.
showStartTick Whether to display the first tick.
showEndTick Whether to display the last tick.
distance The distance between the tick line and axis line.
splitNumber 0 Number of segments that the axis is split into.
autoColor

Background

Inherits or Implemented: MainComponent

Background component.

field default comment
show true Whether to enable the background component.
image the image of background.
imageType the fill type of background image.
imageColor 背景图颜色。
hideThemeBackgroundColor true Whether to hide the background color set in the theme when the background component is on.

Bar

Inherits or Implemented: Serie,INeedSerieContainer

BaseAxisTheme

Inherits or Implemented: ComponentTheme

field default comment
lineType the type of line.
lineWidth 1f the width of line.
lineLength 0f the length of line.
lineColor the color of line.
splitLineType the type of split line.
splitLineWidth 1f the width of split line.
splitLineLength 0f the length of split line.
splitLineColor the color of line.
tickWidth 1f the width of tick.
tickLength 5f the length of tick.
tickColor the color of tick.
splitAreaColors

BaseLine

Inherits or Implemented: ChildComponent

Settings related to base line.

field default comment
show Set this to false to prevent the axis line from showing.
lineStyle 线条样式 LineStyle

BaseScatter

Inherits or Implemented: Serie,INeedSerieContainer

BaseSerie

CalendarCoord

Inherits or Implemented: CoordSystem,IUpdateRuntimeData,ISerieContainer

Candlestick

Inherits or Implemented: Serie,INeedSerieContainer

ChartText

ChildComponent

Comment

Inherits or Implemented: MainComponent

comment of chart.

field default comment
show true Set this to false to prevent the comment from showing.
labelStyle The text style of all comments. LabelStyle
markStyle The text style of all comments. CommentMarkStyle
items

CommentItem

Inherits or Implemented: ChildComponent

comment of chart.

field default comment
show true Set this to false to prevent this comment item from showing.
content content of comment.
position position of comment.
markRect
markStyle CommentMarkStyle
labelStyle The text style of all comments. LabelStyle

CommentMarkStyle

Inherits or Implemented: ChildComponent

comment of chart.

field default comment
show true Set this to false to prevent this comment item from showing.
lineStyle LineStyle

ComponentTheme

Inherits or Implemented: ChildComponent

field default comment
font the font of text.
textColor the color of text.
textBackgroundColor the color of text.
fontSize 18 the font size of text.
tMPFont the font of chart text。 字体。

CoordSystem

Inherits or Implemented: MainComponent

Coordinate system component.

DataZoom

Inherits or Implemented: MainComponent,IUpdateRuntimeData

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.

field default comment
enable true Whether to show dataZoom.
filterMode The mode of data filter.
DataZoom.FilterMode:
- Filter: 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.
- WeakFilter: 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.
- Empty: data that outside the window will be set to NaN, which will not lead to changes of windows of other axes.
- None: Do not filter data.
xAxisIndexs Specify which xAxis is controlled by the dataZoom.
yAxisIndexs Specify which yAxis is controlled by the dataZoom.
supportInside 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).
supportInsideScroll true 是否支持坐标系内滚动
supportInsideDrag true 是否支持坐标系内拖拽
supportSlider Whether a slider is supported. There are separate sliders on which the user zooms or roams.
supportSelect 是否支持框选。提供一个选框进行数据区域缩放。
showDataShadow Whether to show data shadow, to indicate the data tendency in brief.
showDetail Whether to show detail, that is, show the detailed data information when dragging.
zoomLock Specify whether to lock the size of window (selected area).
realtime
fillerColor the color of dataZoom data area.
borderColor the color of dataZoom border.
borderWidth 边框宽。
backgroundColor The background color of the component.
left Distance between dataZoom component and the left side of the container. left value is a instant pixel value like 10 or float value [0-1].
right Distance between dataZoom component and the right side of the container. right value is a instant pixel value like 10 or float value [0-1].
top Distance between dataZoom component and the top side of the container. top value is a instant pixel value like 10 or float value [0-1].
bottom Distance between dataZoom component and the bottom side of the container. bottom value is a instant pixel value like 10 or float value [0-1].
rangeMode Use absolute value or percent value in DataZoom.start and DataZoom.end.
DataZoom.RangeMode:
- //Value: The value type of start and end.取值类型
- Percent: percent value.
start The start percentage of the window out of the data extent, in the range of 0 ~ 100.
end The end percentage of the window out of the data extent, in the range of 0 ~ 100.
startValue
endValue
minShowNum 1 Minimum number of display data. Minimum number of data displayed when DataZoom is enlarged to maximum.
scrollSensitivity 1.1f The sensitivity of dataZoom scroll. The larger the number, the more sensitive it is.
orient Specify whether the layout of dataZoom component is horizontal or vertical. What's more, it indicates whether the horizontal axis or vertical axis is controlled by default in catesian coordinate system.
Orient:
- Horizonal: 水平
- Vertical: 垂直
labelStyle label style. LabelStyle
lineStyle 阴影线条样式。 LineStyle
areaStyle 阴影填充样式。 AreaStyle

DataZoomTheme

Inherits or Implemented: ComponentTheme

field default comment
borderWidth the width of border line.
dataLineWidth the width of data line.
fillerColor the color of dataZoom data area.
borderColor the color of dataZoom border.
dataLineColor the color of data area line.
dataAreaColor the color of data area line.
backgroundColor the background color of datazoom.

DebugInfo

field default comment
show true
showDebugInfo false
showAllChartObject false
foldSeries false
labelStyle LabelStyle

EffectScatter

Inherits or Implemented: BaseScatter

Emphasis

Inherits or Implemented: ChildComponent,ISerieExtraComponent,ISerieDataComponent

高亮的图形样式和文本标签样式。

field default comment
show 是否启用高亮样式。
label 图形文本标签。 LabelStyle
labelLine LabelLine
itemStyle 图形样式。 ItemStyle

EmphasisItemStyle

Inherits or Implemented: ItemStyle,ISerieExtraComponent,ISerieDataComponent

高亮的图形样式

EmphasisLabelLine

Inherits or Implemented: LabelLine,ISerieExtraComponent,ISerieDataComponent

高亮的标签引导线样式

EmphasisLabelStyle

Inherits or Implemented: LabelStyle,ISerieExtraComponent,ISerieDataComponent

高亮的标签样式

EndLabelStyle

Inherits or Implemented: LabelStyle

GridCoord

Inherits or Implemented: CoordSystem,IUpdateRuntimeData,ISerieContainer

Grid component.

field default comment
show true Whether to show the grid in rectangular coordinate.
left 0.1f Distance between grid component and the left side of the container.
right 0.08f Distance between grid component and the right side of the container.
top 0.22f Distance between grid component and the top side of the container.
bottom 0.12f Distance between grid component and the bottom side of the container.
backgroundColor Background color of grid, which is transparent by default.
showBorder false Whether to show the grid border.
borderWidth 0f Border width of grid.
borderColor The color of grid border.

Heatmap

Inherits or Implemented: Serie,INeedSerieContainer

IconStyle

Inherits or Implemented: ChildComponent

field default comment
show false Whether the data icon is show.
layer 显示在上层还是在下层。
IconStyle.Layer:
- UnderText: The icon is display under the label text. 图标在标签文字下
- AboveText: The icon is display above the label text. 图标在标签文字上
align 水平方向对齐方式。
Align:
- Center: 对齐方式
- Left: 对齐方式
- Right: 对齐方式
sprite The image of icon.
type How to display the icon.
color 图标颜色。
width 20 图标宽。
height 20 图标高。
offset 图标偏移。
autoHideWhenLabelEmpty false 当label内容为空时是否自动隐藏图标

ImageStyle

Inherits or Implemented: ChildComponent,ISerieExtraComponent,ISerieDataComponent

field default comment
show true Whether the data icon is show.
sprite The image of icon.
type How to display the image.
autoColor 是否自动颜色。
color 图标颜色。
width 0 图标宽。
height 0 图标高。

Indicator

Indicator of radar chart, which is used to assign multiple variables(dimensions) in radar chart.

field default comment
name
max The maximum value of indicator, with default value of 0, but we recommend to set it manually.
min The minimum value of indicator, with default value of 0.
range Normal range. When the value is outside this range, the display color is automatically changed.
show [default:true] Set this to false to prevent the radar from showing.
shape Radar render type, in which 'Polygon' and 'Circle' are supported.
RadarCoord.Shape:
- Polygon: Radar render type, in which 'Polygon' and 'Circle' are supported.
- Circle: Radar render type, in which 'Polygon' and 'Circle' are supported.
radius 100 the radius of radar.
splitNumber 5 Segments of indicator axis.
center the center of radar chart.
axisLine axis line. AxisLine
axisName Name options for radar indicators. AxisName
splitLine split line. AxisSplitLine
splitArea Split area of axis in grid area. AxisSplitArea
indicator true Whether to show indicator.
positionType The position type of indicator.
RadarCoord.PositionType:
- Vertice: Display at the vertex.
- Between: Display at the middle of line.
indicatorGap 10 The gap of indicator and radar.
ceilRate 0 The ratio of maximum and minimum values rounded upward. The default is 0, which is automatically calculated.
isAxisTooltip 是否Tooltip显示轴线上的所有数据。
outRangeColor Color.red The color displayed when data out of range.
connectCenter false Whether serie data connect to radar center with line.
lineGradient true Whether need gradient for data line.
indicatorList the indicator list.

ItemStyle

Inherits or Implemented: ChildComponent,ISerieDataComponent

图形样式。

field default comment
show true 是否启用。
color 数据项颜色。
color0 数据项颜色。
toColor Gradient color1.
toColor2 Gradient color2.Only valid in line diagrams.
backgroundColor 数据项背景颜色。
backgroundWidth 数据项背景宽度。
centerColor 中心区域颜色。
centerGap 中心区域间隙。
borderWidth 0 边框宽。
borderGap 0 边框间隙。
borderColor 边框的颜色。
borderColor0 边框的颜色。
borderToColor 边框的渐变色。
opacity 1 透明度。支持从 0 到 1 的数字，为 0 时不绘制该图形。
itemMarker 提示框单项的字符标志。用在Tooltip中。
itemFormatter 提示框单项的字符串模版格式器。具体配置参考Tooltip的formatter
numericFormatter Standard numeric format strings.
cornerRadius The radius of rounded corner. Its unit is px. Use array to respectively specify the 4 corner radiuses((clockwise upper left, upper right, bottom right and bottom left)).

LabelLine

Inherits or Implemented: ChildComponent,ISerieExtraComponent,ISerieDataComponent

标签的引导线

field default comment
show true Whether the label line is showed.
lineType the type of visual guide line.
LineType:
- Normal: the normal line chart，
- Smooth: the smooth line chart，
- StepStart: step line.
- StepMiddle: step line.
- StepEnd: step line.
lineColor ChartConst.clearColor32 the color of visual guild line.
lineAngle 0 the angle of visual guild line.
lineWidth 1.0f the width of visual guild line.
lineGap 1.0f the gap of container and guild line.
lineLength1 25f The length of the first segment of visual guide line.
lineLength2 15f The length of the second segment of visual guide line.
startSymbol The symbol of the start point of labelline. SymbolStyle
endSymbol The symbol of the end point of labelline. SymbolStyle

LabelStyle

Inherits or Implemented: ChildComponent,ISerieExtraComponent,ISerieDataComponent

Text label of chart, to explain some data information about graphic item like value, name and so on.

field default comment
show true Whether the label is showed.
Position
autoOffset false 是否开启自动偏移。当开启时，Y的偏移会自动判断曲线的开口来决定向上还是向下偏移。
offset offset to the host graphic element.
rotate Rotation of label.
distance 距离轴线的距离。
formatter
numericFormatter 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
background the sytle of background. ImageStyle
textPadding the text padding of label. TextPadding
textStyle the sytle of text. TextStyle

Lang

Inherits or Implemented: ScriptableObject

Language.

LangCandlestick

LangTime

Legend

Inherits or Implemented: MainComponent,IPropertyChanged

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.

field default comment
show true Whether to show legend component.
iconType Type of legend.
Painter.Type:
- Base:
- Serie:
- Top:
selectedMode Selected mode of legend, which controls whether series can be toggled displaying by clicking legends.
VisualMap.SelectedMode:
- Multiple: 多选。
- Single: 单选。
orient Specify whether the layout of legend component is horizontal or vertical.
Orient:
- Horizonal: 水平
- Vertical: 垂直
location The location of legend. Location
itemWidth 25.0f Image width of legend symbol.
itemHeight 12.0f Image height of legend symbol.
itemGap 10f The distance between each legend, horizontal distance in horizontal layout, and vertical distance in vertical layout.
itemAutoColor true Whether the legend symbol matches the color automatically.
itemOpacity 1 the opacity of item color.
formatter
numericFormatter Standard numeric format strings.
labelStyle the style of text. LabelStyle
data Data array of legend. An array item is usually a name representing string. (If it is a pie chart, it could also be the name of a single data in the pie chart) of a series.
icons 自定义的图例标记图形。
colors

LegendTheme

Inherits or Implemented: ComponentTheme

field default comment
unableColor the color of text.

Level

Inherits or Implemented: ChildComponent

field default comment
label LabelStyle
upperLabel LabelStyle
itemStyle ItemStyle

LevelStyle

Inherits or Implemented: ChildComponent

field default comment
show false 是否启用LevelStyle
levels 各层节点对应的配置。当enableLevels为true时生效，levels[0]对应的第一层的配置，levels[1]对应第二层，依次类推。当levels中没有对应层时用默认的设置。

Line

Inherits or Implemented: Serie,INeedSerieContainer

LineArrow

Inherits or Implemented: ChildComponent,ISerieExtraComponent

field default comment
show Whether to show the arrow.
position The position of arrow.
LabelStyle.Position:
- Default: The position of label.
- Outside: Outside of sectors of pie chart, which relates to corresponding sector through visual guide line.
- Inside: Inside the sectors of pie chart.
- Center: In the center of pie chart.
- Top: top of symbol.
- Bottom: the bottom of symbol.
- Left: the left of symbol.
- Right: the right of symbol.
- Start: the start of line.
- Middle: the middle of line.
- End: the end of line.
arrow the arrow of line. ArrowStyle

LineStyle

Inherits or Implemented: ChildComponent,ISerieDataComponent

The style of line.

field default comment
show true Whether show line.
type the type of line.
Painter.Type:
- Base:
- Serie:
- Top:
color the color of line, default use serie color.
toColor the middle color of line, default use serie color.
toColor2 the end color of line, default use serie color.
width 0
length 0
opacity 1 Opacity of the line. Supports value from 0 to 1, and the line will not be drawn when set to 0.

Location

Inherits or Implemented: ChildComponent,IPropertyChanged

Location type. Quick to set the general location.

field default comment
align 对齐方式。
Align:
- Center: 对齐方式
- Left: 对齐方式
- Right: 对齐方式
left Distance between component and the left side of the container.
right Distance between component and the left side of the container.
top Distance between component and the left side of the container.
bottom Distance between component and the left side of the container.

MainComponent

Inherits or Implemented: IComparable

MarkArea

Inherits or Implemented: MainComponent

field default comment
show true
text
serieIndex 0
start MarkAreaData
end MarkAreaData
itemStyle ItemStyle
label LabelStyle

MarkAreaData

Inherits or Implemented: ChildComponent

field default comment
type Special markArea types, are used to label maximum value, minimum value and so on.
MarkAreaType:
- None: 标域类型
- Min: 最小值。
- Max: 最大值。
- Average: 平均值。
- Median: 中位数。
name
dimension 1 From which dimension of data to calculate the maximum and minimum value and so on.
xPosition The x coordinate relative to the origin, in pixels.
yPosition The y coordinate relative to the origin, in pixels.
xValue The value specified on the X-axis. A value specified when the X-axis is the category axis represents the index of the category axis data, otherwise a specific value.
yValue That's the value on the Y-axis. The value specified when the Y axis is the category axis represents the index of the category axis data, otherwise the specific value.

MarkLine

Inherits or Implemented: MainComponent

Use a line in the chart to illustrate.

field default comment
show true Whether to display the marking line.
serieIndex 0
animation The animation of markline. AnimationStyle
data A list of marked data. When the group of data item is 0, each data item represents a line; When the group is not 0, two data items of the same group represent the starting point and the ending point of the line respectively to form a line. In this case, the relevant style parameters of the line are the parameters of the starting point.

MarkLineData

Inherits or Implemented: ChildComponent

Data of marking line. 图表标线的数据。

field default comment
type Special label types, are used to label maximum value, minimum value and so on.
MarkLineType:
- None: 标线类型
- Min: 最小值。
- Max: 最大值。
- Average: 平均值。
- Median: 中位数。
name
dimension 1 From which dimension of data to calculate the maximum and minimum value and so on.
xPosition The x coordinate relative to the origin, in pixels.
yPosition The y coordinate relative to the origin, in pixels.
xValue The value specified on the X-axis. A value specified when the X-axis is the category axis represents the index of the category axis data, otherwise a specific value.
yValue That's the value on the Y-axis. The value specified when the Y axis is the category axis represents the index of the category axis data, otherwise the specific value.
group 0 Grouping. When the group is not 0, it means that this data is the starting point or end point of the marking line. Data consistent with the group form a marking line.
zeroPosition false Is the origin of the coordinate system.
startSymbol The symbol of the start point of markline. SymbolStyle
endSymbol The symbol of the end point of markline. SymbolStyle
lineStyle The line style of markline. LineStyle
label Text styles of label. You can set position to Start, Middle, and End to display text in different locations. LabelStyle
emphasis Emphasis

Parallel

Inherits or Implemented: Serie,INeedSerieContainer

ParallelAxis

Inherits or Implemented: Axis

ParallelCoord

Inherits or Implemented: CoordSystem,IUpdateRuntimeData,ISerieContainer

Grid component.

field default comment
show true Whether to show the grid in rectangular coordinate.
orient Orientation of the axis. By default, it's 'Vertical'. You can set it to be 'Horizonal' to make a vertical axis.
Orient:
- Horizonal: 水平
- Vertical: 垂直
left 0.1f Distance between grid component and the left side of the container.
right 0.08f Distance between grid component and the right side of the container.
top 0.22f Distance between grid component and the top side of the container.
bottom 0.12f Distance between grid component and the bottom side of the container.
backgroundColor Background color of grid, which is transparent by default.

Pie

Inherits or Implemented: Serie

PolarAxisTheme

Inherits or Implemented: BaseAxisTheme

PolarCoord

Inherits or Implemented: CoordSystem,ISerieContainer

Polar coordinate can be used in scatter and line chart. Every polar coordinate has an angleAxis and a radiusAxis.

field default comment
show true Whether to show the polor component.
center The center of ploar. 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.
radius 0.35f the radius of polar.
backgroundColor Background color of polar, which is transparent by default.

Radar

Inherits or Implemented: Serie,INeedSerieContainer

RadarAxisTheme

Inherits or Implemented: BaseAxisTheme

RadarCoord

Inherits or Implemented: CoordSystem,ISerieContainer

Radar coordinate conponnet for radar charts. 雷达图坐标系组件，只适用于雷达图。

RadiusAxis

Inherits or Implemented: Axis

Radial axis of polar coordinate.

RadiusAxisTheme

Inherits or Implemented: BaseAxisTheme

Ring

Inherits or Implemented: Serie

Scatter

Inherits or Implemented: BaseScatter

Serie

Inherits or Implemented: BaseSerie,IComparable

系列。

field default comment
labels
labelLines
endLabels
lineArrows
areaStyles
titleStyles
emphasisItemStyles
emphasisLabels
emphasisLabelLines
index The index of serie.
show true Whether to show serie in chart.
coordSystem the chart coord system of serie.
serieType the type of serie.
serieName Series name used for displaying in tooltip and filtering with legend.
stack If stack the value. On the same category axis, the series with the same stack name would be put on top of each other.
xAxisIndex 0 the index of XAxis.
yAxisIndex 0 the index of YAxis.
radarIndex 0 Index of radar component that radar chart uses.
vesselIndex 0 Index of vesel component that liquid chart uses.
polarIndex 0 Index of polar component that serie uses.
singleAxisIndex 0 Index of single axis component that serie uses.
parallelIndex 0 Index of parallel coord component that serie uses.
minShow The min number of data to show in chart.
maxShow The max number of data to show in chart.
maxCache The max number of serie data cache.
sampleDist 0 the min pixel dist of sample.
sampleType the type of sample.
SampleType:
- 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.
sampleAverage 0 设定的采样平均值。当sampleType 为 Peak 时，用于和过滤数据的平均值做对比是取最大值还是最小值。默认为0时会实时计算所有数据的平均值。
lineType The type of line chart.
LineType:
- Normal: the normal line chart，
- Smooth: the smooth line chart，
- StepStart: step line.
- StepMiddle: step line.
- StepEnd: step line.
barType 柱形图类型。
BarType:
- Normal: normal bar.
- Zebra: zebra bar.
- Capsule: capsule bar.
barPercentStack false 柱形图是否为百分比堆积。相同stack的serie只要有一个barPercentStack为true，则就显示成百分比堆叠柱状图。
barWidth 0 The width of the bar. Adaptive when default 0.
barGap 0.1f The gap between bars between different series, is a percent value like '0.3f' , which means 30% of the bar width, can be set as a fixed value.
barZebraWidth 4f 斑马线的粗细。
barZebraGap 2f 斑马线的间距。
min 最小值。
max 最大值。
minSize 0f 数据最小值 min 映射的宽度。
maxSize 1f 数据最大值 max 映射的宽度。
startAngle 起始角度。和时钟一样，12点钟位置是0度，顺时针到360度。
endAngle 结束角度。和时钟一样，12点钟位置是0度，顺时针到360度。
minAngle The minimum angle of sector(0-360). It prevents some sector from being too small when value is small.
clockwise true 是否顺时针。
roundCap 是否开启圆弧效果。
splitNumber 刻度分割段数。最大可设置36。
clickOffset true Whether offset when mouse click pie chart item.
roseType Whether to show as Nightingale chart.
RoseType:
- 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.
gap gap of item.
center the center of chart.
radius the radius of chart.
showDataDimension 数据项里的数据维数。
showDataName 在Editor的inpsector上是否显示name参数
showDataIcon
clip false If clip the overflow on the coordinate system.
ignore false 是否开启忽略数据。当为 true 时，数据值为 ignoreValue 时不进行绘制。
ignoreValue 0 忽略数据的默认值。当ignore为true才有效。
ignoreLineBreak false 忽略数据时折线是断开还是连接。默认false为连接。
showAsPositiveNumber false Show negative number as positive number.
large true 是否开启大数据量优化，在数据图形特别多而出现卡顿时候可以开启。 开启后配合 largeThreshold 在数据量大于指定阈值的时候对绘制进行优化。 缺点：优化后不能自定义设置单个数据项的样式，不能显示Label。
largeThreshold 200 开启大数量优化的阈值。只有当开启了large并且数据量大于该阀值时才进入性能模式。
avoidLabelOverlap false 在饼图且标签外部显示的情况下，是否启用防止标签重叠策略，默认关闭，在标签拥挤重叠的情况下会挪动各个标签的位置，防止标签间的重叠。
radarType 雷达图类型。
RadarType:
- Multiple: multiple radar.
- Single: single radar.
placeHolder false 占位模式。占位模式时，数据有效但不参与渲染和显示。
dataSortType 组件的数据排序。
SerieDataSortType:
- None: 按 data 的顺序
- Ascending: 升序
- Descending: 降序
orient 组件的朝向。
Orient:
- Horizonal: 水平
- Vertical: 垂直
align 组件水平方向对齐方式。
Align:
- Center: 对齐方式
- Left: 对齐方式
- Right: 对齐方式
left Distance between component and the left side of the container.
right Distance between component and the right side of the container.
top Distance between component and the top side of the container.
bottom Distance between component and the bottom side of the container.
insertDataToHead Whether to add new data at the head or at the end of the list.
lineStyle The style of line. LineStyle
symbol the symbol of serie data item. SerieSymbol
animation The start animation. AnimationStyle
itemStyle The style of data item. ItemStyle
data 系列中的数据内容数组。SerieData可以设置1到n维数据。

SerieData

Inherits or Implemented: ChildComponent

A data item of serie.

field default comment
index
name the name of data item.
id 数据项的唯一id。唯一id不是必须设置的。
parentId
ignore 是否忽略数据。当为 true 时，数据不进行绘制。
selected Whether the data item is selected.
radius 自定义半径。可用在饼图中自定义某个数据项的半径。
itemStyles
labels
labelLines
symbols
lineStyles
areaStyles
titleStyles
emphasisItemStyles
emphasisLabels
emphasisLabelLines
data An arbitrary dimension data list of data item.

SerieSymbol

Inherits or Implemented: SymbolStyle,ISerieDataComponent

系列数据项的标记的图形

field default comment
sizeType the type of symbol size.
SymbolSizeType:
- Custom: Specify constant for symbol size.
- FromData: Specify the dataIndex and dataScale to calculate symbol size.
- Function: Specify function for symbol size.
selectedSize 0f the size of selected symbol.
dataIndex 1 whitch data index is when the sizeType assined as FromData.
dataScale 1 the scale of data when sizeType assined as FromData.
selectedDataScale 1.5f the scale of selected data when sizeType assined as FromData.
sizeFunction the function of size when sizeType assined as Function.
selectedSizeFunction the function of size when sizeType assined as Function.
startIndex the index start to show symbol.
interval the interval of show symbol.
forceShowLast false whether to show the last symbol.
repeat false 图形是否重复。

SerieTheme

Inherits or Implemented: ChildComponent

field default comment
lineWidth the color of text.
lineSymbolSize
scatterSymbolSize
pieTooltipExtraRadius 饼图鼠标移到高亮时的额外半径
selectedRate 1.3f
pieSelectedOffset 饼图选中时的中心点偏移
candlestickColor Color32(235, 84, 84, 255) K线图阳线（涨）填充色
candlestickColor0 Color32(71, 178, 98, 255) K线图阴线（跌）填充色
candlestickBorderWidth 1 K线图边框宽度
candlestickBorderColor Color32(235, 84, 84, 255) K线图阳线（跌）边框色
candlestickBorderColor0 Color32(71, 178, 98, 255) K线图阴线（跌）边框色

Settings

Inherits or Implemented: MainComponent

Global parameter setting component. The default value can be used in general, and can be adjusted when necessary.

field default comment
show true
maxPainter 10 max painter.
reversePainter false Painter是否逆序。逆序时index大的serie最先绘制。
basePainterMaterial Base Pointer 材质球，设置后会影响Axis等。
seriePainterMaterial Serie Pointer 材质球，设置后会影响所有Serie。
topPainterMaterial Top Pointer 材质球，设置后会影响Tooltip等。
lineSmoothStyle 3f Curve smoothing factor. By adjusting the smoothing coefficient, the curvature of the curve can be changed, and different curves with slightly different appearance can be obtained.
lineSmoothness 2f Smoothness of curve. The smaller the value, the smoother the curve, but the number of vertices will increase.
lineSegmentDistance 3f The partition distance of a line segment. A line in a normal line chart is made up of many segments, the number of which is determined by the change in value. The smaller the number of segments, the higher the number of vertices. When the area with gradient is filled, the larger the value, the worse the transition effect.
cicleSmoothness 2f the smoothess of cricle.
legendIconLineWidth 2 the width of line serie legend.
legendIconCornerRadius The radius of rounded corner. Its unit is px. Use array to respectively specify the 4 corner radiuses((clockwise upper left, upper right, bottom right and bottom left)).

SimplifiedBar

Inherits or Implemented: Serie,INeedSerieContainer,ISimplifiedSerie

SimplifiedCandlestick

Inherits or Implemented: Serie,INeedSerieContainer,ISimplifiedSerie

SimplifiedLine

Inherits or Implemented: Serie,INeedSerieContainer,ISimplifiedSerie

SingleAxis

Inherits or Implemented: Axis,IUpdateRuntimeData

Single axis.

field default comment
orient Orientation of the axis. By default, it's 'Horizontal'. You can set it to be 'Vertical' to make a vertical axis.
Orient:
- Horizonal: 水平
- Vertical: 垂直
left 0.1f Distance between component and the left side of the container.
right 0.1f Distance between component and the right side of the container.
top 0f Distance between component and the top side of the container.
bottom 0.2f Distance between component and the bottom side of the container.
width 0
height 50

SingleAxisCoord

Inherits or Implemented: CoordSystem

StageColor

Inherits or Implemented: ChildComponent

field default comment
percent 结束位置百分比。
color 颜色。

SubTitleTheme

Inherits or Implemented: ComponentTheme

SymbolStyle

Inherits or Implemented: ChildComponent

系列数据项的标记的图形

field default comment
show true Whether the symbol is showed.
type the type of symbol.
SymbolType:
- None: 不显示标记。
- Custom: 自定义标记。
- Circle: 圆形。
- EmptyCircle: 空心圆。
- Rect: 正方形。可通过设置itemStyle的cornerRadius变成圆角矩形。
- EmptyRect: 空心正方形。
- Triangle: 三角形。
- EmptyTriangle: 空心三角形。
- Diamond: 菱形。
- EmptyDiamond: 空心菱形。
- Arrow: 箭头。
- EmptyArrow: 空心箭头。
size 0f the size of symbol.
gap 0 the gap of symbol and line segment.
width 0f 图形的宽。
height 0f 图形的高。
offset Vector2.zero 图形的偏移。
image 自定义的标记图形。
imageType
color 图形的颜色。

TextLimit

Inherits or Implemented: ChildComponent

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.

field default comment
enable false Whether to enable text limit.
maxWidth 0 Set the maximum width. A default of 0 indicates automatic fetch; otherwise, custom.
gap 1 White pixel distance at both ends.
suffix Suffixes when the length exceeds.

TextPadding

Inherits or Implemented: ChildComponent

Settings related to text.

field default comment
show true
top 2
right 4
left 4
bottom 2

TextStyle

Inherits or Implemented: ChildComponent

Settings related to text.

field default comment
show true Settings related to text.
font the font of text. When null, the theme's font is used by default.
autoWrap false 是否自动换行。
autoAlign true 文本是否让系统自动选对齐方式。为false时才会用alignment。
rotate 0 Rotation of text.
autoColor false 是否开启自动颜色。当开启时，会自动设置颜色。
color the color of text.
fontSize 0 font size.
fontStyle font style.
lineSpacing 1f text line spacing.
alignment 对齐方式。
tMPFont
tMPFontStyle
tMPAlignment

Theme

Inherits or Implemented: ScriptableObject

Theme.

field default comment
themeType the theme of chart.
ThemeType:
- Default: 默认主题。
- Light: 亮主题。
- Dark: 暗主题。
- Custom: 自定义主题。
themeName
font the font of chart text。 字体。
tMPFont the font of chart text。 字体。
contrastColor the contrast color of chart.
backgroundColor the background color of chart.
colorPalette The color list of palette. If no color is set in series, the colors would be adopted sequentially and circularly from this list as the colors of series.
common ComponentTheme
title TitleTheme
subTitle SubTitleTheme
legend LegendTheme
axis AxisTheme
tooltip TooltipTheme
dataZoom DataZoomTheme
visualMap VisualMapTheme
serie SerieTheme

ThemeStyle

Inherits or Implemented: ChildComponent

Theme.

field default comment
show true
sharedTheme Theme
transparentBackground false Whether the background color is transparent. When true, the background color is not drawn. ｜是否透明背景颜色。当设置为true时，不绘制背景颜色。
enableCustomTheme false Whether to customize theme colors. When set to true, you can use 'sync color to custom' to synchronize the theme color to the custom color. It can also be set manually.
customFont
customBackgroundColor the custom background color of chart.
customColorPalette

Title

Inherits or Implemented: MainComponent,IPropertyChanged

Title component, including main title and subtitle.

field default comment
show true [default:true] Set this to false to prevent the title from showing.
text The main title text, supporting \n for newlines.
subText Subtitle text, supporting for \n for newlines.
labelStyle The text style of main title. LabelStyle
subLabelStyle The text style of sub title. LabelStyle
itemGap 0 [default:8] The gap between the main title and subtitle.
location The location of title component. Location

TitleStyle

Inherits or Implemented: LabelStyle,ISerieDataComponent,ISerieExtraComponent

the title of serie.

TitleTheme

Inherits or Implemented: ComponentTheme

Tooltip

Inherits or Implemented: MainComponent

Tooltip component.

field default comment
show true Whether to show the tooltip component.
type Indicator type.
Painter.Type:
- Base:
- Serie:
- Top:
trigger Type of triggering.
Tooltip.Trigger:
- Item: Triggered by data item, which is mainly used for charts that don't have a category axis like scatter charts or pie charts.
- Axis: Triggered by axes, which is mainly used for charts that have category axes, like bar charts or line charts.
- None: Trigger nothing.
itemFormatter a string template formatter for a single Serie or data item content. Support for wrapping lines with \n. When formatter is not null, use formatter first, otherwise use itemFormatter.
titleFormatter
marker the marker of serie.
fixedWidth 0 Fixed width. Higher priority than minWidth.
fixedHeight 0 Fixed height. Higher priority than minHeight.
minWidth 0 Minimum width. If fixedWidth has a value, get fixedWidth first.
minHeight 0 Minimum height. If fixedHeight has a value, take priority over fixedHeight.
numericFormatter Standard numeric format string. Used to format numeric values to display as strings. Using 'Axx' form: 'A' is the single character of the format specifier, supporting 'C' currency, 'D' decimal, 'E' exponent, 'F' number of vertices, 'G' regular, 'N' digits, 'P' percentage, 'R' round tripping, 'X' hex etc. 'XX' is the precision specification, from '0' - '99'.
paddingLeftRight 10 the text padding of left and right. defaut:5.
paddingTopBottom 10 the text padding of top and bottom. defaut:5.
ignoreDataShow false Whether to show ignored data on tooltip.
ignoreDataDefaultContent The default display character information for ignored data.
showContent true 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.
alwayShowContent false Whether to trigger after always display.
offset Vector2(18f, -25f) The position offset of tooltip relative to the mouse position.
backgroundImage The background image of tooltip.
backgroundType The background type of tooltip.
backgroundColor The background color of tooltip.
borderWidth 2f the width of tooltip border.
fixedXEnable false
fixedX 0f
fixedYEnable false
fixedY 0f
titleHeight 25f
itemHeight 25f
borderColor Color32(230, 230, 230, 255) the color of tooltip border.
lineStyle the line style of indicator line. LineStyle
indicatorLabelStyle the label style of tooltip axis indicator label. LabelStyle
titleLabelStyle 标题的文本样式。 LabelStyle
contentLabelStyles

TooltipTheme

Inherits or Implemented: ComponentTheme

field default comment
lineType the type of line.
lineWidth 1f the width of line.
lineColor the color of line.
areaColor the color of line.
labelTextColor the text color of tooltip cross indicator's axis label.
labelBackgroundColor the background color of tooltip cross indicator's axis label.

VisualMap

Inherits or Implemented: MainComponent

VisualMap component. Mapping data to visual elements such as colors.

field default comment
show true Whether to enable components.
showUI false Whether to display components. If set to false, it will not show up, but the data mapping function still exists.
type the type of visualmap component.
Painter.Type:
- Base:
- Serie:
- Top:
selectedMode the selected mode for Piecewise visualMap.
VisualMap.SelectedMode:
- Multiple: 多选。
- Single: 单选。
serieIndex 0 the serie index of visualMap.
min 0 范围最小值
max 100 范围最大值
range Specifies the position of the numeric value corresponding to the handle. Range should be within the range of [min,max].
text Text on both ends.
textGap The distance between the two text bodies.
splitNumber 5 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.
calculable false Whether the handle used for dragging is displayed (the handle can be dragged to adjust the selected range).
realtime true Whether to update in real time while dragging.
itemWidth 20f The width of the figure, that is, the width of the color bar.
itemHeight 140f The height of the figure, that is, the height of the color bar.
itemGap 10f 每个图元之间的间隔距离。
borderWidth 0 Border line width.
dimension -1 Specifies "which dimension" of the data to map to the visual element. "Data" is series.data.
hoverLink true 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.
autoMinMax true Automatically set min, Max value 自动设置min，max的值
orient Specify whether the layout of component is horizontal or vertical.
Orient:
- Horizonal: 水平
- Vertical: 垂直
location The location of component. Location
workOnLine true Whether the visualmap is work on linestyle of linechart.
workOnArea false Whether the visualmap is work on areaStyle of linechart.
outOfRange Defines a visual color outside of the selected range.
inRange 分段式每一段的相关配置。

VisualMapRange

Inherits or Implemented: ChildComponent

field default comment
min 范围最小值
max 范围最大值
label 文字描述
color 颜色

VisualMapTheme

Inherits or Implemented: ComponentTheme

field default comment
borderWidth the width of border.
borderColor the color of dataZoom border.
backgroundColor the background color of visualmap.
triangeLen 20f 可视化组件的调节三角形边长。

XAxis

Inherits or Implemented: Axis

The x axis in cartesian(rectangular) coordinate.

XCResourcesImporter

XCSettings

Inherits or Implemented: ScriptableObject

field default comment
lang Lang
font
tMPFont
fontSizeLv1 28
fontSizeLv2 24
fontSizeLv3 20
fontSizeLv4 18
axisLineType
axisLineWidth 0.8f
axisSplitLineType
axisSplitLineWidth 0.8f
axisTickWidth 0.8f
axisTickLength 5f
gaugeAxisLineWidth 15f
gaugeAxisSplitLineWidth 0.8f
gaugeAxisSplitLineLength 15f
gaugeAxisTickWidth 0.8f
gaugeAxisTickLength 5f
tootipLineWidth 0.8f
dataZoomBorderWidth 0.5f
dataZoomDataLineWidth 0.5f
visualMapBorderWidth 0f
serieLineWidth 1.8f
serieLineSymbolSize 5f
serieScatterSymbolSize 20f
serieSelectedRate 1.3f
serieCandlestickBorderWidth 1f
editorShowAllListData false
maxPainter 10
lineSmoothStyle 3f
lineSmoothness 2f
lineSegmentDistance 3f
cicleSmoothness 2f
visualMapTriangeLen 20f
pieTooltipExtraRadius 8f
pieSelectedOffset 8f
customThemes

YAxis

Inherits or Implemented: Axis

The x axis in cartesian(rectangular) coordinate.

XCharts Homepage
XCharts API
XCharts FAQ