@arcgis/map-components 6.0.0-next.2 → 6.0.0-next.21

package/dist/components/arcgis-editor/customElement.d.ts

@@ -1,5 +1,6 @@
 /// <reference path="../../index.d.ts" />
 import type Graphic from "@arcgis/core/Graphic.js";
+import type SelectionOperation from "@arcgis/core/views/selection/SelectionOperation.js";
 import type CreateFeaturesWorkflow from "@arcgis/core/widgets/Editor/CreateFeaturesWorkflow.js";
 import type UpdateWorkflow from "@arcgis/core/widgets/Editor/UpdateWorkflow.js";
 import type SketchLabelOptions from "@arcgis/core/views/interactive/sketch/SketchLabelOptions.js";
@@ -10,6 +11,7 @@ import type { CreateFeaturesCreationInfo } from "@arcgis/core/widgets/Editor.js"
 import type { EditorStartCreateFeaturesWorkflowAtFeatureEditParameters, EditorStartCreateFeaturesWorkflowAtFeatureTypeSelectionParameters, EditorStartMergeFeaturesWorkflowOptions, EditorStartSplitFeatureWorkflowOptions, CancelWorkflowOptions, EditorSketchUpdateEvent, EditorSketchCreateEvent, FeatureInfo, LayerInfo, State, SupportingWidgetDefaults } from "@arcgis/core/widgets/Editor/types.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { ArcgisReferenceElement, IconName } from "../types.js";
+import type { SelectionToolName } from "@arcgis/core/views/selection/types.js";
 import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
 import type { HeadingLevel } from "@arcgis/core/widgets/support/types.js";
 import type { Icon } from "@esri/calcite-components/components/calcite-icon";
@@ -107,7 +109,7 @@ export abstract class ArcgisEditor extends LitElement {
    */
   accessor hideSelectionToolbar: boolean;
   /**
-   * Indicates whether to hide the settings menu. This menu contains the snapping and tooltips settings.
+   * Indicates whether to hide the Settings menu. This menu contains snapping and tooltip options.
    *
    * @default false
    * @since 5.0
@@ -283,8 +285,6 @@ export abstract class ArcgisEditor extends LitElement {
    * the end user to do any type of editing, you can limit this by
    * setting the `enabled` property to `false`.
    *
-   * @see [Sample - Editor widget with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)
-   * @see [Map#editableLayers](https://developers.arcgis.com/javascript/latest/references/core/Map/#editableLayers)
    * @example
    * const editor = new Editor({
    *   view: view,
@@ -334,23 +334,21 @@ export abstract class ArcgisEditor extends LitElement {
   /**
    * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/) for editing. Supports self snapping and feature snapping. Starting with version 4.23, the [SnappingControls](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SnappingControls/) UI is automatically integrated into the Editor component.
    * Modify the `snappingOptions` if modifications are needed from what is provided in the default UI.
+   * These options are preserved but ignored while [useViewOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#useViewOptions) is `true`.
    *
    * @since 4.19
-   * @see [Sample - Editor widget with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)
    * @example
-   * // Creates the Editor with SnappingOptions with no snapping UI
-   * const editor = new Editor({
-   *   view: view,
-   *   snappingOptions: { // autocasts to SnappingOptions()
-   *     enabled: true,
-   *     featureSources: [{layer: streetsLayer}] // autocasts to FeatureSnappingLayerSource()
-   *   }
-   * });
-   *
    * // Add the component to the view component
    * <arcgis-map>
-   *  <arcgis-editor slot="top-right"></arcgis-editor>
+   *   <arcgis-editor slot="top-right"></arcgis-editor>
    * </arcgis-map>
+   *
+   * // Get a reference to the editor and set the snapping options to the desired configuration
+   * const editor = document.querySelector("arcgis-editor");
+   * editor.snappingOptions = new SnappingOptions({
+   *   enabled: true,
+   *   featureSources: [{ layer: streetsLayer }]
+   * });
    */
   accessor snappingOptions: SnappingOptions;
   /** The current state of the component. */
@@ -365,9 +363,6 @@ export abstract class ArcgisEditor extends LitElement {
    * > This property is useful for basic overrides of the default components. There may be some limitations
    * > to what the Editor can do with these overridden properties. For example, the Editor will disable the `multipleSelectionEnabled` property in [Sketch#defaultUpdateOptions](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#defaultUpdateOptions)
    * > no matter what is set within this property.
-   *
-   * @see [Sample - Editor component with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)
-   * @see [Sample - Editing with calculated field expressions](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featureform-async/)
    */
   accessor supportingWidgetDefaults: SupportingWidgetDefaults | null | undefined;
   /**
@@ -381,6 +376,7 @@ export abstract class ArcgisEditor extends LitElement {
   accessor syncViewSelection: boolean;
   /**
    * Options to configure the tooltip shown next to the cursor when creating or updating graphics.
+   * These options are preserved but ignored while [useViewOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#useViewOptions) is `true`.
    *
    * @since 4.24
    */
@@ -405,13 +401,14 @@ export abstract class ArcgisEditor extends LitElement {
    */
   accessor useLegacyCreateTools: boolean;
   /**
-   * Indicates whether the component uses the snapping, tooltip, display-unit, and input-unit options configured through [ViewOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/).
+   * If true, the component uses snapping, tooltips, display units, and input units from [ViewOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/).
    *
-   * When `true`, snapping and tooltip options are inherited from the view. Options specified through [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#snappingOptions) and [tooltipOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#tooltipOptions) are preserved but ignored. When `false`, those options are used instead.
+   * When this property is `true`:
    *
-   * While this property is `true`, snapping controls and the tooltip toggle are hidden from the component's settings menu because these options are inherited from the view.
+   * - Snapping and tooltip options are inherited from the view. The component's [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#snappingOptions) and [tooltipOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#tooltipOptions) are preserved but ignored.
+   * - Snapping controls and the tooltip toggle are hidden from the component's Settings menu.
    *
-   * Explicit unit overrides take precedence over the units inherited from the view for the corresponding measurement type, such as length or area, without changing the units configured in the view. Setting an explicit unit to `null` or `undefined` restores inheritance for that measurement type.
+   * When `false`, the component uses its own snapping, tooltip, and unit options instead.
    *
    * Label [options](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#labelOptions) and [direction mode](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ValueOptions/#directionMode) are not inherited from the view.
    *
@@ -428,6 +425,14 @@ export abstract class ArcgisEditor extends LitElement {
    * > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-editor component will be associated with a map or scene component rather than using the `view` property.
    */
   accessor view: MapViewOrSceneView | null | undefined;
+  /**
+   * Activates a selection tool specified by name. Additionally, cancels the previously active selection operation.
+   *
+   * @param toolName - The name of the selection tool to activate.
+   * @returns A reference to the active selection operation.
+   * @since 5.2
+   */
+  activateSelectionTool(toolName: SelectionToolName): Promise<SelectionOperation | undefined>;
   /**
    * Cancels any active selection operation.
    *