@vertigis/viewer-spec 50.5.0 → 50.6.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.
Files changed (74) hide show
  1. package/README.md +1 -1
  2. package/analytics/AnalyticsContext.d.ts +2 -1
  3. package/analytics/CommonAction.d.ts +2 -1
  4. package/analytics/MobileAction.d.ts +6 -3
  5. package/app-config/AppConfig.d.ts +11 -8
  6. package/app-config/common/BrandingThemeProperties.d.ts +4 -2
  7. package/app-config/common/HighlightModelProperties.d.ts +4 -2
  8. package/app-config/common/LayerPresetsModelProperties.d.ts +2 -1
  9. package/app-config/common/LicensingModelProperties.d.ts +1 -1
  10. package/app-config/common/ResultsModelProperties.d.ts +2 -1
  11. package/app-config/common/TranslatableText.d.ts +2 -1
  12. package/app-config/common/WorkflowModelProperties.d.ts +4 -2
  13. package/app-config/mobile/FeatureDetailsModelProperties.d.ts +4 -2
  14. package/app-config/mobile/VertigisMobileModelProperties.d.ts +4 -3
  15. package/app-config/schema/common-app-config.schema.json +1 -1
  16. package/app-config/schema/mobile-app-config.schema.json +1 -1
  17. package/app-config/schema/web-app-config.schema.json +1 -1
  18. package/app-config/web/CoordinateModelProperties.d.ts +2 -1
  19. package/app-config/web/DrawModelProperties.d.ts +2 -1
  20. package/app-config/web/HasVisibilityFilters.d.ts +2 -1
  21. package/app-config/web/KpiCardModelProperties.d.ts +2 -1
  22. package/app-config/web/MapCoordinatesModelProperties.d.ts +2 -1
  23. package/app-config/web/MapModelProperties.d.ts +4 -2
  24. package/app-config/web/MeasurementModelProperties.d.ts +2 -1
  25. package/app-config/web/PortalModelProperties.d.ts +2 -1
  26. package/app-config/web/ResultsModelProperties.d.ts +4 -2
  27. package/app-config/web/SearchModelProperties.d.ts +2 -1
  28. package/app-config/web/VertigisWebModelProperties.d.ts +6 -3
  29. package/docs/Geocortex Apps.md +8 -8
  30. package/docs/layout-spec.md +105 -94
  31. package/layout/schema/layout-common.xsd +1 -1
  32. package/layout/schema/layout-web.xsd +1 -1
  33. package/messaging/Command.d.ts +4 -2
  34. package/messaging/Event.d.ts +4 -2
  35. package/messaging/Message.d.ts +2 -1
  36. package/messaging/Operation.d.ts +4 -2
  37. package/messaging/common.d.ts +12 -6
  38. package/messaging/registry/app.d.ts +12 -6
  39. package/messaging/registry/arcade.d.ts +6 -3
  40. package/messaging/registry/auth.d.ts +12 -7
  41. package/messaging/registry/basemap.d.ts +2 -1
  42. package/messaging/registry/drawing.d.ts +8 -4
  43. package/messaging/registry/edit.d.ts +6 -3
  44. package/messaging/registry/file.d.ts +2 -1
  45. package/messaging/registry/geocode.d.ts +8 -5
  46. package/messaging/registry/geolocation.d.ts +26 -11
  47. package/messaging/registry/geolocation.js +1 -1
  48. package/messaging/registry/geometry.d.ts +10 -5
  49. package/messaging/registry/kpi.d.ts +4 -2
  50. package/messaging/registry/layout.d.ts +2 -1
  51. package/messaging/registry/location-marker.d.ts +10 -5
  52. package/messaging/registry/map.d.ts +15 -8
  53. package/messaging/registry/measurement.d.ts +4 -2
  54. package/messaging/registry/messaging.d.ts +1 -1
  55. package/messaging/registry/offline.d.ts +16 -9
  56. package/messaging/registry/panel.d.ts +2 -1
  57. package/messaging/registry/portal.d.ts +8 -4
  58. package/messaging/registry/printing.d.ts +4 -2
  59. package/messaging/registry/results.d.ts +19 -10
  60. package/messaging/registry/settings.d.ts +4 -2
  61. package/messaging/registry/sketching.d.ts +38 -26
  62. package/messaging/registry/tasks.d.ts +7 -4
  63. package/messaging/registry/ui.d.ts +14 -7
  64. package/messaging/registry/viewer.d.ts +2 -1
  65. package/messaging/registry/workflow.d.ts +6 -3
  66. package/messaging/schema/common-action.schema.json +269 -236
  67. package/messaging/schema/common-event.schema.json +118 -122
  68. package/messaging/schema/mobile-action.schema.json +294 -217
  69. package/messaging/schema/mobile-event.schema.json +146 -153
  70. package/messaging/schema/web-action.schema.json +305 -269
  71. package/messaging/schema/web-event.schema.json +144 -151
  72. package/package.json +17 -17
  73. package/version.d.ts +2 -2
  74. package/version.js +2 -2
