@vertigis/workflow 5.45.1 → 5.46.1

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 (249) hide show
  1. package/LanguageStringUtils.js +1 -1
  2. package/activities/app/GetApplicationData.d.ts +1 -0
  3. package/activities/app/GetApplicationInfo.d.ts +3 -0
  4. package/activities/app/GetUserInfo.d.ts +3 -0
  5. package/activities/app/PublishEvent.d.ts +0 -3
  6. package/activities/app/RemoveApplicationData.d.ts +1 -0
  7. package/activities/app/RunCommand.d.ts +0 -3
  8. package/activities/app/RunOperation.d.ts +1 -4
  9. package/activities/arcgis/AddAttachment.d.ts +1 -6
  10. package/activities/arcgis/AddAttachment.js +1 -1
  11. package/activities/arcgis/AddFeatureLayer.d.ts +1 -4
  12. package/activities/arcgis/AddFeatures.d.ts +2 -6
  13. package/activities/arcgis/AddGraphics.d.ts +1 -4
  14. package/activities/arcgis/ArcadeScript.d.ts +1 -4
  15. package/activities/arcgis/AreaEngineTask.d.ts +1 -3
  16. package/activities/arcgis/BufferEngineTask.d.ts +2 -7
  17. package/activities/arcgis/BufferServiceTask.d.ts +2 -10
  18. package/activities/arcgis/CastGeometry.d.ts +5 -5
  19. package/activities/arcgis/ClearGraphics.d.ts +0 -1
  20. package/activities/arcgis/ClipEngineTask.d.ts +1 -3
  21. package/activities/arcgis/ClosestFacilityTask.d.ts +8 -34
  22. package/activities/arcgis/CompareGeometries.d.ts +1 -3
  23. package/activities/arcgis/ConvertValueToArcGisFieldType.d.ts +1 -0
  24. package/activities/arcgis/CreateFeatureSet.d.ts +1 -1
  25. package/activities/arcgis/CreateGraphic.d.ts +1 -1
  26. package/activities/arcgis/CreatePoint.d.ts +1 -1
  27. package/activities/arcgis/CutEngineTask.d.ts +1 -3
  28. package/activities/arcgis/DeleteAttachments.d.ts +1 -5
  29. package/activities/arcgis/DeleteAttachments.js +1 -1
  30. package/activities/arcgis/DeleteFeatures.d.ts +2 -7
  31. package/activities/arcgis/DeleteFeatures.js +1 -1
  32. package/activities/arcgis/DensifyEngineTask.d.ts +1 -4
  33. package/activities/arcgis/DifferenceEngineTask.d.ts +2 -5
  34. package/activities/arcgis/DistanceEngineTask.d.ts +1 -4
  35. package/activities/arcgis/DistanceServiceTask.d.ts +1 -6
  36. package/activities/arcgis/ExtendedSpatialReferenceInfoEngineTask.d.ts +1 -2
  37. package/activities/arcgis/FeatureSetFromJson.d.ts +1 -2
  38. package/activities/arcgis/FlipEngineTask.d.ts +1 -4
  39. package/activities/arcgis/FromGeoCoordinateStringServiceTask.d.ts +1 -6
  40. package/activities/arcgis/GeneralizeEngineTask.d.ts +1 -5
  41. package/activities/arcgis/GenerateArcGisToken.d.ts +2 -2
  42. package/activities/arcgis/GenerateWebmapForReport.d.ts +3 -2
  43. package/activities/arcgis/GenerateWebmapForReport.js +1 -1
  44. package/activities/arcgis/Geocode.d.ts +3 -12
  45. package/activities/arcgis/GeometryFromJson.d.ts +1 -2
  46. package/activities/arcgis/Geoprocessing.d.ts +2 -6
  47. package/activities/arcgis/GeoprocessingAsync.d.ts +4 -8
  48. package/activities/arcgis/GetAttributeValue.d.ts +2 -5
  49. package/activities/arcgis/GetAttributeValues.d.ts +2 -4
  50. package/activities/arcgis/GetCentroid.d.ts +1 -2
  51. package/activities/arcgis/GetCodedValueDomain.d.ts +1 -7
  52. package/activities/arcgis/GetCurrentPosition.d.ts +23 -4
  53. package/activities/arcgis/GetFeatureGeometries.d.ts +2 -4
  54. package/activities/arcgis/GetFeatureGeometry.d.ts +1 -3
  55. package/activities/arcgis/GetFeatureLayerInfo.d.ts +1 -4
  56. package/activities/arcgis/GetFeatureLayerInfo.js +1 -1
  57. package/activities/arcgis/GetFeatureSetExtent.d.ts +2 -3
  58. package/activities/arcgis/GetFeatureSetObjectIds.d.ts +2 -4
  59. package/activities/arcgis/GetFormElementItemsFromFeatures.d.ts +1 -4
  60. package/activities/arcgis/GetGeometryExtent.d.ts +2 -2
  61. package/activities/arcgis/GetGraphics.d.ts +1 -3
  62. package/activities/arcgis/GetLayer.d.ts +2 -4
  63. package/activities/arcgis/GetLayerDefinitionExpression.d.ts +1 -2
  64. package/activities/arcgis/GetLayerProperty.d.ts +1 -2
  65. package/activities/arcgis/GetLayerVisibility.d.ts +1 -2
  66. package/activities/arcgis/GetMap.d.ts +1 -0
  67. package/activities/arcgis/GetMapScreenshot.d.ts +1 -2
  68. package/activities/arcgis/GetMapScreenshot.js +1 -1
  69. package/activities/arcgis/GetPortalUser.d.ts +6 -3
  70. package/activities/arcgis/GetPortalUser.js +1 -1
  71. package/activities/arcgis/GetTable.d.ts +1 -2
  72. package/activities/arcgis/GetViewExtent.d.ts +3 -3
  73. package/activities/arcgis/GetViewpoint.d.ts +1 -1
  74. package/activities/arcgis/IntersectEngineTask.d.ts +2 -4
  75. package/activities/arcgis/LabelPointsServiceTask.d.ts +1 -3
  76. package/activities/arcgis/LengthEngineTask.d.ts +1 -3
  77. package/activities/arcgis/MapProvider.js +1 -1
  78. package/activities/arcgis/NearestCoordinateEngineTask.d.ts +5 -7
  79. package/activities/arcgis/NearestVertexEngineTask.d.ts +5 -7
  80. package/activities/arcgis/NearestVerticesEngineTask.d.ts +6 -10
  81. package/activities/arcgis/OffsetEngineTask.d.ts +1 -6
  82. package/activities/arcgis/ProjectServiceTask.d.ts +2 -7
  83. package/activities/arcgis/QueryAttachmentInfos.d.ts +4 -5
  84. package/activities/arcgis/QueryAttachmentInfos.js +1 -1
  85. package/activities/arcgis/QueryTask.d.ts +3 -27
  86. package/activities/arcgis/RefreshLayer.d.ts +0 -1
  87. package/activities/arcgis/RegisterCorsUrl.d.ts +1 -3
  88. package/activities/arcgis/RelateEngineTask.d.ts +2 -5
  89. package/activities/arcgis/RelationServiceTask.d.ts +2 -6
  90. package/activities/arcgis/RelationshipQueryTask.d.ts +1 -12
  91. package/activities/arcgis/RemoveFeatureSetFields.d.ts +2 -5
  92. package/activities/arcgis/RemoveGraphics.d.ts +0 -2
  93. package/activities/arcgis/RemoveLayer.d.ts +1 -1
  94. package/activities/arcgis/RendererFromJson.d.ts +1 -2
  95. package/activities/arcgis/ResetLayerDefinitionExpression.d.ts +2 -7
  96. package/activities/arcgis/ReshapeServiceTask.d.ts +1 -4
  97. package/activities/arcgis/ReverseGeocode.d.ts +2 -8
  98. package/activities/arcgis/RotateEngineTask.d.ts +1 -4
  99. package/activities/arcgis/RouteTask.d.ts +5 -36
  100. package/activities/arcgis/RunPrint.d.ts +7 -4
  101. package/activities/arcgis/RunPrint.js +1 -1
  102. package/activities/arcgis/RunReport.d.ts +5 -3
  103. package/activities/arcgis/RunReport.js +1 -1
  104. package/activities/arcgis/RunWorkflow.d.ts +1 -3
  105. package/activities/arcgis/ServiceAreaTask.d.ts +7 -33
  106. package/activities/arcgis/SetFeatureAttribute.d.ts +0 -3
  107. package/activities/arcgis/SetFeatureGeometry.d.ts +0 -2
  108. package/activities/arcgis/SetFeaturePopup.d.ts +0 -1
  109. package/activities/arcgis/SetFeatureSymbol.d.ts +0 -2
  110. package/activities/arcgis/SetImageryLayerOptions.d.ts +4 -9
  111. package/activities/arcgis/SetLayerDefinitionExpression.d.ts +2 -3
  112. package/activities/arcgis/SetLayerPopup.d.ts +0 -1
  113. package/activities/arcgis/SetLayerProperty.d.ts +2 -5
  114. package/activities/arcgis/SetLayerVisibility.d.ts +2 -5
  115. package/activities/arcgis/SetMap.d.ts +0 -1
  116. package/activities/arcgis/SetViewExtent.d.ts +4 -7
  117. package/activities/arcgis/SetViewpoint.d.ts +2 -5
  118. package/activities/arcgis/ShowFeaturePopup.d.ts +0 -1
  119. package/activities/arcgis/SimplifyEngineTask.d.ts +1 -1
  120. package/activities/arcgis/SortFeatureSet.d.ts +1 -4
  121. package/activities/arcgis/SymbolFromJson.d.ts +1 -2
  122. package/activities/arcgis/ToGeoCoordinateStringServiceTask.d.ts +1 -9
  123. package/activities/arcgis/UnionEngineTask.d.ts +1 -3
  124. package/activities/arcgis/UnionServiceTask.d.ts +1 -4
  125. package/activities/arcgis/UpdateAttachment.d.ts +1 -8
  126. package/activities/arcgis/UpdateAttachment.js +1 -1
  127. package/activities/arcgis/UpdateFeatures.d.ts +2 -6
  128. package/activities/arcgis/printing.d.ts +212 -0
  129. package/activities/arcgis/printing.js +1 -0
  130. package/activities/arcgis/printingFields.d.ts +88 -0
  131. package/activities/arcgis/printingFields.js +1 -0
  132. package/activities/arcgis/runUtils.d.ts +1 -20
  133. package/activities/arcgis/runUtils.js +1 -1
  134. package/activities/arcgis/shared.js +1 -1
  135. package/activities/browser/GetBrowserInfo.d.ts +2 -2
  136. package/activities/core/Annotation.d.ts +0 -1
  137. package/activities/core/CalculateDate.d.ts +2 -0
  138. package/activities/core/Cast.d.ts +1 -1
  139. package/activities/core/Container.d.ts +0 -1
  140. package/activities/core/ConvertBytesToText.d.ts +1 -0
  141. package/activities/core/ConvertDataTableToFeatureSet.d.ts +1 -0
  142. package/activities/core/ConvertTextToBytes.d.ts +1 -0
  143. package/activities/core/ConvertToJson.d.ts +1 -2
  144. package/activities/core/CreateFile.d.ts +1 -0
  145. package/activities/core/CreateValue.d.ts +1 -6
  146. package/activities/core/DecodeUriComponent.d.ts +1 -0
  147. package/activities/core/Delay.d.ts +0 -1
  148. package/activities/core/EncodeUriComponent.d.ts +1 -0
  149. package/activities/core/Evaluate.d.ts +1 -3
  150. package/activities/core/EvaluateAsync.d.ts +1 -3
  151. package/activities/core/ExecuteFunction.d.ts +1 -1
  152. package/activities/core/ForEach.d.ts +4 -6
  153. package/activities/core/FormatDate.d.ts +5 -0
  154. package/activities/core/Function.d.ts +3 -0
  155. package/activities/core/GetBase64StringFromBytes.d.ts +1 -1
  156. package/activities/core/GetBase64StringFromFile.d.ts +1 -0
  157. package/activities/core/GetBytesFromBase64String.d.ts +1 -1
  158. package/activities/core/GetFirstItem.d.ts +1 -0
  159. package/activities/core/GetItemAtIndex.d.ts +1 -0
  160. package/activities/core/GetLastItem.d.ts +1 -0
  161. package/activities/core/GetLogLevel.d.ts +5 -0
  162. package/activities/core/GetTextFromFile.d.ts +1 -0
  163. package/activities/core/GetWorkflowInputs.d.ts +1 -1
  164. package/activities/core/If.d.ts +1 -3
  165. package/activities/core/Log.d.ts +0 -2
  166. package/activities/core/Loop.d.ts +2 -7
  167. package/activities/core/ParseJson.d.ts +1 -2
  168. package/activities/core/ParseNumber.d.ts +1 -0
  169. package/activities/core/ParseUrl.d.ts +5 -6
  170. package/activities/core/RegexMatches.d.ts +1 -0
  171. package/activities/core/RegexReplace.d.ts +1 -0
  172. package/activities/core/RemoveItem.d.ts +1 -0
  173. package/activities/core/RunActivity.d.ts +0 -1
  174. package/activities/core/SetProperty.d.ts +0 -3
  175. package/activities/core/Switch.d.ts +2 -3
  176. package/activities/core/TextReplace.d.ts +1 -0
  177. package/activities/core/TryCatch.d.ts +1 -1
  178. package/activities/core/WebRequest.d.ts +6 -17
  179. package/activities/csv/ConvertCsvToDataTable.d.ts +1 -0
  180. package/activities/csv/ConvertDataTableToCsv.d.ts +1 -0
  181. package/activities/csv/ParseCsv.d.ts +20 -0
  182. package/activities/csv/ParseCsv.js +1 -0
  183. package/activities/essentials/GetEssentialsSite.d.ts +1 -1
  184. package/activities/essentials/RunEssentialsWorkflow.d.ts +1 -4
  185. package/activities/essentials/RunEssentialsWorkflowActivity.d.ts +2 -2
  186. package/activities/forms/AddFormElement.d.ts +0 -3
  187. package/activities/forms/DisplayForm.d.ts +2 -4
  188. package/activities/forms/FilterFormElementItems.d.ts +1 -0
  189. package/activities/forms/FormRenderer.js +1 -1
  190. package/activities/forms/GetFormElementItemsFromCollection.d.ts +1 -4
  191. package/activities/forms/GetFormElementProperty.d.ts +1 -2
  192. package/activities/forms/GetFormElementValue.d.ts +1 -1
  193. package/activities/forms/GetFormEventData.d.ts +5 -0
  194. package/activities/forms/SetCurrentFormElementItem.d.ts +1 -0
  195. package/activities/forms/SetFormElementError.d.ts +0 -2
  196. package/activities/forms/SetFormElementEvent.d.ts +0 -3
  197. package/activities/forms/SetFormElementEvent.js +1 -1
  198. package/activities/forms/SetFormElementItemProperty.d.ts +0 -4
  199. package/activities/forms/SetFormElementItems.d.ts +0 -2
  200. package/activities/forms/SetFormElementProperty.d.ts +0 -3
  201. package/activities/forms/ShowFormElement.d.ts +0 -2
  202. package/activities/image/GetImageMetadata.d.ts +3 -0
  203. package/activities/image/RotateImage.d.ts +1 -0
  204. package/activities/index.js +1 -1
  205. package/activities/math/Abs.d.ts +1 -0
  206. package/activities/math/Cos.d.ts +1 -0
  207. package/activities/math/Max.d.ts +1 -0
  208. package/activities/math/Min.d.ts +1 -0
  209. package/activities/math/Pow.d.ts +1 -0
  210. package/activities/math/Random.d.ts +1 -0
  211. package/activities/math/Sin.d.ts +1 -0
  212. package/activities/math/Sqrt.d.ts +1 -0
  213. package/activities/math/Tan.d.ts +1 -0
  214. package/activities/pdf/AddGeoreferenceToPdf.d.ts +1 -0
  215. package/activities/pdf/AddImageToPdf.d.ts +1 -41
  216. package/activities/pdf/AddTextToPdf.d.ts +0 -38
  217. package/activities/pdf/CreatePdf.d.ts +0 -26
  218. package/activities/pdf/ExtractPdfPages.d.ts +2 -0
  219. package/activities/pdf/MergePdfs.d.ts +2 -0
  220. package/activities/server/CreateDownload.d.ts +1 -1
  221. package/activities/server/CreateEmailAttachment.d.ts +1 -1
  222. package/activities/server/DirectoryExists.d.ts +1 -1
  223. package/activities/server/FileExists.d.ts +1 -1
  224. package/activities/server/GetDirectoriesInDirectory.d.ts +1 -1
  225. package/activities/server/GetFilesInDirectory.d.ts +1 -1
  226. package/activities/server/ReadFile.d.ts +1 -0
  227. package/activities/server/ReadFileBytes.d.ts +1 -0
  228. package/activities/server/RunApplication.d.ts +3 -3
  229. package/activities/server/RunPython.d.ts +4 -4
  230. package/activities/server/SqlNonQuery.d.ts +1 -0
  231. package/activities/server/SqlQuery.d.ts +1 -0
  232. package/activities/server/SqlQueryUnsafe.d.ts +1 -0
  233. package/activities/ui/Alert.d.ts +0 -4
  234. package/activities/ui/Confirm.d.ts +1 -4
  235. package/activities/ui/Prompt.d.ts +1 -5
  236. package/activities/xlsx/ConvertDataTableToXlsx.d.ts +1 -0
  237. package/activities/xlsx/ConvertXlsxToDataSet.d.ts +1 -0
  238. package/execution/ProgramRunner.js +1 -1
  239. package/forms/FormDefinition.d.ts +4 -1
  240. package/forms/components/DateTimePicker.js +1 -1
  241. package/forms/components/TimePicker.js +1 -1
  242. package/forms/constants.d.ts +1 -1
  243. package/forms/dateUtilities.d.ts +12 -0
  244. package/forms/dateUtilities.js +1 -1
  245. package/forms/utils.d.ts +1 -1
  246. package/forms/utils.js +1 -1
  247. package/libs/version.d.ts +1 -1
  248. package/libs/version.js +1 -1
  249. package/package.json +1 -1
