This repository has been archived by the owner on Jun 4, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 74
/
metadata.json
2156 lines (2156 loc) · 83.8 KB
/
metadata.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"src/dash-table/dash/DataTable.js": {
"description": "Dash DataTable is an interactive table component designed for\ndesigned for viewing, editing, and exploring large datasets.\nDataTable is rendered with standard, semantic HTML <table/> markup,\nwhich makes it accessible, responsive, and easy to style. This\ncomponent was written from scratch in React.js specifically for the\nDash community. Its API was designed to be ergonomic and its behavior\nis completely customizable through its properties.",
"displayName": "DataTable",
"methods": [],
"props": {
"active_cell": {
"type": {
"name": "exact",
"value": {
"row": {
"name": "number",
"required": false
},
"column": {
"name": "number",
"required": false
},
"row_id": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "number"
}
],
"required": false
},
"column_id": {
"name": "string",
"required": false
}
}
},
"required": false,
"description": "The row and column indices and IDs of the currently active cell."
},
"columns": {
"type": {
"name": "arrayOf",
"value": {
"name": "exact",
"value": {
"clearable": {
"name": "union",
"value": [
{
"name": "enum",
"value": [
{
"value": "'first'",
"computed": false
},
{
"value": "'last'",
"computed": false
}
]
},
{
"name": "bool"
},
{
"name": "arrayOf",
"value": {
"name": "bool"
}
}
],
"description": "If true, the user can clear the column by clicking on the `clear`\naction button on the column. If there are multiple header rows, true\nwill display the action button on each row.\nIf `last`, the `clear` action button will only appear on the last header\nrow. If `first` it will only appear on the first header row. These\nare respectively shortcut equivalents to `[false, ..., false, true]` and\n`[true, false, ..., false]`.\nIf there are merged, multi-header columns then you can choose\nwhich column header row to display the `clear` action button in by\nsupplying an array of booleans.\nFor example, `[true, false]` will display the `clear` action button\non the first row, but not the second row.\nIf the `clear` action button appears on a merged column, then clicking\non that button will clear *all* of the merged columns associated with it.\nUnlike `column.deletable`, this action does not remove the column(s)\nfrom the table. It only removed the associated entries from `data`.",
"required": false
},
"deletable": {
"name": "union",
"value": [
{
"name": "enum",
"value": [
{
"value": "'first'",
"computed": false
},
{
"value": "'last'",
"computed": false
}
]
},
{
"name": "bool"
},
{
"name": "arrayOf",
"value": {
"name": "bool"
}
}
],
"description": "If true, the user can remove the column by clicking on the `delete`\naction button on the column. If there are multiple header rows, true\nwill display the action button on each row.\nIf `last`, the `delete` action button will only appear on the last header\nrow. If `first` it will only appear on the first header row. These\nare respectively shortcut equivalents to `[false, ..., false, true]` and\n`[true, false, ..., false]`.\nIf there are merged, multi-header columns then you can choose\nwhich column header row to display the `delete` action button in by\nsupplying an array of booleans.\nFor example, `[true, false]` will display the `delete` action button\non the first row, but not the second row.\nIf the `delete` action button appears on a merged column, then clicking\non that button will remove *all* of the merged columns associated with it.",
"required": false
},
"editable": {
"name": "bool",
"description": "There are two `editable` flags in the table.\nThis is the column-level editable flag and there is\nalso the table-level `editable` flag.\nThese flags determine whether the contents of the table\nare editable or not.\nIf the column-level `editable` flag is set it overrides\nthe table-level `editable` flag for that column.",
"required": false
},
"hideable": {
"name": "union",
"value": [
{
"name": "enum",
"value": [
{
"value": "'first'",
"computed": false
},
{
"value": "'last'",
"computed": false
}
]
},
{
"name": "bool"
},
{
"name": "arrayOf",
"value": {
"name": "bool"
}
}
],
"description": "If true, the user can hide the column by clicking on the `hide`\naction button on the column. If there are multiple header rows, true\nwill display the action button on each row.\nIf `last`, the `hide` action button will only appear on the last header\nrow. If `first` it will only appear on the first header row. These\nare respectively shortcut equivalents to `[false, ..., false, true]` and\n`[true, false, ..., false]`.\nIf there are merged, multi-header columns then you can choose\nwhich column header row to display the `hide` action button in by\nsupplying an array of booleans.\nFor example, `[true, false]` will display the `hide` action button\non the first row, but not the second row.\nIf the `hide` action button appears on a merged column, then clicking\non that button will hide *all* of the merged columns associated with it.",
"required": false
},
"renamable": {
"name": "union",
"value": [
{
"name": "enum",
"value": [
{
"value": "'first'",
"computed": false
},
{
"value": "'last'",
"computed": false
}
]
},
{
"name": "bool"
},
{
"name": "arrayOf",
"value": {
"name": "bool"
}
}
],
"description": "If true, the user can rename the column by clicking on the `rename`\naction button on the column. If there are multiple header rows, true\nwill display the action button on each row.\nIf `last`, the `rename` action button will only appear on the last header\nrow. If `first` it will only appear on the first header row. These\nare respectively shortcut equivalents to `[false, ..., false, true]` and\n`[true, false, ..., false]`.\nIf there are merged, multi-header columns then you can choose\nwhich column header row to display the `rename` action button in by\nsupplying an array of booleans.\nFor example, `[true, false]` will display the `rename` action button\non the first row, but not the second row.\nIf the `rename` action button appears on a merged column, then clicking\non that button will rename *all* of the merged columns associated with it.",
"required": false
},
"selectable": {
"name": "union",
"value": [
{
"name": "enum",
"value": [
{
"value": "'first'",
"computed": false
},
{
"value": "'last'",
"computed": false
}
]
},
{
"name": "bool"
},
{
"name": "arrayOf",
"value": {
"name": "bool"
}
}
],
"description": "If true, the user can select the column by clicking on the checkbox or radio button\nin the column. If there are multiple header rows, true will display the input\non each row.\nIf `last`, the input will only appear on the last header row. If `first` it will only\nappear on the first header row. These are respectively shortcut equivalents to\n`[false, ..., false, true]` and `[true, false, ..., false]`.\nIf there are merged, multi-header columns then you can choose which column header\nrow to display the input in by supplying an array of booleans.\nFor example, `[true, false]` will display the `selectable` input on the first row,\nbut now on the second row.\nIf the `selectable` input appears on a merged columns, then clicking on that input\nwill select *all* of the merged columns associated with it.\nThe table-level prop `column_selectable` is used to determine the type of column\nselection to use.",
"required": false
},
"format": {
"name": "exact",
"value": {
"locale": {
"name": "exact",
"value": {
"symbol": {
"name": "arrayOf",
"value": {
"name": "string"
},
"required": false
},
"decimal": {
"name": "string",
"required": false
},
"group": {
"name": "string",
"required": false
},
"grouping": {
"name": "arrayOf",
"value": {
"name": "number"
},
"required": false
},
"numerals": {
"name": "arrayOf",
"value": {
"name": "string"
},
"required": false
},
"percent": {
"name": "string",
"required": false
},
"separate_4digits": {
"name": "bool",
"required": false
}
},
"required": false
},
"nully": {
"name": "any",
"required": false
},
"prefix": {
"name": "number",
"required": false
},
"specifier": {
"name": "string",
"required": false
}
},
"description": "The formatting applied to the column's data.\nThis prop is derived from the [d3-format](https://github.com/d3/d3-format) library specification. Apart from\nbeing structured slightly differently (under a single prop), the usage\nis the same.\n'locale': represents localization specific formatting information.\n When left unspecified, will use the default value provided by d3-format.\n The keys are as follows:\n 'symbol': (default: ['$', '']) a list of two strings representing the\n prefix and suffix symbols. Typically used for currency, and implemented using d3's\n currency format, but you can use this for other symbols such as measurement units;\n 'decimal': (default: '.') the string used for the decimal separator;\n 'group': (default: ',') the string used for the groups separator;\n 'grouping': (default: [3]) a list of integers representing the grouping pattern.\n 'numerals': a list of ten strings used as replacements for numbers 0-9;\n 'percent': (default: '%') the string used for the percentage symbol;\n 'separate_4digits': (default: True) separate integers with 4-digits or less.\n'nully': a value that will be used in place of the nully value during formatting.\n If the value type matches the column type, it will be formatted normally.\n'prefix': a number representing the SI unit to use during formatting.\n See `dash_table.Format.Prefix` enumeration for the list of valid values\n'specifier': (default: '') represents the rules to apply when formatting the number.\ndash_table.FormatTemplate contains helper functions to rapidly use certain\ntypical number formats.",
"required": false
},
"id": {
"name": "string",
"description": "The `id` of the column.\nThe column `id` is used to match cells in data\nwith particular columns.\nThe `id` is not visible in the table.",
"required": true
},
"name": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "arrayOf",
"value": {
"name": "string"
}
}
],
"description": "The `name` of the column,\nas it appears in the column header.\nIf `name` is a list of strings, then the columns\nwill render with multiple headers rows.",
"required": true
},
"presentation": {
"name": "enum",
"value": [
{
"value": "'input'",
"computed": false
},
{
"value": "'dropdown'",
"computed": false
},
{
"value": "'markdown'",
"computed": false
}
],
"description": "The `presentation` to use to display the value.\nDefaults to 'input' for ['datetime', 'numeric', 'text', 'any'].",
"required": false
},
"on_change": {
"name": "exact",
"value": {
"action": {
"name": "enum",
"value": [
{
"value": "'coerce'",
"computed": false
},
{
"value": "'none'",
"computed": false
},
{
"value": "'validate'",
"computed": false
}
],
"required": false
},
"failure": {
"name": "enum",
"value": [
{
"value": "'accept'",
"computed": false
},
{
"value": "'default'",
"computed": false
},
{
"value": "'reject'",
"computed": false
}
],
"required": false
}
},
"description": "The `on_change` behavior of the column for user-initiated modifications.\n'action' (default 'coerce'):\n none: do not validate data;\n coerce: check if the data corresponds to the destination type and\n attempts to coerce it into the destination type if not;\n validate: check if the data corresponds to the destination type (no coercion).\n'failure' (default 'reject'): what to do with the value if the action fails:\n accept: use the invalid value;\n default: replace the provided value with `validation.default`;\n reject: do not modify the existing value.",
"required": false
},
"sort_as_null": {
"name": "arrayOf",
"value": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "number"
},
{
"name": "bool"
}
]
},
"description": "An array of string, number and boolean values that are treated as `null`\n(i.e. ignored and always displayed last) when sorting.\nThis value overrides the table-level `sort_as_null`.",
"required": false
},
"validation": {
"name": "exact",
"value": {
"allow_null": {
"name": "bool",
"required": false
},
"default": {
"name": "any",
"required": false
},
"allow_YY": {
"name": "bool",
"required": false
}
},
"description": "The `validation` options.\n'allow_null': Allow the use of nully values. (undefined, null, NaN) (default: false)\n'default': The default value to apply with on_change.failure = 'default'. (default: null)\n'allow_YY': `datetime` columns only, allow 2-digit years (default: false).\n If true, we interpret years as ranging from now-70 to now+29 - in 2019\n this is 1949 to 2048 but in 2020 it will be different. If used with\n `action: 'coerce'`, will convert user input to a 4-digit year.",
"required": false
},
"type": {
"name": "enum",
"value": [
{
"value": "'any'",
"computed": false
},
{
"value": "'numeric'",
"computed": false
},
{
"value": "'text'",
"computed": false
},
{
"value": "'datetime'",
"computed": false
}
],
"description": "The data-type of the column's data.\n'numeric': represents both floats and ints.\n'text': represents a string.\n'datetime': a string representing a date or date-time, in the form:\n 'YYYY-MM-DD HH:MM:SS.ssssss' or some truncation thereof. Years must\n have 4 digits, unless you use `validation.allow_YY: true`. Also\n accepts 'T' or 't' between date and time, and allows timezone info\n at the end. To convert these strings to Python `datetime` objects,\n use `dateutil.parser.isoparse`. In R use `parse_iso_8601` from the\n `parsedate` library.\n WARNING: these parsers do not work with 2-digit years, if you use\n `validation.allow_YY: true` and do not coerce to 4-digit years.\n And parsers that do work with 2-digit years may make a different\n guess about the century than we make on the front end.\n'any': represents any type of data.\nDefaults to 'any' if undefined.\nNOTE: This feature has not been fully implemented.\nIn the future, it's data types will impact things like\ntext formatting options in the cell (e.g. display 2 decimals\nfor a number), filtering options and behavior, and editing\nbehavior.\nStay tuned by following [https://github.com/plotly/dash-table/issues/166](https://github.com/plotly/dash-table/issues/166)",
"required": false
}
}
}
},
"required": false,
"description": "Columns describes various aspects about each individual column.\n`name` and `id` are the only required parameters.",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"include_headers_on_copy_paste": {
"type": {
"name": "bool"
},
"required": false,
"description": "If true, headers are included when copying from the table to different\ntabs and elsewhere. Note that headers are ignored when copying from the table onto itself and\nbetween two tables within the same tab.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"locale_format": {
"type": {
"name": "exact",
"value": {
"symbol": {
"name": "arrayOf",
"value": {
"name": "string"
},
"required": false
},
"decimal": {
"name": "string",
"required": false
},
"group": {
"name": "string",
"required": false
},
"grouping": {
"name": "arrayOf",
"value": {
"name": "number"
},
"required": false
},
"numerals": {
"name": "arrayOf",
"value": {
"name": "string"
},
"required": false
},
"percent": {
"name": "string",
"required": false
},
"separate_4digits": {
"name": "bool",
"required": false
}
}
},
"required": false,
"description": "The localization specific formatting information applied to all columns in the table.\nThis prop is derived from the [d3.formatLocale](https://github.com/d3/d3-format#formatLocale) data structure specification.\nWhen left unspecified, each individual nested prop will default to a pre-determined value.\n 'symbol': (default: ['$', '']) a list of two strings representing the\n prefix and suffix symbols. Typically used for currency, and implemented using d3's\n currency format, but you can use this for other symbols such as measurement units.\n 'decimal': (default: '.') the string used for the decimal separator.\n 'group': (default: ',') the string used for the groups separator.\n 'grouping': (default: [3]) a list of integers representing the grouping pattern.\n 'numerals': a list of ten strings used as replacements for numbers 0-9.\n 'percent': (default: '%') the string used for the percentage symbol.\n 'separate_4digits': (default: True) separate integers with 4-digits or less."
},
"css": {
"type": {
"name": "arrayOf",
"value": {
"name": "exact",
"value": {
"selector": {
"name": "string",
"required": true
},
"rule": {
"name": "string",
"required": true
}
}
}
},
"required": false,
"description": "The `css` property is a way to embed CSS selectors and rules\nonto the page.\nWe recommend starting with the `style_*` properties\nbefore using this `css` property.\nExample:\n[\n {\"selector\": \".dash-spreadsheet\", \"rule\": 'font-family: \"monospace\"'}\n]",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"data": {
"type": {
"name": "arrayOf",
"value": {
"name": "object"
}
},
"required": false,
"description": "The contents of the table.\nThe keys of each item in data should match the column IDs.\nEach item can also have an 'id' key, whose value is its row ID. If there\nis a column with ID='id' this will display the row ID, otherwise it is\njust used to reference the row for selections, filtering, etc.\nExample:\n[\n {'column-1': 4.5, 'column-2': 'montreal', 'column-3': 'canada'},\n {'column-1': 8, 'column-2': 'boston', 'column-3': 'america'}\n]",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"data_previous": {
"type": {
"name": "arrayOf",
"value": {
"name": "object"
}
},
"required": false,
"description": "The previous state of `data`. `data_previous`\nhas the same structure as `data` and it will be updated\nwhenever `data` changes, either through a callback or\nby editing the table.\nThis is a read-only property: setting this property will not\nhave any impact on the table."
},
"data_timestamp": {
"type": {
"name": "number"
},
"required": false,
"description": "The unix timestamp when the data was last edited.\nUse this property with other timestamp properties\n(such as `n_clicks_timestamp` in `dash_html_components`)\nto determine which property has changed within a callback."
},
"editable": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, then the data in all of the cells is editable.\nWhen `editable` is True, particular columns can be made\nuneditable by setting `editable` to `False` inside the `columns`\nproperty.\nIf False, then the data in all of the cells is uneditable.\nWhen `editable` is False, particular columns can be made\neditable by setting `editable` to `True` inside the `columns`\nproperty.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"end_cell": {
"type": {
"name": "exact",
"value": {
"row": {
"name": "number",
"required": false
},
"column": {
"name": "number",
"required": false
},
"row_id": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "number"
}
],
"required": false
},
"column_id": {
"name": "string",
"required": false
}
}
},
"required": false,
"description": "When selecting multiple cells\n(via clicking on a cell and then shift-clicking on another cell),\n`end_cell` represents the row / column coordinates and IDs of the cell\nin one of the corners of the region.\n`start_cell` represents the coordinates of the other corner."
},
"export_columns": {
"type": {
"name": "enum",
"value": [
{
"value": "'all'",
"computed": false
},
{
"value": "'visible'",
"computed": false
}
]
},
"required": false,
"description": "Denotes the columns that will be used in the export data file.\nIf `all`, all columns will be used (visible + hidden). If `visible`,\nonly the visible columns will be used. Defaults to `visible`.",
"defaultValue": {
"value": "'visible'",
"computed": false
}
},
"export_format": {
"type": {
"name": "enum",
"value": [
{
"value": "'csv'",
"computed": false
},
{
"value": "'xlsx'",
"computed": false
},
{
"value": "'none'",
"computed": false
}
]
},
"required": false,
"description": "Denotes the type of the export data file,\nDefaults to `'none'`",
"defaultValue": {
"value": "'none'",
"computed": false
}
},
"export_headers": {
"type": {
"name": "enum",
"value": [
{
"value": "'none'",
"computed": false
},
{
"value": "'ids'",
"computed": false
},
{
"value": "'names'",
"computed": false
},
{
"value": "'display'",
"computed": false
}
]
},
"required": false,
"description": "Denotes the format of the headers in the export data file.\nIf `'none'`, there will be no header. If `'display'`, then the header\nof the data file will be be how it is currently displayed. Note that\n`'display'` is only supported for `'xlsx'` export_format and will behave\nlike `'names'` for `'csv'` export format. If `'ids'` or `'names'`,\nthen the headers of data file will be the column id or the column\nnames, respectively"
},
"fill_width": {
"type": {
"name": "bool"
},
"required": false,
"description": "`fill_width` toggles between a set of CSS for two common behaviors:\nTrue: The table container's width will grow to fill the available space;\nFalse: The table container's width will equal the width of its content.",
"defaultValue": {
"value": "true",
"computed": false
}
},
"hidden_columns": {
"type": {
"name": "arrayOf",
"value": {
"name": "string"
}
},
"required": false,
"description": "List of columns ids of the columns that are currently hidden.\nSee the associated nested prop `columns.hideable`."
},
"id": {
"type": {
"name": "string"
},
"required": false,
"description": "The ID of the table."
},
"is_focused": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, then the `active_cell` is in a focused state."
},
"merge_duplicate_headers": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, then column headers that have neighbors with duplicate names\nwill be merged into a single cell.\nThis will be applied for single column headers and multi-column\nheaders."
},
"fixed_columns": {
"type": {
"name": "union",
"value": [
{
"name": "exact",
"value": {
"headers": {
"name": "enum",
"value": [
{
"value": "false",
"computed": false
}
],
"required": false
},
"data": {
"name": "enum",
"value": [
{
"value": "0",
"computed": false
}
],
"required": false
}
}
},
{
"name": "exact",
"value": {
"headers": {
"name": "enum",
"value": [
{
"value": "true",
"computed": false
}
],
"required": true
},
"data": {
"name": "number",
"required": false
}
}
}
]
},
"required": false,
"description": "`fixed_columns` will \"fix\" the set of columns so that\nthey remain visible when scrolling horizontally across\nthe unfixed columns. `fixed_columns` fixes columns\nfrom left-to-right.\nIf `headers` is False, no columns are fixed.\nIf `headers` is True, all operation columns (see `row_deletable` and `row_selectable`)\nare fixed. Additional data columns can be fixed by\nassigning a number to `data`.\nDefaults to `{ headers: False }`.\nNote that fixing columns introduces some changes to the\nunderlying markup of the table and may impact the\nway that your columns are rendered or sized.\nView the documentation examples to learn more.",
"defaultValue": {
"value": "{\n headers: false,\n data: 0\n}",
"computed": false
}
},
"fixed_rows": {
"type": {
"name": "union",
"value": [
{
"name": "exact",
"value": {
"headers": {
"name": "enum",
"value": [
{
"value": "false",
"computed": false
}
],
"required": false
},
"data": {
"name": "enum",
"value": [
{
"value": "0",
"computed": false
}
],
"required": false
}
}
},
{
"name": "exact",
"value": {
"headers": {
"name": "enum",
"value": [
{
"value": "true",
"computed": false
}
],
"required": true
},
"data": {
"name": "number",
"required": false
}
}
}
]
},
"required": false,
"description": "`fixed_rows` will \"fix\" the set of rows so that\nthey remain visible when scrolling vertically down\nthe table. `fixed_rows` fixes rows\nfrom top-to-bottom, starting from the headers.\nIf `headers` is False, no rows are fixed.\nIf `headers` is True, all header and filter rows (see `filter_action`) are\nfixed. Additional data rows can be fixed by assigning\na number to `data`.\nDefaults to `{ headers: False }`.\nNote that fixing rows introduces some changes to the\nunderlying markup of the table and may impact the\nway that your columns are rendered or sized.\nView the documentation examples to learn more.",
"defaultValue": {
"value": "{\n headers: false,\n data: 0\n}",
"computed": false
}
},
"column_selectable": {
"type": {
"name": "enum",
"value": [
{
"value": "'single'",
"computed": false
},
{
"value": "'multi'",
"computed": false
},
{
"value": "false",
"computed": false
}
]
},
"required": false,
"description": "If `single`, then the uer can select a single column or group\nof merged columns via the radio button that will appear in the\nheader rows.\nIf `multi`, then the user can select multiple columns or groups\nof merged columns via the checkbox that will appear in the header\nrows.\nIf false, then the user will not be able to select columns and no\ninput will appear in the header rows.\nWhen a column is selected, its id will be contained in `selected_columns`\nand `derived_viewport_selected_columns`.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"row_deletable": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, then a `x` will appear next to each `row`\nand the user can delete the row."
},
"row_selectable": {
"type": {
"name": "enum",
"value": [
{
"value": "'single'",
"computed": false
},
{
"value": "'multi'",
"computed": false
},
{
"value": "false",
"computed": false
}
]
},
"required": false,
"description": "If `single`, then the user can select a single row\nvia a radio button that will appear next to each row.\nIf `multi`, then the user can select multiple rows\nvia a checkbox that will appear next to each row.\nIf false, then the user will not be able to select rows\nand no additional UI elements will appear.\nWhen a row is selected, its index will be contained\nin `selected_rows`.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"selected_cells": {
"type": {
"name": "arrayOf",
"value": {
"name": "exact",
"value": {
"row": {
"name": "number",
"required": false
},
"column": {
"name": "number",
"required": false
},
"row_id": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "number"
}
],
"required": false
},
"column_id": {
"name": "string",
"required": false
}
}
}
},
"required": false,
"description": "`selected_cells` represents the set of cells that are selected,\nas an array of objects, each item similar to `active_cell`.\nMultiple cells can be selected by holding down shift and\nclicking on a different cell or holding down shift and navigating\nwith the arrow keys.",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"selected_rows": {
"type": {
"name": "arrayOf",
"value": {
"name": "number"
}
},
"required": false,
"description": "`selected_rows` contains the indices of rows that\nare selected via the UI elements that appear when\n`row_selectable` is `'single'` or `'multi'`.",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"selected_columns": {
"type": {
"name": "arrayOf",
"value": {
"name": "string"
}
},
"required": false,
"description": "`selected_columns` contains the ids of columns that\nare selected via the UI elements that appear when\n`column_selectable` is `'single' or 'multi'`.",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"selected_row_ids": {
"type": {
"name": "arrayOf",
"value": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "number"
}
]
}
},
"required": false,
"description": "`selected_row_ids` contains the ids of rows that\nare selected via the UI elements that appear when\n`row_selectable` is `'single'` or `'multi'`.",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"setProps": {
"type": {
"name": "func"
},
"required": false,
"description": "Dash-assigned callback that gets fired when the user makes changes."
},
"start_cell": {
"type": {
"name": "exact",
"value": {
"row": {
"name": "number",
"required": false
},
"column": {
"name": "number",
"required": false
},
"row_id": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "number"
}
],
"required": false
},
"column_id": {
"name": "string",
"required": false
}
}
},
"required": false,
"description": "When selecting multiple cells\n(via clicking on a cell and then shift-clicking on another cell),\n`start_cell` represents the [row, column] coordinates of the cell\nin one of the corners of the region.\n`end_cell` represents the coordinates of the other corner."
},
"style_as_list_view": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, then the table will be styled like a list view\nand not have borders between the columns.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"page_action": {
"type": {
"name": "enum",
"value": [
{
"value": "'custom'",
"computed": false
},