@genesislcap/grid-pro 14.450.0 → 14.450.1-alpha-19ffad5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -16035,533 +16035,503 @@
16035
16035
  },
16036
16036
  {
16037
16037
  "kind": "javascript-module",
16038
- "path": "src/grid-pro-genesis-datasource/datasource-events.types.ts",
16038
+ "path": "src/multicolumn-dropdown/index.ts",
16039
+ "declarations": [],
16040
+ "exports": [
16041
+ {
16042
+ "kind": "js",
16043
+ "name": "*",
16044
+ "declaration": {
16045
+ "name": "*",
16046
+ "package": "./multicolumn-dropdown"
16047
+ }
16048
+ },
16049
+ {
16050
+ "kind": "js",
16051
+ "name": "*",
16052
+ "declaration": {
16053
+ "name": "*",
16054
+ "package": "./multicolumn-dropdown.styles"
16055
+ }
16056
+ },
16057
+ {
16058
+ "kind": "js",
16059
+ "name": "*",
16060
+ "declaration": {
16061
+ "name": "*",
16062
+ "package": "./multicolumn-dropdown.template"
16063
+ }
16064
+ }
16065
+ ]
16066
+ },
16067
+ {
16068
+ "kind": "javascript-module",
16069
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts",
16039
16070
  "declarations": [
16040
16071
  {
16041
16072
  "kind": "variable",
16042
- "name": "datasourceEventNames",
16073
+ "name": "dropdownWidthVar",
16043
16074
  "type": {
16044
- "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}"
16075
+ "text": "string"
16045
16076
  },
16046
- "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}",
16047
- "description": "Event names for datasource-grid communication\nThese represent datasource operations, not grid-specific actions"
16077
+ "default": "'--dropdown-width'",
16078
+ "description": "The CSS variable to use for specifying the dropdown's width"
16079
+ },
16080
+ {
16081
+ "kind": "variable",
16082
+ "name": "optionsClass",
16083
+ "type": {
16084
+ "text": "string"
16085
+ },
16086
+ "default": "'options'",
16087
+ "description": "The CSS class to use for the options element's class in the dropdown"
16088
+ },
16089
+ {
16090
+ "kind": "variable",
16091
+ "name": "DISPLAY_NONE_CLASS",
16092
+ "type": {
16093
+ "text": "string"
16094
+ },
16095
+ "default": "'dnone'",
16096
+ "description": "Class name used to hide elements with display:none"
16097
+ },
16098
+ {
16099
+ "kind": "variable",
16100
+ "name": "multicolumnDropdownStyles",
16101
+ "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`",
16102
+ "description": "Multicolumn Dropdown styles.",
16103
+ "privacy": "public"
16048
16104
  }
16049
16105
  ],
16050
16106
  "exports": [
16051
16107
  {
16052
16108
  "kind": "js",
16053
- "name": "datasourceEventNames",
16109
+ "name": "dropdownWidthVar",
16054
16110
  "declaration": {
16055
- "name": "datasourceEventNames",
16056
- "module": "src/grid-pro-genesis-datasource/datasource-events.types.ts"
16111
+ "name": "dropdownWidthVar",
16112
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
16113
+ }
16114
+ },
16115
+ {
16116
+ "kind": "js",
16117
+ "name": "optionsClass",
16118
+ "declaration": {
16119
+ "name": "optionsClass",
16120
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
16121
+ }
16122
+ },
16123
+ {
16124
+ "kind": "js",
16125
+ "name": "DISPLAY_NONE_CLASS",
16126
+ "declaration": {
16127
+ "name": "DISPLAY_NONE_CLASS",
16128
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
16129
+ }
16130
+ },
16131
+ {
16132
+ "kind": "js",
16133
+ "name": "multicolumnDropdownStyles",
16134
+ "declaration": {
16135
+ "name": "multicolumnDropdownStyles",
16136
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
16057
16137
  }
16058
16138
  }
16059
16139
  ]
16060
16140
  },
