@vertigis/viewer-spec 60.8.0 → 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 +3 -3
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -507,6 +507,89 @@
|
|
|
507
507
|
},
|
|
508
508
|
"type": "object"
|
|
509
509
|
},
|
|
510
|
+
"@vertigis.arcgis-extensions.mapping.BasemapExtension.BasemapProperties": {
|
|
511
|
+
"additionalProperties": false,
|
|
512
|
+
"description": "Properties that can be specified for the {@link mapping /BasemapExtension!BasemapExtensionProperties.basemap} property.",
|
|
513
|
+
"properties": {
|
|
514
|
+
"baseMapLayers": {
|
|
515
|
+
"description": "An array of BasemapLayer objects defining the basemaps used in the web map/web scene.",
|
|
516
|
+
"items": {
|
|
517
|
+
"$ref": "#/definitions/BasemapLayerJson"
|
|
518
|
+
},
|
|
519
|
+
"type": "array"
|
|
520
|
+
},
|
|
521
|
+
"elevationLayers": {
|
|
522
|
+
"description": "Deprecated, use ground.layers instead. An array of elevationLayer objects defining the basemaps used in the web scene.",
|
|
523
|
+
"items": {
|
|
524
|
+
"$ref": "#/definitions/ElevationLayerJson"
|
|
525
|
+
},
|
|
526
|
+
"type": "array"
|
|
527
|
+
},
|
|
528
|
+
"id": {
|
|
529
|
+
"description": "An identifier used to refer to the basemap when referencing it elsewhere.\n\nNOTE: Only available in web scenes!",
|
|
530
|
+
"type": "string"
|
|
531
|
+
},
|
|
532
|
+
"title": {
|
|
533
|
+
"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.",
|
|
534
|
+
"type": "string"
|
|
535
|
+
}
|
|
536
|
+
},
|
|
537
|
+
"type": "object"
|
|
538
|
+
},
|
|
539
|
+
"@vertigis.arcgis-extensions.mapping.MapExtension.ViewMode": {
|
|
540
|
+
"description": "Viewing mode for a map (2D map or 3D scene).",
|
|
541
|
+
"enum": [
|
|
542
|
+
"map",
|
|
543
|
+
"scene"
|
|
544
|
+
],
|
|
545
|
+
"type": "string"
|
|
546
|
+
},
|
|
547
|
+
"@vertigis.arcgis-extensions.mapping.MapExtension.WebMapLike": {
|
|
548
|
+
"anyOf": [
|
|
549
|
+
{
|
|
550
|
+
"$ref": "#/definitions/esri.PortalItem"
|
|
551
|
+
},
|
|
552
|
+
{
|
|
553
|
+
"$ref": "#/definitions/esri.rest-api.ItemJson.ItemJson"
|
|
554
|
+
},
|
|
555
|
+
{
|
|
556
|
+
"$ref": "@vertigis.arcgis-extensions.PortalUri.PortalUri"
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
"$ref": "@vertigis.arcgis-extensions.utilities.uri.Uri"
|
|
560
|
+
},
|
|
561
|
+
{
|
|
562
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.WebMapJson"
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"type": "string"
|
|
566
|
+
}
|
|
567
|
+
],
|
|
568
|
+
"description": "A web map definition or reference."
|
|
569
|
+
},
|
|
570
|
+
"@vertigis.arcgis-extensions.mapping.MapExtension.WebSceneLike": {
|
|
571
|
+
"anyOf": [
|
|
572
|
+
{
|
|
573
|
+
"$ref": "#/definitions/esri.PortalItem"
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
"$ref": "#/definitions/esri.rest-api.ItemJson.ItemJson"
|
|
577
|
+
},
|
|
578
|
+
{
|
|
579
|
+
"$ref": "@vertigis.arcgis-extensions.PortalUri.PortalUri"
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
"$ref": "@vertigis.arcgis-extensions.utilities.uri.Uri"
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"$ref": "#/definitions/esri.rest-api.WebSceneJson.WebSceneJson"
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
"type": "string"
|
|
589
|
+
}
|
|
590
|
+
],
|
|
591
|
+
"description": "A web scene definition or reference."
|
|
592
|
+
},
|
|
510
593
|
"@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference": {
|
|
511
594
|
"additionalProperties": false,
|
|
512
595
|
"description": "Matches an existing layer.",
|
|
@@ -534,6 +617,31 @@
|
|
|
534
617
|
},
|
|
535
618
|
"type": "object"
|
|
536
619
|
},
|
|
620
|
+
"@vertigis.arcgis-extensions.support.Action.BoundAction": {
|
|
621
|
+
"additionalProperties": false,
|
|
622
|
+
"description": "An action that is bound to arguments.",
|
|
623
|
+
"properties": {
|
|
624
|
+
"arguments": {
|
|
625
|
+
"description": "Arguments for the action. Can either be a primitive value (string, number, boolean), or a plain JSON object containing named arguments."
|
|
626
|
+
},
|
|
627
|
+
"name": {
|
|
628
|
+
"description": "Determines which action to perform. It is up to the calling application how it transforms an action name into actual executable code.",
|
|
629
|
+
"type": "string"
|
|
630
|
+
}
|
|
631
|
+
},
|
|
632
|
+
"required": [
|
|
633
|
+
"arguments",
|
|
634
|
+
"name"
|
|
635
|
+
],
|
|
636
|
+
"type": "object"
|
|
637
|
+
},
|
|
638
|
+
"@vertigis.arcgis-extensions.support.Action.CompositeAction": {
|
|
639
|
+
"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.",
|
|
640
|
+
"items": {
|
|
641
|
+
"$ref": "#/definitions/SimpleAction"
|
|
642
|
+
},
|
|
643
|
+
"type": "array"
|
|
644
|
+
},
|
|
537
645
|
"@vertigis.arcgis-extensions.support.FormatSettings.FormatSettingsProperties": {
|
|
538
646
|
"additionalProperties": false,
|
|
539
647
|
"description": "Properties that can be passed into the constructor for {@link FormatSettings}.",
|
|
@@ -668,6 +776,16 @@
|
|
|
668
776
|
],
|
|
669
777
|
"type": "object"
|
|
670
778
|
},
|
|
779
|
+
"ArrayBufferLike": {
|
|
780
|
+
"anyOf": [
|
|
781
|
+
{
|
|
782
|
+
"$ref": "ArrayBuffer"
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
"$ref": "SharedArrayBuffer"
|
|
786
|
+
}
|
|
787
|
+
]
|
|
788
|
+
},
|
|
671
789
|
"AttachmentEventArgs": {
|
|
672
790
|
"additionalProperties": false,
|
|
673
791
|
"description": "Event args for attachment events.",
|
|
@@ -697,6 +815,41 @@
|
|
|
697
815
|
],
|
|
698
816
|
"type": "string"
|
|
699
817
|
},
|
|
818
|
+
"BasemapLayerJson": {
|
|
819
|
+
"anyOf": [
|
|
820
|
+
{
|
|
821
|
+
"$ref": "#/definitions/esri.rest-api.ImageServiceLayerJson.ImageServiceLayerJson"
|
|
822
|
+
},
|
|
823
|
+
{
|
|
824
|
+
"$ref": "#/definitions/esri.rest-api.ImageServiceVectorLayerJson.ImageServiceVectorLayerJson"
|
|
825
|
+
},
|
|
826
|
+
{
|
|
827
|
+
"$ref": "#/definitions/esri.rest-api.MapServiceLayerJson.MapServiceLayerJson"
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"$ref": "#/definitions/esri.rest-api.TiledImageServiceLayerJson.TiledImageServiceLayerJson"
|
|
831
|
+
},
|
|
832
|
+
{
|
|
833
|
+
"$ref": "#/definitions/esri.rest-api.TiledMapServiceLayerJson.TiledMapServiceLayerJson"
|
|
834
|
+
},
|
|
835
|
+
{
|
|
836
|
+
"$ref": "#/definitions/esri.rest-api.VectorTileLayerJson.VectorTileLayerJson"
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
"$ref": "#/definitions/esri.rest-api.WebTileLayerJson.WebTileLayerJson"
|
|
840
|
+
},
|
|
841
|
+
{
|
|
842
|
+
"$ref": "#/definitions/esri.rest-api.WMSLayerJson.WMSLayerJson"
|
|
843
|
+
},
|
|
844
|
+
{
|
|
845
|
+
"$ref": "#/definitions/esri.rest-api.BingLayerJson.BingLayerJson"
|
|
846
|
+
},
|
|
847
|
+
{
|
|
848
|
+
"$ref": "#/definitions/esri.rest-api.OpenStreetMapLayerJson.OpenStreetMapLayerJson"
|
|
849
|
+
}
|
|
850
|
+
],
|
|
851
|
+
"description": "A base map layer in a web map/scene."
|
|
852
|
+
},
|
|
700
853
|
"BookmarkEventArgs": {
|
|
701
854
|
"additionalProperties": false,
|
|
702
855
|
"description": "Arguments for the bookmark events.",
|
|
@@ -832,6 +985,17 @@
|
|
|
832
985
|
"description": "Arguments for the \"display.overlap-element-translate-started\" event.",
|
|
833
986
|
"type": "object"
|
|
834
987
|
},
|
|
988
|
+
"ElevationLayerJson": {
|
|
989
|
+
"anyOf": [
|
|
990
|
+
{
|
|
991
|
+
"$ref": "#/definitions/esri.rest-api.RasterDataElevationLayerJson.RasterDataElevationLayerJson"
|
|
992
|
+
},
|
|
993
|
+
{
|
|
994
|
+
"$ref": "#/definitions/esri.rest-api.TiledElevationServiceLayerJson.TiledElevationServiceLayerJson"
|
|
995
|
+
}
|
|
996
|
+
],
|
|
997
|
+
"description": "Elevation layers that can be used in a web scene's ground."
|
|
998
|
+
},
|
|
835
999
|
"Error": {
|
|
836
1000
|
"additionalProperties": false,
|
|
837
1001
|
"properties": {
|
|
@@ -1316,6 +1480,17 @@
|
|
|
1316
1480
|
],
|
|
1317
1481
|
"type": "object"
|
|
1318
1482
|
},
|
|
1483
|
+
"LightingJson": {
|
|
1484
|
+
"anyOf": [
|
|
1485
|
+
{
|
|
1486
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.SunLightingJson"
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.VirtualLightingJson"
|
|
1490
|
+
}
|
|
1491
|
+
],
|
|
1492
|
+
"description": "Settings for defining the lighting of the scene."
|
|
1493
|
+
},
|
|
1319
1494
|
"LocationDisplayModeChangedEventArgs": {
|
|
1320
1495
|
"additionalProperties": false,
|
|
1321
1496
|
"description": "Arguments for the \"geolocation.display-mode-changed\" event.",
|
|
@@ -2077,6 +2252,17 @@
|
|
|
2077
2252
|
],
|
|
2078
2253
|
"type": "object"
|
|
2079
2254
|
},
|
|
2255
|
+
"SimpleAction": {
|
|
2256
|
+
"anyOf": [
|
|
2257
|
+
{
|
|
2258
|
+
"$ref": "#/definitions/@vertigis.arcgis-extensions.support.Action.BoundAction"
|
|
2259
|
+
},
|
|
2260
|
+
{
|
|
2261
|
+
"type": "string"
|
|
2262
|
+
}
|
|
2263
|
+
],
|
|
2264
|
+
"description": "Defines a single action to perform."
|
|
2265
|
+
},
|
|
2080
2266
|
"SourceOperation": {
|
|
2081
2267
|
"description": "Describes the source of results.",
|
|
2082
2268
|
"enum": [
|
|
@@ -2202,6 +2388,26 @@
|
|
|
2202
2388
|
],
|
|
2203
2389
|
"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/}."
|
|
2204
2390
|
},
|
|
2391
|
+
"WeatherJson": {
|
|
2392
|
+
"anyOf": [
|
|
2393
|
+
{
|
|
2394
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.CloudyWeatherJson"
|
|
2395
|
+
},
|
|
2396
|
+
{
|
|
2397
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.FoggyWeatherJson"
|
|
2398
|
+
},
|
|
2399
|
+
{
|
|
2400
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.RainyWeatherJson"
|
|
2401
|
+
},
|
|
2402
|
+
{
|
|
2403
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.SunnyWeatherJson"
|
|
2404
|
+
},
|
|
2405
|
+
{
|
|
2406
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.SnowyWeatherJson"
|
|
2407
|
+
}
|
|
2408
|
+
],
|
|
2409
|
+
"description": "Indicates the type of weather visualization in the scene."
|
|
2410
|
+
},
|
|
2205
2411
|
"WorkflowErrorEventArgs": {
|
|
2206
2412
|
"additionalProperties": false,
|
|
2207
2413
|
"description": "Arguments for the \"workflow.workflow-error\" event.",
|
|
@@ -2600,6 +2806,9 @@
|
|
|
2600
2806
|
"esri.PopupTemplate": {
|
|
2601
2807
|
"$ref": "esri/PopupTemplate"
|
|
2602
2808
|
},
|
|
2809
|
+
"esri.PortalItem": {
|
|
2810
|
+
"$ref": "esri/portal/PortalItem"
|
|
2811
|
+
},
|
|
2603
2812
|
"esri.SpatialReference": {
|
|
2604
2813
|
"$ref": "esri/geometry/SpatialReference"
|
|
2605
2814
|
},
|
|
@@ -2761,44 +2970,41 @@
|
|
|
2761
2970
|
],
|
|
2762
2971
|
"type": "object"
|
|
2763
2972
|
},
|
|
2764
|
-
"esri.rest-api.
|
|
2973
|
+
"esri.rest-api.BasemapJson.BasemapJson": {
|
|
2765
2974
|
"additionalProperties": false,
|
|
2766
|
-
"description": "
|
|
2975
|
+
"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/}.",
|
|
2767
2976
|
"properties": {
|
|
2768
|
-
"
|
|
2769
|
-
"description": "
|
|
2977
|
+
"baseMapLayers": {
|
|
2978
|
+
"description": "An array of BasemapLayer objects defining the basemaps used in the web map/web scene.",
|
|
2770
2979
|
"items": {
|
|
2771
|
-
"$ref": "#/definitions/
|
|
2980
|
+
"$ref": "#/definitions/BasemapLayerJson"
|
|
2772
2981
|
},
|
|
2773
2982
|
"type": "array"
|
|
2774
|
-
}
|
|
2775
|
-
},
|
|
2776
|
-
"type": "object"
|
|
2777
|
-
},
|
|
2778
|
-
"esri.rest-api.BuildingSceneLayerJson.AuthoringInfoFilterTypeJson": {
|
|
2779
|
-
"additionalProperties": false,
|
|
2780
|
-
"description": "The file authoring information for a filter, including the filter type and its value settings.",
|
|
2781
|
-
"properties": {
|
|
2782
|
-
"filterType": {
|
|
2783
|
-
"description": "Represents the filter type name. Name is a unique identifier.",
|
|
2784
|
-
"type": "string"
|
|
2785
2983
|
},
|
|
2786
|
-
"
|
|
2787
|
-
"description": "
|
|
2984
|
+
"elevationLayers": {
|
|
2985
|
+
"description": "Deprecated, use ground.layers instead. An array of elevationLayer objects defining the basemaps used in the web scene.",
|
|
2788
2986
|
"items": {
|
|
2789
|
-
"
|
|
2987
|
+
"$ref": "#/definitions/ElevationLayerJson"
|
|
2790
2988
|
},
|
|
2791
2989
|
"type": "array"
|
|
2990
|
+
},
|
|
2991
|
+
"id": {
|
|
2992
|
+
"description": "An identifier used to refer to the basemap when referencing it elsewhere.\n\nNOTE: Only available in web scenes!",
|
|
2993
|
+
"type": "string"
|
|
2994
|
+
},
|
|
2995
|
+
"title": {
|
|
2996
|
+
"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.",
|
|
2997
|
+
"type": "string"
|
|
2792
2998
|
}
|
|
2793
2999
|
},
|
|
2794
3000
|
"type": "object"
|
|
2795
3001
|
},
|
|
2796
|
-
"esri.rest-api.
|
|
3002
|
+
"esri.rest-api.BingLayerJson.BingLayerJson": {
|
|
2797
3003
|
"additionalProperties": false,
|
|
2798
|
-
"description": "
|
|
3004
|
+
"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/}.",
|
|
2799
3005
|
"properties": {
|
|
2800
|
-
"
|
|
2801
|
-
"description": "
|
|
3006
|
+
"bingKey": {
|
|
3007
|
+
"description": "String value that unlocks the use of Bing layers in a web map.",
|
|
2802
3008
|
"type": "string"
|
|
2803
3009
|
},
|
|
2804
3010
|
"blendMode": {
|
|
@@ -2838,40 +3044,32 @@
|
|
|
2838
3044
|
],
|
|
2839
3045
|
"type": "string"
|
|
2840
3046
|
},
|
|
3047
|
+
"canShareBingPublic": {
|
|
3048
|
+
"description": "Boolean value indicating whether the Bing key can be shared to the public.",
|
|
3049
|
+
"type": "boolean"
|
|
3050
|
+
},
|
|
2841
3051
|
"effect": {
|
|
2842
3052
|
"$ref": "#/definitions/EffectJson",
|
|
2843
3053
|
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
2844
3054
|
},
|
|
2845
|
-
"filters": {
|
|
2846
|
-
"description": "A list of filters available for this layer. Overrides filters defined on the service.",
|
|
2847
|
-
"items": {
|
|
2848
|
-
"$ref": "#/definitions/esri.rest-api.BuildingSceneLayerJson.FilterJson"
|
|
2849
|
-
},
|
|
2850
|
-
"type": "array"
|
|
2851
|
-
},
|
|
2852
3055
|
"id": {
|
|
2853
3056
|
"description": "A unique identifying string for the layer.",
|
|
2854
3057
|
"type": "string"
|
|
2855
3058
|
},
|
|
3059
|
+
"isReference": {
|
|
3060
|
+
"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).",
|
|
3061
|
+
"type": "boolean"
|
|
3062
|
+
},
|
|
2856
3063
|
"itemId": {
|
|
2857
3064
|
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
2858
3065
|
"type": "string"
|
|
2859
3066
|
},
|
|
2860
|
-
"layerDefinition": {
|
|
2861
|
-
"$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
|
|
2862
|
-
"description": "Additional properties that can define an elevation offset for the layer."
|
|
2863
|
-
},
|
|
2864
3067
|
"layerType": {
|
|
2865
|
-
"const": "BuildingSceneLayer",
|
|
2866
3068
|
"description": "The type of layer.",
|
|
2867
|
-
"type": "string"
|
|
2868
|
-
},
|
|
2869
|
-
"listMode": {
|
|
2870
|
-
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
2871
3069
|
"enum": [
|
|
2872
|
-
"
|
|
2873
|
-
"
|
|
2874
|
-
"
|
|
3070
|
+
"BingMapsAerial",
|
|
3071
|
+
"BingMapsHybrid",
|
|
3072
|
+
"BingMapsRoad"
|
|
2875
3073
|
],
|
|
2876
3074
|
"type": "string"
|
|
2877
3075
|
},
|
|
@@ -2887,21 +3085,14 @@
|
|
|
2887
3085
|
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
2888
3086
|
"type": "number"
|
|
2889
3087
|
},
|
|
2890
|
-
"
|
|
2891
|
-
"description": "
|
|
2892
|
-
"type": "
|
|
3088
|
+
"portalUrl": {
|
|
3089
|
+
"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.",
|
|
3090
|
+
"type": "string"
|
|
2893
3091
|
},
|
|
2894
3092
|
"showLegend": {
|
|
2895
3093
|
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
2896
3094
|
"type": "boolean"
|
|
2897
3095
|
},
|
|
2898
|
-
"sublayers": {
|
|
2899
|
-
"description": "An array of objects specifying overrides for building scene layer sublayers.",
|
|
2900
|
-
"items": {
|
|
2901
|
-
"$ref": "#/definitions/esri.rest-api.BuildingSceneSublayerJson.BuildingSceneSublayerJson"
|
|
2902
|
-
},
|
|
2903
|
-
"type": "array"
|
|
2904
|
-
},
|
|
2905
3096
|
"title": {
|
|
2906
3097
|
"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.",
|
|
2907
3098
|
"type": "string"
|
|
@@ -2920,10 +3111,6 @@
|
|
|
2920
3111
|
],
|
|
2921
3112
|
"type": "string"
|
|
2922
3113
|
},
|
|
2923
|
-
"url": {
|
|
2924
|
-
"description": "The URL to the service.",
|
|
2925
|
-
"type": "string"
|
|
2926
|
-
},
|
|
2927
3114
|
"visibility": {
|
|
2928
3115
|
"description": "Determines whether the layer is initially visible in the web map.",
|
|
2929
3116
|
"type": "boolean"
|
|
@@ -2944,52 +3131,242 @@
|
|
|
2944
3131
|
}
|
|
2945
3132
|
},
|
|
2946
3133
|
"required": [
|
|
2947
|
-
"
|
|
3134
|
+
"bingKey",
|
|
3135
|
+
"canShareBingPublic",
|
|
3136
|
+
"layerType",
|
|
3137
|
+
"portalUrl"
|
|
2948
3138
|
],
|
|
2949
3139
|
"type": "object"
|
|
2950
3140
|
},
|
|
2951
|
-
"esri.rest-api.BuildingSceneLayerJson.
|
|
3141
|
+
"esri.rest-api.BuildingSceneLayerJson.AuthoringInfoFilterBlockJson": {
|
|
2952
3142
|
"additionalProperties": false,
|
|
2953
|
-
"description": "
|
|
3143
|
+
"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.",
|
|
2954
3144
|
"properties": {
|
|
2955
|
-
"
|
|
2956
|
-
"description": "Array of filter
|
|
3145
|
+
"filterTypes": {
|
|
3146
|
+
"description": "Array of defined filter types. Each filter type has an array of filter values.",
|
|
2957
3147
|
"items": {
|
|
2958
|
-
"$ref": "#/definitions/esri.rest-api.BuildingSceneLayerJson.
|
|
3148
|
+
"$ref": "#/definitions/esri.rest-api.BuildingSceneLayerJson.AuthoringInfoFilterTypeJson"
|
|
2959
3149
|
},
|
|
2960
3150
|
"type": "array"
|
|
2961
|
-
},
|
|
2962
|
-
"type": {
|
|
2963
|
-
"const": "checkbox",
|
|
2964
|
-
"description": "Type of filter authoring info. Value of this property must be checkbox.",
|
|
2965
|
-
"type": "string"
|
|
2966
3151
|
}
|
|
2967
3152
|
},
|
|
2968
|
-
"required": [
|
|
2969
|
-
"type"
|
|
2970
|
-
],
|
|
2971
3153
|
"type": "object"
|
|
2972
3154
|
},
|
|
2973
|
-
"esri.rest-api.BuildingSceneLayerJson.
|
|
3155
|
+
"esri.rest-api.BuildingSceneLayerJson.AuthoringInfoFilterTypeJson": {
|
|
2974
3156
|
"additionalProperties": false,
|
|
2975
|
-
"description": "
|
|
3157
|
+
"description": "The file authoring information for a filter, including the filter type and its value settings.",
|
|
2976
3158
|
"properties": {
|
|
2977
|
-
"
|
|
2978
|
-
"description": "
|
|
3159
|
+
"filterType": {
|
|
3160
|
+
"description": "Represents the filter type name. Name is a unique identifier.",
|
|
2979
3161
|
"type": "string"
|
|
2980
3162
|
},
|
|
2981
|
-
"
|
|
2982
|
-
"
|
|
2983
|
-
"
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
"
|
|
2987
|
-
|
|
2988
|
-
|
|
2989
|
-
|
|
2990
|
-
|
|
2991
|
-
|
|
2992
|
-
|
|
3163
|
+
"filterValues": {
|
|
3164
|
+
"description": "Array of filter values. Filter values are the attributes that can be stored for individual fields in a layer.",
|
|
3165
|
+
"items": {
|
|
3166
|
+
"type": "string"
|
|
3167
|
+
},
|
|
3168
|
+
"type": "array"
|
|
3169
|
+
}
|
|
3170
|
+
},
|
|
3171
|
+
"type": "object"
|
|
3172
|
+
},
|
|
3173
|
+
"esri.rest-api.BuildingSceneLayerJson.BuildingSceneLayerJson": {
|
|
3174
|
+
"additionalProperties": false,
|
|
3175
|
+
"description": "The BuildingSceneLayer is a layer type designed for on-demand streaming and displaying building data.",
|
|
3176
|
+
"properties": {
|
|
3177
|
+
"activeFilterId": {
|
|
3178
|
+
"description": "Specifies the id of the currently active filter.",
|
|
3179
|
+
"type": "string"
|
|
3180
|
+
},
|
|
3181
|
+
"blendMode": {
|
|
3182
|
+
"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.",
|
|
3183
|
+
"enum": [
|
|
3184
|
+
"average",
|
|
3185
|
+
"color",
|
|
3186
|
+
"color-burn",
|
|
3187
|
+
"color-dodge",
|
|
3188
|
+
"darken",
|
|
3189
|
+
"destination-atop",
|
|
3190
|
+
"destination-in",
|
|
3191
|
+
"destination-out",
|
|
3192
|
+
"destination-over",
|
|
3193
|
+
"difference",
|
|
3194
|
+
"exclusion",
|
|
3195
|
+
"hard-light",
|
|
3196
|
+
"hue",
|
|
3197
|
+
"invert",
|
|
3198
|
+
"lighten",
|
|
3199
|
+
"lighter",
|
|
3200
|
+
"luminosity",
|
|
3201
|
+
"minus",
|
|
3202
|
+
"multiply",
|
|
3203
|
+
"normal",
|
|
3204
|
+
"overlay",
|
|
3205
|
+
"plus",
|
|
3206
|
+
"reflect",
|
|
3207
|
+
"saturation",
|
|
3208
|
+
"screen",
|
|
3209
|
+
"soft-light",
|
|
3210
|
+
"source-atop",
|
|
3211
|
+
"source-in",
|
|
3212
|
+
"source-out",
|
|
3213
|
+
"vivid-light",
|
|
3214
|
+
"xor"
|
|
3215
|
+
],
|
|
3216
|
+
"type": "string"
|
|
3217
|
+
},
|
|
3218
|
+
"effect": {
|
|
3219
|
+
"$ref": "#/definitions/EffectJson",
|
|
3220
|
+
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
3221
|
+
},
|
|
3222
|
+
"filters": {
|
|
3223
|
+
"description": "A list of filters available for this layer. Overrides filters defined on the service.",
|
|
3224
|
+
"items": {
|
|
3225
|
+
"$ref": "#/definitions/esri.rest-api.BuildingSceneLayerJson.FilterJson"
|
|
3226
|
+
},
|
|
3227
|
+
"type": "array"
|
|
3228
|
+
},
|
|
3229
|
+
"id": {
|
|
3230
|
+
"description": "A unique identifying string for the layer.",
|
|
3231
|
+
"type": "string"
|
|
3232
|
+
},
|
|
3233
|
+
"itemId": {
|
|
3234
|
+
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
3235
|
+
"type": "string"
|
|
3236
|
+
},
|
|
3237
|
+
"layerDefinition": {
|
|
3238
|
+
"$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
|
|
3239
|
+
"description": "Additional properties that can define an elevation offset for the layer."
|
|
3240
|
+
},
|
|
3241
|
+
"layerType": {
|
|
3242
|
+
"const": "BuildingSceneLayer",
|
|
3243
|
+
"description": "The type of layer.",
|
|
3244
|
+
"type": "string"
|
|
3245
|
+
},
|
|
3246
|
+
"listMode": {
|
|
3247
|
+
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
3248
|
+
"enum": [
|
|
3249
|
+
"hide",
|
|
3250
|
+
"hide-children",
|
|
3251
|
+
"show"
|
|
3252
|
+
],
|
|
3253
|
+
"type": "string"
|
|
3254
|
+
},
|
|
3255
|
+
"maxScale": {
|
|
3256
|
+
"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.",
|
|
3257
|
+
"type": "number"
|
|
3258
|
+
},
|
|
3259
|
+
"minScale": {
|
|
3260
|
+
"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.",
|
|
3261
|
+
"type": "number"
|
|
3262
|
+
},
|
|
3263
|
+
"opacity": {
|
|
3264
|
+
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
3265
|
+
"type": "number"
|
|
3266
|
+
},
|
|
3267
|
+
"refreshInterval": {
|
|
3268
|
+
"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}.",
|
|
3269
|
+
"type": "number"
|
|
3270
|
+
},
|
|
3271
|
+
"showLegend": {
|
|
3272
|
+
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
3273
|
+
"type": "boolean"
|
|
3274
|
+
},
|
|
3275
|
+
"sublayers": {
|
|
3276
|
+
"description": "An array of objects specifying overrides for building scene layer sublayers.",
|
|
3277
|
+
"items": {
|
|
3278
|
+
"$ref": "#/definitions/esri.rest-api.BuildingSceneSublayerJson.BuildingSceneSublayerJson"
|
|
3279
|
+
},
|
|
3280
|
+
"type": "array"
|
|
3281
|
+
},
|
|
3282
|
+
"title": {
|
|
3283
|
+
"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.",
|
|
3284
|
+
"type": "string"
|
|
3285
|
+
},
|
|
3286
|
+
"type": {
|
|
3287
|
+
"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.",
|
|
3288
|
+
"enum": [
|
|
3289
|
+
"BingMapsAerial",
|
|
3290
|
+
"BingMapsHybrid",
|
|
3291
|
+
"BingMapsRoad",
|
|
3292
|
+
"CSV",
|
|
3293
|
+
"KML",
|
|
3294
|
+
"OpenStreetMap",
|
|
3295
|
+
"WMS",
|
|
3296
|
+
"WebTiledLayer"
|
|
3297
|
+
],
|
|
3298
|
+
"type": "string"
|
|
3299
|
+
},
|
|
3300
|
+
"url": {
|
|
3301
|
+
"description": "The URL to the service.",
|
|
3302
|
+
"type": "string"
|
|
3303
|
+
},
|
|
3304
|
+
"visibility": {
|
|
3305
|
+
"description": "Determines whether the layer is initially visible in the web map.",
|
|
3306
|
+
"type": "boolean"
|
|
3307
|
+
},
|
|
3308
|
+
"visibilityTimeExtent": {
|
|
3309
|
+
"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.",
|
|
3310
|
+
"items": [
|
|
3311
|
+
{
|
|
3312
|
+
"type": "number"
|
|
3313
|
+
},
|
|
3314
|
+
{
|
|
3315
|
+
"type": "number"
|
|
3316
|
+
}
|
|
3317
|
+
],
|
|
3318
|
+
"maxItems": 2,
|
|
3319
|
+
"minItems": 2,
|
|
3320
|
+
"type": "array"
|
|
3321
|
+
}
|
|
3322
|
+
},
|
|
3323
|
+
"required": [
|
|
3324
|
+
"layerType"
|
|
3325
|
+
],
|
|
3326
|
+
"type": "object"
|
|
3327
|
+
},
|
|
3328
|
+
"esri.rest-api.BuildingSceneLayerJson.FilterAuthoringInfoCheckboxJson": {
|
|
3329
|
+
"additionalProperties": false,
|
|
3330
|
+
"description": "Client UI with checkbox representation for each filter type and filter value.",
|
|
3331
|
+
"properties": {
|
|
3332
|
+
"filterBlocks": {
|
|
3333
|
+
"description": "Array of filter block authoring infos.",
|
|
3334
|
+
"items": {
|
|
3335
|
+
"$ref": "#/definitions/esri.rest-api.BuildingSceneLayerJson.AuthoringInfoFilterBlockJson"
|
|
3336
|
+
},
|
|
3337
|
+
"type": "array"
|
|
3338
|
+
},
|
|
3339
|
+
"type": {
|
|
3340
|
+
"const": "checkbox",
|
|
3341
|
+
"description": "Type of filter authoring info. Value of this property must be checkbox.",
|
|
3342
|
+
"type": "string"
|
|
3343
|
+
}
|
|
3344
|
+
},
|
|
3345
|
+
"required": [
|
|
3346
|
+
"type"
|
|
3347
|
+
],
|
|
3348
|
+
"type": "object"
|
|
3349
|
+
},
|
|
3350
|
+
"esri.rest-api.BuildingSceneLayerJson.FilterBlockJson": {
|
|
3351
|
+
"additionalProperties": false,
|
|
3352
|
+
"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.",
|
|
3353
|
+
"properties": {
|
|
3354
|
+
"filterExpression": {
|
|
3355
|
+
"description": "SQL expression to select features that belong to this filter block.",
|
|
3356
|
+
"type": "string"
|
|
3357
|
+
},
|
|
3358
|
+
"filterMode": {
|
|
3359
|
+
"$ref": "#/definitions/FilterModeJson",
|
|
3360
|
+
"description": "Filter mode defines how features are drawn. For example, the filter mode of a filter can be solid or wire frame."
|
|
3361
|
+
},
|
|
3362
|
+
"title": {
|
|
3363
|
+
"description": "Title of the filter block.",
|
|
3364
|
+
"type": "string"
|
|
3365
|
+
}
|
|
3366
|
+
},
|
|
3367
|
+
"type": "object"
|
|
3368
|
+
},
|
|
3369
|
+
"esri.rest-api.BuildingSceneLayerJson.FilterJson": {
|
|
2993
3370
|
"additionalProperties": false,
|
|
2994
3371
|
"description": "Filter allows client applications to reduce the drawn elements of a building to specific types and values. Filters on the webscene override the list of existing filters on the service.",
|
|
2995
3372
|
"properties": {
|
|
@@ -3654,52 +4031,262 @@
|
|
|
3654
4031
|
],
|
|
3655
4032
|
"type": "object"
|
|
3656
4033
|
},
|
|
3657
|
-
"esri.rest-api.
|
|
4034
|
+
"esri.rest-api.EnvironmentJson.CloudyWeatherJson": {
|
|
3658
4035
|
"additionalProperties": false,
|
|
3659
|
-
"description": "
|
|
4036
|
+
"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/}.",
|
|
3660
4037
|
"properties": {
|
|
3661
|
-
"
|
|
3662
|
-
"description": "
|
|
4038
|
+
"cloudCover": {
|
|
4039
|
+
"description": "Specifies the amount of cloud cover in the sky.",
|
|
4040
|
+
"type": "number"
|
|
4041
|
+
},
|
|
4042
|
+
"type": {
|
|
4043
|
+
"const": "cloudy",
|
|
4044
|
+
"description": "The type of weather.",
|
|
4045
|
+
"type": "string"
|
|
4046
|
+
}
|
|
4047
|
+
},
|
|
4048
|
+
"required": [
|
|
4049
|
+
"type"
|
|
4050
|
+
],
|
|
4051
|
+
"type": "object"
|
|
4052
|
+
},
|
|
4053
|
+
"esri.rest-api.EnvironmentJson.ColorBackgroundJson": {
|
|
4054
|
+
"additionalProperties": false,
|
|
4055
|
+
"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/}.",
|
|
4056
|
+
"properties": {
|
|
4057
|
+
"color": {
|
|
4058
|
+
"description": "Color is represented as a three or four-element array.",
|
|
3663
4059
|
"items": {
|
|
3664
|
-
"
|
|
4060
|
+
"type": "number"
|
|
3665
4061
|
},
|
|
3666
4062
|
"type": "array"
|
|
3667
4063
|
},
|
|
3668
|
-
"
|
|
3669
|
-
"description": "
|
|
3670
|
-
"type": "
|
|
4064
|
+
"transparency": {
|
|
4065
|
+
"description": "The value has to lie between 100 (full transparency) and 0 (full opacity). Web scenes only.",
|
|
4066
|
+
"type": "number"
|
|
4067
|
+
},
|
|
4068
|
+
"type": {
|
|
4069
|
+
"const": "color",
|
|
4070
|
+
"description": "The type of background. Web scenes only.",
|
|
4071
|
+
"type": "string"
|
|
3671
4072
|
}
|
|
3672
4073
|
},
|
|
3673
4074
|
"required": [
|
|
3674
|
-
"
|
|
4075
|
+
"type"
|
|
3675
4076
|
],
|
|
3676
4077
|
"type": "object"
|
|
3677
4078
|
},
|
|
3678
|
-
"esri.rest-api.
|
|
4079
|
+
"esri.rest-api.EnvironmentJson.EnvironmentJson": {
|
|
3679
4080
|
"additionalProperties": false,
|
|
3680
|
-
"description": "
|
|
4081
|
+
"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/}.",
|
|
3681
4082
|
"properties": {
|
|
3682
|
-
"
|
|
3683
|
-
"description": "
|
|
4083
|
+
"atmosphereEnabled": {
|
|
4084
|
+
"description": "Whether the atmosphere should be visualized. This includes sky and haze effects.",
|
|
4085
|
+
"type": "boolean"
|
|
3684
4086
|
},
|
|
3685
|
-
"
|
|
3686
|
-
"$ref": "#/definitions/
|
|
3687
|
-
"description": "
|
|
4087
|
+
"background": {
|
|
4088
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.ColorBackgroundJson",
|
|
4089
|
+
"description": "Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed."
|
|
3688
4090
|
},
|
|
3689
|
-
"
|
|
3690
|
-
"$ref": "#/definitions/
|
|
3691
|
-
"description": "
|
|
4091
|
+
"lighting": {
|
|
4092
|
+
"$ref": "#/definitions/LightingJson",
|
|
4093
|
+
"description": "Object containing information on how the scene is lit."
|
|
3692
4094
|
},
|
|
3693
|
-
"
|
|
3694
|
-
"
|
|
3695
|
-
"
|
|
4095
|
+
"starsEnabled": {
|
|
4096
|
+
"description": "Whether stars should be displayed in the sky.",
|
|
4097
|
+
"type": "boolean"
|
|
4098
|
+
},
|
|
4099
|
+
"weather": {
|
|
4100
|
+
"$ref": "#/definitions/WeatherJson",
|
|
4101
|
+
"description": "Indicates the type of weather visualization in the scene."
|
|
3696
4102
|
}
|
|
3697
4103
|
},
|
|
3698
4104
|
"type": "object"
|
|
3699
4105
|
},
|
|
3700
|
-
"esri.rest-api.
|
|
4106
|
+
"esri.rest-api.EnvironmentJson.FoggyWeatherJson": {
|
|
3701
4107
|
"additionalProperties": false,
|
|
3702
|
-
"description": "
|
|
4108
|
+
"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/}.",
|
|
4109
|
+
"properties": {
|
|
4110
|
+
"fogStrength": {
|
|
4111
|
+
"description": "Specifies the amount of fog used in the scene.",
|
|
4112
|
+
"type": "number"
|
|
4113
|
+
},
|
|
4114
|
+
"type": {
|
|
4115
|
+
"const": "foggy",
|
|
4116
|
+
"description": "The type of weather.",
|
|
4117
|
+
"type": "string"
|
|
4118
|
+
}
|
|
4119
|
+
},
|
|
4120
|
+
"required": [
|
|
4121
|
+
"type"
|
|
4122
|
+
],
|
|
4123
|
+
"type": "object"
|
|
4124
|
+
},
|
|
4125
|
+
"esri.rest-api.EnvironmentJson.RainyWeatherJson": {
|
|
4126
|
+
"additionalProperties": false,
|
|
4127
|
+
"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/}.",
|
|
4128
|
+
"properties": {
|
|
4129
|
+
"cloudCover": {
|
|
4130
|
+
"description": "Specifies the amount of cloud cover in the sky.",
|
|
4131
|
+
"type": "number"
|
|
4132
|
+
},
|
|
4133
|
+
"precipitation": {
|
|
4134
|
+
"description": "Specifies the amount of snowfall in the scene.",
|
|
4135
|
+
"type": "number"
|
|
4136
|
+
},
|
|
4137
|
+
"type": {
|
|
4138
|
+
"const": "rainy",
|
|
4139
|
+
"description": "The type of weather.",
|
|
4140
|
+
"type": "string"
|
|
4141
|
+
}
|
|
4142
|
+
},
|
|
4143
|
+
"required": [
|
|
4144
|
+
"type"
|
|
4145
|
+
],
|
|
4146
|
+
"type": "object"
|
|
4147
|
+
},
|
|
4148
|
+
"esri.rest-api.EnvironmentJson.SnowyWeatherJson": {
|
|
4149
|
+
"additionalProperties": false,
|
|
4150
|
+
"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/}.",
|
|
4151
|
+
"properties": {
|
|
4152
|
+
"cloudCover": {
|
|
4153
|
+
"description": "Specifies the amount of cloud cover in the sky.",
|
|
4154
|
+
"type": "number"
|
|
4155
|
+
},
|
|
4156
|
+
"precipitation": {
|
|
4157
|
+
"description": "Specifies the amount of snowfall in the scene.",
|
|
4158
|
+
"type": "number"
|
|
4159
|
+
},
|
|
4160
|
+
"snowCover": {
|
|
4161
|
+
"description": "Display surfaces covered with snow.",
|
|
4162
|
+
"enum": [
|
|
4163
|
+
"disabled",
|
|
4164
|
+
"enabled"
|
|
4165
|
+
],
|
|
4166
|
+
"type": "string"
|
|
4167
|
+
},
|
|
4168
|
+
"type": {
|
|
4169
|
+
"const": "snowy",
|
|
4170
|
+
"description": "The type of weather.",
|
|
4171
|
+
"type": "string"
|
|
4172
|
+
}
|
|
4173
|
+
},
|
|
4174
|
+
"required": [
|
|
4175
|
+
"type"
|
|
4176
|
+
],
|
|
4177
|
+
"type": "object"
|
|
4178
|
+
},
|
|
4179
|
+
"esri.rest-api.EnvironmentJson.SunLightingJson": {
|
|
4180
|
+
"additionalProperties": false,
|
|
4181
|
+
"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/}.",
|
|
4182
|
+
"properties": {
|
|
4183
|
+
"datetime": {
|
|
4184
|
+
"description": "The current date and time of the simulated sun. It is a number representing the number of milliseconds since 1 January, 1970 UTC.",
|
|
4185
|
+
"type": "number"
|
|
4186
|
+
},
|
|
4187
|
+
"directShadows": {
|
|
4188
|
+
"description": "Indicates whether to show shadows cast by the sun.",
|
|
4189
|
+
"type": "boolean"
|
|
4190
|
+
},
|
|
4191
|
+
"displayUTCOffset": {
|
|
4192
|
+
"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).",
|
|
4193
|
+
"type": "number"
|
|
4194
|
+
},
|
|
4195
|
+
"type": {
|
|
4196
|
+
"const": "sun",
|
|
4197
|
+
"description": "The type of lighting.",
|
|
4198
|
+
"type": "string"
|
|
4199
|
+
}
|
|
4200
|
+
},
|
|
4201
|
+
"required": [
|
|
4202
|
+
"type"
|
|
4203
|
+
],
|
|
4204
|
+
"type": "object"
|
|
4205
|
+
},
|
|
4206
|
+
"esri.rest-api.EnvironmentJson.SunnyWeatherJson": {
|
|
4207
|
+
"additionalProperties": false,
|
|
4208
|
+
"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/}.",
|
|
4209
|
+
"properties": {
|
|
4210
|
+
"cloudCover": {
|
|
4211
|
+
"description": "Specifies the amount of cloud cover in the sky.",
|
|
4212
|
+
"type": "number"
|
|
4213
|
+
},
|
|
4214
|
+
"type": {
|
|
4215
|
+
"const": "sunny",
|
|
4216
|
+
"description": "The type of weather.",
|
|
4217
|
+
"type": "string"
|
|
4218
|
+
}
|
|
4219
|
+
},
|
|
4220
|
+
"required": [
|
|
4221
|
+
"type"
|
|
4222
|
+
],
|
|
4223
|
+
"type": "object"
|
|
4224
|
+
},
|
|
4225
|
+
"esri.rest-api.EnvironmentJson.VirtualLightingJson": {
|
|
4226
|
+
"additionalProperties": false,
|
|
4227
|
+
"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/}.",
|
|
4228
|
+
"properties": {
|
|
4229
|
+
"directShadows": {
|
|
4230
|
+
"description": "Indicates whether to show shadows cast by the main light source.",
|
|
4231
|
+
"type": "boolean"
|
|
4232
|
+
},
|
|
4233
|
+
"type": {
|
|
4234
|
+
"const": "virtual",
|
|
4235
|
+
"description": "The type of lighting.",
|
|
4236
|
+
"type": "string"
|
|
4237
|
+
}
|
|
4238
|
+
},
|
|
4239
|
+
"required": [
|
|
4240
|
+
"type"
|
|
4241
|
+
],
|
|
4242
|
+
"type": "object"
|
|
4243
|
+
},
|
|
4244
|
+
"esri.rest-api.FeatureCollectionJson.FeatureCollectionJson": {
|
|
4245
|
+
"additionalProperties": false,
|
|
4246
|
+
"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/}.",
|
|
4247
|
+
"properties": {
|
|
4248
|
+
"layers": {
|
|
4249
|
+
"description": "An array of Layer objects defining all the styling, geometry, and attribute information for the features.",
|
|
4250
|
+
"items": {
|
|
4251
|
+
"$ref": "#/definitions/esri.rest-api.SublayerJson.SublayerJson"
|
|
4252
|
+
},
|
|
4253
|
+
"type": "array"
|
|
4254
|
+
},
|
|
4255
|
+
"showLegend": {
|
|
4256
|
+
"description": "Indicates if this layer should be shown in the legend in client applications. The default is true.",
|
|
4257
|
+
"type": "boolean"
|
|
4258
|
+
}
|
|
4259
|
+
},
|
|
4260
|
+
"required": [
|
|
4261
|
+
"layers"
|
|
4262
|
+
],
|
|
4263
|
+
"type": "object"
|
|
4264
|
+
},
|
|
4265
|
+
"esri.rest-api.FeatureJson.FeatureJson": {
|
|
4266
|
+
"additionalProperties": false,
|
|
4267
|
+
"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/}.",
|
|
4268
|
+
"properties": {
|
|
4269
|
+
"attributes": {
|
|
4270
|
+
"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."
|
|
4271
|
+
},
|
|
4272
|
+
"geometry": {
|
|
4273
|
+
"$ref": "#/definitions/GeometryJson",
|
|
4274
|
+
"description": "The feature geometry."
|
|
4275
|
+
},
|
|
4276
|
+
"popupInfo": {
|
|
4277
|
+
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson",
|
|
4278
|
+
"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."
|
|
4279
|
+
},
|
|
4280
|
+
"symbol": {
|
|
4281
|
+
"$ref": "#/definitions/esri.rest-api.SymbolJson.SymbolJson",
|
|
4282
|
+
"description": "Symbol used for drawing the feature."
|
|
4283
|
+
}
|
|
4284
|
+
},
|
|
4285
|
+
"type": "object"
|
|
4286
|
+
},
|
|
4287
|
+
"esri.rest-api.FeatureLayerJson.FeatureLayerJson": {
|
|
4288
|
+
"additionalProperties": false,
|
|
4289
|
+
"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/}.",
|
|
3703
4290
|
"properties": {
|
|
3704
4291
|
"blendMode": {
|
|
3705
4292
|
"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.",
|
|
@@ -4874,6 +5461,32 @@
|
|
|
4874
5461
|
],
|
|
4875
5462
|
"type": "object"
|
|
4876
5463
|
},
|
|
5464
|
+
"esri.rest-api.GroundJson.GroundJson": {
|
|
5465
|
+
"additionalProperties": false,
|
|
5466
|
+
"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/.",
|
|
5467
|
+
"properties": {
|
|
5468
|
+
"layers": {
|
|
5469
|
+
"description": "An array of elevationLayer objects defining the elevation of the ground in the web scene.",
|
|
5470
|
+
"items": {
|
|
5471
|
+
"$ref": "#/definitions/ElevationLayerJson"
|
|
5472
|
+
},
|
|
5473
|
+
"type": "array"
|
|
5474
|
+
},
|
|
5475
|
+
"navigationConstraint": {
|
|
5476
|
+
"$ref": "__type",
|
|
5477
|
+
"description": "Determines whether the camera is constrained to navigate only above, or also under the ground surface."
|
|
5478
|
+
},
|
|
5479
|
+
"surfaceColor": {
|
|
5480
|
+
"$ref": "#/definitions/esri.rest-api.SymbolJson.ColorJson",
|
|
5481
|
+
"description": "Defines the color of the ground surface, displayed underneath the basemap. If no color, the default grid is shown."
|
|
5482
|
+
},
|
|
5483
|
+
"transparency": {
|
|
5484
|
+
"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).",
|
|
5485
|
+
"type": "number"
|
|
5486
|
+
}
|
|
5487
|
+
},
|
|
5488
|
+
"type": "object"
|
|
5489
|
+
},
|
|
4877
5490
|
"esri.rest-api.GroupLayerJson.GroupLayerJson": {
|
|
4878
5491
|
"additionalProperties": false,
|
|
4879
5492
|
"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/}.",
|
|
@@ -5563,116 +6176,345 @@
|
|
|
5563
6176
|
],
|
|
5564
6177
|
"type": "object"
|
|
5565
6178
|
},
|
|
5566
|
-
"esri.rest-api.
|
|
6179
|
+
"esri.rest-api.ItemJson.ItemJson": {
|
|
5567
6180
|
"additionalProperties": false,
|
|
5568
|
-
"description": "
|
|
6181
|
+
"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/}.",
|
|
5569
6182
|
"properties": {
|
|
5570
|
-
"
|
|
5571
|
-
"description": "
|
|
5572
|
-
"enum": [
|
|
5573
|
-
"average",
|
|
5574
|
-
"color",
|
|
5575
|
-
"color-burn",
|
|
5576
|
-
"color-dodge",
|
|
5577
|
-
"darken",
|
|
5578
|
-
"destination-atop",
|
|
5579
|
-
"destination-in",
|
|
5580
|
-
"destination-out",
|
|
5581
|
-
"destination-over",
|
|
5582
|
-
"difference",
|
|
5583
|
-
"exclusion",
|
|
5584
|
-
"hard-light",
|
|
5585
|
-
"hue",
|
|
5586
|
-
"invert",
|
|
5587
|
-
"lighten",
|
|
5588
|
-
"lighter",
|
|
5589
|
-
"luminosity",
|
|
5590
|
-
"minus",
|
|
5591
|
-
"multiply",
|
|
5592
|
-
"normal",
|
|
5593
|
-
"overlay",
|
|
5594
|
-
"plus",
|
|
5595
|
-
"reflect",
|
|
5596
|
-
"saturation",
|
|
5597
|
-
"screen",
|
|
5598
|
-
"soft-light",
|
|
5599
|
-
"source-atop",
|
|
5600
|
-
"source-in",
|
|
5601
|
-
"source-out",
|
|
5602
|
-
"vivid-light",
|
|
5603
|
-
"xor"
|
|
5604
|
-
],
|
|
5605
|
-
"type": "string"
|
|
5606
|
-
},
|
|
5607
|
-
"effect": {
|
|
5608
|
-
"$ref": "#/definitions/EffectJson",
|
|
5609
|
-
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
5610
|
-
},
|
|
5611
|
-
"id": {
|
|
5612
|
-
"description": "A unique identifying string for the layer.",
|
|
5613
|
-
"type": "string"
|
|
5614
|
-
},
|
|
5615
|
-
"itemId": {
|
|
5616
|
-
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
6183
|
+
"access": {
|
|
6184
|
+
"description": "Indicates the level of access to this item: private, shared, org, or public.",
|
|
5617
6185
|
"type": "string"
|
|
5618
6186
|
},
|
|
5619
|
-
"
|
|
5620
|
-
"
|
|
5621
|
-
"description": "The type of layer.",
|
|
6187
|
+
"accessInformation": {
|
|
6188
|
+
"description": "Information on the source of the item and its copyright status.",
|
|
5622
6189
|
"type": "string"
|
|
5623
6190
|
},
|
|
5624
|
-
"
|
|
5625
|
-
"description": "
|
|
5626
|
-
"enum": [
|
|
5627
|
-
"hide",
|
|
5628
|
-
"hide-children",
|
|
5629
|
-
"show"
|
|
5630
|
-
],
|
|
5631
|
-
"type": "string"
|
|
6191
|
+
"advancedSettings": {
|
|
6192
|
+
"description": "<not in spec>."
|
|
5632
6193
|
},
|
|
5633
|
-
"
|
|
5634
|
-
"description": "
|
|
5635
|
-
"
|
|
6194
|
+
"appCategories": {
|
|
6195
|
+
"description": "An array that primarily applies to a list of categories that the application item is applicable to.",
|
|
6196
|
+
"items": {
|
|
6197
|
+
"type": "string"
|
|
6198
|
+
},
|
|
6199
|
+
"type": "array"
|
|
5636
6200
|
},
|
|
5637
|
-
"
|
|
5638
|
-
"description": "
|
|
6201
|
+
"avgRating": {
|
|
6202
|
+
"description": "Average rating. Uses a weighted average called \"Bayesian average.\".",
|
|
5639
6203
|
"type": "number"
|
|
5640
6204
|
},
|
|
5641
|
-
"
|
|
5642
|
-
"description": "
|
|
5643
|
-
"type": "
|
|
6205
|
+
"banner": {
|
|
6206
|
+
"description": "Primarily applies to the banner associated with an application. The URL to the banner used for the application.",
|
|
6207
|
+
"type": "string"
|
|
5644
6208
|
},
|
|
5645
|
-
"
|
|
5646
|
-
"description": "
|
|
5647
|
-
"
|
|
6209
|
+
"categories": {
|
|
6210
|
+
"description": "An array of organization categories that are set on the item.",
|
|
6211
|
+
"items": {
|
|
6212
|
+
"type": "string"
|
|
6213
|
+
},
|
|
6214
|
+
"type": "array"
|
|
5648
6215
|
},
|
|
5649
|
-
"
|
|
5650
|
-
"description": "Indicates
|
|
6216
|
+
"commentsEnabled": {
|
|
6217
|
+
"description": "Indicates if comments are allowed on the item.",
|
|
5651
6218
|
"type": "boolean"
|
|
5652
6219
|
},
|
|
5653
|
-
"
|
|
5654
|
-
"description": "
|
|
6220
|
+
"contentOrigin": {
|
|
6221
|
+
"description": "<not in spec>.",
|
|
5655
6222
|
"type": "string"
|
|
5656
6223
|
},
|
|
5657
|
-
"
|
|
5658
|
-
"description": "
|
|
5659
|
-
"
|
|
5660
|
-
|
|
5661
|
-
|
|
5662
|
-
|
|
5663
|
-
"CSV",
|
|
5664
|
-
"KML",
|
|
5665
|
-
"OpenStreetMap",
|
|
5666
|
-
"WMS",
|
|
5667
|
-
"WebTiledLayer"
|
|
5668
|
-
],
|
|
6224
|
+
"created": {
|
|
6225
|
+
"description": "The date the item was created. Shown in UNIX time in milliseconds.",
|
|
6226
|
+
"type": "number"
|
|
6227
|
+
},
|
|
6228
|
+
"culture": {
|
|
6229
|
+
"description": "The item locale information (language and country).",
|
|
5669
6230
|
"type": "string"
|
|
5670
6231
|
},
|
|
5671
|
-
"
|
|
5672
|
-
"description": "
|
|
6232
|
+
"description": {
|
|
6233
|
+
"description": "Item description.",
|
|
5673
6234
|
"type": "string"
|
|
5674
6235
|
},
|
|
5675
|
-
"
|
|
6236
|
+
"documentation": {
|
|
6237
|
+
"description": "<not in spec>."
|
|
6238
|
+
},
|
|
6239
|
+
"extent": {
|
|
6240
|
+
"description": "The bounding rectangle of the item. Should always be in WGS84.",
|
|
6241
|
+
"items": {
|
|
6242
|
+
"items": {
|
|
6243
|
+
"type": "number"
|
|
6244
|
+
},
|
|
6245
|
+
"type": "array"
|
|
6246
|
+
},
|
|
6247
|
+
"type": "array"
|
|
6248
|
+
},
|
|
6249
|
+
"groupDesignations": {
|
|
6250
|
+
"description": "<not in spec>."
|
|
6251
|
+
},
|
|
6252
|
+
"guid": {
|
|
6253
|
+
"description": "<not in spec>.",
|
|
6254
|
+
"type": "string"
|
|
6255
|
+
},
|
|
6256
|
+
"id": {
|
|
6257
|
+
"description": "The unique ID for this item.",
|
|
6258
|
+
"type": "string"
|
|
6259
|
+
},
|
|
6260
|
+
"industries": {
|
|
6261
|
+
"description": "Primarily applies to industries associated with the application.",
|
|
6262
|
+
"items": {
|
|
6263
|
+
"type": "string"
|
|
6264
|
+
},
|
|
6265
|
+
"type": "array"
|
|
6266
|
+
},
|
|
6267
|
+
"isOrgItem": {
|
|
6268
|
+
"description": "<not in spec>.",
|
|
6269
|
+
"type": "boolean"
|
|
6270
|
+
},
|
|
6271
|
+
"itemControl": {
|
|
6272
|
+
"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).",
|
|
6273
|
+
"enum": [
|
|
6274
|
+
"admin",
|
|
6275
|
+
"update"
|
|
6276
|
+
],
|
|
6277
|
+
"type": "string"
|
|
6278
|
+
},
|
|
6279
|
+
"languages": {
|
|
6280
|
+
"description": "Primarily applies to languages associated with the application.",
|
|
6281
|
+
"items": {
|
|
6282
|
+
"type": "string"
|
|
6283
|
+
},
|
|
6284
|
+
"type": "array"
|
|
6285
|
+
},
|
|
6286
|
+
"largeThumbnail": {
|
|
6287
|
+
"description": "Primarily applies to thumbnails associated with an application. The URL to the thumbnail used for the application.",
|
|
6288
|
+
"type": "string"
|
|
6289
|
+
},
|
|
6290
|
+
"lastViewed": {
|
|
6291
|
+
"description": "The date/time the item was last accessed in UNIX format (in milliseconds).",
|
|
6292
|
+
"type": "number"
|
|
6293
|
+
},
|
|
6294
|
+
"licenseInfo": {
|
|
6295
|
+
"description": "Any license information or restrictions.",
|
|
6296
|
+
"type": "string"
|
|
6297
|
+
},
|
|
6298
|
+
"listed": {
|
|
6299
|
+
"description": "Primarily applies to the banner associated with an application. The URL to the banner used for the application.",
|
|
6300
|
+
"type": "boolean"
|
|
6301
|
+
},
|
|
6302
|
+
"modified": {
|
|
6303
|
+
"description": "The date the item was last modified. Shown in UNIX time in milliseconds.",
|
|
6304
|
+
"type": "number"
|
|
6305
|
+
},
|
|
6306
|
+
"name": {
|
|
6307
|
+
"description": "The file name of the item for file types. Read-only.",
|
|
6308
|
+
"type": "string"
|
|
6309
|
+
},
|
|
6310
|
+
"numComments": {
|
|
6311
|
+
"description": "Number of comments on the item.",
|
|
6312
|
+
"type": "number"
|
|
6313
|
+
},
|
|
6314
|
+
"numRatings": {
|
|
6315
|
+
"description": "Number of ratings on the item.",
|
|
6316
|
+
"type": "number"
|
|
6317
|
+
},
|
|
6318
|
+
"numViews": {
|
|
6319
|
+
"description": "Number of views of the item.",
|
|
6320
|
+
"type": "number"
|
|
6321
|
+
},
|
|
6322
|
+
"orgId": {
|
|
6323
|
+
"description": "<not in spec>.",
|
|
6324
|
+
"type": "string"
|
|
6325
|
+
},
|
|
6326
|
+
"owner": {
|
|
6327
|
+
"description": "The username of the user who owns this item.",
|
|
6328
|
+
"type": "string"
|
|
6329
|
+
},
|
|
6330
|
+
"ownerFolder": {
|
|
6331
|
+
"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.",
|
|
6332
|
+
"type": "string"
|
|
6333
|
+
},
|
|
6334
|
+
"properties": {
|
|
6335
|
+
"description": "A JSON object that primarily applies to system requirements, Terms and Conditions, version, supported platforms, YouTube video ID, etc associated with the application.",
|
|
6336
|
+
"type": "string"
|
|
6337
|
+
},
|
|
6338
|
+
"protected": {
|
|
6339
|
+
"description": "Protects the item from deletion. False is the default.",
|
|
6340
|
+
"type": "boolean"
|
|
6341
|
+
},
|
|
6342
|
+
"proxyFilter": {
|
|
6343
|
+
"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."
|
|
6344
|
+
},
|
|
6345
|
+
"scoreCompleteness": {
|
|
6346
|
+
"description": "Item information completeness score based upon item snippet, thumbnail, description, title, tags etc.",
|
|
6347
|
+
"type": "number"
|
|
6348
|
+
},
|
|
6349
|
+
"screenshots": {
|
|
6350
|
+
"description": "Primarily applies to screenshots associated with an application. The URL to the screenshots used for the application.",
|
|
6351
|
+
"items": {
|
|
6352
|
+
"type": "string"
|
|
6353
|
+
},
|
|
6354
|
+
"type": "array"
|
|
6355
|
+
},
|
|
6356
|
+
"size": {
|
|
6357
|
+
"description": "The size of the item.",
|
|
6358
|
+
"type": "number"
|
|
6359
|
+
},
|
|
6360
|
+
"snippet": {
|
|
6361
|
+
"description": "A short summary description of the item.",
|
|
6362
|
+
"type": "string"
|
|
6363
|
+
},
|
|
6364
|
+
"spatialReference": {
|
|
6365
|
+
"$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson",
|
|
6366
|
+
"description": "The coordinate system of the item."
|
|
6367
|
+
},
|
|
6368
|
+
"subInfo": {
|
|
6369
|
+
"description": "<not in spec>.",
|
|
6370
|
+
"type": "number"
|
|
6371
|
+
},
|
|
6372
|
+
"tags": {
|
|
6373
|
+
"description": "User defined tags that describe the item.",
|
|
6374
|
+
"items": {
|
|
6375
|
+
"type": "string"
|
|
6376
|
+
},
|
|
6377
|
+
"type": "array"
|
|
6378
|
+
},
|
|
6379
|
+
"thumbnail": {
|
|
6380
|
+
"description": "The URL to the thumbnail used for the item.",
|
|
6381
|
+
"type": "string"
|
|
6382
|
+
},
|
|
6383
|
+
"title": {
|
|
6384
|
+
"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.",
|
|
6385
|
+
"type": "string"
|
|
6386
|
+
},
|
|
6387
|
+
"type": {
|
|
6388
|
+
"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}.",
|
|
6389
|
+
"type": "string"
|
|
6390
|
+
},
|
|
6391
|
+
"typeKeywords": {
|
|
6392
|
+
"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.",
|
|
6393
|
+
"items": {
|
|
6394
|
+
"type": "string"
|
|
6395
|
+
},
|
|
6396
|
+
"type": "array"
|
|
6397
|
+
},
|
|
6398
|
+
"url": {
|
|
6399
|
+
"description": "The URL for the resource represented by the item. Applies only to items that represent web-accessible resources such as map services.",
|
|
6400
|
+
"type": "string"
|
|
6401
|
+
}
|
|
6402
|
+
},
|
|
6403
|
+
"required": [
|
|
6404
|
+
"id"
|
|
6405
|
+
],
|
|
6406
|
+
"type": "object"
|
|
6407
|
+
},
|
|
6408
|
+
"esri.rest-api.KMLLayerJson.KMLLayerJson": {
|
|
6409
|
+
"additionalProperties": false,
|
|
6410
|
+
"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/}.",
|
|
6411
|
+
"properties": {
|
|
6412
|
+
"blendMode": {
|
|
6413
|
+
"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.",
|
|
6414
|
+
"enum": [
|
|
6415
|
+
"average",
|
|
6416
|
+
"color",
|
|
6417
|
+
"color-burn",
|
|
6418
|
+
"color-dodge",
|
|
6419
|
+
"darken",
|
|
6420
|
+
"destination-atop",
|
|
6421
|
+
"destination-in",
|
|
6422
|
+
"destination-out",
|
|
6423
|
+
"destination-over",
|
|
6424
|
+
"difference",
|
|
6425
|
+
"exclusion",
|
|
6426
|
+
"hard-light",
|
|
6427
|
+
"hue",
|
|
6428
|
+
"invert",
|
|
6429
|
+
"lighten",
|
|
6430
|
+
"lighter",
|
|
6431
|
+
"luminosity",
|
|
6432
|
+
"minus",
|
|
6433
|
+
"multiply",
|
|
6434
|
+
"normal",
|
|
6435
|
+
"overlay",
|
|
6436
|
+
"plus",
|
|
6437
|
+
"reflect",
|
|
6438
|
+
"saturation",
|
|
6439
|
+
"screen",
|
|
6440
|
+
"soft-light",
|
|
6441
|
+
"source-atop",
|
|
6442
|
+
"source-in",
|
|
6443
|
+
"source-out",
|
|
6444
|
+
"vivid-light",
|
|
6445
|
+
"xor"
|
|
6446
|
+
],
|
|
6447
|
+
"type": "string"
|
|
6448
|
+
},
|
|
6449
|
+
"effect": {
|
|
6450
|
+
"$ref": "#/definitions/EffectJson",
|
|
6451
|
+
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
6452
|
+
},
|
|
6453
|
+
"id": {
|
|
6454
|
+
"description": "A unique identifying string for the layer.",
|
|
6455
|
+
"type": "string"
|
|
6456
|
+
},
|
|
6457
|
+
"itemId": {
|
|
6458
|
+
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
6459
|
+
"type": "string"
|
|
6460
|
+
},
|
|
6461
|
+
"layerType": {
|
|
6462
|
+
"const": "KML",
|
|
6463
|
+
"description": "The type of layer.",
|
|
6464
|
+
"type": "string"
|
|
6465
|
+
},
|
|
6466
|
+
"listMode": {
|
|
6467
|
+
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
6468
|
+
"enum": [
|
|
6469
|
+
"hide",
|
|
6470
|
+
"hide-children",
|
|
6471
|
+
"show"
|
|
6472
|
+
],
|
|
6473
|
+
"type": "string"
|
|
6474
|
+
},
|
|
6475
|
+
"maxScale": {
|
|
6476
|
+
"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.",
|
|
6477
|
+
"type": "number"
|
|
6478
|
+
},
|
|
6479
|
+
"minScale": {
|
|
6480
|
+
"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.",
|
|
6481
|
+
"type": "number"
|
|
6482
|
+
},
|
|
6483
|
+
"opacity": {
|
|
6484
|
+
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
6485
|
+
"type": "number"
|
|
6486
|
+
},
|
|
6487
|
+
"refreshInterval": {
|
|
6488
|
+
"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}.",
|
|
6489
|
+
"type": "number"
|
|
6490
|
+
},
|
|
6491
|
+
"showLegend": {
|
|
6492
|
+
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
6493
|
+
"type": "boolean"
|
|
6494
|
+
},
|
|
6495
|
+
"title": {
|
|
6496
|
+
"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.",
|
|
6497
|
+
"type": "string"
|
|
6498
|
+
},
|
|
6499
|
+
"type": {
|
|
6500
|
+
"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.",
|
|
6501
|
+
"enum": [
|
|
6502
|
+
"BingMapsAerial",
|
|
6503
|
+
"BingMapsHybrid",
|
|
6504
|
+
"BingMapsRoad",
|
|
6505
|
+
"CSV",
|
|
6506
|
+
"KML",
|
|
6507
|
+
"OpenStreetMap",
|
|
6508
|
+
"WMS",
|
|
6509
|
+
"WebTiledLayer"
|
|
6510
|
+
],
|
|
6511
|
+
"type": "string"
|
|
6512
|
+
},
|
|
6513
|
+
"url": {
|
|
6514
|
+
"description": "The URL to the layer.",
|
|
6515
|
+
"type": "string"
|
|
6516
|
+
},
|
|
6517
|
+
"visibility": {
|
|
5676
6518
|
"description": "Determines whether the layer is initially visible in the web map.",
|
|
5677
6519
|
"type": "boolean"
|
|
5678
6520
|
},
|
|
@@ -7068,9 +7910,9 @@
|
|
|
7068
7910
|
},
|
|
7069
7911
|
"type": "object"
|
|
7070
7912
|
},
|
|
7071
|
-
"esri.rest-api.
|
|
7913
|
+
"esri.rest-api.OpenStreetMapLayerJson.OpenStreetMapLayerJson": {
|
|
7072
7914
|
"additionalProperties": false,
|
|
7073
|
-
"description": "
|
|
7915
|
+
"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.",
|
|
7074
7916
|
"properties": {
|
|
7075
7917
|
"blendMode": {
|
|
7076
7918
|
"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.",
|
|
@@ -7109,10 +7951,6 @@
|
|
|
7109
7951
|
],
|
|
7110
7952
|
"type": "string"
|
|
7111
7953
|
},
|
|
7112
|
-
"disablePopup": {
|
|
7113
|
-
"description": "Indicates whether to allow a client to ignore popups defined by the service item.",
|
|
7114
|
-
"type": "boolean"
|
|
7115
|
-
},
|
|
7116
7954
|
"effect": {
|
|
7117
7955
|
"$ref": "#/definitions/EffectJson",
|
|
7118
7956
|
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
@@ -7121,22 +7959,17 @@
|
|
|
7121
7959
|
"description": "A unique identifying string for the layer.",
|
|
7122
7960
|
"type": "string"
|
|
7123
7961
|
},
|
|
7124
|
-
"
|
|
7125
|
-
"
|
|
7126
|
-
"
|
|
7962
|
+
"isReference": {
|
|
7963
|
+
"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).",
|
|
7964
|
+
"type": "boolean"
|
|
7127
7965
|
},
|
|
7128
|
-
"
|
|
7129
|
-
"
|
|
7130
|
-
"description": "The type of layer.",
|
|
7966
|
+
"itemId": {
|
|
7967
|
+
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
7131
7968
|
"type": "string"
|
|
7132
7969
|
},
|
|
7133
|
-
"
|
|
7134
|
-
"
|
|
7135
|
-
"
|
|
7136
|
-
"hide",
|
|
7137
|
-
"hide-children",
|
|
7138
|
-
"show"
|
|
7139
|
-
],
|
|
7970
|
+
"layerType": {
|
|
7971
|
+
"const": "OpenStreetMap",
|
|
7972
|
+
"description": "The type of layer.",
|
|
7140
7973
|
"type": "string"
|
|
7141
7974
|
},
|
|
7142
7975
|
"maxScale": {
|
|
@@ -7151,14 +7984,6 @@
|
|
|
7151
7984
|
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
7152
7985
|
"type": "number"
|
|
7153
7986
|
},
|
|
7154
|
-
"popupInfo": {
|
|
7155
|
-
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson",
|
|
7156
|
-
"description": "A PopupInfo object defining the content of pop-up windows when you click or query a feature."
|
|
7157
|
-
},
|
|
7158
|
-
"refreshInterval": {
|
|
7159
|
-
"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}.",
|
|
7160
|
-
"type": "number"
|
|
7161
|
-
},
|
|
7162
7987
|
"showLegend": {
|
|
7163
7988
|
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
7164
7989
|
"type": "boolean"
|
|
@@ -7181,7 +8006,144 @@
|
|
|
7181
8006
|
],
|
|
7182
8007
|
"type": "string"
|
|
7183
8008
|
},
|
|
7184
|
-
"
|
|
8009
|
+
"visibility": {
|
|
8010
|
+
"description": "Determines whether the layer is initially visible in the web map.",
|
|
8011
|
+
"type": "boolean"
|
|
8012
|
+
},
|
|
8013
|
+
"visibilityTimeExtent": {
|
|
8014
|
+
"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.",
|
|
8015
|
+
"items": [
|
|
8016
|
+
{
|
|
8017
|
+
"type": "number"
|
|
8018
|
+
},
|
|
8019
|
+
{
|
|
8020
|
+
"type": "number"
|
|
8021
|
+
}
|
|
8022
|
+
],
|
|
8023
|
+
"maxItems": 2,
|
|
8024
|
+
"minItems": 2,
|
|
8025
|
+
"type": "array"
|
|
8026
|
+
}
|
|
8027
|
+
},
|
|
8028
|
+
"required": [
|
|
8029
|
+
"layerType"
|
|
8030
|
+
],
|
|
8031
|
+
"type": "object"
|
|
8032
|
+
},
|
|
8033
|
+
"esri.rest-api.PointCloudLayerJson.PointCloudLayerJson": {
|
|
8034
|
+
"additionalProperties": false,
|
|
8035
|
+
"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/}.",
|
|
8036
|
+
"properties": {
|
|
8037
|
+
"blendMode": {
|
|
8038
|
+
"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.",
|
|
8039
|
+
"enum": [
|
|
8040
|
+
"average",
|
|
8041
|
+
"color",
|
|
8042
|
+
"color-burn",
|
|
8043
|
+
"color-dodge",
|
|
8044
|
+
"darken",
|
|
8045
|
+
"destination-atop",
|
|
8046
|
+
"destination-in",
|
|
8047
|
+
"destination-out",
|
|
8048
|
+
"destination-over",
|
|
8049
|
+
"difference",
|
|
8050
|
+
"exclusion",
|
|
8051
|
+
"hard-light",
|
|
8052
|
+
"hue",
|
|
8053
|
+
"invert",
|
|
8054
|
+
"lighten",
|
|
8055
|
+
"lighter",
|
|
8056
|
+
"luminosity",
|
|
8057
|
+
"minus",
|
|
8058
|
+
"multiply",
|
|
8059
|
+
"normal",
|
|
8060
|
+
"overlay",
|
|
8061
|
+
"plus",
|
|
8062
|
+
"reflect",
|
|
8063
|
+
"saturation",
|
|
8064
|
+
"screen",
|
|
8065
|
+
"soft-light",
|
|
8066
|
+
"source-atop",
|
|
8067
|
+
"source-in",
|
|
8068
|
+
"source-out",
|
|
8069
|
+
"vivid-light",
|
|
8070
|
+
"xor"
|
|
8071
|
+
],
|
|
8072
|
+
"type": "string"
|
|
8073
|
+
},
|
|
8074
|
+
"disablePopup": {
|
|
8075
|
+
"description": "Indicates whether to allow a client to ignore popups defined by the service item.",
|
|
8076
|
+
"type": "boolean"
|
|
8077
|
+
},
|
|
8078
|
+
"effect": {
|
|
8079
|
+
"$ref": "#/definitions/EffectJson",
|
|
8080
|
+
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
8081
|
+
},
|
|
8082
|
+
"id": {
|
|
8083
|
+
"description": "A unique identifying string for the layer.",
|
|
8084
|
+
"type": "string"
|
|
8085
|
+
},
|
|
8086
|
+
"layerDefinition": {
|
|
8087
|
+
"$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
|
|
8088
|
+
"description": "A layerDefinition object defining the attribute schema and drawing information for the layer."
|
|
8089
|
+
},
|
|
8090
|
+
"layerType": {
|
|
8091
|
+
"const": "PointCloudLayer",
|
|
8092
|
+
"description": "The type of layer.",
|
|
8093
|
+
"type": "string"
|
|
8094
|
+
},
|
|
8095
|
+
"listMode": {
|
|
8096
|
+
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
8097
|
+
"enum": [
|
|
8098
|
+
"hide",
|
|
8099
|
+
"hide-children",
|
|
8100
|
+
"show"
|
|
8101
|
+
],
|
|
8102
|
+
"type": "string"
|
|
8103
|
+
},
|
|
8104
|
+
"maxScale": {
|
|
8105
|
+
"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.",
|
|
8106
|
+
"type": "number"
|
|
8107
|
+
},
|
|
8108
|
+
"minScale": {
|
|
8109
|
+
"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.",
|
|
8110
|
+
"type": "number"
|
|
8111
|
+
},
|
|
8112
|
+
"opacity": {
|
|
8113
|
+
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
8114
|
+
"type": "number"
|
|
8115
|
+
},
|
|
8116
|
+
"popupInfo": {
|
|
8117
|
+
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson",
|
|
8118
|
+
"description": "A PopupInfo object defining the content of pop-up windows when you click or query a feature."
|
|
8119
|
+
},
|
|
8120
|
+
"refreshInterval": {
|
|
8121
|
+
"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}.",
|
|
8122
|
+
"type": "number"
|
|
8123
|
+
},
|
|
8124
|
+
"showLegend": {
|
|
8125
|
+
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
8126
|
+
"type": "boolean"
|
|
8127
|
+
},
|
|
8128
|
+
"title": {
|
|
8129
|
+
"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.",
|
|
8130
|
+
"type": "string"
|
|
8131
|
+
},
|
|
8132
|
+
"type": {
|
|
8133
|
+
"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.",
|
|
8134
|
+
"enum": [
|
|
8135
|
+
"BingMapsAerial",
|
|
8136
|
+
"BingMapsHybrid",
|
|
8137
|
+
"BingMapsRoad",
|
|
8138
|
+
"CSV",
|
|
8139
|
+
"KML",
|
|
8140
|
+
"OpenStreetMap",
|
|
8141
|
+
"WMS",
|
|
8142
|
+
"WebTiledLayer"
|
|
8143
|
+
],
|
|
8144
|
+
"type": "string"
|
|
8145
|
+
},
|
|
8146
|
+
"url": {
|
|
7185
8147
|
"description": "URL to the ArcGIS Server Image Service.",
|
|
7186
8148
|
"type": "string"
|
|
7187
8149
|
},
|
|
@@ -7517,67 +8479,200 @@
|
|
|
7517
8479
|
},
|
|
7518
8480
|
"type": "object"
|
|
7519
8481
|
},
|
|
7520
|
-
"esri.rest-api.
|
|
8482
|
+
"esri.rest-api.RasterDataElevationLayerJson.RasterDataElevationLayerJson": {
|
|
7521
8483
|
"additionalProperties": false,
|
|
7522
|
-
"description": "
|
|
8484
|
+
"description": "RasterDataElevationLayer is a single-band raster layer used for rendering elevation.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/rasterDataElevationLayer/}.",
|
|
7523
8485
|
"properties": {
|
|
7524
|
-
"
|
|
7525
|
-
"
|
|
7526
|
-
"
|
|
8486
|
+
"blendMode": {
|
|
8487
|
+
"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.",
|
|
8488
|
+
"enum": [
|
|
8489
|
+
"average",
|
|
8490
|
+
"color",
|
|
8491
|
+
"color-burn",
|
|
8492
|
+
"color-dodge",
|
|
8493
|
+
"darken",
|
|
8494
|
+
"destination-atop",
|
|
8495
|
+
"destination-in",
|
|
8496
|
+
"destination-out",
|
|
8497
|
+
"destination-over",
|
|
8498
|
+
"difference",
|
|
8499
|
+
"exclusion",
|
|
8500
|
+
"hard-light",
|
|
8501
|
+
"hue",
|
|
8502
|
+
"invert",
|
|
8503
|
+
"lighten",
|
|
8504
|
+
"lighter",
|
|
8505
|
+
"luminosity",
|
|
8506
|
+
"minus",
|
|
8507
|
+
"multiply",
|
|
8508
|
+
"normal",
|
|
8509
|
+
"overlay",
|
|
8510
|
+
"plus",
|
|
8511
|
+
"reflect",
|
|
8512
|
+
"saturation",
|
|
8513
|
+
"screen",
|
|
8514
|
+
"soft-light",
|
|
8515
|
+
"source-atop",
|
|
8516
|
+
"source-in",
|
|
8517
|
+
"source-out",
|
|
8518
|
+
"vivid-light",
|
|
8519
|
+
"xor"
|
|
8520
|
+
],
|
|
8521
|
+
"type": "string"
|
|
7527
8522
|
},
|
|
7528
|
-
"
|
|
7529
|
-
"$ref": "#/definitions/
|
|
7530
|
-
"description": "
|
|
8523
|
+
"effect": {
|
|
8524
|
+
"$ref": "#/definitions/EffectJson",
|
|
8525
|
+
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
7531
8526
|
},
|
|
7532
|
-
"
|
|
7533
|
-
"
|
|
7534
|
-
"
|
|
8527
|
+
"id": {
|
|
8528
|
+
"description": "A unique identifying string for the layer.",
|
|
8529
|
+
"type": "string"
|
|
7535
8530
|
},
|
|
7536
|
-
"
|
|
7537
|
-
"description": "
|
|
8531
|
+
"isReference": {
|
|
8532
|
+
"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).",
|
|
8533
|
+
"type": "boolean"
|
|
8534
|
+
},
|
|
8535
|
+
"layerType": {
|
|
8536
|
+
"const": "RasterDataElevationLayer",
|
|
8537
|
+
"description": "The type of layer.",
|
|
7538
8538
|
"type": "string"
|
|
7539
8539
|
},
|
|
7540
|
-
"
|
|
7541
|
-
"description": "
|
|
7542
|
-
"
|
|
8540
|
+
"listMode": {
|
|
8541
|
+
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
8542
|
+
"enum": [
|
|
8543
|
+
"hide",
|
|
8544
|
+
"hide-children",
|
|
8545
|
+
"show"
|
|
8546
|
+
],
|
|
8547
|
+
"type": "string"
|
|
7543
8548
|
},
|
|
7544
|
-
"
|
|
7545
|
-
"
|
|
7546
|
-
"
|
|
8549
|
+
"maxScale": {
|
|
8550
|
+
"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.",
|
|
8551
|
+
"type": "number"
|
|
7547
8552
|
},
|
|
7548
|
-
"
|
|
7549
|
-
"
|
|
7550
|
-
"description": "An array of visualVariable objects used for continuous color or size, simple, and unique values with feature opacity."
|
|
7551
|
-
}
|
|
7552
|
-
},
|
|
7553
|
-
"type": "object"
|
|
7554
|
-
},
|
|
7555
|
-
"esri.rest-api.RendererJson.ClassBreakInfoJson": {
|
|
7556
|
-
"additionalProperties": false,
|
|
7557
|
-
"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/}.",
|
|
7558
|
-
"properties": {
|
|
7559
|
-
"classMaxValue": {
|
|
7560
|
-
"description": "A numeric value used to specify the maximum value for a break.",
|
|
8553
|
+
"minScale": {
|
|
8554
|
+
"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.",
|
|
7561
8555
|
"type": "number"
|
|
7562
8556
|
},
|
|
7563
|
-
"
|
|
7564
|
-
"description": "
|
|
8557
|
+
"opacity": {
|
|
8558
|
+
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
7565
8559
|
"type": "number"
|
|
7566
8560
|
},
|
|
7567
|
-
"
|
|
7568
|
-
"description": "
|
|
8561
|
+
"path": {
|
|
8562
|
+
"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`.",
|
|
7569
8563
|
"type": "string"
|
|
7570
8564
|
},
|
|
7571
|
-
"
|
|
7572
|
-
"description": "
|
|
8565
|
+
"refreshInterval": {
|
|
8566
|
+
"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}.",
|
|
8567
|
+
"type": "number"
|
|
8568
|
+
},
|
|
8569
|
+
"showLegend": {
|
|
8570
|
+
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
8571
|
+
"type": "boolean"
|
|
8572
|
+
},
|
|
8573
|
+
"title": {
|
|
8574
|
+
"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.",
|
|
7573
8575
|
"type": "string"
|
|
7574
8576
|
},
|
|
7575
|
-
"
|
|
7576
|
-
"
|
|
7577
|
-
"
|
|
7578
|
-
|
|
7579
|
-
|
|
7580
|
-
|
|
8577
|
+
"type": {
|
|
8578
|
+
"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.",
|
|
8579
|
+
"enum": [
|
|
8580
|
+
"BingMapsAerial",
|
|
8581
|
+
"BingMapsHybrid",
|
|
8582
|
+
"BingMapsRoad",
|
|
8583
|
+
"CSV",
|
|
8584
|
+
"KML",
|
|
8585
|
+
"OpenStreetMap",
|
|
8586
|
+
"WMS",
|
|
8587
|
+
"WebTiledLayer"
|
|
8588
|
+
],
|
|
8589
|
+
"type": "string"
|
|
8590
|
+
},
|
|
8591
|
+
"visibility": {
|
|
8592
|
+
"description": "Determines whether the layer is initially visible in the web map.",
|
|
8593
|
+
"type": "boolean"
|
|
8594
|
+
},
|
|
8595
|
+
"visibilityTimeExtent": {
|
|
8596
|
+
"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.",
|
|
8597
|
+
"items": [
|
|
8598
|
+
{
|
|
8599
|
+
"type": "number"
|
|
8600
|
+
},
|
|
8601
|
+
{
|
|
8602
|
+
"type": "number"
|
|
8603
|
+
}
|
|
8604
|
+
],
|
|
8605
|
+
"maxItems": 2,
|
|
8606
|
+
"minItems": 2,
|
|
8607
|
+
"type": "array"
|
|
8608
|
+
}
|
|
8609
|
+
},
|
|
8610
|
+
"required": [
|
|
8611
|
+
"layerType"
|
|
8612
|
+
],
|
|
8613
|
+
"type": "object"
|
|
8614
|
+
},
|
|
8615
|
+
"esri.rest-api.RendererJson.AuthoringInfoJson": {
|
|
8616
|
+
"additionalProperties": false,
|
|
8617
|
+
"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/}.",
|
|
8618
|
+
"properties": {
|
|
8619
|
+
"classificationMethod": {
|
|
8620
|
+
"$ref": "esri.rest-api.RendererJson.ClassificationMethodJsonType",
|
|
8621
|
+
"description": "Used for classed color or size. The default value is esriClassifyManual."
|
|
8622
|
+
},
|
|
8623
|
+
"colorRamp": {
|
|
8624
|
+
"$ref": "#/definitions/esri.rest-api.RendererJson.ColorRampJson",
|
|
8625
|
+
"description": "A colorRamp object is used to specify a range of colors that are applied to a group of symbols."
|
|
8626
|
+
},
|
|
8627
|
+
"field": {
|
|
8628
|
+
"$ref": "#/definitions/esri.rest-api.FieldJson.FieldJson",
|
|
8629
|
+
"description": "Contains information about an attribute field."
|
|
8630
|
+
},
|
|
8631
|
+
"fields": {
|
|
8632
|
+
"description": "An array of string values representing field names used for creating predominance renderers.",
|
|
8633
|
+
"type": "string"
|
|
8634
|
+
},
|
|
8635
|
+
"standardDeviationInterval": {
|
|
8636
|
+
"description": "Use if the classificationMethod is esriClassifyStandardDeviation. Possible values: 0.25, 0.33, 0.5, 1.",
|
|
8637
|
+
"type": "number"
|
|
8638
|
+
},
|
|
8639
|
+
"type": {
|
|
8640
|
+
"$ref": "AuthoringInfoJsonType",
|
|
8641
|
+
"description": "In case of classed renderers this is set to either classedSize or classedColor."
|
|
8642
|
+
},
|
|
8643
|
+
"visualVariables": {
|
|
8644
|
+
"$ref": "#/definitions/VisualVariableJson",
|
|
8645
|
+
"description": "An array of visualVariable objects used for continuous color or size, simple, and unique values with feature opacity."
|
|
8646
|
+
}
|
|
8647
|
+
},
|
|
8648
|
+
"type": "object"
|
|
8649
|
+
},
|
|
8650
|
+
"esri.rest-api.RendererJson.ClassBreakInfoJson": {
|
|
8651
|
+
"additionalProperties": false,
|
|
8652
|
+
"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/}.",
|
|
8653
|
+
"properties": {
|
|
8654
|
+
"classMaxValue": {
|
|
8655
|
+
"description": "A numeric value used to specify the maximum value for a break.",
|
|
8656
|
+
"type": "number"
|
|
8657
|
+
},
|
|
8658
|
+
"classMinValue": {
|
|
8659
|
+
"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.",
|
|
8660
|
+
"type": "number"
|
|
8661
|
+
},
|
|
8662
|
+
"description": {
|
|
8663
|
+
"description": "String value used to describe the drawn symbol.",
|
|
8664
|
+
"type": "string"
|
|
8665
|
+
},
|
|
8666
|
+
"label": {
|
|
8667
|
+
"description": "String value used to label the drawn symbol.",
|
|
8668
|
+
"type": "string"
|
|
8669
|
+
},
|
|
8670
|
+
"symbol": {
|
|
8671
|
+
"$ref": "#/definitions/esri.rest-api.SymbolJson.SymbolJson",
|
|
8672
|
+
"description": "An object used to display the value."
|
|
8673
|
+
}
|
|
8674
|
+
},
|
|
8675
|
+
"required": [
|
|
7581
8676
|
"classMaxValue",
|
|
7582
8677
|
"symbol"
|
|
7583
8678
|
],
|
|
@@ -10902,6 +11997,60 @@
|
|
|
10902
11997
|
],
|
|
10903
11998
|
"type": "object"
|
|
10904
11999
|
},
|
|
12000
|
+
"esri.rest-api.TableJson.TableJson": {
|
|
12001
|
+
"additionalProperties": false,
|
|
12002
|
+
"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/}.",
|
|
12003
|
+
"properties": {
|
|
12004
|
+
"capabilities": {
|
|
12005
|
+
"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'.",
|
|
12006
|
+
"enum": [
|
|
12007
|
+
"Create",
|
|
12008
|
+
"Delete",
|
|
12009
|
+
"Editing",
|
|
12010
|
+
"Query",
|
|
12011
|
+
"Update"
|
|
12012
|
+
],
|
|
12013
|
+
"type": "string"
|
|
12014
|
+
},
|
|
12015
|
+
"definitionEditor": {
|
|
12016
|
+
"$ref": "#/definitions/esri.rest-api.DefinitionEditorJson.DefinitionEditorJson",
|
|
12017
|
+
"description": "Object indicating the definitionEditor used as a layer's interactive filter."
|
|
12018
|
+
},
|
|
12019
|
+
"formInfo": {
|
|
12020
|
+
"$ref": "#/definitions/esri.rest-api.FormInfoJson.FormInfoJson",
|
|
12021
|
+
"description": "A formInfo object defining the content of the form when you are editing a record."
|
|
12022
|
+
},
|
|
12023
|
+
"id": {
|
|
12024
|
+
"description": "Unique string identifier for the table.",
|
|
12025
|
+
"type": "string"
|
|
12026
|
+
},
|
|
12027
|
+
"itemId": {
|
|
12028
|
+
"description": "Unique string value indicating an item registered in ArcGIS Online or your organization's portal.",
|
|
12029
|
+
"type": "string"
|
|
12030
|
+
},
|
|
12031
|
+
"layerDefinition": {
|
|
12032
|
+
"$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
|
|
12033
|
+
"description": "A layerDefinition object defining the attribute schema and drawing information for the layer. Used with CSV layers."
|
|
12034
|
+
},
|
|
12035
|
+
"popupInfo": {
|
|
12036
|
+
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson",
|
|
12037
|
+
"description": "An object defining the content of popup windows when you query a record and the sort option for child related records."
|
|
12038
|
+
},
|
|
12039
|
+
"refreshInterval": {
|
|
12040
|
+
"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.",
|
|
12041
|
+
"type": "number"
|
|
12042
|
+
},
|
|
12043
|
+
"title": {
|
|
12044
|
+
"description": "String value for the title of the table.",
|
|
12045
|
+
"type": "string"
|
|
12046
|
+
},
|
|
12047
|
+
"url": {
|
|
12048
|
+
"description": "String value indicating the URL reference of the hosted table.",
|
|
12049
|
+
"type": "string"
|
|
12050
|
+
}
|
|
12051
|
+
},
|
|
12052
|
+
"type": "object"
|
|
12053
|
+
},
|
|
10905
12054
|
"esri.rest-api.TemplateJson.TemplateJson": {
|
|
10906
12055
|
"additionalProperties": false,
|
|
10907
12056
|
"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/}.",
|
|
@@ -10940,9 +12089,9 @@
|
|
|
10940
12089
|
},
|
|
10941
12090
|
"type": "object"
|
|
10942
12091
|
},
|
|
10943
|
-
"esri.rest-api.
|
|
12092
|
+
"esri.rest-api.TiledElevationServiceLayerJson.TiledElevationServiceLayerJson": {
|
|
10944
12093
|
"additionalProperties": false,
|
|
10945
|
-
"description": "
|
|
12094
|
+
"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/}.",
|
|
10946
12095
|
"properties": {
|
|
10947
12096
|
"blendMode": {
|
|
10948
12097
|
"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.",
|
|
@@ -10981,9 +12130,6 @@
|
|
|
10981
12130
|
],
|
|
10982
12131
|
"type": "string"
|
|
10983
12132
|
},
|
|
10984
|
-
"customParameters": {
|
|
10985
|
-
"description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
|
|
10986
|
-
},
|
|
10987
12133
|
"effect": {
|
|
10988
12134
|
"$ref": "#/definitions/EffectJson",
|
|
10989
12135
|
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
@@ -10996,12 +12142,12 @@
|
|
|
10996
12142
|
"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).",
|
|
10997
12143
|
"type": "boolean"
|
|
10998
12144
|
},
|
|
10999
|
-
"
|
|
11000
|
-
"
|
|
11001
|
-
"
|
|
12145
|
+
"itemId": {
|
|
12146
|
+
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
12147
|
+
"type": "string"
|
|
11002
12148
|
},
|
|
11003
12149
|
"layerType": {
|
|
11004
|
-
"const": "
|
|
12150
|
+
"const": "ArcGISTiledElevationServiceLayer",
|
|
11005
12151
|
"description": "The type of layer.",
|
|
11006
12152
|
"type": "string"
|
|
11007
12153
|
},
|
|
@@ -11026,6 +12172,10 @@
|
|
|
11026
12172
|
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
11027
12173
|
"type": "number"
|
|
11028
12174
|
},
|
|
12175
|
+
"path": {
|
|
12176
|
+
"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`.",
|
|
12177
|
+
"type": "string"
|
|
12178
|
+
},
|
|
11029
12179
|
"refreshInterval": {
|
|
11030
12180
|
"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}.",
|
|
11031
12181
|
"type": "number"
|
|
@@ -11053,7 +12203,7 @@
|
|
|
11053
12203
|
"type": "string"
|
|
11054
12204
|
},
|
|
11055
12205
|
"url": {
|
|
11056
|
-
"description": "URL to the
|
|
12206
|
+
"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.",
|
|
11057
12207
|
"type": "string"
|
|
11058
12208
|
},
|
|
11059
12209
|
"visibility": {
|
|
@@ -11080,9 +12230,9 @@
|
|
|
11080
12230
|
],
|
|
11081
12231
|
"type": "object"
|
|
11082
12232
|
},
|
|
11083
|
-
"esri.rest-api.
|
|
12233
|
+
"esri.rest-api.TiledImageServiceLayerJson.TiledImageServiceLayerJson": {
|
|
11084
12234
|
"additionalProperties": false,
|
|
11085
|
-
"description": "An ArcGIS Tiled
|
|
12235
|
+
"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/}.",
|
|
11086
12236
|
"properties": {
|
|
11087
12237
|
"blendMode": {
|
|
11088
12238
|
"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.",
|
|
@@ -11124,21 +12274,10 @@
|
|
|
11124
12274
|
"customParameters": {
|
|
11125
12275
|
"description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
|
|
11126
12276
|
},
|
|
11127
|
-
"displayLevels": {
|
|
11128
|
-
"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.",
|
|
11129
|
-
"items": {
|
|
11130
|
-
"type": "number"
|
|
11131
|
-
},
|
|
11132
|
-
"type": "array"
|
|
11133
|
-
},
|
|
11134
12277
|
"effect": {
|
|
11135
12278
|
"$ref": "#/definitions/EffectJson",
|
|
11136
12279
|
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
11137
12280
|
},
|
|
11138
|
-
"exclusionAreas": {
|
|
11139
|
-
"$ref": "__type",
|
|
11140
|
-
"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/}."
|
|
11141
|
-
},
|
|
11142
12281
|
"id": {
|
|
11143
12282
|
"description": "A unique identifying string for the layer.",
|
|
11144
12283
|
"type": "string"
|
|
@@ -11147,22 +12286,15 @@
|
|
|
11147
12286
|
"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).",
|
|
11148
12287
|
"type": "boolean"
|
|
11149
12288
|
},
|
|
11150
|
-
"
|
|
11151
|
-
"
|
|
11152
|
-
"
|
|
12289
|
+
"layerDefinition": {
|
|
12290
|
+
"$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
|
|
12291
|
+
"description": "An object that defines the attribute schema and drawing information for a layer drawn using client-side graphics. See layerDefinition properties table."
|
|
11153
12292
|
},
|
|
11154
12293
|
"layerType": {
|
|
11155
|
-
"const": "
|
|
12294
|
+
"const": "ArcGISTiledImageServiceLayer",
|
|
11156
12295
|
"description": "The type of layer.",
|
|
11157
12296
|
"type": "string"
|
|
11158
12297
|
},
|
|
11159
|
-
"layers": {
|
|
11160
|
-
"description": "An array of layer objects defining the styling, geometry, and attribute information for the features.",
|
|
11161
|
-
"items": {
|
|
11162
|
-
"$ref": "#/definitions/esri.rest-api.SublayerJson.SublayerJson"
|
|
11163
|
-
},
|
|
11164
|
-
"type": "array"
|
|
11165
|
-
},
|
|
11166
12298
|
"listMode": {
|
|
11167
12299
|
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
11168
12300
|
"enum": [
|
|
@@ -11184,10 +12316,6 @@
|
|
|
11184
12316
|
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
11185
12317
|
"type": "number"
|
|
11186
12318
|
},
|
|
11187
|
-
"path": {
|
|
11188
|
-
"description": "The path to the supporting offline layer. Mobile only. Only valid in MMAP JSON.",
|
|
11189
|
-
"type": "string"
|
|
11190
|
-
},
|
|
11191
12319
|
"refreshInterval": {
|
|
11192
12320
|
"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}.",
|
|
11193
12321
|
"type": "number"
|
|
@@ -11215,7 +12343,7 @@
|
|
|
11215
12343
|
"type": "string"
|
|
11216
12344
|
},
|
|
11217
12345
|
"url": {
|
|
11218
|
-
"description": "URL to the ArcGIS Server
|
|
12346
|
+
"description": "URL to the ArcGIS Server Image Service.",
|
|
11219
12347
|
"type": "string"
|
|
11220
12348
|
},
|
|
11221
12349
|
"visibility": {
|
|
@@ -11242,37 +12370,9 @@
|
|
|
11242
12370
|
],
|
|
11243
12371
|
"type": "object"
|
|
11244
12372
|
},
|
|
11245
|
-
"esri.rest-api.
|
|
11246
|
-
"additionalProperties": false,
|
|
11247
|
-
"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/}.",
|
|
11248
|
-
"properties": {
|
|
11249
|
-
"domains": {
|
|
11250
|
-
"description": "A set of domain objects for each domain in the type."
|
|
11251
|
-
},
|
|
11252
|
-
"id": {
|
|
11253
|
-
"description": "A unique numerical ID for the type.",
|
|
11254
|
-
"type": [
|
|
11255
|
-
"string",
|
|
11256
|
-
"number"
|
|
11257
|
-
]
|
|
11258
|
-
},
|
|
11259
|
-
"name": {
|
|
11260
|
-
"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.",
|
|
11261
|
-
"type": "string"
|
|
11262
|
-
},
|
|
11263
|
-
"templates": {
|
|
11264
|
-
"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.",
|
|
11265
|
-
"items": {
|
|
11266
|
-
"$ref": "#/definitions/esri.rest-api.TemplateJson.TemplateJson"
|
|
11267
|
-
},
|
|
11268
|
-
"type": "array"
|
|
11269
|
-
}
|
|
11270
|
-
},
|
|
11271
|
-
"type": "object"
|
|
11272
|
-
},
|
|
11273
|
-
"esri.rest-api.VectorTileLayerJson.VectorTileLayerJson": {
|
|
12373
|
+
"esri.rest-api.TiledMapServiceLayerJson.TiledMapServiceLayerJson": {
|
|
11274
12374
|
"additionalProperties": false,
|
|
11275
|
-
"description": "
|
|
12375
|
+
"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/}.",
|
|
11276
12376
|
"properties": {
|
|
11277
12377
|
"blendMode": {
|
|
11278
12378
|
"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.",
|
|
@@ -11314,10 +12414,21 @@
|
|
|
11314
12414
|
"customParameters": {
|
|
11315
12415
|
"description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
|
|
11316
12416
|
},
|
|
12417
|
+
"displayLevels": {
|
|
12418
|
+
"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.",
|
|
12419
|
+
"items": {
|
|
12420
|
+
"type": "number"
|
|
12421
|
+
},
|
|
12422
|
+
"type": "array"
|
|
12423
|
+
},
|
|
11317
12424
|
"effect": {
|
|
11318
12425
|
"$ref": "#/definitions/EffectJson",
|
|
11319
12426
|
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
11320
12427
|
},
|
|
12428
|
+
"exclusionAreas": {
|
|
12429
|
+
"$ref": "__type",
|
|
12430
|
+
"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/}."
|
|
12431
|
+
},
|
|
11321
12432
|
"id": {
|
|
11322
12433
|
"description": "A unique identifying string for the layer.",
|
|
11323
12434
|
"type": "string"
|
|
@@ -11331,10 +12442,17 @@
|
|
|
11331
12442
|
"type": "string"
|
|
11332
12443
|
},
|
|
11333
12444
|
"layerType": {
|
|
11334
|
-
"const": "
|
|
12445
|
+
"const": "ArcGISTiledMapServiceLayer",
|
|
11335
12446
|
"description": "The type of layer.",
|
|
11336
12447
|
"type": "string"
|
|
11337
12448
|
},
|
|
12449
|
+
"layers": {
|
|
12450
|
+
"description": "An array of layer objects defining the styling, geometry, and attribute information for the features.",
|
|
12451
|
+
"items": {
|
|
12452
|
+
"$ref": "#/definitions/esri.rest-api.SublayerJson.SublayerJson"
|
|
12453
|
+
},
|
|
12454
|
+
"type": "array"
|
|
12455
|
+
},
|
|
11338
12456
|
"listMode": {
|
|
11339
12457
|
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
11340
12458
|
"enum": [
|
|
@@ -11368,10 +12486,6 @@
|
|
|
11368
12486
|
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
11369
12487
|
"type": "boolean"
|
|
11370
12488
|
},
|
|
11371
|
-
"styleUrl": {
|
|
11372
|
-
"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.",
|
|
11373
|
-
"type": "string"
|
|
11374
|
-
},
|
|
11375
12489
|
"title": {
|
|
11376
12490
|
"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.",
|
|
11377
12491
|
"type": "string"
|
|
@@ -11390,6 +12504,10 @@
|
|
|
11390
12504
|
],
|
|
11391
12505
|
"type": "string"
|
|
11392
12506
|
},
|
|
12507
|
+
"url": {
|
|
12508
|
+
"description": "URL to the ArcGIS Server tiled Map Service.",
|
|
12509
|
+
"type": "string"
|
|
12510
|
+
},
|
|
11393
12511
|
"visibility": {
|
|
11394
12512
|
"description": "Determines whether the layer is initially visible in the web map.",
|
|
11395
12513
|
"type": "boolean"
|
|
@@ -11414,13 +12532,230 @@
|
|
|
11414
12532
|
],
|
|
11415
12533
|
"type": "object"
|
|
11416
12534
|
},
|
|
11417
|
-
"esri.rest-api.
|
|
12535
|
+
"esri.rest-api.TypeJson.TypeJson": {
|
|
11418
12536
|
"additionalProperties": false,
|
|
11419
|
-
"description": "
|
|
12537
|
+
"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/}.",
|
|
11420
12538
|
"properties": {
|
|
11421
|
-
"
|
|
11422
|
-
"description": "A
|
|
11423
|
-
},
|
|
12539
|
+
"domains": {
|
|
12540
|
+
"description": "A set of domain objects for each domain in the type."
|
|
12541
|
+
},
|
|
12542
|
+
"id": {
|
|
12543
|
+
"description": "A unique numerical ID for the type.",
|
|
12544
|
+
"type": [
|
|
12545
|
+
"string",
|
|
12546
|
+
"number"
|
|
12547
|
+
]
|
|
12548
|
+
},
|
|
12549
|
+
"name": {
|
|
12550
|
+
"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.",
|
|
12551
|
+
"type": "string"
|
|
12552
|
+
},
|
|
12553
|
+
"templates": {
|
|
12554
|
+
"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.",
|
|
12555
|
+
"items": {
|
|
12556
|
+
"$ref": "#/definitions/esri.rest-api.TemplateJson.TemplateJson"
|
|
12557
|
+
},
|
|
12558
|
+
"type": "array"
|
|
12559
|
+
}
|
|
12560
|
+
},
|
|
12561
|
+
"type": "object"
|
|
12562
|
+
},
|
|
12563
|
+
"esri.rest-api.VectorTileLayerJson.VectorTileLayerJson": {
|
|
12564
|
+
"additionalProperties": false,
|
|
12565
|
+
"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/}.",
|
|
12566
|
+
"properties": {
|
|
12567
|
+
"blendMode": {
|
|
12568
|
+
"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.",
|
|
12569
|
+
"enum": [
|
|
12570
|
+
"average",
|
|
12571
|
+
"color",
|
|
12572
|
+
"color-burn",
|
|
12573
|
+
"color-dodge",
|
|
12574
|
+
"darken",
|
|
12575
|
+
"destination-atop",
|
|
12576
|
+
"destination-in",
|
|
12577
|
+
"destination-out",
|
|
12578
|
+
"destination-over",
|
|
12579
|
+
"difference",
|
|
12580
|
+
"exclusion",
|
|
12581
|
+
"hard-light",
|
|
12582
|
+
"hue",
|
|
12583
|
+
"invert",
|
|
12584
|
+
"lighten",
|
|
12585
|
+
"lighter",
|
|
12586
|
+
"luminosity",
|
|
12587
|
+
"minus",
|
|
12588
|
+
"multiply",
|
|
12589
|
+
"normal",
|
|
12590
|
+
"overlay",
|
|
12591
|
+
"plus",
|
|
12592
|
+
"reflect",
|
|
12593
|
+
"saturation",
|
|
12594
|
+
"screen",
|
|
12595
|
+
"soft-light",
|
|
12596
|
+
"source-atop",
|
|
12597
|
+
"source-in",
|
|
12598
|
+
"source-out",
|
|
12599
|
+
"vivid-light",
|
|
12600
|
+
"xor"
|
|
12601
|
+
],
|
|
12602
|
+
"type": "string"
|
|
12603
|
+
},
|
|
12604
|
+
"customParameters": {
|
|
12605
|
+
"description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
|
|
12606
|
+
},
|
|
12607
|
+
"effect": {
|
|
12608
|
+
"$ref": "#/definitions/EffectJson",
|
|
12609
|
+
"description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
|
|
12610
|
+
},
|
|
12611
|
+
"id": {
|
|
12612
|
+
"description": "A unique identifying string for the layer.",
|
|
12613
|
+
"type": "string"
|
|
12614
|
+
},
|
|
12615
|
+
"isReference": {
|
|
12616
|
+
"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).",
|
|
12617
|
+
"type": "boolean"
|
|
12618
|
+
},
|
|
12619
|
+
"itemId": {
|
|
12620
|
+
"description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
|
|
12621
|
+
"type": "string"
|
|
12622
|
+
},
|
|
12623
|
+
"layerType": {
|
|
12624
|
+
"const": "VectorTileLayer",
|
|
12625
|
+
"description": "The type of layer.",
|
|
12626
|
+
"type": "string"
|
|
12627
|
+
},
|
|
12628
|
+
"listMode": {
|
|
12629
|
+
"description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}.",
|
|
12630
|
+
"enum": [
|
|
12631
|
+
"hide",
|
|
12632
|
+
"hide-children",
|
|
12633
|
+
"show"
|
|
12634
|
+
],
|
|
12635
|
+
"type": "string"
|
|
12636
|
+
},
|
|
12637
|
+
"maxScale": {
|
|
12638
|
+
"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.",
|
|
12639
|
+
"type": "number"
|
|
12640
|
+
},
|
|
12641
|
+
"minScale": {
|
|
12642
|
+
"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.",
|
|
12643
|
+
"type": "number"
|
|
12644
|
+
},
|
|
12645
|
+
"opacity": {
|
|
12646
|
+
"description": "The degree of transparency applied to the layer on the client side, where\n0 is full transparency and 1 is no transparency.",
|
|
12647
|
+
"type": "number"
|
|
12648
|
+
},
|
|
12649
|
+
"path": {
|
|
12650
|
+
"description": "The path to the supporting offline layer. Mobile only. Only valid in MMAP JSON.",
|
|
12651
|
+
"type": "string"
|
|
12652
|
+
},
|
|
12653
|
+
"refreshInterval": {
|
|
12654
|
+
"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}.",
|
|
12655
|
+
"type": "number"
|
|
12656
|
+
},
|
|
12657
|
+
"showLegend": {
|
|
12658
|
+
"description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
|
|
12659
|
+
"type": "boolean"
|
|
12660
|
+
},
|
|
12661
|
+
"styleUrl": {
|
|
12662
|
+
"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.",
|
|
12663
|
+
"type": "string"
|
|
12664
|
+
},
|
|
12665
|
+
"title": {
|
|
12666
|
+
"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.",
|
|
12667
|
+
"type": "string"
|
|
12668
|
+
},
|
|
12669
|
+
"type": {
|
|
12670
|
+
"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.",
|
|
12671
|
+
"enum": [
|
|
12672
|
+
"BingMapsAerial",
|
|
12673
|
+
"BingMapsHybrid",
|
|
12674
|
+
"BingMapsRoad",
|
|
12675
|
+
"CSV",
|
|
12676
|
+
"KML",
|
|
12677
|
+
"OpenStreetMap",
|
|
12678
|
+
"WMS",
|
|
12679
|
+
"WebTiledLayer"
|
|
12680
|
+
],
|
|
12681
|
+
"type": "string"
|
|
12682
|
+
},
|
|
12683
|
+
"visibility": {
|
|
12684
|
+
"description": "Determines whether the layer is initially visible in the web map.",
|
|
12685
|
+
"type": "boolean"
|
|
12686
|
+
},
|
|
12687
|
+
"visibilityTimeExtent": {
|
|
12688
|
+
"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.",
|
|
12689
|
+
"items": [
|
|
12690
|
+
{
|
|
12691
|
+
"type": "number"
|
|
12692
|
+
},
|
|
12693
|
+
{
|
|
12694
|
+
"type": "number"
|
|
12695
|
+
}
|
|
12696
|
+
],
|
|
12697
|
+
"maxItems": 2,
|
|
12698
|
+
"minItems": 2,
|
|
12699
|
+
"type": "array"
|
|
12700
|
+
}
|
|
12701
|
+
},
|
|
12702
|
+
"required": [
|
|
12703
|
+
"layerType"
|
|
12704
|
+
],
|
|
12705
|
+
"type": "object"
|
|
12706
|
+
},
|
|
12707
|
+
"esri.rest-api.ViewpointJson.CameraJson": {
|
|
12708
|
+
"additionalProperties": false,
|
|
12709
|
+
"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/}.",
|
|
12710
|
+
"properties": {
|
|
12711
|
+
"heading": {
|
|
12712
|
+
"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.",
|
|
12713
|
+
"type": "number"
|
|
12714
|
+
},
|
|
12715
|
+
"position": {
|
|
12716
|
+
"$ref": "#/definitions/esri.rest-api.GeometryJson.PointJson",
|
|
12717
|
+
"description": "The position of the camera defined by a map point."
|
|
12718
|
+
},
|
|
12719
|
+
"tilt": {
|
|
12720
|
+
"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.",
|
|
12721
|
+
"type": "number"
|
|
12722
|
+
}
|
|
12723
|
+
},
|
|
12724
|
+
"required": [
|
|
12725
|
+
"position"
|
|
12726
|
+
],
|
|
12727
|
+
"type": "object"
|
|
12728
|
+
},
|
|
12729
|
+
"esri.rest-api.ViewpointJson.ViewpointJson": {
|
|
12730
|
+
"additionalProperties": false,
|
|
12731
|
+
"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/}.",
|
|
12732
|
+
"properties": {
|
|
12733
|
+
"camera": {
|
|
12734
|
+
"$ref": "#/definitions/esri.rest-api.ViewpointJson.CameraJson",
|
|
12735
|
+
"description": "The camera defines the position, tilt, and heading of the point from which the SceneView's visible extent is observed."
|
|
12736
|
+
},
|
|
12737
|
+
"rotation": {
|
|
12738
|
+
"description": "The rotation of due north in relation to the top of the view in degrees.",
|
|
12739
|
+
"type": "number"
|
|
12740
|
+
},
|
|
12741
|
+
"scale": {
|
|
12742
|
+
"description": "The scale of the viewpoint.",
|
|
12743
|
+
"type": "number"
|
|
12744
|
+
},
|
|
12745
|
+
"targetGeometry": {
|
|
12746
|
+
"$ref": "#/definitions/GeometryJson",
|
|
12747
|
+
"description": "The target geometry framed by the viewpoint."
|
|
12748
|
+
}
|
|
12749
|
+
},
|
|
12750
|
+
"type": "object"
|
|
12751
|
+
},
|
|
12752
|
+
"esri.rest-api.WFSLayerJson.WFSInfoJson": {
|
|
12753
|
+
"additionalProperties": false,
|
|
12754
|
+
"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/}.",
|
|
12755
|
+
"properties": {
|
|
12756
|
+
"customParameters": {
|
|
12757
|
+
"description": "A sequence of parameters used to append custom parameters to all WFS requests. These parameters are applied to GetCapabilities, DescribeFeatureType, and GetFeatures."
|
|
12758
|
+
},
|
|
11424
12759
|
"featureUrl": {
|
|
11425
12760
|
"description": "URL of the WFS service operation.",
|
|
11426
12761
|
"type": "string"
|
|
@@ -11857,6 +13192,664 @@
|
|
|
11857
13192
|
},
|
|
11858
13193
|
"type": "object"
|
|
11859
13194
|
},
|
|
13195
|
+
"esri.rest-api.WebMapJson.ApplicationPropertiesJson": {
|
|
13196
|
+
"additionalProperties": false,
|
|
13197
|
+
"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/}.",
|
|
13198
|
+
"properties": {
|
|
13199
|
+
"editing": {
|
|
13200
|
+
"$ref": "__type",
|
|
13201
|
+
"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/}."
|
|
13202
|
+
},
|
|
13203
|
+
"offline": {
|
|
13204
|
+
"$ref": "__type",
|
|
13205
|
+
"description": "Use if working with offline maps. See {@link https://developers.arcgis.com/web-map-specification/objects/offline/}."
|
|
13206
|
+
},
|
|
13207
|
+
"viewing": {
|
|
13208
|
+
"$ref": "__type",
|
|
13209
|
+
"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/}."
|
|
13210
|
+
}
|
|
13211
|
+
},
|
|
13212
|
+
"type": "object"
|
|
13213
|
+
},
|
|
13214
|
+
"esri.rest-api.WebMapJson.BookmarkJson": {
|
|
13215
|
+
"additionalProperties": false,
|
|
13216
|
+
"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/}.",
|
|
13217
|
+
"properties": {
|
|
13218
|
+
"extent": {
|
|
13219
|
+
"$ref": "#/definitions/esri.rest-api.GeometryJson.ExtentJson"
|
|
13220
|
+
},
|
|
13221
|
+
"name": {
|
|
13222
|
+
"description": "A string name for the bookmark.",
|
|
13223
|
+
"type": "string"
|
|
13224
|
+
},
|
|
13225
|
+
"thumbnail": {
|
|
13226
|
+
"$ref": "__type",
|
|
13227
|
+
"description": "Object containing a thumbnail image."
|
|
13228
|
+
},
|
|
13229
|
+
"viewpoint": {
|
|
13230
|
+
"$ref": "#/definitions/esri.rest-api.ViewpointJson.ViewpointJson",
|
|
13231
|
+
"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."
|
|
13232
|
+
}
|
|
13233
|
+
},
|
|
13234
|
+
"required": [
|
|
13235
|
+
"name"
|
|
13236
|
+
],
|
|
13237
|
+
"type": "object"
|
|
13238
|
+
},
|
|
13239
|
+
"esri.rest-api.WebMapJson.FacilityLayerInfoJson": {
|
|
13240
|
+
"additionalProperties": false,
|
|
13241
|
+
"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/}.",
|
|
13242
|
+
"properties": {
|
|
13243
|
+
"facilityIdField": {
|
|
13244
|
+
"description": "The name of the attribute field that contains a facility feature's unique identifier.",
|
|
13245
|
+
"type": "string"
|
|
13246
|
+
},
|
|
13247
|
+
"layerId": {
|
|
13248
|
+
"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.",
|
|
13249
|
+
"type": "string"
|
|
13250
|
+
},
|
|
13251
|
+
"nameField": {
|
|
13252
|
+
"description": "The name of the attribute field that contains a facility feature's name.",
|
|
13253
|
+
"type": "string"
|
|
13254
|
+
},
|
|
13255
|
+
"siteIdField": {
|
|
13256
|
+
"description": "The name of the attribute field that contains a facility feature's site identifier (a foreign key to the Site layer).",
|
|
13257
|
+
"type": "string"
|
|
13258
|
+
}
|
|
13259
|
+
},
|
|
13260
|
+
"type": "object"
|
|
13261
|
+
},
|
|
13262
|
+
"esri.rest-api.WebMapJson.FloorFilterJson": {
|
|
13263
|
+
"additionalProperties": false,
|
|
13264
|
+
"description": "Configurable properties used by the floor filter widget. See {@link https://developers.arcgis.com/web-map-specification/objects/floorFilter/}.",
|
|
13265
|
+
"properties": {
|
|
13266
|
+
"enabled": {
|
|
13267
|
+
"description": "Indicates whether the floor filter is actively filtering the displayed content according to the floor filter selection.",
|
|
13268
|
+
"type": "boolean"
|
|
13269
|
+
},
|
|
13270
|
+
"facility": {
|
|
13271
|
+
"description": "Contains a facility identifier for the initially selected facility in the floor filter.",
|
|
13272
|
+
"type": "string"
|
|
13273
|
+
},
|
|
13274
|
+
"level": {
|
|
13275
|
+
"description": "Contains a level identifier for the initially selected floor, which is used when filtering floor-aware layers.",
|
|
13276
|
+
"type": "string"
|
|
13277
|
+
},
|
|
13278
|
+
"longNames": {
|
|
13279
|
+
"description": "Indicates whether the floor filter is showing long names instead of short names for floor levels.",
|
|
13280
|
+
"type": "boolean"
|
|
13281
|
+
},
|
|
13282
|
+
"minimized": {
|
|
13283
|
+
"description": "Indicates whether the floor filter has been minimized to show only the levels list instead of showing the full set of breadcrumbs.",
|
|
13284
|
+
"type": "boolean"
|
|
13285
|
+
},
|
|
13286
|
+
"pinnedLevels": {
|
|
13287
|
+
"description": "Indicates whether the floor filter has been pinned to show the floor levels list, instead of including the levels as a breadcrumb dropdown.",
|
|
13288
|
+
"type": "boolean"
|
|
13289
|
+
},
|
|
13290
|
+
"siteIdentifier": {
|
|
13291
|
+
"description": "Contains a site identifier for the initially selected site in the floor filter.",
|
|
13292
|
+
"type": "string"
|
|
13293
|
+
}
|
|
13294
|
+
},
|
|
13295
|
+
"type": "object"
|
|
13296
|
+
},
|
|
13297
|
+
"esri.rest-api.WebMapJson.InitialStateJson": {
|
|
13298
|
+
"additionalProperties": false,
|
|
13299
|
+
"description": "Defines the initial state when opening web scene.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/initialState/}.",
|
|
13300
|
+
"properties": {
|
|
13301
|
+
"environment": {
|
|
13302
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.EnvironmentJson",
|
|
13303
|
+
"description": "The initial environment settings of the WebScene."
|
|
13304
|
+
},
|
|
13305
|
+
"viewpoint": {
|
|
13306
|
+
"$ref": "#/definitions/esri.rest-api.ViewpointJson.ViewpointJson",
|
|
13307
|
+
"description": "Describes a point of view for a 2D or 3D view. In a 3D view, it is determined using a camera position."
|
|
13308
|
+
}
|
|
13309
|
+
},
|
|
13310
|
+
"required": [
|
|
13311
|
+
"viewpoint"
|
|
13312
|
+
],
|
|
13313
|
+
"type": "object"
|
|
13314
|
+
},
|
|
13315
|
+
"esri.rest-api.WebMapJson.LevelLayerInfoJson": {
|
|
13316
|
+
"additionalProperties": false,
|
|
13317
|
+
"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/}.",
|
|
13318
|
+
"properties": {
|
|
13319
|
+
"facilityIdField": {
|
|
13320
|
+
"description": "The name of the attribute field that contains a level feature's facility identifier (a foreign key to the Facility layer).",
|
|
13321
|
+
"type": "string"
|
|
13322
|
+
},
|
|
13323
|
+
"layerId": {
|
|
13324
|
+
"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.",
|
|
13325
|
+
"type": "string"
|
|
13326
|
+
},
|
|
13327
|
+
"levelIdField": {
|
|
13328
|
+
"description": "The name of the attribute field that contains a level feature's unique identifier.",
|
|
13329
|
+
"type": "string"
|
|
13330
|
+
},
|
|
13331
|
+
"levelNumberField": {
|
|
13332
|
+
"description": "The name of the attribute field that contains a level feature's level number specific to its facility.",
|
|
13333
|
+
"type": "string"
|
|
13334
|
+
},
|
|
13335
|
+
"longNameField": {
|
|
13336
|
+
"description": "The name of the attribute field that contains a level feature's long name.",
|
|
13337
|
+
"type": "string"
|
|
13338
|
+
},
|
|
13339
|
+
"shortNameField": {
|
|
13340
|
+
"description": "The name of the attribute field that contains a level feature's short name.",
|
|
13341
|
+
"type": "string"
|
|
13342
|
+
},
|
|
13343
|
+
"verticalOrderField": {
|
|
13344
|
+
"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.",
|
|
13345
|
+
"type": "string"
|
|
13346
|
+
}
|
|
13347
|
+
},
|
|
13348
|
+
"type": "object"
|
|
13349
|
+
},
|
|
13350
|
+
"esri.rest-api.WebMapJson.MapFloorInfoJson": {
|
|
13351
|
+
"additionalProperties": false,
|
|
13352
|
+
"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/}.",
|
|
13353
|
+
"properties": {
|
|
13354
|
+
"facilityLayer": {
|
|
13355
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.FacilityLayerInfoJson",
|
|
13356
|
+
"description": "Defines the layer and field properties for the Facility layer used for floor filtering."
|
|
13357
|
+
},
|
|
13358
|
+
"levelLayer": {
|
|
13359
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.LevelLayerInfoJson",
|
|
13360
|
+
"description": "Defines the layer and field properties for the Level layer used for floor filtering."
|
|
13361
|
+
},
|
|
13362
|
+
"siteLayer": {
|
|
13363
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.SiteLayerInfoJson",
|
|
13364
|
+
"description": "Defines the layer and field properties for the Site layer used for floor filtering. This property is optional."
|
|
13365
|
+
}
|
|
13366
|
+
},
|
|
13367
|
+
"type": "object"
|
|
13368
|
+
},
|
|
13369
|
+
"esri.rest-api.WebMapJson.MapRangeInfoJson": {
|
|
13370
|
+
"additionalProperties": false,
|
|
13371
|
+
"description": "Map Range Information.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/mapRangeInfo/}.",
|
|
13372
|
+
"properties": {
|
|
13373
|
+
"activeRangeName": {
|
|
13374
|
+
"description": "Active range ID that slider/picker acts upon.",
|
|
13375
|
+
"type": "string"
|
|
13376
|
+
},
|
|
13377
|
+
"currentRangeExtent": {
|
|
13378
|
+
"description": "Current range for the active range.",
|
|
13379
|
+
"items": [
|
|
13380
|
+
{
|
|
13381
|
+
"type": "number"
|
|
13382
|
+
},
|
|
13383
|
+
{
|
|
13384
|
+
"type": "number"
|
|
13385
|
+
}
|
|
13386
|
+
],
|
|
13387
|
+
"maxItems": 2,
|
|
13388
|
+
"minItems": 2,
|
|
13389
|
+
"type": "array"
|
|
13390
|
+
},
|
|
13391
|
+
"fullRangeExtent": {
|
|
13392
|
+
"description": "Full range extent for the active range to be presented in the UI.",
|
|
13393
|
+
"items": [
|
|
13394
|
+
{
|
|
13395
|
+
"type": "number"
|
|
13396
|
+
},
|
|
13397
|
+
{
|
|
13398
|
+
"type": "number"
|
|
13399
|
+
}
|
|
13400
|
+
],
|
|
13401
|
+
"maxItems": 2,
|
|
13402
|
+
"minItems": 2,
|
|
13403
|
+
"type": "array"
|
|
13404
|
+
}
|
|
13405
|
+
},
|
|
13406
|
+
"type": "object"
|
|
13407
|
+
},
|
|
13408
|
+
"esri.rest-api.WebMapJson.PresentationJson": {
|
|
13409
|
+
"additionalProperties": false,
|
|
13410
|
+
"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/}.",
|
|
13411
|
+
"properties": {
|
|
13412
|
+
"displayTimeSlider": {
|
|
13413
|
+
"description": "Indicates whether to display the time slider (if accessible). [WebMap only].",
|
|
13414
|
+
"type": "boolean"
|
|
13415
|
+
},
|
|
13416
|
+
"showLegend": {
|
|
13417
|
+
"description": "Indicates whether to display a legend on all slides. [WebMap only].",
|
|
13418
|
+
"type": "boolean"
|
|
13419
|
+
},
|
|
13420
|
+
"slideAdvancementInterval": {
|
|
13421
|
+
"description": "Number of seconds to show slide before proceeding to the next slide. [WebMap only].",
|
|
13422
|
+
"type": "number"
|
|
13423
|
+
},
|
|
13424
|
+
"slides": {
|
|
13425
|
+
"description": "An array of slides that bookmark viewpoints, visible layers, and other settings previously defined in a WebScene.",
|
|
13426
|
+
"items": {
|
|
13427
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.SlideJson"
|
|
13428
|
+
},
|
|
13429
|
+
"type": "array"
|
|
13430
|
+
},
|
|
13431
|
+
"useTimeExtentOfSlide": {
|
|
13432
|
+
"description": "Indicates whether to use the time extent (if applicable) of a slide. [WebMap only].",
|
|
13433
|
+
"type": "boolean"
|
|
13434
|
+
}
|
|
13435
|
+
},
|
|
13436
|
+
"type": "object"
|
|
13437
|
+
},
|
|
13438
|
+
"esri.rest-api.WebMapJson.RangeJson": {
|
|
13439
|
+
"additionalProperties": false,
|
|
13440
|
+
"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/}.",
|
|
13441
|
+
"properties": {
|
|
13442
|
+
"interactionMode": {
|
|
13443
|
+
"description": "Indicates the mode in which the active range should be presented to the user. Must be one of the following values: slider, picker.",
|
|
13444
|
+
"type": "string"
|
|
13445
|
+
},
|
|
13446
|
+
"numberOfStops": {
|
|
13447
|
+
"description": "This is used to generate the activeRangeValues if activeRangeValues are not specified.",
|
|
13448
|
+
"type": "number"
|
|
13449
|
+
},
|
|
13450
|
+
"stopInterval": {
|
|
13451
|
+
"description": "Interval in which stops should be generated.",
|
|
13452
|
+
"type": "number"
|
|
13453
|
+
}
|
|
13454
|
+
},
|
|
13455
|
+
"type": "object"
|
|
13456
|
+
},
|
|
13457
|
+
"esri.rest-api.WebMapJson.SiteLayerInfoJson": {
|
|
13458
|
+
"additionalProperties": false,
|
|
13459
|
+
"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/}.",
|
|
13460
|
+
"properties": {
|
|
13461
|
+
"layerId": {
|
|
13462
|
+
"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.",
|
|
13463
|
+
"type": "string"
|
|
13464
|
+
},
|
|
13465
|
+
"nameField": {
|
|
13466
|
+
"description": "The name of the attribute field that contains a site feature's name.",
|
|
13467
|
+
"type": "string"
|
|
13468
|
+
},
|
|
13469
|
+
"siteIdField": {
|
|
13470
|
+
"description": "The name of the attribute field that contains a site feature's unique identifier.",
|
|
13471
|
+
"type": "string"
|
|
13472
|
+
}
|
|
13473
|
+
},
|
|
13474
|
+
"type": "object"
|
|
13475
|
+
},
|
|
13476
|
+
"esri.rest-api.WebMapJson.SlideJson": {
|
|
13477
|
+
"additionalProperties": false,
|
|
13478
|
+
"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/}.",
|
|
13479
|
+
"properties": {
|
|
13480
|
+
"baseMap": {
|
|
13481
|
+
"anyOf": [
|
|
13482
|
+
{
|
|
13483
|
+
"$ref": "#/definitions/esri.rest-api.BasemapJson.BasemapJson"
|
|
13484
|
+
},
|
|
13485
|
+
{
|
|
13486
|
+
"type": "string"
|
|
13487
|
+
}
|
|
13488
|
+
],
|
|
13489
|
+
"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."
|
|
13490
|
+
},
|
|
13491
|
+
"description": {
|
|
13492
|
+
"$ref": "__type",
|
|
13493
|
+
"description": "Text description of the individual presentation slide."
|
|
13494
|
+
},
|
|
13495
|
+
"environment": {
|
|
13496
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.EnvironmentJson",
|
|
13497
|
+
"description": "Represents settings that affect the environment in which the WebScene is displayed (such as lighting)."
|
|
13498
|
+
},
|
|
13499
|
+
"extent": {
|
|
13500
|
+
"$ref": "#/definitions/esri.rest-api.GeometryJson.ExtentJson",
|
|
13501
|
+
"description": "The standard Esri extent object with spatialReference, xmax, xmin, ymax and ymin. [WebMap Only]."
|
|
13502
|
+
},
|
|
13503
|
+
"hidden": {
|
|
13504
|
+
"description": "Indicates whether the slide should be hidden within the presentation. [WebMap Only].",
|
|
13505
|
+
"type": "boolean"
|
|
13506
|
+
},
|
|
13507
|
+
"id": {
|
|
13508
|
+
"description": "The unique id of a slide within the slides property of a Presentation.",
|
|
13509
|
+
"type": "string"
|
|
13510
|
+
},
|
|
13511
|
+
"mapLocation": {
|
|
13512
|
+
"$ref": "__type",
|
|
13513
|
+
"description": "An object with a centerPoint object and sometimes a resolution. [WebMap Only] {@link https://developers.arcgis.com/web-map-specification/objects/mapLocation/}."
|
|
13514
|
+
},
|
|
13515
|
+
"thumbnail": {
|
|
13516
|
+
"$ref": "__type",
|
|
13517
|
+
"description": "A data URI encoded thumbnail. See {@link https://developers.arcgis.com/web-scene-specification/objects/thumbnail/}."
|
|
13518
|
+
},
|
|
13519
|
+
"timeExtent": {
|
|
13520
|
+
"description": "An array of two numbers. The first one indicates start time and the second one indicates end time. [WebMap Only].",
|
|
13521
|
+
"items": {
|
|
13522
|
+
"type": "number"
|
|
13523
|
+
},
|
|
13524
|
+
"type": "array"
|
|
13525
|
+
},
|
|
13526
|
+
"title": {
|
|
13527
|
+
"$ref": "__type",
|
|
13528
|
+
"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/}."
|
|
13529
|
+
},
|
|
13530
|
+
"viewpoint": {
|
|
13531
|
+
"$ref": "#/definitions/esri.rest-api.ViewpointJson.ViewpointJson",
|
|
13532
|
+
"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."
|
|
13533
|
+
},
|
|
13534
|
+
"visibleLayers": {
|
|
13535
|
+
"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/}.",
|
|
13536
|
+
"items": {
|
|
13537
|
+
"$ref": "__type"
|
|
13538
|
+
},
|
|
13539
|
+
"type": "array"
|
|
13540
|
+
},
|
|
13541
|
+
"visiblePopup": {
|
|
13542
|
+
"$ref": "__type",
|
|
13543
|
+
"description": "A presentation slide's visiblePopup which contains anchorPoint, featureId, layerId, and subLayerId. See {@link https://developers.arcgis.com/web-map-specification/objects/visiblePopup/}."
|
|
13544
|
+
}
|
|
13545
|
+
},
|
|
13546
|
+
"type": "object"
|
|
13547
|
+
},
|
|
13548
|
+
"esri.rest-api.WebMapJson.TimeSliderJson": {
|
|
13549
|
+
"additionalProperties": false,
|
|
13550
|
+
"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/}.",
|
|
13551
|
+
"properties": {
|
|
13552
|
+
"properties": {
|
|
13553
|
+
"$ref": "__type",
|
|
13554
|
+
"description": "Properties for the time slider."
|
|
13555
|
+
}
|
|
13556
|
+
},
|
|
13557
|
+
"required": [
|
|
13558
|
+
"properties"
|
|
13559
|
+
],
|
|
13560
|
+
"type": "object"
|
|
13561
|
+
},
|
|
13562
|
+
"esri.rest-api.WebMapJson.TraceConfigurationJson": {
|
|
13563
|
+
"additionalProperties": false,
|
|
13564
|
+
"description": "An array of pre-configured trace configurations for quickly running common traces. See {@link https://developers.arcgis.com/web-map-specification/objects/traceConfiguration/}.",
|
|
13565
|
+
"properties": {
|
|
13566
|
+
"id": {
|
|
13567
|
+
"description": "A unique identifying string for the trace configuration.",
|
|
13568
|
+
"type": "string"
|
|
13569
|
+
},
|
|
13570
|
+
"title": {
|
|
13571
|
+
"description": "A user-friendly string title for the trace configuration that can be used in a table of contents.",
|
|
13572
|
+
"type": "string"
|
|
13573
|
+
}
|
|
13574
|
+
},
|
|
13575
|
+
"type": "object"
|
|
13576
|
+
},
|
|
13577
|
+
"esri.rest-api.WebMapJson.UtilityNetworkJson": {
|
|
13578
|
+
"additionalProperties": false,
|
|
13579
|
+
"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/}.",
|
|
13580
|
+
"properties": {
|
|
13581
|
+
"id": {
|
|
13582
|
+
"description": "A unique identifying string for the utility network.",
|
|
13583
|
+
"type": "string"
|
|
13584
|
+
},
|
|
13585
|
+
"title": {
|
|
13586
|
+
"description": "A user-friendly string title for the utility network that can be used in a table of contents.",
|
|
13587
|
+
"type": "string"
|
|
13588
|
+
},
|
|
13589
|
+
"traceConfigurations": {
|
|
13590
|
+
"description": "An array of pre-configured trace configurations for quickly running common traces.",
|
|
13591
|
+
"items": {
|
|
13592
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.TraceConfigurationJson"
|
|
13593
|
+
},
|
|
13594
|
+
"type": "array"
|
|
13595
|
+
},
|
|
13596
|
+
"url": {
|
|
13597
|
+
"description": "A string value indicating the URL to the utility network layer.",
|
|
13598
|
+
"type": "string"
|
|
13599
|
+
}
|
|
13600
|
+
},
|
|
13601
|
+
"type": "object"
|
|
13602
|
+
},
|
|
13603
|
+
"esri.rest-api.WebMapJson.WebMapJson": {
|
|
13604
|
+
"additionalProperties": false,
|
|
13605
|
+
"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/}.",
|
|
13606
|
+
"properties": {
|
|
13607
|
+
"applicationProperties": {
|
|
13608
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.ApplicationPropertiesJson",
|
|
13609
|
+
"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."
|
|
13610
|
+
},
|
|
13611
|
+
"authoringApp": {
|
|
13612
|
+
"description": "String value indicating the application which authored the webmap.",
|
|
13613
|
+
"type": "string"
|
|
13614
|
+
},
|
|
13615
|
+
"authoringAppVersion": {
|
|
13616
|
+
"description": "String value indicating the authoring App's version number.",
|
|
13617
|
+
"type": "string"
|
|
13618
|
+
},
|
|
13619
|
+
"background": {
|
|
13620
|
+
"$ref": "#/definitions/esri.rest-api.EnvironmentJson.ColorBackgroundJson",
|
|
13621
|
+
"description": "The background."
|
|
13622
|
+
},
|
|
13623
|
+
"baseMap": {
|
|
13624
|
+
"$ref": "#/definitions/esri.rest-api.BasemapJson.BasemapJson",
|
|
13625
|
+
"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."
|
|
13626
|
+
},
|
|
13627
|
+
"bookmarks": {
|
|
13628
|
+
"description": "Bookmarks that are saved with the map.",
|
|
13629
|
+
"items": {
|
|
13630
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.BookmarkJson"
|
|
13631
|
+
},
|
|
13632
|
+
"type": "array"
|
|
13633
|
+
},
|
|
13634
|
+
"initialState": {
|
|
13635
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.InitialStateJson",
|
|
13636
|
+
"description": "The initial state at which to open the map."
|
|
13637
|
+
},
|
|
13638
|
+
"mapFloorInfo": {
|
|
13639
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.MapFloorInfoJson",
|
|
13640
|
+
"description": "Contains floor-awareness information for the map."
|
|
13641
|
+
},
|
|
13642
|
+
"mapRangeInfo": {
|
|
13643
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.MapRangeInfoJson",
|
|
13644
|
+
"description": "Map range information."
|
|
13645
|
+
},
|
|
13646
|
+
"operationalLayers": {
|
|
13647
|
+
"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/}.",
|
|
13648
|
+
"items": {
|
|
13649
|
+
"$ref": "#/definitions/OperationalLayerJson"
|
|
13650
|
+
},
|
|
13651
|
+
"type": "array"
|
|
13652
|
+
},
|
|
13653
|
+
"presentation": {
|
|
13654
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.PresentationJson",
|
|
13655
|
+
"description": "A presentation consists of multiple slides. Each slide has a different title, extent, basemap, layers etc."
|
|
13656
|
+
},
|
|
13657
|
+
"spatialReference": {
|
|
13658
|
+
"$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson",
|
|
13659
|
+
"description": "An object used to specify the spatial reference of the given geometry."
|
|
13660
|
+
},
|
|
13661
|
+
"tables": {
|
|
13662
|
+
"description": "Specify an array of table objects.",
|
|
13663
|
+
"items": {
|
|
13664
|
+
"$ref": "#/definitions/esri.rest-api.TableJson.TableJson"
|
|
13665
|
+
},
|
|
13666
|
+
"type": "array"
|
|
13667
|
+
},
|
|
13668
|
+
"timeZone": {
|
|
13669
|
+
"description": "TODO: Not yet documented in web map spec, but present in 2.29 web maps generated by Maps SDK 4.28.",
|
|
13670
|
+
"type": "string"
|
|
13671
|
+
},
|
|
13672
|
+
"utilityNetworks": {
|
|
13673
|
+
"description": "An array of utility network objects the map can use to access utility-related functionality, such as tracing and querying associations.",
|
|
13674
|
+
"items": {
|
|
13675
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.UtilityNetworkJson"
|
|
13676
|
+
},
|
|
13677
|
+
"type": "array"
|
|
13678
|
+
},
|
|
13679
|
+
"version": {
|
|
13680
|
+
"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/}.",
|
|
13681
|
+
"type": "string"
|
|
13682
|
+
},
|
|
13683
|
+
"widgets": {
|
|
13684
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.WidgetsJson",
|
|
13685
|
+
"description": "The widgets object contains widgets that should be exposed to the user."
|
|
13686
|
+
}
|
|
13687
|
+
},
|
|
13688
|
+
"required": [
|
|
13689
|
+
"baseMap",
|
|
13690
|
+
"spatialReference",
|
|
13691
|
+
"version"
|
|
13692
|
+
],
|
|
13693
|
+
"type": "object"
|
|
13694
|
+
},
|
|
13695
|
+
"esri.rest-api.WebMapJson.WidgetsJson": {
|
|
13696
|
+
"additionalProperties": false,
|
|
13697
|
+
"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/}.",
|
|
13698
|
+
"properties": {
|
|
13699
|
+
"floorFilter": {
|
|
13700
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.FloorFilterJson",
|
|
13701
|
+
"description": "Configurable properties used by the floor filter widget."
|
|
13702
|
+
},
|
|
13703
|
+
"range": {
|
|
13704
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.RangeJson",
|
|
13705
|
+
"description": "Active range."
|
|
13706
|
+
},
|
|
13707
|
+
"timeSlider": {
|
|
13708
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.TimeSliderJson",
|
|
13709
|
+
"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."
|
|
13710
|
+
}
|
|
13711
|
+
},
|
|
13712
|
+
"type": "object"
|
|
13713
|
+
},
|
|
13714
|
+
"esri.rest-api.WebSceneJson.HeightModelInfoJson": {
|
|
13715
|
+
"additionalProperties": false,
|
|
13716
|
+
"description": "An object that defines the characteristics of the vertical coordinate system used by the web scene.",
|
|
13717
|
+
"properties": {
|
|
13718
|
+
"heightModel": {
|
|
13719
|
+
"description": "The surface type or height model of the vertical coordinate system.",
|
|
13720
|
+
"enum": [
|
|
13721
|
+
"ellipsoidal",
|
|
13722
|
+
"gravity_related_height"
|
|
13723
|
+
],
|
|
13724
|
+
"type": "string"
|
|
13725
|
+
},
|
|
13726
|
+
"heightUnit": {
|
|
13727
|
+
"description": "The unit of the vertical coordinate system.",
|
|
13728
|
+
"enum": [
|
|
13729
|
+
"150-kilometers",
|
|
13730
|
+
"50-kilometers",
|
|
13731
|
+
"benoit-1895-b-chain",
|
|
13732
|
+
"clarke-foot",
|
|
13733
|
+
"clarke-link",
|
|
13734
|
+
"clarke-yard",
|
|
13735
|
+
"foot",
|
|
13736
|
+
"gold-coast-foot",
|
|
13737
|
+
"indian-1937-yard",
|
|
13738
|
+
"indian-yard",
|
|
13739
|
+
"meter",
|
|
13740
|
+
"sears-1922-truncated-chain",
|
|
13741
|
+
"sears-chain",
|
|
13742
|
+
"sears-foot",
|
|
13743
|
+
"sears-yard",
|
|
13744
|
+
"us-foot"
|
|
13745
|
+
],
|
|
13746
|
+
"type": "string"
|
|
13747
|
+
},
|
|
13748
|
+
"vertCRS": {
|
|
13749
|
+
"description": "The datum realization of the vertical coordinate system.",
|
|
13750
|
+
"type": "string"
|
|
13751
|
+
}
|
|
13752
|
+
},
|
|
13753
|
+
"required": [
|
|
13754
|
+
"heightModel",
|
|
13755
|
+
"heightUnit"
|
|
13756
|
+
],
|
|
13757
|
+
"type": "object"
|
|
13758
|
+
},
|
|
13759
|
+
"esri.rest-api.WebSceneJson.WebSceneJson": {
|
|
13760
|
+
"additionalProperties": false,
|
|
13761
|
+
"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/}.",
|
|
13762
|
+
"properties": {
|
|
13763
|
+
"applicationProperties": {
|
|
13764
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.ApplicationPropertiesJson",
|
|
13765
|
+
"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."
|
|
13766
|
+
},
|
|
13767
|
+
"authoringApp": {
|
|
13768
|
+
"description": "String value indicating the application which authored the webmap.",
|
|
13769
|
+
"type": "string"
|
|
13770
|
+
},
|
|
13771
|
+
"authoringAppVersion": {
|
|
13772
|
+
"description": "String value indicating the authoring App's version number.",
|
|
13773
|
+
"type": "string"
|
|
13774
|
+
},
|
|
13775
|
+
"baseMap": {
|
|
13776
|
+
"$ref": "#/definitions/esri.rest-api.BasemapJson.BasemapJson",
|
|
13777
|
+
"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."
|
|
13778
|
+
},
|
|
13779
|
+
"clippingArea": {
|
|
13780
|
+
"$ref": "__type",
|
|
13781
|
+
"description": "Defines are to be clipped for display. See {@link https://developers.arcgis.com/web-scene-specification/objects/clippingArea/}."
|
|
13782
|
+
},
|
|
13783
|
+
"ground": {
|
|
13784
|
+
"$ref": "#/definitions/esri.rest-api.GroundJson.GroundJson",
|
|
13785
|
+
"description": "Ground defines the main surface of the web scene, based on elevation layers."
|
|
13786
|
+
},
|
|
13787
|
+
"heightModelInfo": {
|
|
13788
|
+
"$ref": "#/definitions/esri.rest-api.WebSceneJson.HeightModelInfoJson",
|
|
13789
|
+
"description": "An object that defines the characteristics of the vertical coordinate system used by the web scene."
|
|
13790
|
+
},
|
|
13791
|
+
"initialState": {
|
|
13792
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.InitialStateJson",
|
|
13793
|
+
"description": "The initial state at which to open the map."
|
|
13794
|
+
},
|
|
13795
|
+
"mapFloorInfo": {
|
|
13796
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.MapFloorInfoJson",
|
|
13797
|
+
"description": "Contains floor-awareness information for the map."
|
|
13798
|
+
},
|
|
13799
|
+
"mapRangeInfo": {
|
|
13800
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.MapRangeInfoJson",
|
|
13801
|
+
"description": "Map range information."
|
|
13802
|
+
},
|
|
13803
|
+
"operationalLayers": {
|
|
13804
|
+
"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/}.",
|
|
13805
|
+
"items": {
|
|
13806
|
+
"$ref": "#/definitions/OperationalLayerJson"
|
|
13807
|
+
},
|
|
13808
|
+
"type": "array"
|
|
13809
|
+
},
|
|
13810
|
+
"presentation": {
|
|
13811
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.PresentationJson",
|
|
13812
|
+
"description": "A presentation consists of multiple slides. Each slide has a different title, extent, basemap, layers etc."
|
|
13813
|
+
},
|
|
13814
|
+
"spatialReference": {
|
|
13815
|
+
"$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson",
|
|
13816
|
+
"description": "An object used to specify the spatial reference of the given geometry."
|
|
13817
|
+
},
|
|
13818
|
+
"tables": {
|
|
13819
|
+
"description": "Specify an array of table objects.",
|
|
13820
|
+
"items": {
|
|
13821
|
+
"$ref": "#/definitions/esri.rest-api.TableJson.TableJson"
|
|
13822
|
+
},
|
|
13823
|
+
"type": "array"
|
|
13824
|
+
},
|
|
13825
|
+
"timeZone": {
|
|
13826
|
+
"description": "TODO: Not yet documented in web map spec, but present in 2.29 web maps generated by Maps SDK 4.28.",
|
|
13827
|
+
"type": "string"
|
|
13828
|
+
},
|
|
13829
|
+
"version": {
|
|
13830
|
+
"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/}.",
|
|
13831
|
+
"type": "string"
|
|
13832
|
+
},
|
|
13833
|
+
"viewingMode": {
|
|
13834
|
+
"description": "Must be one of the following values: \"global\" | \"local\".",
|
|
13835
|
+
"enum": [
|
|
13836
|
+
"global",
|
|
13837
|
+
"local"
|
|
13838
|
+
],
|
|
13839
|
+
"type": "string"
|
|
13840
|
+
},
|
|
13841
|
+
"widgets": {
|
|
13842
|
+
"$ref": "#/definitions/esri.rest-api.WebMapJson.WidgetsJson",
|
|
13843
|
+
"description": "The widgets object contains widgets that should be exposed to the user."
|
|
13844
|
+
}
|
|
13845
|
+
},
|
|
13846
|
+
"required": [
|
|
13847
|
+
"baseMap",
|
|
13848
|
+
"spatialReference",
|
|
13849
|
+
"version"
|
|
13850
|
+
],
|
|
13851
|
+
"type": "object"
|
|
13852
|
+
},
|
|
11860
13853
|
"esri.rest-api.WebTileLayerJson.TileInfoJson": {
|
|
11861
13854
|
"additionalProperties": false,
|
|
11862
13855
|
"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/}.",
|