@@ -1,18 +1,15 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Difference activity. This activity relies on the geometry engine. */
3
3
  export interface DifferenceEngineTaskInputs {
4
- /** The input geometry to subtract from. */
5
4
  geometry: __esri.Geometry | __esri.Geometry[];
6
- /** The geometry being subtracted from inclusion. */
7
5
  subtractor: __esri.Geometry;
8
- /** Determines whether the difference is symmetric or not. If true, the symmetric difference between leftGeometry and rightGeometry is returned. Otherwise, rightGeometry is subtracted from leftGeometry. */
9
6
  symmetric: boolean;
10
7
  }
11
8
  /** Defines outputs for the Difference activity. */
12
9
  export interface DifferenceEngineTaskOutputs {
13
- /** Indicates the first difference result. */
10
+ /** @description The first difference result. */
14
11
  geometry?: __esri.Geometry;
15
- /** Indicates all difference results. */
12
+ /** @description The difference results. */
16
13
  results?: __esri.Geometry[];
17
14
  }
18
15
  export declare class DifferenceEngineTask implements IActivityHandler {
@@ -1,16 +1,13 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Distance Engine activity. This activity relies on the geometry engine. */
3
3
  export interface DistanceEngineTaskInputs {
4
- /** The first input geometry. */
5
4
  geometry1: __esri.Geometry;
6
- /** The second input geometry. */
7
5
  geometry2: __esri.Geometry;
8
- /** Measurement unit of the return value. Defaults to the units of the input geometries. Known values: meters | feet | kilometers | miles | nautical-miles | yards. */
9
6
  unit?: "meters" | "feet" | "kilometers" | "miles" | "nautical-miles" | "yards" | string | number;
10
7
  }
11
8
  /** Defines outputs for the Distance Engine activity. */
12
9
  export interface DistanceEngineTaskOutputs {
13
- /** The distance between the two geometries. */
10
+ /** @description The distance between the two geometries. */
14
11
  distance: number;
15
12
  }
16
13
  export declare class DistanceEngineTask implements IActivityHandler {
@@ -1,20 +1,15 @@
1
1
  import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Distance Service activity. This activity relies on an ArcGIS Geometry Service REST endpoint. */
3
3
  export interface DistanceServiceTaskInputs {
4
- /** The URL of the ArcGIS geometry service. */
5
4
  url: string;
6
- /** The first input geometry. */
7
5
  geometry1: __esri.Geometry;
8
- /** The second input geometry. */
9
6
  geometry2: __esri.Geometry;
10
- /** Measurement unit of the return value. If the unit is not specified the units are derived from the spatial reference. */
11
7
  unit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" | string;
12
- /** When true, the geodesic distance between geometry1 and geometry2 is measured. Defaults to false. */
13
8
  geodesic?: boolean;
14
9
  }
15
10
  /** Defines outputs for the Distance Service activity. */
16
11
  export interface DistanceServiceTaskOutputs {
17
- /** The distance between the two geometries. */
12
+ /** @description The distance between the two geometries. */
18
13
  distance: number;
19
14
  }
20
15
  export declare class DistanceServiceTask implements IActivityHandler {
@@ -2,14 +2,13 @@ import { MapProvider } from "./MapProvider";
2
2
  import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
3
3
  /** Defines inputs for the ExtendedSpatialReferenceInfo activity. This activity relies on the geometry engine. */
4
4
  export interface ExtendedSpatialReferenceInfoEngineTaskInputs {
5
- /** The input spatial reference. Valid inputs are projected spatial references (e.g., Web Mercator). Geographic spatial references (e.g., WGS84) are not valid. */
6
5
  spatialReference: __esri.SpatialReference | string | number;
7
6
  }
8
7
  /** Defines outputs for the ExtendedSpatialReferenceInfo activity. */
9
8
  export interface ExtendedSpatialReferenceInfoEngineTaskOutputs {
9
+ /** @description The extended spatial reference information. */
10
10
  spatialReference: __esri.geometryEngineAsyncSpatialReferenceInfo;
11
11
  }
12
- /** Gets extended spatial reference information. */
13
12
  export declare class ExtendedSpatialReferenceInfoEngineTask implements IActivityHandler {
14
13
  static readonly action = "gcx:wf:arcgis::ExtendedSpatialReferenceInfoEngineTask";
15
14
  static readonly suite = "gcx:wf:builtin";
@@ -1,12 +1,11 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the FeatureSet From JSON activity. */
3
3
  export interface FeatureSetFromJsonInputs {
4
- /** The FeatureSet JSON as a string or object. */
5
4
  json: string | object;
6
5
  }
7
6
  /** Defines outputs for the FeatureSet From JSON activity. */
8
7
  export interface FeatureSetFromJsonOutputs {
9
- /** The FeatureSet. */
8
+ /** @description The FeatureSet result. */
10
9
  featureSet?: __esri.FeatureSet;
11
10
  }
12
11
  export declare class FeatureSetFromJson implements IActivityHandler {
@@ -1,16 +1,13 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Flip activity. This activity relies on the geometry engine. */
3
3
  export interface FlipEngineTaskInputs {
4
- /** The geometry to flip. */
5
4
  geometry: __esri.Geometry;
6
- /** The orientation. Defaults to "horizontal". */
7
5
  orientation: "horizontal" | "vertical" | string;
8
- /** Optional point to flip geometry around. Defaults to the centroid of the geometry. */
9
6
  origin?: __esri.Point;
10
7
  }
11
8
  /** Defines the outputs for the Flip activity. */
12
9
  export interface FlipEngineTaskOutputs {
13
- /** The flipped geometry. */
10
+ /** @description The flipped geometry. */
14
11
  geometry?: __esri.Geometry;
15
12
  }
16
13
  export declare class FlipEngineTask implements IActivityHandler {
@@ -1,20 +1,15 @@
1
1
  import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
2
2
  /** Defines inputs for the FromGeoCoordinateString task. This task requires a geometry service. */
3
3
  export interface FromGeoCoordinateStringServiceTaskInputs {
4
- /** The URL of the ArcGIS geometry service. */
5
4
  url: string;
6
- /** An array of formatted strings as specified by conversionType. Example: ["01N AA 66021 00000" , "11S NT 00000 62155" , "31U BT 94071 65288"]. */
7
5
  strings: string[];
8
- /** The spatial reference or well-known ID to convert the input string coordinates to. */
9
6
  spatialReference: string | number | __esri.SpatialReference;
10
- /** The conversion type of the input strings. The default value is mgrs. */
11
7
  conversionType: "mgrs" | "usng" | "utm" | "geo-ref" | "gars" | "dms" | "ddm" | "dd" | string;
12
- /** Conversion options for mgrs, utm, and gars conversion types. See http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#//02r30000026z000000 for valid values and their descriptions. */
13
8
  conversionMode?: string;
14
9
  }
15
10
  /** Defines outputs for the FromGeoCoordinateString task. */
16
11
  export interface FromGeoCoordinateStringServiceTaskOutputs {
17
- /** The XY-coordinate pairs of the converted strings. */
12
+ /** @description The XY-coordinate pairs of the converted strings. */
18
13
  coordinates: number[][];
19
14
  }
20
15
  export declare class FromGeoCoordinateStringServiceTask implements IActivityHandler {
@@ -1,18 +1,14 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Generalize activity. This activity relies on the geometry engine. */
3
3
  export interface GeneralizeEngineTaskInputs {
4
- /** The geometry to generalize. */
5
4
  geometry: __esri.Geometry;
6
- /** The maximum allowed deviation from the generalized geometry to the original geometry. */
7
5
  maxDeviation: number;
8
- /** When true, the degenerate parts of the geometry will be removed from the output. Degenerate parts may be undesirable for drawing. */
9
6
  removeDegenerateParts?: boolean;
10
- /** Measurement unit for maxDeviation. Defaults to the units of the input geometry. Known values: meters | feet | kilometers | miles | nautical-miles | yards. */
11
7
  unit?: string | number;
12
8
  }
13
9
  /** Defines outputs for the Generalize activity. */
14
10
  export interface GeneralizeEngineTaskOutputs {
15
- /** The generalized geometry. */
11
+ /** @description The generalized geometry. */
16
12
  geometry: __esri.Geometry;
17
13
  }
18
14
  export declare class GeneralizeEngineTask implements IActivityHandler {
@@ -11,9 +11,9 @@ export interface GenerateArcGisTokenInputs {
11
11
  }
12
12
  /** Defines outputs for the GenerateArcGisToken activity. */
13
13
  export interface GenerateArcGisTokenOutputs {
14
- /** The generated access token. */
14
+ /** @description The generated access token. */
15
15
  token: string;
16
- /** The expiration time of the token in milliseconds since January 1st, 1970. */
16
+ /** @description The expiration time of the token in milliseconds since January 1st, 1970. */
17
17
  expires: number;
18
18
  }
19
19
  export declare class GenerateArcGisToken implements IActivityHandler {
@@ -1,5 +1,5 @@
1
1
  import { MapProvider } from "./MapProvider";
2
- import type { Webmap, WebmapPrintParameters } from "./runUtils";
2
+ import type { ExportWebMap, WebmapPrintParameters } from "./printing";
3
3
  import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
4
4
  /** Defines inputs for the GenerateWebmapForReport activity. */
5
5
  export interface GenerateWebmapForReportInputs {
@@ -9,12 +9,13 @@ export interface GenerateWebmapForReportInputs {
9
9
  }
10
10
  /** Defines outputs for the GenerateWebmapForReport activity. */
11
11
  export interface GenerateWebmapForReportOutputs {
12
+ /** @description The parameters required as input for printing a map in a report. */
12
13
  result: WebmapPrintParameters;
13
14
  }
14
15
  export declare class GenerateWebmapForReport implements IActivityHandler {
15
16
  static readonly action = "gcx:wf:geocortex::GenerateWebmapForReport";
16
17
  static readonly suite = "gcx:wf:builtin";
17
18
  execute(inputs: GenerateWebmapForReportInputs, context: IActivityContext, MapProviderType: typeof MapProvider): Promise<GenerateWebmapForReportOutputs>;
18
- getWebmap(mapProvider: MapProvider, scale?: number, trivia?: Record<string, any>): Promise<Webmap>;
19
+ getWebmap(mapProvider: MapProvider, scale?: number, trivia?: Record<string, any>): Promise<ExportWebMap>;
19
20
  getWgs84Extent(extent: __esri.Extent): Promise<__esri.Extent>;
20
21
  }
@@ -1 +1 @@
1
- var GenerateWebmapForReport_1;import{__decorate}from"tslib";import{ActivityInputError,ActivityNotImplementedError,GenericActivityError}from"../../Errors.js";import{activate}from"../../Hooks.js";import{validation}from"../../Validation.js";import{MapProvider}from"./MapProvider.js";let GenerateWebmapForReport=GenerateWebmapForReport_1=class{async execute(e,t,r){var a=validation.string("mapName",e.mapName,validation.never),o=validation.number("scale",e.scale,void 0);if(void 0!==o&&o<=0)throw new ActivityInputError("scale","Scale must be greater than zero.");const i=r.create();if(await i.load(),!i.map)throw new GenericActivityError("No map available. Unable to generate webmap parameters.");r=o||i.getScale(),e=e.extent||i.getExtent(),t=await this.getWebmap(i,r,t.ambient.trivia);return{result:{extent:await this.getWgs84Extent(e),mapName:a,scale:o||0,webmap:t}}}async getWebmap(e,t,r){throw console.warn("getWebmap needs to be overridden by a client implementation."),new ActivityNotImplementedError(GenerateWebmapForReport_1.action)}async getWgs84Extent(e){throw console.warn("getWgs84Extent needs to be overridden by a client implementation."),new ActivityNotImplementedError(GenerateWebmapForReport_1.action)}};GenerateWebmapForReport.action="gcx:wf:geocortex::GenerateWebmapForReport",GenerateWebmapForReport.suite="gcx:wf:builtin",GenerateWebmapForReport=GenerateWebmapForReport_1=__decorate([activate(MapProvider)],GenerateWebmapForReport);export{GenerateWebmapForReport};
1
+ var GenerateWebmapForReport_1;import{__decorate}from"tslib";import{ActivityInputError,ActivityNotImplementedError,GenericActivityError}from"../../Errors.js";import{activate}from"../../Hooks.js";import{validation}from"../../Validation.js";import{MapProvider}from"./MapProvider.js";let GenerateWebmapForReport=GenerateWebmapForReport_1=class{async execute(e,t,r){var a=validation.string("mapName",e.mapName,validation.never),o=validation.number("scale",e.scale,void 0);if(void 0!==o&&o<=0)throw new ActivityInputError("scale","Scale must be greater than zero.");const i=r.create();if(await i.load(),!i.map)throw new GenericActivityError(void 0,"No map available. Unable to generate webmap parameters.");r=o||i.getScale(),e=e.extent||i.getExtent(),t=await this.getWebmap(i,r,t.ambient.trivia);return{result:{extent:await this.getWgs84Extent(e),mapName:a,scale:o||0,webmap:t}}}async getWebmap(e,t,r){throw console.warn("getWebmap needs to be overridden by a client implementation."),new ActivityNotImplementedError(GenerateWebmapForReport_1.action)}async getWgs84Extent(e){throw console.warn("getWgs84Extent needs to be overridden by a client implementation."),new ActivityNotImplementedError(GenerateWebmapForReport_1.action)}};GenerateWebmapForReport.action="gcx:wf:geocortex::GenerateWebmapForReport",GenerateWebmapForReport.suite="gcx:wf:builtin",GenerateWebmapForReport=GenerateWebmapForReport_1=__decorate([activate(MapProvider)],GenerateWebmapForReport);export{GenerateWebmapForReport};
@@ -2,32 +2,23 @@ import { MapProvider } from "./MapProvider";
2
2
  import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
3
3
  /** Defines inputs for the Geocode activity. */
4
4
  export interface GeocodeInputs {
5
- /** The URL of the geocoding service. */
6
5
  url: string;
7
- /** The various address fields accepted by the corresponding geocode service. These fields are listed in the addressFields property of the JSON representation of the associated geocode service. Example: Suppose that addressFields of a geocode service resource includes fields with the following names: Street, City, State, and Zone. If you want to perform the Geocode operation by providing values for the Street and Zone fields, you'd set the query parameters as Street: 380 New York St, Zone: 92373. */
8
6
  address?: string | Record<string, any>;
9
- /** The maximum number of locations to be returned by a search, up to the maximum number allowed by the geocode service. If not specified, the maximum number of candidates for which the service is configured will be returned. Note: This parameter was added at 10.3, and is only supported by geocode services published with ArcGIS 10.3 for Server and later versions. */
10
7
  maxLocations?: number;
11
- /** The list of fields to be included in the returned result set. This list is a comma-delimited list of field names. If you specify the shape field in the list of return fields, it is ignored. For non-intersection addresses, you can specify the candidate fields from the geocode service resource. For intersection addresses, you can specify the intersection candidate fields from the geocode service resource. Example: [StreetName,StreetType]. Note: outFields = [*] returns all fields. */
12
8
  outFields?: string | string[];
13
- /** The well-known ID (WKID) of the spatial reference or a Spatial Reference object for the returned address candidates. For a list of valid WKID values, see http://resources.arcgis.com/EN/HELP/REST/APIREF/PCS.HTML and http://resources.arcgis.com/EN/HELP/REST/APIREF/GCS.HTML. */
14
9
  outSpatialReference?: number | string | __esri.SpatialReference;
15
- /** The spatial extent (bounding box) to be used in geocoding. The response will return only the candidates that are within this spatial extent. Unless the spatialReference is included in the searchExtent, the coordinates are assumed to be in the spatial reference of the locator. Note: This optional parameter is supported only for services that use locators created using ArcGIS 10.0 or later. If comma-separated values are used, they must be in the following format: <XMin>,<YMin>,<XMax>,<YMax>. The searchExtent coordinates should always use a period as the decimal separator even in countries where a comma is traditionally used. */
16
10
  searchExtent?: number[] | __esri.Extent;
17
- /** Defines an origin point location that is used with the distance parameter to sort geocoding candidates based on their proximity to said location. The distance parameter specifies the radial distance from the location in meters. If a distance is not specified, it defaults to 2000 meters. The location parameter can be represented by a Point object or as a comma-separated list. The spatial reference can be specified if a Point is used; otherwise the spatial reference is assumed to be the same as that of the geocoding service. If comma-separated values are used, they must be in the following format: <XCoordinate>,<YCoordinate>. Note: This parameter was added at 10.3 and is only supported by geocode services published with ArcGIS 10.3 for Server and later versions. */
18
11
  location?: number[] | __esri.Point;
19
- /** Specifies the radius of an area around a point location that is used to boost the rank of geocoding candidates so that candidates closest to the location are returned first. The distance value is in meters. If the distance parameter is specified, the location parameter must be specified as well. */
20
12
  distance?: number;
21
- /** The time span in milliseconds to wait for the request's results. */
22
13
  timeout?: number;
23
14
  }
24
15
  /** Defines outputs for the Geocode activity. */
25
16
  export interface GeocodeOutputs {
26
- /** Indicates the first candidate address. */
17
+ /** @description The first candidate address. */
27
18
  candidate?: __esri.AddressCandidate;
28
- /** Indicates all the candidates. */
19
+ /** @description The candidate addresses. */
29
20
  candidates?: __esri.AddressCandidate[];
30
- /** Indicates the result spatial reference. */
21
+ /** @description The result spatial reference. */
31
22
  spatialReference?: __esri.SpatialReference;
32
23
  }
33
24
  export declare class Geocode implements IActivityHandler {
@@ -1,12 +1,11 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Geometry From JSON activity. */
3
3
  export interface GeometryFromJsonInputs {
4
- /** The geometry JSON as a string or object. */
5
4
  json: string | object;
6
5
  }
7
6
  /** Defines outputs for the Geometry From JSON activity. */
8
7
  export interface GeometryFromJsonOutputs {
9
- /** The geometry. */
8
+ /** @description The geometry result. */
10
9
  geometry?: __esri.Geometry;
11
10
  }
12
11
  export declare class GeometryFromJson implements IActivityHandler {
@@ -2,20 +2,16 @@ import { MapProvider } from "./MapProvider";
2
2
  import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
3
3
  /** Defines inputs to the Synchronous Geoprocessor task. This task is suitable for geoprocessing services with a synchronous execution type. */
4
4
  export interface GeoprocessingInputs {
5
- /** The URL of the ArcGIS Server Geoprocessing service task. */
6
5
  url: string;
7
- /** The input arguments accepted by the task. */
8
6
  arguments: Record<string, any>;
9
- /** The spatial reference of the output geometries. If this is not specified, the output geometries are in the spatial reference of the input geometries. If processSpatialReference is specified and outputSpatialReference is not specified, the output geometries' spatial reference is processSpatialReference. */
10
7
  outSpatialReference?: number | string | __esri.SpatialReference;
11
- /** The spatial reference that the model uses to perform geometry operations. If processSpatialReference is specified while outputSpatialReference is not, the output geometries' spatial reference is processSpatialReference. */
12
8
  processSpatialReference?: number | string | __esri.SpatialReference;
13
9
  }
14
10
  /** Defines outputs to the Geoprocessor activity. */
15
11
  export interface GeoprocessingOutputs {
16
- /** The messages from the geoprocessing job. */
12
+ /** @description The messages from the geoprocessing job. */
17
13
  messages: __esri.GPMessage[];
18
- /** The results of the geoprocessing job. */
14
+ /** @description The results of the geoprocessing job. */
19
15
  results: Record<string, any>;
20
16
  }
21
17
  export declare class Geoprocessing implements IActivityHandler {
@@ -2,24 +2,20 @@ import { MapProvider } from "./MapProvider";
2
2
  import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
3
3
  /** Defines inputs to the Asynchronous Geoprocessor task. This task is suitable for geoprocessing services with an asynchronous execution type. */
4
4
  export interface GeoprocessingAsyncInputs {
5
- /** The URL of the ArcGIS Server Geoprocessing service task. */
6
5
  url: string;
7
- /** The input arguments accepted by the task. */
8
6
  arguments: Record<string, any>;
9
- /** The spatial reference of the output geometries. If this is not specified, the output geometries are in the spatial reference of the input geometries. If processSpatialReference is specified and outputSpatialReference is not specified, the output geometries' spatial reference is processSpatialReference. */
10
7
  outSpatialReference?: number | string | __esri.SpatialReference;
11
- /** The spatial reference that the model uses to perform geometry operations. If processSpatialReference is specified while outputSpatialReference is not, the output geometries' spatial reference is processSpatialReference. */
12
8
  processSpatialReference?: number | string | __esri.SpatialReference;
13
9
  }
14
10
  /** Defines outputs to the Asynchronous Geoprocessor task. */
15
11
  export interface GeoprocessingAsyncOutputs {
16
- /** The ID of the geoprocessing job. */
12
+ /** @description The ID of the geoprocessing job. */
17
13
  id?: string;
18
- /** The status of the geoprocessing job.. */
14
+ /** @description The status of the geoprocessing job. */
19
15
  status?: string;
20
- /** The messages from the geoprocessing job. */
16
+ /** @description The messages from the geoprocessing job. */
21
17
  messages?: __esri.GPMessage[];
22
- /** The results of the geoprocessing job. */
18
+ /** @description The results of the geoprocessing job. */
23
19
  results?: Record<string, any>;
24
20
  }
25
21
  export declare class GeoprocessingAsync implements IActivityHandler {
@@ -1,18 +1,15 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Get Attribute Value activity. */
3
3
  export interface GetAttributeValueInputs {
4
- /** The feature set or collection of graphics to search for the attribute. */
5
4
  features: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
6
- /** The name of the attribute to get. */
7
5
  attribute: string;
8
- /** The zero-based index of the feature to get the attribute from. If not specified, the first feature will be used. */
9
6
  index?: number;
10
7
  }
11
8
  /** Defines outputs for the Get Attribute Value activity. */
12
9
  export interface GetAttributeValueOutputs {
13
- /** Indicates the feature containing the first assigned attribute. */
10
+ /** @description The feature containing the first assigned attribute. */
14
11
  feature?: __esri.Graphic;
15
- /** Indicates the value of the specified attribute for the first feature. */
12
+ /** @description The value of the specified attribute for the first feature. */
16
13
  value?: any;
17
14
  }
18
15
  export declare class GetAttributeValue implements IActivityHandler {
@@ -1,16 +1,14 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Get Attributes Value activity. */
3
3
  export interface GetAttributeValuesInputs {
4
- /** The feature set or collection of graphics to search for the attribute. */
5
4
  features: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
6
- /** The name of the attribute to get. */
7
5
  attribute: string;
8
6
  }
9
7
  /** Defines outputs for the Get Attribute Values activity. */
10
8
  export interface GetAttributeValuesOutputs {
11
- /** Indicates the value for the first feature. */
9
+ /** @description The value of the first feature having the attribute assigned. */
12
10
  value?: any;
13
- /** Indicates all the values for the features having the attribute assigned. */
11
+ /** @description The values for the features having the attribute assigned. */
14
12
  values?: any[];
15
13
  }
16
14
  export declare class GetAttributeValues implements IActivityHandler {
@@ -1,12 +1,11 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Get Centroid activity. */
3
3
  export interface GetCentroidInputs {
4
- /** The geometry whose centroid will be calculated. In the case of a Polyline, the activity returns the average of midpoints of the Polyline's line segments. */
5
4
  geometry: __esri.Geometry | __esri.Geometry[];
6
5
  }
7
6
  /** Defines outputs for the Get Centroid activity. */
8
7
  export interface GetCentroidOutputs {
9
- /** The centroid of the input geometry. */
8
+ /** @description The centroid of the input geometry. */
10
9
  centroid?: __esri.Point;
11
10
  }
12
11
  export declare class GetCentroid implements IActivityHandler {
@@ -2,24 +2,18 @@ import type { FeatureLayerInfo } from "./libs/arcGisRestApi";
2
2
  import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
3
3
  /** Defines inputs for the GetCodedValueDomain activity. */
4
4
  export interface GetCodedValueDomainInputs {
5
- /** The FeatureLayer or table that contains the fields. */
6
5
  layer?: __esri.FeatureLayer;
7
- /** The FeatureLayerInfo object containing the layer or table's fields. */
8
6
  layerInfo?: FeatureLayerInfo;
9
- /** The id or name of the feature type whose domain is of interest. */
10
7
  type?: string | number;
11
- /** The name of the field whose domain is of interest. */
12
8
  field?: string;
13
9
  url?: string;
14
- /** The layer definition used to describe a dynamic layer. */
15
10
  dynamicLayerDefinition?: any;
16
- /** The layer source used with a dynamic layer. */
17
11
  source?: any;
18
- /** Indicates the timeout for the request. */
19
12
  timeout?: number;
20
13
  }
21
14
  /** Defines outputs for the GetCodedValueDomain activity. */
22
15
  export interface GetCodedValueDomainOutputs {
16
+ /** @description The coded value domain. */
23
17
  domain: __esri.CodedValueDomain;
24
18
  }
25
19
  export declare class GetCodedValueDomain implements IActivityHandler {
@@ -1,40 +1,59 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the GetCurrentPosition activity. */
3
3
  export interface GetCurrentPositionInputs {
4
- /** Whether to request the best possible location data */
5
4
  enableHighAccuracy?: boolean;
6
- /** The maximum age of a cached position that will be accepted. */
7
5
  maximumAge?: number;
8
- /** The amount of time to wait for a location. */
9
6
  timeout?: number;
10
- /** Whether to use multiple readings to improve the accuracy of the geolocation result. */
11
7
  useMultipleReadings?: boolean;
12
8
  accuracyThreshold?: number;
13
9
  }
14
10
  /** Defines outputs for the GetCurrentPosition activity. */
15
11
  export interface GetCurrentPositionOutputs {
12
+ /** @description The position in WGS84. */
16
13
  position: __esri.Point;
14
+ /** @description Represents the accuracy of the latitude and longitude properties, expressed in meters. */
17
15
  accuracy: number;
16
+ /** @description Represents the position's altitude in metres, relative to sea level. This value can be null if the implementation cannot provide the data. */
18
17
  altitude?: number;
18
+ /** @description Represents the position's altitude in metres, relative to sea level. This value can be null if the implementation cannot provide the data. */
19
19
  altitudeAccuracy?: number;
20
+ /** @description Represents the direction in which the device is traveling. This value, specified in degrees, indicates how far off from heading true north the device is. If the device is unable to provide heading information, this value is null. */
20
21
  heading?: number;
22
+ /** @description Represents the position's latitude in decimal degrees. */
21
23
  latitude: number;
24
+ /** @description Represents the position's longitude in decimal degrees. */
22
25
  longitude: number;
26
+ /** @description Represents the velocity of the device in meters per second. This value can be null. */
23
27
  speed?: number;
28
+ /** @description Represents the time (in Unix Epoch milliseconds) at which the location was retrieved. */
24
29
  timestamp: number;
30
+ /** @description Represents the name of the receiver used to get the location. */
25
31
  recieverName?: string;
32
+ /** @description Represents the position dilution of precision. */
26
33
  pdop?: number;
34
+ /** @description Represents the horizontal dilution of precision. */
27
35
  hdop?: number;
36
+ /** @description Represents the vertical dilution of precision. */
28
37
  vdop?: number;
38
+ /** @description Represents the type of gnss location fix. Possible values are: 0 [Invalid], 1 [GPS], 2 [Differential GPS], 3 [Precise Positioning Service], 4 [Real Time Kinematic (Fixed)], 5 [Real Time Kinematic (Floating)], 6 [Estimated], 7 [Manual Input] or 8 [Simulation]. */
29
39
  fixType?: number;
40
+ /** @description Represents the age of the differential correction being applied to the location(s). */
30
41
  correctionAge?: number;
42
+ /** @description Represents the well known id of the station used for differential correction. */
31
43
  stationId?: number;
44
+ /** @description Represents the number of satellites used in calculating position. */
32
45
  numberOfSatellites?: number;
46
+ /** @description Represents the average horizontal accuracy(m). */
33
47
  averageAccuracy?: number;
48
+ /** @description Represents the average vertical accuracy(m). */
34
49
  averageAltitudeAccuracy?: number;
50
+ /** @description Represents the number of positions used in determining the average location. */
35
51
  averagedPositions?: number;
52
+ /** @description Represents the standard deviation of the average. */
36
53
  standardDeviation?: number;
54
+ /** @description Represents the reason of an error occurring when using the geolocating device. This value will be defined if there was an error. */
37
55
  errorCode?: number;
56
+ /** @description Represents the reason of an error occurring when using the geolocating device. This value will be defined if there was an error. */
38
57
  errorMessage?: string;
39
58
  }
40
59
  export declare class GetCurrentPosition implements IActivityHandler {
@@ -1,16 +1,14 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Get Geometries activity. */
3
3
  export interface GetFeatureGeometriesInputs {
4
- /** The feature set or list of features whose geometries will be returned. */
5
4
  features: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
6
- /** If false, the activity returns a list of geometries. If true the activity returns a single geometry that results from unioning the returned geometries together. Unioning takes advantage of the geometry engine. Defaults to false. */
7
5
  union?: boolean;
8
6
  }
9
7
  /** Defines outputs for the Get Geometries activity. */
10
8
  export interface GetFeatureGeometriesOutputs {
11
- /** The first geometry result. */
9
+ /** @description The first geometry result. */
12
10
  geometry?: __esri.Geometry;
13
- /** The result geometries. */
11
+ /** @description The result geometries. */
14
12
  geometries?: __esri.Geometry[];
15
13
  }
16
14
  export declare class GetFeatureGeometries implements IActivityHandler {
@@ -1,14 +1,12 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Get Geometry activity. */
3
3
  export interface GetFeatureGeometryInputs {
4
- /** The FeatureSet or collection of graphics to get the geometry from. */
5
4
  features: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
6
- /** The zero-based index of the feature to get the geometry from. If not specified, the first feature will be used. */
7
5
  index?: number;
8
6
  }
9
7
  /** Defines outputs for the Get Geometry activity. */
10
8
  export interface GetFeatureGeometryOutputs {
11
- /** Indicates the geometry of the feature. */
9
+ /** @description The geometry of the feature. */
12
10
  geometry?: __esri.Geometry;
13
11
  }
14
12
  export declare class GetFeatureGeometry implements IActivityHandler {
@@ -1,17 +1,14 @@
1
1
  import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
2
2
  /** Defines inputs to the GetFeatureLayerInfo activity. */
3
3
  export interface GetFeatureLayerInfoInputs {
4
- /** The URL of the ArcGIS feature layer or table. */
5
4
  url: string;
6
- /** The layer definition used to describe a dynamic layer. */
7
5
  dynamicLayerDefinition?: any;
8
- /** The layer source used with a dynamic layer. */
9
6
  source?: any;
10
- /** The time span in milliseconds to wait for the request's results. */
11
7
  timeout?: number;
12
8
  }
13
9
  /** Defines outputs to the GetFeatureLayerInfo activity. */
14
10
  export interface GetFeatureLayerInfoOutputs {
11
+ /** @description The result layer or table information. */
15
12
  layerInfo: {
16
13
  fields: __esri.Field[];
17
14
  types?: __esri.FeatureType[];
@@ -1 +1 @@
1
- import FeatureType from"@arcgis/core/layers/support/FeatureType";import Field from"@arcgis/core/layers/support/Field";import{GenericActivityError}from"../../Errors.js";import{validation}from"../../Validation.js";import{performRequest}from"./tools.js";class GetFeatureLayerInfo{async execute(e,r){var t=validation.string("url",e.url,validation.never),i=validation.number("timeout",e.timeout,void 0);const o={};e.dynamicLayerDefinition?o.layer=e.dynamicLayerDefinition:e.source&&(o.layer={source:e.source});const a=await performRequest(t,o,i,r.cancellationToken.signal);if(!a.fields)throw new GenericActivityError('Error running the "Get Feature Layer Info" activity. The response did not include the required "fields" property.');return a.fields=a.fields.map(e=>Field.fromJSON(e)),a.types&&(a.types=a.types.map(e=>FeatureType.fromJSON(e))),{layerInfo:a}}}GetFeatureLayerInfo.action="gcx:wf:arcgis::GetFeatureLayerInfo",GetFeatureLayerInfo.suite="gcx:wf:builtin";export{GetFeatureLayerInfo};
1
+ import FeatureType from"@arcgis/core/layers/support/FeatureType";import Field from"@arcgis/core/layers/support/Field";import{GenericActivityError}from"../../Errors.js";import{validation}from"../../Validation.js";import{performRequest}from"./tools.js";class GetFeatureLayerInfo{async execute(e,r){var t=validation.string("url",e.url,validation.never),i=validation.number("timeout",e.timeout,void 0);const o={};e.dynamicLayerDefinition?o.layer=e.dynamicLayerDefinition:e.source&&(o.layer={source:e.source});const a=await performRequest(t,o,i,r.cancellationToken.signal);if(!a.fields)throw new GenericActivityError(void 0,'Error running the "Get Feature Layer Info" activity. The response did not include the required "fields" property.');return a.fields=a.fields.map(e=>Field.fromJSON(e)),a.types&&(a.types=a.types.map(e=>FeatureType.fromJSON(e))),{layerInfo:a}}}GetFeatureLayerInfo.action="gcx:wf:arcgis::GetFeatureLayerInfo",GetFeatureLayerInfo.suite="gcx:wf:builtin";export{GetFeatureLayerInfo};
@@ -1,14 +1,13 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the GetFeatureSetExtent activity. */
3
3
  export interface GetFeatureSetExtentInputs {
4
- /** The features to calculate the bounding extent of. */
5
4
  features: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
6
5
  }
7
6
  /** Defines outputs for the GetFeatureSetExtent activity. */
8
7
  export interface GetFeatureSetExtentOutputs {
9
- /** The extent of all the input features. */
8
+ /** @description The extent of all the input features. */
10
9
  extent: __esri.Extent;
11
- /** The center of the extent. */
10
+ /** @description The center of the extent. */
12
11
  center: __esri.Point;
13
12
  }
14
13
  export declare class GetFeatureSetExtent implements IActivityHandler {
@@ -1,16 +1,14 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  /** Defines inputs for the Get Object IDs activity. */
3
3
  export interface GetFeatureSetObjectIdsInputs {
4
- /** The feature set to obtain the object IDs from. Note that object IDs should be integers. If another data type is used (such as strings) to denote object IDs, they should be retrieved with the Get Attribute Values activity. */
5
4
  features: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
6
- /** The name of the field containing the features' object IDs. Defaults to OBJECTID. */
7
5
  objectIdField?: string;
8
6
  }
9
7
  /** Defines outputs for the Get Object IDs activity. */
10
8
  export interface GetFeatureSetObjectIdsOutputs {
11
- /** Indicates the ID the first feature in the feature set. */
9
+ /** @description The ID of the first feature in the feature set. */
12
10
  id?: number;
13
- /** Indicates all the IDs of the features in the feature set. */
11
+ /** @description The IDs of the features in the feature set. */
14
12
  ids?: number[];
15
13
  }
16
14
  export declare class GetFeatureSetObjectIds implements IActivityHandler {
@@ -1,17 +1,14 @@
1
1
  import type { IActivityHandler } from "../../IActivityHandler";
2
2
  import type { Item } from "../../forms/FormDefinition";
3
3
  export interface GetFormElementItemsFromFeaturesInputs {
4
- /** The features to be converted to the items collection. */
5
4
  features: __esri.Graphic[];
6
- /** The name of the feature field used to populate the items' labels. */
7
5
  labelFieldName?: string;
8
- /** The name of the feature field used to populate the items' values. If not provided, an item's backing feature is used in a DataRef object. */
9
6
  valueFieldName?: string;
10
7
  /** The features' fields. If present, the activity can attempt to match inputs to field aliases. */
11
8
  fields?: __esri.Field[];
12
9
  }
13
10
  export interface GetFormElementItemsFromFeaturesOutputs {
14
- /** The result items collection. */
11
+ /** @description The result items collection. */
15
12
  items: Record<string, Item>;
16
13
  }
17
14
  export declare class GetFormElementItemsFromFeatures implements IActivityHandler {
@@ -5,9 +5,9 @@ export interface GetGeometryExtentInputs {
5
5
  }
6
6
  /** Defines outputs for the GetGeometryExtent activity. */
7
7
  export interface GetGeometryExtentOutputs {
8
- /** The extent of the geometries. */
8
+ /** @description The extent of the geometries. */
9
9
  extent: __esri.Extent;
10
- /** The center of the extent of the geometries. */
10
+ /** @description The center of the extent of the geometries. */
11
11
  center: __esri.Point;
12
12
  }
13
13
  export declare class GetGeometryExtent implements IActivityHandler {
@@ -2,14 +2,12 @@ import { MapProvider } from "./MapProvider";
2
2
  import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
3
3
  /** Defines inputs to the GetGraphics activity. */
4
4
  export interface GetGraphicsInputs {
5
- /** The ID of the graphics layer to get the features from. */
6
5
  layerId?: string | number;
7
- /** The type of geometry to retrieve from the graphics layer. If not specified, all features will be returned. */
8
6
  geometryType?: string;
9
7
  }
10
8
  /** Defines outputs to the GetGraphics activity. */
11
9
  export interface GetGraphicsOutputs {
12
- /** The features of the graphics layer. */
10
+ /** @description The features of the graphics layer. */
13
11
  features: __esri.Graphic[];
14
12
  }
15
13
  export declare class GetGraphics implements IActivityHandler {