@arcgis/core 4.32.0-next.20250220 → 4.32.0-next.20250221

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 (110) hide show
  1. package/arcade/featureSetUtils.js +1 -1
  2. package/arcade/functions/featuresetbase.js +1 -1
  3. package/assets/esri/core/workers/RemoteClient.js +1 -1
  4. package/assets/esri/core/workers/chunks/37323e58dbec303f5054.js +1 -0
  5. package/assets/esri/core/workers/chunks/{7b07410fe98015b80c74.js → 5341b86c2fb5347393c5.js} +1 -1
  6. package/assets/esri/core/workers/chunks/60d5cbfa9e1c6b3c98df.js +1 -0
  7. package/assets/esri/core/workers/chunks/{a5acbdb8347a809a26c0.js → 610c3249fe81e370af8c.js} +1 -1
  8. package/assets/esri/core/workers/chunks/{d98c78e89d70ad0b8628.js → 6ab476f696290d190c6c.js} +1 -1
  9. package/assets/esri/core/workers/chunks/7292bb19b73f601d891b.js +1 -0
  10. package/assets/esri/core/workers/chunks/78c066e8fe167d4ab817.js +1 -0
  11. package/assets/esri/core/workers/chunks/80744ad7f7656ef918db.js +1 -0
  12. package/assets/esri/core/workers/chunks/8bbe8df40df2b8e54562.js +1 -0
  13. package/assets/esri/core/workers/chunks/caf410ed75c40b3703eb.js +1 -0
  14. package/assets/esri/core/workers/chunks/df506c4f81affce248c4.js +1 -0
  15. package/assets/esri/core/workers/chunks/{4be39bc2d2edd94bdb75.js → e481e7d508274bc83c70.js} +1 -1
  16. package/assets/esri/core/workers/chunks/eefa1dfeb63ce965bb40.js +1 -0
  17. package/assets/esri/core/workers/chunks/fd8790291348fb7ead55.js +1 -0
  18. package/assets/esri/themes/base/widgets/_ItemList.scss +14 -0
  19. package/assets/esri/themes/dark/main.css +1 -1
  20. package/assets/esri/themes/light/main.css +1 -1
  21. package/assets/esri/themes/light/view.css +1 -1
  22. package/core/sql/AggregateFunctions.js +1 -1
  23. package/core/sql/DateOnly.js +1 -1
  24. package/core/sql/SqlInterval.js +1 -1
  25. package/core/sql/SqlTimestampOffset.js +1 -1
  26. package/core/sql/TimeOnly.js +1 -1
  27. package/core/sql/WhereClause.js +1 -1
  28. package/core/sql/WhereGrammar.js +1 -1
  29. package/core/sql/sqlCompareUtils.js +1 -1
  30. package/core/sql/sqlDateParsingUtils.js +1 -1
  31. package/editing/sharedTemplates/SharedTemplate.js +1 -1
  32. package/editing/sharedTemplates/SharedTemplateMetadata.js +1 -1
  33. package/editing/sharedTemplates/SharedTemplateProvider.js +1 -1
  34. package/editing/sharedTemplates/executor/support/createServiceEdit.js +1 -1
  35. package/editing/sharedTemplates/support/sharedTemplateErrors.js +1 -1
  36. package/editing/sharedTemplates/templateDefinitions/FeatureTemplateDefinition.js +1 -1
  37. package/editing/sharedTemplates/templateDefinitions/GroupTemplateDefinition.js +1 -1
  38. package/editing/sharedTemplates/templateDefinitions/PresetTemplateDefinition.js +1 -1
  39. package/editing/sharedTemplates/templateDefinitions/TemplateDefinitionBase.js +1 -1
  40. package/editing/sharedTemplates/templateDefinitions/parts/FeatureTemplateRelationshipPart.js +1 -1
  41. package/editing/sharedTemplates/templateDefinitions/parts/GroupTemplatePart.js +1 -1
  42. package/editing/sharedTemplates/templateDefinitions/parts/TemplatePartBase.js +1 -1
  43. package/interfaces.d.ts +448 -63
  44. package/layers/RouteLayer.js +1 -1
  45. package/layers/orientedImagery/core/coverageUtils.js +1 -1
  46. package/layers/orientedImagery/transformations/imageToWorld.js +1 -1
  47. package/layers/orientedImagery/transformations/rectifyMapPoint.js +1 -1
  48. package/layers/orientedImagery/transformations/utils.js +1 -1
  49. package/layers/orientedImagery/transformations/worldToImage.js +1 -1
  50. package/layers/support/Relationship.js +1 -1
  51. package/networks/RulesTable.js +1 -1
  52. package/package.json +1 -1
  53. package/rest/support/PointBarrier.js +1 -1
  54. package/support/revision.js +1 -1
  55. package/symbols/cim/fitVectorMarker.js +1 -1
  56. package/undoredo/support/Services.js +1 -1
  57. package/views/2d/AnimationManager.js +1 -1
  58. package/views/2d/layers/RouteLayerView2D.js +1 -1
  59. package/views/2d/layers/features/sources/FeatureCache.js +1 -1
  60. package/views/2d/layers/features/sources/FeatureSourceQueryInfo.js +1 -1
  61. package/views/2d/layers/features/sources/strategies/support/snapshotUtils.js +5 -0
  62. package/views/2d/layers/features/support/whereUtils.js +1 -1
  63. package/views/View.js +1 -1
  64. package/views/animation/easing.js +1 -1
  65. package/widgets/Directions.js +1 -1
  66. package/widgets/Editor/AddAssociationWorkflow.js +1 -1
  67. package/widgets/Editor/CreateFeaturesWorkflow.js +1 -1
  68. package/widgets/Editor/CreateFeaturesWorkflowData.js +1 -1
  69. package/widgets/Editor/Edits.js +1 -1
  70. package/widgets/Editor/UpdateWorkflow.js +1 -1
  71. package/widgets/Editor/components/PendingFeatureList.js +1 -1
  72. package/widgets/Editor/workflowUtils.js +1 -1
  73. package/widgets/Editor.js +1 -1
  74. package/widgets/FeatureForm/FeatureFormUtilityNetworkAssociations/AssociationDetails.js +1 -1
  75. package/widgets/FeatureForm/FeatureFormUtilityNetworkAssociations/FeatureFormUtilityNetworkAssociationList.js +1 -1
  76. package/widgets/FeatureForm/FeatureFormUtilityNetworkAssociations/UtilityNetworkAssociationItemList.js +1 -1
  77. package/widgets/FeatureForm/FeatureFormUtilityNetworkAssociations/UtilityNetworkAssociationSettings.js +1 -1
  78. package/widgets/FeatureForm/FeatureFormUtilityNetworkAssociations/VisibleElements.js +5 -0
  79. package/widgets/FeatureForm/UtilityNetworkAssociationAddAssociationViewModel.js +1 -1
  80. package/widgets/FeatureForm/UtilityNetworkAssociationInput.js +1 -1
  81. package/widgets/FeatureForm/VisibleElements.js +5 -0
  82. package/widgets/FeatureForm/featureFormUtils.js +1 -1
  83. package/widgets/FeatureForm.js +1 -1
  84. package/widgets/OrientedImageryViewer/OrientedImageryViewerViewModel.js +1 -1
  85. package/widgets/OrientedImageryViewer/adapters/sketch/DataCaptureAdapter.js +5 -0
  86. package/widgets/OrientedImageryViewer/adapters/view/SceneViewAdapter.js +1 -1
  87. package/widgets/OrientedImageryViewer/components/ImageOverlays.js +1 -1
  88. package/widgets/OrientedImageryViewer/components/ImageViewerViewModel.js +1 -1
  89. package/widgets/OrientedImageryViewer/components/OverlayLayersListViewModel.js +1 -1
  90. package/widgets/OrientedImageryViewer/constants.js +1 -1
  91. package/widgets/OrientedImageryViewer/dataCaptureUtils.js +5 -0
  92. package/widgets/OrientedImageryViewer/symbols.js +1 -1
  93. package/widgets/OrientedImageryViewer.js +1 -1
  94. package/widgets/support/FilterCondition.js +1 -1
  95. package/widgets/support/GoTo.js +1 -1
  96. package/widgets/support/UtilityNetworkAssociations/FeatureUtilityNetworkAssociationsViewModel.js +1 -1
  97. package/widgets/support/goToUtils.js +1 -1
  98. package/widgets/support/symbolPreviewUtils.js +1 -1
  99. package/assets/esri/core/workers/chunks/10ca2107c99fab6bcc3b.js +0 -1
  100. package/assets/esri/core/workers/chunks/122ed10cac9f192e1eec.js +0 -1
  101. package/assets/esri/core/workers/chunks/1b3a52ce3e8e5be4d196.js +0 -1
  102. package/assets/esri/core/workers/chunks/35e4af82a08b4eadbfab.js +0 -1
  103. package/assets/esri/core/workers/chunks/6f007703662e714b2f0a.js +0 -1
  104. package/assets/esri/core/workers/chunks/8232a2c4bdc3011bb9e3.js +0 -1
  105. package/assets/esri/core/workers/chunks/8b8579d81728cb35bb29.js +0 -1
  106. package/assets/esri/core/workers/chunks/934857de20f6f5c15188.js +0 -1
  107. package/assets/esri/core/workers/chunks/b8fae500c69ca2cff62a.js +0 -1
  108. package/assets/esri/core/workers/chunks/ebe832bd57a316364ca1.js +0 -1
  109. package/widgets/OrientedImageryViewer/adapters/sketch/DigitizationAdapter.js +0 -5
  110. package/widgets/OrientedImageryViewer/digitizationUtils.js +0 -5
