@genesislcap/grid-pro 14.79.0 → 14.79.2-alpha-ca658e8.0

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.
@@ -4,6 +4,11 @@
4
4
 
5
5
  ## GridPro.enabledRowFlashing property
6
6
 
7
+ > Warning: This API is now obsolete.
8
+ >
9
+ > - use `enableRowFlashing` instead.
10
+ >
11
+
7
12
  **Signature:**
8
13
 
9
14
  ```typescript
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [enableRowFlashing](./grid-pro.gridpro.enablerowflashing.md)
4
+
5
+ ## GridPro.enableRowFlashing property
6
+
7
+ If true, will enable row flashing for all rows for `add` async transactions
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ enableRowFlashing: boolean;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Requires `asyncAdd` to be `true`
18
+
@@ -27,16 +27,21 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
27
27
 
28
28
  | Property | Modifiers | Type | Description |
29
29
  | --- | --- | --- | --- |
30
+ | [addIndex](./grid-pro.gridpro.addindex.md) | | number | The index to add new rows to when using <code>applyTransaction</code> or <code>applyTransactionAsync</code> |
30
31
  | [agAttributes](./grid-pro.gridpro.agattributes.md) | <code>protected</code> | Record&lt;string, string&gt; | |
31
32
  | [agGrid](./grid-pro.gridpro.aggrid.md) | | Grid | |
32
33
  | [agGridOptions](./grid-pro.gridpro.aggridoptions.md) | <code>protected</code> | GridOptions | |
33
34
  | [agPropertiesMap](./grid-pro.gridpro.agpropertiesmap.md) | <code>protected</code> | Record&lt;string, string&gt; | |
35
+ | [asyncAdd](./grid-pro.gridpro.asyncadd.md) | | boolean | Whether to use the <code>applyTransactionAsync</code> function for \*add\* transactions |
36
+ | [asyncRemove](./grid-pro.gridpro.asyncremove.md) | | boolean | Whether to use the <code>applyTransactionAsync</code> function for \*remove\* transactions |
37
+ | [asyncUpdate](./grid-pro.gridpro.asyncupdate.md) | | boolean | Whether to use the <code>applyTransactionAsync</code> function for \*update\* transactions |
34
38
  | [autoCellRendererByType](./grid-pro.gridpro.autocellrendererbytype.md) | | boolean | |
35
39
  | [classNames](./grid-pro.gridpro.classnames.md) | | string | |
36
40
  | [columnApi](./grid-pro.gridpro.columnapi.md) | | ColumnApi | |
37
41
  | [columnComponentName](./grid-pro.gridpro.columncomponentname.md) | | string | |
38
- | [enableCellFlashing](./grid-pro.gridpro.enablecellflashing.md) | | boolean | If true, will enable cell flashing for all cell renderers, unless otherwise defined in custom colDef |
42
+ | [enableCellFlashing](./grid-pro.gridpro.enablecellflashing.md) | | boolean | If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef |
39
43
  | [enabledRowFlashing](./grid-pro.gridpro.enabledrowflashing.md) | | boolean | |
44
+ | [enableRowFlashing](./grid-pro.gridpro.enablerowflashing.md) | | boolean | If true, will enable row flashing for all rows for <code>add</code> async transactions |
40
45
  | [eventsAndCallbacks](./grid-pro.gridpro.eventsandcallbacks.md) | | any | |
41
46
  | [gridApi](./grid-pro.gridpro.gridapi.md) | | GridApi | |
42
47
  | [gridAutosizingEnabled](./grid-pro.gridpro.gridautosizingenabled.md) | | boolean | Boolean attribute to control whether the grid autosizes the columns upon interaction. This will disable the column widths from being manually set, and doesn't save the widths in local storage if you are using <code>persist-column-state-key</code>. |
@@ -49,7 +54,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
49
54
  | [initialised](./grid-pro.gridpro.initialised.md) | <code>protected</code> | boolean | |
50
55
  | [observedAttributes](./grid-pro.gridpro.observedattributes.md) | <code>readonly</code> | string\[\] | |
51
56
  | [onlyTemplateColDefs](./grid-pro.gridpro.onlytemplatecoldefs.md) | | boolean | |
52
- | [persistColumnStateKey](./grid-pro.gridpro.persistcolumnstatekey.md) | | string | |
57
+ | [persistColumnStateKey](./grid-pro.gridpro.persistcolumnstatekey.md) | | string | The key to use for persisting the column state in local storage. |
53
58
  | [rowHeight](./grid-pro.gridpro.rowheight.md) | | number | |
54
59
  | [theme](./grid-pro.gridpro.theme.md) | | string | |
55
60
 
@@ -4,6 +4,8 @@
4
4
 
5
5
  ## GridPro.persistColumnStateKey property
6
6
 
7
+ The key to use for persisting the column state in local storage.
8
+
7
9
  **Signature:**
8
10
 
9
11
  ```typescript
