@pie-element/graphing 10.1.2-next.5 → 10.1.3

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.
Files changed (86) hide show
  1. package/CHANGELOG.json +652 -0
  2. package/CHANGELOG.md +2055 -0
  3. package/LICENSE.md +5 -0
  4. package/README.md +1 -0
  5. package/configure/CHANGELOG.json +382 -0
  6. package/configure/CHANGELOG.md +1846 -0
  7. package/configure/lib/configure.js +328 -0
  8. package/configure/lib/configure.js.map +1 -0
  9. package/configure/lib/correct-response.js +484 -0
  10. package/configure/lib/correct-response.js.map +1 -0
  11. package/configure/lib/defaults.js +448 -0
  12. package/configure/lib/defaults.js.map +1 -0
  13. package/configure/lib/graphing-config.js +388 -0
  14. package/configure/lib/graphing-config.js.map +1 -0
  15. package/configure/lib/index.js +173 -0
  16. package/configure/lib/index.js.map +1 -0
  17. package/configure/lib/utils.js +122 -0
  18. package/configure/lib/utils.js.map +1 -0
  19. package/configure/package.json +30 -0
  20. package/controller/CHANGELOG.json +412 -0
  21. package/controller/CHANGELOG.md +1267 -0
  22. package/controller/lib/defaults.js +64 -0
  23. package/controller/lib/defaults.js.map +1 -0
  24. package/controller/lib/index.js +459 -0
  25. package/controller/lib/index.js.map +1 -0
  26. package/controller/lib/utils.js +451 -0
  27. package/controller/lib/utils.js.map +1 -0
  28. package/controller/package.json +24 -0
  29. package/docs/config-schema.json +3164 -0
  30. package/docs/config-schema.json.md +2293 -0
  31. package/docs/demo/config.js +8 -0
  32. package/docs/demo/generate.js +200 -0
  33. package/docs/demo/index.html +1 -0
  34. package/docs/demo/session.js +20 -0
  35. package/docs/pie-schema.json +3495 -0
  36. package/docs/pie-schema.json.md +1345 -0
  37. package/lib/index.js +69 -0
  38. package/lib/index.js.map +1 -0
  39. package/lib/main.js +161 -0
  40. package/lib/main.js.map +1 -0
  41. package/lib/utils.js +24 -0
  42. package/lib/utils.js.map +1 -0
  43. package/package.json +21 -87
  44. package/configure.js +0 -2
  45. package/controller.js +0 -1
  46. package/dist/author/configure.d.ts +0 -26
  47. package/dist/author/configure.js +0 -208
  48. package/dist/author/correct-response.d.ts +0 -54
  49. package/dist/author/correct-response.js +0 -303
  50. package/dist/author/defaults.d.ts +0 -294
  51. package/dist/author/defaults.js +0 -415
  52. package/dist/author/graphing-config.d.ts +0 -34
  53. package/dist/author/graphing-config.js +0 -244
  54. package/dist/author/index.d.ts +0 -59
  55. package/dist/author/index.js +0 -96
  56. package/dist/author/utils.d.ts +0 -43
  57. package/dist/author/utils.js +0 -260
  58. package/dist/browser/author/index.js +0 -4480
  59. package/dist/browser/author/index.js.map +0 -1
  60. package/dist/browser/container-CTkqz7Oi.js +0 -63877
  61. package/dist/browser/container-CTkqz7Oi.js.map +0 -1
  62. package/dist/browser/controller/index.js +0 -353
  63. package/dist/browser/controller/index.js.map +0 -1
  64. package/dist/browser/delivery/index.js +0 -683
  65. package/dist/browser/delivery/index.js.map +0 -1
  66. package/dist/browser/dist-B7TYAggd.js +0 -551
  67. package/dist/browser/dist-B7TYAggd.js.map +0 -1
  68. package/dist/browser/graphing.css +0 -2
  69. package/dist/controller/defaults.d.ts +0 -59
  70. package/dist/controller/defaults.js +0 -61
  71. package/dist/controller/index.d.ts +0 -34
  72. package/dist/controller/index.js +0 -179
  73. package/dist/controller/utils.d.ts +0 -37
  74. package/dist/controller/utils.js +0 -111
  75. package/dist/delivery/index.d.ts +0 -21
  76. package/dist/delivery/index.js +0 -43
  77. package/dist/delivery/main.d.ts +0 -23
  78. package/dist/delivery/main.js +0 -107
  79. package/dist/delivery/utils.d.ts +0 -22
  80. package/dist/graphing.css +0 -2
  81. package/dist/index.d.ts +0 -1
  82. package/dist/index.iife.d.ts +0 -8
  83. package/dist/index.iife.js +0 -414
  84. package/dist/index.js +0 -2
  85. package/dist/runtime-support.d.ts +0 -12
  86. package/dist/runtime-support.js +0 -12