@@ -12,7 +12,8 @@ export interface CoordinateModelProperties extends CommonCoordinateModelProperti
12
12
  */
13
13
  activeCoordinateOption?: string;
14
14
  /**
15
- * A list of configuration options for displaying map coordinates in the application.
15
+ * A list of configuration options for displaying map coordinates in the
16
+ * application.
16
17
  */
17
18
  coordinateOptions?: CoordinateOptionProperties[];
18
19
  }
@@ -56,7 +56,8 @@ export interface DrawModelBaseProperties extends ModelProperties {
56
56
  symbolPresets?: SymbolPresetProperties[];
57
57
  /**
58
58
  * Shows only symbol presets and no fine-grain controls when a symbol is
59
- * being edited. If no symbol presets are configured, this property is ignored.
59
+ * being edited. If no symbol presets are configured, this property is
60
+ * ignored.
60
61
  */
61
62
  showOnlySymbolPresets?: boolean;
62
63
  }
@@ -7,7 +7,8 @@ export declare type PortalUsername = string;
7
7
  */
8
8
  export declare type PortalGroupId = string;
9
9
  /**
10
- * A defined set of user types for convenient configuration, based on authentication.
10
+ * A defined set of user types for convenient configuration, based on
11
+ * authentication.
11
12
  */
12
13
  export declare type VertigisUserType = "gcx-all-users" | "gcx-anonymous-users" | "gcx-authenticated-users";
13
14
  /**
@@ -78,7 +78,8 @@ export interface KpiCardSectionModelProperties {
78
78
  */
79
79
  text?: string;
80
80
  /**
81
- * The ID of the icon to display in this section, or undefined to show no icon.
81
+ * The ID of the icon to display in this section, or undefined to show no
82
+ * icon.
82
83
  */
83
84
  icon?: string;
84
85
  /**
@@ -13,7 +13,8 @@ export interface MapCoordinatesModelProperties extends CommonMapCoordinatesModel
13
13
  coordinateFormat?: CoordinateFormat;
14
14
  /**
15
15
  * The number of decimal places displayed for LAT_LONG coordinate formats.
16
- * The value must be an integer between 0 and 8 (inclusive). The default is 4.
16
+ * The value must be an integer between 0 and 8 (inclusive). The default is
17
+ * 4.
17
18
  *
18
19
  * @deprecated
19
20
  */
@@ -59,7 +59,8 @@ export interface MapModelProperties extends CommonMapModelProperties, ComponentM
59
59
  */
60
60
  layerComparisonDirection?: LayerComparisonDirection;
61
61
  /**
62
- * The position of the label relative to the slider bar. The default is "start".
62
+ * The position of the label relative to the slider bar. The default is
63
+ * "start".
63
64
  */
64
65
  layerComparisonLabelPosition?: LayerComparisonLabelPosition;
65
66
  /**
@@ -68,7 +69,8 @@ export interface MapModelProperties extends CommonMapModelProperties, ComponentM
68
69
  */
69
70
  layerComparisonIsConfigurable?: boolean;
70
71
  /**
71
- * The viewpoint of the map. This property is only serialized to saved projects.
72
+ * The viewpoint of the map. This property is only serialized to saved
73
+ * projects.
72
74
  */
73
75
  viewpoint?: ViewpointJson;
74
76
  /**
@@ -4,7 +4,8 @@ import type { DrawModelBaseProperties } from "./DrawModelProperties.js";
4
4
  */
5
5
  export interface MeasurementModelProperties extends DrawModelBaseProperties {
6
6
  /**
7
- * The number of decimal places to use in measurement labels. The default is 2.
7
+ * The number of decimal places to use in measurement labels. The default is
8
+ * 2.
8
9
  */
9
10
  decimalPlaces?: number;
10
11
  /**
@@ -4,7 +4,8 @@ import type { ModelProperties } from "../common/ModelProperties.js";
4
4
  */
5
5
  export interface PortalModelProperties extends ModelProperties {
6
6
  /**
7
- * Tags by which the Choose Layer modal will filter out the displayed layers.
7
+ * Tags by which the Choose Layer modal will filter out the displayed
8
+ * layers.
8
9
  */
9
10
  layerFilterTags?: string[];
10
11
  }
@@ -80,13 +80,15 @@ export interface ResultsModelProperties extends CommonResultsModelProperties, Co
80
80
  results?: FeatureListProperties;
81
81
  }
