forked from kdeggelman/xcharts
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs.json
356 lines (356 loc) · 13.6 KB
/
docs.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
{
"defaults": {
"mouseover": {
"type": "function",
"default": "function (data, i) {}",
"arguments": {
"data": "data for the element that was clicked",
"i": "the index of the data in the set"
},
"desc": "Callback behavior for a user mousing over a data point."
},
"mouseout": {
"type": "function",
"default": "function (data, i) {}",
"arguments": {
"data": "data for the element that was clicked",
"i": "the index of the data in the set"
},
"desc": "Callback behavior for a user mousing off a data point."
},
"click": {
"type": "function",
"default": "function (data, i) {}",
"arguments": {
"data": "data for the element that was clicked",
"i": "the index of the data in the set"
},
"desc": "Callback behavior for a user clicking a data point."
},
"axisPaddingTop": {
"type": "Number",
"default": 0,
"desc": "Amount of space between the top of the chart and the top value on the y-scale."
},
"axisPaddingRight": {
"type": "Number",
"default": 0,
"desc": "Amount of space between the right side of the chart and the highest value on the x-scale."
},
"axisPaddingBottom": {
"type": "Number",
"default": 5,
"desc": "Amount of space between the bottom of the chart and the lowest value on the y-scale."
},
"axisPaddingLeft": {
"type": "Number",
"default": 20,
"desc": "Amount of space between the left side of the chart and the lowest value on the x-scale."
},
"xMin": {
"type": "Number",
"default": "null",
"desc": "Minimum allowed value on the xScale. If <code>null</code>, uses the data's min value, logically padded for aesthetics. Does not affect <code>ordinal</code> scales. May be overrided using the <a href=\"#method-setData\">setData</a> method with the <a href=\"#data-xMin\">xMin</a> data format key."
},
"xMax": {
"type": "Number",
"default": "null",
"desc": "Maximum allowed value on the xScale. If <code>null</code>, uses the data's max value, logically padded for aesthetics. Does not affect <code>ordinal</code> scales. May be overrided using the <a href=\"#method-setData\">setData</a> method with the <a href=\"#data-xMax\">xMax</a> data format key."
},
"yMin": {
"type": "Number",
"default": "null",
"desc": "Minimum allowed value on the yScale. If <code>null</code>, uses the data's min value, logically padded for aesthetics. Does not affect <code>ordinal</code> scales. May be overrided using the <a href=\"#method-setData\">setData</a> method with the <a href=\"#data-yMin\">yMin</a> data format key."
},
"yMax": {
"type": "Number",
"default": "null",
"desc": "Maximum allowed value on the yScale. If <code>null</code>, uses the data's max value, logically padded for aesthetics. Does not affect <code>ordinal</code> scales. May be overrided using the <a href=\"#method-setData\">setData</a> method with the <a href=\"#data-yMax\">yMax</a> data format key."
},
"paddingTop": {
"type": "Number",
"default": 0,
"desc": "Amount of space from the top edge of the svg element to the beginning of the <var>axisPaddingTop</var>."
},
"paddingRight": {
"type": "Number",
"default": 0,
"desc": "Amount of space from the right edge of the svg element to the beginning of the <var>axisPaddingRight</var>."
},
"paddingBottom": {
"type": "Number",
"default": 20,
"desc": "Allows space for the x-axis scale. Controls the amount of space from the bottom edge of the svg element to the beginning of the <var>axisPaddingBottom</var>."
},
"paddingLeft": {
"type": "Number",
"default": 60,
"desc": "Allows space for the y-axis scale. Amount of space from the left edge of the svg element to the beginning of the <var>axisPaddingLeft</var>."
},
"tickHintX": {
"type": "Number",
"default": 10,
"desc": "The amount of ticks that you would <em>like</em> to have displayed on the x-axis. Note: this is merely a guide and your results will likely vary."
},
"tickFormatX": {
"type": "function",
"default": "function (x) { return x; }",
"desc": "Provide alternate formatting for the x-axis tick labels.",
"arguments": {
"x": "default tick value"
}
},
"tickHintY": {
"type": "Number",
"default": 10,
"desc": "The amount of ticks that you would <em>like</em> to have displayed on the y-axis. Note: this is merely a guide and your results will likely vary."
},
"tickFormatY": {
"type": "function",
"default": "function (y) { return y; }",
"desc": "Provide alternate formatting for the y-axis tick labels.",
"arguments": {
"y": "default tick value"
}
},
"dataFormatX": {
"type": "function",
"default": "function (x) { return x; }",
"desc": "A method to pre-format the input data for the x-axis before attempting to compute a scale or draw.",
"arguments": {
"x": "datum x-value"
}
},
"dataFormatY": {
"type": "function",
"default": "function (y) { return y; }",
"desc": "A method to pre-format the input data for the y-axis before attempting to compute a scale or draw.",
"arguments": {
"y": "datum y-value"
}
},
"unsupported": {
"type": "function",
"default": "function (selector) {\n d3.select(selector).text('SVG is not supported on your browser');\n}",
"desc": "A callback method that will be invoked if SVG is not supported in the viewer's browser.",
"arguments": {
"selector": "the selector used for this xChart's constructor"
}
},
"noDataMainOnly": {
"type": "boolean",
"default": true,
"desc": "TODO: fix and remove this"
},
"empty": {
"type": "function",
"default": "function (self, selector, data) {}",
"desc": "A callback method invoked when the data set provided was empty and there is nothing to draw.",
"arguments": {
"self": "the xChart instance",
"selector": "the selector used for this xChart's constructor",
"data": "the chart's main data array"
}
},
"notempty": {
"type": "function",
"default": "function (self, selector) {}",
"desc": "The opposite of <var>empty</var>. Invoked if the data set provided was not empty.",
"arguments": {
"self": "the xChart instance",
"selector": "the selector used for this xChart's constructor"
}
},
"timing": {
"type": "Number",
"default": 750,
"desc": "The amount of time, in milliseconds, to transition during draw/update."
},
"interpolation": {
"type": "string",
"default": "monotone",
"desc": "Line interpolation to use when drawing lines. See <a target=\"_blank\" href=\"https://github.com/mbostock/d3/wiki/SVG-Shapes#wiki-line_interpolate\">d3.js's line.interpolate</a> for more information."
}
},
"methods": {
"setData": {
"desc": "Change the data that for this chart and animate from the current display to the new data.",
"arguments": {
"data": {
"type": "object",
"desc": "See <a href=\"#data\">Data Format</a> for format and more information."
}
}
},
"setType": {
"desc": "Change the vis type for this chart and animate the display.",
"arguments": {
"type": {
"type": "string",
"options": ["bar", "cumulative", "line", "line-dotted"],
"desc": "The <em>vis type</em> to force the main data to display with. If not provided, will use the last set <em>vis type</em>, or the one provided at xChart creation time."
}
}
},
"setScale": {
"desc": "Update an axis' scale type.",
"arguments": {
"axis": {
"type": "string",
"desc": "The axis to change",
"options": ["x", "y"]
},
"type": {
"type": "string",
"desc": "Scale type to use along the y-axis (vertical).",
"options": ["ordinal", "linear", "time", "exponential"]
}
}
}
},
"dataFormat": {
"xScale": {
"type": "string",
"desc": "Scale type to use along the x-axis (horizontal).",
"options": ["ordinal", "linear", "time", "exponential"]
},
"yScale": {
"type": "string",
"desc": "Scale type to use along the y-axis (vertical).",
"options": ["ordinal", "linear", "time", "exponential"]
},
"xMin": {
"type": "Number",
"desc": "Minimum allowed value on the xScale. If <code>null</code>, uses the data's min value, logically padded for aesthetics. Does not affect <code>ordinal</code> scales."
},
"xMax": {
"type": "Number",
"desc": "Maximum allowed value on the xScale. If <code>null</code>, uses the data's max value, logically padded for aesthetics. Does not affect <code>ordinal</code> scales."
},
"yMin": {
"type": "Number",
"desc": "Minimum allowed value on the yScale. If <code>null</code>, uses the data's min value, logically padded for aesthetics. Does not affect <code>ordinal</code> scales."
},
"yMax": {
"type": "Number",
"desc": "Maximum allowed value on the yScale. If <code>null</code>, uses the data's max value, logically padded for aesthetics. Does not affect <code>ordinal</code> scales."
},
"type": {
"optional": true,
"type": "string",
"options": ["bar", "cumulative", "line", "line-dotted"],
"desc": "The <em>vis type</em> to force the main data to display with. If not provided, will use the last set <em>vis type</em>, or the one provided at xChart creation time."
},
"main": {
"type": "Array",
"desc": "An array of data sets to be drawn.",
"inc": "docs/main-data.html"
},
"comp": {
"type": "Array",
"desc": "An array of data sets to be used as comparisons to the main data set. This set differs from <var>main</var> in that each set must have its own independent vis type",
"optional": true
}
},
"vismethods": {
"preUpdateScale": {
"optional": true,
"desc": "Executed before the scales have been created for the given data sets.",
"arguments": {
"self": "the xChart instance",
"scaleData": "The union of the main and comp data sets",
"mainData": "The main data set",
"compData": "The comp data set"
},
"inc": "docs/vis-preupdatescale.html"
},
"postUpdateScale": {
"optional": true,
"desc": "Executed after the scales have been created for the given data sets.",
"arguments": {
"self": "the xChart instance",
"scaleData": "The union of the main and comp data sets",
"mainData": "The main data set",
"compData": "The comp data set"
},
"inc": "docs/vis-postupdatescale.html"
},
"enter": {
"optional": false,
"desc": "As the first draw step, enter is used to create any elements that we need and bind the data information to each element.",
"inc": "docs/vis-enter.html",
"arguments": {
"self": "The xChart instance",
"storage": "A persistent object specific to this vis type for you to store data for later retrieval.",
"className": "A set of CSS classNames, dot-separated, that are recommended to be appended to the main element of this vis."
"data": "The data that should be used for drawing this vis.",
}
},
"update": {
"optional": false,
"desc": "During update, we loop over every element and transition its appearance, based on any changes that may have been made to our data series.",
"inc": "docs/vis-update.html",
"arguments": {
"self": "The xChart instance",
"storage": "A persistent object specific to this vis type for you to store data for later retrieval.",
"timing": "Time, in milliseconds, for running transitions."
}
},
"exit": {
"optional": false,
"desc": "Called as the last step of updating a vis, in this method we hide any visual elements that are no longer being used–elements from a previous data series that no longer exist in the new series.",
"inc": "docs/vis-exit.html",
"arguments": {
"self": "The xChart instance",
"storage": "A persistent object specific to this vis type for you to store data for later retrieval.",
"timing": "Time, in milliseconds, for running transitions."
}
},
"destroy": {
"optional": false,
"desc": "In the last step of our vis, we remove all displayed elements. This method is most called when xChart is instructed to change vis-types for the entire chart.",
"inc": "docs/vis-destroy.html",
"arguments": {
"self": "The xChart instance",
"storage": "A persistent object specific to this vis type for you to store data for later retrieval.",
"timing": "Time, in milliseconds, for running transitions."
}
}
},
"pizza": {
"xScale": "ordinal",
"yScale": "linear",
"type": "bar",
"main": [
{
"className": ".pizza",
"data": [
{
"x": "Pepperoni",
"y": 12
},
{
"x": "Cheese",
"y": 8
}
]
}
],
"comp": [
{
"className": ".pizza",
"type": "line-dotted",
"data": [
{
"x": "Pepperoni",
"y": 10
},
{
"x": "Cheese",
"y": 4
}
]
}
]
}
}