# operation: results.configure-upload-data Description: Display a dialog to configure the arguments for the upload layer operation. Web only. Inputs: `UploadDataArgs[]` Outputs: `UploadDataArgs[]` --- # operation: results.contains Description: Check if features are contained in the specified results. Web only. Inputs: `object` Outputs: `boolean[]` --- # operation: results.convert-to-csv 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 | ToCsvConversionArgs )` @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." } } ``` ToCsvConversionArgs properties: ```json { "alwaysQuote": { "description": "Whether to always quote values, even if they do not require it. The default is false.", "type": "boolean" }, "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "delimiter": { "description": "The delimiter between fields. If not specified, an attempt will be made to auto-detect the delimiter.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "features": { "description": "The feature(s) to convert.", "isRequired": "true" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "geometryFields": { "description": "A set of custom field names to use with the selected geometry format.", "items": { "type": "string" }, "type": "array" }, "geometryFormat": { "description": "The format for serializing the geometry. The default is WKT." }, "includeByteOrderMark": { "description": "Whether to include a Unicode byte order mark at the beginning of the text. True by default.", "type": "boolean" }, "includeHeaderRow": { "description": "Whether to include a header row with field names. Default is true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to CSV, this is the spatial reference of the geometry in the CSV. The default is WGS84. When importing from CSV, this is the spatial reference of the geometry in the result." }, "rowDelimiter": { "description": "The delimiter between rows. The default is the platform-specific line ending (e.g. \"\\r\\n\" on Windows, \"\\n\" on Unix or MacOS).", "type": "string" }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` Outputs: `ConversionResult` --- # operation: results.convert-to-layers Description: Creates layer(s) from the specified features. Web only. Inputs: `( @vertigis.api-docs.Features FeatureSet|FeatureList|FeatureStream | T_13 | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties | T_13 )[] | Results | LayerConversionArgs )` @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." } } ``` LayerConversionArgs properties: ```json { "features": { "description": "The feature(s) to convert.", "isRequired": "true" }, "meshSymbol": { "description": "Optionally a symbol to be used for mesh geometries." }, "multipointSymbol": { "description": "Optionally a symbol to be used for multipoint geometries." }, "pointSymbol": { "description": "Optionally a symbol to be used for point geometries." }, "polygonSymbol": { "description": "Optionally a symbol to be used for polygon geometries." }, "polylineSymbol": { "description": "Optionally a symbol to be used for polyline geometries." } } ``` Outputs: `@arcgis.core.layers.Layer.Layer[]` --- # operation: results.convert-to-shapefile Description: Converts the provided Feature(s) to a Shapefile grouped by feature source. If there are multiple sources the Shapefile(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 | ToShapefileConversionArgs )` @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." } } ``` ToShapefileConversionArgs properties: ```json { "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "features": { "description": "The feature(s) to convert.", "isRequired": "true" }, "fileName": { "description": "When exporting to a shapefile, the file name to use.", "type": "string" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to a shapefile, this is the spatial reference of the geometry in the shapefile file. The default is WGS84. When importing from shapefile, this is the spatial reference of the geometry in the result." }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` Outputs: `ConversionResult` --- # operation: results.convert-to-xlsx Description: 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 zip file. Web only. Inputs: `( @vertigis.api-docs.Features FeatureSet|FeatureList|FeatureStream | T_13 | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties | T_13 )[] | Results | ToXLSXConversionArgs )` @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." } } ``` ToXLSXConversionArgs properties: ```json { "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "features": { "description": "The feature(s) to convert.", "isRequired": "true" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "geometryFields": { "description": "A set of custom field names to use with the selected geometry format.", "items": { "type": "string" }, "type": "array" }, "geometryFormat": { "description": "The format for serializing the geometry. The default is WKT." }, "includeHeaderRow": { "description": "Whether to include a header row with field names. Default is true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to XLSX, this is the spatial reference of the geometry in the XLSX file. The default is WGS84. When importing from XLSX, this is the spatial reference of the geometry in the result." }, "sheetName": { "description": "When exporting to XLSX, the name of the resulting work sheet. The default is \"sheet1\".", "type": "string" }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` Outputs: `ConversionResult` --- # operation: results.filter Description: Filters down a set of results using an SQL 'where' clause and/or an intersecting geometry. Web only. Inputs: `FilterResultsArgs` FilterResultsArgs properties: ```json { "features": { "anyOf": [ { "$ref": "#/definitions/CreateGraphicsResult" }, { "$ref": "#/definitions/@arcgis.core.Graphic.Graphic" }, { "$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/esri.rest-api.FeatureJson.FeatureJson" }, { "$ref": "#/definitions/@arcgis.core.rest.support.FeatureSet.FeatureSet" }, { "items": { "anyOf": [ { "$ref": "#/definitions/@arcgis.core.Graphic.Graphic" }, { "$ref": "#/definitions/esri.rest-api.FeatureJson.FeatureJson" } ] }, "type": "array" } ], "description": "Features or Graphics to filter.", "isRequired": "true" }, "options": { "description": "Additional query options with which to filter the results." }, "source": { "description": "The source of the Results. This is only necessary if Graphics are passed into the filter operation." }, "where": { "description": "An SQL 'where' clause used to filter down a set of results.", "type": "string" } } ``` Outputs: `Features` --- # operation: results.from-csv Description: Convert the specified csv blob to Features. Web only. Inputs: `( Blob | Blob[] | FromCsvConversionArgs )` FromCsvConversionArgs properties: ```json { "blobs": { "description": "The data files to use for the command/operation.", "items": { "$ref": "FileLike", "FileLike": {} }, "type": "array" }, "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "delimiter": { "description": "The delimiter between fields. If not specified, an attempt will be made to auto-detect the delimiter.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "geometryFields": { "description": "A set of custom field names to use with the selected geometry format.", "items": { "type": "string" }, "type": "array" }, "geometryFormat": { "description": "The format for serializing the geometry. The default is WKT." }, "inSpatialReference": { "description": "When importing from CSV, this is the spatial reference of the geometry in the CSV." }, "includeHeaderRow": { "description": "Whether to include a header row with field names. Default is true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to CSV, this is the spatial reference of the geometry in the CSV. The default is WGS84. When importing from CSV, this is the spatial reference of the geometry in the result." }, "primaryKeyField": { "description": "Optionally the primary key field, used for converting from CSV to features.", "type": "string" }, "rowDelimiter": { "description": "The delimiter between rows. The default is the platform-specific line ending (e.g. \"\\r\\n\" on Windows, \"\\n\" on Unix or MacOS).", "type": "string" }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` Outputs: `Features` --- # operation: results.from-files Description: Convert the specified csv, xlsx or shapefile files to Features. Web only. Inputs: `( File[] | FromCsvConversionArgs | FromShapefileConversionArgs | FromXLSXConversionArgs )` FromCsvConversionArgs properties: ```json { "blobs": { "description": "The data files to use for the command/operation.", "items": { "$ref": "FileLike", "FileLike": {} }, "type": "array" }, "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "delimiter": { "description": "The delimiter between fields. If not specified, an attempt will be made to auto-detect the delimiter.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "geometryFields": { "description": "A set of custom field names to use with the selected geometry format.", "items": { "type": "string" }, "type": "array" }, "geometryFormat": { "description": "The format for serializing the geometry. The default is WKT." }, "inSpatialReference": { "description": "When importing from CSV, this is the spatial reference of the geometry in the CSV." }, "includeHeaderRow": { "description": "Whether to include a header row with field names. Default is true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to CSV, this is the spatial reference of the geometry in the CSV. The default is WGS84. When importing from CSV, this is the spatial reference of the geometry in the result." }, "primaryKeyField": { "description": "Optionally the primary key field, used for converting from CSV to features.", "type": "string" }, "rowDelimiter": { "description": "The delimiter between rows. The default is the platform-specific line ending (e.g. \"\\r\\n\" on Windows, \"\\n\" on Unix or MacOS).", "type": "string" }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` FromShapefileConversionArgs properties: ```json { "blobs": { "description": "The data files to use for the command/operation.", "items": { "$ref": "FileLike", "FileLike": {} }, "type": "array" }, "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "fileName": { "description": "When exporting to a shapefile, the file name to use.", "type": "string" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to a shapefile, this is the spatial reference of the geometry in the shapefile file. The default is WGS84. When importing from shapefile, this is the spatial reference of the geometry in the result." }, "primaryKeyField": { "description": "Optionally the primary key field, used for converting from Shapefile to features.", "type": "string" }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` FromXLSXConversionArgs properties: ```json { "blobs": { "description": "The data files to use for the command/operation.", "items": { "$ref": "FileLike", "FileLike": {} }, "type": "array" }, "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "geometryFields": { "description": "A set of custom field names to use with the selected geometry format.", "items": { "type": "string" }, "type": "array" }, "geometryFormat": { "description": "The format for serializing the geometry. The default is WKT." }, "inSpatialReference": { "description": "When importing from XLSX, this is the spatial reference of the geometry in the XLSX file." }, "includeHeaderRow": { "description": "Whether to include a header row with field names. Default is true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to XLSX, this is the spatial reference of the geometry in the XLSX file. The default is WGS84. When importing from XLSX, this is the spatial reference of the geometry in the result." }, "primaryKeyField": { "description": "Optionally the primary key field, used for converting from XLSX to features.", "type": "string" }, "sheetName": { "description": "When exporting to XLSX, the name of the resulting work sheet. The default is \"sheet1\".", "type": "string" }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` Outputs: `Features` --- # operation: results.from-graphics Description: Converts provided GraphicsLike to VertiGIS Studio Features using any available metadata. Inputs: `FromGraphicsArgs` FromGraphicsArgs properties: ```json { "featureSettings": { "description": "FeatureSettings to use for feature metadata if the layer is not provided or can't be found." }, "fetchAttachments": { "description": "Whether to fetch attachments for the returned features. Defaults to false. Mobile only.", "type": "boolean" }, "fetchRelatedFeatures": { "description": "Whether to fetch related features for the returned features. Defaults to false. Mobile only.", "type": "boolean" }, "graphics": { "description": "A selection of graphics to be converted to features.", "isRequired": "true" }, "layer": { "anyOf": [ { "$ref": "#/definitions/@arcgis.core.layers.Layer.Layer" }, { "type": "string" } ], "description": "The layer the graphics originate from, or the ID of that layer. Used as the source for created features." }, "maps": { "description": "The maps to search for the given layer." }, "schema": { "description": "The schema to be associated with the returned features. This property is only necessary when no layer nor sublayer are present." }, "sublayer": { "anyOf": [ { "$ref": "T_9" }, { "type": "number" } ], "description": "The sublayer the graphics originate from, or the ID of that sublayer. Used as the source for created features. Will not be used unless layer parameter is also provided." }, "title": { "description": "The feature source title to use if no layer or sublayer is associated with the features.", "type": "string" }, "workflowItemId": { "description": "The feature source ID to use if the results are associated with a workflow.", "type": "string" } } ``` Outputs: `Features` --- # operation: results.from-shapefile Description: Convert the specified Shapefile blob to Features. Web only. Inputs: `( Blob | Blob[] | FromShapefileConversionArgs )` FromShapefileConversionArgs properties: ```json { "blobs": { "description": "The data files to use for the command/operation.", "items": { "$ref": "FileLike", "FileLike": {} }, "type": "array" }, "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "fileName": { "description": "When exporting to a shapefile, the file name to use.", "type": "string" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to a shapefile, this is the spatial reference of the geometry in the shapefile file. The default is WGS84. When importing from shapefile, this is the spatial reference of the geometry in the result." }, "primaryKeyField": { "description": "Optionally the primary key field, used for converting from Shapefile to features.", "type": "string" }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` Outputs: `Features` --- # operation: results.from-xlsx Description: Convert the specified xlsx blob to Features. Web only. Inputs: `( Blob | Blob[] | FromXLSXConversionArgs )` FromXLSXConversionArgs properties: ```json { "blobs": { "description": "The data files to use for the command/operation.", "items": { "$ref": "FileLike", "FileLike": {} }, "type": "array" }, "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "geometryFields": { "description": "A set of custom field names to use with the selected geometry format.", "items": { "type": "string" }, "type": "array" }, "geometryFormat": { "description": "The format for serializing the geometry. The default is WKT." }, "inSpatialReference": { "description": "When importing from XLSX, this is the spatial reference of the geometry in the XLSX file." }, "includeHeaderRow": { "description": "Whether to include a header row with field names. Default is true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to XLSX, this is the spatial reference of the geometry in the XLSX file. The default is WGS84. When importing from XLSX, this is the spatial reference of the geometry in the result." }, "primaryKeyField": { "description": "Optionally the primary key field, used for converting from XLSX to features.", "type": "string" }, "sheetName": { "description": "When exporting to XLSX, the name of the resulting work sheet. The default is \"sheet1\".", "type": "string" }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` Outputs: `Features` --- # operation: results.get-active-features Description: Returns the current active feature from a specific results component if model ID or model is specified, otherwise returns all active features from all results components. Note that each results component can only have one active feature at a time, but the active feature can differ between different results components. Web only. Inputs: `( Model | string )` Model properties: ```json { "id": { "description": "The unique ID for this entity.", "type": "string", "isRequired": "true" }, "itemType": { "description": "The item type for this entity when it participates in an App.", "type": "string", "isRequired": "true" } } ``` Outputs: `Features` --- # operation: results.get-features Description: Returns the current set of features from a specific results component if a model or model ID is specified, otherwise from all results components. Web only. Inputs: `( Model | TargetsResultsSetArgs | string )` Model properties: ```json { "id": { "description": "The unique ID for this entity.", "type": "string", "isRequired": "true" }, "itemType": { "description": "The item type for this entity when it participates in an App.", "type": "string", "isRequired": "true" } } ``` TargetsResultsSetArgs properties: ```json { "resultsSetId": { "description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results. Web only.", "type": "string" } } ``` Outputs: `Features` --- # operation: results.to-graphics Description: Converts VertiGIS Studio Features to Esri graphics. Inputs: `Features` Features properties: ```json { "features": { "description": "Features to use for the command/operation." }, "maps": { "description": "Map(s) to use for the command/operation." } } ``` Outputs: `@arcgis.core.Graphic.Graphic[]` --- # operation: results.upload-data-from-files Description: Convert the specified csv, xlsx or shapefile files to args that can be used to create Features. Web only. Inputs: `( File[] | FromCsvConversionArgs | FromShapefileConversionArgs | FromXLSXConversionArgs )` FromCsvConversionArgs properties: ```json { "blobs": { "description": "The data files to use for the command/operation.", "items": { "$ref": "FileLike", "FileLike": {} }, "type": "array" }, "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "delimiter": { "description": "The delimiter between fields. If not specified, an attempt will be made to auto-detect the delimiter.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "geometryFields": { "description": "A set of custom field names to use with the selected geometry format.", "items": { "type": "string" }, "type": "array" }, "geometryFormat": { "description": "The format for serializing the geometry. The default is WKT." }, "inSpatialReference": { "description": "When importing from CSV, this is the spatial reference of the geometry in the CSV." }, "includeHeaderRow": { "description": "Whether to include a header row with field names. Default is true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to CSV, this is the spatial reference of the geometry in the CSV. The default is WGS84. When importing from CSV, this is the spatial reference of the geometry in the result." }, "primaryKeyField": { "description": "Optionally the primary key field, used for converting from CSV to features.", "type": "string" }, "rowDelimiter": { "description": "The delimiter between rows. The default is the platform-specific line ending (e.g. \"\\r\\n\" on Windows, \"\\n\" on Unix or MacOS).", "type": "string" }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` FromShapefileConversionArgs properties: ```json { "blobs": { "description": "The data files to use for the command/operation.", "items": { "$ref": "FileLike", "FileLike": {} }, "type": "array" }, "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "fileName": { "description": "When exporting to a shapefile, the file name to use.", "type": "string" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to a shapefile, this is the spatial reference of the geometry in the shapefile file. The default is WGS84. When importing from shapefile, this is the spatial reference of the geometry in the result." }, "primaryKeyField": { "description": "Optionally the primary key field, used for converting from Shapefile to features.", "type": "string" }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` FromXLSXConversionArgs properties: ```json { "blobs": { "description": "The data files to use for the command/operation.", "items": { "$ref": "FileLike", "FileLike": {} }, "type": "array" }, "dateFormat": { "description": "The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the \"timestamp\" pseudo-format, or a custom format string.", "type": "string" }, "escapeFormulaChars": { "description": "Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).", "type": "boolean" }, "generatePrimaryKey": { "description": "Indicates if a primary key should be generated if not found, defaults to true.", "type": "boolean" }, "geometryFields": { "description": "A set of custom field names to use with the selected geometry format.", "items": { "type": "string" }, "type": "array" }, "geometryFormat": { "description": "The format for serializing the geometry. The default is WKT." }, "inSpatialReference": { "description": "When importing from XLSX, this is the spatial reference of the geometry in the XLSX file." }, "includeHeaderRow": { "description": "Whether to include a header row with field names. Default is true.", "type": "boolean" }, "locale": { "description": "The locale to use for formatting values. Accepts a valid locale code (example: \"inv\", \"fr\" or \"de-AT\"). Default is \"inv\" or invariant culture.", "type": "string" }, "numberFormat": { "description": "The format for numbers. The default is NumberFormat.ROUND_TRIP.", "type": "string" }, "outFields": { "description": "A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise \"*\" meaning all fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "description": "When exporting to XLSX, this is the spatial reference of the geometry in the XLSX file. The default is WGS84. When importing from XLSX, this is the spatial reference of the geometry in the result." }, "primaryKeyField": { "description": "Optionally the primary key field, used for converting from XLSX to features.", "type": "string" }, "sheetName": { "description": "When exporting to XLSX, the name of the resulting work sheet. The default is \"sheet1\".", "type": "string" }, "timeFormat": { "description": "The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.", "type": "string" }, "useFormattedValues": { "description": "If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.", "type": "boolean" } } ``` Outputs: `UploadDataArgs[]` --- # operation: results.upload-data-to-features Description: Convert the supplied upload data args to features. Inputs: `UploadDataArgs[]` Outputs: `@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream[]` ---