82
82
  /**
83
- * Specifies whether a results list component should display results grouped by source.
83
+ * Specifies whether a results list component should display results grouped by
84
+ * source.
84
85
  *
85
86
  * @webOnly
86
87
  */
87
88
  export declare type ViewMode = "ungrouped" | "grouped";
88
89
  /**
89
- * Specifies what card size a results list component should use to display result items.
90
+ * Specifies what card size a results list component should use to display
91
+ * result items.
90
92
  *
91
93
  * @webOnly
92
94
  */
@@ -10,7 +10,8 @@ export interface SearchModelProperties extends CommonSearchModelProperties, Comp
10
10
  */
11
11
  disableSearchAreaExpansion?: boolean;
12
12
  /**
13
- * This setting is used to indicate if the geocoder should be used by the search.
13
+ * This setting is used to indicate if the geocoder should be used by the
14
+ * search.
14
15
  */
15
16
  geocoderEnabled?: boolean;
16
17
  /**
@@ -40,7 +40,8 @@ export interface VertigisWebModelProperties extends ApplicationModelProperties {
40
40
  */
41
41
  privacyPolicyInfo?: PrivacyPolicyInfoProperties;
42
42
  /**
43
- * The collection of rules specifying the proxy URL to use for a given URL prefix.
43
+ * The collection of rules specifying the proxy URL to use for a given URL
44
+ * prefix.
44
45
  */
45
46
  proxyRules?: ProxyRuleProperties[];
46
47
  /**
@@ -53,7 +54,8 @@ export interface VertigisWebModelProperties extends ApplicationModelProperties {
53
54
  */
54
55
  trustedServers?: string[];
55
56
  /**
56
- * The version of VertiGIS Studio Web that was used to create this app configuration.
57
+ * The version of VertiGIS Studio Web that was used to create this app
58
+ * configuration.
57
59
  */
58
60
  version?: string;
59
61
  /**
@@ -71,7 +73,8 @@ export interface ProxyRuleProperties {
71
73
  */
72
74
  proxyUrl: string;
73
75
  /**
74
- * The URL prefix of the resources that should be accessed through the given proxy.
76
+ * The URL prefix of the resources that should be accessed through the given
77
+ * proxy.
75
78
  */
76
79
  urlPrefix: string;
77
80
  }
@@ -1,14 +1,14 @@
1
- # Geocortex Apps
1
+ # VertiGIS Studio Apps
2
2
 
3
3
  ## Introduction
4
4
 
5
- A Geocortex App is a JSON document containing configuration for an application
6
- that is built on top of the Geocortex API. Building on the Esri Web Map
7
- Specification, Geocortex Apps enable a declarative approach to working with the
8
- Geocortex and Esri APIs. Rather than initializing the properties of API objects
5
+ A VertiGIS Studio App is a JSON document containing configuration for an application
6
+ that is built on top of the ArcGIS Extensions API. Building on the Esri Web Map
7
+ Specification, VertiGIS Studio Apps enable a declarative approach to working with the
8
+ VertiGIS and Esri APIs. Rather than initializing the properties of API objects
9
9
  programmatically in code, you can define all of their settings externally in an
10
10
  App JSON document. Then, you can access the configured objects via the
11
- `AppContainer` class. Here is an example Geocortex App containing a map
11
+ `AppContainer` class. Here is an example VertiGIS Studio App containing a map
12
12
  extension and a menu:
13
13
 
14
14
  ```
@@ -141,13 +141,13 @@ other items, only a single object instance is ever created per unique item.
141
141
  ### Custom Item Types
142
142
 
143
143
  By default, AppContainer is pre-configured to understand the various items types
144
- that are built in the Geocortex API, e.g. MapExtension and Menu. However, you
144
+ that are built in the ArcGIS Extensions API, e.g. MapExtension and Menu. However, you
145
145
  can work with custom item types in an App by registering custom item factories
146
146
  with AppContainer. An item factory is just a method that takes item
147
147
  configuration and produces an actual object. For more information, see
148
148
  [AppContainer.registerType()](apidoc://AppContainer.registerType).
149
149
 
150
- You can also override the built-in factories for Geocortex API items with your
150
+ You can also override the built-in factories for ArcGIS Extensions API items with your
151
151
  own factories to customize how these items are created.
152
152
 
153
153
  ## Settings