16061
16141
  {
16062
16142
  "kind": "javascript-module",
16063
- "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts",
16143
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts",
16064
16144
  "declarations": [
16065
16145
  {
16066
- "kind": "class",
16067
- "description": "The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.",
16068
- "name": "GridProGenesisDatasource",
16069
- "members": [
16146
+ "kind": "function",
16147
+ "name": "getMulticolumnDropdownTemplate",
16148
+ "parameters": [
16070
16149
  {
16071
- "kind": "field",
16072
- "name": "cachedRowArray",
16073
- "type": {
16074
- "text": "any[]"
16075
- },
16076
- "privacy": "private",
16077
- "default": "[]"
16078
- },
16150
+ "name": "designSystem",
16151
+ "default": "'foundation'",
16152
+ "description": "The design system prefix to use. Defaults to 'foundation'."
16153
+ }
16154
+ ],
16155
+ "description": "Get a Design System prefixed Multicolumn Dropdown template.",
16156
+ "return": {
16157
+ "type": {
16158
+ "text": ""
16159
+ }
16160
+ },
16161
+ "privacy": "public"
16162
+ },
16163
+ {
16164
+ "kind": "variable",
16165
+ "name": "multicolumnDropdownTemplate",
16166
+ "description": "The default Multicolumn Dropdown template using the 'foundation' design system prefix.",
16167
+ "privacy": "public"
16168
+ }
16169
+ ],
16170
+ "exports": [
16171
+ {
16172
+ "kind": "js",
16173
+ "name": "getMulticolumnDropdownTemplate",
16174
+ "declaration": {
16175
+ "name": "getMulticolumnDropdownTemplate",
16176
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
16177
+ }
16178
+ },
16179
+ {
16180
+ "kind": "js",
16181
+ "name": "multicolumnDropdownTemplate",
16182
+ "declaration": {
16183
+ "name": "multicolumnDropdownTemplate",
16184
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
16185
+ }
16186
+ }
16187
+ ]
16188
+ },
16189
+ {
16190
+ "kind": "javascript-module",
16191
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.ts",
16192
+ "declarations": [
16193
+ {
16194
+ "kind": "function",
16195
+ "name": "wasClickOutsideElement",
16196
+ "parameters": [
16079
16197
  {
16080
- "kind": "field",
16081
- "name": "transactionData",
16198
+ "name": "event",
16082
16199
  "type": {
16083
- "text": "TransactionData"
16084
- },
16085
- "privacy": "protected",
16086
- "default": "{\n add: [],\n remove: [],\n update: [],\n addIndex: 0,\n }",
16087
- "inheritedFrom": {
16088
- "name": "GridProBaseDatasource",
16089
- "module": "src/datasource/base.datasource.ts"
16200
+ "text": "MouseEvent"
16090
16201
  }
16091
16202
  },
16092
16203
  {
16093
- "kind": "method",
16094
- "name": "criteriaChanged",
16095
- "parameters": [
16096
- {
16097
- "name": "oldCriteria",
16098
- "type": {
16099
- "text": "string"
16100
- }
16101
- },
16102
- {
16103
- "name": "newCriteria",
16104
- "type": {
16105
- "text": "string"
16106
- }
16107
- }
16108
- ]
16109
- },
16110
- {
16111
- "kind": "method",
16112
- "name": "requestChanged",
16113
- "parameters": [
16114
- {
16115
- "name": "oldRequest",
16116
- "type": {
16117
- "text": "string"
16118
- }
16119
- },
16120
- {
16121
- "name": "newRequest",
16122
- "type": {
16123
- "text": "string"
16124
- }
16125
- }
16126
- ]
16127
- },
16128
- {
16129
- "kind": "method",
16130
- "name": "resourceNameChanged",
16131
- "parameters": [
16132
- {
16133
- "name": "oldValue",
16134
- "type": {
16135
- "text": "string"
16136
- }
16137
- },
16138
- {
16139
- "name": "newValue",
16140
- "type": {
16141
- "text": "string"
16142
- }
16143
- }
16144
- ]
16145
- },
16204
+ "name": "target",
16205
+ "type": {
16206
+ "text": "EventTarget"
16207
+ }
16208
+ }
16209
+ ],
16210
+ "description": "Checks if the given mouse event occurred outside the target element.",
16211
+ "privacy": "public"
16212
+ },
16213
+ {
16214
+ "kind": "class",
16215
+ "description": "",
16216
+ "name": "MulticolumnDropdown",
16217
+ "members": [
16146
16218
  {
16147
16219
  "kind": "field",
16148
- "name": "keepColDefsOnClearRowData",
16220
+ "name": "optionsElement",
16149
16221
  "type": {
16150
- "text": "boolean"
16151
- },
16152
- "privacy": "public",
16153
- "default": "false",
16154
- "inheritedFrom": {
16155
- "name": "GridProBaseDatasource",
16156
- "module": "src/datasource/base.datasource.ts"
16222
+ "text": "HTMLElement"
16157
16223
  }
16158
16224
  },
16159
16225
  {
16160
16226
  "kind": "field",
16161
- "name": "dataSub",
16227
+ "name": "lastRequest",
16162
16228
  "type": {
16163
- "text": "Subscription"
16229
+ "text": "object"
16164
16230
  },
16165
16231
  "privacy": "private"
16166
16232
  },
16167
16233
  {
16168
16234
  "kind": "field",
16169
- "name": "updateSub",
16235
+ "name": "connectOverride",
16170
16236
  "type": {
16171
- "text": "Subscription"
16237
+ "text": "Connect"
16172
16238
  },
16173
16239
  "privacy": "private"
16174
16240
  },
16175
16241
  {
16176
16242
  "kind": "field",
16177
- "name": "requiresFullRowDataAndColDefs",
16243
+ "name": "_connectDI",
16178
16244
  "type": {
16179
- "text": "boolean"
16245
+ "text": "Connect"
16180
16246
  },
16181
- "privacy": "private",
16182
- "default": "true"
16247
+ "privacy": "private"
16183
16248
  },
16184
16249
  {
16185
16250
  "kind": "field",
16186
- "name": "_lastMoreRows",
16251
+ "name": "connect",
16252
+ "type": {
16253
+ "text": "Connect"
16254
+ },
16255
+ "description": "The connect service - uses DI by default, but can be manually set for dynamic element creation"
16256
+ },
16257
+ {
16258
+ "kind": "field",
16259
+ "name": "disabled",
16187
16260
  "type": {
16188
16261
  "text": "boolean"
16189
16262
  },
16190
- "privacy": "private",
16191
- "default": "false"
16263
+ "privacy": "public",
16264
+ "description": "Whether to disable control of the component"
16192
16265
  },
16193
16266
  {
16194
16267
  "kind": "field",
16195
- "name": "_isMoreRowsResult",
16268
+ "name": "resourceName",
16269
+ "type": {
16270
+ "text": "string"
16271
+ },
16272
+ "privacy": "public",
16273
+ "description": "The name of the reqrep to get the options from"
16274
+ },
16275
+ {
16276
+ "kind": "field",
16277
+ "name": "searchKey",
16278
+ "type": {
16279
+ "text": "string | string[] | undefined"
16280
+ },
16281
+ "privacy": "public",
16282
+ "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\")."
16283
+ },
16284
+ {
16285
+ "kind": "field",
16286
+ "name": "requestSupportsAdvancedSearch",
16196
16287
  "type": {
16197
16288
  "text": "boolean"
16198
16289
  },
16199
- "privacy": "private",
16200
- "default": "false"
16290
+ "privacy": "public",
16291
+ "default": "false",
16292
+ "description": "Tells whether a given request supports lookup by Groovy Expressions."
16201
16293
  },
16202
16294
  {
16203
16295
  "kind": "field",
16204
- "name": "_sourceRef",
16296
+ "name": "valueKey",
16205
16297
  "type": {
16206
16298
  "text": "string"
16207
16299
  },
16208
- "privacy": "private"
16300
+ "privacy": "public",
16301
+ "description": "The key used as the value sent to the server"
16209
16302
  },
16210
16303
  {
16211
16304
  "kind": "field",
16212
- "name": "_nextOffset",
16305
+ "name": "labelKey",
16213
16306
  "type": {
16214
- "text": "number"
16307
+ "text": "string"
16215
16308
  },
16216
- "privacy": "private",
16217
- "default": "0"
16309
+ "privacy": "public",
16310
+ "description": "The key used as the label displayed in the UI"
16218
16311
  },
16219
16312
  {
16220
16313
  "kind": "field",
16221
- "name": "_loadMoreCount",
16314
+ "name": "dropdownPlacement",
16315
+ "type": {
16316
+ "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
16317
+ },
16318
+ "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"
16319
+ },
16320
+ {
16321
+ "kind": "field",
16322
+ "name": "dropdownWidth",
16222
16323
  "type": {
16223
16324
  "text": "number"
16224
16325
  },
16225
- "privacy": "private",
16226
- "default": "0"
16326
+ "privacy": "public",
16327
+ "description": "Optionally specifies the width of the dropdown"
16227
16328
  },
16228
16329
  {
16229
- "kind": "method",
16230
- "name": "deepClone",
16231
- "return": {
16232
- "type": {
16233
- "text": "Node"
16234
- }
16330
+ "kind": "field",
16331
+ "name": "request",
16332
+ "type": {
16333
+ "text": "object"
16235
16334
  },
16236
- "inheritedFrom": {
16237
- "name": "LifecycleMixin",
16238
- "module": "src/mixins/lifecycle/lifecycle.ts"
16239
- }
16335
+ "privacy": "public",
16336
+ "description": "A request object to pass in the reqrep"
16240
16337
  },
16241
16338
  {
16242
- "kind": "method",
16243
- "name": "colDefsDeepClone",
16244
- "privacy": "private",
16245
- "return": {
16246
- "type": {
16247
- "text": "ColDef[]"
16248
- }
16339
+ "kind": "field",
16340
+ "name": "columnDefinitions",
16341
+ "type": {
16342
+ "text": "ColDef[]"
16249
16343
  },
16250
- "parameters": [
16251
- {
16252
- "name": "key",
16253
- "type": {
16254
- "text": "string"
16255
- }
16256
- },
16257
- {
16258
- "name": "copy",
16259
- "type": {
16260
- "text": "any"
16261
- }
16262
- }
16263
- ]
16344
+ "privacy": "public",
16345
+ "description": "An array of AG Grid column definitions to use in the grid to display the data"
16264
16346
  },
16265
16347
  {
16266
- "kind": "method",
16267
- "name": "init",
16268
- "parameters": [
16269
- {
16270
- "name": "keepColDefsOnClearRowData",
16271
- "optional": true,
16272
- "type": {
16273
- "text": "boolean"
16274
- }
16275
- },
16276
- {
16277
- "description": "Optionally set the `gridOptions` up with column definitions",
16278
- "name": "columnDefinitions"
16279
- },
16280
- {
16281
- "description": "Optionally set the grid up with column state",
16282
- "name": "columnStates"
16283
- }
16284
- ],
16285
- "description": "Initializes the datasource.",
16286
- "privacy": "public"
16348
+ "kind": "field",
16349
+ "name": "baseCriteria",
16350
+ "type": {
16351
+ "text": "string | undefined"
16352
+ },
16353
+ "privacy": "public",
16354
+ "description": "Base criteria that is always applied to requests combined with search criteria via AND.\nUse this to pre-filter results."
16287
16355
  },
16288
16356
  {
16289
- "kind": "method",
16290
- "name": "destroy",
16291
- "description": "Destroys the datasource, resetting it to its initial state.",
16357
+ "kind": "field",
16358
+ "name": "defaultSlottedNodes",
16359
+ "type": {
16360
+ "text": "Node[]"
16361
+ },
16292
16362
  "privacy": "public",
16293
- "inheritedFrom": {
16294
- "name": "GridProBaseDatasource",
16295
- "module": "src/datasource/base.datasource.ts"
16296
- }
16363
+ "default": "[]"
16297
16364
  },
16298
16365
  {
16299
- "kind": "method",
16300
- "name": "deinit",
16301
- "description": "Deinitialises the datasource, resetting it to its initial state.",
16302
- "deprecated": "Use `destroy` instead",
16366
+ "kind": "field",
16367
+ "name": "grid",
16368
+ "type": {
16369
+ "text": "GridPro"
16370
+ },
16303
16371
  "privacy": "public"
16304
16372
  },
16305
16373
  {
16306
- "kind": "method",
16307
- "name": "reset",
16308
- "description": "Resets the datasource to its initial state.",
16309
- "privacy": "public",
16310
- "deprecated": "Use `destroy` instead"
16374
+ "kind": "field",
16375
+ "name": "_value",
16376
+ "type": {
16377
+ "text": "string"
16378
+ },
16379
+ "privacy": "private"
16311
16380
  },
16312
16381
  {
16313
- "kind": "method",
16314
- "name": "restart",
16315
- "description": "Restarts the datasource, uses `destroy` and `init` in sequence.",
16316
- "privacy": "public",
16317
- "inheritedFrom": {
16318
- "name": "GridProBaseDatasource",
16319
- "module": "src/datasource/base.datasource.ts"
16382
+ "kind": "field",
16383
+ "name": "value",
16384
+ "type": {
16385
+ "text": "string"
16320
16386
  }
16321
16387
  },
16322
16388
  {
16323
- "kind": "method",
16324
- "name": "refreshRows",
16325
- "description": "Force the grid to redispatch the current rows"
16389
+ "kind": "field",
16390
+ "name": "filterSearch",
16391
+ "type": {
16392
+ "text": "string"
16393
+ },
16394
+ "privacy": "public",
16395
+ "description": "The criteria to search by"
16326
16396
  },
16327
16397
  {
16328
- "kind": "method",
16329
- "name": "reloadResourceData",
16398
+ "kind": "field",
16399
+ "name": "open",
16400
+ "type": {
16401
+ "text": "boolean"
16402
+ },
16330
16403
  "privacy": "public",
16331
- "return": {
16332
- "type": {
16333
- "text": "Promise<void>"
16334
- }
16404
+ "description": "Whether the dropdown is open or not"
16405
+ },
16406
+ {
16407
+ "kind": "field",
16408
+ "name": "selectedRow",
16409
+ "type": {
16410
+ "text": "object"
16335
16411
  },
16336
- "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).",
16337
- "inheritedFrom": {
16338
- "name": "GridProBaseDatasource",
16339
- "module": "src/datasource/base.datasource.ts"
16340
- }
16412
+ "description": "Data for the selected row"
16413
+ },
16414
+ {
16415
+ "kind": "field",
16416
+ "name": "displayValue",
16417
+ "description": "Value to display in the form field",
16418
+ "readonly": true
16419
+ },
16420
+ {
16421
+ "kind": "field",
16422
+ "name": "hasSearchKey",
16423
+ "type": {
16424
+ "text": "boolean"
16425
+ },
16426
+ "readonly": true
16427
+ },
16428
+ {
16429
+ "kind": "field",
16430
+ "name": "hasSlottedContent",
16431
+ "type": {
16432
+ "text": "boolean"
16433
+ },
16434
+ "readonly": true
16341
16435
  },
16342
16436
  {
16343
16437
  "kind": "method",
16344
- "name": "handleSnapshot",
16438
+ "name": "setGridRowData",
16345
16439
  "privacy": "private",
16346
16440
  "parameters": [
16347
16441
  {
16348
- "name": "result"
16442
+ "name": "rows",
16443
+ "type": {
16444
+ "text": "any[]"
16445
+ }
16349
16446
  }
16350
- ]
16447
+ ],
16448
+ "description": "Sets row data on the grid in a version-safe way.\nAG Grid v32+ removed `setRowData` in favour of `updateGridOptions`."
16351
16449
  },
16352
16450
  {
16353
16451
  "kind": "method",
16354
- "name": "handleStreamResult",
16452
+ "name": "setGridColumnDefs",
16355
16453
  "privacy": "private",
16356
16454
  "parameters": [
16357
16455
  {
16358
- "name": "result",
16456
+ "name": "colDefs",
16359
16457
  "type": {
16360
- "text": "FilteredDataServerResult | RequestServerResult"
16458
+ "text": "ColDef[]"
16361
16459
  }
16362
16460
  }
16363
- ]
16461
+ ],
16462
+ "description": "Sets column defs on the grid in a version-safe way.\nAG Grid v32+ removed `setColumnDefs` in favour of `updateGridOptions`."
16364
16463
  },
16365
16464
  {
16366
16465
  "kind": "method",
16367
- "name": "updateLoadMoreStatus",
16466
+ "name": "emitValue",
16368
16467
  "privacy": "private",
16369
16468
  "parameters": [
16370
16469
  {
16371
- "name": "moreRows",
16372
- "type": {
16373
- "text": "boolean"
16374
- },
16375
- "description": "Whether more rows are available"
16376
- },
16377
- {
16378
- "name": "sourceRef",
16470
+ "name": "value",
16379
16471
  "type": {
16380
16472
  "text": "string"
16381
- },
16382
- "description": "The source reference"
16383
- },
16384
- {
16385
- "description": "The total number of rows",
16386
- "name": "rowsCount"
16473
+ }
16387
16474
  }
16388
16475
  ],
16389
- "description": "Updates the status bar based on more rows status"
16476
+ "description": "Emits 'change' and 'input' events so that the `sync` directive and forms work correctly."
16390
16477
  },
16391
16478
  {
16392
16479
  "kind": "method",
16393
- "name": "applyRequestServerData",
16394
- "privacy": "private",
16395
- "parameters": [
16396
- {
16397
- "name": "requestServerResult",
16398
- "type": {
16399
- "text": "RequestServerResult"
16400
- }
16401
- }
16402
- ]
16480
+ "name": "toggle",
16481
+ "privacy": "public"
16403
16482
  },
16404
16483
  {
16405
16484
  "kind": "method",
16406
- "name": "applyDataserverData",
16407
- "privacy": "private",
16408
- "parameters": [
16409
- {
16410
- "name": "dataServerResult",
16411
- "type": {
16412
- "text": "FilteredDataServerResult"
16413
- }
16414
- }
16415
- ]
16485
+ "name": "getAndSetRows",
16486
+ "privacy": "private"
16416
16487
  },
16417
16488
  {
16418
- "kind": "method",
16419
- "name": "getAgColumnDefs",
16420
- "privacy": "private",
16421
- "parameters": [
16422
- {
16423
- "name": "fieldsMetadata",
16424
- "type": {
16425
- "text": "FieldMetadata[]"
16426
- }
16427
- }
16428
- ]
16489
+ "kind": "field",
16490
+ "name": "getAndSetRowsDebounce",
16491
+ "privacy": "private"
16429
16492
  },
16430
16493
  {
16431
16494
  "kind": "method",
16432
- "name": "setFilter",
16433
- "privacy": "public",
16434
- "parameters": [
16435
- {
16436
- "name": "fieldName",
16437
- "type": {
16438
- "text": "string"
16439
- }
16440
- },
16441
- {
16442
- "name": "newFilter",
16443
- "type": {
16444
- "text": "string"
16445
- }
16446
- }
16447
- ],
16448
- "inheritedFrom": {
16449
- "name": "GenesisGridDatasourceElement",
16450
- "module": "src/datasource/base.datasource.ts"
16451
- }
16495
+ "name": "filterSearchChanged",
16496
+ "privacy": "public"
16452
16497
  },
16453
16498
  {
16454
16499
  "kind": "method",
16455
- "name": "removeFilter",
16456
- "privacy": "public",
16457
- "parameters": [
16458
- {
16459
- "name": "fieldName",
16460
- "type": {
16461
- "text": "string"
16462
- }
16463
- }
16464
- ],
16465
- "inheritedFrom": {
16466
- "name": "GenesisGridDatasourceElement",
16467
- "module": "src/datasource/base.datasource.ts"
16468
- }
16500
+ "name": "requestChanged",
16501
+ "privacy": "public"
16469
16502
  },
16470
16503
  {
16471
16504
  "kind": "method",
16472
- "name": "applyTransaction",
16473
- "privacy": "protected",
16474
- "return": {
16475
- "type": {
16476
- "text": "any"
16477
- }
16478
- },
16479
- "parameters": [
16480
- {
16481
- "name": "transaction",
16482
- "type": {
16483
- "text": "any"
16484
- }
16485
- }
16486
- ],
16487
- "inheritedFrom": {
16488
- "name": "GridProBaseDatasource",
16489
- "module": "src/datasource/base.datasource.ts"
16490
- }
16505
+ "name": "columnDefinitionsChanged",
16506
+ "privacy": "public"
16491
16507
  },
16492
16508
  {
16493
- "kind": "method",
16494
- "name": "handleSizeChanged",
16495
- "privacy": "private",
16496
- "parameters": [
16497
- {
16498
- "name": "oldSize",
16499
- "type": {
16500
- "text": "number"
16501
- }
16502
- },
16503
- {
16504
- "name": "newSize",
16505
- "type": {
16506
- "text": "number"
16507
- }
16508
- }
16509
- ]
16509
+ "kind": "field",
16510
+ "name": "handleClickOutside",
16511
+ "privacy": "private"
16510
16512
  },
16511
16513
  {
16512
16514
  "kind": "method",
16513
- "name": "handleStreamInserts",
16514
- "privacy": "protected",
16515
- "parameters": [
16516
- {
16517
- "name": "inserts",
16518
- "default": "[]"
16519
- }
16520
- ],
16521
- "inheritedFrom": {
16522
- "name": "GridProBaseDatasource",
16523
- "module": "src/datasource/base.datasource.ts"
16524
- }
16515
+ "name": "openChanged",
16516
+ "privacy": "public"
16525
16517
  },
16526
16518
  {
16527
16519
  "kind": "method",
16528
- "name": "handleStreamUpdates",
16529
- "privacy": "protected",
16530
- "parameters": [
16531
- {
16532
- "name": "updates",
16533
- "default": "[]"
16534
- }
16535
- ],
16536
- "inheritedFrom": {
16537
- "name": "GridProBaseDatasource",
16538
- "module": "src/datasource/base.datasource.ts"
16539
- }
16520
+ "name": "dropdownWidthChanged",
16521
+ "privacy": "public"
16540
16522
  },
16541
16523
  {
16542
16524
  "kind": "method",
16543
- "name": "handleStreamDeletes",
16544
- "privacy": "protected",
16525
+ "name": "changeHandler",
16526
+ "privacy": "public",
16545
16527
  "parameters": [
16546
16528
  {
16547
- "name": "deletes",
16548
- "default": "[]",
16549
- "description": "List of records to remove from the grid stream"
16529
+ "name": "event",
16530
+ "type": {
16531
+ "text": "Event"
16532
+ }
16550
16533
  }
16551
- ],
16552
- "description": "Handles stream deletes by removing records from the grid.",
16553
- "inheritedFrom": {
16554
- "name": "GridProBaseDatasource",
16555
- "module": "src/datasource/base.datasource.ts"
16556
- }
16557
- },
16558
- {
16559
- "kind": "method",
16560
- "name": "loadMore",
16561
- "inheritedFrom": {
16562
- "name": "GridProBaseDatasource",
16563
- "module": "src/datasource/base.datasource.ts"
16564
- }
16534
+ ]
16565
16535
  },
16566
16536
  {
16567
16537
  "kind": "method",
@@ -16585,6 +16555,19 @@
16585
16555
  "module": "src/mixins/lifecycle/lifecycle.ts"
16586
16556
  }
16587
16557
  },
16558
+ {
16559
+ "kind": "method",
16560
+ "name": "deepClone",
16561
+ "return": {
16562
+ "type": {
16563
+ "text": "Node"
16564
+ }
16565
+ },
16566
+ "inheritedFrom": {
16567
+ "name": "LifecycleMixin",
16568
+ "module": "src/mixins/lifecycle/lifecycle.ts"
16569
+ }
16570
+ },
16588
16571
  {
16589
16572
  "kind": "field",
16590
16573
  "name": "shouldRunDisconnect",
@@ -16636,1909 +16619,1895 @@
16636
16619
  },
16637
16620
  {
16638
16621
  "kind": "field",
16639
- "name": "dataSubWasLoggedOff",
16622
+ "name": "_presentation",
16640
16623
  "type": {
16641
- "text": "boolean"
16624
+ "text": "ComponentPresentation | null | undefined"
16642
16625
  },
16643
- "privacy": "protected",
16644
- "default": "false",
16626
+ "privacy": "private",
16627
+ "default": "void 0",
16645
16628
  "inheritedFrom": {
16646
- "name": "GridProBaseDatasource",
16647
- "module": "src/datasource/base.datasource.ts"
16629
+ "name": "FoundationElement",
16630
+ "module": "src/foundation-element/foundation-element.ts"
16648
16631
  }
16649
16632
  },
16650
16633
  {
16651
16634
  "kind": "field",
16652
- "name": "rowData",
16635
+ "name": "$presentation",
16653
16636
  "type": {
16654
- "text": "Map<string, any>"
16637
+ "text": "ComponentPresentation | null"
16655
16638
  },
16656
- "default": "new Map()",
16639
+ "privacy": "public",
16640
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
16657
16641
  "inheritedFrom": {
16658
- "name": "GridProBaseDatasource",
16659
- "module": "src/datasource/base.datasource.ts"
16642
+ "name": "FoundationElement",
16643
+ "module": "src/foundation-element/foundation-element.ts"
16660
16644
  }
16661
16645
  },
16662
16646
  {
16663
16647
  "kind": "field",
16664
- "name": "connectionSub",
16648
+ "name": "template",
16665
16649
  "type": {
16666
- "text": "Subscription | undefined"
16650
+ "text": "ElementViewTemplate | void | null"
16667
16651
  },
16668
- "privacy": "protected",
16652
+ "privacy": "public",
16653
+ "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.",
16669
16654
  "inheritedFrom": {
16670
- "name": "GridProBaseDatasource",
16671
- "module": "src/datasource/base.datasource.ts"
16655
+ "name": "FoundationElement",
16656
+ "module": "src/foundation-element/foundation-element.ts"
16672
16657
  }
16673
16658
  },
16674
16659
  {
16675
16660
  "kind": "method",
16676
- "name": "subscribeToConnection",
16661
+ "name": "templateChanged",
16677
16662
  "privacy": "protected",
16663
+ "return": {
16664
+ "type": {
16665
+ "text": "void"
16666
+ }
16667
+ },
16678
16668
  "inheritedFrom": {
16679
- "name": "GridProBaseDatasource",
16680
- "module": "src/datasource/base.datasource.ts"
16681
- }
16682
- },
16683
- {
16684
- "kind": "method",
16685
- "name": "unsubscribeFromConnection",
16686
- "privacy": "protected",
16687
- "inheritedFrom": {
16688
- "name": "GridProBaseDatasource",
16689
- "module": "src/datasource/base.datasource.ts"
16690
- }
16691
- },
16692
- {
16693
- "kind": "method",
16694
- "name": "generateColumnDefsFromMetadata",
16695
- "privacy": "protected",
16696
- "return": {
16697
- "type": {
16698
- "text": "ColDef[]"
16699
- }
16700
- },
16701
- "parameters": [
16702
- {
16703
- "name": "fieldsMetadata",
16704
- "type": {
16705
- "text": "FieldMetadata[]"
16706
- }
16707
- },
16708
- {
16709
- "name": "getFilterParamsByFieldType",
16710
- "type": {
16711
- "text": "(field: FieldMetadata) => ColDef['filterParams'] | any"
16712
- }
16713
- },
16714
- {
16715
- "name": "getFilterByFieldType",
16716
- "type": {
16717
- "text": "(type: FieldTypeEnum) => string"
16718
- }
16719
- }
16720
- ],
16721
- "inheritedFrom": {
16722
- "name": "GridProBaseDatasource",
16723
- "module": "src/datasource/base.datasource.ts"
16724
- }
16725
- },
16726
- {
16727
- "kind": "method",
16728
- "name": "applyAllTransactions",
16729
- "privacy": "protected",
16730
- "inheritedFrom": {
16731
- "name": "GridProBaseDatasource",
16732
- "module": "src/datasource/base.datasource.ts"
16733
- }
16734
- },
16735
- {
16736
- "kind": "method",
16737
- "name": "applyMappedTransaction",
16738
- "privacy": "private",
16739
- "parameters": [
16740
- {
16741
- "name": "transaction",
16742
- "type": {
16743
- "text": "TransactionData"
16744
- }
16745
- },
16746
- {
16747
- "name": "operation",
16748
- "type": {
16749
- "text": "OperationType"
16750
- }
16751
- }
16752
- ],
16753
- "inheritedFrom": {
16754
- "name": "GridProBaseDatasource",
16755
- "module": "src/datasource/base.datasource.ts"
16756
- }
16757
- },
16758
- {
16759
- "kind": "method",
16760
- "name": "mapTransaction",
16761
- "privacy": "private",
16762
- "parameters": [
16763
- {
16764
- "name": "transaction",
16765
- "type": {
16766
- "text": "TransactionData"
16767
- },
16768
- "description": "The transaction data to be mapped."
16769
- },
16770
- {
16771
- "name": "operations",
16772
- "default": "Object.values(OperationType)",
16773
- "type": {
16774
- "text": "OperationType[]"
16775
- },
16776
- "description": "The operations to be mapped. Can be 'add', 'update' or 'remove'."
16777
- }
16778
- ],
16779
- "description": "Maps the transaction data to the row data mapper function, if it exists.",
16780
- "return": {
16781
- "type": {
16782
- "text": ""
16783
- }
16784
- },
16785
- "inheritedFrom": {
16786
- "name": "GridProBaseDatasource",
16787
- "module": "src/datasource/base.datasource.ts"
16788
- }
16789
- },
16790
- {
16791
- "kind": "field",
16792
- "name": "pagination",
16793
- "type": {
16794
- "text": "boolean"
16795
- },
16796
- "privacy": "protected",
16797
- "inheritedFrom": {
16798
- "name": "GridProBaseDatasource",
16799
- "module": "src/datasource/base.datasource.ts"
16669
+ "name": "FoundationElement",
16670
+ "module": "src/foundation-element/foundation-element.ts"
16800
16671
  }
16801
16672
  },
16802
16673
  {
16803
16674
  "kind": "field",
16804
- "name": "_isDisconnected",
16675
+ "name": "styles",
16805
16676
  "type": {
16806
- "text": "boolean"
16677
+ "text": "ElementStyles | void | null"
16807
16678
  },
16808
- "privacy": "private",
16809
- "default": "false",
16810
- "inheritedFrom": {
16811
- "name": "GridProBaseDatasource",
16812
- "module": "src/datasource/base.datasource.ts"
16813
- }
16814
- },
16815
- {
16816
- "kind": "method",
16817
- "name": "setDisconnected",
16818
16679
  "privacy": "public",
16819
- "parameters": [
16820
- {
16821
- "name": "disconnected",
16822
- "type": {
16823
- "text": "boolean"
16824
- },
16825
- "description": "true to set, false to remove"
16826
- }
16827
- ],
16828
- "description": "Sets the disconnected state and emits appropriate events.",
16680
+ "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.",
16829
16681
  "inheritedFrom": {
16830
- "name": "GridProBaseDatasource",
16831
- "module": "src/datasource/base.datasource.ts"
16682
+ "name": "FoundationElement",
16683
+ "module": "src/foundation-element/foundation-element.ts"
16832
16684
  }
16833
16685
  },
16834
16686
  {
16835
16687
  "kind": "method",
16836
- "name": "isDisconnected",
16837
- "privacy": "public",
16688
+ "name": "stylesChanged",
16689
+ "privacy": "protected",
16838
16690
  "return": {
16839
16691
  "type": {
16840
- "text": "boolean"
16692
+ "text": "void"
16841
16693
  }
16842
16694
  },
16843
- "description": "Returns true if the datasource is disconnected.",
16844
16695
  "inheritedFrom": {
16845
- "name": "GridProBaseDatasource",
16846
- "module": "src/datasource/base.datasource.ts"
16696
+ "name": "FoundationElement",
16697
+ "module": "src/foundation-element/foundation-element.ts"
16847
16698
  }
16848
16699
  },
16849
16700
  {
16850
16701
  "kind": "method",
16851
- "name": "getDatasourceStatusBarPanels",
16702
+ "name": "compose",
16852
16703
  "privacy": "public",
16704
+ "static": true,
16853
16705
  "return": {
16854
16706
  "type": {
16855
- "text": "any[]"
16707
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
16856
16708
  }
16857
16709
  },
16858
16710
  "parameters": [
16859
16711
  {
16860
- "name": "isServerSide",
16712
+ "name": "this",
16861
16713
  "type": {
16862
- "text": "boolean"
16714
+ "text": "K"
16863
16715
  }
16864
16716
  },
16865
16717
  {
16866
- "name": "statusBarConfig",
16718
+ "name": "elementDefinition",
16867
16719
  "type": {
16868
- "text": "any"
16869
- }
16720
+ "text": "T"
16721
+ },
16722
+ "description": "The definition of the element to create the registry\nfunction for."
16870
16723
  }
16871
16724
  ],
16872
- "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.",
16725
+ "description": "Defines an element registry function with a set of element definition defaults.",
16873
16726
  "inheritedFrom": {
16874
- "name": "GridProBaseDatasource",
16875
- "module": "src/datasource/base.datasource.ts"
16727
+ "name": "FoundationElement",
16728
+ "module": "src/foundation-element/foundation-element.ts"
16876
16729
  }
16730
+ }
16731
+ ],
16732
+ "events": [
16733
+ {
16734
+ "description": "Fired when the selected value changes",
16735
+ "name": "change"
16877
16736
  },
16878
16737
  {
16879
- "kind": "field",
16880
- "name": "connect",
16738
+ "description": "Fired when the value is updated (including programmatic changes)",
16739
+ "name": "input"
16740
+ }
16741
+ ],
16742
+ "attributes": [
16743
+ {
16881
16744
  "type": {
16882
- "text": "Connect"
16745
+ "text": "boolean"
16883
16746
  },
16884
- "inheritedFrom": {
16885
- "name": "GenesisGridDatasourceElement",
16886
- "module": "src/datasource/base.datasource.ts"
16887
- }
16747
+ "description": "Whether to disable control of the component",
16748
+ "fieldName": "disabled"
16888
16749
  },
16889
16750
  {
16890
- "kind": "field",
16891
- "name": "datasource",
16751
+ "name": "resource-name",
16892
16752
  "type": {
16893
- "text": "Datasource"
16753
+ "text": "string"
16894
16754
  },
16895
- "inheritedFrom": {
16896
- "name": "GenesisGridDatasourceElement",
16897
- "module": "src/datasource/base.datasource.ts"
16898
- }
16755
+ "description": "The name of the reqrep to get the options from",
16756
+ "fieldName": "resourceName"
16899
16757
  },
16900
16758
  {
16901
- "kind": "field",
16902
- "name": "deferredGridOptions",
16759
+ "name": "search-key",
16903
16760
  "type": {
16904
- "text": "GridOptions"
16761
+ "text": "string | string[] | undefined"
16905
16762
  },
16906
- "inheritedFrom": {
16907
- "name": "GenesisGridDatasourceElement",
16908
- "module": "src/datasource/base.datasource.ts"
16909
- }
16763
+ "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\").",
16764
+ "fieldName": "searchKey"
16910
16765
  },
16911
16766
  {
16912
- "kind": "field",
16913
- "name": "deferredColumnStates",
16767
+ "name": "advanced-search-req",
16914
16768
  "type": {
16915
- "text": "ColumnState[]"
16769
+ "text": "boolean"
16916
16770
  },
16917
- "inheritedFrom": {
16918
- "name": "GenesisGridDatasourceElement",
16919
- "module": "src/datasource/base.datasource.ts"
16920
- }
16771
+ "default": "false",
16772
+ "description": "Tells whether a given request supports lookup by Groovy Expressions.",
16773
+ "fieldName": "requestSupportsAdvancedSearch"
16921
16774
  },
16922
16775
  {
16923
- "kind": "field",
16924
- "name": "rowDataMapper",
16776
+ "name": "value-key",
16925
16777
  "type": {
16926
- "text": "Function"
16778
+ "text": "string"
16927
16779
  },
16928
- "description": "Allows grid data updates to be processed via and external function before applying in grid",
16929
- "inheritedFrom": {
16930
- "name": "GenesisGridDatasourceElement",
16931
- "module": "src/datasource/base.datasource.ts"
16932
- }
16780
+ "description": "The key used as the value sent to the server",
16781
+ "fieldName": "valueKey"
16933
16782
  },
16934
16783
  {
16935
- "kind": "field",
16936
- "name": "criteria",
16784
+ "name": "label-key",
16937
16785
  "type": {
16938
16786
  "text": "string"
16939
16787
  },
16940
- "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
16941
- "inheritedFrom": {
16942
- "name": "GenesisGridDatasourceElement",
16943
- "module": "src/datasource/base.datasource.ts"
16944
- }
16788
+ "description": "The key used as the label displayed in the UI",
16789
+ "fieldName": "labelKey"
16945
16790
  },
16946
16791
  {
16947
- "kind": "field",
16948
- "name": "isSnapshot",
16792
+ "name": "dropdown-placement",
16949
16793
  "type": {
16950
- "text": "boolean"
16794
+ "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
16951
16795
  },
16952
- "default": "false",
16953
- "description": "Request a snapshot from the server.",
16954
- "inheritedFrom": {
16955
- "name": "GenesisGridDatasourceElement",
16956
- "module": "src/datasource/base.datasource.ts"
16957
- }
16796
+ "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",
16797
+ "fieldName": "dropdownPlacement"
16958
16798
  },
16959
16799
  {
16960
- "kind": "field",
16961
- "name": "maxRows",
16800
+ "name": "dropdownWidth",
16962
16801
  "type": {
16963
16802
  "text": "number"
16964
16803
  },
16965
- "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
16966
- "inheritedFrom": {
16967
- "name": "GenesisGridDatasourceElement",
16968
- "module": "src/datasource/base.datasource.ts"
16969
- }
16970
- },
16804
+ "description": "Optionally specifies the width of the dropdown",
16805
+ "fieldName": "dropdownWidth"
16806
+ }
16807
+ ],
16808
+ "mixins": [
16809
+ {
16810
+ "name": "LifecycleMixin",
16811
+ "package": "@genesislcap/foundation-utils"
16812
+ }
16813
+ ],
16814
+ "superclass": {
16815
+ "name": "FoundationElement",
16816
+ "package": "@microsoft/fast-foundation"
16817
+ },
16818
+ "tagName": "%%prefix%%-multicolumn-dropdown",
16819
+ "customElement": true
16820
+ },
16821
+ {
16822
+ "kind": "variable",
16823
+ "name": "foundationMulticolumnDropdown",
16824
+ "description": "A function that returns a Multicolumn Dropdown registration for configuring the component with a DesignSystem.",
16825
+ "privacy": "public"
16826
+ }
16827
+ ],
16828
+ "exports": [
16829
+ {
16830
+ "kind": "js",
16831
+ "name": "wasClickOutsideElement",
16832
+ "declaration": {
16833
+ "name": "wasClickOutsideElement",
16834
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
16835
+ }
16836
+ },
16837
+ {
16838
+ "kind": "js",
16839
+ "name": "MulticolumnDropdown",
16840
+ "declaration": {
16841
+ "name": "MulticolumnDropdown",
16842
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
16843
+ }
16844
+ },
16845
+ {
16846
+ "kind": "js",
16847
+ "name": "foundationMulticolumnDropdown",
16848
+ "declaration": {
16849
+ "name": "foundationMulticolumnDropdown",
16850
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
16851
+ }
16852
+ }
16853
+ ]
16854
+ },
16855
+ {
16856
+ "kind": "javascript-module",
16857
+ "path": "src/grid-pro-genesis-datasource/datasource-events.types.ts",
16858
+ "declarations": [
16859
+ {
16860
+ "kind": "variable",
16861
+ "name": "datasourceEventNames",
16862
+ "type": {
16863
+ "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}"
16864
+ },
16865
+ "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}",
16866
+ "description": "Event names for datasource-grid communication\nThese represent datasource operations, not grid-specific actions"
16867
+ }
16868
+ ],
16869
+ "exports": [
16870
+ {
16871
+ "kind": "js",
16872
+ "name": "datasourceEventNames",
16873
+ "declaration": {
16874
+ "name": "datasourceEventNames",
16875
+ "module": "src/grid-pro-genesis-datasource/datasource-events.types.ts"
16876
+ }
16877
+ }
16878
+ ]
16879
+ },
16880
+ {
16881
+ "kind": "javascript-module",
16882
+ "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts",
16883
+ "declarations": [
16884
+ {
16885
+ "kind": "class",
16886
+ "description": "The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.",
16887
+ "name": "GridProGenesisDatasource",
16888
+ "members": [
16971
16889
  {
16972
16890
  "kind": "field",
16973
- "name": "orderBy",
16891
+ "name": "cachedRowArray",
16974
16892
  "type": {
16975
- "text": "string"
16893
+ "text": "any[]"
16976
16894
  },
16977
- "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.",
16978
- "inheritedFrom": {
16979
- "name": "GenesisGridDatasourceElement",
16980
- "module": "src/datasource/base.datasource.ts"
16981
- }
16895
+ "privacy": "private",
16896
+ "default": "[]"
16982
16897
  },
16983
16898
  {
16984
16899
  "kind": "field",
16985
- "name": "resourceName",
16900
+ "name": "transactionData",
16986
16901
  "type": {
16987
- "text": "string"
16902
+ "text": "TransactionData"
16988
16903
  },
16989
- "description": "The name of the target Data Server query or Request Server requestReply.",
16904
+ "privacy": "protected",
16905
+ "default": "{\n add: [],\n remove: [],\n update: [],\n addIndex: 0,\n }",
16990
16906
  "inheritedFrom": {
16991
- "name": "GenesisGridDatasourceElement",
16907
+ "name": "GridProBaseDatasource",
16992
16908
  "module": "src/datasource/base.datasource.ts"
16993
16909
  }
16994
16910
  },
16911
+ {
16912
+ "kind": "method",
16913
+ "name": "criteriaChanged",
16914
+ "parameters": [
16915
+ {
16916
+ "name": "oldCriteria",
16917
+ "type": {
16918
+ "text": "string"
16919
+ }
16920
+ },
16921
+ {
16922
+ "name": "newCriteria",
16923
+ "type": {
16924
+ "text": "string"
16925
+ }
16926
+ }
16927
+ ]
16928
+ },
16929
+ {
16930
+ "kind": "method",
16931
+ "name": "requestChanged",
16932
+ "parameters": [
16933
+ {
16934
+ "name": "oldRequest",
16935
+ "type": {
16936
+ "text": "string"
16937
+ }
16938
+ },
16939
+ {
16940
+ "name": "newRequest",
16941
+ "type": {
16942
+ "text": "string"
16943
+ }
16944
+ }
16945
+ ]
16946
+ },
16947
+ {
16948
+ "kind": "method",
16949
+ "name": "resourceNameChanged",
16950
+ "parameters": [
16951
+ {
16952
+ "name": "oldValue",
16953
+ "type": {
16954
+ "text": "string"
16955
+ }
16956
+ },
16957
+ {
16958
+ "name": "newValue",
16959
+ "type": {
16960
+ "text": "string"
16961
+ }
16962
+ }
16963
+ ]
16964
+ },
16995
16965
  {
16996
16966
  "kind": "field",
16997
- "name": "viewNumber",
16967
+ "name": "keepColDefsOnClearRowData",
16998
16968
  "type": {
16999
- "text": "number"
16969
+ "text": "boolean"
17000
16970
  },
17001
- "description": "The desired view/page you want data from.",
16971
+ "privacy": "public",
16972
+ "default": "false",
17002
16973
  "inheritedFrom": {
17003
- "name": "GenesisGridDatasourceElement",
16974
+ "name": "GridProBaseDatasource",
17004
16975
  "module": "src/datasource/base.datasource.ts"
17005
16976
  }
17006
16977
  },
17007
16978
  {
17008
16979
  "kind": "field",
17009
- "name": "fields",
16980
+ "name": "dataSub",
17010
16981
  "type": {
17011
- "text": "string"
16982
+ "text": "Subscription"
17012
16983
  },
17013
- "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.",
17014
- "inheritedFrom": {
17015
- "name": "GenesisGridDatasourceElement",
17016
- "module": "src/datasource/base.datasource.ts"
17017
- }
16984
+ "privacy": "private"
17018
16985
  },
17019
16986
  {
17020
16987
  "kind": "field",
17021
- "name": "maxView",
16988
+ "name": "updateSub",
17022
16989
  "type": {
17023
- "text": "number"
16990
+ "text": "Subscription"
17024
16991
  },
17025
- "description": "Maximum number of rows to track as part of a client \"view\".",
17026
- "inheritedFrom": {
17027
- "name": "GenesisGridDatasourceElement",
17028
- "module": "src/datasource/base.datasource.ts"
17029
- }
16992
+ "privacy": "private"
17030
16993
  },
17031
16994
  {
17032
16995
  "kind": "field",
17033
- "name": "movingView",
16996
+ "name": "requiresFullRowDataAndColDefs",
17034
16997
  "type": {
17035
16998
  "text": "boolean"
17036
16999
  },
17037
- "default": "false",
17038
- "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.",
17039
- "inheritedFrom": {
17040
- "name": "GenesisGridDatasourceElement",
17041
- "module": "src/datasource/base.datasource.ts"
17042
- }
17000
+ "privacy": "private",
17001
+ "default": "true"
17043
17002
  },
17044
17003
  {
17045
17004
  "kind": "field",
17046
- "name": "reverse",
17005
+ "name": "_lastMoreRows",
17047
17006
  "type": {
17048
17007
  "text": "boolean"
17049
17008
  },
17050
- "default": "false",
17051
- "description": "Option that changes the Data Server index iteration.",
17052
- "inheritedFrom": {
17053
- "name": "GenesisGridDatasourceElement",
17054
- "module": "src/datasource/base.datasource.ts"
17055
- }
17009
+ "privacy": "private",
17010
+ "default": "false"
17056
17011
  },
17057
17012
  {
17058
17013
  "kind": "field",
17059
- "name": "disablePolling",
17014
+ "name": "_isMoreRowsResult",
17060
17015
  "type": {
17061
17016
  "text": "boolean"
17062
17017
  },
17063
- "default": "false",
17064
- "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
17065
- "inheritedFrom": {
17066
- "name": "GenesisGridDatasourceElement",
17067
- "module": "src/datasource/base.datasource.ts"
17068
- }
17018
+ "privacy": "private",
17019
+ "default": "false"
17069
17020
  },
17070
17021
  {
17071
17022
  "kind": "field",
17072
- "name": "offset",
17023
+ "name": "_sourceRef",
17073
17024
  "type": {
17074
- "text": "number"
17025
+ "text": "string"
17075
17026
  },
17076
- "description": "The offset for pagination in REQUEST_SERVER scenarios.",
17077
- "inheritedFrom": {
17078
- "name": "GenesisGridDatasourceElement",
17079
- "module": "src/datasource/base.datasource.ts"
17080
- }
17027
+ "privacy": "private"
17081
17028
  },
17082
17029
  {
17083
17030
  "kind": "field",
17084
- "name": "pollingInterval",
17031
+ "name": "_nextOffset",
17085
17032
  "type": {
17086
17033
  "text": "number"
17087
17034
  },
17088
- "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
17089
- "inheritedFrom": {
17090
- "name": "GenesisGridDatasourceElement",
17091
- "module": "src/datasource/base.datasource.ts"
17092
- }
17035
+ "privacy": "private",
17036
+ "default": "0"
17093
17037
  },
17094
17038
  {
17095
17039
  "kind": "field",
17096
- "name": "pollTriggerEvents",
17040
+ "name": "_loadMoreCount",
17097
17041
  "type": {
17098
- "text": "string[]"
17042
+ "text": "number"
17099
17043
  },
17100
- "default": "[]",
17101
- "description": "Array of event names that will trigger a poll when received as commit responses.",
17102
- "inheritedFrom": {
17103
- "name": "GenesisGridDatasourceElement",
17104
- "module": "src/datasource/base.datasource.ts"
17105
- }
17044
+ "privacy": "private",
17045
+ "default": "0"
17106
17046
  },
17107
17047
  {
17108
- "kind": "field",
17109
- "name": "request",
17110
- "type": {
17111
- "text": "any"
17048
+ "kind": "method",
17049
+ "name": "deepClone",
17050
+ "return": {
17051
+ "type": {
17052
+ "text": "Node"
17053
+ }
17112
17054
  },
17113
- "description": "Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.",
17114
17055
  "inheritedFrom": {
17115
- "name": "GenesisGridDatasourceElement",
17116
- "module": "src/datasource/base.datasource.ts"
17056
+ "name": "LifecycleMixin",
17057
+ "module": "src/mixins/lifecycle/lifecycle.ts"
17117
17058
  }
17118
17059
  },
17119
17060
  {
17120
- "kind": "field",
17121
- "name": "requestAutoSetup",
17122
- "type": {
17123
- "text": "boolean"
17061
+ "kind": "method",
17062
+ "name": "colDefsDeepClone",
17063
+ "privacy": "private",
17064
+ "return": {
17065
+ "type": {
17066
+ "text": "ColDef[]"
17067
+ }
17124
17068
  },
17125
- "default": "true",
17126
- "description": "Attribute to set whether the REQUEST object should be automatically set up.",
17127
- "inheritedFrom": {
17128
- "name": "GenesisGridDatasourceElement",
17129
- "module": "src/datasource/base.datasource.ts"
17130
- }
17069
+ "parameters": [
17070
+ {
17071
+ "name": "key",
17072
+ "type": {
17073
+ "text": "string"
17074
+ }
17075
+ },
17076
+ {
17077
+ "name": "copy",
17078
+ "type": {
17079
+ "text": "any"
17080
+ }
17081
+ }
17082
+ ]
17131
17083
  },
17132
17084
  {
17133
- "kind": "field",
17134
- "name": "rowIdAttr",
17135
- "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
17136
- "inheritedFrom": {
17137
- "name": "GenesisGridDatasourceElement",
17138
- "module": "src/datasource/base.datasource.ts"
17139
- }
17085
+ "kind": "method",
17086
+ "name": "init",
17087
+ "parameters": [
17088
+ {
17089
+ "name": "keepColDefsOnClearRowData",
17090
+ "optional": true,
17091
+ "type": {
17092
+ "text": "boolean"
17093
+ }
17094
+ },
17095
+ {
17096
+ "description": "Optionally set the `gridOptions` up with column definitions",
17097
+ "name": "columnDefinitions"
17098
+ },
17099
+ {
17100
+ "description": "Optionally set the grid up with column state",
17101
+ "name": "columnStates"
17102
+ }
17103
+ ],
17104
+ "description": "Initializes the datasource.",
17105
+ "privacy": "public"
17140
17106
  },
17141
17107
  {
17142
- "kind": "field",
17143
- "name": "restartOnReconnection",
17144
- "type": {
17145
- "text": "boolean"
17146
- },
17147
- "default": "true",
17148
- "description": "Attribute to set whether the datasource should restart when it reconnects.",
17108
+ "kind": "method",
17109
+ "name": "destroy",
17110
+ "description": "Destroys the datasource, resetting it to its initial state.",
17111
+ "privacy": "public",
17149
17112
  "inheritedFrom": {
17150
- "name": "GenesisGridDatasourceElement",
17113
+ "name": "GridProBaseDatasource",
17151
17114
  "module": "src/datasource/base.datasource.ts"
17152
17115
  }
17153
17116
  },
17154
17117
  {
17155
- "kind": "field",
17156
- "name": "defaultRowIdByResourceType",
17157
- "type": {
17158
- "text": "string"
17159
- },
17160
- "privacy": "protected",
17161
- "readonly": true,
17162
- "inheritedFrom": {
17163
- "name": "GenesisGridDatasourceElement",
17164
- "module": "src/datasource/base.datasource.ts"
17165
- }
17118
+ "kind": "method",
17119
+ "name": "deinit",
17120
+ "description": "Deinitialises the datasource, resetting it to its initial state.",
17121
+ "deprecated": "Use `destroy` instead",
17122
+ "privacy": "public"
17166
17123
  },
17167
17124
  {
17168
- "kind": "field",
17169
- "name": "criteriaFromFilters",
17170
- "type": {
17171
- "text": "Map<string, string>"
17172
- },
17173
- "privacy": "protected",
17174
- "default": "new Map()",
17175
- "inheritedFrom": {
17176
- "name": "GenesisGridDatasourceElement",
17177
- "module": "src/datasource/base.datasource.ts"
17178
- }
17125
+ "kind": "method",
17126
+ "name": "reset",
17127
+ "description": "Resets the datasource to its initial state.",
17128
+ "privacy": "public",
17129
+ "deprecated": "Use `destroy` instead"
17179
17130
  },
17180
17131
  {
17181
- "kind": "field",
17182
- "name": "update",
17183
- "type": {
17184
- "text": "BehaviorSubject<Map<string, string>>"
17185
- },
17186
- "privacy": "protected",
17187
- "default": "new BehaviorSubject(new Map())",
17132
+ "kind": "method",
17133
+ "name": "restart",
17134
+ "description": "Restarts the datasource, uses `destroy` and `init` in sequence.",
17135
+ "privacy": "public",
17188
17136
  "inheritedFrom": {
17189
- "name": "GenesisGridDatasourceElement",
17137
+ "name": "GridProBaseDatasource",
17190
17138
  "module": "src/datasource/base.datasource.ts"
17191
17139
  }
17192
17140
  },
17193
17141
  {
17194
17142
  "kind": "method",
17195
- "name": "datasourceOptions",
17196
- "privacy": "protected",
17197
- "return": {
17198
- "type": {
17199
- "text": "DatasourceOptions"
17200
- }
17201
- },
17202
- "inheritedFrom": {
17203
- "name": "GenesisGridDatasourceElement",
17204
- "module": "src/datasource/base.datasource.ts"
17205
- }
17143
+ "name": "refreshRows",
17144
+ "description": "Force the grid to redispatch the current rows"
17206
17145
  },
17207
17146
  {
17208
17147
  "kind": "method",
17209
- "name": "buildCriteria",
17210
- "privacy": "private",
17148
+ "name": "reloadResourceData",
17149
+ "privacy": "public",
17211
17150
  "return": {
17212
17151
  "type": {
17213
- "text": "string"
17152
+ "text": "Promise<void>"
17214
17153
  }
17215
17154
  },
17155
+ "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).",
17216
17156
  "inheritedFrom": {
17217
- "name": "GenesisGridDatasourceElement",
17157
+ "name": "GridProBaseDatasource",
17218
17158
  "module": "src/datasource/base.datasource.ts"
17219
17159
  }
17220
17160
  },
17221
17161
  {
17222
- "kind": "field",
17223
- "name": "isRequestServer",
17224
- "type": {
17225
- "text": "boolean"
17226
- },
17227
- "readonly": true,
17228
- "inheritedFrom": {
17229
- "name": "GenesisGridDatasourceElement",
17230
- "module": "src/datasource/base.datasource.ts"
17231
- }
17162
+ "kind": "method",
17163
+ "name": "handleSnapshot",
17164
+ "privacy": "private",
17165
+ "parameters": [
17166
+ {
17167
+ "name": "result"
17168
+ }
17169
+ ]
17232
17170
  },
17233
17171
  {
17234
17172
  "kind": "method",
17235
- "name": "datasourceStatusChanged",
17173
+ "name": "handleStreamResult",
17174
+ "privacy": "private",
17236
17175
  "parameters": [
17237
17176
  {
17238
- "name": "prev",
17239
- "type": {
17240
- "text": "DatasourceStatus"
17241
- }
17242
- },
17243
- {
17244
- "name": "next",
17177
+ "name": "result",
17245
17178
  "type": {
17246
- "text": "DatasourceStatus"
17179
+ "text": "FilteredDataServerResult | RequestServerResult"
17247
17180
  }
17248
17181
  }
17249
- ],
17250
- "inheritedFrom": {
17251
- "name": "GenesisGridDatasourceElement",
17252
- "module": "src/datasource/base.datasource.ts"
17253
- }
17182
+ ]
17254
17183
  },
17255
17184
  {
17256
17185
  "kind": "method",
17257
- "name": "handleErrors",
17186
+ "name": "updateLoadMoreStatus",
17187
+ "privacy": "private",
17258
17188
  "parameters": [
17259
17189
  {
17260
- "name": "errors",
17190
+ "name": "moreRows",
17261
17191
  "type": {
17262
- "text": "string | any[]"
17192
+ "text": "boolean"
17263
17193
  },
17264
- "description": "The error message or array of error messages"
17194
+ "description": "Whether more rows are available"
17265
17195
  },
17266
17196
  {
17267
- "name": "type",
17268
- "default": "'unknown'",
17197
+ "name": "sourceRef",
17269
17198
  "type": {
17270
- "text": "BaseDatasourceErrorEventDetail['type']"
17199
+ "text": "string"
17271
17200
  },
17272
- "description": "The type of error that occurred"
17201
+ "description": "The source reference"
17202
+ },
17203
+ {
17204
+ "description": "The total number of rows",
17205
+ "name": "rowsCount"
17273
17206
  }
17274
17207
  ],
17275
- "description": "Handles errors and emits appropriate error events.",
17276
- "privacy": "public",
17277
- "inheritedFrom": {
17278
- "name": "GenesisGridDatasourceElement",
17279
- "module": "src/datasource/base.datasource.ts"
17280
- }
17208
+ "description": "Updates the status bar based on more rows status"
17281
17209
  },
17282
17210
  {
17283
17211
  "kind": "method",
17284
- "name": "clearErrors",
17285
- "description": "Clears error state and emits connected event.",
17286
- "privacy": "public",
17287
- "inheritedFrom": {
17288
- "name": "GenesisGridDatasourceElement",
17289
- "module": "src/datasource/base.datasource.ts"
17290
- }
17212
+ "name": "applyRequestServerData",
17213
+ "privacy": "private",
17214
+ "parameters": [
17215
+ {
17216
+ "name": "requestServerResult",
17217
+ "type": {
17218
+ "text": "RequestServerResult"
17219
+ }
17220
+ }
17221
+ ]
17291
17222
  },
17292
17223
  {
17293
- "kind": "field",
17294
- "name": "_presentation",
17295
- "type": {
17296
- "text": "ComponentPresentation | null | undefined"
17297
- },
17224
+ "kind": "method",
17225
+ "name": "applyDataserverData",
17298
17226
  "privacy": "private",
17299
- "default": "void 0",
17300
- "inheritedFrom": {
17301
- "name": "FoundationElement",
17302
- "module": "src/foundation-element/foundation-element.ts"
17303
- }
17304
- },
17305
- {
17306
- "kind": "field",
17307
- "name": "$presentation",
17308
- "type": {
17309
- "text": "ComponentPresentation | null"
17310
- },
17311
- "privacy": "public",
17312
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
17313
- "inheritedFrom": {
17314
- "name": "FoundationElement",
17315
- "module": "src/foundation-element/foundation-element.ts"
17316
- }
17227
+ "parameters": [
17228
+ {
17229
+ "name": "dataServerResult",
17230
+ "type": {
17231
+ "text": "FilteredDataServerResult"
17232
+ }
17233
+ }
17234
+ ]
17317
17235
  },
17318
17236
  {
17319
- "kind": "field",
17320
- "name": "template",
17321
- "type": {
17322
- "text": "ElementViewTemplate | void | null"
17323
- },
17324
- "privacy": "public",
17325
- "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.",
17326
- "inheritedFrom": {
17327
- "name": "FoundationElement",
17328
- "module": "src/foundation-element/foundation-element.ts"
17329
- }
17237
+ "kind": "method",
17238
+ "name": "getAgColumnDefs",
17239
+ "privacy": "private",
17240
+ "parameters": [
17241
+ {
17242
+ "name": "fieldsMetadata",
17243
+ "type": {
17244
+ "text": "FieldMetadata[]"
17245
+ }
17246
+ }
17247
+ ]
17330
17248
  },
17331
17249
  {
17332
17250
  "kind": "method",
17333
- "name": "templateChanged",
17334
- "privacy": "protected",
17335
- "return": {
17336
- "type": {
17337
- "text": "void"
17251
+ "name": "setFilter",
17252
+ "privacy": "public",
17253
+ "parameters": [
17254
+ {
17255
+ "name": "fieldName",
17256
+ "type": {
17257
+ "text": "string"
17258
+ }
17259
+ },
17260
+ {
17261
+ "name": "newFilter",
17262
+ "type": {
17263
+ "text": "string"
17264
+ }
17338
17265
  }
17339
- },
17266
+ ],
17340
17267
  "inheritedFrom": {
17341
- "name": "FoundationElement",
17342
- "module": "src/foundation-element/foundation-element.ts"
17268
+ "name": "GenesisGridDatasourceElement",
17269
+ "module": "src/datasource/base.datasource.ts"
17343
17270
  }
17344
17271
  },
17345
17272
  {
17346
- "kind": "field",
17347
- "name": "styles",
17348
- "type": {
17349
- "text": "ElementStyles | void | null"
17350
- },
17273
+ "kind": "method",
17274
+ "name": "removeFilter",
17351
17275
  "privacy": "public",
17352
- "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.",
17276
+ "parameters": [
17277
+ {
17278
+ "name": "fieldName",
17279
+ "type": {
17280
+ "text": "string"
17281
+ }
17282
+ }
17283
+ ],
17353
17284
  "inheritedFrom": {
17354
- "name": "FoundationElement",
17355
- "module": "src/foundation-element/foundation-element.ts"
17285
+ "name": "GenesisGridDatasourceElement",
17286
+ "module": "src/datasource/base.datasource.ts"
17356
17287
  }
17357
17288
  },
17358
17289
  {
17359
17290
  "kind": "method",
17360
- "name": "stylesChanged",
17291
+ "name": "applyTransaction",
17361
17292
  "privacy": "protected",
17362
17293
  "return": {
17363
17294
  "type": {
17364
- "text": "void"
17295
+ "text": "any"
17365
17296
  }
17366
17297
  },
17298
+ "parameters": [
17299
+ {
17300
+ "name": "transaction",
17301
+ "type": {
17302
+ "text": "any"
17303
+ }
17304
+ }
17305
+ ],
17367
17306
  "inheritedFrom": {
17368
- "name": "FoundationElement",
17369
- "module": "src/foundation-element/foundation-element.ts"
17307
+ "name": "GridProBaseDatasource",
17308
+ "module": "src/datasource/base.datasource.ts"
17370
17309
  }
17371
17310
  },
17372
17311
  {
17373
17312
  "kind": "method",
17374
- "name": "compose",
17375
- "privacy": "public",
17376
- "static": true,
17377
- "return": {
17378
- "type": {
17379
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
17380
- }
17381
- },
17313
+ "name": "handleSizeChanged",
17314
+ "privacy": "private",
17382
17315
  "parameters": [
17383
17316
  {
17384
- "name": "this",
17317
+ "name": "oldSize",
17385
17318
  "type": {
17386
- "text": "K"
17319
+ "text": "number"
17387
17320
  }
17388
17321
  },
17389
17322
  {
17390
- "name": "elementDefinition",
17323
+ "name": "newSize",
17391
17324
  "type": {
17392
- "text": "T"
17393
- },
17394
- "description": "The definition of the element to create the registry\nfunction for."
17325
+ "text": "number"
17326
+ }
17395
17327
  }
17396
- ],
17397
- "description": "Defines an element registry function with a set of element definition defaults.",
17398
- "inheritedFrom": {
17399
- "name": "FoundationElement",
17400
- "module": "src/foundation-element/foundation-element.ts"
17401
- }
17402
- }
17403
- ],
17404
- "events": [
17328
+ ]
17329
+ },
17405
17330
  {
17406
- "description": "Fired when a datasource error is reported",
17407
- "name": "base-datasource-error",
17331
+ "kind": "method",
17332
+ "name": "handleStreamInserts",
17333
+ "privacy": "protected",
17334
+ "parameters": [
17335
+ {
17336
+ "name": "inserts",
17337
+ "default": "[]"
17338
+ }
17339
+ ],
17408
17340
  "inheritedFrom": {
17409
- "name": "GenesisGridDatasourceElement",
17341
+ "name": "GridProBaseDatasource",
17410
17342
  "module": "src/datasource/base.datasource.ts"
17411
17343
  }
17412
17344
  },
17413
17345
  {
17414
- "description": "Fired when a datasource error occurs (for grid integration)",
17415
- "name": "datasource-error",
17346
+ "kind": "method",
17347
+ "name": "handleStreamUpdates",
17348
+ "privacy": "protected",
17349
+ "parameters": [
17350
+ {
17351
+ "name": "updates",
17352
+ "default": "[]"
17353
+ }
17354
+ ],
17416
17355
  "inheritedFrom": {
17417
- "name": "GenesisGridDatasourceElement",
17356
+ "name": "GridProBaseDatasource",
17418
17357
  "module": "src/datasource/base.datasource.ts"
17419
17358
  }
17420
17359
  },
17421
17360
  {
17422
- "description": "Fired when error state is cleared after connection succeeds",
17423
- "name": "base-datasource-connected",
17361
+ "kind": "method",
17362
+ "name": "handleStreamDeletes",
17363
+ "privacy": "protected",
17364
+ "parameters": [
17365
+ {
17366
+ "name": "deletes",
17367
+ "default": "[]",
17368
+ "description": "List of records to remove from the grid stream"
17369
+ }
17370
+ ],
17371
+ "description": "Handles stream deletes by removing records from the grid.",
17424
17372
  "inheritedFrom": {
17425
- "name": "GenesisGridDatasourceElement",
17373
+ "name": "GridProBaseDatasource",
17426
17374
  "module": "src/datasource/base.datasource.ts"
17427
17375
  }
17428
17376
  },
17429
17377
  {
17430
- "description": "Fired when loading completes with no pending row changes",
17431
- "name": "datasource-loading-finished",
17378
+ "kind": "method",
17379
+ "name": "loadMore",
17432
17380
  "inheritedFrom": {
17433
- "name": "GenesisGridDatasourceElement",
17381
+ "name": "GridProBaseDatasource",
17434
17382
  "module": "src/datasource/base.datasource.ts"
17435
17383
  }
17436
17384
  },
17437
17385
  {
17438
- "description": "Fired when the grid has no rows after load",
17439
- "name": "datasource-no-data-available",
17386
+ "kind": "method",
17387
+ "name": "cloneNode",
17388
+ "return": {
17389
+ "type": {
17390
+ "text": "Node"
17391
+ }
17392
+ },
17393
+ "parameters": [
17394
+ {
17395
+ "name": "deep",
17396
+ "optional": true,
17397
+ "type": {
17398
+ "text": "boolean"
17399
+ }
17400
+ }
17401
+ ],
17440
17402
  "inheritedFrom": {
17441
- "name": "GenesisGridDatasourceElement",
17442
- "module": "src/datasource/base.datasource.ts"
17403
+ "name": "LifecycleMixin",
17404
+ "module": "src/mixins/lifecycle/lifecycle.ts"
17443
17405
  }
17444
17406
  },
17445
17407
  {
17446
- "description": "Fired when row data changes from stream updates",
17447
- "name": "datasource-data-changed",
17408
+ "kind": "field",
17409
+ "name": "shouldRunDisconnect",
17410
+ "return": {
17411
+ "type": {
17412
+ "text": ""
17413
+ }
17414
+ },
17415
+ "readonly": true,
17448
17416
  "inheritedFrom": {
17449
- "name": "GenesisGridDatasourceElement",
17450
- "module": "src/datasource/base.datasource.ts"
17417
+ "name": "LifecycleMixin",
17418
+ "module": "src/mixins/lifecycle/lifecycle.ts"
17451
17419
  }
17452
17420
  },
17453
17421
  {
17454
- "description": "Fired to hand off grid options and initialization flags",
17455
- "name": "datasource-initialize"
17456
- },
17457
- {
17458
- "description": "Fired when the datasource is torn down",
17459
- "name": "datasource-destroy"
17460
- },
17461
- {
17462
- "description": "Fired when row data is cleared",
17463
- "name": "datasource-data-cleared"
17464
- },
17465
- {
17466
- "description": "Fired when column metadata or defs are updated",
17467
- "name": "datasource-schema-updated"
17422
+ "kind": "field",
17423
+ "name": "shouldRunConnect",
17424
+ "return": {
17425
+ "type": {
17426
+ "text": ""
17427
+ }
17428
+ },
17429
+ "readonly": true,
17430
+ "inheritedFrom": {
17431
+ "name": "LifecycleMixin",
17432
+ "module": "src/mixins/lifecycle/lifecycle.ts"
17433
+ }
17468
17434
  },
17469
17435
  {
17470
- "description": "Fired when persisted filters are reapplied",
17471
- "name": "datasource-filters-restored"
17472
- },
17473
- {
17474
- "description": "Fired when a data payload is loaded for the grid",
17475
- "name": "datasource-data-loaded"
17476
- },
17477
- {
17478
- "description": "Fired when a load or refresh starts",
17479
- "name": "datasource-loading-started"
17480
- },
17481
- {
17482
- "description": "Fired when more server rows can be requested",
17483
- "name": "datasource-more-data-available"
17484
- },
17485
- {
17486
- "description": "Fired when the host grid is ready (detail includes pagination state)",
17487
- "name": "datasource-ready"
17488
- },
17489
- {
17490
- "description": "Fired when initial grid data is ready for the client-side model",
17491
- "name": "datasource-init"
17492
- },
17493
- {
17494
- "description": "Fired when MORE_ROWS availability changes",
17495
- "name": "more-rows-changed"
17496
- },
17497
- {
17498
- "description": "Fired when layout or viewport sizing affects the datasource",
17499
- "name": "datasource-size-changed"
17500
- }
17501
- ],
17502
- "attributes": [
17503
- {
17504
- "name": "keep-col-defs-on-clear-row-data",
17505
- "type": {
17506
- "text": "boolean"
17507
- },
17508
- "default": "false",
17509
- "fieldName": "keepColDefsOnClearRowData"
17510
- },
17511
- {
17512
- "name": "criteria",
17513
- "type": {
17514
- "text": "string"
17436
+ "kind": "method",
17437
+ "name": "#_blockLifecycleDueToTokenChange",
17438
+ "return": {
17439
+ "type": {
17440
+ "text": "boolean"
17441
+ }
17515
17442
  },
17516
- "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
17517
- "fieldName": "criteria",
17443
+ "parameters": [
17444
+ {
17445
+ "name": "lifecycleType",
17446
+ "type": {
17447
+ "text": "Lifecycletype"
17448
+ }
17449
+ }
17450
+ ],
17518
17451
  "inheritedFrom": {
17519
- "name": "GenesisGridDatasourceElement",
17520
- "module": "src/datasource/base.datasource.ts"
17452
+ "name": "LifecycleMixin",
17453
+ "module": "src/mixins/lifecycle/lifecycle.ts"
17521
17454
  }
17522
17455
  },
17523
17456
  {
17524
- "name": "is-snapshot",
17457
+ "kind": "field",
17458
+ "name": "dataSubWasLoggedOff",
17525
17459
  "type": {
17526
17460
  "text": "boolean"
17527
17461
  },
17462
+ "privacy": "protected",
17528
17463
  "default": "false",
17529
- "description": "Request a snapshot from the server.",
17530
- "fieldName": "isSnapshot",
17531
- "inheritedFrom": {
17532
- "name": "GenesisGridDatasourceElement",
17533
- "module": "src/datasource/base.datasource.ts"
17534
- }
17535
- },
17536
- {
17537
- "name": "max-rows",
17538
- "type": {
17539
- "text": "number"
17540
- },
17541
- "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
17542
- "fieldName": "maxRows",
17543
- "inheritedFrom": {
17544
- "name": "GenesisGridDatasourceElement",
17545
- "module": "src/datasource/base.datasource.ts"
17546
- }
17547
- },
17548
- {
17549
- "name": "order-by",
17550
- "type": {
17551
- "text": "string"
17552
- },
17553
- "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.",
17554
- "fieldName": "orderBy",
17555
17464
  "inheritedFrom": {
17556
- "name": "GenesisGridDatasourceElement",
17465
+ "name": "GridProBaseDatasource",
17557
17466
  "module": "src/datasource/base.datasource.ts"
17558
17467
  }
17559
17468
  },
17560
17469
  {
17561
- "name": "resource-name",
17470
+ "kind": "field",
17471
+ "name": "rowData",
17562
17472
  "type": {
17563
- "text": "string"
17473
+ "text": "Map<string, any>"
17564
17474
  },
17565
- "description": "The name of the target Data Server query or Request Server requestReply.",
17566
- "fieldName": "resourceName",
17475
+ "default": "new Map()",
17567
17476
  "inheritedFrom": {
17568
- "name": "GenesisGridDatasourceElement",
17477
+ "name": "GridProBaseDatasource",
17569
17478
  "module": "src/datasource/base.datasource.ts"
17570
17479
  }
17571
17480
  },
17572
17481
  {
17573
- "name": "view-number",
17482
+ "kind": "field",
17483
+ "name": "connectionSub",
17574
17484
  "type": {
17575
- "text": "number"
17485
+ "text": "Subscription | undefined"
17576
17486
  },
17577
- "description": "The desired view/page you want data from.",
17578
- "fieldName": "viewNumber",
17487
+ "privacy": "protected",
17579
17488
  "inheritedFrom": {
17580
- "name": "GenesisGridDatasourceElement",
17489
+ "name": "GridProBaseDatasource",
17581
17490
  "module": "src/datasource/base.datasource.ts"
17582
17491
  }
17583
17492
  },
17584
17493
  {
17585
- "name": "fields",
17586
- "type": {
17587
- "text": "string"
17588
- },
17589
- "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.",
17590
- "fieldName": "fields",
17494
+ "kind": "method",
17495
+ "name": "subscribeToConnection",
17496
+ "privacy": "protected",
17591
17497
  "inheritedFrom": {
17592
- "name": "GenesisGridDatasourceElement",
17498
+ "name": "GridProBaseDatasource",
17593
17499
  "module": "src/datasource/base.datasource.ts"
17594
17500
  }
17595
17501
  },
17596
17502
  {
17597
- "name": "max-view",
17598
- "type": {
17599
- "text": "number"
17600
- },
17601
- "description": "Maximum number of rows to track as part of a client \"view\".",
17602
- "fieldName": "maxView",
17503
+ "kind": "method",
17504
+ "name": "unsubscribeFromConnection",
17505
+ "privacy": "protected",
17603
17506
  "inheritedFrom": {
17604
- "name": "GenesisGridDatasourceElement",
17507
+ "name": "GridProBaseDatasource",
17605
17508
  "module": "src/datasource/base.datasource.ts"
17606
17509
  }
17607
17510
  },
17608
17511
  {
17609
- "name": "moving-view",
17610
- "type": {
17611
- "text": "boolean"
17512
+ "kind": "method",
17513
+ "name": "generateColumnDefsFromMetadata",
17514
+ "privacy": "protected",
17515
+ "return": {
17516
+ "type": {
17517
+ "text": "ColDef[]"
17518
+ }
17612
17519
  },
17613
- "default": "false",
17614
- "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.",
17615
- "fieldName": "movingView",
17520
+ "parameters": [
17521
+ {
17522
+ "name": "fieldsMetadata",
17523
+ "type": {
17524
+ "text": "FieldMetadata[]"
17525
+ }
17526
+ },
17527
+ {
17528
+ "name": "getFilterParamsByFieldType",
17529
+ "type": {
17530
+ "text": "(field: FieldMetadata) => ColDef['filterParams'] | any"
17531
+ }
17532
+ },
17533
+ {
17534
+ "name": "getFilterByFieldType",
17535
+ "type": {
17536
+ "text": "(type: FieldTypeEnum) => string"
17537
+ }
17538
+ }
17539
+ ],
17616
17540
  "inheritedFrom": {
17617
- "name": "GenesisGridDatasourceElement",
17541
+ "name": "GridProBaseDatasource",
17618
17542
  "module": "src/datasource/base.datasource.ts"
17619
17543
  }
17620
17544
  },
17621
17545
  {
17622
- "type": {
17623
- "text": "number"
17624
- },
17625
- "description": "Option that changes the Data Server index iteration.",
17626
- "fieldName": "reverse",
17627
- "default": "false",
17546
+ "kind": "method",
17547
+ "name": "applyAllTransactions",
17548
+ "privacy": "protected",
17628
17549
  "inheritedFrom": {
17629
- "name": "GenesisGridDatasourceElement",
17550
+ "name": "GridProBaseDatasource",
17630
17551
  "module": "src/datasource/base.datasource.ts"
17631
17552
  }
17632
17553
  },
17633
17554
  {
17634
- "name": "disable-polling",
17635
- "type": {
17636
- "text": "boolean"
17637
- },
17638
- "default": "false",
17639
- "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
17640
- "fieldName": "disablePolling",
17555
+ "kind": "method",
17556
+ "name": "applyMappedTransaction",
17557
+ "privacy": "private",
17558
+ "parameters": [
17559
+ {
17560
+ "name": "transaction",
17561
+ "type": {
17562
+ "text": "TransactionData"
17563
+ }
17564
+ },
17565
+ {
17566
+ "name": "operation",
17567
+ "type": {
17568
+ "text": "OperationType"
17569
+ }
17570
+ }
17571
+ ],
17641
17572
  "inheritedFrom": {
17642
- "name": "GenesisGridDatasourceElement",
17573
+ "name": "GridProBaseDatasource",
17643
17574
  "module": "src/datasource/base.datasource.ts"
17644
17575
  }
17645
17576
  },
17646
17577
  {
17647
- "name": "polling-interval",
17648
- "type": {
17649
- "text": "number"
17578
+ "kind": "method",
17579
+ "name": "mapTransaction",
17580
+ "privacy": "private",
17581
+ "parameters": [
17582
+ {
17583
+ "name": "transaction",
17584
+ "type": {
17585
+ "text": "TransactionData"
17586
+ },
17587
+ "description": "The transaction data to be mapped."
17588
+ },
17589
+ {
17590
+ "name": "operations",
17591
+ "default": "Object.values(OperationType)",
17592
+ "type": {
17593
+ "text": "OperationType[]"
17594
+ },
17595
+ "description": "The operations to be mapped. Can be 'add', 'update' or 'remove'."
17596
+ }
17597
+ ],
17598
+ "description": "Maps the transaction data to the row data mapper function, if it exists.",
17599
+ "return": {
17600
+ "type": {
17601
+ "text": ""
17602
+ }
17650
17603
  },
17651
- "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
17652
- "fieldName": "pollingInterval",
17653
17604
  "inheritedFrom": {
17654
- "name": "GenesisGridDatasourceElement",
17605
+ "name": "GridProBaseDatasource",
17655
17606
  "module": "src/datasource/base.datasource.ts"
17656
17607
  }
17657
17608
  },
17658
17609
  {
17659
- "name": "request-auto-setup",
17610
+ "kind": "field",
17611
+ "name": "pagination",
17660
17612
  "type": {
17661
- "text": "boolean"
17662
- },
17663
- "default": "true",
17664
- "description": "Attribute to set whether the REQUEST object should be automatically set up.",
17665
- "fieldName": "requestAutoSetup",
17666
- "inheritedFrom": {
17667
- "name": "GenesisGridDatasourceElement",
17668
- "module": "src/datasource/base.datasource.ts"
17669
- }
17670
- },
17671
- {
17672
- "name": "row-id",
17673
- "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
17674
- "fieldName": "rowIdAttr",
17675
- "inheritedFrom": {
17676
- "name": "GenesisGridDatasourceElement",
17677
- "module": "src/datasource/base.datasource.ts"
17678
- }
17679
- },
17680
- {
17681
- "name": "restart-on-reconnection",
17682
- "type": {
17683
- "text": "boolean"
17684
- },
17685
- "default": "true",
17686
- "description": "Attribute to set whether the datasource should restart when it reconnects.",
17687
- "fieldName": "restartOnReconnection",
17688
- "inheritedFrom": {
17689
- "name": "GenesisGridDatasourceElement",
17690
- "module": "src/datasource/base.datasource.ts"
17691
- }
17692
- }
17693
- ],
17694
- "mixins": [
17695
- {
17696
- "name": "LifecycleMixin",
17697
- "package": "@genesislcap/foundation-utils"
17698
- }
17699
- ],
17700
- "superclass": {
17701
- "name": "GridProBaseDatasource",
17702
- "module": "/src/datasource/base.datasource"
17703
- },
17704
- "tagName": "grid-pro-genesis-datasource",
17705
- "customElement": true
17706
- }
17707
- ],
17708
- "exports": [
17709
- {
17710
- "kind": "js",
17711
- "name": "GridProGenesisDatasource",
17712
- "declaration": {
17713
- "name": "GridProGenesisDatasource",
17714
- "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
17715
- }
17716
- },
17717
- {
17718
- "kind": "custom-element-definition",
17719
- "name": "grid-pro-genesis-datasource",
17720
- "declaration": {
17721
- "name": "GridProGenesisDatasource",
17722
- "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
17723
- }
17724
- }
17725
- ]
17726
- },
17727
- {
17728
- "kind": "javascript-module",
17729
- "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
17730
- "declarations": [],
17731
- "exports": []
17732
- },
17733
- {
17734
- "kind": "javascript-module",
17735
- "path": "src/grid-pro-genesis-datasource/index.ts",
17736
- "declarations": [],
17737
- "exports": [
17738
- {
17739
- "kind": "js",
17740
- "name": "*",
17741
- "declaration": {
17742
- "name": "*",
17743
- "package": "./datasource-events.types"
17744
- }
17745
- },
17746
- {
17747
- "kind": "js",
17748
- "name": "*",
17749
- "declaration": {
17750
- "name": "*",
17751
- "package": "./grid-pro-genesis-datasource"
17752
- }
17753
- },
17754
- {
17755
- "kind": "js",
17756
- "name": "*",
17757
- "declaration": {
17758
- "name": "*",
17759
- "package": "./grid-pro-genesis-datasource.config"
17760
- }
17761
- },
17762
- {
17763
- "kind": "js",
17764
- "name": "*",
17765
- "declaration": {
17766
- "name": "*",
17767
- "package": "./grid-pro-genesis-datasource.types"
17768
- }
17769
- }
17770
- ]
17771
- },
17772
- {
17773
- "kind": "javascript-module",
17774
- "path": "src/multicolumn-dropdown/index.ts",
17775
- "declarations": [],
17776
- "exports": [
17777
- {
17778
- "kind": "js",
17779
- "name": "*",
17780
- "declaration": {
17781
- "name": "*",
17782
- "package": "./multicolumn-dropdown"
17783
- }
17784
- },
17785
- {
17786
- "kind": "js",
17787
- "name": "*",
17788
- "declaration": {
17789
- "name": "*",
17790
- "package": "./multicolumn-dropdown.styles"
17791
- }
17792
- },
17793
- {
17794
- "kind": "js",
17795
- "name": "*",
17796
- "declaration": {
17797
- "name": "*",
17798
- "package": "./multicolumn-dropdown.template"
17799
- }
17800
- }
17801
- ]
17802
- },
17803
- {
17804
- "kind": "javascript-module",
17805
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts",
17806
- "declarations": [
17807
- {
17808
- "kind": "variable",
17809
- "name": "dropdownWidthVar",
17810
- "type": {
17811
- "text": "string"
17812
- },
17813
- "default": "'--dropdown-width'",
17814
- "description": "The CSS variable to use for specifying the dropdown's width"
17815
- },
17816
- {
17817
- "kind": "variable",
17818
- "name": "optionsClass",
17819
- "type": {
17820
- "text": "string"
17821
- },
17822
- "default": "'options'",
17823
- "description": "The CSS class to use for the options element's class in the dropdown"
17824
- },
17825
- {
17826
- "kind": "variable",
17827
- "name": "DISPLAY_NONE_CLASS",
17828
- "type": {
17829
- "text": "string"
17830
- },
17831
- "default": "'dnone'",
17832
- "description": "Class name used to hide elements with display:none"
17833
- },
17834
- {
17835
- "kind": "variable",
17836
- "name": "multicolumnDropdownStyles",
17837
- "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`",
17838
- "description": "Multicolumn Dropdown styles.",
17839
- "privacy": "public"
17840
- }
17841
- ],
17842
- "exports": [
17843
- {
17844
- "kind": "js",
17845
- "name": "dropdownWidthVar",
17846
- "declaration": {
17847
- "name": "dropdownWidthVar",
17848
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
17849
- }
17850
- },
17851
- {
17852
- "kind": "js",
17853
- "name": "optionsClass",
17854
- "declaration": {
17855
- "name": "optionsClass",
17856
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
17857
- }
17858
- },
17859
- {
17860
- "kind": "js",
17861
- "name": "DISPLAY_NONE_CLASS",
17862
- "declaration": {
17863
- "name": "DISPLAY_NONE_CLASS",
17864
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
17865
- }
17866
- },
17867
- {
17868
- "kind": "js",
17869
- "name": "multicolumnDropdownStyles",
17870
- "declaration": {
17871
- "name": "multicolumnDropdownStyles",
17872
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
17873
- }
17874
- }
17875
- ]
17876
- },
17877
- {
17878
- "kind": "javascript-module",
17879
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts",
17880
- "declarations": [
17881
- {
17882
- "kind": "function",
17883
- "name": "getMulticolumnDropdownTemplate",
17884
- "parameters": [
17885
- {
17886
- "name": "designSystem",
17887
- "default": "'foundation'",
17888
- "description": "The design system prefix to use. Defaults to 'foundation'."
17889
- }
17890
- ],
17891
- "description": "Get a Design System prefixed Multicolumn Dropdown template.",
17892
- "return": {
17893
- "type": {
17894
- "text": ""
17895
- }
17896
- },
17897
- "privacy": "public"
17898
- },
17899
- {
17900
- "kind": "variable",
17901
- "name": "multicolumnDropdownTemplate",
17902
- "description": "The default Multicolumn Dropdown template using the 'foundation' design system prefix.",
17903
- "privacy": "public"
17904
- }
17905
- ],
17906
- "exports": [
17907
- {
17908
- "kind": "js",
17909
- "name": "getMulticolumnDropdownTemplate",
17910
- "declaration": {
17911
- "name": "getMulticolumnDropdownTemplate",
17912
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
17913
- }
17914
- },
17915
- {
17916
- "kind": "js",
17917
- "name": "multicolumnDropdownTemplate",
17918
- "declaration": {
17919
- "name": "multicolumnDropdownTemplate",
17920
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
17921
- }
17922
- }
17923
- ]
17924
- },
17925
- {
17926
- "kind": "javascript-module",
17927
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.ts",
17928
- "declarations": [
17929
- {
17930
- "kind": "function",
17931
- "name": "wasClickOutsideElement",
17932
- "parameters": [
17613
+ "text": "boolean"
17614
+ },
17615
+ "privacy": "protected",
17616
+ "inheritedFrom": {
17617
+ "name": "GridProBaseDatasource",
17618
+ "module": "src/datasource/base.datasource.ts"
17619
+ }
17620
+ },
17933
17621
  {
17934
- "name": "event",
17622
+ "kind": "field",
17623
+ "name": "_isDisconnected",
17935
17624
  "type": {
17936
- "text": "MouseEvent"
17625
+ "text": "boolean"
17626
+ },
17627
+ "privacy": "private",
17628
+ "default": "false",
17629
+ "inheritedFrom": {
17630
+ "name": "GridProBaseDatasource",
17631
+ "module": "src/datasource/base.datasource.ts"
17937
17632
  }
17938
17633
  },
17939
17634
  {
17940
- "name": "target",
17635
+ "kind": "method",
17636
+ "name": "setDisconnected",
17637
+ "privacy": "public",
17638
+ "parameters": [
17639
+ {
17640
+ "name": "disconnected",
17641
+ "type": {
17642
+ "text": "boolean"
17643
+ },
17644
+ "description": "true to set, false to remove"
17645
+ }
17646
+ ],
17647
+ "description": "Sets the disconnected state and emits appropriate events.",
17648
+ "inheritedFrom": {
17649
+ "name": "GridProBaseDatasource",
17650
+ "module": "src/datasource/base.datasource.ts"
17651
+ }
17652
+ },
17653
+ {
17654
+ "kind": "method",
17655
+ "name": "isDisconnected",
17656
+ "privacy": "public",
17657
+ "return": {
17658
+ "type": {
17659
+ "text": "boolean"
17660
+ }
17661
+ },
17662
+ "description": "Returns true if the datasource is disconnected.",
17663
+ "inheritedFrom": {
17664
+ "name": "GridProBaseDatasource",
17665
+ "module": "src/datasource/base.datasource.ts"
17666
+ }
17667
+ },
17668
+ {
17669
+ "kind": "method",
17670
+ "name": "getDatasourceStatusBarPanels",
17671
+ "privacy": "public",
17672
+ "return": {
17673
+ "type": {
17674
+ "text": "any[]"
17675
+ }
17676
+ },
17677
+ "parameters": [
17678
+ {
17679
+ "name": "isServerSide",
17680
+ "type": {
17681
+ "text": "boolean"
17682
+ }
17683
+ },
17684
+ {
17685
+ "name": "statusBarConfig",
17686
+ "type": {
17687
+ "text": "any"
17688
+ }
17689
+ }
17690
+ ],
17691
+ "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.",
17692
+ "inheritedFrom": {
17693
+ "name": "GridProBaseDatasource",
17694
+ "module": "src/datasource/base.datasource.ts"
17695
+ }
17696
+ },
17697
+ {
17698
+ "kind": "field",
17699
+ "name": "connect",
17941
17700
  "type": {
17942
- "text": "EventTarget"
17701
+ "text": "Connect"
17702
+ },
17703
+ "inheritedFrom": {
17704
+ "name": "GenesisGridDatasourceElement",
17705
+ "module": "src/datasource/base.datasource.ts"
17943
17706
  }
17944
- }
17945
- ],
17946
- "description": "Checks if the given mouse event occurred outside the target element.",
17947
- "privacy": "public"
17948
- },
17949
- {
17950
- "kind": "class",
17951
- "description": "",
17952
- "name": "MulticolumnDropdown",
17953
- "members": [
17707
+ },
17954
17708
  {
17955
17709
  "kind": "field",
17956
- "name": "optionsElement",
17710
+ "name": "datasource",
17957
17711
  "type": {
17958
- "text": "HTMLElement"
17712
+ "text": "Datasource"
17713
+ },
17714
+ "inheritedFrom": {
17715
+ "name": "GenesisGridDatasourceElement",
17716
+ "module": "src/datasource/base.datasource.ts"
17959
17717
  }
17960
17718
  },
17961
17719
  {
17962
17720
  "kind": "field",
17963
- "name": "lastRequest",
17721
+ "name": "deferredGridOptions",
17964
17722
  "type": {
17965
- "text": "object"
17723
+ "text": "GridOptions"
17966
17724
  },
17967
- "privacy": "private"
17725
+ "inheritedFrom": {
17726
+ "name": "GenesisGridDatasourceElement",
17727
+ "module": "src/datasource/base.datasource.ts"
17728
+ }
17968
17729
  },
17969
17730
  {
17970
17731
  "kind": "field",
17971
- "name": "connectOverride",
17732
+ "name": "deferredColumnStates",
17972
17733
  "type": {
17973
- "text": "Connect"
17734
+ "text": "ColumnState[]"
17974
17735
  },
17975
- "privacy": "private"
17736
+ "inheritedFrom": {
17737
+ "name": "GenesisGridDatasourceElement",
17738
+ "module": "src/datasource/base.datasource.ts"
17739
+ }
17976
17740
  },
17977
17741
  {
17978
17742
  "kind": "field",
17979
- "name": "_connectDI",
17743
+ "name": "rowDataMapper",
17980
17744
  "type": {
17981
- "text": "Connect"
17745
+ "text": "Function"
17982
17746
  },
17983
- "privacy": "private"
17747
+ "description": "Allows grid data updates to be processed via and external function before applying in grid",
17748
+ "inheritedFrom": {
17749
+ "name": "GenesisGridDatasourceElement",
17750
+ "module": "src/datasource/base.datasource.ts"
17751
+ }
17984
17752
  },
17985
17753
  {
17986
17754
  "kind": "field",
17987
- "name": "connect",
17755
+ "name": "criteria",
17988
17756
  "type": {
17989
- "text": "Connect"
17757
+ "text": "string"
17990
17758
  },
17991
- "description": "The connect service - uses DI by default, but can be manually set for dynamic element creation"
17759
+ "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
17760
+ "inheritedFrom": {
17761
+ "name": "GenesisGridDatasourceElement",
17762
+ "module": "src/datasource/base.datasource.ts"
17763
+ }
17992
17764
  },
17993
17765
  {
17994
17766
  "kind": "field",
17995
- "name": "disabled",
17767
+ "name": "isSnapshot",
17996
17768
  "type": {
17997
17769
  "text": "boolean"
17998
17770
  },
17999
- "privacy": "public",
18000
- "description": "Whether to disable control of the component"
17771
+ "default": "false",
17772
+ "description": "Request a snapshot from the server.",
17773
+ "inheritedFrom": {
17774
+ "name": "GenesisGridDatasourceElement",
17775
+ "module": "src/datasource/base.datasource.ts"
17776
+ }
18001
17777
  },
18002
17778
  {
18003
17779
  "kind": "field",
18004
- "name": "resourceName",
17780
+ "name": "maxRows",
17781
+ "type": {
17782
+ "text": "number"
17783
+ },
17784
+ "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
17785
+ "inheritedFrom": {
17786
+ "name": "GenesisGridDatasourceElement",
17787
+ "module": "src/datasource/base.datasource.ts"
17788
+ }
17789
+ },
17790
+ {
17791
+ "kind": "field",
17792
+ "name": "orderBy",
18005
17793
  "type": {
18006
17794
  "text": "string"
18007
17795
  },
18008
- "privacy": "public",
18009
- "description": "The name of the reqrep to get the options from"
17796
+ "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.",
17797
+ "inheritedFrom": {
17798
+ "name": "GenesisGridDatasourceElement",
17799
+ "module": "src/datasource/base.datasource.ts"
17800
+ }
18010
17801
  },
18011
17802
  {
18012
17803
  "kind": "field",
18013
- "name": "searchKey",
17804
+ "name": "resourceName",
18014
17805
  "type": {
18015
- "text": "string | string[] | undefined"
17806
+ "text": "string"
18016
17807
  },
18017
- "privacy": "public",
18018
- "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\")."
17808
+ "description": "The name of the target Data Server query or Request Server requestReply.",
17809
+ "inheritedFrom": {
17810
+ "name": "GenesisGridDatasourceElement",
17811
+ "module": "src/datasource/base.datasource.ts"
17812
+ }
18019
17813
  },
18020
17814
  {
18021
17815
  "kind": "field",
18022
- "name": "requestSupportsAdvancedSearch",
17816
+ "name": "viewNumber",
18023
17817
  "type": {
18024
- "text": "boolean"
17818
+ "text": "number"
18025
17819
  },
18026
- "privacy": "public",
18027
- "default": "false",
18028
- "description": "Tells whether a given request supports lookup by Groovy Expressions."
17820
+ "description": "The desired view/page you want data from.",
17821
+ "inheritedFrom": {
17822
+ "name": "GenesisGridDatasourceElement",
17823
+ "module": "src/datasource/base.datasource.ts"
17824
+ }
18029
17825
  },
18030
17826
  {
18031
17827
  "kind": "field",
18032
- "name": "valueKey",
17828
+ "name": "fields",
18033
17829
  "type": {
18034
17830
  "text": "string"
18035
17831
  },
18036
- "privacy": "public",
18037
- "description": "The key used as the value sent to the server"
17832
+ "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.",
17833
+ "inheritedFrom": {
17834
+ "name": "GenesisGridDatasourceElement",
17835
+ "module": "src/datasource/base.datasource.ts"
17836
+ }
18038
17837
  },
18039
17838
  {
18040
17839
  "kind": "field",
18041
- "name": "labelKey",
17840
+ "name": "maxView",
18042
17841
  "type": {
18043
- "text": "string"
17842
+ "text": "number"
18044
17843
  },
18045
- "privacy": "public",
18046
- "description": "The key used as the label displayed in the UI"
17844
+ "description": "Maximum number of rows to track as part of a client \"view\".",
17845
+ "inheritedFrom": {
17846
+ "name": "GenesisGridDatasourceElement",
17847
+ "module": "src/datasource/base.datasource.ts"
17848
+ }
18047
17849
  },
18048
17850
  {
18049
17851
  "kind": "field",
18050
- "name": "dropdownPlacement",
17852
+ "name": "movingView",
18051
17853
  "type": {
18052
- "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
17854
+ "text": "boolean"
18053
17855
  },
18054
- "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"
17856
+ "default": "false",
17857
+ "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.",
17858
+ "inheritedFrom": {
17859
+ "name": "GenesisGridDatasourceElement",
17860
+ "module": "src/datasource/base.datasource.ts"
17861
+ }
17862
+ },
17863
+ {
17864
+ "kind": "field",
17865
+ "name": "reverse",
17866
+ "type": {
17867
+ "text": "boolean"
17868
+ },
17869
+ "default": "false",
17870
+ "description": "Option that changes the Data Server index iteration.",
17871
+ "inheritedFrom": {
17872
+ "name": "GenesisGridDatasourceElement",
17873
+ "module": "src/datasource/base.datasource.ts"
17874
+ }
17875
+ },
17876
+ {
17877
+ "kind": "field",
17878
+ "name": "disablePolling",
17879
+ "type": {
17880
+ "text": "boolean"
17881
+ },
17882
+ "default": "false",
17883
+ "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
17884
+ "inheritedFrom": {
17885
+ "name": "GenesisGridDatasourceElement",
17886
+ "module": "src/datasource/base.datasource.ts"
17887
+ }
18055
17888
  },
18056
17889
  {
18057
17890
  "kind": "field",
18058
- "name": "dropdownWidth",
17891
+ "name": "offset",
18059
17892
  "type": {
18060
17893
  "text": "number"
18061
17894
  },
18062
- "privacy": "public",
18063
- "description": "Optionally specifies the width of the dropdown"
17895
+ "description": "The offset for pagination in REQUEST_SERVER scenarios.",
17896
+ "inheritedFrom": {
17897
+ "name": "GenesisGridDatasourceElement",
17898
+ "module": "src/datasource/base.datasource.ts"
17899
+ }
18064
17900
  },
18065
17901
  {
18066
17902
  "kind": "field",
18067
- "name": "request",
17903
+ "name": "pollingInterval",
18068
17904
  "type": {
18069
- "text": "object"
17905
+ "text": "number"
18070
17906
  },
18071
- "privacy": "public",
18072
- "description": "A request object to pass in the reqrep"
17907
+ "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
17908
+ "inheritedFrom": {
17909
+ "name": "GenesisGridDatasourceElement",
17910
+ "module": "src/datasource/base.datasource.ts"
17911
+ }
18073
17912
  },
18074
17913
  {
18075
17914
  "kind": "field",
18076
- "name": "columnDefinitions",
17915
+ "name": "pollTriggerEvents",
18077
17916
  "type": {
18078
- "text": "ColDef[]"
17917
+ "text": "string[]"
18079
17918
  },
18080
- "privacy": "public",
18081
- "description": "An array of AG Grid column definitions to use in the grid to display the data"
17919
+ "default": "[]",
17920
+ "description": "Array of event names that will trigger a poll when received as commit responses.",
17921
+ "inheritedFrom": {
17922
+ "name": "GenesisGridDatasourceElement",
17923
+ "module": "src/datasource/base.datasource.ts"
17924
+ }
18082
17925
  },
18083
17926
  {
18084
17927
  "kind": "field",
18085
- "name": "baseCriteria",
17928
+ "name": "request",
18086
17929
  "type": {
18087
- "text": "string | undefined"
17930
+ "text": "any"
18088
17931
  },
18089
- "privacy": "public",
18090
- "description": "Base criteria that is always applied to requests combined with search criteria via AND.\nUse this to pre-filter results."
17932
+ "description": "Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.",
17933
+ "inheritedFrom": {
17934
+ "name": "GenesisGridDatasourceElement",
17935
+ "module": "src/datasource/base.datasource.ts"
17936
+ }
18091
17937
  },
18092
17938
  {
18093
17939
  "kind": "field",
18094
- "name": "defaultSlottedNodes",
17940
+ "name": "requestAutoSetup",
18095
17941
  "type": {
18096
- "text": "Node[]"
17942
+ "text": "boolean"
18097
17943
  },
18098
- "privacy": "public",
18099
- "default": "[]"
17944
+ "default": "true",
17945
+ "description": "Attribute to set whether the REQUEST object should be automatically set up.",
17946
+ "inheritedFrom": {
17947
+ "name": "GenesisGridDatasourceElement",
17948
+ "module": "src/datasource/base.datasource.ts"
17949
+ }
18100
17950
  },
18101
17951
  {
18102
17952
  "kind": "field",
18103
- "name": "grid",
18104
- "type": {
18105
- "text": "GridPro"
18106
- },
18107
- "privacy": "public"
17953
+ "name": "rowIdAttr",
17954
+ "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
17955
+ "inheritedFrom": {
17956
+ "name": "GenesisGridDatasourceElement",
17957
+ "module": "src/datasource/base.datasource.ts"
17958
+ }
18108
17959
  },
18109
17960
  {
18110
17961
  "kind": "field",
18111
- "name": "_value",
17962
+ "name": "restartOnReconnection",
18112
17963
  "type": {
18113
- "text": "string"
17964
+ "text": "boolean"
18114
17965
  },
18115
- "privacy": "private"
18116
- },
18117
- {
18118
- "kind": "field",
18119
- "name": "value",
18120
- "type": {
18121
- "text": "string"
17966
+ "default": "true",
17967
+ "description": "Attribute to set whether the datasource should restart when it reconnects.",
17968
+ "inheritedFrom": {
17969
+ "name": "GenesisGridDatasourceElement",
17970
+ "module": "src/datasource/base.datasource.ts"
18122
17971
  }
18123
17972
  },
18124
17973
  {
18125
17974
  "kind": "field",
18126
- "name": "filterSearch",
17975
+ "name": "defaultRowIdByResourceType",
18127
17976
  "type": {
18128
17977
  "text": "string"
18129
17978
  },
18130
- "privacy": "public",
18131
- "description": "The criteria to search by"
17979
+ "privacy": "protected",
17980
+ "readonly": true,
17981
+ "inheritedFrom": {
17982
+ "name": "GenesisGridDatasourceElement",
17983
+ "module": "src/datasource/base.datasource.ts"
17984
+ }
18132
17985
  },
18133
17986
  {
18134
17987
  "kind": "field",
18135
- "name": "open",
17988
+ "name": "criteriaFromFilters",
18136
17989
  "type": {
18137
- "text": "boolean"
17990
+ "text": "Map<string, string>"
18138
17991
  },
18139
- "privacy": "public",
18140
- "description": "Whether the dropdown is open or not"
17992
+ "privacy": "protected",
17993
+ "default": "new Map()",
17994
+ "inheritedFrom": {
17995
+ "name": "GenesisGridDatasourceElement",
17996
+ "module": "src/datasource/base.datasource.ts"
17997
+ }
18141
17998
  },
18142
17999
  {
18143
18000
  "kind": "field",
18144
- "name": "selectedRow",
18001
+ "name": "update",
18145
18002
  "type": {
18146
- "text": "object"
18003
+ "text": "BehaviorSubject<Map<string, string>>"
18147
18004
  },
18148
- "description": "Data for the selected row"
18005
+ "privacy": "protected",
18006
+ "default": "new BehaviorSubject(new Map())",
18007
+ "inheritedFrom": {
18008
+ "name": "GenesisGridDatasourceElement",
18009
+ "module": "src/datasource/base.datasource.ts"
18010
+ }
18149
18011
  },
18150
18012
  {
18151
- "kind": "field",
18152
- "name": "displayValue",
18153
- "description": "Value to display in the form field",
18154
- "readonly": true
18013
+ "kind": "method",
18014
+ "name": "datasourceOptions",
18015
+ "privacy": "protected",
18016
+ "return": {
18017
+ "type": {
18018
+ "text": "DatasourceOptions"
18019
+ }
18020
+ },
18021
+ "inheritedFrom": {
18022
+ "name": "GenesisGridDatasourceElement",
18023
+ "module": "src/datasource/base.datasource.ts"
18024
+ }
18155
18025
  },
18156
18026
  {
18157
- "kind": "field",
18158
- "name": "hasSearchKey",
18159
- "type": {
18160
- "text": "boolean"
18027
+ "kind": "method",
18028
+ "name": "buildCriteria",
18029
+ "privacy": "private",
18030
+ "return": {
18031
+ "type": {
18032
+ "text": "string"
18033
+ }
18161
18034
  },
18162
- "readonly": true
18035
+ "inheritedFrom": {
18036
+ "name": "GenesisGridDatasourceElement",
18037
+ "module": "src/datasource/base.datasource.ts"
18038
+ }
18163
18039
  },
18164
18040
  {
18165
18041
  "kind": "field",
18166
- "name": "hasSlottedContent",
18042
+ "name": "isRequestServer",
18167
18043
  "type": {
18168
18044
  "text": "boolean"
18169
18045
  },
18170
- "readonly": true
18046
+ "readonly": true,
18047
+ "inheritedFrom": {
18048
+ "name": "GenesisGridDatasourceElement",
18049
+ "module": "src/datasource/base.datasource.ts"
18050
+ }
18171
18051
  },
18172
18052
  {
18173
18053
  "kind": "method",
18174
- "name": "setGridRowData",
18175
- "privacy": "private",
18054
+ "name": "datasourceStatusChanged",
18176
18055
  "parameters": [
18177
18056
  {
18178
- "name": "rows",
18057
+ "name": "prev",
18179
18058
  "type": {
18180
- "text": "any[]"
18059
+ "text": "DatasourceStatus"
18181
18060
  }
18182
- }
18183
- ],
18184
- "description": "Sets row data on the grid in a version-safe way.\nAG Grid v32+ removed `setRowData` in favour of `updateGridOptions`."
18185
- },
18186
- {
18187
- "kind": "method",
18188
- "name": "setGridColumnDefs",
18189
- "privacy": "private",
18190
- "parameters": [
18061
+ },
18191
18062
  {
18192
- "name": "colDefs",
18063
+ "name": "next",
18193
18064
  "type": {
18194
- "text": "ColDef[]"
18065
+ "text": "DatasourceStatus"
18195
18066
  }
18196
18067
  }
18197
18068
  ],
18198
- "description": "Sets column defs on the grid in a version-safe way.\nAG Grid v32+ removed `setColumnDefs` in favour of `updateGridOptions`."
18069
+ "inheritedFrom": {
18070
+ "name": "GenesisGridDatasourceElement",
18071
+ "module": "src/datasource/base.datasource.ts"
18072
+ }
18199
18073
  },
18200
18074
  {
18201
18075
  "kind": "method",
18202
- "name": "emitValue",
18203
- "privacy": "private",
18076
+ "name": "handleErrors",
18204
18077
  "parameters": [
18205
18078
  {
18206
- "name": "value",
18079
+ "name": "errors",
18207
18080
  "type": {
18208
- "text": "string"
18209
- }
18081
+ "text": "string | any[]"
18082
+ },
18083
+ "description": "The error message or array of error messages"
18084
+ },
18085
+ {
18086
+ "name": "type",
18087
+ "default": "'unknown'",
18088
+ "type": {
18089
+ "text": "BaseDatasourceErrorEventDetail['type']"
18090
+ },
18091
+ "description": "The type of error that occurred"
18210
18092
  }
18211
18093
  ],
18212
- "description": "Emits 'change' and 'input' events so that the `sync` directive and forms work correctly."
18213
- },
18214
- {
18215
- "kind": "method",
18216
- "name": "toggle",
18217
- "privacy": "public"
18218
- },
18219
- {
18220
- "kind": "method",
18221
- "name": "getAndSetRows",
18222
- "privacy": "private"
18223
- },
18224
- {
18225
- "kind": "field",
18226
- "name": "getAndSetRowsDebounce",
18227
- "privacy": "private"
18228
- },
18229
- {
18230
- "kind": "method",
18231
- "name": "filterSearchChanged",
18232
- "privacy": "public"
18233
- },
18234
- {
18235
- "kind": "method",
18236
- "name": "requestChanged",
18237
- "privacy": "public"
18094
+ "description": "Handles errors and emits appropriate error events.",
18095
+ "privacy": "public",
18096
+ "inheritedFrom": {
18097
+ "name": "GenesisGridDatasourceElement",
18098
+ "module": "src/datasource/base.datasource.ts"
18099
+ }
18238
18100
  },
18239
18101
  {
18240
18102
  "kind": "method",
18241
- "name": "columnDefinitionsChanged",
18242
- "privacy": "public"
18103
+ "name": "clearErrors",
18104
+ "description": "Clears error state and emits connected event.",
18105
+ "privacy": "public",
18106
+ "inheritedFrom": {
18107
+ "name": "GenesisGridDatasourceElement",
18108
+ "module": "src/datasource/base.datasource.ts"
18109
+ }
18243
18110
  },
18244
18111
  {
18245
18112
  "kind": "field",
18246
- "name": "handleClickOutside",
18247
- "privacy": "private"
18248
- },
18249
- {
18250
- "kind": "method",
18251
- "name": "openChanged",
18252
- "privacy": "public"
18253
- },
18254
- {
18255
- "kind": "method",
18256
- "name": "dropdownWidthChanged",
18257
- "privacy": "public"
18113
+ "name": "_presentation",
18114
+ "type": {
18115
+ "text": "ComponentPresentation | null | undefined"
18116
+ },
18117
+ "privacy": "private",
18118
+ "default": "void 0",
18119
+ "inheritedFrom": {
18120
+ "name": "FoundationElement",
18121
+ "module": "src/foundation-element/foundation-element.ts"
18122
+ }
18258
18123
  },
18259
18124
  {
18260
- "kind": "method",
18261
- "name": "changeHandler",
18125
+ "kind": "field",
18126
+ "name": "$presentation",
18127
+ "type": {
18128
+ "text": "ComponentPresentation | null"
18129
+ },
18262
18130
  "privacy": "public",
18263
- "parameters": [
18264
- {
18265
- "name": "event",
18266
- "type": {
18267
- "text": "Event"
18268
- }
18269
- }
18270
- ]
18131
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
18132
+ "inheritedFrom": {
18133
+ "name": "FoundationElement",
18134
+ "module": "src/foundation-element/foundation-element.ts"
18135
+ }
18271
18136
  },
18272
18137
  {
18273
- "kind": "method",
18274
- "name": "cloneNode",
18275
- "return": {
18276
- "type": {
18277
- "text": "Node"
18278
- }
18138
+ "kind": "field",
18139
+ "name": "template",
18140
+ "type": {
18141
+ "text": "ElementViewTemplate | void | null"
18279
18142
  },
18280
- "parameters": [
18281
- {
18282
- "name": "deep",
18283
- "optional": true,
18284
- "type": {
18285
- "text": "boolean"
18286
- }
18287
- }
18288
- ],
18143
+ "privacy": "public",
18144
+ "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.",
18289
18145
  "inheritedFrom": {
18290
- "name": "LifecycleMixin",
18291
- "module": "src/mixins/lifecycle/lifecycle.ts"
18146
+ "name": "FoundationElement",
18147
+ "module": "src/foundation-element/foundation-element.ts"
18292
18148
  }
18293
18149
  },
18294
18150
  {
18295
18151
  "kind": "method",
18296
- "name": "deepClone",
18152
+ "name": "templateChanged",
18153
+ "privacy": "protected",
18297
18154
  "return": {
18298
18155
  "type": {
18299
- "text": "Node"
18156
+ "text": "void"
18300
18157
  }
18301
18158
  },
18302
18159
  "inheritedFrom": {
18303
- "name": "LifecycleMixin",
18304
- "module": "src/mixins/lifecycle/lifecycle.ts"
18160
+ "name": "FoundationElement",
18161
+ "module": "src/foundation-element/foundation-element.ts"
18305
18162
  }
18306
18163
  },
18307
18164
  {
18308
18165
  "kind": "field",
18309
- "name": "shouldRunDisconnect",
18310
- "return": {
18311
- "type": {
18312
- "text": ""
18313
- }
18166
+ "name": "styles",
18167
+ "type": {
18168
+ "text": "ElementStyles | void | null"
18314
18169
  },
18315
- "readonly": true,
18170
+ "privacy": "public",
18171
+ "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.",
18316
18172
  "inheritedFrom": {
18317
- "name": "LifecycleMixin",
18318
- "module": "src/mixins/lifecycle/lifecycle.ts"
18173
+ "name": "FoundationElement",
18174
+ "module": "src/foundation-element/foundation-element.ts"
18319
18175
  }
18320
18176
  },
18321
18177
  {
18322
- "kind": "field",
18323
- "name": "shouldRunConnect",
18178
+ "kind": "method",
18179
+ "name": "stylesChanged",
18180
+ "privacy": "protected",
18324
18181
  "return": {
18325
18182
  "type": {
18326
- "text": ""
18183
+ "text": "void"
18327
18184
  }
18328
18185
  },
18329
- "readonly": true,
18330
18186
  "inheritedFrom": {
18331
- "name": "LifecycleMixin",
18332
- "module": "src/mixins/lifecycle/lifecycle.ts"
18187
+ "name": "FoundationElement",
18188
+ "module": "src/foundation-element/foundation-element.ts"
18333
18189
  }
18334
18190
  },
18335
18191
  {
18336
18192
  "kind": "method",
18337
- "name": "#_blockLifecycleDueToTokenChange",
18193
+ "name": "compose",
18194
+ "privacy": "public",
18195
+ "static": true,
18338
18196
  "return": {
18339
18197
  "type": {
18340
- "text": "boolean"
18198
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
18341
18199
  }
18342
18200
  },
18343
18201
  "parameters": [
18344
18202
  {
18345
- "name": "lifecycleType",
18203
+ "name": "this",
18346
18204
  "type": {
18347
- "text": "Lifecycletype"
18205
+ "text": "K"
18348
18206
  }
18207
+ },
18208
+ {
18209
+ "name": "elementDefinition",
18210
+ "type": {
18211
+ "text": "T"
18212
+ },
18213
+ "description": "The definition of the element to create the registry\nfunction for."
18349
18214
  }
18350
18215
  ],
18216
+ "description": "Defines an element registry function with a set of element definition defaults.",
18351
18217
  "inheritedFrom": {
18352
- "name": "LifecycleMixin",
18353
- "module": "src/mixins/lifecycle/lifecycle.ts"
18218
+ "name": "FoundationElement",
18219
+ "module": "src/foundation-element/foundation-element.ts"
18220
+ }
18221
+ }
18222
+ ],
18223
+ "events": [
18224
+ {
18225
+ "description": "Fired when a datasource error is reported",
18226
+ "name": "base-datasource-error",
18227
+ "inheritedFrom": {
18228
+ "name": "GenesisGridDatasourceElement",
18229
+ "module": "src/datasource/base.datasource.ts"
18354
18230
  }
18355
18231
  },
18356
18232
  {
18357
- "kind": "field",
18358
- "name": "_presentation",
18233
+ "description": "Fired when a datasource error occurs (for grid integration)",
18234
+ "name": "datasource-error",
18235
+ "inheritedFrom": {
18236
+ "name": "GenesisGridDatasourceElement",
18237
+ "module": "src/datasource/base.datasource.ts"
18238
+ }
18239
+ },
18240
+ {
18241
+ "description": "Fired when error state is cleared after connection succeeds",
18242
+ "name": "base-datasource-connected",
18243
+ "inheritedFrom": {
18244
+ "name": "GenesisGridDatasourceElement",
18245
+ "module": "src/datasource/base.datasource.ts"
18246
+ }
18247
+ },
18248
+ {
18249
+ "description": "Fired when loading completes with no pending row changes",
18250
+ "name": "datasource-loading-finished",
18251
+ "inheritedFrom": {
18252
+ "name": "GenesisGridDatasourceElement",
18253
+ "module": "src/datasource/base.datasource.ts"
18254
+ }
18255
+ },
18256
+ {
18257
+ "description": "Fired when the grid has no rows after load",
18258
+ "name": "datasource-no-data-available",
18259
+ "inheritedFrom": {
18260
+ "name": "GenesisGridDatasourceElement",
18261
+ "module": "src/datasource/base.datasource.ts"
18262
+ }
18263
+ },
18264
+ {
18265
+ "description": "Fired when row data changes from stream updates",
18266
+ "name": "datasource-data-changed",
18267
+ "inheritedFrom": {
18268
+ "name": "GenesisGridDatasourceElement",
18269
+ "module": "src/datasource/base.datasource.ts"
18270
+ }
18271
+ },
18272
+ {
18273
+ "description": "Fired to hand off grid options and initialization flags",
18274
+ "name": "datasource-initialize"
18275
+ },
18276
+ {
18277
+ "description": "Fired when the datasource is torn down",
18278
+ "name": "datasource-destroy"
18279
+ },
18280
+ {
18281
+ "description": "Fired when row data is cleared",
18282
+ "name": "datasource-data-cleared"
18283
+ },
18284
+ {
18285
+ "description": "Fired when column metadata or defs are updated",
18286
+ "name": "datasource-schema-updated"
18287
+ },
18288
+ {
18289
+ "description": "Fired when persisted filters are reapplied",
18290
+ "name": "datasource-filters-restored"
18291
+ },
18292
+ {
18293
+ "description": "Fired when a data payload is loaded for the grid",
18294
+ "name": "datasource-data-loaded"
18295
+ },
18296
+ {
18297
+ "description": "Fired when a load or refresh starts",
18298
+ "name": "datasource-loading-started"
18299
+ },
18300
+ {
18301
+ "description": "Fired when more server rows can be requested",
18302
+ "name": "datasource-more-data-available"
18303
+ },
18304
+ {
18305
+ "description": "Fired when the host grid is ready (detail includes pagination state)",
18306
+ "name": "datasource-ready"
18307
+ },
18308
+ {
18309
+ "description": "Fired when initial grid data is ready for the client-side model",
18310
+ "name": "datasource-init"
18311
+ },
18312
+ {
18313
+ "description": "Fired when MORE_ROWS availability changes",
18314
+ "name": "more-rows-changed"
18315
+ },
18316
+ {
18317
+ "description": "Fired when layout or viewport sizing affects the datasource",
18318
+ "name": "datasource-size-changed"
18319
+ }
18320
+ ],
18321
+ "attributes": [
18322
+ {
18323
+ "name": "keep-col-defs-on-clear-row-data",
18359
18324
  "type": {
18360
- "text": "ComponentPresentation | null | undefined"
18325
+ "text": "boolean"
18361
18326
  },
18362
- "privacy": "private",
18363
- "default": "void 0",
18327
+ "default": "false",
18328
+ "fieldName": "keepColDefsOnClearRowData"
18329
+ },
18330
+ {
18331
+ "name": "criteria",
18332
+ "type": {
18333
+ "text": "string"
18334
+ },
18335
+ "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
18336
+ "fieldName": "criteria",
18364
18337
  "inheritedFrom": {
18365
- "name": "FoundationElement",
18366
- "module": "src/foundation-element/foundation-element.ts"
18338
+ "name": "GenesisGridDatasourceElement",
18339
+ "module": "src/datasource/base.datasource.ts"
18367
18340
  }
18368
18341
  },
18369
18342
  {
18370
- "kind": "field",
18371
- "name": "$presentation",
18343
+ "name": "is-snapshot",
18372
18344
  "type": {
18373
- "text": "ComponentPresentation | null"
18345
+ "text": "boolean"
18374
18346
  },
18375
- "privacy": "public",
18376
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
18347
+ "default": "false",
18348
+ "description": "Request a snapshot from the server.",
18349
+ "fieldName": "isSnapshot",
18377
18350
  "inheritedFrom": {
18378
- "name": "FoundationElement",
18379
- "module": "src/foundation-element/foundation-element.ts"
18351
+ "name": "GenesisGridDatasourceElement",
18352
+ "module": "src/datasource/base.datasource.ts"
18380
18353
  }
18381
18354
  },
18382
18355
  {
18383
- "kind": "field",
18384
- "name": "template",
18356
+ "name": "max-rows",
18385
18357
  "type": {
18386
- "text": "ElementViewTemplate | void | null"
18358
+ "text": "number"
18387
18359
  },
18388
- "privacy": "public",
18389
- "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.",
18360
+ "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
18361
+ "fieldName": "maxRows",
18390
18362
  "inheritedFrom": {
18391
- "name": "FoundationElement",
18392
- "module": "src/foundation-element/foundation-element.ts"
18363
+ "name": "GenesisGridDatasourceElement",
18364
+ "module": "src/datasource/base.datasource.ts"
18393
18365
  }
18394
18366
  },
18395
18367
  {
18396
- "kind": "method",
18397
- "name": "templateChanged",
18398
- "privacy": "protected",
18399
- "return": {
18400
- "type": {
18401
- "text": "void"
18402
- }
18368
+ "name": "order-by",
18369
+ "type": {
18370
+ "text": "string"
18403
18371
  },
18372
+ "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.",
18373
+ "fieldName": "orderBy",
18404
18374
  "inheritedFrom": {
18405
- "name": "FoundationElement",
18406
- "module": "src/foundation-element/foundation-element.ts"
18375
+ "name": "GenesisGridDatasourceElement",
18376
+ "module": "src/datasource/base.datasource.ts"
18407
18377
  }
18408
18378
  },
18409
18379
  {
18410
- "kind": "field",
18411
- "name": "styles",
18380
+ "name": "resource-name",
18412
18381
  "type": {
18413
- "text": "ElementStyles | void | null"
18382
+ "text": "string"
18414
18383
  },
18415
- "privacy": "public",
18416
- "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.",
18384
+ "description": "The name of the target Data Server query or Request Server requestReply.",
18385
+ "fieldName": "resourceName",
18417
18386
  "inheritedFrom": {
18418
- "name": "FoundationElement",
18419
- "module": "src/foundation-element/foundation-element.ts"
18387
+ "name": "GenesisGridDatasourceElement",
18388
+ "module": "src/datasource/base.datasource.ts"
18420
18389
  }
18421
18390
  },
18422
18391
  {
18423
- "kind": "method",
18424
- "name": "stylesChanged",
18425
- "privacy": "protected",
18426
- "return": {
18427
- "type": {
18428
- "text": "void"
18429
- }
18392
+ "name": "view-number",
18393
+ "type": {
18394
+ "text": "number"
18430
18395
  },
18396
+ "description": "The desired view/page you want data from.",
18397
+ "fieldName": "viewNumber",
18431
18398
  "inheritedFrom": {
18432
- "name": "FoundationElement",
18433
- "module": "src/foundation-element/foundation-element.ts"
18399
+ "name": "GenesisGridDatasourceElement",
18400
+ "module": "src/datasource/base.datasource.ts"
18434
18401
  }
18435
18402
  },
18436
18403
  {
18437
- "kind": "method",
18438
- "name": "compose",
18439
- "privacy": "public",
18440
- "static": true,
18441
- "return": {
18442
- "type": {
18443
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
18444
- }
18404
+ "name": "fields",
18405
+ "type": {
18406
+ "text": "string"
18445
18407
  },
18446
- "parameters": [
18447
- {
18448
- "name": "this",
18449
- "type": {
18450
- "text": "K"
18451
- }
18452
- },
18453
- {
18454
- "name": "elementDefinition",
18455
- "type": {
18456
- "text": "T"
18457
- },
18458
- "description": "The definition of the element to create the registry\nfunction for."
18459
- }
18460
- ],
18461
- "description": "Defines an element registry function with a set of element definition defaults.",
18408
+ "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.",
18409
+ "fieldName": "fields",
18462
18410
  "inheritedFrom": {
18463
- "name": "FoundationElement",
18464
- "module": "src/foundation-element/foundation-element.ts"
18411
+ "name": "GenesisGridDatasourceElement",
18412
+ "module": "src/datasource/base.datasource.ts"
18465
18413
  }
18466
- }
18467
- ],
18468
- "events": [
18469
- {
18470
- "description": "Fired when the selected value changes",
18471
- "name": "change"
18472
18414
  },
18473
18415
  {
18474
- "description": "Fired when the value is updated (including programmatic changes)",
18475
- "name": "input"
18476
- }
18477
- ],
18478
- "attributes": [
18479
- {
18416
+ "name": "max-view",
18480
18417
  "type": {
18481
- "text": "boolean"
18418
+ "text": "number"
18482
18419
  },
18483
- "description": "Whether to disable control of the component",
18484
- "fieldName": "disabled"
18420
+ "description": "Maximum number of rows to track as part of a client \"view\".",
18421
+ "fieldName": "maxView",
18422
+ "inheritedFrom": {
18423
+ "name": "GenesisGridDatasourceElement",
18424
+ "module": "src/datasource/base.datasource.ts"
18425
+ }
18485
18426
  },
18486
18427
  {
18487
- "name": "resource-name",
18428
+ "name": "moving-view",
18488
18429
  "type": {
18489
- "text": "string"
18430
+ "text": "boolean"
18490
18431
  },
18491
- "description": "The name of the reqrep to get the options from",
18492
- "fieldName": "resourceName"
18432
+ "default": "false",
18433
+ "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.",
18434
+ "fieldName": "movingView",
18435
+ "inheritedFrom": {
18436
+ "name": "GenesisGridDatasourceElement",
18437
+ "module": "src/datasource/base.datasource.ts"
18438
+ }
18493
18439
  },
18494
18440
  {
18495
- "name": "search-key",
18496
18441
  "type": {
18497
- "text": "string | string[] | undefined"
18442
+ "text": "number"
18498
18443
  },
18499
- "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\").",
18500
- "fieldName": "searchKey"
18444
+ "description": "Option that changes the Data Server index iteration.",
18445
+ "fieldName": "reverse",
18446
+ "default": "false",
18447
+ "inheritedFrom": {
18448
+ "name": "GenesisGridDatasourceElement",
18449
+ "module": "src/datasource/base.datasource.ts"
18450
+ }
18501
18451
  },
18502
18452
  {
18503
- "name": "advanced-search-req",
18453
+ "name": "disable-polling",
18504
18454
  "type": {
18505
18455
  "text": "boolean"
18506
18456
  },
18507
18457
  "default": "false",
18508
- "description": "Tells whether a given request supports lookup by Groovy Expressions.",
18509
- "fieldName": "requestSupportsAdvancedSearch"
18458
+ "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
18459
+ "fieldName": "disablePolling",
18460
+ "inheritedFrom": {
18461
+ "name": "GenesisGridDatasourceElement",
18462
+ "module": "src/datasource/base.datasource.ts"
18463
+ }
18510
18464
  },
18511
18465
  {
18512
- "name": "value-key",
18466
+ "name": "polling-interval",
18513
18467
  "type": {
18514
- "text": "string"
18468
+ "text": "number"
18515
18469
  },
18516
- "description": "The key used as the value sent to the server",
18517
- "fieldName": "valueKey"
18470
+ "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
18471
+ "fieldName": "pollingInterval",
18472
+ "inheritedFrom": {
18473
+ "name": "GenesisGridDatasourceElement",
18474
+ "module": "src/datasource/base.datasource.ts"
18475
+ }
18518
18476
  },
18519
18477
  {
18520
- "name": "label-key",
18478
+ "name": "request-auto-setup",
18521
18479
  "type": {
18522
- "text": "string"
18480
+ "text": "boolean"
18523
18481
  },
18524
- "description": "The key used as the label displayed in the UI",
18525
- "fieldName": "labelKey"
18482
+ "default": "true",
18483
+ "description": "Attribute to set whether the REQUEST object should be automatically set up.",
18484
+ "fieldName": "requestAutoSetup",
18485
+ "inheritedFrom": {
18486
+ "name": "GenesisGridDatasourceElement",
18487
+ "module": "src/datasource/base.datasource.ts"
18488
+ }
18526
18489
  },
18527
18490
  {
18528
- "name": "dropdown-placement",
18529
- "type": {
18530
- "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
18531
- },
18532
- "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",
18533
- "fieldName": "dropdownPlacement"
18491
+ "name": "row-id",
18492
+ "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
18493
+ "fieldName": "rowIdAttr",
18494
+ "inheritedFrom": {
18495
+ "name": "GenesisGridDatasourceElement",
18496
+ "module": "src/datasource/base.datasource.ts"
18497
+ }
18534
18498
  },
18535
18499
  {
18536
- "name": "dropdownWidth",
18500
+ "name": "restart-on-reconnection",
18537
18501
  "type": {
18538
- "text": "number"
18502
+ "text": "boolean"
18539
18503
  },
18540
- "description": "Optionally specifies the width of the dropdown",
18541
- "fieldName": "dropdownWidth"
18504
+ "default": "true",
18505
+ "description": "Attribute to set whether the datasource should restart when it reconnects.",
18506
+ "fieldName": "restartOnReconnection",
18507
+ "inheritedFrom": {
18508
+ "name": "GenesisGridDatasourceElement",
18509
+ "module": "src/datasource/base.datasource.ts"
18510
+ }
18542
18511
  }
18543
18512
  ],
18544
18513
  "mixins": [
@@ -18548,42 +18517,73 @@
18548
18517
  }
18549
18518
  ],
18550
18519
  "superclass": {
18551
- "name": "FoundationElement",
18552
- "package": "@microsoft/fast-foundation"
18520
+ "name": "GridProBaseDatasource",
18521
+ "module": "/src/datasource/base.datasource"
18553
18522
  },
18554
- "tagName": "%%prefix%%-multicolumn-dropdown",
18523
+ "tagName": "grid-pro-genesis-datasource",
18555
18524
  "customElement": true
18525
+ }
18526
+ ],
18527
+ "exports": [
18528
+ {
18529
+ "kind": "js",
18530
+ "name": "GridProGenesisDatasource",
18531
+ "declaration": {
18532
+ "name": "GridProGenesisDatasource",
18533
+ "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
18534
+ }
18556
18535
  },
18557
18536
  {
18558
- "kind": "variable",
18559
- "name": "foundationMulticolumnDropdown",
18560
- "description": "A function that returns a Multicolumn Dropdown registration for configuring the component with a DesignSystem.",
18561
- "privacy": "public"
18537
+ "kind": "custom-element-definition",
18538
+ "name": "grid-pro-genesis-datasource",
18539
+ "declaration": {
18540
+ "name": "GridProGenesisDatasource",
18541
+ "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
18542
+ }
18562
18543
  }
18563
- ],
18544
+ ]
18545
+ },
18546
+ {
18547
+ "kind": "javascript-module",
18548
+ "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
18549
+ "declarations": [],
18550
+ "exports": []
18551
+ },
18552
+ {
18553
+ "kind": "javascript-module",
18554
+ "path": "src/grid-pro-genesis-datasource/index.ts",
18555
+ "declarations": [],
18564
18556
  "exports": [
18565
18557
  {
18566
18558
  "kind": "js",
18567
- "name": "wasClickOutsideElement",
18559
+ "name": "*",
18568
18560
  "declaration": {
18569
- "name": "wasClickOutsideElement",
18570
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
18561
+ "name": "*",
18562
+ "package": "./datasource-events.types"
18571
18563
  }
18572
18564
  },
18573
18565
  {
18574
18566
  "kind": "js",
18575
- "name": "MulticolumnDropdown",
18567
+ "name": "*",
18576
18568
  "declaration": {
18577
- "name": "MulticolumnDropdown",
18578
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
18569
+ "name": "*",
18570
+ "package": "./grid-pro-genesis-datasource"
18579
18571
  }
18580
18572
  },
18581
18573
  {
18582
18574
  "kind": "js",
18583
- "name": "foundationMulticolumnDropdown",
18575
+ "name": "*",
18584
18576
  "declaration": {
18585
- "name": "foundationMulticolumnDropdown",
18586
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
18577
+ "name": "*",
18578
+ "package": "./grid-pro-genesis-datasource.config"
18579
+ }
18580
+ },
18581
+ {
18582
+ "kind": "js",
18583
+ "name": "*",
18584
+ "declaration": {
18585
+ "name": "*",
18586
+ "package": "./grid-pro-genesis-datasource.types"
18587
18587
  }
18588
18588
  }
18589
18589
  ]