@vaadin/charts 24.4.0-dev.b3e1d14600 → 24.5.0-alpha1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +3 -1141
- package/README.md +0 -1
- package/package.json +6 -6
- package/src/vaadin-chart-series.d.ts +1 -1
- package/src/vaadin-chart-series.js +1 -1
- package/src/vaadin-chart.d.ts +1 -1
- package/src/vaadin-chart.js +24 -1
- package/theme/lumo/vaadin-chart-styles.d.ts +6 -0
- package/theme/lumo/vaadin-chart.d.ts +2 -0
- package/theme/material/vaadin-chart-styles.d.ts +6 -0
- package/theme/material/vaadin-chart.d.ts +2 -0
- package/theme/vaadin-chart-base-theme.js +1 -1
- package/web-types.json +684 -0
- package/web-types.lit.json +433 -0
package/web-types.json
ADDED
|
@@ -0,0 +1,684 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json.schemastore.org/web-types",
|
|
3
|
+
"name": "@vaadin/charts",
|
|
4
|
+
"version": "24.5.0-alpha1",
|
|
5
|
+
"description-markup": "markdown",
|
|
6
|
+
"contributions": {
|
|
7
|
+
"html": {
|
|
8
|
+
"elements": [
|
|
9
|
+
{
|
|
10
|
+
"name": "vaadin-chart",
|
|
11
|
+
"description": "`<vaadin-chart>` is a Web Component for creating high quality charts.\n\n### Basic use\n\nThere are two ways of configuring your `<vaadin-chart>` element: **HTML API**, **JS API** and **JSON API**.\nNote that you can make use of all APIs in your element.\n\n#### Configuring your chart using HTML API\n\n`vaadin-chart` has a set of attributes to make it easier for you to customize your chart.\n\n```html\n <vaadin-chart title=\"The chart title\" subtitle=\"The chart subtitle\">\n <vaadin-chart-series\n type=\"column\"\n title=\"The series title\"\n values=\"[10,20,30]\">\n </vaadin-chart-series>\n </vaadin-chart>\n```\n\n> Note that while you can set type for each series individually, for some types, such as `'bar'`, `'gauge'` and `'solidgauge'`, you\n> have to set it as the default series type on `<vaadin-chart>` in order to work properly.\n\n#### Configuring your chart using JS API\n\n1. Set an id for the `<vaadin-chart>` in the template\n```html\n <vaadin-chart id=\"mychart\"></vaadin-chart>\n```\n1. Add a function that uses `configuration` property (JS Api) to set chart title, categories and data\n```js\ninitChartWithJSApi() {\n requestAnimationFrame(() => {\n const configuration = this.$.mychart.configuration;\n configuration.setTitle({ text: 'The chart title' });\n // By default there is one X axis, it is referenced by configuration.xAxis[0].\n configuration.xAxis[0].setCategories(['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']);\n configuration.addSeries({\n type: 'column',\n data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]\n });\n });\n}\n```\n1. Call that function from connectedCallback (when the element is added to a document)\n```js\nconnectedCallback() {\n super.connectedCallback();\n this.initChartWithJSApi();\n}\n```\n\n#### Configuring your chart using JS JSON API\n\nJS JSON API is a simple alternative to the JS API.\n\n1. Set an id for the `<vaadin-chart>` in the template\n```html\n <vaadin-chart id=\"mychart\"></vaadin-chart>\n```\n1. Add a function that uses `updateConfiguration` method (JS JSON Api) to set chart title, categories and data\n```js\ninitChartWithJSJSONApi() {\n this.$.mychart.updateConfiguration({\n title: {\n text: 'The chart title'\n },\n subtitle: {\n text: 'Subtitle'\n },\n xAxis: {\n categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']\n },\n series: [{\n type: 'column',\n data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]\n }]\n });\n}\n```\n1. Call that function from connectedCallback (when the element is added to a document)\n```js\nconnectedCallback() {\n super.connectedCallback();\n this.initChartWithJSJSONApi();\n}\n```\n\nIt should be noted that chart style customization cannot be done via the JS or JSON API.\nStyling properties in the JSON configuration will be ignored. The following section discusses chart styling.\n\n### CSS Styling\n\nChart appearance is primarily controlled by CSS style rules.\nA comprehensive list of the supported style classes can be found at\nhttps://www.highcharts.com/docs/chart-design-and-style/style-by-css\n\nSee also the [Chart Styling](https://vaadin.com/docs/latest/components/charts/css-styling) documentation.\n\n### RTL support\n\n`vaadin-charts` as well as [Highcharts](https://www.highcharts.com/) by itself are not adjusting the layout\nbased on the `dir` attribute. In order to make `vaadin-charts` display RTL content properly additional\nJSON configuration should be used.\nEach chart should be updated based on the specific needs, but general recommendations are:\n\n 1. Set `reversed` to true for xAxis (https://api.highcharts.com/highcharts/xAxis.reversed).\n 2. Set `useHTML` to true for text elements, i.e. `tooltip` (https://api.highcharts.com/highcharts/tooltip.useHTML).\n 3. Set `rtl` to true for `legend` (https://api.highcharts.com/highcharts/legend.rtl).\n\n### Setting colors\n\nAlthough charts can be styled as described above, there is a simpler way for setting colors.\nColors can be set using CSS custom properties `--vaadin-charts-color-{n}` (where `n` goes from `0 - 9`).\n\nFor example `--vaadin-charts-color-0` sets the color of the first series on a chart.\n\n### Validating your License\n\nWhen using Vaadin Charts in a development environment, you will see a pop-up that asks you\nto validate your license by signing in to vaadin.com.",
|
|
12
|
+
"attributes": [
|
|
13
|
+
{
|
|
14
|
+
"name": "category-max",
|
|
15
|
+
"description": "Category-axis maximum value. Defaults to `undefined`.",
|
|
16
|
+
"value": {
|
|
17
|
+
"type": [
|
|
18
|
+
"number",
|
|
19
|
+
"null",
|
|
20
|
+
"undefined"
|
|
21
|
+
]
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"name": "category-min",
|
|
26
|
+
"description": "Category-axis minimum value. Defaults to `undefined`.",
|
|
27
|
+
"value": {
|
|
28
|
+
"type": [
|
|
29
|
+
"number",
|
|
30
|
+
"null",
|
|
31
|
+
"undefined"
|
|
32
|
+
]
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"name": "category-position",
|
|
37
|
+
"description": "The position of the category axis. Acceptable values are `left`, `right`, `top` and `bottom`\nexcept for bar charts which only accept `left` and `right`.\nWith the default value, charts appear as though they have `category-position=\"bottom\"`\nexcept for bar charts that appear as though they have `category-position=\"left\"`.\n\nDefaults to `undefined`",
|
|
38
|
+
"value": {
|
|
39
|
+
"type": [
|
|
40
|
+
"ChartCategoryPosition",
|
|
41
|
+
"undefined"
|
|
42
|
+
]
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"name": "no-legend",
|
|
47
|
+
"description": "Specifies whether to hide legend or show.\nLegend configuration can be set up via additionalOptions property",
|
|
48
|
+
"value": {
|
|
49
|
+
"type": [
|
|
50
|
+
"boolean",
|
|
51
|
+
"null",
|
|
52
|
+
"undefined"
|
|
53
|
+
]
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "stacking",
|
|
58
|
+
"description": "Specifies how series are stacked on top of each other.\nPossible values are null, \"normal\" or \"percent\".\nIf \"stack\" property is not defined on the vaadin-chart-series elements, then series will be put into\nthe default stack.",
|
|
59
|
+
"value": {
|
|
60
|
+
"type": [
|
|
61
|
+
"ChartStacking",
|
|
62
|
+
"undefined"
|
|
63
|
+
]
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "timeline",
|
|
68
|
+
"description": "Specifies whether the chart is a normal chart or a timeline chart.",
|
|
69
|
+
"value": {
|
|
70
|
+
"type": [
|
|
71
|
+
"boolean",
|
|
72
|
+
"null",
|
|
73
|
+
"undefined"
|
|
74
|
+
]
|
|
75
|
+
}
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "title",
|
|
79
|
+
"description": "Represents the title of the chart.",
|
|
80
|
+
"value": {
|
|
81
|
+
"type": [
|
|
82
|
+
"string"
|
|
83
|
+
]
|
|
84
|
+
}
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"name": "tooltip",
|
|
88
|
+
"description": "Whether or not to show tooltip when hovering data points.",
|
|
89
|
+
"value": {
|
|
90
|
+
"type": [
|
|
91
|
+
"boolean",
|
|
92
|
+
"null",
|
|
93
|
+
"undefined"
|
|
94
|
+
]
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"name": "type",
|
|
99
|
+
"description": "Sets the default series type of the chart.\nNote that `'bar'`, `'gauge'` and `'solidgauge'` should be set as default series type.",
|
|
100
|
+
"value": {
|
|
101
|
+
"type": [
|
|
102
|
+
"string",
|
|
103
|
+
"null",
|
|
104
|
+
"undefined"
|
|
105
|
+
]
|
|
106
|
+
}
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"name": "subtitle",
|
|
110
|
+
"description": "Represents the subtitle of the chart.",
|
|
111
|
+
"value": {
|
|
112
|
+
"type": [
|
|
113
|
+
"string",
|
|
114
|
+
"undefined"
|
|
115
|
+
]
|
|
116
|
+
}
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"name": "chart3d",
|
|
120
|
+
"description": "Specifies whether to show chart in 3 or in 2 dimensions.\nSome display angles are added by default to the \"chart.options3d\" (`{alpha: 15, beta: 15, depth: 50}`).\n3D display options can be modified via `additionalOptions`.\nThe thickness of a Pie chart can be set on `additionalOptions` through `plotOptions.pie.depth`.\n3D is supported by Bar, Column, Pie and Scatter3D charts.\nMore info available at [Highcharts](https://www.highcharts.com/docs/chart-concepts/3d-charts).",
|
|
121
|
+
"value": {
|
|
122
|
+
"type": [
|
|
123
|
+
"boolean",
|
|
124
|
+
"null",
|
|
125
|
+
"undefined"
|
|
126
|
+
]
|
|
127
|
+
}
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"name": "empty-text",
|
|
131
|
+
"description": "Specifies the message displayed on a chart without displayable data.",
|
|
132
|
+
"value": {
|
|
133
|
+
"type": [
|
|
134
|
+
"string"
|
|
135
|
+
]
|
|
136
|
+
}
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"name": "polar",
|
|
140
|
+
"description": "When present, cartesian charts like line, spline, area and column are transformed\ninto the polar coordinate system.",
|
|
141
|
+
"value": {
|
|
142
|
+
"type": [
|
|
143
|
+
"boolean",
|
|
144
|
+
"null",
|
|
145
|
+
"undefined"
|
|
146
|
+
]
|
|
147
|
+
}
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
"name": "theme",
|
|
151
|
+
"description": "The theme variants to apply to the component.",
|
|
152
|
+
"value": {
|
|
153
|
+
"type": [
|
|
154
|
+
"string",
|
|
155
|
+
"null",
|
|
156
|
+
"undefined"
|
|
157
|
+
]
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
],
|
|
161
|
+
"js": {
|
|
162
|
+
"properties": [
|
|
163
|
+
{
|
|
164
|
+
"name": "configuration",
|
|
165
|
+
"description": "Configuration object that exposes the JS Api to configure the chart.\n\nMost important methods are:\n- `addSeries (Object options, [Boolean redraw], [Mixed animation])`\n- `addAxis (Object options, [Boolean isX], [Boolean redraw], [Mixed animation])`\n- `setTitle (Object title, object subtitle, Boolean redraw)`\n\nMost important properties are:\n- `configuration.series`: An array of the chart's series. Detailed API for Series object is\n available in [API Site](http://api.highcharts.com/class-reference/Highcharts.Series)\n- `configuration.xAxis`: An array of the chart's x axes. Detailed API for Axis object is\n available in [API Site](http://api.highcharts.com/class-reference/Highcharts.Axis)\n- `configuration.yAxis`: An array of the chart's y axes. Detailed API for Axis object is\n available in [API Site](http://api.highcharts.com/class-reference/Highcharts.Axis)\n- `configuration.title`: The chart title.\n\nFor detailed documentation of available API check the [API site](http://api.highcharts.com/class-reference/classes.list)",
|
|
166
|
+
"value": {
|
|
167
|
+
"type": [
|
|
168
|
+
"Highcharts.Chart",
|
|
169
|
+
"undefined"
|
|
170
|
+
]
|
|
171
|
+
}
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"name": "categories",
|
|
175
|
+
"description": "If categories are present names are used instead of numbers for the category axis.\nThe format of categories can be an `Array` with a list of categories, such as `['2010', '2011', '2012']`\nor a mapping `Object`, like `{0:'1',9:'Target (10)', 15: 'Max'}`.",
|
|
176
|
+
"value": {
|
|
177
|
+
"type": [
|
|
178
|
+
"ChartCategories",
|
|
179
|
+
"undefined"
|
|
180
|
+
]
|
|
181
|
+
}
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"name": "categoryMax",
|
|
185
|
+
"description": "Category-axis maximum value. Defaults to `undefined`.",
|
|
186
|
+
"value": {
|
|
187
|
+
"type": [
|
|
188
|
+
"number",
|
|
189
|
+
"null",
|
|
190
|
+
"undefined"
|
|
191
|
+
]
|
|
192
|
+
}
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"name": "categoryMin",
|
|
196
|
+
"description": "Category-axis minimum value. Defaults to `undefined`.",
|
|
197
|
+
"value": {
|
|
198
|
+
"type": [
|
|
199
|
+
"number",
|
|
200
|
+
"null",
|
|
201
|
+
"undefined"
|
|
202
|
+
]
|
|
203
|
+
}
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"name": "categoryPosition",
|
|
207
|
+
"description": "The position of the category axis. Acceptable values are `left`, `right`, `top` and `bottom`\nexcept for bar charts which only accept `left` and `right`.\nWith the default value, charts appear as though they have `category-position=\"bottom\"`\nexcept for bar charts that appear as though they have `category-position=\"left\"`.\n\nDefaults to `undefined`",
|
|
208
|
+
"value": {
|
|
209
|
+
"type": [
|
|
210
|
+
"ChartCategoryPosition",
|
|
211
|
+
"undefined"
|
|
212
|
+
]
|
|
213
|
+
}
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"name": "noLegend",
|
|
217
|
+
"description": "Specifies whether to hide legend or show.\nLegend configuration can be set up via additionalOptions property",
|
|
218
|
+
"value": {
|
|
219
|
+
"type": [
|
|
220
|
+
"boolean",
|
|
221
|
+
"null",
|
|
222
|
+
"undefined"
|
|
223
|
+
]
|
|
224
|
+
}
|
|
225
|
+
},
|
|
226
|
+
{
|
|
227
|
+
"name": "stacking",
|
|
228
|
+
"description": "Specifies how series are stacked on top of each other.\nPossible values are null, \"normal\" or \"percent\".\nIf \"stack\" property is not defined on the vaadin-chart-series elements, then series will be put into\nthe default stack.",
|
|
229
|
+
"value": {
|
|
230
|
+
"type": [
|
|
231
|
+
"ChartStacking",
|
|
232
|
+
"undefined"
|
|
233
|
+
]
|
|
234
|
+
}
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
"name": "timeline",
|
|
238
|
+
"description": "Specifies whether the chart is a normal chart or a timeline chart.",
|
|
239
|
+
"value": {
|
|
240
|
+
"type": [
|
|
241
|
+
"boolean",
|
|
242
|
+
"null",
|
|
243
|
+
"undefined"
|
|
244
|
+
]
|
|
245
|
+
}
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
"name": "title",
|
|
249
|
+
"description": "Represents the title of the chart.",
|
|
250
|
+
"value": {
|
|
251
|
+
"type": [
|
|
252
|
+
"string"
|
|
253
|
+
]
|
|
254
|
+
}
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"name": "tooltip",
|
|
258
|
+
"description": "Whether or not to show tooltip when hovering data points.",
|
|
259
|
+
"value": {
|
|
260
|
+
"type": [
|
|
261
|
+
"boolean",
|
|
262
|
+
"null",
|
|
263
|
+
"undefined"
|
|
264
|
+
]
|
|
265
|
+
}
|
|
266
|
+
},
|
|
267
|
+
{
|
|
268
|
+
"name": "type",
|
|
269
|
+
"description": "Sets the default series type of the chart.\nNote that `'bar'`, `'gauge'` and `'solidgauge'` should be set as default series type.",
|
|
270
|
+
"value": {
|
|
271
|
+
"type": [
|
|
272
|
+
"string",
|
|
273
|
+
"null",
|
|
274
|
+
"undefined"
|
|
275
|
+
]
|
|
276
|
+
}
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
"name": "subtitle",
|
|
280
|
+
"description": "Represents the subtitle of the chart.",
|
|
281
|
+
"value": {
|
|
282
|
+
"type": [
|
|
283
|
+
"string",
|
|
284
|
+
"undefined"
|
|
285
|
+
]
|
|
286
|
+
}
|
|
287
|
+
},
|
|
288
|
+
{
|
|
289
|
+
"name": "chart3d",
|
|
290
|
+
"description": "Specifies whether to show chart in 3 or in 2 dimensions.\nSome display angles are added by default to the \"chart.options3d\" (`{alpha: 15, beta: 15, depth: 50}`).\n3D display options can be modified via `additionalOptions`.\nThe thickness of a Pie chart can be set on `additionalOptions` through `plotOptions.pie.depth`.\n3D is supported by Bar, Column, Pie and Scatter3D charts.\nMore info available at [Highcharts](https://www.highcharts.com/docs/chart-concepts/3d-charts).",
|
|
291
|
+
"value": {
|
|
292
|
+
"type": [
|
|
293
|
+
"boolean",
|
|
294
|
+
"null",
|
|
295
|
+
"undefined"
|
|
296
|
+
]
|
|
297
|
+
}
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
"name": "emptyText",
|
|
301
|
+
"description": "Specifies the message displayed on a chart without displayable data.",
|
|
302
|
+
"value": {
|
|
303
|
+
"type": [
|
|
304
|
+
"string"
|
|
305
|
+
]
|
|
306
|
+
}
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
"name": "additionalOptions",
|
|
310
|
+
"description": "Represents additional JSON configuration.",
|
|
311
|
+
"value": {
|
|
312
|
+
"type": [
|
|
313
|
+
"Options",
|
|
314
|
+
"undefined"
|
|
315
|
+
]
|
|
316
|
+
}
|
|
317
|
+
},
|
|
318
|
+
{
|
|
319
|
+
"name": "polar",
|
|
320
|
+
"description": "When present, cartesian charts like line, spline, area and column are transformed\ninto the polar coordinate system.",
|
|
321
|
+
"value": {
|
|
322
|
+
"type": [
|
|
323
|
+
"boolean",
|
|
324
|
+
"null",
|
|
325
|
+
"undefined"
|
|
326
|
+
]
|
|
327
|
+
}
|
|
328
|
+
}
|
|
329
|
+
],
|
|
330
|
+
"events": [
|
|
331
|
+
{
|
|
332
|
+
"name": "chart-add-series",
|
|
333
|
+
"description": "Fired when a new series is added."
|
|
334
|
+
},
|
|
335
|
+
{
|
|
336
|
+
"name": "chart-after-export",
|
|
337
|
+
"description": "Fired after a chart is exported."
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
"name": "chart-after-print",
|
|
341
|
+
"description": "Fired after a chart is printed."
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"name": "chart-before-export",
|
|
345
|
+
"description": "Fired before a chart is exported."
|
|
346
|
+
},
|
|
347
|
+
{
|
|
348
|
+
"name": "chart-before-print",
|
|
349
|
+
"description": "Fired before a chart is printed."
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
"name": "chart-click",
|
|
353
|
+
"description": "Fired when clicking on the plot background."
|
|
354
|
+
},
|
|
355
|
+
{
|
|
356
|
+
"name": "chart-drilldown",
|
|
357
|
+
"description": "Fired when drilldown point is clicked."
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
"name": "chart-drillup",
|
|
361
|
+
"description": "Fired when drilling up from a drilldown series."
|
|
362
|
+
},
|
|
363
|
+
{
|
|
364
|
+
"name": "chart-drillupall",
|
|
365
|
+
"description": "Fired after all the series has been drilled up if chart has multiple drilldown series."
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
"name": "chart-load",
|
|
369
|
+
"description": "Fired when the chart is finished loading."
|
|
370
|
+
},
|
|
371
|
+
{
|
|
372
|
+
"name": "chart-redraw",
|
|
373
|
+
"description": "Fired when the chart is redraw. Can be called after a `Chart.configuration.redraw()`\nor after an axis, series or point is modified with the `redraw` option set to `true`."
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
"name": "chart-selection",
|
|
377
|
+
"description": "Fired when an area of the chart has been selected."
|
|
378
|
+
},
|
|
379
|
+
{
|
|
380
|
+
"name": "point-click",
|
|
381
|
+
"description": "Fired when the point is clicked."
|
|
382
|
+
},
|
|
383
|
+
{
|
|
384
|
+
"name": "point-legend-item-click",
|
|
385
|
+
"description": "Fired when the legend item belonging to the point is clicked."
|
|
386
|
+
},
|
|
387
|
+
{
|
|
388
|
+
"name": "point-mouse-out",
|
|
389
|
+
"description": "Fired when the mouse leaves the area close to the point."
|
|
390
|
+
},
|
|
391
|
+
{
|
|
392
|
+
"name": "point-mouse-over",
|
|
393
|
+
"description": "Fired when the mouse enters the area close to the point."
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
"name": "point-remove",
|
|
397
|
+
"description": "Fired when the point is removed from the series."
|
|
398
|
+
},
|
|
399
|
+
{
|
|
400
|
+
"name": "point-select",
|
|
401
|
+
"description": "Fired when the point is selected either programmatically or by clicking on the point."
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
"name": "point-unselect",
|
|
405
|
+
"description": "Fired when the point is unselected either programmatically or by clicking on the point"
|
|
406
|
+
},
|
|
407
|
+
{
|
|
408
|
+
"name": "point-update",
|
|
409
|
+
"description": "Fired when the point is updated programmatically through `.updateConfiguration()` method."
|
|
410
|
+
},
|
|
411
|
+
{
|
|
412
|
+
"name": "series-after-animate",
|
|
413
|
+
"description": "Fired when the series has finished its initial animation."
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
"name": "series-checkbox-click",
|
|
417
|
+
"description": "Fired when the checkbox next to the series' name in the legend is clicked."
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
"name": "series-click",
|
|
421
|
+
"description": "Fired when the series is clicked."
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
"name": "series-hide",
|
|
425
|
+
"description": "Fired when the series is hidden after chart generation time."
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
"name": "series-legend-item-click",
|
|
429
|
+
"description": "Fired when the legend item belonging to the series is clicked."
|
|
430
|
+
},
|
|
431
|
+
{
|
|
432
|
+
"name": "series-mouse-out",
|
|
433
|
+
"description": "Fired when the mouses leave the graph."
|
|
434
|
+
},
|
|
435
|
+
{
|
|
436
|
+
"name": "series-mouse-over",
|
|
437
|
+
"description": "Fired when the mouse enters the graph."
|
|
438
|
+
},
|
|
439
|
+
{
|
|
440
|
+
"name": "series-show",
|
|
441
|
+
"description": "Fired when the series is show after chart generation time."
|
|
442
|
+
},
|
|
443
|
+
{
|
|
444
|
+
"name": "xaxes-extremes-set",
|
|
445
|
+
"description": "Fired when when the minimum and maximum is set for the x axis."
|
|
446
|
+
},
|
|
447
|
+
{
|
|
448
|
+
"name": "yaxes-extremes-set",
|
|
449
|
+
"description": "Fired when when the minimum and maximum is set for the y axis."
|
|
450
|
+
}
|
|
451
|
+
]
|
|
452
|
+
}
|
|
453
|
+
},
|
|
454
|
+
{
|
|
455
|
+
"name": "vaadin-chart-series",
|
|
456
|
+
"description": "`<vaadin-chart-series>` is a custom element for creating series for Vaadin Charts.\n\n### Basic use\n\nTo use `<vaadin-chart-series>`, add it inside a `<vaadin-chart>` element:\n\n```html\n <vaadin-chart>\n <vaadin-chart-series></vaadin-chart-series>\n </vaadin-chart>\n```\n\n`<vaadin-chart-series>` accepts `values` as an array attribute, so you can add it to your element definition:\n\n```html\n <vaadin-chart-series values=\"[10,20,30,40,50]\"></vaadin-chart-series>\n```\n\nwhich will add a new line series, where each value will be a data point.\nLook for the Properties session to see all available attributes.\n\n### Dynamically adding and removing series\n\nYou are also able to add and remove series by using DOM API.\n\nTo create a new series, call `document.createElement('vaadin-chart-series')` and append it to your `<vaadin-chart>`:\n\n```js\n const chart = \\* a <vaadin-chart> reference *\\\n const newSeries = document.createElement('vaadin-chart-series');\n newSeries.values = [10,20,30,40,50];\n chart.appendChild(newSeries);\n```\n\nIn order to remove it, you should use the series to be removed as a reference for the `#removeChild()` call:\n\n```js\n const chart = \\* a <vaadin-chart> reference *\\\n const seriesToBeRemoved = \\* a <vaadin-chart-series> reference to remove*\\\n chart.removeChild(seriesToBeRemoved);\n```",
|
|
457
|
+
"attributes": [
|
|
458
|
+
{
|
|
459
|
+
"name": "value-min",
|
|
460
|
+
"description": "Value-axis minimum-value.\nSets the value to a series bound by 'unit' property.\nOtherwise sets the value to the first series.\nUndefined by default (determined from data).",
|
|
461
|
+
"value": {
|
|
462
|
+
"type": [
|
|
463
|
+
"number",
|
|
464
|
+
"null",
|
|
465
|
+
"undefined"
|
|
466
|
+
]
|
|
467
|
+
}
|
|
468
|
+
},
|
|
469
|
+
{
|
|
470
|
+
"name": "value-max",
|
|
471
|
+
"description": "Value-axis maximum-value.\nSee the 'valueMin'",
|
|
472
|
+
"value": {
|
|
473
|
+
"type": [
|
|
474
|
+
"number",
|
|
475
|
+
"null",
|
|
476
|
+
"undefined"
|
|
477
|
+
]
|
|
478
|
+
}
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"name": "type",
|
|
482
|
+
"description": "A string with the type of the series.\nDefaults to `'line'` in case no type is set for the chart.\nNote that `'bar'`, `'gauge'` and `'solidgauge'` should be set as default series type on `<vaadin-chart>`.",
|
|
483
|
+
"value": {
|
|
484
|
+
"type": [
|
|
485
|
+
"string",
|
|
486
|
+
"null",
|
|
487
|
+
"undefined"
|
|
488
|
+
]
|
|
489
|
+
}
|
|
490
|
+
},
|
|
491
|
+
{
|
|
492
|
+
"name": "title",
|
|
493
|
+
"description": "The name of the series as shown in the legend, tooltip etc.",
|
|
494
|
+
"value": {
|
|
495
|
+
"type": [
|
|
496
|
+
"string"
|
|
497
|
+
]
|
|
498
|
+
}
|
|
499
|
+
},
|
|
500
|
+
{
|
|
501
|
+
"name": "markers",
|
|
502
|
+
"description": "Shows/hides data-point markers for line-like series.\nAcceptable input are:\n - `shown`: markers are always visible\n - `hidden`: markers are always hidden\n - `auto`: markers are visible for widespread data and hidden, when data is dense *(default)*",
|
|
503
|
+
"value": {
|
|
504
|
+
"type": [
|
|
505
|
+
"ChartSeriesMarkers",
|
|
506
|
+
"undefined"
|
|
507
|
+
]
|
|
508
|
+
}
|
|
509
|
+
},
|
|
510
|
+
{
|
|
511
|
+
"name": "unit",
|
|
512
|
+
"description": "Used to connect the series to an axis; if multiple series have the same `unit`, they will share axis.\nDisplayed as a title for the axis.\nIf no unit is defined, then series will be connected to the first axis.",
|
|
513
|
+
"value": {
|
|
514
|
+
"type": [
|
|
515
|
+
"string",
|
|
516
|
+
"null",
|
|
517
|
+
"undefined"
|
|
518
|
+
]
|
|
519
|
+
}
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"name": "stack",
|
|
523
|
+
"description": "Used to group series in a different stacks.\n\"stacking\" property should be specified either for each series or in plotOptions.\nIt is recommended to place series in a single stack, when they belong to the same yAxis.",
|
|
524
|
+
"value": {
|
|
525
|
+
"type": [
|
|
526
|
+
"number",
|
|
527
|
+
"string"
|
|
528
|
+
]
|
|
529
|
+
}
|
|
530
|
+
},
|
|
531
|
+
{
|
|
532
|
+
"name": "neck-position",
|
|
533
|
+
"description": "The height of the neck, the lower part of the funnel.\nA number defines pixel width, a percentage string defines a percentage of the plot area height. Defaults to 30%.\nNote that this property only applies for \"funnel\" charts.",
|
|
534
|
+
"value": {
|
|
535
|
+
"type": [
|
|
536
|
+
"number",
|
|
537
|
+
"string"
|
|
538
|
+
]
|
|
539
|
+
}
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"name": "neck-width",
|
|
543
|
+
"description": "The width of the neck, the lower part of the funnel.\nA number defines pixel width, a percentage string defines a percentage of the plot area width. Defaults to 30%.\nNote that this property only applies for \"funnel\" charts.",
|
|
544
|
+
"value": {
|
|
545
|
+
"type": [
|
|
546
|
+
"number",
|
|
547
|
+
"string"
|
|
548
|
+
]
|
|
549
|
+
}
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
"name": "theme",
|
|
553
|
+
"description": "The theme variants to apply to the component.",
|
|
554
|
+
"value": {
|
|
555
|
+
"type": [
|
|
556
|
+
"string",
|
|
557
|
+
"null",
|
|
558
|
+
"undefined"
|
|
559
|
+
]
|
|
560
|
+
}
|
|
561
|
+
}
|
|
562
|
+
],
|
|
563
|
+
"js": {
|
|
564
|
+
"properties": [
|
|
565
|
+
{
|
|
566
|
+
"name": "values",
|
|
567
|
+
"description": "An array of data used by the series.\nFormat depends on the chart type and can be:\n - An array of numerical values `[y0, y1, y2, y3,...]`\n - An array of arrays with 2 values (`x`, `y`) `[ [x0, y0], [x1, y1], [x2, y2], ... ]`\n - An array of objects, each one describing one point `[ {x: x0, y: y0, name: 'Point0', color: '#FF0000'}, {...}, ...]`\n\n See more in [API Site](https://api.highcharts.com/highcharts/series)\n\nNote that you should always use [Polymer API](https://www.polymer-project.org/2.0/docs/devguide/model-data#array-mutation)\nto mutate the values array in order to make the component aware of the\nchange and be able to synchronize it.",
|
|
568
|
+
"value": {
|
|
569
|
+
"type": [
|
|
570
|
+
"ChartSeriesValues"
|
|
571
|
+
]
|
|
572
|
+
}
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
"name": "valueMin",
|
|
576
|
+
"description": "Value-axis minimum-value.\nSets the value to a series bound by 'unit' property.\nOtherwise sets the value to the first series.\nUndefined by default (determined from data).",
|
|
577
|
+
"value": {
|
|
578
|
+
"type": [
|
|
579
|
+
"number",
|
|
580
|
+
"null",
|
|
581
|
+
"undefined"
|
|
582
|
+
]
|
|
583
|
+
}
|
|
584
|
+
},
|
|
585
|
+
{
|
|
586
|
+
"name": "valueMax",
|
|
587
|
+
"description": "Value-axis maximum-value.\nSee the 'valueMin'",
|
|
588
|
+
"value": {
|
|
589
|
+
"type": [
|
|
590
|
+
"number",
|
|
591
|
+
"null",
|
|
592
|
+
"undefined"
|
|
593
|
+
]
|
|
594
|
+
}
|
|
595
|
+
},
|
|
596
|
+
{
|
|
597
|
+
"name": "type",
|
|
598
|
+
"description": "A string with the type of the series.\nDefaults to `'line'` in case no type is set for the chart.\nNote that `'bar'`, `'gauge'` and `'solidgauge'` should be set as default series type on `<vaadin-chart>`.",
|
|
599
|
+
"value": {
|
|
600
|
+
"type": [
|
|
601
|
+
"string",
|
|
602
|
+
"null",
|
|
603
|
+
"undefined"
|
|
604
|
+
]
|
|
605
|
+
}
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
"name": "title",
|
|
609
|
+
"description": "The name of the series as shown in the legend, tooltip etc.",
|
|
610
|
+
"value": {
|
|
611
|
+
"type": [
|
|
612
|
+
"string"
|
|
613
|
+
]
|
|
614
|
+
}
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
"name": "markers",
|
|
618
|
+
"description": "Shows/hides data-point markers for line-like series.\nAcceptable input are:\n - `shown`: markers are always visible\n - `hidden`: markers are always hidden\n - `auto`: markers are visible for widespread data and hidden, when data is dense *(default)*",
|
|
619
|
+
"value": {
|
|
620
|
+
"type": [
|
|
621
|
+
"ChartSeriesMarkers",
|
|
622
|
+
"undefined"
|
|
623
|
+
]
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"name": "unit",
|
|
628
|
+
"description": "Used to connect the series to an axis; if multiple series have the same `unit`, they will share axis.\nDisplayed as a title for the axis.\nIf no unit is defined, then series will be connected to the first axis.",
|
|
629
|
+
"value": {
|
|
630
|
+
"type": [
|
|
631
|
+
"string",
|
|
632
|
+
"null",
|
|
633
|
+
"undefined"
|
|
634
|
+
]
|
|
635
|
+
}
|
|
636
|
+
},
|
|
637
|
+
{
|
|
638
|
+
"name": "stack",
|
|
639
|
+
"description": "Used to group series in a different stacks.\n\"stacking\" property should be specified either for each series or in plotOptions.\nIt is recommended to place series in a single stack, when they belong to the same yAxis.",
|
|
640
|
+
"value": {
|
|
641
|
+
"type": [
|
|
642
|
+
"number",
|
|
643
|
+
"string"
|
|
644
|
+
]
|
|
645
|
+
}
|
|
646
|
+
},
|
|
647
|
+
{
|
|
648
|
+
"name": "neckPosition",
|
|
649
|
+
"description": "The height of the neck, the lower part of the funnel.\nA number defines pixel width, a percentage string defines a percentage of the plot area height. Defaults to 30%.\nNote that this property only applies for \"funnel\" charts.",
|
|
650
|
+
"value": {
|
|
651
|
+
"type": [
|
|
652
|
+
"number",
|
|
653
|
+
"string"
|
|
654
|
+
]
|
|
655
|
+
}
|
|
656
|
+
},
|
|
657
|
+
{
|
|
658
|
+
"name": "neckWidth",
|
|
659
|
+
"description": "The width of the neck, the lower part of the funnel.\nA number defines pixel width, a percentage string defines a percentage of the plot area width. Defaults to 30%.\nNote that this property only applies for \"funnel\" charts.",
|
|
660
|
+
"value": {
|
|
661
|
+
"type": [
|
|
662
|
+
"number",
|
|
663
|
+
"string"
|
|
664
|
+
]
|
|
665
|
+
}
|
|
666
|
+
},
|
|
667
|
+
{
|
|
668
|
+
"name": "additionalOptions",
|
|
669
|
+
"description": "Represents additional JSON configuration.",
|
|
670
|
+
"value": {
|
|
671
|
+
"type": [
|
|
672
|
+
"SeriesOptionsType",
|
|
673
|
+
"undefined"
|
|
674
|
+
]
|
|
675
|
+
}
|
|
676
|
+
}
|
|
677
|
+
],
|
|
678
|
+
"events": []
|
|
679
|
+
}
|
|
680
|
+
}
|
|
681
|
+
]
|
|
682
|
+
}
|
|
683
|
+
}
|
|
684
|
+
}
|