@genesislcap/grid-pro 14.353.3 → 14.353.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/custom-elements.json +1643 -1643
  2. package/package.json +13 -13
@@ -7241,308 +7241,621 @@
7241
7241
  },
7242
7242
  {
7243
7243
  "kind": "javascript-module",
7244
- "path": "src/datasource/base.datasource.ts",
7244
+ "path": "src/column/column.template.ts",
7245
7245
  "declarations": [
7246
7246
  {
7247
7247
  "kind": "variable",
7248
- "name": "criteriaDelimiter",
7249
- "type": {
7250
- "text": "string"
7251
- },
7252
- "default": "';'",
7253
- "description": "The delimiter for the criteria string.",
7248
+ "name": "ColumnTemplate",
7249
+ "default": "html<GridProColumn>`\n <template>\n <slot ${slotted('slottedAgCell')} @slotchange=\"${(x) => x.slottedAgCellChanged()}\"></slot>\n </template>\n`",
7250
+ "description": "The Grid Pro Column Template.",
7254
7251
  "privacy": "public"
7255
- },
7252
+ }
7253
+ ],
7254
+ "exports": [
7256
7255
  {
7257
- "kind": "variable",
7258
- "name": "criteriaJoin",
7259
- "type": {
7260
- "text": "string"
7261
- },
7262
- "default": "' && '",
7263
- "description": "The join for the criteria string.",
7264
- "privacy": "public"
7265
- },
7256
+ "kind": "js",
7257
+ "name": "ColumnTemplate",
7258
+ "declaration": {
7259
+ "name": "ColumnTemplate",
7260
+ "module": "src/column/column.template.ts"
7261
+ }
7262
+ }
7263
+ ]
7264
+ },
7265
+ {
7266
+ "kind": "javascript-module",
7267
+ "path": "src/column/column.ts",
7268
+ "declarations": [
7266
7269
  {
7267
7270
  "kind": "class",
7268
- "description": "The base datasource element for the grid-pro element.",
7269
- "name": "GenesisGridDatasourceElement",
7271
+ "description": "The Grid Pro Column element.",
7272
+ "name": "GridProColumn",
7270
7273
  "members": [
7271
7274
  {
7272
7275
  "kind": "field",
7273
- "name": "connect",
7274
- "type": {
7275
- "text": "Connect"
7276
- }
7277
- },
7278
- {
7279
- "kind": "field",
7280
- "name": "datasource",
7281
- "type": {
7282
- "text": "Datasource"
7283
- }
7284
- },
7285
- {
7286
- "kind": "field",
7287
- "name": "deferredGridOptions",
7288
- "type": {
7289
- "text": "GridOptions"
7290
- }
7291
- },
7292
- {
7293
- "kind": "field",
7294
- "name": "deferredColumnStates",
7276
+ "name": "slottedAgCell",
7295
7277
  "type": {
7296
- "text": "ColumnState[]"
7297
- }
7278
+ "text": "HTMLElement[]"
7279
+ },
7280
+ "privacy": "public"
7298
7281
  },
7299
7282
  {
7300
7283
  "kind": "field",
7301
- "name": "rowDataMapper",
7284
+ "name": "definition",
7302
7285
  "type": {
7303
- "text": "Function"
7286
+ "text": "ColDef"
7304
7287
  },
7305
- "description": "Allows grid data updates to be processed via and external function before applying in grid"
7288
+ "default": "{}"
7306
7289
  },
7307
7290
  {
7308
- "kind": "field",
7309
- "name": "criteria",
7310
- "type": {
7311
- "text": "string"
7312
- },
7313
- "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription."
7291
+ "kind": "method",
7292
+ "name": "slottedAgCellChanged",
7293
+ "privacy": "public"
7314
7294
  },
7315
7295
  {
7316
- "kind": "field",
7317
- "name": "isSnapshot",
7318
- "type": {
7319
- "text": "boolean"
7296
+ "kind": "method",
7297
+ "name": "deepClone",
7298
+ "return": {
7299
+ "type": {
7300
+ "text": "Node"
7301
+ }
7320
7302
  },
7321
- "default": "false",
7322
- "description": "Request a snapshot from the server."
7303
+ "inheritedFrom": {
7304
+ "name": "LifecycleMixin",
7305
+ "module": "src/mixins/lifecycle/lifecycle.ts"
7306
+ }
7323
7307
  },
7324
7308
  {
7325
- "kind": "field",
7326
- "name": "maxRows",
7327
- "type": {
7328
- "text": "number"
7309
+ "kind": "method",
7310
+ "name": "cloneNode",
7311
+ "return": {
7312
+ "type": {
7313
+ "text": "Node"
7314
+ }
7329
7315
  },
7330
- "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages."
7316
+ "parameters": [
7317
+ {
7318
+ "name": "deep",
7319
+ "optional": true,
7320
+ "type": {
7321
+ "text": "boolean"
7322
+ }
7323
+ }
7324
+ ],
7325
+ "inheritedFrom": {
7326
+ "name": "LifecycleMixin",
7327
+ "module": "src/mixins/lifecycle/lifecycle.ts"
7328
+ }
7331
7329
  },
7332
7330
  {
7333
7331
  "kind": "field",
7334
- "name": "orderBy",
7335
- "type": {
7336
- "text": "string"
7332
+ "name": "shouldRunDisconnect",
7333
+ "return": {
7334
+ "type": {
7335
+ "text": ""
7336
+ }
7337
7337
  },
7338
- "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."
7338
+ "readonly": true,
7339
+ "inheritedFrom": {
7340
+ "name": "LifecycleMixin",
7341
+ "module": "src/mixins/lifecycle/lifecycle.ts"
7342
+ }
7339
7343
  },
7340
7344
  {
7341
7345
  "kind": "field",
7342
- "name": "resourceName",
7343
- "type": {
7344
- "text": "string"
7346
+ "name": "shouldRunConnect",
7347
+ "return": {
7348
+ "type": {
7349
+ "text": ""
7350
+ }
7345
7351
  },
7346
- "description": "The name of the target Data Server query or Request Server requestReply."
7352
+ "readonly": true,
7353
+ "inheritedFrom": {
7354
+ "name": "LifecycleMixin",
7355
+ "module": "src/mixins/lifecycle/lifecycle.ts"
7356
+ }
7347
7357
  },
7348
7358
  {
7349
- "kind": "field",
7350
- "name": "viewNumber",
7351
- "type": {
7352
- "text": "number"
7359
+ "kind": "method",
7360
+ "name": "#_blockLifecycleDueToTokenChange",
7361
+ "return": {
7362
+ "type": {
7363
+ "text": "boolean"
7364
+ }
7353
7365
  },
7354
- "description": "The desired view/page you want data from."
7366
+ "parameters": [
7367
+ {
7368
+ "name": "lifecycleType",
7369
+ "type": {
7370
+ "text": "Lifecycletype"
7371
+ }
7372
+ }
7373
+ ],
7374
+ "inheritedFrom": {
7375
+ "name": "LifecycleMixin",
7376
+ "module": "src/mixins/lifecycle/lifecycle.ts"
7377
+ }
7355
7378
  },
7356
7379
  {
7357
7380
  "kind": "field",
7358
- "name": "fields",
7381
+ "name": "_presentation",
7359
7382
  "type": {
7360
- "text": "string"
7383
+ "text": "ComponentPresentation | null | undefined"
7361
7384
  },
7362
- "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."
7385
+ "privacy": "private",
7386
+ "default": "void 0",
7387
+ "inheritedFrom": {
7388
+ "name": "FoundationElement",
7389
+ "module": "src/foundation-element/foundation-element.ts"
7390
+ }
7363
7391
  },
7364
7392
  {
7365
7393
  "kind": "field",
7366
- "name": "maxView",
7394
+ "name": "$presentation",
7367
7395
  "type": {
7368
- "text": "number"
7396
+ "text": "ComponentPresentation | null"
7369
7397
  },
7370
- "description": "Maximum number of rows to track as part of a client \"view\"."
7398
+ "privacy": "public",
7399
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
7400
+ "inheritedFrom": {
7401
+ "name": "FoundationElement",
7402
+ "module": "src/foundation-element/foundation-element.ts"
7403
+ }
7371
7404
  },
7372
7405
  {
7373
7406
  "kind": "field",
7374
- "name": "movingView",
7407
+ "name": "template",
7375
7408
  "type": {
7376
- "text": "boolean"
7409
+ "text": "ElementViewTemplate | void | null"
7377
7410
  },
7378
- "default": "false",
7379
- "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."
7411
+ "privacy": "public",
7412
+ "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.",
7413
+ "inheritedFrom": {
7414
+ "name": "FoundationElement",
7415
+ "module": "src/foundation-element/foundation-element.ts"
7416
+ }
7380
7417
  },
7381
7418
  {
7382
- "kind": "field",
7383
- "name": "reverse",
7384
- "type": {
7385
- "text": "boolean"
7419
+ "kind": "method",
7420
+ "name": "templateChanged",
7421
+ "privacy": "protected",
7422
+ "return": {
7423
+ "type": {
7424
+ "text": "void"
7425
+ }
7386
7426
  },
7387
- "default": "false",
7388
- "description": "Option that changes the Data Server index iteration."
7427
+ "inheritedFrom": {
7428
+ "name": "FoundationElement",
7429
+ "module": "src/foundation-element/foundation-element.ts"
7430
+ }
7389
7431
  },
7390
7432
  {
7391
7433
  "kind": "field",
7392
- "name": "disablePolling",
7434
+ "name": "styles",
7393
7435
  "type": {
7394
- "text": "boolean"
7436
+ "text": "ElementStyles | void | null"
7395
7437
  },
7396
- "default": "false",
7397
- "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically)."
7438
+ "privacy": "public",
7439
+ "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.",
7440
+ "inheritedFrom": {
7441
+ "name": "FoundationElement",
7442
+ "module": "src/foundation-element/foundation-element.ts"
7443
+ }
7398
7444
  },
7399
7445
  {
7400
- "kind": "field",
7401
- "name": "offset",
7402
- "type": {
7403
- "text": "number"
7446
+ "kind": "method",
7447
+ "name": "stylesChanged",
7448
+ "privacy": "protected",
7449
+ "return": {
7450
+ "type": {
7451
+ "text": "void"
7452
+ }
7404
7453
  },
7405
- "description": "The offset for pagination in REQUEST_SERVER scenarios."
7454
+ "inheritedFrom": {
7455
+ "name": "FoundationElement",
7456
+ "module": "src/foundation-element/foundation-element.ts"
7457
+ }
7406
7458
  },
7407
7459
  {
7408
- "kind": "field",
7409
- "name": "pollingInterval",
7410
- "type": {
7411
- "text": "number"
7460
+ "kind": "method",
7461
+ "name": "compose",
7462
+ "privacy": "public",
7463
+ "static": true,
7464
+ "return": {
7465
+ "type": {
7466
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
7467
+ }
7412
7468
  },
7413
- "description": "Custom polling frequency (in milliseconds) for a Request Server resource."
7414
- },
7469
+ "parameters": [
7470
+ {
7471
+ "name": "this",
7472
+ "type": {
7473
+ "text": "K"
7474
+ }
7475
+ },
7476
+ {
7477
+ "name": "elementDefinition",
7478
+ "type": {
7479
+ "text": "T"
7480
+ },
7481
+ "description": "The definition of the element to create the registry\nfunction for."
7482
+ }
7483
+ ],
7484
+ "description": "Defines an element registry function with a set of element definition defaults.",
7485
+ "inheritedFrom": {
7486
+ "name": "FoundationElement",
7487
+ "module": "src/foundation-element/foundation-element.ts"
7488
+ }
7489
+ }
7490
+ ],
7491
+ "mixins": [
7492
+ {
7493
+ "name": "LifecycleMixin",
7494
+ "package": "@genesislcap/foundation-utils"
7495
+ }
7496
+ ],
7497
+ "superclass": {
7498
+ "name": "FoundationElement",
7499
+ "package": "@microsoft/fast-foundation"
7500
+ },
7501
+ "tagName": "grid-pro-column",
7502
+ "customElement": true
7503
+ }
7504
+ ],
7505
+ "exports": [
7506
+ {
7507
+ "kind": "js",
7508
+ "name": "GridProColumn",
7509
+ "declaration": {
7510
+ "name": "GridProColumn",
7511
+ "module": "src/column/column.ts"
7512
+ }
7513
+ },
7514
+ {
7515
+ "kind": "custom-element-definition",
7516
+ "name": "grid-pro-column",
7517
+ "declaration": {
7518
+ "name": "GridProColumn",
7519
+ "module": "src/column/column.ts"
7520
+ }
7521
+ }
7522
+ ]
7523
+ },
7524
+ {
7525
+ "kind": "javascript-module",
7526
+ "path": "src/column/index.ts",
7527
+ "declarations": [],
7528
+ "exports": [
7529
+ {
7530
+ "kind": "js",
7531
+ "name": "*",
7532
+ "declaration": {
7533
+ "name": "*",
7534
+ "package": "./column.template"
7535
+ }
7536
+ },
7537
+ {
7538
+ "kind": "js",
7539
+ "name": "*",
7540
+ "declaration": {
7541
+ "name": "*",
7542
+ "package": "./column"
7543
+ }
7544
+ },
7545
+ {
7546
+ "kind": "js",
7547
+ "name": "*",
7548
+ "declaration": {
7549
+ "name": "*",
7550
+ "package": "./utils"
7551
+ }
7552
+ }
7553
+ ]
7554
+ },
7555
+ {
7556
+ "kind": "javascript-module",
7557
+ "path": "src/datasource/base.datasource.ts",
7558
+ "declarations": [
7559
+ {
7560
+ "kind": "variable",
7561
+ "name": "criteriaDelimiter",
7562
+ "type": {
7563
+ "text": "string"
7564
+ },
7565
+ "default": "';'",
7566
+ "description": "The delimiter for the criteria string.",
7567
+ "privacy": "public"
7568
+ },
7569
+ {
7570
+ "kind": "variable",
7571
+ "name": "criteriaJoin",
7572
+ "type": {
7573
+ "text": "string"
7574
+ },
7575
+ "default": "' && '",
7576
+ "description": "The join for the criteria string.",
7577
+ "privacy": "public"
7578
+ },
7579
+ {
7580
+ "kind": "class",
7581
+ "description": "The base datasource element for the grid-pro element.",
7582
+ "name": "GenesisGridDatasourceElement",
7583
+ "members": [
7415
7584
  {
7416
7585
  "kind": "field",
7417
- "name": "pollTriggerEvents",
7586
+ "name": "connect",
7418
7587
  "type": {
7419
- "text": "string[]"
7420
- },
7421
- "default": "[]",
7422
- "description": "Array of event names that will trigger a poll when received as commit responses."
7588
+ "text": "Connect"
7589
+ }
7423
7590
  },
7424
7591
  {
7425
7592
  "kind": "field",
7426
- "name": "request",
7593
+ "name": "datasource",
7427
7594
  "type": {
7428
- "text": "any"
7429
- },
7430
- "description": "Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards."
7595
+ "text": "Datasource"
7596
+ }
7431
7597
  },
7432
7598
  {
7433
7599
  "kind": "field",
7434
- "name": "requestAutoSetup",
7600
+ "name": "deferredGridOptions",
7435
7601
  "type": {
7436
- "text": "boolean"
7437
- },
7438
- "default": "true",
7439
- "description": "Attribute to set whether the REQUEST object should be automatically set up."
7602
+ "text": "GridOptions"
7603
+ }
7440
7604
  },
7441
7605
  {
7442
7606
  "kind": "field",
7443
- "name": "rowIdAttr",
7444
- "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type."
7607
+ "name": "deferredColumnStates",
7608
+ "type": {
7609
+ "text": "ColumnState[]"
7610
+ }
7445
7611
  },
7446
7612
  {
7447
7613
  "kind": "field",
7448
- "name": "restartOnReconnection",
7614
+ "name": "rowDataMapper",
7449
7615
  "type": {
7450
- "text": "boolean"
7616
+ "text": "Function"
7451
7617
  },
7452
- "default": "true",
7453
- "description": "Attribute to set whether the datasource should restart when it reconnects."
7618
+ "description": "Allows grid data updates to be processed via and external function before applying in grid"
7454
7619
  },
7455
7620
  {
7456
7621
  "kind": "field",
7457
- "name": "defaultRowIdByResourceType",
7622
+ "name": "criteria",
7458
7623
  "type": {
7459
7624
  "text": "string"
7460
7625
  },
7461
- "privacy": "protected",
7462
- "readonly": true
7626
+ "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription."
7463
7627
  },
7464
7628
  {
7465
7629
  "kind": "field",
7466
- "name": "criteriaFromFilters",
7630
+ "name": "isSnapshot",
7467
7631
  "type": {
7468
- "text": "Map<string, string>"
7632
+ "text": "boolean"
7469
7633
  },
7470
- "privacy": "protected",
7471
- "default": "new Map()"
7634
+ "default": "false",
7635
+ "description": "Request a snapshot from the server."
7472
7636
  },
7473
7637
  {
7474
7638
  "kind": "field",
7475
- "name": "update",
7639
+ "name": "maxRows",
7476
7640
  "type": {
7477
- "text": "BehaviorSubject<Map<string, string>>"
7641
+ "text": "number"
7478
7642
  },
7479
- "privacy": "protected",
7480
- "default": "new BehaviorSubject(new Map())"
7481
- },
7482
- {
7483
- "kind": "method",
7484
- "name": "datasourceOptions",
7485
- "privacy": "protected",
7486
- "return": {
7487
- "type": {
7488
- "text": "DatasourceOptions"
7489
- }
7490
- }
7643
+ "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages."
7491
7644
  },
7492
7645
  {
7493
- "kind": "method",
7494
- "name": "buildCriteria",
7495
- "privacy": "private",
7496
- "return": {
7497
- "type": {
7498
- "text": "string"
7499
- }
7500
- }
7646
+ "kind": "field",
7647
+ "name": "orderBy",
7648
+ "type": {
7649
+ "text": "string"
7650
+ },
7651
+ "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."
7501
7652
  },
7502
7653
  {
7503
- "kind": "method",
7504
- "name": "setFilter",
7505
- "privacy": "public",
7506
- "parameters": [
7507
- {
7508
- "name": "fieldName",
7509
- "type": {
7510
- "text": "string"
7511
- }
7512
- },
7513
- {
7514
- "name": "newFilter",
7515
- "type": {
7516
- "text": "string"
7517
- }
7518
- }
7519
- ]
7654
+ "kind": "field",
7655
+ "name": "resourceName",
7656
+ "type": {
7657
+ "text": "string"
7658
+ },
7659
+ "description": "The name of the target Data Server query or Request Server requestReply."
7520
7660
  },
7521
7661
  {
7522
- "kind": "method",
7523
- "name": "removeFilter",
7524
- "privacy": "public",
7525
- "parameters": [
7526
- {
7527
- "name": "fieldName",
7528
- "type": {
7529
- "text": "string"
7530
- }
7531
- }
7532
- ]
7662
+ "kind": "field",
7663
+ "name": "viewNumber",
7664
+ "type": {
7665
+ "text": "number"
7666
+ },
7667
+ "description": "The desired view/page you want data from."
7533
7668
  },
7534
7669
  {
7535
7670
  "kind": "field",
7536
- "name": "isRequestServer",
7671
+ "name": "fields",
7537
7672
  "type": {
7538
- "text": "boolean"
7673
+ "text": "string"
7539
7674
  },
7540
- "readonly": true
7675
+ "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."
7541
7676
  },
7542
7677
  {
7543
- "kind": "method",
7544
- "name": "datasourceStatusChanged",
7545
- "parameters": [
7678
+ "kind": "field",
7679
+ "name": "maxView",
7680
+ "type": {
7681
+ "text": "number"
7682
+ },
7683
+ "description": "Maximum number of rows to track as part of a client \"view\"."
7684
+ },
7685
+ {
7686
+ "kind": "field",
7687
+ "name": "movingView",
7688
+ "type": {
7689
+ "text": "boolean"
7690
+ },
7691
+ "default": "false",
7692
+ "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."
7693
+ },
7694
+ {
7695
+ "kind": "field",
7696
+ "name": "reverse",
7697
+ "type": {
7698
+ "text": "boolean"
7699
+ },
7700
+ "default": "false",
7701
+ "description": "Option that changes the Data Server index iteration."
7702
+ },
7703
+ {
7704
+ "kind": "field",
7705
+ "name": "disablePolling",
7706
+ "type": {
7707
+ "text": "boolean"
7708
+ },
7709
+ "default": "false",
7710
+ "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically)."
7711
+ },
7712
+ {
7713
+ "kind": "field",
7714
+ "name": "offset",
7715
+ "type": {
7716
+ "text": "number"
7717
+ },
7718
+ "description": "The offset for pagination in REQUEST_SERVER scenarios."
7719
+ },
7720
+ {
7721
+ "kind": "field",
7722
+ "name": "pollingInterval",
7723
+ "type": {
7724
+ "text": "number"
7725
+ },
7726
+ "description": "Custom polling frequency (in milliseconds) for a Request Server resource."
7727
+ },
7728
+ {
7729
+ "kind": "field",
7730
+ "name": "pollTriggerEvents",
7731
+ "type": {
7732
+ "text": "string[]"
7733
+ },
7734
+ "default": "[]",
7735
+ "description": "Array of event names that will trigger a poll when received as commit responses."
7736
+ },
7737
+ {
7738
+ "kind": "field",
7739
+ "name": "request",
7740
+ "type": {
7741
+ "text": "any"
7742
+ },
7743
+ "description": "Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards."
7744
+ },
7745
+ {
7746
+ "kind": "field",
7747
+ "name": "requestAutoSetup",
7748
+ "type": {
7749
+ "text": "boolean"
7750
+ },
7751
+ "default": "true",
7752
+ "description": "Attribute to set whether the REQUEST object should be automatically set up."
7753
+ },
7754
+ {
7755
+ "kind": "field",
7756
+ "name": "rowIdAttr",
7757
+ "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type."
7758
+ },
7759
+ {
7760
+ "kind": "field",
7761
+ "name": "restartOnReconnection",
7762
+ "type": {
7763
+ "text": "boolean"
7764
+ },
7765
+ "default": "true",
7766
+ "description": "Attribute to set whether the datasource should restart when it reconnects."
7767
+ },
7768
+ {
7769
+ "kind": "field",
7770
+ "name": "defaultRowIdByResourceType",
7771
+ "type": {
7772
+ "text": "string"
7773
+ },
7774
+ "privacy": "protected",
7775
+ "readonly": true
7776
+ },
7777
+ {
7778
+ "kind": "field",
7779
+ "name": "criteriaFromFilters",
7780
+ "type": {
7781
+ "text": "Map<string, string>"
7782
+ },
7783
+ "privacy": "protected",
7784
+ "default": "new Map()"
7785
+ },
7786
+ {
7787
+ "kind": "field",
7788
+ "name": "update",
7789
+ "type": {
7790
+ "text": "BehaviorSubject<Map<string, string>>"
7791
+ },
7792
+ "privacy": "protected",
7793
+ "default": "new BehaviorSubject(new Map())"
7794
+ },
7795
+ {
7796
+ "kind": "method",
7797
+ "name": "datasourceOptions",
7798
+ "privacy": "protected",
7799
+ "return": {
7800
+ "type": {
7801
+ "text": "DatasourceOptions"
7802
+ }
7803
+ }
7804
+ },
7805
+ {
7806
+ "kind": "method",
7807
+ "name": "buildCriteria",
7808
+ "privacy": "private",
7809
+ "return": {
7810
+ "type": {
7811
+ "text": "string"
7812
+ }
7813
+ }
7814
+ },
7815
+ {
7816
+ "kind": "method",
7817
+ "name": "setFilter",
7818
+ "privacy": "public",
7819
+ "parameters": [
7820
+ {
7821
+ "name": "fieldName",
7822
+ "type": {
7823
+ "text": "string"
7824
+ }
7825
+ },
7826
+ {
7827
+ "name": "newFilter",
7828
+ "type": {
7829
+ "text": "string"
7830
+ }
7831
+ }
7832
+ ]
7833
+ },
7834
+ {
7835
+ "kind": "method",
7836
+ "name": "removeFilter",
7837
+ "privacy": "public",
7838
+ "parameters": [
7839
+ {
7840
+ "name": "fieldName",
7841
+ "type": {
7842
+ "text": "string"
7843
+ }
7844
+ }
7845
+ ]
7846
+ },
7847
+ {
7848
+ "kind": "field",
7849
+ "name": "isRequestServer",
7850
+ "type": {
7851
+ "text": "boolean"
7852
+ },
7853
+ "readonly": true
7854
+ },
7855
+ {
7856
+ "kind": "method",
7857
+ "name": "datasourceStatusChanged",
7858
+ "parameters": [
7546
7859
  {
7547
7860
  "name": "prev",
7548
7861
  "type": {
@@ -14308,684 +14621,637 @@
14308
14621
  },
14309
14622
  {
14310
14623
  "kind": "javascript-module",
14311
- "path": "src/column/column.template.ts",
14624
+ "path": "src/grid-pro-genesis-datasource/datasource-events.types.ts",
14312
14625
  "declarations": [
14313
14626
  {
14314
14627
  "kind": "variable",
14315
- "name": "ColumnTemplate",
14316
- "default": "html<GridProColumn>`\n <template>\n <slot ${slotted('slottedAgCell')} @slotchange=\"${(x) => x.slottedAgCellChanged()}\"></slot>\n </template>\n`",
14317
- "description": "The Grid Pro Column Template.",
14318
- "privacy": "public"
14628
+ "name": "datasourceEventNames",
14629
+ "type": {
14630
+ "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 // 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}"
14631
+ },
14632
+ "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 // 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}",
14633
+ "description": "Event names for datasource-grid communication\nThese represent datasource operations, not grid-specific actions"
14319
14634
  }
14320
14635
  ],
14321
14636
  "exports": [
14322
14637
  {
14323
14638
  "kind": "js",
14324
- "name": "ColumnTemplate",
14639
+ "name": "datasourceEventNames",
14325
14640
  "declaration": {
14326
- "name": "ColumnTemplate",
14327
- "module": "src/column/column.template.ts"
14641
+ "name": "datasourceEventNames",
14642
+ "module": "src/grid-pro-genesis-datasource/datasource-events.types.ts"
14328
14643
  }
14329
14644
  }
14330
14645
  ]
14331
14646
  },
14332
14647
  {
14333
14648
  "kind": "javascript-module",
14334
- "path": "src/column/column.ts",
14649
+ "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts",
14335
14650
  "declarations": [
14336
14651
  {
14337
14652
  "kind": "class",
14338
- "description": "The Grid Pro Column element.",
14339
- "name": "GridProColumn",
14653
+ "description": "The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.",
14654
+ "name": "GridProGenesisDatasource",
14340
14655
  "members": [
14341
14656
  {
14342
14657
  "kind": "field",
14343
- "name": "slottedAgCell",
14658
+ "name": "cachedRowArray",
14344
14659
  "type": {
14345
- "text": "HTMLElement[]"
14660
+ "text": "any[]"
14346
14661
  },
14347
- "privacy": "public"
14662
+ "privacy": "private",
14663
+ "default": "[]"
14348
14664
  },
14349
14665
  {
14350
14666
  "kind": "field",
14351
- "name": "definition",
14667
+ "name": "transactionData",
14352
14668
  "type": {
14353
- "text": "ColDef"
14354
- },
14355
- "default": "{}"
14356
- },
14357
- {
14358
- "kind": "method",
14359
- "name": "slottedAgCellChanged",
14360
- "privacy": "public"
14361
- },
14362
- {
14363
- "kind": "method",
14364
- "name": "deepClone",
14365
- "return": {
14366
- "type": {
14367
- "text": "Node"
14368
- }
14669
+ "text": "TransactionData"
14369
14670
  },
14671
+ "privacy": "protected",
14672
+ "default": "{\n add: [],\n remove: [],\n update: [],\n addIndex: 0,\n }",
14370
14673
  "inheritedFrom": {
14371
- "name": "LifecycleMixin",
14372
- "module": "src/mixins/lifecycle/lifecycle.ts"
14674
+ "name": "GridProBaseDatasource",
14675
+ "module": "src/datasource/base.datasource.ts"
14373
14676
  }
14374
14677
  },
14375
14678
  {
14376
14679
  "kind": "method",
14377
- "name": "cloneNode",
14378
- "return": {
14379
- "type": {
14380
- "text": "Node"
14381
- }
14382
- },
14680
+ "name": "criteriaChanged",
14383
14681
  "parameters": [
14384
14682
  {
14385
- "name": "deep",
14386
- "optional": true,
14683
+ "name": "oldCriteria",
14387
14684
  "type": {
14388
- "text": "boolean"
14685
+ "text": "string"
14686
+ }
14687
+ },
14688
+ {
14689
+ "name": "newCriteria",
14690
+ "type": {
14691
+ "text": "string"
14389
14692
  }
14390
14693
  }
14391
- ],
14392
- "inheritedFrom": {
14393
- "name": "LifecycleMixin",
14394
- "module": "src/mixins/lifecycle/lifecycle.ts"
14395
- }
14396
- },
14397
- {
14398
- "kind": "field",
14399
- "name": "shouldRunDisconnect",
14400
- "return": {
14401
- "type": {
14402
- "text": ""
14403
- }
14404
- },
14405
- "readonly": true,
14406
- "inheritedFrom": {
14407
- "name": "LifecycleMixin",
14408
- "module": "src/mixins/lifecycle/lifecycle.ts"
14409
- }
14694
+ ]
14410
14695
  },
14411
14696
  {
14412
- "kind": "field",
14413
- "name": "shouldRunConnect",
14414
- "return": {
14415
- "type": {
14416
- "text": ""
14697
+ "kind": "method",
14698
+ "name": "requestChanged",
14699
+ "parameters": [
14700
+ {
14701
+ "name": "oldRequest",
14702
+ "type": {
14703
+ "text": "string"
14704
+ }
14705
+ },
14706
+ {
14707
+ "name": "newRequest",
14708
+ "type": {
14709
+ "text": "string"
14710
+ }
14417
14711
  }
14418
- },
14419
- "readonly": true,
14420
- "inheritedFrom": {
14421
- "name": "LifecycleMixin",
14422
- "module": "src/mixins/lifecycle/lifecycle.ts"
14423
- }
14712
+ ]
14424
14713
  },
14425
14714
  {
14426
14715
  "kind": "method",
14427
- "name": "#_blockLifecycleDueToTokenChange",
14428
- "return": {
14429
- "type": {
14430
- "text": "boolean"
14431
- }
14432
- },
14716
+ "name": "resourceNameChanged",
14433
14717
  "parameters": [
14434
14718
  {
14435
- "name": "lifecycleType",
14719
+ "name": "oldValue",
14436
14720
  "type": {
14437
- "text": "Lifecycletype"
14721
+ "text": "string"
14722
+ }
14723
+ },
14724
+ {
14725
+ "name": "newValue",
14726
+ "type": {
14727
+ "text": "string"
14438
14728
  }
14439
14729
  }
14440
- ],
14730
+ ]
14731
+ },
14732
+ {
14733
+ "kind": "field",
14734
+ "name": "keepColDefsOnClearRowData",
14735
+ "type": {
14736
+ "text": "boolean"
14737
+ },
14738
+ "privacy": "public",
14739
+ "default": "false",
14441
14740
  "inheritedFrom": {
14442
- "name": "LifecycleMixin",
14443
- "module": "src/mixins/lifecycle/lifecycle.ts"
14741
+ "name": "GridProBaseDatasource",
14742
+ "module": "src/datasource/base.datasource.ts"
14444
14743
  }
14445
14744
  },
14446
14745
  {
14447
14746
  "kind": "field",
14448
- "name": "_presentation",
14747
+ "name": "dataSub",
14449
14748
  "type": {
14450
- "text": "ComponentPresentation | null | undefined"
14749
+ "text": "Subscription"
14750
+ },
14751
+ "privacy": "private"
14752
+ },
14753
+ {
14754
+ "kind": "field",
14755
+ "name": "updateSub",
14756
+ "type": {
14757
+ "text": "Subscription"
14758
+ },
14759
+ "privacy": "private"
14760
+ },
14761
+ {
14762
+ "kind": "field",
14763
+ "name": "requiresFullRowDataAndColDefs",
14764
+ "type": {
14765
+ "text": "boolean"
14451
14766
  },
14452
14767
  "privacy": "private",
14453
- "default": "void 0",
14454
- "inheritedFrom": {
14455
- "name": "FoundationElement",
14456
- "module": "src/foundation-element/foundation-element.ts"
14457
- }
14768
+ "default": "true"
14458
14769
  },
14459
14770
  {
14460
14771
  "kind": "field",
14461
- "name": "$presentation",
14772
+ "name": "_lastMoreRows",
14462
14773
  "type": {
14463
- "text": "ComponentPresentation | null"
14774
+ "text": "boolean"
14464
14775
  },
14465
- "privacy": "public",
14466
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
14467
- "inheritedFrom": {
14468
- "name": "FoundationElement",
14469
- "module": "src/foundation-element/foundation-element.ts"
14470
- }
14776
+ "privacy": "private",
14777
+ "default": "false"
14471
14778
  },
14472
14779
  {
14473
14780
  "kind": "field",
14474
- "name": "template",
14781
+ "name": "_isMoreRowsResult",
14475
14782
  "type": {
14476
- "text": "ElementViewTemplate | void | null"
14783
+ "text": "boolean"
14477
14784
  },
14478
- "privacy": "public",
14479
- "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.",
14480
- "inheritedFrom": {
14481
- "name": "FoundationElement",
14482
- "module": "src/foundation-element/foundation-element.ts"
14483
- }
14785
+ "privacy": "private",
14786
+ "default": "false"
14484
14787
  },
14485
14788
  {
14486
- "kind": "method",
14487
- "name": "templateChanged",
14488
- "privacy": "protected",
14489
- "return": {
14490
- "type": {
14491
- "text": "void"
14492
- }
14789
+ "kind": "field",
14790
+ "name": "_sourceRef",
14791
+ "type": {
14792
+ "text": "string"
14493
14793
  },
14494
- "inheritedFrom": {
14495
- "name": "FoundationElement",
14496
- "module": "src/foundation-element/foundation-element.ts"
14497
- }
14794
+ "privacy": "private"
14498
14795
  },
14499
14796
  {
14500
14797
  "kind": "field",
14501
- "name": "styles",
14798
+ "name": "_nextOffset",
14502
14799
  "type": {
14503
- "text": "ElementStyles | void | null"
14800
+ "text": "number"
14504
14801
  },
14505
- "privacy": "public",
14506
- "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.",
14507
- "inheritedFrom": {
14508
- "name": "FoundationElement",
14509
- "module": "src/foundation-element/foundation-element.ts"
14510
- }
14802
+ "privacy": "private",
14803
+ "default": "0"
14804
+ },
14805
+ {
14806
+ "kind": "field",
14807
+ "name": "_loadMoreCount",
14808
+ "type": {
14809
+ "text": "number"
14810
+ },
14811
+ "privacy": "private",
14812
+ "default": "0"
14511
14813
  },
14512
14814
  {
14513
14815
  "kind": "method",
14514
- "name": "stylesChanged",
14515
- "privacy": "protected",
14816
+ "name": "deepClone",
14516
14817
  "return": {
14517
14818
  "type": {
14518
- "text": "void"
14819
+ "text": "Node"
14519
14820
  }
14520
14821
  },
14521
14822
  "inheritedFrom": {
14522
- "name": "FoundationElement",
14523
- "module": "src/foundation-element/foundation-element.ts"
14823
+ "name": "LifecycleMixin",
14824
+ "module": "src/mixins/lifecycle/lifecycle.ts"
14524
14825
  }
14525
14826
  },
14526
14827
  {
14527
14828
  "kind": "method",
14528
- "name": "compose",
14529
- "privacy": "public",
14530
- "static": true,
14829
+ "name": "colDefsDeepClone",
14830
+ "privacy": "private",
14531
14831
  "return": {
14532
14832
  "type": {
14533
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
14833
+ "text": "ColDef[]"
14534
14834
  }
14535
14835
  },
14536
14836
  "parameters": [
14537
14837
  {
14538
- "name": "this",
14838
+ "name": "key",
14539
14839
  "type": {
14540
- "text": "K"
14840
+ "text": "string"
14541
14841
  }
14542
14842
  },
14543
14843
  {
14544
- "name": "elementDefinition",
14844
+ "name": "copy",
14545
14845
  "type": {
14546
- "text": "T"
14547
- },
14548
- "description": "The definition of the element to create the registry\nfunction for."
14846
+ "text": "any"
14847
+ }
14848
+ }
14849
+ ]
14850
+ },
14851
+ {
14852
+ "kind": "method",
14853
+ "name": "init",
14854
+ "parameters": [
14855
+ {
14856
+ "name": "keepColDefsOnClearRowData",
14857
+ "optional": true,
14858
+ "type": {
14859
+ "text": "boolean"
14860
+ }
14861
+ },
14862
+ {
14863
+ "description": "Optionally set the `gridOptions` up with column definitions",
14864
+ "name": "columnDefinitions"
14865
+ },
14866
+ {
14867
+ "description": "Optionally set the grid up with column state",
14868
+ "name": "columnStates"
14549
14869
  }
14550
14870
  ],
14551
- "description": "Defines an element registry function with a set of element definition defaults.",
14871
+ "description": "Initializes the datasource.",
14872
+ "privacy": "public"
14873
+ },
14874
+ {
14875
+ "kind": "method",
14876
+ "name": "destroy",
14877
+ "description": "Destroys the datasource, resetting it to its initial state.",
14878
+ "privacy": "public",
14552
14879
  "inheritedFrom": {
14553
- "name": "FoundationElement",
14554
- "module": "src/foundation-element/foundation-element.ts"
14880
+ "name": "GridProBaseDatasource",
14881
+ "module": "src/datasource/base.datasource.ts"
14555
14882
  }
14556
- }
14557
- ],
14558
- "mixins": [
14883
+ },
14559
14884
  {
14560
- "name": "LifecycleMixin",
14561
- "package": "@genesislcap/foundation-utils"
14562
- }
14563
- ],
14564
- "superclass": {
14565
- "name": "FoundationElement",
14566
- "package": "@microsoft/fast-foundation"
14567
- },
14568
- "tagName": "grid-pro-column",
14569
- "customElement": true
14570
- }
14571
- ],
14572
- "exports": [
14573
- {
14574
- "kind": "js",
14575
- "name": "GridProColumn",
14576
- "declaration": {
14577
- "name": "GridProColumn",
14578
- "module": "src/column/column.ts"
14579
- }
14580
- },
14581
- {
14582
- "kind": "custom-element-definition",
14583
- "name": "grid-pro-column",
14584
- "declaration": {
14585
- "name": "GridProColumn",
14586
- "module": "src/column/column.ts"
14587
- }
14588
- }
14589
- ]
14590
- },
14591
- {
14592
- "kind": "javascript-module",
14593
- "path": "src/column/index.ts",
14594
- "declarations": [],
14595
- "exports": [
14596
- {
14597
- "kind": "js",
14598
- "name": "*",
14599
- "declaration": {
14600
- "name": "*",
14601
- "package": "./column.template"
14602
- }
14603
- },
14604
- {
14605
- "kind": "js",
14606
- "name": "*",
14607
- "declaration": {
14608
- "name": "*",
14609
- "package": "./column"
14610
- }
14611
- },
14612
- {
14613
- "kind": "js",
14614
- "name": "*",
14615
- "declaration": {
14616
- "name": "*",
14617
- "package": "./utils"
14618
- }
14619
- }
14620
- ]
14621
- },
14622
- {
14623
- "kind": "javascript-module",
14624
- "path": "src/state-persistence/index.ts",
14625
- "declarations": [],
14626
- "exports": [
14627
- {
14628
- "kind": "js",
14629
- "name": "*",
14630
- "declaration": {
14631
- "name": "*",
14632
- "package": "./kv-state"
14633
- }
14634
- },
14635
- {
14636
- "kind": "js",
14637
- "name": "*",
14638
- "declaration": {
14639
- "name": "*",
14640
- "package": "./local-state"
14641
- }
14642
- },
14643
- {
14644
- "kind": "js",
14645
- "name": "*",
14646
- "declaration": {
14647
- "name": "*",
14648
- "package": "./state-persistence"
14649
- }
14650
- }
14651
- ]
14652
- },
14653
- {
14654
- "kind": "javascript-module",
14655
- "path": "src/state-persistence/kv-state.ts",
14656
- "declarations": [
14657
- {
14658
- "kind": "class",
14659
- "description": "Implementation for the KV Storage State Persistence interface.",
14660
- "name": "KVStorageStatePersistence",
14661
- "members": [
14885
+ "kind": "method",
14886
+ "name": "deinit",
14887
+ "description": "Deinitialises the datasource, resetting it to its initial state.",
14888
+ "deprecated": "Use `destroy` instead",
14889
+ "privacy": "public"
14890
+ },
14662
14891
  {
14663
- "kind": "field",
14664
- "name": "kvStorage",
14665
- "type": {
14666
- "text": "KVStorage"
14667
- }
14892
+ "kind": "method",
14893
+ "name": "reset",
14894
+ "description": "Resets the datasource to its initial state.",
14895
+ "privacy": "public",
14896
+ "deprecated": "Use `destroy` instead"
14668
14897
  },
14669
14898
  {
14670
- "kind": "field",
14671
- "name": "session",
14672
- "type": {
14673
- "text": "Session"
14899
+ "kind": "method",
14900
+ "name": "restart",
14901
+ "description": "Restarts the datasource, uses `destroy` and `init` in sequence.",
14902
+ "privacy": "public",
14903
+ "inheritedFrom": {
14904
+ "name": "GridProBaseDatasource",
14905
+ "module": "src/datasource/base.datasource.ts"
14674
14906
  }
14675
14907
  },
14676
14908
  {
14677
14909
  "kind": "method",
14678
- "name": "getColumnState",
14910
+ "name": "refreshRows",
14911
+ "description": "Force the grid to redispatch the current rows"
14912
+ },
14913
+ {
14914
+ "kind": "method",
14915
+ "name": "reloadResourceData",
14916
+ "privacy": "public",
14679
14917
  "return": {
14680
14918
  "type": {
14681
- "text": "Promise<ColumnState[]>"
14919
+ "text": "Promise<void>"
14682
14920
  }
14683
14921
  },
14922
+ "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).",
14923
+ "inheritedFrom": {
14924
+ "name": "GridProBaseDatasource",
14925
+ "module": "src/datasource/base.datasource.ts"
14926
+ }
14927
+ },
14928
+ {
14929
+ "kind": "method",
14930
+ "name": "handleSnapshot",
14931
+ "privacy": "private",
14684
14932
  "parameters": [
14685
14933
  {
14686
- "name": "persistColumnStateKey",
14934
+ "name": "result"
14935
+ }
14936
+ ]
14937
+ },
14938
+ {
14939
+ "kind": "method",
14940
+ "name": "handleStreamResult",
14941
+ "privacy": "private",
14942
+ "parameters": [
14943
+ {
14944
+ "name": "result",
14687
14945
  "type": {
14688
- "text": "string"
14946
+ "text": "FilteredDataServerResult | RequestServerResult"
14689
14947
  }
14690
14948
  }
14691
14949
  ]
14692
14950
  },
14693
14951
  {
14694
14952
  "kind": "method",
14695
- "name": "saveColumnState",
14696
- "return": {
14697
- "type": {
14698
- "text": "Promise<void>"
14699
- }
14700
- },
14953
+ "name": "updateLoadMoreStatus",
14954
+ "privacy": "private",
14701
14955
  "parameters": [
14702
14956
  {
14703
- "name": "persistColumnStateKey",
14957
+ "name": "moreRows",
14704
14958
  "type": {
14705
- "text": "string"
14706
- }
14959
+ "text": "boolean"
14960
+ },
14961
+ "description": "Whether more rows are available"
14707
14962
  },
14708
14963
  {
14709
- "name": "columnState",
14964
+ "name": "sourceRef",
14710
14965
  "type": {
14711
- "text": "ColumnState[]"
14712
- }
14966
+ "text": "string"
14967
+ },
14968
+ "description": "The source reference"
14969
+ },
14970
+ {
14971
+ "description": "The total number of rows",
14972
+ "name": "rowsCount"
14713
14973
  }
14714
- ]
14974
+ ],
14975
+ "description": "Updates the status bar based on more rows status"
14715
14976
  },
14716
14977
  {
14717
14978
  "kind": "method",
14718
- "name": "deleteColumnState",
14719
- "return": {
14720
- "type": {
14721
- "text": "Promise<void>"
14722
- }
14723
- },
14979
+ "name": "applyRequestServerData",
14980
+ "privacy": "private",
14724
14981
  "parameters": [
14725
14982
  {
14726
- "name": "persistColumnStateKey",
14983
+ "name": "requestServerResult",
14727
14984
  "type": {
14728
- "text": "string"
14985
+ "text": "RequestServerResult"
14729
14986
  }
14730
14987
  }
14731
14988
  ]
14732
14989
  },
14733
14990
  {
14734
14991
  "kind": "method",
14735
- "name": "migrateLocalStorageToKVStorage",
14992
+ "name": "applyDataserverData",
14736
14993
  "privacy": "private",
14737
- "return": {
14738
- "type": {
14739
- "text": "Promise<void>"
14740
- }
14741
- },
14742
14994
  "parameters": [
14743
14995
  {
14744
- "name": "persistColumnStateKey",
14996
+ "name": "dataServerResult",
14745
14997
  "type": {
14746
- "text": "string"
14998
+ "text": "FilteredDataServerResult"
14747
14999
  }
14748
15000
  }
14749
15001
  ]
14750
15002
  },
14751
15003
  {
14752
15004
  "kind": "method",
14753
- "name": "getFilterModel",
14754
- "return": {
14755
- "type": {
14756
- "text": "Promise<{ [key: string]: any }>"
14757
- }
14758
- },
15005
+ "name": "getAgColumnDefs",
15006
+ "privacy": "private",
14759
15007
  "parameters": [
14760
15008
  {
14761
- "name": "persistFilterModelKey",
15009
+ "name": "fieldsMetadata",
14762
15010
  "type": {
14763
- "text": "string"
15011
+ "text": "FieldMetadata[]"
14764
15012
  }
14765
15013
  }
14766
15014
  ]
14767
15015
  },
14768
15016
  {
14769
15017
  "kind": "method",
14770
- "name": "saveFilterModel",
14771
- "return": {
14772
- "type": {
14773
- "text": "Promise<void>"
14774
- }
14775
- },
15018
+ "name": "setFilter",
15019
+ "privacy": "public",
14776
15020
  "parameters": [
14777
15021
  {
14778
- "name": "persistFilterModelKey",
15022
+ "name": "fieldName",
14779
15023
  "type": {
14780
15024
  "text": "string"
14781
15025
  }
14782
15026
  },
14783
15027
  {
14784
- "name": "filterModel",
15028
+ "name": "newFilter",
14785
15029
  "type": {
14786
- "text": "{ [key: string]: any }"
15030
+ "text": "string"
14787
15031
  }
14788
15032
  }
14789
- ]
14790
- }
14791
- ]
14792
- }
14793
- ],
14794
- "exports": [
14795
- {
14796
- "kind": "js",
14797
- "name": "KVStorageStatePersistence",
14798
- "declaration": {
14799
- "name": "KVStorageStatePersistence",
14800
- "module": "src/state-persistence/kv-state.ts"
14801
- }
14802
- }
14803
- ]
14804
- },
14805
- {
14806
- "kind": "javascript-module",
14807
- "path": "src/state-persistence/local-state.ts",
14808
- "declarations": [
14809
- {
14810
- "kind": "class",
14811
- "description": "Implementation for the Local Storage State Persistence interface.",
14812
- "name": "LocalStorageStatePersistence",
14813
- "members": [
14814
- {
14815
- "kind": "field",
14816
- "name": "session",
14817
- "type": {
14818
- "text": "Session"
15033
+ ],
15034
+ "inheritedFrom": {
15035
+ "name": "GenesisGridDatasourceElement",
15036
+ "module": "src/datasource/base.datasource.ts"
14819
15037
  }
14820
15038
  },
14821
15039
  {
14822
15040
  "kind": "method",
14823
- "name": "getColumnState",
14824
- "return": {
14825
- "type": {
14826
- "text": "Promise<ColumnState[]>"
14827
- }
14828
- },
15041
+ "name": "removeFilter",
15042
+ "privacy": "public",
14829
15043
  "parameters": [
14830
15044
  {
14831
- "name": "persistColumnStateKey",
15045
+ "name": "fieldName",
14832
15046
  "type": {
14833
15047
  "text": "string"
14834
15048
  }
14835
15049
  }
14836
- ]
15050
+ ],
15051
+ "inheritedFrom": {
15052
+ "name": "GenesisGridDatasourceElement",
15053
+ "module": "src/datasource/base.datasource.ts"
15054
+ }
14837
15055
  },
14838
15056
  {
14839
15057
  "kind": "method",
14840
- "name": "saveColumnState",
15058
+ "name": "applyTransaction",
15059
+ "privacy": "protected",
14841
15060
  "return": {
14842
15061
  "type": {
14843
- "text": "Promise<void>"
15062
+ "text": "any"
14844
15063
  }
14845
15064
  },
14846
15065
  "parameters": [
14847
15066
  {
14848
- "name": "persistColumnStateKey",
15067
+ "name": "transaction",
14849
15068
  "type": {
14850
- "text": "string"
15069
+ "text": "any"
15070
+ }
15071
+ }
15072
+ ],
15073
+ "inheritedFrom": {
15074
+ "name": "GridProBaseDatasource",
15075
+ "module": "src/datasource/base.datasource.ts"
15076
+ }
15077
+ },
15078
+ {
15079
+ "kind": "method",
15080
+ "name": "handleSizeChanged",
15081
+ "privacy": "private",
15082
+ "parameters": [
15083
+ {
15084
+ "name": "oldSize",
15085
+ "type": {
15086
+ "text": "number"
14851
15087
  }
14852
15088
  },
14853
15089
  {
14854
- "name": "columnState",
15090
+ "name": "newSize",
14855
15091
  "type": {
14856
- "text": "ColumnState[]"
15092
+ "text": "number"
14857
15093
  }
14858
15094
  }
14859
15095
  ]
14860
15096
  },
14861
15097
  {
14862
15098
  "kind": "method",
14863
- "name": "deleteColumnState",
14864
- "return": {
14865
- "type": {
14866
- "text": "Promise<void>"
15099
+ "name": "handleStreamInserts",
15100
+ "privacy": "protected",
15101
+ "parameters": [
15102
+ {
15103
+ "name": "inserts",
15104
+ "default": "[]"
14867
15105
  }
14868
- },
15106
+ ],
15107
+ "inheritedFrom": {
15108
+ "name": "GridProBaseDatasource",
15109
+ "module": "src/datasource/base.datasource.ts"
15110
+ }
15111
+ },
15112
+ {
15113
+ "kind": "method",
15114
+ "name": "handleStreamUpdates",
15115
+ "privacy": "protected",
14869
15116
  "parameters": [
14870
15117
  {
14871
- "name": "persistColumnStateKey",
14872
- "type": {
14873
- "text": "string"
14874
- }
15118
+ "name": "updates",
15119
+ "default": "[]"
14875
15120
  }
14876
- ]
15121
+ ],
15122
+ "inheritedFrom": {
15123
+ "name": "GridProBaseDatasource",
15124
+ "module": "src/datasource/base.datasource.ts"
15125
+ }
14877
15126
  },
14878
15127
  {
14879
15128
  "kind": "method",
14880
- "name": "getFilterModel",
15129
+ "name": "handleStreamDeletes",
15130
+ "privacy": "protected",
15131
+ "parameters": [
15132
+ {
15133
+ "name": "deletes",
15134
+ "default": "[]",
15135
+ "description": "List of records to remove from the grid stream"
15136
+ }
15137
+ ],
15138
+ "description": "Handles stream deletes by removing records from the grid.",
15139
+ "inheritedFrom": {
15140
+ "name": "GridProBaseDatasource",
15141
+ "module": "src/datasource/base.datasource.ts"
15142
+ }
15143
+ },
15144
+ {
15145
+ "kind": "method",
15146
+ "name": "loadMore",
15147
+ "inheritedFrom": {
15148
+ "name": "GridProBaseDatasource",
15149
+ "module": "src/datasource/base.datasource.ts"
15150
+ }
15151
+ },
15152
+ {
15153
+ "kind": "method",
15154
+ "name": "cloneNode",
14881
15155
  "return": {
14882
15156
  "type": {
14883
- "text": "Promise<{ [key: string]: any }>"
15157
+ "text": "Node"
14884
15158
  }
14885
15159
  },
14886
15160
  "parameters": [
14887
15161
  {
14888
- "name": "persistFilterModelKey",
15162
+ "name": "deep",
15163
+ "optional": true,
14889
15164
  "type": {
14890
- "text": "string"
15165
+ "text": "boolean"
14891
15166
  }
14892
15167
  }
14893
- ]
15168
+ ],
15169
+ "inheritedFrom": {
15170
+ "name": "LifecycleMixin",
15171
+ "module": "src/mixins/lifecycle/lifecycle.ts"
15172
+ }
15173
+ },
15174
+ {
15175
+ "kind": "field",
15176
+ "name": "shouldRunDisconnect",
15177
+ "return": {
15178
+ "type": {
15179
+ "text": ""
15180
+ }
15181
+ },
15182
+ "readonly": true,
15183
+ "inheritedFrom": {
15184
+ "name": "LifecycleMixin",
15185
+ "module": "src/mixins/lifecycle/lifecycle.ts"
15186
+ }
15187
+ },
15188
+ {
15189
+ "kind": "field",
15190
+ "name": "shouldRunConnect",
15191
+ "return": {
15192
+ "type": {
15193
+ "text": ""
15194
+ }
15195
+ },
15196
+ "readonly": true,
15197
+ "inheritedFrom": {
15198
+ "name": "LifecycleMixin",
15199
+ "module": "src/mixins/lifecycle/lifecycle.ts"
15200
+ }
14894
15201
  },
14895
15202
  {
14896
15203
  "kind": "method",
14897
- "name": "saveFilterModel",
15204
+ "name": "#_blockLifecycleDueToTokenChange",
14898
15205
  "return": {
14899
15206
  "type": {
14900
- "text": "Promise<void>"
15207
+ "text": "boolean"
14901
15208
  }
14902
15209
  },
14903
15210
  "parameters": [
14904
15211
  {
14905
- "name": "persistFilterModelKey",
14906
- "type": {
14907
- "text": "string"
14908
- }
14909
- },
14910
- {
14911
- "name": "filterModel",
15212
+ "name": "lifecycleType",
14912
15213
  "type": {
14913
- "text": "{ [key: string]: any }"
15214
+ "text": "Lifecycletype"
14914
15215
  }
14915
15216
  }
14916
- ]
14917
- }
14918
- ]
14919
- }
14920
- ],
14921
- "exports": [
14922
- {
14923
- "kind": "js",
14924
- "name": "LocalStorageStatePersistence",
14925
- "declaration": {
14926
- "name": "LocalStorageStatePersistence",
14927
- "module": "src/state-persistence/local-state.ts"
14928
- }
14929
- }
14930
- ]
14931
- },
14932
- {
14933
- "kind": "javascript-module",
14934
- "path": "src/state-persistence/state-persistence.ts",
14935
- "declarations": [],
14936
- "exports": []
14937
- },
14938
- {
14939
- "kind": "javascript-module",
14940
- "path": "src/grid-pro-genesis-datasource/datasource-events.types.ts",
14941
- "declarations": [
14942
- {
14943
- "kind": "variable",
14944
- "name": "datasourceEventNames",
14945
- "type": {
14946
- "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 // 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}"
14947
- },
14948
- "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 // 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}",
14949
- "description": "Event names for datasource-grid communication\nThese represent datasource operations, not grid-specific actions"
14950
- }
14951
- ],
14952
- "exports": [
14953
- {
14954
- "kind": "js",
14955
- "name": "datasourceEventNames",
14956
- "declaration": {
14957
- "name": "datasourceEventNames",
14958
- "module": "src/grid-pro-genesis-datasource/datasource-events.types.ts"
14959
- }
14960
- }
14961
- ]
14962
- },
14963
- {
14964
- "kind": "javascript-module",
14965
- "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts",
14966
- "declarations": [
14967
- {
14968
- "kind": "class",
14969
- "description": "The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.",
14970
- "name": "GridProGenesisDatasource",
14971
- "members": [
15217
+ ],
15218
+ "inheritedFrom": {
15219
+ "name": "LifecycleMixin",
15220
+ "module": "src/mixins/lifecycle/lifecycle.ts"
15221
+ }
15222
+ },
14972
15223
  {
14973
15224
  "kind": "field",
14974
- "name": "cachedRowArray",
15225
+ "name": "dataSubWasLoggedOff",
14975
15226
  "type": {
14976
- "text": "any[]"
15227
+ "text": "boolean"
14977
15228
  },
14978
- "privacy": "private",
14979
- "default": "[]"
15229
+ "privacy": "protected",
15230
+ "default": "false",
15231
+ "inheritedFrom": {
15232
+ "name": "GridProBaseDatasource",
15233
+ "module": "src/datasource/base.datasource.ts"
15234
+ }
14980
15235
  },
14981
15236
  {
14982
15237
  "kind": "field",
14983
- "name": "transactionData",
15238
+ "name": "rowData",
14984
15239
  "type": {
14985
- "text": "TransactionData"
15240
+ "text": "Map<string, any>"
15241
+ },
15242
+ "default": "new Map()",
15243
+ "inheritedFrom": {
15244
+ "name": "GridProBaseDatasource",
15245
+ "module": "src/datasource/base.datasource.ts"
15246
+ }
15247
+ },
15248
+ {
15249
+ "kind": "field",
15250
+ "name": "connectionSub",
15251
+ "type": {
15252
+ "text": "Subscription | undefined"
14986
15253
  },
14987
15254
  "privacy": "protected",
14988
- "default": "{\n add: [],\n remove: [],\n update: [],\n addIndex: 0,\n }",
14989
15255
  "inheritedFrom": {
14990
15256
  "name": "GridProBaseDatasource",
14991
15257
  "module": "src/datasource/base.datasource.ts"
@@ -14993,1572 +15259,1306 @@
14993
15259
  },
14994
15260
  {
14995
15261
  "kind": "method",
14996
- "name": "criteriaChanged",
14997
- "parameters": [
14998
- {
14999
- "name": "oldCriteria",
15000
- "type": {
15001
- "text": "string"
15002
- }
15003
- },
15004
- {
15005
- "name": "newCriteria",
15006
- "type": {
15007
- "text": "string"
15008
- }
15009
- }
15010
- ]
15262
+ "name": "subscribeToConnection",
15263
+ "privacy": "protected",
15264
+ "inheritedFrom": {
15265
+ "name": "GridProBaseDatasource",
15266
+ "module": "src/datasource/base.datasource.ts"
15267
+ }
15011
15268
  },
15012
15269
  {
15013
15270
  "kind": "method",
15014
- "name": "requestChanged",
15271
+ "name": "unsubscribeFromConnection",
15272
+ "privacy": "protected",
15273
+ "inheritedFrom": {
15274
+ "name": "GridProBaseDatasource",
15275
+ "module": "src/datasource/base.datasource.ts"
15276
+ }
15277
+ },
15278
+ {
15279
+ "kind": "method",
15280
+ "name": "generateColumnDefsFromMetadata",
15281
+ "privacy": "protected",
15282
+ "return": {
15283
+ "type": {
15284
+ "text": "ColDef[]"
15285
+ }
15286
+ },
15015
15287
  "parameters": [
15016
15288
  {
15017
- "name": "oldRequest",
15289
+ "name": "fieldsMetadata",
15018
15290
  "type": {
15019
- "text": "string"
15291
+ "text": "FieldMetadata[]"
15020
15292
  }
15021
15293
  },
15022
15294
  {
15023
- "name": "newRequest",
15295
+ "name": "getFilterParamsByFieldType",
15024
15296
  "type": {
15025
- "text": "string"
15297
+ "text": "Function"
15026
15298
  }
15027
15299
  }
15028
- ]
15300
+ ],
15301
+ "inheritedFrom": {
15302
+ "name": "GridProBaseDatasource",
15303
+ "module": "src/datasource/base.datasource.ts"
15304
+ }
15029
15305
  },
15030
15306
  {
15031
15307
  "kind": "method",
15032
- "name": "resourceNameChanged",
15308
+ "name": "applyAllTransactions",
15309
+ "privacy": "protected",
15310
+ "inheritedFrom": {
15311
+ "name": "GridProBaseDatasource",
15312
+ "module": "src/datasource/base.datasource.ts"
15313
+ }
15314
+ },
15315
+ {
15316
+ "kind": "method",
15317
+ "name": "applyMappedTransaction",
15318
+ "privacy": "private",
15033
15319
  "parameters": [
15034
15320
  {
15035
- "name": "oldValue",
15321
+ "name": "transaction",
15036
15322
  "type": {
15037
- "text": "string"
15323
+ "text": "TransactionData"
15038
15324
  }
15039
15325
  },
15040
15326
  {
15041
- "name": "newValue",
15327
+ "name": "operation",
15042
15328
  "type": {
15043
- "text": "string"
15329
+ "text": "OperationType"
15044
15330
  }
15045
15331
  }
15046
- ]
15047
- },
15048
- {
15049
- "kind": "field",
15050
- "name": "keepColDefsOnClearRowData",
15051
- "type": {
15052
- "text": "boolean"
15053
- },
15054
- "privacy": "public",
15055
- "default": "false",
15332
+ ],
15056
15333
  "inheritedFrom": {
15057
15334
  "name": "GridProBaseDatasource",
15058
15335
  "module": "src/datasource/base.datasource.ts"
15059
15336
  }
15060
15337
  },
15061
15338
  {
15062
- "kind": "field",
15063
- "name": "dataSub",
15064
- "type": {
15065
- "text": "Subscription"
15066
- },
15067
- "privacy": "private"
15068
- },
15069
- {
15070
- "kind": "field",
15071
- "name": "updateSub",
15072
- "type": {
15073
- "text": "Subscription"
15074
- },
15075
- "privacy": "private"
15076
- },
15077
- {
15078
- "kind": "field",
15079
- "name": "requiresFullRowDataAndColDefs",
15080
- "type": {
15081
- "text": "boolean"
15082
- },
15339
+ "kind": "method",
15340
+ "name": "mapTransaction",
15083
15341
  "privacy": "private",
15084
- "default": "true"
15085
- },
15086
- {
15087
- "kind": "field",
15088
- "name": "_lastMoreRows",
15089
- "type": {
15090
- "text": "boolean"
15342
+ "parameters": [
15343
+ {
15344
+ "name": "transaction",
15345
+ "type": {
15346
+ "text": "TransactionData"
15347
+ },
15348
+ "description": "The transaction data to be mapped."
15349
+ },
15350
+ {
15351
+ "name": "operations",
15352
+ "default": "Object.values(OperationType)",
15353
+ "type": {
15354
+ "text": "OperationType[]"
15355
+ },
15356
+ "description": "The operations to be mapped. Can be 'add', 'update' or 'remove'."
15357
+ }
15358
+ ],
15359
+ "description": "Maps the transaction data to the row data mapper function, if it exists.",
15360
+ "return": {
15361
+ "type": {
15362
+ "text": ""
15363
+ }
15091
15364
  },
15092
- "privacy": "private",
15093
- "default": "false"
15365
+ "inheritedFrom": {
15366
+ "name": "GridProBaseDatasource",
15367
+ "module": "src/datasource/base.datasource.ts"
15368
+ }
15094
15369
  },
15095
15370
  {
15096
15371
  "kind": "field",
15097
- "name": "_isMoreRowsResult",
15372
+ "name": "pagination",
15098
15373
  "type": {
15099
15374
  "text": "boolean"
15100
15375
  },
15101
- "privacy": "private",
15102
- "default": "false"
15103
- },
15104
- {
15105
- "kind": "field",
15106
- "name": "_sourceRef",
15107
- "type": {
15108
- "text": "string"
15109
- },
15110
- "privacy": "private"
15376
+ "privacy": "protected",
15377
+ "inheritedFrom": {
15378
+ "name": "GridProBaseDatasource",
15379
+ "module": "src/datasource/base.datasource.ts"
15380
+ }
15111
15381
  },
15112
15382
  {
15113
15383
  "kind": "field",
15114
- "name": "_nextOffset",
15384
+ "name": "_isDisconnected",
15115
15385
  "type": {
15116
- "text": "number"
15386
+ "text": "boolean"
15117
15387
  },
15118
15388
  "privacy": "private",
15119
- "default": "0"
15389
+ "default": "false",
15390
+ "inheritedFrom": {
15391
+ "name": "GridProBaseDatasource",
15392
+ "module": "src/datasource/base.datasource.ts"
15393
+ }
15120
15394
  },
15121
15395
  {
15122
- "kind": "field",
15123
- "name": "_loadMoreCount",
15124
- "type": {
15125
- "text": "number"
15126
- },
15127
- "privacy": "private",
15128
- "default": "0"
15396
+ "kind": "method",
15397
+ "name": "setDisconnected",
15398
+ "privacy": "public",
15399
+ "parameters": [
15400
+ {
15401
+ "name": "disconnected",
15402
+ "type": {
15403
+ "text": "boolean"
15404
+ },
15405
+ "description": "true to set, false to remove"
15406
+ }
15407
+ ],
15408
+ "description": "Sets the disconnected state and emits appropriate events.",
15409
+ "inheritedFrom": {
15410
+ "name": "GridProBaseDatasource",
15411
+ "module": "src/datasource/base.datasource.ts"
15412
+ }
15129
15413
  },
15130
15414
  {
15131
15415
  "kind": "method",
15132
- "name": "deepClone",
15416
+ "name": "isDisconnected",
15417
+ "privacy": "public",
15133
15418
  "return": {
15134
15419
  "type": {
15135
- "text": "Node"
15420
+ "text": "boolean"
15136
15421
  }
15137
15422
  },
15423
+ "description": "Returns true if the datasource is disconnected.",
15138
15424
  "inheritedFrom": {
15139
- "name": "LifecycleMixin",
15140
- "module": "src/mixins/lifecycle/lifecycle.ts"
15425
+ "name": "GridProBaseDatasource",
15426
+ "module": "src/datasource/base.datasource.ts"
15141
15427
  }
15142
15428
  },
15143
15429
  {
15144
15430
  "kind": "method",
15145
- "name": "colDefsDeepClone",
15146
- "privacy": "private",
15431
+ "name": "getDatasourceStatusBarPanels",
15432
+ "privacy": "public",
15147
15433
  "return": {
15148
15434
  "type": {
15149
- "text": "ColDef[]"
15435
+ "text": "any[]"
15150
15436
  }
15151
15437
  },
15152
15438
  "parameters": [
15153
15439
  {
15154
- "name": "key",
15440
+ "name": "isServerSide",
15155
15441
  "type": {
15156
- "text": "string"
15442
+ "text": "boolean"
15157
15443
  }
15158
15444
  },
15159
15445
  {
15160
- "name": "copy",
15446
+ "name": "statusBarConfig",
15161
15447
  "type": {
15162
15448
  "text": "any"
15163
15449
  }
15164
15450
  }
15165
- ]
15166
- },
15167
- {
15168
- "kind": "method",
15169
- "name": "init",
15170
- "parameters": [
15171
- {
15172
- "name": "keepColDefsOnClearRowData",
15173
- "optional": true,
15174
- "type": {
15175
- "text": "boolean"
15176
- }
15177
- },
15178
- {
15179
- "description": "Optionally set the `gridOptions` up with column definitions",
15180
- "name": "columnDefinitions"
15181
- },
15182
- {
15183
- "description": "Optionally set the grid up with column state",
15184
- "name": "columnStates"
15185
- }
15186
15451
  ],
15187
- "description": "Initializes the datasource.",
15188
- "privacy": "public"
15452
+ "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.",
15453
+ "inheritedFrom": {
15454
+ "name": "GridProBaseDatasource",
15455
+ "module": "src/datasource/base.datasource.ts"
15456
+ }
15189
15457
  },
15190
15458
  {
15191
- "kind": "method",
15192
- "name": "destroy",
15193
- "description": "Destroys the datasource, resetting it to its initial state.",
15194
- "privacy": "public",
15459
+ "kind": "field",
15460
+ "name": "connect",
15461
+ "type": {
15462
+ "text": "Connect"
15463
+ },
15195
15464
  "inheritedFrom": {
15196
- "name": "GridProBaseDatasource",
15465
+ "name": "GenesisGridDatasourceElement",
15197
15466
  "module": "src/datasource/base.datasource.ts"
15198
15467
  }
15199
15468
  },
15200
15469
  {
15201
- "kind": "method",
15202
- "name": "deinit",
15203
- "description": "Deinitialises the datasource, resetting it to its initial state.",
15204
- "deprecated": "Use `destroy` instead",
15205
- "privacy": "public"
15470
+ "kind": "field",
15471
+ "name": "datasource",
15472
+ "type": {
15473
+ "text": "Datasource"
15474
+ },
15475
+ "inheritedFrom": {
15476
+ "name": "GenesisGridDatasourceElement",
15477
+ "module": "src/datasource/base.datasource.ts"
15478
+ }
15206
15479
  },
15207
15480
  {
15208
- "kind": "method",
15209
- "name": "reset",
15210
- "description": "Resets the datasource to its initial state.",
15211
- "privacy": "public",
15212
- "deprecated": "Use `destroy` instead"
15481
+ "kind": "field",
15482
+ "name": "deferredGridOptions",
15483
+ "type": {
15484
+ "text": "GridOptions"
15485
+ },
15486
+ "inheritedFrom": {
15487
+ "name": "GenesisGridDatasourceElement",
15488
+ "module": "src/datasource/base.datasource.ts"
15489
+ }
15213
15490
  },
15214
15491
  {
15215
- "kind": "method",
15216
- "name": "restart",
15217
- "description": "Restarts the datasource, uses `destroy` and `init` in sequence.",
15218
- "privacy": "public",
15492
+ "kind": "field",
15493
+ "name": "deferredColumnStates",
15494
+ "type": {
15495
+ "text": "ColumnState[]"
15496
+ },
15219
15497
  "inheritedFrom": {
15220
- "name": "GridProBaseDatasource",
15498
+ "name": "GenesisGridDatasourceElement",
15221
15499
  "module": "src/datasource/base.datasource.ts"
15222
15500
  }
15223
15501
  },
15224
15502
  {
15225
- "kind": "method",
15226
- "name": "refreshRows",
15227
- "description": "Force the grid to redispatch the current rows"
15503
+ "kind": "field",
15504
+ "name": "rowDataMapper",
15505
+ "type": {
15506
+ "text": "Function"
15507
+ },
15508
+ "description": "Allows grid data updates to be processed via and external function before applying in grid",
15509
+ "inheritedFrom": {
15510
+ "name": "GenesisGridDatasourceElement",
15511
+ "module": "src/datasource/base.datasource.ts"
15512
+ }
15228
15513
  },
15229
15514
  {
15230
- "kind": "method",
15231
- "name": "reloadResourceData",
15232
- "privacy": "public",
15233
- "return": {
15234
- "type": {
15235
- "text": "Promise<void>"
15236
- }
15515
+ "kind": "field",
15516
+ "name": "criteria",
15517
+ "type": {
15518
+ "text": "string"
15237
15519
  },
15238
- "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).",
15520
+ "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
15239
15521
  "inheritedFrom": {
15240
- "name": "GridProBaseDatasource",
15522
+ "name": "GenesisGridDatasourceElement",
15241
15523
  "module": "src/datasource/base.datasource.ts"
15242
15524
  }
15243
15525
  },
15244
15526
  {
15245
- "kind": "method",
15246
- "name": "handleSnapshot",
15247
- "privacy": "private",
15248
- "parameters": [
15249
- {
15250
- "name": "result"
15251
- }
15252
- ]
15527
+ "kind": "field",
15528
+ "name": "isSnapshot",
15529
+ "type": {
15530
+ "text": "boolean"
15531
+ },
15532
+ "default": "false",
15533
+ "description": "Request a snapshot from the server.",
15534
+ "inheritedFrom": {
15535
+ "name": "GenesisGridDatasourceElement",
15536
+ "module": "src/datasource/base.datasource.ts"
15537
+ }
15253
15538
  },
15254
15539
  {
15255
- "kind": "method",
15256
- "name": "handleStreamResult",
15257
- "privacy": "private",
15258
- "parameters": [
15259
- {
15260
- "name": "result",
15261
- "type": {
15262
- "text": "FilteredDataServerResult | RequestServerResult"
15263
- }
15264
- }
15265
- ]
15540
+ "kind": "field",
15541
+ "name": "maxRows",
15542
+ "type": {
15543
+ "text": "number"
15544
+ },
15545
+ "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
15546
+ "inheritedFrom": {
15547
+ "name": "GenesisGridDatasourceElement",
15548
+ "module": "src/datasource/base.datasource.ts"
15549
+ }
15266
15550
  },
15267
15551
  {
15268
- "kind": "method",
15269
- "name": "updateLoadMoreStatus",
15270
- "privacy": "private",
15271
- "parameters": [
15272
- {
15273
- "name": "moreRows",
15274
- "type": {
15275
- "text": "boolean"
15276
- },
15277
- "description": "Whether more rows are available"
15278
- },
15279
- {
15280
- "name": "sourceRef",
15281
- "type": {
15282
- "text": "string"
15283
- },
15284
- "description": "The source reference"
15285
- },
15286
- {
15287
- "description": "The total number of rows",
15288
- "name": "rowsCount"
15289
- }
15290
- ],
15291
- "description": "Updates the status bar based on more rows status"
15552
+ "kind": "field",
15553
+ "name": "orderBy",
15554
+ "type": {
15555
+ "text": "string"
15556
+ },
15557
+ "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.",
15558
+ "inheritedFrom": {
15559
+ "name": "GenesisGridDatasourceElement",
15560
+ "module": "src/datasource/base.datasource.ts"
15561
+ }
15292
15562
  },
15293
15563
  {
15294
- "kind": "method",
15295
- "name": "applyRequestServerData",
15296
- "privacy": "private",
15297
- "parameters": [
15298
- {
15299
- "name": "requestServerResult",
15300
- "type": {
15301
- "text": "RequestServerResult"
15302
- }
15303
- }
15304
- ]
15564
+ "kind": "field",
15565
+ "name": "resourceName",
15566
+ "type": {
15567
+ "text": "string"
15568
+ },
15569
+ "description": "The name of the target Data Server query or Request Server requestReply.",
15570
+ "inheritedFrom": {
15571
+ "name": "GenesisGridDatasourceElement",
15572
+ "module": "src/datasource/base.datasource.ts"
15573
+ }
15305
15574
  },
15306
15575
  {
15307
- "kind": "method",
15308
- "name": "applyDataserverData",
15309
- "privacy": "private",
15310
- "parameters": [
15311
- {
15312
- "name": "dataServerResult",
15313
- "type": {
15314
- "text": "FilteredDataServerResult"
15315
- }
15316
- }
15317
- ]
15576
+ "kind": "field",
15577
+ "name": "viewNumber",
15578
+ "type": {
15579
+ "text": "number"
15580
+ },
15581
+ "description": "The desired view/page you want data from.",
15582
+ "inheritedFrom": {
15583
+ "name": "GenesisGridDatasourceElement",
15584
+ "module": "src/datasource/base.datasource.ts"
15585
+ }
15318
15586
  },
15319
15587
  {
15320
- "kind": "method",
15321
- "name": "getAgColumnDefs",
15322
- "privacy": "private",
15323
- "parameters": [
15324
- {
15325
- "name": "fieldsMetadata",
15326
- "type": {
15327
- "text": "FieldMetadata[]"
15328
- }
15329
- }
15330
- ]
15588
+ "kind": "field",
15589
+ "name": "fields",
15590
+ "type": {
15591
+ "text": "string"
15592
+ },
15593
+ "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.",
15594
+ "inheritedFrom": {
15595
+ "name": "GenesisGridDatasourceElement",
15596
+ "module": "src/datasource/base.datasource.ts"
15597
+ }
15331
15598
  },
15332
15599
  {
15333
- "kind": "method",
15334
- "name": "setFilter",
15335
- "privacy": "public",
15336
- "parameters": [
15337
- {
15338
- "name": "fieldName",
15339
- "type": {
15340
- "text": "string"
15341
- }
15342
- },
15343
- {
15344
- "name": "newFilter",
15345
- "type": {
15346
- "text": "string"
15347
- }
15348
- }
15349
- ],
15600
+ "kind": "field",
15601
+ "name": "maxView",
15602
+ "type": {
15603
+ "text": "number"
15604
+ },
15605
+ "description": "Maximum number of rows to track as part of a client \"view\".",
15350
15606
  "inheritedFrom": {
15351
15607
  "name": "GenesisGridDatasourceElement",
15352
15608
  "module": "src/datasource/base.datasource.ts"
15353
15609
  }
15354
15610
  },
15355
15611
  {
15356
- "kind": "method",
15357
- "name": "removeFilter",
15358
- "privacy": "public",
15359
- "parameters": [
15360
- {
15361
- "name": "fieldName",
15362
- "type": {
15363
- "text": "string"
15364
- }
15365
- }
15366
- ],
15612
+ "kind": "field",
15613
+ "name": "movingView",
15614
+ "type": {
15615
+ "text": "boolean"
15616
+ },
15617
+ "default": "false",
15618
+ "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.",
15367
15619
  "inheritedFrom": {
15368
15620
  "name": "GenesisGridDatasourceElement",
15369
15621
  "module": "src/datasource/base.datasource.ts"
15370
15622
  }
15371
15623
  },
15372
15624
  {
15373
- "kind": "method",
15374
- "name": "applyTransaction",
15375
- "privacy": "protected",
15376
- "return": {
15377
- "type": {
15378
- "text": "any"
15379
- }
15625
+ "kind": "field",
15626
+ "name": "reverse",
15627
+ "type": {
15628
+ "text": "boolean"
15380
15629
  },
15381
- "parameters": [
15382
- {
15383
- "name": "transaction",
15384
- "type": {
15385
- "text": "any"
15386
- }
15387
- }
15388
- ],
15630
+ "default": "false",
15631
+ "description": "Option that changes the Data Server index iteration.",
15389
15632
  "inheritedFrom": {
15390
- "name": "GridProBaseDatasource",
15633
+ "name": "GenesisGridDatasourceElement",
15391
15634
  "module": "src/datasource/base.datasource.ts"
15392
15635
  }
15393
15636
  },
15394
15637
  {
15395
- "kind": "method",
15396
- "name": "handleSizeChanged",
15397
- "privacy": "private",
15398
- "parameters": [
15399
- {
15400
- "name": "oldSize",
15401
- "type": {
15402
- "text": "number"
15403
- }
15404
- },
15405
- {
15406
- "name": "newSize",
15407
- "type": {
15408
- "text": "number"
15409
- }
15410
- }
15411
- ]
15412
- },
15413
- {
15414
- "kind": "method",
15415
- "name": "handleStreamInserts",
15416
- "privacy": "protected",
15417
- "parameters": [
15418
- {
15419
- "name": "inserts",
15420
- "default": "[]"
15421
- }
15422
- ],
15423
- "inheritedFrom": {
15424
- "name": "GridProBaseDatasource",
15425
- "module": "src/datasource/base.datasource.ts"
15426
- }
15427
- },
15428
- {
15429
- "kind": "method",
15430
- "name": "handleStreamUpdates",
15431
- "privacy": "protected",
15432
- "parameters": [
15433
- {
15434
- "name": "updates",
15435
- "default": "[]"
15436
- }
15437
- ],
15638
+ "kind": "field",
15639
+ "name": "disablePolling",
15640
+ "type": {
15641
+ "text": "boolean"
15642
+ },
15643
+ "default": "false",
15644
+ "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
15438
15645
  "inheritedFrom": {
15439
- "name": "GridProBaseDatasource",
15646
+ "name": "GenesisGridDatasourceElement",
15440
15647
  "module": "src/datasource/base.datasource.ts"
15441
15648
  }
15442
15649
  },
15443
15650
  {
15444
- "kind": "method",
15445
- "name": "handleStreamDeletes",
15446
- "privacy": "protected",
15447
- "parameters": [
15448
- {
15449
- "name": "deletes",
15450
- "default": "[]",
15451
- "description": "List of records to remove from the grid stream"
15452
- }
15453
- ],
15454
- "description": "Handles stream deletes by removing records from the grid.",
15651
+ "kind": "field",
15652
+ "name": "offset",
15653
+ "type": {
15654
+ "text": "number"
15655
+ },
15656
+ "description": "The offset for pagination in REQUEST_SERVER scenarios.",
15455
15657
  "inheritedFrom": {
15456
- "name": "GridProBaseDatasource",
15658
+ "name": "GenesisGridDatasourceElement",
15457
15659
  "module": "src/datasource/base.datasource.ts"
15458
15660
  }
15459
15661
  },
15460
15662
  {
15461
- "kind": "method",
15462
- "name": "loadMore",
15663
+ "kind": "field",
15664
+ "name": "pollingInterval",
15665
+ "type": {
15666
+ "text": "number"
15667
+ },
15668
+ "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
15463
15669
  "inheritedFrom": {
15464
- "name": "GridProBaseDatasource",
15670
+ "name": "GenesisGridDatasourceElement",
15465
15671
  "module": "src/datasource/base.datasource.ts"
15466
15672
  }
15467
15673
  },
15468
15674
  {
15469
- "kind": "method",
15470
- "name": "cloneNode",
15471
- "return": {
15472
- "type": {
15473
- "text": "Node"
15474
- }
15675
+ "kind": "field",
15676
+ "name": "pollTriggerEvents",
15677
+ "type": {
15678
+ "text": "string[]"
15475
15679
  },
15476
- "parameters": [
15477
- {
15478
- "name": "deep",
15479
- "optional": true,
15480
- "type": {
15481
- "text": "boolean"
15482
- }
15483
- }
15484
- ],
15680
+ "default": "[]",
15681
+ "description": "Array of event names that will trigger a poll when received as commit responses.",
15485
15682
  "inheritedFrom": {
15486
- "name": "LifecycleMixin",
15487
- "module": "src/mixins/lifecycle/lifecycle.ts"
15683
+ "name": "GenesisGridDatasourceElement",
15684
+ "module": "src/datasource/base.datasource.ts"
15488
15685
  }
15489
15686
  },
15490
15687
  {
15491
15688
  "kind": "field",
15492
- "name": "shouldRunDisconnect",
15493
- "return": {
15494
- "type": {
15495
- "text": ""
15496
- }
15689
+ "name": "request",
15690
+ "type": {
15691
+ "text": "any"
15497
15692
  },
15498
- "readonly": true,
15693
+ "description": "Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.",
15499
15694
  "inheritedFrom": {
15500
- "name": "LifecycleMixin",
15501
- "module": "src/mixins/lifecycle/lifecycle.ts"
15695
+ "name": "GenesisGridDatasourceElement",
15696
+ "module": "src/datasource/base.datasource.ts"
15502
15697
  }
15503
15698
  },
15504
15699
  {
15505
15700
  "kind": "field",
15506
- "name": "shouldRunConnect",
15507
- "return": {
15508
- "type": {
15509
- "text": ""
15510
- }
15701
+ "name": "requestAutoSetup",
15702
+ "type": {
15703
+ "text": "boolean"
15511
15704
  },
15512
- "readonly": true,
15705
+ "default": "true",
15706
+ "description": "Attribute to set whether the REQUEST object should be automatically set up.",
15513
15707
  "inheritedFrom": {
15514
- "name": "LifecycleMixin",
15515
- "module": "src/mixins/lifecycle/lifecycle.ts"
15708
+ "name": "GenesisGridDatasourceElement",
15709
+ "module": "src/datasource/base.datasource.ts"
15516
15710
  }
15517
15711
  },
15518
15712
  {
15519
- "kind": "method",
15520
- "name": "#_blockLifecycleDueToTokenChange",
15521
- "return": {
15522
- "type": {
15523
- "text": "boolean"
15524
- }
15525
- },
15526
- "parameters": [
15527
- {
15528
- "name": "lifecycleType",
15529
- "type": {
15530
- "text": "Lifecycletype"
15531
- }
15532
- }
15533
- ],
15713
+ "kind": "field",
15714
+ "name": "rowIdAttr",
15715
+ "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
15534
15716
  "inheritedFrom": {
15535
- "name": "LifecycleMixin",
15536
- "module": "src/mixins/lifecycle/lifecycle.ts"
15717
+ "name": "GenesisGridDatasourceElement",
15718
+ "module": "src/datasource/base.datasource.ts"
15537
15719
  }
15538
15720
  },
15539
15721
  {
15540
15722
  "kind": "field",
15541
- "name": "dataSubWasLoggedOff",
15723
+ "name": "restartOnReconnection",
15542
15724
  "type": {
15543
15725
  "text": "boolean"
15544
15726
  },
15545
- "privacy": "protected",
15546
- "default": "false",
15727
+ "default": "true",
15728
+ "description": "Attribute to set whether the datasource should restart when it reconnects.",
15547
15729
  "inheritedFrom": {
15548
- "name": "GridProBaseDatasource",
15730
+ "name": "GenesisGridDatasourceElement",
15549
15731
  "module": "src/datasource/base.datasource.ts"
15550
15732
  }
15551
15733
  },
15552
15734
  {
15553
15735
  "kind": "field",
15554
- "name": "rowData",
15736
+ "name": "defaultRowIdByResourceType",
15555
15737
  "type": {
15556
- "text": "Map<string, any>"
15738
+ "text": "string"
15557
15739
  },
15558
- "default": "new Map()",
15740
+ "privacy": "protected",
15741
+ "readonly": true,
15559
15742
  "inheritedFrom": {
15560
- "name": "GridProBaseDatasource",
15743
+ "name": "GenesisGridDatasourceElement",
15561
15744
  "module": "src/datasource/base.datasource.ts"
15562
15745
  }
15563
15746
  },
15564
15747
  {
15565
15748
  "kind": "field",
15566
- "name": "connectionSub",
15749
+ "name": "criteriaFromFilters",
15567
15750
  "type": {
15568
- "text": "Subscription | undefined"
15751
+ "text": "Map<string, string>"
15569
15752
  },
15570
15753
  "privacy": "protected",
15754
+ "default": "new Map()",
15571
15755
  "inheritedFrom": {
15572
- "name": "GridProBaseDatasource",
15756
+ "name": "GenesisGridDatasourceElement",
15573
15757
  "module": "src/datasource/base.datasource.ts"
15574
15758
  }
15575
15759
  },
15576
15760
  {
15577
- "kind": "method",
15578
- "name": "subscribeToConnection",
15761
+ "kind": "field",
15762
+ "name": "update",
15763
+ "type": {
15764
+ "text": "BehaviorSubject<Map<string, string>>"
15765
+ },
15579
15766
  "privacy": "protected",
15767
+ "default": "new BehaviorSubject(new Map())",
15580
15768
  "inheritedFrom": {
15581
- "name": "GridProBaseDatasource",
15769
+ "name": "GenesisGridDatasourceElement",
15582
15770
  "module": "src/datasource/base.datasource.ts"
15583
15771
  }
15584
15772
  },
15585
15773
  {
15586
15774
  "kind": "method",
15587
- "name": "unsubscribeFromConnection",
15775
+ "name": "datasourceOptions",
15588
15776
  "privacy": "protected",
15777
+ "return": {
15778
+ "type": {
15779
+ "text": "DatasourceOptions"
15780
+ }
15781
+ },
15589
15782
  "inheritedFrom": {
15590
- "name": "GridProBaseDatasource",
15783
+ "name": "GenesisGridDatasourceElement",
15591
15784
  "module": "src/datasource/base.datasource.ts"
15592
15785
  }
15593
15786
  },
15594
15787
  {
15595
15788
  "kind": "method",
15596
- "name": "generateColumnDefsFromMetadata",
15597
- "privacy": "protected",
15789
+ "name": "buildCriteria",
15790
+ "privacy": "private",
15598
15791
  "return": {
15599
15792
  "type": {
15600
- "text": "ColDef[]"
15793
+ "text": "string"
15601
15794
  }
15602
15795
  },
15603
- "parameters": [
15604
- {
15605
- "name": "fieldsMetadata",
15606
- "type": {
15607
- "text": "FieldMetadata[]"
15608
- }
15609
- },
15610
- {
15611
- "name": "getFilterParamsByFieldType",
15612
- "type": {
15613
- "text": "Function"
15614
- }
15615
- }
15616
- ],
15617
15796
  "inheritedFrom": {
15618
- "name": "GridProBaseDatasource",
15797
+ "name": "GenesisGridDatasourceElement",
15619
15798
  "module": "src/datasource/base.datasource.ts"
15620
15799
  }
15621
15800
  },
15622
15801
  {
15623
- "kind": "method",
15624
- "name": "applyAllTransactions",
15625
- "privacy": "protected",
15802
+ "kind": "field",
15803
+ "name": "isRequestServer",
15804
+ "type": {
15805
+ "text": "boolean"
15806
+ },
15807
+ "readonly": true,
15626
15808
  "inheritedFrom": {
15627
- "name": "GridProBaseDatasource",
15809
+ "name": "GenesisGridDatasourceElement",
15628
15810
  "module": "src/datasource/base.datasource.ts"
15629
15811
  }
15630
15812
  },
15631
15813
  {
15632
15814
  "kind": "method",
15633
- "name": "applyMappedTransaction",
15634
- "privacy": "private",
15815
+ "name": "datasourceStatusChanged",
15635
15816
  "parameters": [
15636
15817
  {
15637
- "name": "transaction",
15818
+ "name": "prev",
15638
15819
  "type": {
15639
- "text": "TransactionData"
15820
+ "text": "DatasourceStatus"
15640
15821
  }
15641
15822
  },
15642
15823
  {
15643
- "name": "operation",
15824
+ "name": "next",
15644
15825
  "type": {
15645
- "text": "OperationType"
15826
+ "text": "DatasourceStatus"
15646
15827
  }
15647
15828
  }
15648
15829
  ],
15649
15830
  "inheritedFrom": {
15650
- "name": "GridProBaseDatasource",
15831
+ "name": "GenesisGridDatasourceElement",
15651
15832
  "module": "src/datasource/base.datasource.ts"
15652
15833
  }
15653
15834
  },
15654
15835
  {
15655
15836
  "kind": "method",
15656
- "name": "mapTransaction",
15657
- "privacy": "private",
15837
+ "name": "handleErrors",
15658
15838
  "parameters": [
15659
15839
  {
15660
- "name": "transaction",
15840
+ "name": "errors",
15661
15841
  "type": {
15662
- "text": "TransactionData"
15842
+ "text": "string | any[]"
15663
15843
  },
15664
- "description": "The transaction data to be mapped."
15844
+ "description": "The error message or array of error messages"
15665
15845
  },
15666
15846
  {
15667
- "name": "operations",
15668
- "default": "Object.values(OperationType)",
15847
+ "name": "type",
15848
+ "default": "'unknown'",
15669
15849
  "type": {
15670
- "text": "OperationType[]"
15850
+ "text": "BaseDatasourceErrorEventDetail['type']"
15671
15851
  },
15672
- "description": "The operations to be mapped. Can be 'add', 'update' or 'remove'."
15852
+ "description": "The type of error that occurred"
15673
15853
  }
15674
15854
  ],
15675
- "description": "Maps the transaction data to the row data mapper function, if it exists.",
15676
- "return": {
15677
- "type": {
15678
- "text": ""
15679
- }
15680
- },
15855
+ "description": "Handles errors and emits appropriate error events.",
15856
+ "privacy": "public",
15681
15857
  "inheritedFrom": {
15682
- "name": "GridProBaseDatasource",
15858
+ "name": "GenesisGridDatasourceElement",
15683
15859
  "module": "src/datasource/base.datasource.ts"
15684
15860
  }
15685
15861
  },
15686
15862
  {
15687
- "kind": "field",
15688
- "name": "pagination",
15689
- "type": {
15690
- "text": "boolean"
15691
- },
15692
- "privacy": "protected",
15863
+ "kind": "method",
15864
+ "name": "clearErrors",
15865
+ "description": "Clears error state and emits connected event.",
15866
+ "privacy": "public",
15693
15867
  "inheritedFrom": {
15694
- "name": "GridProBaseDatasource",
15868
+ "name": "GenesisGridDatasourceElement",
15695
15869
  "module": "src/datasource/base.datasource.ts"
15696
15870
  }
15697
15871
  },
15698
15872
  {
15699
15873
  "kind": "field",
15700
- "name": "_isDisconnected",
15874
+ "name": "_presentation",
15701
15875
  "type": {
15702
- "text": "boolean"
15876
+ "text": "ComponentPresentation | null | undefined"
15703
15877
  },
15704
15878
  "privacy": "private",
15705
- "default": "false",
15879
+ "default": "void 0",
15706
15880
  "inheritedFrom": {
15707
- "name": "GridProBaseDatasource",
15708
- "module": "src/datasource/base.datasource.ts"
15881
+ "name": "FoundationElement",
15882
+ "module": "src/foundation-element/foundation-element.ts"
15709
15883
  }
15710
15884
  },
15711
15885
  {
15712
- "kind": "method",
15713
- "name": "setDisconnected",
15886
+ "kind": "field",
15887
+ "name": "$presentation",
15888
+ "type": {
15889
+ "text": "ComponentPresentation | null"
15890
+ },
15714
15891
  "privacy": "public",
15715
- "parameters": [
15716
- {
15717
- "name": "disconnected",
15718
- "type": {
15719
- "text": "boolean"
15720
- },
15721
- "description": "true to set, false to remove"
15722
- }
15723
- ],
15724
- "description": "Sets the disconnected state and emits appropriate events.",
15892
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
15725
15893
  "inheritedFrom": {
15726
- "name": "GridProBaseDatasource",
15727
- "module": "src/datasource/base.datasource.ts"
15894
+ "name": "FoundationElement",
15895
+ "module": "src/foundation-element/foundation-element.ts"
15728
15896
  }
15729
15897
  },
15730
15898
  {
15731
- "kind": "method",
15732
- "name": "isDisconnected",
15733
- "privacy": "public",
15734
- "return": {
15735
- "type": {
15736
- "text": "boolean"
15737
- }
15899
+ "kind": "field",
15900
+ "name": "template",
15901
+ "type": {
15902
+ "text": "ElementViewTemplate | void | null"
15738
15903
  },
15739
- "description": "Returns true if the datasource is disconnected.",
15904
+ "privacy": "public",
15905
+ "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.",
15740
15906
  "inheritedFrom": {
15741
- "name": "GridProBaseDatasource",
15742
- "module": "src/datasource/base.datasource.ts"
15907
+ "name": "FoundationElement",
15908
+ "module": "src/foundation-element/foundation-element.ts"
15743
15909
  }
15744
15910
  },
15745
15911
  {
15746
15912
  "kind": "method",
15747
- "name": "getDatasourceStatusBarPanels",
15748
- "privacy": "public",
15913
+ "name": "templateChanged",
15914
+ "privacy": "protected",
15749
15915
  "return": {
15750
15916
  "type": {
15751
- "text": "any[]"
15752
- }
15753
- },
15754
- "parameters": [
15755
- {
15756
- "name": "isServerSide",
15757
- "type": {
15758
- "text": "boolean"
15759
- }
15760
- },
15761
- {
15762
- "name": "statusBarConfig",
15763
- "type": {
15764
- "text": "any"
15765
- }
15917
+ "text": "void"
15766
15918
  }
15767
- ],
15768
- "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.",
15769
- "inheritedFrom": {
15770
- "name": "GridProBaseDatasource",
15771
- "module": "src/datasource/base.datasource.ts"
15772
- }
15773
- },
15774
- {
15775
- "kind": "field",
15776
- "name": "connect",
15777
- "type": {
15778
- "text": "Connect"
15779
15919
  },
15780
15920
  "inheritedFrom": {
15781
- "name": "GenesisGridDatasourceElement",
15782
- "module": "src/datasource/base.datasource.ts"
15921
+ "name": "FoundationElement",
15922
+ "module": "src/foundation-element/foundation-element.ts"
15783
15923
  }
15784
15924
  },
15785
15925
  {
15786
15926
  "kind": "field",
15787
- "name": "datasource",
15927
+ "name": "styles",
15788
15928
  "type": {
15789
- "text": "Datasource"
15929
+ "text": "ElementStyles | void | null"
15790
15930
  },
15931
+ "privacy": "public",
15932
+ "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.",
15791
15933
  "inheritedFrom": {
15792
- "name": "GenesisGridDatasourceElement",
15793
- "module": "src/datasource/base.datasource.ts"
15934
+ "name": "FoundationElement",
15935
+ "module": "src/foundation-element/foundation-element.ts"
15794
15936
  }
15795
15937
  },
15796
15938
  {
15797
- "kind": "field",
15798
- "name": "deferredGridOptions",
15799
- "type": {
15800
- "text": "GridOptions"
15939
+ "kind": "method",
15940
+ "name": "stylesChanged",
15941
+ "privacy": "protected",
15942
+ "return": {
15943
+ "type": {
15944
+ "text": "void"
15945
+ }
15801
15946
  },
15802
15947
  "inheritedFrom": {
15803
- "name": "GenesisGridDatasourceElement",
15804
- "module": "src/datasource/base.datasource.ts"
15948
+ "name": "FoundationElement",
15949
+ "module": "src/foundation-element/foundation-element.ts"
15805
15950
  }
15806
15951
  },
15807
15952
  {
15808
- "kind": "field",
15809
- "name": "deferredColumnStates",
15810
- "type": {
15811
- "text": "ColumnState[]"
15953
+ "kind": "method",
15954
+ "name": "compose",
15955
+ "privacy": "public",
15956
+ "static": true,
15957
+ "return": {
15958
+ "type": {
15959
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
15960
+ }
15812
15961
  },
15962
+ "parameters": [
15963
+ {
15964
+ "name": "this",
15965
+ "type": {
15966
+ "text": "K"
15967
+ }
15968
+ },
15969
+ {
15970
+ "name": "elementDefinition",
15971
+ "type": {
15972
+ "text": "T"
15973
+ },
15974
+ "description": "The definition of the element to create the registry\nfunction for."
15975
+ }
15976
+ ],
15977
+ "description": "Defines an element registry function with a set of element definition defaults.",
15813
15978
  "inheritedFrom": {
15814
- "name": "GenesisGridDatasourceElement",
15815
- "module": "src/datasource/base.datasource.ts"
15979
+ "name": "FoundationElement",
15980
+ "module": "src/foundation-element/foundation-element.ts"
15816
15981
  }
15817
- },
15982
+ }
15983
+ ],
15984
+ "attributes": [
15818
15985
  {
15819
- "kind": "field",
15820
- "name": "rowDataMapper",
15986
+ "name": "keep-col-defs-on-clear-row-data",
15821
15987
  "type": {
15822
- "text": "Function"
15988
+ "text": "boolean"
15823
15989
  },
15824
- "description": "Allows grid data updates to be processed via and external function before applying in grid",
15825
- "inheritedFrom": {
15826
- "name": "GenesisGridDatasourceElement",
15827
- "module": "src/datasource/base.datasource.ts"
15828
- }
15990
+ "default": "false",
15991
+ "fieldName": "keepColDefsOnClearRowData"
15829
15992
  },
15830
15993
  {
15831
- "kind": "field",
15832
15994
  "name": "criteria",
15833
15995
  "type": {
15834
15996
  "text": "string"
15835
15997
  },
15836
15998
  "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
15999
+ "fieldName": "criteria",
15837
16000
  "inheritedFrom": {
15838
16001
  "name": "GenesisGridDatasourceElement",
15839
16002
  "module": "src/datasource/base.datasource.ts"
15840
16003
  }
15841
16004
  },
15842
16005
  {
15843
- "kind": "field",
15844
- "name": "isSnapshot",
16006
+ "name": "is-snapshot",
15845
16007
  "type": {
15846
16008
  "text": "boolean"
15847
16009
  },
15848
16010
  "default": "false",
15849
16011
  "description": "Request a snapshot from the server.",
16012
+ "fieldName": "isSnapshot",
15850
16013
  "inheritedFrom": {
15851
16014
  "name": "GenesisGridDatasourceElement",
15852
16015
  "module": "src/datasource/base.datasource.ts"
15853
16016
  }
15854
16017
  },
15855
16018
  {
15856
- "kind": "field",
15857
- "name": "maxRows",
16019
+ "name": "max-rows",
15858
16020
  "type": {
15859
16021
  "text": "number"
15860
16022
  },
15861
16023
  "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
16024
+ "fieldName": "maxRows",
15862
16025
  "inheritedFrom": {
15863
16026
  "name": "GenesisGridDatasourceElement",
15864
16027
  "module": "src/datasource/base.datasource.ts"
15865
16028
  }
15866
16029
  },
15867
16030
  {
15868
- "kind": "field",
15869
- "name": "orderBy",
16031
+ "name": "order-by",
15870
16032
  "type": {
15871
16033
  "text": "string"
15872
16034
  },
15873
16035
  "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.",
16036
+ "fieldName": "orderBy",
15874
16037
  "inheritedFrom": {
15875
16038
  "name": "GenesisGridDatasourceElement",
15876
16039
  "module": "src/datasource/base.datasource.ts"
15877
16040
  }
15878
16041
  },
15879
16042
  {
15880
- "kind": "field",
15881
- "name": "resourceName",
16043
+ "name": "resource-name",
15882
16044
  "type": {
15883
16045
  "text": "string"
15884
16046
  },
15885
16047
  "description": "The name of the target Data Server query or Request Server requestReply.",
16048
+ "fieldName": "resourceName",
15886
16049
  "inheritedFrom": {
15887
16050
  "name": "GenesisGridDatasourceElement",
15888
16051
  "module": "src/datasource/base.datasource.ts"
15889
16052
  }
15890
16053
  },
15891
16054
  {
15892
- "kind": "field",
15893
- "name": "viewNumber",
16055
+ "name": "view-number",
15894
16056
  "type": {
15895
16057
  "text": "number"
15896
16058
  },
15897
16059
  "description": "The desired view/page you want data from.",
16060
+ "fieldName": "viewNumber",
15898
16061
  "inheritedFrom": {
15899
16062
  "name": "GenesisGridDatasourceElement",
15900
16063
  "module": "src/datasource/base.datasource.ts"
15901
16064
  }
15902
16065
  },
15903
16066
  {
15904
- "kind": "field",
15905
16067
  "name": "fields",
15906
16068
  "type": {
15907
16069
  "text": "string"
15908
16070
  },
15909
16071
  "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.",
16072
+ "fieldName": "fields",
15910
16073
  "inheritedFrom": {
15911
16074
  "name": "GenesisGridDatasourceElement",
15912
16075
  "module": "src/datasource/base.datasource.ts"
15913
16076
  }
15914
16077
  },
15915
16078
  {
15916
- "kind": "field",
15917
- "name": "maxView",
16079
+ "name": "max-view",
15918
16080
  "type": {
15919
16081
  "text": "number"
15920
16082
  },
15921
16083
  "description": "Maximum number of rows to track as part of a client \"view\".",
16084
+ "fieldName": "maxView",
15922
16085
  "inheritedFrom": {
15923
16086
  "name": "GenesisGridDatasourceElement",
15924
16087
  "module": "src/datasource/base.datasource.ts"
15925
16088
  }
15926
16089
  },
15927
16090
  {
15928
- "kind": "field",
15929
- "name": "movingView",
16091
+ "name": "moving-view",
15930
16092
  "type": {
15931
16093
  "text": "boolean"
15932
16094
  },
15933
16095
  "default": "false",
15934
16096
  "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.",
16097
+ "fieldName": "movingView",
15935
16098
  "inheritedFrom": {
15936
16099
  "name": "GenesisGridDatasourceElement",
15937
16100
  "module": "src/datasource/base.datasource.ts"
15938
16101
  }
15939
16102
  },
15940
16103
  {
15941
- "kind": "field",
15942
- "name": "reverse",
15943
16104
  "type": {
15944
- "text": "boolean"
16105
+ "text": "number"
15945
16106
  },
15946
- "default": "false",
15947
16107
  "description": "Option that changes the Data Server index iteration.",
16108
+ "fieldName": "reverse",
16109
+ "default": "false",
15948
16110
  "inheritedFrom": {
15949
16111
  "name": "GenesisGridDatasourceElement",
15950
16112
  "module": "src/datasource/base.datasource.ts"
15951
16113
  }
15952
16114
  },
15953
16115
  {
15954
- "kind": "field",
15955
- "name": "disablePolling",
16116
+ "name": "disable-polling",
15956
16117
  "type": {
15957
16118
  "text": "boolean"
15958
16119
  },
15959
16120
  "default": "false",
15960
16121
  "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
16122
+ "fieldName": "disablePolling",
15961
16123
  "inheritedFrom": {
15962
16124
  "name": "GenesisGridDatasourceElement",
15963
16125
  "module": "src/datasource/base.datasource.ts"
15964
16126
  }
15965
16127
  },
15966
16128
  {
15967
- "kind": "field",
15968
- "name": "offset",
16129
+ "name": "polling-interval",
15969
16130
  "type": {
15970
16131
  "text": "number"
15971
16132
  },
15972
- "description": "The offset for pagination in REQUEST_SERVER scenarios.",
16133
+ "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
16134
+ "fieldName": "pollingInterval",
15973
16135
  "inheritedFrom": {
15974
16136
  "name": "GenesisGridDatasourceElement",
15975
16137
  "module": "src/datasource/base.datasource.ts"
15976
16138
  }
15977
16139
  },
15978
16140
  {
15979
- "kind": "field",
15980
- "name": "pollingInterval",
16141
+ "name": "request-auto-setup",
15981
16142
  "type": {
15982
- "text": "number"
16143
+ "text": "boolean"
15983
16144
  },
15984
- "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
16145
+ "default": "true",
16146
+ "description": "Attribute to set whether the REQUEST object should be automatically set up.",
16147
+ "fieldName": "requestAutoSetup",
15985
16148
  "inheritedFrom": {
15986
16149
  "name": "GenesisGridDatasourceElement",
15987
16150
  "module": "src/datasource/base.datasource.ts"
15988
16151
  }
15989
16152
  },
15990
16153
  {
15991
- "kind": "field",
15992
- "name": "pollTriggerEvents",
15993
- "type": {
15994
- "text": "string[]"
15995
- },
15996
- "default": "[]",
15997
- "description": "Array of event names that will trigger a poll when received as commit responses.",
16154
+ "name": "row-id",
16155
+ "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
16156
+ "fieldName": "rowIdAttr",
15998
16157
  "inheritedFrom": {
15999
16158
  "name": "GenesisGridDatasourceElement",
16000
16159
  "module": "src/datasource/base.datasource.ts"
16001
16160
  }
16002
16161
  },
16003
16162
  {
16004
- "kind": "field",
16005
- "name": "request",
16006
- "type": {
16007
- "text": "any"
16008
- },
16009
- "description": "Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.",
16010
- "inheritedFrom": {
16011
- "name": "GenesisGridDatasourceElement",
16012
- "module": "src/datasource/base.datasource.ts"
16013
- }
16014
- },
16015
- {
16016
- "kind": "field",
16017
- "name": "requestAutoSetup",
16018
- "type": {
16019
- "text": "boolean"
16020
- },
16021
- "default": "true",
16022
- "description": "Attribute to set whether the REQUEST object should be automatically set up.",
16023
- "inheritedFrom": {
16024
- "name": "GenesisGridDatasourceElement",
16025
- "module": "src/datasource/base.datasource.ts"
16026
- }
16027
- },
16028
- {
16029
- "kind": "field",
16030
- "name": "rowIdAttr",
16031
- "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
16032
- "inheritedFrom": {
16033
- "name": "GenesisGridDatasourceElement",
16034
- "module": "src/datasource/base.datasource.ts"
16035
- }
16036
- },
16037
- {
16038
- "kind": "field",
16039
- "name": "restartOnReconnection",
16163
+ "name": "restart-on-reconnection",
16040
16164
  "type": {
16041
16165
  "text": "boolean"
16042
16166
  },
16043
16167
  "default": "true",
16044
16168
  "description": "Attribute to set whether the datasource should restart when it reconnects.",
16169
+ "fieldName": "restartOnReconnection",
16045
16170
  "inheritedFrom": {
16046
16171
  "name": "GenesisGridDatasourceElement",
16047
16172
  "module": "src/datasource/base.datasource.ts"
16048
16173
  }
16049
- },
16174
+ }
16175
+ ],
16176
+ "mixins": [
16050
16177
  {
16051
- "kind": "field",
16052
- "name": "defaultRowIdByResourceType",
16053
- "type": {
16054
- "text": "string"
16055
- },
16056
- "privacy": "protected",
16057
- "readonly": true,
16058
- "inheritedFrom": {
16059
- "name": "GenesisGridDatasourceElement",
16060
- "module": "src/datasource/base.datasource.ts"
16061
- }
16062
- },
16178
+ "name": "LifecycleMixin",
16179
+ "package": "@genesislcap/foundation-utils"
16180
+ }
16181
+ ],
16182
+ "superclass": {
16183
+ "name": "GridProBaseDatasource",
16184
+ "module": "/src/datasource/base.datasource"
16185
+ },
16186
+ "tagName": "grid-pro-genesis-datasource",
16187
+ "customElement": true
16188
+ }
16189
+ ],
16190
+ "exports": [
16191
+ {
16192
+ "kind": "js",
16193
+ "name": "GridProGenesisDatasource",
16194
+ "declaration": {
16195
+ "name": "GridProGenesisDatasource",
16196
+ "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
16197
+ }
16198
+ },
16199
+ {
16200
+ "kind": "custom-element-definition",
16201
+ "name": "grid-pro-genesis-datasource",
16202
+ "declaration": {
16203
+ "name": "GridProGenesisDatasource",
16204
+ "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
16205
+ }
16206
+ }
16207
+ ]
16208
+ },
16209
+ {
16210
+ "kind": "javascript-module",
16211
+ "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
16212
+ "declarations": [],
16213
+ "exports": []
16214
+ },
16215
+ {
16216
+ "kind": "javascript-module",
16217
+ "path": "src/grid-pro-genesis-datasource/index.ts",
16218
+ "declarations": [],
16219
+ "exports": [
16220
+ {
16221
+ "kind": "js",
16222
+ "name": "*",
16223
+ "declaration": {
16224
+ "name": "*",
16225
+ "package": "./grid-pro-genesis-datasource.config"
16226
+ }
16227
+ },
16228
+ {
16229
+ "kind": "js",
16230
+ "name": "*",
16231
+ "declaration": {
16232
+ "name": "*",
16233
+ "package": "./grid-pro-genesis-datasource.types"
16234
+ }
16235
+ },
16236
+ {
16237
+ "kind": "js",
16238
+ "name": "*",
16239
+ "declaration": {
16240
+ "name": "*",
16241
+ "package": "./grid-pro-genesis-datasource"
16242
+ }
16243
+ }
16244
+ ]
16245
+ },
16246
+ {
16247
+ "kind": "javascript-module",
16248
+ "path": "src/state-persistence/index.ts",
16249
+ "declarations": [],
16250
+ "exports": [
16251
+ {
16252
+ "kind": "js",
16253
+ "name": "*",
16254
+ "declaration": {
16255
+ "name": "*",
16256
+ "package": "./kv-state"
16257
+ }
16258
+ },
16259
+ {
16260
+ "kind": "js",
16261
+ "name": "*",
16262
+ "declaration": {
16263
+ "name": "*",
16264
+ "package": "./local-state"
16265
+ }
16266
+ },
16267
+ {
16268
+ "kind": "js",
16269
+ "name": "*",
16270
+ "declaration": {
16271
+ "name": "*",
16272
+ "package": "./state-persistence"
16273
+ }
16274
+ }
16275
+ ]
16276
+ },
16277
+ {
16278
+ "kind": "javascript-module",
16279
+ "path": "src/state-persistence/kv-state.ts",
16280
+ "declarations": [
16281
+ {
16282
+ "kind": "class",
16283
+ "description": "Implementation for the KV Storage State Persistence interface.",
16284
+ "name": "KVStorageStatePersistence",
16285
+ "members": [
16063
16286
  {
16064
16287
  "kind": "field",
16065
- "name": "criteriaFromFilters",
16288
+ "name": "kvStorage",
16066
16289
  "type": {
16067
- "text": "Map<string, string>"
16068
- },
16069
- "privacy": "protected",
16070
- "default": "new Map()",
16071
- "inheritedFrom": {
16072
- "name": "GenesisGridDatasourceElement",
16073
- "module": "src/datasource/base.datasource.ts"
16290
+ "text": "KVStorage"
16074
16291
  }
16075
16292
  },
16076
16293
  {
16077
16294
  "kind": "field",
16078
- "name": "update",
16295
+ "name": "session",
16079
16296
  "type": {
16080
- "text": "BehaviorSubject<Map<string, string>>"
16081
- },
16082
- "privacy": "protected",
16083
- "default": "new BehaviorSubject(new Map())",
16084
- "inheritedFrom": {
16085
- "name": "GenesisGridDatasourceElement",
16086
- "module": "src/datasource/base.datasource.ts"
16297
+ "text": "Session"
16087
16298
  }
16088
16299
  },
16089
16300
  {
16090
16301
  "kind": "method",
16091
- "name": "datasourceOptions",
16092
- "privacy": "protected",
16302
+ "name": "getColumnState",
16093
16303
  "return": {
16094
16304
  "type": {
16095
- "text": "DatasourceOptions"
16305
+ "text": "Promise<ColumnState[]>"
16096
16306
  }
16097
16307
  },
16098
- "inheritedFrom": {
16099
- "name": "GenesisGridDatasourceElement",
16100
- "module": "src/datasource/base.datasource.ts"
16101
- }
16308
+ "parameters": [
16309
+ {
16310
+ "name": "persistColumnStateKey",
16311
+ "type": {
16312
+ "text": "string"
16313
+ }
16314
+ }
16315
+ ]
16102
16316
  },
16103
16317
  {
16104
16318
  "kind": "method",
16105
- "name": "buildCriteria",
16106
- "privacy": "private",
16319
+ "name": "saveColumnState",
16107
16320
  "return": {
16108
16321
  "type": {
16109
- "text": "string"
16322
+ "text": "Promise<void>"
16110
16323
  }
16111
16324
  },
16112
- "inheritedFrom": {
16113
- "name": "GenesisGridDatasourceElement",
16114
- "module": "src/datasource/base.datasource.ts"
16115
- }
16116
- },
16117
- {
16118
- "kind": "field",
16119
- "name": "isRequestServer",
16120
- "type": {
16121
- "text": "boolean"
16122
- },
16123
- "readonly": true,
16124
- "inheritedFrom": {
16125
- "name": "GenesisGridDatasourceElement",
16126
- "module": "src/datasource/base.datasource.ts"
16127
- }
16128
- },
16129
- {
16130
- "kind": "method",
16131
- "name": "datasourceStatusChanged",
16132
16325
  "parameters": [
16133
16326
  {
16134
- "name": "prev",
16327
+ "name": "persistColumnStateKey",
16135
16328
  "type": {
16136
- "text": "DatasourceStatus"
16329
+ "text": "string"
16137
16330
  }
16138
16331
  },
16139
16332
  {
16140
- "name": "next",
16333
+ "name": "columnState",
16141
16334
  "type": {
16142
- "text": "DatasourceStatus"
16335
+ "text": "ColumnState[]"
16143
16336
  }
16144
16337
  }
16145
- ],
16146
- "inheritedFrom": {
16147
- "name": "GenesisGridDatasourceElement",
16148
- "module": "src/datasource/base.datasource.ts"
16149
- }
16338
+ ]
16150
16339
  },
16151
16340
  {
16152
16341
  "kind": "method",
16153
- "name": "handleErrors",
16342
+ "name": "deleteColumnState",
16343
+ "return": {
16344
+ "type": {
16345
+ "text": "Promise<void>"
16346
+ }
16347
+ },
16154
16348
  "parameters": [
16155
16349
  {
16156
- "name": "errors",
16157
- "type": {
16158
- "text": "string | any[]"
16159
- },
16160
- "description": "The error message or array of error messages"
16161
- },
16162
- {
16163
- "name": "type",
16164
- "default": "'unknown'",
16350
+ "name": "persistColumnStateKey",
16165
16351
  "type": {
16166
- "text": "BaseDatasourceErrorEventDetail['type']"
16167
- },
16168
- "description": "The type of error that occurred"
16169
- }
16170
- ],
16171
- "description": "Handles errors and emits appropriate error events.",
16172
- "privacy": "public",
16173
- "inheritedFrom": {
16174
- "name": "GenesisGridDatasourceElement",
16175
- "module": "src/datasource/base.datasource.ts"
16176
- }
16352
+ "text": "string"
16353
+ }
16354
+ }
16355
+ ]
16177
16356
  },
16178
16357
  {
16179
16358
  "kind": "method",
16180
- "name": "clearErrors",
16181
- "description": "Clears error state and emits connected event.",
16182
- "privacy": "public",
16183
- "inheritedFrom": {
16184
- "name": "GenesisGridDatasourceElement",
16185
- "module": "src/datasource/base.datasource.ts"
16186
- }
16187
- },
16188
- {
16189
- "kind": "field",
16190
- "name": "_presentation",
16191
- "type": {
16192
- "text": "ComponentPresentation | null | undefined"
16193
- },
16359
+ "name": "migrateLocalStorageToKVStorage",
16194
16360
  "privacy": "private",
16195
- "default": "void 0",
16196
- "inheritedFrom": {
16197
- "name": "FoundationElement",
16198
- "module": "src/foundation-element/foundation-element.ts"
16199
- }
16200
- },
16201
- {
16202
- "kind": "field",
16203
- "name": "$presentation",
16204
- "type": {
16205
- "text": "ComponentPresentation | null"
16361
+ "return": {
16362
+ "type": {
16363
+ "text": "Promise<void>"
16364
+ }
16206
16365
  },
16207
- "privacy": "public",
16208
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
16209
- "inheritedFrom": {
16210
- "name": "FoundationElement",
16211
- "module": "src/foundation-element/foundation-element.ts"
16212
- }
16366
+ "parameters": [
16367
+ {
16368
+ "name": "persistColumnStateKey",
16369
+ "type": {
16370
+ "text": "string"
16371
+ }
16372
+ }
16373
+ ]
16213
16374
  },
16214
16375
  {
16215
- "kind": "field",
16216
- "name": "template",
16217
- "type": {
16218
- "text": "ElementViewTemplate | void | null"
16376
+ "kind": "method",
16377
+ "name": "getFilterModel",
16378
+ "return": {
16379
+ "type": {
16380
+ "text": "Promise<{ [key: string]: any }>"
16381
+ }
16219
16382
  },
16220
- "privacy": "public",
16221
- "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.",
16222
- "inheritedFrom": {
16223
- "name": "FoundationElement",
16224
- "module": "src/foundation-element/foundation-element.ts"
16225
- }
16383
+ "parameters": [
16384
+ {
16385
+ "name": "persistFilterModelKey",
16386
+ "type": {
16387
+ "text": "string"
16388
+ }
16389
+ }
16390
+ ]
16226
16391
  },
16227
16392
  {
16228
16393
  "kind": "method",
16229
- "name": "templateChanged",
16230
- "privacy": "protected",
16394
+ "name": "saveFilterModel",
16231
16395
  "return": {
16232
16396
  "type": {
16233
- "text": "void"
16397
+ "text": "Promise<void>"
16234
16398
  }
16235
16399
  },
16236
- "inheritedFrom": {
16237
- "name": "FoundationElement",
16238
- "module": "src/foundation-element/foundation-element.ts"
16239
- }
16240
- },
16400
+ "parameters": [
16401
+ {
16402
+ "name": "persistFilterModelKey",
16403
+ "type": {
16404
+ "text": "string"
16405
+ }
16406
+ },
16407
+ {
16408
+ "name": "filterModel",
16409
+ "type": {
16410
+ "text": "{ [key: string]: any }"
16411
+ }
16412
+ }
16413
+ ]
16414
+ }
16415
+ ]
16416
+ }
16417
+ ],
16418
+ "exports": [
16419
+ {
16420
+ "kind": "js",
16421
+ "name": "KVStorageStatePersistence",
16422
+ "declaration": {
16423
+ "name": "KVStorageStatePersistence",
16424
+ "module": "src/state-persistence/kv-state.ts"
16425
+ }
16426
+ }
16427
+ ]
16428
+ },
16429
+ {
16430
+ "kind": "javascript-module",
16431
+ "path": "src/state-persistence/local-state.ts",
16432
+ "declarations": [
16433
+ {
16434
+ "kind": "class",
16435
+ "description": "Implementation for the Local Storage State Persistence interface.",
16436
+ "name": "LocalStorageStatePersistence",
16437
+ "members": [
16241
16438
  {
16242
16439
  "kind": "field",
16243
- "name": "styles",
16440
+ "name": "session",
16244
16441
  "type": {
16245
- "text": "ElementStyles | void | null"
16246
- },
16247
- "privacy": "public",
16248
- "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.",
16249
- "inheritedFrom": {
16250
- "name": "FoundationElement",
16251
- "module": "src/foundation-element/foundation-element.ts"
16442
+ "text": "Session"
16252
16443
  }
16253
16444
  },
16254
16445
  {
16255
16446
  "kind": "method",
16256
- "name": "stylesChanged",
16257
- "privacy": "protected",
16447
+ "name": "getColumnState",
16258
16448
  "return": {
16259
16449
  "type": {
16260
- "text": "void"
16450
+ "text": "Promise<ColumnState[]>"
16261
16451
  }
16262
16452
  },
16263
- "inheritedFrom": {
16264
- "name": "FoundationElement",
16265
- "module": "src/foundation-element/foundation-element.ts"
16266
- }
16453
+ "parameters": [
16454
+ {
16455
+ "name": "persistColumnStateKey",
16456
+ "type": {
16457
+ "text": "string"
16458
+ }
16459
+ }
16460
+ ]
16267
16461
  },
16268
16462
  {
16269
16463
  "kind": "method",
16270
- "name": "compose",
16271
- "privacy": "public",
16272
- "static": true,
16464
+ "name": "saveColumnState",
16273
16465
  "return": {
16274
16466
  "type": {
16275
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
16467
+ "text": "Promise<void>"
16276
16468
  }
16277
16469
  },
16278
16470
  "parameters": [
16279
16471
  {
16280
- "name": "this",
16472
+ "name": "persistColumnStateKey",
16281
16473
  "type": {
16282
- "text": "K"
16474
+ "text": "string"
16283
16475
  }
16284
16476
  },
16285
16477
  {
16286
- "name": "elementDefinition",
16478
+ "name": "columnState",
16287
16479
  "type": {
16288
- "text": "T"
16289
- },
16290
- "description": "The definition of the element to create the registry\nfunction for."
16480
+ "text": "ColumnState[]"
16481
+ }
16291
16482
  }
16292
- ],
16293
- "description": "Defines an element registry function with a set of element definition defaults.",
16294
- "inheritedFrom": {
16295
- "name": "FoundationElement",
16296
- "module": "src/foundation-element/foundation-element.ts"
16297
- }
16298
- }
16299
- ],
16300
- "attributes": [
16301
- {
16302
- "name": "keep-col-defs-on-clear-row-data",
16303
- "type": {
16304
- "text": "boolean"
16305
- },
16306
- "default": "false",
16307
- "fieldName": "keepColDefsOnClearRowData"
16308
- },
16309
- {
16310
- "name": "criteria",
16311
- "type": {
16312
- "text": "string"
16313
- },
16314
- "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
16315
- "fieldName": "criteria",
16316
- "inheritedFrom": {
16317
- "name": "GenesisGridDatasourceElement",
16318
- "module": "src/datasource/base.datasource.ts"
16319
- }
16320
- },
16321
- {
16322
- "name": "is-snapshot",
16323
- "type": {
16324
- "text": "boolean"
16325
- },
16326
- "default": "false",
16327
- "description": "Request a snapshot from the server.",
16328
- "fieldName": "isSnapshot",
16329
- "inheritedFrom": {
16330
- "name": "GenesisGridDatasourceElement",
16331
- "module": "src/datasource/base.datasource.ts"
16332
- }
16333
- },
16334
- {
16335
- "name": "max-rows",
16336
- "type": {
16337
- "text": "number"
16338
- },
16339
- "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
16340
- "fieldName": "maxRows",
16341
- "inheritedFrom": {
16342
- "name": "GenesisGridDatasourceElement",
16343
- "module": "src/datasource/base.datasource.ts"
16344
- }
16345
- },
16346
- {
16347
- "name": "order-by",
16348
- "type": {
16349
- "text": "string"
16350
- },
16351
- "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.",
16352
- "fieldName": "orderBy",
16353
- "inheritedFrom": {
16354
- "name": "GenesisGridDatasourceElement",
16355
- "module": "src/datasource/base.datasource.ts"
16356
- }
16357
- },
16358
- {
16359
- "name": "resource-name",
16360
- "type": {
16361
- "text": "string"
16362
- },
16363
- "description": "The name of the target Data Server query or Request Server requestReply.",
16364
- "fieldName": "resourceName",
16365
- "inheritedFrom": {
16366
- "name": "GenesisGridDatasourceElement",
16367
- "module": "src/datasource/base.datasource.ts"
16368
- }
16369
- },
16370
- {
16371
- "name": "view-number",
16372
- "type": {
16373
- "text": "number"
16374
- },
16375
- "description": "The desired view/page you want data from.",
16376
- "fieldName": "viewNumber",
16377
- "inheritedFrom": {
16378
- "name": "GenesisGridDatasourceElement",
16379
- "module": "src/datasource/base.datasource.ts"
16380
- }
16381
- },
16382
- {
16383
- "name": "fields",
16384
- "type": {
16385
- "text": "string"
16386
- },
16387
- "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.",
16388
- "fieldName": "fields",
16389
- "inheritedFrom": {
16390
- "name": "GenesisGridDatasourceElement",
16391
- "module": "src/datasource/base.datasource.ts"
16392
- }
16393
- },
16394
- {
16395
- "name": "max-view",
16396
- "type": {
16397
- "text": "number"
16398
- },
16399
- "description": "Maximum number of rows to track as part of a client \"view\".",
16400
- "fieldName": "maxView",
16401
- "inheritedFrom": {
16402
- "name": "GenesisGridDatasourceElement",
16403
- "module": "src/datasource/base.datasource.ts"
16404
- }
16405
- },
16406
- {
16407
- "name": "moving-view",
16408
- "type": {
16409
- "text": "boolean"
16410
- },
16411
- "default": "false",
16412
- "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.",
16413
- "fieldName": "movingView",
16414
- "inheritedFrom": {
16415
- "name": "GenesisGridDatasourceElement",
16416
- "module": "src/datasource/base.datasource.ts"
16417
- }
16418
- },
16419
- {
16420
- "type": {
16421
- "text": "number"
16422
- },
16423
- "description": "Option that changes the Data Server index iteration.",
16424
- "fieldName": "reverse",
16425
- "default": "false",
16426
- "inheritedFrom": {
16427
- "name": "GenesisGridDatasourceElement",
16428
- "module": "src/datasource/base.datasource.ts"
16429
- }
16430
- },
16431
- {
16432
- "name": "disable-polling",
16433
- "type": {
16434
- "text": "boolean"
16435
- },
16436
- "default": "false",
16437
- "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
16438
- "fieldName": "disablePolling",
16439
- "inheritedFrom": {
16440
- "name": "GenesisGridDatasourceElement",
16441
- "module": "src/datasource/base.datasource.ts"
16442
- }
16483
+ ]
16443
16484
  },
16444
16485
  {
16445
- "name": "polling-interval",
16446
- "type": {
16447
- "text": "number"
16486
+ "kind": "method",
16487
+ "name": "deleteColumnState",
16488
+ "return": {
16489
+ "type": {
16490
+ "text": "Promise<void>"
16491
+ }
16448
16492
  },
16449
- "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
16450
- "fieldName": "pollingInterval",
16451
- "inheritedFrom": {
16452
- "name": "GenesisGridDatasourceElement",
16453
- "module": "src/datasource/base.datasource.ts"
16454
- }
16493
+ "parameters": [
16494
+ {
16495
+ "name": "persistColumnStateKey",
16496
+ "type": {
16497
+ "text": "string"
16498
+ }
16499
+ }
16500
+ ]
16455
16501
  },
16456
16502
  {
16457
- "name": "request-auto-setup",
16458
- "type": {
16459
- "text": "boolean"
16503
+ "kind": "method",
16504
+ "name": "getFilterModel",
16505
+ "return": {
16506
+ "type": {
16507
+ "text": "Promise<{ [key: string]: any }>"
16508
+ }
16460
16509
  },
16461
- "default": "true",
16462
- "description": "Attribute to set whether the REQUEST object should be automatically set up.",
16463
- "fieldName": "requestAutoSetup",
16464
- "inheritedFrom": {
16465
- "name": "GenesisGridDatasourceElement",
16466
- "module": "src/datasource/base.datasource.ts"
16467
- }
16468
- },
16469
- {
16470
- "name": "row-id",
16471
- "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
16472
- "fieldName": "rowIdAttr",
16473
- "inheritedFrom": {
16474
- "name": "GenesisGridDatasourceElement",
16475
- "module": "src/datasource/base.datasource.ts"
16476
- }
16510
+ "parameters": [
16511
+ {
16512
+ "name": "persistFilterModelKey",
16513
+ "type": {
16514
+ "text": "string"
16515
+ }
16516
+ }
16517
+ ]
16477
16518
  },
16478
16519
  {
16479
- "name": "restart-on-reconnection",
16480
- "type": {
16481
- "text": "boolean"
16520
+ "kind": "method",
16521
+ "name": "saveFilterModel",
16522
+ "return": {
16523
+ "type": {
16524
+ "text": "Promise<void>"
16525
+ }
16482
16526
  },
16483
- "default": "true",
16484
- "description": "Attribute to set whether the datasource should restart when it reconnects.",
16485
- "fieldName": "restartOnReconnection",
16486
- "inheritedFrom": {
16487
- "name": "GenesisGridDatasourceElement",
16488
- "module": "src/datasource/base.datasource.ts"
16489
- }
16490
- }
16491
- ],
16492
- "mixins": [
16493
- {
16494
- "name": "LifecycleMixin",
16495
- "package": "@genesislcap/foundation-utils"
16527
+ "parameters": [
16528
+ {
16529
+ "name": "persistFilterModelKey",
16530
+ "type": {
16531
+ "text": "string"
16532
+ }
16533
+ },
16534
+ {
16535
+ "name": "filterModel",
16536
+ "type": {
16537
+ "text": "{ [key: string]: any }"
16538
+ }
16539
+ }
16540
+ ]
16496
16541
  }
16497
- ],
16498
- "superclass": {
16499
- "name": "GridProBaseDatasource",
16500
- "module": "/src/datasource/base.datasource"
16501
- },
16502
- "tagName": "grid-pro-genesis-datasource",
16503
- "customElement": true
16542
+ ]
16504
16543
  }
16505
16544
  ],
16506
16545
  "exports": [
16507
16546
  {
16508
16547
  "kind": "js",
16509
- "name": "GridProGenesisDatasource",
16510
- "declaration": {
16511
- "name": "GridProGenesisDatasource",
16512
- "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
16513
- }
16514
- },
16515
- {
16516
- "kind": "custom-element-definition",
16517
- "name": "grid-pro-genesis-datasource",
16548
+ "name": "LocalStorageStatePersistence",
16518
16549
  "declaration": {
16519
- "name": "GridProGenesisDatasource",
16520
- "module": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"
16550
+ "name": "LocalStorageStatePersistence",
16551
+ "module": "src/state-persistence/local-state.ts"
16521
16552
  }
16522
16553
  }
16523
16554
  ]
16524
16555
  },
16525
16556
  {
16526
16557
  "kind": "javascript-module",
16527
- "path": "src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.ts",
16558
+ "path": "src/state-persistence/state-persistence.ts",
16528
16559
  "declarations": [],
16529
16560
  "exports": []
16530
16561
  },
16531
- {
16532
- "kind": "javascript-module",
16533
- "path": "src/grid-pro-genesis-datasource/index.ts",
16534
- "declarations": [],
16535
- "exports": [
16536
- {
16537
- "kind": "js",
16538
- "name": "*",
16539
- "declaration": {
16540
- "name": "*",
16541
- "package": "./grid-pro-genesis-datasource.config"
16542
- }
16543
- },
16544
- {
16545
- "kind": "js",
16546
- "name": "*",
16547
- "declaration": {
16548
- "name": "*",
16549
- "package": "./grid-pro-genesis-datasource.types"
16550
- }
16551
- },
16552
- {
16553
- "kind": "js",
16554
- "name": "*",
16555
- "declaration": {
16556
- "name": "*",
16557
- "package": "./grid-pro-genesis-datasource"
16558
- }
16559
- }
16560
- ]
16561
- },
16562
16562
  {
16563
16563
  "kind": "javascript-module",
16564
16564
  "path": "src/status-bar-components/index.ts",