@bryntum/chart-vue-3-thin 7.2.3 → 7.3.0

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.
@@ -1,19 +1,17 @@
1
- import type { AlignSpec, Base, Color, DomConfig, KeyMapConfig, MaskConfig, MenuItemEntry, Model, ModelConfig, Rectangle, Scroller, ScrollerConfig, TabConfig, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
2
- import type { ChartListeners, ChartTooltipConfig, ChartContainerItemConfig, ChartContainerLayoutConfig, DataSeries, DataSeriesRole, Font } from '@bryntum/chart-thin';
1
+ import type { AlignSpec, Base, Color, DomConfig, KeyMapConfig, MaskConfig, MenuItemEntry, Model, ModelConfig, ReactJSX, Rectangle, Scroller, ScrollerConfig, TabConfig, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
2
+ import type { ChartListeners, ChartTooltipConfig, ChartContainerItemConfig, ChartContainerLayoutConfig, DataSeries, Font } from '@bryntum/chart-thin';
3
3
 
4
4
  export declare type BryntumChartProps = {
5
5
  // Configs
6
6
  /**
7
7
  * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
8
8
  * content will be placed inside this element.
9
- * ...
10
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-adopt)
9
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-adopt)
11
10
  */
12
11
  adopt ? : HTMLElement|string
13
12
  /**
14
13
  * *Only valid if this Widget is [floating](https://bryntum.com/products/chart/docs/api/Core/widget/Widget#config-floating).*
15
- * ...
16
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-align)
14
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-align)
17
15
  */
18
16
  align ? : AlignSpec|string
19
17
  /**
@@ -43,15 +41,13 @@ export declare type BryntumChartProps = {
43
41
  /**
44
42
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
45
43
  * into an element which will be linked using the `aria-describedby` attribute.
46
- * ...
47
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-ariaDescription)
44
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-ariaDescription)
48
45
  */
49
46
  ariaDescription ? : string
50
47
  /**
51
48
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
52
49
  * the `aria-label` attribute.
53
- * ...
54
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-ariaLabel)
50
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-ariaLabel)
55
51
  */
56
52
  ariaLabel ? : string
57
53
  /**
@@ -86,8 +82,7 @@ export declare type BryntumChartProps = {
86
82
  /**
87
83
  * An object where property names with a truthy value indicate which events should bubble up the ownership
88
84
  * hierarchy when triggered.
89
- * ...
90
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-bubbleEvents)
85
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-bubbleEvents)
91
86
  */
92
87
  bubbleEvents ? : object
93
88
  /**
@@ -96,15 +91,13 @@ export declare type BryntumChartProps = {
96
91
  bubbleScaleFactor ? : number
97
92
  /**
98
93
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
99
- * ...
100
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-callOnFunctions)
94
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-callOnFunctions)
101
95
  */
102
96
  callOnFunctions ? : Boolean
103
97
  /**
104
98
  * By default, if an event handler throws an exception, the error propagates up the stack and the
105
99
  * application state is undefined. Code which follows the event handler will *not* be executed.
106
- * ...
107
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-catchEventHandlerExceptions)
100
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-catchEventHandlerExceptions)
108
101
  */
109
102
  catchEventHandlerExceptions ? : Boolean
110
103
  /**
@@ -130,15 +123,13 @@ export declare type BryntumChartProps = {
130
123
  * Custom CSS classes to add to element.
131
124
  * May be specified as a space separated string, or as an object in which property names
132
125
  * with truthy values are used as the class names:
133
- * ...
134
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-cls)
126
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-cls)
135
127
  */
136
128
  cls ? : string|object
137
129
  /**
138
130
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
139
131
  * `style` block.
140
- * ...
141
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-color)
132
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-color)
142
133
  */
143
134
  color ? : Color
144
135
  /**
@@ -162,8 +153,7 @@ export declare type BryntumChartProps = {
162
153
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/chart/docs/api/Core/widget/Widget#property-contentElement).
163
154
  * May be specified as a space separated string, or as an object in which property names
164
155
  * with truthy values are used as the class names:
165
- * ...
166
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-contentElementCls)
156
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-contentElementCls)
167
157
  */
168
158
  contentElementCls ? : string|object
169
159
  /**
@@ -191,8 +181,7 @@ export declare type BryntumChartProps = {
191
181
  /**
192
182
  * A [query](https://bryntum.com/products/chart/docs/api/Core/widget/Container#function-query) selector function which can identify the descendant widget to which
193
183
  * focus should be directed by default.
194
- * ...
195
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-defaultFocus)
184
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-defaultFocus)
196
185
  * @param {Core.widget.Widget} widget Widget passed to method
197
186
  * @returns {boolean} truthy value if widget is the default one
198
187
  */
@@ -202,16 +191,15 @@ export declare type BryntumChartProps = {
202
191
  */
203
192
  defaults ? : ChartContainerItemConfig
204
193
  /**
205
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
206
- * ...
207
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-detectCSSCompatibilityIssues)
194
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
195
+ * checks:
196
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-detectCSSCompatibilityIssues)
208
197
  */
209
198
  detectCSSCompatibilityIssues ? : Boolean
210
199
  /**
211
200
  * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/chart/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
212
201
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
213
- * ...
214
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-disabled)
202
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-disabled)
215
203
  */
216
204
  disabled ? : Boolean|'inert'
217
205
  /**
@@ -219,25 +207,21 @@ export declare type BryntumChartProps = {
219
207
  * [strips collection](https://bryntum.com/products/chart/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
220
208
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
221
209
  * body. Such widgets are called "edge strips".
222
- * ...
223
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-dock)
210
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-dock)
224
211
  */
225
212
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
226
213
  /**
227
214
  * *Only valid if this Widget is [floating](https://bryntum.com/products/chart/docs/api/Core/widget/Widget#config-floating).*
228
215
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
229
216
  * property which controls when a drag should start.
230
- * ...
231
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-draggable)
217
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-draggable)
218
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
232
219
  */
233
- draggable ? : Boolean|{
234
- handleSelector?: string
235
- }
220
+ draggable ? : Boolean|object
236
221
  /**
237
222
  * An object specifying attributes to assign to the root element of this widget.
238
223
  * Set `null` value to attribute to remove it.
239
- * ...
240
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-elementAttributes)
224
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-elementAttributes)
241
225
  */
242
226
  elementAttributes ? : Record<string, string|null>
243
227
  extraData ? : any
@@ -279,25 +263,21 @@ export declare type BryntumChartProps = {
279
263
  hidden ? : Boolean
280
264
  /**
281
265
  * *Only valid if this Widget is [floating](https://bryntum.com/products/chart/docs/api/Core/widget/Widget#config-floating).*
282
- * ...
283
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-hideAnimation)
266
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-hideAnimation)
284
267
  */
285
268
  hideAnimation ? : Boolean|object
286
269
  /**
287
270
  * Specify `true` to make this container hide when it has no visible children (Either empty
288
271
  * or all children hidden).
289
- * ...
290
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-hideWhenEmpty)
272
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-hideWhenEmpty)
291
273
  */
292
274
  hideWhenEmpty ? : Boolean
293
275
  /**
294
276
  * The HTML to display initially or a function returning the markup (called at widget construction time).
295
- * ...
296
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-html)
277
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-html)
297
278
  * @param {Core.widget.Widget} widget The calling Widget
298
- * @returns {string}
299
279
  */
300
- html ? : string|((widget: Widget) => string)|DomConfig|DomConfig[]|VueConfig
280
+ html ? : string|((widget: Widget) => void)|DomConfig|DomConfig[]|VueConfig|ReactJSX
301
281
  /**
302
282
  * The CSS class(es) to add when HTML content is being applied to this widget.
303
283
  */
@@ -308,16 +288,14 @@ export declare type BryntumChartProps = {
308
288
  id ? : string
309
289
  /**
310
290
  * Determines if the widgets read-only state should be controlled by its parent.
311
- * ...
312
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-ignoreParentReadOnly)
291
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-ignoreParentReadOnly)
313
292
  */
314
293
  ignoreParentReadOnly ? : Boolean
315
294
  /**
316
295
  * Convenience setting to align input fields of child widgets. By default, the Field input element is
317
296
  * placed immediately following the `label`. If you prefer to have all input fields aligned to the
318
297
  * right, set this config to `'end'`.
319
- * ...
320
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-inputFieldAlign)
298
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-inputFieldAlign)
321
299
  */
322
300
  inputFieldAlign ? : 'start'|'end'
323
301
  /**
@@ -339,16 +317,14 @@ export declare type BryntumChartProps = {
339
317
  /**
340
318
  * An object containing typed child widget config objects or Widgets. May also be specified
341
319
  * as an array.
342
- * ...
343
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-items)
320
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-items)
344
321
  */
345
322
  items ? : Record<string, ChartContainerItemConfig|MenuItemEntry>|(ChartContainerItemConfig|MenuItemEntry|Widget)[]
346
323
  /**
347
324
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
348
325
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
349
326
  * are the name of the instance method to call when the keystroke is received.
350
- * ...
351
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-keyMap)
327
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-keyMap)
352
328
  */
353
329
  keyMap ? : Record<string, KeyMapConfig>
354
330
  /**
@@ -357,8 +333,7 @@ export declare type BryntumChartProps = {
357
333
  label ? : string
358
334
  /**
359
335
  * Convenience setting to use same label placement on all child widgets.
360
- * ...
361
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-labelPosition)
336
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-labelPosition)
362
337
  */
363
338
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
364
339
  /**
@@ -366,23 +341,25 @@ export declare type BryntumChartProps = {
366
341
  * For pie and donut chart, it defines the data values to use as slice labels.
367
342
  */
368
343
  labels ? : DataSeries
344
+ /**
345
+ * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
346
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-labelWidth)
347
+ */
348
+ labelWidth ? : number|null
369
349
  /**
370
350
  * The short name of a helper class which manages rendering and styling of child items.
371
- * ...
372
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-layout)
351
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-layout)
373
352
  */
374
353
  layout ? : string|ChartContainerLayoutConfig
375
354
  /**
376
355
  * The CSS style properties to apply to the [contentElement](https://bryntum.com/products/chart/docs/api/Core/widget/Widget#property-contentElement).
377
- * ...
378
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-layoutStyle)
356
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-layoutStyle)
379
357
  */
380
358
  layoutStyle ? : object
381
359
  /**
382
360
  * An array of [child item](https://bryntum.com/products/chart/docs/api/Core/widget/Container#config-items) *config objects* which is to be converted into
383
361
  * instances only when this Container is rendered, rather than eagerly at construct time.
384
- * ...
385
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-lazyItems)
362
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-lazyItems)
386
363
  */
387
364
  lazyItems ? : Record<string, ChartContainerItemConfig>|ChartContainerItemConfig[]|Widget[]
388
365
  /**
@@ -397,16 +374,14 @@ export declare type BryntumChartProps = {
397
374
  legendScale ? : number
398
375
  /**
399
376
  * The listener set for this object.
400
- * ...
401
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-listeners)
377
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-listeners)
402
378
  */
403
379
  listeners ? : ChartListeners
404
380
  /**
405
381
  * A class translations of which are used for translating this entity.
406
382
  * This is often used when translations of an item are defined on its container class.
407
383
  * For example:
408
- * ...
409
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-localeClass)
384
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-localeClass)
410
385
  */
411
386
  localeClass ? : typeof Base
412
387
  /**
@@ -418,8 +393,7 @@ export declare type BryntumChartProps = {
418
393
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
419
394
  * you could use 'localeKey' meta configuration.
420
395
  * Example:
421
- * ...
422
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-localizableProperties)
396
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-localizableProperties)
423
397
  */
424
398
  localizableProperties ? : string[]
425
399
  /**
@@ -449,8 +423,7 @@ export declare type BryntumChartProps = {
449
423
  maxHeight ? : string|number
450
424
  /**
451
425
  * *Only valid if this Widget is [floating](https://bryntum.com/products/chart/docs/api/Core/widget/Widget#config-floating).*
452
- * ...
453
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-maximizeOnMobile)
426
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-maximizeOnMobile)
454
427
  */
455
428
  maximizeOnMobile ? : number|string
456
429
  /**
@@ -484,18 +457,15 @@ export declare type BryntumChartProps = {
484
457
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
485
458
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
486
459
  * layout.
487
- * ...
488
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-monitorResize)
460
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-monitorResize)
461
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
489
462
  */
490
- monitorResize ? : Boolean|{
491
- immediate?: Boolean
492
- }
463
+ monitorResize ? : Boolean|object
493
464
  /**
494
465
  * An object containing default config objects which may be referenced by name in the [items](https://bryntum.com/products/chart/docs/api/Core/widget/Container#config-items)
495
466
  * config. For example, a specialized [Menu](https://bryntum.com/products/chart/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
496
467
  * value defined like this:
497
- * ...
498
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-namedItems)
468
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-namedItems)
499
469
  */
500
470
  namedItems ? : Record<string, ChartContainerItemConfig>
501
471
  /**
@@ -506,8 +476,7 @@ export declare type BryntumChartProps = {
506
476
  * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/chart/docs/api/Core/widget/Widget#property-contentElement), but must
507
477
  * not participate in the standard layout of that widget, and must be positioned relatively to that
508
478
  * widget's [contentElement](https://bryntum.com/products/chart/docs/api/Core/widget/Widget#property-contentElement).
509
- * ...
510
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-positioned)
479
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-positioned)
511
480
  */
512
481
  positioned ? : Boolean
513
482
  /**
@@ -518,50 +487,45 @@ export declare type BryntumChartProps = {
518
487
  /**
519
488
  * Whether this widget is read-only. This is only valid if the widget is an input
520
489
  * field, <strong>or contains input fields at any depth</strong>.
521
- * ...
522
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-readOnly)
490
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-readOnly)
523
491
  */
524
492
  readOnly ? : Boolean
525
493
  /**
526
494
  * [Record](https://bryntum.com/products/chart/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
527
- * ...
528
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-record)
495
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-record)
529
496
  */
530
497
  record ? : Model
531
498
  relayStoreEvents ? : Boolean
532
499
  /**
533
500
  * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
534
501
  * `type`.
535
- * ...
536
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-rendition)
502
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-rendition)
537
503
  */
538
504
  rendition ? : string|Record<string, string>|null
539
505
  /**
540
506
  * Configure as `true` to have the component display a translucent ripple when its
541
507
  * [focusElement](https://bryntum.com/products/chart/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
542
508
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
543
- * ...
544
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-ripple)
509
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-ripple)
510
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
511
+ * @property {string} [color] A CSS color name or specification.
512
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
513
+ * @property {string} [clip] A string which describes how to clip the ripple if it is not to be clipped to the default element. Either the property of the widget to use as the clipping element, or a selector to allow clipping to the closest matching ancestor to the target element.
545
514
  */
546
- ripple ? : Boolean|{
547
- delegate?: string
548
- color?: string
549
- radius?: number
550
- clip?: string
551
- }
515
+ ripple ? : Boolean|object
552
516
  /**
553
- * (Optional) Required when using certain chart types, for example `scatter`, where series can be arbitrarily
554
- * assigned to different axes. The `role` determines how this series is used in the chart.
517
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
518
+ * accidentally applying a role which may interfere with screen readers.
519
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-role)
555
520
  */
556
- role ? : DataSeriesRole
521
+ role ? : string
557
522
  /**
558
523
  * If you are rendering this widget to a shadow root inside a web component, set this config to the shadowRoot. If not inside a web component, set it to `document.body`
559
524
  */
560
525
  rootElement ? : ShadowRoot|HTMLElement
561
526
  /**
562
527
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
563
- * ...
564
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-rtl)
528
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-rtl)
565
529
  */
566
530
  rtl ? : Boolean
567
531
  /**
@@ -569,8 +533,7 @@ export declare type BryntumChartProps = {
569
533
  * in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
570
534
  * applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
571
535
  * CSS overflow properties thus:
572
- * ...
573
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-scrollable)
536
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-scrollable)
574
537
  */
575
538
  scrollable ? : Boolean|ScrollerConfig|Scroller
576
539
  /**
@@ -596,8 +559,7 @@ export declare type BryntumChartProps = {
596
559
  seriesLineThickness ? : number
597
560
  /**
598
561
  * *Only valid if this Widget is [floating](https://bryntum.com/products/chart/docs/api/Core/widget/Widget#config-floating).*
599
- * ...
600
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-showAnimation)
562
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-showAnimation)
601
563
  */
602
564
  showAnimation ? : Boolean|object
603
565
  /**
@@ -647,8 +609,7 @@ export declare type BryntumChartProps = {
647
609
  subtitle ? : string
648
610
  /**
649
611
  * The font to use for the chart subtitle.
650
- * ...
651
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-subtitleFont)
612
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-subtitleFont)
652
613
  */
653
614
  subtitleFont ? : Font
654
615
  /**
@@ -659,15 +620,13 @@ export declare type BryntumChartProps = {
659
620
  * A configuration for the [tab](https://bryntum.com/products/chart/docs/api/Core/widget/Tab) created for this widget when it is placed in a
660
621
  * [TabPanel](https://bryntum.com/products/chart/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
661
622
  * this widget:
662
- * ...
663
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-tab)
623
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-tab)
664
624
  */
665
625
  tab ? : Boolean|TabConfig
666
626
  /**
667
627
  * When this container is used as a tab in a TabPanel, these items are added to the
668
628
  * [TabBar](https://bryntum.com/products/chart/docs/api/Core/widget/TabBar) when this container is the active tab.
669
- * ...
670
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-tabBarItems)
629
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-tabBarItems)
671
630
  */
672
631
  tabBarItems ? : ToolbarItems[]|Widget[]
673
632
  /**
@@ -676,21 +635,18 @@ export declare type BryntumChartProps = {
676
635
  tag ? : string
677
636
  /**
678
637
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
679
- * ...
680
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-textAlign)
638
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-textAlign)
681
639
  */
682
640
  textAlign ? : 'left'|'center'|'right'|'start'|'end'
683
641
  /**
684
642
  * Specify `true` for a container used to show text markup. It will apply the CSS class `b-text-content`
685
643
  * which specifies a default max-width that makes long text more readable.
686
- * ...
687
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-textContent)
644
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-textContent)
688
645
  */
689
646
  textContent ? : Boolean
690
647
  /**
691
648
  * The font to use for tick labels on the chart axes.
692
- * ...
693
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-tickFont)
649
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-tickFont)
694
650
  */
695
651
  tickFont ? : Font
696
652
  /**
@@ -703,8 +659,7 @@ export declare type BryntumChartProps = {
703
659
  title ? : string
704
660
  /**
705
661
  * The font to use for the chart title.
706
- * ...
707
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-titleFont)
662
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-titleFont)
708
663
  */
709
664
  titleFont ? : Font
710
665
  /**
@@ -713,8 +668,7 @@ export declare type BryntumChartProps = {
713
668
  titlePadding ? : object
714
669
  /**
715
670
  * Tooltip for the widget, either as a string or as a Tooltip config object.
716
- * ...
717
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-tooltip)
671
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-tooltip)
718
672
  */
719
673
  tooltip ? : string|TooltipConfig|null
720
674
  type ? : 'chart'
@@ -722,8 +676,7 @@ export declare type BryntumChartProps = {
722
676
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
723
677
  * as a space separated string, an array of strings, or as an object in which property names with truthy
724
678
  * values are used as the class names.
725
- * ...
726
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-ui)
679
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-ui)
727
680
  */
728
681
  ui ? : string|object
729
682
  /**
@@ -739,14 +692,12 @@ export declare type BryntumChartProps = {
739
692
  width ? : string|number
740
693
  /**
741
694
  * The x position for the widget.
742
- * ...
743
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-x)
695
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-x)
744
696
  */
745
697
  x ? : number
746
698
  /**
747
699
  * The y position for the widget.
748
- * ...
749
- * [View online docs...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-y)
700
+ * [More...](https://bryntum.com/products/chart/docs/api/Chart/widget/Chart#config-y)
750
701
  */
751
702
  y ? : number
752
703
 
@@ -0,0 +1,60 @@
1
+ <template>
2
+ <div ref="refElement" />
3
+ </template>
4
+
5
+ <script setup lang="ts">
6
+ import { onBeforeUnmount, onMounted, ref } from 'vue';
7
+ import { Combo, DomHelper, BrowserHelper } from '@bryntum/core-thin';
8
+
9
+ const refElement = ref<HTMLElement | null>(null);
10
+ let combo: Combo | null = null;
11
+
12
+ onMounted(() => {
13
+ combo = new Combo({
14
+ appendTo : refElement.value as HTMLElement,
15
+ store : {
16
+ data : [
17
+ { id : 'svalbard-light', text : 'Svalbard Light' },
18
+ { id : 'svalbard-dark', text : 'Svalbard Dark' },
19
+ { id : 'visby-light', text : 'Visby Light' },
20
+ { id : 'visby-dark', text : 'Visby Dark' },
21
+ { id : 'stockholm-light', text : 'Stockholm Light' },
22
+ { id : 'stockholm-dark', text : 'Stockholm Dark' },
23
+ { id : 'material3-light', text : 'Material3 Light' },
24
+ { id : 'material3-dark', text : 'Material3 Dark' },
25
+ { id : 'fluent2-light', text : 'Fluent2 Light' },
26
+ { id : 'fluent2-dark', text : 'Fluent2 Dark' },
27
+ { id : 'high-contrast-light', text : 'High Contrast Light' },
28
+ { id : 'high-contrast-dark', text : 'High Contrast Dark' }
29
+ ]
30
+ },
31
+ label : 'Theme',
32
+ width : '16em',
33
+ value : 'svalbard-light',
34
+ editable : false,
35
+ labelPosition : 'before',
36
+ ref : 'themeCombo',
37
+ listeners : {
38
+ change({ value }: { value: string }) {
39
+ DomHelper.setTheme(value).then((context: any) => {
40
+ if (context) {
41
+ const { theme, prev } = context;
42
+ document.body.classList.remove(`b-theme-${prev}`);
43
+ document.body.classList.add(`b-theme-${theme}`);
44
+ }
45
+ });
46
+ }
47
+ }
48
+ });
49
+
50
+ // Apply from search param
51
+ const theme = BrowserHelper.searchParam('theme');
52
+ if (theme) {
53
+ combo.value = theme;
54
+ }
55
+ });
56
+
57
+ onBeforeUnmount(() => {
58
+ combo?.destroy();
59
+ });
60
+ </script>