@vertigis/viewer-spec 61.7.0 → 61.8.0

package/messaging/registry/results.d.ts

@@ -64,6 +64,15 @@ export interface ToCsvConversionArgs extends ToCsvOptions {
      */
     features: Features;
 }
+/**
+ * Arguments for the "results.convert-to-gpx" operation.
+ */
+export interface ToGpxConversionArgs {
+    /**
+     * The feature(s) to convert.
+     */
+    features: Features;
+}
 /**
  * Arguments for the "results.upload-data-args-to-feature" operation.
  */
@@ -578,6 +587,14 @@ export declare class ResultsOperations extends OperationRegistry {
      * @webOnly
      */
     get convertToCsv(): Operation<ToCsvConversionArgs | Features, ConversionResult>;
+    /**
+     * Converts the provided Feature(s) to a CSV file grouped by feature source.
+     * If there are multiple sources the CSV(s) will be bundled in a zip file.
+     * Web only.
+     *
+     * @webOnly
+     */
+    get convertToGpx(): Operation<ToGpxConversionArgs | Features, ConversionResult>;
     /**
      * Converts the provided Feature(s) to a XLSX file grouped by feature
      * source. If there are multiple sources the XLSX(s) will be bundled in a

package/messaging/registry/results.js

@@ -1 +1 @@
-import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export var KnownResultSetIds;!function(t){t.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends t{_prefix="results";get activateDisplayComponents(){return this._get("activate-display-components")}get activateGroup(){return this._get("activate-group")}get display(){return this._get("display")}get setActiveFeature(){return this._get("set-active-feature")}get setDisplayComponents(){return this._get("set-display-components")}get displayDetails(){return this._get("display-details")}get displaySummary(){return this._get("display-summary")}get displayNewDetails(){return this._get("display-new-details")}get add(){return this._get("add")}get intersect(){return this._get("intersect")}get remove(){return this._get("remove")}get replace(){return this._get("replace")}get clear(){return this._get("clear")}get clearDetails(){return this._get("clear-details")}get hideDetails(){return this._get("hide-details")}get openAttachment(){return this._get("open-attachment")}get refresh(){return this._get("refresh")}get setListViewMode(){return this._get("set-list-view-mode")}get setListCardSize(){return this._get("set-list-card-size")}}export class ResultsEvents extends e{_prefix="results";get changed(){return this._get("changed")}get displayed(){return this._get("displayed")}get attachmentOpened(){return this._get("attachment-opened")}get detailsShown(){return this._get("details-shown")}get relatedDetailsShown(){return this._get("related-details-shown")}}export class ResultsOperations extends r{_prefix="results";get configureUploadData(){return this._get("configure-upload-data")}get contains(){return this._get("contains")}get convertToCsv(){return this._get("convert-to-csv")}get convertToXlsx(){return this._get("convert-to-xlsx")}get convertToShapefile(){return this._get("convert-to-shapefile")}get convertToLayers(){return this._get("convert-to-layers")}get fromCsv(){return this._get("from-csv")}get fromFiles(){return this._get("from-files")}get getActiveFeatures(){return this._get("get-active-features")}get uploadDataFromFiles(){return this._get("upload-data-from-files")}get uploadDataToFeatures(){return this._get("upload-data-to-features")}get fromShapefile(){return this._get("from-shapefile")}get fromXlsx(){return this._get("from-xlsx")}get fromGraphics(){return this._get("from-graphics")}get toGraphics(){return this._get("to-graphics")}get getFeatures(){return this._get("get-features")}get filter(){return this._get("filter")}}
+import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export var KnownResultSetIds;!function(t){t.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends t{_prefix="results";get activateDisplayComponents(){return this._get("activate-display-components")}get activateGroup(){return this._get("activate-group")}get display(){return this._get("display")}get setActiveFeature(){return this._get("set-active-feature")}get setDisplayComponents(){return this._get("set-display-components")}get displayDetails(){return this._get("display-details")}get displaySummary(){return this._get("display-summary")}get displayNewDetails(){return this._get("display-new-details")}get add(){return this._get("add")}get intersect(){return this._get("intersect")}get remove(){return this._get("remove")}get replace(){return this._get("replace")}get clear(){return this._get("clear")}get clearDetails(){return this._get("clear-details")}get hideDetails(){return this._get("hide-details")}get openAttachment(){return this._get("open-attachment")}get refresh(){return this._get("refresh")}get setListViewMode(){return this._get("set-list-view-mode")}get setListCardSize(){return this._get("set-list-card-size")}}export class ResultsEvents extends e{_prefix="results";get changed(){return this._get("changed")}get displayed(){return this._get("displayed")}get attachmentOpened(){return this._get("attachment-opened")}get detailsShown(){return this._get("details-shown")}get relatedDetailsShown(){return this._get("related-details-shown")}}export class ResultsOperations extends r{_prefix="results";get configureUploadData(){return this._get("configure-upload-data")}get contains(){return this._get("contains")}get convertToCsv(){return this._get("convert-to-csv")}get convertToGpx(){return this._get("convert-to-gpx")}get convertToXlsx(){return this._get("convert-to-xlsx")}get convertToShapefile(){return this._get("convert-to-shapefile")}get convertToLayers(){return this._get("convert-to-layers")}get fromCsv(){return this._get("from-csv")}get fromFiles(){return this._get("from-files")}get getActiveFeatures(){return this._get("get-active-features")}get uploadDataFromFiles(){return this._get("upload-data-from-files")}get uploadDataToFeatures(){return this._get("upload-data-to-features")}get fromShapefile(){return this._get("from-shapefile")}get fromXlsx(){return this._get("from-xlsx")}get fromGraphics(){return this._get("from-graphics")}get toGraphics(){return this._get("to-graphics")}get getFeatures(){return this._get("get-features")}get filter(){return this._get("filter")}}

package/messaging/schema/web-action.schema.json

@@ -11102,6 +11102,20 @@
             ],
             "type": "object"
         },
+        "ToGpxConversionArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"results.convert-to-gpx\" operation.",
+            "properties": {
+                "features": {
+                    "$ref": "#/definitions/Features",
+                    "description": "The feature(s) to convert."
+                }
+            },
+            "required": [
+                "features"
+            ],
+            "type": "object"
+        },
         "ToShapefileConversionArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"results.convert-to-shapefile\" operation.",
@@ -27198,6 +27212,50 @@
         "results.convert-to-csv:output": {
             "$ref": "#/definitions/ConversionResult"
         },
+        "results.convert-to-gpx": {
+            "description": "Converts the provided Feature(s) to a CSV file grouped by feature source. If there are multiple sources the CSV(s) will be bundled in a zip file. Web only.",
+            "enum": [
+                "results.convert-to-gpx"
+            ]
+        },
+        "results.convert-to-gpx:input": {
+            "anyOf": [
+                {
+                    "$ref": "T_13"
+                },
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet"
+                },
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureList.FeatureList"
+                },
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream"
+                },
+                {
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
+                            },
+                            {
+                                "$ref": "T_13"
+                            }
+                        ]
+                    },
+                    "type": "array"
+                },
+                {
+                    "$ref": "#/definitions/Results"
+                },
+                {
+                    "$ref": "ToGpxConversionArgs"
+                }
+            ]
+        },
+        "results.convert-to-gpx:output": {
+            "$ref": "#/definitions/ConversionResult"
+        },
         "results.convert-to-layers": {
             "description": "Creates layer(s) from the specified features. Web only.",
             "enum": [
@@ -32818,6 +32876,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/results.convert-to-gpx:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/results.convert-to-gpx"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -33700,6 +33774,9 @@
                 {
                     "$ref": "#/definitions/results.convert-to-csv"
                 },
+                {
+                    "$ref": "#/definitions/results.convert-to-gpx"
+                },
                 {
                     "$ref": "#/definitions/results.convert-to-layers"
                 },

package/messaging/schema/web-results-operation-definitions.md

@@ -180,6 +180,105 @@ ToCsvConversionArgs properties:
 
 Outputs: `ConversionResult`
 
+---
+# operation: results.convert-to-gpx
+Description: Converts the provided Feature(s) to a CSV file grouped by feature source. If there are multiple sources the CSV(s) will be bundled in a zip file. Web only.
+
+Inputs: `( @vertigis.api-docs.Features FeatureSet|FeatureList|FeatureStream | T_13 | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties | T_13 )[] | Results | ToGpxConversionArgs )`
+
+@vertigis.arcgis-extensions.data.Feature.FeatureProperties properties:
+```json
+{
+  "attributes": {
+    "anyOf": [
+      {},
+      {
+        "$ref": "Map"
+      }
+    ],
+    "description": "The feature's attributes, keyed by field name."
+  },
+  "failureMode": {
+    "description": "See {@link support /InitializableBase!InitializableBase.failureMode}."
+  },
+  "geometry": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/@arcgis.core.geometry.Extent.Extent"
+      },
+      {
+        "$ref": "#/definitions/@arcgis.core.geometry.Multipoint.Multipoint"
+      },
+      {
+        "$ref": "#/definitions/@arcgis.core.geometry.Point.Point"
+      },
+      {
+        "$ref": "T_6"
+      },
+      {
+        "$ref": "#/definitions/@arcgis.core.geometry.Polyline.Polyline"
+      },
+      {
+        "$ref": "#/definitions/@arcgis.core.geometry.Mesh.Mesh"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.GeometryJson.PointJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.GeometryJson.MultipointJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.GeometryJson.PolylineJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.GeometryJson.PolygonJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.GeometryJson.ExtentJson"
+      }
+    ],
+    "description": "The feature's geometry."
+  },
+  "id": {
+    "description": "The unique ID to assign to the entity. If not specified, one will be generated.",
+    "type": "string"
+  },
+  "schema": {
+    "description": "Metadata about the feature, such as fields, domains, geometry type, etc."
+  },
+  "settings": {
+    "description": "Settings for this feature."
+  },
+  "source": {
+    "description": "The source of the feature."
+  }
+}
+```
+
+Results properties:
+```json
+{
+  "features": {
+    "description": "Features to use for the command/operation."
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  }
+}
+```
+
+ToGpxConversionArgs properties:
+```json
+{
+  "features": {
+    "description": "The feature(s) to convert.",
+    "isRequired": "true"
+  }
+}
+```
+
+Outputs: `ConversionResult`
+
 ---
 # operation: results.convert-to-layers
 Description: Creates layer(s) from the specified features. Web only.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "61.7.0",
+  "version": "61.8.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export declare const version = "61.7.0";
+export declare const version = "61.8.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export const version = "61.7.0";
+export const version = "61.8.0";