@genesislcap/grid-pro 15.3.2-FUI-2591.1 → 15.3.2-canary.16

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.
@@ -16275,592 +16275,534 @@
16275
16275
  },
16276
16276
  {
16277
16277
  "kind": "javascript-module",
16278
- "path": "src/grid-pro-genesis-datasource/datasource-events.types.ts",
16278
+ "path": "src/multicolumn-dropdown/index.ts",
16279
+ "declarations": [],
16280
+ "exports": [
16281
+ {
16282
+ "kind": "js",
16283
+ "name": "*",
16284
+ "declaration": {
16285
+ "name": "*",
16286
+ "package": "./multicolumn-dropdown"
16287
+ }
16288
+ },
16289
+ {
16290
+ "kind": "js",
16291
+ "name": "*",
16292
+ "declaration": {
16293
+ "name": "*",
16294
+ "package": "./multicolumn-dropdown.styles"
16295
+ }
16296
+ },
16297
+ {
16298
+ "kind": "js",
16299
+ "name": "*",
16300
+ "declaration": {
16301
+ "name": "*",
16302
+ "package": "./multicolumn-dropdown.template"
16303
+ }
16304
+ }
16305
+ ]
16306
+ },
16307
+ {
16308
+ "kind": "javascript-module",
16309
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts",
16279
16310
  "declarations": [
16280
16311
  {
16281
16312
  "kind": "variable",
16282
- "name": "datasourceEventNames",
16313
+ "name": "dropdownWidthVar",
16283
16314
  "type": {
16284
- "text": "{\n // Initialization events\n initialize: 'datasource-initialize',\n ready: 'datasource-ready',\n\n // Data events\n dataLoaded: 'datasource-data-loaded',\n dataChanged: 'datasource-data-changed',\n dataCleared: 'datasource-data-cleared',\n\n // Schema events\n schemaUpdated: 'datasource-schema-updated',\n\n // Status events\n loadingStarted: 'datasource-loading-started',\n loadingFinished: 'datasource-loading-finished',\n noDataAvailable: 'datasource-no-data-available',\n moreDataAvailable: 'datasource-more-data-available',\n\n // Filter events\n filtersRestored: 'datasource-filters-restored',\n\n // Error events\n error: 'datasource-error',\n\n // Destroy datasource events\n destroy: 'datasource-destroy',\n\n // Size events\n sizeChanged: 'datasource-size-changed',\n\n // Server-side specific events\n cacheFilterConfig: 'cache-filter-config',\n refreshServerSide: 'refresh-server-side',\n setServerSideDatasource: 'set-server-side-datasource',\n addGridCssClass: 'add-grid-css-class',\n removeGridCssClass: 'remove-grid-css-class',\n applyServerSideTransaction: 'apply-server-side-transaction',\n}"
16315
+ "text": "string"
16285
16316
  },
16286
- "default": "{\n // Initialization events\n initialize: 'datasource-initialize',\n ready: 'datasource-ready',\n\n // Data events\n dataLoaded: 'datasource-data-loaded',\n dataChanged: 'datasource-data-changed',\n dataCleared: 'datasource-data-cleared',\n\n // Schema events\n schemaUpdated: 'datasource-schema-updated',\n\n // Status events\n loadingStarted: 'datasource-loading-started',\n loadingFinished: 'datasource-loading-finished',\n noDataAvailable: 'datasource-no-data-available',\n moreDataAvailable: 'datasource-more-data-available',\n\n // Filter events\n filtersRestored: 'datasource-filters-restored',\n\n // Error events\n error: 'datasource-error',\n\n // Destroy datasource events\n destroy: 'datasource-destroy',\n\n // Size events\n sizeChanged: 'datasource-size-changed',\n\n // Server-side specific events\n cacheFilterConfig: 'cache-filter-config',\n refreshServerSide: 'refresh-server-side',\n setServerSideDatasource: 'set-server-side-datasource',\n addGridCssClass: 'add-grid-css-class',\n removeGridCssClass: 'remove-grid-css-class',\n applyServerSideTransaction: 'apply-server-side-transaction',\n}",
16287
- "description": "Event names for datasource-grid communication\nThese represent datasource operations, not grid-specific actions"
16317
+ "default": "'--dropdown-width'",
16318
+ "description": "The CSS variable to use for specifying the dropdown's width"
16319
+ },
16320
+ {
16321
+ "kind": "variable",
16322
+ "name": "optionsClass",
16323
+ "type": {
16324
+ "text": "string"
16325
+ },
16326
+ "default": "'options'",
16327
+ "description": "The CSS class to use for the options element's class in the dropdown"
16328
+ },
16329
+ {
16330
+ "kind": "variable",
16331
+ "name": "DISPLAY_NONE_CLASS",
16332
+ "type": {
16333
+ "text": "string"
16334
+ },
16335
+ "default": "'dnone'",
16336
+ "description": "Class name used to hide elements with display:none"
16337
+ },
16338
+ {
16339
+ "kind": "variable",
16340
+ "name": "multicolumnDropdownStyles",
16341
+ "default": "css`\n label {\n color: var(--neutral-foreground-hint, rgb(135 155 166));\n font-style: normal;\n margin: calc(var(--design-unit) * 2px) 0;\n display: block;\n cursor: pointer;\n font-size: var(--type-ramp-base-font-size);\n line-height: var(--type-ramp-base-line-height);\n }\n\n .${DISPLAY_NONE_CLASS} {\n display: none !important;\n }\n\n .root {\n position: relative;\n width: inherit;\n min-width: 250px;\n ${dropdownWidthVar}: 350px;\n }\n\n .control {\n cursor: pointer;\n position: relative;\n display: flex;\n align-items: center;\n width: 100%;\n border-radius: calc(var(--control-corner-radius) * 1px);\n }\n\n #display-field {\n width: 100%;\n cursor: pointer;\n color: inherit;\n min-height: 40px;\n padding-left: calc(var(--design-unit) * 2.25px);\n padding-right: 52px;\n border-width: 0;\n background: var(--neutral-fill-input-rest);\n border-radius: calc(var(--control-corner-radius) * 1px);\n text-overflow: ellipsis;\n font-size: var(--type-ramp-base-font-size);\n font-family: var(--body-font);\n }\n\n #display-field[disabled] {\n cursor: not-allowed;\n opacity: var(--disabled-opacity);\n }\n\n #display-field:focus {\n outline: 1px solid var(--accent-fill-rest);\n background: var(--neutral-fill-input-rest);\n border-style: none;\n box-shadow: none;\n }\n\n #display-field:hover:not(:focus):not([disabled]) {\n outline: 1px solid var(--neutral-stroke-hover, rgb(231 232 232));\n }\n\n button {\n pointer-events: none;\n }\n\n #arrow-icon {\n display: inline-block;\n width: 16px;\n color: currentColor;\n position: absolute;\n left: calc(100% - 26px);\n padding: 0;\n cursor: pointer;\n transform: rotate(0deg);\n transition: transform 0.2s linear 0s;\n }\n\n #arrow-icon.flipped {\n transform: rotate(180deg);\n }\n\n .cross-icon {\n display: inline-block;\n width: 12px;\n color: currentColor;\n position: absolute;\n left: calc(100% - 46px);\n padding: 0;\n cursor: pointer;\n visibility: hidden;\n }\n\n .cross-icon:hover {\n color: var(--error-color);\n }\n\n .disabled-icon {\n pointer-events: none;\n opacity: var(--disabled-opacity);\n }\n\n .${optionsClass} {\n min-width: 100%;\n width: var(${dropdownWidthVar});\n display: flex;\n flex-direction: column;\n position: absolute;\n height: max-content;\n overflow-y: hidden;\n margin: 5px 0;\n background: var(--neutral-fill-input-rest);\n visibility: hidden;\n z-index: 999;\n }\n\n .dropdown-above {\n bottom: 100%;\n }\n\n .dropdown-left {\n right: 0;\n }\n\n .grid-container {\n height: 300px;\n width: 100%;\n }\n\n #filter-search {\n padding: 5px;\n }\n\n .visible {\n visibility: visible;\n }\n`",
16342
+ "description": "Multicolumn Dropdown styles.",
16343
+ "privacy": "public"
16288
16344
  }
16289
16345
  ],
16290
16346
  "exports": [
16291
16347
  {
16292
16348
  "kind": "js",
16293
- "name": "datasourceEventNames",
16349
+ "name": "dropdownWidthVar",
16294
16350
  "declaration": {
16295
- "name": "datasourceEventNames",
16296
- "module": "src/grid-pro-genesis-datasource/datasource-events.types.ts"
16351
+ "name": "dropdownWidthVar",
16352
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
16353
+ }
16354
+ },
16355
+ {
16356
+ "kind": "js",
16357
+ "name": "optionsClass",
16358
+ "declaration": {
16359
+ "name": "optionsClass",
16360
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
16361
+ }
16362
+ },
16363
+ {
16364
+ "kind": "js",
16365
+ "name": "DISPLAY_NONE_CLASS",
16366
+ "declaration": {
16367
+ "name": "DISPLAY_NONE_CLASS",
16368
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
16369
+ }
16370
+ },
16371
+ {
16372
+ "kind": "js",
16373
+ "name": "multicolumnDropdownStyles",
16374
+ "declaration": {
16375
+ "name": "multicolumnDropdownStyles",
16376
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
16297
16377
  }
16298
16378
  }
16299
16379
  ]
16300
16380
  },
