tinybase 8.1.0-beta.4 → 8.1.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/@types/ui-svelte/index.d.ts +452 -361
- package/@types/ui-svelte/with-schemas/index.d.ts +447 -359
- package/min/ui-svelte/index.js +1 -1
- package/min/ui-svelte/index.js.gz +0 -0
- package/min/ui-svelte/with-schemas/index.js +1 -1
- package/min/ui-svelte/with-schemas/index.js.gz +0 -0
- package/package.json +1 -1
- package/readme.md +2 -2
- package/releases.md +7 -7
- package/ui-svelte/index.js +121 -121
- package/ui-svelte/with-schemas/index.js +121 -121
|
@@ -141,17 +141,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
141
141
|
* Metrics | Id;
|
|
142
142
|
* ```
|
|
143
143
|
*
|
|
144
|
-
* In some simple cases you will already have a direct reference to the
|
|
145
|
-
*
|
|
144
|
+
* In some simple cases you will already have a direct reference to the Metrics
|
|
145
|
+
* object.
|
|
146
146
|
*
|
|
147
147
|
* This module also includes a Provider component that can be used to wrap
|
|
148
148
|
* multiple Metrics objects into a context that can be used throughout the app.
|
|
149
|
-
* In this case you will want to refer to a Metrics object by its Id in
|
|
150
|
-
*
|
|
149
|
+
* In this case you will want to refer to a Metrics object by its Id in that
|
|
150
|
+
* context.
|
|
151
151
|
*
|
|
152
152
|
* Many functions and components in this ui-svelte module take this type as a
|
|
153
|
-
* parameter or a prop, allowing you to pass in either the Metrics object or
|
|
154
|
-
*
|
|
153
|
+
* parameter or a prop, allowing you to pass in either the Metrics object or its
|
|
154
|
+
* Id.
|
|
155
155
|
* @category Identity
|
|
156
156
|
* @since v8.1.0
|
|
157
157
|
*/
|
|
@@ -167,17 +167,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
167
167
|
* Indexes | Id;
|
|
168
168
|
* ```
|
|
169
169
|
*
|
|
170
|
-
* In some simple cases you will already have a direct reference to the
|
|
171
|
-
*
|
|
170
|
+
* In some simple cases you will already have a direct reference to the Indexes
|
|
171
|
+
* object.
|
|
172
172
|
*
|
|
173
173
|
* This module also includes a Provider component that can be used to wrap
|
|
174
174
|
* multiple Indexes objects into a context that can be used throughout the app.
|
|
175
|
-
* In this case you will want to refer to an Indexes object by its Id in
|
|
176
|
-
*
|
|
175
|
+
* In this case you will want to refer to an Indexes object by its Id in that
|
|
176
|
+
* context.
|
|
177
177
|
*
|
|
178
178
|
* Many functions and components in this ui-svelte module take this type as a
|
|
179
|
-
* parameter or a prop, allowing you to pass in either the Indexes object or
|
|
180
|
-
*
|
|
179
|
+
* parameter or a prop, allowing you to pass in either the Indexes object or its
|
|
180
|
+
* Id.
|
|
181
181
|
* @category Identity
|
|
182
182
|
* @since v8.1.0
|
|
183
183
|
*/
|
|
@@ -219,17 +219,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
219
219
|
* Queries | Id;
|
|
220
220
|
* ```
|
|
221
221
|
*
|
|
222
|
-
* In some simple cases you will already have a direct reference to the
|
|
223
|
-
*
|
|
222
|
+
* In some simple cases you will already have a direct reference to the Queries
|
|
223
|
+
* object.
|
|
224
224
|
*
|
|
225
225
|
* This module also includes a Provider component that can be used to wrap
|
|
226
226
|
* multiple Queries objects into a context that can be used throughout the app.
|
|
227
|
-
* In this case you will want to refer to a Queries object by its Id in
|
|
228
|
-
*
|
|
227
|
+
* In this case you will want to refer to a Queries object by its Id in that
|
|
228
|
+
* context.
|
|
229
229
|
*
|
|
230
230
|
* Many functions and components in this ui-svelte module take this type as a
|
|
231
|
-
* parameter or a prop, allowing you to pass in either the Queries object or
|
|
232
|
-
*
|
|
231
|
+
* parameter or a prop, allowing you to pass in either the Queries object or its
|
|
232
|
+
* Id.
|
|
233
233
|
* @category Identity
|
|
234
234
|
* @since v8.1.0
|
|
235
235
|
*/
|
|
@@ -305,8 +305,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
305
305
|
* in that context.
|
|
306
306
|
*
|
|
307
307
|
* Many functions and components in this ui-svelte module take this type as a
|
|
308
|
-
* parameter or a prop, allowing you to pass in either the Synchronizer or
|
|
309
|
-
*
|
|
308
|
+
* parameter or a prop, allowing you to pass in either the Synchronizer or its
|
|
309
|
+
* Id.
|
|
310
310
|
* @category Identity
|
|
311
311
|
* @since v8.1.0
|
|
312
312
|
*/
|
|
@@ -314,8 +314,9 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
314
314
|
|
|
315
315
|
/**
|
|
316
316
|
* ProviderProps props are used with the Provider component, so that Store,
|
|
317
|
-
* Metrics, Indexes, Relationships, Queries,
|
|
318
|
-
* passed into the context of a Svelte 5 application and
|
|
317
|
+
* Metrics, Indexes, Relationships, Queries, Checkpoints, Persisters, and
|
|
318
|
+
* Synchronizers can be passed into the context of a Svelte 5 application and
|
|
319
|
+
* used throughout.
|
|
319
320
|
*
|
|
320
321
|
* One of each type of object can be provided as a default within the context.
|
|
321
322
|
* Additionally, multiple of each type of object can be provided in an Id-keyed
|
|
@@ -436,47 +437,44 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
436
437
|
* @since v8.1.0
|
|
437
438
|
*/
|
|
438
439
|
readonly synchronizersById?: {readonly [id: Id]: Synchronizer<Schemas>};
|
|
439
|
-
/**
|
|
440
|
-
* The `children` prop of a ProviderProps object — the app subtree that will
|
|
441
|
-
* have access to the provided context.
|
|
442
|
-
* @category Prop
|
|
443
|
-
* @since v8.1.0
|
|
444
|
-
*/
|
|
445
440
|
readonly children: Snippet;
|
|
446
441
|
};
|
|
447
442
|
|
|
448
443
|
/**
|
|
449
|
-
*
|
|
444
|
+
* CellViewProps props are used for components that refer to a single Cell in a
|
|
445
|
+
* Row, such as the CellView component.
|
|
450
446
|
* @category Props
|
|
451
447
|
* @since v8.1.0
|
|
452
448
|
*/
|
|
453
449
|
CellViewProps: {
|
|
454
450
|
/**
|
|
455
|
-
* The
|
|
451
|
+
* The Id of the Table in the Store.
|
|
456
452
|
* @category Props
|
|
457
453
|
* @since v8.1.0
|
|
458
454
|
*/
|
|
459
455
|
readonly tableId: TableIdFromSchema<Schemas[0]>;
|
|
460
456
|
/**
|
|
461
|
-
* The
|
|
457
|
+
* The Id of the Row in the Table.
|
|
462
458
|
* @category Props
|
|
463
459
|
* @since v8.1.0
|
|
464
460
|
*/
|
|
465
461
|
readonly rowId: Id;
|
|
466
462
|
/**
|
|
467
|
-
* The
|
|
463
|
+
* The Id of the Cell in the Row to be rendered.
|
|
468
464
|
* @category Props
|
|
469
465
|
* @since v8.1.0
|
|
470
466
|
*/
|
|
471
467
|
readonly cellId: AllCellIdFromSchema<Schemas[0]>;
|
|
472
468
|
/**
|
|
473
|
-
* The
|
|
469
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
470
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
474
471
|
* @category Props
|
|
475
472
|
* @since v8.1.0
|
|
476
473
|
*/
|
|
477
474
|
readonly store?: StoreOrStoreId<Schemas>;
|
|
478
475
|
/**
|
|
479
|
-
*
|
|
476
|
+
* Whether the component should also render the Id of the Cell to assist with
|
|
477
|
+
* debugging.
|
|
480
478
|
* @category Props
|
|
481
479
|
* @since v8.1.0
|
|
482
480
|
*/
|
|
@@ -484,25 +482,28 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
484
482
|
};
|
|
485
483
|
|
|
486
484
|
/**
|
|
487
|
-
*
|
|
485
|
+
* ValueViewProps props are used for components that refer to a single Value in
|
|
486
|
+
* a Store, such as the ValueView component.
|
|
488
487
|
* @category Props
|
|
489
488
|
* @since v8.1.0
|
|
490
489
|
*/
|
|
491
490
|
ValueViewProps: {
|
|
492
491
|
/**
|
|
493
|
-
* The
|
|
492
|
+
* The Id of the Value in the Store to be rendered.
|
|
494
493
|
* @category Props
|
|
495
494
|
* @since v8.1.0
|
|
496
495
|
*/
|
|
497
496
|
readonly valueId: ValueIdFromSchema<Schemas[1]>;
|
|
498
497
|
/**
|
|
499
|
-
* The
|
|
498
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
499
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
500
500
|
* @category Props
|
|
501
501
|
* @since v8.1.0
|
|
502
502
|
*/
|
|
503
503
|
readonly store?: StoreOrStoreId<Schemas>;
|
|
504
504
|
/**
|
|
505
|
-
*
|
|
505
|
+
* Whether the component should also render the Id of the Value to assist
|
|
506
|
+
* with debugging.
|
|
506
507
|
* @category Props
|
|
507
508
|
* @since v8.1.0
|
|
508
509
|
*/
|
|
@@ -510,25 +511,29 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
510
511
|
};
|
|
511
512
|
|
|
512
513
|
/**
|
|
513
|
-
*
|
|
514
|
+
* MetricViewProps props are used for components that refer to a single Metric
|
|
515
|
+
* in a Metrics object, such as the MetricView component.
|
|
514
516
|
* @category Props
|
|
515
517
|
* @since v8.1.0
|
|
516
518
|
*/
|
|
517
519
|
MetricViewProps: {
|
|
518
520
|
/**
|
|
519
|
-
* The
|
|
521
|
+
* The Id of the Metric in the Metrics object to be rendered.
|
|
520
522
|
* @category Props
|
|
521
523
|
* @since v8.1.0
|
|
522
524
|
*/
|
|
523
525
|
readonly metricId: Id;
|
|
524
526
|
/**
|
|
525
|
-
* The
|
|
527
|
+
* The Metrics object to be accessed: omit for the default context Metrics
|
|
528
|
+
* object, provide an Id for a named context Metrics object, or provide an
|
|
529
|
+
* explicit reference.
|
|
526
530
|
* @category Props
|
|
527
531
|
* @since v8.1.0
|
|
528
532
|
*/
|
|
529
533
|
readonly metrics?: MetricsOrMetricsId<Schemas>;
|
|
530
534
|
/**
|
|
531
|
-
*
|
|
535
|
+
* Whether the component should also render the Id of the Metric to assist
|
|
536
|
+
* with debugging.
|
|
532
537
|
* @category Props
|
|
533
538
|
* @since v8.1.0
|
|
534
539
|
*/
|
|
@@ -536,26 +541,29 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
536
541
|
};
|
|
537
542
|
|
|
538
543
|
/**
|
|
539
|
-
*
|
|
540
|
-
* CheckpointView component.
|
|
544
|
+
* CheckpointViewProps props are used for components that refer to a single
|
|
545
|
+
* checkpoint in a Checkpoints object, such as the CheckpointView component.
|
|
541
546
|
* @category Props
|
|
542
547
|
* @since v8.1.0
|
|
543
548
|
*/
|
|
544
549
|
CheckpointViewProps: {
|
|
545
550
|
/**
|
|
546
|
-
* The
|
|
551
|
+
* The Id of the checkpoint in the Checkpoints object.
|
|
547
552
|
* @category Props
|
|
548
553
|
* @since v8.1.0
|
|
549
554
|
*/
|
|
550
555
|
readonly checkpointId: Id;
|
|
551
556
|
/**
|
|
552
|
-
* The
|
|
557
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
558
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
559
|
+
* or provide an explicit reference.
|
|
553
560
|
* @category Props
|
|
554
561
|
* @since v8.1.0
|
|
555
562
|
*/
|
|
556
563
|
readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
|
|
557
564
|
/**
|
|
558
|
-
*
|
|
565
|
+
* Whether the component should also render the Id of the checkpoint to
|
|
566
|
+
* assist with debugging.
|
|
559
567
|
* @category Props
|
|
560
568
|
* @since v8.1.0
|
|
561
569
|
*/
|
|
@@ -563,49 +571,54 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
563
571
|
};
|
|
564
572
|
|
|
565
573
|
/**
|
|
566
|
-
*
|
|
574
|
+
* RowViewProps props are used for components that refer to a single Row in a
|
|
575
|
+
* Table, such as the RowView component.
|
|
567
576
|
* @category Props
|
|
568
577
|
* @since v8.1.0
|
|
569
578
|
*/
|
|
570
579
|
RowViewProps: {
|
|
571
580
|
/**
|
|
572
|
-
* The
|
|
581
|
+
* The Id of the Table in the Store.
|
|
573
582
|
* @category Props
|
|
574
583
|
* @since v8.1.0
|
|
575
584
|
*/
|
|
576
585
|
readonly tableId: TableIdFromSchema<Schemas[0]>;
|
|
577
586
|
/**
|
|
578
|
-
* The
|
|
587
|
+
* The Id of the Row in the Table to be rendered.
|
|
579
588
|
* @category Props
|
|
580
589
|
* @since v8.1.0
|
|
581
590
|
*/
|
|
582
591
|
readonly rowId: Id;
|
|
583
592
|
/**
|
|
584
|
-
* The
|
|
593
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
594
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
585
595
|
* @category Props
|
|
586
596
|
* @since v8.1.0
|
|
587
597
|
*/
|
|
588
598
|
readonly store?: StoreOrStoreId<Schemas>;
|
|
589
599
|
/**
|
|
590
|
-
*
|
|
600
|
+
* An optional list of Cell Ids to use for rendering a prescribed set of the
|
|
601
|
+
* Row's Cells in a given order.
|
|
591
602
|
* @category Props
|
|
592
603
|
* @since v8.1.0
|
|
593
604
|
*/
|
|
594
605
|
readonly customCellIds?: Ids;
|
|
595
606
|
/**
|
|
596
|
-
*
|
|
607
|
+
* A component or string to separate each rendered Cell.
|
|
597
608
|
* @category Props
|
|
598
609
|
* @since v8.1.0
|
|
599
610
|
*/
|
|
600
611
|
readonly separator?: Snippet<[]>;
|
|
601
612
|
/**
|
|
602
|
-
*
|
|
613
|
+
* Whether the component should also render the Id of the Row, and its
|
|
614
|
+
* descendent objects, to assist with debugging.
|
|
603
615
|
* @category Props
|
|
604
616
|
* @since v8.1.0
|
|
605
617
|
*/
|
|
606
618
|
readonly debugIds?: boolean;
|
|
607
619
|
/**
|
|
608
|
-
*
|
|
620
|
+
* A snippet for rendering each Cell in the Row, to override the default
|
|
621
|
+
* CellView component.
|
|
609
622
|
* @category Props
|
|
610
623
|
* @since v8.1.0
|
|
611
624
|
*/
|
|
@@ -613,43 +626,48 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
613
626
|
};
|
|
614
627
|
|
|
615
628
|
/**
|
|
616
|
-
*
|
|
629
|
+
* TableViewProps props are used for components that refer to a single Table in
|
|
630
|
+
* a Store, such as the TableView component.
|
|
617
631
|
* @category Props
|
|
618
632
|
* @since v8.1.0
|
|
619
633
|
*/
|
|
620
634
|
TableViewProps: {
|
|
621
635
|
/**
|
|
622
|
-
* The
|
|
636
|
+
* The Id of the Table in the Store to be rendered.
|
|
623
637
|
* @category Props
|
|
624
638
|
* @since v8.1.0
|
|
625
639
|
*/
|
|
626
640
|
readonly tableId: TableIdFromSchema<Schemas[0]>;
|
|
627
641
|
/**
|
|
628
|
-
* The
|
|
642
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
643
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
629
644
|
* @category Props
|
|
630
645
|
* @since v8.1.0
|
|
631
646
|
*/
|
|
632
647
|
readonly store?: StoreOrStoreId<Schemas>;
|
|
633
648
|
/**
|
|
634
|
-
*
|
|
649
|
+
* An optional list of Cell Ids to use for rendering a prescribed set of the
|
|
650
|
+
* Table's Cells in a given order for each Row.
|
|
635
651
|
* @category Props
|
|
636
652
|
* @since v8.1.0
|
|
637
653
|
*/
|
|
638
654
|
readonly customCellIds?: Ids;
|
|
639
655
|
/**
|
|
640
|
-
*
|
|
656
|
+
* A component or string to separate each rendered Row.
|
|
641
657
|
* @category Props
|
|
642
658
|
* @since v8.1.0
|
|
643
659
|
*/
|
|
644
660
|
readonly separator?: Snippet<[]>;
|
|
645
661
|
/**
|
|
646
|
-
*
|
|
662
|
+
* Whether the component should also render the Id of the Table, and its
|
|
663
|
+
* descendent objects, to assist with debugging.
|
|
647
664
|
* @category Props
|
|
648
665
|
* @since v8.1.0
|
|
649
666
|
*/
|
|
650
667
|
readonly debugIds?: boolean;
|
|
651
668
|
/**
|
|
652
|
-
*
|
|
669
|
+
* A snippet for rendering each Row in the Table, to override the default
|
|
670
|
+
* RowView component.
|
|
653
671
|
* @category Props
|
|
654
672
|
* @since v8.1.0
|
|
655
673
|
*/
|
|
@@ -657,68 +675,73 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
657
675
|
};
|
|
658
676
|
|
|
659
677
|
/**
|
|
660
|
-
*
|
|
661
|
-
* SortedTableView component.
|
|
678
|
+
* SortedTableViewProps props are used for components that refer to a single
|
|
679
|
+
* sorted Table in a Store, such as the SortedTableView component.
|
|
662
680
|
* @category Props
|
|
663
681
|
* @since v8.1.0
|
|
664
682
|
*/
|
|
665
683
|
SortedTableViewProps: {
|
|
666
684
|
/**
|
|
667
|
-
* The
|
|
685
|
+
* The Id of the Table in the Store to be rendered.
|
|
668
686
|
* @category Props
|
|
669
687
|
* @since v8.1.0
|
|
670
688
|
*/
|
|
671
689
|
readonly tableId: TableIdFromSchema<Schemas[0]>;
|
|
672
690
|
/**
|
|
673
|
-
* The
|
|
691
|
+
* The Id of the Cell whose values are used for sorting. If omitted, the view
|
|
692
|
+
* will sort the Row Id itself.
|
|
674
693
|
* @category Props
|
|
675
694
|
* @since v8.1.0
|
|
676
695
|
*/
|
|
677
696
|
readonly cellId?: AllCellIdFromSchema<Schemas[0]>;
|
|
678
697
|
/**
|
|
679
|
-
*
|
|
698
|
+
* Whether the sorting should be in descending order.
|
|
680
699
|
* @category Props
|
|
681
700
|
* @since v8.1.0
|
|
682
701
|
*/
|
|
683
702
|
readonly descending?: boolean;
|
|
684
703
|
/**
|
|
685
|
-
* The
|
|
704
|
+
* The number of Row Ids to skip for pagination purposes.
|
|
686
705
|
* @category Props
|
|
687
706
|
* @since v8.1.0
|
|
688
707
|
*/
|
|
689
708
|
readonly offset?: number;
|
|
690
709
|
/**
|
|
691
|
-
* The
|
|
710
|
+
* The maximum number of Row Ids to return.
|
|
692
711
|
* @category Props
|
|
693
712
|
* @since v8.1.0
|
|
694
713
|
*/
|
|
695
714
|
readonly limit?: number;
|
|
696
715
|
/**
|
|
697
|
-
* The
|
|
716
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
717
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
698
718
|
* @category Props
|
|
699
719
|
* @since v8.1.0
|
|
700
720
|
*/
|
|
701
721
|
readonly store?: StoreOrStoreId<Schemas>;
|
|
702
722
|
/**
|
|
703
|
-
*
|
|
723
|
+
* An optional list of Cell Ids to use for rendering a prescribed set of the
|
|
724
|
+
* sorted Table's Cells in a given order.
|
|
704
725
|
* @category Props
|
|
705
726
|
* @since v8.1.0
|
|
706
727
|
*/
|
|
707
728
|
readonly customCellIds?: Ids;
|
|
708
729
|
/**
|
|
709
|
-
*
|
|
730
|
+
* A component or string to separate each rendered Row.
|
|
710
731
|
* @category Props
|
|
711
732
|
* @since v8.1.0
|
|
712
733
|
*/
|
|
713
734
|
readonly separator?: Snippet<[]>;
|
|
714
735
|
/**
|
|
715
|
-
*
|
|
736
|
+
* Whether the component should also render the Id of the Table, and its
|
|
737
|
+
* descendent objects, to assist with debugging.
|
|
716
738
|
* @category Props
|
|
717
739
|
* @since v8.1.0
|
|
718
740
|
*/
|
|
719
741
|
readonly debugIds?: boolean;
|
|
720
742
|
/**
|
|
721
|
-
*
|
|
743
|
+
* A snippet for rendering each Row in the sorted Table, to override the
|
|
744
|
+
* default RowView component.
|
|
722
745
|
* @category Props
|
|
723
746
|
* @since v8.1.0
|
|
724
747
|
*/
|
|
@@ -726,31 +749,35 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
726
749
|
};
|
|
727
750
|
|
|
728
751
|
/**
|
|
729
|
-
*
|
|
752
|
+
* TablesViewProps props are used for components that refer to all the Tables
|
|
753
|
+
* in a Store, such as the TablesView component.
|
|
730
754
|
* @category Props
|
|
731
755
|
* @since v8.1.0
|
|
732
756
|
*/
|
|
733
757
|
TablesViewProps: {
|
|
734
758
|
/**
|
|
735
|
-
* The
|
|
759
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
760
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
736
761
|
* @category Props
|
|
737
762
|
* @since v8.1.0
|
|
738
763
|
*/
|
|
739
764
|
readonly store?: StoreOrStoreId<Schemas>;
|
|
740
765
|
/**
|
|
741
|
-
*
|
|
766
|
+
* A component or string to separate each rendered Table.
|
|
742
767
|
* @category Props
|
|
743
768
|
* @since v8.1.0
|
|
744
769
|
*/
|
|
745
770
|
readonly separator?: Snippet<[]>;
|
|
746
771
|
/**
|
|
747
|
-
*
|
|
772
|
+
* Whether the component should also render the Ids of each Table, and its
|
|
773
|
+
* descendent objects, to assist with debugging.
|
|
748
774
|
* @category Props
|
|
749
775
|
* @since v8.1.0
|
|
750
776
|
*/
|
|
751
777
|
readonly debugIds?: boolean;
|
|
752
778
|
/**
|
|
753
|
-
*
|
|
779
|
+
* A snippet for rendering each Table in the Store, to override the default
|
|
780
|
+
* TableView component.
|
|
754
781
|
* @category Props
|
|
755
782
|
* @since v8.1.0
|
|
756
783
|
*/
|
|
@@ -758,31 +785,35 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
758
785
|
};
|
|
759
786
|
|
|
760
787
|
/**
|
|
761
|
-
*
|
|
788
|
+
* ValuesViewProps props are used for components that refer to all the Values
|
|
789
|
+
* in a Store, such as the ValuesView component.
|
|
762
790
|
* @category Props
|
|
763
791
|
* @since v8.1.0
|
|
764
792
|
*/
|
|
765
793
|
ValuesViewProps: {
|
|
766
794
|
/**
|
|
767
|
-
* The
|
|
795
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
796
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
768
797
|
* @category Props
|
|
769
798
|
* @since v8.1.0
|
|
770
799
|
*/
|
|
771
800
|
readonly store?: StoreOrStoreId<Schemas>;
|
|
772
801
|
/**
|
|
773
|
-
*
|
|
802
|
+
* A component or string to separate each rendered Value.
|
|
774
803
|
* @category Props
|
|
775
804
|
* @since v8.1.0
|
|
776
805
|
*/
|
|
777
806
|
readonly separator?: Snippet<[]>;
|
|
778
807
|
/**
|
|
779
|
-
*
|
|
808
|
+
* Whether the component should also render the Ids of each Value to assist
|
|
809
|
+
* with debugging.
|
|
780
810
|
* @category Props
|
|
781
811
|
* @since v8.1.0
|
|
782
812
|
*/
|
|
783
813
|
readonly debugIds?: boolean;
|
|
784
814
|
/**
|
|
785
|
-
*
|
|
815
|
+
* A snippet for rendering each Value in the Store, to override the default
|
|
816
|
+
* ValueView component.
|
|
786
817
|
* @category Props
|
|
787
818
|
* @since v8.1.0
|
|
788
819
|
*/
|
|
@@ -790,37 +821,41 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
790
821
|
};
|
|
791
822
|
|
|
792
823
|
/**
|
|
793
|
-
*
|
|
824
|
+
* IndexViewProps props are used for components that refer to a single Index in
|
|
825
|
+
* an Indexes object, such as the IndexView component.
|
|
794
826
|
* @category Props
|
|
795
827
|
* @since v8.1.0
|
|
796
828
|
*/
|
|
797
829
|
IndexViewProps: {
|
|
798
830
|
/**
|
|
799
|
-
* The
|
|
831
|
+
* The Id of the Index in the Indexes object to be rendered.
|
|
800
832
|
* @category Props
|
|
801
833
|
* @since v8.1.0
|
|
802
834
|
*/
|
|
803
835
|
readonly indexId: Id;
|
|
804
836
|
/**
|
|
805
|
-
* The
|
|
837
|
+
* The Indexes object to be accessed: omit for the default context Indexes
|
|
838
|
+
* object, provide an Id for a named context Indexes object, or provide an
|
|
839
|
+
* explicit reference.
|
|
806
840
|
* @category Props
|
|
807
841
|
* @since v8.1.0
|
|
808
842
|
*/
|
|
809
843
|
readonly indexes?: IndexesOrIndexesId<Schemas>;
|
|
810
844
|
/**
|
|
811
|
-
*
|
|
845
|
+
* A component or string to separate each rendered Slice.
|
|
812
846
|
* @category Props
|
|
813
847
|
* @since v8.1.0
|
|
814
848
|
*/
|
|
815
849
|
readonly separator?: Snippet<[]>;
|
|
816
850
|
/**
|
|
817
|
-
*
|
|
851
|
+
* Whether the component should also render the Id of the Index, and its
|
|
852
|
+
* descendent objects, to assist with debugging.
|
|
818
853
|
* @category Props
|
|
819
854
|
* @since v8.1.0
|
|
820
855
|
*/
|
|
821
856
|
readonly debugIds?: boolean;
|
|
822
857
|
/**
|
|
823
|
-
*
|
|
858
|
+
* A snippet for rendering each Slice in the Index.
|
|
824
859
|
* @category Props
|
|
825
860
|
* @since v8.1.0
|
|
826
861
|
*/
|
|
@@ -828,43 +863,48 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
828
863
|
};
|
|
829
864
|
|
|
830
865
|
/**
|
|
831
|
-
*
|
|
866
|
+
* SliceViewProps props are used for components that refer to a single Slice in
|
|
867
|
+
* an Index object, such as the SliceView component.
|
|
832
868
|
* @category Props
|
|
833
869
|
* @since v8.1.0
|
|
834
870
|
*/
|
|
835
871
|
SliceViewProps: {
|
|
836
872
|
/**
|
|
837
|
-
* The
|
|
873
|
+
* The Id of the Index in the Indexes object.
|
|
838
874
|
* @category Props
|
|
839
875
|
* @since v8.1.0
|
|
840
876
|
*/
|
|
841
877
|
readonly indexId: Id;
|
|
842
878
|
/**
|
|
843
|
-
* The
|
|
879
|
+
* The Id of the Slice in the Index to be rendered.
|
|
844
880
|
* @category Props
|
|
845
881
|
* @since v8.1.0
|
|
846
882
|
*/
|
|
847
883
|
readonly sliceId: Id;
|
|
848
884
|
/**
|
|
849
|
-
* The
|
|
885
|
+
* The Indexes object to be accessed: omit for the default context Indexes
|
|
886
|
+
* object, provide an Id for a named context Indexes object, or provide an
|
|
887
|
+
* explicit reference.
|
|
850
888
|
* @category Props
|
|
851
889
|
* @since v8.1.0
|
|
852
890
|
*/
|
|
853
891
|
readonly indexes?: IndexesOrIndexesId<Schemas>;
|
|
854
892
|
/**
|
|
855
|
-
*
|
|
893
|
+
* A component or string to separate each rendered Row.
|
|
856
894
|
* @category Props
|
|
857
895
|
* @since v8.1.0
|
|
858
896
|
*/
|
|
859
897
|
readonly separator?: Snippet<[]>;
|
|
860
898
|
/**
|
|
861
|
-
*
|
|
899
|
+
* Whether the component should also render the Id of the Slice, and its
|
|
900
|
+
* descendent objects, to assist with debugging.
|
|
862
901
|
* @category Props
|
|
863
902
|
* @since v8.1.0
|
|
864
903
|
*/
|
|
865
904
|
readonly debugIds?: boolean;
|
|
866
905
|
/**
|
|
867
|
-
*
|
|
906
|
+
* A snippet for rendering each Row in the Slice, to override the default
|
|
907
|
+
* RowView component.
|
|
868
908
|
* @category Props
|
|
869
909
|
* @since v8.1.0
|
|
870
910
|
*/
|
|
@@ -872,38 +912,43 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
872
912
|
};
|
|
873
913
|
|
|
874
914
|
/**
|
|
875
|
-
*
|
|
876
|
-
*
|
|
915
|
+
* RemoteRowViewProps props are used for components that refer to a single
|
|
916
|
+
* Relationship in a Relationships object, and where you want to render a
|
|
917
|
+
* remote Row based on a local Row, such as in the RemoteRowView component.
|
|
877
918
|
* @category Props
|
|
878
919
|
* @since v8.1.0
|
|
879
920
|
*/
|
|
880
921
|
RemoteRowViewProps: {
|
|
881
922
|
/**
|
|
882
|
-
* The
|
|
923
|
+
* The Id of the Relationship in the Relationships object.
|
|
883
924
|
* @category Props
|
|
884
925
|
* @since v8.1.0
|
|
885
926
|
*/
|
|
886
927
|
readonly relationshipId: Id;
|
|
887
928
|
/**
|
|
888
|
-
* The
|
|
929
|
+
* The Id of the local Row for which to render the remote Row.
|
|
889
930
|
* @category Props
|
|
890
931
|
* @since v8.1.0
|
|
891
932
|
*/
|
|
892
933
|
readonly localRowId: Id;
|
|
893
934
|
/**
|
|
894
|
-
* The
|
|
935
|
+
* The Relationships object to be accessed: omit for the default context
|
|
936
|
+
* Relationships object, provide an Id for a named context Relationships
|
|
937
|
+
* object, or provide an explicit reference.
|
|
895
938
|
* @category Props
|
|
896
939
|
* @since v8.1.0
|
|
897
940
|
*/
|
|
898
941
|
readonly relationships?: RelationshipsOrRelationshipsId<Schemas>;
|
|
899
942
|
/**
|
|
900
|
-
*
|
|
943
|
+
* Whether the component should also render the Id of the Row in the
|
|
944
|
+
* Relationship, and its descendent objects, to assist with debugging.
|
|
901
945
|
* @category Props
|
|
902
946
|
* @since v8.1.0
|
|
903
947
|
*/
|
|
904
948
|
readonly debugIds?: boolean;
|
|
905
949
|
/**
|
|
906
|
-
*
|
|
950
|
+
* A snippet for rendering each (remote, local, or linked) Row in the
|
|
951
|
+
* Relationship.
|
|
907
952
|
* @category Props
|
|
908
953
|
* @since v8.1.0
|
|
909
954
|
*/
|
|
@@ -911,44 +956,49 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
911
956
|
};
|
|
912
957
|
|
|
913
958
|
/**
|
|
914
|
-
*
|
|
915
|
-
*
|
|
959
|
+
* LocalRowsViewProps props are used for components that refer to a single
|
|
960
|
+
* Relationship in a Relationships object, and where you want to render local
|
|
961
|
+
* Rows based on a remote Row, such as the LocalRowsView component.
|
|
916
962
|
* @category Props
|
|
917
963
|
* @since v8.1.0
|
|
918
964
|
*/
|
|
919
965
|
LocalRowsViewProps: {
|
|
920
966
|
/**
|
|
921
|
-
* The
|
|
967
|
+
* The Id of the Relationship in the Relationships object.
|
|
922
968
|
* @category Props
|
|
923
969
|
* @since v8.1.0
|
|
924
970
|
*/
|
|
925
971
|
readonly relationshipId: Id;
|
|
926
972
|
/**
|
|
927
|
-
* The
|
|
973
|
+
* The Id of the remote Row for which to render the local Rows.
|
|
928
974
|
* @category Props
|
|
929
975
|
* @since v8.1.0
|
|
930
976
|
*/
|
|
931
977
|
readonly remoteRowId: Id;
|
|
932
978
|
/**
|
|
933
|
-
* The
|
|
979
|
+
* The Relationships object to be accessed: omit for the default context
|
|
980
|
+
* Relationships object, provide an Id for a named context Relationships
|
|
981
|
+
* object, or provide an explicit reference.
|
|
934
982
|
* @category Props
|
|
935
983
|
* @since v8.1.0
|
|
936
984
|
*/
|
|
937
985
|
readonly relationships?: RelationshipsOrRelationshipsId<Schemas>;
|
|
938
986
|
/**
|
|
939
|
-
*
|
|
987
|
+
* A component or string to separate each rendered Row.
|
|
940
988
|
* @category Props
|
|
941
989
|
* @since v8.1.0
|
|
942
990
|
*/
|
|
943
991
|
readonly separator?: Snippet<[]>;
|
|
944
992
|
/**
|
|
945
|
-
*
|
|
993
|
+
* Whether the component should also render the Id of the Row in the
|
|
994
|
+
* Relationship, and its descendent objects, to assist with debugging.
|
|
946
995
|
* @category Props
|
|
947
996
|
* @since v8.1.0
|
|
948
997
|
*/
|
|
949
998
|
readonly debugIds?: boolean;
|
|
950
999
|
/**
|
|
951
|
-
*
|
|
1000
|
+
* A snippet for rendering each (remote, local, or linked) Row in the
|
|
1001
|
+
* Relationship.
|
|
952
1002
|
* @category Props
|
|
953
1003
|
* @since v8.1.0
|
|
954
1004
|
*/
|
|
@@ -956,44 +1006,50 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
956
1006
|
};
|
|
957
1007
|
|
|
958
1008
|
/**
|
|
959
|
-
*
|
|
960
|
-
*
|
|
1009
|
+
* LinkedRowsViewProps props are used for components that refer to a single
|
|
1010
|
+
* Relationship in a Relationships object, and where you want to render a
|
|
1011
|
+
* linked list of Rows starting from a first Row, such as the LinkedRowsView
|
|
1012
|
+
* component.
|
|
961
1013
|
* @category Props
|
|
962
1014
|
* @since v8.1.0
|
|
963
1015
|
*/
|
|
964
1016
|
LinkedRowsViewProps: {
|
|
965
1017
|
/**
|
|
966
|
-
* The
|
|
1018
|
+
* The Id of the Relationship in the Relationships object.
|
|
967
1019
|
* @category Props
|
|
968
1020
|
* @since v8.1.0
|
|
969
1021
|
*/
|
|
970
1022
|
readonly relationshipId: Id;
|
|
971
1023
|
/**
|
|
972
|
-
* The
|
|
1024
|
+
* The Id of the first Row in the linked list Relationship.
|
|
973
1025
|
* @category Props
|
|
974
1026
|
* @since v8.1.0
|
|
975
1027
|
*/
|
|
976
1028
|
readonly firstRowId: Id;
|
|
977
1029
|
/**
|
|
978
|
-
* The
|
|
1030
|
+
* The Relationships object to be accessed: omit for the default context
|
|
1031
|
+
* Relationships object, provide an Id for a named context Relationships
|
|
1032
|
+
* object, or provide an explicit reference.
|
|
979
1033
|
* @category Props
|
|
980
1034
|
* @since v8.1.0
|
|
981
1035
|
*/
|
|
982
1036
|
readonly relationships?: RelationshipsOrRelationshipsId<Schemas>;
|
|
983
1037
|
/**
|
|
984
|
-
*
|
|
1038
|
+
* A component or string to separate each rendered Row.
|
|
985
1039
|
* @category Props
|
|
986
1040
|
* @since v8.1.0
|
|
987
1041
|
*/
|
|
988
1042
|
readonly separator?: Snippet<[]>;
|
|
989
1043
|
/**
|
|
990
|
-
*
|
|
1044
|
+
* Whether the component should also render the Id of the Row in the
|
|
1045
|
+
* Relationship, and its descendent objects, to assist with debugging.
|
|
991
1046
|
* @category Props
|
|
992
1047
|
* @since v8.1.0
|
|
993
1048
|
*/
|
|
994
1049
|
readonly debugIds?: boolean;
|
|
995
1050
|
/**
|
|
996
|
-
*
|
|
1051
|
+
* A snippet for rendering each (remote, local, or linked) Row in the
|
|
1052
|
+
* Relationship.
|
|
997
1053
|
* @category Props
|
|
998
1054
|
* @since v8.1.0
|
|
999
1055
|
*/
|
|
@@ -1001,38 +1057,42 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1001
1057
|
};
|
|
1002
1058
|
|
|
1003
1059
|
/**
|
|
1004
|
-
*
|
|
1005
|
-
* ResultCellView component.
|
|
1060
|
+
* ResultCellViewProps props are used for components that refer to a single
|
|
1061
|
+
* Cell in a Row of a query ResultTable, such as the ResultCellView component.
|
|
1006
1062
|
* @category Props
|
|
1007
1063
|
* @since v8.1.0
|
|
1008
1064
|
*/
|
|
1009
1065
|
ResultCellViewProps: {
|
|
1010
1066
|
/**
|
|
1011
|
-
* The
|
|
1067
|
+
* The Id of the query in the Queries object for which the ResultTable will be
|
|
1068
|
+
* rendered.
|
|
1012
1069
|
* @category Props
|
|
1013
1070
|
* @since v8.1.0
|
|
1014
1071
|
*/
|
|
1015
1072
|
readonly queryId: Id;
|
|
1016
1073
|
/**
|
|
1017
|
-
* The
|
|
1074
|
+
* The Id of the Row in the ResultTable.
|
|
1018
1075
|
* @category Props
|
|
1019
1076
|
* @since v8.1.0
|
|
1020
1077
|
*/
|
|
1021
1078
|
readonly rowId: Id;
|
|
1022
1079
|
/**
|
|
1023
|
-
* The
|
|
1080
|
+
* The Id of the Cell in the Row to be rendered.
|
|
1024
1081
|
* @category Props
|
|
1025
1082
|
* @since v8.1.0
|
|
1026
1083
|
*/
|
|
1027
1084
|
readonly cellId: Id;
|
|
1028
1085
|
/**
|
|
1029
|
-
* The
|
|
1086
|
+
* The Queries object to be accessed: omit for the default context Queries
|
|
1087
|
+
* object, provide an Id for a named context Queries object, or provide an
|
|
1088
|
+
* explicit reference.
|
|
1030
1089
|
* @category Props
|
|
1031
1090
|
* @since v8.1.0
|
|
1032
1091
|
*/
|
|
1033
1092
|
readonly queries?: QueriesOrQueriesId<Schemas>;
|
|
1034
1093
|
/**
|
|
1035
|
-
*
|
|
1094
|
+
* Whether the component should also render the Id of the Cell to assist with
|
|
1095
|
+
* debugging.
|
|
1036
1096
|
* @category Props
|
|
1037
1097
|
* @since v8.1.0
|
|
1038
1098
|
*/
|
|
@@ -1040,44 +1100,49 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1040
1100
|
};
|
|
1041
1101
|
|
|
1042
1102
|
/**
|
|
1043
|
-
*
|
|
1044
|
-
* ResultRowView component.
|
|
1103
|
+
* ResultRowViewProps props are used for components that refer to a single Row
|
|
1104
|
+
* in a query ResultTable, such as the ResultRowView component.
|
|
1045
1105
|
* @category Props
|
|
1046
1106
|
* @since v8.1.0
|
|
1047
1107
|
*/
|
|
1048
1108
|
ResultRowViewProps: {
|
|
1049
1109
|
/**
|
|
1050
|
-
* The
|
|
1110
|
+
* The Id of the query in the Queries object for which the ResultTable will be
|
|
1111
|
+
* rendered.
|
|
1051
1112
|
* @category Props
|
|
1052
1113
|
* @since v8.1.0
|
|
1053
1114
|
*/
|
|
1054
1115
|
readonly queryId: Id;
|
|
1055
1116
|
/**
|
|
1056
|
-
* The
|
|
1117
|
+
* The Id of the Row in the ResultTable to be rendered.
|
|
1057
1118
|
* @category Props
|
|
1058
1119
|
* @since v8.1.0
|
|
1059
1120
|
*/
|
|
1060
1121
|
readonly rowId: Id;
|
|
1061
1122
|
/**
|
|
1062
|
-
* The
|
|
1123
|
+
* The Queries object to be accessed: omit for the default context Queries
|
|
1124
|
+
* object, provide an Id for a named context Queries object, or provide an
|
|
1125
|
+
* explicit reference.
|
|
1063
1126
|
* @category Props
|
|
1064
1127
|
* @since v8.1.0
|
|
1065
1128
|
*/
|
|
1066
1129
|
readonly queries?: QueriesOrQueriesId<Schemas>;
|
|
1067
1130
|
/**
|
|
1068
|
-
*
|
|
1131
|
+
* A component or string to separate each rendered Cell.
|
|
1069
1132
|
* @category Props
|
|
1070
1133
|
* @since v8.1.0
|
|
1071
1134
|
*/
|
|
1072
1135
|
readonly separator?: Snippet<[]>;
|
|
1073
1136
|
/**
|
|
1074
|
-
*
|
|
1137
|
+
* Whether the component should also render the Id of the Row, and its
|
|
1138
|
+
* descendent objects, to assist with debugging.
|
|
1075
1139
|
* @category Props
|
|
1076
1140
|
* @since v8.1.0
|
|
1077
1141
|
*/
|
|
1078
1142
|
readonly debugIds?: boolean;
|
|
1079
1143
|
/**
|
|
1080
|
-
*
|
|
1144
|
+
* A snippet for rendering each Cell in the Row, to override the default
|
|
1145
|
+
* ResultCellView component.
|
|
1081
1146
|
* @category Props
|
|
1082
1147
|
* @since v8.1.0
|
|
1083
1148
|
*/
|
|
@@ -1085,38 +1150,43 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1085
1150
|
};
|
|
1086
1151
|
|
|
1087
1152
|
/**
|
|
1088
|
-
*
|
|
1089
|
-
* ResultTableView component.
|
|
1153
|
+
* ResultTableViewProps props are used for components that refer to a single
|
|
1154
|
+
* query ResultTable, such as the ResultTableView component.
|
|
1090
1155
|
* @category Props
|
|
1091
1156
|
* @since v8.1.0
|
|
1092
1157
|
*/
|
|
1093
1158
|
ResultTableViewProps: {
|
|
1094
1159
|
/**
|
|
1095
|
-
* The
|
|
1160
|
+
* The Id of the query in the Queries object for which the ResultTable will be
|
|
1161
|
+
* rendered.
|
|
1096
1162
|
* @category Props
|
|
1097
1163
|
* @since v8.1.0
|
|
1098
1164
|
*/
|
|
1099
1165
|
readonly queryId: Id;
|
|
1100
1166
|
/**
|
|
1101
|
-
* The
|
|
1167
|
+
* The Queries object to be accessed: omit for the default context Queries
|
|
1168
|
+
* object, provide an Id for a named context Queries object, or provide an
|
|
1169
|
+
* explicit reference.
|
|
1102
1170
|
* @category Props
|
|
1103
1171
|
* @since v8.1.0
|
|
1104
1172
|
*/
|
|
1105
1173
|
readonly queries?: QueriesOrQueriesId<Schemas>;
|
|
1106
1174
|
/**
|
|
1107
|
-
*
|
|
1175
|
+
* A component or string to separate each rendered Row.
|
|
1108
1176
|
* @category Props
|
|
1109
1177
|
* @since v8.1.0
|
|
1110
1178
|
*/
|
|
1111
1179
|
readonly separator?: Snippet<[]>;
|
|
1112
1180
|
/**
|
|
1113
|
-
*
|
|
1181
|
+
* Whether the component should also render the Id of the query, and its
|
|
1182
|
+
* descendent objects, to assist with debugging.
|
|
1114
1183
|
* @category Props
|
|
1115
1184
|
* @since v8.1.0
|
|
1116
1185
|
*/
|
|
1117
1186
|
readonly debugIds?: boolean;
|
|
1118
1187
|
/**
|
|
1119
|
-
*
|
|
1188
|
+
* A snippet for rendering each Row in the Table, to override the default
|
|
1189
|
+
* ResultRowView component.
|
|
1120
1190
|
* @category Props
|
|
1121
1191
|
* @since v8.1.0
|
|
1122
1192
|
*/
|
|
@@ -1124,62 +1194,69 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1124
1194
|
};
|
|
1125
1195
|
|
|
1126
1196
|
/**
|
|
1127
|
-
*
|
|
1128
|
-
* ResultSortedTableView
|
|
1197
|
+
* ResultSortedTableViewProps props are used for components that refer to a
|
|
1198
|
+
* single sorted query ResultTable, such as the ResultSortedTableView
|
|
1199
|
+
* component.
|
|
1129
1200
|
* @category Props
|
|
1130
1201
|
* @since v8.1.0
|
|
1131
1202
|
*/
|
|
1132
1203
|
ResultSortedTableViewProps: {
|
|
1133
1204
|
/**
|
|
1134
|
-
* The
|
|
1205
|
+
* The Id of the query in the Queries object for which the sorted ResultTable
|
|
1206
|
+
* will be rendered.
|
|
1135
1207
|
* @category Props
|
|
1136
1208
|
* @since v8.1.0
|
|
1137
1209
|
*/
|
|
1138
1210
|
readonly queryId: Id;
|
|
1139
1211
|
/**
|
|
1140
|
-
* The
|
|
1212
|
+
* The Id of the Cell whose values are used for sorting. If omitted, the view
|
|
1213
|
+
* will sort the Row Id itself.
|
|
1141
1214
|
* @category Props
|
|
1142
1215
|
* @since v8.1.0
|
|
1143
1216
|
*/
|
|
1144
1217
|
readonly cellId?: Id;
|
|
1145
1218
|
/**
|
|
1146
|
-
*
|
|
1219
|
+
* Whether the sorting should be in descending order.
|
|
1147
1220
|
* @category Props
|
|
1148
1221
|
* @since v8.1.0
|
|
1149
1222
|
*/
|
|
1150
1223
|
readonly descending?: boolean;
|
|
1151
1224
|
/**
|
|
1152
|
-
* The
|
|
1225
|
+
* The number of Row Ids to skip for pagination purposes.
|
|
1153
1226
|
* @category Props
|
|
1154
1227
|
* @since v8.1.0
|
|
1155
1228
|
*/
|
|
1156
1229
|
readonly offset?: number;
|
|
1157
1230
|
/**
|
|
1158
|
-
* The
|
|
1231
|
+
* The maximum number of Row Ids to return.
|
|
1159
1232
|
* @category Props
|
|
1160
1233
|
* @since v8.1.0
|
|
1161
1234
|
*/
|
|
1162
1235
|
readonly limit?: number;
|
|
1163
1236
|
/**
|
|
1164
|
-
* The
|
|
1237
|
+
* The Queries object to be accessed: omit for the default context Queries
|
|
1238
|
+
* object, provide an Id for a named context Queries object, or provide an
|
|
1239
|
+
* explicit reference.
|
|
1165
1240
|
* @category Props
|
|
1166
1241
|
* @since v8.1.0
|
|
1167
1242
|
*/
|
|
1168
1243
|
readonly queries?: QueriesOrQueriesId<Schemas>;
|
|
1169
1244
|
/**
|
|
1170
|
-
*
|
|
1245
|
+
* A component or string to separate each rendered Row.
|
|
1171
1246
|
* @category Props
|
|
1172
1247
|
* @since v8.1.0
|
|
1173
1248
|
*/
|
|
1174
1249
|
readonly separator?: Snippet<[]>;
|
|
1175
1250
|
/**
|
|
1176
|
-
*
|
|
1251
|
+
* Whether the component should also render the Id of the query, and its
|
|
1252
|
+
* descendent objects, to assist with debugging.
|
|
1177
1253
|
* @category Props
|
|
1178
1254
|
* @since v8.1.0
|
|
1179
1255
|
*/
|
|
1180
1256
|
readonly debugIds?: boolean;
|
|
1181
1257
|
/**
|
|
1182
|
-
*
|
|
1258
|
+
* A snippet for rendering each Row in the Table, to override the default
|
|
1259
|
+
* ResultRowView component.
|
|
1183
1260
|
* @category Props
|
|
1184
1261
|
* @since v8.1.0
|
|
1185
1262
|
*/
|
|
@@ -1187,32 +1264,36 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1187
1264
|
};
|
|
1188
1265
|
|
|
1189
1266
|
/**
|
|
1190
|
-
*
|
|
1267
|
+
* BackwardCheckpointsViewProps props are used for components that refer to a
|
|
1268
|
+
* list of previous checkpoints in a Checkpoints object, such as the
|
|
1191
1269
|
* BackwardCheckpointsView component.
|
|
1192
1270
|
* @category Props
|
|
1193
1271
|
* @since v8.1.0
|
|
1194
1272
|
*/
|
|
1195
1273
|
BackwardCheckpointsViewProps: {
|
|
1196
1274
|
/**
|
|
1197
|
-
* The
|
|
1275
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
1276
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
1277
|
+
* or provide an explicit reference.
|
|
1198
1278
|
* @category Props
|
|
1199
1279
|
* @since v8.1.0
|
|
1200
1280
|
*/
|
|
1201
1281
|
readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
|
|
1202
1282
|
/**
|
|
1203
|
-
*
|
|
1283
|
+
* A component or string to separate each rendered checkpoint.
|
|
1204
1284
|
* @category Props
|
|
1205
1285
|
* @since v8.1.0
|
|
1206
1286
|
*/
|
|
1207
1287
|
readonly separator?: Snippet<[]>;
|
|
1208
1288
|
/**
|
|
1209
|
-
*
|
|
1289
|
+
* Whether the component should also render the Ids of the checkpoints to
|
|
1290
|
+
* assist with debugging.
|
|
1210
1291
|
* @category Props
|
|
1211
1292
|
* @since v8.1.0
|
|
1212
1293
|
*/
|
|
1213
1294
|
readonly debugIds?: boolean;
|
|
1214
1295
|
/**
|
|
1215
|
-
*
|
|
1296
|
+
* A snippet for rendering each checkpoint in the Checkpoints object.
|
|
1216
1297
|
* @category Props
|
|
1217
1298
|
* @since v8.1.0
|
|
1218
1299
|
*/
|
|
@@ -1220,32 +1301,36 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1220
1301
|
};
|
|
1221
1302
|
|
|
1222
1303
|
/**
|
|
1223
|
-
*
|
|
1304
|
+
* ForwardCheckpointsViewProps props are used for components that refer to a
|
|
1305
|
+
* list of future checkpoints in a Checkpoints object, such as the
|
|
1224
1306
|
* ForwardCheckpointsView component.
|
|
1225
1307
|
* @category Props
|
|
1226
1308
|
* @since v8.1.0
|
|
1227
1309
|
*/
|
|
1228
1310
|
ForwardCheckpointsViewProps: {
|
|
1229
1311
|
/**
|
|
1230
|
-
* The
|
|
1312
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
1313
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
1314
|
+
* or provide an explicit reference.
|
|
1231
1315
|
* @category Props
|
|
1232
1316
|
* @since v8.1.0
|
|
1233
1317
|
*/
|
|
1234
1318
|
readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
|
|
1235
1319
|
/**
|
|
1236
|
-
*
|
|
1320
|
+
* A component or string to separate each rendered checkpoint.
|
|
1237
1321
|
* @category Props
|
|
1238
1322
|
* @since v8.1.0
|
|
1239
1323
|
*/
|
|
1240
1324
|
readonly separator?: Snippet<[]>;
|
|
1241
1325
|
/**
|
|
1242
|
-
*
|
|
1326
|
+
* Whether the component should also render the Ids of the checkpoints to
|
|
1327
|
+
* assist with debugging.
|
|
1243
1328
|
* @category Props
|
|
1244
1329
|
* @since v8.1.0
|
|
1245
1330
|
*/
|
|
1246
1331
|
readonly debugIds?: boolean;
|
|
1247
1332
|
/**
|
|
1248
|
-
*
|
|
1333
|
+
* A snippet for rendering each checkpoint in the Checkpoints object.
|
|
1249
1334
|
* @category Props
|
|
1250
1335
|
* @since v8.1.0
|
|
1251
1336
|
*/
|
|
@@ -1253,26 +1338,30 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1253
1338
|
};
|
|
1254
1339
|
|
|
1255
1340
|
/**
|
|
1256
|
-
*
|
|
1341
|
+
* CurrentCheckpointViewProps props are used for components that refer to the
|
|
1342
|
+
* current checkpoint in a Checkpoints object, such as the
|
|
1257
1343
|
* CurrentCheckpointView component.
|
|
1258
1344
|
* @category Props
|
|
1259
1345
|
* @since v8.1.0
|
|
1260
1346
|
*/
|
|
1261
1347
|
CurrentCheckpointViewProps: {
|
|
1262
1348
|
/**
|
|
1263
|
-
* The
|
|
1349
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
1350
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
1351
|
+
* or provide an explicit reference.
|
|
1264
1352
|
* @category Props
|
|
1265
1353
|
* @since v8.1.0
|
|
1266
1354
|
*/
|
|
1267
1355
|
readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
|
|
1268
1356
|
/**
|
|
1269
|
-
*
|
|
1357
|
+
* Whether the component should also render the Id of the current checkpoint
|
|
1358
|
+
* to assist with debugging.
|
|
1270
1359
|
* @category Props
|
|
1271
1360
|
* @since v8.1.0
|
|
1272
1361
|
*/
|
|
1273
1362
|
readonly debugIds?: boolean;
|
|
1274
1363
|
/**
|
|
1275
|
-
*
|
|
1364
|
+
* A snippet for rendering the current checkpoint in the Checkpoints object.
|
|
1276
1365
|
* @category Props
|
|
1277
1366
|
* @since v8.1.0
|
|
1278
1367
|
*/
|
|
@@ -1320,8 +1409,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1320
1409
|
|
|
1321
1410
|
/**
|
|
1322
1411
|
* The ValueView component renders the value of a single Value in a Store, and
|
|
1323
|
-
* registers a listener so that any changes to that result will cause
|
|
1324
|
-
*
|
|
1412
|
+
* registers a listener so that any changes to that result will cause a
|
|
1413
|
+
* re-render.
|
|
1325
1414
|
* @param props The props for this component.
|
|
1326
1415
|
* @returns A rendering of the Value, or nothing if not present.
|
|
1327
1416
|
* @category Component
|
|
@@ -1331,8 +1420,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1331
1420
|
|
|
1332
1421
|
/**
|
|
1333
1422
|
* The RowView component renders the contents of a single Row in a given Table,
|
|
1334
|
-
* and registers a listener so that any changes to that result will cause
|
|
1335
|
-
*
|
|
1423
|
+
* and registers a listener so that any changes to that result will cause a
|
|
1424
|
+
* re-render.
|
|
1336
1425
|
* @param props The props for this component.
|
|
1337
1426
|
* @returns A rendering of the Row, or nothing if not present.
|
|
1338
1427
|
* @category Component
|
|
@@ -1363,8 +1452,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1363
1452
|
|
|
1364
1453
|
/**
|
|
1365
1454
|
* The TablesView component renders the contents of all Tables in a Store, and
|
|
1366
|
-
* registers a listener so that any changes to that result will cause
|
|
1367
|
-
*
|
|
1455
|
+
* registers a listener so that any changes to that result will cause a
|
|
1456
|
+
* re-render.
|
|
1368
1457
|
* @param props The props for this component.
|
|
1369
1458
|
* @returns A rendering of all Tables.
|
|
1370
1459
|
* @category Component
|
|
@@ -1405,8 +1494,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1405
1494
|
|
|
1406
1495
|
/**
|
|
1407
1496
|
* The SliceView component renders the Row Ids in a named Slice in an Index, and
|
|
1408
|
-
* registers a listener so that any changes to that result will cause
|
|
1409
|
-
*
|
|
1497
|
+
* registers a listener so that any changes to that result will cause a
|
|
1498
|
+
* re-render.
|
|
1410
1499
|
* @param props The props for this component.
|
|
1411
1500
|
* @returns A rendering of the Rows in the Slice.
|
|
1412
1501
|
* @category Component
|
|
@@ -1438,8 +1527,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1438
1527
|
|
|
1439
1528
|
/**
|
|
1440
1529
|
* The LinkedRowsView component renders the Rows in a linked list Relationship,
|
|
1441
|
-
* and registers a listener so that any changes to that result will cause
|
|
1442
|
-
*
|
|
1530
|
+
* and registers a listener so that any changes to that result will cause a
|
|
1531
|
+
* re-render.
|
|
1443
1532
|
* @param props The props for this component.
|
|
1444
1533
|
* @returns A rendering of the linked Row Ids.
|
|
1445
1534
|
* @category Component
|
|
@@ -1544,97 +1633,97 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1544
1633
|
>;
|
|
1545
1634
|
|
|
1546
1635
|
/**
|
|
1547
|
-
* The
|
|
1636
|
+
* The hasTables function returns a reactive object indicating whether any
|
|
1548
1637
|
* Tables exist in the Store, and registers a listener so that any changes to
|
|
1549
|
-
* that result will update
|
|
1638
|
+
* that result will update `current`.
|
|
1550
1639
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1551
1640
|
* @returns A reactive object with a `current` boolean property.
|
|
1552
1641
|
* @category Getter
|
|
1553
1642
|
* @since v8.1.0
|
|
1554
1643
|
*/
|
|
1555
|
-
|
|
1644
|
+
hasTables: (
|
|
1556
1645
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
|
|
1557
1646
|
) => {
|
|
1558
1647
|
readonly current: boolean;
|
|
1559
1648
|
};
|
|
1560
1649
|
|
|
1561
1650
|
/**
|
|
1562
|
-
* The
|
|
1563
|
-
*
|
|
1564
|
-
* update
|
|
1651
|
+
* The getTables function returns a reactive object reflecting the Tables in the
|
|
1652
|
+
* Store, and registers a listener so that any changes to those Tables will
|
|
1653
|
+
* update `current`.
|
|
1565
1654
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1566
1655
|
* @returns A reactive object with a `current` Tables property.
|
|
1567
1656
|
* @category Getter
|
|
1568
1657
|
* @since v8.1.0
|
|
1569
1658
|
*/
|
|
1570
|
-
|
|
1659
|
+
getTables: (
|
|
1571
1660
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
|
|
1572
1661
|
) => {
|
|
1573
1662
|
readonly current: Tables<Schemas[0]>;
|
|
1574
1663
|
};
|
|
1575
1664
|
|
|
1576
1665
|
/**
|
|
1577
|
-
* The
|
|
1578
|
-
*
|
|
1579
|
-
*
|
|
1666
|
+
* The getTableIds function returns a reactive object reflecting the Ids of the
|
|
1667
|
+
* Tables in a Store, and registers a listener so that any changes to those Ids
|
|
1668
|
+
* will update `current`.
|
|
1580
1669
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1581
1670
|
* @returns A reactive object with a `current` Ids property.
|
|
1582
1671
|
* @category Getter
|
|
1583
1672
|
* @since v8.1.0
|
|
1584
1673
|
*/
|
|
1585
|
-
|
|
1674
|
+
getTableIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
|
|
1586
1675
|
readonly current: TableIdFromSchema<Schemas[0]>[];
|
|
1587
1676
|
};
|
|
1588
1677
|
|
|
1589
1678
|
/**
|
|
1590
|
-
* The
|
|
1591
|
-
*
|
|
1592
|
-
*
|
|
1679
|
+
* The hasTable function returns a reactive object indicating whether a Table
|
|
1680
|
+
* exists in the Store, and registers a listener so that any changes to that
|
|
1681
|
+
* result will update `current`.
|
|
1593
1682
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1594
1683
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1595
1684
|
* @returns A reactive object with a `current` boolean property.
|
|
1596
1685
|
* @category Getter
|
|
1597
1686
|
* @since v8.1.0
|
|
1598
1687
|
*/
|
|
1599
|
-
|
|
1688
|
+
hasTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
1600
1689
|
tableId: MaybeGetter<TableId>,
|
|
1601
1690
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1602
1691
|
) => {readonly current: boolean};
|
|
1603
1692
|
|
|
1604
1693
|
/**
|
|
1605
|
-
* The
|
|
1606
|
-
* Store, and registers a listener so that any changes to that Table will
|
|
1607
|
-
*
|
|
1694
|
+
* The getTable function returns a reactive object reflecting a Table in a
|
|
1695
|
+
* Store, and registers a listener so that any changes to that Table will update
|
|
1696
|
+
* `current`.
|
|
1608
1697
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1609
1698
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1610
1699
|
* @returns A reactive object with a `current` Table property.
|
|
1611
1700
|
* @category Getter
|
|
1612
1701
|
* @since v8.1.0
|
|
1613
1702
|
*/
|
|
1614
|
-
|
|
1703
|
+
getTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
1615
1704
|
tableId: MaybeGetter<TableId>,
|
|
1616
1705
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1617
1706
|
) => {readonly current: Table<Schemas[0], TableId>};
|
|
1618
1707
|
|
|
1619
1708
|
/**
|
|
1620
|
-
* The
|
|
1621
|
-
*
|
|
1622
|
-
*
|
|
1709
|
+
* The getTableCellIds function returns a reactive object reflecting the Ids of
|
|
1710
|
+
* all Cells used across a Table, and registers a listener so that any changes
|
|
1711
|
+
* to those Ids will update `current`.
|
|
1623
1712
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1624
1713
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1625
1714
|
* @returns A reactive object with a `current` Ids property.
|
|
1626
1715
|
* @category Getter
|
|
1627
1716
|
* @since v8.1.0
|
|
1628
1717
|
*/
|
|
1629
|
-
|
|
1718
|
+
getTableCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
1630
1719
|
tableId: MaybeGetter<TableId>,
|
|
1631
1720
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1632
1721
|
) => {readonly current: CellIdFromSchema<Schemas[0], TableId>[]};
|
|
1633
1722
|
|
|
1634
1723
|
/**
|
|
1635
|
-
* The
|
|
1636
|
-
*
|
|
1637
|
-
*
|
|
1724
|
+
* The hasTableCell function returns a reactive object indicating whether a
|
|
1725
|
+
* particular Cell is used anywhere in a Table, and registers a listener so that
|
|
1726
|
+
* any changes to that result will update `current`.
|
|
1638
1727
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1639
1728
|
* @param cellId The Id of the Cell (or a getter returning it).
|
|
1640
1729
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1642,46 +1731,46 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1642
1731
|
* @category Getter
|
|
1643
1732
|
* @since v8.1.0
|
|
1644
1733
|
*/
|
|
1645
|
-
|
|
1734
|
+
hasTableCell: <TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
1646
1735
|
tableId: MaybeGetter<TableId>,
|
|
1647
1736
|
cellId: MaybeGetter<CellIdFromSchema<Schemas[0], TableId>>,
|
|
1648
1737
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1649
1738
|
) => {readonly current: boolean};
|
|
1650
1739
|
|
|
1651
1740
|
/**
|
|
1652
|
-
* The
|
|
1653
|
-
*
|
|
1654
|
-
*
|
|
1741
|
+
* The getRowCount function returns a reactive object reflecting the number of
|
|
1742
|
+
* Rows in a Table, and registers a listener so that any changes will update
|
|
1743
|
+
* `current`.
|
|
1655
1744
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1656
1745
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1657
1746
|
* @returns A reactive object with a `current` number property.
|
|
1658
1747
|
* @category Getter
|
|
1659
1748
|
* @since v8.1.0
|
|
1660
1749
|
*/
|
|
1661
|
-
|
|
1750
|
+
getRowCount: (
|
|
1662
1751
|
tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
|
|
1663
1752
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1664
1753
|
) => {readonly current: number};
|
|
1665
1754
|
|
|
1666
1755
|
/**
|
|
1667
|
-
* The
|
|
1668
|
-
* Rows in a Table, and registers a listener so that any changes will
|
|
1669
|
-
*
|
|
1756
|
+
* The getRowIds function returns a reactive object reflecting the Ids of the
|
|
1757
|
+
* Rows in a Table, and registers a listener so that any changes will update
|
|
1758
|
+
* `current`.
|
|
1670
1759
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1671
1760
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1672
1761
|
* @returns A reactive object with a `current` Ids property.
|
|
1673
1762
|
* @category Getter
|
|
1674
1763
|
* @since v8.1.0
|
|
1675
1764
|
*/
|
|
1676
|
-
|
|
1765
|
+
getRowIds: (
|
|
1677
1766
|
tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
|
|
1678
1767
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1679
1768
|
) => {readonly current: Ids};
|
|
1680
1769
|
|
|
1681
1770
|
/**
|
|
1682
|
-
* The
|
|
1683
|
-
*
|
|
1684
|
-
*
|
|
1771
|
+
* The getSortedRowIds function returns a reactive object reflecting the sorted
|
|
1772
|
+
* Row Ids in a Table, and registers a listener so that any changes will update
|
|
1773
|
+
* `current`.
|
|
1685
1774
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1686
1775
|
* @param cellId The Id of the Cell to sort by (or a getter returning it).
|
|
1687
1776
|
* @param descending Whether to sort descending (or a getter returning it).
|
|
@@ -1692,7 +1781,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1692
1781
|
* @category Getter
|
|
1693
1782
|
* @since v8.1.0
|
|
1694
1783
|
*/
|
|
1695
|
-
|
|
1784
|
+
getSortedRowIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
1696
1785
|
tableId: MaybeGetter<TableId>,
|
|
1697
1786
|
cellId?: MaybeGetter<CellIdFromSchema<Schemas[0], TableId> | undefined>,
|
|
1698
1787
|
descending?: MaybeGetter<boolean>,
|
|
@@ -1702,9 +1791,9 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1702
1791
|
) => {readonly current: Ids};
|
|
1703
1792
|
|
|
1704
1793
|
/**
|
|
1705
|
-
* The
|
|
1706
|
-
*
|
|
1707
|
-
*
|
|
1794
|
+
* The hasRow function returns a reactive object indicating whether a Row exists
|
|
1795
|
+
* in a Table, and registers a listener so that any changes to that result will
|
|
1796
|
+
* update `current`.
|
|
1708
1797
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1709
1798
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1710
1799
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1712,16 +1801,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1712
1801
|
* @category Getter
|
|
1713
1802
|
* @since v8.1.0
|
|
1714
1803
|
*/
|
|
1715
|
-
|
|
1804
|
+
hasRow: (
|
|
1716
1805
|
tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
|
|
1717
1806
|
rowId: MaybeGetter<Id>,
|
|
1718
1807
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1719
1808
|
) => {readonly current: boolean};
|
|
1720
1809
|
|
|
1721
1810
|
/**
|
|
1722
|
-
* The
|
|
1723
|
-
* and registers a listener so that any changes to that Row will
|
|
1724
|
-
*
|
|
1811
|
+
* The getRow function returns a reactive object reflecting a Row in a Table,
|
|
1812
|
+
* and registers a listener so that any changes to that Row will update
|
|
1813
|
+
* `current`.
|
|
1725
1814
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1726
1815
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1727
1816
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1729,16 +1818,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1729
1818
|
* @category Getter
|
|
1730
1819
|
* @since v8.1.0
|
|
1731
1820
|
*/
|
|
1732
|
-
|
|
1821
|
+
getRow: <TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
1733
1822
|
tableId: MaybeGetter<TableId>,
|
|
1734
1823
|
rowId: MaybeGetter<Id>,
|
|
1735
1824
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1736
1825
|
) => {readonly current: Row<Schemas[0], TableId>};
|
|
1737
1826
|
|
|
1738
1827
|
/**
|
|
1739
|
-
* The
|
|
1740
|
-
*
|
|
1741
|
-
*
|
|
1828
|
+
* The getCellIds function returns a reactive object reflecting the Ids of the
|
|
1829
|
+
* Cells in a Row, and registers a listener so that any changes will update
|
|
1830
|
+
* `current`.
|
|
1742
1831
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1743
1832
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1744
1833
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1746,16 +1835,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1746
1835
|
* @category Getter
|
|
1747
1836
|
* @since v8.1.0
|
|
1748
1837
|
*/
|
|
1749
|
-
|
|
1838
|
+
getCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
1750
1839
|
tableId: MaybeGetter<TableId>,
|
|
1751
1840
|
rowId: MaybeGetter<Id>,
|
|
1752
1841
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1753
1842
|
) => {readonly current: CellIdFromSchema<Schemas[0], TableId>[]};
|
|
1754
1843
|
|
|
1755
1844
|
/**
|
|
1756
|
-
* The
|
|
1757
|
-
*
|
|
1758
|
-
*
|
|
1845
|
+
* The hasCell function returns a reactive object indicating whether a Cell
|
|
1846
|
+
* exists in a Row in a Table, and registers a listener so that any changes to
|
|
1847
|
+
* that result will update `current`.
|
|
1759
1848
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1760
1849
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1761
1850
|
* @param cellId The Id of the Cell (or a getter returning it).
|
|
@@ -1764,7 +1853,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1764
1853
|
* @category Getter
|
|
1765
1854
|
* @since v8.1.0
|
|
1766
1855
|
*/
|
|
1767
|
-
|
|
1856
|
+
hasCell: <
|
|
1768
1857
|
TableId extends TableIdFromSchema<Schemas[0]>,
|
|
1769
1858
|
CellId extends CellIdFromSchema<Schemas[0], TableId>,
|
|
1770
1859
|
>(
|
|
@@ -1775,14 +1864,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1775
1864
|
) => {readonly current: boolean};
|
|
1776
1865
|
|
|
1777
1866
|
/**
|
|
1778
|
-
* The
|
|
1779
|
-
*
|
|
1780
|
-
*
|
|
1867
|
+
* The getCell function returns a reactive object reflecting the value of a Cell
|
|
1868
|
+
* in a Row in a Table, and registers a listener so that any changes to that
|
|
1869
|
+
* Cell will update `current`.
|
|
1781
1870
|
*
|
|
1782
1871
|
* This has schema-based typing. The following is a simplified representation:
|
|
1783
1872
|
*
|
|
1784
1873
|
* ```ts override
|
|
1785
|
-
*
|
|
1874
|
+
* getCell(
|
|
1786
1875
|
* tableId: MaybeGetter<Id>,
|
|
1787
1876
|
* rowId: MaybeGetter<Id>,
|
|
1788
1877
|
* cellId: MaybeGetter<Id>,
|
|
@@ -1798,18 +1887,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1798
1887
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1799
1888
|
* @returns A reactive object with gettable and settable `current`.
|
|
1800
1889
|
* @example
|
|
1801
|
-
* This example uses the
|
|
1890
|
+
* This example uses the getCell function to display a Cell value reactively.
|
|
1802
1891
|
*
|
|
1803
1892
|
* ```ts
|
|
1804
1893
|
* // In a .svelte file:
|
|
1805
1894
|
* // const store = createStore().setCell('pets', 'cat', 'name', 'Fido');
|
|
1806
|
-
* // const name =
|
|
1895
|
+
* // const name = getCell('pets', 'cat', 'name', store);
|
|
1807
1896
|
* // $: console.log(name.current); // 'Fido'
|
|
1808
1897
|
* ```
|
|
1809
1898
|
* @category Getter
|
|
1810
1899
|
* @since v8.1.0
|
|
1811
1900
|
*/
|
|
1812
|
-
|
|
1901
|
+
getCell: <
|
|
1813
1902
|
TableId extends TableIdFromSchema<Schemas[0]>,
|
|
1814
1903
|
CellId extends CellIdFromSchema<Schemas[0], TableId>,
|
|
1815
1904
|
>(
|
|
@@ -1823,72 +1912,71 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1823
1912
|
};
|
|
1824
1913
|
|
|
1825
1914
|
/**
|
|
1826
|
-
* The
|
|
1915
|
+
* The hasValues function returns a reactive object indicating whether any
|
|
1827
1916
|
* Values exist in the Store, and registers a listener so that any changes to
|
|
1828
|
-
* that result will update
|
|
1917
|
+
* that result will update `current`.
|
|
1829
1918
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1830
1919
|
* @returns A reactive object with a `current` boolean property.
|
|
1831
1920
|
* @category Getter
|
|
1832
1921
|
* @since v8.1.0
|
|
1833
1922
|
*/
|
|
1834
|
-
|
|
1923
|
+
hasValues: (
|
|
1835
1924
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
|
|
1836
1925
|
) => {
|
|
1837
1926
|
readonly current: boolean;
|
|
1838
1927
|
};
|
|
1839
1928
|
|
|
1840
1929
|
/**
|
|
1841
|
-
* The
|
|
1842
|
-
*
|
|
1843
|
-
* update `.current`.
|
|
1930
|
+
* The getValues function returns a reactive object reflecting the Values in the
|
|
1931
|
+
* Store, and registers a listener so that any changes will update `current`.
|
|
1844
1932
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1845
1933
|
* @returns A reactive object with a `current` Values property.
|
|
1846
1934
|
* @category Getter
|
|
1847
1935
|
* @since v8.1.0
|
|
1848
1936
|
*/
|
|
1849
|
-
|
|
1937
|
+
getValues: (
|
|
1850
1938
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
|
|
1851
1939
|
) => {
|
|
1852
1940
|
readonly current: Values<Schemas[1]>;
|
|
1853
1941
|
};
|
|
1854
1942
|
|
|
1855
1943
|
/**
|
|
1856
|
-
* The
|
|
1857
|
-
*
|
|
1858
|
-
*
|
|
1944
|
+
* The getValueIds function returns a reactive object reflecting the Ids of the
|
|
1945
|
+
* Values in a Store, and registers a listener so that any changes will update
|
|
1946
|
+
* `current`.
|
|
1859
1947
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1860
1948
|
* @returns A reactive object with a `current` Ids property.
|
|
1861
1949
|
* @category Getter
|
|
1862
1950
|
* @since v8.1.0
|
|
1863
1951
|
*/
|
|
1864
|
-
|
|
1952
|
+
getValueIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
|
|
1865
1953
|
readonly current: ValueIdFromSchema<Schemas[1]>[];
|
|
1866
1954
|
};
|
|
1867
1955
|
|
|
1868
1956
|
/**
|
|
1869
|
-
* The
|
|
1870
|
-
*
|
|
1871
|
-
*
|
|
1957
|
+
* The hasValue function returns a reactive object indicating whether a Value
|
|
1958
|
+
* exists in the Store, and registers a listener so that any changes to that
|
|
1959
|
+
* result will update `current`.
|
|
1872
1960
|
* @param valueId The Id of the Value (or a getter returning it).
|
|
1873
1961
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1874
1962
|
* @returns A reactive object with a `current` boolean property.
|
|
1875
1963
|
* @category Getter
|
|
1876
1964
|
* @since v8.1.0
|
|
1877
1965
|
*/
|
|
1878
|
-
|
|
1966
|
+
hasValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
|
|
1879
1967
|
valueId: MaybeGetter<ValueId>,
|
|
1880
1968
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1881
1969
|
) => {readonly current: boolean};
|
|
1882
1970
|
|
|
1883
1971
|
/**
|
|
1884
|
-
* The
|
|
1972
|
+
* The getValue function returns a reactive object reflecting the value of a
|
|
1885
1973
|
* Value in a Store, and registers a listener so that any changes to that Value
|
|
1886
|
-
* will update
|
|
1974
|
+
* will update `current`.
|
|
1887
1975
|
*
|
|
1888
1976
|
* This has schema-based typing. The following is a simplified representation:
|
|
1889
1977
|
*
|
|
1890
1978
|
* ```ts override
|
|
1891
|
-
*
|
|
1979
|
+
* getValue(
|
|
1892
1980
|
* valueId: MaybeGetter<Id>,
|
|
1893
1981
|
* storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1894
1982
|
* ): {get current(): ValueOrUndefined; set current(v: Value)};
|
|
@@ -1902,7 +1990,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1902
1990
|
* @category Getter
|
|
1903
1991
|
* @since v8.1.0
|
|
1904
1992
|
*/
|
|
1905
|
-
|
|
1993
|
+
getValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
|
|
1906
1994
|
valueId: MaybeGetter<ValueId>,
|
|
1907
1995
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1908
1996
|
) => {
|
|
@@ -1933,13 +2021,13 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1933
2021
|
) => () => Store<Schemas> | undefined;
|
|
1934
2022
|
|
|
1935
2023
|
/**
|
|
1936
|
-
* The
|
|
1937
|
-
*
|
|
2024
|
+
* The getStoreIds function returns a reactive object with the Ids of all Stores
|
|
2025
|
+
* registered in the current Provider context.
|
|
1938
2026
|
* @returns A reactive object with a `current` Ids property.
|
|
1939
2027
|
* @category Getter
|
|
1940
2028
|
* @since v8.1.0
|
|
1941
2029
|
*/
|
|
1942
|
-
|
|
2030
|
+
getStoreIds: () => {readonly current: Ids};
|
|
1943
2031
|
|
|
1944
2032
|
/**
|
|
1945
2033
|
* The getMetrics function returns the default Metrics object from the current
|
|
@@ -1965,33 +2053,33 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1965
2053
|
) => () => Metrics<Schemas> | undefined;
|
|
1966
2054
|
|
|
1967
2055
|
/**
|
|
1968
|
-
* The
|
|
2056
|
+
* The getMetricsIds function returns a reactive object with the Ids of all
|
|
1969
2057
|
* Metrics objects registered in the current Provider context.
|
|
1970
2058
|
* @returns A reactive object with a `current` Ids property.
|
|
1971
2059
|
* @category Getter
|
|
1972
2060
|
* @since v8.1.0
|
|
1973
2061
|
*/
|
|
1974
|
-
|
|
2062
|
+
getMetricsIds: () => {readonly current: Ids};
|
|
1975
2063
|
|
|
1976
2064
|
/**
|
|
1977
|
-
* The
|
|
1978
|
-
*
|
|
1979
|
-
* will update
|
|
2065
|
+
* The getMetricIds function returns a reactive object reflecting the Ids of the
|
|
2066
|
+
* Metrics in a Metrics object, and registers a listener so that any changes
|
|
2067
|
+
* will update `current`.
|
|
1980
2068
|
* @param metricsOrMetricsId The Metrics object to use, or its Id.
|
|
1981
2069
|
* @returns A reactive object with a `current` Ids property.
|
|
1982
2070
|
* @category Getter
|
|
1983
2071
|
* @since v8.1.0
|
|
1984
2072
|
*/
|
|
1985
|
-
|
|
2073
|
+
getMetricIds: (
|
|
1986
2074
|
metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId<Schemas> | undefined>,
|
|
1987
2075
|
) => {
|
|
1988
2076
|
readonly current: Ids;
|
|
1989
2077
|
};
|
|
1990
2078
|
|
|
1991
2079
|
/**
|
|
1992
|
-
* The
|
|
2080
|
+
* The getMetric function returns a reactive object reflecting the value of a
|
|
1993
2081
|
* named Metric in a Metrics object, and registers a listener so that any
|
|
1994
|
-
* changes to that Metric will update
|
|
2082
|
+
* changes to that Metric will update `current`.
|
|
1995
2083
|
* @param metricId The Id of the Metric (or a getter returning it).
|
|
1996
2084
|
* @param metricsOrMetricsId The Metrics object to use (plain or getter), or its
|
|
1997
2085
|
* Id.
|
|
@@ -1999,7 +2087,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1999
2087
|
* @category Getter
|
|
2000
2088
|
* @since v8.1.0
|
|
2001
2089
|
*/
|
|
2002
|
-
|
|
2090
|
+
getMetric: (
|
|
2003
2091
|
metricId: MaybeGetter<Id>,
|
|
2004
2092
|
metricsOrMetricsId?: MetricsOrMetricsId<Schemas>,
|
|
2005
2093
|
) => {readonly current: number | undefined};
|
|
@@ -2045,33 +2133,33 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2045
2133
|
};
|
|
2046
2134
|
|
|
2047
2135
|
/**
|
|
2048
|
-
* The
|
|
2136
|
+
* The getIndexesIds function returns a reactive object with the Ids of all
|
|
2049
2137
|
* Indexes objects registered in the current Provider context.
|
|
2050
2138
|
* @returns A reactive object with a `current` Ids property.
|
|
2051
2139
|
* @category Getter
|
|
2052
2140
|
* @since v8.1.0
|
|
2053
2141
|
*/
|
|
2054
|
-
|
|
2142
|
+
getIndexesIds: () => {readonly current: Ids};
|
|
2055
2143
|
|
|
2056
2144
|
/**
|
|
2057
|
-
* The
|
|
2058
|
-
*
|
|
2059
|
-
*
|
|
2145
|
+
* The getIndexIds function returns a reactive object reflecting the Ids of the
|
|
2146
|
+
* Indexes in an Indexes object, and registers a listener so that any changes
|
|
2147
|
+
* will update `current`.
|
|
2060
2148
|
* @param indexesOrIndexesId The Indexes object to use, or its Id.
|
|
2061
2149
|
* @returns A reactive object with a `current` Ids property.
|
|
2062
2150
|
* @category Getter
|
|
2063
2151
|
* @since v8.1.0
|
|
2064
2152
|
*/
|
|
2065
|
-
|
|
2153
|
+
getIndexIds: (
|
|
2066
2154
|
indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId<Schemas> | undefined>,
|
|
2067
2155
|
) => {
|
|
2068
2156
|
readonly current: Ids;
|
|
2069
2157
|
};
|
|
2070
2158
|
|
|
2071
2159
|
/**
|
|
2072
|
-
* The
|
|
2073
|
-
*
|
|
2074
|
-
*
|
|
2160
|
+
* The getSliceIds function returns a reactive object reflecting the Ids of the
|
|
2161
|
+
* Slices in an Index, and registers a listener so that any changes will update
|
|
2162
|
+
* `current`.
|
|
2075
2163
|
* @param indexId The Id of the Index (or a getter returning it).
|
|
2076
2164
|
* @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
|
|
2077
2165
|
* Id.
|
|
@@ -2079,15 +2167,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2079
2167
|
* @category Getter
|
|
2080
2168
|
* @since v8.1.0
|
|
2081
2169
|
*/
|
|
2082
|
-
|
|
2170
|
+
getSliceIds: (
|
|
2083
2171
|
indexId: MaybeGetter<Id>,
|
|
2084
2172
|
indexesOrIndexesId?: IndexesOrIndexesId<Schemas>,
|
|
2085
2173
|
) => {readonly current: Ids};
|
|
2086
2174
|
|
|
2087
2175
|
/**
|
|
2088
|
-
* The
|
|
2089
|
-
*
|
|
2090
|
-
*
|
|
2176
|
+
* The getSliceRowIds function returns a reactive object reflecting the Ids of
|
|
2177
|
+
* the Rows in a Slice, and registers a listener so that any changes will update
|
|
2178
|
+
* `current`.
|
|
2091
2179
|
* @param indexId The Id of the Index (or a getter returning it).
|
|
2092
2180
|
* @param sliceId The Id of the Slice (or a getter returning it).
|
|
2093
2181
|
* @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
|
|
@@ -2096,7 +2184,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2096
2184
|
* @category Getter
|
|
2097
2185
|
* @since v8.1.0
|
|
2098
2186
|
*/
|
|
2099
|
-
|
|
2187
|
+
getSliceRowIds: (
|
|
2100
2188
|
indexId: MaybeGetter<Id>,
|
|
2101
2189
|
sliceId: MaybeGetter<Id>,
|
|
2102
2190
|
indexesOrIndexesId?: IndexesOrIndexesId<Schemas>,
|
|
@@ -2126,33 +2214,33 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2126
2214
|
) => () => Queries<Schemas> | undefined;
|
|
2127
2215
|
|
|
2128
2216
|
/**
|
|
2129
|
-
* The
|
|
2217
|
+
* The getQueriesIds function returns a reactive object with the Ids of all
|
|
2130
2218
|
* Queries objects registered in the current Provider context.
|
|
2131
2219
|
* @returns A reactive object with a `current` Ids property.
|
|
2132
2220
|
* @category Getter
|
|
2133
2221
|
* @since v8.1.0
|
|
2134
2222
|
*/
|
|
2135
|
-
|
|
2223
|
+
getQueriesIds: () => {readonly current: Ids};
|
|
2136
2224
|
|
|
2137
2225
|
/**
|
|
2138
|
-
* The
|
|
2139
|
-
*
|
|
2140
|
-
* will update
|
|
2226
|
+
* The getQueryIds function returns a reactive object reflecting the Ids of the
|
|
2227
|
+
* Queries in a Queries object, and registers a listener so that any changes
|
|
2228
|
+
* will update `current`.
|
|
2141
2229
|
* @param queriesOrQueriesId The Queries object to use, or its Id.
|
|
2142
2230
|
* @returns A reactive object with a `current` Ids property.
|
|
2143
2231
|
* @category Getter
|
|
2144
2232
|
* @since v8.1.0
|
|
2145
2233
|
*/
|
|
2146
|
-
|
|
2234
|
+
getQueryIds: (
|
|
2147
2235
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId<Schemas> | undefined>,
|
|
2148
2236
|
) => {
|
|
2149
2237
|
readonly current: Ids;
|
|
2150
2238
|
};
|
|
2151
2239
|
|
|
2152
2240
|
/**
|
|
2153
|
-
* The
|
|
2241
|
+
* The getResultTable function returns a reactive object reflecting a result
|
|
2154
2242
|
* Table in a Queries object, and registers a listener so that any changes to
|
|
2155
|
-
* that result will update
|
|
2243
|
+
* that result will update `current`.
|
|
2156
2244
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2157
2245
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2158
2246
|
* Id.
|
|
@@ -2160,15 +2248,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2160
2248
|
* @category Getter
|
|
2161
2249
|
* @since v8.1.0
|
|
2162
2250
|
*/
|
|
2163
|
-
|
|
2251
|
+
getResultTable: (
|
|
2164
2252
|
queryId: MaybeGetter<Id>,
|
|
2165
2253
|
queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
|
|
2166
2254
|
) => {readonly current: ResultTable};
|
|
2167
2255
|
|
|
2168
2256
|
/**
|
|
2169
|
-
* The
|
|
2170
|
-
*
|
|
2171
|
-
*
|
|
2257
|
+
* The getResultTableCellIds function returns a reactive object reflecting the
|
|
2258
|
+
* Ids of all Cells used across a result Table, and registers a listener so that
|
|
2259
|
+
* any changes will update `current`.
|
|
2172
2260
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2173
2261
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2174
2262
|
* Id.
|
|
@@ -2176,15 +2264,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2176
2264
|
* @category Getter
|
|
2177
2265
|
* @since v8.1.0
|
|
2178
2266
|
*/
|
|
2179
|
-
|
|
2267
|
+
getResultTableCellIds: (
|
|
2180
2268
|
queryId: MaybeGetter<Id>,
|
|
2181
2269
|
queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
|
|
2182
2270
|
) => {readonly current: Ids};
|
|
2183
2271
|
|
|
2184
2272
|
/**
|
|
2185
|
-
* The
|
|
2273
|
+
* The getResultRowCount function returns a reactive object reflecting the
|
|
2186
2274
|
* number of Rows in a result Table, and registers a listener so that any
|
|
2187
|
-
* changes will update
|
|
2275
|
+
* changes will update `current`.
|
|
2188
2276
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2189
2277
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2190
2278
|
* Id.
|
|
@@ -2192,15 +2280,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2192
2280
|
* @category Getter
|
|
2193
2281
|
* @since v8.1.0
|
|
2194
2282
|
*/
|
|
2195
|
-
|
|
2283
|
+
getResultRowCount: (
|
|
2196
2284
|
queryId: MaybeGetter<Id>,
|
|
2197
2285
|
queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
|
|
2198
2286
|
) => {readonly current: number};
|
|
2199
2287
|
|
|
2200
2288
|
/**
|
|
2201
|
-
* The
|
|
2202
|
-
*
|
|
2203
|
-
*
|
|
2289
|
+
* The getResultRowIds function returns a reactive object reflecting the Ids of
|
|
2290
|
+
* the Rows in a result Table, and registers a listener so that any changes will
|
|
2291
|
+
* update `current`.
|
|
2204
2292
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2205
2293
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2206
2294
|
* Id.
|
|
@@ -2208,15 +2296,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2208
2296
|
* @category Getter
|
|
2209
2297
|
* @since v8.1.0
|
|
2210
2298
|
*/
|
|
2211
|
-
|
|
2299
|
+
getResultRowIds: (
|
|
2212
2300
|
queryId: MaybeGetter<Id>,
|
|
2213
2301
|
queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
|
|
2214
2302
|
) => {readonly current: Ids};
|
|
2215
2303
|
|
|
2216
2304
|
/**
|
|
2217
|
-
* The
|
|
2218
|
-
*
|
|
2219
|
-
* changes will update
|
|
2305
|
+
* The getResultSortedRowIds function returns a reactive object reflecting the
|
|
2306
|
+
* sorted Row Ids in a result Table, and registers a listener so that any
|
|
2307
|
+
* changes will update `current`.
|
|
2220
2308
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2221
2309
|
* @param cellId The Id of the Cell to sort by (or a getter returning it).
|
|
2222
2310
|
* @param descending Whether to sort descending (or a getter returning it).
|
|
@@ -2228,7 +2316,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2228
2316
|
* @category Getter
|
|
2229
2317
|
* @since v8.1.0
|
|
2230
2318
|
*/
|
|
2231
|
-
|
|
2319
|
+
getResultSortedRowIds: (
|
|
2232
2320
|
queryId: MaybeGetter<Id>,
|
|
2233
2321
|
cellId?: MaybeGetter<Id | undefined>,
|
|
2234
2322
|
descending?: MaybeGetter<boolean>,
|
|
@@ -2238,9 +2326,9 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2238
2326
|
) => {readonly current: Ids};
|
|
2239
2327
|
|
|
2240
2328
|
/**
|
|
2241
|
-
* The
|
|
2242
|
-
*
|
|
2243
|
-
*
|
|
2329
|
+
* The getResultRow function returns a reactive object reflecting a result Row
|
|
2330
|
+
* in a result Table, and registers a listener so that any changes will update
|
|
2331
|
+
* `current`.
|
|
2244
2332
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2245
2333
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
2246
2334
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
@@ -2249,16 +2337,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2249
2337
|
* @category Getter
|
|
2250
2338
|
* @since v8.1.0
|
|
2251
2339
|
*/
|
|
2252
|
-
|
|
2340
|
+
getResultRow: (
|
|
2253
2341
|
queryId: MaybeGetter<Id>,
|
|
2254
2342
|
rowId: MaybeGetter<Id>,
|
|
2255
2343
|
queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
|
|
2256
2344
|
) => {readonly current: ResultRow};
|
|
2257
2345
|
|
|
2258
2346
|
/**
|
|
2259
|
-
* The
|
|
2260
|
-
*
|
|
2261
|
-
*
|
|
2347
|
+
* The getResultCellIds function returns a reactive object reflecting the Ids of
|
|
2348
|
+
* the Cells in a result Row, and registers a listener so that any changes will
|
|
2349
|
+
* update `current`.
|
|
2262
2350
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2263
2351
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
2264
2352
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
@@ -2267,16 +2355,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2267
2355
|
* @category Getter
|
|
2268
2356
|
* @since v8.1.0
|
|
2269
2357
|
*/
|
|
2270
|
-
|
|
2358
|
+
getResultCellIds: (
|
|
2271
2359
|
queryId: MaybeGetter<Id>,
|
|
2272
2360
|
rowId: MaybeGetter<Id>,
|
|
2273
2361
|
queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
|
|
2274
2362
|
) => {readonly current: Ids};
|
|
2275
2363
|
|
|
2276
2364
|
/**
|
|
2277
|
-
* The
|
|
2278
|
-
*
|
|
2279
|
-
* update
|
|
2365
|
+
* The getResultCell function returns a reactive object reflecting the value of
|
|
2366
|
+
* a Cell in a result Row, and registers a listener so that any changes will
|
|
2367
|
+
* update `current`.
|
|
2280
2368
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2281
2369
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
2282
2370
|
* @param cellId The Id of the Cell (or a getter returning it).
|
|
@@ -2286,7 +2374,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2286
2374
|
* @category Getter
|
|
2287
2375
|
* @since v8.1.0
|
|
2288
2376
|
*/
|
|
2289
|
-
|
|
2377
|
+
getResultCell: (
|
|
2290
2378
|
queryId: MaybeGetter<Id>,
|
|
2291
2379
|
rowId: MaybeGetter<Id>,
|
|
2292
2380
|
cellId: MaybeGetter<Id>,
|
|
@@ -2343,34 +2431,34 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2343
2431
|
};
|
|
2344
2432
|
|
|
2345
2433
|
/**
|
|
2346
|
-
* The
|
|
2434
|
+
* The getRelationshipsIds function returns a reactive object with the Ids of
|
|
2347
2435
|
* all Relationships objects registered in the current Provider context.
|
|
2348
2436
|
* @returns A reactive object with a `current` Ids property.
|
|
2349
2437
|
* @category Getter
|
|
2350
2438
|
* @since v8.1.0
|
|
2351
2439
|
*/
|
|
2352
|
-
|
|
2440
|
+
getRelationshipsIds: () => {readonly current: Ids};
|
|
2353
2441
|
|
|
2354
2442
|
/**
|
|
2355
|
-
* The
|
|
2356
|
-
*
|
|
2357
|
-
*
|
|
2443
|
+
* The getRelationshipIds function returns a reactive object reflecting the Ids
|
|
2444
|
+
* of the Relationships in a Relationships object, and registers a listener so
|
|
2445
|
+
* that any changes will update `current`.
|
|
2358
2446
|
* @param relationshipsOrRelationshipsId The Relationships object to use, or its
|
|
2359
2447
|
* Id.
|
|
2360
2448
|
* @returns A reactive object with a `current` Ids property.
|
|
2361
2449
|
* @category Getter
|
|
2362
2450
|
* @since v8.1.0
|
|
2363
2451
|
*/
|
|
2364
|
-
|
|
2452
|
+
getRelationshipIds: (
|
|
2365
2453
|
relationshipsOrRelationshipsId?: MaybeGetter<
|
|
2366
2454
|
RelationshipsOrRelationshipsId<Schemas> | undefined
|
|
2367
2455
|
>,
|
|
2368
2456
|
) => {readonly current: Ids};
|
|
2369
2457
|
|
|
2370
2458
|
/**
|
|
2371
|
-
* The
|
|
2372
|
-
*
|
|
2373
|
-
*
|
|
2459
|
+
* The getRemoteRowId function returns a reactive object reflecting the remote
|
|
2460
|
+
* Row Id for a given local Row in a Relationship, and registers a listener so
|
|
2461
|
+
* that any changes will update `current`.
|
|
2374
2462
|
* @param relationshipId The Id of the Relationship (or a getter returning it).
|
|
2375
2463
|
* @param localRowId The Id of the local Row (or a getter returning it).
|
|
2376
2464
|
* @param relationshipsOrRelationshipsId The Relationships object to use (plain
|
|
@@ -2379,16 +2467,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2379
2467
|
* @category Getter
|
|
2380
2468
|
* @since v8.1.0
|
|
2381
2469
|
*/
|
|
2382
|
-
|
|
2470
|
+
getRemoteRowId: (
|
|
2383
2471
|
relationshipId: MaybeGetter<Id>,
|
|
2384
2472
|
localRowId: MaybeGetter<Id>,
|
|
2385
2473
|
relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
|
|
2386
2474
|
) => {readonly current: Id | undefined};
|
|
2387
2475
|
|
|
2388
2476
|
/**
|
|
2389
|
-
* The
|
|
2477
|
+
* The getLocalRowIds function returns a reactive object reflecting the local
|
|
2390
2478
|
* Row Ids for a given remote Row in a Relationship, and registers a listener so
|
|
2391
|
-
* that any changes will update
|
|
2479
|
+
* that any changes will update `current`.
|
|
2392
2480
|
* @param relationshipId The Id of the Relationship (or a getter returning it).
|
|
2393
2481
|
* @param remoteRowId The Id of the remote Row (or a getter returning it).
|
|
2394
2482
|
* @param relationshipsOrRelationshipsId The Relationships object to use (plain
|
|
@@ -2397,16 +2485,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2397
2485
|
* @category Getter
|
|
2398
2486
|
* @since v8.1.0
|
|
2399
2487
|
*/
|
|
2400
|
-
|
|
2488
|
+
getLocalRowIds: (
|
|
2401
2489
|
relationshipId: MaybeGetter<Id>,
|
|
2402
2490
|
remoteRowId: MaybeGetter<Id>,
|
|
2403
2491
|
relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
|
|
2404
2492
|
) => {readonly current: Ids};
|
|
2405
2493
|
|
|
2406
2494
|
/**
|
|
2407
|
-
* The
|
|
2408
|
-
*
|
|
2409
|
-
*
|
|
2495
|
+
* The getLinkedRowIds function returns a reactive object reflecting the linked
|
|
2496
|
+
* Row Ids in a Relationship, and registers a listener so that any changes will
|
|
2497
|
+
* update `current`.
|
|
2410
2498
|
* @param relationshipId The Id of the Relationship (or a getter returning it).
|
|
2411
2499
|
* @param firstRowId The Id of the first Row (or a getter returning it).
|
|
2412
2500
|
* @param relationshipsOrRelationshipsId The Relationships object to use (plain
|
|
@@ -2415,7 +2503,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2415
2503
|
* @category Getter
|
|
2416
2504
|
* @since v8.1.0
|
|
2417
2505
|
*/
|
|
2418
|
-
|
|
2506
|
+
getLinkedRowIds: (
|
|
2419
2507
|
relationshipId: MaybeGetter<Id>,
|
|
2420
2508
|
firstRowId: MaybeGetter<Id>,
|
|
2421
2509
|
relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
|
|
@@ -2448,32 +2536,32 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2448
2536
|
) => () => Checkpoints<Schemas> | undefined;
|
|
2449
2537
|
|
|
2450
2538
|
/**
|
|
2451
|
-
* The
|
|
2452
|
-
*
|
|
2539
|
+
* The getCheckpointsIds function returns a reactive object with the Ids of all
|
|
2540
|
+
* Checkpoints objects registered in the current Provider context.
|
|
2453
2541
|
* @returns A reactive object with a `current` Ids property.
|
|
2454
2542
|
* @category Getter
|
|
2455
2543
|
* @since v8.1.0
|
|
2456
2544
|
*/
|
|
2457
|
-
|
|
2545
|
+
getCheckpointsIds: () => {readonly current: Ids};
|
|
2458
2546
|
|
|
2459
2547
|
/**
|
|
2460
|
-
* The
|
|
2548
|
+
* The getCheckpointIds function returns a reactive object reflecting the
|
|
2461
2549
|
* CheckpointIds (backward, current, forward) in a Checkpoints object, and
|
|
2462
|
-
* registers a listener so that any changes will update
|
|
2550
|
+
* registers a listener so that any changes will update `current`.
|
|
2463
2551
|
* @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
|
|
2464
2552
|
* getter), or its Id.
|
|
2465
2553
|
* @returns A reactive object with a `current` CheckpointIds property.
|
|
2466
2554
|
* @category Getter
|
|
2467
2555
|
* @since v8.1.0
|
|
2468
2556
|
*/
|
|
2469
|
-
|
|
2557
|
+
getCheckpointIds: (
|
|
2470
2558
|
checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
|
|
2471
2559
|
) => {readonly current: CheckpointIds};
|
|
2472
2560
|
|
|
2473
2561
|
/**
|
|
2474
|
-
* The
|
|
2475
|
-
*
|
|
2476
|
-
*
|
|
2562
|
+
* The getCheckpoint function returns a reactive object reflecting the label of
|
|
2563
|
+
* a checkpoint, and registers a listener so that any changes will update
|
|
2564
|
+
* `current`.
|
|
2477
2565
|
* @param checkpointId The Id of the checkpoint (or a getter returning it).
|
|
2478
2566
|
* @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
|
|
2479
2567
|
* getter), or its Id.
|
|
@@ -2481,7 +2569,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2481
2569
|
* @category Getter
|
|
2482
2570
|
* @since v8.1.0
|
|
2483
2571
|
*/
|
|
2484
|
-
|
|
2572
|
+
getCheckpoint: (
|
|
2485
2573
|
checkpointId: MaybeGetter<Id>,
|
|
2486
2574
|
checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
|
|
2487
2575
|
) => {readonly current: string | undefined};
|
|
@@ -2540,24 +2628,24 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2540
2628
|
) => () => AnyPersister<Schemas> | undefined;
|
|
2541
2629
|
|
|
2542
2630
|
/**
|
|
2543
|
-
* The
|
|
2631
|
+
* The getPersisterIds function returns a reactive object with the Ids of all
|
|
2544
2632
|
* Persisters registered in the current Provider context.
|
|
2545
2633
|
* @returns A reactive object with a `current` Ids property.
|
|
2546
2634
|
* @category Getter
|
|
2547
2635
|
* @since v8.1.0
|
|
2548
2636
|
*/
|
|
2549
|
-
|
|
2637
|
+
getPersisterIds: () => {readonly current: Ids};
|
|
2550
2638
|
|
|
2551
2639
|
/**
|
|
2552
|
-
* The
|
|
2640
|
+
* The getPersisterStatus function returns a reactive object reflecting the
|
|
2553
2641
|
* status of a Persister, and registers a listener so that any changes will
|
|
2554
|
-
* update
|
|
2642
|
+
* update `current`.
|
|
2555
2643
|
* @param persisterOrPersisterId The Persister to use, or its Id.
|
|
2556
2644
|
* @returns A reactive object with a `current` Status property.
|
|
2557
2645
|
* @category Getter
|
|
2558
2646
|
* @since v8.1.0
|
|
2559
2647
|
*/
|
|
2560
|
-
|
|
2648
|
+
getPersisterStatus: (
|
|
2561
2649
|
persisterOrPersisterId?: MaybeGetter<
|
|
2562
2650
|
PersisterOrPersisterId<Schemas> | undefined
|
|
2563
2651
|
>,
|
|
@@ -2591,24 +2679,24 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2591
2679
|
) => () => Synchronizer<Schemas> | undefined;
|
|
2592
2680
|
|
|
2593
2681
|
/**
|
|
2594
|
-
* The
|
|
2595
|
-
*
|
|
2682
|
+
* The getSynchronizerIds function returns a reactive object with the Ids of all
|
|
2683
|
+
* Synchronizers registered in the current Provider context.
|
|
2596
2684
|
* @returns A reactive object with a `current` Ids property.
|
|
2597
2685
|
* @category Getter
|
|
2598
2686
|
* @since v8.1.0
|
|
2599
2687
|
*/
|
|
2600
|
-
|
|
2688
|
+
getSynchronizerIds: () => {readonly current: Ids};
|
|
2601
2689
|
|
|
2602
2690
|
/**
|
|
2603
|
-
* The
|
|
2604
|
-
*
|
|
2605
|
-
*
|
|
2691
|
+
* The getSynchronizerStatus function returns a reactive object reflecting the
|
|
2692
|
+
* status of a Synchronizer, and registers a listener so that any changes will
|
|
2693
|
+
* update `current`.
|
|
2606
2694
|
* @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
|
|
2607
2695
|
* @returns A reactive object with a `current` Status property.
|
|
2608
2696
|
* @category Getter
|
|
2609
2697
|
* @since v8.1.0
|
|
2610
2698
|
*/
|
|
2611
|
-
|
|
2699
|
+
getSynchronizerStatus: (
|
|
2612
2700
|
synchronizerOrSynchronizerId?: MaybeGetter<
|
|
2613
2701
|
SynchronizerOrSynchronizerId<Schemas> | undefined
|
|
2614
2702
|
>,
|