package/interfaces.d.ts CHANGED
@@ -2205,7 +2205,7 @@ declare namespace __esri {
2205
2205
  /**
2206
2206
  * Creates a {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#Profile Profile} definition for an Arcade profile implemented in the ArcGIS Maps SDK for JavaScript.
2207
2207
  *
2208
- * @param profileName The name of the Arcade profile definition to create.
2208
+ * @param profileName The name of the Arcade profile definition to create. _The values `"feature-reduction-popup"` and `"feature-reduction-popup-element"` are deprecated since 4.32._
2209
2209
  *
2210
2210
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-arcade.html#createArcadeProfile Read more...}
2211
2211
  */
@@ -28804,8 +28804,7 @@ declare namespace __esri {
28804
28804
  * --------------------------------|----------------
28805
28805
  * directionsOutputType | "featuresets"
28806
28806
  * ignoreInvalidLocations | `true`
28807
- * preserveFirstStop | `true`
28808
- * preserveLastStop | `true`
28807
+ * preserveObjectID | `true`
28809
28808
  * returnBarriers | `true`
28810
28809
  * returnDirections | `true`
28811
28810
  * returnPolygonBarriers | `true`
@@ -38791,6 +38790,12 @@ declare namespace __esri {
38791
38790
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#cardinality Read more...}
38792
38791
  */
38793
38792
  cardinality: "one-to-one" | "one-to-many" | "many-to-many";
38793
+ /**
38794
+ * The globally unique identifier for the relationship.
38795
+ *
38796
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#catalogId Read more...}
38797
+ */
38798
+ catalogId: string | nullish;
38794
38799
  /**
38795
38800
  * Indicates whether the relationship is composite.
38796
38801
  *
@@ -38878,6 +38883,12 @@ declare namespace __esri {
38878
38883
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#cardinality Read more...}
38879
38884
  */
38880
38885
  cardinality?: "one-to-one" | "one-to-many" | "many-to-many";
38886
+ /**
38887
+ * The globally unique identifier for the relationship.
38888
+ *
38889
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#catalogId Read more...}
38890
+ */
38891
+ catalogId?: string | nullish;
38881
38892
  /**
38882
38893
  * Indicates whether the relationship is composite.
38883
38894
  *
@@ -49208,7 +49219,7 @@ declare namespace __esri {
49208
49219
  /**
49209
49220
  * Returns all associations filtered by the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html QueryAssociationsParameters} in a utility network.
49210
49221
  *
49211
- * @param props The parameters required by this functions include {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#elements QueryAssociationsParameters}, what {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#types QueryAssociationsParameters} of associations to return, {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-QueryAssociationsParameters.html#moment QueryAssociationsParameters} and more.
49222
+ * @param props Describes the parameters required to execute the `queryAssociations` method, which returns a list of {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-Association.html associations} filtered by the parameters set.
49212
49223
  *
49213
49224
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#queryAssociations Read more...}
49214
49225
  */
@@ -49223,11 +49234,11 @@ declare namespace __esri {
49223
49234
  */
49224
49235
  submitTopologyValidationJob(parameters: ValidateTopologyProps, options?: RequestOptions): Promise<TopologyValidationJobInfo | nullish>;
49225
49236
  /**
49226
- * Takes the traceProps and preforms an async trace on a {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html UtilityNetwork}.
49237
+ * The submitTraceJob method takes a set of parameters, executes the asynchronous trace on the backend, and returns trace results.
49227
49238
  *
49228
49239
  * @param props Props consists of namedTraceConfigurationGlobalId, traceLocations, outSpatialReference, traceConfiguration, resultTypes, and traceType.
49229
49240
  * @param props.namedTraceConfigurationGlobalId The globalId (UUID) of the named trace configuration persisted in the network.
49230
- * @param props.gdbVersion The geodatabase version to execute the function against. Defaults to `SDE.DEFAULT` when no version is provided.
49241
+ * @param props.gdbVersion The `gdbVersion` property will be hydrated from this {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html UtilityNetwork}.
49231
49242
  * @param props.traceLocations The list of starting points and barriers that will define where the trace starts and stops. This parameter can be optional (defaults to empty array) if {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#minStartingPoints minStartingPoints} in `NamedTraceConfiguration` is set to `none`.
49232
49243
  * @param props.outSpatialReference The spatial reference that should be used to project the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html aggregated geometries} returned by the trace (if applicable).
49233
49244
  * @param props.traceConfiguration Defines the properties of a trace.
@@ -49240,17 +49251,17 @@ declare namespace __esri {
49240
49251
  /**
49241
49252
  * Given an extent, returns all associations within this extent and their synthesized geometries.
49242
49253
  *
49243
- * @param params The parameters required by this functions include extent, what types of associations to return, spatial reference and more
49254
+ * @param params Describes the parameters required to execute the `synthesizeAssociationGeometries` method which synthesizes and returns the associations geometries in a given extent.
49244
49255
  *
49245
49256
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html#synthesizeAssociationGeometries Read more...}
49246
49257
  */
49247
49258
  synthesizeAssociationGeometries(params: SynthesizeAssociationGeometriesParameters): Promise<AssociationGeometriesResult>;
49248
49259
  /**
49249
- * Takes the traceProps and preforms a trace on a {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html UtilityNetwork}.
49260
+ * The trace method takes a set of parameters, executes the trace on the backend, and returns trace results.
49250
49261
  *
49251
49262
  * @param props Props consists of namedTraceConfigurationGlobalId, traceLocations, outSpatialReference, traceConfiguration, resultTypes, and traceType.
49252
49263
  * @param props.namedTraceConfigurationGlobalId The globalId (UUID) of the named trace configuration persisted in the network.
49253
- * @param props.gdbVersion The geodatabase version to execute the function against. Defaults to `SDE.DEFAULT` when no version is provided.
49264
+ * @param props.gdbVersion The `gdbVersion` property will be hydrated from this {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html UtilityNetwork}.
49254
49265
  * @param props.traceLocations The list of starting points and barriers that will define where the trace starts and stops. This parameter can be optional (defaults to empty array) if {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-NamedTraceConfiguration.html#minStartingPoints minStartingPoints} in `NamedTraceConfiguration` is set to `none`.
49255
49266
  * @param props.outSpatialReference The spatial reference that should be used to project the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-AggregatedGeometry.html aggregated geometries} returned by the trace (if applicable).
49256
49267
  * @param props.traceConfiguration Defines the properties of a trace.
@@ -62959,116 +62970,440 @@ declare namespace __esri {
62959
62970
  interface SourceTypeValueBehaviorProperties {
62960
62971
  }
62961
62972
 
62962
- export class CIMFilteredFindPathsConfiguration extends JSONSupport {
62973
+ export interface CIMFilteredFindPathsConfiguration extends Accessor, JSONSupport {
62974
+ }
62975
+
62976
+ export class CIMFilteredFindPathsConfiguration {
62977
+ /**
62978
+ * Specifies the direction which the algorithm uses to traverse relationship in the path.
62979
+ *
62980
+ * @default "Any"
62981
+ *
62982
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#defaultTraversalDirectionType Read more...}
62983
+ */
62963
62984
  defaultTraversalDirectionType: "Any" | "Forward" | "Backward";
62985
+ /**
62986
+ * The {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html entities} to use as the destination of the path.
62987
+ *
62988
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#destinationEntities Read more...}
62989
+ */
62964
62990
  destinationEntities: CIMFilteredFindPathsEntity[];
62991
+ /**
62992
+ * Specifies how the origin and destination entities are used in the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous} algorithm.
62993
+ *
62994
+ * @default "AnyOriginAnyDestination"
62995
+ *
62996
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#entityUsage Read more...}
62997
+ */
62965
62998
  entityUsage: | "AnyOriginAnyDestination"
62966
62999
  | "AnyOriginAllDestinations"
62967
63000
  | "AllOriginsAnyDestination"
62968
63001
  | "AllOriginsAllDestinations"
62969
63002
  | "EachPair";
63003
+ /**
63004
+ * The maximum number of paths that the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}
63005
+ * algorithm returns.
63006
+ *
63007
+ * @default 100000
63008
+ *
63009
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#maxCountPaths Read more...}
63010
+ */
62970
63011
  maxCountPaths: number;
63012
+ /**
63013
+ * The maximum path length.
63014
+ *
63015
+ * @default 0
63016
+ *
63017
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#maxPathLength Read more...}
63018
+ */
62971
63019
  maxPathLength: number;
63020
+ /**
63021
+ * The minimum path length.
63022
+ *
63023
+ * @default 1
63024
+ *
63025
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#minPathLength Read more...}
63026
+ */
62972
63027
  minPathLength: number;
63028
+ /**
63029
+ * The name of the configuration.
63030
+ *
63031
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#name Read more...}
63032
+ */
62973
63033
  name: string;
63034
+ /**
63035
+ * The {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html entities} to use as the origin of the paths.
63036
+ *
63037
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#originEntities Read more...}
63038
+ */
62974
63039
  originEntities: CIMFilteredFindPathsEntity[];
63040
+ /**
63041
+ * Any {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html filters} to use during pathfinding.
63042
+ *
63043
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#pathFilters Read more...}
63044
+ */
62975
63045
  pathFilters: CIMFilteredFindPathsPathFilter[];
63046
+ /**
63047
+ * Specifies whether the filtered find paths algorithm searches for all paths or only the shortest paths.
63048
+ *
63049
+ * @default "Shortest"
63050
+ *
63051
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#pathMode Read more...}
63052
+ */
62976
63053
  pathMode: "Shortest" | "All";
63054
+ /**
63055
+ * The filtered find paths algorithm uses traversal directions to specify how relationships are traversed.
63056
+ *
63057
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#traversalDirections Read more...}
63058
+ */
62977
63059
  traversalDirections: CIMKGTraversalDirection[];
62978
63060
  readonly type: "CIMFilteredFindPathsConfiguration";
63061
+ /**
63062
+ * The pathfinding configuration for {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths}
63063
+ * and {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}.
63064
+ *
63065
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html Read more...}
63066
+ */
62979
63067
  constructor(properties?: CIMFilteredFindPathsConfigurationProperties);
63068
+ /**
63069
+ * Converts an instance of this class to its [ArcGIS portal JSON](https://developers.arcgis.com/documentation/common-data-types/geometry-objects.htm) representation.
63070
+ *
63071
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#toJSON Read more...}
63072
+ */
63073
+ toJSON(): any;
63074
+ /**
63075
+ * Creates a new instance of this class and initializes it with values from a JSON object
63076
+ * generated from an ArcGIS product.
63077
+ *
63078
+ * @param json A JSON representation of the instance in the ArcGIS format. See the [ArcGIS REST API documentation](https://developers.arcgis.com/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects.
63079
+ *
63080
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#fromJSON Read more...}
63081
+ */
63082
+ static fromJSON(json: any): any | nullish;
62980
63083
  static fromJSON(json: any): CIMFilteredFindPathsConfiguration;
62981
63084
  }
62982
63085
 
62983
63086
  interface CIMFilteredFindPathsConfigurationProperties {
63087
+ /**
63088
+ * Specifies the direction which the algorithm uses to traverse relationship in the path.
63089
+ *
63090
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#defaultTraversalDirectionType Read more...}
63091
+ */
62984
63092
  defaultTraversalDirectionType?: "Any" | "Forward" | "Backward";
63093
+ /**
63094
+ * The {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html entities} to use as the destination of the path.
63095
+ *
63096
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#destinationEntities Read more...}
63097
+ */
62985
63098
  destinationEntities?: CIMFilteredFindPathsEntity[];
63099
+ /**
63100
+ * Specifies how the origin and destination entities are used in the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous} algorithm.
63101
+ *
63102
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#entityUsage Read more...}
63103
+ */
62986
63104
  entityUsage?: | "AnyOriginAnyDestination"
62987
63105
  | "AnyOriginAllDestinations"
62988
63106
  | "AllOriginsAnyDestination"
62989
63107
  | "AllOriginsAllDestinations"
62990
63108
  | "EachPair";
63109
+ /**
63110
+ * The maximum number of paths that the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}
63111
+ * algorithm returns.
63112
+ *
63113
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#maxCountPaths Read more...}
63114
+ */
62991
63115
  maxCountPaths?: number;
63116
+ /**
63117
+ * The maximum path length.
63118
+ *
63119
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#maxPathLength Read more...}
63120
+ */
62992
63121
  maxPathLength?: number;
63122
+ /**
63123
+ * The minimum path length.
63124
+ *
63125
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#minPathLength Read more...}
63126
+ */
62993
63127
  minPathLength?: number;
63128
+ /**
63129
+ * The name of the configuration.
63130
+ *
63131
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#name Read more...}
63132
+ */
62994
63133
  name?: string;
63134
+ /**
63135
+ * The {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html entities} to use as the origin of the paths.
63136
+ *
63137
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#originEntities Read more...}
63138
+ */
62995
63139
  originEntities?: CIMFilteredFindPathsEntity[];
63140
+ /**
63141
+ * Any {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html filters} to use during pathfinding.
63142
+ *
63143
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#pathFilters Read more...}
63144
+ */
62996
63145
  pathFilters?: CIMFilteredFindPathsPathFilter[];
63146
+ /**
63147
+ * Specifies whether the filtered find paths algorithm searches for all paths or only the shortest paths.
63148
+ *
63149
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#pathMode Read more...}
63150
+ */
62997
63151
  pathMode?: "Shortest" | "All";
63152
+ /**
63153
+ * The filtered find paths algorithm uses traversal directions to specify how relationships are traversed.
63154
+ *
63155
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#traversalDirections Read more...}
63156
+ */
62998
63157
  traversalDirections?: CIMKGTraversalDirection[];
62999
63158
  }
63000
63159
 
63001
- export class CIMFilteredFindPathsEntity extends JSONSupport {
63160
+ export interface CIMFilteredFindPathsEntity extends Accessor, JSONSupport {
63161
+ }
63162
+
63163
+ export class CIMFilteredFindPathsEntity {
63164
+ /**
63165
+ * The {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html#typeName typeName} of the entity specified in {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD iD}.
63166
+ *
63167
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#entityTypeName Read more...}
63168
+ */
63002
63169
  entityTypeName: string | nullish;
63170
+ /**
63171
+ * The unique ID to use as a filter.
63172
+ *
63173
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD Read more...}
63174
+ */
63003
63175
  iD: string | nullish;
63176
+ /**
63177
+ * The property filter predicate (openCypher syntax) associated with the path filter.
63178
+ *
63179
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#propertyFilterPredicate Read more...}
63180
+ */
63004
63181
  propertyFilterPredicate: string | nullish;
63005
- readonly type: string;
63182
+ readonly type: "CIMFilteredFindPathsEntity";
63183
+ /**
63184
+ * Defines an {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#originEntities origin}
63185
+ * or {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#destinationEntities destination} entity,
63186
+ * in this case the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD iD} is used, or all entities of an entity type, in which case the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD iD} is null.
63187
+ *
63188
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html Read more...}
63189
+ */
63006
63190
  constructor(properties?: CIMFilteredFindPathsEntityProperties);
63191
+ /**
63192
+ * Converts an instance of this class to its [ArcGIS portal JSON](https://developers.arcgis.com/documentation/common-data-types/geometry-objects.htm) representation.
63193
+ *
63194
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#toJSON Read more...}
63195
+ */
63196
+ toJSON(): any;
63197
+ /**
63198
+ * Creates a new instance of this class and initializes it with values from a JSON object
63199
+ * generated from an ArcGIS product.
63200
+ *
63201
+ * @param json A JSON representation of the instance in the ArcGIS format. See the [ArcGIS REST API documentation](https://developers.arcgis.com/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects.
63202
+ *
63203
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#fromJSON Read more...}
63204
+ */
63205
+ static fromJSON(json: any): any | nullish;
63007
63206
  static fromJSON(json: any): CIMFilteredFindPathsEntity;
63008
63207
  }
63009
63208
 
63010
63209
  interface CIMFilteredFindPathsEntityProperties {
63210
+ /**
63211
+ * The {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html#typeName typeName} of the entity specified in {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD iD}.
63212
+ *
63213
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#entityTypeName Read more...}
63214
+ */
63011
63215
  entityTypeName?: string | nullish;
63216
+ /**
63217
+ * The unique ID to use as a filter.
63218
+ *
63219
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD Read more...}
63220
+ */
63012
63221
  iD?: string | nullish;
63222
+ /**
63223
+ * The property filter predicate (openCypher syntax) associated with the path filter.
63224
+ *
63225
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#propertyFilterPredicate Read more...}
63226
+ */
63013
63227
  propertyFilterPredicate?: string | nullish;
63014
63228
  }
63015
63229
 
63016
- export class CIMFilteredFindPathsPathFilter extends JSONSupport {
63230
+ export interface CIMFilteredFindPathsPathFilter extends Accessor, JSONSupport {
63231
+ }
63232
+
63233
+ export class CIMFilteredFindPathsPathFilter {
63234
+ /**
63235
+ * Specifies the filter type to use in the path filter for the specified entity or relationship.
63236
+ *
63237
+ * @default "Exclude"
63238
+ *
63239
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#filterType Read more...}
63240
+ */
63017
63241
  filterType: "IncludeOnly" | "Exclude" | "MandatoryWaypoint" | "OptionalWaypoint";
63018
63242
  /**
63019
- * ID to use as a filter.
63243
+ * The unique ID to use as a filter.
63020
63244
  *
63021
63245
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD Read more...}
63022
63246
  */
63023
63247
  iD: string | nullish;
63248
+ /**
63249
+ * Whether the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD iD} or {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemTypeName itemTypeName} is an entity or relationship.
63250
+ *
63251
+ * @default "Entity"
63252
+ *
63253
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemType Read more...}
63254
+ */
63024
63255
  itemType: "Entity" | "Relationship";
63256
+ /**
63257
+ * The {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html#typeName typeName} of the entity or relationship specified in {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD iD}.
63258
+ *
63259
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemTypeName Read more...}
63260
+ */
63025
63261
  itemTypeName: string | nullish;
63262
+ /**
63263
+ * The property filter predicate (openCypher syntax) associated with the path filter.
63264
+ *
63265
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#propertyFilterPredicate Read more...}
63266
+ */
63026
63267
  propertyFilterPredicate: string | nullish;
63027
- type: string;
63268
+ readonly type: "CIMFilteredFindPathsPathFilter";
63269
+ /**
63270
+ * Defines path filters to determine what records are used to find paths in the graph between the
63271
+ * origin
63272
+ * and destination entities.
63273
+ *
63274
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html Read more...}
63275
+ */
63028
63276
  constructor(properties?: CIMFilteredFindPathsPathFilterProperties);
63277
+ /**
63278
+ * Converts an instance of this class to its [ArcGIS portal JSON](https://developers.arcgis.com/documentation/common-data-types/geometry-objects.htm) representation.
63279
+ *
63280
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#toJSON Read more...}
63281
+ */
63282
+ toJSON(): any;
63283
+ /**
63284
+ * Creates a new instance of this class and initializes it with values from a JSON object
63285
+ * generated from an ArcGIS product.
63286
+ *
63287
+ * @param json A JSON representation of the instance in the ArcGIS format. See the [ArcGIS REST API documentation](https://developers.arcgis.com/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects.
63288
+ *
63289
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#fromJSON Read more...}
63290
+ */
63291
+ static fromJSON(json: any): any | nullish;
63029
63292
  static fromJSON(json: any): CIMFilteredFindPathsPathFilter;
63030
63293
  }
63031
63294
 
63032
63295
  interface CIMFilteredFindPathsPathFilterProperties {
63296
+ /**
63297
+ * Specifies the filter type to use in the path filter for the specified entity or relationship.
63298
+ *
63299
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#filterType Read more...}
63300
+ */
63033
63301
  filterType?: "IncludeOnly" | "Exclude" | "MandatoryWaypoint" | "OptionalWaypoint";
63034
63302
  /**
63035
- * ID to use as a filter.
63303
+ * The unique ID to use as a filter.
63036
63304
  *
63037
63305
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD Read more...}
63038
63306
  */
63039
63307
  iD?: string | nullish;
63308
+ /**
63309
+ * Whether the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD iD} or {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemTypeName itemTypeName} is an entity or relationship.
63310
+ *
63311
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemType Read more...}
63312
+ */
63040
63313
  itemType?: "Entity" | "Relationship";
63314
+ /**
63315
+ * The {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html#typeName typeName} of the entity or relationship specified in {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD iD}.
63316
+ *
63317
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemTypeName Read more...}
63318
+ */
63041
63319
  itemTypeName?: string | nullish;
63320
+ /**
63321
+ * The property filter predicate (openCypher syntax) associated with the path filter.
63322
+ *
63323
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#propertyFilterPredicate Read more...}
63324
+ */
63042
63325
  propertyFilterPredicate?: string | nullish;
63043
- type?: string;
63044
63326
  }
63045
63327
 
63046
- export class CIMKGTraversalDirection extends JSONSupport {
63328
+ export interface CIMKGTraversalDirection extends Accessor, JSONSupport {
63329
+ }
63330
+
63331
+ export class CIMKGTraversalDirection {
63332
+ /**
63333
+ * Specifies the direction which the algorithm uses to traverse relationships in the path.
63334
+ *
63335
+ * @default "Any"
63336
+ *
63337
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMKGTraversalDirection.html#traversalDirectionType Read more...}
63338
+ */
63047
63339
  traversalDirectionType: "Any" | "Forward" | "Backward";
63048
- readonly type: string;
63340
+ readonly type: "CIMKGTraversalDirection";
63341
+ /**
63342
+ * The traversal directions
63343
+ * that specify how relationships are traversed along paths between the
63344
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#originEntities origin}
63345
+ * and {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#destinationEntities destination}.
63346
+ *
63347
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMKGTraversalDirection.html Read more...}
63348
+ */
63049
63349
  constructor(properties?: CIMKGTraversalDirectionProperties);
63350
+ /**
63351
+ * Converts an instance of this class to its [ArcGIS portal JSON](https://developers.arcgis.com/documentation/common-data-types/geometry-objects.htm) representation.
63352
+ *
63353
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMKGTraversalDirection.html#toJSON Read more...}
63354
+ */
63355
+ toJSON(): any;
63356
+ /**
63357
+ * Creates a new instance of this class and initializes it with values from a JSON object
63358
+ * generated from an ArcGIS product.
63359
+ *
63360
+ * @param json A JSON representation of the instance in the ArcGIS format. See the [ArcGIS REST API documentation](https://developers.arcgis.com/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects.
63361
+ *
63362
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMKGTraversalDirection.html#fromJSON Read more...}
63363
+ */
63364
+ static fromJSON(json: any): any | nullish;
63050
63365
  static fromJSON(json: any): CIMKGTraversalDirection;
63051
63366
  }
63052
63367
 
63053
63368
  interface CIMKGTraversalDirectionProperties {
63369
+ /**
63370
+ * Specifies the direction which the algorithm uses to traverse relationships in the path.
63371
+ *
63372
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMKGTraversalDirection.html#traversalDirectionType Read more...}
63373
+ */
63054
63374
  traversalDirectionType?: "Any" | "Forward" | "Backward";
63055
63375
  }
63056
63376
 
63057
63377
  export class FindPathsToolSettings extends Accessor {
63378
+ /**
63379
+ * The pathfinding configuration.
63380
+ *
63381
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html#config Read more...}
63382
+ */
63058
63383
  config: CIMFilteredFindPathsConfiguration;
63059
63384
  /**
63060
- * URL of the KG Server the tool should operate on.
63385
+ * URL to the [ArcGIS Knowledge Server REST](https://developers.arcgis.com/rest/services-reference/enterprise/kgs-hosted-server.htm) resource that represents a knowledge graph service.
63061
63386
  *
63062
63387
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html#inKnowledgeGraphUrl Read more...}
63063
63388
  */
63064
63389
  inKnowledgeGraphUrl: string;
63390
+ /**
63391
+ * Settings for executing {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}.
63392
+ *
63393
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html Read more...}
63394
+ */
63065
63395
  constructor(properties?: FindPathsToolSettingsProperties);
63066
63396
  }
63067
63397
 
63068
63398
  interface FindPathsToolSettingsProperties {
63399
+ /**
63400
+ * The pathfinding configuration.
63401
+ *
63402
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html#config Read more...}
63403
+ */
63069
63404
  config?: CIMFilteredFindPathsConfiguration;
63070
63405
  /**
63071
- * URL of the KG Server the tool should operate on.
63406
+ * URL to the [ArcGIS Knowledge Server REST](https://developers.arcgis.com/rest/services-reference/enterprise/kgs-hosted-server.htm) resource that represents a knowledge graph service.
63072
63407
  *
63073
63408
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html#inKnowledgeGraphUrl Read more...}
63074
63409
  */
@@ -63093,7 +63428,23 @@ declare namespace __esri {
63093
63428
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeApplyEdits Read more...}
63094
63429
  */
63095
63430
  executeApplyEdits(graph: KnowledgeGraph, edits: GraphApplyEdits, requestOptions?: RequestOptions): Promise<GraphApplyEditsResult>;
63431
+ /**
63432
+ * Executes a request to the ServerFilteredFindPaths GP tool.
63433
+ *
63434
+ * @param toolSettings The pathfinding configuration such as origin and destination, waypoints and other tool settings. See {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html FindPathToolSettings} for the full list of available settings.
63435
+ * @param requestOptions Additional options specified in the data request. See {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions RequestOptions} for available properties.
63436
+ *
63437
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths Read more...}
63438
+ */
63096
63439
  executeFindPaths(toolSettings: FindPathsToolSettings, requestOptions?: RequestOptions): Promise<CIMFilteredFindPathsResultJSON>;
63440
+ /**
63441
+ * Executes an asynchronous request to the ServerFilteredFindPaths GP tool.
63442
+ *
63443
+ * @param toolSettings The pathfinding configuration such as origin and destination, waypoints and other tool settings. See {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html FindPathToolSettings} for the full list of available settings.
63444
+ * @param requestOptions The options specified by the user in the data request. See {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions RequestOptions} for available properties.
63445
+ *
63446
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous Read more...}
63447
+ */
63097
63448
  executeFindPathsAsynchronous(toolSettings: FindPathsToolSettings, requestOptions?: RequestOptions): Promise<JobInfo>;
63098
63449
  /**
63099
63450
  * Executes a query on {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html knowledge graph service's}
@@ -63138,6 +63489,14 @@ declare namespace __esri {
63138
63489
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeSearchStreaming Read more...}
63139
63490
  */
63140
63491
  executeSearchStreaming(graph: KnowledgeGraph, searchArguments: GraphSearchStreaming, requestOptions?: RequestOptions): Promise<GraphQueryStreamingResult>;
63492
+ /**
63493
+ * Retrieves the filtered find path results from a job started by {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}.
63494
+ *
63495
+ * @param jobInfo The job info returned from {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}.
63496
+ * @param requestOptions Additional options specified in the data request.
63497
+ *
63498
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#fetchAsynchronousFindPathsResultData Read more...}
63499
+ */
63141
63500
  fetchAsynchronousFindPathsResultData(jobInfo: JobInfo, requestOptions?: RequestOptions): Promise<CIMFilteredFindPathsResultJSON>;
63142
63501
  /**
63143
63502
  * Retrieves the specified client data keys from the knowledge graph service associated with the given knowledge graph, if they exist.
@@ -63171,21 +63530,12 @@ declare namespace __esri {
63171
63530
 
63172
63531
  export const knowledgeGraphService: knowledgeGraphService;
63173
63532
 
63174
- export interface CIMFilteredFindPathsResultJSON {
63175
- type: "CIMFilteredFindPathsResult";
63176
- error?: knowledgeGraphServiceError;
63177
- configurationWarning: | "None"
63178
- | "AllOriginsAreExcluded"
63179
- | "AllDestinationsAreExcluded"
63180
- | "AllOptionalWaypointsAreExcluded"
63181
- | "AtLeastOneMandatoryEntityWaypointIsExcluded"
63182
- | "AtLeastOneMandatoryRelationshipWaypointIsExcluded"
63183
- | "ReachedMaxPathLength";
63184
- statistics: Statistics;
63185
- paths: Paths;
63186
- }
63187
-
63188
- export interface knowledgeGraphServiceError {
63533
+ /**
63534
+ * Errors returned in the result of {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}.
63535
+ *
63536
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#CIMFilteredFindPathsError Read more...}
63537
+ */
63538
+ export interface CIMFilteredFindPathsError {
63189
63539
  type: "CIMFilteredFindPathsError";
63190
63540
  error: | "None"
63191
63541
  | "ConfigurationHasTooManyInputEntities"
@@ -63197,12 +63547,31 @@ declare namespace __esri {
63197
63547
  detailedErrorMessage: string;
63198
63548
  }
63199
63549
 
63200
- export interface knowledgeGraphServiceFetchClientDataAtKeysOptions {
63201
- ignoreCache?: boolean;
63202
- requestOptions?: RequestOptions;
63550
+ /**
63551
+ * The returned result of {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}.
63552
+ *
63553
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#CIMFilteredFindPathsResultJSON Read more...}
63554
+ */
63555
+ export interface CIMFilteredFindPathsResultJSON {
63556
+ type: "CIMFilteredFindPathsResult";
63557
+ error?: CIMFilteredFindPathsError;
63558
+ configurationWarning: | "None"
63559
+ | "AllOriginsAreExcluded"
63560
+ | "AllDestinationsAreExcluded"
63561
+ | "AllOptionalWaypointsAreExcluded"
63562
+ | "AtLeastOneMandatoryEntityWaypointIsExcluded"
63563
+ | "AtLeastOneMandatoryRelationshipWaypointIsExcluded"
63564
+ | "ReachedMaxPathLength";
63565
+ statistics: CIMFilteredFindPathsStatistics;
63566
+ paths: CIMFilteredFindPathsResultPaths;
63203
63567
  }
63204
63568
 
63205
- export interface Paths {
63569
+ /**
63570
+ * Represents the paths found by an {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous} search.
63571
+ *
63572
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#CIMFilteredFindPathsResultPaths Read more...}
63573
+ */
63574
+ export interface CIMFilteredFindPathsResultPaths {
63206
63575
  type: "CIMKGPaths";
63207
63576
  entitiesUIDs?: string[];
63208
63577
  entityTypes?: number[];
@@ -63219,7 +63588,12 @@ declare namespace __esri {
63219
63588
  pathsEndIndex?: number[];
63220
63589
  }
63221
63590
 
63222
- export interface Statistics {
63591
+ /**
63592
+ * Represents the statistics related to an {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} or {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous} search.
63593
+ *
63594
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#CIMFilteredFindPathsStatistics Read more...}
63595
+ */
63596
+ export interface CIMFilteredFindPathsStatistics {
63223
63597
  type: "CIMFilteredFindPathsStatistics";
63224
63598
  countLocalGraphNodes?: number;
63225
63599
  countLocalGraphEdges?: number;
@@ -63228,6 +63602,11 @@ declare namespace __esri {
63228
63602
  countWaypointsExpansionQueries?: number;
63229
63603
  }
63230
63604
 
63605
+ export interface knowledgeGraphServiceFetchClientDataAtKeysOptions {
63606
+ ignoreCache?: boolean;
63607
+ requestOptions?: RequestOptions;
63608
+ }
63609
+
63231
63610
  /**
63232
63611
  * A convenience module for importing {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html locator} functions when developing with
63233
63612
  * {@link https://developers.arcgis.com/javascript/latest/typescript-setup/ TypeScript}.
@@ -97725,7 +98104,19 @@ declare namespace __esri {
97725
98104
  speedFactor?: number;
97726
98105
  duration?: number;
97727
98106
  maxDuration?: number;
97728
- easing?: "linear" | "ease" | "ease-in" | "ease-out" | "ease-in-out" | MapViewEasingFunction;
98107
+ easing?: | "linear"
98108
+ | "in-cubic"
98109
+ | "out-cubic"
98110
+ | "in-out-cubic"
98111
+ | "in-expo"
98112
+ | "out-expo"
98113
+ | "in-out-expo"
98114
+ | "in-out-coast-quad"
98115
+ | "ease"
98116
+ | "ease-in"
98117
+ | "ease-out"
98118
+ | "ease-in-out"
98119
+ | MapViewEasingFunction;
97729
98120
  pickClosestTarget?: boolean;
97730
98121
  signal?: AbortSignal | nullish;
97731
98122
  }
@@ -98740,6 +99131,10 @@ declare namespace __esri {
98740
99131
  | "out-expo"
98741
99132
  | "in-out-expo"
98742
99133
  | "in-out-coast-quad"
99134
+ | "ease"
99135
+ | "ease-in"
99136
+ | "ease-out"
99137
+ | "ease-in-out"
98743
99138
  | EasingFunction;
98744
99139
  signal?: AbortSignal | nullish;
98745
99140
  }
@@ -113820,7 +114215,7 @@ declare namespace __esri {
113820
114215
  *
113821
114216
  * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#zoomTo Read more...}
113822
114217
  */
113823
- zoomTo(params: GoToParameters2D | GoToParameters3D): Promise<any>;
114218
+ zoomTo(params: GoToParameters): Promise<any>;
113824
114219
  on(name: "trigger-action", eventHandler: FeaturesViewModelTriggerActionEventHandler): IHandle;
113825
114220
  }
113826
114221
 
@@ -121990,9 +122385,9 @@ declare namespace __esri {
121990
122385
  /**
121991
122386
  * Indicates whether the data capture tools are enabled in the oriented imagery viewer for digitization.
121992
122387
  *
121993
- * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#digitizationEnabled Read more...}
122388
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#dataCaptureEnabled Read more...}
121994
122389
  */
121995
- digitizationEnabled: boolean;
122390
+ dataCaptureEnabled: boolean;
121996
122391
  /**
121997
122392
  * When `false`, the view click interaction is enabled for the oriented imagery viewer widget.
121998
122393
  *
@@ -122104,9 +122499,9 @@ declare namespace __esri {
122104
122499
  /**
122105
122500
  * Indicates whether the data capture tools are enabled in the oriented imagery viewer for digitization.
122106
122501
  *
122107
- * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#digitizationEnabled Read more...}
122502
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#dataCaptureEnabled Read more...}
122108
122503
  */
122109
- digitizationEnabled?: boolean;
122504
+ dataCaptureEnabled?: boolean;
122110
122505
  /**
122111
122506
  * When `false`, the view click interaction is enabled for the oriented imagery viewer widget.
122112
122507
  *
@@ -131027,26 +131422,16 @@ declare namespace __esri {
131027
131422
  }
131028
131423
  }
131029
131424
 
131030
- export type GoToOverride = (view: MapView | SceneView, goToParameters: GoToParameters2D | GoToParameters3D) => void;
131031
-
131032
- /**
131033
- * The parameters for the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo MapView's goTo()} method.
131034
- *
131035
- * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#GoToParameters2D Read more...}
131036
- */
131037
- export interface GoToParameters2D {
131038
- target: GoToTarget2D;
131039
- options?: GoToOptions2D;
131040
- }
131425
+ export type GoToOverride = (view: MapView | SceneView, goToParameters: GoToParameters) => void;
131041
131426
 
131042
131427
  /**
131043
- * The parameters for the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo SceneView's goTo()} method.
131428
+ * The parameters for the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo MapView's goTo()} method and the {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo SceneView's goTo()} method.
131044
131429
  *
131045
- * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#GoToParameters3D Read more...}
131430
+ * {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#GoToParameters Read more...}
131046
131431
  */
131047
- export interface GoToParameters3D {
131048
- target: GoToTarget3D;
131049
- options?: GoToOptions3D;
131432
+ export interface GoToParameters {
131433
+ target: GoToTarget2D & GoToTarget3D;
131434
+ options?: GoToOptions2D & GoToOptions3D;
131050
131435
  }
131051
131436
 
131052
131437
  export class Swipe extends Widget {