@genesislcap/grid-pro 15.58.0 → 15.58.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -21012,344 +21012,218 @@
21012
21012
  },
21013
21013
  {
21014
21014
  "kind": "javascript-module",
21015
- "path": "src/multicolumn-dropdown/index.ts",
21016
- "declarations": [],
21017
- "exports": [
21018
- {
21019
- "kind": "js",
21020
- "name": "*",
21021
- "declaration": {
21022
- "name": "*",
21023
- "package": "./multicolumn-dropdown"
21024
- }
21025
- },
21026
- {
21027
- "kind": "js",
21028
- "name": "*",
21029
- "declaration": {
21030
- "name": "*",
21031
- "package": "./multicolumn-dropdown.styles"
21032
- }
21033
- },
21034
- {
21035
- "kind": "js",
21036
- "name": "*",
21037
- "declaration": {
21038
- "name": "*",
21039
- "package": "./multicolumn-dropdown.template"
21040
- }
21041
- }
21042
- ]
21043
- },
21044
- {
21045
- "kind": "javascript-module",
21046
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts",
21015
+ "path": "src/grid-pro-genesis-datasource/datasource-events.types.ts",
21047
21016
  "declarations": [
21048
21017
  {
21049
21018
  "kind": "variable",
21050
- "name": "dropdownWidthVar",
21051
- "type": {
21052
- "text": "string"
21053
- },
21054
- "default": "'--dropdown-width'",
21055
- "description": "The CSS variable to use for specifying the dropdown's width"
21056
- },
21057
- {
21058
- "kind": "variable",
21059
- "name": "optionsClass",
21060
- "type": {
21061
- "text": "string"
21062
- },
21063
- "default": "'options'",
21064
- "description": "The CSS class to use for the options element's class in the dropdown"
21065
- },
21066
- {
21067
- "kind": "variable",
21068
- "name": "DISPLAY_NONE_CLASS",
21019
+ "name": "datasourceEventNames",
21069
21020
  "type": {
21070
- "text": "string"
21071
- },
21072
- "default": "'dnone'",
21073
- "description": "Class name used to hide elements with display:none"
21074
- },
21075
- {
21076
- "kind": "variable",
21077
- "name": "multicolumnDropdownStyles",
21078
- "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`",
21079
- "description": "Multicolumn Dropdown styles.",
21080
- "privacy": "public"
21081
- }
21082
- ],
21083
- "exports": [
21084
- {
21085
- "kind": "js",
21086
- "name": "dropdownWidthVar",
21087
- "declaration": {
21088
- "name": "dropdownWidthVar",
21089
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
21090
- }
21091
- },
21092
- {
21093
- "kind": "js",
21094
- "name": "optionsClass",
21095
- "declaration": {
21096
- "name": "optionsClass",
21097
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
21098
- }
21099
- },
21100
- {
21101
- "kind": "js",
21102
- "name": "DISPLAY_NONE_CLASS",
21103
- "declaration": {
21104
- "name": "DISPLAY_NONE_CLASS",
21105
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
21106
- }
21107
- },
21108
- {
21109
- "kind": "js",
21110
- "name": "multicolumnDropdownStyles",
21111
- "declaration": {
21112
- "name": "multicolumnDropdownStyles",
21113
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
21114
- }
21115
- }
21116
- ]
21117
- },
21118
- {
21119
- "kind": "javascript-module",
21120
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts",
21121
- "declarations": [
21122
- {
21123
- "kind": "function",
21124
- "name": "getMulticolumnDropdownTemplate",
21125
- "parameters": [
21126
- {
21127
- "name": "designSystem",
21128
- "default": "'foundation'",
21129
- "description": "The design system prefix to use. Defaults to 'foundation'."
21130
- }
21131
- ],
21132
- "description": "Get a Design System prefixed Multicolumn Dropdown template.",
21133
- "return": {
21134
- "type": {
21135
- "text": ""
21136
- }
21021
+ "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\n // Infinite Row Model specific events\n setInfiniteDatasource: 'set-infinite-datasource',\n refreshInfiniteCache: 'refresh-infinite-cache',\n}"
21137
21022
  },
21138
- "privacy": "public"
21139
- },
21140
- {
21141
- "kind": "variable",
21142
- "name": "multicolumnDropdownTemplate",
21143
- "description": "The default Multicolumn Dropdown template using the 'foundation' design system prefix.",
21144
- "privacy": "public"
21023
+ "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\n // Infinite Row Model specific events\n setInfiniteDatasource: 'set-infinite-datasource',\n refreshInfiniteCache: 'refresh-infinite-cache',\n}",
21024
+ "description": "Event names for datasource-grid communication\nThese represent datasource operations, not grid-specific actions"
21145
21025
  }
21146
21026
  ],
21147
21027
  "exports": [
21148
21028
  {
21149
21029
  "kind": "js",
21150
- "name": "getMulticolumnDropdownTemplate",
21151
- "declaration": {
21152
- "name": "getMulticolumnDropdownTemplate",
21153
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
21154
- }
21155
- },
21156
- {
21157
- "kind": "js",
21158
- "name": "multicolumnDropdownTemplate",
21030
+ "name": "datasourceEventNames",
21159
21031
  "declaration": {
21160
- "name": "multicolumnDropdownTemplate",
21161
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
21032
+ "name": "datasourceEventNames",
21033
+ "module": "src/grid-pro-genesis-datasource/datasource-events.types.ts"
21162
21034
  }
21163
21035
  }
21164
21036
  ]
21165
21037
  },
