@vertigis/viewer-spec 60.8.1 → 60.9.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/messaging/schema/common-action.schema.json +1923 -164
- package/messaging/schema/common-event.schema.json +2350 -348
- package/messaging/schema/mobile-action.schema.json +2076 -269
- package/messaging/schema/mobile-event.schema.json +2344 -351
- package/messaging/schema/web-action.schema.json +1130 -5
- package/messaging/schema/web-event.schema.json +1386 -9
- package/package.json +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -1,6 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$ref": "#/definitions/viewer-spec.Event",
|
|
3
3
|
"definitions": {
|
|
4
|
+
"@vertigis.arcgis-extensions.FailureMode.FailureMode": {
|
|
5
|
+
"description": "Possible modes of failure when there is an error resolving or initializing an item.",
|
|
6
|
+
"enum": [
|
|
7
|
+
"error",
|
|
8
|
+
"ignore",
|
|
9
|
+
"warn"
|
|
10
|
+
],
|
|
11
|
+
"type": "string"
|
|
12
|
+
},
|
|
4
13
|
"@vertigis.arcgis-extensions.data._TableExtension.TableReference": {
|
|
5
14
|
"additionalProperties": false,
|
|
6
15
|
"description": "Matches an existing table in a map.",
|
|
@@ -16,6 +25,89 @@
|
|
|
16
25
|
},
|
|
17
26
|
"type": "object"
|
|
18
27
|
},
|
|
28
|
+
"@vertigis.arcgis-extensions.mapping.BasemapExtension.BasemapProperties": {
|
|
29
|
+
"additionalProperties": false,
|
|
30
|
+
"description": "Properties that can be specified for the {@link mapping /BasemapExtension!BasemapExtensionProperties.basemap} property.",
|
|
31
|
+
"properties": {
|
|
32
|
+
"baseMapLayers": {
|
|
33
|
+
"description": "An array of BasemapLayer objects defining the basemaps used in the web map/web scene.",
|
|
34
|
+
"items": {
|
|
35
|
+
"$ref": "#/definitions/BasemapLayerJson"
|
|
36
|
+
},
|
|
37
|
+
"type": "array"
|
|
38
|
+
},
|
|
39
|
+
"elevationLayers": {
|
|
40
|
+
"description": "Deprecated, use ground.layers instead. An array of elevationLayer objects defining the basemaps used in the web scene.",
|
|
41
|
+
"items": {
|
|
42
|
+
"$ref": "#/definitions/ElevationLayerJson"
|
|
43
|
+
},
|
|
44
|
+
"type": "array"
|
|
45
|
+
},
|
|
46
|
+
"id": {
|
|
47
|
+
"description": "An identifier used to refer to the basemap when referencing it elsewhere.\n\nNOTE: Only available in web scenes!",
|
|
48
|
+
"type": "string"
|
|
49
|
+
},
|
|
50
|
+
"title": {
|
|
51
|
+
"description": "String title for the basemap that can be used in a table of contents. If not defined, then it takes the title of the first baseMapLayer in the array.",
|
|
52
|
+
"type": "string"
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
"type": "object"
|
|
56
|
+
},
|
|
57
|
+
"@vertigis.arcgis-extensions.mapping.MapExtension.ViewMode": {
|
|
58
|
+
"description": "Viewing mode for a map (2D map or 3D scene).",
|
|
59
|
+
"enum": [
|
|
60
|
+
"map",
|
|
61
|
+
"scene"
|
|
62
|
+
],
|
|
63
|
+
"type": "string"
|
|
64
|
+
},
|
|
65
|
+
"@vertigis.arcgis-extensions.mapping.MapExtension.WebMapLike": {
|
|
66
|
+
"anyOf": [
|
|
67
|
+
{
|
|
68
|
+
"$ref": "#/definitions/esri.PortalItem"
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"$ref": "#/definitions/esri.rest-api.ItemJson.ItemJson"
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"$ref": "@vertigis.arcgis-extensions.PortalUri.PortalUri"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"$ref": "@vertigis.arcgis-extensions.utilities.uri.Uri"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.WebMapJson"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"type": "string"
|
|
84
|
+
}
|
|
85
|
+
],
|
|
86
|
+
"description": "A web map definition or reference."
|
|
87
|
+
},
|
|
88
|
+
"@vertigis.arcgis-extensions.mapping.MapExtension.WebSceneLike": {
|
|
89
|
+
"anyOf": [
|
|
90
|
+
{
|
|
91
|
+
"$ref": "#/definitions/esri.PortalItem"
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"$ref": "#/definitions/esri.rest-api.ItemJson.ItemJson"
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
"$ref": "@vertigis.arcgis-extensions.PortalUri.PortalUri"
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"$ref": "@vertigis.arcgis-extensions.utilities.uri.Uri"
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
"$ref": "#/definitions/esri.rest-api.WebSceneJson.WebSceneJson"
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"type": "string"
|
|
107
|
+
}
|
|
108
|
+
],
|
|
109
|
+
"description": "A web scene definition or reference."
|
|
110
|
+
},
|
|
19
111
|
"@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference": {
|
|
20
112
|
"additionalProperties": false,
|
|
21
113
|
"description": "Matches an existing layer.",
|
|
@@ -43,10 +135,45 @@
|
|
|
43
135
|
},
|
|
44
136
|
"type": "object"
|
|
45
137
|
},
|
|
138
|
+
"@vertigis.arcgis-extensions.support.Action.BoundAction": {
|
|
139
|
+
"additionalProperties": false,
|
|
140
|
+
"description": "An action that is bound to arguments.",
|
|
141
|
+
"properties": {
|
|
142
|
+
"arguments": {
|
|
143
|
+
"description": "Arguments for the action. Can either be a primitive value (string, number, boolean), or a plain JSON object containing named arguments."
|
|
144
|
+
},
|
|
145
|
+
"name": {
|
|
146
|
+
"description": "Determines which action to perform. It is up to the calling application how it transforms an action name into actual executable code.",
|
|
147
|
+
"type": "string"
|
|
148
|
+
}
|
|
149
|
+
},
|
|
150
|
+
"required": [
|
|
151
|
+
"arguments",
|
|
152
|
+
"name"
|
|
153
|
+
],
|
|
154
|
+
"type": "object"
|
|
155
|
+
},
|
|
156
|
+
"@vertigis.arcgis-extensions.support.Action.CompositeAction": {
|
|
157
|
+
"description": "A composite action that is made up of a sequence of one or more actions. The intent is that the application should execute these in the given order. If any of the actions produces an output, that should be used as the input arguments for all subsequent actions.",
|
|
158
|
+
"items": {
|
|
159
|
+
"$ref": "#/definitions/SimpleAction"
|
|
160
|
+
},
|
|
161
|
+
"type": "array"
|
|
162
|
+
},
|
|
46
163
|
"ArcGISPortalIdentity": {
|
|
47
164
|
"additionalProperties": false,
|
|
48
165
|
"type": "object"
|
|
49
166
|
},
|
|
167
|
+
"ArrayBufferLike": {
|
|
168
|
+
"anyOf": [
|
|
169
|
+
{
|
|
170
|
+
"$ref": "ArrayBuffer"
|
|
171
|
+
},
|
|
172
|
+
{
|
|
173
|
+
"$ref": "SharedArrayBuffer"
|
|
174
|
+
}
|
|
175
|
+
]
|
|
176
|
+
},
|
|
50
177
|
"AuthenticationType": {
|
|
51
178
|
"description": "A type of authentication.",
|
|
52
179
|
"enum": [
|
|
@@ -57,6 +184,41 @@
|
|
|
57
184
|
],
|
|
58
185
|
"type": "string"
|
|
59
186
|
},
|
|
187
|
+
"BasemapLayerJson": {
|
|
188
|
+
"anyOf": [
|
|
189
|
+
{
|
|
190
|
+
"$ref": "#/definitions/esri.rest-api.ImageServiceLayerJson.ImageServiceLayerJson"
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"$ref": "#/definitions/esri.rest-api.ImageServiceVectorLayerJson.ImageServiceVectorLayerJson"
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
"$ref": "#/definitions/esri.rest-api.MapServiceLayerJson.MapServiceLayerJson"
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"$ref": "#/definitions/esri.rest-api.TiledImageServiceLayerJson.TiledImageServiceLayerJson"
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
"$ref": "#/definitions/esri.rest-api.TiledMapServiceLayerJson.TiledMapServiceLayerJson"
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"$ref": "#/definitions/esri.rest-api.VectorTileLayerJson.VectorTileLayerJson"
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
"$ref": "#/definitions/esri.rest-api.WebTileLayerJson.WebTileLayerJson"
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
"$ref": "#/definitions/esri.rest-api.WMSLayerJson.WMSLayerJson"
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"$ref": "#/definitions/esri.rest-api.BingLayerJson.BingLayerJson"
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
"$ref": "#/definitions/esri.rest-api.OpenStreetMapLayerJson.OpenStreetMapLayerJson"
|
|
218
|
+
}
|
|
219
|
+
],
|
|
220
|
+
"description": "A base map layer in a web map/scene."
|
|
221
|
+
},
|
|
60
222
|
"DataSourceJson": {
|
|
61
223
|
"anyOf": [
|
|
62
224
|
{
|
|
@@ -154,6 +316,17 @@
|
|
|
154
316
|
],
|
|
155
317
|
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
156
318
|
},
|
|
319
|
+
"ElevationLayerJson": {
|
|
320
|
+
"anyOf": [
|
|
321
|
+
{
|
|
322
|
+
"$ref": "#/definitions/esri.rest-api.RasterDataElevationLayerJson.RasterDataElevationLayerJson"
|
|
323
|
+
},
|
|
324
|
+
{
|
|
325
|
+
"$ref": "#/definitions/esri.rest-api.TiledElevationServiceLayerJson.TiledElevationServiceLayerJson"
|
|
326
|
+
}
|
|
327
|
+
],
|
|
328
|
+
"description": "Elevation layers that can be used in a web scene's ground."
|
|
329
|
+
},
|
|
157
330
|
"Error": {
|
|
158
331
|
"additionalProperties": false,
|
|
159
332
|
"properties": {
|
|
@@ -383,6 +556,17 @@
|
|
|
383
556
|
],
|
|
384
557
|
"description": "One or more objects that are convertible to layer extensions."
|
|
385
558
|
},
|
|
559
|
+
"LightingJson": {
|
|
560
|
+
"anyOf": [
|
|
561
|
+
{
|
|
562
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.SunLightingJson"
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.VirtualLightingJson"
|
|
566
|
+
}
|
|
567
|
+
],
|
|
568
|
+
"description": "Settings for defining the lighting of the scene."
|
|
569
|
+
},
|
|
386
570
|
"MapEvent": {
|
|
387
571
|
"additionalProperties": false,
|
|
388
572
|
"description": "Arguments for the various map events.",
|
|
@@ -737,6 +921,17 @@
|
|
|
737
921
|
],
|
|
738
922
|
"type": "object"
|
|
739
923
|
},
|
|
924
|
+
"SimpleAction": {
|
|
925
|
+
"anyOf": [
|
|
926
|
+
{
|
|
927
|
+
"$ref": "#/definitions/@vertigis.arcgis-extensions.support.Action.BoundAction"
|
|
928
|
+
},
|
|
929
|
+
{
|
|
930
|
+
"type": "string"
|
|
931
|
+
}
|
|
932
|
+
],
|
|
933
|
+
"description": "Defines a single action to perform."
|
|
934
|
+
},
|
|
740
935
|
"Symbol2DJson": {
|
|
741
936
|
"anyOf": [
|
|
742
937
|
{
|
|
@@ -817,6 +1012,26 @@
|
|
|
817
1012
|
],
|
|
818
1013
|
"description": "A visualVariable is an object containing the type of drawing property, the axis the variable is applied to, and additional properties for the variable. There are three types of visual variables, 'colorInfo', 'sizeInfo', and 'transparencyInfo'.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/visualVariable/} {@link https://developers.arcgis.com/web-scene-specification/objects/visualVariable/}."
|
|
819
1014
|
},
|
|
1015
|
+
"WeatherJson": {
|
|
1016
|
+
"anyOf": [
|
|
1017
|
+
{
|
|
1018
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.CloudyWeatherJson"
|
|
1019
|
+
},
|
|
1020
|
+
{
|
|
1021
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.FoggyWeatherJson"
|
|
1022
|
+
},
|
|
1023
|
+
{
|
|
1024
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.RainyWeatherJson"
|
|
1025
|
+
},
|
|
1026
|
+
{
|
|
1027
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.SunnyWeatherJson"
|
|
1028
|
+
},
|
|
1029
|
+
{
|
|
1030
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.SnowyWeatherJson"
|
|
1031
|
+
}
|
|
1032
|
+
],
|
|
1033
|
+
"description": "Indicates the type of weather visualization in the scene."
|
|
1034
|
+
},
|
|
820
1035
|
"WorkflowErrorEventArgs": {
|
|
821
1036
|
"additionalProperties": false,
|
|
822
1037
|
"description": "Arguments for the \"workflow.workflow-error\" event.",
|
|
@@ -955,6 +1170,9 @@
|
|
|
955
1170
|
"esri.Point": {
|
|
956
1171
|
"$ref": "esri/geometry/Point"
|
|
957
1172
|
},
|
|
1173
|
+
"esri.PortalItem": {
|
|
1174
|
+
"$ref": "esri/portal/PortalItem"
|
|
1175
|
+
},
|
|
958
1176
|
"esri.rest-api.AnnotationLayerJson.AnnotationLayerJson": {
|
|
959
1177
|
"additionalProperties": false,
|
|
960
1178
|
"description": "Annotation layers can be created by referencing a layer from a feature service. Annotation layers honor any feature templates configured in the source document.",
|
|
@@ -1110,44 +1328,41 @@
|
|
|
1110
1328
|
],
|
|
1111
1329
|
"type": "object"
|
|
1112
1330
|
},
|
|
1113
|
-
"esri.rest-api.
|
|
1331
|
+
"esri.rest-api.BasemapJson.BasemapJson": {
|
|
1114
1332
|
"additionalProperties": false,
|
|
1115
|
-
"description": "
|
|
1333
|
+
"description": "A basemap layer is a layer that provides geographic context to the map. A web map always contains a basemap. A web scene is not required to always contain a basemap. The basemap has a title and is the combination of each BasemapLayer.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/basemap/}.",
|
|
1116
1334
|
"properties": {
|
|
1117
|
-
"
|
|
1118
|
-
"description": "
|
|
1335
|
+
"baseMapLayers": {
|
|
1336
|
+
"description": "An array of BasemapLayer objects defining the basemaps used in the web map/web scene.",
|
|
1119
1337
|
"items": {
|
|
1120
|
-
"$ref": "#/definitions/
|
|
1338
|
+
"$ref": "#/definitions/BasemapLayerJson"
|
|
1121
1339
|
},
|
|
1122
1340
|
"type": "array"
|
|
1123
|
-
}
|
|
1124
|
-
},
|
|
1125
|
-
"type": "object"
|
|
1126
|
-
},
|
|
1127
|
-
"esri.rest-api.BuildingSceneLayerJson.AuthoringInfoFilterTypeJson": {
|
|
1128
|
-
"additionalProperties": false,
|
|
1129
|
-
"description": "The file authoring information for a filter, including the filter type and its value settings.",
|
|
1130
|
-
"properties": {
|
|
1131
|
-
"filterType": {
|
|
1132
|
-
"description": "Represents the filter type name. Name is a unique identifier.",
|
|
1133
|
-
"type": "string"
|
|
1134
1341
|
},
|
|
1135
|
-
"
|
|
1136
|
-
"description": "
|
|
1342
|
+
"elevationLayers": {
|
|
1343
|
+
"description": "Deprecated, use ground.layers instead. An array of elevationLayer objects defining the basemaps used in the web scene.",
|
|
1137
1344
|
"items": {
|
|
1138
|
-
"
|
|
1345
|
+
"$ref": "#/definitions/ElevationLayerJson"
|
|
1139
1346
|
},
|
|
1140
1347
|
"type": "array"
|
|
1348
|
+
},
|
|
1349
|
+
"id": {
|
|
1350
|
+
"description": "An identifier used to refer to the basemap when referencing it elsewhere.\n\nNOTE: Only available in web scenes!",
|
|
1351
|
+
"type": "string"
|
|
1352
|
+
},
|
|
1353
|
+
"title": {
|
|
1354
|
+
"description": "String title for the basemap that can be used in a table of contents. If not defined, then it takes the title of the first baseMapLayer in the array.",
|
|
1355
|
+
"type": "string"
|
|
1141
1356
|
}
|
|
1142
1357
|
},
|
|
1143
1358
|
"type": "object"
|
|
1144
1359
|
},
|
|
1145
|
-
"esri.rest-api.
|
|
1360
|
+
"esri.rest-api.BingLayerJson.BingLayerJson": {
|
|
1146
1361
|
"additionalProperties": false,
|
|
1147
|
-
"description": "
|
|
1362
|
+
"description": "Indicates if working with Microsoft Bing layers. There are three layer types associated with Bing Layers: BingMapsAerial, BingMapsRoad, and BingMapsHybrid.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/bingLayer/}.",
|
|
1148
1363
|
"properties": {
|
|
1149
|
-
"
|
|
1150
|
-
"description": "
|
|
1364
|
+
"bingKey": {
|
|
1365
|
+
"description": "String value that unlocks the use of Bing layers in a web map.",
|
|
1151
1366
|
"type": "string"
|
|
1152
1367
|
},
|
|
1153
1368
|
"blendMode": {
|
|
@@ -1187,40 +1402,32 @@
|
|
|
1187
1402
|
],
|
|
1188
1403
|
"type": "string"
|
|
1189
1404
|
},
|
|
1405
|
+
"canShareBingPublic": {
|
|
1406
|
+
"description": "Boolean value indicating whether the Bing key can be shared to the public.",
|
|
1407
|
+
"type": "boolean"
|
|
1408
|
+
},
|
|
1190
1409
|
"effect": {
|
|
1191
1410
|
"$ref": "#/definitions/EffectJson",
|
|
1192
1411
|
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
1193
1412
|
},
|
|
1194
|
-
"filters": {
|
|
1195
|
-
"description": "A list of filters available for this layer. Overrides filters defined on the service.",
|
|
1196
|
-
"items": {
|
|
1197
|
-
"$ref": "#/definitions/esri.rest-api.BuildingSceneLayerJson.FilterJson"
|
|
1198
|
-
},
|
|
1199
|
-
"type": "array"
|
|
1200
|
-
},
|
|
1201
1413
|
"id": {
|
|
1202
1414
|
"description": "A unique identifying string for the layer.",
|
|
1203
1415
|
"type": "string"
|
|
1204
1416
|
},
|
|
1417
|
+
"isReference": {
|
|
1418
|
+
"description": "This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).",
|
|
1419
|
+
"type": "boolean"
|
|
1420
|
+
},
|
|
1205
1421
|
"itemId": {
|
|
1206
1422
|
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
1207
1423
|
"type": "string"
|
|
1208
1424
|
},
|
|
1209
|
-
"layerDefinition": {
|
|
1210
|
-
"$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
|
|
1211
|
-
"description": "Additional properties that can define an elevation offset for the layer."
|
|
1212
|
-
},
|
|
1213
1425
|
"layerType": {
|
|
1214
|
-
"const": "BuildingSceneLayer",
|
|
1215
1426
|
"description": "The type of layer.",
|
|
1216
|
-
"type": "string"
|
|
1217
|
-
},
|
|
1218
|
-
"listMode": {
|
|
1219
|
-
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
1220
1427
|
"enum": [
|
|
1221
|
-
"
|
|
1222
|
-
"
|
|
1223
|
-
"
|
|
1428
|
+
"BingMapsAerial",
|
|
1429
|
+
"BingMapsHybrid",
|
|
1430
|
+
"BingMapsRoad"
|
|
1224
1431
|
],
|
|
1225
1432
|
"type": "string"
|
|
1226
1433
|
},
|
|
@@ -1236,21 +1443,14 @@
|
|
|
1236
1443
|
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
1237
1444
|
"type": "number"
|
|
1238
1445
|
},
|
|
1239
|
-
"
|
|
1240
|
-
"description": "
|
|
1241
|
-
"type": "
|
|
1446
|
+
"portalUrl": {
|
|
1447
|
+
"description": "A string value representing the URL to the portal/organization. Calls should be made to this property to retrieve the Bing key. If the key is not made accessible to the public or if canShareBingPublic is false, any web maps using Bing layers will not work.",
|
|
1448
|
+
"type": "string"
|
|
1242
1449
|
},
|
|
1243
1450
|
"showLegend": {
|
|
1244
1451
|
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
1245
1452
|
"type": "boolean"
|
|
1246
1453
|
},
|
|
1247
|
-
"sublayers": {
|
|
1248
|
-
"description": "An array of objects specifying overrides for building scene layer sublayers.",
|
|
1249
|
-
"items": {
|
|
1250
|
-
"$ref": "#/definitions/esri.rest-api.BuildingSceneSublayerJson.BuildingSceneSublayerJson"
|
|
1251
|
-
},
|
|
1252
|
-
"type": "array"
|
|
1253
|
-
},
|
|
1254
1454
|
"title": {
|
|
1255
1455
|
"description": "A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.",
|
|
1256
1456
|
"type": "string"
|
|
@@ -1269,10 +1469,6 @@
|
|
|
1269
1469
|
],
|
|
1270
1470
|
"type": "string"
|
|
1271
1471
|
},
|
|
1272
|
-
"url": {
|
|
1273
|
-
"description": "The URL to the service.",
|
|
1274
|
-
"type": "string"
|
|
1275
|
-
},
|
|
1276
1472
|
"visibility": {
|
|
1277
1473
|
"description": "Determines whether the layer is initially visible in the web map.",
|
|
1278
1474
|
"type": "boolean"
|
|
@@ -1293,48 +1489,238 @@
|
|
|
1293
1489
|
}
|
|
1294
1490
|
},
|
|
1295
1491
|
"required": [
|
|
1296
|
-
"
|
|
1492
|
+
"bingKey",
|
|
1493
|
+
"canShareBingPublic",
|
|
1494
|
+
"layerType",
|
|
1495
|
+
"portalUrl"
|
|
1297
1496
|
],
|
|
1298
1497
|
"type": "object"
|
|
1299
1498
|
},
|
|
1300
|
-
"esri.rest-api.BuildingSceneLayerJson.
|
|
1499
|
+
"esri.rest-api.BuildingSceneLayerJson.AuthoringInfoFilterBlockJson": {
|
|
1301
1500
|
"additionalProperties": false,
|
|
1302
|
-
"description": "
|
|
1501
|
+
"description": "The filter authoring info object contains metadata about the authoring process for creating a filter block object. This allows the authoring client to save specific, overridable settings. The next time it is accessed via an authoring client, their selections are remembered. Non-authoring clients can ignore it.",
|
|
1303
1502
|
"properties": {
|
|
1304
|
-
"
|
|
1305
|
-
"description": "Array of filter
|
|
1503
|
+
"filterTypes": {
|
|
1504
|
+
"description": "Array of defined filter types. Each filter type has an array of filter values.",
|
|
1306
1505
|
"items": {
|
|
1307
|
-
"$ref": "#/definitions/esri.rest-api.BuildingSceneLayerJson.
|
|
1506
|
+
"$ref": "#/definitions/esri.rest-api.BuildingSceneLayerJson.AuthoringInfoFilterTypeJson"
|
|
1308
1507
|
},
|
|
1309
1508
|
"type": "array"
|
|
1310
|
-
},
|
|
1311
|
-
"type": {
|
|
1312
|
-
"const": "checkbox",
|
|
1313
|
-
"description": "Type of filter authoring info. Value of this property must be checkbox.",
|
|
1314
|
-
"type": "string"
|
|
1315
1509
|
}
|
|
1316
1510
|
},
|
|
1317
|
-
"required": [
|
|
1318
|
-
"type"
|
|
1319
|
-
],
|
|
1320
1511
|
"type": "object"
|
|
1321
1512
|
},
|
|
1322
|
-
"esri.rest-api.BuildingSceneLayerJson.
|
|
1513
|
+
"esri.rest-api.BuildingSceneLayerJson.AuthoringInfoFilterTypeJson": {
|
|
1323
1514
|
"additionalProperties": false,
|
|
1324
|
-
"description": "
|
|
1515
|
+
"description": "The file authoring information for a filter, including the filter type and its value settings.",
|
|
1325
1516
|
"properties": {
|
|
1326
|
-
"
|
|
1327
|
-
"description": "
|
|
1517
|
+
"filterType": {
|
|
1518
|
+
"description": "Represents the filter type name. Name is a unique identifier.",
|
|
1328
1519
|
"type": "string"
|
|
1329
1520
|
},
|
|
1330
|
-
"
|
|
1331
|
-
"
|
|
1332
|
-
"
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
"
|
|
1336
|
-
|
|
1337
|
-
|
|
1521
|
+
"filterValues": {
|
|
1522
|
+
"description": "Array of filter values. Filter values are the attributes that can be stored for individual fields in a layer.",
|
|
1523
|
+
"items": {
|
|
1524
|
+
"type": "string"
|
|
1525
|
+
},
|
|
1526
|
+
"type": "array"
|
|
1527
|
+
}
|
|
1528
|
+
},
|
|
1529
|
+
"type": "object"
|
|
1530
|
+
},
|
|
1531
|
+
"esri.rest-api.BuildingSceneLayerJson.BuildingSceneLayerJson": {
|
|
1532
|
+
"additionalProperties": false,
|
|
1533
|
+
"description": "The BuildingSceneLayer is a layer type designed for on-demand streaming and displaying building data.",
|
|
1534
|
+
"properties": {
|
|
1535
|
+
"activeFilterId": {
|
|
1536
|
+
"description": "Specifies the id of the currently active filter.",
|
|
1537
|
+
"type": "string"
|
|
1538
|
+
},
|
|
1539
|
+
"blendMode": {
|
|
1540
|
+
"description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
|
|
1541
|
+
"enum": [
|
|
1542
|
+
"average",
|
|
1543
|
+
"color",
|
|
1544
|
+
"color-burn",
|
|
1545
|
+
"color-dodge",
|
|
1546
|
+
"darken",
|
|
1547
|
+
"destination-atop",
|
|
1548
|
+
"destination-in",
|
|
1549
|
+
"destination-out",
|
|
1550
|
+
"destination-over",
|
|
1551
|
+
"difference",
|
|
1552
|
+
"exclusion",
|
|
1553
|
+
"hard-light",
|
|
1554
|
+
"hue",
|
|
1555
|
+
"invert",
|
|
1556
|
+
"lighten",
|
|
1557
|
+
"lighter",
|
|
1558
|
+
"luminosity",
|
|
1559
|
+
"minus",
|
|
1560
|
+
"multiply",
|
|
1561
|
+
"normal",
|
|
1562
|
+
"overlay",
|
|
1563
|
+
"plus",
|
|
1564
|
+
"reflect",
|
|
1565
|
+
"saturation",
|
|
1566
|
+
"screen",
|
|
1567
|
+
"soft-light",
|
|
1568
|
+
"source-atop",
|
|
1569
|
+
"source-in",
|
|
1570
|
+
"source-out",
|
|
1571
|
+
"vivid-light",
|
|
1572
|
+
"xor"
|
|
1573
|
+
],
|
|
1574
|
+
"type": "string"
|
|
1575
|
+
},
|
|
1576
|
+
"effect": {
|
|
1577
|
+
"$ref": "#/definitions/EffectJson",
|
|
1578
|
+
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
1579
|
+
},
|
|
1580
|
+
"filters": {
|
|
1581
|
+
"description": "A list of filters available for this layer. Overrides filters defined on the service.",
|
|
1582
|
+
"items": {
|
|
1583
|
+
"$ref": "#/definitions/esri.rest-api.BuildingSceneLayerJson.FilterJson"
|
|
1584
|
+
},
|
|
1585
|
+
"type": "array"
|
|
1586
|
+
},
|
|
1587
|
+
"id": {
|
|
1588
|
+
"description": "A unique identifying string for the layer.",
|
|
1589
|
+
"type": "string"
|
|
1590
|
+
},
|
|
1591
|
+
"itemId": {
|
|
1592
|
+
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
1593
|
+
"type": "string"
|
|
1594
|
+
},
|
|
1595
|
+
"layerDefinition": {
|
|
1596
|
+
"$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
|
|
1597
|
+
"description": "Additional properties that can define an elevation offset for the layer."
|
|
1598
|
+
},
|
|
1599
|
+
"layerType": {
|
|
1600
|
+
"const": "BuildingSceneLayer",
|
|
1601
|
+
"description": "The type of layer.",
|
|
1602
|
+
"type": "string"
|
|
1603
|
+
},
|
|
1604
|
+
"listMode": {
|
|
1605
|
+
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
1606
|
+
"enum": [
|
|
1607
|
+
"hide",
|
|
1608
|
+
"hide-children",
|
|
1609
|
+
"show"
|
|
1610
|
+
],
|
|
1611
|
+
"type": "string"
|
|
1612
|
+
},
|
|
1613
|
+
"maxScale": {
|
|
1614
|
+
"description": "A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.",
|
|
1615
|
+
"type": "number"
|
|
1616
|
+
},
|
|
1617
|
+
"minScale": {
|
|
1618
|
+
"description": "A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.",
|
|
1619
|
+
"type": "number"
|
|
1620
|
+
},
|
|
1621
|
+
"opacity": {
|
|
1622
|
+
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
1623
|
+
"type": "number"
|
|
1624
|
+
},
|
|
1625
|
+
"refreshInterval": {
|
|
1626
|
+
"description": "When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See {@link https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm}.",
|
|
1627
|
+
"type": "number"
|
|
1628
|
+
},
|
|
1629
|
+
"showLegend": {
|
|
1630
|
+
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
1631
|
+
"type": "boolean"
|
|
1632
|
+
},
|
|
1633
|
+
"sublayers": {
|
|
1634
|
+
"description": "An array of objects specifying overrides for building scene layer sublayers.",
|
|
1635
|
+
"items": {
|
|
1636
|
+
"$ref": "#/definitions/esri.rest-api.BuildingSceneSublayerJson.BuildingSceneSublayerJson"
|
|
1637
|
+
},
|
|
1638
|
+
"type": "array"
|
|
1639
|
+
},
|
|
1640
|
+
"title": {
|
|
1641
|
+
"description": "A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.",
|
|
1642
|
+
"type": "string"
|
|
1643
|
+
},
|
|
1644
|
+
"type": {
|
|
1645
|
+
"description": "(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type.",
|
|
1646
|
+
"enum": [
|
|
1647
|
+
"BingMapsAerial",
|
|
1648
|
+
"BingMapsHybrid",
|
|
1649
|
+
"BingMapsRoad",
|
|
1650
|
+
"CSV",
|
|
1651
|
+
"KML",
|
|
1652
|
+
"OpenStreetMap",
|
|
1653
|
+
"WMS",
|
|
1654
|
+
"WebTiledLayer"
|
|
1655
|
+
],
|
|
1656
|
+
"type": "string"
|
|
1657
|
+
},
|
|
1658
|
+
"url": {
|
|
1659
|
+
"description": "The URL to the service.",
|
|
1660
|
+
"type": "string"
|
|
1661
|
+
},
|
|
1662
|
+
"visibility": {
|
|
1663
|
+
"description": "Determines whether the layer is initially visible in the web map.",
|
|
1664
|
+
"type": "boolean"
|
|
1665
|
+
},
|
|
1666
|
+
"visibilityTimeExtent": {
|
|
1667
|
+
"description": "Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.",
|
|
1668
|
+
"items": [
|
|
1669
|
+
{
|
|
1670
|
+
"type": "number"
|
|
1671
|
+
},
|
|
1672
|
+
{
|
|
1673
|
+
"type": "number"
|
|
1674
|
+
}
|
|
1675
|
+
],
|
|
1676
|
+
"maxItems": 2,
|
|
1677
|
+
"minItems": 2,
|
|
1678
|
+
"type": "array"
|
|
1679
|
+
}
|
|
1680
|
+
},
|
|
1681
|
+
"required": [
|
|
1682
|
+
"layerType"
|
|
1683
|
+
],
|
|
1684
|
+
"type": "object"
|
|
1685
|
+
},
|
|
1686
|
+
"esri.rest-api.BuildingSceneLayerJson.FilterAuthoringInfoCheckboxJson": {
|
|
1687
|
+
"additionalProperties": false,
|
|
1688
|
+
"description": "Client UI with checkbox representation for each filter type and filter value.",
|
|
1689
|
+
"properties": {
|
|
1690
|
+
"filterBlocks": {
|
|
1691
|
+
"description": "Array of filter block authoring infos.",
|
|
1692
|
+
"items": {
|
|
1693
|
+
"$ref": "#/definitions/esri.rest-api.BuildingSceneLayerJson.AuthoringInfoFilterBlockJson"
|
|
1694
|
+
},
|
|
1695
|
+
"type": "array"
|
|
1696
|
+
},
|
|
1697
|
+
"type": {
|
|
1698
|
+
"const": "checkbox",
|
|
1699
|
+
"description": "Type of filter authoring info. Value of this property must be checkbox.",
|
|
1700
|
+
"type": "string"
|
|
1701
|
+
}
|
|
1702
|
+
},
|
|
1703
|
+
"required": [
|
|
1704
|
+
"type"
|
|
1705
|
+
],
|
|
1706
|
+
"type": "object"
|
|
1707
|
+
},
|
|
1708
|
+
"esri.rest-api.BuildingSceneLayerJson.FilterBlockJson": {
|
|
1709
|
+
"additionalProperties": false,
|
|
1710
|
+
"description": "A filter block defines what elements will be filtered with a specific filter mode. To ensure performance on client applications, it is not recommended to declare multiple filter blocks with the same filter mode. Filter blocks are contained in a filter for a building scene layer. Each filter includes at least one filter block.",
|
|
1711
|
+
"properties": {
|
|
1712
|
+
"filterExpression": {
|
|
1713
|
+
"description": "SQL expression to select features that belong to this filter block.",
|
|
1714
|
+
"type": "string"
|
|
1715
|
+
},
|
|
1716
|
+
"filterMode": {
|
|
1717
|
+
"$ref": "#/definitions/FilterModeJson",
|
|
1718
|
+
"description": "Filter mode defines how features are drawn. For example, the filter mode of a filter can be solid or wire frame."
|
|
1719
|
+
},
|
|
1720
|
+
"title": {
|
|
1721
|
+
"description": "Title of the filter block.",
|
|
1722
|
+
"type": "string"
|
|
1723
|
+
}
|
|
1338
1724
|
},
|
|
1339
1725
|
"type": "object"
|
|
1340
1726
|
},
|
|
@@ -2003,57 +2389,267 @@
|
|
|
2003
2389
|
],
|
|
2004
2390
|
"type": "object"
|
|
2005
2391
|
},
|
|
2006
|
-
"esri.rest-api.
|
|
2392
|
+
"esri.rest-api.EnvironmentJson.CloudyWeatherJson": {
|
|
2007
2393
|
"additionalProperties": false,
|
|
2008
|
-
"description": "
|
|
2394
|
+
"description": "Object containing information for changing the weather conditions in the scene to cloudy.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/cloudyWeather/}.",
|
|
2009
2395
|
"properties": {
|
|
2010
|
-
"
|
|
2011
|
-
"description": "
|
|
2396
|
+
"cloudCover": {
|
|
2397
|
+
"description": "Specifies the amount of cloud cover in the sky.",
|
|
2398
|
+
"type": "number"
|
|
2399
|
+
},
|
|
2400
|
+
"type": {
|
|
2401
|
+
"const": "cloudy",
|
|
2402
|
+
"description": "The type of weather.",
|
|
2403
|
+
"type": "string"
|
|
2404
|
+
}
|
|
2405
|
+
},
|
|
2406
|
+
"required": [
|
|
2407
|
+
"type"
|
|
2408
|
+
],
|
|
2409
|
+
"type": "object"
|
|
2410
|
+
},
|
|
2411
|
+
"esri.rest-api.EnvironmentJson.ColorBackgroundJson": {
|
|
2412
|
+
"additionalProperties": false,
|
|
2413
|
+
"description": "Specifies a single color to fill the background of the scene with. The scene background is displayed behind any scene objects, stars and atmosphere.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/environment_background_color/}.",
|
|
2414
|
+
"properties": {
|
|
2415
|
+
"color": {
|
|
2416
|
+
"description": "Color is represented as a three or four-element array.",
|
|
2012
2417
|
"items": {
|
|
2013
|
-
"
|
|
2418
|
+
"type": "number"
|
|
2014
2419
|
},
|
|
2015
2420
|
"type": "array"
|
|
2016
2421
|
},
|
|
2017
|
-
"
|
|
2018
|
-
"description": "
|
|
2019
|
-
"type": "
|
|
2422
|
+
"transparency": {
|
|
2423
|
+
"description": "The value has to lie between 100 (full transparency) and 0 (full opacity). Web scenes only.",
|
|
2424
|
+
"type": "number"
|
|
2425
|
+
},
|
|
2426
|
+
"type": {
|
|
2427
|
+
"const": "color",
|
|
2428
|
+
"description": "The type of background. Web scenes only.",
|
|
2429
|
+
"type": "string"
|
|
2020
2430
|
}
|
|
2021
2431
|
},
|
|
2022
2432
|
"required": [
|
|
2023
|
-
"
|
|
2433
|
+
"type"
|
|
2024
2434
|
],
|
|
2025
2435
|
"type": "object"
|
|
2026
2436
|
},
|
|
2027
|
-
"esri.rest-api.
|
|
2437
|
+
"esri.rest-api.EnvironmentJson.EnvironmentJson": {
|
|
2028
2438
|
"additionalProperties": false,
|
|
2029
|
-
"description": "
|
|
2439
|
+
"description": "Represents settings that affect the environment in which the WebScene is displayed (such as lighting). It is part of the initial state of the WebScene as well as slides in the presentation.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/environment/}.",
|
|
2030
2440
|
"properties": {
|
|
2031
|
-
"
|
|
2032
|
-
"description": "
|
|
2441
|
+
"atmosphereEnabled": {
|
|
2442
|
+
"description": "Whether the atmosphere should be visualized. This includes sky and haze effects.",
|
|
2443
|
+
"type": "boolean"
|
|
2033
2444
|
},
|
|
2034
|
-
"
|
|
2035
|
-
"$ref": "#/definitions/
|
|
2036
|
-
"description": "
|
|
2445
|
+
"background": {
|
|
2446
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.ColorBackgroundJson",
|
|
2447
|
+
"description": "Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed."
|
|
2037
2448
|
},
|
|
2038
|
-
"
|
|
2039
|
-
"$ref": "#/definitions/
|
|
2040
|
-
"description": "
|
|
2449
|
+
"lighting": {
|
|
2450
|
+
"$ref": "#/definitions/LightingJson",
|
|
2451
|
+
"description": "Object containing information on how the scene is lit."
|
|
2041
2452
|
},
|
|
2042
|
-
"
|
|
2043
|
-
"
|
|
2044
|
-
"
|
|
2453
|
+
"starsEnabled": {
|
|
2454
|
+
"description": "Whether stars should be displayed in the sky.",
|
|
2455
|
+
"type": "boolean"
|
|
2456
|
+
},
|
|
2457
|
+
"weather": {
|
|
2458
|
+
"$ref": "#/definitions/WeatherJson",
|
|
2459
|
+
"description": "Indicates the type of weather visualization in the scene."
|
|
2045
2460
|
}
|
|
2046
2461
|
},
|
|
2047
2462
|
"type": "object"
|
|
2048
2463
|
},
|
|
2049
|
-
"esri.rest-api.
|
|
2464
|
+
"esri.rest-api.EnvironmentJson.FoggyWeatherJson": {
|
|
2050
2465
|
"additionalProperties": false,
|
|
2051
|
-
"description": "
|
|
2466
|
+
"description": "Object containing information for changing the weather conditions in the scene to foggy.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/foggyWeather/}.",
|
|
2052
2467
|
"properties": {
|
|
2053
|
-
"
|
|
2054
|
-
"description": "
|
|
2055
|
-
"
|
|
2056
|
-
|
|
2468
|
+
"fogStrength": {
|
|
2469
|
+
"description": "Specifies the amount of fog used in the scene.",
|
|
2470
|
+
"type": "number"
|
|
2471
|
+
},
|
|
2472
|
+
"type": {
|
|
2473
|
+
"const": "foggy",
|
|
2474
|
+
"description": "The type of weather.",
|
|
2475
|
+
"type": "string"
|
|
2476
|
+
}
|
|
2477
|
+
},
|
|
2478
|
+
"required": [
|
|
2479
|
+
"type"
|
|
2480
|
+
],
|
|
2481
|
+
"type": "object"
|
|
2482
|
+
},
|
|
2483
|
+
"esri.rest-api.EnvironmentJson.RainyWeatherJson": {
|
|
2484
|
+
"additionalProperties": false,
|
|
2485
|
+
"description": "Object containing information for changing the weather conditions in the scene to rainy.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/rainyWeather/}.",
|
|
2486
|
+
"properties": {
|
|
2487
|
+
"cloudCover": {
|
|
2488
|
+
"description": "Specifies the amount of cloud cover in the sky.",
|
|
2489
|
+
"type": "number"
|
|
2490
|
+
},
|
|
2491
|
+
"precipitation": {
|
|
2492
|
+
"description": "Specifies the amount of snowfall in the scene.",
|
|
2493
|
+
"type": "number"
|
|
2494
|
+
},
|
|
2495
|
+
"type": {
|
|
2496
|
+
"const": "rainy",
|
|
2497
|
+
"description": "The type of weather.",
|
|
2498
|
+
"type": "string"
|
|
2499
|
+
}
|
|
2500
|
+
},
|
|
2501
|
+
"required": [
|
|
2502
|
+
"type"
|
|
2503
|
+
],
|
|
2504
|
+
"type": "object"
|
|
2505
|
+
},
|
|
2506
|
+
"esri.rest-api.EnvironmentJson.SnowyWeatherJson": {
|
|
2507
|
+
"additionalProperties": false,
|
|
2508
|
+
"description": "Object containing information for changing the weather conditions in the scene to snowy.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/sunnyWeather/}.",
|
|
2509
|
+
"properties": {
|
|
2510
|
+
"cloudCover": {
|
|
2511
|
+
"description": "Specifies the amount of cloud cover in the sky.",
|
|
2512
|
+
"type": "number"
|
|
2513
|
+
},
|
|
2514
|
+
"precipitation": {
|
|
2515
|
+
"description": "Specifies the amount of snowfall in the scene.",
|
|
2516
|
+
"type": "number"
|
|
2517
|
+
},
|
|
2518
|
+
"snowCover": {
|
|
2519
|
+
"description": "Display surfaces covered with snow.",
|
|
2520
|
+
"enum": [
|
|
2521
|
+
"disabled",
|
|
2522
|
+
"enabled"
|
|
2523
|
+
],
|
|
2524
|
+
"type": "string"
|
|
2525
|
+
},
|
|
2526
|
+
"type": {
|
|
2527
|
+
"const": "snowy",
|
|
2528
|
+
"description": "The type of weather.",
|
|
2529
|
+
"type": "string"
|
|
2530
|
+
}
|
|
2531
|
+
},
|
|
2532
|
+
"required": [
|
|
2533
|
+
"type"
|
|
2534
|
+
],
|
|
2535
|
+
"type": "object"
|
|
2536
|
+
},
|
|
2537
|
+
"esri.rest-api.EnvironmentJson.SunLightingJson": {
|
|
2538
|
+
"additionalProperties": false,
|
|
2539
|
+
"description": "Object containing information for the sun lighting type. The position of the light is set to the sun's location.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/sunLighting/}.",
|
|
2540
|
+
"properties": {
|
|
2541
|
+
"datetime": {
|
|
2542
|
+
"description": "The current date and time of the simulated sun. It is a number representing the number of milliseconds since 1 January, 1970 UTC.",
|
|
2543
|
+
"type": "number"
|
|
2544
|
+
},
|
|
2545
|
+
"directShadows": {
|
|
2546
|
+
"description": "Indicates whether to show shadows cast by the sun.",
|
|
2547
|
+
"type": "boolean"
|
|
2548
|
+
},
|
|
2549
|
+
"displayUTCOffset": {
|
|
2550
|
+
"description": "UTC offset in decimal hours. Not to be applied to datetime for sun position, only to adjust display of datetime in UI. If displayUTCOffset is null, offset is calculated for the current location (approximate only).",
|
|
2551
|
+
"type": "number"
|
|
2552
|
+
},
|
|
2553
|
+
"type": {
|
|
2554
|
+
"const": "sun",
|
|
2555
|
+
"description": "The type of lighting.",
|
|
2556
|
+
"type": "string"
|
|
2557
|
+
}
|
|
2558
|
+
},
|
|
2559
|
+
"required": [
|
|
2560
|
+
"type"
|
|
2561
|
+
],
|
|
2562
|
+
"type": "object"
|
|
2563
|
+
},
|
|
2564
|
+
"esri.rest-api.EnvironmentJson.SunnyWeatherJson": {
|
|
2565
|
+
"additionalProperties": false,
|
|
2566
|
+
"description": "Object containing information for changing the weather conditions in the scene to sunny.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/sunnyWeather/}.",
|
|
2567
|
+
"properties": {
|
|
2568
|
+
"cloudCover": {
|
|
2569
|
+
"description": "Specifies the amount of cloud cover in the sky.",
|
|
2570
|
+
"type": "number"
|
|
2571
|
+
},
|
|
2572
|
+
"type": {
|
|
2573
|
+
"const": "sunny",
|
|
2574
|
+
"description": "The type of weather.",
|
|
2575
|
+
"type": "string"
|
|
2576
|
+
}
|
|
2577
|
+
},
|
|
2578
|
+
"required": [
|
|
2579
|
+
"type"
|
|
2580
|
+
],
|
|
2581
|
+
"type": "object"
|
|
2582
|
+
},
|
|
2583
|
+
"esri.rest-api.EnvironmentJson.VirtualLightingJson": {
|
|
2584
|
+
"additionalProperties": false,
|
|
2585
|
+
"description": "Object containing information for the virtual lighting type. The position of the light follows the camera and is set behind the camera with a small offset to the left side.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/sunLighting/}.",
|
|
2586
|
+
"properties": {
|
|
2587
|
+
"directShadows": {
|
|
2588
|
+
"description": "Indicates whether to show shadows cast by the main light source.",
|
|
2589
|
+
"type": "boolean"
|
|
2590
|
+
},
|
|
2591
|
+
"type": {
|
|
2592
|
+
"const": "virtual",
|
|
2593
|
+
"description": "The type of lighting.",
|
|
2594
|
+
"type": "string"
|
|
2595
|
+
}
|
|
2596
|
+
},
|
|
2597
|
+
"required": [
|
|
2598
|
+
"type"
|
|
2599
|
+
],
|
|
2600
|
+
"type": "object"
|
|
2601
|
+
},
|
|
2602
|
+
"esri.rest-api.FeatureCollectionJson.FeatureCollectionJson": {
|
|
2603
|
+
"additionalProperties": false,
|
|
2604
|
+
"description": "Defines a layer of features whose geometry and attributes will be stored directly within the web map.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/featureCollection/}.",
|
|
2605
|
+
"properties": {
|
|
2606
|
+
"layers": {
|
|
2607
|
+
"description": "An array of Layer objects defining all the styling, geometry, and attribute information for the features.",
|
|
2608
|
+
"items": {
|
|
2609
|
+
"$ref": "#/definitions/esri.rest-api.SublayerJson.SublayerJson"
|
|
2610
|
+
},
|
|
2611
|
+
"type": "array"
|
|
2612
|
+
},
|
|
2613
|
+
"showLegend": {
|
|
2614
|
+
"description": "Indicates if this layer should be shown in the legend in client applications. The default is true.",
|
|
2615
|
+
"type": "boolean"
|
|
2616
|
+
}
|
|
2617
|
+
},
|
|
2618
|
+
"required": [
|
|
2619
|
+
"layers"
|
|
2620
|
+
],
|
|
2621
|
+
"type": "object"
|
|
2622
|
+
},
|
|
2623
|
+
"esri.rest-api.FeatureJson.FeatureJson": {
|
|
2624
|
+
"additionalProperties": false,
|
|
2625
|
+
"description": "Contains information about an attribute field and feature geometry.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/feature/} {@link https://developers.arcgis.com/web-scene-specification/objects/feature/}.",
|
|
2626
|
+
"properties": {
|
|
2627
|
+
"attributes": {
|
|
2628
|
+
"description": "The feature attributes. It is a JSON object that contains a dictionary of name-value pairs. The names are the feature field names. The values are the field values and they can be any of the standard JSON types - string, number and boolean. Note that date values are encoded as numbers. The number represents the number of milliseconds since epoch (January 1,\n1970) in UTC."
|
|
2629
|
+
},
|
|
2630
|
+
"geometry": {
|
|
2631
|
+
"$ref": "#/definitions/GeometryJson",
|
|
2632
|
+
"description": "The feature geometry."
|
|
2633
|
+
},
|
|
2634
|
+
"popupInfo": {
|
|
2635
|
+
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson",
|
|
2636
|
+
"description": "A popupInfo object defining the content of popup window when you click a feature on the map. Applicable to features in a map notes feature layer only."
|
|
2637
|
+
},
|
|
2638
|
+
"symbol": {
|
|
2639
|
+
"$ref": "#/definitions/esri.rest-api.SymbolJson.SymbolJson",
|
|
2640
|
+
"description": "Symbol used for drawing the feature."
|
|
2641
|
+
}
|
|
2642
|
+
},
|
|
2643
|
+
"type": "object"
|
|
2644
|
+
},
|
|
2645
|
+
"esri.rest-api.FeatureLayerJson.FeatureLayerJson": {
|
|
2646
|
+
"additionalProperties": false,
|
|
2647
|
+
"description": "Feature layers can be created by referencing a layer from either a map service or a feature service or by specifying a feature collection object. Use a map service if you just want to retrieve geometries and attributes from the server and symbolize them yourself. Use a feature service if you want to take advantage of symbols from the service's source map document. Also, use a feature service if you plan on doing editing with the feature layer. Feature layers honor any feature templates configured in the source map document. Feature collection objects are used to create a feature layer based on the supplied definition.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/featureLayer/} {@link https://developers.arcgis.com/web-scene-specification/objects/featureLayer/}.",
|
|
2648
|
+
"properties": {
|
|
2649
|
+
"blendMode": {
|
|
2650
|
+
"description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
|
|
2651
|
+
"enum": [
|
|
2652
|
+
"average",
|
|
2057
2653
|
"color",
|
|
2058
2654
|
"color-burn",
|
|
2059
2655
|
"color-dodge",
|
|
@@ -3223,6 +3819,32 @@
|
|
|
3223
3819
|
],
|
|
3224
3820
|
"type": "object"
|
|
3225
3821
|
},
|
|
3822
|
+
"esri.rest-api.GroundJson.GroundJson": {
|
|
3823
|
+
"additionalProperties": false,
|
|
3824
|
+
"description": "Ground defines the main surface of the web scene, based on elevation layers..\n\nSee https://developers.arcgis.com/web-scene-specification/objects/ground/.",
|
|
3825
|
+
"properties": {
|
|
3826
|
+
"layers": {
|
|
3827
|
+
"description": "An array of elevationLayer objects defining the elevation of the ground in the web scene.",
|
|
3828
|
+
"items": {
|
|
3829
|
+
"$ref": "#/definitions/ElevationLayerJson"
|
|
3830
|
+
},
|
|
3831
|
+
"type": "array"
|
|
3832
|
+
},
|
|
3833
|
+
"navigationConstraint": {
|
|
3834
|
+
"$ref": "__type",
|
|
3835
|
+
"description": "Determines whether the camera is constrained to navigate only above, or also under the ground surface."
|
|
3836
|
+
},
|
|
3837
|
+
"surfaceColor": {
|
|
3838
|
+
"$ref": "#/definitions/esri.rest-api.SymbolJson.ColorJson",
|
|
3839
|
+
"description": "Defines the color of the ground surface, displayed underneath the basemap. If no color, the default grid is shown."
|
|
3840
|
+
},
|
|
3841
|
+
"transparency": {
|
|
3842
|
+
"description": "The transparency of the ground surface. It is used for seeing through the ground, therefore this property also changes the transparency of the basemap. Draped operational layers are not affected by this property. The value has to lie between 100 (full transparency) and 0 (full opacity).",
|
|
3843
|
+
"type": "number"
|
|
3844
|
+
}
|
|
3845
|
+
},
|
|
3846
|
+
"type": "object"
|
|
3847
|
+
},
|
|
3226
3848
|
"esri.rest-api.GroupLayerJson.GroupLayerJson": {
|
|
3227
3849
|
"additionalProperties": false,
|
|
3228
3850
|
"description": "GroupLayer provides the ability to organize several sublayers into one common layer. Suppose there are several FeatureLayers that all represent water features in different dimensions. For example, wells (points), streams (lines), and lakes (polygons). The GroupLayer provides the functionality to treat them as one layer called Water Features even though they are stored as separate feature layers.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/groupLayer/}.",
|
|
@@ -3912,109 +4534,338 @@
|
|
|
3912
4534
|
],
|
|
3913
4535
|
"type": "object"
|
|
3914
4536
|
},
|
|
3915
|
-
"esri.rest-api.
|
|
4537
|
+
"esri.rest-api.ItemJson.ItemJson": {
|
|
3916
4538
|
"additionalProperties": false,
|
|
3917
|
-
"description": "
|
|
4539
|
+
"description": "An item (a unit of content) in the portal. Each item has a unique identifier and a well known URL that is independent of the user owning the item. An item can have associated binary or textual data that's available via the item data resource. For example, an item of type Map Package returns the actual bits corresponding to the map package via the item data resource. The numViews is incremented when an item is opened.\n\nSee {@link http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Item/02r30000007w000000/}.",
|
|
3918
4540
|
"properties": {
|
|
3919
|
-
"
|
|
3920
|
-
"description": "
|
|
3921
|
-
"enum": [
|
|
3922
|
-
"average",
|
|
3923
|
-
"color",
|
|
3924
|
-
"color-burn",
|
|
3925
|
-
"color-dodge",
|
|
3926
|
-
"darken",
|
|
3927
|
-
"destination-atop",
|
|
3928
|
-
"destination-in",
|
|
3929
|
-
"destination-out",
|
|
3930
|
-
"destination-over",
|
|
3931
|
-
"difference",
|
|
3932
|
-
"exclusion",
|
|
3933
|
-
"hard-light",
|
|
3934
|
-
"hue",
|
|
3935
|
-
"invert",
|
|
3936
|
-
"lighten",
|
|
3937
|
-
"lighter",
|
|
3938
|
-
"luminosity",
|
|
3939
|
-
"minus",
|
|
3940
|
-
"multiply",
|
|
3941
|
-
"normal",
|
|
3942
|
-
"overlay",
|
|
3943
|
-
"plus",
|
|
3944
|
-
"reflect",
|
|
3945
|
-
"saturation",
|
|
3946
|
-
"screen",
|
|
3947
|
-
"soft-light",
|
|
3948
|
-
"source-atop",
|
|
3949
|
-
"source-in",
|
|
3950
|
-
"source-out",
|
|
3951
|
-
"vivid-light",
|
|
3952
|
-
"xor"
|
|
3953
|
-
],
|
|
3954
|
-
"type": "string"
|
|
3955
|
-
},
|
|
3956
|
-
"effect": {
|
|
3957
|
-
"$ref": "#/definitions/EffectJson",
|
|
3958
|
-
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
3959
|
-
},
|
|
3960
|
-
"id": {
|
|
3961
|
-
"description": "A unique identifying string for the layer.",
|
|
3962
|
-
"type": "string"
|
|
3963
|
-
},
|
|
3964
|
-
"itemId": {
|
|
3965
|
-
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
4541
|
+
"access": {
|
|
4542
|
+
"description": "Indicates the level of access to this item: private, shared, org, or public.",
|
|
3966
4543
|
"type": "string"
|
|
3967
4544
|
},
|
|
3968
|
-
"
|
|
3969
|
-
"
|
|
3970
|
-
"description": "The type of layer.",
|
|
4545
|
+
"accessInformation": {
|
|
4546
|
+
"description": "Information on the source of the item and its copyright status.",
|
|
3971
4547
|
"type": "string"
|
|
3972
4548
|
},
|
|
3973
|
-
"
|
|
3974
|
-
"description": "
|
|
3975
|
-
"enum": [
|
|
3976
|
-
"hide",
|
|
3977
|
-
"hide-children",
|
|
3978
|
-
"show"
|
|
3979
|
-
],
|
|
3980
|
-
"type": "string"
|
|
4549
|
+
"advancedSettings": {
|
|
4550
|
+
"description": "<not in spec>."
|
|
3981
4551
|
},
|
|
3982
|
-
"
|
|
3983
|
-
"description": "
|
|
3984
|
-
"
|
|
4552
|
+
"appCategories": {
|
|
4553
|
+
"description": "An array that primarily applies to a list of categories that the application item is applicable to.",
|
|
4554
|
+
"items": {
|
|
4555
|
+
"type": "string"
|
|
4556
|
+
},
|
|
4557
|
+
"type": "array"
|
|
3985
4558
|
},
|
|
3986
|
-
"
|
|
3987
|
-
"description": "
|
|
4559
|
+
"avgRating": {
|
|
4560
|
+
"description": "Average rating. Uses a weighted average called \"Bayesian average.\".",
|
|
3988
4561
|
"type": "number"
|
|
3989
4562
|
},
|
|
3990
|
-
"
|
|
3991
|
-
"description": "
|
|
3992
|
-
"type": "
|
|
4563
|
+
"banner": {
|
|
4564
|
+
"description": "Primarily applies to the banner associated with an application. The URL to the banner used for the application.",
|
|
4565
|
+
"type": "string"
|
|
3993
4566
|
},
|
|
3994
|
-
"
|
|
3995
|
-
"description": "
|
|
3996
|
-
"
|
|
4567
|
+
"categories": {
|
|
4568
|
+
"description": "An array of organization categories that are set on the item.",
|
|
4569
|
+
"items": {
|
|
4570
|
+
"type": "string"
|
|
4571
|
+
},
|
|
4572
|
+
"type": "array"
|
|
3997
4573
|
},
|
|
3998
|
-
"
|
|
3999
|
-
"description": "Indicates
|
|
4574
|
+
"commentsEnabled": {
|
|
4575
|
+
"description": "Indicates if comments are allowed on the item.",
|
|
4000
4576
|
"type": "boolean"
|
|
4001
4577
|
},
|
|
4002
|
-
"
|
|
4003
|
-
"description": "
|
|
4578
|
+
"contentOrigin": {
|
|
4579
|
+
"description": "<not in spec>.",
|
|
4004
4580
|
"type": "string"
|
|
4005
4581
|
},
|
|
4006
|
-
"
|
|
4007
|
-
"description": "
|
|
4008
|
-
"
|
|
4009
|
-
|
|
4010
|
-
|
|
4011
|
-
|
|
4012
|
-
|
|
4013
|
-
|
|
4014
|
-
|
|
4015
|
-
|
|
4016
|
-
|
|
4017
|
-
|
|
4582
|
+
"created": {
|
|
4583
|
+
"description": "The date the item was created. Shown in UNIX time in milliseconds.",
|
|
4584
|
+
"type": "number"
|
|
4585
|
+
},
|
|
4586
|
+
"culture": {
|
|
4587
|
+
"description": "The item locale information (language and country).",
|
|
4588
|
+
"type": "string"
|
|
4589
|
+
},
|
|
4590
|
+
"description": {
|
|
4591
|
+
"description": "Item description.",
|
|
4592
|
+
"type": "string"
|
|
4593
|
+
},
|
|
4594
|
+
"documentation": {
|
|
4595
|
+
"description": "<not in spec>."
|
|
4596
|
+
},
|
|
4597
|
+
"extent": {
|
|
4598
|
+
"description": "The bounding rectangle of the item. Should always be in WGS84.",
|
|
4599
|
+
"items": {
|
|
4600
|
+
"items": {
|
|
4601
|
+
"type": "number"
|
|
4602
|
+
},
|
|
4603
|
+
"type": "array"
|
|
4604
|
+
},
|
|
4605
|
+
"type": "array"
|
|
4606
|
+
},
|
|
4607
|
+
"groupDesignations": {
|
|
4608
|
+
"description": "<not in spec>."
|
|
4609
|
+
},
|
|
4610
|
+
"guid": {
|
|
4611
|
+
"description": "<not in spec>.",
|
|
4612
|
+
"type": "string"
|
|
4613
|
+
},
|
|
4614
|
+
"id": {
|
|
4615
|
+
"description": "The unique ID for this item.",
|
|
4616
|
+
"type": "string"
|
|
4617
|
+
},
|
|
4618
|
+
"industries": {
|
|
4619
|
+
"description": "Primarily applies to industries associated with the application.",
|
|
4620
|
+
"items": {
|
|
4621
|
+
"type": "string"
|
|
4622
|
+
},
|
|
4623
|
+
"type": "array"
|
|
4624
|
+
},
|
|
4625
|
+
"isOrgItem": {
|
|
4626
|
+
"description": "<not in spec>.",
|
|
4627
|
+
"type": "boolean"
|
|
4628
|
+
},
|
|
4629
|
+
"itemControl": {
|
|
4630
|
+
"description": "Indicates user's control to the item.\n\nValues: admin (for item owner and org admin) | update (for members of groups with item update capability that the item is shared with).",
|
|
4631
|
+
"enum": [
|
|
4632
|
+
"admin",
|
|
4633
|
+
"update"
|
|
4634
|
+
],
|
|
4635
|
+
"type": "string"
|
|
4636
|
+
},
|
|
4637
|
+
"languages": {
|
|
4638
|
+
"description": "Primarily applies to languages associated with the application.",
|
|
4639
|
+
"items": {
|
|
4640
|
+
"type": "string"
|
|
4641
|
+
},
|
|
4642
|
+
"type": "array"
|
|
4643
|
+
},
|
|
4644
|
+
"largeThumbnail": {
|
|
4645
|
+
"description": "Primarily applies to thumbnails associated with an application. The URL to the thumbnail used for the application.",
|
|
4646
|
+
"type": "string"
|
|
4647
|
+
},
|
|
4648
|
+
"lastViewed": {
|
|
4649
|
+
"description": "The date/time the item was last accessed in UNIX format (in milliseconds).",
|
|
4650
|
+
"type": "number"
|
|
4651
|
+
},
|
|
4652
|
+
"licenseInfo": {
|
|
4653
|
+
"description": "Any license information or restrictions.",
|
|
4654
|
+
"type": "string"
|
|
4655
|
+
},
|
|
4656
|
+
"listed": {
|
|
4657
|
+
"description": "Primarily applies to the banner associated with an application. The URL to the banner used for the application.",
|
|
4658
|
+
"type": "boolean"
|
|
4659
|
+
},
|
|
4660
|
+
"modified": {
|
|
4661
|
+
"description": "The date the item was last modified. Shown in UNIX time in milliseconds.",
|
|
4662
|
+
"type": "number"
|
|
4663
|
+
},
|
|
4664
|
+
"name": {
|
|
4665
|
+
"description": "The file name of the item for file types. Read-only.",
|
|
4666
|
+
"type": "string"
|
|
4667
|
+
},
|
|
4668
|
+
"numComments": {
|
|
4669
|
+
"description": "Number of comments on the item.",
|
|
4670
|
+
"type": "number"
|
|
4671
|
+
},
|
|
4672
|
+
"numRatings": {
|
|
4673
|
+
"description": "Number of ratings on the item.",
|
|
4674
|
+
"type": "number"
|
|
4675
|
+
},
|
|
4676
|
+
"numViews": {
|
|
4677
|
+
"description": "Number of views of the item.",
|
|
4678
|
+
"type": "number"
|
|
4679
|
+
},
|
|
4680
|
+
"orgId": {
|
|
4681
|
+
"description": "<not in spec>.",
|
|
4682
|
+
"type": "string"
|
|
4683
|
+
},
|
|
4684
|
+
"owner": {
|
|
4685
|
+
"description": "The username of the user who owns this item.",
|
|
4686
|
+
"type": "string"
|
|
4687
|
+
},
|
|
4688
|
+
"ownerFolder": {
|
|
4689
|
+
"description": "The ID of the folder in which the owner has stored the item. The property is only returned to the item owner or the org admin.",
|
|
4690
|
+
"type": "string"
|
|
4691
|
+
},
|
|
4692
|
+
"properties": {
|
|
4693
|
+
"description": "A JSON object that primarily applies to system requirements, Terms and Conditions, version, supported platforms, YouTube video ID, etc associated with the application.",
|
|
4694
|
+
"type": "string"
|
|
4695
|
+
},
|
|
4696
|
+
"protected": {
|
|
4697
|
+
"description": "Protects the item from deletion. False is the default.",
|
|
4698
|
+
"type": "boolean"
|
|
4699
|
+
},
|
|
4700
|
+
"proxyFilter": {
|
|
4701
|
+
"description": "A JSON object used to restrict service item response results based on specified filter, i.e. limit results returned from a geocode service based on defined filters.See serviceProxyFilter for object details."
|
|
4702
|
+
},
|
|
4703
|
+
"scoreCompleteness": {
|
|
4704
|
+
"description": "Item information completeness score based upon item snippet, thumbnail, description, title, tags etc.",
|
|
4705
|
+
"type": "number"
|
|
4706
|
+
},
|
|
4707
|
+
"screenshots": {
|
|
4708
|
+
"description": "Primarily applies to screenshots associated with an application. The URL to the screenshots used for the application.",
|
|
4709
|
+
"items": {
|
|
4710
|
+
"type": "string"
|
|
4711
|
+
},
|
|
4712
|
+
"type": "array"
|
|
4713
|
+
},
|
|
4714
|
+
"size": {
|
|
4715
|
+
"description": "The size of the item.",
|
|
4716
|
+
"type": "number"
|
|
4717
|
+
},
|
|
4718
|
+
"snippet": {
|
|
4719
|
+
"description": "A short summary description of the item.",
|
|
4720
|
+
"type": "string"
|
|
4721
|
+
},
|
|
4722
|
+
"spatialReference": {
|
|
4723
|
+
"$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson",
|
|
4724
|
+
"description": "The coordinate system of the item."
|
|
4725
|
+
},
|
|
4726
|
+
"subInfo": {
|
|
4727
|
+
"description": "<not in spec>.",
|
|
4728
|
+
"type": "number"
|
|
4729
|
+
},
|
|
4730
|
+
"tags": {
|
|
4731
|
+
"description": "User defined tags that describe the item.",
|
|
4732
|
+
"items": {
|
|
4733
|
+
"type": "string"
|
|
4734
|
+
},
|
|
4735
|
+
"type": "array"
|
|
4736
|
+
},
|
|
4737
|
+
"thumbnail": {
|
|
4738
|
+
"description": "The URL to the thumbnail used for the item.",
|
|
4739
|
+
"type": "string"
|
|
4740
|
+
},
|
|
4741
|
+
"title": {
|
|
4742
|
+
"description": "The title of the item. This is the name that's displayed to users and by which they refer to the item. Every item must have a title.",
|
|
4743
|
+
"type": "string"
|
|
4744
|
+
},
|
|
4745
|
+
"type": {
|
|
4746
|
+
"description": "The GIS content type of this item. Example types include Web Map, Map Service, Shapefile, and Web Mapping Application. See {@link http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#//02r3000000ms000000}.",
|
|
4747
|
+
"type": "string"
|
|
4748
|
+
},
|
|
4749
|
+
"typeKeywords": {
|
|
4750
|
+
"description": "A set of keywords that further describes the type of this item. Each item is tagged with a set of type keywords that are derived based on its primary type.",
|
|
4751
|
+
"items": {
|
|
4752
|
+
"type": "string"
|
|
4753
|
+
},
|
|
4754
|
+
"type": "array"
|
|
4755
|
+
},
|
|
4756
|
+
"url": {
|
|
4757
|
+
"description": "The URL for the resource represented by the item. Applies only to items that represent web-accessible resources such as map services.",
|
|
4758
|
+
"type": "string"
|
|
4759
|
+
}
|
|
4760
|
+
},
|
|
4761
|
+
"required": [
|
|
4762
|
+
"id"
|
|
4763
|
+
],
|
|
4764
|
+
"type": "object"
|
|
4765
|
+
},
|
|
4766
|
+
"esri.rest-api.KMLLayerJson.KMLLayerJson": {
|
|
4767
|
+
"additionalProperties": false,
|
|
4768
|
+
"description": "Keyhole Markup Language (KML) is an XML-based format for storing geographic data and associated content and is an official Open Geospatial Consortium (OGC) standard. KML is a common format for sharing geographic data with non-GIS users as it can be easily delivered on the Internet.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/kmlLayer/}.",
|
|
4769
|
+
"properties": {
|
|
4770
|
+
"blendMode": {
|
|
4771
|
+
"description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
|
|
4772
|
+
"enum": [
|
|
4773
|
+
"average",
|
|
4774
|
+
"color",
|
|
4775
|
+
"color-burn",
|
|
4776
|
+
"color-dodge",
|
|
4777
|
+
"darken",
|
|
4778
|
+
"destination-atop",
|
|
4779
|
+
"destination-in",
|
|
4780
|
+
"destination-out",
|
|
4781
|
+
"destination-over",
|
|
4782
|
+
"difference",
|
|
4783
|
+
"exclusion",
|
|
4784
|
+
"hard-light",
|
|
4785
|
+
"hue",
|
|
4786
|
+
"invert",
|
|
4787
|
+
"lighten",
|
|
4788
|
+
"lighter",
|
|
4789
|
+
"luminosity",
|
|
4790
|
+
"minus",
|
|
4791
|
+
"multiply",
|
|
4792
|
+
"normal",
|
|
4793
|
+
"overlay",
|
|
4794
|
+
"plus",
|
|
4795
|
+
"reflect",
|
|
4796
|
+
"saturation",
|
|
4797
|
+
"screen",
|
|
4798
|
+
"soft-light",
|
|
4799
|
+
"source-atop",
|
|
4800
|
+
"source-in",
|
|
4801
|
+
"source-out",
|
|
4802
|
+
"vivid-light",
|
|
4803
|
+
"xor"
|
|
4804
|
+
],
|
|
4805
|
+
"type": "string"
|
|
4806
|
+
},
|
|
4807
|
+
"effect": {
|
|
4808
|
+
"$ref": "#/definitions/EffectJson",
|
|
4809
|
+
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
4810
|
+
},
|
|
4811
|
+
"id": {
|
|
4812
|
+
"description": "A unique identifying string for the layer.",
|
|
4813
|
+
"type": "string"
|
|
4814
|
+
},
|
|
4815
|
+
"itemId": {
|
|
4816
|
+
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
4817
|
+
"type": "string"
|
|
4818
|
+
},
|
|
4819
|
+
"layerType": {
|
|
4820
|
+
"const": "KML",
|
|
4821
|
+
"description": "The type of layer.",
|
|
4822
|
+
"type": "string"
|
|
4823
|
+
},
|
|
4824
|
+
"listMode": {
|
|
4825
|
+
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
4826
|
+
"enum": [
|
|
4827
|
+
"hide",
|
|
4828
|
+
"hide-children",
|
|
4829
|
+
"show"
|
|
4830
|
+
],
|
|
4831
|
+
"type": "string"
|
|
4832
|
+
},
|
|
4833
|
+
"maxScale": {
|
|
4834
|
+
"description": "A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.",
|
|
4835
|
+
"type": "number"
|
|
4836
|
+
},
|
|
4837
|
+
"minScale": {
|
|
4838
|
+
"description": "A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.",
|
|
4839
|
+
"type": "number"
|
|
4840
|
+
},
|
|
4841
|
+
"opacity": {
|
|
4842
|
+
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
4843
|
+
"type": "number"
|
|
4844
|
+
},
|
|
4845
|
+
"refreshInterval": {
|
|
4846
|
+
"description": "When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See {@link https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm}.",
|
|
4847
|
+
"type": "number"
|
|
4848
|
+
},
|
|
4849
|
+
"showLegend": {
|
|
4850
|
+
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
4851
|
+
"type": "boolean"
|
|
4852
|
+
},
|
|
4853
|
+
"title": {
|
|
4854
|
+
"description": "A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.",
|
|
4855
|
+
"type": "string"
|
|
4856
|
+
},
|
|
4857
|
+
"type": {
|
|
4858
|
+
"description": "(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type.",
|
|
4859
|
+
"enum": [
|
|
4860
|
+
"BingMapsAerial",
|
|
4861
|
+
"BingMapsHybrid",
|
|
4862
|
+
"BingMapsRoad",
|
|
4863
|
+
"CSV",
|
|
4864
|
+
"KML",
|
|
4865
|
+
"OpenStreetMap",
|
|
4866
|
+
"WMS",
|
|
4867
|
+
"WebTiledLayer"
|
|
4868
|
+
],
|
|
4018
4869
|
"type": "string"
|
|
4019
4870
|
},
|
|
4020
4871
|
"url": {
|
|
@@ -5417,9 +6268,9 @@
|
|
|
5417
6268
|
},
|
|
5418
6269
|
"type": "object"
|
|
5419
6270
|
},
|
|
5420
|
-
"esri.rest-api.
|
|
6271
|
+
"esri.rest-api.OpenStreetMapLayerJson.OpenStreetMapLayerJson": {
|
|
5421
6272
|
"additionalProperties": false,
|
|
5422
|
-
"description": "
|
|
6273
|
+
"description": "Allows use of OpenStreetMap data for use in basemaps only.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/openStreetMapLayer/} {@link https://developers.arcgis.com/web-scene-specification/objects/openStreetMapLayer/} Note: In the JavaScript API, open street map derived from Web tile layer.",
|
|
5423
6274
|
"properties": {
|
|
5424
6275
|
"blendMode": {
|
|
5425
6276
|
"description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
|
|
@@ -5458,10 +6309,6 @@
|
|
|
5458
6309
|
],
|
|
5459
6310
|
"type": "string"
|
|
5460
6311
|
},
|
|
5461
|
-
"disablePopup": {
|
|
5462
|
-
"description": "Indicates whether to allow a client to ignore popups defined by the service item.",
|
|
5463
|
-
"type": "boolean"
|
|
5464
|
-
},
|
|
5465
6312
|
"effect": {
|
|
5466
6313
|
"$ref": "#/definitions/EffectJson",
|
|
5467
6314
|
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
@@ -5470,22 +6317,17 @@
|
|
|
5470
6317
|
"description": "A unique identifying string for the layer.",
|
|
5471
6318
|
"type": "string"
|
|
5472
6319
|
},
|
|
5473
|
-
"
|
|
5474
|
-
"
|
|
5475
|
-
"
|
|
6320
|
+
"isReference": {
|
|
6321
|
+
"description": "This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).",
|
|
6322
|
+
"type": "boolean"
|
|
5476
6323
|
},
|
|
5477
|
-
"
|
|
5478
|
-
"
|
|
5479
|
-
"description": "The type of layer.",
|
|
6324
|
+
"itemId": {
|
|
6325
|
+
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
5480
6326
|
"type": "string"
|
|
5481
6327
|
},
|
|
5482
|
-
"
|
|
5483
|
-
"
|
|
5484
|
-
"
|
|
5485
|
-
"hide",
|
|
5486
|
-
"hide-children",
|
|
5487
|
-
"show"
|
|
5488
|
-
],
|
|
6328
|
+
"layerType": {
|
|
6329
|
+
"const": "OpenStreetMap",
|
|
6330
|
+
"description": "The type of layer.",
|
|
5489
6331
|
"type": "string"
|
|
5490
6332
|
},
|
|
5491
6333
|
"maxScale": {
|
|
@@ -5500,14 +6342,6 @@
|
|
|
5500
6342
|
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
5501
6343
|
"type": "number"
|
|
5502
6344
|
},
|
|
5503
|
-
"popupInfo": {
|
|
5504
|
-
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson",
|
|
5505
|
-
"description": "A PopupInfo object defining the content of pop-up windows when you click or query a feature."
|
|
5506
|
-
},
|
|
5507
|
-
"refreshInterval": {
|
|
5508
|
-
"description": "When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See {@link https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm}.",
|
|
5509
|
-
"type": "number"
|
|
5510
|
-
},
|
|
5511
6345
|
"showLegend": {
|
|
5512
6346
|
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
5513
6347
|
"type": "boolean"
|
|
@@ -5530,9 +6364,146 @@
|
|
|
5530
6364
|
],
|
|
5531
6365
|
"type": "string"
|
|
5532
6366
|
},
|
|
5533
|
-
"
|
|
5534
|
-
"description": "
|
|
5535
|
-
"type": "
|
|
6367
|
+
"visibility": {
|
|
6368
|
+
"description": "Determines whether the layer is initially visible in the web map.",
|
|
6369
|
+
"type": "boolean"
|
|
6370
|
+
},
|
|
6371
|
+
"visibilityTimeExtent": {
|
|
6372
|
+
"description": "Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.",
|
|
6373
|
+
"items": [
|
|
6374
|
+
{
|
|
6375
|
+
"type": "number"
|
|
6376
|
+
},
|
|
6377
|
+
{
|
|
6378
|
+
"type": "number"
|
|
6379
|
+
}
|
|
6380
|
+
],
|
|
6381
|
+
"maxItems": 2,
|
|
6382
|
+
"minItems": 2,
|
|
6383
|
+
"type": "array"
|
|
6384
|
+
}
|
|
6385
|
+
},
|
|
6386
|
+
"required": [
|
|
6387
|
+
"layerType"
|
|
6388
|
+
],
|
|
6389
|
+
"type": "object"
|
|
6390
|
+
},
|
|
6391
|
+
"esri.rest-api.PointCloudLayerJson.PointCloudLayerJson": {
|
|
6392
|
+
"additionalProperties": false,
|
|
6393
|
+
"description": "Point cloud data is post-processed spatially organized lidar data that consists of large collections of 3D points. Elevations for the ground, buildings, forest canopy, highway overpasses, and anything else encountered during the lidar survey make up the point cloud data. Point cloud layers allow for fast visualization of point cloud data in the browser.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/pointCloudLayer/}.",
|
|
6394
|
+
"properties": {
|
|
6395
|
+
"blendMode": {
|
|
6396
|
+
"description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
|
|
6397
|
+
"enum": [
|
|
6398
|
+
"average",
|
|
6399
|
+
"color",
|
|
6400
|
+
"color-burn",
|
|
6401
|
+
"color-dodge",
|
|
6402
|
+
"darken",
|
|
6403
|
+
"destination-atop",
|
|
6404
|
+
"destination-in",
|
|
6405
|
+
"destination-out",
|
|
6406
|
+
"destination-over",
|
|
6407
|
+
"difference",
|
|
6408
|
+
"exclusion",
|
|
6409
|
+
"hard-light",
|
|
6410
|
+
"hue",
|
|
6411
|
+
"invert",
|
|
6412
|
+
"lighten",
|
|
6413
|
+
"lighter",
|
|
6414
|
+
"luminosity",
|
|
6415
|
+
"minus",
|
|
6416
|
+
"multiply",
|
|
6417
|
+
"normal",
|
|
6418
|
+
"overlay",
|
|
6419
|
+
"plus",
|
|
6420
|
+
"reflect",
|
|
6421
|
+
"saturation",
|
|
6422
|
+
"screen",
|
|
6423
|
+
"soft-light",
|
|
6424
|
+
"source-atop",
|
|
6425
|
+
"source-in",
|
|
6426
|
+
"source-out",
|
|
6427
|
+
"vivid-light",
|
|
6428
|
+
"xor"
|
|
6429
|
+
],
|
|
6430
|
+
"type": "string"
|
|
6431
|
+
},
|
|
6432
|
+
"disablePopup": {
|
|
6433
|
+
"description": "Indicates whether to allow a client to ignore popups defined by the service item.",
|
|
6434
|
+
"type": "boolean"
|
|
6435
|
+
},
|
|
6436
|
+
"effect": {
|
|
6437
|
+
"$ref": "#/definitions/EffectJson",
|
|
6438
|
+
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
6439
|
+
},
|
|
6440
|
+
"id": {
|
|
6441
|
+
"description": "A unique identifying string for the layer.",
|
|
6442
|
+
"type": "string"
|
|
6443
|
+
},
|
|
6444
|
+
"layerDefinition": {
|
|
6445
|
+
"$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
|
|
6446
|
+
"description": "A layerDefinition object defining the attribute schema and drawing information for the layer."
|
|
6447
|
+
},
|
|
6448
|
+
"layerType": {
|
|
6449
|
+
"const": "PointCloudLayer",
|
|
6450
|
+
"description": "The type of layer.",
|
|
6451
|
+
"type": "string"
|
|
6452
|
+
},
|
|
6453
|
+
"listMode": {
|
|
6454
|
+
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
6455
|
+
"enum": [
|
|
6456
|
+
"hide",
|
|
6457
|
+
"hide-children",
|
|
6458
|
+
"show"
|
|
6459
|
+
],
|
|
6460
|
+
"type": "string"
|
|
6461
|
+
},
|
|
6462
|
+
"maxScale": {
|
|
6463
|
+
"description": "A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.",
|
|
6464
|
+
"type": "number"
|
|
6465
|
+
},
|
|
6466
|
+
"minScale": {
|
|
6467
|
+
"description": "A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.",
|
|
6468
|
+
"type": "number"
|
|
6469
|
+
},
|
|
6470
|
+
"opacity": {
|
|
6471
|
+
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
6472
|
+
"type": "number"
|
|
6473
|
+
},
|
|
6474
|
+
"popupInfo": {
|
|
6475
|
+
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson",
|
|
6476
|
+
"description": "A PopupInfo object defining the content of pop-up windows when you click or query a feature."
|
|
6477
|
+
},
|
|
6478
|
+
"refreshInterval": {
|
|
6479
|
+
"description": "When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See {@link https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm}.",
|
|
6480
|
+
"type": "number"
|
|
6481
|
+
},
|
|
6482
|
+
"showLegend": {
|
|
6483
|
+
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
6484
|
+
"type": "boolean"
|
|
6485
|
+
},
|
|
6486
|
+
"title": {
|
|
6487
|
+
"description": "A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.",
|
|
6488
|
+
"type": "string"
|
|
6489
|
+
},
|
|
6490
|
+
"type": {
|
|
6491
|
+
"description": "(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type.",
|
|
6492
|
+
"enum": [
|
|
6493
|
+
"BingMapsAerial",
|
|
6494
|
+
"BingMapsHybrid",
|
|
6495
|
+
"BingMapsRoad",
|
|
6496
|
+
"CSV",
|
|
6497
|
+
"KML",
|
|
6498
|
+
"OpenStreetMap",
|
|
6499
|
+
"WMS",
|
|
6500
|
+
"WebTiledLayer"
|
|
6501
|
+
],
|
|
6502
|
+
"type": "string"
|
|
6503
|
+
},
|
|
6504
|
+
"url": {
|
|
6505
|
+
"description": "URL to the ArcGIS Server Image Service.",
|
|
6506
|
+
"type": "string"
|
|
5536
6507
|
},
|
|
5537
6508
|
"visibility": {
|
|
5538
6509
|
"description": "Determines whether the layer is initially visible in the web map.",
|
|
@@ -5866,65 +6837,198 @@
|
|
|
5866
6837
|
},
|
|
5867
6838
|
"type": "object"
|
|
5868
6839
|
},
|
|
5869
|
-
"esri.rest-api.
|
|
6840
|
+
"esri.rest-api.RasterDataElevationLayerJson.RasterDataElevationLayerJson": {
|
|
5870
6841
|
"additionalProperties": false,
|
|
5871
|
-
"description": "
|
|
6842
|
+
"description": "RasterDataElevationLayer is a single-band raster layer used for rendering elevation.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/rasterDataElevationLayer/}.",
|
|
5872
6843
|
"properties": {
|
|
5873
|
-
"
|
|
5874
|
-
"
|
|
5875
|
-
"
|
|
6844
|
+
"blendMode": {
|
|
6845
|
+
"description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
|
|
6846
|
+
"enum": [
|
|
6847
|
+
"average",
|
|
6848
|
+
"color",
|
|
6849
|
+
"color-burn",
|
|
6850
|
+
"color-dodge",
|
|
6851
|
+
"darken",
|
|
6852
|
+
"destination-atop",
|
|
6853
|
+
"destination-in",
|
|
6854
|
+
"destination-out",
|
|
6855
|
+
"destination-over",
|
|
6856
|
+
"difference",
|
|
6857
|
+
"exclusion",
|
|
6858
|
+
"hard-light",
|
|
6859
|
+
"hue",
|
|
6860
|
+
"invert",
|
|
6861
|
+
"lighten",
|
|
6862
|
+
"lighter",
|
|
6863
|
+
"luminosity",
|
|
6864
|
+
"minus",
|
|
6865
|
+
"multiply",
|
|
6866
|
+
"normal",
|
|
6867
|
+
"overlay",
|
|
6868
|
+
"plus",
|
|
6869
|
+
"reflect",
|
|
6870
|
+
"saturation",
|
|
6871
|
+
"screen",
|
|
6872
|
+
"soft-light",
|
|
6873
|
+
"source-atop",
|
|
6874
|
+
"source-in",
|
|
6875
|
+
"source-out",
|
|
6876
|
+
"vivid-light",
|
|
6877
|
+
"xor"
|
|
6878
|
+
],
|
|
6879
|
+
"type": "string"
|
|
5876
6880
|
},
|
|
5877
|
-
"
|
|
5878
|
-
"$ref": "#/definitions/
|
|
5879
|
-
"description": "
|
|
6881
|
+
"effect": {
|
|
6882
|
+
"$ref": "#/definitions/EffectJson",
|
|
6883
|
+
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
5880
6884
|
},
|
|
5881
|
-
"
|
|
5882
|
-
"
|
|
5883
|
-
"
|
|
6885
|
+
"id": {
|
|
6886
|
+
"description": "A unique identifying string for the layer.",
|
|
6887
|
+
"type": "string"
|
|
5884
6888
|
},
|
|
5885
|
-
"
|
|
5886
|
-
"description": "
|
|
6889
|
+
"isReference": {
|
|
6890
|
+
"description": "This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).",
|
|
6891
|
+
"type": "boolean"
|
|
6892
|
+
},
|
|
6893
|
+
"layerType": {
|
|
6894
|
+
"const": "RasterDataElevationLayer",
|
|
6895
|
+
"description": "The type of layer.",
|
|
5887
6896
|
"type": "string"
|
|
5888
6897
|
},
|
|
5889
|
-
"
|
|
5890
|
-
"description": "
|
|
5891
|
-
"
|
|
6898
|
+
"listMode": {
|
|
6899
|
+
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
6900
|
+
"enum": [
|
|
6901
|
+
"hide",
|
|
6902
|
+
"hide-children",
|
|
6903
|
+
"show"
|
|
6904
|
+
],
|
|
6905
|
+
"type": "string"
|
|
5892
6906
|
},
|
|
5893
|
-
"
|
|
5894
|
-
"
|
|
5895
|
-
"
|
|
6907
|
+
"maxScale": {
|
|
6908
|
+
"description": "A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.",
|
|
6909
|
+
"type": "number"
|
|
5896
6910
|
},
|
|
5897
|
-
"
|
|
5898
|
-
"
|
|
5899
|
-
"description": "An array of visualVariable objects used for continuous color or size, simple, and unique values with feature opacity."
|
|
5900
|
-
}
|
|
5901
|
-
},
|
|
5902
|
-
"type": "object"
|
|
5903
|
-
},
|
|
5904
|
-
"esri.rest-api.RendererJson.ClassBreakInfoJson": {
|
|
5905
|
-
"additionalProperties": false,
|
|
5906
|
-
"description": "The classBreaksInfo object provides information about the class breaks associated with the renderer.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/classBreakInfo/} {@link https://developers.arcgis.com/web-scene-specification/objects/classBreakInfo/}.",
|
|
5907
|
-
"properties": {
|
|
5908
|
-
"classMaxValue": {
|
|
5909
|
-
"description": "A numeric value used to specify the maximum value for a break.",
|
|
6911
|
+
"minScale": {
|
|
6912
|
+
"description": "A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.",
|
|
5910
6913
|
"type": "number"
|
|
5911
6914
|
},
|
|
5912
|
-
"
|
|
5913
|
-
"description": "
|
|
6915
|
+
"opacity": {
|
|
6916
|
+
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
5914
6917
|
"type": "number"
|
|
5915
6918
|
},
|
|
5916
|
-
"
|
|
5917
|
-
"description": "
|
|
6919
|
+
"path": {
|
|
6920
|
+
"description": "For offline data, a path to an ArcGIS Runtime supported raster data file. A URI format is used, starting with file: followed by a file system path. A relative path must be from the file which defines the layer. For example `file:../data/raster_data/beijing.tif`.",
|
|
5918
6921
|
"type": "string"
|
|
5919
6922
|
},
|
|
5920
|
-
"
|
|
5921
|
-
"description": "
|
|
6923
|
+
"refreshInterval": {
|
|
6924
|
+
"description": "When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See {@link https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm}.",
|
|
6925
|
+
"type": "number"
|
|
6926
|
+
},
|
|
6927
|
+
"showLegend": {
|
|
6928
|
+
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
6929
|
+
"type": "boolean"
|
|
6930
|
+
},
|
|
6931
|
+
"title": {
|
|
6932
|
+
"description": "A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.",
|
|
5922
6933
|
"type": "string"
|
|
5923
6934
|
},
|
|
5924
|
-
"
|
|
5925
|
-
"
|
|
5926
|
-
"
|
|
5927
|
-
|
|
6935
|
+
"type": {
|
|
6936
|
+
"description": "(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type.",
|
|
6937
|
+
"enum": [
|
|
6938
|
+
"BingMapsAerial",
|
|
6939
|
+
"BingMapsHybrid",
|
|
6940
|
+
"BingMapsRoad",
|
|
6941
|
+
"CSV",
|
|
6942
|
+
"KML",
|
|
6943
|
+
"OpenStreetMap",
|
|
6944
|
+
"WMS",
|
|
6945
|
+
"WebTiledLayer"
|
|
6946
|
+
],
|
|
6947
|
+
"type": "string"
|
|
6948
|
+
},
|
|
6949
|
+
"visibility": {
|
|
6950
|
+
"description": "Determines whether the layer is initially visible in the web map.",
|
|
6951
|
+
"type": "boolean"
|
|
6952
|
+
},
|
|
6953
|
+
"visibilityTimeExtent": {
|
|
6954
|
+
"description": "Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.",
|
|
6955
|
+
"items": [
|
|
6956
|
+
{
|
|
6957
|
+
"type": "number"
|
|
6958
|
+
},
|
|
6959
|
+
{
|
|
6960
|
+
"type": "number"
|
|
6961
|
+
}
|
|
6962
|
+
],
|
|
6963
|
+
"maxItems": 2,
|
|
6964
|
+
"minItems": 2,
|
|
6965
|
+
"type": "array"
|
|
6966
|
+
}
|
|
6967
|
+
},
|
|
6968
|
+
"required": [
|
|
6969
|
+
"layerType"
|
|
6970
|
+
],
|
|
6971
|
+
"type": "object"
|
|
6972
|
+
},
|
|
6973
|
+
"esri.rest-api.RendererJson.AuthoringInfoJson": {
|
|
6974
|
+
"additionalProperties": false,
|
|
6975
|
+
"description": "The authoringInfo is an object containing metadata about the authoring process for creating a renderer object. This allows the authoring clients to save specific overridable settings so that next time it is accessed via the UI, their selections are remembered. Non-authoring clients should ignore it. In order to support the slider with color/size/transparency information, the selection of the various themes, classification, and additional properties are saved within this object.\n\nNote: The authoringInfo object is not required with a renderer. It is only used if rendering was generated using Map Viewer rendering tools.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/authoringInfo/} {@link https://developers.arcgis.com/web-scene-specification/objects/authoringInfo/}.",
|
|
6976
|
+
"properties": {
|
|
6977
|
+
"classificationMethod": {
|
|
6978
|
+
"$ref": "esri.rest-api.RendererJson.ClassificationMethodJsonType",
|
|
6979
|
+
"description": "Used for classed color or size. The default value is esriClassifyManual."
|
|
6980
|
+
},
|
|
6981
|
+
"colorRamp": {
|
|
6982
|
+
"$ref": "#/definitions/esri.rest-api.RendererJson.ColorRampJson",
|
|
6983
|
+
"description": "A colorRamp object is used to specify a range of colors that are applied to a group of symbols."
|
|
6984
|
+
},
|
|
6985
|
+
"field": {
|
|
6986
|
+
"$ref": "#/definitions/esri.rest-api.FieldJson.FieldJson",
|
|
6987
|
+
"description": "Contains information about an attribute field."
|
|
6988
|
+
},
|
|
6989
|
+
"fields": {
|
|
6990
|
+
"description": "An array of string values representing field names used for creating predominance renderers.",
|
|
6991
|
+
"type": "string"
|
|
6992
|
+
},
|
|
6993
|
+
"standardDeviationInterval": {
|
|
6994
|
+
"description": "Use if the classificationMethod is esriClassifyStandardDeviation. Possible values: 0.25, 0.33, 0.5, 1.",
|
|
6995
|
+
"type": "number"
|
|
6996
|
+
},
|
|
6997
|
+
"type": {
|
|
6998
|
+
"$ref": "AuthoringInfoJsonType",
|
|
6999
|
+
"description": "In case of classed renderers this is set to either classedSize or classedColor."
|
|
7000
|
+
},
|
|
7001
|
+
"visualVariables": {
|
|
7002
|
+
"$ref": "#/definitions/VisualVariableJson",
|
|
7003
|
+
"description": "An array of visualVariable objects used for continuous color or size, simple, and unique values with feature opacity."
|
|
7004
|
+
}
|
|
7005
|
+
},
|
|
7006
|
+
"type": "object"
|
|
7007
|
+
},
|
|
7008
|
+
"esri.rest-api.RendererJson.ClassBreakInfoJson": {
|
|
7009
|
+
"additionalProperties": false,
|
|
7010
|
+
"description": "The classBreaksInfo object provides information about the class breaks associated with the renderer.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/classBreakInfo/} {@link https://developers.arcgis.com/web-scene-specification/objects/classBreakInfo/}.",
|
|
7011
|
+
"properties": {
|
|
7012
|
+
"classMaxValue": {
|
|
7013
|
+
"description": "A numeric value used to specify the maximum value for a break.",
|
|
7014
|
+
"type": "number"
|
|
7015
|
+
},
|
|
7016
|
+
"classMinValue": {
|
|
7017
|
+
"description": "A numeric value used to specify discontinuous class breaks. If this value is null or is missing, the map server will calculate the minimum value based on the preceding class' maximum value.",
|
|
7018
|
+
"type": "number"
|
|
7019
|
+
},
|
|
7020
|
+
"description": {
|
|
7021
|
+
"description": "String value used to describe the drawn symbol.",
|
|
7022
|
+
"type": "string"
|
|
7023
|
+
},
|
|
7024
|
+
"label": {
|
|
7025
|
+
"description": "String value used to label the drawn symbol.",
|
|
7026
|
+
"type": "string"
|
|
7027
|
+
},
|
|
7028
|
+
"symbol": {
|
|
7029
|
+
"$ref": "#/definitions/esri.rest-api.SymbolJson.SymbolJson",
|
|
7030
|
+
"description": "An object used to display the value."
|
|
7031
|
+
}
|
|
5928
7032
|
},
|
|
5929
7033
|
"required": [
|
|
5930
7034
|
"classMaxValue",
|
|
@@ -9251,6 +10355,60 @@
|
|
|
9251
10355
|
],
|
|
9252
10356
|
"type": "object"
|
|
9253
10357
|
},
|
|
10358
|
+
"esri.rest-api.TableJson.TableJson": {
|
|
10359
|
+
"additionalProperties": false,
|
|
10360
|
+
"description": "Root element in the web map specifying an array of table objects.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/table/} {@link https://developers.arcgis.com/web-scene-specification/objects/table/}.",
|
|
10361
|
+
"properties": {
|
|
10362
|
+
"capabilities": {
|
|
10363
|
+
"description": "A comma-separated string listing which editing operations are allowed on an editable feature service. Available operations include: 'Create', 'Delete', 'Query', 'Update', and 'Editing'.",
|
|
10364
|
+
"enum": [
|
|
10365
|
+
"Create",
|
|
10366
|
+
"Delete",
|
|
10367
|
+
"Editing",
|
|
10368
|
+
"Query",
|
|
10369
|
+
"Update"
|
|
10370
|
+
],
|
|
10371
|
+
"type": "string"
|
|
10372
|
+
},
|
|
10373
|
+
"definitionEditor": {
|
|
10374
|
+
"$ref": "#/definitions/esri.rest-api.DefinitionEditorJson.DefinitionEditorJson",
|
|
10375
|
+
"description": "Object indicating the definitionEditor used as a layer's interactive filter."
|
|
10376
|
+
},
|
|
10377
|
+
"formInfo": {
|
|
10378
|
+
"$ref": "#/definitions/esri.rest-api.FormInfoJson.FormInfoJson",
|
|
10379
|
+
"description": "A formInfo object defining the content of the form when you are editing a record."
|
|
10380
|
+
},
|
|
10381
|
+
"id": {
|
|
10382
|
+
"description": "Unique string identifier for the table.",
|
|
10383
|
+
"type": "string"
|
|
10384
|
+
},
|
|
10385
|
+
"itemId": {
|
|
10386
|
+
"description": "Unique string value indicating an item registered in ArcGIS Online or your organization's portal.",
|
|
10387
|
+
"type": "string"
|
|
10388
|
+
},
|
|
10389
|
+
"layerDefinition": {
|
|
10390
|
+
"$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
|
|
10391
|
+
"description": "A layerDefinition object defining the attribute schema and drawing information for the layer. Used with CSV layers."
|
|
10392
|
+
},
|
|
10393
|
+
"popupInfo": {
|
|
10394
|
+
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson",
|
|
10395
|
+
"description": "An object defining the content of popup windows when you query a record and the sort option for child related records."
|
|
10396
|
+
},
|
|
10397
|
+
"refreshInterval": {
|
|
10398
|
+
"description": "Refresh interval of the table in minutes. Non-zero value indicates automatic table refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.",
|
|
10399
|
+
"type": "number"
|
|
10400
|
+
},
|
|
10401
|
+
"title": {
|
|
10402
|
+
"description": "String value for the title of the table.",
|
|
10403
|
+
"type": "string"
|
|
10404
|
+
},
|
|
10405
|
+
"url": {
|
|
10406
|
+
"description": "String value indicating the URL reference of the hosted table.",
|
|
10407
|
+
"type": "string"
|
|
10408
|
+
}
|
|
10409
|
+
},
|
|
10410
|
+
"type": "object"
|
|
10411
|
+
},
|
|
9254
10412
|
"esri.rest-api.TemplateJson.TemplateJson": {
|
|
9255
10413
|
"additionalProperties": false,
|
|
9256
10414
|
"description": "Templates describe features that can be created in a layer. Templates are used with map notes, other feature collections, and editable web-based CSV layers. They are not used with ArcGIS feature services, which already have feature templates defined in the service.\n\nTemplates are defined as a property of the layer definition when there are no types defined; otherwise, templates are defined as properties of the types.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/template/} {@link https://developers.arcgis.com/web-scene-specification/objects/template/}.",
|
|
@@ -9289,9 +10447,9 @@
|
|
|
9289
10447
|
},
|
|
9290
10448
|
"type": "object"
|
|
9291
10449
|
},
|
|
9292
|
-
"esri.rest-api.
|
|
10450
|
+
"esri.rest-api.TiledElevationServiceLayerJson.TiledElevationServiceLayerJson": {
|
|
9293
10451
|
"additionalProperties": false,
|
|
9294
|
-
"description": "
|
|
10452
|
+
"description": "ElevationLayer is a tile layer used for rendering elevation in web scenes. A default world elevation layer can be added to the map by setting the map's ground property to world-elevation.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/elevationLayer/}.",
|
|
9295
10453
|
"properties": {
|
|
9296
10454
|
"blendMode": {
|
|
9297
10455
|
"description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
|
|
@@ -9330,9 +10488,6 @@
|
|
|
9330
10488
|
],
|
|
9331
10489
|
"type": "string"
|
|
9332
10490
|
},
|
|
9333
|
-
"customParameters": {
|
|
9334
|
-
"description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
|
|
9335
|
-
},
|
|
9336
10491
|
"effect": {
|
|
9337
10492
|
"$ref": "#/definitions/EffectJson",
|
|
9338
10493
|
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
@@ -9345,12 +10500,12 @@
|
|
|
9345
10500
|
"description": "This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).",
|
|
9346
10501
|
"type": "boolean"
|
|
9347
10502
|
},
|
|
9348
|
-
"
|
|
9349
|
-
"
|
|
9350
|
-
"
|
|
10503
|
+
"itemId": {
|
|
10504
|
+
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
10505
|
+
"type": "string"
|
|
9351
10506
|
},
|
|
9352
10507
|
"layerType": {
|
|
9353
|
-
"const": "
|
|
10508
|
+
"const": "ArcGISTiledElevationServiceLayer",
|
|
9354
10509
|
"description": "The type of layer.",
|
|
9355
10510
|
"type": "string"
|
|
9356
10511
|
},
|
|
@@ -9375,6 +10530,10 @@
|
|
|
9375
10530
|
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
9376
10531
|
"type": "number"
|
|
9377
10532
|
},
|
|
10533
|
+
"path": {
|
|
10534
|
+
"description": "For offline data, a path to an ArcGIS Runtime supported raster data file. A URI format is used, starting with file: followed by a file system path. A relative path must be from the file which defines the layer. For example `file:../data/raster_data/beijing.tif`.",
|
|
10535
|
+
"type": "string"
|
|
10536
|
+
},
|
|
9378
10537
|
"refreshInterval": {
|
|
9379
10538
|
"description": "When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See {@link https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm}.",
|
|
9380
10539
|
"type": "number"
|
|
@@ -9402,7 +10561,7 @@
|
|
|
9402
10561
|
"type": "string"
|
|
9403
10562
|
},
|
|
9404
10563
|
"url": {
|
|
9405
|
-
"description": "URL to the
|
|
10564
|
+
"description": "The URL to the layer.If the layer is not from a web service but rather a feature collection, then the url property is omitted.",
|
|
9406
10565
|
"type": "string"
|
|
9407
10566
|
},
|
|
9408
10567
|
"visibility": {
|
|
@@ -9429,9 +10588,9 @@
|
|
|
9429
10588
|
],
|
|
9430
10589
|
"type": "object"
|
|
9431
10590
|
},
|
|
9432
|
-
"esri.rest-api.
|
|
10591
|
+
"esri.rest-api.TiledImageServiceLayerJson.TiledImageServiceLayerJson": {
|
|
9433
10592
|
"additionalProperties": false,
|
|
9434
|
-
"description": "An ArcGIS Tiled
|
|
10593
|
+
"description": "An ArcGIS Tiled Image Service layer displays map content from an ArcGIS Server Image service that has been cached (tiled).\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/tiledImageServiceLayer/} {@link https://developers.arcgis.com/web-scene-specification/objects/tiledImageServiceLayer/}.",
|
|
9435
10594
|
"properties": {
|
|
9436
10595
|
"blendMode": {
|
|
9437
10596
|
"description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
|
|
@@ -9473,21 +10632,10 @@
|
|
|
9473
10632
|
"customParameters": {
|
|
9474
10633
|
"description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
|
|
9475
10634
|
},
|
|
9476
|
-
"displayLevels": {
|
|
9477
|
-
"description": "NOTE: Applicable if used as a baseMapLayer. Integer value(s) indicating the display levels of the basemap layer. Only applicable for TiledMapService layers. All tiled map service layers should share the same tiling scheme. This property cannot be set via the Map Viewer UI.",
|
|
9478
|
-
"items": {
|
|
9479
|
-
"type": "number"
|
|
9480
|
-
},
|
|
9481
|
-
"type": "array"
|
|
9482
|
-
},
|
|
9483
10635
|
"effect": {
|
|
9484
10636
|
"$ref": "#/definitions/EffectJson",
|
|
9485
10637
|
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
9486
10638
|
},
|
|
9487
|
-
"exclusionAreas": {
|
|
9488
|
-
"$ref": "__type",
|
|
9489
|
-
"description": "Exclusion areas define extent areas where no data will be fetched for a layer. NOTE: Applicable if used as a baseMapLayer. An array of exclusionArea objects defining the layer exclusions. See {@link https://developers.arcgis.com/web-map-specification/objects/exclusionArea/}."
|
|
9490
|
-
},
|
|
9491
10639
|
"id": {
|
|
9492
10640
|
"description": "A unique identifying string for the layer.",
|
|
9493
10641
|
"type": "string"
|
|
@@ -9496,22 +10644,15 @@
|
|
|
9496
10644
|
"description": "This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).",
|
|
9497
10645
|
"type": "boolean"
|
|
9498
10646
|
},
|
|
9499
|
-
"
|
|
9500
|
-
"
|
|
9501
|
-
"
|
|
10647
|
+
"layerDefinition": {
|
|
10648
|
+
"$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
|
|
10649
|
+
"description": "An object that defines the attribute schema and drawing information for a layer drawn using client-side graphics. See layerDefinition properties table."
|
|
9502
10650
|
},
|
|
9503
10651
|
"layerType": {
|
|
9504
|
-
"const": "
|
|
10652
|
+
"const": "ArcGISTiledImageServiceLayer",
|
|
9505
10653
|
"description": "The type of layer.",
|
|
9506
10654
|
"type": "string"
|
|
9507
10655
|
},
|
|
9508
|
-
"layers": {
|
|
9509
|
-
"description": "An array of layer objects defining the styling, geometry, and attribute information for the features.",
|
|
9510
|
-
"items": {
|
|
9511
|
-
"$ref": "#/definitions/esri.rest-api.SublayerJson.SublayerJson"
|
|
9512
|
-
},
|
|
9513
|
-
"type": "array"
|
|
9514
|
-
},
|
|
9515
10656
|
"listMode": {
|
|
9516
10657
|
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
9517
10658
|
"enum": [
|
|
@@ -9533,10 +10674,6 @@
|
|
|
9533
10674
|
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
9534
10675
|
"type": "number"
|
|
9535
10676
|
},
|
|
9536
|
-
"path": {
|
|
9537
|
-
"description": "The path to the supporting offline layer. Mobile only. Only valid in MMAP JSON.",
|
|
9538
|
-
"type": "string"
|
|
9539
|
-
},
|
|
9540
10677
|
"refreshInterval": {
|
|
9541
10678
|
"description": "When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See {@link https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm}.",
|
|
9542
10679
|
"type": "number"
|
|
@@ -9564,7 +10701,7 @@
|
|
|
9564
10701
|
"type": "string"
|
|
9565
10702
|
},
|
|
9566
10703
|
"url": {
|
|
9567
|
-
"description": "URL to the ArcGIS Server
|
|
10704
|
+
"description": "URL to the ArcGIS Server Image Service.",
|
|
9568
10705
|
"type": "string"
|
|
9569
10706
|
},
|
|
9570
10707
|
"visibility": {
|
|
@@ -9591,37 +10728,9 @@
|
|
|
9591
10728
|
],
|
|
9592
10729
|
"type": "object"
|
|
9593
10730
|
},
|
|
9594
|
-
"esri.rest-api.
|
|
9595
|
-
"additionalProperties": false,
|
|
9596
|
-
"description": "Types contain information about the combinations of attributes allowed for features in the dataset. Each feature in the dataset can have a type, indicated in its typeIdField, which is used in LayerDefinition.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/type/} {@link https://developers.arcgis.com/web-scene-specification/objects/type/}.",
|
|
9597
|
-
"properties": {
|
|
9598
|
-
"domains": {
|
|
9599
|
-
"description": "A set of domain objects for each domain in the type."
|
|
9600
|
-
},
|
|
9601
|
-
"id": {
|
|
9602
|
-
"description": "A unique numerical ID for the type.",
|
|
9603
|
-
"type": [
|
|
9604
|
-
"string",
|
|
9605
|
-
"number"
|
|
9606
|
-
]
|
|
9607
|
-
},
|
|
9608
|
-
"name": {
|
|
9609
|
-
"description": "A string containing a user-friendly name for the type. This might be shown on a menu of feature types that editors can create in the collection.",
|
|
9610
|
-
"type": "string"
|
|
9611
|
-
},
|
|
9612
|
-
"templates": {
|
|
9613
|
-
"description": "An array of template objects describing features that can be created in this layer. Templates are used with map notes, other feature collections, and editable web-based CSV layers. They are not used with ArcGIS feature services, which already have feature templates defined in the service.\n\nTemplates are defined as a property of the layer definition when there are no types defined; otherwise, templates are defined as properties of the types.\n\nYou might have more than one template per type if the attributes of available features vary slightly. For example, you might have a type named Copper pipe containing two templates: one whose DIAMETER property is 12 and another whose DIAMETER property is 10.",
|
|
9614
|
-
"items": {
|
|
9615
|
-
"$ref": "#/definitions/esri.rest-api.TemplateJson.TemplateJson"
|
|
9616
|
-
},
|
|
9617
|
-
"type": "array"
|
|
9618
|
-
}
|
|
9619
|
-
},
|
|
9620
|
-
"type": "object"
|
|
9621
|
-
},
|
|
9622
|
-
"esri.rest-api.VectorTileLayerJson.VectorTileLayerJson": {
|
|
10731
|
+
"esri.rest-api.TiledMapServiceLayerJson.TiledMapServiceLayerJson": {
|
|
9623
10732
|
"additionalProperties": false,
|
|
9624
|
-
"description": "
|
|
10733
|
+
"description": "An ArcGIS Tiled Map Service layer displays map content from an ArcGIS Server Map service that has been cached (tiled).\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/tiledMapServiceLayer/} {@link https://developers.arcgis.com/web-scene-specification/objects/tiledMapServiceLayer/}.",
|
|
9625
10734
|
"properties": {
|
|
9626
10735
|
"blendMode": {
|
|
9627
10736
|
"description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
|
|
@@ -9663,10 +10772,21 @@
|
|
|
9663
10772
|
"customParameters": {
|
|
9664
10773
|
"description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
|
|
9665
10774
|
},
|
|
10775
|
+
"displayLevels": {
|
|
10776
|
+
"description": "NOTE: Applicable if used as a baseMapLayer. Integer value(s) indicating the display levels of the basemap layer. Only applicable for TiledMapService layers. All tiled map service layers should share the same tiling scheme. This property cannot be set via the Map Viewer UI.",
|
|
10777
|
+
"items": {
|
|
10778
|
+
"type": "number"
|
|
10779
|
+
},
|
|
10780
|
+
"type": "array"
|
|
10781
|
+
},
|
|
9666
10782
|
"effect": {
|
|
9667
10783
|
"$ref": "#/definitions/EffectJson",
|
|
9668
10784
|
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
9669
10785
|
},
|
|
10786
|
+
"exclusionAreas": {
|
|
10787
|
+
"$ref": "__type",
|
|
10788
|
+
"description": "Exclusion areas define extent areas where no data will be fetched for a layer. NOTE: Applicable if used as a baseMapLayer. An array of exclusionArea objects defining the layer exclusions. See {@link https://developers.arcgis.com/web-map-specification/objects/exclusionArea/}."
|
|
10789
|
+
},
|
|
9670
10790
|
"id": {
|
|
9671
10791
|
"description": "A unique identifying string for the layer.",
|
|
9672
10792
|
"type": "string"
|
|
@@ -9680,10 +10800,17 @@
|
|
|
9680
10800
|
"type": "string"
|
|
9681
10801
|
},
|
|
9682
10802
|
"layerType": {
|
|
9683
|
-
"const": "
|
|
10803
|
+
"const": "ArcGISTiledMapServiceLayer",
|
|
9684
10804
|
"description": "The type of layer.",
|
|
9685
10805
|
"type": "string"
|
|
9686
10806
|
},
|
|
10807
|
+
"layers": {
|
|
10808
|
+
"description": "An array of layer objects defining the styling, geometry, and attribute information for the features.",
|
|
10809
|
+
"items": {
|
|
10810
|
+
"$ref": "#/definitions/esri.rest-api.SublayerJson.SublayerJson"
|
|
10811
|
+
},
|
|
10812
|
+
"type": "array"
|
|
10813
|
+
},
|
|
9687
10814
|
"listMode": {
|
|
9688
10815
|
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
9689
10816
|
"enum": [
|
|
@@ -9717,10 +10844,6 @@
|
|
|
9717
10844
|
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
9718
10845
|
"type": "boolean"
|
|
9719
10846
|
},
|
|
9720
|
-
"styleUrl": {
|
|
9721
|
-
"description": "A url to a JSON file containing the stylesheet information used to render the layer. You may also pass an object containing the stylesheet information identical to the JSON file.",
|
|
9722
|
-
"type": "string"
|
|
9723
|
-
},
|
|
9724
10847
|
"title": {
|
|
9725
10848
|
"description": "A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.",
|
|
9726
10849
|
"type": "string"
|
|
@@ -9739,6 +10862,10 @@
|
|
|
9739
10862
|
],
|
|
9740
10863
|
"type": "string"
|
|
9741
10864
|
},
|
|
10865
|
+
"url": {
|
|
10866
|
+
"description": "URL to the ArcGIS Server tiled Map Service.",
|
|
10867
|
+
"type": "string"
|
|
10868
|
+
},
|
|
9742
10869
|
"visibility": {
|
|
9743
10870
|
"description": "Determines whether the layer is initially visible in the web map.",
|
|
9744
10871
|
"type": "boolean"
|
|
@@ -9763,14 +10890,231 @@
|
|
|
9763
10890
|
],
|
|
9764
10891
|
"type": "object"
|
|
9765
10892
|
},
|
|
9766
|
-
"esri.rest-api.
|
|
10893
|
+
"esri.rest-api.TypeJson.TypeJson": {
|
|
9767
10894
|
"additionalProperties": false,
|
|
9768
|
-
"description": "
|
|
10895
|
+
"description": "Types contain information about the combinations of attributes allowed for features in the dataset. Each feature in the dataset can have a type, indicated in its typeIdField, which is used in LayerDefinition.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/type/} {@link https://developers.arcgis.com/web-scene-specification/objects/type/}.",
|
|
9769
10896
|
"properties": {
|
|
9770
|
-
"
|
|
9771
|
-
"description": "A
|
|
10897
|
+
"domains": {
|
|
10898
|
+
"description": "A set of domain objects for each domain in the type."
|
|
9772
10899
|
},
|
|
9773
|
-
"
|
|
10900
|
+
"id": {
|
|
10901
|
+
"description": "A unique numerical ID for the type.",
|
|
10902
|
+
"type": [
|
|
10903
|
+
"string",
|
|
10904
|
+
"number"
|
|
10905
|
+
]
|
|
10906
|
+
},
|
|
10907
|
+
"name": {
|
|
10908
|
+
"description": "A string containing a user-friendly name for the type. This might be shown on a menu of feature types that editors can create in the collection.",
|
|
10909
|
+
"type": "string"
|
|
10910
|
+
},
|
|
10911
|
+
"templates": {
|
|
10912
|
+
"description": "An array of template objects describing features that can be created in this layer. Templates are used with map notes, other feature collections, and editable web-based CSV layers. They are not used with ArcGIS feature services, which already have feature templates defined in the service.\n\nTemplates are defined as a property of the layer definition when there are no types defined; otherwise, templates are defined as properties of the types.\n\nYou might have more than one template per type if the attributes of available features vary slightly. For example, you might have a type named Copper pipe containing two templates: one whose DIAMETER property is 12 and another whose DIAMETER property is 10.",
|
|
10913
|
+
"items": {
|
|
10914
|
+
"$ref": "#/definitions/esri.rest-api.TemplateJson.TemplateJson"
|
|
10915
|
+
},
|
|
10916
|
+
"type": "array"
|
|
10917
|
+
}
|
|
10918
|
+
},
|
|
10919
|
+
"type": "object"
|
|
10920
|
+
},
|
|
10921
|
+
"esri.rest-api.VectorTileLayerJson.VectorTileLayerJson": {
|
|
10922
|
+
"additionalProperties": false,
|
|
10923
|
+
"description": "A vector tile layer references a set of web-accessible vector tiles and the corresponding style for how those tiles should be drawn.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/vectorTileLayer/} {@link https://developers.arcgis.com/web-scene-specification/objects/vectorTileLayer/}.",
|
|
10924
|
+
"properties": {
|
|
10925
|
+
"blendMode": {
|
|
10926
|
+
"description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
|
|
10927
|
+
"enum": [
|
|
10928
|
+
"average",
|
|
10929
|
+
"color",
|
|
10930
|
+
"color-burn",
|
|
10931
|
+
"color-dodge",
|
|
10932
|
+
"darken",
|
|
10933
|
+
"destination-atop",
|
|
10934
|
+
"destination-in",
|
|
10935
|
+
"destination-out",
|
|
10936
|
+
"destination-over",
|
|
10937
|
+
"difference",
|
|
10938
|
+
"exclusion",
|
|
10939
|
+
"hard-light",
|
|
10940
|
+
"hue",
|
|
10941
|
+
"invert",
|
|
10942
|
+
"lighten",
|
|
10943
|
+
"lighter",
|
|
10944
|
+
"luminosity",
|
|
10945
|
+
"minus",
|
|
10946
|
+
"multiply",
|
|
10947
|
+
"normal",
|
|
10948
|
+
"overlay",
|
|
10949
|
+
"plus",
|
|
10950
|
+
"reflect",
|
|
10951
|
+
"saturation",
|
|
10952
|
+
"screen",
|
|
10953
|
+
"soft-light",
|
|
10954
|
+
"source-atop",
|
|
10955
|
+
"source-in",
|
|
10956
|
+
"source-out",
|
|
10957
|
+
"vivid-light",
|
|
10958
|
+
"xor"
|
|
10959
|
+
],
|
|
10960
|
+
"type": "string"
|
|
10961
|
+
},
|
|
10962
|
+
"customParameters": {
|
|
10963
|
+
"description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
|
|
10964
|
+
},
|
|
10965
|
+
"effect": {
|
|
10966
|
+
"$ref": "#/definitions/EffectJson",
|
|
10967
|
+
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
10968
|
+
},
|
|
10969
|
+
"id": {
|
|
10970
|
+
"description": "A unique identifying string for the layer.",
|
|
10971
|
+
"type": "string"
|
|
10972
|
+
},
|
|
10973
|
+
"isReference": {
|
|
10974
|
+
"description": "This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).",
|
|
10975
|
+
"type": "boolean"
|
|
10976
|
+
},
|
|
10977
|
+
"itemId": {
|
|
10978
|
+
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
10979
|
+
"type": "string"
|
|
10980
|
+
},
|
|
10981
|
+
"layerType": {
|
|
10982
|
+
"const": "VectorTileLayer",
|
|
10983
|
+
"description": "The type of layer.",
|
|
10984
|
+
"type": "string"
|
|
10985
|
+
},
|
|
10986
|
+
"listMode": {
|
|
10987
|
+
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
10988
|
+
"enum": [
|
|
10989
|
+
"hide",
|
|
10990
|
+
"hide-children",
|
|
10991
|
+
"show"
|
|
10992
|
+
],
|
|
10993
|
+
"type": "string"
|
|
10994
|
+
},
|
|
10995
|
+
"maxScale": {
|
|
10996
|
+
"description": "A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.",
|
|
10997
|
+
"type": "number"
|
|
10998
|
+
},
|
|
10999
|
+
"minScale": {
|
|
11000
|
+
"description": "A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.",
|
|
11001
|
+
"type": "number"
|
|
11002
|
+
},
|
|
11003
|
+
"opacity": {
|
|
11004
|
+
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
11005
|
+
"type": "number"
|
|
11006
|
+
},
|
|
11007
|
+
"path": {
|
|
11008
|
+
"description": "The path to the supporting offline layer. Mobile only. Only valid in MMAP JSON.",
|
|
11009
|
+
"type": "string"
|
|
11010
|
+
},
|
|
11011
|
+
"refreshInterval": {
|
|
11012
|
+
"description": "When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See {@link https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm}.",
|
|
11013
|
+
"type": "number"
|
|
11014
|
+
},
|
|
11015
|
+
"showLegend": {
|
|
11016
|
+
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
11017
|
+
"type": "boolean"
|
|
11018
|
+
},
|
|
11019
|
+
"styleUrl": {
|
|
11020
|
+
"description": "A url to a JSON file containing the stylesheet information used to render the layer. You may also pass an object containing the stylesheet information identical to the JSON file.",
|
|
11021
|
+
"type": "string"
|
|
11022
|
+
},
|
|
11023
|
+
"title": {
|
|
11024
|
+
"description": "A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.",
|
|
11025
|
+
"type": "string"
|
|
11026
|
+
},
|
|
11027
|
+
"type": {
|
|
11028
|
+
"description": "(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type.",
|
|
11029
|
+
"enum": [
|
|
11030
|
+
"BingMapsAerial",
|
|
11031
|
+
"BingMapsHybrid",
|
|
11032
|
+
"BingMapsRoad",
|
|
11033
|
+
"CSV",
|
|
11034
|
+
"KML",
|
|
11035
|
+
"OpenStreetMap",
|
|
11036
|
+
"WMS",
|
|
11037
|
+
"WebTiledLayer"
|
|
11038
|
+
],
|
|
11039
|
+
"type": "string"
|
|
11040
|
+
},
|
|
11041
|
+
"visibility": {
|
|
11042
|
+
"description": "Determines whether the layer is initially visible in the web map.",
|
|
11043
|
+
"type": "boolean"
|
|
11044
|
+
},
|
|
11045
|
+
"visibilityTimeExtent": {
|
|
11046
|
+
"description": "Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.",
|
|
11047
|
+
"items": [
|
|
11048
|
+
{
|
|
11049
|
+
"type": "number"
|
|
11050
|
+
},
|
|
11051
|
+
{
|
|
11052
|
+
"type": "number"
|
|
11053
|
+
}
|
|
11054
|
+
],
|
|
11055
|
+
"maxItems": 2,
|
|
11056
|
+
"minItems": 2,
|
|
11057
|
+
"type": "array"
|
|
11058
|
+
}
|
|
11059
|
+
},
|
|
11060
|
+
"required": [
|
|
11061
|
+
"layerType"
|
|
11062
|
+
],
|
|
11063
|
+
"type": "object"
|
|
11064
|
+
},
|
|
11065
|
+
"esri.rest-api.ViewpointJson.CameraJson": {
|
|
11066
|
+
"additionalProperties": false,
|
|
11067
|
+
"description": "The camera defines the position, tilt, and heading of the point from which the SceneView's visible extent is observed.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/camera/}.",
|
|
11068
|
+
"properties": {
|
|
11069
|
+
"heading": {
|
|
11070
|
+
"description": "The heading of the camera in degrees. Heading is zero when north is the top of the screen. It increases as the view rotates clockwise. The angles are always normalized between 0 and 360 degrees.",
|
|
11071
|
+
"type": "number"
|
|
11072
|
+
},
|
|
11073
|
+
"position": {
|
|
11074
|
+
"$ref": "#/definitions/esri.rest-api.GeometryJson.PointJson",
|
|
11075
|
+
"description": "The position of the camera defined by a map point."
|
|
11076
|
+
},
|
|
11077
|
+
"tilt": {
|
|
11078
|
+
"description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position. Tilt is zero when looking straight down at the surface and 90 degrees when the camera is looking parallel to the surface.",
|
|
11079
|
+
"type": "number"
|
|
11080
|
+
}
|
|
11081
|
+
},
|
|
11082
|
+
"required": [
|
|
11083
|
+
"position"
|
|
11084
|
+
],
|
|
11085
|
+
"type": "object"
|
|
11086
|
+
},
|
|
11087
|
+
"esri.rest-api.ViewpointJson.ViewpointJson": {
|
|
11088
|
+
"additionalProperties": false,
|
|
11089
|
+
"description": "Describes a point of view for a 2D or 3D view. In a 2D view, the viewpoint is determined using a center point and scale value. In a 3D view, it is determined using a camera position. The Viewpoint can be bookmarked for later use, or used for navigation purposes.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/viewpoint/} {@link https://developers.arcgis.com/web-scene-specification/objects/viewpoint/}.",
|
|
11090
|
+
"properties": {
|
|
11091
|
+
"camera": {
|
|
11092
|
+
"$ref": "#/definitions/esri.rest-api.ViewpointJson.CameraJson",
|
|
11093
|
+
"description": "The camera defines the position, tilt, and heading of the point from which the SceneView's visible extent is observed."
|
|
11094
|
+
},
|
|
11095
|
+
"rotation": {
|
|
11096
|
+
"description": "The rotation of due north in relation to the top of the view in degrees.",
|
|
11097
|
+
"type": "number"
|
|
11098
|
+
},
|
|
11099
|
+
"scale": {
|
|
11100
|
+
"description": "The scale of the viewpoint.",
|
|
11101
|
+
"type": "number"
|
|
11102
|
+
},
|
|
11103
|
+
"targetGeometry": {
|
|
11104
|
+
"$ref": "#/definitions/GeometryJson",
|
|
11105
|
+
"description": "The target geometry framed by the viewpoint."
|
|
11106
|
+
}
|
|
11107
|
+
},
|
|
11108
|
+
"type": "object"
|
|
11109
|
+
},
|
|
11110
|
+
"esri.rest-api.WFSLayerJson.WFSInfoJson": {
|
|
11111
|
+
"additionalProperties": false,
|
|
11112
|
+
"description": "Object that defines and provides information about layers in a WFS service.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/wfsInfo/}.",
|
|
11113
|
+
"properties": {
|
|
11114
|
+
"customParameters": {
|
|
11115
|
+
"description": "A sequence of parameters used to append custom parameters to all WFS requests. These parameters are applied to GetCapabilities, DescribeFeatureType, and GetFeatures."
|
|
11116
|
+
},
|
|
11117
|
+
"featureUrl": {
|
|
9774
11118
|
"description": "URL of the WFS service operation.",
|
|
9775
11119
|
"type": "string"
|
|
9776
11120
|
},
|
|
@@ -10206,6 +11550,664 @@
|
|
|
10206
11550
|
},
|
|
10207
11551
|
"type": "object"
|
|
10208
11552
|
},
|
|
11553
|
+
"esri.rest-api.WebMapJson.ApplicationPropertiesJson": {
|
|
11554
|
+
"additionalProperties": false,
|
|
11555
|
+
"description": "The applicationProperties object is one of the objects at the top level of the JSON web map JSON schema. This is responsible for containing the viewing and editing properties of the web map. There are specific objects within this object that are applicable only to Collector and are explained within the property descriptions.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/applicationProperties/}.",
|
|
11556
|
+
"properties": {
|
|
11557
|
+
"editing": {
|
|
11558
|
+
"$ref": "__type",
|
|
11559
|
+
"description": "If locationTracking is set and enabled, the Collector application will update the feature service at the defined interval with the current location of the user logged into the Collector app. See {@link https://developers.arcgis.com/web-map-specification/objects/editing/}."
|
|
11560
|
+
},
|
|
11561
|
+
"offline": {
|
|
11562
|
+
"$ref": "__type",
|
|
11563
|
+
"description": "Use if working with offline maps. See {@link https://developers.arcgis.com/web-map-specification/objects/offline/}."
|
|
11564
|
+
},
|
|
11565
|
+
"viewing": {
|
|
11566
|
+
"$ref": "__type",
|
|
11567
|
+
"description": "An object containing all the viewing properties of the web map. If this is null or not defined, the client should assume a logical default. See {@link https://developers.arcgis.com/web-map-specification/objects/viewing/}."
|
|
11568
|
+
}
|
|
11569
|
+
},
|
|
11570
|
+
"type": "object"
|
|
11571
|
+
},
|
|
11572
|
+
"esri.rest-api.WebMapJson.BookmarkJson": {
|
|
11573
|
+
"additionalProperties": false,
|
|
11574
|
+
"description": "Predefined bookmarks for use by the application. A bookmark is a saved map extent that allows end users to quickly navigate to a particular area of interest.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/bookmark/}.",
|
|
11575
|
+
"properties": {
|
|
11576
|
+
"extent": {
|
|
11577
|
+
"$ref": "#/definitions/esri.rest-api.GeometryJson.ExtentJson"
|
|
11578
|
+
},
|
|
11579
|
+
"name": {
|
|
11580
|
+
"description": "A string name for the bookmark.",
|
|
11581
|
+
"type": "string"
|
|
11582
|
+
},
|
|
11583
|
+
"thumbnail": {
|
|
11584
|
+
"$ref": "__type",
|
|
11585
|
+
"description": "Object containing a thumbnail image."
|
|
11586
|
+
},
|
|
11587
|
+
"viewpoint": {
|
|
11588
|
+
"$ref": "#/definitions/esri.rest-api.ViewpointJson.ViewpointJson",
|
|
11589
|
+
"description": "Represents the location displayed on the map. If viewpoint is defined, ignore the extent. If viewpoint is not defined, use the extent property. For backwards compatibility, please save both extent and viewpoint properties."
|
|
11590
|
+
}
|
|
11591
|
+
},
|
|
11592
|
+
"required": [
|
|
11593
|
+
"name"
|
|
11594
|
+
],
|
|
11595
|
+
"type": "object"
|
|
11596
|
+
},
|
|
11597
|
+
"esri.rest-api.WebMapJson.FacilityLayerInfoJson": {
|
|
11598
|
+
"additionalProperties": false,
|
|
11599
|
+
"description": "Defines the layer and field properties for the Facility layer used for floor filtering. See {@link https://developers.arcgis.com/web-map-specification/objects/facilityLayerInfo/}.",
|
|
11600
|
+
"properties": {
|
|
11601
|
+
"facilityIdField": {
|
|
11602
|
+
"description": "The name of the attribute field that contains a facility feature's unique identifier.",
|
|
11603
|
+
"type": "string"
|
|
11604
|
+
},
|
|
11605
|
+
"layerId": {
|
|
11606
|
+
"description": "A layer ID that refers to an operational layer in the map. The layer provides access to Facility features to use for floor filtering.",
|
|
11607
|
+
"type": "string"
|
|
11608
|
+
},
|
|
11609
|
+
"nameField": {
|
|
11610
|
+
"description": "The name of the attribute field that contains a facility feature's name.",
|
|
11611
|
+
"type": "string"
|
|
11612
|
+
},
|
|
11613
|
+
"siteIdField": {
|
|
11614
|
+
"description": "The name of the attribute field that contains a facility feature's site identifier (a foreign key to the Site layer).",
|
|
11615
|
+
"type": "string"
|
|
11616
|
+
}
|
|
11617
|
+
},
|
|
11618
|
+
"type": "object"
|
|
11619
|
+
},
|
|
11620
|
+
"esri.rest-api.WebMapJson.FloorFilterJson": {
|
|
11621
|
+
"additionalProperties": false,
|
|
11622
|
+
"description": "Configurable properties used by the floor filter widget. See {@link https://developers.arcgis.com/web-map-specification/objects/floorFilter/}.",
|
|
11623
|
+
"properties": {
|
|
11624
|
+
"enabled": {
|
|
11625
|
+
"description": "Indicates whether the floor filter is actively filtering the displayed content according to the floor filter selection.",
|
|
11626
|
+
"type": "boolean"
|
|
11627
|
+
},
|
|
11628
|
+
"facility": {
|
|
11629
|
+
"description": "Contains a facility identifier for the initially selected facility in the floor filter.",
|
|
11630
|
+
"type": "string"
|
|
11631
|
+
},
|
|
11632
|
+
"level": {
|
|
11633
|
+
"description": "Contains a level identifier for the initially selected floor, which is used when filtering floor-aware layers.",
|
|
11634
|
+
"type": "string"
|
|
11635
|
+
},
|
|
11636
|
+
"longNames": {
|
|
11637
|
+
"description": "Indicates whether the floor filter is showing long names instead of short names for floor levels.",
|
|
11638
|
+
"type": "boolean"
|
|
11639
|
+
},
|
|
11640
|
+
"minimized": {
|
|
11641
|
+
"description": "Indicates whether the floor filter has been minimized to show only the levels list instead of showing the full set of breadcrumbs.",
|
|
11642
|
+
"type": "boolean"
|
|
11643
|
+
},
|
|
11644
|
+
"pinnedLevels": {
|
|
11645
|
+
"description": "Indicates whether the floor filter has been pinned to show the floor levels list, instead of including the levels as a breadcrumb dropdown.",
|
|
11646
|
+
"type": "boolean"
|
|
11647
|
+
},
|
|
11648
|
+
"siteIdentifier": {
|
|
11649
|
+
"description": "Contains a site identifier for the initially selected site in the floor filter.",
|
|
11650
|
+
"type": "string"
|
|
11651
|
+
}
|
|
11652
|
+
},
|
|
11653
|
+
"type": "object"
|
|
11654
|
+
},
|
|
11655
|
+
"esri.rest-api.WebMapJson.InitialStateJson": {
|
|
11656
|
+
"additionalProperties": false,
|
|
11657
|
+
"description": "Defines the initial state when opening web scene.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/initialState/}.",
|
|
11658
|
+
"properties": {
|
|
11659
|
+
"environment": {
|
|
11660
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.EnvironmentJson",
|
|
11661
|
+
"description": "The initial environment settings of the WebScene."
|
|
11662
|
+
},
|
|
11663
|
+
"viewpoint": {
|
|
11664
|
+
"$ref": "#/definitions/esri.rest-api.ViewpointJson.ViewpointJson",
|
|
11665
|
+
"description": "Describes a point of view for a 2D or 3D view. In a 3D view, it is determined using a camera position."
|
|
11666
|
+
}
|
|
11667
|
+
},
|
|
11668
|
+
"required": [
|
|
11669
|
+
"viewpoint"
|
|
11670
|
+
],
|
|
11671
|
+
"type": "object"
|
|
11672
|
+
},
|
|
11673
|
+
"esri.rest-api.WebMapJson.LevelLayerInfoJson": {
|
|
11674
|
+
"additionalProperties": false,
|
|
11675
|
+
"description": "Defines the layer and field properties for the Level layer used for floor filtering. See {@link https://developers.arcgis.com/web-map-specification/objects/levelLayerInfo/}.",
|
|
11676
|
+
"properties": {
|
|
11677
|
+
"facilityIdField": {
|
|
11678
|
+
"description": "The name of the attribute field that contains a level feature's facility identifier (a foreign key to the Facility layer).",
|
|
11679
|
+
"type": "string"
|
|
11680
|
+
},
|
|
11681
|
+
"layerId": {
|
|
11682
|
+
"description": "A layer ID that refers to an operational layer in the map. The layer provides access to Level features to use for floor filtering.",
|
|
11683
|
+
"type": "string"
|
|
11684
|
+
},
|
|
11685
|
+
"levelIdField": {
|
|
11686
|
+
"description": "The name of the attribute field that contains a level feature's unique identifier.",
|
|
11687
|
+
"type": "string"
|
|
11688
|
+
},
|
|
11689
|
+
"levelNumberField": {
|
|
11690
|
+
"description": "The name of the attribute field that contains a level feature's level number specific to its facility.",
|
|
11691
|
+
"type": "string"
|
|
11692
|
+
},
|
|
11693
|
+
"longNameField": {
|
|
11694
|
+
"description": "The name of the attribute field that contains a level feature's long name.",
|
|
11695
|
+
"type": "string"
|
|
11696
|
+
},
|
|
11697
|
+
"shortNameField": {
|
|
11698
|
+
"description": "The name of the attribute field that contains a level feature's short name.",
|
|
11699
|
+
"type": "string"
|
|
11700
|
+
},
|
|
11701
|
+
"verticalOrderField": {
|
|
11702
|
+
"description": "The name of the attribute field that contains a level feature's vertical order. The vertical order defines the order of display in the floor filter widget, and it also references the floor levels of an Indoor Positioning System.",
|
|
11703
|
+
"type": "string"
|
|
11704
|
+
}
|
|
11705
|
+
},
|
|
11706
|
+
"type": "object"
|
|
11707
|
+
},
|
|
11708
|
+
"esri.rest-api.WebMapJson.MapFloorInfoJson": {
|
|
11709
|
+
"additionalProperties": false,
|
|
11710
|
+
"description": "Contains floor-awareness information for the map. Defines the layers and required fields for each layer that are used for floor filtering. See {@link https://developers.arcgis.com/web-map-specification/objects/mapFloorInfo/}.",
|
|
11711
|
+
"properties": {
|
|
11712
|
+
"facilityLayer": {
|
|
11713
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.FacilityLayerInfoJson",
|
|
11714
|
+
"description": "Defines the layer and field properties for the Facility layer used for floor filtering."
|
|
11715
|
+
},
|
|
11716
|
+
"levelLayer": {
|
|
11717
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.LevelLayerInfoJson",
|
|
11718
|
+
"description": "Defines the layer and field properties for the Level layer used for floor filtering."
|
|
11719
|
+
},
|
|
11720
|
+
"siteLayer": {
|
|
11721
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.SiteLayerInfoJson",
|
|
11722
|
+
"description": "Defines the layer and field properties for the Site layer used for floor filtering. This property is optional."
|
|
11723
|
+
}
|
|
11724
|
+
},
|
|
11725
|
+
"type": "object"
|
|
11726
|
+
},
|
|
11727
|
+
"esri.rest-api.WebMapJson.MapRangeInfoJson": {
|
|
11728
|
+
"additionalProperties": false,
|
|
11729
|
+
"description": "Map Range Information.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/mapRangeInfo/}.",
|
|
11730
|
+
"properties": {
|
|
11731
|
+
"activeRangeName": {
|
|
11732
|
+
"description": "Active range ID that slider/picker acts upon.",
|
|
11733
|
+
"type": "string"
|
|
11734
|
+
},
|
|
11735
|
+
"currentRangeExtent": {
|
|
11736
|
+
"description": "Current range for the active range.",
|
|
11737
|
+
"items": [
|
|
11738
|
+
{
|
|
11739
|
+
"type": "number"
|
|
11740
|
+
},
|
|
11741
|
+
{
|
|
11742
|
+
"type": "number"
|
|
11743
|
+
}
|
|
11744
|
+
],
|
|
11745
|
+
"maxItems": 2,
|
|
11746
|
+
"minItems": 2,
|
|
11747
|
+
"type": "array"
|
|
11748
|
+
},
|
|
11749
|
+
"fullRangeExtent": {
|
|
11750
|
+
"description": "Full range extent for the active range to be presented in the UI.",
|
|
11751
|
+
"items": [
|
|
11752
|
+
{
|
|
11753
|
+
"type": "number"
|
|
11754
|
+
},
|
|
11755
|
+
{
|
|
11756
|
+
"type": "number"
|
|
11757
|
+
}
|
|
11758
|
+
],
|
|
11759
|
+
"maxItems": 2,
|
|
11760
|
+
"minItems": 2,
|
|
11761
|
+
"type": "array"
|
|
11762
|
+
}
|
|
11763
|
+
},
|
|
11764
|
+
"type": "object"
|
|
11765
|
+
},
|
|
11766
|
+
"esri.rest-api.WebMapJson.PresentationJson": {
|
|
11767
|
+
"additionalProperties": false,
|
|
11768
|
+
"description": "A presentation consists of multiple slides, where each slide is a specific view into the web scene.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/presentation/} {@link https://developers.arcgis.com/web-scene-specification/objects/presentation/}.",
|
|
11769
|
+
"properties": {
|
|
11770
|
+
"displayTimeSlider": {
|
|
11771
|
+
"description": "Indicates whether to display the time slider (if accessible). [WebMap only].",
|
|
11772
|
+
"type": "boolean"
|
|
11773
|
+
},
|
|
11774
|
+
"showLegend": {
|
|
11775
|
+
"description": "Indicates whether to display a legend on all slides. [WebMap only].",
|
|
11776
|
+
"type": "boolean"
|
|
11777
|
+
},
|
|
11778
|
+
"slideAdvancementInterval": {
|
|
11779
|
+
"description": "Number of seconds to show slide before proceeding to the next slide. [WebMap only].",
|
|
11780
|
+
"type": "number"
|
|
11781
|
+
},
|
|
11782
|
+
"slides": {
|
|
11783
|
+
"description": "An array of slides that bookmark viewpoints, visible layers, and other settings previously defined in a WebScene.",
|
|
11784
|
+
"items": {
|
|
11785
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.SlideJson"
|
|
11786
|
+
},
|
|
11787
|
+
"type": "array"
|
|
11788
|
+
},
|
|
11789
|
+
"useTimeExtentOfSlide": {
|
|
11790
|
+
"description": "Indicates whether to use the time extent (if applicable) of a slide. [WebMap only].",
|
|
11791
|
+
"type": "boolean"
|
|
11792
|
+
}
|
|
11793
|
+
},
|
|
11794
|
+
"type": "object"
|
|
11795
|
+
},
|
|
11796
|
+
"esri.rest-api.WebMapJson.RangeJson": {
|
|
11797
|
+
"additionalProperties": false,
|
|
11798
|
+
"description": "Range object.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/range/} {@link https://developers.arcgis.com/web-scene-specification/objects/range/}.",
|
|
11799
|
+
"properties": {
|
|
11800
|
+
"interactionMode": {
|
|
11801
|
+
"description": "Indicates the mode in which the active range should be presented to the user. Must be one of the following values: slider, picker.",
|
|
11802
|
+
"type": "string"
|
|
11803
|
+
},
|
|
11804
|
+
"numberOfStops": {
|
|
11805
|
+
"description": "This is used to generate the activeRangeValues if activeRangeValues are not specified.",
|
|
11806
|
+
"type": "number"
|
|
11807
|
+
},
|
|
11808
|
+
"stopInterval": {
|
|
11809
|
+
"description": "Interval in which stops should be generated.",
|
|
11810
|
+
"type": "number"
|
|
11811
|
+
}
|
|
11812
|
+
},
|
|
11813
|
+
"type": "object"
|
|
11814
|
+
},
|
|
11815
|
+
"esri.rest-api.WebMapJson.SiteLayerInfoJson": {
|
|
11816
|
+
"additionalProperties": false,
|
|
11817
|
+
"description": "Defines the layer and field properties for the Site layer used for floor filtering. This property is optional. See {@link https://developers.arcgis.com/web-map-specification/objects/siteLayerInfo/}.",
|
|
11818
|
+
"properties": {
|
|
11819
|
+
"layerId": {
|
|
11820
|
+
"description": "A layer ID that refers to an operational layer in the map. The layer provides access to Site features to use for floor filtering.",
|
|
11821
|
+
"type": "string"
|
|
11822
|
+
},
|
|
11823
|
+
"nameField": {
|
|
11824
|
+
"description": "The name of the attribute field that contains a site feature's name.",
|
|
11825
|
+
"type": "string"
|
|
11826
|
+
},
|
|
11827
|
+
"siteIdField": {
|
|
11828
|
+
"description": "The name of the attribute field that contains a site feature's unique identifier.",
|
|
11829
|
+
"type": "string"
|
|
11830
|
+
}
|
|
11831
|
+
},
|
|
11832
|
+
"type": "object"
|
|
11833
|
+
},
|
|
11834
|
+
"esri.rest-api.WebMapJson.SlideJson": {
|
|
11835
|
+
"additionalProperties": false,
|
|
11836
|
+
"description": "A slide stores a snapshot of several pre-set properties of the WebScene, such as the basemap, viewpoint and visible layers.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/slide/} {@link https://developers.arcgis.com/web-scene-specification/objects/slide/}.",
|
|
11837
|
+
"properties": {
|
|
11838
|
+
"baseMap": {
|
|
11839
|
+
"anyOf": [
|
|
11840
|
+
{
|
|
11841
|
+
"$ref": "#/definitions/esri.rest-api.BasemapJson.BasemapJson"
|
|
11842
|
+
},
|
|
11843
|
+
{
|
|
11844
|
+
"type": "string"
|
|
11845
|
+
}
|
|
11846
|
+
],
|
|
11847
|
+
"description": "The basemap of the scene. Only the base and reference layers of the basemap are stored in a slide. This value can be an instance of Basemap or one of the strings listed in the table below. Same as baseMap, but with no elevationLayers property."
|
|
11848
|
+
},
|
|
11849
|
+
"description": {
|
|
11850
|
+
"$ref": "__type",
|
|
11851
|
+
"description": "Text description of the individual presentation slide."
|
|
11852
|
+
},
|
|
11853
|
+
"environment": {
|
|
11854
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.EnvironmentJson",
|
|
11855
|
+
"description": "Represents settings that affect the environment in which the WebScene is displayed (such as lighting)."
|
|
11856
|
+
},
|
|
11857
|
+
"extent": {
|
|
11858
|
+
"$ref": "#/definitions/esri.rest-api.GeometryJson.ExtentJson",
|
|
11859
|
+
"description": "The standard Esri extent object with spatialReference, xmax, xmin, ymax and ymin. [WebMap Only]."
|
|
11860
|
+
},
|
|
11861
|
+
"hidden": {
|
|
11862
|
+
"description": "Indicates whether the slide should be hidden within the presentation. [WebMap Only].",
|
|
11863
|
+
"type": "boolean"
|
|
11864
|
+
},
|
|
11865
|
+
"id": {
|
|
11866
|
+
"description": "The unique id of a slide within the slides property of a Presentation.",
|
|
11867
|
+
"type": "string"
|
|
11868
|
+
},
|
|
11869
|
+
"mapLocation": {
|
|
11870
|
+
"$ref": "__type",
|
|
11871
|
+
"description": "An object with a centerPoint object and sometimes a resolution. [WebMap Only] {@link https://developers.arcgis.com/web-map-specification/objects/mapLocation/}."
|
|
11872
|
+
},
|
|
11873
|
+
"thumbnail": {
|
|
11874
|
+
"$ref": "__type",
|
|
11875
|
+
"description": "A data URI encoded thumbnail. See {@link https://developers.arcgis.com/web-scene-specification/objects/thumbnail/}."
|
|
11876
|
+
},
|
|
11877
|
+
"timeExtent": {
|
|
11878
|
+
"description": "An array of two numbers. The first one indicates start time and the second one indicates end time. [WebMap Only].",
|
|
11879
|
+
"items": {
|
|
11880
|
+
"type": "number"
|
|
11881
|
+
},
|
|
11882
|
+
"type": "array"
|
|
11883
|
+
},
|
|
11884
|
+
"title": {
|
|
11885
|
+
"$ref": "__type",
|
|
11886
|
+
"description": "Text and formatting for the title of the individual presentation slide https://developers.arcgis.com/web-map-specification/objects/title/ {@link https://developers.arcgis.com/web-scene-specification/objects/title/}."
|
|
11887
|
+
},
|
|
11888
|
+
"viewpoint": {
|
|
11889
|
+
"$ref": "#/definitions/esri.rest-api.ViewpointJson.ViewpointJson",
|
|
11890
|
+
"description": "The viewpoint of the slide. This acts like a bookmark, saving a predefined location or point of view from which to view the scene."
|
|
11891
|
+
},
|
|
11892
|
+
"visibleLayers": {
|
|
11893
|
+
"description": "An array of numbers indicating layer visibility. Stores references (by ID) to the layers that are set as visible when a slide is applied to a MapView or SceneView. See {@link https://developers.arcgis.com/web-map-specification/objects/visibleLayer/} {@link https://developers.arcgis.com/web-scene-specification/objects/visibleLayer/}.",
|
|
11894
|
+
"items": {
|
|
11895
|
+
"$ref": "__type"
|
|
11896
|
+
},
|
|
11897
|
+
"type": "array"
|
|
11898
|
+
},
|
|
11899
|
+
"visiblePopup": {
|
|
11900
|
+
"$ref": "__type",
|
|
11901
|
+
"description": "A presentation slide's visiblePopup which contains anchorPoint, featureId, layerId, and subLayerId. See {@link https://developers.arcgis.com/web-map-specification/objects/visiblePopup/}."
|
|
11902
|
+
}
|
|
11903
|
+
},
|
|
11904
|
+
"type": "object"
|
|
11905
|
+
},
|
|
11906
|
+
"esri.rest-api.WebMapJson.TimeSliderJson": {
|
|
11907
|
+
"additionalProperties": false,
|
|
11908
|
+
"description": "Time animation is controlled by a configurable time slider. Those configurations are saved to the web map as a timeSlider widget.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/timeSlider/}.",
|
|
11909
|
+
"properties": {
|
|
11910
|
+
"properties": {
|
|
11911
|
+
"$ref": "__type",
|
|
11912
|
+
"description": "Properties for the time slider."
|
|
11913
|
+
}
|
|
11914
|
+
},
|
|
11915
|
+
"required": [
|
|
11916
|
+
"properties"
|
|
11917
|
+
],
|
|
11918
|
+
"type": "object"
|
|
11919
|
+
},
|
|
11920
|
+
"esri.rest-api.WebMapJson.TraceConfigurationJson": {
|
|
11921
|
+
"additionalProperties": false,
|
|
11922
|
+
"description": "An array of pre-configured trace configurations for quickly running common traces. See {@link https://developers.arcgis.com/web-map-specification/objects/traceConfiguration/}.",
|
|
11923
|
+
"properties": {
|
|
11924
|
+
"id": {
|
|
11925
|
+
"description": "A unique identifying string for the trace configuration.",
|
|
11926
|
+
"type": "string"
|
|
11927
|
+
},
|
|
11928
|
+
"title": {
|
|
11929
|
+
"description": "A user-friendly string title for the trace configuration that can be used in a table of contents.",
|
|
11930
|
+
"type": "string"
|
|
11931
|
+
}
|
|
11932
|
+
},
|
|
11933
|
+
"type": "object"
|
|
11934
|
+
},
|
|
11935
|
+
"esri.rest-api.WebMapJson.UtilityNetworkJson": {
|
|
11936
|
+
"additionalProperties": false,
|
|
11937
|
+
"description": "Identifies the central object for utility network schema information to access utility-related functionality, such as tracing and querying associations. See {@link https://developers.arcgis.com/web-map-specification/objects/utilityNetwork/}.",
|
|
11938
|
+
"properties": {
|
|
11939
|
+
"id": {
|
|
11940
|
+
"description": "A unique identifying string for the utility network.",
|
|
11941
|
+
"type": "string"
|
|
11942
|
+
},
|
|
11943
|
+
"title": {
|
|
11944
|
+
"description": "A user-friendly string title for the utility network that can be used in a table of contents.",
|
|
11945
|
+
"type": "string"
|
|
11946
|
+
},
|
|
11947
|
+
"traceConfigurations": {
|
|
11948
|
+
"description": "An array of pre-configured trace configurations for quickly running common traces.",
|
|
11949
|
+
"items": {
|
|
11950
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.TraceConfigurationJson"
|
|
11951
|
+
},
|
|
11952
|
+
"type": "array"
|
|
11953
|
+
},
|
|
11954
|
+
"url": {
|
|
11955
|
+
"description": "A string value indicating the URL to the utility network layer.",
|
|
11956
|
+
"type": "string"
|
|
11957
|
+
}
|
|
11958
|
+
},
|
|
11959
|
+
"type": "object"
|
|
11960
|
+
},
|
|
11961
|
+
"esri.rest-api.WebMapJson.WebMapJson": {
|
|
11962
|
+
"additionalProperties": false,
|
|
11963
|
+
"description": "The web map data lists the basemap, operational layers, and bookmarks to be used in the web map. It also contains information about popup windows and layer styling overrides to be used in the web map. A version property allows you to supply the version of the web map JSON format being used.\n\nPart of the Esri web map specification. See {@link http://resources.arcgis.com/en/help/arcgis-web-map-json/}. See {@link https://developers.arcgis.com/web-map-specification/objects/webmap/}.",
|
|
11964
|
+
"properties": {
|
|
11965
|
+
"applicationProperties": {
|
|
11966
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.ApplicationPropertiesJson",
|
|
11967
|
+
"description": "The applicationProperties object is one of the objects at the top level of the JSON web map JSON schema. This is responsible for containing the viewing and editing properties of the web map. There are specific objects within this object that are applicable only to Collector and are explained within the property descriptions."
|
|
11968
|
+
},
|
|
11969
|
+
"authoringApp": {
|
|
11970
|
+
"description": "String value indicating the application which authored the webmap.",
|
|
11971
|
+
"type": "string"
|
|
11972
|
+
},
|
|
11973
|
+
"authoringAppVersion": {
|
|
11974
|
+
"description": "String value indicating the authoring App's version number.",
|
|
11975
|
+
"type": "string"
|
|
11976
|
+
},
|
|
11977
|
+
"background": {
|
|
11978
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.ColorBackgroundJson",
|
|
11979
|
+
"description": "The background."
|
|
11980
|
+
},
|
|
11981
|
+
"baseMap": {
|
|
11982
|
+
"$ref": "#/definitions/esri.rest-api.BasemapJson.BasemapJson",
|
|
11983
|
+
"description": "The map's basemap layer(s). Layers are drawn based on the index position in the array; The first layer in the array is the first layer drawn, the next layer in the array is drawn on top of it, and so on."
|
|
11984
|
+
},
|
|
11985
|
+
"bookmarks": {
|
|
11986
|
+
"description": "Bookmarks that are saved with the map.",
|
|
11987
|
+
"items": {
|
|
11988
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.BookmarkJson"
|
|
11989
|
+
},
|
|
11990
|
+
"type": "array"
|
|
11991
|
+
},
|
|
11992
|
+
"initialState": {
|
|
11993
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.InitialStateJson",
|
|
11994
|
+
"description": "The initial state at which to open the map."
|
|
11995
|
+
},
|
|
11996
|
+
"mapFloorInfo": {
|
|
11997
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.MapFloorInfoJson",
|
|
11998
|
+
"description": "Contains floor-awareness information for the map."
|
|
11999
|
+
},
|
|
12000
|
+
"mapRangeInfo": {
|
|
12001
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.MapRangeInfoJson",
|
|
12002
|
+
"description": "Map range information."
|
|
12003
|
+
},
|
|
12004
|
+
"operationalLayers": {
|
|
12005
|
+
"description": "Operational layers contain your business data. They are used to make thematic maps. Usually, a basemap sits beneath your operational layers to give them geographic context. See {@link https://developers.arcgis.com/web-map-specification/objects/operationalLayers/}.",
|
|
12006
|
+
"items": {
|
|
12007
|
+
"$ref": "#/definitions/OperationalLayerJson"
|
|
12008
|
+
},
|
|
12009
|
+
"type": "array"
|
|
12010
|
+
},
|
|
12011
|
+
"presentation": {
|
|
12012
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.PresentationJson",
|
|
12013
|
+
"description": "A presentation consists of multiple slides. Each slide has a different title, extent, basemap, layers etc."
|
|
12014
|
+
},
|
|
12015
|
+
"spatialReference": {
|
|
12016
|
+
"$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson",
|
|
12017
|
+
"description": "An object used to specify the spatial reference of the given geometry."
|
|
12018
|
+
},
|
|
12019
|
+
"tables": {
|
|
12020
|
+
"description": "Specify an array of table objects.",
|
|
12021
|
+
"items": {
|
|
12022
|
+
"$ref": "#/definitions/esri.rest-api.TableJson.TableJson"
|
|
12023
|
+
},
|
|
12024
|
+
"type": "array"
|
|
12025
|
+
},
|
|
12026
|
+
"timeZone": {
|
|
12027
|
+
"description": "TODO: Not yet documented in web map spec, but present in 2.29 web maps generated by Maps SDK 4.28.",
|
|
12028
|
+
"type": "string"
|
|
12029
|
+
},
|
|
12030
|
+
"utilityNetworks": {
|
|
12031
|
+
"description": "An array of utility network objects the map can use to access utility-related functionality, such as tracing and querying associations.",
|
|
12032
|
+
"items": {
|
|
12033
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.UtilityNetworkJson"
|
|
12034
|
+
},
|
|
12035
|
+
"type": "array"
|
|
12036
|
+
},
|
|
12037
|
+
"version": {
|
|
12038
|
+
"description": "Root element in the web map specifying a string value indicating the web map version. See {@link https://developers.arcgis.com/web-map-specification/objects/version/}.",
|
|
12039
|
+
"type": "string"
|
|
12040
|
+
},
|
|
12041
|
+
"widgets": {
|
|
12042
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.WidgetsJson",
|
|
12043
|
+
"description": "The widgets object contains widgets that should be exposed to the user."
|
|
12044
|
+
}
|
|
12045
|
+
},
|
|
12046
|
+
"required": [
|
|
12047
|
+
"baseMap",
|
|
12048
|
+
"spatialReference",
|
|
12049
|
+
"version"
|
|
12050
|
+
],
|
|
12051
|
+
"type": "object"
|
|
12052
|
+
},
|
|
12053
|
+
"esri.rest-api.WebMapJson.WidgetsJson": {
|
|
12054
|
+
"additionalProperties": false,
|
|
12055
|
+
"description": "The widgets object contains widgets that should be exposed to the user.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/widgets/} {@link https://developers.arcgis.com/web-scene-specification/objects/widgets/}.",
|
|
12056
|
+
"properties": {
|
|
12057
|
+
"floorFilter": {
|
|
12058
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.FloorFilterJson",
|
|
12059
|
+
"description": "Configurable properties used by the floor filter widget."
|
|
12060
|
+
},
|
|
12061
|
+
"range": {
|
|
12062
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.RangeJson",
|
|
12063
|
+
"description": "Active range."
|
|
12064
|
+
},
|
|
12065
|
+
"timeSlider": {
|
|
12066
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.TimeSliderJson",
|
|
12067
|
+
"description": "Time animation is controlled by a configurable time slider. The time slider widget will act upon all the time aware layers in the map."
|
|
12068
|
+
}
|
|
12069
|
+
},
|
|
12070
|
+
"type": "object"
|
|
12071
|
+
},
|
|
12072
|
+
"esri.rest-api.WebSceneJson.HeightModelInfoJson": {
|
|
12073
|
+
"additionalProperties": false,
|
|
12074
|
+
"description": "An object that defines the characteristics of the vertical coordinate system used by the web scene.",
|
|
12075
|
+
"properties": {
|
|
12076
|
+
"heightModel": {
|
|
12077
|
+
"description": "The surface type or height model of the vertical coordinate system.",
|
|
12078
|
+
"enum": [
|
|
12079
|
+
"ellipsoidal",
|
|
12080
|
+
"gravity_related_height"
|
|
12081
|
+
],
|
|
12082
|
+
"type": "string"
|
|
12083
|
+
},
|
|
12084
|
+
"heightUnit": {
|
|
12085
|
+
"description": "The unit of the vertical coordinate system.",
|
|
12086
|
+
"enum": [
|
|
12087
|
+
"150-kilometers",
|
|
12088
|
+
"50-kilometers",
|
|
12089
|
+
"benoit-1895-b-chain",
|
|
12090
|
+
"clarke-foot",
|
|
12091
|
+
"clarke-link",
|
|
12092
|
+
"clarke-yard",
|
|
12093
|
+
"foot",
|
|
12094
|
+
"gold-coast-foot",
|
|
12095
|
+
"indian-1937-yard",
|
|
12096
|
+
"indian-yard",
|
|
12097
|
+
"meter",
|
|
12098
|
+
"sears-1922-truncated-chain",
|
|
12099
|
+
"sears-chain",
|
|
12100
|
+
"sears-foot",
|
|
12101
|
+
"sears-yard",
|
|
12102
|
+
"us-foot"
|
|
12103
|
+
],
|
|
12104
|
+
"type": "string"
|
|
12105
|
+
},
|
|
12106
|
+
"vertCRS": {
|
|
12107
|
+
"description": "The datum realization of the vertical coordinate system.",
|
|
12108
|
+
"type": "string"
|
|
12109
|
+
}
|
|
12110
|
+
},
|
|
12111
|
+
"required": [
|
|
12112
|
+
"heightModel",
|
|
12113
|
+
"heightUnit"
|
|
12114
|
+
],
|
|
12115
|
+
"type": "object"
|
|
12116
|
+
},
|
|
12117
|
+
"esri.rest-api.WebSceneJson.WebSceneJson": {
|
|
12118
|
+
"additionalProperties": false,
|
|
12119
|
+
"description": "An Esri web scene.\n\nThe web scene is the core element of 3D mapping across the ArcGIS platform. It defines the content, style, environment, and slides of your scene and it can be shared across multiple ArcGIS web and desktop applications. Web scenes can be created, published, and consumed in ArcGIS Pro and ArcGIS Online with the Scene Viewer. The web scene is saved as a JSON document that can be consumed by the ArcGIS API for JavaScript via the WebScene class to easily create compelling 3D applications.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/webscene/}.",
|
|
12120
|
+
"properties": {
|
|
12121
|
+
"applicationProperties": {
|
|
12122
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.ApplicationPropertiesJson",
|
|
12123
|
+
"description": "The applicationProperties object is one of the objects at the top level of the JSON web map JSON schema. This is responsible for containing the viewing and editing properties of the web map. There are specific objects within this object that are applicable only to Collector and are explained within the property descriptions."
|
|
12124
|
+
},
|
|
12125
|
+
"authoringApp": {
|
|
12126
|
+
"description": "String value indicating the application which authored the webmap.",
|
|
12127
|
+
"type": "string"
|
|
12128
|
+
},
|
|
12129
|
+
"authoringAppVersion": {
|
|
12130
|
+
"description": "String value indicating the authoring App's version number.",
|
|
12131
|
+
"type": "string"
|
|
12132
|
+
},
|
|
12133
|
+
"baseMap": {
|
|
12134
|
+
"$ref": "#/definitions/esri.rest-api.BasemapJson.BasemapJson",
|
|
12135
|
+
"description": "The map's basemap layer(s). Layers are drawn based on the index position in the array; The first layer in the array is the first layer drawn, the next layer in the array is drawn on top of it, and so on."
|
|
12136
|
+
},
|
|
12137
|
+
"clippingArea": {
|
|
12138
|
+
"$ref": "__type",
|
|
12139
|
+
"description": "Defines are to be clipped for display. See {@link https://developers.arcgis.com/web-scene-specification/objects/clippingArea/}."
|
|
12140
|
+
},
|
|
12141
|
+
"ground": {
|
|
12142
|
+
"$ref": "#/definitions/esri.rest-api.GroundJson.GroundJson",
|
|
12143
|
+
"description": "Ground defines the main surface of the web scene, based on elevation layers."
|
|
12144
|
+
},
|
|
12145
|
+
"heightModelInfo": {
|
|
12146
|
+
"$ref": "#/definitions/esri.rest-api.WebSceneJson.HeightModelInfoJson",
|
|
12147
|
+
"description": "An object that defines the characteristics of the vertical coordinate system used by the web scene."
|
|
12148
|
+
},
|
|
12149
|
+
"initialState": {
|
|
12150
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.InitialStateJson",
|
|
12151
|
+
"description": "The initial state at which to open the map."
|
|
12152
|
+
},
|
|
12153
|
+
"mapFloorInfo": {
|
|
12154
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.MapFloorInfoJson",
|
|
12155
|
+
"description": "Contains floor-awareness information for the map."
|
|
12156
|
+
},
|
|
12157
|
+
"mapRangeInfo": {
|
|
12158
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.MapRangeInfoJson",
|
|
12159
|
+
"description": "Map range information."
|
|
12160
|
+
},
|
|
12161
|
+
"operationalLayers": {
|
|
12162
|
+
"description": "Operational layers contain your business data. They are used to make thematic maps. Usually, a basemap sits beneath your operational layers to give them geographic context. See {@link https://developers.arcgis.com/web-map-specification/objects/operationalLayers/}.",
|
|
12163
|
+
"items": {
|
|
12164
|
+
"$ref": "#/definitions/OperationalLayerJson"
|
|
12165
|
+
},
|
|
12166
|
+
"type": "array"
|
|
12167
|
+
},
|
|
12168
|
+
"presentation": {
|
|
12169
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.PresentationJson",
|
|
12170
|
+
"description": "A presentation consists of multiple slides. Each slide has a different title, extent, basemap, layers etc."
|
|
12171
|
+
},
|
|
12172
|
+
"spatialReference": {
|
|
12173
|
+
"$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson",
|
|
12174
|
+
"description": "An object used to specify the spatial reference of the given geometry."
|
|
12175
|
+
},
|
|
12176
|
+
"tables": {
|
|
12177
|
+
"description": "Specify an array of table objects.",
|
|
12178
|
+
"items": {
|
|
12179
|
+
"$ref": "#/definitions/esri.rest-api.TableJson.TableJson"
|
|
12180
|
+
},
|
|
12181
|
+
"type": "array"
|
|
12182
|
+
},
|
|
12183
|
+
"timeZone": {
|
|
12184
|
+
"description": "TODO: Not yet documented in web map spec, but present in 2.29 web maps generated by Maps SDK 4.28.",
|
|
12185
|
+
"type": "string"
|
|
12186
|
+
},
|
|
12187
|
+
"version": {
|
|
12188
|
+
"description": "Root element in the web map specifying a string value indicating the web map version. See {@link https://developers.arcgis.com/web-map-specification/objects/version/}.",
|
|
12189
|
+
"type": "string"
|
|
12190
|
+
},
|
|
12191
|
+
"viewingMode": {
|
|
12192
|
+
"description": "Must be one of the following values: \"global\" | \"local\".",
|
|
12193
|
+
"enum": [
|
|
12194
|
+
"global",
|
|
12195
|
+
"local"
|
|
12196
|
+
],
|
|
12197
|
+
"type": "string"
|
|
12198
|
+
},
|
|
12199
|
+
"widgets": {
|
|
12200
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.WidgetsJson",
|
|
12201
|
+
"description": "The widgets object contains widgets that should be exposed to the user."
|
|
12202
|
+
}
|
|
12203
|
+
},
|
|
12204
|
+
"required": [
|
|
12205
|
+
"baseMap",
|
|
12206
|
+
"spatialReference",
|
|
12207
|
+
"version"
|
|
12208
|
+
],
|
|
12209
|
+
"type": "object"
|
|
12210
|
+
},
|
|
10209
12211
|
"esri.rest-api.WebTileLayerJson.TileInfoJson": {
|
|
10210
12212
|
"additionalProperties": false,
|
|
10211
12213
|
"description": "Tile information, returned from the WMTS OGC Web Service. The tileInfo will contain the spatial reference of the layer. TileInfo is the same json representation as the ArcGIS Map/Image service tileInfo except that it may contain a levelValue on the lod objects that should be used instead of the level in the templateUrl.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/tileInfo/} {@link https://developers.arcgis.com/web-scene-specification/objects/tileInfo/}.",
|