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
|
@@ -8,12 +8,15 @@
|
|
|
8
8
|
* objects with a `current` property. Those functions register listeners such
|
|
9
9
|
* that components using them re-render when data changes.
|
|
10
10
|
*
|
|
11
|
+
* Functions like the getStore function and getMetrics function return TinyBase
|
|
12
|
+
* objects directly from Provider context. Functions like the getCell function,
|
|
13
|
+
* the getRow function, the getTable function, the getValue function, and the
|
|
14
|
+
* hasCell function return reactive objects whose `current` property reflects
|
|
15
|
+
* underlying TinyBase data.
|
|
16
|
+
*
|
|
11
17
|
* Function parameters accept either plain values or reactive getter functions
|
|
12
|
-
* (
|
|
18
|
+
* (as per the MaybeGetter type), so passing `() => tableId` from a `let`-bound
|
|
13
19
|
* Svelte prop makes the function re-execute whenever the prop changes.
|
|
14
|
-
*
|
|
15
|
-
* The components in this module provide a further abstraction over those
|
|
16
|
-
* functions to ease the composition of user interfaces that use TinyBase.
|
|
17
20
|
* @see Building UIs With Svelte guide
|
|
18
21
|
* @packageDocumentation
|
|
19
22
|
* @module ui-svelte
|
|
@@ -124,17 +127,17 @@ export type StoreOrStoreId = Store | Id;
|
|
|
124
127
|
* The MetricsOrMetricsId type is used when you need to refer to a Metrics
|
|
125
128
|
* object in a ui-svelte function or component.
|
|
126
129
|
*
|
|
127
|
-
* In some simple cases you will already have a direct reference to the
|
|
128
|
-
*
|
|
130
|
+
* In some simple cases you will already have a direct reference to the Metrics
|
|
131
|
+
* object.
|
|
129
132
|
*
|
|
130
133
|
* This module also includes a Provider component that can be used to wrap
|
|
131
134
|
* multiple Metrics objects into a context that can be used throughout the app.
|
|
132
|
-
* In this case you will want to refer to a Metrics object by its Id in
|
|
133
|
-
*
|
|
135
|
+
* In this case you will want to refer to a Metrics object by its Id in that
|
|
136
|
+
* context.
|
|
134
137
|
*
|
|
135
138
|
* Many functions and components in this ui-svelte module take this type as a
|
|
136
|
-
* parameter or a prop, allowing you to pass in either the Metrics object or
|
|
137
|
-
*
|
|
139
|
+
* parameter or a prop, allowing you to pass in either the Metrics object or its
|
|
140
|
+
* Id.
|
|
138
141
|
* @category Identity
|
|
139
142
|
* @since v8.1.0
|
|
140
143
|
*/
|
|
@@ -144,17 +147,17 @@ export type MetricsOrMetricsId = Metrics | Id;
|
|
|
144
147
|
* The IndexesOrIndexesId type is used when you need to refer to an Indexes
|
|
145
148
|
* object in a ui-svelte function or component.
|
|
146
149
|
*
|
|
147
|
-
* In some simple cases you will already have a direct reference to the
|
|
148
|
-
*
|
|
150
|
+
* In some simple cases you will already have a direct reference to the Indexes
|
|
151
|
+
* object.
|
|
149
152
|
*
|
|
150
153
|
* This module also includes a Provider component that can be used to wrap
|
|
151
154
|
* multiple Indexes objects into a context that can be used throughout the app.
|
|
152
|
-
* In this case you will want to refer to an Indexes object by its Id in
|
|
153
|
-
*
|
|
155
|
+
* In this case you will want to refer to an Indexes object by its Id in that
|
|
156
|
+
* context.
|
|
154
157
|
*
|
|
155
158
|
* Many functions and components in this ui-svelte module take this type as a
|
|
156
|
-
* parameter or a prop, allowing you to pass in either the Indexes object or
|
|
157
|
-
*
|
|
159
|
+
* parameter or a prop, allowing you to pass in either the Indexes object or its
|
|
160
|
+
* Id.
|
|
158
161
|
* @category Identity
|
|
159
162
|
* @since v8.1.0
|
|
160
163
|
*/
|
|
@@ -184,17 +187,17 @@ export type RelationshipsOrRelationshipsId = Relationships | Id;
|
|
|
184
187
|
* The QueriesOrQueriesId type is used when you need to refer to a Queries
|
|
185
188
|
* object in a ui-svelte function or component.
|
|
186
189
|
*
|
|
187
|
-
* In some simple cases you will already have a direct reference to the
|
|
188
|
-
*
|
|
190
|
+
* In some simple cases you will already have a direct reference to the Queries
|
|
191
|
+
* object.
|
|
189
192
|
*
|
|
190
193
|
* This module also includes a Provider component that can be used to wrap
|
|
191
194
|
* multiple Queries objects into a context that can be used throughout the app.
|
|
192
|
-
* In this case you will want to refer to a Queries object by its Id in
|
|
193
|
-
*
|
|
195
|
+
* In this case you will want to refer to a Queries object by its Id in that
|
|
196
|
+
* context.
|
|
194
197
|
*
|
|
195
198
|
* Many functions and components in this ui-svelte module take this type as a
|
|
196
|
-
* parameter or a prop, allowing you to pass in either the Queries object or
|
|
197
|
-
*
|
|
199
|
+
* parameter or a prop, allowing you to pass in either the Queries object or its
|
|
200
|
+
* Id.
|
|
198
201
|
* @category Identity
|
|
199
202
|
* @since v8.1.0
|
|
200
203
|
*/
|
|
@@ -252,8 +255,8 @@ export type PersisterOrPersisterId = AnyPersister | Id;
|
|
|
252
255
|
* in that context.
|
|
253
256
|
*
|
|
254
257
|
* Many functions and components in this ui-svelte module take this type as a
|
|
255
|
-
* parameter or a prop, allowing you to pass in either the Synchronizer or
|
|
256
|
-
*
|
|
258
|
+
* parameter or a prop, allowing you to pass in either the Synchronizer or its
|
|
259
|
+
* Id.
|
|
257
260
|
* @category Identity
|
|
258
261
|
* @since v8.1.0
|
|
259
262
|
*/
|
|
@@ -261,8 +264,9 @@ export type SynchronizerOrSynchronizerId = Synchronizer | Id;
|
|
|
261
264
|
|
|
262
265
|
/**
|
|
263
266
|
* ProviderProps props are used with the Provider component, so that Store,
|
|
264
|
-
* Metrics, Indexes, Relationships, Queries,
|
|
265
|
-
* passed into the context of a Svelte 5 application and
|
|
267
|
+
* Metrics, Indexes, Relationships, Queries, Checkpoints, Persisters, and
|
|
268
|
+
* Synchronizers can be passed into the context of a Svelte 5 application and
|
|
269
|
+
* used throughout.
|
|
266
270
|
*
|
|
267
271
|
* One of each type of object can be provided as a default within the context.
|
|
268
272
|
* Additionally, multiple of each type of object can be provided in an Id-keyed
|
|
@@ -383,47 +387,44 @@ export type ProviderProps = {
|
|
|
383
387
|
* @since v8.1.0
|
|
384
388
|
*/
|
|
385
389
|
readonly synchronizersById?: {readonly [id: Id]: Synchronizer};
|
|
386
|
-
/**
|
|
387
|
-
* The `children` prop of a ProviderProps object — the app subtree that will
|
|
388
|
-
* have access to the provided context.
|
|
389
|
-
* @category Prop
|
|
390
|
-
* @since v8.1.0
|
|
391
|
-
*/
|
|
392
390
|
readonly children: Snippet;
|
|
393
391
|
};
|
|
394
392
|
|
|
395
393
|
/**
|
|
396
|
-
*
|
|
394
|
+
* CellViewProps props are used for components that refer to a single Cell in a
|
|
395
|
+
* Row, such as the CellView component.
|
|
397
396
|
* @category Props
|
|
398
397
|
* @since v8.1.0
|
|
399
398
|
*/
|
|
400
399
|
export type CellViewProps = {
|
|
401
400
|
/**
|
|
402
|
-
* The
|
|
401
|
+
* The Id of the Table in the Store.
|
|
403
402
|
* @category Props
|
|
404
403
|
* @since v8.1.0
|
|
405
404
|
*/
|
|
406
405
|
readonly tableId: Id;
|
|
407
406
|
/**
|
|
408
|
-
* The
|
|
407
|
+
* The Id of the Row in the Table.
|
|
409
408
|
* @category Props
|
|
410
409
|
* @since v8.1.0
|
|
411
410
|
*/
|
|
412
411
|
readonly rowId: Id;
|
|
413
412
|
/**
|
|
414
|
-
* The
|
|
413
|
+
* The Id of the Cell in the Row to be rendered.
|
|
415
414
|
* @category Props
|
|
416
415
|
* @since v8.1.0
|
|
417
416
|
*/
|
|
418
417
|
readonly cellId: Id;
|
|
419
418
|
/**
|
|
420
|
-
* The
|
|
419
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
420
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
421
421
|
* @category Props
|
|
422
422
|
* @since v8.1.0
|
|
423
423
|
*/
|
|
424
424
|
readonly store?: StoreOrStoreId;
|
|
425
425
|
/**
|
|
426
|
-
*
|
|
426
|
+
* Whether the component should also render the Id of the Cell to assist with
|
|
427
|
+
* debugging.
|
|
427
428
|
* @category Props
|
|
428
429
|
* @since v8.1.0
|
|
429
430
|
*/
|
|
@@ -431,25 +432,28 @@ export type CellViewProps = {
|
|
|
431
432
|
};
|
|
432
433
|
|
|
433
434
|
/**
|
|
434
|
-
*
|
|
435
|
+
* ValueViewProps props are used for components that refer to a single Value in
|
|
436
|
+
* a Store, such as the ValueView component.
|
|
435
437
|
* @category Props
|
|
436
438
|
* @since v8.1.0
|
|
437
439
|
*/
|
|
438
440
|
export type ValueViewProps = {
|
|
439
441
|
/**
|
|
440
|
-
* The
|
|
442
|
+
* The Id of the Value in the Store to be rendered.
|
|
441
443
|
* @category Props
|
|
442
444
|
* @since v8.1.0
|
|
443
445
|
*/
|
|
444
446
|
readonly valueId: Id;
|
|
445
447
|
/**
|
|
446
|
-
* The
|
|
448
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
449
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
447
450
|
* @category Props
|
|
448
451
|
* @since v8.1.0
|
|
449
452
|
*/
|
|
450
453
|
readonly store?: StoreOrStoreId;
|
|
451
454
|
/**
|
|
452
|
-
*
|
|
455
|
+
* Whether the component should also render the Id of the Value to assist
|
|
456
|
+
* with debugging.
|
|
453
457
|
* @category Props
|
|
454
458
|
* @since v8.1.0
|
|
455
459
|
*/
|
|
@@ -457,25 +461,29 @@ export type ValueViewProps = {
|
|
|
457
461
|
};
|
|
458
462
|
|
|
459
463
|
/**
|
|
460
|
-
*
|
|
464
|
+
* MetricViewProps props are used for components that refer to a single Metric
|
|
465
|
+
* in a Metrics object, such as the MetricView component.
|
|
461
466
|
* @category Props
|
|
462
467
|
* @since v8.1.0
|
|
463
468
|
*/
|
|
464
469
|
export type MetricViewProps = {
|
|
465
470
|
/**
|
|
466
|
-
* The
|
|
471
|
+
* The Id of the Metric in the Metrics object to be rendered.
|
|
467
472
|
* @category Props
|
|
468
473
|
* @since v8.1.0
|
|
469
474
|
*/
|
|
470
475
|
readonly metricId: Id;
|
|
471
476
|
/**
|
|
472
|
-
* The
|
|
477
|
+
* The Metrics object to be accessed: omit for the default context Metrics
|
|
478
|
+
* object, provide an Id for a named context Metrics object, or provide an
|
|
479
|
+
* explicit reference.
|
|
473
480
|
* @category Props
|
|
474
481
|
* @since v8.1.0
|
|
475
482
|
*/
|
|
476
483
|
readonly metrics?: MetricsOrMetricsId;
|
|
477
484
|
/**
|
|
478
|
-
*
|
|
485
|
+
* Whether the component should also render the Id of the Metric to assist
|
|
486
|
+
* with debugging.
|
|
479
487
|
* @category Props
|
|
480
488
|
* @since v8.1.0
|
|
481
489
|
*/
|
|
@@ -483,26 +491,29 @@ export type MetricViewProps = {
|
|
|
483
491
|
};
|
|
484
492
|
|
|
485
493
|
/**
|
|
486
|
-
*
|
|
487
|
-
* CheckpointView component.
|
|
494
|
+
* CheckpointViewProps props are used for components that refer to a single
|
|
495
|
+
* checkpoint in a Checkpoints object, such as the CheckpointView component.
|
|
488
496
|
* @category Props
|
|
489
497
|
* @since v8.1.0
|
|
490
498
|
*/
|
|
491
499
|
export type CheckpointViewProps = {
|
|
492
500
|
/**
|
|
493
|
-
* The
|
|
501
|
+
* The Id of the checkpoint in the Checkpoints object.
|
|
494
502
|
* @category Props
|
|
495
503
|
* @since v8.1.0
|
|
496
504
|
*/
|
|
497
505
|
readonly checkpointId: Id;
|
|
498
506
|
/**
|
|
499
|
-
* The
|
|
507
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
508
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
509
|
+
* or provide an explicit reference.
|
|
500
510
|
* @category Props
|
|
501
511
|
* @since v8.1.0
|
|
502
512
|
*/
|
|
503
513
|
readonly checkpoints?: CheckpointsOrCheckpointsId;
|
|
504
514
|
/**
|
|
505
|
-
*
|
|
515
|
+
* Whether the component should also render the Id of the checkpoint to
|
|
516
|
+
* assist with debugging.
|
|
506
517
|
* @category Props
|
|
507
518
|
* @since v8.1.0
|
|
508
519
|
*/
|
|
@@ -510,49 +521,54 @@ export type CheckpointViewProps = {
|
|
|
510
521
|
};
|
|
511
522
|
|
|
512
523
|
/**
|
|
513
|
-
*
|
|
524
|
+
* RowViewProps props are used for components that refer to a single Row in a
|
|
525
|
+
* Table, such as the RowView component.
|
|
514
526
|
* @category Props
|
|
515
527
|
* @since v8.1.0
|
|
516
528
|
*/
|
|
517
529
|
export type RowViewProps = {
|
|
518
530
|
/**
|
|
519
|
-
* The
|
|
531
|
+
* The Id of the Table in the Store.
|
|
520
532
|
* @category Props
|
|
521
533
|
* @since v8.1.0
|
|
522
534
|
*/
|
|
523
535
|
readonly tableId: Id;
|
|
524
536
|
/**
|
|
525
|
-
* The
|
|
537
|
+
* The Id of the Row in the Table to be rendered.
|
|
526
538
|
* @category Props
|
|
527
539
|
* @since v8.1.0
|
|
528
540
|
*/
|
|
529
541
|
readonly rowId: Id;
|
|
530
542
|
/**
|
|
531
|
-
* The
|
|
543
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
544
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
532
545
|
* @category Props
|
|
533
546
|
* @since v8.1.0
|
|
534
547
|
*/
|
|
535
548
|
readonly store?: StoreOrStoreId;
|
|
536
549
|
/**
|
|
537
|
-
*
|
|
550
|
+
* An optional list of Cell Ids to use for rendering a prescribed set of the
|
|
551
|
+
* Row's Cells in a given order.
|
|
538
552
|
* @category Props
|
|
539
553
|
* @since v8.1.0
|
|
540
554
|
*/
|
|
541
555
|
readonly customCellIds?: Ids;
|
|
542
556
|
/**
|
|
543
|
-
*
|
|
557
|
+
* A component or string to separate each rendered Cell.
|
|
544
558
|
* @category Props
|
|
545
559
|
* @since v8.1.0
|
|
546
560
|
*/
|
|
547
561
|
readonly separator?: Snippet<[]>;
|
|
548
562
|
/**
|
|
549
|
-
*
|
|
563
|
+
* Whether the component should also render the Id of the Row, and its
|
|
564
|
+
* descendent objects, to assist with debugging.
|
|
550
565
|
* @category Props
|
|
551
566
|
* @since v8.1.0
|
|
552
567
|
*/
|
|
553
568
|
readonly debugIds?: boolean;
|
|
554
569
|
/**
|
|
555
|
-
*
|
|
570
|
+
* A snippet for rendering each Cell in the Row, to override the default
|
|
571
|
+
* CellView component.
|
|
556
572
|
* @category Props
|
|
557
573
|
* @since v8.1.0
|
|
558
574
|
*/
|
|
@@ -560,43 +576,48 @@ export type RowViewProps = {
|
|
|
560
576
|
};
|
|
561
577
|
|
|
562
578
|
/**
|
|
563
|
-
*
|
|
579
|
+
* TableViewProps props are used for components that refer to a single Table in
|
|
580
|
+
* a Store, such as the TableView component.
|
|
564
581
|
* @category Props
|
|
565
582
|
* @since v8.1.0
|
|
566
583
|
*/
|
|
567
584
|
export type TableViewProps = {
|
|
568
585
|
/**
|
|
569
|
-
* The
|
|
586
|
+
* The Id of the Table in the Store to be rendered.
|
|
570
587
|
* @category Props
|
|
571
588
|
* @since v8.1.0
|
|
572
589
|
*/
|
|
573
590
|
readonly tableId: Id;
|
|
574
591
|
/**
|
|
575
|
-
* The
|
|
592
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
593
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
576
594
|
* @category Props
|
|
577
595
|
* @since v8.1.0
|
|
578
596
|
*/
|
|
579
597
|
readonly store?: StoreOrStoreId;
|
|
580
598
|
/**
|
|
581
|
-
*
|
|
599
|
+
* An optional list of Cell Ids to use for rendering a prescribed set of the
|
|
600
|
+
* Table's Cells in a given order for each Row.
|
|
582
601
|
* @category Props
|
|
583
602
|
* @since v8.1.0
|
|
584
603
|
*/
|
|
585
604
|
readonly customCellIds?: Ids;
|
|
586
605
|
/**
|
|
587
|
-
*
|
|
606
|
+
* A component or string to separate each rendered Row.
|
|
588
607
|
* @category Props
|
|
589
608
|
* @since v8.1.0
|
|
590
609
|
*/
|
|
591
610
|
readonly separator?: Snippet<[]>;
|
|
592
611
|
/**
|
|
593
|
-
*
|
|
612
|
+
* Whether the component should also render the Id of the Table, and its
|
|
613
|
+
* descendent objects, to assist with debugging.
|
|
594
614
|
* @category Props
|
|
595
615
|
* @since v8.1.0
|
|
596
616
|
*/
|
|
597
617
|
readonly debugIds?: boolean;
|
|
598
618
|
/**
|
|
599
|
-
*
|
|
619
|
+
* A snippet for rendering each Row in the Table, to override the default
|
|
620
|
+
* RowView component.
|
|
600
621
|
* @category Props
|
|
601
622
|
* @since v8.1.0
|
|
602
623
|
*/
|
|
@@ -604,68 +625,73 @@ export type TableViewProps = {
|
|
|
604
625
|
};
|
|
605
626
|
|
|
606
627
|
/**
|
|
607
|
-
*
|
|
608
|
-
* SortedTableView component.
|
|
628
|
+
* SortedTableViewProps props are used for components that refer to a single
|
|
629
|
+
* sorted Table in a Store, such as the SortedTableView component.
|
|
609
630
|
* @category Props
|
|
610
631
|
* @since v8.1.0
|
|
611
632
|
*/
|
|
612
633
|
export type SortedTableViewProps = {
|
|
613
634
|
/**
|
|
614
|
-
* The
|
|
635
|
+
* The Id of the Table in the Store to be rendered.
|
|
615
636
|
* @category Props
|
|
616
637
|
* @since v8.1.0
|
|
617
638
|
*/
|
|
618
639
|
readonly tableId: Id;
|
|
619
640
|
/**
|
|
620
|
-
* The
|
|
641
|
+
* The Id of the Cell whose values are used for sorting. If omitted, the view
|
|
642
|
+
* will sort the Row Id itself.
|
|
621
643
|
* @category Props
|
|
622
644
|
* @since v8.1.0
|
|
623
645
|
*/
|
|
624
646
|
readonly cellId?: Id;
|
|
625
647
|
/**
|
|
626
|
-
*
|
|
648
|
+
* Whether the sorting should be in descending order.
|
|
627
649
|
* @category Props
|
|
628
650
|
* @since v8.1.0
|
|
629
651
|
*/
|
|
630
652
|
readonly descending?: boolean;
|
|
631
653
|
/**
|
|
632
|
-
* The
|
|
654
|
+
* The number of Row Ids to skip for pagination purposes.
|
|
633
655
|
* @category Props
|
|
634
656
|
* @since v8.1.0
|
|
635
657
|
*/
|
|
636
658
|
readonly offset?: number;
|
|
637
659
|
/**
|
|
638
|
-
* The
|
|
660
|
+
* The maximum number of Row Ids to return.
|
|
639
661
|
* @category Props
|
|
640
662
|
* @since v8.1.0
|
|
641
663
|
*/
|
|
642
664
|
readonly limit?: number;
|
|
643
665
|
/**
|
|
644
|
-
* The
|
|
666
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
667
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
645
668
|
* @category Props
|
|
646
669
|
* @since v8.1.0
|
|
647
670
|
*/
|
|
648
671
|
readonly store?: StoreOrStoreId;
|
|
649
672
|
/**
|
|
650
|
-
*
|
|
673
|
+
* An optional list of Cell Ids to use for rendering a prescribed set of the
|
|
674
|
+
* sorted Table's Cells in a given order.
|
|
651
675
|
* @category Props
|
|
652
676
|
* @since v8.1.0
|
|
653
677
|
*/
|
|
654
678
|
readonly customCellIds?: Ids;
|
|
655
679
|
/**
|
|
656
|
-
*
|
|
680
|
+
* A component or string to separate each rendered Row.
|
|
657
681
|
* @category Props
|
|
658
682
|
* @since v8.1.0
|
|
659
683
|
*/
|
|
660
684
|
readonly separator?: Snippet<[]>;
|
|
661
685
|
/**
|
|
662
|
-
*
|
|
686
|
+
* Whether the component should also render the Id of the Table, and its
|
|
687
|
+
* descendent objects, to assist with debugging.
|
|
663
688
|
* @category Props
|
|
664
689
|
* @since v8.1.0
|
|
665
690
|
*/
|
|
666
691
|
readonly debugIds?: boolean;
|
|
667
692
|
/**
|
|
668
|
-
*
|
|
693
|
+
* A snippet for rendering each Row in the sorted Table, to override the
|
|
694
|
+
* default RowView component.
|
|
669
695
|
* @category Props
|
|
670
696
|
* @since v8.1.0
|
|
671
697
|
*/
|
|
@@ -673,31 +699,35 @@ export type SortedTableViewProps = {
|
|
|
673
699
|
};
|
|
674
700
|
|
|
675
701
|
/**
|
|
676
|
-
*
|
|
702
|
+
* TablesViewProps props are used for components that refer to all the Tables
|
|
703
|
+
* in a Store, such as the TablesView component.
|
|
677
704
|
* @category Props
|
|
678
705
|
* @since v8.1.0
|
|
679
706
|
*/
|
|
680
707
|
export type TablesViewProps = {
|
|
681
708
|
/**
|
|
682
|
-
* The
|
|
709
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
710
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
683
711
|
* @category Props
|
|
684
712
|
* @since v8.1.0
|
|
685
713
|
*/
|
|
686
714
|
readonly store?: StoreOrStoreId;
|
|
687
715
|
/**
|
|
688
|
-
*
|
|
716
|
+
* A component or string to separate each rendered Table.
|
|
689
717
|
* @category Props
|
|
690
718
|
* @since v8.1.0
|
|
691
719
|
*/
|
|
692
720
|
readonly separator?: Snippet<[]>;
|
|
693
721
|
/**
|
|
694
|
-
*
|
|
722
|
+
* Whether the component should also render the Ids of each Table, and its
|
|
723
|
+
* descendent objects, to assist with debugging.
|
|
695
724
|
* @category Props
|
|
696
725
|
* @since v8.1.0
|
|
697
726
|
*/
|
|
698
727
|
readonly debugIds?: boolean;
|
|
699
728
|
/**
|
|
700
|
-
*
|
|
729
|
+
* A snippet for rendering each Table in the Store, to override the default
|
|
730
|
+
* TableView component.
|
|
701
731
|
* @category Props
|
|
702
732
|
* @since v8.1.0
|
|
703
733
|
*/
|
|
@@ -705,31 +735,35 @@ export type TablesViewProps = {
|
|
|
705
735
|
};
|
|
706
736
|
|
|
707
737
|
/**
|
|
708
|
-
*
|
|
738
|
+
* ValuesViewProps props are used for components that refer to all the Values
|
|
739
|
+
* in a Store, such as the ValuesView component.
|
|
709
740
|
* @category Props
|
|
710
741
|
* @since v8.1.0
|
|
711
742
|
*/
|
|
712
743
|
export type ValuesViewProps = {
|
|
713
744
|
/**
|
|
714
|
-
* The
|
|
745
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
746
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
715
747
|
* @category Props
|
|
716
748
|
* @since v8.1.0
|
|
717
749
|
*/
|
|
718
750
|
readonly store?: StoreOrStoreId;
|
|
719
751
|
/**
|
|
720
|
-
*
|
|
752
|
+
* A component or string to separate each rendered Value.
|
|
721
753
|
* @category Props
|
|
722
754
|
* @since v8.1.0
|
|
723
755
|
*/
|
|
724
756
|
readonly separator?: Snippet<[]>;
|
|
725
757
|
/**
|
|
726
|
-
*
|
|
758
|
+
* Whether the component should also render the Ids of each Value to assist
|
|
759
|
+
* with debugging.
|
|
727
760
|
* @category Props
|
|
728
761
|
* @since v8.1.0
|
|
729
762
|
*/
|
|
730
763
|
readonly debugIds?: boolean;
|
|
731
764
|
/**
|
|
732
|
-
*
|
|
765
|
+
* A snippet for rendering each Value in the Store, to override the default
|
|
766
|
+
* ValueView component.
|
|
733
767
|
* @category Props
|
|
734
768
|
* @since v8.1.0
|
|
735
769
|
*/
|
|
@@ -737,37 +771,41 @@ export type ValuesViewProps = {
|
|
|
737
771
|
};
|
|
738
772
|
|
|
739
773
|
/**
|
|
740
|
-
*
|
|
774
|
+
* IndexViewProps props are used for components that refer to a single Index in
|
|
775
|
+
* an Indexes object, such as the IndexView component.
|
|
741
776
|
* @category Props
|
|
742
777
|
* @since v8.1.0
|
|
743
778
|
*/
|
|
744
779
|
export type IndexViewProps = {
|
|
745
780
|
/**
|
|
746
|
-
* The
|
|
781
|
+
* The Id of the Index in the Indexes object to be rendered.
|
|
747
782
|
* @category Props
|
|
748
783
|
* @since v8.1.0
|
|
749
784
|
*/
|
|
750
785
|
readonly indexId: Id;
|
|
751
786
|
/**
|
|
752
|
-
* The
|
|
787
|
+
* The Indexes object to be accessed: omit for the default context Indexes
|
|
788
|
+
* object, provide an Id for a named context Indexes object, or provide an
|
|
789
|
+
* explicit reference.
|
|
753
790
|
* @category Props
|
|
754
791
|
* @since v8.1.0
|
|
755
792
|
*/
|
|
756
793
|
readonly indexes?: IndexesOrIndexesId;
|
|
757
794
|
/**
|
|
758
|
-
*
|
|
795
|
+
* A component or string to separate each rendered Slice.
|
|
759
796
|
* @category Props
|
|
760
797
|
* @since v8.1.0
|
|
761
798
|
*/
|
|
762
799
|
readonly separator?: Snippet<[]>;
|
|
763
800
|
/**
|
|
764
|
-
*
|
|
801
|
+
* Whether the component should also render the Id of the Index, and its
|
|
802
|
+
* descendent objects, to assist with debugging.
|
|
765
803
|
* @category Props
|
|
766
804
|
* @since v8.1.0
|
|
767
805
|
*/
|
|
768
806
|
readonly debugIds?: boolean;
|
|
769
807
|
/**
|
|
770
|
-
*
|
|
808
|
+
* A snippet for rendering each Slice in the Index.
|
|
771
809
|
* @category Props
|
|
772
810
|
* @since v8.1.0
|
|
773
811
|
*/
|
|
@@ -775,43 +813,48 @@ export type IndexViewProps = {
|
|
|
775
813
|
};
|
|
776
814
|
|
|
777
815
|
/**
|
|
778
|
-
*
|
|
816
|
+
* SliceViewProps props are used for components that refer to a single Slice in
|
|
817
|
+
* an Index object, such as the SliceView component.
|
|
779
818
|
* @category Props
|
|
780
819
|
* @since v8.1.0
|
|
781
820
|
*/
|
|
782
821
|
export type SliceViewProps = {
|
|
783
822
|
/**
|
|
784
|
-
* The
|
|
823
|
+
* The Id of the Index in the Indexes object.
|
|
785
824
|
* @category Props
|
|
786
825
|
* @since v8.1.0
|
|
787
826
|
*/
|
|
788
827
|
readonly indexId: Id;
|
|
789
828
|
/**
|
|
790
|
-
* The
|
|
829
|
+
* The Id of the Slice in the Index to be rendered.
|
|
791
830
|
* @category Props
|
|
792
831
|
* @since v8.1.0
|
|
793
832
|
*/
|
|
794
833
|
readonly sliceId: Id;
|
|
795
834
|
/**
|
|
796
|
-
* The
|
|
835
|
+
* The Indexes object to be accessed: omit for the default context Indexes
|
|
836
|
+
* object, provide an Id for a named context Indexes object, or provide an
|
|
837
|
+
* explicit reference.
|
|
797
838
|
* @category Props
|
|
798
839
|
* @since v8.1.0
|
|
799
840
|
*/
|
|
800
841
|
readonly indexes?: IndexesOrIndexesId;
|
|
801
842
|
/**
|
|
802
|
-
*
|
|
843
|
+
* A component or string to separate each rendered Row.
|
|
803
844
|
* @category Props
|
|
804
845
|
* @since v8.1.0
|
|
805
846
|
*/
|
|
806
847
|
readonly separator?: Snippet<[]>;
|
|
807
848
|
/**
|
|
808
|
-
*
|
|
849
|
+
* Whether the component should also render the Id of the Slice, and its
|
|
850
|
+
* descendent objects, to assist with debugging.
|
|
809
851
|
* @category Props
|
|
810
852
|
* @since v8.1.0
|
|
811
853
|
*/
|
|
812
854
|
readonly debugIds?: boolean;
|
|
813
855
|
/**
|
|
814
|
-
*
|
|
856
|
+
* A snippet for rendering each Row in the Slice, to override the default
|
|
857
|
+
* RowView component.
|
|
815
858
|
* @category Props
|
|
816
859
|
* @since v8.1.0
|
|
817
860
|
*/
|
|
@@ -819,38 +862,43 @@ export type SliceViewProps = {
|
|
|
819
862
|
};
|
|
820
863
|
|
|
821
864
|
/**
|
|
822
|
-
*
|
|
823
|
-
*
|
|
865
|
+
* RemoteRowViewProps props are used for components that refer to a single
|
|
866
|
+
* Relationship in a Relationships object, and where you want to render a
|
|
867
|
+
* remote Row based on a local Row, such as in the RemoteRowView component.
|
|
824
868
|
* @category Props
|
|
825
869
|
* @since v8.1.0
|
|
826
870
|
*/
|
|
827
871
|
export type RemoteRowViewProps = {
|
|
828
872
|
/**
|
|
829
|
-
* The
|
|
873
|
+
* The Id of the Relationship in the Relationships object.
|
|
830
874
|
* @category Props
|
|
831
875
|
* @since v8.1.0
|
|
832
876
|
*/
|
|
833
877
|
readonly relationshipId: Id;
|
|
834
878
|
/**
|
|
835
|
-
* The
|
|
879
|
+
* The Id of the local Row for which to render the remote Row.
|
|
836
880
|
* @category Props
|
|
837
881
|
* @since v8.1.0
|
|
838
882
|
*/
|
|
839
883
|
readonly localRowId: Id;
|
|
840
884
|
/**
|
|
841
|
-
* The
|
|
885
|
+
* The Relationships object to be accessed: omit for the default context
|
|
886
|
+
* Relationships object, provide an Id for a named context Relationships
|
|
887
|
+
* object, or provide an explicit reference.
|
|
842
888
|
* @category Props
|
|
843
889
|
* @since v8.1.0
|
|
844
890
|
*/
|
|
845
891
|
readonly relationships?: RelationshipsOrRelationshipsId;
|
|
846
892
|
/**
|
|
847
|
-
*
|
|
893
|
+
* Whether the component should also render the Id of the Row in the
|
|
894
|
+
* Relationship, and its descendent objects, to assist with debugging.
|
|
848
895
|
* @category Props
|
|
849
896
|
* @since v8.1.0
|
|
850
897
|
*/
|
|
851
898
|
readonly debugIds?: boolean;
|
|
852
899
|
/**
|
|
853
|
-
*
|
|
900
|
+
* A snippet for rendering each (remote, local, or linked) Row in the
|
|
901
|
+
* Relationship.
|
|
854
902
|
* @category Props
|
|
855
903
|
* @since v8.1.0
|
|
856
904
|
*/
|
|
@@ -858,44 +906,49 @@ export type RemoteRowViewProps = {
|
|
|
858
906
|
};
|
|
859
907
|
|
|
860
908
|
/**
|
|
861
|
-
*
|
|
862
|
-
*
|
|
909
|
+
* LocalRowsViewProps props are used for components that refer to a single
|
|
910
|
+
* Relationship in a Relationships object, and where you want to render local
|
|
911
|
+
* Rows based on a remote Row, such as the LocalRowsView component.
|
|
863
912
|
* @category Props
|
|
864
913
|
* @since v8.1.0
|
|
865
914
|
*/
|
|
866
915
|
export type LocalRowsViewProps = {
|
|
867
916
|
/**
|
|
868
|
-
* The
|
|
917
|
+
* The Id of the Relationship in the Relationships object.
|
|
869
918
|
* @category Props
|
|
870
919
|
* @since v8.1.0
|
|
871
920
|
*/
|
|
872
921
|
readonly relationshipId: Id;
|
|
873
922
|
/**
|
|
874
|
-
* The
|
|
923
|
+
* The Id of the remote Row for which to render the local Rows.
|
|
875
924
|
* @category Props
|
|
876
925
|
* @since v8.1.0
|
|
877
926
|
*/
|
|
878
927
|
readonly remoteRowId: Id;
|
|
879
928
|
/**
|
|
880
|
-
* The
|
|
929
|
+
* The Relationships object to be accessed: omit for the default context
|
|
930
|
+
* Relationships object, provide an Id for a named context Relationships
|
|
931
|
+
* object, or provide an explicit reference.
|
|
881
932
|
* @category Props
|
|
882
933
|
* @since v8.1.0
|
|
883
934
|
*/
|
|
884
935
|
readonly relationships?: RelationshipsOrRelationshipsId;
|
|
885
936
|
/**
|
|
886
|
-
*
|
|
937
|
+
* A component or string to separate each rendered Row.
|
|
887
938
|
* @category Props
|
|
888
939
|
* @since v8.1.0
|
|
889
940
|
*/
|
|
890
941
|
readonly separator?: Snippet<[]>;
|
|
891
942
|
/**
|
|
892
|
-
*
|
|
943
|
+
* Whether the component should also render the Id of the Row in the
|
|
944
|
+
* Relationship, and its descendent objects, to assist with debugging.
|
|
893
945
|
* @category Props
|
|
894
946
|
* @since v8.1.0
|
|
895
947
|
*/
|
|
896
948
|
readonly debugIds?: boolean;
|
|
897
949
|
/**
|
|
898
|
-
*
|
|
950
|
+
* A snippet for rendering each (remote, local, or linked) Row in the
|
|
951
|
+
* Relationship.
|
|
899
952
|
* @category Props
|
|
900
953
|
* @since v8.1.0
|
|
901
954
|
*/
|
|
@@ -903,44 +956,50 @@ export type LocalRowsViewProps = {
|
|
|
903
956
|
};
|
|
904
957
|
|
|
905
958
|
/**
|
|
906
|
-
*
|
|
907
|
-
*
|
|
959
|
+
* LinkedRowsViewProps props are used for components that refer to a single
|
|
960
|
+
* Relationship in a Relationships object, and where you want to render a
|
|
961
|
+
* linked list of Rows starting from a first Row, such as the LinkedRowsView
|
|
962
|
+
* component.
|
|
908
963
|
* @category Props
|
|
909
964
|
* @since v8.1.0
|
|
910
965
|
*/
|
|
911
966
|
export type LinkedRowsViewProps = {
|
|
912
967
|
/**
|
|
913
|
-
* The
|
|
968
|
+
* The Id of the Relationship in the Relationships object.
|
|
914
969
|
* @category Props
|
|
915
970
|
* @since v8.1.0
|
|
916
971
|
*/
|
|
917
972
|
readonly relationshipId: Id;
|
|
918
973
|
/**
|
|
919
|
-
* The
|
|
974
|
+
* The Id of the first Row in the linked list Relationship.
|
|
920
975
|
* @category Props
|
|
921
976
|
* @since v8.1.0
|
|
922
977
|
*/
|
|
923
978
|
readonly firstRowId: Id;
|
|
924
979
|
/**
|
|
925
|
-
* The
|
|
980
|
+
* The Relationships object to be accessed: omit for the default context
|
|
981
|
+
* Relationships object, provide an Id for a named context Relationships
|
|
982
|
+
* object, or provide an explicit reference.
|
|
926
983
|
* @category Props
|
|
927
984
|
* @since v8.1.0
|
|
928
985
|
*/
|
|
929
986
|
readonly relationships?: RelationshipsOrRelationshipsId;
|
|
930
987
|
/**
|
|
931
|
-
*
|
|
988
|
+
* A component or string to separate each rendered Row.
|
|
932
989
|
* @category Props
|
|
933
990
|
* @since v8.1.0
|
|
934
991
|
*/
|
|
935
992
|
readonly separator?: Snippet<[]>;
|
|
936
993
|
/**
|
|
937
|
-
*
|
|
994
|
+
* Whether the component should also render the Id of the Row in the
|
|
995
|
+
* Relationship, and its descendent objects, to assist with debugging.
|
|
938
996
|
* @category Props
|
|
939
997
|
* @since v8.1.0
|
|
940
998
|
*/
|
|
941
999
|
readonly debugIds?: boolean;
|
|
942
1000
|
/**
|
|
943
|
-
*
|
|
1001
|
+
* A snippet for rendering each (remote, local, or linked) Row in the
|
|
1002
|
+
* Relationship.
|
|
944
1003
|
* @category Props
|
|
945
1004
|
* @since v8.1.0
|
|
946
1005
|
*/
|
|
@@ -948,38 +1007,42 @@ export type LinkedRowsViewProps = {
|
|
|
948
1007
|
};
|
|
949
1008
|
|
|
950
1009
|
/**
|
|
951
|
-
*
|
|
952
|
-
* ResultCellView component.
|
|
1010
|
+
* ResultCellViewProps props are used for components that refer to a single
|
|
1011
|
+
* Cell in a Row of a query ResultTable, such as the ResultCellView component.
|
|
953
1012
|
* @category Props
|
|
954
1013
|
* @since v8.1.0
|
|
955
1014
|
*/
|
|
956
1015
|
export type ResultCellViewProps = {
|
|
957
1016
|
/**
|
|
958
|
-
* The
|
|
1017
|
+
* The Id of the query in the Queries object for which the ResultTable will be
|
|
1018
|
+
* rendered.
|
|
959
1019
|
* @category Props
|
|
960
1020
|
* @since v8.1.0
|
|
961
1021
|
*/
|
|
962
1022
|
readonly queryId: Id;
|
|
963
1023
|
/**
|
|
964
|
-
* The
|
|
1024
|
+
* The Id of the Row in the ResultTable.
|
|
965
1025
|
* @category Props
|
|
966
1026
|
* @since v8.1.0
|
|
967
1027
|
*/
|
|
968
1028
|
readonly rowId: Id;
|
|
969
1029
|
/**
|
|
970
|
-
* The
|
|
1030
|
+
* The Id of the Cell in the Row to be rendered.
|
|
971
1031
|
* @category Props
|
|
972
1032
|
* @since v8.1.0
|
|
973
1033
|
*/
|
|
974
1034
|
readonly cellId: Id;
|
|
975
1035
|
/**
|
|
976
|
-
* The
|
|
1036
|
+
* The Queries object to be accessed: omit for the default context Queries
|
|
1037
|
+
* object, provide an Id for a named context Queries object, or provide an
|
|
1038
|
+
* explicit reference.
|
|
977
1039
|
* @category Props
|
|
978
1040
|
* @since v8.1.0
|
|
979
1041
|
*/
|
|
980
1042
|
readonly queries?: QueriesOrQueriesId;
|
|
981
1043
|
/**
|
|
982
|
-
*
|
|
1044
|
+
* Whether the component should also render the Id of the Cell to assist with
|
|
1045
|
+
* debugging.
|
|
983
1046
|
* @category Props
|
|
984
1047
|
* @since v8.1.0
|
|
985
1048
|
*/
|
|
@@ -987,44 +1050,49 @@ export type ResultCellViewProps = {
|
|
|
987
1050
|
};
|
|
988
1051
|
|
|
989
1052
|
/**
|
|
990
|
-
*
|
|
991
|
-
* ResultRowView component.
|
|
1053
|
+
* ResultRowViewProps props are used for components that refer to a single Row
|
|
1054
|
+
* in a query ResultTable, such as the ResultRowView component.
|
|
992
1055
|
* @category Props
|
|
993
1056
|
* @since v8.1.0
|
|
994
1057
|
*/
|
|
995
1058
|
export type ResultRowViewProps = {
|
|
996
1059
|
/**
|
|
997
|
-
* The
|
|
1060
|
+
* The Id of the query in the Queries object for which the ResultTable will be
|
|
1061
|
+
* rendered.
|
|
998
1062
|
* @category Props
|
|
999
1063
|
* @since v8.1.0
|
|
1000
1064
|
*/
|
|
1001
1065
|
readonly queryId: Id;
|
|
1002
1066
|
/**
|
|
1003
|
-
* The
|
|
1067
|
+
* The Id of the Row in the ResultTable to be rendered.
|
|
1004
1068
|
* @category Props
|
|
1005
1069
|
* @since v8.1.0
|
|
1006
1070
|
*/
|
|
1007
1071
|
readonly rowId: Id;
|
|
1008
1072
|
/**
|
|
1009
|
-
* The
|
|
1073
|
+
* The Queries object to be accessed: omit for the default context Queries
|
|
1074
|
+
* object, provide an Id for a named context Queries object, or provide an
|
|
1075
|
+
* explicit reference.
|
|
1010
1076
|
* @category Props
|
|
1011
1077
|
* @since v8.1.0
|
|
1012
1078
|
*/
|
|
1013
1079
|
readonly queries?: QueriesOrQueriesId;
|
|
1014
1080
|
/**
|
|
1015
|
-
*
|
|
1081
|
+
* A component or string to separate each rendered Cell.
|
|
1016
1082
|
* @category Props
|
|
1017
1083
|
* @since v8.1.0
|
|
1018
1084
|
*/
|
|
1019
1085
|
readonly separator?: Snippet<[]>;
|
|
1020
1086
|
/**
|
|
1021
|
-
*
|
|
1087
|
+
* Whether the component should also render the Id of the Row, and its
|
|
1088
|
+
* descendent objects, to assist with debugging.
|
|
1022
1089
|
* @category Props
|
|
1023
1090
|
* @since v8.1.0
|
|
1024
1091
|
*/
|
|
1025
1092
|
readonly debugIds?: boolean;
|
|
1026
1093
|
/**
|
|
1027
|
-
*
|
|
1094
|
+
* A snippet for rendering each Cell in the Row, to override the default
|
|
1095
|
+
* ResultCellView component.
|
|
1028
1096
|
* @category Props
|
|
1029
1097
|
* @since v8.1.0
|
|
1030
1098
|
*/
|
|
@@ -1032,38 +1100,43 @@ export type ResultRowViewProps = {
|
|
|
1032
1100
|
};
|
|
1033
1101
|
|
|
1034
1102
|
/**
|
|
1035
|
-
*
|
|
1036
|
-
* ResultTableView component.
|
|
1103
|
+
* ResultTableViewProps props are used for components that refer to a single
|
|
1104
|
+
* query ResultTable, such as the ResultTableView component.
|
|
1037
1105
|
* @category Props
|
|
1038
1106
|
* @since v8.1.0
|
|
1039
1107
|
*/
|
|
1040
1108
|
export type ResultTableViewProps = {
|
|
1041
1109
|
/**
|
|
1042
|
-
* The
|
|
1110
|
+
* The Id of the query in the Queries object for which the ResultTable will be
|
|
1111
|
+
* rendered.
|
|
1043
1112
|
* @category Props
|
|
1044
1113
|
* @since v8.1.0
|
|
1045
1114
|
*/
|
|
1046
1115
|
readonly queryId: Id;
|
|
1047
1116
|
/**
|
|
1048
|
-
* The
|
|
1117
|
+
* The Queries object to be accessed: omit for the default context Queries
|
|
1118
|
+
* object, provide an Id for a named context Queries object, or provide an
|
|
1119
|
+
* explicit reference.
|
|
1049
1120
|
* @category Props
|
|
1050
1121
|
* @since v8.1.0
|
|
1051
1122
|
*/
|
|
1052
1123
|
readonly queries?: QueriesOrQueriesId;
|
|
1053
1124
|
/**
|
|
1054
|
-
*
|
|
1125
|
+
* A component or string to separate each rendered Row.
|
|
1055
1126
|
* @category Props
|
|
1056
1127
|
* @since v8.1.0
|
|
1057
1128
|
*/
|
|
1058
1129
|
readonly separator?: Snippet<[]>;
|
|
1059
1130
|
/**
|
|
1060
|
-
*
|
|
1131
|
+
* Whether the component should also render the Id of the query, and its
|
|
1132
|
+
* descendent objects, to assist with debugging.
|
|
1061
1133
|
* @category Props
|
|
1062
1134
|
* @since v8.1.0
|
|
1063
1135
|
*/
|
|
1064
1136
|
readonly debugIds?: boolean;
|
|
1065
1137
|
/**
|
|
1066
|
-
*
|
|
1138
|
+
* A snippet for rendering each Row in the Table, to override the default
|
|
1139
|
+
* ResultRowView component.
|
|
1067
1140
|
* @category Props
|
|
1068
1141
|
* @since v8.1.0
|
|
1069
1142
|
*/
|
|
@@ -1071,62 +1144,69 @@ export type ResultTableViewProps = {
|
|
|
1071
1144
|
};
|
|
1072
1145
|
|
|
1073
1146
|
/**
|
|
1074
|
-
*
|
|
1075
|
-
* ResultSortedTableView
|
|
1147
|
+
* ResultSortedTableViewProps props are used for components that refer to a
|
|
1148
|
+
* single sorted query ResultTable, such as the ResultSortedTableView
|
|
1149
|
+
* component.
|
|
1076
1150
|
* @category Props
|
|
1077
1151
|
* @since v8.1.0
|
|
1078
1152
|
*/
|
|
1079
1153
|
export type ResultSortedTableViewProps = {
|
|
1080
1154
|
/**
|
|
1081
|
-
* The
|
|
1155
|
+
* The Id of the query in the Queries object for which the sorted ResultTable
|
|
1156
|
+
* will be rendered.
|
|
1082
1157
|
* @category Props
|
|
1083
1158
|
* @since v8.1.0
|
|
1084
1159
|
*/
|
|
1085
1160
|
readonly queryId: Id;
|
|
1086
1161
|
/**
|
|
1087
|
-
* The
|
|
1162
|
+
* The Id of the Cell whose values are used for sorting. If omitted, the view
|
|
1163
|
+
* will sort the Row Id itself.
|
|
1088
1164
|
* @category Props
|
|
1089
1165
|
* @since v8.1.0
|
|
1090
1166
|
*/
|
|
1091
1167
|
readonly cellId?: Id;
|
|
1092
1168
|
/**
|
|
1093
|
-
*
|
|
1169
|
+
* Whether the sorting should be in descending order.
|
|
1094
1170
|
* @category Props
|
|
1095
1171
|
* @since v8.1.0
|
|
1096
1172
|
*/
|
|
1097
1173
|
readonly descending?: boolean;
|
|
1098
1174
|
/**
|
|
1099
|
-
* The
|
|
1175
|
+
* The number of Row Ids to skip for pagination purposes.
|
|
1100
1176
|
* @category Props
|
|
1101
1177
|
* @since v8.1.0
|
|
1102
1178
|
*/
|
|
1103
1179
|
readonly offset?: number;
|
|
1104
1180
|
/**
|
|
1105
|
-
* The
|
|
1181
|
+
* The maximum number of Row Ids to return.
|
|
1106
1182
|
* @category Props
|
|
1107
1183
|
* @since v8.1.0
|
|
1108
1184
|
*/
|
|
1109
1185
|
readonly limit?: number;
|
|
1110
1186
|
/**
|
|
1111
|
-
* The
|
|
1187
|
+
* The Queries object to be accessed: omit for the default context Queries
|
|
1188
|
+
* object, provide an Id for a named context Queries object, or provide an
|
|
1189
|
+
* explicit reference.
|
|
1112
1190
|
* @category Props
|
|
1113
1191
|
* @since v8.1.0
|
|
1114
1192
|
*/
|
|
1115
1193
|
readonly queries?: QueriesOrQueriesId;
|
|
1116
1194
|
/**
|
|
1117
|
-
*
|
|
1195
|
+
* A component or string to separate each rendered Row.
|
|
1118
1196
|
* @category Props
|
|
1119
1197
|
* @since v8.1.0
|
|
1120
1198
|
*/
|
|
1121
1199
|
readonly separator?: Snippet<[]>;
|
|
1122
1200
|
/**
|
|
1123
|
-
*
|
|
1201
|
+
* Whether the component should also render the Id of the query, and its
|
|
1202
|
+
* descendent objects, to assist with debugging.
|
|
1124
1203
|
* @category Props
|
|
1125
1204
|
* @since v8.1.0
|
|
1126
1205
|
*/
|
|
1127
1206
|
readonly debugIds?: boolean;
|
|
1128
1207
|
/**
|
|
1129
|
-
*
|
|
1208
|
+
* A snippet for rendering each Row in the Table, to override the default
|
|
1209
|
+
* ResultRowView component.
|
|
1130
1210
|
* @category Props
|
|
1131
1211
|
* @since v8.1.0
|
|
1132
1212
|
*/
|
|
@@ -1134,32 +1214,36 @@ export type ResultSortedTableViewProps = {
|
|
|
1134
1214
|
};
|
|
1135
1215
|
|
|
1136
1216
|
/**
|
|
1137
|
-
*
|
|
1217
|
+
* BackwardCheckpointsViewProps props are used for components that refer to a
|
|
1218
|
+
* list of previous checkpoints in a Checkpoints object, such as the
|
|
1138
1219
|
* BackwardCheckpointsView component.
|
|
1139
1220
|
* @category Props
|
|
1140
1221
|
* @since v8.1.0
|
|
1141
1222
|
*/
|
|
1142
1223
|
export type BackwardCheckpointsViewProps = {
|
|
1143
1224
|
/**
|
|
1144
|
-
* The
|
|
1225
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
1226
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
1227
|
+
* or provide an explicit reference.
|
|
1145
1228
|
* @category Props
|
|
1146
1229
|
* @since v8.1.0
|
|
1147
1230
|
*/
|
|
1148
1231
|
readonly checkpoints?: CheckpointsOrCheckpointsId;
|
|
1149
1232
|
/**
|
|
1150
|
-
*
|
|
1233
|
+
* A component or string to separate each rendered checkpoint.
|
|
1151
1234
|
* @category Props
|
|
1152
1235
|
* @since v8.1.0
|
|
1153
1236
|
*/
|
|
1154
1237
|
readonly separator?: Snippet<[]>;
|
|
1155
1238
|
/**
|
|
1156
|
-
*
|
|
1239
|
+
* Whether the component should also render the Ids of the checkpoints to
|
|
1240
|
+
* assist with debugging.
|
|
1157
1241
|
* @category Props
|
|
1158
1242
|
* @since v8.1.0
|
|
1159
1243
|
*/
|
|
1160
1244
|
readonly debugIds?: boolean;
|
|
1161
1245
|
/**
|
|
1162
|
-
*
|
|
1246
|
+
* A snippet for rendering each checkpoint in the Checkpoints object.
|
|
1163
1247
|
* @category Props
|
|
1164
1248
|
* @since v8.1.0
|
|
1165
1249
|
*/
|
|
@@ -1167,32 +1251,36 @@ export type BackwardCheckpointsViewProps = {
|
|
|
1167
1251
|
};
|
|
1168
1252
|
|
|
1169
1253
|
/**
|
|
1170
|
-
*
|
|
1254
|
+
* ForwardCheckpointsViewProps props are used for components that refer to a
|
|
1255
|
+
* list of future checkpoints in a Checkpoints object, such as the
|
|
1171
1256
|
* ForwardCheckpointsView component.
|
|
1172
1257
|
* @category Props
|
|
1173
1258
|
* @since v8.1.0
|
|
1174
1259
|
*/
|
|
1175
1260
|
export type ForwardCheckpointsViewProps = {
|
|
1176
1261
|
/**
|
|
1177
|
-
* The
|
|
1262
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
1263
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
1264
|
+
* or provide an explicit reference.
|
|
1178
1265
|
* @category Props
|
|
1179
1266
|
* @since v8.1.0
|
|
1180
1267
|
*/
|
|
1181
1268
|
readonly checkpoints?: CheckpointsOrCheckpointsId;
|
|
1182
1269
|
/**
|
|
1183
|
-
*
|
|
1270
|
+
* A component or string to separate each rendered checkpoint.
|
|
1184
1271
|
* @category Props
|
|
1185
1272
|
* @since v8.1.0
|
|
1186
1273
|
*/
|
|
1187
1274
|
readonly separator?: Snippet<[]>;
|
|
1188
1275
|
/**
|
|
1189
|
-
*
|
|
1276
|
+
* Whether the component should also render the Ids of the checkpoints to
|
|
1277
|
+
* assist with debugging.
|
|
1190
1278
|
* @category Props
|
|
1191
1279
|
* @since v8.1.0
|
|
1192
1280
|
*/
|
|
1193
1281
|
readonly debugIds?: boolean;
|
|
1194
1282
|
/**
|
|
1195
|
-
*
|
|
1283
|
+
* A snippet for rendering each checkpoint in the Checkpoints object.
|
|
1196
1284
|
* @category Props
|
|
1197
1285
|
* @since v8.1.0
|
|
1198
1286
|
*/
|
|
@@ -1200,26 +1288,30 @@ export type ForwardCheckpointsViewProps = {
|
|
|
1200
1288
|
};
|
|
1201
1289
|
|
|
1202
1290
|
/**
|
|
1203
|
-
*
|
|
1291
|
+
* CurrentCheckpointViewProps props are used for components that refer to the
|
|
1292
|
+
* current checkpoint in a Checkpoints object, such as the
|
|
1204
1293
|
* CurrentCheckpointView component.
|
|
1205
1294
|
* @category Props
|
|
1206
1295
|
* @since v8.1.0
|
|
1207
1296
|
*/
|
|
1208
1297
|
export type CurrentCheckpointViewProps = {
|
|
1209
1298
|
/**
|
|
1210
|
-
* The
|
|
1299
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
1300
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
1301
|
+
* or provide an explicit reference.
|
|
1211
1302
|
* @category Props
|
|
1212
1303
|
* @since v8.1.0
|
|
1213
1304
|
*/
|
|
1214
1305
|
readonly checkpoints?: CheckpointsOrCheckpointsId;
|
|
1215
1306
|
/**
|
|
1216
|
-
*
|
|
1307
|
+
* Whether the component should also render the Id of the current checkpoint
|
|
1308
|
+
* to assist with debugging.
|
|
1217
1309
|
* @category Props
|
|
1218
1310
|
* @since v8.1.0
|
|
1219
1311
|
*/
|
|
1220
1312
|
readonly debugIds?: boolean;
|
|
1221
1313
|
/**
|
|
1222
|
-
*
|
|
1314
|
+
* A snippet for rendering the current checkpoint in the Checkpoints object.
|
|
1223
1315
|
* @category Props
|
|
1224
1316
|
* @since v8.1.0
|
|
1225
1317
|
*/
|
|
@@ -1315,8 +1407,8 @@ export const IndexView: Component<IndexViewProps>;
|
|
|
1315
1407
|
|
|
1316
1408
|
/**
|
|
1317
1409
|
* The LinkedRowsView component renders the Rows in a linked list Relationship,
|
|
1318
|
-
* and registers a listener so that any changes to that result will cause
|
|
1319
|
-
*
|
|
1410
|
+
* and registers a listener so that any changes to that result will cause a
|
|
1411
|
+
* re-render.
|
|
1320
1412
|
* @param props The props for this component.
|
|
1321
1413
|
* @returns A rendering of the linked Row Ids.
|
|
1322
1414
|
* @category Component
|
|
@@ -1403,8 +1495,8 @@ export const ResultTableView: Component<ResultTableViewProps>;
|
|
|
1403
1495
|
|
|
1404
1496
|
/**
|
|
1405
1497
|
* The RowView component renders the contents of a single Row in a given Table,
|
|
1406
|
-
* and registers a listener so that any changes to that result will cause
|
|
1407
|
-
*
|
|
1498
|
+
* and registers a listener so that any changes to that result will cause a
|
|
1499
|
+
* re-render.
|
|
1408
1500
|
* @param props The props for this component.
|
|
1409
1501
|
* @returns A rendering of the Row, or nothing if not present.
|
|
1410
1502
|
* @category Component
|
|
@@ -1414,8 +1506,8 @@ export const RowView: Component<RowViewProps>;
|
|
|
1414
1506
|
|
|
1415
1507
|
/**
|
|
1416
1508
|
* The SliceView component renders the Row Ids in a named Slice in an Index, and
|
|
1417
|
-
* registers a listener so that any changes to that result will cause
|
|
1418
|
-
*
|
|
1509
|
+
* registers a listener so that any changes to that result will cause a
|
|
1510
|
+
* re-render.
|
|
1419
1511
|
* @param props The props for this component.
|
|
1420
1512
|
* @returns A rendering of the Rows in the Slice.
|
|
1421
1513
|
* @category Component
|
|
@@ -1446,8 +1538,8 @@ export const TableView: Component<TableViewProps>;
|
|
|
1446
1538
|
|
|
1447
1539
|
/**
|
|
1448
1540
|
* The TablesView component renders the contents of all Tables in a Store, and
|
|
1449
|
-
* registers a listener so that any changes to that result will cause
|
|
1450
|
-
*
|
|
1541
|
+
* registers a listener so that any changes to that result will cause a
|
|
1542
|
+
* re-render.
|
|
1451
1543
|
* @param props The props for this component.
|
|
1452
1544
|
* @returns A rendering of all Tables.
|
|
1453
1545
|
* @category Component
|
|
@@ -1457,8 +1549,8 @@ export const TablesView: Component<TablesViewProps>;
|
|
|
1457
1549
|
|
|
1458
1550
|
/**
|
|
1459
1551
|
* The ValueView component renders the value of a single Value in a Store, and
|
|
1460
|
-
* registers a listener so that any changes to that result will cause
|
|
1461
|
-
*
|
|
1552
|
+
* registers a listener so that any changes to that result will cause a
|
|
1553
|
+
* re-render.
|
|
1462
1554
|
* @param props The props for this component.
|
|
1463
1555
|
* @returns A rendering of the Value, or nothing if not present.
|
|
1464
1556
|
* @category Component
|
|
@@ -1477,99 +1569,99 @@ export const ValueView: Component<ValueViewProps>;
|
|
|
1477
1569
|
export const ValuesView: Component<ValuesViewProps>;
|
|
1478
1570
|
|
|
1479
1571
|
/**
|
|
1480
|
-
* The
|
|
1572
|
+
* The hasTables function returns a reactive object indicating whether any
|
|
1481
1573
|
* Tables exist in the Store, and registers a listener so that any changes to
|
|
1482
|
-
* that result will update
|
|
1574
|
+
* that result will update `current`.
|
|
1483
1575
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1484
1576
|
* @returns A reactive object with a `current` boolean property.
|
|
1485
1577
|
* @category Getter
|
|
1486
1578
|
* @since v8.1.0
|
|
1487
1579
|
*/
|
|
1488
|
-
export function
|
|
1580
|
+
export function hasTables(
|
|
1489
1581
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1490
1582
|
): {
|
|
1491
1583
|
readonly current: boolean;
|
|
1492
1584
|
};
|
|
1493
1585
|
|
|
1494
1586
|
/**
|
|
1495
|
-
* The
|
|
1496
|
-
*
|
|
1497
|
-
* update
|
|
1587
|
+
* The getTables function returns a reactive object reflecting the Tables in the
|
|
1588
|
+
* Store, and registers a listener so that any changes to those Tables will
|
|
1589
|
+
* update `current`.
|
|
1498
1590
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1499
1591
|
* @returns A reactive object with a `current` Tables property.
|
|
1500
1592
|
* @category Getter
|
|
1501
1593
|
* @since v8.1.0
|
|
1502
1594
|
*/
|
|
1503
|
-
export function
|
|
1595
|
+
export function getTables(
|
|
1504
1596
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1505
1597
|
): {
|
|
1506
1598
|
readonly current: Tables;
|
|
1507
1599
|
};
|
|
1508
1600
|
|
|
1509
1601
|
/**
|
|
1510
|
-
* The
|
|
1511
|
-
*
|
|
1512
|
-
*
|
|
1602
|
+
* The getTableIds function returns a reactive object reflecting the Ids of the
|
|
1603
|
+
* Tables in a Store, and registers a listener so that any changes to those Ids
|
|
1604
|
+
* will update `current`.
|
|
1513
1605
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1514
1606
|
* @returns A reactive object with a `current` Ids property.
|
|
1515
1607
|
* @category Getter
|
|
1516
1608
|
* @since v8.1.0
|
|
1517
1609
|
*/
|
|
1518
|
-
export function
|
|
1610
|
+
export function getTableIds(
|
|
1519
1611
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1520
1612
|
): {
|
|
1521
1613
|
readonly current: Ids;
|
|
1522
1614
|
};
|
|
1523
1615
|
|
|
1524
1616
|
/**
|
|
1525
|
-
* The
|
|
1526
|
-
*
|
|
1527
|
-
*
|
|
1617
|
+
* The hasTable function returns a reactive object indicating whether a Table
|
|
1618
|
+
* exists in the Store, and registers a listener so that any changes to that
|
|
1619
|
+
* result will update `current`.
|
|
1528
1620
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1529
1621
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1530
1622
|
* @returns A reactive object with a `current` boolean property.
|
|
1531
1623
|
* @category Getter
|
|
1532
1624
|
* @since v8.1.0
|
|
1533
1625
|
*/
|
|
1534
|
-
export function
|
|
1626
|
+
export function hasTable(
|
|
1535
1627
|
tableId: MaybeGetter<Id>,
|
|
1536
1628
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1537
1629
|
): {readonly current: boolean};
|
|
1538
1630
|
|
|
1539
1631
|
/**
|
|
1540
|
-
* The
|
|
1541
|
-
* Store, and registers a listener so that any changes to that Table will
|
|
1542
|
-
*
|
|
1632
|
+
* The getTable function returns a reactive object reflecting a Table in a
|
|
1633
|
+
* Store, and registers a listener so that any changes to that Table will update
|
|
1634
|
+
* `current`.
|
|
1543
1635
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1544
1636
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1545
1637
|
* @returns A reactive object with a `current` Table property.
|
|
1546
1638
|
* @category Getter
|
|
1547
1639
|
* @since v8.1.0
|
|
1548
1640
|
*/
|
|
1549
|
-
export function
|
|
1641
|
+
export function getTable(
|
|
1550
1642
|
tableId: MaybeGetter<Id>,
|
|
1551
1643
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1552
1644
|
): {readonly current: Table};
|
|
1553
1645
|
|
|
1554
1646
|
/**
|
|
1555
|
-
* The
|
|
1556
|
-
*
|
|
1557
|
-
*
|
|
1647
|
+
* The getTableCellIds function returns a reactive object reflecting the Ids of
|
|
1648
|
+
* all Cells used across a Table, and registers a listener so that any changes
|
|
1649
|
+
* to those Ids will update `current`.
|
|
1558
1650
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1559
1651
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1560
1652
|
* @returns A reactive object with a `current` Ids property.
|
|
1561
1653
|
* @category Getter
|
|
1562
1654
|
* @since v8.1.0
|
|
1563
1655
|
*/
|
|
1564
|
-
export function
|
|
1656
|
+
export function getTableCellIds(
|
|
1565
1657
|
tableId: MaybeGetter<Id>,
|
|
1566
1658
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1567
1659
|
): {readonly current: Ids};
|
|
1568
1660
|
|
|
1569
1661
|
/**
|
|
1570
|
-
* The
|
|
1571
|
-
*
|
|
1572
|
-
*
|
|
1662
|
+
* The hasTableCell function returns a reactive object indicating whether a
|
|
1663
|
+
* particular Cell is used anywhere in a Table, and registers a listener so that
|
|
1664
|
+
* any changes to that result will update `current`.
|
|
1573
1665
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1574
1666
|
* @param cellId The Id of the Cell (or a getter returning it).
|
|
1575
1667
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1577,46 +1669,46 @@ export function createTableCellIds(
|
|
|
1577
1669
|
* @category Getter
|
|
1578
1670
|
* @since v8.1.0
|
|
1579
1671
|
*/
|
|
1580
|
-
export function
|
|
1672
|
+
export function hasTableCell(
|
|
1581
1673
|
tableId: MaybeGetter<Id>,
|
|
1582
1674
|
cellId: MaybeGetter<Id>,
|
|
1583
1675
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1584
1676
|
): {readonly current: boolean};
|
|
1585
1677
|
|
|
1586
1678
|
/**
|
|
1587
|
-
* The
|
|
1588
|
-
*
|
|
1589
|
-
*
|
|
1679
|
+
* The getRowCount function returns a reactive object reflecting the number of
|
|
1680
|
+
* Rows in a Table, and registers a listener so that any changes will update
|
|
1681
|
+
* `current`.
|
|
1590
1682
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1591
1683
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1592
1684
|
* @returns A reactive object with a `current` number property.
|
|
1593
1685
|
* @category Getter
|
|
1594
1686
|
* @since v8.1.0
|
|
1595
1687
|
*/
|
|
1596
|
-
export function
|
|
1688
|
+
export function getRowCount(
|
|
1597
1689
|
tableId: MaybeGetter<Id>,
|
|
1598
1690
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1599
1691
|
): {readonly current: number};
|
|
1600
1692
|
|
|
1601
1693
|
/**
|
|
1602
|
-
* The
|
|
1603
|
-
* Rows in a Table, and registers a listener so that any changes will
|
|
1604
|
-
*
|
|
1694
|
+
* The getRowIds function returns a reactive object reflecting the Ids of the
|
|
1695
|
+
* Rows in a Table, and registers a listener so that any changes will update
|
|
1696
|
+
* `current`.
|
|
1605
1697
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1606
1698
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1607
1699
|
* @returns A reactive object with a `current` Ids property.
|
|
1608
1700
|
* @category Getter
|
|
1609
1701
|
* @since v8.1.0
|
|
1610
1702
|
*/
|
|
1611
|
-
export function
|
|
1703
|
+
export function getRowIds(
|
|
1612
1704
|
tableId: MaybeGetter<Id>,
|
|
1613
1705
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1614
1706
|
): {readonly current: Ids};
|
|
1615
1707
|
|
|
1616
1708
|
/**
|
|
1617
|
-
* The
|
|
1618
|
-
*
|
|
1619
|
-
*
|
|
1709
|
+
* The getSortedRowIds function returns a reactive object reflecting the sorted
|
|
1710
|
+
* Row Ids in a Table, and registers a listener so that any changes will update
|
|
1711
|
+
* `current`.
|
|
1620
1712
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1621
1713
|
* @param cellId The Id of the Cell to sort by (or a getter returning it).
|
|
1622
1714
|
* @param descending Whether to sort descending (or a getter returning it).
|
|
@@ -1627,7 +1719,7 @@ export function createRowIds(
|
|
|
1627
1719
|
* @category Getter
|
|
1628
1720
|
* @since v8.1.0
|
|
1629
1721
|
*/
|
|
1630
|
-
export function
|
|
1722
|
+
export function getSortedRowIds(
|
|
1631
1723
|
tableId: MaybeGetter<Id>,
|
|
1632
1724
|
cellId?: MaybeGetter<Id | undefined>,
|
|
1633
1725
|
descending?: MaybeGetter<boolean>,
|
|
@@ -1637,9 +1729,9 @@ export function createSortedRowIds(
|
|
|
1637
1729
|
): {readonly current: Ids};
|
|
1638
1730
|
|
|
1639
1731
|
/**
|
|
1640
|
-
* The
|
|
1641
|
-
*
|
|
1642
|
-
*
|
|
1732
|
+
* The hasRow function returns a reactive object indicating whether a Row exists
|
|
1733
|
+
* in a Table, and registers a listener so that any changes to that result will
|
|
1734
|
+
* update `current`.
|
|
1643
1735
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1644
1736
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1645
1737
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1647,16 +1739,16 @@ export function createSortedRowIds(
|
|
|
1647
1739
|
* @category Getter
|
|
1648
1740
|
* @since v8.1.0
|
|
1649
1741
|
*/
|
|
1650
|
-
export function
|
|
1742
|
+
export function hasRow(
|
|
1651
1743
|
tableId: MaybeGetter<Id>,
|
|
1652
1744
|
rowId: MaybeGetter<Id>,
|
|
1653
1745
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1654
1746
|
): {readonly current: boolean};
|
|
1655
1747
|
|
|
1656
1748
|
/**
|
|
1657
|
-
* The
|
|
1658
|
-
* and registers a listener so that any changes to that Row will
|
|
1659
|
-
*
|
|
1749
|
+
* The getRow function returns a reactive object reflecting a Row in a Table,
|
|
1750
|
+
* and registers a listener so that any changes to that Row will update
|
|
1751
|
+
* `current`.
|
|
1660
1752
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1661
1753
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1662
1754
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1664,16 +1756,16 @@ export function createHasRow(
|
|
|
1664
1756
|
* @category Getter
|
|
1665
1757
|
* @since v8.1.0
|
|
1666
1758
|
*/
|
|
1667
|
-
export function
|
|
1759
|
+
export function getRow(
|
|
1668
1760
|
tableId: MaybeGetter<Id>,
|
|
1669
1761
|
rowId: MaybeGetter<Id>,
|
|
1670
1762
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1671
1763
|
): {readonly current: Row};
|
|
1672
1764
|
|
|
1673
1765
|
/**
|
|
1674
|
-
* The
|
|
1675
|
-
*
|
|
1676
|
-
*
|
|
1766
|
+
* The getCellIds function returns a reactive object reflecting the Ids of the
|
|
1767
|
+
* Cells in a Row, and registers a listener so that any changes will update
|
|
1768
|
+
* `current`.
|
|
1677
1769
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1678
1770
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1679
1771
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1681,16 +1773,16 @@ export function createRow(
|
|
|
1681
1773
|
* @category Getter
|
|
1682
1774
|
* @since v8.1.0
|
|
1683
1775
|
*/
|
|
1684
|
-
export function
|
|
1776
|
+
export function getCellIds(
|
|
1685
1777
|
tableId: MaybeGetter<Id>,
|
|
1686
1778
|
rowId: MaybeGetter<Id>,
|
|
1687
1779
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1688
1780
|
): {readonly current: Ids};
|
|
1689
1781
|
|
|
1690
1782
|
/**
|
|
1691
|
-
* The
|
|
1692
|
-
*
|
|
1693
|
-
*
|
|
1783
|
+
* The hasCell function returns a reactive object indicating whether a Cell
|
|
1784
|
+
* exists in a Row in a Table, and registers a listener so that any changes to
|
|
1785
|
+
* that result will update `current`.
|
|
1694
1786
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1695
1787
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1696
1788
|
* @param cellId The Id of the Cell (or a getter returning it).
|
|
@@ -1699,7 +1791,7 @@ export function createCellIds(
|
|
|
1699
1791
|
* @category Getter
|
|
1700
1792
|
* @since v8.1.0
|
|
1701
1793
|
*/
|
|
1702
|
-
export function
|
|
1794
|
+
export function hasCell(
|
|
1703
1795
|
tableId: MaybeGetter<Id>,
|
|
1704
1796
|
rowId: MaybeGetter<Id>,
|
|
1705
1797
|
cellId: MaybeGetter<Id>,
|
|
@@ -1707,9 +1799,9 @@ export function createHasCell(
|
|
|
1707
1799
|
): {readonly current: boolean};
|
|
1708
1800
|
|
|
1709
1801
|
/**
|
|
1710
|
-
* The
|
|
1711
|
-
*
|
|
1712
|
-
*
|
|
1802
|
+
* The getCell function returns a reactive object reflecting the value of a Cell
|
|
1803
|
+
* in a Row in a Table, and registers a listener so that any changes to that
|
|
1804
|
+
* Cell will update `current`.
|
|
1713
1805
|
*
|
|
1714
1806
|
* Since Cells are mutable leaf values in a Store, the returned object's
|
|
1715
1807
|
* `current` property can also be assigned to write back to the Store.
|
|
@@ -1719,18 +1811,18 @@ export function createHasCell(
|
|
|
1719
1811
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1720
1812
|
* @returns A reactive object with gettable and settable `current`.
|
|
1721
1813
|
* @example
|
|
1722
|
-
* This example uses the
|
|
1814
|
+
* This example uses the getCell function to display a Cell value reactively.
|
|
1723
1815
|
*
|
|
1724
1816
|
* ```ts
|
|
1725
1817
|
* // In a .svelte file:
|
|
1726
1818
|
* // const store = createStore().setCell('pets', 'cat', 'name', 'Fido');
|
|
1727
|
-
* // const name =
|
|
1819
|
+
* // const name = getCell('pets', 'cat', 'name', store);
|
|
1728
1820
|
* // $: console.log(name.current); // 'Fido'
|
|
1729
1821
|
* ```
|
|
1730
1822
|
* @category Getter
|
|
1731
1823
|
* @since v8.1.0
|
|
1732
1824
|
*/
|
|
1733
|
-
export function
|
|
1825
|
+
export function getCell(
|
|
1734
1826
|
tableId: MaybeGetter<Id>,
|
|
1735
1827
|
rowId: MaybeGetter<Id>,
|
|
1736
1828
|
cellId: MaybeGetter<Id>,
|
|
@@ -1738,69 +1830,68 @@ export function createCell(
|
|
|
1738
1830
|
): {get current(): CellOrUndefined; set current(v: Cell)};
|
|
1739
1831
|
|
|
1740
1832
|
/**
|
|
1741
|
-
* The
|
|
1833
|
+
* The hasValues function returns a reactive object indicating whether any
|
|
1742
1834
|
* Values exist in the Store, and registers a listener so that any changes to
|
|
1743
|
-
* that result will update
|
|
1835
|
+
* that result will update `current`.
|
|
1744
1836
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1745
1837
|
* @returns A reactive object with a `current` boolean property.
|
|
1746
1838
|
* @category Getter
|
|
1747
1839
|
* @since v8.1.0
|
|
1748
1840
|
*/
|
|
1749
|
-
export function
|
|
1841
|
+
export function hasValues(
|
|
1750
1842
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1751
1843
|
): {
|
|
1752
1844
|
readonly current: boolean;
|
|
1753
1845
|
};
|
|
1754
1846
|
|
|
1755
1847
|
/**
|
|
1756
|
-
* The
|
|
1757
|
-
*
|
|
1758
|
-
* update `.current`.
|
|
1848
|
+
* The getValues function returns a reactive object reflecting the Values in the
|
|
1849
|
+
* Store, and registers a listener so that any changes will update `current`.
|
|
1759
1850
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1760
1851
|
* @returns A reactive object with a `current` Values property.
|
|
1761
1852
|
* @category Getter
|
|
1762
1853
|
* @since v8.1.0
|
|
1763
1854
|
*/
|
|
1764
|
-
export function
|
|
1855
|
+
export function getValues(
|
|
1765
1856
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1766
1857
|
): {
|
|
1767
1858
|
readonly current: Values;
|
|
1768
1859
|
};
|
|
1769
1860
|
|
|
1770
1861
|
/**
|
|
1771
|
-
* The
|
|
1772
|
-
*
|
|
1773
|
-
*
|
|
1862
|
+
* The getValueIds function returns a reactive object reflecting the Ids of the
|
|
1863
|
+
* Values in a Store, and registers a listener so that any changes will update
|
|
1864
|
+
* `current`.
|
|
1774
1865
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1775
1866
|
* @returns A reactive object with a `current` Ids property.
|
|
1776
1867
|
* @category Getter
|
|
1777
1868
|
* @since v8.1.0
|
|
1778
1869
|
*/
|
|
1779
|
-
export function
|
|
1870
|
+
export function getValueIds(
|
|
1780
1871
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1781
1872
|
): {
|
|
1782
1873
|
readonly current: Ids;
|
|
1783
1874
|
};
|
|
1784
1875
|
|
|
1785
1876
|
/**
|
|
1786
|
-
* The
|
|
1787
|
-
*
|
|
1788
|
-
*
|
|
1877
|
+
* The hasValue function returns a reactive object indicating whether a Value
|
|
1878
|
+
* exists in the Store, and registers a listener so that any changes to that
|
|
1879
|
+
* result will update `current`.
|
|
1789
1880
|
* @param valueId The Id of the Value (or a getter returning it).
|
|
1790
1881
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1791
1882
|
* @returns A reactive object with a `current` boolean property.
|
|
1792
1883
|
* @category Getter
|
|
1793
1884
|
* @since v8.1.0
|
|
1794
1885
|
*/
|
|
1795
|
-
export function
|
|
1886
|
+
export function hasValue(
|
|
1796
1887
|
valueId: MaybeGetter<Id>,
|
|
1797
1888
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1798
1889
|
): {readonly current: boolean};
|
|
1799
1890
|
|
|
1800
1891
|
/**
|
|
1801
|
-
* The
|
|
1892
|
+
* The getValue function returns a reactive object reflecting the value of a
|
|
1802
1893
|
* Value in a Store, and registers a listener so that any changes to that Value
|
|
1803
|
-
* will update
|
|
1894
|
+
* will update `current`.
|
|
1804
1895
|
*
|
|
1805
1896
|
* Since Values are mutable leaf values in a Store, the returned object's
|
|
1806
1897
|
* `current` property can also be assigned to write back to the Store.
|
|
@@ -1810,7 +1901,7 @@ export function createHasValue(
|
|
|
1810
1901
|
* @category Getter
|
|
1811
1902
|
* @since v8.1.0
|
|
1812
1903
|
*/
|
|
1813
|
-
export function
|
|
1904
|
+
export function getValue(
|
|
1814
1905
|
valueId: MaybeGetter<Id>,
|
|
1815
1906
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1816
1907
|
): {get current(): ValueOrUndefined; set current(v: Value)};
|
|
@@ -1838,13 +1929,13 @@ export function resolveStore(
|
|
|
1838
1929
|
): () => Store | undefined;
|
|
1839
1930
|
|
|
1840
1931
|
/**
|
|
1841
|
-
* The
|
|
1842
|
-
*
|
|
1932
|
+
* The getStoreIds function returns a reactive object with the Ids of all Stores
|
|
1933
|
+
* registered in the current Provider context.
|
|
1843
1934
|
* @returns A reactive object with a `current` Ids property.
|
|
1844
1935
|
* @category Getter
|
|
1845
1936
|
* @since v8.1.0
|
|
1846
1937
|
*/
|
|
1847
|
-
export function
|
|
1938
|
+
export function getStoreIds(): {readonly current: Ids};
|
|
1848
1939
|
|
|
1849
1940
|
/**
|
|
1850
1941
|
* The getMetrics function returns the default Metrics object from the current
|
|
@@ -1870,33 +1961,33 @@ export function resolveMetrics(
|
|
|
1870
1961
|
): () => Metrics | undefined;
|
|
1871
1962
|
|
|
1872
1963
|
/**
|
|
1873
|
-
* The
|
|
1964
|
+
* The getMetricsIds function returns a reactive object with the Ids of all
|
|
1874
1965
|
* Metrics objects registered in the current Provider context.
|
|
1875
1966
|
* @returns A reactive object with a `current` Ids property.
|
|
1876
1967
|
* @category Getter
|
|
1877
1968
|
* @since v8.1.0
|
|
1878
1969
|
*/
|
|
1879
|
-
export function
|
|
1970
|
+
export function getMetricsIds(): {readonly current: Ids};
|
|
1880
1971
|
|
|
1881
1972
|
/**
|
|
1882
|
-
* The
|
|
1883
|
-
*
|
|
1884
|
-
* will update
|
|
1973
|
+
* The getMetricIds function returns a reactive object reflecting the Ids of the
|
|
1974
|
+
* Metrics in a Metrics object, and registers a listener so that any changes
|
|
1975
|
+
* will update `current`.
|
|
1885
1976
|
* @param metricsOrMetricsId The Metrics object to use, or its Id.
|
|
1886
1977
|
* @returns A reactive object with a `current` Ids property.
|
|
1887
1978
|
* @category Getter
|
|
1888
1979
|
* @since v8.1.0
|
|
1889
1980
|
*/
|
|
1890
|
-
export function
|
|
1981
|
+
export function getMetricIds(
|
|
1891
1982
|
metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId | undefined>,
|
|
1892
1983
|
): {
|
|
1893
1984
|
readonly current: Ids;
|
|
1894
1985
|
};
|
|
1895
1986
|
|
|
1896
1987
|
/**
|
|
1897
|
-
* The
|
|
1988
|
+
* The getMetric function returns a reactive object reflecting the value of a
|
|
1898
1989
|
* named Metric in a Metrics object, and registers a listener so that any
|
|
1899
|
-
* changes to that Metric will update
|
|
1990
|
+
* changes to that Metric will update `current`.
|
|
1900
1991
|
* @param metricId The Id of the Metric (or a getter returning it).
|
|
1901
1992
|
* @param metricsOrMetricsId The Metrics object to use (plain or getter), or its
|
|
1902
1993
|
* Id.
|
|
@@ -1904,7 +1995,7 @@ export function createMetricIds(
|
|
|
1904
1995
|
* @category Getter
|
|
1905
1996
|
* @since v8.1.0
|
|
1906
1997
|
*/
|
|
1907
|
-
export function
|
|
1998
|
+
export function getMetric(
|
|
1908
1999
|
metricId: MaybeGetter<Id>,
|
|
1909
2000
|
metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId | undefined>,
|
|
1910
2001
|
): {readonly current: number | undefined};
|
|
@@ -1947,33 +2038,33 @@ export function getIndexStoreTableId(
|
|
|
1947
2038
|
): {readonly store: Store | undefined; readonly tableId: Id | undefined};
|
|
1948
2039
|
|
|
1949
2040
|
/**
|
|
1950
|
-
* The
|
|
2041
|
+
* The getIndexesIds function returns a reactive object with the Ids of all
|
|
1951
2042
|
* Indexes objects registered in the current Provider context.
|
|
1952
2043
|
* @returns A reactive object with a `current` Ids property.
|
|
1953
2044
|
* @category Getter
|
|
1954
2045
|
* @since v8.1.0
|
|
1955
2046
|
*/
|
|
1956
|
-
export function
|
|
2047
|
+
export function getIndexesIds(): {readonly current: Ids};
|
|
1957
2048
|
|
|
1958
2049
|
/**
|
|
1959
|
-
* The
|
|
1960
|
-
*
|
|
1961
|
-
*
|
|
2050
|
+
* The getIndexIds function returns a reactive object reflecting the Ids of the
|
|
2051
|
+
* Indexes in an Indexes object, and registers a listener so that any changes
|
|
2052
|
+
* will update `current`.
|
|
1962
2053
|
* @param indexesOrIndexesId The Indexes object to use, or its Id.
|
|
1963
2054
|
* @returns A reactive object with a `current` Ids property.
|
|
1964
2055
|
* @category Getter
|
|
1965
2056
|
* @since v8.1.0
|
|
1966
2057
|
*/
|
|
1967
|
-
export function
|
|
2058
|
+
export function getIndexIds(
|
|
1968
2059
|
indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId | undefined>,
|
|
1969
2060
|
): {
|
|
1970
2061
|
readonly current: Ids;
|
|
1971
2062
|
};
|
|
1972
2063
|
|
|
1973
2064
|
/**
|
|
1974
|
-
* The
|
|
1975
|
-
*
|
|
1976
|
-
*
|
|
2065
|
+
* The getSliceIds function returns a reactive object reflecting the Ids of the
|
|
2066
|
+
* Slices in an Index, and registers a listener so that any changes will update
|
|
2067
|
+
* `current`.
|
|
1977
2068
|
* @param indexId The Id of the Index (or a getter returning it).
|
|
1978
2069
|
* @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
|
|
1979
2070
|
* Id.
|
|
@@ -1981,15 +2072,15 @@ export function createIndexIds(
|
|
|
1981
2072
|
* @category Getter
|
|
1982
2073
|
* @since v8.1.0
|
|
1983
2074
|
*/
|
|
1984
|
-
export function
|
|
2075
|
+
export function getSliceIds(
|
|
1985
2076
|
indexId: MaybeGetter<Id>,
|
|
1986
2077
|
indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId | undefined>,
|
|
1987
2078
|
): {readonly current: Ids};
|
|
1988
2079
|
|
|
1989
2080
|
/**
|
|
1990
|
-
* The
|
|
1991
|
-
*
|
|
1992
|
-
*
|
|
2081
|
+
* The getSliceRowIds function returns a reactive object reflecting the Ids of
|
|
2082
|
+
* the Rows in a Slice, and registers a listener so that any changes will update
|
|
2083
|
+
* `current`.
|
|
1993
2084
|
* @param indexId The Id of the Index (or a getter returning it).
|
|
1994
2085
|
* @param sliceId The Id of the Slice (or a getter returning it).
|
|
1995
2086
|
* @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
|
|
@@ -1998,7 +2089,7 @@ export function createSliceIds(
|
|
|
1998
2089
|
* @category Getter
|
|
1999
2090
|
* @since v8.1.0
|
|
2000
2091
|
*/
|
|
2001
|
-
export function
|
|
2092
|
+
export function getSliceRowIds(
|
|
2002
2093
|
indexId: MaybeGetter<Id>,
|
|
2003
2094
|
sliceId: MaybeGetter<Id>,
|
|
2004
2095
|
indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId | undefined>,
|
|
@@ -2028,33 +2119,33 @@ export function resolveQueries(
|
|
|
2028
2119
|
): () => Queries | undefined;
|
|
2029
2120
|
|
|
2030
2121
|
/**
|
|
2031
|
-
* The
|
|
2122
|
+
* The getQueriesIds function returns a reactive object with the Ids of all
|
|
2032
2123
|
* Queries objects registered in the current Provider context.
|
|
2033
2124
|
* @returns A reactive object with a `current` Ids property.
|
|
2034
2125
|
* @category Getter
|
|
2035
2126
|
* @since v8.1.0
|
|
2036
2127
|
*/
|
|
2037
|
-
export function
|
|
2128
|
+
export function getQueriesIds(): {readonly current: Ids};
|
|
2038
2129
|
|
|
2039
2130
|
/**
|
|
2040
|
-
* The
|
|
2041
|
-
*
|
|
2042
|
-
* will update
|
|
2131
|
+
* The getQueryIds function returns a reactive object reflecting the Ids of the
|
|
2132
|
+
* Queries in a Queries object, and registers a listener so that any changes
|
|
2133
|
+
* will update `current`.
|
|
2043
2134
|
* @param queriesOrQueriesId The Queries object to use, or its Id.
|
|
2044
2135
|
* @returns A reactive object with a `current` Ids property.
|
|
2045
2136
|
* @category Getter
|
|
2046
2137
|
* @since v8.1.0
|
|
2047
2138
|
*/
|
|
2048
|
-
export function
|
|
2139
|
+
export function getQueryIds(
|
|
2049
2140
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2050
2141
|
): {
|
|
2051
2142
|
readonly current: Ids;
|
|
2052
2143
|
};
|
|
2053
2144
|
|
|
2054
2145
|
/**
|
|
2055
|
-
* The
|
|
2146
|
+
* The getResultTable function returns a reactive object reflecting a result
|
|
2056
2147
|
* Table in a Queries object, and registers a listener so that any changes to
|
|
2057
|
-
* that result will update
|
|
2148
|
+
* that result will update `current`.
|
|
2058
2149
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2059
2150
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2060
2151
|
* Id.
|
|
@@ -2062,15 +2153,15 @@ export function createQueryIds(
|
|
|
2062
2153
|
* @category Getter
|
|
2063
2154
|
* @since v8.1.0
|
|
2064
2155
|
*/
|
|
2065
|
-
export function
|
|
2156
|
+
export function getResultTable(
|
|
2066
2157
|
queryId: MaybeGetter<Id>,
|
|
2067
2158
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2068
2159
|
): {readonly current: Table};
|
|
2069
2160
|
|
|
2070
2161
|
/**
|
|
2071
|
-
* The
|
|
2072
|
-
*
|
|
2073
|
-
*
|
|
2162
|
+
* The getResultTableCellIds function returns a reactive object reflecting the
|
|
2163
|
+
* Ids of all Cells used across a result Table, and registers a listener so that
|
|
2164
|
+
* any changes will update `current`.
|
|
2074
2165
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2075
2166
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2076
2167
|
* Id.
|
|
@@ -2078,15 +2169,15 @@ export function createResultTable(
|
|
|
2078
2169
|
* @category Getter
|
|
2079
2170
|
* @since v8.1.0
|
|
2080
2171
|
*/
|
|
2081
|
-
export function
|
|
2172
|
+
export function getResultTableCellIds(
|
|
2082
2173
|
queryId: MaybeGetter<Id>,
|
|
2083
2174
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2084
2175
|
): {readonly current: Ids};
|
|
2085
2176
|
|
|
2086
2177
|
/**
|
|
2087
|
-
* The
|
|
2178
|
+
* The getResultRowCount function returns a reactive object reflecting the
|
|
2088
2179
|
* number of Rows in a result Table, and registers a listener so that any
|
|
2089
|
-
* changes will update
|
|
2180
|
+
* changes will update `current`.
|
|
2090
2181
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2091
2182
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2092
2183
|
* Id.
|
|
@@ -2094,15 +2185,15 @@ export function createResultTableCellIds(
|
|
|
2094
2185
|
* @category Getter
|
|
2095
2186
|
* @since v8.1.0
|
|
2096
2187
|
*/
|
|
2097
|
-
export function
|
|
2188
|
+
export function getResultRowCount(
|
|
2098
2189
|
queryId: MaybeGetter<Id>,
|
|
2099
2190
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2100
2191
|
): {readonly current: number};
|
|
2101
2192
|
|
|
2102
2193
|
/**
|
|
2103
|
-
* The
|
|
2104
|
-
*
|
|
2105
|
-
*
|
|
2194
|
+
* The getResultRowIds function returns a reactive object reflecting the Ids of
|
|
2195
|
+
* the Rows in a result Table, and registers a listener so that any changes will
|
|
2196
|
+
* update `current`.
|
|
2106
2197
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2107
2198
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2108
2199
|
* Id.
|
|
@@ -2110,15 +2201,15 @@ export function createResultRowCount(
|
|
|
2110
2201
|
* @category Getter
|
|
2111
2202
|
* @since v8.1.0
|
|
2112
2203
|
*/
|
|
2113
|
-
export function
|
|
2204
|
+
export function getResultRowIds(
|
|
2114
2205
|
queryId: MaybeGetter<Id>,
|
|
2115
2206
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2116
2207
|
): {readonly current: Ids};
|
|
2117
2208
|
|
|
2118
2209
|
/**
|
|
2119
|
-
* The
|
|
2120
|
-
*
|
|
2121
|
-
* changes will update
|
|
2210
|
+
* The getResultSortedRowIds function returns a reactive object reflecting the
|
|
2211
|
+
* sorted Row Ids in a result Table, and registers a listener so that any
|
|
2212
|
+
* changes will update `current`.
|
|
2122
2213
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2123
2214
|
* @param cellId The Id of the Cell to sort by (or a getter returning it).
|
|
2124
2215
|
* @param descending Whether to sort descending (or a getter returning it).
|
|
@@ -2130,7 +2221,7 @@ export function createResultRowIds(
|
|
|
2130
2221
|
* @category Getter
|
|
2131
2222
|
* @since v8.1.0
|
|
2132
2223
|
*/
|
|
2133
|
-
export function
|
|
2224
|
+
export function getResultSortedRowIds(
|
|
2134
2225
|
queryId: MaybeGetter<Id>,
|
|
2135
2226
|
cellId?: MaybeGetter<Id | undefined>,
|
|
2136
2227
|
descending?: MaybeGetter<boolean>,
|
|
@@ -2140,9 +2231,9 @@ export function createResultSortedRowIds(
|
|
|
2140
2231
|
): {readonly current: Ids};
|
|
2141
2232
|
|
|
2142
2233
|
/**
|
|
2143
|
-
* The
|
|
2144
|
-
*
|
|
2145
|
-
*
|
|
2234
|
+
* The getResultRow function returns a reactive object reflecting a result Row
|
|
2235
|
+
* in a result Table, and registers a listener so that any changes will update
|
|
2236
|
+
* `current`.
|
|
2146
2237
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2147
2238
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
2148
2239
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
@@ -2151,16 +2242,16 @@ export function createResultSortedRowIds(
|
|
|
2151
2242
|
* @category Getter
|
|
2152
2243
|
* @since v8.1.0
|
|
2153
2244
|
*/
|
|
2154
|
-
export function
|
|
2245
|
+
export function getResultRow(
|
|
2155
2246
|
queryId: MaybeGetter<Id>,
|
|
2156
2247
|
rowId: MaybeGetter<Id>,
|
|
2157
2248
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2158
2249
|
): {readonly current: Row};
|
|
2159
2250
|
|
|
2160
2251
|
/**
|
|
2161
|
-
* The
|
|
2162
|
-
*
|
|
2163
|
-
*
|
|
2252
|
+
* The getResultCellIds function returns a reactive object reflecting the Ids of
|
|
2253
|
+
* the Cells in a result Row, and registers a listener so that any changes will
|
|
2254
|
+
* update `current`.
|
|
2164
2255
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2165
2256
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
2166
2257
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
@@ -2169,16 +2260,16 @@ export function createResultRow(
|
|
|
2169
2260
|
* @category Getter
|
|
2170
2261
|
* @since v8.1.0
|
|
2171
2262
|
*/
|
|
2172
|
-
export function
|
|
2263
|
+
export function getResultCellIds(
|
|
2173
2264
|
queryId: MaybeGetter<Id>,
|
|
2174
2265
|
rowId: MaybeGetter<Id>,
|
|
2175
2266
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2176
2267
|
): {readonly current: Ids};
|
|
2177
2268
|
|
|
2178
2269
|
/**
|
|
2179
|
-
* The
|
|
2180
|
-
*
|
|
2181
|
-
* update
|
|
2270
|
+
* The getResultCell function returns a reactive object reflecting the value of
|
|
2271
|
+
* a Cell in a result Row, and registers a listener so that any changes will
|
|
2272
|
+
* update `current`.
|
|
2182
2273
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2183
2274
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
2184
2275
|
* @param cellId The Id of the Cell (or a getter returning it).
|
|
@@ -2188,7 +2279,7 @@ export function createResultCellIds(
|
|
|
2188
2279
|
* @category Getter
|
|
2189
2280
|
* @since v8.1.0
|
|
2190
2281
|
*/
|
|
2191
|
-
export function
|
|
2282
|
+
export function getResultCell(
|
|
2192
2283
|
queryId: MaybeGetter<Id>,
|
|
2193
2284
|
rowId: MaybeGetter<Id>,
|
|
2194
2285
|
cellId: MaybeGetter<Id>,
|
|
@@ -2243,34 +2334,34 @@ export function getRelationshipsStoreTableIds(
|
|
|
2243
2334
|
};
|
|
2244
2335
|
|
|
2245
2336
|
/**
|
|
2246
|
-
* The
|
|
2337
|
+
* The getRelationshipsIds function returns a reactive object with the Ids of
|
|
2247
2338
|
* all Relationships objects registered in the current Provider context.
|
|
2248
2339
|
* @returns A reactive object with a `current` Ids property.
|
|
2249
2340
|
* @category Getter
|
|
2250
2341
|
* @since v8.1.0
|
|
2251
2342
|
*/
|
|
2252
|
-
export function
|
|
2343
|
+
export function getRelationshipsIds(): {readonly current: Ids};
|
|
2253
2344
|
|
|
2254
2345
|
/**
|
|
2255
|
-
* The
|
|
2256
|
-
*
|
|
2257
|
-
*
|
|
2346
|
+
* The getRelationshipIds function returns a reactive object reflecting the Ids
|
|
2347
|
+
* of the Relationships in a Relationships object, and registers a listener so
|
|
2348
|
+
* that any changes will update `current`.
|
|
2258
2349
|
* @param relationshipsOrRelationshipsId The Relationships object to use, or its
|
|
2259
2350
|
* Id.
|
|
2260
2351
|
* @returns A reactive object with a `current` Ids property.
|
|
2261
2352
|
* @category Getter
|
|
2262
2353
|
* @since v8.1.0
|
|
2263
2354
|
*/
|
|
2264
|
-
export function
|
|
2355
|
+
export function getRelationshipIds(
|
|
2265
2356
|
relationshipsOrRelationshipsId?: MaybeGetter<
|
|
2266
2357
|
RelationshipsOrRelationshipsId | undefined
|
|
2267
2358
|
>,
|
|
2268
2359
|
): {readonly current: Ids};
|
|
2269
2360
|
|
|
2270
2361
|
/**
|
|
2271
|
-
* The
|
|
2272
|
-
*
|
|
2273
|
-
*
|
|
2362
|
+
* The getRemoteRowId function returns a reactive object reflecting the remote
|
|
2363
|
+
* Row Id for a given local Row in a Relationship, and registers a listener so
|
|
2364
|
+
* that any changes will update `current`.
|
|
2274
2365
|
* @param relationshipId The Id of the Relationship (or a getter returning it).
|
|
2275
2366
|
* @param localRowId The Id of the local Row (or a getter returning it).
|
|
2276
2367
|
* @param relationshipsOrRelationshipsId The Relationships object to use (plain
|
|
@@ -2279,7 +2370,7 @@ export function createRelationshipIds(
|
|
|
2279
2370
|
* @category Getter
|
|
2280
2371
|
* @since v8.1.0
|
|
2281
2372
|
*/
|
|
2282
|
-
export function
|
|
2373
|
+
export function getRemoteRowId(
|
|
2283
2374
|
relationshipId: MaybeGetter<Id>,
|
|
2284
2375
|
localRowId: MaybeGetter<Id>,
|
|
2285
2376
|
relationshipsOrRelationshipsId?: MaybeGetter<
|
|
@@ -2288,9 +2379,9 @@ export function createRemoteRowId(
|
|
|
2288
2379
|
): {readonly current: Id | undefined};
|
|
2289
2380
|
|
|
2290
2381
|
/**
|
|
2291
|
-
* The
|
|
2382
|
+
* The getLocalRowIds function returns a reactive object reflecting the local
|
|
2292
2383
|
* Row Ids for a given remote Row in a Relationship, and registers a listener so
|
|
2293
|
-
* that any changes will update
|
|
2384
|
+
* that any changes will update `current`.
|
|
2294
2385
|
* @param relationshipId The Id of the Relationship (or a getter returning it).
|
|
2295
2386
|
* @param remoteRowId The Id of the remote Row (or a getter returning it).
|
|
2296
2387
|
* @param relationshipsOrRelationshipsId The Relationships object to use (plain
|
|
@@ -2299,7 +2390,7 @@ export function createRemoteRowId(
|
|
|
2299
2390
|
* @category Getter
|
|
2300
2391
|
* @since v8.1.0
|
|
2301
2392
|
*/
|
|
2302
|
-
export function
|
|
2393
|
+
export function getLocalRowIds(
|
|
2303
2394
|
relationshipId: MaybeGetter<Id>,
|
|
2304
2395
|
remoteRowId: MaybeGetter<Id>,
|
|
2305
2396
|
relationshipsOrRelationshipsId?: MaybeGetter<
|
|
@@ -2308,9 +2399,9 @@ export function createLocalRowIds(
|
|
|
2308
2399
|
): {readonly current: Ids};
|
|
2309
2400
|
|
|
2310
2401
|
/**
|
|
2311
|
-
* The
|
|
2312
|
-
*
|
|
2313
|
-
*
|
|
2402
|
+
* The getLinkedRowIds function returns a reactive object reflecting the linked
|
|
2403
|
+
* Row Ids in a Relationship, and registers a listener so that any changes will
|
|
2404
|
+
* update `current`.
|
|
2314
2405
|
* @param relationshipId The Id of the Relationship (or a getter returning it).
|
|
2315
2406
|
* @param firstRowId The Id of the first Row (or a getter returning it).
|
|
2316
2407
|
* @param relationshipsOrRelationshipsId The Relationships object to use (plain
|
|
@@ -2319,7 +2410,7 @@ export function createLocalRowIds(
|
|
|
2319
2410
|
* @category Getter
|
|
2320
2411
|
* @since v8.1.0
|
|
2321
2412
|
*/
|
|
2322
|
-
export function
|
|
2413
|
+
export function getLinkedRowIds(
|
|
2323
2414
|
relationshipId: MaybeGetter<Id>,
|
|
2324
2415
|
firstRowId: MaybeGetter<Id>,
|
|
2325
2416
|
relationshipsOrRelationshipsId?: MaybeGetter<
|
|
@@ -2354,34 +2445,34 @@ export function resolveCheckpoints(
|
|
|
2354
2445
|
): () => Checkpoints | undefined;
|
|
2355
2446
|
|
|
2356
2447
|
/**
|
|
2357
|
-
* The
|
|
2358
|
-
*
|
|
2448
|
+
* The getCheckpointsIds function returns a reactive object with the Ids of all
|
|
2449
|
+
* Checkpoints objects registered in the current Provider context.
|
|
2359
2450
|
* @returns A reactive object with a `current` Ids property.
|
|
2360
2451
|
* @category Getter
|
|
2361
2452
|
* @since v8.1.0
|
|
2362
2453
|
*/
|
|
2363
|
-
export function
|
|
2454
|
+
export function getCheckpointsIds(): {readonly current: Ids};
|
|
2364
2455
|
|
|
2365
2456
|
/**
|
|
2366
|
-
* The
|
|
2457
|
+
* The getCheckpointIds function returns a reactive object reflecting the
|
|
2367
2458
|
* CheckpointIds (backward, current, forward) in a Checkpoints object, and
|
|
2368
|
-
* registers a listener so that any changes will update
|
|
2459
|
+
* registers a listener so that any changes will update `current`.
|
|
2369
2460
|
* @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
|
|
2370
2461
|
* getter), or its Id.
|
|
2371
2462
|
* @returns A reactive object with a `current` CheckpointIds property.
|
|
2372
2463
|
* @category Getter
|
|
2373
2464
|
* @since v8.1.0
|
|
2374
2465
|
*/
|
|
2375
|
-
export function
|
|
2466
|
+
export function getCheckpointIds(
|
|
2376
2467
|
checkpointsOrCheckpointsId?: MaybeGetter<
|
|
2377
2468
|
CheckpointsOrCheckpointsId | undefined
|
|
2378
2469
|
>,
|
|
2379
2470
|
): {readonly current: CheckpointIds};
|
|
2380
2471
|
|
|
2381
2472
|
/**
|
|
2382
|
-
* The
|
|
2383
|
-
*
|
|
2384
|
-
*
|
|
2473
|
+
* The getCheckpoint function returns a reactive object reflecting the label of
|
|
2474
|
+
* a checkpoint, and registers a listener so that any changes will update
|
|
2475
|
+
* `current`.
|
|
2385
2476
|
* @param checkpointId The Id of the checkpoint (or a getter returning it).
|
|
2386
2477
|
* @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
|
|
2387
2478
|
* getter), or its Id.
|
|
@@ -2389,7 +2480,7 @@ export function createCheckpointIds(
|
|
|
2389
2480
|
* @category Getter
|
|
2390
2481
|
* @since v8.1.0
|
|
2391
2482
|
*/
|
|
2392
|
-
export function
|
|
2483
|
+
export function getCheckpoint(
|
|
2393
2484
|
checkpointId: MaybeGetter<Id>,
|
|
2394
2485
|
checkpointsOrCheckpointsId?: MaybeGetter<
|
|
2395
2486
|
CheckpointsOrCheckpointsId | undefined
|
|
@@ -2448,24 +2539,24 @@ export function resolvePersister(
|
|
|
2448
2539
|
): () => AnyPersister | undefined;
|
|
2449
2540
|
|
|
2450
2541
|
/**
|
|
2451
|
-
* The
|
|
2542
|
+
* The getPersisterIds function returns a reactive object with the Ids of all
|
|
2452
2543
|
* Persisters registered in the current Provider context.
|
|
2453
2544
|
* @returns A reactive object with a `current` Ids property.
|
|
2454
2545
|
* @category Getter
|
|
2455
2546
|
* @since v8.1.0
|
|
2456
2547
|
*/
|
|
2457
|
-
export function
|
|
2548
|
+
export function getPersisterIds(): {readonly current: Ids};
|
|
2458
2549
|
|
|
2459
2550
|
/**
|
|
2460
|
-
* The
|
|
2551
|
+
* The getPersisterStatus function returns a reactive object reflecting the
|
|
2461
2552
|
* status of a Persister, and registers a listener so that any changes will
|
|
2462
|
-
* update
|
|
2553
|
+
* update `current`.
|
|
2463
2554
|
* @param persisterOrPersisterId The Persister to use, or its Id.
|
|
2464
2555
|
* @returns A reactive object with a `current` Status property.
|
|
2465
2556
|
* @category Getter
|
|
2466
2557
|
* @since v8.1.0
|
|
2467
2558
|
*/
|
|
2468
|
-
export function
|
|
2559
|
+
export function getPersisterStatus(
|
|
2469
2560
|
persisterOrPersisterId?: MaybeGetter<PersisterOrPersisterId | undefined>,
|
|
2470
2561
|
): {readonly current: Status};
|
|
2471
2562
|
|
|
@@ -2495,24 +2586,24 @@ export function resolveSynchronizer(
|
|
|
2495
2586
|
): () => Synchronizer | undefined;
|
|
2496
2587
|
|
|
2497
2588
|
/**
|
|
2498
|
-
* The
|
|
2499
|
-
*
|
|
2589
|
+
* The getSynchronizerIds function returns a reactive object with the Ids of all
|
|
2590
|
+
* Synchronizers registered in the current Provider context.
|
|
2500
2591
|
* @returns A reactive object with a `current` Ids property.
|
|
2501
2592
|
* @category Getter
|
|
2502
2593
|
* @since v8.1.0
|
|
2503
2594
|
*/
|
|
2504
|
-
export function
|
|
2595
|
+
export function getSynchronizerIds(): {readonly current: Ids};
|
|
2505
2596
|
|
|
2506
2597
|
/**
|
|
2507
|
-
* The
|
|
2508
|
-
*
|
|
2509
|
-
*
|
|
2598
|
+
* The getSynchronizerStatus function returns a reactive object reflecting the
|
|
2599
|
+
* status of a Synchronizer, and registers a listener so that any changes will
|
|
2600
|
+
* update `current`.
|
|
2510
2601
|
* @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
|
|
2511
2602
|
* @returns A reactive object with a `current` Status property.
|
|
2512
2603
|
* @category Getter
|
|
2513
2604
|
* @since v8.1.0
|
|
2514
2605
|
*/
|
|
2515
|
-
export function
|
|
2606
|
+
export function getSynchronizerStatus(
|
|
2516
2607
|
synchronizerOrSynchronizerId?: MaybeGetter<
|
|
2517
2608
|
SynchronizerOrSynchronizerId | undefined
|
|
2518
2609
|
>,
|