@@ -74,34 +74,34 @@ items:
74
74
v-chart :
75
75
props :
76
76
prevent-render :
77
- version : next
77
+ version : v2.9.1
78
78
type : boolean
79
79
default : false
80
80
en : whether prevent rendering
81
81
zh-CN : 是否自定义渲染逻辑
82
82
prevent-default :
83
- version : next
83
+ version : v2.9.1
84
84
type : boolean
85
85
default : false
86
86
en : whether prevent default behavior
87
87
zh-CN : 是否阻止默认行为
88
88
events :
89
89
on-render :
90
- version : next
90
+ version : v2.9.1
91
91
params : ' `({ chart })`'
92
92
en : fires before render
93
93
zh-CN : 渲染前触发,一般用于配合 `prevent-render` 自定义渲染逻辑
94
94
methods :
95
95
rerender :
96
- version : next
96
+ version : v2.9.1
97
97
en : destroy and re-render canvas
98
98
zh-CN : 清除并重新渲染
99
99
repaint :
100
- version : next
100
+ version : v2.9.1
101
101
en : repain canvas
102
102
zh-CN : 重新渲染
103
103
destroy :
104
- version : next
104
+ version : v2.9.1
105
105
en : destroy chart
106
106
zh-CN : 销毁图表,canvas dom 元素不会销毁
107
107
v-point :
@@ -115,17 +115,17 @@ v-line:
115
115
:::
116
116
props :
117
117
shape :
118
- version : next
118
+ version : v2.9.1
119
119
type : String
120
120
en : shape type, one of `line`, `smooth`, `dash`
121
121
zh-CN : 线条形状,可选值 `line`(默认), `smooth`(平滑线), `dash`(虚线)
122
122
series-field :
123
- version : next
123
+ version : v2.9.1
124
124
type : String
125
125
en : alias to color, specify color value or which field to color
126
126
zh-CN : 用于绘制多组线条时的分组字段名。该属性相当于 F2 里的 `color`,出于理解和设置方便使用 `series-field`
127
127
colors :
128
- version : next
128
+ version : v2.9.1
129
129
type : String,Array
130
130
en : colors, use default colors if not specified
131
131
zh-CN : 线条颜色,可以为单个颜色或者颜色列表。不指定时使用默认颜色。
@@ -136,24 +136,24 @@ v-guide:
136
136
:::
137
137
props :
138
138
type :
139
- version : next
139
+ version : v2.9.1
140
140
type : String
141
141
en : guide type, one of `line`, `text`, `tag`, `rect`, `html`, `arc`
142
142
zh-CN : 辅助元素类型,可以为 `line`, `text`, `tag`, `rect`, `html`, `arc`
143
143
options :
144
- version : next
144
+ version : v2.9.1
145
145
type : Object
146
146
en : guide options
147
147
zh-CN : 辅助元素属性对象。你也可以在 template 里将属性分开写,不需要使用该 prop,同时使用时属性会被合并。
148
148
v-area :
149
149
props :
150
150
series-field :
151
- version : next
151
+ version : v2.9.1
152
152
type : String
153
153
en : alias to color, specify color value or which field to color
154
154
zh-CN : 用于绘制多组线条时的分组字段名。该属性相当于 F2 里的 `color`,出于理解和设置方便使用 `series-field`
155
155
colors :
156
- version : next
156
+ version : v2.9.1
157
157
type : String,Array
158
158
en : colors, use default colors if not specified
159
159
zh-CN : 线条颜色,可以为单个颜色或者颜色列表。不指定时使用默认颜色。
@@ -166,19 +166,19 @@ v-tooltip:
166
166
:::
167
167
props :
168
168
disabled :
169
- version : next
169
+ version : v2.9.1
170
170
type : boolean
171
171
default : false
172
172
en : whether disable tooltip
173
173
zh-CN : ' [快捷属性,非 F2 原有属性]是否禁用 tooltip, 相当于调用`chart.tooltip(false)`'
174
174
show-x-value :
175
- version : next
175
+ version : v2.9.1
176
176
type : boolean
177
177
default : false
178
178
en : whether set display template to `xValue:yValue`, default `xLabel:yValue`
179
179
zh-CN : ' [快捷属性,非 F2 原有属性]用于单折线的情况,设定是否将 x 轴值显示在 tooltip 里,默认是 `xLabel:yValue` 的形式(value:23),启用将变成 `xValue:yValue` 的形式(2017-01-01:23),建议在 `tickCount` 无法完全显示时启用。该设置会覆盖原有 `onShow` 设置。'
180
180
show-value-in-legend :
181
- version : next
181
+ version : v2.9.1
182
182
type : boolean
183
183
default : false
184
184
en : whether hide default tooltip and show value in legend
@@ -188,7 +188,7 @@ v-legend:
188
188
图例。[F2 Legend](https://antv.alipay.com/zh-cn/f2/3.x/api/legend.html)。
189
189
props :
190
190
disabled :
191
- version : next
191
+ version : v2.9.1
192
192
type : boolean
193
193
default : false
194
194
en : whether disable tooltip
@@ -198,7 +198,7 @@ v-bar:
198
198
柱状图,使用垂直的柱子显示类别之间的数值比较。
199
199
props :
200
200
colors :
201
- version : next
201
+ version : v2.9.1
202
202
type : String,Array
203
203
en : colors, use default colors if not specified
204
204
zh-CN : 线条颜色,可以为单个颜色或者颜色列表。不指定时使用默认颜色。
@@ -209,56 +209,56 @@ v-axis:
209
209
坐标轴配置。[详细文档](https://antv.alipay.com/zh-cn/f2/3.x/api/axis.html)。
210
210
props :
211
211
disabled :
212
- version : next
212
+ version : v2.9.1
213
213
type : boolean
214
214
zh-CN : 禁用当前坐标轴。
215
215
x :
216
- version : next
216
+ version : v2.9.1
217
217
type : boolean
218
218
zh-CN : ' [组件属性]是否为 `x轴` 配置。'
219
219
y :
220
- version : next
220
+ version : v2.9.1
221
221
type : boolean
222
222
zh-CN : ' [组件属性]是否为 `y轴` 配置。'
223
223
v-scale :
224
224
description : |
225
225
度量 Scale,是数据空间到图形空间的转换桥梁,负责原始数据到 [0, 1] 区间数值的相互转换工作。针对不同的数据类型对应不同类型的度量。详细文档 [F2 Scale](https://antv.alipay.com/zh-cn/f2/3.x/api/scale.html)。
226
226
props :
227
227
field :
228
- version : next
228
+ version : v2.9.1
229
229
type : string
230
230
zh-CN : ' [组件属性]指定 `坐标轴` 字段。对于简单数据,VChart 可以判断使用哪个字段,但是如果顺序不确定或者多字段的数据,最好手动指定。'
231
231
x :
232
- version : next
232
+ version : v2.9.1
233
233
type : boolean
234
234
zh-CN : ' [组件属性]是否为 `x轴` 配置。'
235
235
y :
236
- version : next
236
+ version : v2.9.1
237
237
type : boolean
238
238
zh-CN : ' [组件属性]是否为 `y轴` 配置。'
239
239
type :
240
- version : next
240
+ version : v2.9.1
241
241
type : string
242
242
zh-CN : 指定不同的度量类型,支持的 type 为 `identity`、`linear`、`cat`、`timeCat`。
243
243
formatter :
244
- version : next
244
+ version : v2.9.1
245
245
type : function
246
246
zh-CN : 回调函数,用于格式化坐标轴刻度点的文本显示,会影响数据在坐标轴 axis、图例 legend、提示信息 tooltip 上的显示。
247
247
range :
248
- version : next
248
+ version : v2.9.1
249
249
type : array
250
250
default : ' [0, 1]'
251
251
zh-CN : 输出数据的范围,默认[0, 1],格式为 [min, max],min 和 max 均为 0 至 1 范围的数据。
252
252
alias :
253
- version : next
253
+ version : v2.9.1
254
254
type : string
255
255
zh-CN : ' 该数据字段的显示别名,一般用于将字段的英文名称转换成中文名(tooltip 中显示)。'
256
256
tick-count :
257
- version : next
257
+ version : v2.9.1
258
258
type : number
259
259
default : 5
260
260
zh-CN : 坐标轴上刻度点的个数,设为 0 时表示全部显示。
261
261
ticks :
262
- version : next
262
+ version : v2.9.1
263
263
type : array
264
264
zh-CN : ' 用于指定坐标轴上刻度点的文本信息,当用户设置了 ticks 就会按照 ticks 的个数和文本来显示。如 `[ 0, 50, 100, 150, 200, 300, 500 ]`'
0 commit comments