21166
21038
  {
21167
21039
  "kind": "javascript-module",
21168
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.ts",
21040
+ "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts",
21169
21041
  "declarations": [
21170
- {
21171
- "kind": "function",
21172
- "name": "wasClickOutsideElement",
21173
- "parameters": [
21174
- {
21175
- "name": "event",
21176
- "type": {
21177
- "text": "MouseEvent"
21178
- }
21179
- },
21180
- {
21181
- "name": "target",
21182
- "type": {
21183
- "text": "EventTarget"
21184
- }
21185
- }
21186
- ],
21187
- "description": "Checks if the given mouse event occurred outside the target element.",
21188
- "privacy": "public"
21189
- },
21190
21042
  {
21191
21043
  "kind": "class",
21192
- "description": "",
21193
- "name": "MulticolumnDropdown",
21044
+ "description": "The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.",
21045
+ "name": "GridProGenesisDatasource",
21194
21046
  "members": [
21195
21047
  {
21196
21048
  "kind": "field",
21197
- "name": "optionsElement",
21049
+ "name": "cachedRowArray",
21198
21050
  "type": {
21199
- "text": "HTMLElement"
21200
- }
21051
+ "text": "any[]"
21052
+ },
21053
+ "privacy": "private",
21054
+ "default": "[]"
21201
21055
  },
21202
21056
  {
21203
21057
  "kind": "field",
21204
- "name": "lastRequest",
21058
+ "name": "transactionData",
21205
21059
  "type": {
21206
- "text": "object"
21060
+ "text": "TransactionData"
21207
21061
  },
21208
- "privacy": "private"
21062
+ "privacy": "protected",
21063
+ "default": "{\n add: [],\n remove: [],\n update: [],\n addIndex: 0,\n }",
21064
+ "inheritedFrom": {
21065
+ "name": "GridProBaseDatasource",
21066
+ "module": "src/datasource/base.datasource.ts"
21067
+ }
21209
21068
  },
21210
21069
  {
21211
- "kind": "field",
21212
- "name": "connectOverride",
21213
- "type": {
21214
- "text": "Connect"
21215
- },
21216
- "privacy": "private"
21070
+ "kind": "method",
21071
+ "name": "criteriaChanged",
21072
+ "parameters": [
21073
+ {
21074
+ "name": "oldCriteria",
21075
+ "type": {
21076
+ "text": "string"
21077
+ }
21078
+ },
21079
+ {
21080
+ "name": "newCriteria",
21081
+ "type": {
21082
+ "text": "string"
21083
+ }
21084
+ }
21085
+ ]
21217
21086
  },
21218
21087
  {
21219
- "kind": "field",
21220
- "name": "_connectDI",
21221
- "type": {
21222
- "text": "Connect"
21223
- },
21224
- "privacy": "private"
21088
+ "kind": "method",
21089
+ "name": "requestChanged",
21090
+ "parameters": [
21091
+ {
21092
+ "name": "oldRequest",
21093
+ "type": {
21094
+ "text": "string"
21095
+ }
21096
+ },
21097
+ {
21098
+ "name": "newRequest",
21099
+ "type": {
21100
+ "text": "string"
21101
+ }
21102
+ }
21103
+ ]
21225
21104
  },
21226
21105
  {
21227
- "kind": "field",
21228
- "name": "connect",
21229
- "type": {
21230
- "text": "Connect"
21231
- },
21232
- "description": "The connect service - uses DI by default, but can be manually set for dynamic element creation"
21106
+ "kind": "method",
21107
+ "name": "resourceNameChanged",
21108
+ "parameters": [
21109
+ {
21110
+ "name": "oldValue",
21111
+ "type": {
21112
+ "text": "string"
21113
+ }
21114
+ },
21115
+ {
21116
+ "name": "newValue",
21117
+ "type": {
21118
+ "text": "string"
21119
+ }
21120
+ }
21121
+ ]
21233
21122
  },
21234
21123
  {
21235
21124
  "kind": "field",
21236
- "name": "disabled",
21125
+ "name": "keepColDefsOnClearRowData",
21237
21126
  "type": {
21238
21127
  "text": "boolean"
21239
21128
  },
21240
21129
  "privacy": "public",
21241
- "description": "Whether to disable control of the component"
21242
- },
21243
- {
21244
- "kind": "field",
21245
- "name": "resourceName",
21246
- "type": {
21247
- "text": "string"
21248
- },
21249
- "privacy": "public",
21250
- "description": "The name of the reqrep to get the options from"
21251
- },
21252
- {
21253
- "kind": "field",
21254
- "name": "searchKey",
21255
- "type": {
21256
- "text": "string | string[] | undefined"
21257
- },
21258
- "privacy": "public",
21259
- "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\")."
21130
+ "default": "false",
21131
+ "inheritedFrom": {
21132
+ "name": "GridProBaseDatasource",
21133
+ "module": "src/datasource/base.datasource.ts"
21134
+ }
21260
21135
  },
21261
21136
  {
21262
21137
  "kind": "field",
21263
- "name": "requestSupportsAdvancedSearch",
21138
+ "name": "requestVisibleColumnsOnly",
21264
21139
  "type": {
21265
21140
  "text": "boolean"
21266
21141
  },
21267
- "privacy": "public",
21268
21142
  "default": "false",
21269
- "description": "Tells whether a given request supports lookup by Groovy Expressions."
21143
+ "description": "When enabled and column definitions are provided, the datasource requests data only for the\ncolumns that are currently visible. The visible set is seeded from the column config (columns\nnot flagged with `hide`) and updated by the host grid via `setVisibleColumns`; the data\nis reloaded whenever that set changes."
21270
21144
  },
21271
21145
  {
21272
21146
  "kind": "field",
21273
- "name": "valueKey",
21147
+ "name": "_visibleColumns",
21274
21148
  "type": {
21275
- "text": "string"
21149
+ "text": "string[] | undefined"
21276
21150
  },
21277
- "privacy": "public",
21278
- "description": "The key used as the value sent to the server"
21151
+ "privacy": "private"
21279
21152
  },
21280
21153
  {
21281
21154
  "kind": "field",
21282
- "name": "labelKey",
21155
+ "name": "dataSub",
21283
21156
  "type": {
21284
- "text": "string"
21157
+ "text": "Subscription"
21285
21158
  },
21286
- "privacy": "public",
21287
- "description": "The key used as the label displayed in the UI"
21159
+ "privacy": "private"
21288
21160
  },
21289
21161
  {
21290
21162
  "kind": "field",
21291
- "name": "dropdownPlacement",
21163
+ "name": "updateSub",
21292
21164
  "type": {
21293
- "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
21165
+ "text": "Subscription"
21294
21166
  },
21295
- "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"
21167
+ "privacy": "private"
21296
21168
  },
21297
21169
  {
21298
21170
  "kind": "field",
21299
- "name": "dropdownWidth",
21171
+ "name": "requiresFullRowDataAndColDefs",
21300
21172
  "type": {
21301
- "text": "number"
21173
+ "text": "boolean"
21302
21174
  },
21303
- "privacy": "public",
21304
- "description": "Optionally specifies the width of the dropdown"
21175
+ "privacy": "private",
21176
+ "default": "true"
21305
21177
  },
21306
21178
  {
21307
21179
  "kind": "field",
21308
- "name": "request",
21180
+ "name": "_lastMoreRows",
21309
21181
  "type": {
21310
- "text": "object"
21182
+ "text": "boolean"
21311
21183
  },
21312
- "privacy": "public",
21313
- "description": "A request object to pass in the reqrep"
21184
+ "privacy": "private",
21185
+ "default": "false"
21314
21186
  },
21315
21187
  {
21316
21188
  "kind": "field",
21317
- "name": "columnDefinitions",
21189
+ "name": "_isMoreRowsResult",
21318
21190
  "type": {
21319
- "text": "ColDef[]"
21191
+ "text": "boolean"
21320
21192
  },
21321
- "privacy": "public",
21322
- "description": "An array of AG Grid column definitions to use in the grid to display the data"
21193
+ "privacy": "private",
21194
+ "default": "false"
21323
21195
  },
21324
21196
  {
21325
21197
  "kind": "field",
21326
- "name": "baseCriteria",
21198
+ "name": "_pendingLoadMore",
21327
21199
  "type": {
21328
- "text": "string | undefined"
21200
+ "text": "number"
21329
21201
  },
21330
- "privacy": "public",
21331
- "description": "Base criteria that is always applied to requests combined with search criteria via AND.\nUse this to pre-filter results."
21202
+ "privacy": "private",
21203
+ "default": "0",
21204
+ "description": "How many MORE_ROWS sent by loadMore() are awaiting their reply. @internal"
21332
21205
  },
21333
21206
  {
21334
21207
  "kind": "field",
21335
- "name": "defaultSlottedNodes",
21208
+ "name": "_serverMoreRows",
21336
21209
  "type": {
21337
- "text": "Node[]"
21210
+ "text": "boolean | undefined"
21338
21211
  },
21339
- "privacy": "public",
21340
- "default": "[]"
21212
+ "privacy": "private",
21213
+ "description": "The latest MORE_ROWS the server sent. @internal"
21341
21214
  },
21342
21215
  {
21343
21216
  "kind": "field",
21344
- "name": "grid",
21217
+ "name": "_pagingStopped",
21345
21218
  "type": {
21346
- "text": "GridPro | GridProLegacy"
21219
+ "text": "'view-full' | 'stalled' | undefined"
21347
21220
  },
21348
- "privacy": "public"
21221
+ "privacy": "private",
21222
+ "description": "Set when Load More stops short of MORE_ROWS false - see notePagingStatus. @internal"
21349
21223
  },
21350
21224
  {
21351
21225
  "kind": "field",
21352
- "name": "_value",
21226
+ "name": "_sourceRef",
21353
21227
  "type": {
21354
21228
  "text": "string"
21355
21229
  },
@@ -21357,674 +21231,585 @@
21357
21231
  },
21358
21232
  {
21359
21233
  "kind": "field",
21360
- "name": "value",
21361
- "type": {
21362
- "text": "string"
21363
- }
21364
- },
21365
- {
21366
- "kind": "field",
21367
- "name": "filterSearch",
21368
- "type": {
21369
- "text": "string"
21370
- },
21371
- "privacy": "public",
21372
- "description": "The criteria to search by"
21373
- },
21374
- {
21375
- "kind": "field",
21376
- "name": "open",
21234
+ "name": "_nextOffset",
21377
21235
  "type": {
21378
- "text": "boolean"
21236
+ "text": "number"
21379
21237
  },
21380
- "privacy": "public",
21381
- "description": "Whether the dropdown is open or not"
21238
+ "privacy": "private",
21239
+ "default": "0"
21382
21240
  },
21383
21241
  {
21384
21242
  "kind": "field",
21385
- "name": "selectedRow",
21243
+ "name": "_loadMoreCount",
21386
21244
  "type": {
21387
- "text": "object"
21245
+ "text": "number"
21388
21246
  },
21389
- "description": "Data for the selected row"
21390
- },
21391
- {
21392
- "kind": "field",
21393
- "name": "displayValue",
21394
- "description": "Value to display in the form field",
21395
- "readonly": true
21247
+ "privacy": "private",
21248
+ "default": "0"
21396
21249
  },
21397
21250
  {
21398
21251
  "kind": "field",
21399
- "name": "hasSearchKey",
21252
+ "name": "onDatasourceReady",
21400
21253
  "type": {
21401
- "text": "boolean"
21254
+ "text": "EventListener"
21402
21255
  },
21256
+ "privacy": "private",
21403
21257
  "readonly": true
21404
21258
  },
21405
21259
  {
21406
- "kind": "field",
21407
- "name": "hasSlottedContent",
21408
- "type": {
21409
- "text": "boolean"
21260
+ "kind": "method",
21261
+ "name": "deepClone",
21262
+ "return": {
21263
+ "type": {
21264
+ "text": "Node"
21265
+ }
21410
21266
  },
21411
- "readonly": true
21267
+ "inheritedFrom": {
21268
+ "name": "LifecycleMixin",
21269
+ "module": "src/mixins/lifecycle/lifecycle.ts"
21270
+ }
21412
21271
  },
21413
21272
  {
21414
21273
  "kind": "method",
21415
- "name": "setGridRowData",
21274
+ "name": "colDefsDeepClone",
21416
21275
  "privacy": "private",
21276
+ "return": {
21277
+ "type": {
21278
+ "text": "ColDef[]"
21279
+ }
21280
+ },
21417
21281
  "parameters": [
21418
21282
  {
21419
- "name": "rows",
21283
+ "name": "key",
21420
21284
  "type": {
21421
- "text": "any[]"
21285
+ "text": "string"
21422
21286
  }
21423
- }
21424
- ],
21425
- "description": "Sets row data on the grid in a version-safe way.\nAG Grid v32+ removed `setRowData` in favour of `updateGridOptions`."
21426
- },
21427
- {
21428
- "kind": "method",
21429
- "name": "setGridColumnDefs",
21430
- "privacy": "private",
21431
- "parameters": [
21287
+ },
21432
21288
  {
21433
- "name": "colDefs",
21289
+ "name": "copy",
21434
21290
  "type": {
21435
- "text": "ColDef[]"
21291
+ "text": "any"
21436
21292
  }
21437
21293
  }
21438
- ],
21439
- "description": "Sets column defs on the grid in a version-safe way.\nAG Grid v32+ removed `setColumnDefs` in favour of `updateGridOptions`."
21294
+ ]
21440
21295
  },
21441
21296
  {
21442
21297
  "kind": "method",
21443
- "name": "emitValue",
21444
- "privacy": "private",
21298
+ "name": "init",
21445
21299
  "parameters": [
21446
21300
  {
21447
- "name": "value",
21301
+ "name": "keepColDefsOnClearRowData",
21302
+ "optional": true,
21448
21303
  "type": {
21449
- "text": "string"
21304
+ "text": "boolean"
21450
21305
  }
21306
+ },
21307
+ {
21308
+ "description": "Optionally set the `gridOptions` up with column definitions",
21309
+ "name": "columnDefinitions"
21310
+ },
21311
+ {
21312
+ "description": "Optionally set the grid up with column state",
21313
+ "name": "columnStates"
21451
21314
  }
21452
21315
  ],
21453
- "description": "Emits 'change' and 'input' events so that the `sync` directive and forms work correctly."
21454
- },
21455
- {
21456
- "kind": "method",
21457
- "name": "toggle",
21316
+ "description": "Initializes the datasource.",
21458
21317
  "privacy": "public"
21459
21318
  },
21460
21319
  {
21461
21320
  "kind": "method",
21462
- "name": "getAndSetRows",
21463
- "privacy": "private"
21464
- },
21465
- {
21466
- "kind": "field",
21467
- "name": "getAndSetRowsDebounce",
21321
+ "name": "clearReadyListener",
21468
21322
  "privacy": "private"
21469
21323
  },
21470
21324
  {
21471
21325
  "kind": "method",
21472
- "name": "filterSearchChanged",
21473
- "privacy": "public"
21326
+ "name": "destroy",
21327
+ "description": "Destroys the datasource, resetting it to its initial state.",
21328
+ "privacy": "public",
21329
+ "inheritedFrom": {
21330
+ "name": "GridProBaseDatasource",
21331
+ "module": "src/datasource/base.datasource.ts"
21332
+ }
21474
21333
  },
21475
21334
  {
21476
21335
  "kind": "method",
21477
- "name": "requestChanged",
21336
+ "name": "deinit",
21337
+ "description": "Deinitialises the datasource, resetting it to its initial state.",
21338
+ "deprecated": "Use `destroy` instead",
21478
21339
  "privacy": "public"
21479
21340
  },
21480
21341
  {
21481
21342
  "kind": "method",
21482
- "name": "columnDefinitionsChanged",
21483
- "privacy": "public"
21484
- },
21485
- {
21486
- "kind": "field",
21487
- "name": "handleClickOutside",
21488
- "privacy": "private"
21343
+ "name": "reset",
21344
+ "description": "Resets the datasource to its initial state.",
21345
+ "privacy": "public",
21346
+ "deprecated": "Use `destroy` instead"
21489
21347
  },
21490
21348
  {
21491
21349
  "kind": "method",
21492
- "name": "openChanged",
21493
- "privacy": "public"
21350
+ "name": "restart",
21351
+ "description": "Restarts the datasource, uses `destroy` and `init` in sequence.",
21352
+ "privacy": "public",
21353
+ "inheritedFrom": {
21354
+ "name": "GridProBaseDatasource",
21355
+ "module": "src/datasource/base.datasource.ts"
21356
+ }
21494
21357
  },
21495
21358
  {
21496
21359
  "kind": "method",
21497
- "name": "dropdownWidthChanged",
21498
- "privacy": "public"
21360
+ "name": "refreshRows",
21361
+ "description": "Force the grid to redispatch the current rows"
21499
21362
  },
21500
21363
  {
21501
21364
  "kind": "method",
21502
- "name": "changeHandler",
21365
+ "name": "reloadResourceData",
21503
21366
  "privacy": "public",
21504
- "parameters": [
21505
- {
21506
- "name": "event",
21367
+ "return": {
21368
+ "type": {
21369
+ "text": "Promise<void>"
21370
+ }
21371
+ },
21372
+ "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).",
21373
+ "inheritedFrom": {
21374
+ "name": "GridProBaseDatasource",
21375
+ "module": "src/datasource/base.datasource.ts"
21376
+ }
21377
+ },
21378
+ {
21379
+ "kind": "method",
21380
+ "name": "handleSnapshot",
21381
+ "privacy": "private",
21382
+ "parameters": [
21383
+ {
21384
+ "name": "result"
21385
+ }
21386
+ ]
21387
+ },
21388
+ {
21389
+ "kind": "method",
21390
+ "name": "handleStreamResult",
21391
+ "privacy": "private",
21392
+ "parameters": [
21393
+ {
21394
+ "name": "result",
21507
21395
  "type": {
21508
- "text": "Event"
21396
+ "text": "FilteredDataServerResult | RequestServerResult"
21509
21397
  }
21510
21398
  }
21511
21399
  ]
21512
21400
  },
21513
21401
  {
21514
21402
  "kind": "method",
21515
- "name": "cloneNode",
21516
- "return": {
21517
- "type": {
21518
- "text": "Node"
21519
- }
21520
- },
21403
+ "name": "emitMoreRowsChanged",
21404
+ "privacy": "private",
21521
21405
  "parameters": [
21522
21406
  {
21523
- "name": "deep",
21524
- "optional": true,
21407
+ "name": "moreRows",
21525
21408
  "type": {
21526
21409
  "text": "boolean"
21527
21410
  }
21411
+ },
21412
+ {
21413
+ "name": "sourceRef",
21414
+ "type": {
21415
+ "text": "string"
21416
+ }
21528
21417
  }
21529
21418
  ],
21530
- "inheritedFrom": {
21531
- "name": "LifecycleMixin",
21532
- "module": "src/mixins/lifecycle/lifecycle.ts"
21533
- }
21419
+ "description": "Emits `more-rows-changed` when the availability of more rows changes. @internal"
21534
21420
  },
21535
21421
  {
21536
21422
  "kind": "method",
21537
- "name": "deepClone",
21538
- "return": {
21539
- "type": {
21540
- "text": "Node"
21423
+ "name": "updateLoadMoreStatus",
21424
+ "privacy": "private",
21425
+ "parameters": [
21426
+ {
21427
+ "name": "moreRows",
21428
+ "type": {
21429
+ "text": "boolean"
21430
+ },
21431
+ "description": "Whether more rows are available"
21432
+ },
21433
+ {
21434
+ "name": "sourceRef",
21435
+ "type": {
21436
+ "text": "string"
21437
+ },
21438
+ "description": "The source reference"
21439
+ },
21440
+ {
21441
+ "description": "The total number of rows",
21442
+ "name": "rowsCount"
21541
21443
  }
21542
- },
21543
- "inheritedFrom": {
21544
- "name": "LifecycleMixin",
21545
- "module": "src/mixins/lifecycle/lifecycle.ts"
21546
- }
21444
+ ],
21445
+ "description": "Updates the status bar based on more rows status"
21547
21446
  },
21548
21447
  {
21549
- "kind": "field",
21550
- "name": "shouldRunDisconnect",
21551
- "return": {
21552
- "type": {
21553
- "text": ""
21448
+ "kind": "method",
21449
+ "name": "applyRequestServerData",
21450
+ "privacy": "private",
21451
+ "parameters": [
21452
+ {
21453
+ "name": "requestServerResult",
21454
+ "type": {
21455
+ "text": "RequestServerResult"
21456
+ }
21554
21457
  }
21555
- },
21556
- "readonly": true,
21557
- "inheritedFrom": {
21558
- "name": "LifecycleMixin",
21559
- "module": "src/mixins/lifecycle/lifecycle.ts"
21560
- }
21458
+ ]
21561
21459
  },
21562
21460
  {
21563
- "kind": "field",
21564
- "name": "shouldRunConnect",
21565
- "return": {
21566
- "type": {
21567
- "text": ""
21461
+ "kind": "method",
21462
+ "name": "applyDataserverData",
21463
+ "privacy": "private",
21464
+ "parameters": [
21465
+ {
21466
+ "name": "dataServerResult",
21467
+ "type": {
21468
+ "text": "FilteredDataServerResult"
21469
+ }
21568
21470
  }
21569
- },
21570
- "readonly": true,
21571
- "inheritedFrom": {
21572
- "name": "LifecycleMixin",
21573
- "module": "src/mixins/lifecycle/lifecycle.ts"
21574
- }
21471
+ ]
21575
21472
  },
21576
21473
  {
21577
21474
  "kind": "method",
21578
- "name": "#_blockLifecycleDueToTokenChange",
21579
- "return": {
21580
- "type": {
21581
- "text": "boolean"
21582
- }
21583
- },
21475
+ "name": "getAgColumnDefs",
21476
+ "privacy": "private",
21584
21477
  "parameters": [
21585
21478
  {
21586
- "name": "lifecycleType",
21479
+ "name": "fieldsMetadata",
21587
21480
  "type": {
21588
- "text": "Lifecycletype"
21481
+ "text": "FieldMetadata[]"
21589
21482
  }
21590
21483
  }
21591
- ],
21592
- "inheritedFrom": {
21593
- "name": "LifecycleMixin",
21594
- "module": "src/mixins/lifecycle/lifecycle.ts"
21595
- }
21484
+ ]
21596
21485
  },
21597
21486
  {
21598
- "kind": "field",
21599
- "name": "_presentation",
21600
- "type": {
21601
- "text": "ComponentPresentation | null | undefined"
21602
- },
21603
- "privacy": "private",
21604
- "default": "void 0",
21487
+ "kind": "method",
21488
+ "name": "setFilter",
21489
+ "privacy": "public",
21490
+ "parameters": [
21491
+ {
21492
+ "name": "fieldName",
21493
+ "type": {
21494
+ "text": "string"
21495
+ }
21496
+ },
21497
+ {
21498
+ "name": "newFilter",
21499
+ "type": {
21500
+ "text": "string"
21501
+ }
21502
+ }
21503
+ ],
21605
21504
  "inheritedFrom": {
21606
- "name": "FoundationElement",
21607
- "module": "src/foundation-element/foundation-element.ts"
21505
+ "name": "GenesisGridDatasourceElement",
21506
+ "module": "src/datasource/base.datasource.ts"
21608
21507
  }
21609
21508
  },
21610
21509
  {
21611
- "kind": "field",
21612
- "name": "$presentation",
21613
- "type": {
21614
- "text": "ComponentPresentation | null"
21615
- },
21510
+ "kind": "method",
21511
+ "name": "removeFilter",
21616
21512
  "privacy": "public",
21617
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
21513
+ "parameters": [
21514
+ {
21515
+ "name": "fieldName",
21516
+ "type": {
21517
+ "text": "string"
21518
+ }
21519
+ }
21520
+ ],
21618
21521
  "inheritedFrom": {
21619
- "name": "FoundationElement",
21620
- "module": "src/foundation-element/foundation-element.ts"
21522
+ "name": "GenesisGridDatasourceElement",
21523
+ "module": "src/datasource/base.datasource.ts"
21621
21524
  }
21622
21525
  },
21623
21526
  {
21624
- "kind": "field",
21625
- "name": "template",
21626
- "type": {
21627
- "text": "ElementViewTemplate | void | null"
21628
- },
21629
- "privacy": "public",
21630
- "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.",
21631
- "inheritedFrom": {
21632
- "name": "FoundationElement",
21633
- "module": "src/foundation-element/foundation-element.ts"
21634
- }
21527
+ "kind": "method",
21528
+ "name": "handleSizeChanged",
21529
+ "privacy": "private",
21530
+ "parameters": [
21531
+ {
21532
+ "name": "oldSize",
21533
+ "type": {
21534
+ "text": "number"
21535
+ }
21536
+ },
21537
+ {
21538
+ "name": "newSize",
21539
+ "type": {
21540
+ "text": "number"
21541
+ }
21542
+ }
21543
+ ]
21635
21544
  },
21636
21545
  {
21637
21546
  "kind": "method",
21638
- "name": "templateChanged",
21547
+ "name": "handleStreamInserts",
21639
21548
  "privacy": "protected",
21640
- "return": {
21641
- "type": {
21642
- "text": "void"
21549
+ "parameters": [
21550
+ {
21551
+ "name": "inserts",
21552
+ "default": "[]"
21643
21553
  }
21644
- },
21554
+ ],
21645
21555
  "inheritedFrom": {
21646
- "name": "FoundationElement",
21647
- "module": "src/foundation-element/foundation-element.ts"
21556
+ "name": "GridProBaseDatasource",
21557
+ "module": "src/datasource/base.datasource.ts"
21648
21558
  }
21649
21559
  },
21650
21560
  {
21651
- "kind": "field",
21652
- "name": "styles",
21653
- "type": {
21654
- "text": "ElementStyles | void | null"
21655
- },
21656
- "privacy": "public",
21657
- "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.",
21561
+ "kind": "method",
21562
+ "name": "handleStreamUpdates",
21563
+ "privacy": "protected",
21564
+ "parameters": [
21565
+ {
21566
+ "name": "updates",
21567
+ "default": "[]"
21568
+ }
21569
+ ],
21658
21570
  "inheritedFrom": {
21659
- "name": "FoundationElement",
21660
- "module": "src/foundation-element/foundation-element.ts"
21571
+ "name": "GridProBaseDatasource",
21572
+ "module": "src/datasource/base.datasource.ts"
21661
21573
  }
21662
21574
  },
21663
21575
  {
21664
21576
  "kind": "method",
21665
- "name": "stylesChanged",
21577
+ "name": "handleStreamDeletes",
21666
21578
  "privacy": "protected",
21579
+ "parameters": [
21580
+ {
21581
+ "name": "deletes",
21582
+ "default": "[]",
21583
+ "description": "List of records to remove from the grid stream"
21584
+ }
21585
+ ],
21586
+ "description": "Handles stream deletes by removing records from the grid.",
21587
+ "inheritedFrom": {
21588
+ "name": "GridProBaseDatasource",
21589
+ "module": "src/datasource/base.datasource.ts"
21590
+ }
21591
+ },
21592
+ {
21593
+ "kind": "method",
21594
+ "name": "setVisibleColumns",
21667
21595
  "return": {
21668
21596
  "type": {
21669
21597
  "text": "void"
21670
21598
  }
21671
21599
  },
21600
+ "parameters": [
21601
+ {
21602
+ "name": "visibleFields",
21603
+ "type": {
21604
+ "text": "string[]"
21605
+ },
21606
+ "description": "Field names of the currently visible columns."
21607
+ }
21608
+ ],
21609
+ "description": "Updates the set of visible columns and reloads the data when the set changes.",
21610
+ "privacy": "public",
21672
21611
  "inheritedFrom": {
21673
- "name": "FoundationElement",
21674
- "module": "src/foundation-element/foundation-element.ts"
21612
+ "name": "GridProBaseDatasource",
21613
+ "module": "src/datasource/base.datasource.ts"
21675
21614
  }
21676
21615
  },
21677
21616
  {
21678
21617
  "kind": "method",
21679
- "name": "compose",
21680
- "privacy": "public",
21681
- "static": true,
21618
+ "name": "loadMore",
21619
+ "inheritedFrom": {
21620
+ "name": "GridProBaseDatasource",
21621
+ "module": "src/datasource/base.datasource.ts"
21622
+ }
21623
+ },
21624
+ {
21625
+ "kind": "method",
21626
+ "name": "cloneNode",
21682
21627
  "return": {
21683
21628
  "type": {
21684
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
21629
+ "text": "Node"
21685
21630
  }
21686
21631
  },
21687
21632
  "parameters": [
21688
21633
  {
21689
- "name": "this",
21634
+ "name": "deep",
21635
+ "optional": true,
21690
21636
  "type": {
21691
- "text": "K"
21637
+ "text": "boolean"
21692
21638
  }
21693
- },
21694
- {
21695
- "name": "elementDefinition",
21696
- "type": {
21697
- "text": "T"
21698
- },
21699
- "description": "The definition of the element to create the registry\nfunction for."
21700
21639
  }
21701
21640
  ],
21702
- "description": "Defines an element registry function with a set of element definition defaults.",
21703
21641
  "inheritedFrom": {
21704
- "name": "FoundationElement",
21705
- "module": "src/foundation-element/foundation-element.ts"
21642
+ "name": "LifecycleMixin",
21643
+ "module": "src/mixins/lifecycle/lifecycle.ts"
21706
21644
  }
21707
- }
21708
- ],
21709
- "events": [
21710
- {
21711
- "description": "Fired when the selected value changes. detail: `string`",
21712
- "name": "change"
21713
21645
  },
21714
21646
  {
21715
- "description": "Fired when the value is updated (including programmatic changes). detail: `string`",
21716
- "name": "input"
21717
- }
21718
- ],
21719
- "attributes": [
21647
+ "kind": "field",
21648
+ "name": "shouldRunDisconnect",
21649
+ "return": {
21650
+ "type": {
21651
+ "text": ""
21652
+ }
21653
+ },
21654
+ "readonly": true,
21655
+ "inheritedFrom": {
21656
+ "name": "LifecycleMixin",
21657
+ "module": "src/mixins/lifecycle/lifecycle.ts"
21658
+ }
21659
+ },
21720
21660
  {
21721
- "type": {
21722
- "text": "boolean"
21661
+ "kind": "field",
21662
+ "name": "shouldRunConnect",
21663
+ "return": {
21664
+ "type": {
21665
+ "text": ""
21666
+ }
21723
21667
  },
21724
- "description": "Whether to disable control of the component",
21725
- "fieldName": "disabled"
21668
+ "readonly": true,
21669
+ "inheritedFrom": {
21670
+ "name": "LifecycleMixin",
21671
+ "module": "src/mixins/lifecycle/lifecycle.ts"
21672
+ }
21726
21673
  },
21727
21674
  {
21728
- "name": "resource-name",
21729
- "type": {
21730
- "text": "string"
21675
+ "kind": "method",
21676
+ "name": "#_blockLifecycleDueToTokenChange",
21677
+ "return": {
21678
+ "type": {
21679
+ "text": "boolean"
21680
+ }
21731
21681
  },
21732
- "description": "The name of the reqrep to get the options from",
21733
- "fieldName": "resourceName"
21682
+ "parameters": [
21683
+ {
21684
+ "name": "lifecycleType",
21685
+ "type": {
21686
+ "text": "Lifecycletype"
21687
+ }
21688
+ }
21689
+ ],
21690
+ "inheritedFrom": {
21691
+ "name": "LifecycleMixin",
21692
+ "module": "src/mixins/lifecycle/lifecycle.ts"
21693
+ }
21734
21694
  },
21735
21695
  {
21736
- "name": "search-key",
21696
+ "kind": "field",
21697
+ "name": "serializer",
21737
21698
  "type": {
21738
- "text": "string | string[] | undefined"
21699
+ "text": "JSONSerializer"
21739
21700
  },
21740
- "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\").",
21741
- "fieldName": "searchKey"
21701
+ "inheritedFrom": {
21702
+ "name": "GridProBaseDatasource",
21703
+ "module": "src/datasource/base.datasource.ts"
21704
+ }
21742
21705
  },
21743
21706
  {
21744
- "name": "advanced-search-req",
21707
+ "kind": "field",
21708
+ "name": "dataSubWasLoggedOff",
21745
21709
  "type": {
21746
21710
  "text": "boolean"
21747
21711
  },
21712
+ "privacy": "protected",
21748
21713
  "default": "false",
21749
- "description": "Tells whether a given request supports lookup by Groovy Expressions.",
21750
- "fieldName": "requestSupportsAdvancedSearch"
21714
+ "inheritedFrom": {
21715
+ "name": "GridProBaseDatasource",
21716
+ "module": "src/datasource/base.datasource.ts"
21717
+ }
21751
21718
  },
21752
21719
  {
21753
- "name": "value-key",
21720
+ "kind": "field",
21721
+ "name": "rowData",
21754
21722
  "type": {
21755
- "text": "string"
21723
+ "text": "Map<string, any>"
21756
21724
  },
21757
- "description": "The key used as the value sent to the server",
21758
- "fieldName": "valueKey"
21725
+ "default": "new Map()",
21726
+ "inheritedFrom": {
21727
+ "name": "GridProBaseDatasource",
21728
+ "module": "src/datasource/base.datasource.ts"
21729
+ }
21759
21730
  },
21760
21731
  {
21761
- "name": "label-key",
21732
+ "kind": "field",
21733
+ "name": "missingRowIdWarned",
21762
21734
  "type": {
21763
- "text": "string"
21735
+ "text": "boolean"
21764
21736
  },
21765
- "description": "The key used as the label displayed in the UI",
21766
- "fieldName": "labelKey"
21737
+ "privacy": "private",
21738
+ "default": "false",
21739
+ "description": "So rows without a row id are warned about once per element, not once per block. @internal",
21740
+ "inheritedFrom": {
21741
+ "name": "GridProBaseDatasource",
21742
+ "module": "src/datasource/base.datasource.ts"
21743
+ }
21767
21744
  },
21768
21745
  {
21769
- "name": "dropdown-placement",
21746
+ "kind": "field",
21747
+ "name": "connectionSub",
21770
21748
  "type": {
21771
- "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
21749
+ "text": "Subscription | undefined"
21772
21750
  },
21773
- "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",
21774
- "fieldName": "dropdownPlacement"
21751
+ "privacy": "protected",
21752
+ "inheritedFrom": {
21753
+ "name": "GridProBaseDatasource",
21754
+ "module": "src/datasource/base.datasource.ts"
21755
+ }
21775
21756
  },
21776
21757
  {
21777
- "name": "dropdownWidth",
21778
- "type": {
21779
- "text": "number"
21758
+ "kind": "method",
21759
+ "name": "subscribeToConnection",
21760
+ "privacy": "protected",
21761
+ "inheritedFrom": {
21762
+ "name": "GridProBaseDatasource",
21763
+ "module": "src/datasource/base.datasource.ts"
21764
+ }
21765
+ },
21766
+ {
21767
+ "kind": "method",
21768
+ "name": "unsubscribeFromConnection",
21769
+ "privacy": "protected",
21770
+ "inheritedFrom": {
21771
+ "name": "GridProBaseDatasource",
21772
+ "module": "src/datasource/base.datasource.ts"
21773
+ }
21774
+ },
21775
+ {
21776
+ "kind": "method",
21777
+ "name": "generateColumnDefsFromMetadata",
21778
+ "privacy": "protected",
21779
+ "return": {
21780
+ "type": {
21781
+ "text": "ColDef[]"
21782
+ }
21780
21783
  },
21781
- "description": "Optionally specifies the width of the dropdown",
21782
- "fieldName": "dropdownWidth"
21783
- }
21784
- ],
21785
- "mixins": [
21784
+ "parameters": [
21785
+ {
21786
+ "name": "fieldsMetadata",
21787
+ "type": {
21788
+ "text": "FieldMetadata[]"
21789
+ }
21790
+ },
21791
+ {
21792
+ "name": "getFilterParamsByFieldType",
21793
+ "type": {
21794
+ "text": "(field: FieldMetadata) => ColDef['filterParams'] | any"
21795
+ }
21796
+ },
21797
+ {
21798
+ "name": "getFilterByFieldType",
21799
+ "type": {
21800
+ "text": "(type: FieldTypeEnum) => string"
21801
+ }
21802
+ }
21803
+ ],
21804
+ "inheritedFrom": {
21805
+ "name": "GridProBaseDatasource",
21806
+ "module": "src/datasource/base.datasource.ts"
21807
+ }
21808
+ },
21786
21809
  {
21787
- "name": "LifecycleMixin",
21788
- "package": "@genesislcap/foundation-utils"
21789
- }
21790
- ],
21791
- "superclass": {
21792
- "name": "FoundationElement",
21793
- "package": "@microsoft/fast-foundation"
21794
- },
21795
- "tagName": "%%prefix%%-multicolumn-dropdown",
21796
- "customElement": true
21797
- },
21798
- {
21799
- "kind": "variable",
21800
- "name": "foundationMulticolumnDropdown",
21801
- "description": "A function that returns a Multicolumn Dropdown registration for configuring the component with a DesignSystem.",
21802
- "privacy": "public"
21803
- }
21804
- ],
21805
- "exports": [
21806
- {
21807
- "kind": "js",
21808
- "name": "wasClickOutsideElement",
21809
- "declaration": {
21810
- "name": "wasClickOutsideElement",
21811
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
21812
- }
21813
- },
21814
- {
21815
- "kind": "js",
21816
- "name": "MulticolumnDropdown",
21817
- "declaration": {
21818
- "name": "MulticolumnDropdown",
21819
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
21820
- }
21821
- },
21822
- {
21823
- "kind": "js",
21824
- "name": "foundationMulticolumnDropdown",
21825
- "declaration": {
21826
- "name": "foundationMulticolumnDropdown",
21827
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
21828
- }
21829
- }
21830
- ]
21831
- },
21832
- {
21833
- "kind": "javascript-module",
21834
- "path": "src/row-alert/index.ts",
21835
- "declarations": [],
21836
- "exports": [
21837
- {
21838
- "kind": "js",
21839
- "name": "*",
21840
- "declaration": {
21841
- "name": "*",
21842
- "package": "./row-alert"
21843
- }
21844
- },
21845
- {
21846
- "kind": "js",
21847
- "name": "*",
21848
- "declaration": {
21849
- "name": "*",
21850
- "package": "./row-alert.types"
21851
- }
21852
- }
21853
- ]
21854
- },
21855
- {
21856
- "kind": "javascript-module",
21857
- "path": "src/row-alert/row-alert.ts",
21858
- "declarations": [
21859
- {
21860
- "kind": "function",
21861
- "name": "createRowAlert",
21862
- "return": {
21863
- "type": {
21864
- "text": "RowAlert"
21865
- }
21866
- },
21867
- "parameters": [
21868
- {
21869
- "name": "criteria",
21870
- "type": {
21871
- "text": "RowMatchCriteria"
21872
- }
21873
- },
21874
- {
21875
- "name": "options",
21876
- "default": "{}",
21877
- "type": {
21878
- "text": "RowAlertOptions"
21879
- }
21880
- }
21881
- ],
21882
- "description": "Builds the class rules that flash rows matching `criteria`, together with the context menu\nthat lets a user recolor, retime, or narrow that flash to a single cell.\n\nThe rules are created once and never replaced, because a grid backed by a Genesis datasource\nkeeps the options it was created with — handing it new rules later would change nothing. Each\nrule instead asks, as it runs, whether its scope is the one currently selected, so switching\ntarget only needs the rows redrawn.\n\n```ts\nconst alert = createRowAlert(criteria, { persistPreferencesKey: 'orders.row-alert' });\ngridOptions = {\n rowClassRules: alert.rowClassRules,\n defaultColDef: alert.defaultColDef,\n getContextMenuItems: alert.getContextMenuItems,\n};\n```\n\nAlerts sharing a `persistPreferencesKey` share their preferences, so a page of grids that each\nwatch for something different still answers to one setting.\n\nPairs with DatasourceRowMatchTracker: give both the same criteria and a tab can say\nthere is work to do while the grid shows which rows it meant.",
21883
- "privacy": "public"
21884
- }
21885
- ],
21886
- "exports": [
21887
- {
21888
- "kind": "js",
21889
- "name": "createRowAlert",
21890
- "declaration": {
21891
- "name": "createRowAlert",
21892
- "module": "src/row-alert/row-alert.ts"
21893
- }
21894
- }
21895
- ]
21896
- },
21897
- {
21898
- "kind": "javascript-module",
21899
- "path": "src/row-alert/row-alert.types.ts",
21900
- "declarations": [
21901
- {
21902
- "kind": "variable",
21903
- "name": "defaultRowAlertColorPresets",
21904
- "type": {
21905
- "text": "[\n { id: 'error', label: 'Error', value: 'var(--error-fill-rest, #c62828)' },\n { id: 'warning', label: 'Warning', value: 'var(--warning-fill-rest, #ef6c00)' },\n { id: 'success', label: 'Success', value: 'var(--success-fill-rest, #2e7d32)' },\n { id: 'accent', label: 'Accent', value: 'var(--accent-fill-rest, #1565c0)' },\n { id: 'neutral', label: 'Neutral', value: 'var(--neutral-fill-rest, #546e7a)' },\n]"
21906
- },
21907
- "default": "[\n { id: 'error', label: 'Error', value: 'var(--error-fill-rest, #c62828)' },\n { id: 'warning', label: 'Warning', value: 'var(--warning-fill-rest, #ef6c00)' },\n { id: 'success', label: 'Success', value: 'var(--success-fill-rest, #2e7d32)' },\n { id: 'accent', label: 'Accent', value: 'var(--accent-fill-rest, #1565c0)' },\n { id: 'neutral', label: 'Neutral', value: 'var(--neutral-fill-rest, #546e7a)' },\n]",
21908
- "description": "Colors offered by default. Each resolves a design token so the menu follows the host\napplication's theme, falling back to a fixed color for design systems that lack the token.",
21909
- "privacy": "public"
21910
- },
21911
- {
21912
- "kind": "variable",
21913
- "name": "defaultRowAlertRatePresets",
21914
- "type": {
21915
- "text": "[\n { id: 'slow', label: 'Slow', value: 1400 },\n { id: 'normal', label: 'Normal', value: 1000 },\n { id: 'fast', label: 'Fast', value: 500 },\n]"
21916
- },
21917
- "default": "[\n { id: 'slow', label: 'Slow', value: 1400 },\n { id: 'normal', label: 'Normal', value: 1000 },\n { id: 'fast', label: 'Fast', value: 500 },\n]",
21918
- "description": "Flash rates offered by default.",
21919
- "privacy": "public"
21920
- },
21921
- {
21922
- "kind": "variable",
21923
- "name": "defaultRowAlertScopePresets",
21924
- "type": {
21925
- "text": "[\n { id: 'row', label: 'Whole row', value: 'row' },\n { id: 'cell', label: 'Alert field cell', value: 'cell' },\n]"
21926
- },
21927
- "default": "[\n { id: 'row', label: 'Whole row', value: 'row' },\n { id: 'cell', label: 'Alert field cell', value: 'cell' },\n]",
21928
- "description": "Flash targets offered by default. Cell scope only has an effect when the criteria name a\n`flashField`.",
21929
- "privacy": "public"
21930
- },
21931
- {
21932
- "kind": "variable",
21933
- "name": "defaultRowAlertPreferences",
21934
- "type": {
21935
- "text": "RowAlertPreferences"
21936
- },
21937
- "default": "{\n color: defaultRowAlertColorPresets[0].value,\n durationMs: defaultRowAlertRatePresets[1].value,\n scope: 'row',\n}",
21938
- "description": "Where preferences start before a user changes anything.",
21939
- "privacy": "public"
21940
- }
21941
- ],
21942
- "exports": [
21943
- {
21944
- "kind": "js",
21945
- "name": "defaultRowAlertColorPresets",
21946
- "declaration": {
21947
- "name": "defaultRowAlertColorPresets",
21948
- "module": "src/row-alert/row-alert.types.ts"
21949
- }
21950
- },
21951
- {
21952
- "kind": "js",
21953
- "name": "defaultRowAlertRatePresets",
21954
- "declaration": {
21955
- "name": "defaultRowAlertRatePresets",
21956
- "module": "src/row-alert/row-alert.types.ts"
21957
- }
21958
- },
21959
- {
21960
- "kind": "js",
21961
- "name": "defaultRowAlertScopePresets",
21962
- "declaration": {
21963
- "name": "defaultRowAlertScopePresets",
21964
- "module": "src/row-alert/row-alert.types.ts"
21965
- }
21966
- },
21967
- {
21968
- "kind": "js",
21969
- "name": "defaultRowAlertPreferences",
21970
- "declaration": {
21971
- "name": "defaultRowAlertPreferences",
21972
- "module": "src/row-alert/row-alert.types.ts"
21973
- }
21974
- }
21975
- ]
21976
- },
21977
- {
21978
- "kind": "javascript-module",
21979
- "path": "src/grid-pro-genesis-datasource/datasource-events.types.ts",
21980
- "declarations": [
21981
- {
21982
- "kind": "variable",
21983
- "name": "datasourceEventNames",
21984
- "type": {
21985
- "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\n // Infinite Row Model specific events\n setInfiniteDatasource: 'set-infinite-datasource',\n refreshInfiniteCache: 'refresh-infinite-cache',\n}"
21986
- },
21987
- "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\n // Infinite Row Model specific events\n setInfiniteDatasource: 'set-infinite-datasource',\n refreshInfiniteCache: 'refresh-infinite-cache',\n}",
21988
- "description": "Event names for datasource-grid communication\nThese represent datasource operations, not grid-specific actions"
21989
- }
21990
- ],
21991
- "exports": [
21992
- {
21993
- "kind": "js",
21994
- "name": "datasourceEventNames",
21995
- "declaration": {
21996
- "name": "datasourceEventNames",
21997
- "module": "src/grid-pro-genesis-datasource/datasource-events.types.ts"
21998
- }
21999
- }
22000
- ]
22001
- },
22002
- {
22003
- "kind": "javascript-module",
22004
- "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts",
22005
- "declarations": [
22006
- {
22007
- "kind": "class",
22008
- "description": "The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.",
22009
- "name": "GridProGenesisDatasource",
22010
- "members": [
22011
- {
22012
- "kind": "field",
22013
- "name": "cachedRowArray",
22014
- "type": {
22015
- "text": "any[]"
22016
- },
22017
- "privacy": "private",
22018
- "default": "[]"
22019
- },
22020
- {
22021
- "kind": "field",
22022
- "name": "transactionData",
22023
- "type": {
22024
- "text": "TransactionData"
22025
- },
21810
+ "kind": "method",
21811
+ "name": "applyAllTransactions",
22026
21812
  "privacy": "protected",
22027
- "default": "{\n add: [],\n remove: [],\n update: [],\n addIndex: 0,\n }",
22028
21813
  "inheritedFrom": {
22029
21814
  "name": "GridProBaseDatasource",
22030
21815
  "module": "src/datasource/base.datasource.ts"
@@ -22032,65 +21817,89 @@
22032
21817
  },
22033
21818
  {
22034
21819
  "kind": "method",
22035
- "name": "criteriaChanged",
21820
+ "name": "applyMappedTransaction",
21821
+ "privacy": "private",
22036
21822
  "parameters": [
22037
21823
  {
22038
- "name": "oldCriteria",
21824
+ "name": "transaction",
22039
21825
  "type": {
22040
- "text": "string"
21826
+ "text": "TransactionData"
22041
21827
  }
22042
21828
  },
22043
21829
  {
22044
- "name": "newCriteria",
21830
+ "name": "operation",
22045
21831
  "type": {
22046
- "text": "string"
21832
+ "text": "OperationType"
22047
21833
  }
22048
21834
  }
22049
- ]
21835
+ ],
21836
+ "inheritedFrom": {
21837
+ "name": "GridProBaseDatasource",
21838
+ "module": "src/datasource/base.datasource.ts"
21839
+ }
22050
21840
  },
22051
21841
  {
22052
21842
  "kind": "method",
22053
- "name": "requestChanged",
21843
+ "name": "emitTransaction",
21844
+ "privacy": "protected",
21845
+ "return": {
21846
+ "type": {
21847
+ "text": "void"
21848
+ }
21849
+ },
22054
21850
  "parameters": [
22055
21851
  {
22056
- "name": "oldRequest",
21852
+ "name": "transaction",
22057
21853
  "type": {
22058
- "text": "string"
22059
- }
22060
- },
22061
- {
22062
- "name": "newRequest",
22063
- "type": {
22064
- "text": "string"
21854
+ "text": "TransactionData | undefined"
22065
21855
  }
22066
21856
  }
22067
- ]
21857
+ ],
21858
+ "description": "Emits `datasource-data-changed` for `transaction` when it is non-empty. @internal",
21859
+ "inheritedFrom": {
21860
+ "name": "GridProBaseDatasource",
21861
+ "module": "src/datasource/base.datasource.ts"
21862
+ }
22068
21863
  },
22069
21864
  {
22070
21865
  "kind": "method",
22071
- "name": "resourceNameChanged",
21866
+ "name": "mapTransaction",
21867
+ "privacy": "private",
22072
21868
  "parameters": [
22073
21869
  {
22074
- "name": "oldValue",
21870
+ "name": "transaction",
22075
21871
  "type": {
22076
- "text": "string"
22077
- }
21872
+ "text": "TransactionData"
21873
+ },
21874
+ "description": "The transaction data to be mapped."
22078
21875
  },
22079
21876
  {
22080
- "name": "newValue",
21877
+ "name": "operations",
21878
+ "default": "Object.values(OperationType)",
22081
21879
  "type": {
22082
- "text": "string"
22083
- }
21880
+ "text": "OperationType[]"
21881
+ },
21882
+ "description": "The operations to be mapped. Can be 'add', 'update' or 'remove'."
22084
21883
  }
22085
- ]
21884
+ ],
21885
+ "description": "Maps the transaction data to the row data mapper function, if it exists.",
21886
+ "return": {
21887
+ "type": {
21888
+ "text": ""
21889
+ }
21890
+ },
21891
+ "inheritedFrom": {
21892
+ "name": "GridProBaseDatasource",
21893
+ "module": "src/datasource/base.datasource.ts"
21894
+ }
22086
21895
  },
22087
21896
  {
22088
21897
  "kind": "field",
22089
- "name": "keepColDefsOnClearRowData",
21898
+ "name": "_isDisconnected",
22090
21899
  "type": {
22091
21900
  "text": "boolean"
22092
21901
  },
22093
- "privacy": "public",
21902
+ "privacy": "private",
22094
21903
  "default": "false",
22095
21904
  "inheritedFrom": {
22096
21905
  "name": "GridProBaseDatasource",
@@ -22098,373 +21907,453 @@
22098
21907
  }
22099
21908
  },
22100
21909
  {
22101
- "kind": "field",
22102
- "name": "requestVisibleColumnsOnly",
22103
- "type": {
22104
- "text": "boolean"
21910
+ "kind": "method",
21911
+ "name": "setDisconnected",
21912
+ "privacy": "public",
21913
+ "parameters": [
21914
+ {
21915
+ "name": "disconnected",
21916
+ "type": {
21917
+ "text": "boolean"
21918
+ },
21919
+ "description": "true to set, false to remove"
21920
+ }
21921
+ ],
21922
+ "description": "Sets the disconnected state and emits appropriate events.\nA repeated `true` is ignored so the dialog does not gain another \"Datasource disconnected\" line.",
21923
+ "inheritedFrom": {
21924
+ "name": "GridProBaseDatasource",
21925
+ "module": "src/datasource/base.datasource.ts"
21926
+ }
21927
+ },
21928
+ {
21929
+ "kind": "method",
21930
+ "name": "isDisconnected",
21931
+ "privacy": "public",
21932
+ "return": {
21933
+ "type": {
21934
+ "text": "boolean"
21935
+ }
22105
21936
  },
22106
- "default": "false",
22107
- "description": "When enabled and column definitions are provided, the datasource requests data only for the\ncolumns that are currently visible. The visible set is seeded from the column config (columns\nnot flagged with `hide`) and updated by the host grid via `setVisibleColumns`; the data\nis reloaded whenever that set changes."
21937
+ "description": "Returns true if the datasource is disconnected.",
21938
+ "inheritedFrom": {
21939
+ "name": "GridProBaseDatasource",
21940
+ "module": "src/datasource/base.datasource.ts"
21941
+ }
22108
21942
  },
22109
21943
  {
22110
- "kind": "field",
22111
- "name": "_visibleColumns",
22112
- "type": {
22113
- "text": "string[] | undefined"
21944
+ "kind": "method",
21945
+ "name": "getDatasourceStatusBarPanels",
21946
+ "privacy": "public",
21947
+ "return": {
21948
+ "type": {
21949
+ "text": "any[]"
21950
+ }
22114
21951
  },
22115
- "privacy": "private"
21952
+ "parameters": [
21953
+ {
21954
+ "name": "isServerSide",
21955
+ "type": {
21956
+ "text": "boolean"
21957
+ }
21958
+ },
21959
+ {
21960
+ "name": "statusBarConfig",
21961
+ "type": {
21962
+ "text": "any"
21963
+ }
21964
+ }
21965
+ ],
21966
+ "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.",
21967
+ "inheritedFrom": {
21968
+ "name": "GridProBaseDatasource",
21969
+ "module": "src/datasource/base.datasource.ts"
21970
+ }
22116
21971
  },
22117
21972
  {
22118
21973
  "kind": "field",
22119
- "name": "dataSub",
21974
+ "name": "connect",
22120
21975
  "type": {
22121
- "text": "Subscription"
21976
+ "text": "Connect"
22122
21977
  },
22123
- "privacy": "private"
21978
+ "inheritedFrom": {
21979
+ "name": "GenesisGridDatasourceElement",
21980
+ "module": "src/datasource/base.datasource.ts"
21981
+ }
22124
21982
  },
22125
21983
  {
22126
21984
  "kind": "field",
22127
- "name": "updateSub",
21985
+ "name": "datasource",
22128
21986
  "type": {
22129
- "text": "Subscription"
21987
+ "text": "Datasource"
22130
21988
  },
22131
- "privacy": "private"
21989
+ "inheritedFrom": {
21990
+ "name": "GenesisGridDatasourceElement",
21991
+ "module": "src/datasource/base.datasource.ts"
21992
+ }
22132
21993
  },
22133
21994
  {
22134
21995
  "kind": "field",
22135
- "name": "requiresFullRowDataAndColDefs",
21996
+ "name": "deferredGridOptions",
22136
21997
  "type": {
22137
- "text": "boolean"
21998
+ "text": "GridOptions"
22138
21999
  },
22139
- "privacy": "private",
22140
- "default": "true"
22000
+ "inheritedFrom": {
22001
+ "name": "GenesisGridDatasourceElement",
22002
+ "module": "src/datasource/base.datasource.ts"
22003
+ }
22141
22004
  },
22142
22005
  {
22143
22006
  "kind": "field",
22144
- "name": "_lastMoreRows",
22007
+ "name": "deferredColumnStates",
22145
22008
  "type": {
22146
- "text": "boolean"
22009
+ "text": "ColumnState[]"
22147
22010
  },
22148
- "privacy": "private",
22149
- "default": "false"
22011
+ "inheritedFrom": {
22012
+ "name": "GenesisGridDatasourceElement",
22013
+ "module": "src/datasource/base.datasource.ts"
22014
+ }
22150
22015
  },
22151
22016
  {
22152
22017
  "kind": "field",
22153
- "name": "_isMoreRowsResult",
22018
+ "name": "rowDataMapper",
22154
22019
  "type": {
22155
- "text": "boolean"
22020
+ "text": "Function"
22156
22021
  },
22157
- "privacy": "private",
22158
- "default": "false"
22022
+ "description": "Allows grid data updates to be processed via and external function before applying in grid",
22023
+ "inheritedFrom": {
22024
+ "name": "GenesisGridDatasourceElement",
22025
+ "module": "src/datasource/base.datasource.ts"
22026
+ }
22159
22027
  },
22160
22028
  {
22161
22029
  "kind": "field",
22162
- "name": "_pendingLoadMore",
22030
+ "name": "criteria",
22163
22031
  "type": {
22164
- "text": "number"
22032
+ "text": "string"
22165
22033
  },
22166
- "privacy": "private",
22167
- "default": "0",
22168
- "description": "How many MORE_ROWS sent by loadMore() are awaiting their reply. @internal"
22034
+ "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
22035
+ "inheritedFrom": {
22036
+ "name": "GenesisGridDatasourceElement",
22037
+ "module": "src/datasource/base.datasource.ts"
22038
+ }
22169
22039
  },
22170
22040
  {
22171
22041
  "kind": "field",
22172
- "name": "_serverMoreRows",
22042
+ "name": "isSnapshot",
22173
22043
  "type": {
22174
- "text": "boolean | undefined"
22044
+ "text": "boolean"
22175
22045
  },
22176
- "privacy": "private",
22177
- "description": "The latest MORE_ROWS the server sent. @internal"
22046
+ "default": "false",
22047
+ "description": "Request a snapshot from the server.",
22048
+ "inheritedFrom": {
22049
+ "name": "GenesisGridDatasourceElement",
22050
+ "module": "src/datasource/base.datasource.ts"
22051
+ }
22178
22052
  },
22179
22053
  {
22180
22054
  "kind": "field",
22181
- "name": "_pagingStopped",
22055
+ "name": "maxRows",
22182
22056
  "type": {
22183
- "text": "'view-full' | 'stalled' | undefined"
22057
+ "text": "number"
22184
22058
  },
22185
- "privacy": "private",
22186
- "description": "Set when Load More stops short of MORE_ROWS false - see notePagingStatus. @internal"
22059
+ "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
22060
+ "inheritedFrom": {
22061
+ "name": "GenesisGridDatasourceElement",
22062
+ "module": "src/datasource/base.datasource.ts"
22063
+ }
22187
22064
  },
22188
22065
  {
22189
22066
  "kind": "field",
22190
- "name": "_sourceRef",
22067
+ "name": "orderBy",
22191
22068
  "type": {
22192
22069
  "text": "string"
22193
22070
  },
22194
- "privacy": "private"
22071
+ "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.",
22072
+ "inheritedFrom": {
22073
+ "name": "GenesisGridDatasourceElement",
22074
+ "module": "src/datasource/base.datasource.ts"
22075
+ }
22195
22076
  },
22196
22077
  {
22197
22078
  "kind": "field",
22198
- "name": "_nextOffset",
22079
+ "name": "resourceName",
22199
22080
  "type": {
22200
- "text": "number"
22081
+ "text": "string"
22201
22082
  },
22202
- "privacy": "private",
22203
- "default": "0"
22083
+ "description": "The name of the target Data Server query or Request Server requestReply.",
22084
+ "inheritedFrom": {
22085
+ "name": "GenesisGridDatasourceElement",
22086
+ "module": "src/datasource/base.datasource.ts"
22087
+ }
22204
22088
  },
22205
22089
  {
22206
22090
  "kind": "field",
22207
- "name": "_loadMoreCount",
22091
+ "name": "viewNumber",
22208
22092
  "type": {
22209
22093
  "text": "number"
22210
22094
  },
22211
- "privacy": "private",
22212
- "default": "0"
22095
+ "description": "The desired view/page you want data from.",
22096
+ "inheritedFrom": {
22097
+ "name": "GenesisGridDatasourceElement",
22098
+ "module": "src/datasource/base.datasource.ts"
22099
+ }
22213
22100
  },
22214
22101
  {
22215
22102
  "kind": "field",
22216
- "name": "onDatasourceReady",
22103
+ "name": "fields",
22217
22104
  "type": {
22218
- "text": "EventListener"
22105
+ "text": "string"
22219
22106
  },
22220
- "privacy": "private",
22221
- "readonly": true
22107
+ "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.",
22108
+ "inheritedFrom": {
22109
+ "name": "GenesisGridDatasourceElement",
22110
+ "module": "src/datasource/base.datasource.ts"
22111
+ }
22222
22112
  },
22223
22113
  {
22224
- "kind": "method",
22225
- "name": "deepClone",
22226
- "return": {
22227
- "type": {
22228
- "text": "Node"
22229
- }
22114
+ "kind": "field",
22115
+ "name": "maxView",
22116
+ "type": {
22117
+ "text": "number"
22230
22118
  },
22119
+ "description": "Maximum number of rows to track as part of a client \"view\".",
22231
22120
  "inheritedFrom": {
22232
- "name": "LifecycleMixin",
22233
- "module": "src/mixins/lifecycle/lifecycle.ts"
22121
+ "name": "GenesisGridDatasourceElement",
22122
+ "module": "src/datasource/base.datasource.ts"
22234
22123
  }
22235
22124
  },
22236
22125
  {
22237
- "kind": "method",
22238
- "name": "colDefsDeepClone",
22239
- "privacy": "private",
22240
- "return": {
22241
- "type": {
22242
- "text": "ColDef[]"
22243
- }
22126
+ "kind": "field",
22127
+ "name": "movingView",
22128
+ "type": {
22129
+ "text": "boolean"
22244
22130
  },
22245
- "parameters": [
22246
- {
22247
- "name": "key",
22248
- "type": {
22249
- "text": "string"
22250
- }
22251
- },
22252
- {
22253
- "name": "copy",
22254
- "type": {
22255
- "text": "any"
22256
- }
22257
- }
22258
- ]
22131
+ "default": "false",
22132
+ "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.",
22133
+ "inheritedFrom": {
22134
+ "name": "GenesisGridDatasourceElement",
22135
+ "module": "src/datasource/base.datasource.ts"
22136
+ }
22259
22137
  },
22260
22138
  {
22261
- "kind": "method",
22262
- "name": "init",
22263
- "parameters": [
22264
- {
22265
- "name": "keepColDefsOnClearRowData",
22266
- "optional": true,
22267
- "type": {
22268
- "text": "boolean"
22269
- }
22270
- },
22271
- {
22272
- "description": "Optionally set the `gridOptions` up with column definitions",
22273
- "name": "columnDefinitions"
22274
- },
22275
- {
22276
- "description": "Optionally set the grid up with column state",
22277
- "name": "columnStates"
22278
- }
22279
- ],
22280
- "description": "Initializes the datasource.",
22281
- "privacy": "public"
22139
+ "kind": "field",
22140
+ "name": "reverse",
22141
+ "type": {
22142
+ "text": "boolean"
22143
+ },
22144
+ "default": "false",
22145
+ "description": "Option that changes the Data Server index iteration.",
22146
+ "inheritedFrom": {
22147
+ "name": "GenesisGridDatasourceElement",
22148
+ "module": "src/datasource/base.datasource.ts"
22149
+ }
22282
22150
  },
22283
22151
  {
22284
- "kind": "method",
22285
- "name": "clearReadyListener",
22286
- "privacy": "private"
22152
+ "kind": "field",
22153
+ "name": "disablePolling",
22154
+ "type": {
22155
+ "text": "boolean"
22156
+ },
22157
+ "default": "false",
22158
+ "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
22159
+ "inheritedFrom": {
22160
+ "name": "GenesisGridDatasourceElement",
22161
+ "module": "src/datasource/base.datasource.ts"
22162
+ }
22287
22163
  },
22288
22164
  {
22289
- "kind": "method",
22290
- "name": "destroy",
22291
- "description": "Destroys the datasource, resetting it to its initial state.",
22292
- "privacy": "public",
22165
+ "kind": "field",
22166
+ "name": "offset",
22167
+ "type": {
22168
+ "text": "number"
22169
+ },
22170
+ "description": "The offset for pagination in REQUEST_SERVER scenarios.",
22293
22171
  "inheritedFrom": {
22294
- "name": "GridProBaseDatasource",
22172
+ "name": "GenesisGridDatasourceElement",
22295
22173
  "module": "src/datasource/base.datasource.ts"
22296
22174
  }
22297
22175
  },
22298
22176
  {
22299
- "kind": "method",
22300
- "name": "deinit",
22301
- "description": "Deinitialises the datasource, resetting it to its initial state.",
22302
- "deprecated": "Use `destroy` instead",
22303
- "privacy": "public"
22177
+ "kind": "field",
22178
+ "name": "pollingInterval",
22179
+ "type": {
22180
+ "text": "number"
22181
+ },
22182
+ "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
22183
+ "inheritedFrom": {
22184
+ "name": "GenesisGridDatasourceElement",
22185
+ "module": "src/datasource/base.datasource.ts"
22186
+ }
22304
22187
  },
22305
22188
  {
22306
- "kind": "method",
22307
- "name": "reset",
22308
- "description": "Resets the datasource to its initial state.",
22309
- "privacy": "public",
22310
- "deprecated": "Use `destroy` instead"
22189
+ "kind": "field",
22190
+ "name": "pollTriggerEvents",
22191
+ "type": {
22192
+ "text": "string[]"
22193
+ },
22194
+ "default": "[]",
22195
+ "description": "Array of event names that will trigger a poll when received as commit responses.",
22196
+ "inheritedFrom": {
22197
+ "name": "GenesisGridDatasourceElement",
22198
+ "module": "src/datasource/base.datasource.ts"
22199
+ }
22311
22200
  },
22312
22201
  {
22313
- "kind": "method",
22314
- "name": "restart",
22315
- "description": "Restarts the datasource, uses `destroy` and `init` in sequence.",
22316
- "privacy": "public",
22202
+ "kind": "field",
22203
+ "name": "request",
22204
+ "type": {
22205
+ "text": "any"
22206
+ },
22207
+ "description": "Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.",
22317
22208
  "inheritedFrom": {
22318
- "name": "GridProBaseDatasource",
22209
+ "name": "GenesisGridDatasourceElement",
22319
22210
  "module": "src/datasource/base.datasource.ts"
22320
22211
  }
22321
22212
  },
22322
22213
  {
22323
- "kind": "method",
22324
- "name": "refreshRows",
22325
- "description": "Force the grid to redispatch the current rows"
22214
+ "kind": "field",
22215
+ "name": "requestAutoSetup",
22216
+ "type": {
22217
+ "text": "boolean"
22218
+ },
22219
+ "default": "true",
22220
+ "description": "Attribute to set whether the REQUEST object should be automatically set up.",
22221
+ "inheritedFrom": {
22222
+ "name": "GenesisGridDatasourceElement",
22223
+ "module": "src/datasource/base.datasource.ts"
22224
+ }
22225
+ },
22226
+ {
22227
+ "kind": "field",
22228
+ "name": "rowIdAttr",
22229
+ "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
22230
+ "inheritedFrom": {
22231
+ "name": "GenesisGridDatasourceElement",
22232
+ "module": "src/datasource/base.datasource.ts"
22233
+ }
22234
+ },
22235
+ {
22236
+ "kind": "field",
22237
+ "name": "restartOnReconnection",
22238
+ "type": {
22239
+ "text": "boolean"
22240
+ },
22241
+ "default": "true",
22242
+ "description": "Attribute to set whether the datasource should restart when it reconnects.",
22243
+ "inheritedFrom": {
22244
+ "name": "GenesisGridDatasourceElement",
22245
+ "module": "src/datasource/base.datasource.ts"
22246
+ }
22247
+ },
22248
+ {
22249
+ "kind": "field",
22250
+ "name": "defaultRowIdByResourceType",
22251
+ "type": {
22252
+ "text": "string"
22253
+ },
22254
+ "privacy": "protected",
22255
+ "readonly": true,
22256
+ "inheritedFrom": {
22257
+ "name": "GenesisGridDatasourceElement",
22258
+ "module": "src/datasource/base.datasource.ts"
22259
+ }
22260
+ },
22261
+ {
22262
+ "kind": "field",
22263
+ "name": "criteriaFromFilters",
22264
+ "type": {
22265
+ "text": "Map<string, string>"
22266
+ },
22267
+ "privacy": "protected",
22268
+ "default": "new Map()",
22269
+ "inheritedFrom": {
22270
+ "name": "GenesisGridDatasourceElement",
22271
+ "module": "src/datasource/base.datasource.ts"
22272
+ }
22273
+ },
22274
+ {
22275
+ "kind": "field",
22276
+ "name": "update",
22277
+ "type": {
22278
+ "text": "BehaviorSubject<Map<string, string>>"
22279
+ },
22280
+ "privacy": "protected",
22281
+ "default": "new BehaviorSubject(new Map())",
22282
+ "inheritedFrom": {
22283
+ "name": "GenesisGridDatasourceElement",
22284
+ "module": "src/datasource/base.datasource.ts"
22285
+ }
22326
22286
  },
22327
22287
  {
22328
22288
  "kind": "method",
22329
- "name": "reloadResourceData",
22330
- "privacy": "public",
22289
+ "name": "datasourceOptions",
22290
+ "privacy": "protected",
22331
22291
  "return": {
22332
22292
  "type": {
22333
- "text": "Promise<void>"
22293
+ "text": "DatasourceOptions"
22334
22294
  }
22335
22295
  },
22336
- "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).",
22337
22296
  "inheritedFrom": {
22338
- "name": "GridProBaseDatasource",
22297
+ "name": "GenesisGridDatasourceElement",
22339
22298
  "module": "src/datasource/base.datasource.ts"
22340
22299
  }
22341
22300
  },
22342
22301
  {
22343
- "kind": "method",
22344
- "name": "handleSnapshot",
22345
- "privacy": "private",
22346
- "parameters": [
22347
- {
22348
- "name": "result"
22349
- }
22350
- ]
22302
+ "kind": "field",
22303
+ "name": "isRequestServer",
22304
+ "type": {
22305
+ "text": "boolean"
22306
+ },
22307
+ "readonly": true,
22308
+ "inheritedFrom": {
22309
+ "name": "GenesisGridDatasourceElement",
22310
+ "module": "src/datasource/base.datasource.ts"
22311
+ }
22351
22312
  },
22352
22313
  {
22353
22314
  "kind": "method",
22354
- "name": "handleStreamResult",
22355
- "privacy": "private",
22315
+ "name": "datasourceStatusChanged",
22356
22316
  "parameters": [
22357
22317
  {
22358
- "name": "result",
22318
+ "name": "prev",
22359
22319
  "type": {
22360
- "text": "FilteredDataServerResult | RequestServerResult"
22320
+ "text": "DatasourceStatus"
22321
+ }
22322
+ },
22323
+ {
22324
+ "name": "next",
22325
+ "type": {
22326
+ "text": "DatasourceStatus"
22361
22327
  }
22362
22328
  }
22363
- ]
22329
+ ],
22330
+ "inheritedFrom": {
22331
+ "name": "GenesisGridDatasourceElement",
22332
+ "module": "src/datasource/base.datasource.ts"
22333
+ }
22364
22334
  },
22365
22335
  {
22366
22336
  "kind": "method",
22367
- "name": "emitMoreRowsChanged",
22368
- "privacy": "private",
22337
+ "name": "handleErrors",
22369
22338
  "parameters": [
22370
22339
  {
22371
- "name": "moreRows",
22340
+ "name": "errors",
22372
22341
  "type": {
22373
- "text": "boolean"
22374
- }
22375
- },
22376
- {
22377
- "name": "sourceRef",
22378
- "type": {
22379
- "text": "string"
22380
- }
22381
- }
22382
- ],
22383
- "description": "Emits `more-rows-changed` when the availability of more rows changes. @internal"
22384
- },
22385
- {
22386
- "kind": "method",
22387
- "name": "updateLoadMoreStatus",
22388
- "privacy": "private",
22389
- "parameters": [
22390
- {
22391
- "name": "moreRows",
22392
- "type": {
22393
- "text": "boolean"
22342
+ "text": "string | any[]"
22394
22343
  },
22395
- "description": "Whether more rows are available"
22344
+ "description": "The error message or array of error messages"
22396
22345
  },
22397
22346
  {
22398
- "name": "sourceRef",
22347
+ "name": "type",
22348
+ "default": "'unknown'",
22399
22349
  "type": {
22400
- "text": "string"
22350
+ "text": "BaseDatasourceErrorEventDetail['type']"
22401
22351
  },
22402
- "description": "The source reference"
22403
- },
22404
- {
22405
- "description": "The total number of rows",
22406
- "name": "rowsCount"
22352
+ "description": "The type of error that occurred"
22407
22353
  }
22408
22354
  ],
22409
- "description": "Updates the status bar based on more rows status"
22410
- },
22411
- {
22412
- "kind": "method",
22413
- "name": "applyRequestServerData",
22414
- "privacy": "private",
22415
- "parameters": [
22416
- {
22417
- "name": "requestServerResult",
22418
- "type": {
22419
- "text": "RequestServerResult"
22420
- }
22421
- }
22422
- ]
22423
- },
22424
- {
22425
- "kind": "method",
22426
- "name": "applyDataserverData",
22427
- "privacy": "private",
22428
- "parameters": [
22429
- {
22430
- "name": "dataServerResult",
22431
- "type": {
22432
- "text": "FilteredDataServerResult"
22433
- }
22434
- }
22435
- ]
22436
- },
22437
- {
22438
- "kind": "method",
22439
- "name": "getAgColumnDefs",
22440
- "privacy": "private",
22441
- "parameters": [
22442
- {
22443
- "name": "fieldsMetadata",
22444
- "type": {
22445
- "text": "FieldMetadata[]"
22446
- }
22447
- }
22448
- ]
22449
- },
22450
- {
22451
- "kind": "method",
22452
- "name": "setFilter",
22355
+ "description": "Handles errors and emits appropriate error events.",
22453
22356
  "privacy": "public",
22454
- "parameters": [
22455
- {
22456
- "name": "fieldName",
22457
- "type": {
22458
- "text": "string"
22459
- }
22460
- },
22461
- {
22462
- "name": "newFilter",
22463
- "type": {
22464
- "text": "string"
22465
- }
22466
- }
22467
- ],
22468
22357
  "inheritedFrom": {
22469
22358
  "name": "GenesisGridDatasourceElement",
22470
22359
  "module": "src/datasource/base.datasource.ts"
@@ -22472,1276 +22361,1273 @@
22472
22361
  },
22473
22362
  {
22474
22363
  "kind": "method",
22475
- "name": "removeFilter",
22364
+ "name": "clearErrors",
22365
+ "description": "Clears error state and emits connected event.",
22476
22366
  "privacy": "public",
22477
- "parameters": [
22478
- {
22479
- "name": "fieldName",
22480
- "type": {
22481
- "text": "string"
22482
- }
22483
- }
22484
- ],
22485
22367
  "inheritedFrom": {
22486
22368
  "name": "GenesisGridDatasourceElement",
22487
22369
  "module": "src/datasource/base.datasource.ts"
22488
22370
  }
22489
22371
  },
22490
22372
  {
22491
- "kind": "method",
22492
- "name": "handleSizeChanged",
22373
+ "kind": "field",
22374
+ "name": "_presentation",
22375
+ "type": {
22376
+ "text": "ComponentPresentation | null | undefined"
22377
+ },
22493
22378
  "privacy": "private",
22494
- "parameters": [
22495
- {
22496
- "name": "oldSize",
22497
- "type": {
22498
- "text": "number"
22499
- }
22500
- },
22501
- {
22502
- "name": "newSize",
22503
- "type": {
22504
- "text": "number"
22505
- }
22506
- }
22507
- ]
22508
- },
22509
- {
22510
- "kind": "method",
22511
- "name": "handleStreamInserts",
22512
- "privacy": "protected",
22513
- "parameters": [
22514
- {
22515
- "name": "inserts",
22516
- "default": "[]"
22517
- }
22518
- ],
22379
+ "default": "void 0",
22519
22380
  "inheritedFrom": {
22520
- "name": "GridProBaseDatasource",
22521
- "module": "src/datasource/base.datasource.ts"
22381
+ "name": "FoundationElement",
22382
+ "module": "src/foundation-element/foundation-element.ts"
22522
22383
  }
22523
22384
  },
22524
22385
  {
22525
- "kind": "method",
22526
- "name": "handleStreamUpdates",
22527
- "privacy": "protected",
22528
- "parameters": [
22529
- {
22530
- "name": "updates",
22531
- "default": "[]"
22532
- }
22533
- ],
22386
+ "kind": "field",
22387
+ "name": "$presentation",
22388
+ "type": {
22389
+ "text": "ComponentPresentation | null"
22390
+ },
22391
+ "privacy": "public",
22392
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
22534
22393
  "inheritedFrom": {
22535
- "name": "GridProBaseDatasource",
22536
- "module": "src/datasource/base.datasource.ts"
22394
+ "name": "FoundationElement",
22395
+ "module": "src/foundation-element/foundation-element.ts"
22537
22396
  }
22538
22397
  },
22539
22398
  {
22540
- "kind": "method",
22541
- "name": "handleStreamDeletes",
22542
- "privacy": "protected",
22543
- "parameters": [
22544
- {
22545
- "name": "deletes",
22546
- "default": "[]",
22547
- "description": "List of records to remove from the grid stream"
22548
- }
22549
- ],
22550
- "description": "Handles stream deletes by removing records from the grid.",
22399
+ "kind": "field",
22400
+ "name": "template",
22401
+ "type": {
22402
+ "text": "ElementViewTemplate | void | null"
22403
+ },
22404
+ "privacy": "public",
22405
+ "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.",
22551
22406
  "inheritedFrom": {
22552
- "name": "GridProBaseDatasource",
22553
- "module": "src/datasource/base.datasource.ts"
22407
+ "name": "FoundationElement",
22408
+ "module": "src/foundation-element/foundation-element.ts"
22554
22409
  }
22555
22410
  },
22556
22411
  {
22557
22412
  "kind": "method",
22558
- "name": "setVisibleColumns",
22413
+ "name": "templateChanged",
22414
+ "privacy": "protected",
22559
22415
  "return": {
22560
22416
  "type": {
22561
22417
  "text": "void"
22562
22418
  }
22563
22419
  },
22564
- "parameters": [
22565
- {
22566
- "name": "visibleFields",
22567
- "type": {
22568
- "text": "string[]"
22569
- },
22570
- "description": "Field names of the currently visible columns."
22571
- }
22572
- ],
22573
- "description": "Updates the set of visible columns and reloads the data when the set changes.",
22420
+ "inheritedFrom": {
22421
+ "name": "FoundationElement",
22422
+ "module": "src/foundation-element/foundation-element.ts"
22423
+ }
22424
+ },
22425
+ {
22426
+ "kind": "field",
22427
+ "name": "styles",
22428
+ "type": {
22429
+ "text": "ElementStyles | void | null"
22430
+ },
22574
22431
  "privacy": "public",
22432
+ "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.",
22575
22433
  "inheritedFrom": {
22576
- "name": "GridProBaseDatasource",
22577
- "module": "src/datasource/base.datasource.ts"
22434
+ "name": "FoundationElement",
22435
+ "module": "src/foundation-element/foundation-element.ts"
22578
22436
  }
22579
22437
  },
22580
22438
  {
22581
22439
  "kind": "method",
22582
- "name": "loadMore",
22440
+ "name": "stylesChanged",
22441
+ "privacy": "protected",
22442
+ "return": {
22443
+ "type": {
22444
+ "text": "void"
22445
+ }
22446
+ },
22583
22447
  "inheritedFrom": {
22584
- "name": "GridProBaseDatasource",
22585
- "module": "src/datasource/base.datasource.ts"
22448
+ "name": "FoundationElement",
22449
+ "module": "src/foundation-element/foundation-element.ts"
22586
22450
  }
22587
22451
  },
22588
22452
  {
22589
22453
  "kind": "method",
22590
- "name": "cloneNode",
22454
+ "name": "compose",
22455
+ "privacy": "public",
22456
+ "static": true,
22591
22457
  "return": {
22592
22458
  "type": {
22593
- "text": "Node"
22459
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
22594
22460
  }
22595
22461
  },
22596
22462
  "parameters": [
22597
22463
  {
22598
- "name": "deep",
22599
- "optional": true,
22464
+ "name": "this",
22600
22465
  "type": {
22601
- "text": "boolean"
22466
+ "text": "K"
22602
22467
  }
22468
+ },
22469
+ {
22470
+ "name": "elementDefinition",
22471
+ "type": {
22472
+ "text": "T"
22473
+ },
22474
+ "description": "The definition of the element to create the registry\nfunction for."
22603
22475
  }
22604
22476
  ],
22477
+ "description": "Defines an element registry function with a set of element definition defaults.",
22605
22478
  "inheritedFrom": {
22606
- "name": "LifecycleMixin",
22607
- "module": "src/mixins/lifecycle/lifecycle.ts"
22479
+ "name": "FoundationElement",
22480
+ "module": "src/foundation-element/foundation-element.ts"
22608
22481
  }
22609
- },
22482
+ }
22483
+ ],
22484
+ "events": [
22610
22485
  {
22611
- "kind": "field",
22612
- "name": "shouldRunDisconnect",
22613
- "return": {
22614
- "type": {
22615
- "text": ""
22616
- }
22617
- },
22618
- "readonly": true,
22486
+ "description": "Fired when a datasource error is reported. detail: `BaseDatasourceErrorEventDetail`",
22487
+ "name": "base-datasource-error",
22619
22488
  "inheritedFrom": {
22620
- "name": "LifecycleMixin",
22621
- "module": "src/mixins/lifecycle/lifecycle.ts"
22489
+ "name": "GenesisGridDatasourceElement",
22490
+ "module": "src/datasource/base.datasource.ts"
22622
22491
  }
22623
22492
  },
22624
22493
  {
22625
- "kind": "field",
22626
- "name": "shouldRunConnect",
22627
- "return": {
22628
- "type": {
22629
- "text": ""
22630
- }
22631
- },
22632
- "readonly": true,
22494
+ "description": "Fired when a datasource error occurs (for grid integration). detail: `DatasourceErrorEventDetail`",
22495
+ "name": "datasource-error",
22633
22496
  "inheritedFrom": {
22634
- "name": "LifecycleMixin",
22635
- "module": "src/mixins/lifecycle/lifecycle.ts"
22497
+ "name": "GenesisGridDatasourceElement",
22498
+ "module": "src/datasource/base.datasource.ts"
22636
22499
  }
22637
22500
  },
22638
22501
  {
22639
- "kind": "method",
22640
- "name": "#_blockLifecycleDueToTokenChange",
22641
- "return": {
22642
- "type": {
22643
- "text": "boolean"
22644
- }
22645
- },
22646
- "parameters": [
22647
- {
22648
- "name": "lifecycleType",
22649
- "type": {
22650
- "text": "Lifecycletype"
22651
- }
22652
- }
22653
- ],
22502
+ "description": "Fired when error state is cleared after connection succeeds",
22503
+ "name": "base-datasource-connected",
22654
22504
  "inheritedFrom": {
22655
- "name": "LifecycleMixin",
22656
- "module": "src/mixins/lifecycle/lifecycle.ts"
22505
+ "name": "GenesisGridDatasourceElement",
22506
+ "module": "src/datasource/base.datasource.ts"
22657
22507
  }
22658
22508
  },
22659
22509
  {
22660
- "kind": "field",
22661
- "name": "serializer",
22510
+ "description": "Fired when loading completes with no pending row changes",
22511
+ "name": "datasource-loading-finished",
22512
+ "inheritedFrom": {
22513
+ "name": "GenesisGridDatasourceElement",
22514
+ "module": "src/datasource/base.datasource.ts"
22515
+ }
22516
+ },
22517
+ {
22518
+ "description": "Fired when the grid has no rows after load",
22519
+ "name": "datasource-no-data-available",
22520
+ "inheritedFrom": {
22521
+ "name": "GenesisGridDatasourceElement",
22522
+ "module": "src/datasource/base.datasource.ts"
22523
+ }
22524
+ },
22525
+ {
22526
+ "description": "Fired when row data changes from stream updates. detail: `DataChangedEventDetail`",
22527
+ "name": "datasource-data-changed",
22528
+ "inheritedFrom": {
22529
+ "name": "GenesisGridDatasourceElement",
22530
+ "module": "src/datasource/base.datasource.ts"
22531
+ }
22532
+ },
22533
+ {
22534
+ "description": "Fired to hand off grid options and initialization flags. detail: `InitializeEventDetail`",
22535
+ "name": "datasource-initialize"
22536
+ },
22537
+ {
22538
+ "description": "Fired when the datasource is torn down",
22539
+ "name": "datasource-destroy"
22540
+ },
22541
+ {
22542
+ "description": "Fired when row data is cleared. detail: `DataClearedEventDetail`",
22543
+ "name": "datasource-data-cleared"
22544
+ },
22545
+ {
22546
+ "description": "Fired when column metadata or defs are updated. detail: `SchemaUpdatedEventDetail`",
22547
+ "name": "datasource-schema-updated"
22548
+ },
22549
+ {
22550
+ "description": "Fired when persisted filters are reapplied",
22551
+ "name": "datasource-filters-restored"
22552
+ },
22553
+ {
22554
+ "description": "Fired when a data payload is loaded for the grid. detail: `DataLoadedEventDetail`",
22555
+ "name": "datasource-data-loaded"
22556
+ },
22557
+ {
22558
+ "description": "Fired when a load or refresh starts",
22559
+ "name": "datasource-loading-started"
22560
+ },
22561
+ {
22562
+ "description": "Fired when more server rows can be requested. detail: `MoreDataAvailableEventDetail`",
22563
+ "name": "datasource-more-data-available"
22564
+ },
22565
+ {
22566
+ "description": "Fired when the host grid is ready to start loading data",
22567
+ "name": "datasource-ready"
22568
+ },
22569
+ {
22570
+ "description": "Fired when initial grid data is ready for the client-side model",
22571
+ "name": "datasource-init"
22572
+ },
22573
+ {
22574
+ "description": "Fired when MORE_ROWS availability changes. detail: `MoreRowsDetail`",
22575
+ "name": "more-rows-changed"
22576
+ },
22577
+ {
22578
+ "description": "Fired when layout or viewport sizing affects the datasource. detail: `GrigProGenesisDatasourceSizeChangedEventDetail`",
22579
+ "name": "datasource-size-changed"
22580
+ }
22581
+ ],
22582
+ "attributes": [
22583
+ {
22584
+ "name": "keep-col-defs-on-clear-row-data",
22662
22585
  "type": {
22663
- "text": "JSONSerializer"
22586
+ "text": "boolean"
22587
+ },
22588
+ "default": "false",
22589
+ "fieldName": "keepColDefsOnClearRowData"
22590
+ },
22591
+ {
22592
+ "name": "request-visible-columns-only",
22593
+ "type": {
22594
+ "text": "boolean"
22595
+ },
22596
+ "default": "false",
22597
+ "description": "When enabled and column definitions are provided, the datasource requests data only for the\ncolumns that are currently visible. The visible set is seeded from the column config (columns\nnot flagged with `hide`) and updated by the host grid via `setVisibleColumns`; the data\nis reloaded whenever that set changes.",
22598
+ "fieldName": "requestVisibleColumnsOnly"
22599
+ },
22600
+ {
22601
+ "name": "criteria",
22602
+ "type": {
22603
+ "text": "string"
22664
22604
  },
22605
+ "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
22606
+ "fieldName": "criteria",
22665
22607
  "inheritedFrom": {
22666
- "name": "GridProBaseDatasource",
22608
+ "name": "GenesisGridDatasourceElement",
22667
22609
  "module": "src/datasource/base.datasource.ts"
22668
22610
  }
22669
22611
  },
22670
22612
  {
22671
- "kind": "field",
22672
- "name": "dataSubWasLoggedOff",
22613
+ "name": "is-snapshot",
22673
22614
  "type": {
22674
22615
  "text": "boolean"
22675
22616
  },
22676
- "privacy": "protected",
22677
22617
  "default": "false",
22618
+ "description": "Request a snapshot from the server.",
22619
+ "fieldName": "isSnapshot",
22678
22620
  "inheritedFrom": {
22679
- "name": "GridProBaseDatasource",
22621
+ "name": "GenesisGridDatasourceElement",
22680
22622
  "module": "src/datasource/base.datasource.ts"
22681
22623
  }
22682
22624
  },
22683
22625
  {
22684
- "kind": "field",
22685
- "name": "rowData",
22626
+ "name": "max-rows",
22686
22627
  "type": {
22687
- "text": "Map<string, any>"
22628
+ "text": "number"
22688
22629
  },
22689
- "default": "new Map()",
22630
+ "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
22631
+ "fieldName": "maxRows",
22690
22632
  "inheritedFrom": {
22691
- "name": "GridProBaseDatasource",
22633
+ "name": "GenesisGridDatasourceElement",
22692
22634
  "module": "src/datasource/base.datasource.ts"
22693
22635
  }
22694
22636
  },
22695
22637
  {
22696
- "kind": "field",
22697
- "name": "missingRowIdWarned",
22638
+ "name": "order-by",
22698
22639
  "type": {
22699
- "text": "boolean"
22640
+ "text": "string"
22700
22641
  },
22701
- "privacy": "private",
22702
- "default": "false",
22703
- "description": "So rows without a row id are warned about once per element, not once per block. @internal",
22642
+ "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.",
22643
+ "fieldName": "orderBy",
22704
22644
  "inheritedFrom": {
22705
- "name": "GridProBaseDatasource",
22645
+ "name": "GenesisGridDatasourceElement",
22706
22646
  "module": "src/datasource/base.datasource.ts"
22707
22647
  }
22708
22648
  },
22709
22649
  {
22710
- "kind": "field",
22711
- "name": "connectionSub",
22650
+ "name": "resource-name",
22712
22651
  "type": {
22713
- "text": "Subscription | undefined"
22652
+ "text": "string"
22714
22653
  },
22715
- "privacy": "protected",
22654
+ "description": "The name of the target Data Server query or Request Server requestReply.",
22655
+ "fieldName": "resourceName",
22716
22656
  "inheritedFrom": {
22717
- "name": "GridProBaseDatasource",
22657
+ "name": "GenesisGridDatasourceElement",
22718
22658
  "module": "src/datasource/base.datasource.ts"
22719
22659
  }
22720
22660
  },
22721
22661
  {
22722
- "kind": "method",
22723
- "name": "subscribeToConnection",
22724
- "privacy": "protected",
22662
+ "name": "view-number",
22663
+ "type": {
22664
+ "text": "number"
22665
+ },
22666
+ "description": "The desired view/page you want data from.",
22667
+ "fieldName": "viewNumber",
22725
22668
  "inheritedFrom": {
22726
- "name": "GridProBaseDatasource",
22669
+ "name": "GenesisGridDatasourceElement",
22727
22670
  "module": "src/datasource/base.datasource.ts"
22728
22671
  }
22729
22672
  },
22730
22673
  {
22731
- "kind": "method",
22732
- "name": "unsubscribeFromConnection",
22733
- "privacy": "protected",
22674
+ "name": "fields",
22675
+ "type": {
22676
+ "text": "string"
22677
+ },
22678
+ "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.",
22679
+ "fieldName": "fields",
22734
22680
  "inheritedFrom": {
22735
- "name": "GridProBaseDatasource",
22681
+ "name": "GenesisGridDatasourceElement",
22736
22682
  "module": "src/datasource/base.datasource.ts"
22737
22683
  }
22738
22684
  },
22739
22685
  {
22740
- "kind": "method",
22741
- "name": "generateColumnDefsFromMetadata",
22742
- "privacy": "protected",
22743
- "return": {
22744
- "type": {
22745
- "text": "ColDef[]"
22746
- }
22686
+ "name": "max-view",
22687
+ "type": {
22688
+ "text": "number"
22747
22689
  },
22748
- "parameters": [
22749
- {
22750
- "name": "fieldsMetadata",
22751
- "type": {
22752
- "text": "FieldMetadata[]"
22753
- }
22754
- },
22755
- {
22756
- "name": "getFilterParamsByFieldType",
22757
- "type": {
22758
- "text": "(field: FieldMetadata) => ColDef['filterParams'] | any"
22759
- }
22760
- },
22761
- {
22762
- "name": "getFilterByFieldType",
22763
- "type": {
22764
- "text": "(type: FieldTypeEnum) => string"
22765
- }
22766
- }
22767
- ],
22690
+ "description": "Maximum number of rows to track as part of a client \"view\".",
22691
+ "fieldName": "maxView",
22768
22692
  "inheritedFrom": {
22769
- "name": "GridProBaseDatasource",
22693
+ "name": "GenesisGridDatasourceElement",
22770
22694
  "module": "src/datasource/base.datasource.ts"
22771
22695
  }
22772
22696
  },
22773
22697
  {
22774
- "kind": "method",
22775
- "name": "applyAllTransactions",
22776
- "privacy": "protected",
22698
+ "name": "moving-view",
22699
+ "type": {
22700
+ "text": "boolean"
22701
+ },
22702
+ "default": "false",
22703
+ "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.",
22704
+ "fieldName": "movingView",
22777
22705
  "inheritedFrom": {
22778
- "name": "GridProBaseDatasource",
22706
+ "name": "GenesisGridDatasourceElement",
22779
22707
  "module": "src/datasource/base.datasource.ts"
22780
22708
  }
22781
22709
  },
22782
22710
  {
22783
- "kind": "method",
22784
- "name": "applyMappedTransaction",
22785
- "privacy": "private",
22786
- "parameters": [
22787
- {
22788
- "name": "transaction",
22789
- "type": {
22790
- "text": "TransactionData"
22791
- }
22792
- },
22793
- {
22794
- "name": "operation",
22795
- "type": {
22796
- "text": "OperationType"
22797
- }
22798
- }
22799
- ],
22800
- "inheritedFrom": {
22801
- "name": "GridProBaseDatasource",
22802
- "module": "src/datasource/base.datasource.ts"
22803
- }
22804
- },
22805
- {
22806
- "kind": "method",
22807
- "name": "emitTransaction",
22808
- "privacy": "protected",
22809
- "return": {
22810
- "type": {
22811
- "text": "void"
22812
- }
22813
- },
22814
- "parameters": [
22815
- {
22816
- "name": "transaction",
22817
- "type": {
22818
- "text": "TransactionData | undefined"
22819
- }
22820
- }
22821
- ],
22822
- "description": "Emits `datasource-data-changed` for `transaction` when it is non-empty. @internal",
22823
- "inheritedFrom": {
22824
- "name": "GridProBaseDatasource",
22825
- "module": "src/datasource/base.datasource.ts"
22826
- }
22827
- },
22828
- {
22829
- "kind": "method",
22830
- "name": "mapTransaction",
22831
- "privacy": "private",
22832
- "parameters": [
22833
- {
22834
- "name": "transaction",
22835
- "type": {
22836
- "text": "TransactionData"
22837
- },
22838
- "description": "The transaction data to be mapped."
22839
- },
22840
- {
22841
- "name": "operations",
22842
- "default": "Object.values(OperationType)",
22843
- "type": {
22844
- "text": "OperationType[]"
22845
- },
22846
- "description": "The operations to be mapped. Can be 'add', 'update' or 'remove'."
22847
- }
22848
- ],
22849
- "description": "Maps the transaction data to the row data mapper function, if it exists.",
22850
- "return": {
22851
- "type": {
22852
- "text": ""
22853
- }
22854
- },
22855
- "inheritedFrom": {
22856
- "name": "GridProBaseDatasource",
22857
- "module": "src/datasource/base.datasource.ts"
22858
- }
22859
- },
22860
- {
22861
- "kind": "field",
22862
- "name": "_isDisconnected",
22863
22711
  "type": {
22864
- "text": "boolean"
22712
+ "text": "number"
22865
22713
  },
22866
- "privacy": "private",
22714
+ "description": "Option that changes the Data Server index iteration.",
22715
+ "fieldName": "reverse",
22867
22716
  "default": "false",
22868
- "inheritedFrom": {
22869
- "name": "GridProBaseDatasource",
22870
- "module": "src/datasource/base.datasource.ts"
22871
- }
22872
- },
22873
- {
22874
- "kind": "method",
22875
- "name": "setDisconnected",
22876
- "privacy": "public",
22877
- "parameters": [
22878
- {
22879
- "name": "disconnected",
22880
- "type": {
22881
- "text": "boolean"
22882
- },
22883
- "description": "true to set, false to remove"
22884
- }
22885
- ],
22886
- "description": "Sets the disconnected state and emits appropriate events.\nA repeated `true` is ignored so the dialog does not gain another \"Datasource disconnected\" line.",
22887
- "inheritedFrom": {
22888
- "name": "GridProBaseDatasource",
22889
- "module": "src/datasource/base.datasource.ts"
22890
- }
22891
- },
22892
- {
22893
- "kind": "method",
22894
- "name": "isDisconnected",
22895
- "privacy": "public",
22896
- "return": {
22897
- "type": {
22898
- "text": "boolean"
22899
- }
22900
- },
22901
- "description": "Returns true if the datasource is disconnected.",
22902
- "inheritedFrom": {
22903
- "name": "GridProBaseDatasource",
22904
- "module": "src/datasource/base.datasource.ts"
22905
- }
22906
- },
22907
- {
22908
- "kind": "method",
22909
- "name": "getDatasourceStatusBarPanels",
22910
- "privacy": "public",
22911
- "return": {
22912
- "type": {
22913
- "text": "any[]"
22914
- }
22915
- },
22916
- "parameters": [
22917
- {
22918
- "name": "isServerSide",
22919
- "type": {
22920
- "text": "boolean"
22921
- }
22922
- },
22923
- {
22924
- "name": "statusBarConfig",
22925
- "type": {
22926
- "text": "any"
22927
- }
22928
- }
22929
- ],
22930
- "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.",
22931
- "inheritedFrom": {
22932
- "name": "GridProBaseDatasource",
22933
- "module": "src/datasource/base.datasource.ts"
22934
- }
22935
- },
22936
- {
22937
- "kind": "field",
22938
- "name": "connect",
22939
- "type": {
22940
- "text": "Connect"
22941
- },
22942
- "inheritedFrom": {
22943
- "name": "GenesisGridDatasourceElement",
22944
- "module": "src/datasource/base.datasource.ts"
22945
- }
22946
- },
22947
- {
22948
- "kind": "field",
22949
- "name": "datasource",
22950
- "type": {
22951
- "text": "Datasource"
22952
- },
22953
- "inheritedFrom": {
22954
- "name": "GenesisGridDatasourceElement",
22955
- "module": "src/datasource/base.datasource.ts"
22956
- }
22957
- },
22958
- {
22959
- "kind": "field",
22960
- "name": "deferredGridOptions",
22961
- "type": {
22962
- "text": "GridOptions"
22963
- },
22964
- "inheritedFrom": {
22965
- "name": "GenesisGridDatasourceElement",
22966
- "module": "src/datasource/base.datasource.ts"
22967
- }
22968
- },
22969
- {
22970
- "kind": "field",
22971
- "name": "deferredColumnStates",
22972
- "type": {
22973
- "text": "ColumnState[]"
22974
- },
22975
- "inheritedFrom": {
22976
- "name": "GenesisGridDatasourceElement",
22977
- "module": "src/datasource/base.datasource.ts"
22978
- }
22979
- },
22980
- {
22981
- "kind": "field",
22982
- "name": "rowDataMapper",
22983
- "type": {
22984
- "text": "Function"
22985
- },
22986
- "description": "Allows grid data updates to be processed via and external function before applying in grid",
22987
- "inheritedFrom": {
22988
- "name": "GenesisGridDatasourceElement",
22989
- "module": "src/datasource/base.datasource.ts"
22990
- }
22991
- },
22992
- {
22993
- "kind": "field",
22994
- "name": "criteria",
22995
- "type": {
22996
- "text": "string"
22997
- },
22998
- "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
22999
22717
  "inheritedFrom": {
23000
22718
  "name": "GenesisGridDatasourceElement",
23001
22719
  "module": "src/datasource/base.datasource.ts"
23002
22720
  }
23003
22721
  },
23004
22722
  {
23005
- "kind": "field",
23006
- "name": "isSnapshot",
22723
+ "name": "disable-polling",
23007
22724
  "type": {
23008
22725
  "text": "boolean"
23009
22726
  },
23010
22727
  "default": "false",
23011
- "description": "Request a snapshot from the server.",
22728
+ "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
22729
+ "fieldName": "disablePolling",
23012
22730
  "inheritedFrom": {
23013
22731
  "name": "GenesisGridDatasourceElement",
23014
22732
  "module": "src/datasource/base.datasource.ts"
23015
22733
  }
23016
22734
  },
23017
22735
  {
23018
- "kind": "field",
23019
- "name": "maxRows",
22736
+ "name": "polling-interval",
23020
22737
  "type": {
23021
22738
  "text": "number"
23022
22739
  },
23023
- "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
22740
+ "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
22741
+ "fieldName": "pollingInterval",
23024
22742
  "inheritedFrom": {
23025
22743
  "name": "GenesisGridDatasourceElement",
23026
22744
  "module": "src/datasource/base.datasource.ts"
23027
22745
  }
23028
22746
  },
23029
22747
  {
23030
- "kind": "field",
23031
- "name": "orderBy",
22748
+ "name": "request-auto-setup",
23032
22749
  "type": {
23033
- "text": "string"
22750
+ "text": "boolean"
23034
22751
  },
23035
- "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.",
22752
+ "default": "true",
22753
+ "description": "Attribute to set whether the REQUEST object should be automatically set up.",
22754
+ "fieldName": "requestAutoSetup",
23036
22755
  "inheritedFrom": {
23037
22756
  "name": "GenesisGridDatasourceElement",
23038
22757
  "module": "src/datasource/base.datasource.ts"
23039
22758
  }
23040
22759
  },
23041
22760
  {
23042
- "kind": "field",
23043
- "name": "resourceName",
23044
- "type": {
23045
- "text": "string"
23046
- },
23047
- "description": "The name of the target Data Server query or Request Server requestReply.",
22761
+ "name": "row-id",
22762
+ "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
22763
+ "fieldName": "rowIdAttr",
23048
22764
  "inheritedFrom": {
23049
22765
  "name": "GenesisGridDatasourceElement",
23050
22766
  "module": "src/datasource/base.datasource.ts"
23051
22767
  }
23052
22768
  },
23053
22769
  {
23054
- "kind": "field",
23055
- "name": "viewNumber",
22770
+ "name": "restart-on-reconnection",
23056
22771
  "type": {
23057
- "text": "number"
22772
+ "text": "boolean"
23058
22773
  },
23059
- "description": "The desired view/page you want data from.",
22774
+ "default": "true",
22775
+ "description": "Attribute to set whether the datasource should restart when it reconnects.",
22776
+ "fieldName": "restartOnReconnection",
23060
22777
  "inheritedFrom": {
23061
22778
  "name": "GenesisGridDatasourceElement",
23062
22779
  "module": "src/datasource/base.datasource.ts"
23063
22780
  }
23064
- },
22781
+ }
22782
+ ],
22783
+ "mixins": [
23065
22784
  {
23066
- "kind": "field",
23067
- "name": "fields",
23068
- "type": {
23069
- "text": "string"
23070
- },
23071
- "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.",
23072
- "inheritedFrom": {
23073
- "name": "GenesisGridDatasourceElement",
23074
- "module": "src/datasource/base.datasource.ts"
23075
- }
23076
- },
22785
+ "name": "LifecycleMixin",
22786
+ "package": "@genesislcap/foundation-utils"
22787
+ }
22788
+ ],
22789
+ "superclass": {
22790
+ "name": "GridProBaseDatasource",
22791
+ "module": "/src/datasource/base.datasource"
22792
+ },
22793
+ "tagName": "grid-pro-genesis-datasource",
22794
+ "customElement": true
22795
+ }
22796
+ ],
22797
+ "exports": [
22798
+ {
22799
+ "kind": "js",
22800
+ "name": "GridProGenesisDatasource",
22801
+ "declaration": {
22802
+ "name": "GridProGenesisDatasource",
22803
+ "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
22804
+ }
22805
+ },
22806
+ {
22807
+ "kind": "custom-element-definition",
22808
+ "name": "grid-pro-genesis-datasource",
22809
+ "declaration": {
22810
+ "name": "GridProGenesisDatasource",
22811
+ "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
22812
+ }
22813
+ }
22814
+ ]
22815
+ },
22816
+ {
22817
+ "kind": "javascript-module",
22818
+ "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
22819
+ "declarations": [],
22820
+ "exports": []
22821
+ },
22822
+ {
22823
+ "kind": "javascript-module",
22824
+ "path": "src/grid-pro-genesis-datasource/index.ts",
22825
+ "declarations": [],
22826
+ "exports": [
22827
+ {
22828
+ "kind": "js",
22829
+ "name": "*",
22830
+ "declaration": {
22831
+ "name": "*",
22832
+ "package": "./datasource-events.types"
22833
+ }
22834
+ },
22835
+ {
22836
+ "kind": "js",
22837
+ "name": "*",
22838
+ "declaration": {
22839
+ "name": "*",
22840
+ "package": "./grid-pro-genesis-datasource"
22841
+ }
22842
+ },
22843
+ {
22844
+ "kind": "js",
22845
+ "name": "*",
22846
+ "declaration": {
22847
+ "name": "*",
22848
+ "package": "./grid-pro-genesis-datasource.config"
22849
+ }
22850
+ },
22851
+ {
22852
+ "kind": "js",
22853
+ "name": "*",
22854
+ "declaration": {
22855
+ "name": "*",
22856
+ "package": "./grid-pro-genesis-datasource.types"
22857
+ }
22858
+ }
22859
+ ]
22860
+ },
22861
+ {
22862
+ "kind": "javascript-module",
22863
+ "path": "src/multicolumn-dropdown/index.ts",
22864
+ "declarations": [],
22865
+ "exports": [
22866
+ {
22867
+ "kind": "js",
22868
+ "name": "*",
22869
+ "declaration": {
22870
+ "name": "*",
22871
+ "package": "./multicolumn-dropdown"
22872
+ }
22873
+ },
22874
+ {
22875
+ "kind": "js",
22876
+ "name": "*",
22877
+ "declaration": {
22878
+ "name": "*",
22879
+ "package": "./multicolumn-dropdown.styles"
22880
+ }
22881
+ },
22882
+ {
22883
+ "kind": "js",
22884
+ "name": "*",
22885
+ "declaration": {
22886
+ "name": "*",
22887
+ "package": "./multicolumn-dropdown.template"
22888
+ }
22889
+ }
22890
+ ]
22891
+ },
22892
+ {
22893
+ "kind": "javascript-module",
22894
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts",
22895
+ "declarations": [
22896
+ {
22897
+ "kind": "variable",
22898
+ "name": "dropdownWidthVar",
22899
+ "type": {
22900
+ "text": "string"
22901
+ },
22902
+ "default": "'--dropdown-width'",
22903
+ "description": "The CSS variable to use for specifying the dropdown's width"
22904
+ },
22905
+ {
22906
+ "kind": "variable",
22907
+ "name": "optionsClass",
22908
+ "type": {
22909
+ "text": "string"
22910
+ },
22911
+ "default": "'options'",
22912
+ "description": "The CSS class to use for the options element's class in the dropdown"
22913
+ },
22914
+ {
22915
+ "kind": "variable",
22916
+ "name": "DISPLAY_NONE_CLASS",
22917
+ "type": {
22918
+ "text": "string"
22919
+ },
22920
+ "default": "'dnone'",
22921
+ "description": "Class name used to hide elements with display:none"
22922
+ },
22923
+ {
22924
+ "kind": "variable",
22925
+ "name": "multicolumnDropdownStyles",
22926
+ "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`",
22927
+ "description": "Multicolumn Dropdown styles.",
22928
+ "privacy": "public"
22929
+ }
22930
+ ],
22931
+ "exports": [
22932
+ {
22933
+ "kind": "js",
22934
+ "name": "dropdownWidthVar",
22935
+ "declaration": {
22936
+ "name": "dropdownWidthVar",
22937
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
22938
+ }
22939
+ },
22940
+ {
22941
+ "kind": "js",
22942
+ "name": "optionsClass",
22943
+ "declaration": {
22944
+ "name": "optionsClass",
22945
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
22946
+ }
22947
+ },
22948
+ {
22949
+ "kind": "js",
22950
+ "name": "DISPLAY_NONE_CLASS",
22951
+ "declaration": {
22952
+ "name": "DISPLAY_NONE_CLASS",
22953
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
22954
+ }
22955
+ },
22956
+ {
22957
+ "kind": "js",
22958
+ "name": "multicolumnDropdownStyles",
22959
+ "declaration": {
22960
+ "name": "multicolumnDropdownStyles",
22961
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
22962
+ }
22963
+ }
22964
+ ]
22965
+ },
22966
+ {
22967
+ "kind": "javascript-module",
22968
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts",
22969
+ "declarations": [
22970
+ {
22971
+ "kind": "function",
22972
+ "name": "getMulticolumnDropdownTemplate",
22973
+ "parameters": [
23077
22974
  {
23078
- "kind": "field",
23079
- "name": "maxView",
22975
+ "name": "designSystem",
22976
+ "default": "'foundation'",
22977
+ "description": "The design system prefix to use. Defaults to 'foundation'."
22978
+ }
22979
+ ],
22980
+ "description": "Get a Design System prefixed Multicolumn Dropdown template.",
22981
+ "return": {
22982
+ "type": {
22983
+ "text": ""
22984
+ }
22985
+ },
22986
+ "privacy": "public"
22987
+ },
22988
+ {
22989
+ "kind": "variable",
22990
+ "name": "multicolumnDropdownTemplate",
22991
+ "description": "The default Multicolumn Dropdown template using the 'foundation' design system prefix.",
22992
+ "privacy": "public"
22993
+ }
22994
+ ],
22995
+ "exports": [
22996
+ {
22997
+ "kind": "js",
22998
+ "name": "getMulticolumnDropdownTemplate",
22999
+ "declaration": {
23000
+ "name": "getMulticolumnDropdownTemplate",
23001
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
23002
+ }
23003
+ },
23004
+ {
23005
+ "kind": "js",
23006
+ "name": "multicolumnDropdownTemplate",
23007
+ "declaration": {
23008
+ "name": "multicolumnDropdownTemplate",
23009
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
23010
+ }
23011
+ }
23012
+ ]
23013
+ },
23014
+ {
23015
+ "kind": "javascript-module",
23016
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.ts",
23017
+ "declarations": [
23018
+ {
23019
+ "kind": "function",
23020
+ "name": "wasClickOutsideElement",
23021
+ "parameters": [
23022
+ {
23023
+ "name": "event",
23080
23024
  "type": {
23081
- "text": "number"
23082
- },
23083
- "description": "Maximum number of rows to track as part of a client \"view\".",
23084
- "inheritedFrom": {
23085
- "name": "GenesisGridDatasourceElement",
23086
- "module": "src/datasource/base.datasource.ts"
23025
+ "text": "MouseEvent"
23087
23026
  }
23088
23027
  },
23089
23028
  {
23090
- "kind": "field",
23091
- "name": "movingView",
23029
+ "name": "target",
23092
23030
  "type": {
23093
- "text": "boolean"
23094
- },
23095
- "default": "false",
23096
- "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.",
23097
- "inheritedFrom": {
23098
- "name": "GenesisGridDatasourceElement",
23099
- "module": "src/datasource/base.datasource.ts"
23031
+ "text": "EventTarget"
23100
23032
  }
23101
- },
23033
+ }
23034
+ ],
23035
+ "description": "Checks if the given mouse event occurred outside the target element.",
23036
+ "privacy": "public"
23037
+ },
23038
+ {
23039
+ "kind": "class",
23040
+ "description": "",
23041
+ "name": "MulticolumnDropdown",
23042
+ "members": [
23102
23043
  {
23103
23044
  "kind": "field",
23104
- "name": "reverse",
23105
- "type": {
23106
- "text": "boolean"
23107
- },
23108
- "default": "false",
23109
- "description": "Option that changes the Data Server index iteration.",
23110
- "inheritedFrom": {
23111
- "name": "GenesisGridDatasourceElement",
23112
- "module": "src/datasource/base.datasource.ts"
23045
+ "name": "optionsElement",
23046
+ "type": {
23047
+ "text": "HTMLElement"
23113
23048
  }
23114
23049
  },
23115
23050
  {
23116
23051
  "kind": "field",
23117
- "name": "disablePolling",
23052
+ "name": "lastRequest",
23118
23053
  "type": {
23119
- "text": "boolean"
23054
+ "text": "object"
23120
23055
  },
23121
- "default": "false",
23122
- "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
23123
- "inheritedFrom": {
23124
- "name": "GenesisGridDatasourceElement",
23125
- "module": "src/datasource/base.datasource.ts"
23126
- }
23056
+ "privacy": "private"
23127
23057
  },
23128
23058
  {
23129
23059
  "kind": "field",
23130
- "name": "offset",
23060
+ "name": "connectOverride",
23131
23061
  "type": {
23132
- "text": "number"
23062
+ "text": "Connect"
23133
23063
  },
23134
- "description": "The offset for pagination in REQUEST_SERVER scenarios.",
23135
- "inheritedFrom": {
23136
- "name": "GenesisGridDatasourceElement",
23137
- "module": "src/datasource/base.datasource.ts"
23138
- }
23064
+ "privacy": "private"
23139
23065
  },
23140
23066
  {
23141
23067
  "kind": "field",
23142
- "name": "pollingInterval",
23068
+ "name": "_connectDI",
23143
23069
  "type": {
23144
- "text": "number"
23070
+ "text": "Connect"
23145
23071
  },
23146
- "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
23147
- "inheritedFrom": {
23148
- "name": "GenesisGridDatasourceElement",
23149
- "module": "src/datasource/base.datasource.ts"
23150
- }
23072
+ "privacy": "private"
23151
23073
  },
23152
23074
  {
23153
23075
  "kind": "field",
23154
- "name": "pollTriggerEvents",
23076
+ "name": "connect",
23155
23077
  "type": {
23156
- "text": "string[]"
23078
+ "text": "Connect"
23157
23079
  },
23158
- "default": "[]",
23159
- "description": "Array of event names that will trigger a poll when received as commit responses.",
23160
- "inheritedFrom": {
23161
- "name": "GenesisGridDatasourceElement",
23162
- "module": "src/datasource/base.datasource.ts"
23163
- }
23080
+ "description": "The connect service - uses DI by default, but can be manually set for dynamic element creation"
23164
23081
  },
23165
23082
  {
23166
23083
  "kind": "field",
23167
- "name": "request",
23084
+ "name": "disabled",
23168
23085
  "type": {
23169
- "text": "any"
23086
+ "text": "boolean"
23170
23087
  },
23171
- "description": "Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.",
23172
- "inheritedFrom": {
23173
- "name": "GenesisGridDatasourceElement",
23174
- "module": "src/datasource/base.datasource.ts"
23175
- }
23088
+ "privacy": "public",
23089
+ "description": "Whether to disable control of the component"
23176
23090
  },
23177
23091
  {
23178
23092
  "kind": "field",
23179
- "name": "requestAutoSetup",
23093
+ "name": "resourceName",
23180
23094
  "type": {
23181
- "text": "boolean"
23095
+ "text": "string"
23182
23096
  },
23183
- "default": "true",
23184
- "description": "Attribute to set whether the REQUEST object should be automatically set up.",
23185
- "inheritedFrom": {
23186
- "name": "GenesisGridDatasourceElement",
23187
- "module": "src/datasource/base.datasource.ts"
23188
- }
23097
+ "privacy": "public",
23098
+ "description": "The name of the reqrep to get the options from"
23189
23099
  },
23190
23100
  {
23191
23101
  "kind": "field",
23192
- "name": "rowIdAttr",
23193
- "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
23194
- "inheritedFrom": {
23195
- "name": "GenesisGridDatasourceElement",
23196
- "module": "src/datasource/base.datasource.ts"
23197
- }
23102
+ "name": "searchKey",
23103
+ "type": {
23104
+ "text": "string | string[] | undefined"
23105
+ },
23106
+ "privacy": "public",
23107
+ "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\")."
23198
23108
  },
23199
23109
  {
23200
23110
  "kind": "field",
23201
- "name": "restartOnReconnection",
23111
+ "name": "requestSupportsAdvancedSearch",
23202
23112
  "type": {
23203
23113
  "text": "boolean"
23204
23114
  },
23205
- "default": "true",
23206
- "description": "Attribute to set whether the datasource should restart when it reconnects.",
23207
- "inheritedFrom": {
23208
- "name": "GenesisGridDatasourceElement",
23209
- "module": "src/datasource/base.datasource.ts"
23210
- }
23115
+ "privacy": "public",
23116
+ "default": "false",
23117
+ "description": "Tells whether a given request supports lookup by Groovy Expressions."
23211
23118
  },
23212
23119
  {
23213
23120
  "kind": "field",
23214
- "name": "defaultRowIdByResourceType",
23121
+ "name": "valueKey",
23215
23122
  "type": {
23216
23123
  "text": "string"
23217
23124
  },
23218
- "privacy": "protected",
23219
- "readonly": true,
23220
- "inheritedFrom": {
23221
- "name": "GenesisGridDatasourceElement",
23222
- "module": "src/datasource/base.datasource.ts"
23223
- }
23125
+ "privacy": "public",
23126
+ "description": "The key used as the value sent to the server"
23224
23127
  },
23225
23128
  {
23226
23129
  "kind": "field",
23227
- "name": "criteriaFromFilters",
23130
+ "name": "labelKey",
23228
23131
  "type": {
23229
- "text": "Map<string, string>"
23132
+ "text": "string"
23230
23133
  },
23231
- "privacy": "protected",
23232
- "default": "new Map()",
23233
- "inheritedFrom": {
23234
- "name": "GenesisGridDatasourceElement",
23235
- "module": "src/datasource/base.datasource.ts"
23236
- }
23134
+ "privacy": "public",
23135
+ "description": "The key used as the label displayed in the UI"
23237
23136
  },
23238
23137
  {
23239
23138
  "kind": "field",
23240
- "name": "update",
23139
+ "name": "dropdownPlacement",
23241
23140
  "type": {
23242
- "text": "BehaviorSubject<Map<string, string>>"
23141
+ "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
23243
23142
  },
23244
- "privacy": "protected",
23245
- "default": "new BehaviorSubject(new Map())",
23246
- "inheritedFrom": {
23247
- "name": "GenesisGridDatasourceElement",
23248
- "module": "src/datasource/base.datasource.ts"
23249
- }
23143
+ "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"
23250
23144
  },
23251
23145
  {
23252
- "kind": "method",
23253
- "name": "datasourceOptions",
23254
- "privacy": "protected",
23255
- "return": {
23256
- "type": {
23257
- "text": "DatasourceOptions"
23258
- }
23146
+ "kind": "field",
23147
+ "name": "dropdownWidth",
23148
+ "type": {
23149
+ "text": "number"
23259
23150
  },
23260
- "inheritedFrom": {
23261
- "name": "GenesisGridDatasourceElement",
23262
- "module": "src/datasource/base.datasource.ts"
23263
- }
23151
+ "privacy": "public",
23152
+ "description": "Optionally specifies the width of the dropdown"
23264
23153
  },
23265
23154
  {
23266
23155
  "kind": "field",
23267
- "name": "isRequestServer",
23156
+ "name": "request",
23268
23157
  "type": {
23269
- "text": "boolean"
23158
+ "text": "object"
23270
23159
  },
23271
- "readonly": true,
23272
- "inheritedFrom": {
23273
- "name": "GenesisGridDatasourceElement",
23274
- "module": "src/datasource/base.datasource.ts"
23275
- }
23160
+ "privacy": "public",
23161
+ "description": "A request object to pass in the reqrep"
23276
23162
  },
23277
23163
  {
23278
- "kind": "method",
23279
- "name": "datasourceStatusChanged",
23280
- "parameters": [
23281
- {
23282
- "name": "prev",
23283
- "type": {
23284
- "text": "DatasourceStatus"
23285
- }
23286
- },
23287
- {
23288
- "name": "next",
23289
- "type": {
23290
- "text": "DatasourceStatus"
23291
- }
23292
- }
23293
- ],
23294
- "inheritedFrom": {
23295
- "name": "GenesisGridDatasourceElement",
23296
- "module": "src/datasource/base.datasource.ts"
23297
- }
23164
+ "kind": "field",
23165
+ "name": "columnDefinitions",
23166
+ "type": {
23167
+ "text": "ColDef[]"
23168
+ },
23169
+ "privacy": "public",
23170
+ "description": "An array of AG Grid column definitions to use in the grid to display the data"
23298
23171
  },
23299
23172
  {
23300
- "kind": "method",
23301
- "name": "handleErrors",
23302
- "parameters": [
23303
- {
23304
- "name": "errors",
23305
- "type": {
23306
- "text": "string | any[]"
23307
- },
23308
- "description": "The error message or array of error messages"
23309
- },
23310
- {
23311
- "name": "type",
23312
- "default": "'unknown'",
23313
- "type": {
23314
- "text": "BaseDatasourceErrorEventDetail['type']"
23315
- },
23316
- "description": "The type of error that occurred"
23317
- }
23318
- ],
23319
- "description": "Handles errors and emits appropriate error events.",
23173
+ "kind": "field",
23174
+ "name": "baseCriteria",
23175
+ "type": {
23176
+ "text": "string | undefined"
23177
+ },
23320
23178
  "privacy": "public",
23321
- "inheritedFrom": {
23322
- "name": "GenesisGridDatasourceElement",
23323
- "module": "src/datasource/base.datasource.ts"
23324
- }
23179
+ "description": "Base criteria that is always applied to requests combined with search criteria via AND.\nUse this to pre-filter results."
23325
23180
  },
23326
23181
  {
23327
- "kind": "method",
23328
- "name": "clearErrors",
23329
- "description": "Clears error state and emits connected event.",
23182
+ "kind": "field",
23183
+ "name": "defaultSlottedNodes",
23184
+ "type": {
23185
+ "text": "Node[]"
23186
+ },
23330
23187
  "privacy": "public",
23331
- "inheritedFrom": {
23332
- "name": "GenesisGridDatasourceElement",
23333
- "module": "src/datasource/base.datasource.ts"
23334
- }
23188
+ "default": "[]"
23335
23189
  },
23336
23190
  {
23337
23191
  "kind": "field",
23338
- "name": "_presentation",
23192
+ "name": "grid",
23339
23193
  "type": {
23340
- "text": "ComponentPresentation | null | undefined"
23194
+ "text": "GridPro | GridProLegacy"
23341
23195
  },
23342
- "privacy": "private",
23343
- "default": "void 0",
23344
- "inheritedFrom": {
23345
- "name": "FoundationElement",
23346
- "module": "src/foundation-element/foundation-element.ts"
23196
+ "privacy": "public"
23197
+ },
23198
+ {
23199
+ "kind": "field",
23200
+ "name": "_value",
23201
+ "type": {
23202
+ "text": "string"
23203
+ },
23204
+ "privacy": "private"
23205
+ },
23206
+ {
23207
+ "kind": "field",
23208
+ "name": "value",
23209
+ "type": {
23210
+ "text": "string"
23347
23211
  }
23348
23212
  },
23349
23213
  {
23350
23214
  "kind": "field",
23351
- "name": "$presentation",
23215
+ "name": "filterSearch",
23352
23216
  "type": {
23353
- "text": "ComponentPresentation | null"
23217
+ "text": "string"
23354
23218
  },
23355
23219
  "privacy": "public",
23356
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
23357
- "inheritedFrom": {
23358
- "name": "FoundationElement",
23359
- "module": "src/foundation-element/foundation-element.ts"
23360
- }
23220
+ "description": "The criteria to search by"
23361
23221
  },
23362
23222
  {
23363
23223
  "kind": "field",
23364
- "name": "template",
23224
+ "name": "open",
23365
23225
  "type": {
23366
- "text": "ElementViewTemplate | void | null"
23226
+ "text": "boolean"
23367
23227
  },
23368
23228
  "privacy": "public",
23369
- "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.",
23370
- "inheritedFrom": {
23371
- "name": "FoundationElement",
23372
- "module": "src/foundation-element/foundation-element.ts"
23373
- }
23229
+ "description": "Whether the dropdown is open or not"
23374
23230
  },
23375
23231
  {
23376
- "kind": "method",
23377
- "name": "templateChanged",
23378
- "privacy": "protected",
23379
- "return": {
23380
- "type": {
23381
- "text": "void"
23382
- }
23232
+ "kind": "field",
23233
+ "name": "selectedRow",
23234
+ "type": {
23235
+ "text": "object"
23383
23236
  },
23384
- "inheritedFrom": {
23385
- "name": "FoundationElement",
23386
- "module": "src/foundation-element/foundation-element.ts"
23387
- }
23237
+ "description": "Data for the selected row"
23388
23238
  },
23389
23239
  {
23390
23240
  "kind": "field",
23391
- "name": "styles",
23241
+ "name": "displayValue",
23242
+ "description": "Value to display in the form field",
23243
+ "readonly": true
23244
+ },
23245
+ {
23246
+ "kind": "field",
23247
+ "name": "hasSearchKey",
23392
23248
  "type": {
23393
- "text": "ElementStyles | void | null"
23249
+ "text": "boolean"
23394
23250
  },
23395
- "privacy": "public",
23396
- "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.",
23397
- "inheritedFrom": {
23398
- "name": "FoundationElement",
23399
- "module": "src/foundation-element/foundation-element.ts"
23400
- }
23251
+ "readonly": true
23401
23252
  },
23402
23253
  {
23403
- "kind": "method",
23404
- "name": "stylesChanged",
23405
- "privacy": "protected",
23406
- "return": {
23407
- "type": {
23408
- "text": "void"
23409
- }
23254
+ "kind": "field",
23255
+ "name": "hasSlottedContent",
23256
+ "type": {
23257
+ "text": "boolean"
23410
23258
  },
23411
- "inheritedFrom": {
23412
- "name": "FoundationElement",
23413
- "module": "src/foundation-element/foundation-element.ts"
23414
- }
23259
+ "readonly": true
23415
23260
  },
23416
23261
  {
23417
23262
  "kind": "method",
23418
- "name": "compose",
23419
- "privacy": "public",
23420
- "static": true,
23421
- "return": {
23422
- "type": {
23423
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
23424
- }
23425
- },
23263
+ "name": "setGridRowData",
23264
+ "privacy": "private",
23426
23265
  "parameters": [
23427
23266
  {
23428
- "name": "this",
23267
+ "name": "rows",
23429
23268
  "type": {
23430
- "text": "K"
23269
+ "text": "any[]"
23431
23270
  }
23432
- },
23433
- {
23434
- "name": "elementDefinition",
23435
- "type": {
23436
- "text": "T"
23437
- },
23438
- "description": "The definition of the element to create the registry\nfunction for."
23439
23271
  }
23440
23272
  ],
23441
- "description": "Defines an element registry function with a set of element definition defaults.",
23442
- "inheritedFrom": {
23443
- "name": "FoundationElement",
23444
- "module": "src/foundation-element/foundation-element.ts"
23445
- }
23446
- }
23447
- ],
23448
- "events": [
23449
- {
23450
- "description": "Fired when a datasource error is reported. detail: `BaseDatasourceErrorEventDetail`",
23451
- "name": "base-datasource-error",
23452
- "inheritedFrom": {
23453
- "name": "GenesisGridDatasourceElement",
23454
- "module": "src/datasource/base.datasource.ts"
23455
- }
23456
- },
23457
- {
23458
- "description": "Fired when a datasource error occurs (for grid integration). detail: `DatasourceErrorEventDetail`",
23459
- "name": "datasource-error",
23460
- "inheritedFrom": {
23461
- "name": "GenesisGridDatasourceElement",
23462
- "module": "src/datasource/base.datasource.ts"
23463
- }
23464
- },
23465
- {
23466
- "description": "Fired when error state is cleared after connection succeeds",
23467
- "name": "base-datasource-connected",
23468
- "inheritedFrom": {
23469
- "name": "GenesisGridDatasourceElement",
23470
- "module": "src/datasource/base.datasource.ts"
23471
- }
23472
- },
23473
- {
23474
- "description": "Fired when loading completes with no pending row changes",
23475
- "name": "datasource-loading-finished",
23476
- "inheritedFrom": {
23477
- "name": "GenesisGridDatasourceElement",
23478
- "module": "src/datasource/base.datasource.ts"
23479
- }
23480
- },
23481
- {
23482
- "description": "Fired when the grid has no rows after load",
23483
- "name": "datasource-no-data-available",
23484
- "inheritedFrom": {
23485
- "name": "GenesisGridDatasourceElement",
23486
- "module": "src/datasource/base.datasource.ts"
23487
- }
23273
+ "description": "Sets row data on the grid in a version-safe way.\nAG Grid v32+ removed `setRowData` in favour of `updateGridOptions`."
23488
23274
  },
23489
23275
  {
23490
- "description": "Fired when row data changes from stream updates. detail: `DataChangedEventDetail`",
23491
- "name": "datasource-data-changed",
23492
- "inheritedFrom": {
23493
- "name": "GenesisGridDatasourceElement",
23494
- "module": "src/datasource/base.datasource.ts"
23495
- }
23276
+ "kind": "method",
23277
+ "name": "setGridColumnDefs",
23278
+ "privacy": "private",
23279
+ "parameters": [
23280
+ {
23281
+ "name": "colDefs",
23282
+ "type": {
23283
+ "text": "ColDef[]"
23284
+ }
23285
+ }
23286
+ ],
23287
+ "description": "Sets column defs on the grid in a version-safe way.\nAG Grid v32+ removed `setColumnDefs` in favour of `updateGridOptions`."
23496
23288
  },
23497
23289
  {
23498
- "description": "Fired to hand off grid options and initialization flags. detail: `InitializeEventDetail`",
23499
- "name": "datasource-initialize"
23290
+ "kind": "method",
23291
+ "name": "emitValue",
23292
+ "privacy": "private",
23293
+ "parameters": [
23294
+ {
23295
+ "name": "value",
23296
+ "type": {
23297
+ "text": "string"
23298
+ }
23299
+ }
23300
+ ],
23301
+ "description": "Emits 'change' and 'input' events so that the `sync` directive and forms work correctly."
23500
23302
  },
23501
23303
  {
23502
- "description": "Fired when the datasource is torn down",
23503
- "name": "datasource-destroy"
23304
+ "kind": "method",
23305
+ "name": "toggle",
23306
+ "privacy": "public"
23504
23307
  },
23505
23308
  {
23506
- "description": "Fired when row data is cleared. detail: `DataClearedEventDetail`",
23507
- "name": "datasource-data-cleared"
23309
+ "kind": "method",
23310
+ "name": "getAndSetRows",
23311
+ "privacy": "private"
23508
23312
  },
23509
23313
  {
23510
- "description": "Fired when column metadata or defs are updated. detail: `SchemaUpdatedEventDetail`",
23511
- "name": "datasource-schema-updated"
23314
+ "kind": "field",
23315
+ "name": "getAndSetRowsDebounce",
23316
+ "privacy": "private"
23512
23317
  },
23513
23318
  {
23514
- "description": "Fired when persisted filters are reapplied",
23515
- "name": "datasource-filters-restored"
23319
+ "kind": "method",
23320
+ "name": "filterSearchChanged",
23321
+ "privacy": "public"
23516
23322
  },
23517
23323
  {
23518
- "description": "Fired when a data payload is loaded for the grid. detail: `DataLoadedEventDetail`",
23519
- "name": "datasource-data-loaded"
23324
+ "kind": "method",
23325
+ "name": "requestChanged",
23326
+ "privacy": "public"
23520
23327
  },
23521
23328
  {
23522
- "description": "Fired when a load or refresh starts",
23523
- "name": "datasource-loading-started"
23329
+ "kind": "method",
23330
+ "name": "columnDefinitionsChanged",
23331
+ "privacy": "public"
23524
23332
  },
23525
23333
  {
23526
- "description": "Fired when more server rows can be requested. detail: `MoreDataAvailableEventDetail`",
23527
- "name": "datasource-more-data-available"
23334
+ "kind": "field",
23335
+ "name": "handleClickOutside",
23336
+ "privacy": "private"
23528
23337
  },
23529
23338
  {
23530
- "description": "Fired when the host grid is ready to start loading data",
23531
- "name": "datasource-ready"
23339
+ "kind": "method",
23340
+ "name": "openChanged",
23341
+ "privacy": "public"
23532
23342
  },
23533
23343
  {
23534
- "description": "Fired when initial grid data is ready for the client-side model",
23535
- "name": "datasource-init"
23344
+ "kind": "method",
23345
+ "name": "dropdownWidthChanged",
23346
+ "privacy": "public"
23536
23347
  },
23537
23348
  {
23538
- "description": "Fired when MORE_ROWS availability changes. detail: `MoreRowsDetail`",
23539
- "name": "more-rows-changed"
23349
+ "kind": "method",
23350
+ "name": "changeHandler",
23351
+ "privacy": "public",
23352
+ "parameters": [
23353
+ {
23354
+ "name": "event",
23355
+ "type": {
23356
+ "text": "Event"
23357
+ }
23358
+ }
23359
+ ]
23540
23360
  },
23541
23361
  {
23542
- "description": "Fired when layout or viewport sizing affects the datasource. detail: `GrigProGenesisDatasourceSizeChangedEventDetail`",
23543
- "name": "datasource-size-changed"
23544
- }
23545
- ],
23546
- "attributes": [
23547
- {
23548
- "name": "keep-col-defs-on-clear-row-data",
23549
- "type": {
23550
- "text": "boolean"
23362
+ "kind": "method",
23363
+ "name": "cloneNode",
23364
+ "return": {
23365
+ "type": {
23366
+ "text": "Node"
23367
+ }
23551
23368
  },
23552
- "default": "false",
23553
- "fieldName": "keepColDefsOnClearRowData"
23369
+ "parameters": [
23370
+ {
23371
+ "name": "deep",
23372
+ "optional": true,
23373
+ "type": {
23374
+ "text": "boolean"
23375
+ }
23376
+ }
23377
+ ],
23378
+ "inheritedFrom": {
23379
+ "name": "LifecycleMixin",
23380
+ "module": "src/mixins/lifecycle/lifecycle.ts"
23381
+ }
23554
23382
  },
23555
23383
  {
23556
- "name": "request-visible-columns-only",
23557
- "type": {
23558
- "text": "boolean"
23384
+ "kind": "method",
23385
+ "name": "deepClone",
23386
+ "return": {
23387
+ "type": {
23388
+ "text": "Node"
23389
+ }
23559
23390
  },
23560
- "default": "false",
23561
- "description": "When enabled and column definitions are provided, the datasource requests data only for the\ncolumns that are currently visible. The visible set is seeded from the column config (columns\nnot flagged with `hide`) and updated by the host grid via `setVisibleColumns`; the data\nis reloaded whenever that set changes.",
23562
- "fieldName": "requestVisibleColumnsOnly"
23391
+ "inheritedFrom": {
23392
+ "name": "LifecycleMixin",
23393
+ "module": "src/mixins/lifecycle/lifecycle.ts"
23394
+ }
23563
23395
  },
23564
23396
  {
23565
- "name": "criteria",
23566
- "type": {
23567
- "text": "string"
23397
+ "kind": "field",
23398
+ "name": "shouldRunDisconnect",
23399
+ "return": {
23400
+ "type": {
23401
+ "text": ""
23402
+ }
23568
23403
  },
23569
- "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
23570
- "fieldName": "criteria",
23404
+ "readonly": true,
23571
23405
  "inheritedFrom": {
23572
- "name": "GenesisGridDatasourceElement",
23573
- "module": "src/datasource/base.datasource.ts"
23406
+ "name": "LifecycleMixin",
23407
+ "module": "src/mixins/lifecycle/lifecycle.ts"
23574
23408
  }
23575
23409
  },
23576
23410
  {
23577
- "name": "is-snapshot",
23578
- "type": {
23579
- "text": "boolean"
23411
+ "kind": "field",
23412
+ "name": "shouldRunConnect",
23413
+ "return": {
23414
+ "type": {
23415
+ "text": ""
23416
+ }
23580
23417
  },
23581
- "default": "false",
23582
- "description": "Request a snapshot from the server.",
23583
- "fieldName": "isSnapshot",
23418
+ "readonly": true,
23584
23419
  "inheritedFrom": {
23585
- "name": "GenesisGridDatasourceElement",
23586
- "module": "src/datasource/base.datasource.ts"
23420
+ "name": "LifecycleMixin",
23421
+ "module": "src/mixins/lifecycle/lifecycle.ts"
23587
23422
  }
23588
23423
  },
23589
23424
  {
23590
- "name": "max-rows",
23591
- "type": {
23592
- "text": "number"
23425
+ "kind": "method",
23426
+ "name": "#_blockLifecycleDueToTokenChange",
23427
+ "return": {
23428
+ "type": {
23429
+ "text": "boolean"
23430
+ }
23593
23431
  },
23594
- "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
23595
- "fieldName": "maxRows",
23432
+ "parameters": [
23433
+ {
23434
+ "name": "lifecycleType",
23435
+ "type": {
23436
+ "text": "Lifecycletype"
23437
+ }
23438
+ }
23439
+ ],
23596
23440
  "inheritedFrom": {
23597
- "name": "GenesisGridDatasourceElement",
23598
- "module": "src/datasource/base.datasource.ts"
23441
+ "name": "LifecycleMixin",
23442
+ "module": "src/mixins/lifecycle/lifecycle.ts"
23599
23443
  }
23600
23444
  },
23601
23445
  {
23602
- "name": "order-by",
23446
+ "kind": "field",
23447
+ "name": "_presentation",
23603
23448
  "type": {
23604
- "text": "string"
23449
+ "text": "ComponentPresentation | null | undefined"
23605
23450
  },
23606
- "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.",
23607
- "fieldName": "orderBy",
23451
+ "privacy": "private",
23452
+ "default": "void 0",
23608
23453
  "inheritedFrom": {
23609
- "name": "GenesisGridDatasourceElement",
23610
- "module": "src/datasource/base.datasource.ts"
23454
+ "name": "FoundationElement",
23455
+ "module": "src/foundation-element/foundation-element.ts"
23611
23456
  }
23612
23457
  },
23613
23458
  {
23614
- "name": "resource-name",
23459
+ "kind": "field",
23460
+ "name": "$presentation",
23615
23461
  "type": {
23616
- "text": "string"
23462
+ "text": "ComponentPresentation | null"
23617
23463
  },
23618
- "description": "The name of the target Data Server query or Request Server requestReply.",
23619
- "fieldName": "resourceName",
23464
+ "privacy": "public",
23465
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
23620
23466
  "inheritedFrom": {
23621
- "name": "GenesisGridDatasourceElement",
23622
- "module": "src/datasource/base.datasource.ts"
23467
+ "name": "FoundationElement",
23468
+ "module": "src/foundation-element/foundation-element.ts"
23623
23469
  }
23624
23470
  },
23625
23471
  {
23626
- "name": "view-number",
23472
+ "kind": "field",
23473
+ "name": "template",
23627
23474
  "type": {
23628
- "text": "number"
23475
+ "text": "ElementViewTemplate | void | null"
23629
23476
  },
23630
- "description": "The desired view/page you want data from.",
23631
- "fieldName": "viewNumber",
23477
+ "privacy": "public",
23478
+ "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.",
23632
23479
  "inheritedFrom": {
23633
- "name": "GenesisGridDatasourceElement",
23634
- "module": "src/datasource/base.datasource.ts"
23480
+ "name": "FoundationElement",
23481
+ "module": "src/foundation-element/foundation-element.ts"
23635
23482
  }
23636
23483
  },
23637
23484
  {
23638
- "name": "fields",
23639
- "type": {
23640
- "text": "string"
23485
+ "kind": "method",
23486
+ "name": "templateChanged",
23487
+ "privacy": "protected",
23488
+ "return": {
23489
+ "type": {
23490
+ "text": "void"
23491
+ }
23641
23492
  },
23642
- "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.",
23643
- "fieldName": "fields",
23644
23493
  "inheritedFrom": {
23645
- "name": "GenesisGridDatasourceElement",
23646
- "module": "src/datasource/base.datasource.ts"
23494
+ "name": "FoundationElement",
23495
+ "module": "src/foundation-element/foundation-element.ts"
23647
23496
  }
23648
23497
  },
23649
23498
  {
23650
- "name": "max-view",
23499
+ "kind": "field",
23500
+ "name": "styles",
23651
23501
  "type": {
23652
- "text": "number"
23502
+ "text": "ElementStyles | void | null"
23653
23503
  },
23654
- "description": "Maximum number of rows to track as part of a client \"view\".",
23655
- "fieldName": "maxView",
23504
+ "privacy": "public",
23505
+ "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.",
23656
23506
  "inheritedFrom": {
23657
- "name": "GenesisGridDatasourceElement",
23658
- "module": "src/datasource/base.datasource.ts"
23507
+ "name": "FoundationElement",
23508
+ "module": "src/foundation-element/foundation-element.ts"
23659
23509
  }
23660
23510
  },
23661
23511
  {
23662
- "name": "moving-view",
23663
- "type": {
23664
- "text": "boolean"
23512
+ "kind": "method",
23513
+ "name": "stylesChanged",
23514
+ "privacy": "protected",
23515
+ "return": {
23516
+ "type": {
23517
+ "text": "void"
23518
+ }
23665
23519
  },
23666
- "default": "false",
23667
- "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.",
23668
- "fieldName": "movingView",
23669
23520
  "inheritedFrom": {
23670
- "name": "GenesisGridDatasourceElement",
23671
- "module": "src/datasource/base.datasource.ts"
23521
+ "name": "FoundationElement",
23522
+ "module": "src/foundation-element/foundation-element.ts"
23672
23523
  }
23673
23524
  },
23674
23525
  {
23675
- "type": {
23676
- "text": "number"
23526
+ "kind": "method",
23527
+ "name": "compose",
23528
+ "privacy": "public",
23529
+ "static": true,
23530
+ "return": {
23531
+ "type": {
23532
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
23533
+ }
23677
23534
  },
23678
- "description": "Option that changes the Data Server index iteration.",
23679
- "fieldName": "reverse",
23680
- "default": "false",
23535
+ "parameters": [
23536
+ {
23537
+ "name": "this",
23538
+ "type": {
23539
+ "text": "K"
23540
+ }
23541
+ },
23542
+ {
23543
+ "name": "elementDefinition",
23544
+ "type": {
23545
+ "text": "T"
23546
+ },
23547
+ "description": "The definition of the element to create the registry\nfunction for."
23548
+ }
23549
+ ],
23550
+ "description": "Defines an element registry function with a set of element definition defaults.",
23681
23551
  "inheritedFrom": {
23682
- "name": "GenesisGridDatasourceElement",
23683
- "module": "src/datasource/base.datasource.ts"
23552
+ "name": "FoundationElement",
23553
+ "module": "src/foundation-element/foundation-element.ts"
23684
23554
  }
23555
+ }
23556
+ ],
23557
+ "events": [
23558
+ {
23559
+ "description": "Fired when the selected value changes. detail: `string`",
23560
+ "name": "change"
23685
23561
  },
23686
23562
  {
23687
- "name": "disable-polling",
23563
+ "description": "Fired when the value is updated (including programmatic changes). detail: `string`",
23564
+ "name": "input"
23565
+ }
23566
+ ],
23567
+ "attributes": [
23568
+ {
23688
23569
  "type": {
23689
23570
  "text": "boolean"
23690
23571
  },
23691
- "default": "false",
23692
- "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
23693
- "fieldName": "disablePolling",
23694
- "inheritedFrom": {
23695
- "name": "GenesisGridDatasourceElement",
23696
- "module": "src/datasource/base.datasource.ts"
23697
- }
23572
+ "description": "Whether to disable control of the component",
23573
+ "fieldName": "disabled"
23698
23574
  },
23699
23575
  {
23700
- "name": "polling-interval",
23576
+ "name": "resource-name",
23701
23577
  "type": {
23702
- "text": "number"
23578
+ "text": "string"
23703
23579
  },
23704
- "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
23705
- "fieldName": "pollingInterval",
23706
- "inheritedFrom": {
23707
- "name": "GenesisGridDatasourceElement",
23708
- "module": "src/datasource/base.datasource.ts"
23709
- }
23580
+ "description": "The name of the reqrep to get the options from",
23581
+ "fieldName": "resourceName"
23710
23582
  },
23711
23583
  {
23712
- "name": "request-auto-setup",
23584
+ "name": "search-key",
23585
+ "type": {
23586
+ "text": "string | string[] | undefined"
23587
+ },
23588
+ "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\").",
23589
+ "fieldName": "searchKey"
23590
+ },
23591
+ {
23592
+ "name": "advanced-search-req",
23713
23593
  "type": {
23714
23594
  "text": "boolean"
23715
23595
  },
23716
- "default": "true",
23717
- "description": "Attribute to set whether the REQUEST object should be automatically set up.",
23718
- "fieldName": "requestAutoSetup",
23719
- "inheritedFrom": {
23720
- "name": "GenesisGridDatasourceElement",
23721
- "module": "src/datasource/base.datasource.ts"
23722
- }
23596
+ "default": "false",
23597
+ "description": "Tells whether a given request supports lookup by Groovy Expressions.",
23598
+ "fieldName": "requestSupportsAdvancedSearch"
23723
23599
  },
23724
23600
  {
23725
- "name": "row-id",
23726
- "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
23727
- "fieldName": "rowIdAttr",
23728
- "inheritedFrom": {
23729
- "name": "GenesisGridDatasourceElement",
23730
- "module": "src/datasource/base.datasource.ts"
23731
- }
23601
+ "name": "value-key",
23602
+ "type": {
23603
+ "text": "string"
23604
+ },
23605
+ "description": "The key used as the value sent to the server",
23606
+ "fieldName": "valueKey"
23607
+ },
23608
+ {
23609
+ "name": "label-key",
23610
+ "type": {
23611
+ "text": "string"
23612
+ },
23613
+ "description": "The key used as the label displayed in the UI",
23614
+ "fieldName": "labelKey"
23732
23615
  },
23733
23616
  {
23734
- "name": "restart-on-reconnection",
23617
+ "name": "dropdown-placement",
23735
23618
  "type": {
23736
- "text": "boolean"
23619
+ "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
23737
23620
  },
23738
- "default": "true",
23739
- "description": "Attribute to set whether the datasource should restart when it reconnects.",
23740
- "fieldName": "restartOnReconnection",
23741
- "inheritedFrom": {
23742
- "name": "GenesisGridDatasourceElement",
23743
- "module": "src/datasource/base.datasource.ts"
23744
- }
23621
+ "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",
23622
+ "fieldName": "dropdownPlacement"
23623
+ },
23624
+ {
23625
+ "name": "dropdownWidth",
23626
+ "type": {
23627
+ "text": "number"
23628
+ },
23629
+ "description": "Optionally specifies the width of the dropdown",
23630
+ "fieldName": "dropdownWidth"
23745
23631
  }
23746
23632
  ],
23747
23633
  "mixins": [
@@ -23751,41 +23637,49 @@
23751
23637
  }
23752
23638
  ],
23753
23639
  "superclass": {
23754
- "name": "GridProBaseDatasource",
23755
- "module": "/src/datasource/base.datasource"
23640
+ "name": "FoundationElement",
23641
+ "package": "@microsoft/fast-foundation"
23756
23642
  },
23757
- "tagName": "grid-pro-genesis-datasource",
23643
+ "tagName": "%%prefix%%-multicolumn-dropdown",
23758
23644
  "customElement": true
23645
+ },
23646
+ {
23647
+ "kind": "variable",
23648
+ "name": "foundationMulticolumnDropdown",
23649
+ "description": "A function that returns a Multicolumn Dropdown registration for configuring the component with a DesignSystem.",
23650
+ "privacy": "public"
23759
23651
  }
23760
23652
  ],
23761
23653
  "exports": [
23762
23654
  {
23763
23655
  "kind": "js",
23764
- "name": "GridProGenesisDatasource",
23656
+ "name": "wasClickOutsideElement",
23765
23657
  "declaration": {
23766
- "name": "GridProGenesisDatasource",
23767
- "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
23658
+ "name": "wasClickOutsideElement",
23659
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
23768
23660
  }
23769
23661
  },
23770
23662
  {
23771
- "kind": "custom-element-definition",
23772
- "name": "grid-pro-genesis-datasource",
23663
+ "kind": "js",
23664
+ "name": "MulticolumnDropdown",
23773
23665
  "declaration": {
23774
- "name": "GridProGenesisDatasource",
23775
- "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
23666
+ "name": "MulticolumnDropdown",
23667
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
23668
+ }
23669
+ },
23670
+ {
23671
+ "kind": "js",
23672
+ "name": "foundationMulticolumnDropdown",
23673
+ "declaration": {
23674
+ "name": "foundationMulticolumnDropdown",
23675
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
23776
23676
  }
23777
23677
  }
23778
23678
  ]
23779
23679
  },
23780
23680
  {
23781
23681
  "kind": "javascript-module",
23782
- "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
23783
- "declarations": [],
23784
- "exports": []
23785
- },
23786
- {
23787
- "kind": "javascript-module",
23788
- "path": "src/grid-pro-genesis-datasource/index.ts",
23682
+ "path": "src/row-alert/index.ts",
23789
23683
  "declarations": [],
23790
23684
  "exports": [
23791
23685
  {
@@ -23793,7 +23687,7 @@
23793
23687
  "name": "*",
23794
23688
  "declaration": {
23795
23689
  "name": "*",
23796
- "package": "./datasource-events.types"
23690
+ "package": "./row-alert"
23797
23691
  }
23798
23692
  },
23799
23693
  {
@@ -23801,23 +23695,129 @@
23801
23695
  "name": "*",
23802
23696
  "declaration": {
23803
23697
  "name": "*",
23804
- "package": "./grid-pro-genesis-datasource"
23698
+ "package": "./row-alert.types"
23699
+ }
23700
+ }
23701
+ ]
23702
+ },
23703
+ {
23704
+ "kind": "javascript-module",
23705
+ "path": "src/row-alert/row-alert.ts",
23706
+ "declarations": [
23707
+ {
23708
+ "kind": "function",
23709
+ "name": "createRowAlert",
23710
+ "return": {
23711
+ "type": {
23712
+ "text": "RowAlert"
23713
+ }
23714
+ },
23715
+ "parameters": [
23716
+ {
23717
+ "name": "criteria",
23718
+ "type": {
23719
+ "text": "RowMatchCriteria"
23720
+ }
23721
+ },
23722
+ {
23723
+ "name": "options",
23724
+ "default": "{}",
23725
+ "type": {
23726
+ "text": "RowAlertOptions"
23727
+ }
23728
+ }
23729
+ ],
23730
+ "description": "Builds the class rules that flash rows matching `criteria`, together with the context menu\nthat lets a user recolor, retime, or narrow that flash to a single cell.\n\nThe rules are created once and never replaced, because a grid backed by a Genesis datasource\nkeeps the options it was created with — handing it new rules later would change nothing. Each\nrule instead asks, as it runs, whether its scope is the one currently selected, so switching\ntarget only needs the rows redrawn.\n\n```ts\nconst alert = createRowAlert(criteria, { persistPreferencesKey: 'orders.row-alert' });\ngridOptions = {\n rowClassRules: alert.rowClassRules,\n defaultColDef: alert.defaultColDef,\n getContextMenuItems: alert.getContextMenuItems,\n};\n```\n\nAlerts sharing a `persistPreferencesKey` share their preferences, so a page of grids that each\nwatch for something different still answers to one setting.\n\nPairs with DatasourceRowMatchTracker: give both the same criteria and a tab can say\nthere is work to do while the grid shows which rows it meant.",
23731
+ "privacy": "public"
23732
+ }
23733
+ ],
23734
+ "exports": [
23735
+ {
23736
+ "kind": "js",
23737
+ "name": "createRowAlert",
23738
+ "declaration": {
23739
+ "name": "createRowAlert",
23740
+ "module": "src/row-alert/row-alert.ts"
23741
+ }
23742
+ }
23743
+ ]
23744
+ },
23745
+ {
23746
+ "kind": "javascript-module",
23747
+ "path": "src/row-alert/row-alert.types.ts",
23748
+ "declarations": [
23749
+ {
23750
+ "kind": "variable",
23751
+ "name": "defaultRowAlertColorPresets",
23752
+ "type": {
23753
+ "text": "[\n { id: 'error', label: 'Error', value: 'var(--error-fill-rest, #c62828)' },\n { id: 'warning', label: 'Warning', value: 'var(--warning-fill-rest, #ef6c00)' },\n { id: 'success', label: 'Success', value: 'var(--success-fill-rest, #2e7d32)' },\n { id: 'accent', label: 'Accent', value: 'var(--accent-fill-rest, #1565c0)' },\n { id: 'neutral', label: 'Neutral', value: 'var(--neutral-fill-rest, #546e7a)' },\n]"
23754
+ },
23755
+ "default": "[\n { id: 'error', label: 'Error', value: 'var(--error-fill-rest, #c62828)' },\n { id: 'warning', label: 'Warning', value: 'var(--warning-fill-rest, #ef6c00)' },\n { id: 'success', label: 'Success', value: 'var(--success-fill-rest, #2e7d32)' },\n { id: 'accent', label: 'Accent', value: 'var(--accent-fill-rest, #1565c0)' },\n { id: 'neutral', label: 'Neutral', value: 'var(--neutral-fill-rest, #546e7a)' },\n]",
23756
+ "description": "Colors offered by default. Each resolves a design token so the menu follows the host\napplication's theme, falling back to a fixed color for design systems that lack the token.",
23757
+ "privacy": "public"
23758
+ },
23759
+ {
23760
+ "kind": "variable",
23761
+ "name": "defaultRowAlertRatePresets",
23762
+ "type": {
23763
+ "text": "[\n { id: 'slow', label: 'Slow', value: 1400 },\n { id: 'normal', label: 'Normal', value: 1000 },\n { id: 'fast', label: 'Fast', value: 500 },\n]"
23764
+ },
23765
+ "default": "[\n { id: 'slow', label: 'Slow', value: 1400 },\n { id: 'normal', label: 'Normal', value: 1000 },\n { id: 'fast', label: 'Fast', value: 500 },\n]",
23766
+ "description": "Flash rates offered by default.",
23767
+ "privacy": "public"
23768
+ },
23769
+ {
23770
+ "kind": "variable",
23771
+ "name": "defaultRowAlertScopePresets",
23772
+ "type": {
23773
+ "text": "[\n { id: 'row', label: 'Whole row', value: 'row' },\n { id: 'cell', label: 'Alert field cell', value: 'cell' },\n]"
23774
+ },
23775
+ "default": "[\n { id: 'row', label: 'Whole row', value: 'row' },\n { id: 'cell', label: 'Alert field cell', value: 'cell' },\n]",
23776
+ "description": "Flash targets offered by default. Cell scope only has an effect when the criteria name a\n`flashField`.",
23777
+ "privacy": "public"
23778
+ },
23779
+ {
23780
+ "kind": "variable",
23781
+ "name": "defaultRowAlertPreferences",
23782
+ "type": {
23783
+ "text": "RowAlertPreferences"
23784
+ },
23785
+ "default": "{\n color: defaultRowAlertColorPresets[0].value,\n durationMs: defaultRowAlertRatePresets[1].value,\n scope: 'row',\n}",
23786
+ "description": "Where preferences start before a user changes anything.",
23787
+ "privacy": "public"
23788
+ }
23789
+ ],
23790
+ "exports": [
23791
+ {
23792
+ "kind": "js",
23793
+ "name": "defaultRowAlertColorPresets",
23794
+ "declaration": {
23795
+ "name": "defaultRowAlertColorPresets",
23796
+ "module": "src/row-alert/row-alert.types.ts"
23805
23797
  }
23806
23798
  },
23807
23799
  {
23808
23800
  "kind": "js",
23809
- "name": "*",
23801
+ "name": "defaultRowAlertRatePresets",
23810
23802
  "declaration": {
23811
- "name": "*",
23812
- "package": "./grid-pro-genesis-datasource.config"
23803
+ "name": "defaultRowAlertRatePresets",
23804
+ "module": "src/row-alert/row-alert.types.ts"
23813
23805
  }
23814
23806
  },
23815
23807
  {
23816
23808
  "kind": "js",
23817
- "name": "*",
23809
+ "name": "defaultRowAlertScopePresets",
23818
23810
  "declaration": {
23819
- "name": "*",
23820
- "package": "./grid-pro-genesis-datasource.types"
23811
+ "name": "defaultRowAlertScopePresets",
23812
+ "module": "src/row-alert/row-alert.types.ts"
23813
+ }
23814
+ },
23815
+ {
23816
+ "kind": "js",
23817
+ "name": "defaultRowAlertPreferences",
23818
+ "declaration": {
23819
+ "name": "defaultRowAlertPreferences",
23820
+ "module": "src/row-alert/row-alert.types.ts"
23821
23821
  }
23822
23822
  }
23823
23823
  ]
@@ -24218,41 +24218,6 @@
24218
24218
  "declarations": [],
24219
24219
  "exports": []
24220
24220
  },
24221
- {
24222
- "kind": "javascript-module",
24223
- "path": "src/style/colors.ts",
24224
- "declarations": [],
24225
- "exports": []
24226
- },
24227
- {
24228
- "kind": "javascript-module",
24229
- "path": "src/style/index.ts",
24230
- "declarations": [],
24231
- "exports": [
24232
- {
24233
- "kind": "js",
24234
- "name": "*",
24235
- "declaration": {
24236
- "name": "*",
24237
- "package": "./colors"
24238
- }
24239
- },
24240
- {
24241
- "kind": "js",
24242
- "name": "*",
24243
- "declaration": {
24244
- "name": "*",
24245
- "package": "./tokens"
24246
- }
24247
- }
24248
- ]
24249
- },
24250
- {
24251
- "kind": "javascript-module",
24252
- "path": "src/style/tokens.ts",
24253
- "declarations": [],
24254
- "exports": []
24255
- },
24256
24221
  {
24257
24222
  "kind": "javascript-module",
24258
24223
  "path": "src/status-bar-components/index.ts",
@@ -24824,6 +24789,41 @@
24824
24789
  }
24825
24790
  ]
24826
24791
  },
24792
+ {
24793
+ "kind": "javascript-module",
24794
+ "path": "src/style/colors.ts",
24795
+ "declarations": [],
24796
+ "exports": []
24797
+ },
24798
+ {
24799
+ "kind": "javascript-module",
24800
+ "path": "src/style/index.ts",
24801
+ "declarations": [],
24802
+ "exports": [
24803
+ {
24804
+ "kind": "js",
24805
+ "name": "*",
24806
+ "declaration": {
24807
+ "name": "*",
24808
+ "package": "./colors"
24809
+ }
24810
+ },
24811
+ {
24812
+ "kind": "js",
24813
+ "name": "*",
24814
+ "declaration": {
24815
+ "name": "*",
24816
+ "package": "./tokens"
24817
+ }
24818
+ }
24819
+ ]
24820
+ },
24821
+ {
24822
+ "kind": "javascript-module",
24823
+ "path": "src/style/tokens.ts",
24824
+ "declarations": [],
24825
+ "exports": []
24826
+ },
24827
24827
  {
24828
24828
  "kind": "javascript-module",
24829
24829
  "path": "src/tooltips/error-tooltip.ts",