@vertigis/viewer-spec 58.10.2 → 58.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -292,13 +292,40 @@ export interface NarrateOptions extends TranslateOptions {
|
|
|
292
292
|
*/
|
|
293
293
|
timeout?: number;
|
|
294
294
|
}
|
|
295
|
+
/**
|
|
296
|
+
* Arguments for the "ui.activate" and "ui.deactivate" commands.
|
|
297
|
+
*
|
|
298
|
+
* @webOnly
|
|
299
|
+
*/
|
|
300
|
+
export interface ActivationArgs {
|
|
301
|
+
/**
|
|
302
|
+
* The component to activate or deactivate. Can be identified by its ID or
|
|
303
|
+
* model.
|
|
304
|
+
*/
|
|
305
|
+
component: ComponentId | Model;
|
|
306
|
+
/**
|
|
307
|
+
* Whether to validate the component's state before activation or
|
|
308
|
+
* deactivation. Defaults to `false` if not provided.
|
|
309
|
+
*/
|
|
310
|
+
validateState?: boolean;
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* Arguments that can be passed to the "ui.activate" command. Supports a
|
|
314
|
+
* component's ID, its model, or detailed activation arguments.
|
|
315
|
+
*/
|
|
316
|
+
export type ActivateArgs = ActivationArgs | ComponentId | Model;
|
|
317
|
+
/**
|
|
318
|
+
* Arguments that can be passed to the "ui.deactivate" command. Supports a
|
|
319
|
+
* component's ID, its model, or detailed deactivation arguments.
|
|
320
|
+
*/
|
|
321
|
+
export type DeactivateArgs = ActivationArgs | ComponentId | Model;
|
|
295
322
|
export declare class UICommands extends CommandRegistry {
|
|
296
323
|
protected readonly _prefix = "ui";
|
|
297
324
|
/**
|
|
298
325
|
* Activates a component with the given ID or model, causing it to become
|
|
299
326
|
* visible. For VertiGIS Studio Mobile, only ID is supported.
|
|
300
327
|
*/
|
|
301
|
-
get activate(): Command<
|
|
328
|
+
get activate(): Command<ActivateArgs>;
|
|
302
329
|
/**
|
|
303
330
|
* Toggles the active state on a component with the given ID. Mobile only.
|
|
304
331
|
*
|
|
@@ -321,7 +348,7 @@ export declare class UICommands extends CommandRegistry {
|
|
|
321
348
|
* Deactivates a component with the given ID, causing it to disappear. For
|
|
322
349
|
* VertiGIS Studio Mobile, only ID is supported.
|
|
323
350
|
*/
|
|
324
|
-
get deactivate(): Command<
|
|
351
|
+
get deactivate(): Command<DeactivateArgs>;
|
|
325
352
|
/**
|
|
326
353
|
* Displays a loading indicator and custom message to the user to indicate
|
|
327
354
|
* that the UI is busy.
|
|
@@ -676,6 +676,45 @@
|
|
|
676
676
|
],
|
|
677
677
|
"description": "A reference to a portal item."
|
|
678
678
|
},
|
|
679
|
+
"ActivateArgs": {
|
|
680
|
+
"anyOf": [
|
|
681
|
+
{
|
|
682
|
+
"$ref": "#/definitions/Model"
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
"$ref": "#/definitions/ActivationArgs"
|
|
686
|
+
},
|
|
687
|
+
{
|
|
688
|
+
"type": "string"
|
|
689
|
+
}
|
|
690
|
+
],
|
|
691
|
+
"description": "Arguments that can be passed to the \"ui.activate\" command. Supports a component's ID, its model, or detailed activation arguments."
|
|
692
|
+
},
|
|
693
|
+
"ActivationArgs": {
|
|
694
|
+
"additionalProperties": false,
|
|
695
|
+
"description": "Arguments for the \"ui.activate\" and \"ui.deactivate\" commands.",
|
|
696
|
+
"properties": {
|
|
697
|
+
"component": {
|
|
698
|
+
"anyOf": [
|
|
699
|
+
{
|
|
700
|
+
"$ref": "#/definitions/Model"
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
"type": "string"
|
|
704
|
+
}
|
|
705
|
+
],
|
|
706
|
+
"description": "The component to activate or deactivate. Can be identified by its ID or model."
|
|
707
|
+
},
|
|
708
|
+
"validateState": {
|
|
709
|
+
"description": "Whether to validate the component's state before activation or deactivation. Defaults to `false` if not provided.",
|
|
710
|
+
"type": "boolean"
|
|
711
|
+
}
|
|
712
|
+
},
|
|
713
|
+
"required": [
|
|
714
|
+
"component"
|
|
715
|
+
],
|
|
716
|
+
"type": "object"
|
|
717
|
+
},
|
|
679
718
|
"AddAttachmentArgs": {
|
|
680
719
|
"additionalProperties": false,
|
|
681
720
|
"description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.",
|
|
@@ -1203,6 +1242,20 @@
|
|
|
1203
1242
|
],
|
|
1204
1243
|
"type": "object"
|
|
1205
1244
|
},
|
|
1245
|
+
"DeactivateArgs": {
|
|
1246
|
+
"anyOf": [
|
|
1247
|
+
{
|
|
1248
|
+
"$ref": "#/definitions/Model"
|
|
1249
|
+
},
|
|
1250
|
+
{
|
|
1251
|
+
"$ref": "#/definitions/ActivationArgs"
|
|
1252
|
+
},
|
|
1253
|
+
{
|
|
1254
|
+
"type": "string"
|
|
1255
|
+
}
|
|
1256
|
+
],
|
|
1257
|
+
"description": "Arguments that can be passed to the \"ui.deactivate\" command. Supports a component's ID, its model, or detailed deactivation arguments."
|
|
1258
|
+
},
|
|
1206
1259
|
"DeleteAttachmentArgs": {
|
|
1207
1260
|
"additionalProperties": false,
|
|
1208
1261
|
"description": "Arguments for the \"edit.delete-attachment\" command.",
|
|
@@ -14295,14 +14348,7 @@
|
|
|
14295
14348
|
]
|
|
14296
14349
|
},
|
|
14297
14350
|
"ui.activate:input": {
|
|
14298
|
-
"
|
|
14299
|
-
{
|
|
14300
|
-
"$ref": "#/definitions/Model"
|
|
14301
|
-
},
|
|
14302
|
-
{
|
|
14303
|
-
"type": "string"
|
|
14304
|
-
}
|
|
14305
|
-
]
|
|
14351
|
+
"$ref": "#/definitions/ActivateArgs"
|
|
14306
14352
|
},
|
|
14307
14353
|
"ui.alert": {
|
|
14308
14354
|
"description": "Shows an alert to the user.",
|
|
@@ -14332,14 +14378,7 @@
|
|
|
14332
14378
|
]
|
|
14333
14379
|
},
|
|
14334
14380
|
"ui.deactivate:input": {
|
|
14335
|
-
"
|
|
14336
|
-
{
|
|
14337
|
-
"$ref": "#/definitions/Model"
|
|
14338
|
-
},
|
|
14339
|
-
{
|
|
14340
|
-
"type": "string"
|
|
14341
|
-
}
|
|
14342
|
-
]
|
|
14381
|
+
"$ref": "#/definitions/DeactivateArgs"
|
|
14343
14382
|
},
|
|
14344
14383
|
"ui.display-busy-state": {
|
|
14345
14384
|
"description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",
|
|
@@ -660,6 +660,45 @@
|
|
|
660
660
|
],
|
|
661
661
|
"description": "A reference to a portal item."
|
|
662
662
|
},
|
|
663
|
+
"ActivateArgs": {
|
|
664
|
+
"anyOf": [
|
|
665
|
+
{
|
|
666
|
+
"$ref": "#/definitions/Model"
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"$ref": "#/definitions/ActivationArgs"
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
"type": "string"
|
|
673
|
+
}
|
|
674
|
+
],
|
|
675
|
+
"description": "Arguments that can be passed to the \"ui.activate\" command. Supports a component's ID, its model, or detailed activation arguments."
|
|
676
|
+
},
|
|
677
|
+
"ActivationArgs": {
|
|
678
|
+
"additionalProperties": false,
|
|
679
|
+
"description": "Arguments for the \"ui.activate\" and \"ui.deactivate\" commands.",
|
|
680
|
+
"properties": {
|
|
681
|
+
"component": {
|
|
682
|
+
"anyOf": [
|
|
683
|
+
{
|
|
684
|
+
"$ref": "#/definitions/Model"
|
|
685
|
+
},
|
|
686
|
+
{
|
|
687
|
+
"type": "string"
|
|
688
|
+
}
|
|
689
|
+
],
|
|
690
|
+
"description": "The component to activate or deactivate. Can be identified by its ID or model."
|
|
691
|
+
},
|
|
692
|
+
"validateState": {
|
|
693
|
+
"description": "Whether to validate the component's state before activation or deactivation. Defaults to `false` if not provided.",
|
|
694
|
+
"type": "boolean"
|
|
695
|
+
}
|
|
696
|
+
},
|
|
697
|
+
"required": [
|
|
698
|
+
"component"
|
|
699
|
+
],
|
|
700
|
+
"type": "object"
|
|
701
|
+
},
|
|
663
702
|
"AddAttachmentArgs": {
|
|
664
703
|
"additionalProperties": false,
|
|
665
704
|
"description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.",
|
|
@@ -1407,6 +1446,20 @@
|
|
|
1407
1446
|
],
|
|
1408
1447
|
"type": "object"
|
|
1409
1448
|
},
|
|
1449
|
+
"DeactivateArgs": {
|
|
1450
|
+
"anyOf": [
|
|
1451
|
+
{
|
|
1452
|
+
"$ref": "#/definitions/Model"
|
|
1453
|
+
},
|
|
1454
|
+
{
|
|
1455
|
+
"$ref": "#/definitions/ActivationArgs"
|
|
1456
|
+
},
|
|
1457
|
+
{
|
|
1458
|
+
"type": "string"
|
|
1459
|
+
}
|
|
1460
|
+
],
|
|
1461
|
+
"description": "Arguments that can be passed to the \"ui.deactivate\" command. Supports a component's ID, its model, or detailed deactivation arguments."
|
|
1462
|
+
},
|
|
1410
1463
|
"DeleteAttachmentArgs": {
|
|
1411
1464
|
"additionalProperties": false,
|
|
1412
1465
|
"description": "Arguments for the \"edit.delete-attachment\" command.",
|
|
@@ -16436,14 +16489,7 @@
|
|
|
16436
16489
|
]
|
|
16437
16490
|
},
|
|
16438
16491
|
"ui.activate:input": {
|
|
16439
|
-
"
|
|
16440
|
-
{
|
|
16441
|
-
"$ref": "#/definitions/Model"
|
|
16442
|
-
},
|
|
16443
|
-
{
|
|
16444
|
-
"type": "string"
|
|
16445
|
-
}
|
|
16446
|
-
]
|
|
16492
|
+
"$ref": "#/definitions/ActivateArgs"
|
|
16447
16493
|
},
|
|
16448
16494
|
"ui.active-toggle": {
|
|
16449
16495
|
"description": "Toggles the active state on a component with the given ID. Mobile only.",
|
|
@@ -16491,14 +16537,7 @@
|
|
|
16491
16537
|
]
|
|
16492
16538
|
},
|
|
16493
16539
|
"ui.deactivate:input": {
|
|
16494
|
-
"
|
|
16495
|
-
{
|
|
16496
|
-
"$ref": "#/definitions/Model"
|
|
16497
|
-
},
|
|
16498
|
-
{
|
|
16499
|
-
"type": "string"
|
|
16500
|
-
}
|
|
16501
|
-
]
|
|
16540
|
+
"$ref": "#/definitions/DeactivateArgs"
|
|
16502
16541
|
},
|
|
16503
16542
|
"ui.display-busy-state": {
|
|
16504
16543
|
"description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",
|
|
@@ -835,6 +835,20 @@
|
|
|
835
835
|
],
|
|
836
836
|
"description": "A reference to a portal item."
|
|
837
837
|
},
|
|
838
|
+
"ActivateArgs": {
|
|
839
|
+
"anyOf": [
|
|
840
|
+
{
|
|
841
|
+
"$ref": "#/definitions/Model"
|
|
842
|
+
},
|
|
843
|
+
{
|
|
844
|
+
"$ref": "#/definitions/ActivationArgs"
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
"type": "string"
|
|
848
|
+
}
|
|
849
|
+
],
|
|
850
|
+
"description": "Arguments that can be passed to the \"ui.activate\" command. Supports a component's ID, its model, or detailed activation arguments."
|
|
851
|
+
},
|
|
838
852
|
"ActivateResultGroupArgs": {
|
|
839
853
|
"additionalProperties": false,
|
|
840
854
|
"description": "Arguments for the \"results.activate-group\" command.",
|
|
@@ -857,6 +871,31 @@
|
|
|
857
871
|
},
|
|
858
872
|
"type": "object"
|
|
859
873
|
},
|
|
874
|
+
"ActivationArgs": {
|
|
875
|
+
"additionalProperties": false,
|
|
876
|
+
"description": "Arguments for the \"ui.activate\" and \"ui.deactivate\" commands.",
|
|
877
|
+
"properties": {
|
|
878
|
+
"component": {
|
|
879
|
+
"anyOf": [
|
|
880
|
+
{
|
|
881
|
+
"$ref": "#/definitions/Model"
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
"type": "string"
|
|
885
|
+
}
|
|
886
|
+
],
|
|
887
|
+
"description": "The component to activate or deactivate. Can be identified by its ID or model."
|
|
888
|
+
},
|
|
889
|
+
"validateState": {
|
|
890
|
+
"description": "Whether to validate the component's state before activation or deactivation. Defaults to `false` if not provided.",
|
|
891
|
+
"type": "boolean"
|
|
892
|
+
}
|
|
893
|
+
},
|
|
894
|
+
"required": [
|
|
895
|
+
"component"
|
|
896
|
+
],
|
|
897
|
+
"type": "object"
|
|
898
|
+
},
|
|
860
899
|
"AddAttachmentArgs": {
|
|
861
900
|
"additionalProperties": false,
|
|
862
901
|
"description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.",
|
|
@@ -2011,6 +2050,20 @@
|
|
|
2011
2050
|
],
|
|
2012
2051
|
"type": "object"
|
|
2013
2052
|
},
|
|
2053
|
+
"DeactivateArgs": {
|
|
2054
|
+
"anyOf": [
|
|
2055
|
+
{
|
|
2056
|
+
"$ref": "#/definitions/Model"
|
|
2057
|
+
},
|
|
2058
|
+
{
|
|
2059
|
+
"$ref": "#/definitions/ActivationArgs"
|
|
2060
|
+
},
|
|
2061
|
+
{
|
|
2062
|
+
"type": "string"
|
|
2063
|
+
}
|
|
2064
|
+
],
|
|
2065
|
+
"description": "Arguments that can be passed to the \"ui.deactivate\" command. Supports a component's ID, its model, or detailed deactivation arguments."
|
|
2066
|
+
},
|
|
2014
2067
|
"DeleteAttachmentArgs": {
|
|
2015
2068
|
"additionalProperties": false,
|
|
2016
2069
|
"description": "Arguments for the \"edit.delete-attachment\" command.",
|
|
@@ -22655,14 +22708,7 @@
|
|
|
22655
22708
|
]
|
|
22656
22709
|
},
|
|
22657
22710
|
"ui.activate:input": {
|
|
22658
|
-
"
|
|
22659
|
-
{
|
|
22660
|
-
"$ref": "#/definitions/Model"
|
|
22661
|
-
},
|
|
22662
|
-
{
|
|
22663
|
-
"type": "string"
|
|
22664
|
-
}
|
|
22665
|
-
]
|
|
22711
|
+
"$ref": "#/definitions/ActivateArgs"
|
|
22666
22712
|
},
|
|
22667
22713
|
"ui.alert": {
|
|
22668
22714
|
"description": "Shows an alert to the user.",
|
|
@@ -22692,14 +22738,7 @@
|
|
|
22692
22738
|
]
|
|
22693
22739
|
},
|
|
22694
22740
|
"ui.deactivate:input": {
|
|
22695
|
-
"
|
|
22696
|
-
{
|
|
22697
|
-
"$ref": "#/definitions/Model"
|
|
22698
|
-
},
|
|
22699
|
-
{
|
|
22700
|
-
"type": "string"
|
|
22701
|
-
}
|
|
22702
|
-
]
|
|
22741
|
+
"$ref": "#/definitions/DeactivateArgs"
|
|
22703
22742
|
},
|
|
22704
22743
|
"ui.display-busy-state": {
|
|
22705
22744
|
"description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",
|
package/package.json
CHANGED
package/version.d.ts
CHANGED
package/version.js
CHANGED