@@ -0,0 +1,2293 @@
1
+ Config Object for @pie-elements/graphing
2
+
3
+ The schema defines the following properties:
4
+
5
+ # `baseInputConfiguration` (object)
6
+
7
+ Properties of the `baseInputConfiguration` object:
8
+
9
+ ## `math` (object)
10
+
11
+ Properties of the `math` object:
12
+
13
+ ### `disabled` (boolean)
14
+
15
+ Indicates if the plugin is disabled or not
16
+
17
+ ## `audio` (object)
18
+
19
+ Properties of the `audio` object:
20
+
21
+ ### `disabled` (boolean)
22
+
23
+ Indicates if the plugin is disabled or not
24
+
25
+ ## `video` (object)
26
+
27
+ Properties of the `video` object:
28
+
29
+ ### `disabled` (boolean)
30
+
31
+ Indicates if the plugin is disabled or not
32
+
33
+ ## `image` (object)
34
+
35
+ Properties of the `image` object:
36
+
37
+ ### `disabled` (boolean)
38
+
39
+ Indicates if the plugin is disabled or not
40
+
41
+ ## `customPlugins` (array)
42
+
43
+ An array of objects that determine custom plugins.
44
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
45
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
46
+
47
+ The object is an array with all elements of the type `object`.
48
+
49
+ The array object has the following properties:
50
+
51
+ ### `event` (string, required)
52
+
53
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
54
+ PIE will emit the event prefixed with "PIE-".
55
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
56
+
57
+ ### `iconAlt` (string, required)
58
+
59
+ The alt for the custom button icon
60
+
61
+ ### `iconType` (string, required)
62
+
63
+ The icon type.
64
+ Currently, only "SVG" is supported.
65
+
66
+ ### `icon` (string, required)
67
+
68
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
69
+
70
+ ## `blockquote` (object)
71
+
72
+ Properties of the `blockquote` object:
73
+
74
+ ### `disabled` (boolean)
75
+
76
+ Indicates if the plugin is disabled or not
77
+
78
+ ## `h3` (object)
79
+
80
+ Properties of the `h3` object:
81
+
82
+ ### `disabled` (boolean)
83
+
84
+ Indicates if the plugin is disabled or not
85
+
86
+ ## `characters` (object)
87
+
88
+ Properties of the `characters` object:
89
+
90
+ ### `disabled` (boolean)
91
+
92
+ Indicates if the plugin is disabled or not
93
+
94
+ ## `bold` (object)
95
+
96
+ Properties of the `bold` object:
97
+
98
+ ### `disabled` (boolean)
99
+
100
+ Indicates if the plugin is disabled or not
101
+
102
+ ## `html` (object)
103
+
104
+ Properties of the `html` object:
105
+
106
+ ### `disabled` (boolean)
107
+
108
+ Indicates if the plugin is disabled or not
109
+
110
+ ## `italic` (object)
111
+
112
+ Properties of the `italic` object:
113
+
114
+ ### `disabled` (boolean)
115
+
116
+ Indicates if the plugin is disabled or not
117
+
118
+ ## `ol_list` (object)
119
+
120
+ Properties of the `ol_list` object:
121
+
122
+ ### `disabled` (boolean)
123
+
124
+ Indicates if the plugin is disabled or not
125
+
126
+ ## `redo` (object)
127
+
128
+ Properties of the `redo` object:
129
+
130
+ ### `disabled` (boolean)
131
+
132
+ Indicates if the plugin is disabled or not
133
+
134
+ ## `strikethrough` (object)
135
+
136
+ Properties of the `strikethrough` object:
137
+
138
+ ### `disabled` (boolean)
139
+
140
+ Indicates if the plugin is disabled or not
141
+
142
+ ## `sub` (object)
143
+
144
+ Properties of the `sub` object:
145
+
146
+ ### `disabled` (boolean)
147
+
148
+ Indicates if the plugin is disabled or not
149
+
150
+ ## `sup` (object)
151
+
152
+ Properties of the `sup` object:
153
+
154
+ ### `disabled` (boolean)
155
+
156
+ Indicates if the plugin is disabled or not
157
+
158
+ ## `table` (object)
159
+
160
+ Properties of the `table` object:
161
+
162
+ ### `disabled` (boolean)
163
+
164
+ Indicates if the plugin is disabled or not
165
+
166
+ ## `ul_list` (object)
167
+
168
+ Properties of the `ul_list` object:
169
+
170
+ ### `disabled` (boolean)
171
+
172
+ Indicates if the plugin is disabled or not
173
+
174
+ ## `underline` (object)
175
+
176
+ Properties of the `underline` object:
177
+
178
+ ### `disabled` (boolean)
179
+
180
+ Indicates if the plugin is disabled or not
181
+
182
+ ## `undo` (object)
183
+
184
+ Properties of the `undo` object:
185
+
186
+ ### `disabled` (boolean)
187
+
188
+ Indicates if the plugin is disabled or not
189
+
190
+ # `authoring` (object)
191
+
192
+ Properties of the `authoring` object:
193
+
194
+ ## `settings` (boolean)
195
+
196
+ Indicates if the item is displayed in the Settings Panel
197
+
198
+ ## `label` (string)
199
+
200
+ Indicates the label for the item that is displayed in the Settings Panel
201
+
202
+ ## `enabled` (boolean)
203
+
204
+ Indicates if the Grid Setup Panel is displayed
205
+
206
+ ## `includeAxesEnabled` (boolean)
207
+
208
+ Indicates if the "includeAxes" toggle is displayed in the Grid Setup Panel
209
+
210
+ ## `standardGridEnabled` (boolean)
211
+
212
+ Indicates if the "standardGrid" toggle is displayed in the Grid Setup Panel
213
+
214
+ ## `min` (object)
215
+
216
+ Properties of the `min` object:
217
+
218
+ ### `label` (string)
219
+
220
+ Indicates the label for the item that is displayed in the Grid Setup Panel
221
+
222
+ ### `enabled` (boolean)
223
+
224
+ Indicates if the item is displayed in the Grid Setup Panel
225
+
226
+ ## `max` (object)
227
+
228
+ Properties of the `max` object:
229
+
230
+ ### `label` (string)
231
+
232
+ Indicates the label for the item that is displayed in the Grid Setup Panel
233
+
234
+ ### `enabled` (boolean)
235
+
236
+ Indicates if the item is displayed in the Grid Setup Panel
237
+
238
+ ## `axisLabel` (object)
239
+
240
+ Properties of the `axisLabel` object:
241
+
242
+ ### `label` (string)
243
+
244
+ Indicates the label for the item that is displayed in the Grid Setup Panel
245
+
246
+ ### `enabled` (boolean)
247
+
248
+ Indicates if the item is displayed in the Grid Setup Panel
249
+
250
+ ## `step` (object)
251
+
252
+ Properties of the `step` object:
253
+
254
+ ### `label` (string)
255
+
256
+ Indicates the label for the item that is displayed in the Grid Setup Panel
257
+
258
+ ### `enabled` (boolean)
259
+
260
+ Indicates if the item is displayed in the Grid Setup Panel
261
+
262
+ ## `labelStep` (object)
263
+
264
+ Properties of the `labelStep` object:
265
+
266
+ ### `label` (string)
267
+
268
+ Indicates the label for the item that is displayed in the Grid Setup Panel
269
+
270
+ ### `enabled` (boolean)
271
+
272
+ Indicates if the item is displayed in the Grid Setup Panel
273
+
274
+ # `arrows` (object)
275
+
276
+ Properties of the `arrows` object:
277
+
278
+ ## `settings` (boolean)
279
+
280
+ Indicates if the item has to be displayed in the Settings Panel
281
+
282
+ ## `label` (string)
283
+
284
+ Indicates the label for the item that has to be displayed in the Settings Panel
285
+
286
+ ## `left` (object)
287
+
288
+ Properties of the `left` object:
289
+
290
+ ### `label` (string)
291
+
292
+ Indicates the label for the arrow that has to be displayed in the Settings Panel
293
+
294
+ ## `right` (object)
295
+
296
+ Properties of the `right` object:
297
+
298
+ ### `label` (string)
299
+
300
+ Indicates the label for the arrow that has to be displayed in the Settings Panel
301
+
302
+ ## `up` (object)
303
+
304
+ Properties of the `up` object:
305
+
306
+ ### `label` (string)
307
+
308
+ Indicates the label for the arrow that has to be displayed in the Settings Panel
309
+
310
+ ## `down` (object)
311
+
312
+ Properties of the `down` object:
313
+
314
+ ### `label` (string)
315
+
316
+ Indicates the label for the arrow that has to be displayed in the Settings Panel
317
+
318
+ # `availableTools` (array)
319
+
320
+ Graph toolbar tools configuration
321
+
322
+ The object is an array with all elements of the type `string`.
323
+
324
+ # `coordinatesOnHover` (object)
325
+
326
+ Properties of the `coordinatesOnHover` object:
327
+
328
+ ## `settings` (boolean)
329
+
330
+ Indicates if the item has to be displayed in the Settings Panel
331
+
332
+ ## `label` (string)
333
+
334
+ Indicates the label for the item that has to be displayed in the Settings Panel
335
+
336
+ # `graphDimensions` (object)
337
+
338
+ Properties of the `graphDimensions` object:
339
+
340
+ ## `settings` (boolean)
341
+
342
+ Indicates if the item has to be displayed in the Settings Panel
343
+
344
+ ## `label` (string)
345
+
346
+ Indicates the label for the item that has to be displayed in the Settings Panel
347
+
348
+ ## `enabled` (boolean)
349
+
350
+ Indicates if the graph dimensions are included in the Grid Setup Panel
351
+
352
+ ## `min` (number)
353
+
354
+ Indicates the minimum value for the graph width and height
355
+
356
+ ## `max` (number)
357
+
358
+ Indicates the maximum value for the graph width and height
359
+
360
+ ## `step` (number)
361
+
362
+ Indicates the increase/decrease value for the graph width and height
363
+
364
+ # `gridConfigurations` (array, required)
365
+
366
+ Grid default configurations
367
+
368
+ The object is an array with all elements of the type `object`.
369
+
370
+ The array object has the following properties:
371
+
372
+ ## `label` (string)
373
+
374
+ Indicates the label for the configuration
375
+
376
+ ## `arrows` (object)
377
+
378
+ Properties of the `arrows` object:
379
+
380
+ ### `left` (boolean, required)
381
+
382
+ Indicates if left arrow is enabled
383
+
384
+ ### `right` (boolean, required)
385
+
386
+ Indicates if right arrow is enabled
387
+
388
+ ### `up` (boolean, required)
389
+
390
+ Indicates if up arrow is enabled
391
+
392
+ ### `down` (boolean, required)
393
+
394
+ Indicates if down arrow is enabled
395
+
396
+ ## `domain` (object, required)
397
+
398
+ Properties of the `domain` object:
399
+
400
+ ### `min` (number, required)
401
+
402
+ Min value
403
+
404
+ ### `max` (number, required)
405
+
406
+ Max value
407
+
408
+ ### `padding` (number, required)
409
+
410
+ Padding value
411
+
412
+ ### `step` (number, required)
413
+
414
+ Step value
415
+
416
+ ### `labelStep` (number, required)
417
+
418
+ Label step value
419
+
420
+ ### `axisLabel` (string, required)
421
+
422
+ Axis Label
423
+
424
+ ## `graph` (object, required)
425
+
426
+ Properties of the `graph` object:
427
+
428
+ ### `width` (number, required)
429
+
430
+ Width for graph representation
431
+
432
+ ### `height` (number, required)
433
+
434
+ Height for graph representation
435
+
436
+ ## `includeAxes` (boolean)
437
+
438
+ Indicates if the graph axes and labels are enabled
439
+
440
+ ## `labels` (object)
441
+
442
+ Properties of the `labels` object:
443
+
444
+ ### `top` (string, required)
445
+
446
+ Label for top side of the graph
447
+
448
+ ### `bottom` (string, required)
449
+
450
+ Label for bottom side of the graph
451
+
452
+ ### `left` (string, required)
453
+
454
+ Label for left side of the graph
455
+
456
+ ### `right` (string, required)
457
+
458
+ Label for right side of the graph
459
+
460
+ ## `padding` (boolean)
461
+
462
+ Indicates if padding is enabled
463
+
464
+ ## `range` (object, required)
465
+
466
+ Properties of the `range` object:
467
+
468
+ ### `min` (number, required)
469
+
470
+ Min value
471
+
472
+ ### `max` (number, required)
473
+
474
+ Max value
475
+
476
+ ### `padding` (number, required)
477
+
478
+ Padding value
479
+
480
+ ### `step` (number, required)
481
+
482
+ Step value
483
+
484
+ ### `labelStep` (number, required)
485
+
486
+ Label step value
487
+
488
+ ### `axisLabel` (string, required)
489
+
490
+ Axis Label
491
+
492
+ ## `standardGrid` (boolean)
493
+
494
+ Indicates if some domain values will be synched to the range values
495
+
496
+ ## `title` (string)
497
+
498
+ Indicates graph title
499
+
500
+ # `padding` (object)
501
+
502
+ Properties of the `padding` object:
503
+
504
+ ## `settings` (boolean)
505
+
506
+ Indicates if the item has to be displayed in the Settings Panel
507
+
508
+ ## `label` (string)
509
+
510
+ Indicates the label for the item that has to be displayed in the Settings Panel
511
+
512
+ # `labels` (object)
513
+
514
+ Properties of the `labels` object:
515
+
516
+ ## `top` (string)
517
+
518
+ Indicates the placeholder for the top label
519
+
520
+ ## `right` (string)
521
+
522
+ Indicates the placeholder for the right label
523
+
524
+ ## `bottom` (string)
525
+
526
+ Indicates the placeholder for the bottom label
527
+
528
+ ## `left` (string)
529
+
530
+ Indicates the placeholder for the left label
531
+
532
+ ## `enabled` (boolean)
533
+
534
+ Indicates the value of the item if it affects config-ui
535
+ (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
536
+
537
+ ## `settings` (boolean)
538
+
539
+ Indicates if the item has to be displayed in the Settings Panel
540
+
541
+ ## `label` (string)
542
+
543
+ Indicates the label for the item that has to be displayed in the Settings Panel
544
+
545
+ # `language` (object)
546
+
547
+ Properties of the `language` object:
548
+
549
+ ## `enabled` (boolean)
550
+
551
+ Indicates the value of the item if it affects config-ui
552
+ (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
553
+
554
+ ## `settings` (boolean)
555
+
556
+ Indicates if the item has to be displayed in the Settings Panel
557
+
558
+ ## `label` (string)
559
+
560
+ Indicates the label for the item that has to be displayed in the Settings Panel
561
+
562
+ # `languageChoices` (object)
563
+
564
+ Language choices configuration
565
+ Only available if language is enabled
566
+
567
+ Properties of the `languageChoices` object:
568
+
569
+ ## `label` (string, required)
570
+
571
+ ## `options` (array, required)
572
+
573
+ The object is an array with all elements of the type `object`.
574
+
575
+ The array object has the following properties:
576
+
577
+ ### `value` (string, required)
578
+
579
+ Value of the language option
580
+
581
+ ### `label` (string, required)
582
+
583
+ Label of the language option
584
+
585
+ # `prompt` (object)
586
+
587
+ Properties of the `prompt` object:
588
+
589
+ ## `inputConfiguration` (object)
590
+
591
+ Properties of the `inputConfiguration` object:
592
+
593
+ ### `math` (object)
594
+
595
+ Properties of the `math` object:
596
+
597
+ #### `disabled` (boolean)
598
+
599
+ Indicates if the plugin is disabled or not
600
+
601
+ ### `audio` (object)
602
+
603
+ Properties of the `audio` object:
604
+
605
+ #### `disabled` (boolean)
606
+
607
+ Indicates if the plugin is disabled or not
608
+
609
+ ### `video` (object)
610
+
611
+ Properties of the `video` object:
612
+
613
+ #### `disabled` (boolean)
614
+
615
+ Indicates if the plugin is disabled or not
616
+
617
+ ### `image` (object)
618
+
619
+ Properties of the `image` object:
620
+
621
+ #### `disabled` (boolean)
622
+
623
+ Indicates if the plugin is disabled or not
624
+
625
+ ### `customPlugins` (array)
626
+
627
+ An array of objects that determine custom plugins.
628
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
629
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
630
+
631
+ The object is an array with all elements of the type `object`.
632
+
633
+ The array object has the following properties:
634
+
635
+ #### `event` (string, required)
636
+
637
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
638
+ PIE will emit the event prefixed with "PIE-".
639
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
640
+
641
+ #### `iconAlt` (string, required)
642
+
643
+ The alt for the custom button icon
644
+
645
+ #### `iconType` (string, required)
646
+
647
+ The icon type.
648
+ Currently, only "SVG" is supported.
649
+
650
+ #### `icon` (string, required)
651
+
652
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
653
+
654
+ ### `blockquote` (object)
655
+
656
+ Properties of the `blockquote` object:
657
+
658
+ #### `disabled` (boolean)
659
+
660
+ Indicates if the plugin is disabled or not
661
+
662
+ ### `h3` (object)
663
+
664
+ Properties of the `h3` object:
665
+
666
+ #### `disabled` (boolean)
667
+
668
+ Indicates if the plugin is disabled or not
669
+
670
+ ### `characters` (object)
671
+
672
+ Properties of the `characters` object:
673
+
674
+ #### `disabled` (boolean)
675
+
676
+ Indicates if the plugin is disabled or not
677
+
678
+ ### `bold` (object)
679
+
680
+ Properties of the `bold` object:
681
+
682
+ #### `disabled` (boolean)
683
+
684
+ Indicates if the plugin is disabled or not
685
+
686
+ ### `html` (object)
687
+
688
+ Properties of the `html` object:
689
+
690
+ #### `disabled` (boolean)
691
+
692
+ Indicates if the plugin is disabled or not
693
+
694
+ ### `italic` (object)
695
+
696
+ Properties of the `italic` object:
697
+
698
+ #### `disabled` (boolean)
699
+
700
+ Indicates if the plugin is disabled or not
701
+
702
+ ### `ol_list` (object)
703
+
704
+ Properties of the `ol_list` object:
705
+
706
+ #### `disabled` (boolean)
707
+
708
+ Indicates if the plugin is disabled or not
709
+
710
+ ### `redo` (object)
711
+
712
+ Properties of the `redo` object:
713
+
714
+ #### `disabled` (boolean)
715
+
716
+ Indicates if the plugin is disabled or not
717
+
718
+ ### `strikethrough` (object)
719
+
720
+ Properties of the `strikethrough` object:
721
+
722
+ #### `disabled` (boolean)
723
+
724
+ Indicates if the plugin is disabled or not
725
+
726
+ ### `sub` (object)
727
+
728
+ Properties of the `sub` object:
729
+
730
+ #### `disabled` (boolean)
731
+
732
+ Indicates if the plugin is disabled or not
733
+
734
+ ### `sup` (object)
735
+
736
+ Properties of the `sup` object:
737
+
738
+ #### `disabled` (boolean)
739
+
740
+ Indicates if the plugin is disabled or not
741
+
742
+ ### `table` (object)
743
+
744
+ Properties of the `table` object:
745
+
746
+ #### `disabled` (boolean)
747
+
748
+ Indicates if the plugin is disabled or not
749
+
750
+ ### `ul_list` (object)
751
+
752
+ Properties of the `ul_list` object:
753
+
754
+ #### `disabled` (boolean)
755
+
756
+ Indicates if the plugin is disabled or not
757
+
758
+ ### `underline` (object)
759
+
760
+ Properties of the `underline` object:
761
+
762
+ #### `disabled` (boolean)
763
+
764
+ Indicates if the plugin is disabled or not
765
+
766
+ ### `undo` (object)
767
+
768
+ Properties of the `undo` object:
769
+
770
+ #### `disabled` (boolean)
771
+
772
+ Indicates if the plugin is disabled or not
773
+
774
+ ## `required` (boolean)
775
+
776
+ Indicates if the item is required and the value cannot be empty
777
+
778
+ ## `settings` (boolean)
779
+
780
+ Indicates if the item has to be displayed in the Settings Panel
781
+
782
+ ## `label` (string)
783
+
784
+ Indicates the label for the item that has to be displayed in the Settings Panel
785
+
786
+ # `settingsPanelDisabled` (boolean)
787
+
788
+ Indicates if the settings panel is not available
789
+
790
+ # `spellCheck` (object)
791
+
792
+ Properties of the `spellCheck` object:
793
+
794
+ ## `settings` (boolean)
795
+
796
+ Indicates if the item has to be displayed in the Settings Panel
797
+
798
+ ## `label` (string)
799
+
800
+ Indicates the label for the item that has to be displayed in the Settings Panel
801
+
802
+ # `rationale` (object)
803
+
804
+ Properties of the `rationale` object:
805
+
806
+ ## `inputConfiguration` (object)
807
+
808
+ Properties of the `inputConfiguration` object:
809
+
810
+ ### `math` (object)
811
+
812
+ Properties of the `math` object:
813
+
814
+ #### `disabled` (boolean)
815
+
816
+ Indicates if the plugin is disabled or not
817
+
818
+ ### `audio` (object)
819
+
820
+ Properties of the `audio` object:
821
+
822
+ #### `disabled` (boolean)
823
+
824
+ Indicates if the plugin is disabled or not
825
+
826
+ ### `video` (object)
827
+
828
+ Properties of the `video` object:
829
+
830
+ #### `disabled` (boolean)
831
+
832
+ Indicates if the plugin is disabled or not
833
+
834
+ ### `image` (object)
835
+
836
+ Properties of the `image` object:
837
+
838
+ #### `disabled` (boolean)
839
+
840
+ Indicates if the plugin is disabled or not
841
+
842
+ ### `customPlugins` (array)
843
+
844
+ An array of objects that determine custom plugins.
845
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
846
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
847
+
848
+ The object is an array with all elements of the type `object`.
849
+
850
+ The array object has the following properties:
851
+
852
+ #### `event` (string, required)
853
+
854
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
855
+ PIE will emit the event prefixed with "PIE-".
856
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
857
+
858
+ #### `iconAlt` (string, required)
859
+
860
+ The alt for the custom button icon
861
+
862
+ #### `iconType` (string, required)
863
+
864
+ The icon type.
865
+ Currently, only "SVG" is supported.
866
+
867
+ #### `icon` (string, required)
868
+
869
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
870
+
871
+ ### `blockquote` (object)
872
+
873
+ Properties of the `blockquote` object:
874
+
875
+ #### `disabled` (boolean)
876
+
877
+ Indicates if the plugin is disabled or not
878
+
879
+ ### `h3` (object)
880
+
881
+ Properties of the `h3` object:
882
+
883
+ #### `disabled` (boolean)
884
+
885
+ Indicates if the plugin is disabled or not
886
+
887
+ ### `characters` (object)
888
+
889
+ Properties of the `characters` object:
890
+
891
+ #### `disabled` (boolean)
892
+
893
+ Indicates if the plugin is disabled or not
894
+
895
+ ### `bold` (object)
896
+
897
+ Properties of the `bold` object:
898
+
899
+ #### `disabled` (boolean)
900
+
901
+ Indicates if the plugin is disabled or not
902
+
903
+ ### `html` (object)
904
+
905
+ Properties of the `html` object:
906
+
907
+ #### `disabled` (boolean)
908
+
909
+ Indicates if the plugin is disabled or not
910
+
911
+ ### `italic` (object)
912
+
913
+ Properties of the `italic` object:
914
+
915
+ #### `disabled` (boolean)
916
+
917
+ Indicates if the plugin is disabled or not
918
+
919
+ ### `ol_list` (object)
920
+
921
+ Properties of the `ol_list` object:
922
+
923
+ #### `disabled` (boolean)
924
+
925
+ Indicates if the plugin is disabled or not
926
+
927
+ ### `redo` (object)
928
+
929
+ Properties of the `redo` object:
930
+
931
+ #### `disabled` (boolean)
932
+
933
+ Indicates if the plugin is disabled or not
934
+
935
+ ### `strikethrough` (object)
936
+
937
+ Properties of the `strikethrough` object:
938
+
939
+ #### `disabled` (boolean)
940
+
941
+ Indicates if the plugin is disabled or not
942
+
943
+ ### `sub` (object)
944
+
945
+ Properties of the `sub` object:
946
+
947
+ #### `disabled` (boolean)
948
+
949
+ Indicates if the plugin is disabled or not
950
+
951
+ ### `sup` (object)
952
+
953
+ Properties of the `sup` object:
954
+
955
+ #### `disabled` (boolean)
956
+
957
+ Indicates if the plugin is disabled or not
958
+
959
+ ### `table` (object)
960
+
961
+ Properties of the `table` object:
962
+
963
+ #### `disabled` (boolean)
964
+
965
+ Indicates if the plugin is disabled or not
966
+
967
+ ### `ul_list` (object)
968
+
969
+ Properties of the `ul_list` object:
970
+
971
+ #### `disabled` (boolean)
972
+
973
+ Indicates if the plugin is disabled or not
974
+
975
+ ### `underline` (object)
976
+
977
+ Properties of the `underline` object:
978
+
979
+ #### `disabled` (boolean)
980
+
981
+ Indicates if the plugin is disabled or not
982
+
983
+ ### `undo` (object)
984
+
985
+ Properties of the `undo` object:
986
+
987
+ #### `disabled` (boolean)
988
+
989
+ Indicates if the plugin is disabled or not
990
+
991
+ ## `required` (boolean)
992
+
993
+ Indicates if the item is required and the value cannot be empty
994
+
995
+ ## `settings` (boolean)
996
+
997
+ Indicates if the item has to be displayed in the Settings Panel
998
+
999
+ ## `label` (string)
1000
+
1001
+ Indicates the label for the item that has to be displayed in the Settings Panel
1002
+
1003
+ # `scoringType` (object)
1004
+
1005
+ Properties of the `scoringType` object:
1006
+
1007
+ ## `settings` (boolean)
1008
+
1009
+ Indicates if the item has to be displayed in the Settings Panel
1010
+
1011
+ ## `label` (string)
1012
+
1013
+ Indicates the label for the item that has to be displayed in the Settings Panel
1014
+
1015
+ # `studentInstructions` (object)
1016
+
1017
+ Properties of the `studentInstructions` object:
1018
+
1019
+ ## `settings` (boolean)
1020
+
1021
+ Indicates if the item has to be displayed in the Settings Panel
1022
+
1023
+ ## `label` (string)
1024
+
1025
+ Indicates the label for the item that has to be displayed in the Settings Panel
1026
+
1027
+ # `teacherInstructions` (object)
1028
+
1029
+ Properties of the `teacherInstructions` object:
1030
+
1031
+ ## `inputConfiguration` (object)
1032
+
1033
+ Properties of the `inputConfiguration` object:
1034
+
1035
+ ### `math` (object)
1036
+
1037
+ Properties of the `math` object:
1038
+
1039
+ #### `disabled` (boolean)
1040
+
1041
+ Indicates if the plugin is disabled or not
1042
+
1043
+ ### `audio` (object)
1044
+
1045
+ Properties of the `audio` object:
1046
+
1047
+ #### `disabled` (boolean)
1048
+
1049
+ Indicates if the plugin is disabled or not
1050
+
1051
+ ### `video` (object)
1052
+
1053
+ Properties of the `video` object:
1054
+
1055
+ #### `disabled` (boolean)
1056
+
1057
+ Indicates if the plugin is disabled or not
1058
+
1059
+ ### `image` (object)
1060
+
1061
+ Properties of the `image` object:
1062
+
1063
+ #### `disabled` (boolean)
1064
+
1065
+ Indicates if the plugin is disabled or not
1066
+
1067
+ ### `customPlugins` (array)
1068
+
1069
+ An array of objects that determine custom plugins.
1070
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
1071
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1072
+
1073
+ The object is an array with all elements of the type `object`.
1074
+
1075
+ The array object has the following properties:
1076
+
1077
+ #### `event` (string, required)
1078
+
1079
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1080
+ PIE will emit the event prefixed with "PIE-".
1081
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1082
+
1083
+ #### `iconAlt` (string, required)
1084
+
1085
+ The alt for the custom button icon
1086
+
1087
+ #### `iconType` (string, required)
1088
+
1089
+ The icon type.
1090
+ Currently, only "SVG" is supported.
1091
+
1092
+ #### `icon` (string, required)
1093
+
1094
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1095
+
1096
+ ### `blockquote` (object)
1097
+
1098
+ Properties of the `blockquote` object:
1099
+
1100
+ #### `disabled` (boolean)
1101
+
1102
+ Indicates if the plugin is disabled or not
1103
+
1104
+ ### `h3` (object)
1105
+
1106
+ Properties of the `h3` object:
1107
+
1108
+ #### `disabled` (boolean)
1109
+
1110
+ Indicates if the plugin is disabled or not
1111
+
1112
+ ### `characters` (object)
1113
+
1114
+ Properties of the `characters` object:
1115
+
1116
+ #### `disabled` (boolean)
1117
+
1118
+ Indicates if the plugin is disabled or not
1119
+
1120
+ ### `bold` (object)
1121
+
1122
+ Properties of the `bold` object:
1123
+
1124
+ #### `disabled` (boolean)
1125
+
1126
+ Indicates if the plugin is disabled or not
1127
+
1128
+ ### `html` (object)
1129
+
1130
+ Properties of the `html` object:
1131
+
1132
+ #### `disabled` (boolean)
1133
+
1134
+ Indicates if the plugin is disabled or not
1135
+
1136
+ ### `italic` (object)
1137
+
1138
+ Properties of the `italic` object:
1139
+
1140
+ #### `disabled` (boolean)
1141
+
1142
+ Indicates if the plugin is disabled or not
1143
+
1144
+ ### `ol_list` (object)
1145
+
1146
+ Properties of the `ol_list` object:
1147
+
1148
+ #### `disabled` (boolean)
1149
+
1150
+ Indicates if the plugin is disabled or not
1151
+
1152
+ ### `redo` (object)
1153
+
1154
+ Properties of the `redo` object:
1155
+
1156
+ #### `disabled` (boolean)
1157
+
1158
+ Indicates if the plugin is disabled or not
1159
+
1160
+ ### `strikethrough` (object)
1161
+
1162
+ Properties of the `strikethrough` object:
1163
+
1164
+ #### `disabled` (boolean)
1165
+
1166
+ Indicates if the plugin is disabled or not
1167
+
1168
+ ### `sub` (object)
1169
+
1170
+ Properties of the `sub` object:
1171
+
1172
+ #### `disabled` (boolean)
1173
+
1174
+ Indicates if the plugin is disabled or not
1175
+
1176
+ ### `sup` (object)
1177
+
1178
+ Properties of the `sup` object:
1179
+
1180
+ #### `disabled` (boolean)
1181
+
1182
+ Indicates if the plugin is disabled or not
1183
+
1184
+ ### `table` (object)
1185
+
1186
+ Properties of the `table` object:
1187
+
1188
+ #### `disabled` (boolean)
1189
+
1190
+ Indicates if the plugin is disabled or not
1191
+
1192
+ ### `ul_list` (object)
1193
+
1194
+ Properties of the `ul_list` object:
1195
+
1196
+ #### `disabled` (boolean)
1197
+
1198
+ Indicates if the plugin is disabled or not
1199
+
1200
+ ### `underline` (object)
1201
+
1202
+ Properties of the `underline` object:
1203
+
1204
+ #### `disabled` (boolean)
1205
+
1206
+ Indicates if the plugin is disabled or not
1207
+
1208
+ ### `undo` (object)
1209
+
1210
+ Properties of the `undo` object:
1211
+
1212
+ #### `disabled` (boolean)
1213
+
1214
+ Indicates if the plugin is disabled or not
1215
+
1216
+ ## `required` (boolean)
1217
+
1218
+ Indicates if the item is required and the value cannot be empty
1219
+
1220
+ ## `settings` (boolean)
1221
+
1222
+ Indicates if the item has to be displayed in the Settings Panel
1223
+
1224
+ ## `label` (string)
1225
+
1226
+ Indicates the label for the item that has to be displayed in the Settings Panel
1227
+
1228
+ # `title` (object)
1229
+
1230
+ Properties of the `title` object:
1231
+
1232
+ ## `placeholder` (string)
1233
+
1234
+ Indicates the placeholder for the title label
1235
+
1236
+ ## `enabled` (boolean)
1237
+
1238
+ Indicates the value of the item if it affects config-ui
1239
+ (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
1240
+
1241
+ ## `settings` (boolean)
1242
+
1243
+ Indicates if the item has to be displayed in the Settings Panel
1244
+
1245
+ ## `label` (string)
1246
+
1247
+ Indicates the label for the item that has to be displayed in the Settings Panel
1248
+
1249
+ # `maxImageWidth` (object)
1250
+
1251
+ Properties of the `maxImageWidth` object:
1252
+
1253
+ ## `teacherInstructions` (number)
1254
+
1255
+ Indicates the max dimension for images in teacher instructions
1256
+
1257
+ ## `prompt` (number)
1258
+
1259
+ Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
1260
+
1261
+ ## `rationale` (number)
1262
+
1263
+ Indicates the max dimension for images in rationale
1264
+
1265
+ # `maxImageHeight` (object)
1266
+
1267
+ Properties of the `maxImageHeight` object:
1268
+
1269
+ ## `teacherInstructions` (number)
1270
+
1271
+ Indicates the max dimension for images in teacher instructions
1272
+
1273
+ ## `prompt` (number)
1274
+
1275
+ Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
1276
+
1277
+ ## `rationale` (number)
1278
+
1279
+ Indicates the max dimension for images in rationale
1280
+
1281
+ # `withRubric` (object)
1282
+
1283
+ Properties of the `withRubric` object:
1284
+
1285
+ ## `settings` (boolean)
1286
+
1287
+ Indicates if the item has to be displayed in the Settings Panel
1288
+
1289
+ ## `label` (string)
1290
+
1291
+ Indicates the label for the item that has to be displayed in the Settings Panel
1292
+
1293
+ # `mathMlOptions` (object)
1294
+
1295
+ Properties of the `mathMlOptions` object:
1296
+
1297
+ ## `mmlOutput` (number)
1298
+
1299
+ Indicates if model should have mathML output instead of latex
1300
+
1301
+ ## `mmlEditing` (number)
1302
+
1303
+ Indicates if mathML that's already in model should be editable
1304
+
1305
+ # `removeIncompleteTool` (boolean)
1306
+
1307
+ Ability to remove incomplete tool added after switching current tool.
1308
+
1309
+ # `showPrompt` (boolean)
1310
+
1311
+ Determines whether prompt field will be displayed or not
1312
+
1313
+ Default: `true`
1314
+
1315
+ # `promptLabel` (string)
1316
+
1317
+ The label for the item stem/prompt field
1318
+
1319
+ Default: `"Item Stemm"`
1320
+
1321
+ # `contentDimensions` (object)
1322
+
1323
+ Indicates the dimensions configuration for the authoring container
1324
+ Note: Some items have a default minimum width because of their content, but if
1325
+ the minWidth is lower than this, the overflow behavior will take care of that
1326
+
1327
+ Properties of the `contentDimensions` object:
1328
+
1329
+ ## `maxHeight` (string,number)
1330
+
1331
+ Indicates the max height of the authoring container
1332
+
1333
+ Default: `"undefined"`
1334
+
1335
+ ## `maxWidth` (string,number)
1336
+
1337
+ Indicates the max width of the authoring container
1338
+
1339
+ Default: `"undefined"`
1340
+
1341
+ ## `minHeight` (string,number)
1342
+
1343
+ Indicates the min height of the authoring container
1344
+
1345
+ Default: `"undefined"`
1346
+
1347
+ ## `minWidth` (string,number)
1348
+
1349
+ Indicates the min width of the authoring container
1350
+
1351
+ Default: `"undefined"`
1352
+
1353
+ Default: `": {}"`
1354
+
1355
+ # `settingsPartialScoring` (boolean)
1356
+
1357
+ Indicates whether the settings panel wil allow the author to modify settings for partial scoring
1358
+
1359
+ Default: `true`
1360
+
1361
+ ---
1362
+
1363
+ # Sub Schemas
1364
+
1365
+ The schema defines the following additional types:
1366
+
1367
+ ## `EditableHtmlConfigureProp` (object)
1368
+
1369
+ Properties of the `EditableHtmlConfigureProp` object:
1370
+
1371
+ ### `math` (object)
1372
+
1373
+ Properties of the `math` object:
1374
+
1375
+ #### `disabled` (boolean)
1376
+
1377
+ Indicates if the plugin is disabled or not
1378
+
1379
+ ### `audio` (object)
1380
+
1381
+ Properties of the `audio` object:
1382
+
1383
+ #### `disabled` (boolean)
1384
+
1385
+ Indicates if the plugin is disabled or not
1386
+
1387
+ ### `video` (object)
1388
+
1389
+ Properties of the `video` object:
1390
+
1391
+ #### `disabled` (boolean)
1392
+
1393
+ Indicates if the plugin is disabled or not
1394
+
1395
+ ### `image` (object)
1396
+
1397
+ Properties of the `image` object:
1398
+
1399
+ #### `disabled` (boolean)
1400
+
1401
+ Indicates if the plugin is disabled or not
1402
+
1403
+ ### `customPlugins` (array)
1404
+
1405
+ An array of objects that determine custom plugins.
1406
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
1407
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1408
+
1409
+ The object is an array with all elements of the type `object`.
1410
+
1411
+ The array object has the following properties:
1412
+
1413
+ #### `event` (string, required)
1414
+
1415
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1416
+ PIE will emit the event prefixed with "PIE-".
1417
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1418
+
1419
+ #### `iconAlt` (string, required)
1420
+
1421
+ The alt for the custom button icon
1422
+
1423
+ #### `iconType` (string, required)
1424
+
1425
+ The icon type.
1426
+ Currently, only "SVG" is supported.
1427
+
1428
+ #### `icon` (string, required)
1429
+
1430
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1431
+
1432
+ ### `blockquote` (object)
1433
+
1434
+ Properties of the `blockquote` object:
1435
+
1436
+ #### `disabled` (boolean)
1437
+
1438
+ Indicates if the plugin is disabled or not
1439
+
1440
+ ### `h3` (object)
1441
+
1442
+ Properties of the `h3` object:
1443
+
1444
+ #### `disabled` (boolean)
1445
+
1446
+ Indicates if the plugin is disabled or not
1447
+
1448
+ ### `characters` (object)
1449
+
1450
+ Properties of the `characters` object:
1451
+
1452
+ #### `disabled` (boolean)
1453
+
1454
+ Indicates if the plugin is disabled or not
1455
+
1456
+ ### `bold` (object)
1457
+
1458
+ Properties of the `bold` object:
1459
+
1460
+ #### `disabled` (boolean)
1461
+
1462
+ Indicates if the plugin is disabled or not
1463
+
1464
+ ### `html` (object)
1465
+
1466
+ Properties of the `html` object:
1467
+
1468
+ #### `disabled` (boolean)
1469
+
1470
+ Indicates if the plugin is disabled or not
1471
+
1472
+ ### `italic` (object)
1473
+
1474
+ Properties of the `italic` object:
1475
+
1476
+ #### `disabled` (boolean)
1477
+
1478
+ Indicates if the plugin is disabled or not
1479
+
1480
+ ### `ol_list` (object)
1481
+
1482
+ Properties of the `ol_list` object:
1483
+
1484
+ #### `disabled` (boolean)
1485
+
1486
+ Indicates if the plugin is disabled or not
1487
+
1488
+ ### `redo` (object)
1489
+
1490
+ Properties of the `redo` object:
1491
+
1492
+ #### `disabled` (boolean)
1493
+
1494
+ Indicates if the plugin is disabled or not
1495
+
1496
+ ### `strikethrough` (object)
1497
+
1498
+ Properties of the `strikethrough` object:
1499
+
1500
+ #### `disabled` (boolean)
1501
+
1502
+ Indicates if the plugin is disabled or not
1503
+
1504
+ ### `sub` (object)
1505
+
1506
+ Properties of the `sub` object:
1507
+
1508
+ #### `disabled` (boolean)
1509
+
1510
+ Indicates if the plugin is disabled or not
1511
+
1512
+ ### `sup` (object)
1513
+
1514
+ Properties of the `sup` object:
1515
+
1516
+ #### `disabled` (boolean)
1517
+
1518
+ Indicates if the plugin is disabled or not
1519
+
1520
+ ### `table` (object)
1521
+
1522
+ Properties of the `table` object:
1523
+
1524
+ #### `disabled` (boolean)
1525
+
1526
+ Indicates if the plugin is disabled or not
1527
+
1528
+ ### `ul_list` (object)
1529
+
1530
+ Properties of the `ul_list` object:
1531
+
1532
+ #### `disabled` (boolean)
1533
+
1534
+ Indicates if the plugin is disabled or not
1535
+
1536
+ ### `underline` (object)
1537
+
1538
+ Properties of the `underline` object:
1539
+
1540
+ #### `disabled` (boolean)
1541
+
1542
+ Indicates if the plugin is disabled or not
1543
+
1544
+ ### `undo` (object)
1545
+
1546
+ Properties of the `undo` object:
1547
+
1548
+ #### `disabled` (boolean)
1549
+
1550
+ Indicates if the plugin is disabled or not
1551
+
1552
+ ## `EditableHtmlButtonConfigure` (object)
1553
+
1554
+ Properties of the `EditableHtmlButtonConfigure` object:
1555
+
1556
+ ### `disabled` (boolean)
1557
+
1558
+ Indicates if the plugin is disabled or not
1559
+
1560
+ ## `CustomPlugin` (object)
1561
+
1562
+ Properties of the `CustomPlugin` object:
1563
+
1564
+ ### `event` (string, required)
1565
+
1566
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1567
+ PIE will emit the event prefixed with "PIE-".
1568
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1569
+
1570
+ ### `iconAlt` (string, required)
1571
+
1572
+ The alt for the custom button icon
1573
+
1574
+ ### `iconType` (string, required)
1575
+
1576
+ The icon type.
1577
+ Currently, only "SVG" is supported.
1578
+
1579
+ ### `icon` (string, required)
1580
+
1581
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1582
+
1583
+ ## `AuthoringConfigProp` (object)
1584
+
1585
+ Properties of the `AuthoringConfigProp` object:
1586
+
1587
+ ### `settings` (boolean)
1588
+
1589
+ Indicates if the item is displayed in the Settings Panel
1590
+
1591
+ ### `label` (string)
1592
+
1593
+ Indicates the label for the item that is displayed in the Settings Panel
1594
+
1595
+ ### `enabled` (boolean)
1596
+
1597
+ Indicates if the Grid Setup Panel is displayed
1598
+
1599
+ ### `includeAxesEnabled` (boolean)
1600
+
1601
+ Indicates if the "includeAxes" toggle is displayed in the Grid Setup Panel
1602
+
1603
+ ### `standardGridEnabled` (boolean)
1604
+
1605
+ Indicates if the "standardGrid" toggle is displayed in the Grid Setup Panel
1606
+
1607
+ ### `min` (object)
1608
+
1609
+ Properties of the `min` object:
1610
+
1611
+ #### `label` (string)
1612
+
1613
+ Indicates the label for the item that is displayed in the Grid Setup Panel
1614
+
1615
+ #### `enabled` (boolean)
1616
+
1617
+ Indicates if the item is displayed in the Grid Setup Panel
1618
+
1619
+ ### `max` (object)
1620
+
1621
+ Properties of the `max` object:
1622
+
1623
+ #### `label` (string)
1624
+
1625
+ Indicates the label for the item that is displayed in the Grid Setup Panel
1626
+
1627
+ #### `enabled` (boolean)
1628
+
1629
+ Indicates if the item is displayed in the Grid Setup Panel
1630
+
1631
+ ### `axisLabel` (object)
1632
+
1633
+ Properties of the `axisLabel` object:
1634
+
1635
+ #### `label` (string)
1636
+
1637
+ Indicates the label for the item that is displayed in the Grid Setup Panel
1638
+
1639
+ #### `enabled` (boolean)
1640
+
1641
+ Indicates if the item is displayed in the Grid Setup Panel
1642
+
1643
+ ### `step` (object)
1644
+
1645
+ Properties of the `step` object:
1646
+
1647
+ #### `label` (string)
1648
+
1649
+ Indicates the label for the item that is displayed in the Grid Setup Panel
1650
+
1651
+ #### `enabled` (boolean)
1652
+
1653
+ Indicates if the item is displayed in the Grid Setup Panel
1654
+
1655
+ ### `labelStep` (object)
1656
+
1657
+ Properties of the `labelStep` object:
1658
+
1659
+ #### `label` (string)
1660
+
1661
+ Indicates the label for the item that is displayed in the Grid Setup Panel
1662
+
1663
+ #### `enabled` (boolean)
1664
+
1665
+ Indicates if the item is displayed in the Grid Setup Panel
1666
+
1667
+ ## `GridPanelConfigProp` (object)
1668
+
1669
+ Properties of the `GridPanelConfigProp` object:
1670
+
1671
+ ### `label` (string)
1672
+
1673
+ Indicates the label for the item that is displayed in the Grid Setup Panel
1674
+
1675
+ ### `enabled` (boolean)
1676
+
1677
+ Indicates if the item is displayed in the Grid Setup Panel
1678
+
1679
+ ## `ArrowsConfigProp` (object)
1680
+
1681
+ Properties of the `ArrowsConfigProp` object:
1682
+
1683
+ ### `settings` (boolean)
1684
+
1685
+ Indicates if the item has to be displayed in the Settings Panel
1686
+
1687
+ ### `label` (string)
1688
+
1689
+ Indicates the label for the item that has to be displayed in the Settings Panel
1690
+
1691
+ ### `left` (object)
1692
+
1693
+ Properties of the `left` object:
1694
+
1695
+ #### `label` (string)
1696
+
1697
+ Indicates the label for the arrow that has to be displayed in the Settings Panel
1698
+
1699
+ ### `right` (object)
1700
+
1701
+ Properties of the `right` object:
1702
+
1703
+ #### `label` (string)
1704
+
1705
+ Indicates the label for the arrow that has to be displayed in the Settings Panel
1706
+
1707
+ ### `up` (object)
1708
+
1709
+ Properties of the `up` object:
1710
+
1711
+ #### `label` (string)
1712
+
1713
+ Indicates the label for the arrow that has to be displayed in the Settings Panel
1714
+
1715
+ ### `down` (object)
1716
+
1717
+ Properties of the `down` object:
1718
+
1719
+ #### `label` (string)
1720
+
1721
+ Indicates the label for the arrow that has to be displayed in the Settings Panel
1722
+
1723
+ ## `ArrowsProp` (object)
1724
+
1725
+ Properties of the `ArrowsProp` object:
1726
+
1727
+ ### `label` (string)
1728
+
1729
+ Indicates the label for the arrow that has to be displayed in the Settings Panel
1730
+
1731
+ ## `ConfigureProp` (object)
1732
+
1733
+ Properties of the `ConfigureProp` object:
1734
+
1735
+ ### `settings` (boolean)
1736
+
1737
+ Indicates if the item has to be displayed in the Settings Panel
1738
+
1739
+ ### `label` (string)
1740
+
1741
+ Indicates the label for the item that has to be displayed in the Settings Panel
1742
+
1743
+ ## `DimensionsConfigProp` (object)
1744
+
1745
+ Properties of the `DimensionsConfigProp` object:
1746
+
1747
+ ### `settings` (boolean)
1748
+
1749
+ Indicates if the item has to be displayed in the Settings Panel
1750
+
1751
+ ### `label` (string)
1752
+
1753
+ Indicates the label for the item that has to be displayed in the Settings Panel
1754
+
1755
+ ### `enabled` (boolean)
1756
+
1757
+ Indicates if the graph dimensions are included in the Grid Setup Panel
1758
+
1759
+ ### `min` (number)
1760
+
1761
+ Indicates the minimum value for the graph width and height
1762
+
1763
+ ### `max` (number)
1764
+
1765
+ Indicates the maximum value for the graph width and height
1766
+
1767
+ ### `step` (number)
1768
+
1769
+ Indicates the increase/decrease value for the graph width and height
1770
+
1771
+ ## `GridConfigurationsProp` (object)
1772
+
1773
+ Properties of the `GridConfigurationsProp` object:
1774
+
1775
+ ### `label` (string)
1776
+
1777
+ Indicates the label for the configuration
1778
+
1779
+ ### `arrows` (object)
1780
+
1781
+ Properties of the `arrows` object:
1782
+
1783
+ #### `left` (boolean, required)
1784
+
1785
+ Indicates if left arrow is enabled
1786
+
1787
+ #### `right` (boolean, required)
1788
+
1789
+ Indicates if right arrow is enabled
1790
+
1791
+ #### `up` (boolean, required)
1792
+
1793
+ Indicates if up arrow is enabled
1794
+
1795
+ #### `down` (boolean, required)
1796
+
1797
+ Indicates if down arrow is enabled
1798
+
1799
+ ### `domain` (object, required)
1800
+
1801
+ Properties of the `domain` object:
1802
+
1803
+ #### `min` (number, required)
1804
+
1805
+ Min value
1806
+
1807
+ #### `max` (number, required)
1808
+
1809
+ Max value
1810
+
1811
+ #### `padding` (number, required)
1812
+
1813
+ Padding value
1814
+
1815
+ #### `step` (number, required)
1816
+
1817
+ Step value
1818
+
1819
+ #### `labelStep` (number, required)
1820
+
1821
+ Label step value
1822
+
1823
+ #### `axisLabel` (string, required)
1824
+
1825
+ Axis Label
1826
+
1827
+ ### `graph` (object, required)
1828
+
1829
+ Properties of the `graph` object:
1830
+
1831
+ #### `width` (number, required)
1832
+
1833
+ Width for graph representation
1834
+
1835
+ #### `height` (number, required)
1836
+
1837
+ Height for graph representation
1838
+
1839
+ ### `includeAxes` (boolean)
1840
+
1841
+ Indicates if the graph axes and labels are enabled
1842
+
1843
+ ### `labels` (object)
1844
+
1845
+ Properties of the `labels` object:
1846
+
1847
+ #### `top` (string, required)
1848
+
1849
+ Label for top side of the graph
1850
+
1851
+ #### `bottom` (string, required)
1852
+
1853
+ Label for bottom side of the graph
1854
+
1855
+ #### `left` (string, required)
1856
+
1857
+ Label for left side of the graph
1858
+
1859
+ #### `right` (string, required)
1860
+
1861
+ Label for right side of the graph
1862
+
1863
+ ### `padding` (boolean)
1864
+
1865
+ Indicates if padding is enabled
1866
+
1867
+ ### `range` (object, required)
1868
+
1869
+ Properties of the `range` object:
1870
+
1871
+ #### `min` (number, required)
1872
+
1873
+ Min value
1874
+
1875
+ #### `max` (number, required)
1876
+
1877
+ Max value
1878
+
1879
+ #### `padding` (number, required)
1880
+
1881
+ Padding value
1882
+
1883
+ #### `step` (number, required)
1884
+
1885
+ Step value
1886
+
1887
+ #### `labelStep` (number, required)
1888
+
1889
+ Label step value
1890
+
1891
+ #### `axisLabel` (string, required)
1892
+
1893
+ Axis Label
1894
+
1895
+ ### `standardGrid` (boolean)
1896
+
1897
+ Indicates if some domain values will be synched to the range values
1898
+
1899
+ ### `title` (string)
1900
+
1901
+ Indicates graph title
1902
+
1903
+ ## `Arrows` (object)
1904
+
1905
+ Properties of the `Arrows` object:
1906
+
1907
+ ### `left` (boolean, required)
1908
+
1909
+ Indicates if left arrow is enabled
1910
+
1911
+ ### `right` (boolean, required)
1912
+
1913
+ Indicates if right arrow is enabled
1914
+
1915
+ ### `up` (boolean, required)
1916
+
1917
+ Indicates if up arrow is enabled
1918
+
1919
+ ### `down` (boolean, required)
1920
+
1921
+ Indicates if down arrow is enabled
1922
+
1923
+ ## `GraphSettings` (object)
1924
+
1925
+ Properties of the `GraphSettings` object:
1926
+
1927
+ ### `min` (number, required)
1928
+
1929
+ Min value
1930
+
1931
+ ### `max` (number, required)
1932
+
1933
+ Max value
1934
+
1935
+ ### `padding` (number, required)
1936
+
1937
+ Padding value
1938
+
1939
+ ### `step` (number, required)
1940
+
1941
+ Step value
1942
+
1943
+ ### `labelStep` (number, required)
1944
+
1945
+ Label step value
1946
+
1947
+ ### `axisLabel` (string, required)
1948
+
1949
+ Axis Label
1950
+
1951
+ ## `Graph` (object)
1952
+
1953
+ Properties of the `Graph` object:
1954
+
1955
+ ### `width` (number, required)
1956
+
1957
+ Width for graph representation
1958
+
1959
+ ### `height` (number, required)
1960
+
1961
+ Height for graph representation
1962
+
1963
+ ## `Labels` (object)
1964
+
1965
+ Properties of the `Labels` object:
1966
+
1967
+ ### `top` (string, required)
1968
+
1969
+ Label for top side of the graph
1970
+
1971
+ ### `bottom` (string, required)
1972
+
1973
+ Label for bottom side of the graph
1974
+
1975
+ ### `left` (string, required)
1976
+
1977
+ Label for left side of the graph
1978
+
1979
+ ### `right` (string, required)
1980
+
1981
+ Label for right side of the graph
1982
+
1983
+ ## `LabelsConfigProp` (object)
1984
+
1985
+ Properties of the `LabelsConfigProp` object:
1986
+
1987
+ ### `top` (string)
1988
+
1989
+ Indicates the placeholder for the top label
1990
+
1991
+ ### `right` (string)
1992
+
1993
+ Indicates the placeholder for the right label
1994
+
1995
+ ### `bottom` (string)
1996
+
1997
+ Indicates the placeholder for the bottom label
1998
+
1999
+ ### `left` (string)
2000
+
2001
+ Indicates the placeholder for the left label
2002
+
2003
+ ### `enabled` (boolean)
2004
+
2005
+ Indicates the value of the item if it affects config-ui
2006
+ (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
2007
+
2008
+ ### `settings` (boolean)
2009
+
2010
+ Indicates if the item has to be displayed in the Settings Panel
2011
+
2012
+ ### `label` (string)
2013
+
2014
+ Indicates the label for the item that has to be displayed in the Settings Panel
2015
+
2016
+ ## `ConfigurePropWithEnabled` (object)
2017
+
2018
+ Properties of the `ConfigurePropWithEnabled` object:
2019
+
2020
+ ### `enabled` (boolean)
2021
+
2022
+ Indicates the value of the item if it affects config-ui
2023
+ (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
2024
+
2025
+ ### `settings` (boolean)
2026
+
2027
+ Indicates if the item has to be displayed in the Settings Panel
2028
+
2029
+ ### `label` (string)
2030
+
2031
+ Indicates the label for the item that has to be displayed in the Settings Panel
2032
+
2033
+ ## `ConfigureLanguageOptionsProp` (object)
2034
+
2035
+ Properties of the `ConfigureLanguageOptionsProp` object:
2036
+
2037
+ ### `value` (string, required)
2038
+
2039
+ Value of the language option
2040
+
2041
+ ### `label` (string, required)
2042
+
2043
+ Label of the language option
2044
+
2045
+ ## `EditableHtmlPluginConfigureRequired` (object)
2046
+
2047
+ Properties of the `EditableHtmlPluginConfigureRequired` object:
2048
+
2049
+ ### `inputConfiguration` (object)
2050
+
2051
+ Properties of the `inputConfiguration` object:
2052
+
2053
+ #### `math` (object)
2054
+
2055
+ Properties of the `math` object:
2056
+
2057
+ ##### `disabled` (boolean)
2058
+
2059
+ Indicates if the plugin is disabled or not
2060
+
2061
+ #### `audio` (object)
2062
+
2063
+ Properties of the `audio` object:
2064
+
2065
+ ##### `disabled` (boolean)
2066
+
2067
+ Indicates if the plugin is disabled or not
2068
+
2069
+ #### `video` (object)
2070
+
2071
+ Properties of the `video` object:
2072
+
2073
+ ##### `disabled` (boolean)
2074
+
2075
+ Indicates if the plugin is disabled or not
2076
+
2077
+ #### `image` (object)
2078
+
2079
+ Properties of the `image` object:
2080
+
2081
+ ##### `disabled` (boolean)
2082
+
2083
+ Indicates if the plugin is disabled or not
2084
+
2085
+ #### `customPlugins` (array)
2086
+
2087
+ An array of objects that determine custom plugins.
2088
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
2089
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
2090
+
2091
+ The object is an array with all elements of the type `object`.
2092
+
2093
+ The array object has the following properties:
2094
+
2095
+ ##### `event` (string, required)
2096
+
2097
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
2098
+ PIE will emit the event prefixed with "PIE-".
2099
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
2100
+
2101
+ ##### `iconAlt` (string, required)
2102
+
2103
+ The alt for the custom button icon
2104
+
2105
+ ##### `iconType` (string, required)
2106
+
2107
+ The icon type.
2108
+ Currently, only "SVG" is supported.
2109
+
2110
+ ##### `icon` (string, required)
2111
+
2112
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
2113
+
2114
+ #### `blockquote` (object)
2115
+
2116
+ Properties of the `blockquote` object:
2117
+
2118
+ ##### `disabled` (boolean)
2119
+
2120
+ Indicates if the plugin is disabled or not
2121
+
2122
+ #### `h3` (object)
2123
+
2124
+ Properties of the `h3` object:
2125
+
2126
+ ##### `disabled` (boolean)
2127
+
2128
+ Indicates if the plugin is disabled or not
2129
+
2130
+ #### `characters` (object)
2131
+
2132
+ Properties of the `characters` object:
2133
+
2134
+ ##### `disabled` (boolean)
2135
+
2136
+ Indicates if the plugin is disabled or not
2137
+
2138
+ #### `bold` (object)
2139
+
2140
+ Properties of the `bold` object:
2141
+
2142
+ ##### `disabled` (boolean)
2143
+
2144
+ Indicates if the plugin is disabled or not
2145
+
2146
+ #### `html` (object)
2147
+
2148
+ Properties of the `html` object:
2149
+
2150
+ ##### `disabled` (boolean)
2151
+
2152
+ Indicates if the plugin is disabled or not
2153
+
2154
+ #### `italic` (object)
2155
+
2156
+ Properties of the `italic` object:
2157
+
2158
+ ##### `disabled` (boolean)
2159
+
2160
+ Indicates if the plugin is disabled or not
2161
+
2162
+ #### `ol_list` (object)
2163
+
2164
+ Properties of the `ol_list` object:
2165
+
2166
+ ##### `disabled` (boolean)
2167
+
2168
+ Indicates if the plugin is disabled or not
2169
+
2170
+ #### `redo` (object)
2171
+
2172
+ Properties of the `redo` object:
2173
+
2174
+ ##### `disabled` (boolean)
2175
+
2176
+ Indicates if the plugin is disabled or not
2177
+
2178
+ #### `strikethrough` (object)
2179
+
2180
+ Properties of the `strikethrough` object:
2181
+
2182
+ ##### `disabled` (boolean)
2183
+
2184
+ Indicates if the plugin is disabled or not
2185
+
2186
+ #### `sub` (object)
2187
+
2188
+ Properties of the `sub` object:
2189
+
2190
+ ##### `disabled` (boolean)
2191
+
2192
+ Indicates if the plugin is disabled or not
2193
+
2194
+ #### `sup` (object)
2195
+
2196
+ Properties of the `sup` object:
2197
+
2198
+ ##### `disabled` (boolean)
2199
+
2200
+ Indicates if the plugin is disabled or not
2201
+
2202
+ #### `table` (object)
2203
+
2204
+ Properties of the `table` object:
2205
+
2206
+ ##### `disabled` (boolean)
2207
+
2208
+ Indicates if the plugin is disabled or not
2209
+
2210
+ #### `ul_list` (object)
2211
+
2212
+ Properties of the `ul_list` object:
2213
+
2214
+ ##### `disabled` (boolean)
2215
+
2216
+ Indicates if the plugin is disabled or not
2217
+
2218
+ #### `underline` (object)
2219
+
2220
+ Properties of the `underline` object:
2221
+
2222
+ ##### `disabled` (boolean)
2223
+
2224
+ Indicates if the plugin is disabled or not
2225
+
2226
+ #### `undo` (object)
2227
+
2228
+ Properties of the `undo` object:
2229
+
2230
+ ##### `disabled` (boolean)
2231
+
2232
+ Indicates if the plugin is disabled or not
2233
+
2234
+ ### `required` (boolean)
2235
+
2236
+ Indicates if the item is required and the value cannot be empty
2237
+
2238
+ ### `settings` (boolean)
2239
+
2240
+ Indicates if the item has to be displayed in the Settings Panel
2241
+
2242
+ ### `label` (string)
2243
+
2244
+ Indicates the label for the item that has to be displayed in the Settings Panel
2245
+
2246
+ ## `TitleConfigProp` (object)
2247
+
2248
+ Properties of the `TitleConfigProp` object:
2249
+
2250
+ ### `placeholder` (string)
2251
+
2252
+ Indicates the placeholder for the title label
2253
+
2254
+ ### `enabled` (boolean)
2255
+
2256
+ Indicates the value of the item if it affects config-ui
2257
+ (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
2258
+
2259
+ ### `settings` (boolean)
2260
+
2261
+ Indicates if the item has to be displayed in the Settings Panel
2262
+
2263
+ ### `label` (string)
2264
+
2265
+ Indicates the label for the item that has to be displayed in the Settings Panel
2266
+
2267
+ ## `ConfigureMaxImageDimensionsProp` (object)
2268
+
2269
+ Properties of the `ConfigureMaxImageDimensionsProp` object:
2270
+
2271
+ ### `teacherInstructions` (number)
2272
+
2273
+ Indicates the max dimension for images in teacher instructions
2274
+
2275
+ ### `prompt` (number)
2276
+
2277
+ Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
2278
+
2279
+ ### `rationale` (number)
2280
+
2281
+ Indicates the max dimension for images in rationale
2282
+
2283
+ ## `ConfigureMathMLProp` (object)
2284
+
2285
+ Properties of the `ConfigureMathMLProp` object:
2286
+
2287
+ ### `mmlOutput` (number)
2288
+
2289
+ Indicates if model should have mathML output instead of latex
2290
+
2291
+ ### `mmlEditing` (number)
2292
+
2293
+ Indicates if mathML that's already in model should be editable