@@ -530,6 +530,7 @@ export type GridComponents = {
530
530
  // @public
531
531
  export class GridPro extends GridPro_base {
532
532
  constructor();
533
+ addIndex: number;
533
534
  // (undocumented)
534
535
  agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
535
536
  // (undocumented)
@@ -542,6 +543,9 @@ export class GridPro extends GridPro_base {
542
543
  protected agPropertiesMap: Record<string, string>;
543
544
  // (undocumented)
544
545
  applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefs?: boolean): ColDef<any>[];
546
+ asyncAdd: boolean;
547
+ asyncRemove: boolean;
548
+ asyncUpdate: boolean;
545
549
  // (undocumented)
546
550
  autoCellRendererByType: boolean;
547
551
  // (undocumented)
@@ -557,8 +561,9 @@ export class GridPro extends GridPro_base {
557
561
  // (undocumented)
558
562
  disconnectedCallback(): void;
559
563
  enableCellFlashing: boolean;
560
- // (undocumented)
564
+ // @deprecated (undocumented)
561
565
  enabledRowFlashing: boolean;
566
+ enableRowFlashing: boolean;
562
567
  // (undocumented)
563
568
  eventsAndCallbacks: any;
564
569
  getSavedColumnState(): ColumnState[];
@@ -588,7 +593,6 @@ export class GridPro extends GridPro_base {
588
593
  get observedAttributes(): string[];
589
594
  // (undocumented)
590
595
  onlyTemplateColDefs: boolean;
591
- // (undocumented)
592
596
  persistColumnStateKey: string;
593
597
  // (undocumented)
594
598
  rowHeight: number;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/grid-pro",
3
3
  "description": "Genesis Foundation AG Grid",
4
- "version": "14.79.0",
4
+ "version": "14.79.2-alpha-ca658e8.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -28,14 +28,14 @@
28
28
  "test:debug": "genx test --debug"
29
29
  },
30
30
  "devDependencies": {
31
- "@genesislcap/foundation-testing": "14.79.0",
32
- "@genesislcap/genx": "14.79.0",
31
+ "@genesislcap/foundation-testing": "14.79.2-alpha-ca658e8.0",
32
+ "@genesislcap/genx": "14.79.2-alpha-ca658e8.0",
33
33
  "rimraf": "^3.0.2"
34
34
  },
35
35
  "dependencies": {
36
- "@genesislcap/foundation-comms": "14.79.0",
37
- "@genesislcap/foundation-ui": "14.79.0",
38
- "@genesislcap/foundation-utils": "14.79.0",
36
+ "@genesislcap/foundation-comms": "14.79.2-alpha-ca658e8.0",
37
+ "@genesislcap/foundation-ui": "14.79.2-alpha-ca658e8.0",
38
+ "@genesislcap/foundation-utils": "14.79.2-alpha-ca658e8.0",
39
39
  "@microsoft/fast-colors": "^5.1.4",
40
40
  "@microsoft/fast-components": "^2.21.3",
41
41
  "@microsoft/fast-element": "^1.7.0",
@@ -58,5 +58,5 @@
58
58
  "access": "public"
59
59
  },
60
60
  "customElements": "dist/custom-elements.json",
61
- "gitHead": "387b58371f312eade8910d403a6bcce506212bb7"
61
+ "gitHead": "661e12b401aacf5b3f1c11e50d4d22dbeda577d9"
62
62
  }