@vertigis/viewer-spec 56.1.0 → 56.3.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.
@@ -1,4 +1,6 @@
1
1
  import type Point from "@arcgis/core/geometry/Point.js";
2
+ import type { ItemRef } from "app-config/common/ItemRef.js";
3
+ import type { CoordinateOptionProperties } from "app-config/web/CoordinateModelProperties.js";
2
4
  import type { Command } from "../Command.js";
3
5
  import { CommandRegistry } from "../CommandRegistry.js";
4
6
  import type { Event } from "../Event.js";
@@ -93,6 +95,13 @@ export interface OpenUrlArgs {
93
95
  * The URL to open.
94
96
  */
95
97
  url: string;
98
+ /**
99
+ * The coordinate option to use when formatting coordinate tokens. Valid
100
+ * options must support latitude and longitude. Can be a reference to an
101
+ * existing 'coordinate-option' item, or inline JSON defining a coordinate
102
+ * option item.
103
+ */
104
+ coordinateOption?: ItemRef | CoordinateOptionProperties;
96
105
  /**
97
106
  * An object containing arguments that this command was originally executed
98
107
  * with. This property is populated automatically when using a bound action.
@@ -87,6 +87,11 @@ export interface IdentifyArgs {
87
87
  * VertiGIS Studio Mobile.
88
88
  */
89
89
  returnGeometry?: boolean;
90
+ /**
91
+ * List of fields that should be returned that overrides the default out
92
+ * fields. Not supported in VertiGIS Studio Mobile.
93
+ */
94
+ outFields?: string[];
90
95
  /**
91
96
  * The spatial reference for the returned geometry. Not supported in
92
97
  * VertiGIS Studio Mobile.
@@ -1021,6 +1021,51 @@
1021
1021
  },
1022
1022
  "type": "object"
1023
1023
  },
1024
+ "CoordinateFormat": {
1025
+ "description": "The format in which a map coordinate could be displayed.",
1026
+ "enum": [
1027
+ "lat-long-dd",
1028
+ "lat-long-ddm",
1029
+ "lat-long-dms",
1030
+ "mgrs",
1031
+ "usng",
1032
+ "utm",
1033
+ "xy"
1034
+ ],
1035
+ "type": "string"
1036
+ },
1037
+ "CoordinateOptionProperties": {
1038
+ "additionalProperties": false,
1039
+ "description": "Options for configuring the display of map coordinates.",
1040
+ "properties": {
1041
+ "format": {
1042
+ "$ref": "#/definitions/CoordinateFormat",
1043
+ "description": "The format to display map coordinates in."
1044
+ },
1045
+ "id": {
1046
+ "description": "The unique ID of the Coordinate Option.",
1047
+ "type": "string"
1048
+ },
1049
+ "precision": {
1050
+ "description": "For LAT_LONG and XY coordinate formats, this property depicts the number of decimal places displayed. For MGRS and USNG coordinate formats, this property depicts the precision of the coordinates using an integer between 0 and 8 (inclusive). This Value is ignored by UTM coordinate formats. The default values for coordinate formats are as follows: LAT_LONG=4, XY=2, MGRS=5, and USNG=5.",
1051
+ "type": "number"
1052
+ },
1053
+ "spatialReference": {
1054
+ "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson",
1055
+ "description": "The spatial reference to display map coordinates in. If this property is not defined, the spatial reference of the map will be used."
1056
+ },
1057
+ "title": {
1058
+ "description": "The display name of the CoordinateOption.",
1059
+ "type": "string"
1060
+ }
1061
+ },
1062
+ "required": [
1063
+ "format",
1064
+ "id",
1065
+ "title"
1066
+ ],
1067
+ "type": "object"
1068
+ },
1024
1069
  "CreateGraphicsArgs": {
1025
1070
  "additionalProperties": false,
1026
1071
  "description": "Arguments for the \"drawing.create-graphics\" operation. `GeometryLike`, `FeaturesLike` and `SymbolLike` are only available in Web.",
@@ -2006,6 +2051,13 @@
2006
2051
  "description": "The maximum number of results to return per source. Not supported in VertiGIS Studio Mobile.",
2007
2052
  "type": "number"
2008
2053
  },
2054
+ "outFields": {
2055
+ "description": "List of fields that should be returned that overrides the default out fields. Not supported in VertiGIS Studio Mobile.",
2056
+ "items": {
2057
+ "type": "string"
2058
+ },
2059
+ "type": "array"
2060
+ },
2009
2061
  "outSpatialReference": {
2010
2062
  "$ref": "#/definitions/esri.SpatialReference",
2011
2063
  "description": "The spatial reference for the returned geometry. Not supported in VertiGIS Studio Mobile."
@@ -2238,6 +2290,17 @@
2238
2290
  "context": {
2239
2291
  "description": "An object containing arguments that this command was originally executed with. This property is populated automatically when using a bound action. The URL will be the configured value, and the context is automatically populated as the argument that was passed into the execute method when the command was executed in context."
2240
2292
  },
2293
+ "coordinateOption": {
2294
+ "anyOf": [
2295
+ {
2296
+ "$ref": "#/definitions/CoordinateOptionProperties"
2297
+ },
2298
+ {
2299
+ "type": "string"
2300
+ }
2301
+ ],
2302
+ "description": "The coordinate option to use when formatting coordinate tokens. Valid options must support latitude and longitude. Can be a reference to an existing 'coordinate-option' item, or inline JSON defining a coordinate option item."
2303
+ },
2241
2304
  "numberFormatterLocale": {
2242
2305
  "description": "The locale to use for number token substitution. Accepts a valid locale code (example: \"en\", \"fr\" or \"de-AT\"), or \"device\" or \"invariant\" which will use the device's current culture or the invariant culture, respectively. Default is invariant culture.",
2243
2306
  "type": "string"
@@ -3198,6 +3261,17 @@
3198
3261
  "additionalProperties": false,
3199
3262
  "description": "VertiGIS Studio Web's arguments for the system.open-url command.",
3200
3263
  "properties": {
3264
+ "coordinateOption": {
3265
+ "anyOf": [
3266
+ {
3267
+ "$ref": "#/definitions/CoordinateOptionProperties"
3268
+ },
3269
+ {
3270
+ "type": "string"
3271
+ }
3272
+ ],
3273
+ "description": "The coordinate option to use when formatting coordinate tokens. Valid options must support latitude and longitude. Can be a reference to an existing 'coordinate-option' item, or inline JSON defining a coordinate option item."
3274
+ },
3201
3275
  "features": {
3202
3276
  "$ref": "#/definitions/FeaturesLike",
3203
3277
  "description": "Features to use for the command/operation."
@@ -1141,6 +1141,51 @@
1141
1141
  },
1142
1142
  "type": "object"
1143
1143
  },
1144
+ "CoordinateFormat": {
1145
+ "description": "The format in which a map coordinate could be displayed.",
1146
+ "enum": [
1147
+ "lat-long-dd",
1148
+ "lat-long-ddm",
1149
+ "lat-long-dms",
1150
+ "mgrs",
1151
+ "usng",
1152
+ "utm",
1153
+ "xy"
1154
+ ],
1155
+ "type": "string"
1156
+ },
1157
+ "CoordinateOptionProperties": {
1158
+ "additionalProperties": false,
1159
+ "description": "Options for configuring the display of map coordinates.",
1160
+ "properties": {
1161
+ "format": {
1162
+ "$ref": "#/definitions/CoordinateFormat",
1163
+ "description": "The format to display map coordinates in."
1164
+ },
1165
+ "id": {
1166
+ "description": "The unique ID of the Coordinate Option.",
1167
+ "type": "string"
1168
+ },
1169
+ "precision": {
1170
+ "description": "For LAT_LONG and XY coordinate formats, this property depicts the number of decimal places displayed. For MGRS and USNG coordinate formats, this property depicts the precision of the coordinates using an integer between 0 and 8 (inclusive). This Value is ignored by UTM coordinate formats. The default values for coordinate formats are as follows: LAT_LONG=4, XY=2, MGRS=5, and USNG=5.",
1171
+ "type": "number"
1172
+ },
1173
+ "spatialReference": {
1174
+ "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson",
1175
+ "description": "The spatial reference to display map coordinates in. If this property is not defined, the spatial reference of the map will be used."
1176
+ },
1177
+ "title": {
1178
+ "description": "The display name of the CoordinateOption.",
1179
+ "type": "string"
1180
+ }
1181
+ },
1182
+ "required": [
1183
+ "format",
1184
+ "id",
1185
+ "title"
1186
+ ],
1187
+ "type": "object"
1188
+ },
1144
1189
  "CoordinateTransformation": {
1145
1190
  "additionalProperties": false,
1146
1191
  "description": "Result of the \"map.get-coordinate-transformation\" operation.",
@@ -2519,6 +2564,13 @@
2519
2564
  "description": "The maximum number of results to return per source. Not supported in VertiGIS Studio Mobile.",
2520
2565
  "type": "number"
2521
2566
  },
2567
+ "outFields": {
2568
+ "description": "List of fields that should be returned that overrides the default out fields. Not supported in VertiGIS Studio Mobile.",
2569
+ "items": {
2570
+ "type": "string"
2571
+ },
2572
+ "type": "array"
2573
+ },
2522
2574
  "outSpatialReference": {
2523
2575
  "$ref": "#/definitions/esri.SpatialReference",
2524
2576
  "description": "The spatial reference for the returned geometry. Not supported in VertiGIS Studio Mobile."
@@ -2944,6 +2996,17 @@
2944
2996
  "context": {
2945
2997
  "description": "An object containing arguments that this command was originally executed with. This property is populated automatically when using a bound action. The URL will be the configured value, and the context is automatically populated as the argument that was passed into the execute method when the command was executed in context."
2946
2998
  },
2999
+ "coordinateOption": {
3000
+ "anyOf": [
3001
+ {
3002
+ "$ref": "#/definitions/CoordinateOptionProperties"
3003
+ },
3004
+ {
3005
+ "type": "string"
3006
+ }
3007
+ ],
3008
+ "description": "The coordinate option to use when formatting coordinate tokens. Valid options must support latitude and longitude. Can be a reference to an existing 'coordinate-option' item, or inline JSON defining a coordinate option item."
3009
+ },
2947
3010
  "numberFormatterLocale": {
2948
3011
  "description": "The locale to use for number token substitution. Accepts a valid locale code (example: \"en\", \"fr\" or \"de-AT\"), or \"device\" or \"invariant\" which will use the device's current culture or the invariant culture, respectively. Default is invariant culture.",
2949
3012
  "type": "string"
@@ -4239,6 +4302,17 @@
4239
4302
  "additionalProperties": false,
4240
4303
  "description": "VertiGIS Studio Web's arguments for the system.open-url command.",
4241
4304
  "properties": {
4305
+ "coordinateOption": {
4306
+ "anyOf": [
4307
+ {
4308
+ "$ref": "#/definitions/CoordinateOptionProperties"
4309
+ },
4310
+ {
4311
+ "type": "string"
4312
+ }
4313
+ ],
4314
+ "description": "The coordinate option to use when formatting coordinate tokens. Valid options must support latitude and longitude. Can be a reference to an existing 'coordinate-option' item, or inline JSON defining a coordinate option item."
4315
+ },
4242
4316
  "features": {
4243
4317
  "$ref": "#/definitions/FeaturesLike",
4244
4318
  "description": "Features to use for the command/operation."
@@ -718,6 +718,13 @@
718
718
  "$ref": "__type",
719
719
  "description": "An optional callback that will be invoked with additional information about the tasks's result for each source."
720
720
  },
721
+ "outFields": {
722
+ "description": "List of fields that should be returned that overrides the default out fields.",
723
+ "items": {
724
+ "type": "string"
725
+ },
726
+ "type": "array"
727
+ },
721
728
  "outSpatialReference": {
722
729
  "$ref": "#/definitions/esri.SpatialReference",
723
730
  "description": "The spatial reference for the returned geometry."
@@ -1487,6 +1494,51 @@
1487
1494
  ],
1488
1495
  "type": "object"
1489
1496
  },
1497
+ "CoordinateFormat": {
1498
+ "description": "The format in which a map coordinate could be displayed.",
1499
+ "enum": [
1500
+ "lat-long-dd",
1501
+ "lat-long-ddm",
1502
+ "lat-long-dms",
1503
+ "mgrs",
1504
+ "usng",
1505
+ "utm",
1506
+ "xy"
1507
+ ],
1508
+ "type": "string"
1509
+ },
1510
+ "CoordinateOptionProperties": {
1511
+ "additionalProperties": false,
1512
+ "description": "Options for configuring the display of map coordinates.",
1513
+ "properties": {
1514
+ "format": {
1515
+ "$ref": "#/definitions/CoordinateFormat",
1516
+ "description": "The format to display map coordinates in."
1517
+ },
1518
+ "id": {
1519
+ "description": "The unique ID of the Coordinate Option.",
1520
+ "type": "string"
1521
+ },
1522
+ "precision": {
1523
+ "description": "For LAT_LONG and XY coordinate formats, this property depicts the number of decimal places displayed. For MGRS and USNG coordinate formats, this property depicts the precision of the coordinates using an integer between 0 and 8 (inclusive). This Value is ignored by UTM coordinate formats. The default values for coordinate formats are as follows: LAT_LONG=4, XY=2, MGRS=5, and USNG=5.",
1524
+ "type": "number"
1525
+ },
1526
+ "spatialReference": {
1527
+ "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson",
1528
+ "description": "The spatial reference to display map coordinates in. If this property is not defined, the spatial reference of the map will be used."
1529
+ },
1530
+ "title": {
1531
+ "description": "The display name of the CoordinateOption.",
1532
+ "type": "string"
1533
+ }
1534
+ },
1535
+ "required": [
1536
+ "format",
1537
+ "id",
1538
+ "title"
1539
+ ],
1540
+ "type": "object"
1541
+ },
1490
1542
  "CreateFeatureArgs": {
1491
1543
  "additionalProperties": false,
1492
1544
  "description": "Arguments for the \"edit.create-feature\" operation. A valid feature layer, subtype group layer, or subtype sublayer is required. The geometry is required for non-tabular features. Web only.",
@@ -3953,6 +4005,13 @@
3953
4005
  "description": "The maximum number of results to return per source. Not supported in VertiGIS Studio Mobile.",
3954
4006
  "type": "number"
3955
4007
  },
4008
+ "outFields": {
4009
+ "description": "List of fields that should be returned that overrides the default out fields. Not supported in VertiGIS Studio Mobile.",
4010
+ "items": {
4011
+ "type": "string"
4012
+ },
4013
+ "type": "array"
4014
+ },
3956
4015
  "outSpatialReference": {
3957
4016
  "$ref": "#/definitions/esri.SpatialReference",
3958
4017
  "description": "The spatial reference for the returned geometry. Not supported in VertiGIS Studio Mobile."
@@ -4688,6 +4747,17 @@
4688
4747
  "context": {
4689
4748
  "description": "An object containing arguments that this command was originally executed with. This property is populated automatically when using a bound action. The URL will be the configured value, and the context is automatically populated as the argument that was passed into the execute method when the command was executed in context."
4690
4749
  },
4750
+ "coordinateOption": {
4751
+ "anyOf": [
4752
+ {
4753
+ "$ref": "#/definitions/CoordinateOptionProperties"
4754
+ },
4755
+ {
4756
+ "type": "string"
4757
+ }
4758
+ ],
4759
+ "description": "The coordinate option to use when formatting coordinate tokens. Valid options must support latitude and longitude. Can be a reference to an existing 'coordinate-option' item, or inline JSON defining a coordinate option item."
4760
+ },
4691
4761
  "numberFormatterLocale": {
4692
4762
  "description": "The locale to use for number token substitution. Accepts a valid locale code (example: \"en\", \"fr\" or \"de-AT\"), or \"device\" or \"invariant\" which will use the device's current culture or the invariant culture, respectively. Default is invariant culture.",
4693
4763
  "type": "string"
@@ -7450,6 +7520,17 @@
7450
7520
  "additionalProperties": false,
7451
7521
  "description": "VertiGIS Studio Web's arguments for the system.open-url command.",
7452
7522
  "properties": {
7523
+ "coordinateOption": {
7524
+ "anyOf": [
7525
+ {
7526
+ "$ref": "#/definitions/CoordinateOptionProperties"
7527
+ },
7528
+ {
7529
+ "type": "string"
7530
+ }
7531
+ ],
7532
+ "description": "The coordinate option to use when formatting coordinate tokens. Valid options must support latitude and longitude. Can be a reference to an existing 'coordinate-option' item, or inline JSON defining a coordinate option item."
7533
+ },
7453
7534
  "features": {
7454
7535
  "$ref": "#/definitions/FeaturesLike",
7455
7536
  "description": "Features to use for the command/operation."
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertigis/viewer-spec",
3
- "version": "56.1.0",
3
+ "version": "56.3.0",
4
4
  "license": "SEE LICENSE IN LICENSE",
5
5
  "description": "VertiGIS Viewer Specification",
6
6
  "type": "module",
@@ -43,7 +43,7 @@
43
43
  ],
44
44
  "peerDependencies": {
45
45
  "@arcgis/core": "*",
46
- "@vertigis/arcgis-extensions": ">= 41.0.0 < 42.0.0"
46
+ "@vertigis/arcgis-extensions": ">= 41.2.0 < 42.0.0"
47
47
  },
48
48
  "devDependencies": {
49
49
  "@prettier/plugin-xml": "2.2.0",
package/version.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * The current version of the VertiGIS Studio Viewer Specification.
3
3
  */
4
- export declare const version = "56.1.0";
4
+ export declare const version = "56.3.0";
package/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * The current version of the VertiGIS Studio Viewer Specification.
3
3
  */
4
- export const version = "56.1.0";
4
+ export const version = "56.3.0";