@arcgis/core/rest/knowledgeGraph/toolService/findPaths/FindPathsToolSettings.d.ts

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

import type Accessor from "../../../../core/Accessor.js";
import type CIMFilteredFindPathsConfiguration from "./CIMFilteredFindPathsConfiguration.js";

export interface FindPathsToolSettingsProperties extends Partial<Pick<FindPathsToolSettings, "config" | "inKnowledgeGraphUrl">> {}

/**
 * Settings for executing  [executeFindPaths()](https://developers.arcgis.com/javascript/latest/references/core/rest/knowledgeGraphService/#executeFindPaths) and [executeFindPathsAsynchronous()](https://developers.arcgis.com/javascript/latest/references/core/rest/knowledgeGraphService/#executeFindPathsAsynchronous).
 *
 * @beta
 * @since 4.32
 */
export default class FindPathsToolSettings extends Accessor {
  constructor(properties?: FindPathsToolSettingsProperties);
  /** The pathfinding configuration. */
  accessor config: CIMFilteredFindPathsConfiguration;
  /**
   * 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.
   * For example `https://server.mydomain.com/server/rest/services/Hosted/myKnowledgeGraphName/KnowledgeGraphServer`
   *
   * @default ""
   */
  accessor inKnowledgeGraphUrl: string;
}