16301
16381
  {
16302
16382
  "kind": "javascript-module",
16303
- "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts",
16383
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts",
16384
+ "declarations": [
16385
+ {
16386
+ "kind": "function",
16387
+ "name": "getMulticolumnDropdownTemplate",
16388
+ "parameters": [
16389
+ {
16390
+ "name": "designSystem",
16391
+ "default": "'foundation'",
16392
+ "description": "The design system prefix to use. Defaults to 'foundation'."
16393
+ }
16394
+ ],
16395
+ "description": "Get a Design System prefixed Multicolumn Dropdown template.",
16396
+ "return": {
16397
+ "type": {
16398
+ "text": ""
16399
+ }
16400
+ },
16401
+ "privacy": "public"
16402
+ },
16403
+ {
16404
+ "kind": "variable",
16405
+ "name": "multicolumnDropdownTemplate",
16406
+ "description": "The default Multicolumn Dropdown template using the 'foundation' design system prefix.",
16407
+ "privacy": "public"
16408
+ }
16409
+ ],
16410
+ "exports": [
16411
+ {
16412
+ "kind": "js",
16413
+ "name": "getMulticolumnDropdownTemplate",
16414
+ "declaration": {
16415
+ "name": "getMulticolumnDropdownTemplate",
16416
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
16417
+ }
16418
+ },
16419
+ {
16420
+ "kind": "js",
16421
+ "name": "multicolumnDropdownTemplate",
16422
+ "declaration": {
16423
+ "name": "multicolumnDropdownTemplate",
16424
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
16425
+ }
16426
+ }
16427
+ ]
16428
+ },
16429
+ {
16430
+ "kind": "javascript-module",
16431
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.ts",
16304
16432
  "declarations": [
16433
+ {
16434
+ "kind": "function",
16435
+ "name": "wasClickOutsideElement",
16436
+ "parameters": [
16437
+ {
16438
+ "name": "event",
16439
+ "type": {
16440
+ "text": "MouseEvent"
16441
+ }
16442
+ },
16443
+ {
16444
+ "name": "target",
16445
+ "type": {
16446
+ "text": "EventTarget"
16447
+ }
16448
+ }
16449
+ ],
16450
+ "description": "Checks if the given mouse event occurred outside the target element.",
16451
+ "privacy": "public"
16452
+ },
16305
16453
  {
16306
16454
  "kind": "class",
16307
- "description": "The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.",
16308
- "name": "GridProGenesisDatasource",
16455
+ "description": "",
16456
+ "name": "MulticolumnDropdown",
16309
16457
  "members": [
16310
16458
  {
16311
16459
  "kind": "field",
16312
- "name": "cachedRowArray",
16460
+ "name": "optionsElement",
16313
16461
  "type": {
16314
- "text": "any[]"
16315
- },
16316
- "privacy": "private",
16317
- "default": "[]"
16462
+ "text": "HTMLElement"
16463
+ }
16318
16464
  },
16319
16465
  {
16320
16466
  "kind": "field",
16321
- "name": "transactionData",
16467
+ "name": "lastRequest",
16322
16468
  "type": {
16323
- "text": "TransactionData"
16469
+ "text": "object"
16324
16470
  },
16325
- "privacy": "protected",
16326
- "default": "{\n add: [],\n remove: [],\n update: [],\n addIndex: 0,\n }",
16327
- "inheritedFrom": {
16328
- "name": "GridProBaseDatasource",
16329
- "module": "src/datasource/base.datasource.ts"
16330
- }
16331
- },
16332
- {
16333
- "kind": "method",
16334
- "name": "criteriaChanged",
16335
- "parameters": [
16336
- {
16337
- "name": "oldCriteria",
16338
- "type": {
16339
- "text": "string"
16340
- }
16341
- },
16342
- {
16343
- "name": "newCriteria",
16344
- "type": {
16345
- "text": "string"
16346
- }
16347
- }
16348
- ]
16349
- },
16350
- {
16351
- "kind": "method",
16352
- "name": "requestChanged",
16353
- "parameters": [
16354
- {
16355
- "name": "oldRequest",
16356
- "type": {
16357
- "text": "string"
16358
- }
16359
- },
16360
- {
16361
- "name": "newRequest",
16362
- "type": {
16363
- "text": "string"
16364
- }
16365
- }
16366
- ]
16367
- },
16368
- {
16369
- "kind": "method",
16370
- "name": "resourceNameChanged",
16371
- "parameters": [
16372
- {
16373
- "name": "oldValue",
16374
- "type": {
16375
- "text": "string"
16376
- }
16377
- },
16378
- {
16379
- "name": "newValue",
16380
- "type": {
16381
- "text": "string"
16382
- }
16383
- }
16384
- ]
16471
+ "privacy": "private"
16385
16472
  },
16386
16473
  {
16387
16474
  "kind": "field",
16388
- "name": "keepColDefsOnClearRowData",
16475
+ "name": "connectOverride",
16389
16476
  "type": {
16390
- "text": "boolean"
16477
+ "text": "Connect"
16391
16478
  },
16392
- "privacy": "public",
16393
- "default": "false",
16394
- "inheritedFrom": {
16395
- "name": "GridProBaseDatasource",
16396
- "module": "src/datasource/base.datasource.ts"
16397
- }
16479
+ "privacy": "private"
16398
16480
  },
16399
16481
  {
16400
16482
  "kind": "field",
16401
- "name": "requestVisibleColumnsOnly",
16483
+ "name": "_connectDI",
16402
16484
  "type": {
16403
- "text": "boolean"
16485
+ "text": "Connect"
16404
16486
  },
16405
- "default": "false",
16406
- "description": "When enabled and column definitions are provided, the datasource requests data only for the\ncolumns that are currently visible. The visible set is seeded from the column config (columns\nnot flagged with `hide`) and updated by the host grid via `setVisibleColumns`; the data\nis reloaded whenever that set changes."
16487
+ "privacy": "private"
16407
16488
  },
16408
16489
  {
16409
16490
  "kind": "field",
16410
- "name": "_visibleColumns",
16491
+ "name": "connect",
16411
16492
  "type": {
16412
- "text": "string[] | undefined"
16493
+ "text": "Connect"
16413
16494
  },
16414
- "privacy": "private"
16495
+ "description": "The connect service - uses DI by default, but can be manually set for dynamic element creation"
16415
16496
  },
16416
16497
  {
16417
16498
  "kind": "field",
16418
- "name": "dataSub",
16499
+ "name": "disabled",
16419
16500
  "type": {
16420
- "text": "Subscription"
16501
+ "text": "boolean"
16421
16502
  },
16422
- "privacy": "private"
16503
+ "privacy": "public",
16504
+ "description": "Whether to disable control of the component"
16423
16505
  },
16424
16506
  {
16425
16507
  "kind": "field",
16426
- "name": "updateSub",
16508
+ "name": "resourceName",
16427
16509
  "type": {
16428
- "text": "Subscription"
16510
+ "text": "string"
16429
16511
  },
16430
- "privacy": "private"
16512
+ "privacy": "public",
16513
+ "description": "The name of the reqrep to get the options from"
16431
16514
  },
16432
16515
  {
16433
16516
  "kind": "field",
16434
- "name": "requiresFullRowDataAndColDefs",
16517
+ "name": "searchKey",
16435
16518
  "type": {
16436
- "text": "boolean"
16519
+ "text": "string | string[] | undefined"
16437
16520
  },
16438
- "privacy": "private",
16439
- "default": "true"
16521
+ "privacy": "public",
16522
+ "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\")."
16440
16523
  },
16441
16524
  {
16442
16525
  "kind": "field",
16443
- "name": "_lastMoreRows",
16526
+ "name": "requestSupportsAdvancedSearch",
16444
16527
  "type": {
16445
16528
  "text": "boolean"
16446
16529
  },
16447
- "privacy": "private",
16448
- "default": "false"
16530
+ "privacy": "public",
16531
+ "default": "false",
16532
+ "description": "Tells whether a given request supports lookup by Groovy Expressions."
16449
16533
  },
16450
16534
  {
16451
16535
  "kind": "field",
16452
- "name": "_isMoreRowsResult",
16536
+ "name": "valueKey",
16453
16537
  "type": {
16454
- "text": "boolean"
16538
+ "text": "string"
16455
16539
  },
16456
- "privacy": "private",
16457
- "default": "false"
16540
+ "privacy": "public",
16541
+ "description": "The key used as the value sent to the server"
16458
16542
  },
16459
16543
  {
16460
16544
  "kind": "field",
16461
- "name": "_sourceRef",
16545
+ "name": "labelKey",
16462
16546
  "type": {
16463
16547
  "text": "string"
16464
16548
  },
16465
- "privacy": "private"
16549
+ "privacy": "public",
16550
+ "description": "The key used as the label displayed in the UI"
16466
16551
  },
16467
16552
  {
16468
16553
  "kind": "field",
16469
- "name": "_nextOffset",
16554
+ "name": "dropdownPlacement",
16470
16555
  "type": {
16471
- "text": "number"
16556
+ "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
16472
16557
  },
16473
- "privacy": "private",
16474
- "default": "0"
16558
+ "description": "Position of the dropdown panel relative to the control.\n- `'bottom-right'` – default; opens below and aligns to the right edge of the control\n- `'bottom-left'` – opens below and extends to the left\n- `'top-right'` – opens above and aligns to the right edge of the control\n- `'top-left'` – opens above and extends to the left"
16475
16559
  },
16476
16560
  {
16477
16561
  "kind": "field",
16478
- "name": "_loadMoreCount",
16562
+ "name": "dropdownWidth",
16479
16563
  "type": {
16480
16564
  "text": "number"
16481
16565
  },
16482
- "privacy": "private",
16483
- "default": "0"
16566
+ "privacy": "public",
16567
+ "description": "Optionally specifies the width of the dropdown"
16484
16568
  },
16485
16569
  {
16486
- "kind": "method",
16487
- "name": "deepClone",
16488
- "return": {
16489
- "type": {
16490
- "text": "Node"
16491
- }
16570
+ "kind": "field",
16571
+ "name": "request",
16572
+ "type": {
16573
+ "text": "object"
16492
16574
  },
16493
- "inheritedFrom": {
16494
- "name": "LifecycleMixin",
16495
- "module": "src/mixins/lifecycle/lifecycle.ts"
16496
- }
16575
+ "privacy": "public",
16576
+ "description": "A request object to pass in the reqrep"
16497
16577
  },
16498
16578
  {
16499
- "kind": "method",
16500
- "name": "colDefsDeepClone",
16501
- "privacy": "private",
16502
- "return": {
16503
- "type": {
16504
- "text": "ColDef[]"
16505
- }
16579
+ "kind": "field",
16580
+ "name": "columnDefinitions",
16581
+ "type": {
16582
+ "text": "ColDef[]"
16506
16583
  },
16507
- "parameters": [
16508
- {
16509
- "name": "key",
16510
- "type": {
16511
- "text": "string"
16512
- }
16513
- },
16514
- {
16515
- "name": "copy",
16516
- "type": {
16517
- "text": "any"
16518
- }
16519
- }
16520
- ]
16584
+ "privacy": "public",
16585
+ "description": "An array of AG Grid column definitions to use in the grid to display the data"
16521
16586
  },
16522
16587
  {
16523
- "kind": "method",
16524
- "name": "init",
16525
- "parameters": [
16526
- {
16527
- "name": "keepColDefsOnClearRowData",
16528
- "optional": true,
16529
- "type": {
16530
- "text": "boolean"
16531
- }
16532
- },
16533
- {
16534
- "description": "Optionally set the `gridOptions` up with column definitions",
16535
- "name": "columnDefinitions"
16536
- },
16537
- {
16538
- "description": "Optionally set the grid up with column state",
16539
- "name": "columnStates"
16540
- }
16541
- ],
16542
- "description": "Initializes the datasource.",
16543
- "privacy": "public"
16588
+ "kind": "field",
16589
+ "name": "baseCriteria",
16590
+ "type": {
16591
+ "text": "string | undefined"
16592
+ },
16593
+ "privacy": "public",
16594
+ "description": "Base criteria that is always applied to requests combined with search criteria via AND.\nUse this to pre-filter results."
16544
16595
  },
16545
16596
  {
16546
- "kind": "method",
16547
- "name": "destroy",
16548
- "description": "Destroys the datasource, resetting it to its initial state.",
16597
+ "kind": "field",
16598
+ "name": "defaultSlottedNodes",
16599
+ "type": {
16600
+ "text": "Node[]"
16601
+ },
16549
16602
  "privacy": "public",
16550
- "inheritedFrom": {
16551
- "name": "GridProBaseDatasource",
16552
- "module": "src/datasource/base.datasource.ts"
16553
- }
16603
+ "default": "[]"
16554
16604
  },
16555
16605
  {
16556
- "kind": "method",
16557
- "name": "deinit",
16558
- "description": "Deinitialises the datasource, resetting it to its initial state.",
16559
- "deprecated": "Use `destroy` instead",
16606
+ "kind": "field",
16607
+ "name": "grid",
16608
+ "type": {
16609
+ "text": "GridPro"
16610
+ },
16560
16611
  "privacy": "public"
16561
16612
  },
16562
16613
  {
16563
- "kind": "method",
16564
- "name": "reset",
16565
- "description": "Resets the datasource to its initial state.",
16566
- "privacy": "public",
16567
- "deprecated": "Use `destroy` instead"
16614
+ "kind": "field",
16615
+ "name": "_value",
16616
+ "type": {
16617
+ "text": "string"
16618
+ },
16619
+ "privacy": "private"
16568
16620
  },
16569
16621
  {
16570
- "kind": "method",
16571
- "name": "restart",
16572
- "description": "Restarts the datasource, uses `destroy` and `init` in sequence.",
16573
- "privacy": "public",
16574
- "inheritedFrom": {
16575
- "name": "GridProBaseDatasource",
16576
- "module": "src/datasource/base.datasource.ts"
16622
+ "kind": "field",
16623
+ "name": "value",
16624
+ "type": {
16625
+ "text": "string"
16577
16626
  }
16578
16627
  },
16579
16628
  {
16580
- "kind": "method",
16581
- "name": "refreshRows",
16582
- "description": "Force the grid to redispatch the current rows"
16629
+ "kind": "field",
16630
+ "name": "filterSearch",
16631
+ "type": {
16632
+ "text": "string"
16633
+ },
16634
+ "privacy": "public",
16635
+ "description": "The criteria to search by"
16583
16636
  },
16584
16637
  {
16585
- "kind": "method",
16586
- "name": "reloadResourceData",
16638
+ "kind": "field",
16639
+ "name": "open",
16640
+ "type": {
16641
+ "text": "boolean"
16642
+ },
16587
16643
  "privacy": "public",
16588
- "return": {
16589
- "type": {
16590
- "text": "Promise<void>"
16591
- }
16644
+ "description": "Whether the dropdown is open or not"
16645
+ },
16646
+ {
16647
+ "kind": "field",
16648
+ "name": "selectedRow",
16649
+ "type": {
16650
+ "text": "object"
16592
16651
  },
16593
- "description": "Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.\nLoads resource data without full initialization (no metadata fetch).",
16594
- "inheritedFrom": {
16595
- "name": "GridProBaseDatasource",
16596
- "module": "src/datasource/base.datasource.ts"
16597
- }
16652
+ "description": "Data for the selected row"
16653
+ },
16654
+ {
16655
+ "kind": "field",
16656
+ "name": "displayValue",
16657
+ "description": "Value to display in the form field",
16658
+ "readonly": true
16659
+ },
16660
+ {
16661
+ "kind": "field",
16662
+ "name": "hasSearchKey",
16663
+ "type": {
16664
+ "text": "boolean"
16665
+ },
16666
+ "readonly": true
16667
+ },
16668
+ {
16669
+ "kind": "field",
16670
+ "name": "hasSlottedContent",
16671
+ "type": {
16672
+ "text": "boolean"
16673
+ },
16674
+ "readonly": true
16598
16675
  },
16599
16676
  {
16600
16677
  "kind": "method",
16601
- "name": "handleSnapshot",
16678
+ "name": "setGridRowData",
16602
16679
  "privacy": "private",
16603
16680
  "parameters": [
16604
16681
  {
16605
- "name": "result"
16682
+ "name": "rows",
16683
+ "type": {
16684
+ "text": "any[]"
16685
+ }
16606
16686
  }
16607
- ]
16687
+ ],
16688
+ "description": "Sets row data on the grid in a version-safe way.\nAG Grid v32+ removed `setRowData` in favour of `updateGridOptions`."
16608
16689
  },
16609
16690
  {
16610
16691
  "kind": "method",
16611
- "name": "handleStreamResult",
16692
+ "name": "setGridColumnDefs",
16612
16693
  "privacy": "private",
16613
16694
  "parameters": [
16614
16695
  {
16615
- "name": "result",
16696
+ "name": "colDefs",
16616
16697
  "type": {
16617
- "text": "FilteredDataServerResult | RequestServerResult"
16698
+ "text": "ColDef[]"
16618
16699
  }
16619
16700
  }
16620
- ]
16701
+ ],
16702
+ "description": "Sets column defs on the grid in a version-safe way.\nAG Grid v32+ removed `setColumnDefs` in favour of `updateGridOptions`."
16621
16703
  },
16622
16704
  {
16623
16705
  "kind": "method",
16624
- "name": "updateLoadMoreStatus",
16706
+ "name": "emitValue",
16625
16707
  "privacy": "private",
16626
16708
  "parameters": [
16627
16709
  {
16628
- "name": "moreRows",
16629
- "type": {
16630
- "text": "boolean"
16631
- },
16632
- "description": "Whether more rows are available"
16633
- },
16634
- {
16635
- "name": "sourceRef",
16710
+ "name": "value",
16636
16711
  "type": {
16637
16712
  "text": "string"
16638
- },
16639
- "description": "The source reference"
16640
- },
16641
- {
16642
- "description": "The total number of rows",
16643
- "name": "rowsCount"
16713
+ }
16644
16714
  }
16645
16715
  ],
16646
- "description": "Updates the status bar based on more rows status"
16716
+ "description": "Emits 'change' and 'input' events so that the `sync` directive and forms work correctly."
16647
16717
  },
16648
16718
  {
16649
16719
  "kind": "method",
16650
- "name": "applyRequestServerData",
16651
- "privacy": "private",
16652
- "parameters": [
16653
- {
16654
- "name": "requestServerResult",
16655
- "type": {
16656
- "text": "RequestServerResult"
16657
- }
16658
- }
16659
- ]
16720
+ "name": "toggle",
16721
+ "privacy": "public"
16660
16722
  },
16661
16723
  {
16662
16724
  "kind": "method",
16663
- "name": "applyDataserverData",
16664
- "privacy": "private",
16665
- "parameters": [
16666
- {
16667
- "name": "dataServerResult",
16668
- "type": {
16669
- "text": "FilteredDataServerResult"
16670
- }
16671
- }
16672
- ]
16725
+ "name": "getAndSetRows",
16726
+ "privacy": "private"
16673
16727
  },
16674
16728
  {
16675
- "kind": "method",
16676
- "name": "getAgColumnDefs",
16677
- "privacy": "private",
16678
- "parameters": [
16679
- {
16680
- "name": "fieldsMetadata",
16681
- "type": {
16682
- "text": "FieldMetadata[]"
16683
- }
16684
- }
16685
- ]
16729
+ "kind": "field",
16730
+ "name": "getAndSetRowsDebounce",
16731
+ "privacy": "private"
16686
16732
  },
16687
16733
  {
16688
16734
  "kind": "method",
16689
- "name": "setFilter",
16690
- "privacy": "public",
16691
- "parameters": [
16692
- {
16693
- "name": "fieldName",
16694
- "type": {
16695
- "text": "string"
16696
- }
16697
- },
16698
- {
16699
- "name": "newFilter",
16700
- "type": {
16701
- "text": "string"
16702
- }
16703
- }
16704
- ],
16705
- "inheritedFrom": {
16706
- "name": "GenesisGridDatasourceElement",
16707
- "module": "src/datasource/base.datasource.ts"
16708
- }
16735
+ "name": "filterSearchChanged",
16736
+ "privacy": "public"
16709
16737
  },
16710
16738
  {
16711
16739
  "kind": "method",
16712
- "name": "removeFilter",
16713
- "privacy": "public",
16714
- "parameters": [
16715
- {
16716
- "name": "fieldName",
16717
- "type": {
16718
- "text": "string"
16719
- }
16720
- }
16721
- ],
16722
- "inheritedFrom": {
16723
- "name": "GenesisGridDatasourceElement",
16724
- "module": "src/datasource/base.datasource.ts"
16725
- }
16740
+ "name": "requestChanged",
16741
+ "privacy": "public"
16726
16742
  },
16727
16743
  {
16728
16744
  "kind": "method",
16729
- "name": "applyTransaction",
16730
- "privacy": "protected",
16731
- "return": {
16732
- "type": {
16733
- "text": "any"
16734
- }
16735
- },
16736
- "parameters": [
16737
- {
16738
- "name": "transaction",
16739
- "type": {
16740
- "text": "any"
16741
- }
16742
- }
16743
- ],
16744
- "inheritedFrom": {
16745
- "name": "GridProBaseDatasource",
16746
- "module": "src/datasource/base.datasource.ts"
16747
- }
16745
+ "name": "columnDefinitionsChanged",
16746
+ "privacy": "public"
16748
16747
  },
16749
16748
  {
16750
- "kind": "method",
16751
- "name": "handleSizeChanged",
16752
- "privacy": "private",
16753
- "parameters": [
16754
- {
16755
- "name": "oldSize",
16756
- "type": {
16757
- "text": "number"
16758
- }
16759
- },
16760
- {
16761
- "name": "newSize",
16762
- "type": {
16763
- "text": "number"
16764
- }
16765
- }
16766
- ]
16749
+ "kind": "field",
16750
+ "name": "handleClickOutside",
16751
+ "privacy": "private"
16767
16752
  },
16768
16753
  {
16769
16754
  "kind": "method",
16770
- "name": "handleStreamInserts",
16771
- "privacy": "protected",
16772
- "parameters": [
16773
- {
16774
- "name": "inserts",
16775
- "default": "[]"
16776
- }
16777
- ],
16778
- "inheritedFrom": {
16779
- "name": "GridProBaseDatasource",
16780
- "module": "src/datasource/base.datasource.ts"
16781
- }
16755
+ "name": "openChanged",
16756
+ "privacy": "public"
16782
16757
  },
16783
16758
  {
16784
16759
  "kind": "method",
16785
- "name": "handleStreamUpdates",
16786
- "privacy": "protected",
16787
- "parameters": [
16788
- {
16789
- "name": "updates",
16790
- "default": "[]"
16791
- }
16792
- ],
16793
- "inheritedFrom": {
16794
- "name": "GridProBaseDatasource",
16795
- "module": "src/datasource/base.datasource.ts"
16796
- }
16760
+ "name": "dropdownWidthChanged",
16761
+ "privacy": "public"
16797
16762
  },
16798
16763
  {
16799
16764
  "kind": "method",
16800
- "name": "handleStreamDeletes",
16801
- "privacy": "protected",
16765
+ "name": "changeHandler",
16766
+ "privacy": "public",
16802
16767
  "parameters": [
16803
16768
  {
16804
- "name": "deletes",
16805
- "default": "[]",
16806
- "description": "List of records to remove from the grid stream"
16769
+ "name": "event",
16770
+ "type": {
16771
+ "text": "Event"
16772
+ }
16807
16773
  }
16808
- ],
16809
- "description": "Handles stream deletes by removing records from the grid.",
16810
- "inheritedFrom": {
16811
- "name": "GridProBaseDatasource",
16812
- "module": "src/datasource/base.datasource.ts"
16813
- }
16774
+ ]
16814
16775
  },
16815
16776
  {
16816
16777
  "kind": "method",
16817
- "name": "setVisibleColumns",
16778
+ "name": "cloneNode",
16818
16779
  "return": {
16819
16780
  "type": {
16820
- "text": "void"
16781
+ "text": "Node"
16821
16782
  }
16822
16783
  },
16823
16784
  "parameters": [
16824
16785
  {
16825
- "name": "visibleFields",
16786
+ "name": "deep",
16787
+ "optional": true,
16826
16788
  "type": {
16827
- "text": "string[]"
16828
- },
16829
- "description": "Field names of the currently visible columns."
16789
+ "text": "boolean"
16790
+ }
16830
16791
  }
16831
16792
  ],
16832
- "description": "Updates the set of visible columns and reloads the data when the set changes.",
16833
- "privacy": "public",
16834
- "inheritedFrom": {
16835
- "name": "GridProBaseDatasource",
16836
- "module": "src/datasource/base.datasource.ts"
16837
- }
16838
- },
16839
- {
16840
- "kind": "method",
16841
- "name": "loadMore",
16842
16793
  "inheritedFrom": {
16843
- "name": "GridProBaseDatasource",
16844
- "module": "src/datasource/base.datasource.ts"
16794
+ "name": "LifecycleMixin",
16795
+ "module": "src/mixins/lifecycle/lifecycle.ts"
16845
16796
  }
16846
16797
  },
16847
16798
  {
16848
16799
  "kind": "method",
16849
- "name": "cloneNode",
16800
+ "name": "deepClone",
16850
16801
  "return": {
16851
16802
  "type": {
16852
16803
  "text": "Node"
16853
16804
  }
16854
16805
  },
16855
- "parameters": [
16856
- {
16857
- "name": "deep",
16858
- "optional": true,
16859
- "type": {
16860
- "text": "boolean"
16861
- }
16862
- }
16863
- ],
16864
16806
  "inheritedFrom": {
16865
16807
  "name": "LifecycleMixin",
16866
16808
  "module": "src/mixins/lifecycle/lifecycle.ts"
@@ -16917,1906 +16859,1933 @@
16917
16859
  },
16918
16860
  {
16919
16861
  "kind": "field",
16920
- "name": "dataSubWasLoggedOff",
16862
+ "name": "_presentation",
16921
16863
  "type": {
16922
- "text": "boolean"
16864
+ "text": "ComponentPresentation | null | undefined"
16923
16865
  },
16924
- "privacy": "protected",
16925
- "default": "false",
16866
+ "privacy": "private",
16867
+ "default": "void 0",
16926
16868
  "inheritedFrom": {
16927
- "name": "GridProBaseDatasource",
16928
- "module": "src/datasource/base.datasource.ts"
16869
+ "name": "FoundationElement",
16870
+ "module": "src/foundation-element/foundation-element.ts"
16929
16871
  }
16930
16872
  },
16931
16873
  {
16932
16874
  "kind": "field",
16933
- "name": "rowData",
16875
+ "name": "$presentation",
16934
16876
  "type": {
16935
- "text": "Map<string, any>"
16877
+ "text": "ComponentPresentation | null"
16936
16878
  },
16937
- "default": "new Map()",
16879
+ "privacy": "public",
16880
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
16938
16881
  "inheritedFrom": {
16939
- "name": "GridProBaseDatasource",
16940
- "module": "src/datasource/base.datasource.ts"
16882
+ "name": "FoundationElement",
16883
+ "module": "src/foundation-element/foundation-element.ts"
16941
16884
  }
16942
16885
  },
16943
16886
  {
16944
16887
  "kind": "field",
16945
- "name": "connectionSub",
16888
+ "name": "template",
16946
16889
  "type": {
16947
- "text": "Subscription | undefined"
16890
+ "text": "ElementViewTemplate | void | null"
16948
16891
  },
16949
- "privacy": "protected",
16892
+ "privacy": "public",
16893
+ "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
16950
16894
  "inheritedFrom": {
16951
- "name": "GridProBaseDatasource",
16952
- "module": "src/datasource/base.datasource.ts"
16895
+ "name": "FoundationElement",
16896
+ "module": "src/foundation-element/foundation-element.ts"
16953
16897
  }
16954
16898
  },
16955
16899
  {
16956
16900
  "kind": "method",
16957
- "name": "subscribeToConnection",
16901
+ "name": "templateChanged",
16958
16902
  "privacy": "protected",
16959
- "inheritedFrom": {
16960
- "name": "GridProBaseDatasource",
16961
- "module": "src/datasource/base.datasource.ts"
16962
- }
16963
- },
16964
- {
16965
- "kind": "method",
16966
- "name": "unsubscribeFromConnection",
16967
- "privacy": "protected",
16968
- "inheritedFrom": {
16969
- "name": "GridProBaseDatasource",
16970
- "module": "src/datasource/base.datasource.ts"
16971
- }
16972
- },
16973
- {
16974
- "kind": "method",
16975
- "name": "generateColumnDefsFromMetadata",
16976
- "privacy": "protected",
16977
- "return": {
16978
- "type": {
16979
- "text": "ColDef[]"
16980
- }
16981
- },
16982
- "parameters": [
16983
- {
16984
- "name": "fieldsMetadata",
16985
- "type": {
16986
- "text": "FieldMetadata[]"
16987
- }
16988
- },
16989
- {
16990
- "name": "getFilterParamsByFieldType",
16991
- "type": {
16992
- "text": "(field: FieldMetadata) => ColDef['filterParams'] | any"
16993
- }
16994
- },
16995
- {
16996
- "name": "getFilterByFieldType",
16997
- "type": {
16998
- "text": "(type: FieldTypeEnum) => string"
16999
- }
17000
- }
17001
- ],
17002
- "inheritedFrom": {
17003
- "name": "GridProBaseDatasource",
17004
- "module": "src/datasource/base.datasource.ts"
17005
- }
17006
- },
17007
- {
17008
- "kind": "method",
17009
- "name": "applyAllTransactions",
17010
- "privacy": "protected",
17011
- "inheritedFrom": {
17012
- "name": "GridProBaseDatasource",
17013
- "module": "src/datasource/base.datasource.ts"
17014
- }
17015
- },
17016
- {
17017
- "kind": "method",
17018
- "name": "applyMappedTransaction",
17019
- "privacy": "private",
17020
- "parameters": [
17021
- {
17022
- "name": "transaction",
17023
- "type": {
17024
- "text": "TransactionData"
17025
- }
17026
- },
17027
- {
17028
- "name": "operation",
17029
- "type": {
17030
- "text": "OperationType"
17031
- }
17032
- }
17033
- ],
17034
- "inheritedFrom": {
17035
- "name": "GridProBaseDatasource",
17036
- "module": "src/datasource/base.datasource.ts"
17037
- }
17038
- },
17039
- {
17040
- "kind": "method",
17041
- "name": "mapTransaction",
17042
- "privacy": "private",
17043
- "parameters": [
17044
- {
17045
- "name": "transaction",
17046
- "type": {
17047
- "text": "TransactionData"
17048
- },
17049
- "description": "The transaction data to be mapped."
17050
- },
17051
- {
17052
- "name": "operations",
17053
- "default": "Object.values(OperationType)",
17054
- "type": {
17055
- "text": "OperationType[]"
17056
- },
17057
- "description": "The operations to be mapped. Can be 'add', 'update' or 'remove'."
17058
- }
17059
- ],
17060
- "description": "Maps the transaction data to the row data mapper function, if it exists.",
17061
16903
  "return": {
17062
16904
  "type": {
17063
- "text": ""
16905
+ "text": "void"
17064
16906
  }
17065
16907
  },
17066
16908
  "inheritedFrom": {
17067
- "name": "GridProBaseDatasource",
17068
- "module": "src/datasource/base.datasource.ts"
16909
+ "name": "FoundationElement",
16910
+ "module": "src/foundation-element/foundation-element.ts"
17069
16911
  }
17070
16912
  },
17071
16913
  {
17072
16914
  "kind": "field",
17073
- "name": "_isDisconnected",
16915
+ "name": "styles",
17074
16916
  "type": {
17075
- "text": "boolean"
16917
+ "text": "ElementStyles | void | null"
17076
16918
  },
17077
- "privacy": "private",
17078
- "default": "false",
17079
- "inheritedFrom": {
17080
- "name": "GridProBaseDatasource",
17081
- "module": "src/datasource/base.datasource.ts"
17082
- }
17083
- },
17084
- {
17085
- "kind": "method",
17086
- "name": "setDisconnected",
17087
16919
  "privacy": "public",
17088
- "parameters": [
17089
- {
17090
- "name": "disconnected",
17091
- "type": {
17092
- "text": "boolean"
17093
- },
17094
- "description": "true to set, false to remove"
17095
- }
17096
- ],
17097
- "description": "Sets the disconnected state and emits appropriate events.",
16920
+ "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
17098
16921
  "inheritedFrom": {
17099
- "name": "GridProBaseDatasource",
17100
- "module": "src/datasource/base.datasource.ts"
16922
+ "name": "FoundationElement",
16923
+ "module": "src/foundation-element/foundation-element.ts"
17101
16924
  }
17102
16925
  },
17103
16926
  {
17104
16927
  "kind": "method",
17105
- "name": "isDisconnected",
17106
- "privacy": "public",
16928
+ "name": "stylesChanged",
16929
+ "privacy": "protected",
17107
16930
  "return": {
17108
16931
  "type": {
17109
- "text": "boolean"
16932
+ "text": "void"
17110
16933
  }
17111
16934
  },
17112
- "description": "Returns true if the datasource is disconnected.",
17113
16935
  "inheritedFrom": {
17114
- "name": "GridProBaseDatasource",
17115
- "module": "src/datasource/base.datasource.ts"
16936
+ "name": "FoundationElement",
16937
+ "module": "src/foundation-element/foundation-element.ts"
17116
16938
  }
17117
16939
  },
17118
16940
  {
17119
16941
  "kind": "method",
17120
- "name": "getDatasourceStatusBarPanels",
16942
+ "name": "compose",
17121
16943
  "privacy": "public",
16944
+ "static": true,
17122
16945
  "return": {
17123
16946
  "type": {
17124
- "text": "any[]"
16947
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
17125
16948
  }
17126
16949
  },
17127
16950
  "parameters": [
17128
16951
  {
17129
- "name": "isServerSide",
16952
+ "name": "this",
17130
16953
  "type": {
17131
- "text": "boolean"
16954
+ "text": "K"
17132
16955
  }
17133
16956
  },
17134
16957
  {
17135
- "name": "statusBarConfig",
16958
+ "name": "elementDefinition",
17136
16959
  "type": {
17137
- "text": "any"
17138
- }
16960
+ "text": "T"
16961
+ },
16962
+ "description": "The definition of the element to create the registry\nfunction for."
17139
16963
  }
17140
16964
  ],
17141
- "description": "Gets datasource-specific status bar component configurations.\nThis method should be called by the grid to get status bar panels specific to this datasource.",
16965
+ "description": "Defines an element registry function with a set of element definition defaults.",
17142
16966
  "inheritedFrom": {
17143
- "name": "GridProBaseDatasource",
17144
- "module": "src/datasource/base.datasource.ts"
16967
+ "name": "FoundationElement",
16968
+ "module": "src/foundation-element/foundation-element.ts"
17145
16969
  }
16970
+ }
16971
+ ],
16972
+ "events": [
16973
+ {
16974
+ "description": "Fired when the selected value changes. detail: `string`",
16975
+ "name": "change"
17146
16976
  },
17147
16977
  {
17148
- "kind": "field",
17149
- "name": "connect",
16978
+ "description": "Fired when the value is updated (including programmatic changes). detail: `string`",
16979
+ "name": "input"
16980
+ }
16981
+ ],
16982
+ "attributes": [
16983
+ {
17150
16984
  "type": {
17151
- "text": "Connect"
16985
+ "text": "boolean"
17152
16986
  },
17153
- "inheritedFrom": {
17154
- "name": "GenesisGridDatasourceElement",
17155
- "module": "src/datasource/base.datasource.ts"
17156
- }
16987
+ "description": "Whether to disable control of the component",
16988
+ "fieldName": "disabled"
17157
16989
  },
17158
16990
  {
17159
- "kind": "field",
17160
- "name": "datasource",
16991
+ "name": "resource-name",
17161
16992
  "type": {
17162
- "text": "Datasource"
16993
+ "text": "string"
17163
16994
  },
17164
- "inheritedFrom": {
17165
- "name": "GenesisGridDatasourceElement",
17166
- "module": "src/datasource/base.datasource.ts"
17167
- }
16995
+ "description": "The name of the reqrep to get the options from",
16996
+ "fieldName": "resourceName"
17168
16997
  },
17169
16998
  {
17170
- "kind": "field",
17171
- "name": "deferredGridOptions",
16999
+ "name": "search-key",
17172
17000
  "type": {
17173
- "text": "GridOptions"
17001
+ "text": "string | string[] | undefined"
17174
17002
  },
17175
- "inheritedFrom": {
17176
- "name": "GenesisGridDatasourceElement",
17177
- "module": "src/datasource/base.datasource.ts"
17178
- }
17003
+ "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\").",
17004
+ "fieldName": "searchKey"
17179
17005
  },
17180
17006
  {
17181
- "kind": "field",
17182
- "name": "deferredColumnStates",
17007
+ "name": "advanced-search-req",
17183
17008
  "type": {
17184
- "text": "ColumnState[]"
17009
+ "text": "boolean"
17185
17010
  },
17186
- "inheritedFrom": {
17187
- "name": "GenesisGridDatasourceElement",
17188
- "module": "src/datasource/base.datasource.ts"
17189
- }
17011
+ "default": "false",
17012
+ "description": "Tells whether a given request supports lookup by Groovy Expressions.",
17013
+ "fieldName": "requestSupportsAdvancedSearch"
17190
17014
  },
17191
17015
  {
17192
- "kind": "field",
17193
- "name": "rowDataMapper",
17016
+ "name": "value-key",
17194
17017
  "type": {
17195
- "text": "Function"
17018
+ "text": "string"
17196
17019
  },
17197
- "description": "Allows grid data updates to be processed via and external function before applying in grid",
17198
- "inheritedFrom": {
17199
- "name": "GenesisGridDatasourceElement",
17200
- "module": "src/datasource/base.datasource.ts"
17201
- }
17020
+ "description": "The key used as the value sent to the server",
17021
+ "fieldName": "valueKey"
17202
17022
  },
17203
17023
  {
17204
- "kind": "field",
17205
- "name": "criteria",
17024
+ "name": "label-key",
17206
17025
  "type": {
17207
17026
  "text": "string"
17208
17027
  },
17209
- "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
17210
- "inheritedFrom": {
17211
- "name": "GenesisGridDatasourceElement",
17212
- "module": "src/datasource/base.datasource.ts"
17213
- }
17028
+ "description": "The key used as the label displayed in the UI",
17029
+ "fieldName": "labelKey"
17214
17030
  },
17215
17031
  {
17216
- "kind": "field",
17217
- "name": "isSnapshot",
17032
+ "name": "dropdown-placement",
17218
17033
  "type": {
17219
- "text": "boolean"
17034
+ "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
17220
17035
  },
17221
- "default": "false",
17222
- "description": "Request a snapshot from the server.",
17223
- "inheritedFrom": {
17224
- "name": "GenesisGridDatasourceElement",
17225
- "module": "src/datasource/base.datasource.ts"
17226
- }
17036
+ "description": "Position of the dropdown panel relative to the control.\n- `'bottom-right'` – default; opens below and aligns to the right edge of the control\n- `'bottom-left'` – opens below and extends to the left\n- `'top-right'` – opens above and aligns to the right edge of the control\n- `'top-left'` – opens above and extends to the left",
17037
+ "fieldName": "dropdownPlacement"
17227
17038
  },
17228
17039
  {
17229
- "kind": "field",
17230
- "name": "maxRows",
17040
+ "name": "dropdownWidth",
17231
17041
  "type": {
17232
17042
  "text": "number"
17233
17043
  },
17234
- "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
17235
- "inheritedFrom": {
17236
- "name": "GenesisGridDatasourceElement",
17237
- "module": "src/datasource/base.datasource.ts"
17238
- }
17239
- },
17044
+ "description": "Optionally specifies the width of the dropdown",
17045
+ "fieldName": "dropdownWidth"
17046
+ }
17047
+ ],
17048
+ "mixins": [
17049
+ {
17050
+ "name": "LifecycleMixin",
17051
+ "package": "@genesislcap/foundation-utils"
17052
+ }
17053
+ ],
17054
+ "superclass": {
17055
+ "name": "FoundationElement",
17056
+ "package": "@microsoft/fast-foundation"
17057
+ },
17058
+ "tagName": "%%prefix%%-multicolumn-dropdown",
17059
+ "customElement": true
17060
+ },
17061
+ {
17062
+ "kind": "variable",
17063
+ "name": "foundationMulticolumnDropdown",
17064
+ "description": "A function that returns a Multicolumn Dropdown registration for configuring the component with a DesignSystem.",
17065
+ "privacy": "public"
17066
+ }
17067
+ ],
17068
+ "exports": [
17069
+ {
17070
+ "kind": "js",
17071
+ "name": "wasClickOutsideElement",
17072
+ "declaration": {
17073
+ "name": "wasClickOutsideElement",
17074
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
17075
+ }
17076
+ },
17077
+ {
17078
+ "kind": "js",
17079
+ "name": "MulticolumnDropdown",
17080
+ "declaration": {
17081
+ "name": "MulticolumnDropdown",
17082
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
17083
+ }
17084
+ },
17085
+ {
17086
+ "kind": "js",
17087
+ "name": "foundationMulticolumnDropdown",
17088
+ "declaration": {
17089
+ "name": "foundationMulticolumnDropdown",
17090
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
17091
+ }
17092
+ }
17093
+ ]
17094
+ },
17095
+ {
17096
+ "kind": "javascript-module",
17097
+ "path": "src/grid-pro-genesis-datasource/datasource-events.types.ts",
17098
+ "declarations": [
17099
+ {
17100
+ "kind": "variable",
17101
+ "name": "datasourceEventNames",
17102
+ "type": {
17103
+ "text": "{\n // Initialization events\n initialize: 'datasource-initialize',\n ready: 'datasource-ready',\n\n // Data events\n dataLoaded: 'datasource-data-loaded',\n dataChanged: 'datasource-data-changed',\n dataCleared: 'datasource-data-cleared',\n\n // Schema events\n schemaUpdated: 'datasource-schema-updated',\n\n // Status events\n loadingStarted: 'datasource-loading-started',\n loadingFinished: 'datasource-loading-finished',\n noDataAvailable: 'datasource-no-data-available',\n moreDataAvailable: 'datasource-more-data-available',\n\n // Filter events\n filtersRestored: 'datasource-filters-restored',\n\n // Error events\n error: 'datasource-error',\n\n // Destroy datasource events\n destroy: 'datasource-destroy',\n\n // Size events\n sizeChanged: 'datasource-size-changed',\n\n // Server-side specific events\n cacheFilterConfig: 'cache-filter-config',\n refreshServerSide: 'refresh-server-side',\n setServerSideDatasource: 'set-server-side-datasource',\n addGridCssClass: 'add-grid-css-class',\n removeGridCssClass: 'remove-grid-css-class',\n applyServerSideTransaction: 'apply-server-side-transaction',\n}"
17104
+ },
17105
+ "default": "{\n // Initialization events\n initialize: 'datasource-initialize',\n ready: 'datasource-ready',\n\n // Data events\n dataLoaded: 'datasource-data-loaded',\n dataChanged: 'datasource-data-changed',\n dataCleared: 'datasource-data-cleared',\n\n // Schema events\n schemaUpdated: 'datasource-schema-updated',\n\n // Status events\n loadingStarted: 'datasource-loading-started',\n loadingFinished: 'datasource-loading-finished',\n noDataAvailable: 'datasource-no-data-available',\n moreDataAvailable: 'datasource-more-data-available',\n\n // Filter events\n filtersRestored: 'datasource-filters-restored',\n\n // Error events\n error: 'datasource-error',\n\n // Destroy datasource events\n destroy: 'datasource-destroy',\n\n // Size events\n sizeChanged: 'datasource-size-changed',\n\n // Server-side specific events\n cacheFilterConfig: 'cache-filter-config',\n refreshServerSide: 'refresh-server-side',\n setServerSideDatasource: 'set-server-side-datasource',\n addGridCssClass: 'add-grid-css-class',\n removeGridCssClass: 'remove-grid-css-class',\n applyServerSideTransaction: 'apply-server-side-transaction',\n}",
17106
+ "description": "Event names for datasource-grid communication\nThese represent datasource operations, not grid-specific actions"
17107
+ }
17108
+ ],
17109
+ "exports": [
17110
+ {
17111
+ "kind": "js",
17112
+ "name": "datasourceEventNames",
17113
+ "declaration": {
17114
+ "name": "datasourceEventNames",
17115
+ "module": "src/grid-pro-genesis-datasource/datasource-events.types.ts"
17116
+ }
17117
+ }
17118
+ ]
17119
+ },
17120
+ {
17121
+ "kind": "javascript-module",
17122
+ "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts",
17123
+ "declarations": [
17124
+ {
17125
+ "kind": "class",
17126
+ "description": "The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.",
17127
+ "name": "GridProGenesisDatasource",
17128
+ "members": [
17240
17129
  {
17241
17130
  "kind": "field",
17242
- "name": "orderBy",
17131
+ "name": "cachedRowArray",
17243
17132
  "type": {
17244
- "text": "string"
17133
+ "text": "any[]"
17245
17134
  },
17246
- "description": "Option to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way.",
17247
- "inheritedFrom": {
17248
- "name": "GenesisGridDatasourceElement",
17249
- "module": "src/datasource/base.datasource.ts"
17250
- }
17135
+ "privacy": "private",
17136
+ "default": "[]"
17251
17137
  },
17252
17138
  {
17253
17139
  "kind": "field",
17254
- "name": "resourceName",
17140
+ "name": "transactionData",
17255
17141
  "type": {
17256
- "text": "string"
17142
+ "text": "TransactionData"
17257
17143
  },
17258
- "description": "The name of the target Data Server query or Request Server requestReply.",
17144
+ "privacy": "protected",
17145
+ "default": "{\n add: [],\n remove: [],\n update: [],\n addIndex: 0,\n }",
17259
17146
  "inheritedFrom": {
17260
- "name": "GenesisGridDatasourceElement",
17147
+ "name": "GridProBaseDatasource",
17261
17148
  "module": "src/datasource/base.datasource.ts"
17262
17149
  }
17263
17150
  },
17264
17151
  {
17265
- "kind": "field",
17266
- "name": "viewNumber",
17267
- "type": {
17268
- "text": "number"
17269
- },
17270
- "description": "The desired view/page you want data from.",
17271
- "inheritedFrom": {
17272
- "name": "GenesisGridDatasourceElement",
17273
- "module": "src/datasource/base.datasource.ts"
17274
- }
17152
+ "kind": "method",
17153
+ "name": "criteriaChanged",
17154
+ "parameters": [
17155
+ {
17156
+ "name": "oldCriteria",
17157
+ "type": {
17158
+ "text": "string"
17159
+ }
17160
+ },
17161
+ {
17162
+ "name": "newCriteria",
17163
+ "type": {
17164
+ "text": "string"
17165
+ }
17166
+ }
17167
+ ]
17275
17168
  },
17276
17169
  {
17277
- "kind": "field",
17278
- "name": "fields",
17279
- "type": {
17280
- "text": "string"
17281
- },
17282
- "description": "Optional parameter that allows you to select a subset of fields from the query if the client is not interested in receiving all of them.",
17283
- "inheritedFrom": {
17284
- "name": "GenesisGridDatasourceElement",
17285
- "module": "src/datasource/base.datasource.ts"
17286
- }
17170
+ "kind": "method",
17171
+ "name": "requestChanged",
17172
+ "parameters": [
17173
+ {
17174
+ "name": "oldRequest",
17175
+ "type": {
17176
+ "text": "string"
17177
+ }
17178
+ },
17179
+ {
17180
+ "name": "newRequest",
17181
+ "type": {
17182
+ "text": "string"
17183
+ }
17184
+ }
17185
+ ]
17287
17186
  },
17288
17187
  {
17289
- "kind": "field",
17290
- "name": "maxView",
17291
- "type": {
17292
- "text": "number"
17293
- },
17294
- "description": "Maximum number of rows to track as part of a client \"view\".",
17295
- "inheritedFrom": {
17296
- "name": "GenesisGridDatasourceElement",
17297
- "module": "src/datasource/base.datasource.ts"
17298
- }
17188
+ "kind": "method",
17189
+ "name": "resourceNameChanged",
17190
+ "parameters": [
17191
+ {
17192
+ "name": "oldValue",
17193
+ "type": {
17194
+ "text": "string"
17195
+ }
17196
+ },
17197
+ {
17198
+ "name": "newValue",
17199
+ "type": {
17200
+ "text": "string"
17201
+ }
17202
+ }
17203
+ ]
17299
17204
  },
17300
17205
  {
17301
17206
  "kind": "field",
17302
- "name": "movingView",
17207
+ "name": "keepColDefsOnClearRowData",
17303
17208
  "type": {
17304
17209
  "text": "boolean"
17305
17210
  },
17211
+ "privacy": "public",
17306
17212
  "default": "false",
17307
- "description": "If true, when the maximum number of rows defined in max-view is reached, the Data Server will start discarding the oldest rows (in terms of timestamp) and sending newer rows.",
17308
17213
  "inheritedFrom": {
17309
- "name": "GenesisGridDatasourceElement",
17214
+ "name": "GridProBaseDatasource",
17310
17215
  "module": "src/datasource/base.datasource.ts"
17311
17216
  }
17312
17217
  },
17313
17218
  {
17314
17219
  "kind": "field",
17315
- "name": "reverse",
17220
+ "name": "requestVisibleColumnsOnly",
17316
17221
  "type": {
17317
17222
  "text": "boolean"
17318
17223
  },
17319
17224
  "default": "false",
17320
- "description": "Option that changes the Data Server index iteration.",
17321
- "inheritedFrom": {
17322
- "name": "GenesisGridDatasourceElement",
17323
- "module": "src/datasource/base.datasource.ts"
17324
- }
17225
+ "description": "When enabled and column definitions are provided, the datasource requests data only for the\ncolumns that are currently visible. The visible set is seeded from the column config (columns\nnot flagged with `hide`) and updated by the host grid via `setVisibleColumns`; the data\nis reloaded whenever that set changes."
17325
17226
  },
17326
17227
  {
17327
17228
  "kind": "field",
17328
- "name": "disablePolling",
17229
+ "name": "_visibleColumns",
17329
17230
  "type": {
17330
- "text": "boolean"
17231
+ "text": "string[] | undefined"
17331
17232
  },
17332
- "default": "false",
17333
- "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
17334
- "inheritedFrom": {
17335
- "name": "GenesisGridDatasourceElement",
17336
- "module": "src/datasource/base.datasource.ts"
17337
- }
17233
+ "privacy": "private"
17338
17234
  },
17339
17235
  {
17340
17236
  "kind": "field",
17341
- "name": "offset",
17237
+ "name": "dataSub",
17342
17238
  "type": {
17343
- "text": "number"
17239
+ "text": "Subscription"
17344
17240
  },
17345
- "description": "The offset for pagination in REQUEST_SERVER scenarios.",
17346
- "inheritedFrom": {
17347
- "name": "GenesisGridDatasourceElement",
17348
- "module": "src/datasource/base.datasource.ts"
17349
- }
17241
+ "privacy": "private"
17350
17242
  },
17351
17243
  {
17352
17244
  "kind": "field",
17353
- "name": "pollingInterval",
17245
+ "name": "updateSub",
17354
17246
  "type": {
17355
- "text": "number"
17247
+ "text": "Subscription"
17356
17248
  },
17357
- "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
17358
- "inheritedFrom": {
17359
- "name": "GenesisGridDatasourceElement",
17360
- "module": "src/datasource/base.datasource.ts"
17361
- }
17249
+ "privacy": "private"
17362
17250
  },
17363
17251
  {
17364
17252
  "kind": "field",
17365
- "name": "pollTriggerEvents",
17253
+ "name": "requiresFullRowDataAndColDefs",
17366
17254
  "type": {
17367
- "text": "string[]"
17255
+ "text": "boolean"
17368
17256
  },
17369
- "default": "[]",
17370
- "description": "Array of event names that will trigger a poll when received as commit responses.",
17371
- "inheritedFrom": {
17372
- "name": "GenesisGridDatasourceElement",
17373
- "module": "src/datasource/base.datasource.ts"
17374
- }
17257
+ "privacy": "private",
17258
+ "default": "true"
17375
17259
  },
17376
17260
  {
17377
17261
  "kind": "field",
17378
- "name": "request",
17379
- "type": {
17380
- "text": "any"
17381
- },
17382
- "description": "Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.",
17383
- "inheritedFrom": {
17384
- "name": "GenesisGridDatasourceElement",
17385
- "module": "src/datasource/base.datasource.ts"
17386
- }
17387
- },
17388
- {
17389
- "kind": "field",
17390
- "name": "requestAutoSetup",
17262
+ "name": "_lastMoreRows",
17391
17263
  "type": {
17392
17264
  "text": "boolean"
17393
17265
  },
17394
- "default": "true",
17395
- "description": "Attribute to set whether the REQUEST object should be automatically set up.",
17396
- "inheritedFrom": {
17397
- "name": "GenesisGridDatasourceElement",
17398
- "module": "src/datasource/base.datasource.ts"
17399
- }
17400
- },
17401
- {
17402
- "kind": "field",
17403
- "name": "rowIdAttr",
17404
- "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
17405
- "inheritedFrom": {
17406
- "name": "GenesisGridDatasourceElement",
17407
- "module": "src/datasource/base.datasource.ts"
17408
- }
17266
+ "privacy": "private",
17267
+ "default": "false"
17409
17268
  },
17410
17269
  {
17411
17270
  "kind": "field",
17412
- "name": "restartOnReconnection",
17271
+ "name": "_isMoreRowsResult",
17413
17272
  "type": {
17414
17273
  "text": "boolean"
17415
17274
  },
17416
- "default": "true",
17417
- "description": "Attribute to set whether the datasource should restart when it reconnects.",
17418
- "inheritedFrom": {
17419
- "name": "GenesisGridDatasourceElement",
17420
- "module": "src/datasource/base.datasource.ts"
17421
- }
17275
+ "privacy": "private",
17276
+ "default": "false"
17422
17277
  },
17423
17278
  {
17424
17279
  "kind": "field",
17425
- "name": "defaultRowIdByResourceType",
17280
+ "name": "_sourceRef",
17426
17281
  "type": {
17427
17282
  "text": "string"
17428
17283
  },
17429
- "privacy": "protected",
17430
- "readonly": true,
17431
- "inheritedFrom": {
17432
- "name": "GenesisGridDatasourceElement",
17433
- "module": "src/datasource/base.datasource.ts"
17434
- }
17284
+ "privacy": "private"
17435
17285
  },
17436
17286
  {
17437
17287
  "kind": "field",
17438
- "name": "criteriaFromFilters",
17288
+ "name": "_nextOffset",
17439
17289
  "type": {
17440
- "text": "Map<string, string>"
17290
+ "text": "number"
17441
17291
  },
17442
- "privacy": "protected",
17443
- "default": "new Map()",
17444
- "inheritedFrom": {
17445
- "name": "GenesisGridDatasourceElement",
17446
- "module": "src/datasource/base.datasource.ts"
17447
- }
17292
+ "privacy": "private",
17293
+ "default": "0"
17448
17294
  },
17449
17295
  {
17450
17296
  "kind": "field",
17451
- "name": "update",
17297
+ "name": "_loadMoreCount",
17452
17298
  "type": {
17453
- "text": "BehaviorSubject<Map<string, string>>"
17299
+ "text": "number"
17454
17300
  },
17455
- "privacy": "protected",
17456
- "default": "new BehaviorSubject(new Map())",
17457
- "inheritedFrom": {
17458
- "name": "GenesisGridDatasourceElement",
17459
- "module": "src/datasource/base.datasource.ts"
17460
- }
17301
+ "privacy": "private",
17302
+ "default": "0"
17461
17303
  },
17462
17304
  {
17463
17305
  "kind": "method",
17464
- "name": "datasourceOptions",
17465
- "privacy": "protected",
17306
+ "name": "deepClone",
17466
17307
  "return": {
17467
17308
  "type": {
17468
- "text": "DatasourceOptions"
17309
+ "text": "Node"
17469
17310
  }
17470
17311
  },
17471
17312
  "inheritedFrom": {
17472
- "name": "GenesisGridDatasourceElement",
17473
- "module": "src/datasource/base.datasource.ts"
17313
+ "name": "LifecycleMixin",
17314
+ "module": "src/mixins/lifecycle/lifecycle.ts"
17474
17315
  }
17475
17316
  },
17476
17317
  {
17477
17318
  "kind": "method",
17478
- "name": "buildCriteria",
17319
+ "name": "colDefsDeepClone",
17479
17320
  "privacy": "private",
17480
17321
  "return": {
17481
17322
  "type": {
17482
- "text": "string"
17323
+ "text": "ColDef[]"
17483
17324
  }
17484
17325
  },
17485
- "inheritedFrom": {
17486
- "name": "GenesisGridDatasourceElement",
17487
- "module": "src/datasource/base.datasource.ts"
17488
- }
17489
- },
17490
- {
17491
- "kind": "field",
17492
- "name": "isRequestServer",
17493
- "type": {
17494
- "text": "boolean"
17495
- },
17496
- "readonly": true,
17497
- "inheritedFrom": {
17498
- "name": "GenesisGridDatasourceElement",
17499
- "module": "src/datasource/base.datasource.ts"
17500
- }
17501
- },
17502
- {
17503
- "kind": "method",
17504
- "name": "datasourceStatusChanged",
17505
17326
  "parameters": [
17506
17327
  {
17507
- "name": "prev",
17328
+ "name": "key",
17508
17329
  "type": {
17509
- "text": "DatasourceStatus"
17330
+ "text": "string"
17510
17331
  }
17511
17332
  },
17512
17333
  {
17513
- "name": "next",
17334
+ "name": "copy",
17514
17335
  "type": {
17515
- "text": "DatasourceStatus"
17336
+ "text": "any"
17516
17337
  }
17517
17338
  }
17518
- ],
17519
- "inheritedFrom": {
17520
- "name": "GenesisGridDatasourceElement",
17521
- "module": "src/datasource/base.datasource.ts"
17522
- }
17339
+ ]
17523
17340
  },
17524
17341
  {
17525
17342
  "kind": "method",
17526
- "name": "handleErrors",
17343
+ "name": "init",
17527
17344
  "parameters": [
17528
17345
  {
17529
- "name": "errors",
17346
+ "name": "keepColDefsOnClearRowData",
17347
+ "optional": true,
17530
17348
  "type": {
17531
- "text": "string | any[]"
17532
- },
17533
- "description": "The error message or array of error messages"
17349
+ "text": "boolean"
17350
+ }
17534
17351
  },
17535
17352
  {
17536
- "name": "type",
17537
- "default": "'unknown'",
17538
- "type": {
17539
- "text": "BaseDatasourceErrorEventDetail['type']"
17540
- },
17541
- "description": "The type of error that occurred"
17353
+ "description": "Optionally set the `gridOptions` up with column definitions",
17354
+ "name": "columnDefinitions"
17355
+ },
17356
+ {
17357
+ "description": "Optionally set the grid up with column state",
17358
+ "name": "columnStates"
17542
17359
  }
17543
17360
  ],
17544
- "description": "Handles errors and emits appropriate error events.",
17545
- "privacy": "public",
17546
- "inheritedFrom": {
17547
- "name": "GenesisGridDatasourceElement",
17548
- "module": "src/datasource/base.datasource.ts"
17549
- }
17361
+ "description": "Initializes the datasource.",
17362
+ "privacy": "public"
17550
17363
  },
17551
17364
  {
17552
17365
  "kind": "method",
17553
- "name": "clearErrors",
17554
- "description": "Clears error state and emits connected event.",
17366
+ "name": "destroy",
17367
+ "description": "Destroys the datasource, resetting it to its initial state.",
17555
17368
  "privacy": "public",
17556
17369
  "inheritedFrom": {
17557
- "name": "GenesisGridDatasourceElement",
17370
+ "name": "GridProBaseDatasource",
17558
17371
  "module": "src/datasource/base.datasource.ts"
17559
17372
  }
17560
17373
  },
17561
17374
  {
17562
- "kind": "field",
17563
- "name": "_presentation",
17564
- "type": {
17565
- "text": "ComponentPresentation | null | undefined"
17566
- },
17567
- "privacy": "private",
17568
- "default": "void 0",
17569
- "inheritedFrom": {
17570
- "name": "FoundationElement",
17571
- "module": "src/foundation-element/foundation-element.ts"
17572
- }
17375
+ "kind": "method",
17376
+ "name": "deinit",
17377
+ "description": "Deinitialises the datasource, resetting it to its initial state.",
17378
+ "deprecated": "Use `destroy` instead",
17379
+ "privacy": "public"
17573
17380
  },
17574
17381
  {
17575
- "kind": "field",
17576
- "name": "$presentation",
17577
- "type": {
17578
- "text": "ComponentPresentation | null"
17579
- },
17382
+ "kind": "method",
17383
+ "name": "reset",
17384
+ "description": "Resets the datasource to its initial state.",
17580
17385
  "privacy": "public",
17581
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
17582
- "inheritedFrom": {
17583
- "name": "FoundationElement",
17584
- "module": "src/foundation-element/foundation-element.ts"
17585
- }
17386
+ "deprecated": "Use `destroy` instead"
17586
17387
  },
17587
17388
  {
17588
- "kind": "field",
17589
- "name": "template",
17590
- "type": {
17591
- "text": "ElementViewTemplate | void | null"
17592
- },
17389
+ "kind": "method",
17390
+ "name": "restart",
17391
+ "description": "Restarts the datasource, uses `destroy` and `init` in sequence.",
17593
17392
  "privacy": "public",
17594
- "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
17595
17393
  "inheritedFrom": {
17596
- "name": "FoundationElement",
17597
- "module": "src/foundation-element/foundation-element.ts"
17394
+ "name": "GridProBaseDatasource",
17395
+ "module": "src/datasource/base.datasource.ts"
17598
17396
  }
17599
17397
  },
17600
17398
  {
17601
17399
  "kind": "method",
17602
- "name": "templateChanged",
17603
- "privacy": "protected",
17604
- "return": {
17605
- "type": {
17606
- "text": "void"
17607
- }
17608
- },
17609
- "inheritedFrom": {
17610
- "name": "FoundationElement",
17611
- "module": "src/foundation-element/foundation-element.ts"
17612
- }
17613
- },
17614
- {
17615
- "kind": "field",
17616
- "name": "styles",
17617
- "type": {
17618
- "text": "ElementStyles | void | null"
17619
- },
17620
- "privacy": "public",
17621
- "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
17622
- "inheritedFrom": {
17623
- "name": "FoundationElement",
17624
- "module": "src/foundation-element/foundation-element.ts"
17625
- }
17400
+ "name": "refreshRows",
17401
+ "description": "Force the grid to redispatch the current rows"
17626
17402
  },
17627
17403
  {
17628
17404
  "kind": "method",
17629
- "name": "stylesChanged",
17630
- "privacy": "protected",
17405
+ "name": "reloadResourceData",
17406
+ "privacy": "public",
17631
17407
  "return": {
17632
17408
  "type": {
17633
- "text": "void"
17409
+ "text": "Promise<void>"
17634
17410
  }
17635
17411
  },
17412
+ "description": "Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.\nLoads resource data without full initialization (no metadata fetch).",
17636
17413
  "inheritedFrom": {
17637
- "name": "FoundationElement",
17638
- "module": "src/foundation-element/foundation-element.ts"
17414
+ "name": "GridProBaseDatasource",
17415
+ "module": "src/datasource/base.datasource.ts"
17639
17416
  }
17640
17417
  },
17641
17418
  {
17642
17419
  "kind": "method",
17643
- "name": "compose",
17644
- "privacy": "public",
17645
- "static": true,
17646
- "return": {
17647
- "type": {
17648
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
17420
+ "name": "handleSnapshot",
17421
+ "privacy": "private",
17422
+ "parameters": [
17423
+ {
17424
+ "name": "result"
17649
17425
  }
17650
- },
17426
+ ]
17427
+ },
17428
+ {
17429
+ "kind": "method",
17430
+ "name": "handleStreamResult",
17431
+ "privacy": "private",
17651
17432
  "parameters": [
17652
17433
  {
17653
- "name": "this",
17434
+ "name": "result",
17654
17435
  "type": {
17655
- "text": "K"
17436
+ "text": "FilteredDataServerResult | RequestServerResult"
17656
17437
  }
17438
+ }
17439
+ ]
17440
+ },
17441
+ {
17442
+ "kind": "method",
17443
+ "name": "updateLoadMoreStatus",
17444
+ "privacy": "private",
17445
+ "parameters": [
17446
+ {
17447
+ "name": "moreRows",
17448
+ "type": {
17449
+ "text": "boolean"
17450
+ },
17451
+ "description": "Whether more rows are available"
17657
17452
  },
17658
17453
  {
17659
- "name": "elementDefinition",
17454
+ "name": "sourceRef",
17660
17455
  "type": {
17661
- "text": "T"
17456
+ "text": "string"
17662
17457
  },
17663
- "description": "The definition of the element to create the registry\nfunction for."
17458
+ "description": "The source reference"
17459
+ },
17460
+ {
17461
+ "description": "The total number of rows",
17462
+ "name": "rowsCount"
17664
17463
  }
17665
17464
  ],
17666
- "description": "Defines an element registry function with a set of element definition defaults.",
17667
- "inheritedFrom": {
17668
- "name": "FoundationElement",
17669
- "module": "src/foundation-element/foundation-element.ts"
17670
- }
17671
- }
17672
- ],
17673
- "events": [
17465
+ "description": "Updates the status bar based on more rows status"
17466
+ },
17674
17467
  {
17675
- "description": "Fired when a datasource error is reported. detail: `BaseDatasourceErrorEventDetail`",
17676
- "name": "base-datasource-error",
17468
+ "kind": "method",
17469
+ "name": "applyRequestServerData",
17470
+ "privacy": "private",
17471
+ "parameters": [
17472
+ {
17473
+ "name": "requestServerResult",
17474
+ "type": {
17475
+ "text": "RequestServerResult"
17476
+ }
17477
+ }
17478
+ ]
17479
+ },
17480
+ {
17481
+ "kind": "method",
17482
+ "name": "applyDataserverData",
17483
+ "privacy": "private",
17484
+ "parameters": [
17485
+ {
17486
+ "name": "dataServerResult",
17487
+ "type": {
17488
+ "text": "FilteredDataServerResult"
17489
+ }
17490
+ }
17491
+ ]
17492
+ },
17493
+ {
17494
+ "kind": "method",
17495
+ "name": "getAgColumnDefs",
17496
+ "privacy": "private",
17497
+ "parameters": [
17498
+ {
17499
+ "name": "fieldsMetadata",
17500
+ "type": {
17501
+ "text": "FieldMetadata[]"
17502
+ }
17503
+ }
17504
+ ]
17505
+ },
17506
+ {
17507
+ "kind": "method",
17508
+ "name": "setFilter",
17509
+ "privacy": "public",
17510
+ "parameters": [
17511
+ {
17512
+ "name": "fieldName",
17513
+ "type": {
17514
+ "text": "string"
17515
+ }
17516
+ },
17517
+ {
17518
+ "name": "newFilter",
17519
+ "type": {
17520
+ "text": "string"
17521
+ }
17522
+ }
17523
+ ],
17677
17524
  "inheritedFrom": {
17678
17525
  "name": "GenesisGridDatasourceElement",
17679
17526
  "module": "src/datasource/base.datasource.ts"
17680
17527
  }
17681
17528
  },
17682
17529
  {
17683
- "description": "Fired when a datasource error occurs (for grid integration). detail: `DatasourceErrorEventDetail`",
17684
- "name": "datasource-error",
17530
+ "kind": "method",
17531
+ "name": "removeFilter",
17532
+ "privacy": "public",
17533
+ "parameters": [
17534
+ {
17535
+ "name": "fieldName",
17536
+ "type": {
17537
+ "text": "string"
17538
+ }
17539
+ }
17540
+ ],
17685
17541
  "inheritedFrom": {
17686
17542
  "name": "GenesisGridDatasourceElement",
17687
17543
  "module": "src/datasource/base.datasource.ts"
17688
17544
  }
17689
17545
  },
17690
17546
  {
17691
- "description": "Fired when error state is cleared after connection succeeds",
17692
- "name": "base-datasource-connected",
17547
+ "kind": "method",
17548
+ "name": "applyTransaction",
17549
+ "privacy": "protected",
17550
+ "return": {
17551
+ "type": {
17552
+ "text": "any"
17553
+ }
17554
+ },
17555
+ "parameters": [
17556
+ {
17557
+ "name": "transaction",
17558
+ "type": {
17559
+ "text": "any"
17560
+ }
17561
+ }
17562
+ ],
17693
17563
  "inheritedFrom": {
17694
- "name": "GenesisGridDatasourceElement",
17564
+ "name": "GridProBaseDatasource",
17695
17565
  "module": "src/datasource/base.datasource.ts"
17696
17566
  }
17697
17567
  },
17698
17568
  {
17699
- "description": "Fired when loading completes with no pending row changes",
17700
- "name": "datasource-loading-finished",
17569
+ "kind": "method",
17570
+ "name": "handleSizeChanged",
17571
+ "privacy": "private",
17572
+ "parameters": [
17573
+ {
17574
+ "name": "oldSize",
17575
+ "type": {
17576
+ "text": "number"
17577
+ }
17578
+ },
17579
+ {
17580
+ "name": "newSize",
17581
+ "type": {
17582
+ "text": "number"
17583
+ }
17584
+ }
17585
+ ]
17586
+ },
17587
+ {
17588
+ "kind": "method",
17589
+ "name": "handleStreamInserts",
17590
+ "privacy": "protected",
17591
+ "parameters": [
17592
+ {
17593
+ "name": "inserts",
17594
+ "default": "[]"
17595
+ }
17596
+ ],
17701
17597
  "inheritedFrom": {
17702
- "name": "GenesisGridDatasourceElement",
17598
+ "name": "GridProBaseDatasource",
17703
17599
  "module": "src/datasource/base.datasource.ts"
17704
17600
  }
17705
17601
  },
17706
17602
  {
17707
- "description": "Fired when the grid has no rows after load",
17708
- "name": "datasource-no-data-available",
17603
+ "kind": "method",
17604
+ "name": "handleStreamUpdates",
17605
+ "privacy": "protected",
17606
+ "parameters": [
17607
+ {
17608
+ "name": "updates",
17609
+ "default": "[]"
17610
+ }
17611
+ ],
17709
17612
  "inheritedFrom": {
17710
- "name": "GenesisGridDatasourceElement",
17613
+ "name": "GridProBaseDatasource",
17711
17614
  "module": "src/datasource/base.datasource.ts"
17712
17615
  }
17713
17616
  },
17714
17617
  {
17715
- "description": "Fired when row data changes from stream updates. detail: `DataChangedEventDetail`",
17716
- "name": "datasource-data-changed",
17618
+ "kind": "method",
17619
+ "name": "handleStreamDeletes",
17620
+ "privacy": "protected",
17621
+ "parameters": [
17622
+ {
17623
+ "name": "deletes",
17624
+ "default": "[]",
17625
+ "description": "List of records to remove from the grid stream"
17626
+ }
17627
+ ],
17628
+ "description": "Handles stream deletes by removing records from the grid.",
17717
17629
  "inheritedFrom": {
17718
- "name": "GenesisGridDatasourceElement",
17630
+ "name": "GridProBaseDatasource",
17719
17631
  "module": "src/datasource/base.datasource.ts"
17720
17632
  }
17721
17633
  },
17722
17634
  {
17723
- "description": "Fired to hand off grid options and initialization flags. detail: `InitializeEventDetail`",
17724
- "name": "datasource-initialize"
17635
+ "kind": "method",
17636
+ "name": "setVisibleColumns",
17637
+ "return": {
17638
+ "type": {
17639
+ "text": "void"
17640
+ }
17641
+ },
17642
+ "parameters": [
17643
+ {
17644
+ "name": "visibleFields",
17645
+ "type": {
17646
+ "text": "string[]"
17647
+ },
17648
+ "description": "Field names of the currently visible columns."
17649
+ }
17650
+ ],
17651
+ "description": "Updates the set of visible columns and reloads the data when the set changes.",
17652
+ "privacy": "public",
17653
+ "inheritedFrom": {
17654
+ "name": "GridProBaseDatasource",
17655
+ "module": "src/datasource/base.datasource.ts"
17656
+ }
17725
17657
  },
17726
17658
  {
17727
- "description": "Fired when the datasource is torn down",
17728
- "name": "datasource-destroy"
17659
+ "kind": "method",
17660
+ "name": "loadMore",
17661
+ "inheritedFrom": {
17662
+ "name": "GridProBaseDatasource",
17663
+ "module": "src/datasource/base.datasource.ts"
17664
+ }
17729
17665
  },
17730
17666
  {
17731
- "description": "Fired when row data is cleared. detail: `DataClearedEventDetail`",
17732
- "name": "datasource-data-cleared"
17667
+ "kind": "method",
17668
+ "name": "cloneNode",
17669
+ "return": {
17670
+ "type": {
17671
+ "text": "Node"
17672
+ }
17673
+ },
17674
+ "parameters": [
17675
+ {
17676
+ "name": "deep",
17677
+ "optional": true,
17678
+ "type": {
17679
+ "text": "boolean"
17680
+ }
17681
+ }
17682
+ ],
17683
+ "inheritedFrom": {
17684
+ "name": "LifecycleMixin",
17685
+ "module": "src/mixins/lifecycle/lifecycle.ts"
17686
+ }
17733
17687
  },
17734
17688
  {
17735
- "description": "Fired when column metadata or defs are updated. detail: `SchemaUpdatedEventDetail`",
17736
- "name": "datasource-schema-updated"
17689
+ "kind": "field",
17690
+ "name": "shouldRunDisconnect",
17691
+ "return": {
17692
+ "type": {
17693
+ "text": ""
17694
+ }
17695
+ },
17696
+ "readonly": true,
17697
+ "inheritedFrom": {
17698
+ "name": "LifecycleMixin",
17699
+ "module": "src/mixins/lifecycle/lifecycle.ts"
17700
+ }
17737
17701
  },
17738
17702
  {
17739
- "description": "Fired when persisted filters are reapplied",
17740
- "name": "datasource-filters-restored"
17741
- },
17742
- {
17743
- "description": "Fired when a data payload is loaded for the grid. detail: `DataLoadedEventDetail`",
17744
- "name": "datasource-data-loaded"
17745
- },
17746
- {
17747
- "description": "Fired when a load or refresh starts",
17748
- "name": "datasource-loading-started"
17749
- },
17750
- {
17751
- "description": "Fired when more server rows can be requested. detail: `MoreDataAvailableEventDetail`",
17752
- "name": "datasource-more-data-available"
17753
- },
17754
- {
17755
- "description": "Fired when the host grid is ready to start loading data",
17756
- "name": "datasource-ready"
17757
- },
17758
- {
17759
- "description": "Fired when initial grid data is ready for the client-side model",
17760
- "name": "datasource-init"
17761
- },
17762
- {
17763
- "description": "Fired when MORE_ROWS availability changes. detail: `MoreRowsDetail`",
17764
- "name": "more-rows-changed"
17765
- },
17766
- {
17767
- "description": "Fired when layout or viewport sizing affects the datasource. detail: `GrigProGenesisDatasourceSizeChangedEventDetail`",
17768
- "name": "datasource-size-changed"
17769
- }
17770
- ],
17771
- "attributes": [
17772
- {
17773
- "name": "keep-col-defs-on-clear-row-data",
17774
- "type": {
17775
- "text": "boolean"
17776
- },
17777
- "default": "false",
17778
- "fieldName": "keepColDefsOnClearRowData"
17779
- },
17780
- {
17781
- "name": "request-visible-columns-only",
17782
- "type": {
17783
- "text": "boolean"
17784
- },
17785
- "default": "false",
17786
- "description": "When enabled and column definitions are provided, the datasource requests data only for the\ncolumns that are currently visible. The visible set is seeded from the column config (columns\nnot flagged with `hide`) and updated by the host grid via `setVisibleColumns`; the data\nis reloaded whenever that set changes.",
17787
- "fieldName": "requestVisibleColumnsOnly"
17788
- },
17789
- {
17790
- "name": "criteria",
17791
- "type": {
17792
- "text": "string"
17793
- },
17794
- "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
17795
- "fieldName": "criteria",
17796
- "inheritedFrom": {
17797
- "name": "GenesisGridDatasourceElement",
17798
- "module": "src/datasource/base.datasource.ts"
17799
- }
17800
- },
17801
- {
17802
- "name": "is-snapshot",
17803
- "type": {
17804
- "text": "boolean"
17805
- },
17806
- "default": "false",
17807
- "description": "Request a snapshot from the server.",
17808
- "fieldName": "isSnapshot",
17809
- "inheritedFrom": {
17810
- "name": "GenesisGridDatasourceElement",
17811
- "module": "src/datasource/base.datasource.ts"
17812
- }
17813
- },
17814
- {
17815
- "name": "max-rows",
17816
- "type": {
17817
- "text": "number"
17818
- },
17819
- "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
17820
- "fieldName": "maxRows",
17821
- "inheritedFrom": {
17822
- "name": "GenesisGridDatasourceElement",
17823
- "module": "src/datasource/base.datasource.ts"
17824
- }
17825
- },
17826
- {
17827
- "name": "order-by",
17828
- "type": {
17829
- "text": "string"
17703
+ "kind": "field",
17704
+ "name": "shouldRunConnect",
17705
+ "return": {
17706
+ "type": {
17707
+ "text": ""
17708
+ }
17830
17709
  },
17831
- "description": "Option to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way.",
17832
- "fieldName": "orderBy",
17710
+ "readonly": true,
17833
17711
  "inheritedFrom": {
17834
- "name": "GenesisGridDatasourceElement",
17835
- "module": "src/datasource/base.datasource.ts"
17712
+ "name": "LifecycleMixin",
17713
+ "module": "src/mixins/lifecycle/lifecycle.ts"
17836
17714
  }
17837
17715
  },
17838
17716
  {
17839
- "name": "resource-name",
17840
- "type": {
17841
- "text": "string"
17717
+ "kind": "method",
17718
+ "name": "#_blockLifecycleDueToTokenChange",
17719
+ "return": {
17720
+ "type": {
17721
+ "text": "boolean"
17722
+ }
17842
17723
  },
17843
- "description": "The name of the target Data Server query or Request Server requestReply.",
17844
- "fieldName": "resourceName",
17724
+ "parameters": [
17725
+ {
17726
+ "name": "lifecycleType",
17727
+ "type": {
17728
+ "text": "Lifecycletype"
17729
+ }
17730
+ }
17731
+ ],
17845
17732
  "inheritedFrom": {
17846
- "name": "GenesisGridDatasourceElement",
17847
- "module": "src/datasource/base.datasource.ts"
17733
+ "name": "LifecycleMixin",
17734
+ "module": "src/mixins/lifecycle/lifecycle.ts"
17848
17735
  }
17849
17736
  },
17850
17737
  {
17851
- "name": "view-number",
17738
+ "kind": "field",
17739
+ "name": "dataSubWasLoggedOff",
17852
17740
  "type": {
17853
- "text": "number"
17741
+ "text": "boolean"
17854
17742
  },
17855
- "description": "The desired view/page you want data from.",
17856
- "fieldName": "viewNumber",
17743
+ "privacy": "protected",
17744
+ "default": "false",
17857
17745
  "inheritedFrom": {
17858
- "name": "GenesisGridDatasourceElement",
17746
+ "name": "GridProBaseDatasource",
17859
17747
  "module": "src/datasource/base.datasource.ts"
17860
17748
  }
17861
17749
  },
17862
17750
  {
17863
- "name": "fields",
17751
+ "kind": "field",
17752
+ "name": "rowData",
17864
17753
  "type": {
17865
- "text": "string"
17754
+ "text": "Map<string, any>"
17866
17755
  },
17867
- "description": "Optional parameter that allows you to select a subset of fields from the query if the client is not interested in receiving all of them.",
17868
- "fieldName": "fields",
17756
+ "default": "new Map()",
17869
17757
  "inheritedFrom": {
17870
- "name": "GenesisGridDatasourceElement",
17758
+ "name": "GridProBaseDatasource",
17871
17759
  "module": "src/datasource/base.datasource.ts"
17872
17760
  }
17873
17761
  },
17874
17762
  {
17875
- "name": "max-view",
17763
+ "kind": "field",
17764
+ "name": "connectionSub",
17876
17765
  "type": {
17877
- "text": "number"
17766
+ "text": "Subscription | undefined"
17878
17767
  },
17879
- "description": "Maximum number of rows to track as part of a client \"view\".",
17880
- "fieldName": "maxView",
17768
+ "privacy": "protected",
17881
17769
  "inheritedFrom": {
17882
- "name": "GenesisGridDatasourceElement",
17770
+ "name": "GridProBaseDatasource",
17883
17771
  "module": "src/datasource/base.datasource.ts"
17884
17772
  }
17885
17773
  },
17886
17774
  {
17887
- "name": "moving-view",
17888
- "type": {
17889
- "text": "boolean"
17890
- },
17891
- "default": "false",
17892
- "description": "If true, when the maximum number of rows defined in max-view is reached, the Data Server will start discarding the oldest rows (in terms of timestamp) and sending newer rows.",
17893
- "fieldName": "movingView",
17775
+ "kind": "method",
17776
+ "name": "subscribeToConnection",
17777
+ "privacy": "protected",
17894
17778
  "inheritedFrom": {
17895
- "name": "GenesisGridDatasourceElement",
17779
+ "name": "GridProBaseDatasource",
17896
17780
  "module": "src/datasource/base.datasource.ts"
17897
17781
  }
17898
17782
  },
17899
17783
  {
17900
- "type": {
17901
- "text": "number"
17902
- },
17903
- "description": "Option that changes the Data Server index iteration.",
17904
- "fieldName": "reverse",
17905
- "default": "false",
17784
+ "kind": "method",
17785
+ "name": "unsubscribeFromConnection",
17786
+ "privacy": "protected",
17906
17787
  "inheritedFrom": {
17907
- "name": "GenesisGridDatasourceElement",
17788
+ "name": "GridProBaseDatasource",
17908
17789
  "module": "src/datasource/base.datasource.ts"
17909
17790
  }
17910
17791
  },
17911
17792
  {
17912
- "name": "disable-polling",
17913
- "type": {
17914
- "text": "boolean"
17793
+ "kind": "method",
17794
+ "name": "generateColumnDefsFromMetadata",
17795
+ "privacy": "protected",
17796
+ "return": {
17797
+ "type": {
17798
+ "text": "ColDef[]"
17799
+ }
17915
17800
  },
17916
- "default": "false",
17917
- "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
17918
- "fieldName": "disablePolling",
17801
+ "parameters": [
17802
+ {
17803
+ "name": "fieldsMetadata",
17804
+ "type": {
17805
+ "text": "FieldMetadata[]"
17806
+ }
17807
+ },
17808
+ {
17809
+ "name": "getFilterParamsByFieldType",
17810
+ "type": {
17811
+ "text": "(field: FieldMetadata) => ColDef['filterParams'] | any"
17812
+ }
17813
+ },
17814
+ {
17815
+ "name": "getFilterByFieldType",
17816
+ "type": {
17817
+ "text": "(type: FieldTypeEnum) => string"
17818
+ }
17819
+ }
17820
+ ],
17919
17821
  "inheritedFrom": {
17920
- "name": "GenesisGridDatasourceElement",
17822
+ "name": "GridProBaseDatasource",
17921
17823
  "module": "src/datasource/base.datasource.ts"
17922
17824
  }
17923
17825
  },
17924
17826
  {
17925
- "name": "polling-interval",
17926
- "type": {
17927
- "text": "number"
17928
- },
17929
- "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
17930
- "fieldName": "pollingInterval",
17827
+ "kind": "method",
17828
+ "name": "applyAllTransactions",
17829
+ "privacy": "protected",
17931
17830
  "inheritedFrom": {
17932
- "name": "GenesisGridDatasourceElement",
17831
+ "name": "GridProBaseDatasource",
17933
17832
  "module": "src/datasource/base.datasource.ts"
17934
17833
  }
17935
17834
  },
17936
17835
  {
17937
- "name": "request-auto-setup",
17938
- "type": {
17939
- "text": "boolean"
17940
- },
17941
- "default": "true",
17942
- "description": "Attribute to set whether the REQUEST object should be automatically set up.",
17943
- "fieldName": "requestAutoSetup",
17836
+ "kind": "method",
17837
+ "name": "applyMappedTransaction",
17838
+ "privacy": "private",
17839
+ "parameters": [
17840
+ {
17841
+ "name": "transaction",
17842
+ "type": {
17843
+ "text": "TransactionData"
17844
+ }
17845
+ },
17846
+ {
17847
+ "name": "operation",
17848
+ "type": {
17849
+ "text": "OperationType"
17850
+ }
17851
+ }
17852
+ ],
17944
17853
  "inheritedFrom": {
17945
- "name": "GenesisGridDatasourceElement",
17854
+ "name": "GridProBaseDatasource",
17946
17855
  "module": "src/datasource/base.datasource.ts"
17947
17856
  }
17948
17857
  },
17949
17858
  {
17950
- "name": "row-id",
17951
- "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
17952
- "fieldName": "rowIdAttr",
17953
- "inheritedFrom": {
17954
- "name": "GenesisGridDatasourceElement",
17955
- "module": "src/datasource/base.datasource.ts"
17956
- }
17957
- },
17958
- {
17959
- "name": "restart-on-reconnection",
17960
- "type": {
17961
- "text": "boolean"
17962
- },
17963
- "default": "true",
17964
- "description": "Attribute to set whether the datasource should restart when it reconnects.",
17965
- "fieldName": "restartOnReconnection",
17966
- "inheritedFrom": {
17967
- "name": "GenesisGridDatasourceElement",
17968
- "module": "src/datasource/base.datasource.ts"
17969
- }
17970
- }
17971
- ],
17972
- "mixins": [
17973
- {
17974
- "name": "LifecycleMixin",
17975
- "package": "@genesislcap/foundation-utils"
17976
- }
17977
- ],
17978
- "superclass": {
17979
- "name": "GridProBaseDatasource",
17980
- "module": "/src/datasource/base.datasource"
17981
- },
17982
- "tagName": "grid-pro-genesis-datasource",
17983
- "customElement": true
17984
- }
17985
- ],
17986
- "exports": [
17987
- {
17988
- "kind": "js",
17989
- "name": "GridProGenesisDatasource",
17990
- "declaration": {
17991
- "name": "GridProGenesisDatasource",
17992
- "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
17993
- }
17994
- },
17995
- {
17996
- "kind": "custom-element-definition",
17997
- "name": "grid-pro-genesis-datasource",
17998
- "declaration": {
17999
- "name": "GridProGenesisDatasource",
18000
- "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
18001
- }
18002
- }
18003
- ]
18004
- },
18005
- {
18006
- "kind": "javascript-module",
18007
- "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
18008
- "declarations": [],
18009
- "exports": []
18010
- },
18011
- {
18012
- "kind": "javascript-module",
18013
- "path": "src/grid-pro-genesis-datasource/index.ts",
18014
- "declarations": [],
18015
- "exports": [
18016
- {
18017
- "kind": "js",
18018
- "name": "*",
18019
- "declaration": {
18020
- "name": "*",
18021
- "package": "./datasource-events.types"
18022
- }
18023
- },
18024
- {
18025
- "kind": "js",
18026
- "name": "*",
18027
- "declaration": {
18028
- "name": "*",
18029
- "package": "./grid-pro-genesis-datasource"
18030
- }
18031
- },
18032
- {
18033
- "kind": "js",
18034
- "name": "*",
18035
- "declaration": {
18036
- "name": "*",
18037
- "package": "./grid-pro-genesis-datasource.config"
18038
- }
18039
- },
18040
- {
18041
- "kind": "js",
18042
- "name": "*",
18043
- "declaration": {
18044
- "name": "*",
18045
- "package": "./grid-pro-genesis-datasource.types"
18046
- }
18047
- }
18048
- ]
18049
- },
18050
- {
18051
- "kind": "javascript-module",
18052
- "path": "src/multicolumn-dropdown/index.ts",
18053
- "declarations": [],
18054
- "exports": [
18055
- {
18056
- "kind": "js",
18057
- "name": "*",
18058
- "declaration": {
18059
- "name": "*",
18060
- "package": "./multicolumn-dropdown"
18061
- }
18062
- },
18063
- {
18064
- "kind": "js",
18065
- "name": "*",
18066
- "declaration": {
18067
- "name": "*",
18068
- "package": "./multicolumn-dropdown.styles"
18069
- }
18070
- },
18071
- {
18072
- "kind": "js",
18073
- "name": "*",
18074
- "declaration": {
18075
- "name": "*",
18076
- "package": "./multicolumn-dropdown.template"
18077
- }
18078
- }
18079
- ]
18080
- },
18081
- {
18082
- "kind": "javascript-module",
18083
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts",
18084
- "declarations": [
18085
- {
18086
- "kind": "variable",
18087
- "name": "dropdownWidthVar",
18088
- "type": {
18089
- "text": "string"
18090
- },
18091
- "default": "'--dropdown-width'",
18092
- "description": "The CSS variable to use for specifying the dropdown's width"
18093
- },
18094
- {
18095
- "kind": "variable",
18096
- "name": "optionsClass",
18097
- "type": {
18098
- "text": "string"
18099
- },
18100
- "default": "'options'",
18101
- "description": "The CSS class to use for the options element's class in the dropdown"
18102
- },
18103
- {
18104
- "kind": "variable",
18105
- "name": "DISPLAY_NONE_CLASS",
18106
- "type": {
18107
- "text": "string"
18108
- },
18109
- "default": "'dnone'",
18110
- "description": "Class name used to hide elements with display:none"
18111
- },
18112
- {
18113
- "kind": "variable",
18114
- "name": "multicolumnDropdownStyles",
18115
- "default": "css`\n label {\n color: var(--neutral-foreground-hint, rgb(135 155 166));\n font-style: normal;\n margin: calc(var(--design-unit) * 2px) 0;\n display: block;\n cursor: pointer;\n font-size: var(--type-ramp-base-font-size);\n line-height: var(--type-ramp-base-line-height);\n }\n\n .${DISPLAY_NONE_CLASS} {\n display: none !important;\n }\n\n .root {\n position: relative;\n width: inherit;\n min-width: 250px;\n ${dropdownWidthVar}: 350px;\n }\n\n .control {\n cursor: pointer;\n position: relative;\n display: flex;\n align-items: center;\n width: 100%;\n border-radius: calc(var(--control-corner-radius) * 1px);\n }\n\n #display-field {\n width: 100%;\n cursor: pointer;\n color: inherit;\n min-height: 40px;\n padding-left: calc(var(--design-unit) * 2.25px);\n padding-right: 52px;\n border-width: 0;\n background: var(--neutral-fill-input-rest);\n border-radius: calc(var(--control-corner-radius) * 1px);\n text-overflow: ellipsis;\n font-size: var(--type-ramp-base-font-size);\n font-family: var(--body-font);\n }\n\n #display-field[disabled] {\n cursor: not-allowed;\n opacity: var(--disabled-opacity);\n }\n\n #display-field:focus {\n outline: 1px solid var(--accent-fill-rest);\n background: var(--neutral-fill-input-rest);\n border-style: none;\n box-shadow: none;\n }\n\n #display-field:hover:not(:focus):not([disabled]) {\n outline: 1px solid var(--neutral-stroke-hover, rgb(231 232 232));\n }\n\n button {\n pointer-events: none;\n }\n\n #arrow-icon {\n display: inline-block;\n width: 16px;\n color: currentColor;\n position: absolute;\n left: calc(100% - 26px);\n padding: 0;\n cursor: pointer;\n transform: rotate(0deg);\n transition: transform 0.2s linear 0s;\n }\n\n #arrow-icon.flipped {\n transform: rotate(180deg);\n }\n\n .cross-icon {\n display: inline-block;\n width: 12px;\n color: currentColor;\n position: absolute;\n left: calc(100% - 46px);\n padding: 0;\n cursor: pointer;\n visibility: hidden;\n }\n\n .cross-icon:hover {\n color: var(--error-color);\n }\n\n .disabled-icon {\n pointer-events: none;\n opacity: var(--disabled-opacity);\n }\n\n .${optionsClass} {\n min-width: 100%;\n width: var(${dropdownWidthVar});\n display: flex;\n flex-direction: column;\n position: absolute;\n height: max-content;\n overflow-y: hidden;\n margin: 5px 0;\n background: var(--neutral-fill-input-rest);\n visibility: hidden;\n z-index: 999;\n }\n\n .dropdown-above {\n bottom: 100%;\n }\n\n .dropdown-left {\n right: 0;\n }\n\n .grid-container {\n height: 300px;\n width: 100%;\n }\n\n #filter-search {\n padding: 5px;\n }\n\n .visible {\n visibility: visible;\n }\n`",
18116
- "description": "Multicolumn Dropdown styles.",
18117
- "privacy": "public"
18118
- }
18119
- ],
18120
- "exports": [
18121
- {
18122
- "kind": "js",
18123
- "name": "dropdownWidthVar",
18124
- "declaration": {
18125
- "name": "dropdownWidthVar",
18126
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
18127
- }
18128
- },
18129
- {
18130
- "kind": "js",
18131
- "name": "optionsClass",
18132
- "declaration": {
18133
- "name": "optionsClass",
18134
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
18135
- }
18136
- },
18137
- {
18138
- "kind": "js",
18139
- "name": "DISPLAY_NONE_CLASS",
18140
- "declaration": {
18141
- "name": "DISPLAY_NONE_CLASS",
18142
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
18143
- }
18144
- },
18145
- {
18146
- "kind": "js",
18147
- "name": "multicolumnDropdownStyles",
18148
- "declaration": {
18149
- "name": "multicolumnDropdownStyles",
18150
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
18151
- }
18152
- }
18153
- ]
18154
- },
18155
- {
18156
- "kind": "javascript-module",
18157
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts",
18158
- "declarations": [
18159
- {
18160
- "kind": "function",
18161
- "name": "getMulticolumnDropdownTemplate",
18162
- "parameters": [
18163
- {
18164
- "name": "designSystem",
18165
- "default": "'foundation'",
18166
- "description": "The design system prefix to use. Defaults to 'foundation'."
18167
- }
18168
- ],
18169
- "description": "Get a Design System prefixed Multicolumn Dropdown template.",
18170
- "return": {
18171
- "type": {
18172
- "text": ""
18173
- }
18174
- },
18175
- "privacy": "public"
18176
- },
18177
- {
18178
- "kind": "variable",
18179
- "name": "multicolumnDropdownTemplate",
18180
- "description": "The default Multicolumn Dropdown template using the 'foundation' design system prefix.",
18181
- "privacy": "public"
18182
- }
18183
- ],
18184
- "exports": [
18185
- {
18186
- "kind": "js",
18187
- "name": "getMulticolumnDropdownTemplate",
18188
- "declaration": {
18189
- "name": "getMulticolumnDropdownTemplate",
18190
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
18191
- }
18192
- },
18193
- {
18194
- "kind": "js",
18195
- "name": "multicolumnDropdownTemplate",
18196
- "declaration": {
18197
- "name": "multicolumnDropdownTemplate",
18198
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
18199
- }
18200
- }
18201
- ]
18202
- },
18203
- {
18204
- "kind": "javascript-module",
18205
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.ts",
18206
- "declarations": [
18207
- {
18208
- "kind": "function",
18209
- "name": "wasClickOutsideElement",
18210
- "parameters": [
17859
+ "kind": "method",
17860
+ "name": "mapTransaction",
17861
+ "privacy": "private",
17862
+ "parameters": [
17863
+ {
17864
+ "name": "transaction",
17865
+ "type": {
17866
+ "text": "TransactionData"
17867
+ },
17868
+ "description": "The transaction data to be mapped."
17869
+ },
17870
+ {
17871
+ "name": "operations",
17872
+ "default": "Object.values(OperationType)",
17873
+ "type": {
17874
+ "text": "OperationType[]"
17875
+ },
17876
+ "description": "The operations to be mapped. Can be 'add', 'update' or 'remove'."
17877
+ }
17878
+ ],
17879
+ "description": "Maps the transaction data to the row data mapper function, if it exists.",
17880
+ "return": {
17881
+ "type": {
17882
+ "text": ""
17883
+ }
17884
+ },
17885
+ "inheritedFrom": {
17886
+ "name": "GridProBaseDatasource",
17887
+ "module": "src/datasource/base.datasource.ts"
17888
+ }
17889
+ },
18211
17890
  {
18212
- "name": "event",
17891
+ "kind": "field",
17892
+ "name": "_isDisconnected",
18213
17893
  "type": {
18214
- "text": "MouseEvent"
17894
+ "text": "boolean"
17895
+ },
17896
+ "privacy": "private",
17897
+ "default": "false",
17898
+ "inheritedFrom": {
17899
+ "name": "GridProBaseDatasource",
17900
+ "module": "src/datasource/base.datasource.ts"
18215
17901
  }
18216
17902
  },
18217
17903
  {
18218
- "name": "target",
17904
+ "kind": "method",
17905
+ "name": "setDisconnected",
17906
+ "privacy": "public",
17907
+ "parameters": [
17908
+ {
17909
+ "name": "disconnected",
17910
+ "type": {
17911
+ "text": "boolean"
17912
+ },
17913
+ "description": "true to set, false to remove"
17914
+ }
17915
+ ],
17916
+ "description": "Sets the disconnected state and emits appropriate events.",
17917
+ "inheritedFrom": {
17918
+ "name": "GridProBaseDatasource",
17919
+ "module": "src/datasource/base.datasource.ts"
17920
+ }
17921
+ },
17922
+ {
17923
+ "kind": "method",
17924
+ "name": "isDisconnected",
17925
+ "privacy": "public",
17926
+ "return": {
17927
+ "type": {
17928
+ "text": "boolean"
17929
+ }
17930
+ },
17931
+ "description": "Returns true if the datasource is disconnected.",
17932
+ "inheritedFrom": {
17933
+ "name": "GridProBaseDatasource",
17934
+ "module": "src/datasource/base.datasource.ts"
17935
+ }
17936
+ },
17937
+ {
17938
+ "kind": "method",
17939
+ "name": "getDatasourceStatusBarPanels",
17940
+ "privacy": "public",
17941
+ "return": {
17942
+ "type": {
17943
+ "text": "any[]"
17944
+ }
17945
+ },
17946
+ "parameters": [
17947
+ {
17948
+ "name": "isServerSide",
17949
+ "type": {
17950
+ "text": "boolean"
17951
+ }
17952
+ },
17953
+ {
17954
+ "name": "statusBarConfig",
17955
+ "type": {
17956
+ "text": "any"
17957
+ }
17958
+ }
17959
+ ],
17960
+ "description": "Gets datasource-specific status bar component configurations.\nThis method should be called by the grid to get status bar panels specific to this datasource.",
17961
+ "inheritedFrom": {
17962
+ "name": "GridProBaseDatasource",
17963
+ "module": "src/datasource/base.datasource.ts"
17964
+ }
17965
+ },
17966
+ {
17967
+ "kind": "field",
17968
+ "name": "connect",
18219
17969
  "type": {
18220
- "text": "EventTarget"
17970
+ "text": "Connect"
17971
+ },
17972
+ "inheritedFrom": {
17973
+ "name": "GenesisGridDatasourceElement",
17974
+ "module": "src/datasource/base.datasource.ts"
18221
17975
  }
18222
- }
18223
- ],
18224
- "description": "Checks if the given mouse event occurred outside the target element.",
18225
- "privacy": "public"
18226
- },
18227
- {
18228
- "kind": "class",
18229
- "description": "",
18230
- "name": "MulticolumnDropdown",
18231
- "members": [
17976
+ },
18232
17977
  {
18233
17978
  "kind": "field",
18234
- "name": "optionsElement",
17979
+ "name": "datasource",
18235
17980
  "type": {
18236
- "text": "HTMLElement"
17981
+ "text": "Datasource"
17982
+ },
17983
+ "inheritedFrom": {
17984
+ "name": "GenesisGridDatasourceElement",
17985
+ "module": "src/datasource/base.datasource.ts"
18237
17986
  }
18238
17987
  },
18239
17988
  {
18240
17989
  "kind": "field",
18241
- "name": "lastRequest",
17990
+ "name": "deferredGridOptions",
18242
17991
  "type": {
18243
- "text": "object"
17992
+ "text": "GridOptions"
18244
17993
  },
18245
- "privacy": "private"
17994
+ "inheritedFrom": {
17995
+ "name": "GenesisGridDatasourceElement",
17996
+ "module": "src/datasource/base.datasource.ts"
17997
+ }
18246
17998
  },
18247
17999
  {
18248
18000
  "kind": "field",
18249
- "name": "connectOverride",
18001
+ "name": "deferredColumnStates",
18250
18002
  "type": {
18251
- "text": "Connect"
18003
+ "text": "ColumnState[]"
18252
18004
  },
18253
- "privacy": "private"
18005
+ "inheritedFrom": {
18006
+ "name": "GenesisGridDatasourceElement",
18007
+ "module": "src/datasource/base.datasource.ts"
18008
+ }
18254
18009
  },
18255
18010
  {
18256
18011
  "kind": "field",
18257
- "name": "_connectDI",
18012
+ "name": "rowDataMapper",
18258
18013
  "type": {
18259
- "text": "Connect"
18014
+ "text": "Function"
18260
18015
  },
18261
- "privacy": "private"
18016
+ "description": "Allows grid data updates to be processed via and external function before applying in grid",
18017
+ "inheritedFrom": {
18018
+ "name": "GenesisGridDatasourceElement",
18019
+ "module": "src/datasource/base.datasource.ts"
18020
+ }
18262
18021
  },
18263
18022
  {
18264
18023
  "kind": "field",
18265
- "name": "connect",
18024
+ "name": "criteria",
18266
18025
  "type": {
18267
- "text": "Connect"
18026
+ "text": "string"
18268
18027
  },
18269
- "description": "The connect service - uses DI by default, but can be manually set for dynamic element creation"
18028
+ "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
18029
+ "inheritedFrom": {
18030
+ "name": "GenesisGridDatasourceElement",
18031
+ "module": "src/datasource/base.datasource.ts"
18032
+ }
18270
18033
  },
18271
18034
  {
18272
18035
  "kind": "field",
18273
- "name": "disabled",
18036
+ "name": "isSnapshot",
18274
18037
  "type": {
18275
18038
  "text": "boolean"
18276
18039
  },
18277
- "privacy": "public",
18278
- "description": "Whether to disable control of the component"
18040
+ "default": "false",
18041
+ "description": "Request a snapshot from the server.",
18042
+ "inheritedFrom": {
18043
+ "name": "GenesisGridDatasourceElement",
18044
+ "module": "src/datasource/base.datasource.ts"
18045
+ }
18279
18046
  },
18280
18047
  {
18281
18048
  "kind": "field",
18282
- "name": "resourceName",
18049
+ "name": "maxRows",
18050
+ "type": {
18051
+ "text": "number"
18052
+ },
18053
+ "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
18054
+ "inheritedFrom": {
18055
+ "name": "GenesisGridDatasourceElement",
18056
+ "module": "src/datasource/base.datasource.ts"
18057
+ }
18058
+ },
18059
+ {
18060
+ "kind": "field",
18061
+ "name": "orderBy",
18283
18062
  "type": {
18284
18063
  "text": "string"
18285
18064
  },
18286
- "privacy": "public",
18287
- "description": "The name of the reqrep to get the options from"
18065
+ "description": "Option to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way.",
18066
+ "inheritedFrom": {
18067
+ "name": "GenesisGridDatasourceElement",
18068
+ "module": "src/datasource/base.datasource.ts"
18069
+ }
18288
18070
  },
18289
18071
  {
18290
18072
  "kind": "field",
18291
- "name": "searchKey",
18073
+ "name": "resourceName",
18292
18074
  "type": {
18293
- "text": "string | string[] | undefined"
18075
+ "text": "string"
18294
18076
  },
18295
- "privacy": "public",
18296
- "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\")."
18077
+ "description": "The name of the target Data Server query or Request Server requestReply.",
18078
+ "inheritedFrom": {
18079
+ "name": "GenesisGridDatasourceElement",
18080
+ "module": "src/datasource/base.datasource.ts"
18081
+ }
18297
18082
  },
18298
18083
  {
18299
18084
  "kind": "field",
18300
- "name": "requestSupportsAdvancedSearch",
18085
+ "name": "viewNumber",
18301
18086
  "type": {
18302
- "text": "boolean"
18087
+ "text": "number"
18303
18088
  },
18304
- "privacy": "public",
18305
- "default": "false",
18306
- "description": "Tells whether a given request supports lookup by Groovy Expressions."
18089
+ "description": "The desired view/page you want data from.",
18090
+ "inheritedFrom": {
18091
+ "name": "GenesisGridDatasourceElement",
18092
+ "module": "src/datasource/base.datasource.ts"
18093
+ }
18307
18094
  },
18308
18095
  {
18309
18096
  "kind": "field",
18310
- "name": "valueKey",
18097
+ "name": "fields",
18311
18098
  "type": {
18312
18099
  "text": "string"
18313
18100
  },
18314
- "privacy": "public",
18315
- "description": "The key used as the value sent to the server"
18101
+ "description": "Optional parameter that allows you to select a subset of fields from the query if the client is not interested in receiving all of them.",
18102
+ "inheritedFrom": {
18103
+ "name": "GenesisGridDatasourceElement",
18104
+ "module": "src/datasource/base.datasource.ts"
18105
+ }
18316
18106
  },
18317
18107
  {
18318
18108
  "kind": "field",
18319
- "name": "labelKey",
18109
+ "name": "maxView",
18320
18110
  "type": {
18321
- "text": "string"
18111
+ "text": "number"
18322
18112
  },
18323
- "privacy": "public",
18324
- "description": "The key used as the label displayed in the UI"
18113
+ "description": "Maximum number of rows to track as part of a client \"view\".",
18114
+ "inheritedFrom": {
18115
+ "name": "GenesisGridDatasourceElement",
18116
+ "module": "src/datasource/base.datasource.ts"
18117
+ }
18325
18118
  },
18326
18119
  {
18327
18120
  "kind": "field",
18328
- "name": "dropdownPlacement",
18121
+ "name": "movingView",
18329
18122
  "type": {
18330
- "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
18123
+ "text": "boolean"
18331
18124
  },
18332
- "description": "Position of the dropdown panel relative to the control.\n- `'bottom-right'` – default; opens below and aligns to the right edge of the control\n- `'bottom-left'` – opens below and extends to the left\n- `'top-right'` – opens above and aligns to the right edge of the control\n- `'top-left'` – opens above and extends to the left"
18125
+ "default": "false",
18126
+ "description": "If true, when the maximum number of rows defined in max-view is reached, the Data Server will start discarding the oldest rows (in terms of timestamp) and sending newer rows.",
18127
+ "inheritedFrom": {
18128
+ "name": "GenesisGridDatasourceElement",
18129
+ "module": "src/datasource/base.datasource.ts"
18130
+ }
18333
18131
  },
18334
18132
  {
18335
18133
  "kind": "field",
18336
- "name": "dropdownWidth",
18134
+ "name": "reverse",
18337
18135
  "type": {
18338
- "text": "number"
18136
+ "text": "boolean"
18339
18137
  },
18340
- "privacy": "public",
18341
- "description": "Optionally specifies the width of the dropdown"
18138
+ "default": "false",
18139
+ "description": "Option that changes the Data Server index iteration.",
18140
+ "inheritedFrom": {
18141
+ "name": "GenesisGridDatasourceElement",
18142
+ "module": "src/datasource/base.datasource.ts"
18143
+ }
18342
18144
  },
18343
18145
  {
18344
18146
  "kind": "field",
18345
- "name": "request",
18147
+ "name": "disablePolling",
18346
18148
  "type": {
18347
- "text": "object"
18149
+ "text": "boolean"
18348
18150
  },
18349
- "privacy": "public",
18350
- "description": "A request object to pass in the reqrep"
18151
+ "default": "false",
18152
+ "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
18153
+ "inheritedFrom": {
18154
+ "name": "GenesisGridDatasourceElement",
18155
+ "module": "src/datasource/base.datasource.ts"
18156
+ }
18351
18157
  },
18352
18158
  {
18353
18159
  "kind": "field",
18354
- "name": "columnDefinitions",
18160
+ "name": "offset",
18355
18161
  "type": {
18356
- "text": "ColDef[]"
18162
+ "text": "number"
18357
18163
  },
18358
- "privacy": "public",
18359
- "description": "An array of AG Grid column definitions to use in the grid to display the data"
18164
+ "description": "The offset for pagination in REQUEST_SERVER scenarios.",
18165
+ "inheritedFrom": {
18166
+ "name": "GenesisGridDatasourceElement",
18167
+ "module": "src/datasource/base.datasource.ts"
18168
+ }
18360
18169
  },
18361
18170
  {
18362
18171
  "kind": "field",
18363
- "name": "baseCriteria",
18172
+ "name": "pollingInterval",
18364
18173
  "type": {
18365
- "text": "string | undefined"
18174
+ "text": "number"
18366
18175
  },
18367
- "privacy": "public",
18368
- "description": "Base criteria that is always applied to requests combined with search criteria via AND.\nUse this to pre-filter results."
18176
+ "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
18177
+ "inheritedFrom": {
18178
+ "name": "GenesisGridDatasourceElement",
18179
+ "module": "src/datasource/base.datasource.ts"
18180
+ }
18369
18181
  },
18370
18182
  {
18371
18183
  "kind": "field",
18372
- "name": "defaultSlottedNodes",
18184
+ "name": "pollTriggerEvents",
18373
18185
  "type": {
18374
- "text": "Node[]"
18186
+ "text": "string[]"
18375
18187
  },
18376
- "privacy": "public",
18377
- "default": "[]"
18188
+ "default": "[]",
18189
+ "description": "Array of event names that will trigger a poll when received as commit responses.",
18190
+ "inheritedFrom": {
18191
+ "name": "GenesisGridDatasourceElement",
18192
+ "module": "src/datasource/base.datasource.ts"
18193
+ }
18378
18194
  },
18379
18195
  {
18380
18196
  "kind": "field",
18381
- "name": "grid",
18197
+ "name": "request",
18382
18198
  "type": {
18383
- "text": "GridPro"
18199
+ "text": "any"
18384
18200
  },
18385
- "privacy": "public"
18201
+ "description": "Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.",
18202
+ "inheritedFrom": {
18203
+ "name": "GenesisGridDatasourceElement",
18204
+ "module": "src/datasource/base.datasource.ts"
18205
+ }
18386
18206
  },
18387
18207
  {
18388
18208
  "kind": "field",
18389
- "name": "_value",
18209
+ "name": "requestAutoSetup",
18390
18210
  "type": {
18391
- "text": "string"
18211
+ "text": "boolean"
18392
18212
  },
18393
- "privacy": "private"
18213
+ "default": "true",
18214
+ "description": "Attribute to set whether the REQUEST object should be automatically set up.",
18215
+ "inheritedFrom": {
18216
+ "name": "GenesisGridDatasourceElement",
18217
+ "module": "src/datasource/base.datasource.ts"
18218
+ }
18394
18219
  },
18395
18220
  {
18396
18221
  "kind": "field",
18397
- "name": "value",
18222
+ "name": "rowIdAttr",
18223
+ "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
18224
+ "inheritedFrom": {
18225
+ "name": "GenesisGridDatasourceElement",
18226
+ "module": "src/datasource/base.datasource.ts"
18227
+ }
18228
+ },
18229
+ {
18230
+ "kind": "field",
18231
+ "name": "restartOnReconnection",
18398
18232
  "type": {
18399
- "text": "string"
18233
+ "text": "boolean"
18234
+ },
18235
+ "default": "true",
18236
+ "description": "Attribute to set whether the datasource should restart when it reconnects.",
18237
+ "inheritedFrom": {
18238
+ "name": "GenesisGridDatasourceElement",
18239
+ "module": "src/datasource/base.datasource.ts"
18400
18240
  }
18401
18241
  },
18402
18242
  {
18403
18243
  "kind": "field",
18404
- "name": "filterSearch",
18244
+ "name": "defaultRowIdByResourceType",
18405
18245
  "type": {
18406
18246
  "text": "string"
18407
18247
  },
18408
- "privacy": "public",
18409
- "description": "The criteria to search by"
18248
+ "privacy": "protected",
18249
+ "readonly": true,
18250
+ "inheritedFrom": {
18251
+ "name": "GenesisGridDatasourceElement",
18252
+ "module": "src/datasource/base.datasource.ts"
18253
+ }
18410
18254
  },
18411
18255
  {
18412
18256
  "kind": "field",
18413
- "name": "open",
18257
+ "name": "criteriaFromFilters",
18414
18258
  "type": {
18415
- "text": "boolean"
18259
+ "text": "Map<string, string>"
18416
18260
  },
18417
- "privacy": "public",
18418
- "description": "Whether the dropdown is open or not"
18261
+ "privacy": "protected",
18262
+ "default": "new Map()",
18263
+ "inheritedFrom": {
18264
+ "name": "GenesisGridDatasourceElement",
18265
+ "module": "src/datasource/base.datasource.ts"
18266
+ }
18419
18267
  },
18420
18268
  {
18421
18269
  "kind": "field",
18422
- "name": "selectedRow",
18270
+ "name": "update",
18423
18271
  "type": {
18424
- "text": "object"
18272
+ "text": "BehaviorSubject<Map<string, string>>"
18425
18273
  },
18426
- "description": "Data for the selected row"
18274
+ "privacy": "protected",
18275
+ "default": "new BehaviorSubject(new Map())",
18276
+ "inheritedFrom": {
18277
+ "name": "GenesisGridDatasourceElement",
18278
+ "module": "src/datasource/base.datasource.ts"
18279
+ }
18427
18280
  },
18428
18281
  {
18429
- "kind": "field",
18430
- "name": "displayValue",
18431
- "description": "Value to display in the form field",
18432
- "readonly": true
18282
+ "kind": "method",
18283
+ "name": "datasourceOptions",
18284
+ "privacy": "protected",
18285
+ "return": {
18286
+ "type": {
18287
+ "text": "DatasourceOptions"
18288
+ }
18289
+ },
18290
+ "inheritedFrom": {
18291
+ "name": "GenesisGridDatasourceElement",
18292
+ "module": "src/datasource/base.datasource.ts"
18293
+ }
18433
18294
  },
18434
18295
  {
18435
- "kind": "field",
18436
- "name": "hasSearchKey",
18437
- "type": {
18438
- "text": "boolean"
18296
+ "kind": "method",
18297
+ "name": "buildCriteria",
18298
+ "privacy": "private",
18299
+ "return": {
18300
+ "type": {
18301
+ "text": "string"
18302
+ }
18439
18303
  },
18440
- "readonly": true
18304
+ "inheritedFrom": {
18305
+ "name": "GenesisGridDatasourceElement",
18306
+ "module": "src/datasource/base.datasource.ts"
18307
+ }
18441
18308
  },
18442
18309
  {
18443
18310
  "kind": "field",
18444
- "name": "hasSlottedContent",
18311
+ "name": "isRequestServer",
18445
18312
  "type": {
18446
18313
  "text": "boolean"
18447
18314
  },
18448
- "readonly": true
18315
+ "readonly": true,
18316
+ "inheritedFrom": {
18317
+ "name": "GenesisGridDatasourceElement",
18318
+ "module": "src/datasource/base.datasource.ts"
18319
+ }
18449
18320
  },
18450
18321
  {
18451
18322
  "kind": "method",
18452
- "name": "setGridRowData",
18453
- "privacy": "private",
18323
+ "name": "datasourceStatusChanged",
18454
18324
  "parameters": [
18455
18325
  {
18456
- "name": "rows",
18326
+ "name": "prev",
18457
18327
  "type": {
18458
- "text": "any[]"
18328
+ "text": "DatasourceStatus"
18459
18329
  }
18460
- }
18461
- ],
18462
- "description": "Sets row data on the grid in a version-safe way.\nAG Grid v32+ removed `setRowData` in favour of `updateGridOptions`."
18463
- },
18464
- {
18465
- "kind": "method",
18466
- "name": "setGridColumnDefs",
18467
- "privacy": "private",
18468
- "parameters": [
18330
+ },
18469
18331
  {
18470
- "name": "colDefs",
18332
+ "name": "next",
18471
18333
  "type": {
18472
- "text": "ColDef[]"
18334
+ "text": "DatasourceStatus"
18473
18335
  }
18474
18336
  }
18475
18337
  ],
18476
- "description": "Sets column defs on the grid in a version-safe way.\nAG Grid v32+ removed `setColumnDefs` in favour of `updateGridOptions`."
18338
+ "inheritedFrom": {
18339
+ "name": "GenesisGridDatasourceElement",
18340
+ "module": "src/datasource/base.datasource.ts"
18341
+ }
18477
18342
  },
18478
18343
  {
18479
18344
  "kind": "method",
18480
- "name": "emitValue",
18481
- "privacy": "private",
18345
+ "name": "handleErrors",
18482
18346
  "parameters": [
18483
18347
  {
18484
- "name": "value",
18348
+ "name": "errors",
18485
18349
  "type": {
18486
- "text": "string"
18487
- }
18350
+ "text": "string | any[]"
18351
+ },
18352
+ "description": "The error message or array of error messages"
18353
+ },
18354
+ {
18355
+ "name": "type",
18356
+ "default": "'unknown'",
18357
+ "type": {
18358
+ "text": "BaseDatasourceErrorEventDetail['type']"
18359
+ },
18360
+ "description": "The type of error that occurred"
18488
18361
  }
18489
18362
  ],
18490
- "description": "Emits 'change' and 'input' events so that the `sync` directive and forms work correctly."
18491
- },
18492
- {
18493
- "kind": "method",
18494
- "name": "toggle",
18495
- "privacy": "public"
18496
- },
18497
- {
18498
- "kind": "method",
18499
- "name": "getAndSetRows",
18500
- "privacy": "private"
18501
- },
18502
- {
18503
- "kind": "field",
18504
- "name": "getAndSetRowsDebounce",
18505
- "privacy": "private"
18506
- },
18507
- {
18508
- "kind": "method",
18509
- "name": "filterSearchChanged",
18510
- "privacy": "public"
18511
- },
18512
- {
18513
- "kind": "method",
18514
- "name": "requestChanged",
18515
- "privacy": "public"
18363
+ "description": "Handles errors and emits appropriate error events.",
18364
+ "privacy": "public",
18365
+ "inheritedFrom": {
18366
+ "name": "GenesisGridDatasourceElement",
18367
+ "module": "src/datasource/base.datasource.ts"
18368
+ }
18516
18369
  },
18517
18370
  {
18518
18371
  "kind": "method",
18519
- "name": "columnDefinitionsChanged",
18520
- "privacy": "public"
18372
+ "name": "clearErrors",
18373
+ "description": "Clears error state and emits connected event.",
18374
+ "privacy": "public",
18375
+ "inheritedFrom": {
18376
+ "name": "GenesisGridDatasourceElement",
18377
+ "module": "src/datasource/base.datasource.ts"
18378
+ }
18521
18379
  },
18522
18380
  {
18523
18381
  "kind": "field",
18524
- "name": "handleClickOutside",
18525
- "privacy": "private"
18526
- },
18527
- {
18528
- "kind": "method",
18529
- "name": "openChanged",
18530
- "privacy": "public"
18531
- },
18532
- {
18533
- "kind": "method",
18534
- "name": "dropdownWidthChanged",
18535
- "privacy": "public"
18382
+ "name": "_presentation",
18383
+ "type": {
18384
+ "text": "ComponentPresentation | null | undefined"
18385
+ },
18386
+ "privacy": "private",
18387
+ "default": "void 0",
18388
+ "inheritedFrom": {
18389
+ "name": "FoundationElement",
18390
+ "module": "src/foundation-element/foundation-element.ts"
18391
+ }
18536
18392
  },
18537
18393
  {
18538
- "kind": "method",
18539
- "name": "changeHandler",
18394
+ "kind": "field",
18395
+ "name": "$presentation",
18396
+ "type": {
18397
+ "text": "ComponentPresentation | null"
18398
+ },
18540
18399
  "privacy": "public",
18541
- "parameters": [
18542
- {
18543
- "name": "event",
18544
- "type": {
18545
- "text": "Event"
18546
- }
18547
- }
18548
- ]
18400
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
18401
+ "inheritedFrom": {
18402
+ "name": "FoundationElement",
18403
+ "module": "src/foundation-element/foundation-element.ts"
18404
+ }
18549
18405
  },
18550
18406
  {
18551
- "kind": "method",
18552
- "name": "cloneNode",
18553
- "return": {
18554
- "type": {
18555
- "text": "Node"
18556
- }
18407
+ "kind": "field",
18408
+ "name": "template",
18409
+ "type": {
18410
+ "text": "ElementViewTemplate | void | null"
18557
18411
  },
18558
- "parameters": [
18559
- {
18560
- "name": "deep",
18561
- "optional": true,
18562
- "type": {
18563
- "text": "boolean"
18564
- }
18565
- }
18566
- ],
18412
+ "privacy": "public",
18413
+ "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
18567
18414
  "inheritedFrom": {
18568
- "name": "LifecycleMixin",
18569
- "module": "src/mixins/lifecycle/lifecycle.ts"
18415
+ "name": "FoundationElement",
18416
+ "module": "src/foundation-element/foundation-element.ts"
18570
18417
  }
18571
18418
  },
18572
18419
  {
18573
18420
  "kind": "method",
18574
- "name": "deepClone",
18421
+ "name": "templateChanged",
18422
+ "privacy": "protected",
18575
18423
  "return": {
18576
18424
  "type": {
18577
- "text": "Node"
18425
+ "text": "void"
18578
18426
  }
18579
18427
  },
18580
18428
  "inheritedFrom": {
18581
- "name": "LifecycleMixin",
18582
- "module": "src/mixins/lifecycle/lifecycle.ts"
18429
+ "name": "FoundationElement",
18430
+ "module": "src/foundation-element/foundation-element.ts"
18583
18431
  }
18584
18432
  },
18585
18433
  {
18586
18434
  "kind": "field",
18587
- "name": "shouldRunDisconnect",
18588
- "return": {
18589
- "type": {
18590
- "text": ""
18591
- }
18435
+ "name": "styles",
18436
+ "type": {
18437
+ "text": "ElementStyles | void | null"
18592
18438
  },
18593
- "readonly": true,
18439
+ "privacy": "public",
18440
+ "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
18594
18441
  "inheritedFrom": {
18595
- "name": "LifecycleMixin",
18596
- "module": "src/mixins/lifecycle/lifecycle.ts"
18442
+ "name": "FoundationElement",
18443
+ "module": "src/foundation-element/foundation-element.ts"
18597
18444
  }
18598
18445
  },
18599
18446
  {
18600
- "kind": "field",
18601
- "name": "shouldRunConnect",
18447
+ "kind": "method",
18448
+ "name": "stylesChanged",
18449
+ "privacy": "protected",
18602
18450
  "return": {
18603
18451
  "type": {
18604
- "text": ""
18452
+ "text": "void"
18605
18453
  }
18606
18454
  },
18607
- "readonly": true,
18608
18455
  "inheritedFrom": {
18609
- "name": "LifecycleMixin",
18610
- "module": "src/mixins/lifecycle/lifecycle.ts"
18456
+ "name": "FoundationElement",
18457
+ "module": "src/foundation-element/foundation-element.ts"
18611
18458
  }
18612
18459
  },
18613
18460
  {
18614
18461
  "kind": "method",
18615
- "name": "#_blockLifecycleDueToTokenChange",
18462
+ "name": "compose",
18463
+ "privacy": "public",
18464
+ "static": true,
18616
18465
  "return": {
18617
18466
  "type": {
18618
- "text": "boolean"
18467
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
18619
18468
  }
18620
18469
  },
18621
18470
  "parameters": [
18622
18471
  {
18623
- "name": "lifecycleType",
18472
+ "name": "this",
18624
18473
  "type": {
18625
- "text": "Lifecycletype"
18474
+ "text": "K"
18626
18475
  }
18476
+ },
18477
+ {
18478
+ "name": "elementDefinition",
18479
+ "type": {
18480
+ "text": "T"
18481
+ },
18482
+ "description": "The definition of the element to create the registry\nfunction for."
18627
18483
  }
18628
18484
  ],
18485
+ "description": "Defines an element registry function with a set of element definition defaults.",
18629
18486
  "inheritedFrom": {
18630
- "name": "LifecycleMixin",
18631
- "module": "src/mixins/lifecycle/lifecycle.ts"
18487
+ "name": "FoundationElement",
18488
+ "module": "src/foundation-element/foundation-element.ts"
18489
+ }
18490
+ }
18491
+ ],
18492
+ "events": [
18493
+ {
18494
+ "description": "Fired when a datasource error is reported. detail: `BaseDatasourceErrorEventDetail`",
18495
+ "name": "base-datasource-error",
18496
+ "inheritedFrom": {
18497
+ "name": "GenesisGridDatasourceElement",
18498
+ "module": "src/datasource/base.datasource.ts"
18632
18499
  }
18633
18500
  },
18634
18501
  {
18635
- "kind": "field",
18636
- "name": "_presentation",
18502
+ "description": "Fired when a datasource error occurs (for grid integration). detail: `DatasourceErrorEventDetail`",
18503
+ "name": "datasource-error",
18504
+ "inheritedFrom": {
18505
+ "name": "GenesisGridDatasourceElement",
18506
+ "module": "src/datasource/base.datasource.ts"
18507
+ }
18508
+ },
18509
+ {
18510
+ "description": "Fired when error state is cleared after connection succeeds",
18511
+ "name": "base-datasource-connected",
18512
+ "inheritedFrom": {
18513
+ "name": "GenesisGridDatasourceElement",
18514
+ "module": "src/datasource/base.datasource.ts"
18515
+ }
18516
+ },
18517
+ {
18518
+ "description": "Fired when loading completes with no pending row changes",
18519
+ "name": "datasource-loading-finished",
18520
+ "inheritedFrom": {
18521
+ "name": "GenesisGridDatasourceElement",
18522
+ "module": "src/datasource/base.datasource.ts"
18523
+ }
18524
+ },
18525
+ {
18526
+ "description": "Fired when the grid has no rows after load",
18527
+ "name": "datasource-no-data-available",
18528
+ "inheritedFrom": {
18529
+ "name": "GenesisGridDatasourceElement",
18530
+ "module": "src/datasource/base.datasource.ts"
18531
+ }
18532
+ },
18533
+ {
18534
+ "description": "Fired when row data changes from stream updates. detail: `DataChangedEventDetail`",
18535
+ "name": "datasource-data-changed",
18536
+ "inheritedFrom": {
18537
+ "name": "GenesisGridDatasourceElement",
18538
+ "module": "src/datasource/base.datasource.ts"
18539
+ }
18540
+ },
18541
+ {
18542
+ "description": "Fired to hand off grid options and initialization flags. detail: `InitializeEventDetail`",
18543
+ "name": "datasource-initialize"
18544
+ },
18545
+ {
18546
+ "description": "Fired when the datasource is torn down",
18547
+ "name": "datasource-destroy"
18548
+ },
18549
+ {
18550
+ "description": "Fired when row data is cleared. detail: `DataClearedEventDetail`",
18551
+ "name": "datasource-data-cleared"
18552
+ },
18553
+ {
18554
+ "description": "Fired when column metadata or defs are updated. detail: `SchemaUpdatedEventDetail`",
18555
+ "name": "datasource-schema-updated"
18556
+ },
18557
+ {
18558
+ "description": "Fired when persisted filters are reapplied",
18559
+ "name": "datasource-filters-restored"
18560
+ },
18561
+ {
18562
+ "description": "Fired when a data payload is loaded for the grid. detail: `DataLoadedEventDetail`",
18563
+ "name": "datasource-data-loaded"
18564
+ },
18565
+ {
18566
+ "description": "Fired when a load or refresh starts",
18567
+ "name": "datasource-loading-started"
18568
+ },
18569
+ {
18570
+ "description": "Fired when more server rows can be requested. detail: `MoreDataAvailableEventDetail`",
18571
+ "name": "datasource-more-data-available"
18572
+ },
18573
+ {
18574
+ "description": "Fired when the host grid is ready to start loading data",
18575
+ "name": "datasource-ready"
18576
+ },
18577
+ {
18578
+ "description": "Fired when initial grid data is ready for the client-side model",
18579
+ "name": "datasource-init"
18580
+ },
18581
+ {
18582
+ "description": "Fired when MORE_ROWS availability changes. detail: `MoreRowsDetail`",
18583
+ "name": "more-rows-changed"
18584
+ },
18585
+ {
18586
+ "description": "Fired when layout or viewport sizing affects the datasource. detail: `GrigProGenesisDatasourceSizeChangedEventDetail`",
18587
+ "name": "datasource-size-changed"
18588
+ }
18589
+ ],
18590
+ "attributes": [
18591
+ {
18592
+ "name": "keep-col-defs-on-clear-row-data",
18637
18593
  "type": {
18638
- "text": "ComponentPresentation | null | undefined"
18594
+ "text": "boolean"
18639
18595
  },
18640
- "privacy": "private",
18641
- "default": "void 0",
18596
+ "default": "false",
18597
+ "fieldName": "keepColDefsOnClearRowData"
18598
+ },
18599
+ {
18600
+ "name": "request-visible-columns-only",
18601
+ "type": {
18602
+ "text": "boolean"
18603
+ },
18604
+ "default": "false",
18605
+ "description": "When enabled and column definitions are provided, the datasource requests data only for the\ncolumns that are currently visible. The visible set is seeded from the column config (columns\nnot flagged with `hide`) and updated by the host grid via `setVisibleColumns`; the data\nis reloaded whenever that set changes.",
18606
+ "fieldName": "requestVisibleColumnsOnly"
18607
+ },
18608
+ {
18609
+ "name": "criteria",
18610
+ "type": {
18611
+ "text": "string"
18612
+ },
18613
+ "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
18614
+ "fieldName": "criteria",
18642
18615
  "inheritedFrom": {
18643
- "name": "FoundationElement",
18644
- "module": "src/foundation-element/foundation-element.ts"
18616
+ "name": "GenesisGridDatasourceElement",
18617
+ "module": "src/datasource/base.datasource.ts"
18645
18618
  }
18646
18619
  },
18647
18620
  {
18648
- "kind": "field",
18649
- "name": "$presentation",
18621
+ "name": "is-snapshot",
18650
18622
  "type": {
18651
- "text": "ComponentPresentation | null"
18623
+ "text": "boolean"
18652
18624
  },
18653
- "privacy": "public",
18654
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
18625
+ "default": "false",
18626
+ "description": "Request a snapshot from the server.",
18627
+ "fieldName": "isSnapshot",
18655
18628
  "inheritedFrom": {
18656
- "name": "FoundationElement",
18657
- "module": "src/foundation-element/foundation-element.ts"
18629
+ "name": "GenesisGridDatasourceElement",
18630
+ "module": "src/datasource/base.datasource.ts"
18658
18631
  }
18659
18632
  },
18660
18633
  {
18661
- "kind": "field",
18662
- "name": "template",
18634
+ "name": "max-rows",
18663
18635
  "type": {
18664
- "text": "ElementViewTemplate | void | null"
18636
+ "text": "number"
18665
18637
  },
18666
- "privacy": "public",
18667
- "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
18638
+ "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
18639
+ "fieldName": "maxRows",
18668
18640
  "inheritedFrom": {
18669
- "name": "FoundationElement",
18670
- "module": "src/foundation-element/foundation-element.ts"
18641
+ "name": "GenesisGridDatasourceElement",
18642
+ "module": "src/datasource/base.datasource.ts"
18671
18643
  }
18672
18644
  },
18673
18645
  {
18674
- "kind": "method",
18675
- "name": "templateChanged",
18676
- "privacy": "protected",
18677
- "return": {
18678
- "type": {
18679
- "text": "void"
18680
- }
18646
+ "name": "order-by",
18647
+ "type": {
18648
+ "text": "string"
18681
18649
  },
18650
+ "description": "Option to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way.",
18651
+ "fieldName": "orderBy",
18682
18652
  "inheritedFrom": {
18683
- "name": "FoundationElement",
18684
- "module": "src/foundation-element/foundation-element.ts"
18653
+ "name": "GenesisGridDatasourceElement",
18654
+ "module": "src/datasource/base.datasource.ts"
18685
18655
  }
18686
18656
  },
18687
18657
  {
18688
- "kind": "field",
18689
- "name": "styles",
18658
+ "name": "resource-name",
18690
18659
  "type": {
18691
- "text": "ElementStyles | void | null"
18660
+ "text": "string"
18692
18661
  },
18693
- "privacy": "public",
18694
- "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
18662
+ "description": "The name of the target Data Server query or Request Server requestReply.",
18663
+ "fieldName": "resourceName",
18695
18664
  "inheritedFrom": {
18696
- "name": "FoundationElement",
18697
- "module": "src/foundation-element/foundation-element.ts"
18665
+ "name": "GenesisGridDatasourceElement",
18666
+ "module": "src/datasource/base.datasource.ts"
18698
18667
  }
18699
18668
  },
18700
18669
  {
18701
- "kind": "method",
18702
- "name": "stylesChanged",
18703
- "privacy": "protected",
18704
- "return": {
18705
- "type": {
18706
- "text": "void"
18707
- }
18670
+ "name": "view-number",
18671
+ "type": {
18672
+ "text": "number"
18708
18673
  },
18674
+ "description": "The desired view/page you want data from.",
18675
+ "fieldName": "viewNumber",
18709
18676
  "inheritedFrom": {
18710
- "name": "FoundationElement",
18711
- "module": "src/foundation-element/foundation-element.ts"
18677
+ "name": "GenesisGridDatasourceElement",
18678
+ "module": "src/datasource/base.datasource.ts"
18712
18679
  }
18713
18680
  },
18714
18681
  {
18715
- "kind": "method",
18716
- "name": "compose",
18717
- "privacy": "public",
18718
- "static": true,
18719
- "return": {
18720
- "type": {
18721
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
18722
- }
18682
+ "name": "fields",
18683
+ "type": {
18684
+ "text": "string"
18723
18685
  },
18724
- "parameters": [
18725
- {
18726
- "name": "this",
18727
- "type": {
18728
- "text": "K"
18729
- }
18730
- },
18731
- {
18732
- "name": "elementDefinition",
18733
- "type": {
18734
- "text": "T"
18735
- },
18736
- "description": "The definition of the element to create the registry\nfunction for."
18737
- }
18738
- ],
18739
- "description": "Defines an element registry function with a set of element definition defaults.",
18686
+ "description": "Optional parameter that allows you to select a subset of fields from the query if the client is not interested in receiving all of them.",
18687
+ "fieldName": "fields",
18740
18688
  "inheritedFrom": {
18741
- "name": "FoundationElement",
18742
- "module": "src/foundation-element/foundation-element.ts"
18689
+ "name": "GenesisGridDatasourceElement",
18690
+ "module": "src/datasource/base.datasource.ts"
18743
18691
  }
18744
- }
18745
- ],
18746
- "events": [
18747
- {
18748
- "description": "Fired when the selected value changes. detail: `string`",
18749
- "name": "change"
18750
18692
  },
18751
18693
  {
18752
- "description": "Fired when the value is updated (including programmatic changes). detail: `string`",
18753
- "name": "input"
18754
- }
18755
- ],
18756
- "attributes": [
18757
- {
18694
+ "name": "max-view",
18758
18695
  "type": {
18759
- "text": "boolean"
18696
+ "text": "number"
18760
18697
  },
18761
- "description": "Whether to disable control of the component",
18762
- "fieldName": "disabled"
18698
+ "description": "Maximum number of rows to track as part of a client \"view\".",
18699
+ "fieldName": "maxView",
18700
+ "inheritedFrom": {
18701
+ "name": "GenesisGridDatasourceElement",
18702
+ "module": "src/datasource/base.datasource.ts"
18703
+ }
18763
18704
  },
18764
18705
  {
18765
- "name": "resource-name",
18706
+ "name": "moving-view",
18766
18707
  "type": {
18767
- "text": "string"
18708
+ "text": "boolean"
18768
18709
  },
18769
- "description": "The name of the reqrep to get the options from",
18770
- "fieldName": "resourceName"
18710
+ "default": "false",
18711
+ "description": "If true, when the maximum number of rows defined in max-view is reached, the Data Server will start discarding the oldest rows (in terms of timestamp) and sending newer rows.",
18712
+ "fieldName": "movingView",
18713
+ "inheritedFrom": {
18714
+ "name": "GenesisGridDatasourceElement",
18715
+ "module": "src/datasource/base.datasource.ts"
18716
+ }
18771
18717
  },
18772
18718
  {
18773
- "name": "search-key",
18774
18719
  "type": {
18775
- "text": "string | string[] | undefined"
18720
+ "text": "number"
18776
18721
  },
18777
- "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\").",
18778
- "fieldName": "searchKey"
18722
+ "description": "Option that changes the Data Server index iteration.",
18723
+ "fieldName": "reverse",
18724
+ "default": "false",
18725
+ "inheritedFrom": {
18726
+ "name": "GenesisGridDatasourceElement",
18727
+ "module": "src/datasource/base.datasource.ts"
18728
+ }
18779
18729
  },
18780
18730
  {
18781
- "name": "advanced-search-req",
18731
+ "name": "disable-polling",
18782
18732
  "type": {
18783
18733
  "text": "boolean"
18784
18734
  },
18785
18735
  "default": "false",
18786
- "description": "Tells whether a given request supports lookup by Groovy Expressions.",
18787
- "fieldName": "requestSupportsAdvancedSearch"
18736
+ "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
18737
+ "fieldName": "disablePolling",
18738
+ "inheritedFrom": {
18739
+ "name": "GenesisGridDatasourceElement",
18740
+ "module": "src/datasource/base.datasource.ts"
18741
+ }
18788
18742
  },
18789
18743
  {
18790
- "name": "value-key",
18744
+ "name": "polling-interval",
18791
18745
  "type": {
18792
- "text": "string"
18746
+ "text": "number"
18793
18747
  },
18794
- "description": "The key used as the value sent to the server",
18795
- "fieldName": "valueKey"
18748
+ "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
18749
+ "fieldName": "pollingInterval",
18750
+ "inheritedFrom": {
18751
+ "name": "GenesisGridDatasourceElement",
18752
+ "module": "src/datasource/base.datasource.ts"
18753
+ }
18796
18754
  },
18797
18755
  {
18798
- "name": "label-key",
18756
+ "name": "request-auto-setup",
18799
18757
  "type": {
18800
- "text": "string"
18758
+ "text": "boolean"
18801
18759
  },
18802
- "description": "The key used as the label displayed in the UI",
18803
- "fieldName": "labelKey"
18760
+ "default": "true",
18761
+ "description": "Attribute to set whether the REQUEST object should be automatically set up.",
18762
+ "fieldName": "requestAutoSetup",
18763
+ "inheritedFrom": {
18764
+ "name": "GenesisGridDatasourceElement",
18765
+ "module": "src/datasource/base.datasource.ts"
18766
+ }
18804
18767
  },
18805
18768
  {
18806
- "name": "dropdown-placement",
18807
- "type": {
18808
- "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
18809
- },
18810
- "description": "Position of the dropdown panel relative to the control.\n- `'bottom-right'` – default; opens below and aligns to the right edge of the control\n- `'bottom-left'` – opens below and extends to the left\n- `'top-right'` – opens above and aligns to the right edge of the control\n- `'top-left'` – opens above and extends to the left",
18811
- "fieldName": "dropdownPlacement"
18769
+ "name": "row-id",
18770
+ "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
18771
+ "fieldName": "rowIdAttr",
18772
+ "inheritedFrom": {
18773
+ "name": "GenesisGridDatasourceElement",
18774
+ "module": "src/datasource/base.datasource.ts"
18775
+ }
18812
18776
  },
18813
18777
  {
18814
- "name": "dropdownWidth",
18778
+ "name": "restart-on-reconnection",
18815
18779
  "type": {
18816
- "text": "number"
18780
+ "text": "boolean"
18817
18781
  },
18818
- "description": "Optionally specifies the width of the dropdown",
18819
- "fieldName": "dropdownWidth"
18782
+ "default": "true",
18783
+ "description": "Attribute to set whether the datasource should restart when it reconnects.",
18784
+ "fieldName": "restartOnReconnection",
18785
+ "inheritedFrom": {
18786
+ "name": "GenesisGridDatasourceElement",
18787
+ "module": "src/datasource/base.datasource.ts"
18788
+ }
18820
18789
  }
18821
18790
  ],
18822
18791
  "mixins": [
@@ -18826,42 +18795,73 @@
18826
18795
  }
18827
18796
  ],
18828
18797
  "superclass": {
18829
- "name": "FoundationElement",
18830
- "package": "@microsoft/fast-foundation"
18798
+ "name": "GridProBaseDatasource",
18799
+ "module": "/src/datasource/base.datasource"
18831
18800
  },
18832
- "tagName": "%%prefix%%-multicolumn-dropdown",
18801
+ "tagName": "grid-pro-genesis-datasource",
18833
18802
  "customElement": true
18803
+ }
18804
+ ],
18805
+ "exports": [
18806
+ {
18807
+ "kind": "js",
18808
+ "name": "GridProGenesisDatasource",
18809
+ "declaration": {
18810
+ "name": "GridProGenesisDatasource",
18811
+ "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
18812
+ }
18834
18813
  },
18835
18814
  {
18836
- "kind": "variable",
18837
- "name": "foundationMulticolumnDropdown",
18838
- "description": "A function that returns a Multicolumn Dropdown registration for configuring the component with a DesignSystem.",
18839
- "privacy": "public"
18815
+ "kind": "custom-element-definition",
18816
+ "name": "grid-pro-genesis-datasource",
18817
+ "declaration": {
18818
+ "name": "GridProGenesisDatasource",
18819
+ "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
18820
+ }
18840
18821
  }
18841
- ],
18822
+ ]
18823
+ },
18824
+ {
18825
+ "kind": "javascript-module",
18826
+ "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
18827
+ "declarations": [],
18828
+ "exports": []
18829
+ },
18830
+ {
18831
+ "kind": "javascript-module",
18832
+ "path": "src/grid-pro-genesis-datasource/index.ts",
18833
+ "declarations": [],
18842
18834
  "exports": [
18843
18835
  {
18844
18836
  "kind": "js",
18845
- "name": "wasClickOutsideElement",
18837
+ "name": "*",
18846
18838
  "declaration": {
18847
- "name": "wasClickOutsideElement",
18848
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
18839
+ "name": "*",
18840
+ "package": "./datasource-events.types"
18849
18841
  }
18850
18842
  },
18851
18843
  {
18852
18844
  "kind": "js",
18853
- "name": "MulticolumnDropdown",
18845
+ "name": "*",
18854
18846
  "declaration": {
18855
- "name": "MulticolumnDropdown",
18856
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
18847
+ "name": "*",
18848
+ "package": "./grid-pro-genesis-datasource"
18857
18849
  }
18858
18850
  },
18859
18851
  {
18860
18852
  "kind": "js",
18861
- "name": "foundationMulticolumnDropdown",
18853
+ "name": "*",
18862
18854
  "declaration": {
18863
- "name": "foundationMulticolumnDropdown",
18864
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
18855
+ "name": "*",
18856
+ "package": "./grid-pro-genesis-datasource.config"
18857
+ }
18858
+ },
18859
+ {
18860
+ "kind": "js",
18861
+ "name": "*",
18862
+ "declaration": {
18863
+ "name": "*",
18864
+ "package": "./grid-pro-genesis-datasource.types"
18865
18865
  }
18866
18866
  }
18867
18867
  ]