npm - @sankhyalabs/core-docs - Versions diffs - 4.1.1 → 4.2.1 - Mend

@sankhyalabs/core-docs 4.1.1 → 4.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

package/classes/Change.md +11 -11
package/classes/DataUnit.md +104 -49
package/enums/Action.md +14 -3
package/enums/ChangeOperation.md +4 -4
package/interfaces/AllRecord.md +96 -0
package/interfaces/DUActionInterceptor.md +1 -1
package/interfaces/PageRequest.md +3 -3
package/interfaces/QuickFilter.md +2 -2
package/interfaces/Record.md +6 -4
package/interfaces/SavedRecord.md +5 -5
package/interfaces/WaitingChange.md +3 -3
package/modules.md +1 -0
package/package.json +1 -1

package/classes/Change.md CHANGED Viewed

@@ -47,7 +47,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1493
+src/dataunit/DataUnit.ts:1529
 ## Properties
@@ -57,7 +57,7 @@ src/dataunit/DataUnit.ts:1493
 #### Defined in
-src/dataunit/DataUnit.ts:1491
+src/dataunit/DataUnit.ts:1527
 ___
@@ -67,7 +67,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1486
+src/dataunit/DataUnit.ts:1522
 ___
@@ -77,7 +77,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1487
+src/dataunit/DataUnit.ts:1523
 ___
@@ -87,7 +87,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1488
+src/dataunit/DataUnit.ts:1524
 ___
@@ -97,7 +97,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1489
+src/dataunit/DataUnit.ts:1525
 ## Accessors
@@ -115,7 +115,7 @@ Obtém o tipo de operação que está sendo realizada.
 #### Defined in
-src/dataunit/DataUnit.ts:1508
+src/dataunit/DataUnit.ts:1544
 ## Methods
@@ -133,7 +133,7 @@ Retorna se o DataUnit está em uma operação de cópia.
 #### Defined in
-src/dataunit/DataUnit.ts:1530
+src/dataunit/DataUnit.ts:1566
 ___
@@ -151,7 +151,7 @@ Retorna se o DataUnit está em uma operação de deleção.
 #### Defined in
-src/dataunit/DataUnit.ts:1541
+src/dataunit/DataUnit.ts:1577
 ___
@@ -169,7 +169,7 @@ Retorna se o DataUnit está em uma operação de inserção.
 #### Defined in
-src/dataunit/DataUnit.ts:1519
+src/dataunit/DataUnit.ts:1555
 ___
@@ -187,4 +187,4 @@ Retorna se o DataUnit está em uma operação de atualização.
 #### Defined in
-src/dataunit/DataUnit.ts:1552
+src/dataunit/DataUnit.ts:1588

package/classes/DataUnit.md CHANGED Viewed

