mirror of
https://github.com/XCharts-Team/XCharts.git
synced 2026-05-28 03:58:49 +00:00
更新文档
This commit is contained in:
@@ -2,6 +2,7 @@
|
||||
sidebar_position: 31
|
||||
slug: /configuration
|
||||
---
|
||||
import APITable from '@site/src/components/APITable';
|
||||
|
||||
# Chart Configuration
|
||||
|
||||
@@ -195,6 +196,7 @@ Angle axis of Polar Coordinate.
|
||||
<APITable name="AngleAxis">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|startAngle|0||Starting angle of axis. 0 degrees by default, standing for right position of center.
|
||||
@@ -217,6 +219,7 @@ the animation of serie.
|
||||
<APITable name="AnimationStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|enable|true||Whether to enable animation.
|
||||
@@ -246,6 +249,7 @@ The style of area.
|
||||
<APITable name="AreaStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Set this to false to prevent the areafrom showing.
|
||||
@@ -268,6 +272,7 @@ The style of area.
|
||||
<APITable name="ArrowStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|width|10||The widht of arrow.
|
||||
@@ -290,6 +295,7 @@ The axis in rectangular coordinate.
|
||||
<APITable name="Axis">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether to show axis.
|
||||
@@ -338,6 +344,7 @@ Settings related to axis label.
|
||||
<APITable name="AxisLabel">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|interval|0||The display interval of the axis label.
|
||||
@@ -362,6 +369,7 @@ Settings related to axis line.
|
||||
<APITable name="AxisLine">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|onZero|||When mutiple axes exists, this option can be used to specify which axis can be "onZero" to.
|
||||
@@ -384,6 +392,7 @@ Minor split line of axis in grid area.
|
||||
<APITable name="AxisMinorSplitLine">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|distance|||The distance between the split line and axis line.
|
||||
@@ -405,6 +414,7 @@ Settings related to axis minor tick.
|
||||
<APITable name="AxisMinorTick">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|splitNumber|5||Number of segments that the axis is split into.
|
||||
@@ -424,6 +434,7 @@ the name of axis.
|
||||
<APITable name="AxisName">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|||Whether to show axis name.
|
||||
@@ -445,6 +456,7 @@ Split area of axis in grid area, not shown by default.
|
||||
<APITable name="AxisSplitArea">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|||Set this to true to show the splitArea.
|
||||
@@ -464,6 +476,7 @@ Split line of axis in grid area.
|
||||
<APITable name="AxisSplitLine">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|interval|||Interval of Axis splitLine.
|
||||
@@ -490,6 +503,7 @@ Settings related to axis tick.
|
||||
<APITable name="AxisTick">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|alignWithLabel|||Align axis tick with label, which is available only when boundaryGap is set to be true in category axis.
|
||||
@@ -514,6 +528,7 @@ Background component.
|
||||
<APITable name="Background">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether to enable the background component.
|
||||
@@ -538,6 +553,7 @@ Background component.
|
||||
<APITable name="BaseAxisTheme">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|lineType|||the type of line.<br/>`LineStyle.Type`:<br/>- `Solid`: 实线<br/>- `Dashed`: 虚线<br/>- `Dotted`: 点线<br/>- `DashDot`: 点划线<br/>- `DashDotDot`: 双点划线<br/>- `None`: 双点划线<br/>|
|
||||
@@ -568,6 +584,7 @@ Settings related to base line.
|
||||
<APITable name="BaseLine">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|||Set this to false to prevent the axis line from showing.
|
||||
@@ -619,6 +636,7 @@ comment of chart.
|
||||
<APITable name="Comment">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Set this to false to prevent the comment from showing.
|
||||
@@ -640,6 +658,7 @@ comment of chart.
|
||||
<APITable name="CommentItem">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Set this to false to prevent this comment item from showing.
|
||||
@@ -663,6 +682,7 @@ the comment mark style.
|
||||
<APITable name="CommentMarkStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Set this to false to prevent this comment item from showing.
|
||||
@@ -680,6 +700,7 @@ the comment mark style.
|
||||
<APITable name="ComponentTheme">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|font|||the font of text.
|
||||
@@ -708,6 +729,7 @@ DataZoom component is used for zooming a specific area, which enables user to in
|
||||
<APITable name="DataZoom">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|enable|true||Whether to show dataZoom.
|
||||
@@ -755,6 +777,7 @@ DataZoom component is used for zooming a specific area, which enables user to in
|
||||
<APITable name="DataZoomTheme">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|borderWidth|||the width of border line.
|
||||
@@ -777,6 +800,7 @@ DataZoom component is used for zooming a specific area, which enables user to in
|
||||
<APITable name="DebugInfo">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether show debug component.
|
||||
@@ -805,6 +829,7 @@ Configurations of emphasis state.
|
||||
<APITable name="EmphasisStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|scale|1.1f||Whether to scale to highlight the data in emphasis state.
|
||||
@@ -829,6 +854,7 @@ Grid component.
|
||||
<APITable name="GridCoord">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether to show the grid in rectangular coordinate.
|
||||
@@ -853,6 +879,7 @@ Grid component.
|
||||
<APITable name="Heatmap">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|heatmapType||v3.3.0|The mapping type of heatmap.<br/>`HeatmapType`:<br/>- `Data`: Data mapping type.By default, the second dimension data is used as the color map.<br/>- `Count`: Number mapping type.The number of occurrences of a statistic in a divided grid, as a color map.<br/>|
|
||||
@@ -869,6 +896,7 @@ Grid component.
|
||||
<APITable name="IconStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|false||Whether the data icon is show.
|
||||
@@ -894,6 +922,7 @@ Grid component.
|
||||
<APITable name="ImageStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether the data icon is show.
|
||||
@@ -918,6 +947,7 @@ Indicator of radar chart, which is used to assign multiple variables(dimensions)
|
||||
<APITable name="Indicator">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|name|||The name of indicator.
|
||||
@@ -988,6 +1018,7 @@ The interface for serie data component.
|
||||
<APITable name="ItemStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||是否启用。
|
||||
@@ -1029,6 +1060,7 @@ The interface for serie data component.
|
||||
<APITable name="LabelLine">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether the label line is showed.
|
||||
@@ -1056,6 +1088,7 @@ Text label of chart, to explain some data information about graphic item like va
|
||||
<APITable name="LabelStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether the label is showed.
|
||||
@@ -1102,6 +1135,7 @@ Legend component.The legend component shows different sets of tags, colors, and
|
||||
<APITable name="Legend">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether to show legend component.
|
||||
@@ -1136,6 +1170,7 @@ Legend component.The legend component shows different sets of tags, colors, and
|
||||
<APITable name="LegendTheme">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|unableColor|||the color of text.
|
||||
@@ -1152,6 +1187,7 @@ Legend component.The legend component shows different sets of tags, colors, and
|
||||
<APITable name="Level">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|label|||文本标签样式。 [LabelStyle](#labelstyle)|
|
||||
@@ -1170,6 +1206,7 @@ Legend component.The legend component shows different sets of tags, colors, and
|
||||
<APITable name="LevelStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|false||是否启用LevelStyle
|
||||
@@ -1191,6 +1228,7 @@ Legend component.The legend component shows different sets of tags, colors, and
|
||||
<APITable name="LineArrow">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|||Whether to show the arrow.
|
||||
@@ -1211,6 +1249,7 @@ The style of line.
|
||||
<APITable name="LineStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether show line.
|
||||
@@ -1236,6 +1275,7 @@ Location type. Quick to set the general location.
|
||||
<APITable name="Location">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|align|||对齐方式。<br/>`Location.Align`:<br/>- `TopLeft`: 对齐方式<br/>- `TopRight`: 对齐方式<br/>- `TopCenter`: 对齐方式<br/>- `BottomLeft`: 对齐方式<br/>- `BottomRight`: 对齐方式<br/>- `BottomCenter`: 对齐方式<br/>- `Center`: 对齐方式<br/>- `CenterLeft`: 对齐方式<br/>- `CenterRight`: 对齐方式<br/>|
|
||||
@@ -1262,6 +1302,7 @@ Used to mark an area in chart. For example, mark a time interval.
|
||||
<APITable name="MarkArea">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||是否显示标域。
|
||||
@@ -1286,6 +1327,7 @@ Used to mark an area in chart. For example, mark a time interval.
|
||||
<APITable name="MarkAreaData">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|type|||Special markArea types, are used to label maximum value, minimum value and so on.<br/>`MarkAreaType`:<br/>- `None`: 标域类型<br/>- `Min`: 最小值。<br/>- `Max`: 最大值。<br/>- `Average`: 平均值。<br/>- `Median`: 中位数。<br/>|
|
||||
@@ -1310,6 +1352,7 @@ Use a line in the chart to illustrate.
|
||||
<APITable name="MarkLine">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether to display the marking line.
|
||||
@@ -1331,6 +1374,7 @@ Data of marking line.
|
||||
<APITable name="MarkLineData">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|type|||Special label types, are used to label maximum value, minimum value and so on.<br/>`MarkLineType`:<br/>- `None`: 标线类型<br/>- `Min`: 最小值。<br/>- `Max`: 最大值。<br/>- `Average`: 平均值。<br/>- `Median`: 中位数。<br/>|
|
||||
@@ -1363,6 +1407,7 @@ Marquee style. It can be used for the DataZoom component. 选取框样式。可
|
||||
<APITable name="MarqueeStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|apply|false|v3.5.0|Check whether the scope is applied to the DataZoom. If this parameter is set to true, the range after the selection is complete is the DataZoom selection range.
|
||||
@@ -1384,6 +1429,7 @@ padding setting of item or text.
|
||||
<APITable name="Padding">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||show padding. 是否显示。
|
||||
@@ -1414,6 +1460,7 @@ Grid component.
|
||||
<APITable name="ParallelCoord">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether to show the grid in rectangular coordinate.
|
||||
@@ -1446,6 +1493,7 @@ Polar coordinate can be used in scatter and line chart. Every polar coordinate h
|
||||
<APITable name="PolarCoord">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether to show the polor component.
|
||||
@@ -1465,6 +1513,7 @@ Polar coordinate can be used in scatter and line chart. Every polar coordinate h
|
||||
<APITable name="Radar">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|smooth|false|v3.2.0|Whether use smooth curve.
|
||||
@@ -1519,6 +1568,7 @@ Configurations of select state.
|
||||
<APITable name="Serie">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|index|||The index of serie.
|
||||
@@ -1606,6 +1656,7 @@ A data item of serie.
|
||||
<APITable name="SerieData">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|index|||the index of SerieData.
|
||||
@@ -1632,6 +1683,7 @@ A data item of serie.
|
||||
<APITable name="SerieSymbol">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|sizeType|||the type of symbol size.<br/>`SymbolSizeType`:<br/>- `Custom`: Specify constant for symbol size.<br/>- `FromData`: Specify the dataIndex and dataScale to calculate symbol size.<br/>- `Function`: Specify function for symbol size.<br/>|
|
||||
@@ -1657,6 +1709,7 @@ A data item of serie.
|
||||
<APITable name="SerieTheme">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|lineWidth|||the color of text.
|
||||
@@ -1685,6 +1738,7 @@ Global parameter setting component. The default value can be used in general, an
|
||||
<APITable name="Settings">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||
|
||||
@@ -1728,6 +1782,7 @@ Single axis.
|
||||
<APITable name="SingleAxis">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|orient|||Orientation of the axis. By default, it's 'Horizontal'. You can set it to be 'Vertical' to make a vertical axis.<br/>`Orient`:<br/>- `Horizonal`: 水平<br/>- `Vertical`: 垂直<br/>|
|
||||
@@ -1754,6 +1809,7 @@ Single axis.
|
||||
<APITable name="StageColor">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|percent|||结束位置百分比。
|
||||
@@ -1775,6 +1831,7 @@ the state style of serie.
|
||||
<APITable name="StateStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||是否启用高亮样式。
|
||||
@@ -1803,6 +1860,7 @@ the state style of serie.
|
||||
<APITable name="SymbolStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether the symbol is showed.
|
||||
@@ -1830,6 +1888,7 @@ Text character limitation and adaptation component. When the length of the text
|
||||
<APITable name="TextLimit">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|enable|false||Whether to enable text limit.
|
||||
@@ -1857,6 +1916,7 @@ Settings related to text.
|
||||
<APITable name="TextStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Settings related to text.
|
||||
@@ -1889,6 +1949,7 @@ Theme.
|
||||
<APITable name="Theme">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|themeType|||the theme of chart.<br/>`ThemeType`:<br/>- `Default`: 默认主题。<br/>- `Light`: 亮主题。<br/>- `Dark`: 暗主题。<br/>- `Custom`: 自定义主题。<br/>|
|
||||
@@ -1922,6 +1983,7 @@ Theme.
|
||||
<APITable name="ThemeStyle">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||
|
||||
@@ -1946,6 +2008,7 @@ Title component, including main title and subtitle.
|
||||
<APITable name="Title">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||[default:true] Set this to false to prevent the title from showing.
|
||||
@@ -1980,6 +2043,7 @@ Tooltip component.
|
||||
<APITable name="Tooltip">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether to show the tooltip component.
|
||||
@@ -2026,6 +2090,7 @@ Tooltip component.
|
||||
<APITable name="TooltipTheme">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|lineType|||the type of line.<br/>`LineStyle.Type`:<br/>- `Solid`: 实线<br/>- `Dashed`: 虚线<br/>- `Dotted`: 点线<br/>- `DashDot`: 点划线<br/>- `DashDotDot`: 双点划线<br/>- `None`: 双点划线<br/>|
|
||||
@@ -2047,6 +2112,7 @@ Tooltip component.
|
||||
<APITable name="UIComponentTheme">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||
|
||||
@@ -2067,6 +2133,7 @@ VisualMap component. Mapping data to visual elements such as colors.
|
||||
<APITable name="VisualMap">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|show|true||Whether to enable components.
|
||||
@@ -2108,6 +2175,7 @@ VisualMap component. Mapping data to visual elements such as colors.
|
||||
<APITable name="VisualMapRange">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|min|||范围最小值
|
||||
@@ -2127,6 +2195,7 @@ VisualMap component. Mapping data to visual elements such as colors.
|
||||
<APITable name="VisualMapTheme">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|borderWidth|||the width of border.
|
||||
@@ -2156,6 +2225,7 @@ The x axis in cartesian(rectangular) coordinate.
|
||||
<APITable name="XCSettings">
|
||||
```
|
||||
|
||||
|
||||
|field|default|since|comment|
|
||||
|--|--|--|--|
|
||||
|lang||| [Lang](#lang)|
|
||||
|
||||
Reference in New Issue
Block a user