@vertigis/viewer-spec 58.10.1 → 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.
- package/app-config/web/FeatureSetProperties.d.ts +1 -1
- package/app-config/web/ResultsModelProperties.d.ts +1 -1
- package/messaging/common.d.ts +7 -3
- package/messaging/registry/arcade.d.ts +3 -4
- package/messaging/registry/system.d.ts +3 -4
- package/messaging/registry/ui.d.ts +34 -11
- package/messaging/schema/common-action.schema.json +65 -20
- package/messaging/schema/mobile-action.schema.json +65 -20
- package/messaging/schema/web-action.schema.json +102 -43
- package/package.json +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { FeatureProperties } from "@vertigis/arcgis-extensions/data/Feature";
|
|
2
2
|
import type { FeatureSetProperties as ApiFeatureSetProperties } from "@vertigis/arcgis-extensions/data/FeatureSet";
|
|
3
|
-
import type { ItemRef } from "
|
|
3
|
+
import type { ItemRef } from "../common/ItemRef";
|
|
4
4
|
/**
|
|
5
5
|
* Properties for a FeatureSet.
|
|
6
6
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Action } from "@vertigis/arcgis-extensions/support/Action";
|
|
2
|
-
import type { ItemRef } from "
|
|
2
|
+
import type { ItemRef } from "../common/ItemRef.js";
|
|
3
3
|
import type { ResultsModelProperties as CommonResultsModelProperties } from "../common/ResultsModelProperties.js";
|
|
4
4
|
import type { ComponentModelProperties } from "./ComponentModelProperties.js";
|
|
5
5
|
import type { FeatureListProperties } from "./FeatureListProperties.js";
|
package/messaging/common.d.ts
CHANGED
|
@@ -31,8 +31,12 @@ import type { LayerExtension, LayerReference as LayerReferenceObject } from "@ve
|
|
|
31
31
|
import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtension";
|
|
32
32
|
import type { SublayerExtension } from "@vertigis/arcgis-extensions/mapping/SublayerExtension";
|
|
33
33
|
import type { SublayerLike } from "@vertigis/arcgis-extensions/support/esri";
|
|
34
|
-
import type { ItemRef } from "app-config/common/ItemRef";
|
|
34
|
+
import type { ItemRef } from "../app-config/common/ItemRef";
|
|
35
35
|
import type { TimeSpan } from "./DotNetTypes";
|
|
36
|
+
/**
|
|
37
|
+
* A component's ID in the layout.
|
|
38
|
+
*/
|
|
39
|
+
export type ComponentId = string;
|
|
36
40
|
/**
|
|
37
41
|
* A model belonging to a component.
|
|
38
42
|
*/
|
|
@@ -41,7 +45,7 @@ export interface Model extends Entity {
|
|
|
41
45
|
/**
|
|
42
46
|
* A reference to a model (using its ID or model instance).
|
|
43
47
|
*/
|
|
44
|
-
export type ModelRef =
|
|
48
|
+
export type ModelRef = ItemRef | Model;
|
|
45
49
|
/**
|
|
46
50
|
* Result of the "drawing.create-graphics" and "measurement.create-graphics"
|
|
47
51
|
* operations.
|
|
@@ -217,7 +221,7 @@ export interface HasUITarget {
|
|
|
217
221
|
* component will be the parent of the temporary UI that will be removed
|
|
218
222
|
* after the command/operation completes.
|
|
219
223
|
*/
|
|
220
|
-
parent?:
|
|
224
|
+
parent?: ComponentId | ModelRef;
|
|
221
225
|
/**
|
|
222
226
|
* Optional layout XML attributes to be used for the transient UI container.
|
|
223
227
|
*/
|
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import type { ItemRef } from "app-config/common/ItemRef.js";
|
|
2
1
|
import type { Operation } from "../Operation.js";
|
|
3
2
|
import { OperationRegistry } from "../OperationRegistry.js";
|
|
4
|
-
import type { HasFeatures, HasLayers, HasMaps,
|
|
3
|
+
import type { HasFeatures, HasLayers, HasMaps, ModelRef } from "../common.js";
|
|
5
4
|
/**
|
|
6
5
|
* The arguments for the arcade.run operation.
|
|
7
6
|
*/
|
|
@@ -59,7 +58,7 @@ export interface ItemPropertyPath {
|
|
|
59
58
|
/**
|
|
60
59
|
* The item from which to access a property value.
|
|
61
60
|
*/
|
|
62
|
-
item:
|
|
61
|
+
item: ModelRef;
|
|
63
62
|
/**
|
|
64
63
|
* The path to a property on an item.
|
|
65
64
|
*/
|
|
@@ -102,7 +101,7 @@ export interface WatchEventHandleProperties {
|
|
|
102
101
|
/**
|
|
103
102
|
* The item whose properties will be watched for changes and/or events.
|
|
104
103
|
*/
|
|
105
|
-
item:
|
|
104
|
+
item: ModelRef;
|
|
106
105
|
/**
|
|
107
106
|
* One or more properties on the item that will be watched for changes
|
|
108
107
|
* and/or events. Any strings will be used as propertyPaths that will be
|
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
import type Point from "@arcgis/core/geometry/Point.js";
|
|
2
2
|
import type { Action } from "@vertigis/arcgis-extensions/support/Action.js";
|
|
3
|
-
import type {
|
|
4
|
-
import type { CoordinateOptionProperties } from "app-config/web/CoordinateModelProperties.js";
|
|
3
|
+
import type { CoordinateOptionProperties } from "../../app-config/web/CoordinateModelProperties.js";
|
|
5
4
|
import type { Command } from "../Command.js";
|
|
6
5
|
import { CommandRegistry } from "../CommandRegistry.js";
|
|
7
6
|
import type { Event } from "../Event.js";
|
|
8
7
|
import { EventRegistry } from "../EventRegistry.js";
|
|
9
8
|
import type { Operation } from "../Operation.js";
|
|
10
9
|
import { OperationRegistry } from "../OperationRegistry.js";
|
|
11
|
-
import type { Blob, File, HasFeatures, HasFiles, HasGeometry, HasLayers, HasMaps, HasUITarget } from "../common.js";
|
|
10
|
+
import type { Blob, File, HasFeatures, HasFiles, HasGeometry, HasLayers, HasMaps, HasUITarget, ModelRef } from "../common.js";
|
|
12
11
|
/**
|
|
13
12
|
* Arguments for the system.download-file operation.
|
|
14
13
|
*/
|
|
@@ -117,7 +116,7 @@ export interface OpenUrlArgs {
|
|
|
117
116
|
* existing 'coordinate-option' item, or inline JSON defining a coordinate
|
|
118
117
|
* option item.
|
|
119
118
|
*/
|
|
120
|
-
coordinateOption?:
|
|
119
|
+
coordinateOption?: ModelRef | CoordinateOptionProperties;
|
|
121
120
|
/**
|
|
122
121
|
* An object containing arguments that this command was originally executed
|
|
123
122
|
* with. This property is populated automatically when using a bound action.
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import type { ItemRef } from "app-config/common/ItemRef.js";
|
|
2
1
|
import type { UIDensity } from "../../app-config/common/BrandingModelProperties.js";
|
|
3
2
|
import type { TranslatableText, TranslateOptions } from "../../app-config/common/TranslatableText.js";
|
|
4
3
|
import type { Command } from "../Command.js";
|
|
@@ -7,7 +6,8 @@ import type { Event } from "../Event.js";
|
|
|
7
6
|
import { EventRegistry } from "../EventRegistry.js";
|
|
8
7
|
import type { Operation } from "../Operation.js";
|
|
9
8
|
import { OperationRegistry } from "../OperationRegistry.js";
|
|
10
|
-
import type { Model } from "../common.js";
|
|
9
|
+
import type { ComponentId, Model } from "../common.js";
|
|
10
|
+
export type { ComponentId };
|
|
11
11
|
/**
|
|
12
12
|
* A category for a notification that affects the color and icon used.
|
|
13
13
|
*/
|
|
@@ -211,10 +211,6 @@ export interface DisplayBusyStateArgs {
|
|
|
211
211
|
*/
|
|
212
212
|
maximumDisplayDurationMs?: number;
|
|
213
213
|
}
|
|
214
|
-
/**
|
|
215
|
-
* A component's ID in the layout.
|
|
216
|
-
*/
|
|
217
|
-
export type ComponentId = string;
|
|
218
214
|
/**
|
|
219
215
|
* Arguments for the "ui.focus" command.
|
|
220
216
|
*/
|
|
@@ -296,13 +292,40 @@ export interface NarrateOptions extends TranslateOptions {
|
|
|
296
292
|
*/
|
|
297
293
|
timeout?: number;
|
|
298
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;
|
|
299
322
|
export declare class UICommands extends CommandRegistry {
|
|
300
323
|
protected readonly _prefix = "ui";
|
|
301
324
|
/**
|
|
302
325
|
* Activates a component with the given ID or model, causing it to become
|
|
303
326
|
* visible. For VertiGIS Studio Mobile, only ID is supported.
|
|
304
327
|
*/
|
|
305
|
-
get activate(): Command<
|
|
328
|
+
get activate(): Command<ActivateArgs>;
|
|
306
329
|
/**
|
|
307
330
|
* Toggles the active state on a component with the given ID. Mobile only.
|
|
308
331
|
*
|
|
@@ -325,7 +348,7 @@ export declare class UICommands extends CommandRegistry {
|
|
|
325
348
|
* Deactivates a component with the given ID, causing it to disappear. For
|
|
326
349
|
* VertiGIS Studio Mobile, only ID is supported.
|
|
327
350
|
*/
|
|
328
|
-
get deactivate(): Command<
|
|
351
|
+
get deactivate(): Command<DeactivateArgs>;
|
|
329
352
|
/**
|
|
330
353
|
* Displays a loading indicator and custom message to the user to indicate
|
|
331
354
|
* that the UI is busy.
|
|
@@ -430,7 +453,7 @@ export declare class UIOperations extends OperationRegistry {
|
|
|
430
453
|
*
|
|
431
454
|
* @webOnly
|
|
432
455
|
*/
|
|
433
|
-
get getComponentIds(): Operation<
|
|
456
|
+
get getComponentIds(): Operation<ComponentId | Model, string[]>;
|
|
434
457
|
/**
|
|
435
458
|
* Gets the current locale code for the application. (example: "en", "fr" or
|
|
436
459
|
* "de-AT"). Web only.
|
|
@@ -457,13 +480,13 @@ export declare class UIOperations extends OperationRegistry {
|
|
|
457
480
|
*
|
|
458
481
|
* @webOnly
|
|
459
482
|
*/
|
|
460
|
-
get getVisualState(): Operation<ComponentId, VisualState | undefined>;
|
|
483
|
+
get getVisualState(): Operation<ComponentId | Model, VisualState | undefined>;
|
|
461
484
|
/**
|
|
462
485
|
* Gets the state of a component. Web only.
|
|
463
486
|
*
|
|
464
487
|
* @webOnly
|
|
465
488
|
*/
|
|
466
|
-
get getComponentState(): Operation<ComponentId, State | undefined>;
|
|
489
|
+
get getComponentState(): Operation<ComponentId | Model, State | undefined>;
|
|
467
490
|
/**
|
|
468
491
|
* Prompts the user to enter a value in a popup box. Web only.
|
|
469
492
|
*
|
|
@@ -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.",
|
|
@@ -1566,8 +1619,8 @@
|
|
|
1566
1619
|
"type": "string"
|
|
1567
1620
|
},
|
|
1568
1621
|
"parent": {
|
|
1569
|
-
"
|
|
1570
|
-
"
|
|
1622
|
+
"$ref": "#/definitions/ModelRef",
|
|
1623
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
1571
1624
|
},
|
|
1572
1625
|
"pluginSettings": {
|
|
1573
1626
|
"description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
|
|
@@ -2233,8 +2286,8 @@
|
|
|
2233
2286
|
"type": "string"
|
|
2234
2287
|
},
|
|
2235
2288
|
"parent": {
|
|
2236
|
-
"
|
|
2237
|
-
"
|
|
2289
|
+
"$ref": "#/definitions/ModelRef",
|
|
2290
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
2238
2291
|
}
|
|
2239
2292
|
},
|
|
2240
2293
|
"type": "object"
|
|
@@ -2537,6 +2590,9 @@
|
|
|
2537
2590
|
{
|
|
2538
2591
|
"$ref": "#/definitions/CoordinateOptionProperties"
|
|
2539
2592
|
},
|
|
2593
|
+
{
|
|
2594
|
+
"$ref": "#/definitions/Model"
|
|
2595
|
+
},
|
|
2540
2596
|
{
|
|
2541
2597
|
"type": "string"
|
|
2542
2598
|
}
|
|
@@ -3586,6 +3642,9 @@
|
|
|
3586
3642
|
{
|
|
3587
3643
|
"$ref": "#/definitions/CoordinateOptionProperties"
|
|
3588
3644
|
},
|
|
3645
|
+
{
|
|
3646
|
+
"$ref": "#/definitions/Model"
|
|
3647
|
+
},
|
|
3589
3648
|
{
|
|
3590
3649
|
"type": "string"
|
|
3591
3650
|
}
|
|
@@ -14289,14 +14348,7 @@
|
|
|
14289
14348
|
]
|
|
14290
14349
|
},
|
|
14291
14350
|
"ui.activate:input": {
|
|
14292
|
-
"
|
|
14293
|
-
{
|
|
14294
|
-
"$ref": "#/definitions/Model"
|
|
14295
|
-
},
|
|
14296
|
-
{
|
|
14297
|
-
"type": "string"
|
|
14298
|
-
}
|
|
14299
|
-
]
|
|
14351
|
+
"$ref": "#/definitions/ActivateArgs"
|
|
14300
14352
|
},
|
|
14301
14353
|
"ui.alert": {
|
|
14302
14354
|
"description": "Shows an alert to the user.",
|
|
@@ -14326,14 +14378,7 @@
|
|
|
14326
14378
|
]
|
|
14327
14379
|
},
|
|
14328
14380
|
"ui.deactivate:input": {
|
|
14329
|
-
"
|
|
14330
|
-
{
|
|
14331
|
-
"$ref": "#/definitions/Model"
|
|
14332
|
-
},
|
|
14333
|
-
{
|
|
14334
|
-
"type": "string"
|
|
14335
|
-
}
|
|
14336
|
-
]
|
|
14381
|
+
"$ref": "#/definitions/DeactivateArgs"
|
|
14337
14382
|
},
|
|
14338
14383
|
"ui.display-busy-state": {
|
|
14339
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.",
|
|
@@ -1821,8 +1874,8 @@
|
|
|
1821
1874
|
"type": "string"
|
|
1822
1875
|
},
|
|
1823
1876
|
"parent": {
|
|
1824
|
-
"
|
|
1825
|
-
"
|
|
1877
|
+
"$ref": "#/definitions/ModelRef",
|
|
1878
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
1826
1879
|
},
|
|
1827
1880
|
"pluginSettings": {
|
|
1828
1881
|
"description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
|
|
@@ -2689,8 +2742,8 @@
|
|
|
2689
2742
|
"type": "string"
|
|
2690
2743
|
},
|
|
2691
2744
|
"parent": {
|
|
2692
|
-
"
|
|
2693
|
-
"
|
|
2745
|
+
"$ref": "#/definitions/ModelRef",
|
|
2746
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
2694
2747
|
}
|
|
2695
2748
|
},
|
|
2696
2749
|
"type": "object"
|
|
@@ -3224,6 +3277,9 @@
|
|
|
3224
3277
|
{
|
|
3225
3278
|
"$ref": "#/definitions/CoordinateOptionProperties"
|
|
3226
3279
|
},
|
|
3280
|
+
{
|
|
3281
|
+
"$ref": "#/definitions/Model"
|
|
3282
|
+
},
|
|
3227
3283
|
{
|
|
3228
3284
|
"type": "string"
|
|
3229
3285
|
}
|
|
@@ -4608,6 +4664,9 @@
|
|
|
4608
4664
|
{
|
|
4609
4665
|
"$ref": "#/definitions/CoordinateOptionProperties"
|
|
4610
4666
|
},
|
|
4667
|
+
{
|
|
4668
|
+
"$ref": "#/definitions/Model"
|
|
4669
|
+
},
|
|
4611
4670
|
{
|
|
4612
4671
|
"type": "string"
|
|
4613
4672
|
}
|
|
@@ -16430,14 +16489,7 @@
|
|
|
16430
16489
|
]
|
|
16431
16490
|
},
|
|
16432
16491
|
"ui.activate:input": {
|
|
16433
|
-
"
|
|
16434
|
-
{
|
|
16435
|
-
"$ref": "#/definitions/Model"
|
|
16436
|
-
},
|
|
16437
|
-
{
|
|
16438
|
-
"type": "string"
|
|
16439
|
-
}
|
|
16440
|
-
]
|
|
16492
|
+
"$ref": "#/definitions/ActivateArgs"
|
|
16441
16493
|
},
|
|
16442
16494
|
"ui.active-toggle": {
|
|
16443
16495
|
"description": "Toggles the active state on a component with the given ID. Mobile only.",
|
|
@@ -16485,14 +16537,7 @@
|
|
|
16485
16537
|
]
|
|
16486
16538
|
},
|
|
16487
16539
|
"ui.deactivate:input": {
|
|
16488
|
-
"
|
|
16489
|
-
{
|
|
16490
|
-
"$ref": "#/definitions/Model"
|
|
16491
|
-
},
|
|
16492
|
-
{
|
|
16493
|
-
"type": "string"
|
|
16494
|
-
}
|
|
16495
|
-
]
|
|
16540
|
+
"$ref": "#/definitions/DeactivateArgs"
|
|
16496
16541
|
},
|
|
16497
16542
|
"ui.display-busy-state": {
|
|
16498
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.",
|
|
@@ -1533,8 +1572,8 @@
|
|
|
1533
1572
|
"description": "Map(s) to use for the command/operation."
|
|
1534
1573
|
},
|
|
1535
1574
|
"parent": {
|
|
1536
|
-
"
|
|
1537
|
-
"
|
|
1575
|
+
"$ref": "#/definitions/ModelRef",
|
|
1576
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
1538
1577
|
},
|
|
1539
1578
|
"sources": {
|
|
1540
1579
|
"description": "Optionally specify the sources that we want to expose. If specified this will overwrite the configured default in the Portal Model.",
|
|
@@ -1946,8 +1985,8 @@
|
|
|
1946
1985
|
"description": "The map that should show the created note."
|
|
1947
1986
|
},
|
|
1948
1987
|
"parent": {
|
|
1949
|
-
"
|
|
1950
|
-
"
|
|
1988
|
+
"$ref": "#/definitions/ModelRef",
|
|
1989
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
1951
1990
|
}
|
|
1952
1991
|
},
|
|
1953
1992
|
"required": [
|
|
@@ -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.",
|
|
@@ -2425,8 +2478,8 @@
|
|
|
2425
2478
|
"type": "string"
|
|
2426
2479
|
},
|
|
2427
2480
|
"parent": {
|
|
2428
|
-
"
|
|
2429
|
-
"
|
|
2481
|
+
"$ref": "#/definitions/ModelRef",
|
|
2482
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
2430
2483
|
},
|
|
2431
2484
|
"pluginSettings": {
|
|
2432
2485
|
"description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
|
|
@@ -2747,8 +2800,8 @@
|
|
|
2747
2800
|
"description": "The map on which to edit the result."
|
|
2748
2801
|
},
|
|
2749
2802
|
"parent": {
|
|
2750
|
-
"
|
|
2751
|
-
"
|
|
2803
|
+
"$ref": "#/definitions/ModelRef",
|
|
2804
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
2752
2805
|
}
|
|
2753
2806
|
},
|
|
2754
2807
|
"required": [
|
|
@@ -2788,8 +2841,8 @@
|
|
|
2788
2841
|
"description": "Map(s) to use for the command/operation."
|
|
2789
2842
|
},
|
|
2790
2843
|
"parent": {
|
|
2791
|
-
"
|
|
2792
|
-
"
|
|
2844
|
+
"$ref": "#/definitions/ModelRef",
|
|
2845
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
2793
2846
|
},
|
|
2794
2847
|
"showOnlySymbolPresets": {
|
|
2795
2848
|
"description": "If the fine-grain controls should be hidden and only the symbol presets should be shown. If no valid symbol presets are configured, this property will be ignored. Default is false. If defined, this will override the value of the DrawService's 'showOnlySymbolPresets' property.",
|
|
@@ -4156,8 +4209,8 @@
|
|
|
4156
4209
|
"description": "The map on which to select the result."
|
|
4157
4210
|
},
|
|
4158
4211
|
"parent": {
|
|
4159
|
-
"
|
|
4160
|
-
"
|
|
4212
|
+
"$ref": "#/definitions/ModelRef",
|
|
4213
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
4161
4214
|
}
|
|
4162
4215
|
},
|
|
4163
4216
|
"type": "object"
|
|
@@ -4472,8 +4525,8 @@
|
|
|
4472
4525
|
"type": "string"
|
|
4473
4526
|
},
|
|
4474
4527
|
"parent": {
|
|
4475
|
-
"
|
|
4476
|
-
"
|
|
4528
|
+
"$ref": "#/definitions/ModelRef",
|
|
4529
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
4477
4530
|
}
|
|
4478
4531
|
},
|
|
4479
4532
|
"type": "object"
|
|
@@ -5309,6 +5362,9 @@
|
|
|
5309
5362
|
{
|
|
5310
5363
|
"$ref": "#/definitions/CoordinateOptionProperties"
|
|
5311
5364
|
},
|
|
5365
|
+
{
|
|
5366
|
+
"$ref": "#/definitions/Model"
|
|
5367
|
+
},
|
|
5312
5368
|
{
|
|
5313
5369
|
"type": "string"
|
|
5314
5370
|
}
|
|
@@ -5713,8 +5769,8 @@
|
|
|
5713
5769
|
"type": "boolean"
|
|
5714
5770
|
},
|
|
5715
5771
|
"parent": {
|
|
5716
|
-
"
|
|
5717
|
-
"
|
|
5772
|
+
"$ref": "#/definitions/ModelRef",
|
|
5773
|
+
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
|
|
5718
5774
|
},
|
|
5719
5775
|
"promptMessage": {
|
|
5720
5776
|
"description": "If present, overrides the default message of the dialog that prompts the user for a file.",
|
|
@@ -8273,14 +8329,7 @@
|
|
|
8273
8329
|
"description": "Properties used to set a series of watch handles and/or event listeners on an item.",
|
|
8274
8330
|
"properties": {
|
|
8275
8331
|
"item": {
|
|
8276
|
-
"
|
|
8277
|
-
{
|
|
8278
|
-
"$ref": "#/definitions/Model"
|
|
8279
|
-
},
|
|
8280
|
-
{
|
|
8281
|
-
"type": "string"
|
|
8282
|
-
}
|
|
8283
|
-
],
|
|
8332
|
+
"$ref": "#/definitions/ModelRef",
|
|
8284
8333
|
"description": "The item whose properties will be watched for changes and/or events."
|
|
8285
8334
|
},
|
|
8286
8335
|
"watch": {
|
|
@@ -8370,6 +8419,9 @@
|
|
|
8370
8419
|
{
|
|
8371
8420
|
"$ref": "#/definitions/CoordinateOptionProperties"
|
|
8372
8421
|
},
|
|
8422
|
+
{
|
|
8423
|
+
"$ref": "#/definitions/Model"
|
|
8424
|
+
},
|
|
8373
8425
|
{
|
|
8374
8426
|
"type": "string"
|
|
8375
8427
|
}
|
|
@@ -22656,14 +22708,7 @@
|
|
|
22656
22708
|
]
|
|
22657
22709
|
},
|
|
22658
22710
|
"ui.activate:input": {
|
|
22659
|
-
"
|
|
22660
|
-
{
|
|
22661
|
-
"$ref": "#/definitions/Model"
|
|
22662
|
-
},
|
|
22663
|
-
{
|
|
22664
|
-
"type": "string"
|
|
22665
|
-
}
|
|
22666
|
-
]
|
|
22711
|
+
"$ref": "#/definitions/ActivateArgs"
|
|
22667
22712
|
},
|
|
22668
22713
|
"ui.alert": {
|
|
22669
22714
|
"description": "Shows an alert to the user.",
|
|
@@ -22693,14 +22738,7 @@
|
|
|
22693
22738
|
]
|
|
22694
22739
|
},
|
|
22695
22740
|
"ui.deactivate:input": {
|
|
22696
|
-
"
|
|
22697
|
-
{
|
|
22698
|
-
"$ref": "#/definitions/Model"
|
|
22699
|
-
},
|
|
22700
|
-
{
|
|
22701
|
-
"type": "string"
|
|
22702
|
-
}
|
|
22703
|
-
]
|
|
22741
|
+
"$ref": "#/definitions/DeactivateArgs"
|
|
22704
22742
|
},
|
|
22705
22743
|
"ui.display-busy-state": {
|
|
22706
22744
|
"description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",
|
|
@@ -22736,7 +22774,14 @@
|
|
|
22736
22774
|
]
|
|
22737
22775
|
},
|
|
22738
22776
|
"ui.get-component-ids:input": {
|
|
22739
|
-
"
|
|
22777
|
+
"anyOf": [
|
|
22778
|
+
{
|
|
22779
|
+
"$ref": "#/definitions/Model"
|
|
22780
|
+
},
|
|
22781
|
+
{
|
|
22782
|
+
"type": "string"
|
|
22783
|
+
}
|
|
22784
|
+
]
|
|
22740
22785
|
},
|
|
22741
22786
|
"ui.get-component-ids:output": {
|
|
22742
22787
|
"items": {
|
|
@@ -22751,7 +22796,14 @@
|
|
|
22751
22796
|
]
|
|
22752
22797
|
},
|
|
22753
22798
|
"ui.get-component-state:input": {
|
|
22754
|
-
"
|
|
22799
|
+
"anyOf": [
|
|
22800
|
+
{
|
|
22801
|
+
"$ref": "#/definitions/Model"
|
|
22802
|
+
},
|
|
22803
|
+
{
|
|
22804
|
+
"type": "string"
|
|
22805
|
+
}
|
|
22806
|
+
]
|
|
22755
22807
|
},
|
|
22756
22808
|
"ui.get-component-state:output": {
|
|
22757
22809
|
"$ref": "#/definitions/State"
|
|
@@ -22793,7 +22845,14 @@
|
|
|
22793
22845
|
]
|
|
22794
22846
|
},
|
|
22795
22847
|
"ui.get-visual-state:input": {
|
|
22796
|
-
"
|
|
22848
|
+
"anyOf": [
|
|
22849
|
+
{
|
|
22850
|
+
"$ref": "#/definitions/Model"
|
|
22851
|
+
},
|
|
22852
|
+
{
|
|
22853
|
+
"type": "string"
|
|
22854
|
+
}
|
|
22855
|
+
]
|
|
22797
22856
|
},
|
|
22798
22857
|
"ui.get-visual-state:output": {
|
|
22799
22858
|
"type": "string"
|
package/package.json
CHANGED
package/version.d.ts
CHANGED
package/version.js
CHANGED