@@ -51,6 +51,7 @@
 - [childrenIsDirty](DataUnit.md#childrenisdirty)
 - [clearDataUnit](DataUnit.md#cleardataunit)
 - [clearInvalid](DataUnit.md#clearinvalid)
+- [clearSelection](DataUnit.md#clearselection)
 - [copySelected](DataUnit.md#copyselected)
 - [disableField](DataUnit.md#disablefield)
 - [dispatchAction](DataUnit.md#dispatchaction)
@@ -108,6 +109,7 @@
 - [setInvalidField](DataUnit.md#setinvalidfield)
 - [setSelection](DataUnit.md#setselection)
 - [setSelectionByIndex](DataUnit.md#setselectionbyindex)
+- [setUnselection](DataUnit.md#setunselection)
 - [showField](DataUnit.md#showfield)
 - [startChange](DataUnit.md#startchange)
 - [subscribe](DataUnit.md#subscribe)
@@ -641,7 +643,7 @@ Verdadeiro se for possível refazer a ação.
 #### Defined in
-src/dataunit/DataUnit.ts:1183
+src/dataunit/DataUnit.ts:1214
 ___
@@ -659,7 +661,7 @@ Verdadeiro se for possível desfazer a ação.
 #### Defined in
-src/dataunit/DataUnit.ts:1172
+src/dataunit/DataUnit.ts:1203
 ___
@@ -682,7 +684,7 @@ Cancela edição do registro atual.
 #### Defined in
-src/dataunit/DataUnit.ts:1041
+src/dataunit/DataUnit.ts:1072
 ___
@@ -722,7 +724,7 @@ Verdadeiro se existir alterações pendentes em algum DataUnit detail.
 #### Defined in
-src/dataunit/DataUnit.ts:1068
+src/dataunit/DataUnit.ts:1099
 ___
@@ -738,7 +740,7 @@ Limpa todos os registros do DataUnit
 #### Defined in
-src/dataunit/DataUnit.ts:975
+src/dataunit/DataUnit.ts:1006
 ___
@@ -765,6 +767,30 @@ src/dataunit/DataUnit.ts:839
 ___
+### clearSelection
+▸ **clearSelection**(`executionCtx?`): `Promise`<`boolean`\>
+Remove a seleção de todos os registros.
+#### Parameters
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da remoção da seleção dos registros do DataUnit. |
+#### Returns
+`Promise`<`boolean`\>
+- Verdadeiro se ação executada.
+#### Defined in
+src/dataunit/DataUnit.ts:924
+___
 ### copySelected
 ▸ **copySelected**(`executionCtx?`): `void`
@@ -805,7 +831,7 @@ Desabilita um campo do DataUnit
 #### Defined in
-src/dataunit/DataUnit.ts:1418
+src/dataunit/DataUnit.ts:1449
 ___
@@ -831,7 +857,7 @@ Lança ação do DataUnit para que sejam processadas.
 #### Defined in
-src/dataunit/DataUnit.ts:1233
+src/dataunit/DataUnit.ts:1264
 ___
@@ -853,7 +879,7 @@ Processa as ações no DataUnit e notifica os observers.
 #### Defined in
-src/dataunit/DataUnit.ts:1281
+src/dataunit/DataUnit.ts:1312
 ___
@@ -875,7 +901,7 @@ Habilita um campo do DataUnit
 #### Defined in
-src/dataunit/DataUnit.ts:1403
+src/dataunit/DataUnit.ts:1434
 ___
@@ -959,7 +985,7 @@ Cria um dataunit filho.
 #### Defined in
-src/dataunit/DataUnit.ts:1304
+src/dataunit/DataUnit.ts:1335
 ___
@@ -1073,7 +1099,7 @@ Obtém todos os filtros de dados.
 #### Defined in
-src/dataunit/DataUnit.ts:1386
+src/dataunit/DataUnit.ts:1417
 ___
@@ -1211,7 +1237,7 @@ Retorna apenas um registro selecionado no Dataunit
 #### Defined in
-src/dataunit/DataUnit.ts:962
+src/dataunit/DataUnit.ts:993
 ___
@@ -1219,35 +1245,35 @@ ___
 ▸ **getSelectedRecords**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
-Obtém todos os registros selecionados.
+Obtém os registros selecionados da página atual.
 #### Returns
 `undefined` \| [`Record`](../interfaces/Record.md)[]
-- Lista de registros selecionados.
+- Lista de registros selecionados da página atual.
 #### Defined in
-src/dataunit/DataUnit.ts:947
+src/dataunit/DataUnit.ts:976
 ___
 ### getSelection
-▸ **getSelection**(): `string`[]
+▸ **getSelection**(): [`Record`](../interfaces/Record.md)[]
-Obtém registros selecionados.
+Obtém todos os registros selecionados.
 #### Returns
-`string`[]
+[`Record`](../interfaces/Record.md)[]
-- Registros selecionados.
+- Lista de todos os registros selecionados.
 #### Defined in
-src/dataunit/DataUnit.ts:885
+src/dataunit/DataUnit.ts:883
 ___
@@ -1265,7 +1291,7 @@ Obtém a estrutura de ordenação das colunas dos dados.
 #### Defined in
-src/dataunit/DataUnit.ts:1375
+src/dataunit/DataUnit.ts:1406
 ___
@@ -1308,7 +1334,7 @@ Verdadeiro se algum registro foi adicionado.
 #### Defined in
-src/dataunit/DataUnit.ts:1152
+src/dataunit/DataUnit.ts:1183
 ___
@@ -1326,7 +1352,7 @@ Verdadeiro se existir alterações de registros pendentes.
 #### Defined in
-src/dataunit/DataUnit.ts:1082
+src/dataunit/DataUnit.ts:1113
 ___
@@ -1344,7 +1370,7 @@ Verdadeiro se algum registro foi adicionado.
 #### Defined in
-src/dataunit/DataUnit.ts:1140
+src/dataunit/DataUnit.ts:1171
 ___
@@ -1362,7 +1388,7 @@ Verdadeiro se existir uma próxima página.
 #### Defined in
-src/dataunit/DataUnit.ts:1093
+src/dataunit/DataUnit.ts:1124
 ___
@@ -1380,7 +1406,7 @@ Verdadeiro se existir uma página anterior.
 #### Defined in
-src/dataunit/DataUnit.ts:1108
+src/dataunit/DataUnit.ts:1139
 ___
@@ -1402,7 +1428,7 @@ Deixa um campo do DataUnit invisível
 #### Defined in
-src/dataunit/DataUnit.ts:1433
+src/dataunit/DataUnit.ts:1464
 ___
@@ -1427,7 +1453,7 @@ Notifica os interceptors de que uma ação foi executada, para que cada intercep
 #### Defined in
-src/dataunit/DataUnit.ts:1264
+src/dataunit/DataUnit.ts:1295
 ___
@@ -1445,7 +1471,7 @@ Verdadeiro se existir alterações pendentes.
 #### Defined in
-src/dataunit/DataUnit.ts:1057
+src/dataunit/DataUnit.ts:1088
 ___
@@ -1469,7 +1495,7 @@ Verdadeiro se o id solicitado é de um registro novo.
 #### Defined in
-src/dataunit/DataUnit.ts:1124
+src/dataunit/DataUnit.ts:1155
 ___
@@ -1585,7 +1611,7 @@ Seleciona o próximo registro.
 #### Defined in
-src/dataunit/DataUnit.ts:987
+src/dataunit/DataUnit.ts:1018
 ___
@@ -1673,7 +1699,7 @@ Seleciona o registro anterior.
 #### Defined in
-src/dataunit/DataUnit.ts:1014
+src/dataunit/DataUnit.ts:1045
 ___
@@ -1695,7 +1721,7 @@ Refaz a última ação.
 #### Defined in
-src/dataunit/DataUnit.ts:1206
+src/dataunit/DataUnit.ts:1237
 ___
@@ -1729,7 +1755,7 @@ Recarrega registro selecionado com dados atualizados do servidor.
 #### Defined in
-src/dataunit/DataUnit.ts:1351
+src/dataunit/DataUnit.ts:1382
 ___
@@ -1751,7 +1777,7 @@ Remove um dataunit filho.
 #### Defined in
-src/dataunit/DataUnit.ts:1317
+src/dataunit/DataUnit.ts:1348
 ___
@@ -1870,7 +1896,7 @@ Seleciona o primeiro registro.
 #### Defined in
-src/dataunit/DataUnit.ts:908
+src/dataunit/DataUnit.ts:935
 ___
@@ -1892,7 +1918,7 @@ Seleciona o último registro.
 #### Defined in
-src/dataunit/DataUnit.ts:921
+src/dataunit/DataUnit.ts:948
 ___
@@ -1946,20 +1972,22 @@ ___
 ### setSelection
-▸ **setSelection**(`selection`, `executionCtx?`): `void`
+▸ **setSelection**(`selection`, `executionCtx?`): `Promise`<`boolean`\>
-Seleciona múltiplos registros por ID.
+Seleciona múltiplos registros.
 #### Parameters
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `selection` | `string`[] | IDs para selecionar. |
+| `selection` | [`Record`](../interfaces/Record.md)[] | Registros para selecionar. |
 | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção dos registros do DataUnit. |
 #### Returns
-`void`
+`Promise`<`boolean`\>
+- Verdadeiro se ação executada.
 #### Defined in
@@ -1969,7 +1997,7 @@ ___
 ### setSelectionByIndex
-▸ **setSelectionByIndex**(`selection`, `executionCtx?`): `void`
+▸ **setSelectionByIndex**(`selection`, `executionCtx?`): `Promise`<`boolean`\>
 Seleciona múltiplos registros por índice.
@@ -1982,11 +2010,38 @@ Seleciona múltiplos registros por índice.
 #### Returns
-`void`
+`Promise`<`boolean`\>
+- Verdadeiro se ação executada.
+#### Defined in
+src/dataunit/DataUnit.ts:965
+___
+### setUnselection
+▸ **setUnselection**(`unselection`, `executionCtx?`): `Promise`<`boolean`\>
+Remove a seleção de múltiplos registros.
+#### Parameters
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `unselection` | [`Record`](../interfaces/Record.md)[] | Registros para remover a seleção. |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da remoção da seleção dos registros do DataUnit. |
+#### Returns
+`Promise`<`boolean`\>
+- Verdadeiro se ação executada.
 #### Defined in
-src/dataunit/DataUnit.ts:936
+src/dataunit/DataUnit.ts:911
 ___
@@ -2008,7 +2063,7 @@ Deixa um campo do DataUnit visível
 #### Defined in
-src/dataunit/DataUnit.ts:1448
+src/dataunit/DataUnit.ts:1479
 ___
@@ -2054,7 +2109,7 @@ Ela vai ser chamada sempre que uma ação for despachada (dispatchAction()).
 #### Defined in
-src/dataunit/DataUnit.ts:1329
+src/dataunit/DataUnit.ts:1360
 ___
@@ -2072,7 +2127,7 @@ Obtém a representação textual do DataUnit, nesse caso, o nome do DataUnit.
 #### Defined in
-src/dataunit/DataUnit.ts:1217
+src/dataunit/DataUnit.ts:1248
 ___
@@ -2094,7 +2149,7 @@ Desfaz a última ação.
 #### Defined in
-src/dataunit/DataUnit.ts:1195
+src/dataunit/DataUnit.ts:1226
 ___
@@ -2116,7 +2171,7 @@ Remove um observer existente.
 #### Defined in
-src/dataunit/DataUnit.ts:1340
+src/dataunit/DataUnit.ts:1371
 ___

package/enums/Action.md CHANGED Viewed

@@ -29,6 +29,7 @@
 - [REMOVING\_RECORDS](Action.md#removing_records)
 - [SAVING\_DATA](Action.md#saving_data)
 - [SELECTION\_CHANGED](Action.md#selection_changed)
+- [SELECTION\_REMOVED](Action.md#selection_removed)
 - [STATE\_CHANGED](Action.md#state_changed)
 - [WAITING\_CHANGE\_CANCELED](Action.md#waiting_change_canceled)
@@ -70,7 +71,7 @@ ___
 #### Defined in
-src/dataunit/state/action/DataUnitAction.ts:61
+src/dataunit/state/action/DataUnitAction.ts:63
 ___
@@ -120,7 +121,7 @@ ___
 #### Defined in
-src/dataunit/state/action/DataUnitAction.ts:63
+src/dataunit/state/action/DataUnitAction.ts:65
 ___
@@ -130,7 +131,7 @@ ___
 #### Defined in
-src/dataunit/state/action/DataUnitAction.ts:64
+src/dataunit/state/action/DataUnitAction.ts:66
 ___
@@ -264,6 +265,16 @@ src/dataunit/state/action/DataUnitAction.ts:52
 ___
+### SELECTION\_REMOVED
+• **SELECTION\_REMOVED** = ``"selectionRemoved"``
+#### Defined in
+src/dataunit/state/action/DataUnitAction.ts:61
+___
 ### STATE\_CHANGED
 • **STATE\_CHANGED** = ``"stateChanged"``

package/enums/ChangeOperation.md CHANGED Viewed

@@ -19,7 +19,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1476
+src/dataunit/DataUnit.ts:1512
 ___
@@ -29,7 +29,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1478
+src/dataunit/DataUnit.ts:1514
 ___
@@ -39,7 +39,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1475
+src/dataunit/DataUnit.ts:1511
 ___
@@ -49,4 +49,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1477
+src/dataunit/DataUnit.ts:1513

package/interfaces/AllRecord.md ADDED Viewed

@@ -0,0 +1,96 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / AllRecord
+# Interface: AllRecord
+## Hierarchy
+- [`Record`](Record.md)
+  ↳ **`AllRecord`**
+## Table of contents
+### Properties
+- [\_\_owner\_\_dataunit\_\_name\_\_](AllRecord.md#__owner__dataunit__name__)
+- [\_\_parent\_\_record\_\_id\_\_](AllRecord.md#__parent__record__id__)
+- [\_\_record\_\_id\_\_](AllRecord.md#__record__id__)
+- [\_\_record\_\_label\_\_](AllRecord.md#__record__label__)
+- [filter](AllRecord.md#filter)
+- [sort](AllRecord.md#sort)
+## Properties
+### \_\_owner\_\_dataunit\_\_name\_\_
+• `Optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
+#### Inherited from
+[Record](Record.md).[__owner__dataunit__name__](Record.md#__owner__dataunit__name__)
+#### Defined in
+src/dataunit/DataUnit.ts:1497
+___
+### \_\_parent\_\_record\_\_id\_\_
+• `Optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
+#### Inherited from
+[Record](Record.md).[__parent__record__id__](Record.md#__parent__record__id__)
+#### Defined in
+src/dataunit/DataUnit.ts:1496
+___
+### \_\_record\_\_id\_\_
+• **\_\_record\_\_id\_\_**: `string`
+#### Inherited from
+[Record](Record.md).[__record__id__](Record.md#__record__id__)
+#### Defined in
+src/dataunit/DataUnit.ts:1494
+___
+### \_\_record\_\_label\_\_
+• `Optional` **\_\_record\_\_label\_\_**: `string`
+#### Inherited from
+[Record](Record.md).[__record__label__](Record.md#__record__label__)
+#### Defined in
+src/dataunit/DataUnit.ts:1495
+___
+### filter
+• **filter**: [`Filter`](Filter.md)[]
+#### Defined in
+src/dataunit/DataUnit.ts:1506
+___
+### sort
+• **sort**: [`Sort`](Sort.md)[]
+#### Defined in
+src/dataunit/DataUnit.ts:1507

package/interfaces/DUActionInterceptor.md CHANGED Viewed

@@ -26,4 +26,4 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1459
+src/dataunit/DataUnit.ts:1490

package/interfaces/PageRequest.md CHANGED Viewed

@@ -18,7 +18,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1565
+src/dataunit/DataUnit.ts:1601
 ___
@@ -28,7 +28,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1566
+src/dataunit/DataUnit.ts:1602
 ___
@@ -38,4 +38,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1567
+src/dataunit/DataUnit.ts:1603

package/interfaces/QuickFilter.md CHANGED Viewed

@@ -17,7 +17,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1572
+src/dataunit/DataUnit.ts:1608
 ___
@@ -27,4 +27,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1571
+src/dataunit/DataUnit.ts:1607

package/interfaces/Record.md CHANGED Viewed

@@ -8,6 +8,8 @@
   ↳ [`SavedRecord`](SavedRecord.md)
+  ↳ [`AllRecord`](AllRecord.md)
 ## Indexable
 ▪ [key: `string`]: `any`
@@ -29,7 +31,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1466
+src/dataunit/DataUnit.ts:1497
 ___
@@ -39,7 +41,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1465
+src/dataunit/DataUnit.ts:1496
 ___
@@ -49,7 +51,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1463
+src/dataunit/DataUnit.ts:1494
 ___
@@ -59,4 +61,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1464
+src/dataunit/DataUnit.ts:1495

package/interfaces/SavedRecord.md CHANGED Viewed

@@ -26,7 +26,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1471
+src/dataunit/DataUnit.ts:1502
 ___
@@ -40,7 +40,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1466
+src/dataunit/DataUnit.ts:1497
 ___
@@ -54,7 +54,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1465
+src/dataunit/DataUnit.ts:1496
 ___
@@ -68,7 +68,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1463
+src/dataunit/DataUnit.ts:1494
 ___
@@ -82,4 +82,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1464
+src/dataunit/DataUnit.ts:1495

package/interfaces/WaitingChange.md CHANGED Viewed

@@ -18,7 +18,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1560
+src/dataunit/DataUnit.ts:1596
 ___
@@ -28,7 +28,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1561
+src/dataunit/DataUnit.ts:1597
 ___
@@ -38,4 +38,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1559
+src/dataunit/DataUnit.ts:1595

package/modules.md CHANGED Viewed

@@ -47,6 +47,7 @@
 ### Interfaces
+- [AllRecord](interfaces/AllRecord.md)
 - [ChildDescriptor](interfaces/ChildDescriptor.md)
 - [ChildLink](interfaces/ChildLink.md)
 - [DUActionInterceptor](interfaces/DUActionInterceptor.md)

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@sankhyalabs/core-docs",
-    "version": "4.1.1",
+    "version": "4.2.1",
     "description": "Documentação da biblioteca de componentes Sankhya.",
     "main": "",
     "files": [