@arcgis/map-components 5.1.0-next.5 → 5.1.0-next.51

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

@@ -1,19 +1,18 @@
 /// <reference path="../../index.d.ts" />
-import type Graphic from "@arcgis/core/Graphic";
+import type Graphic from "@arcgis/core/Graphic.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";
+import type SelectionManager from "@arcgis/core/views/SelectionManager.js";
 import type SnappingOptions from "@arcgis/core/views/interactive/snapping/SnappingOptions.js";
 import type SketchTooltipOptions from "@arcgis/core/views/interactive/sketch/SketchTooltipOptions.js";
-import type { CreateFeaturesCreationInfo } from "@arcgis/core/widgets/Editor.js";
+import type { CreateFeaturesCreationInfo, EditorStartMergeFeaturesWorkflowOptions, EditorStartSplitFeatureWorkflowOptions } from "@arcgis/core/widgets/Editor.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
-import type { IconName } from "../../utils/action-utils.js";
-import type { EditorSketchUpdateEvent, EditorSketchCreateEvent } from "@arcgis/core/widgets/Editor/types";
+import type { ArcgisReferenceElement, IconName } from "../types.js";
+import type { EditorSketchUpdateEvent, EditorSketchCreateEvent, FeatureInfo, LayerInfo, State, SupportingWidgetDefaults } from "@arcgis/core/widgets/Editor/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";
-import type { LayerInfo, State, SupportingWidgetDefaults } from "@arcgis/core/widgets/Editor/types.js";
 
 /**
  * The Editor component provides an out-of-the-box editing experience to help streamline editing within a web application.
@@ -23,7 +22,7 @@ import type { LayerInfo, State, SupportingWidgetDefaults } from "@arcgis/core/wi
 export abstract class ArcgisEditor extends LitElement {
   /**
    * A property indicating the current active workflow. This is either
-   * [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-CreateFeaturesWorkflow.html) or [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-UpdateWorkflow.html).
+   * [CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/CreateFeaturesWorkflow/) or [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/UpdateWorkflow/).
    */
   get activeWorkflow(): CreateFeaturesWorkflow | UpdateWorkflow | null | undefined;
   /**
@@ -94,7 +93,7 @@ export abstract class ArcgisEditor extends LitElement {
   accessor hideSketch: boolean;
   /**
    * Indicates whether to hide the `enabledToggle` (Enable snapping). This toggles
-   * the [SnappingOptions#enabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#enabled) property.
+   * the [SnappingOptions#enabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#enabled) property.
    * > [!WARNING]
    * >
    * > **Note**
@@ -108,14 +107,14 @@ export abstract class ArcgisEditor extends LitElement {
   accessor hideSnappingControlsElementsEnabledToggle: boolean;
   /**
    * Indicates whether to hide the `featureEnabledToggle` (Feature to feature). This toggles
-   * the [SnappingOptions#featureEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#featureEnabled) property.
+   * the [SnappingOptions#featureEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#featureEnabled) property.
    *
    * @default false
    * @since 5.0
    */
   accessor hideSnappingControlsElementsFeatureEnabledToggle: boolean;
   /**
-   * Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html) layerList. The layerlist provides the available layer sources supported for snapping.
+   * Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/FeatureSnappingLayerSource/) layerList. The layerlist provides the available layer sources supported for snapping.
    *
    * @default false
    * @since 5.0
@@ -123,7 +122,7 @@ export abstract class ArcgisEditor extends LitElement {
   accessor hideSnappingControlsElementsLayerList: boolean;
   /**
    * Indicates whether to hide the `selfEnabledToggle` (Geometry guides). This toggles
-   * the [SnappingOptions#selfEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html#selfEnabled) property.
+   * the [SnappingOptions#selfEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#selfEnabled) property.
    *
    * @default false
    * @since 5.0
@@ -180,20 +179,20 @@ export abstract class ArcgisEditor extends LitElement {
    * >
    * > **Known Limitation**
    * >
-   * > Sketch labels are currently only supported when working with a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   * > Sketch labels are currently only supported when working with a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).
    *
    * @since 4.24
    */
   accessor labelOptions: SketchLabelOptions;
   /**
-   * An array of editing configurations for individual layers. It is possible to iterate through the map's [Map#editableLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#editableLayers) and configure these individual layers as needed.
+   * An array of editing configurations for individual layers. It is possible to iterate through the map's [Map#editableLayers](https://developers.arcgis.com/javascript/latest/references/core/Map/#editableLayers) and configure these individual layers as needed.
    *
    * If you have an editable feature layer but do not want
    * 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/api-reference/esri-Map.html#editableLayers)
+   * @see [Map#editableLayers](https://developers.arcgis.com/javascript/latest/references/core/Map/#editableLayers)
    * @example
    * const editor = new Editor({
    *   view: view,
@@ -226,6 +225,14 @@ export abstract class ArcgisEditor extends LitElement {
    * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
    */
   accessor referenceElement: ArcgisReferenceElement | string | undefined;
+  /**
+   * Use this property to supply a custom [SelectionManager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/) that overrides the default selection manager.
+   * This is useful when applications want to share selection sets between components, without relying on the view's selection manager. This property is ignored if [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#syncViewSelection) is `true`.
+   *
+   * @since 5.0
+   * @beta
+   */
+  accessor selectionManager: SelectionManager | null | undefined;
   /**
    * Indicates whether to display the header. Default is `false`.
    *
@@ -234,7 +241,7 @@ export abstract class ArcgisEditor extends LitElement {
    */
   accessor showSnappingControlsElementsHeader: boolean;
   /**
-   * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for editing. Supports self snapping and feature snapping. Starting with version 4.23, the [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) UI is automatically integrated into the Editor component.
+   * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/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.
    *
    * @since 4.19
@@ -259,13 +266,13 @@ export abstract class ArcgisEditor extends LitElement {
   get state(): State;
   /**
    * This property allows customization of supporting Editor components and their default behavior.
-   * These components include [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html), [FeatureTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html), and the
-   * [SketchViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html).
+   * These components include [FeatureForm](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureForm/), [FeatureTemplates](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/), and the
+   * [SketchViewModel](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/SketchViewModel/).
    *
    * > [!WARNING]
    * >
    * > 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/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions)
+   * > 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/)
@@ -279,6 +286,7 @@ export abstract class ArcgisEditor extends LitElement {
    *
    * @default false
    * @since 5.0
+   * @beta
    */
   accessor syncViewSelection: boolean;
   /**
@@ -287,6 +295,25 @@ export abstract class ArcgisEditor extends LitElement {
    * @since 4.24
    */
   accessor tooltipOptions: SketchTooltipOptions;
+  /**
+   * Starting at version 5.0, `arcgis-editor` is transitioning to a next generation geometry
+   * creation experience. This new experience provides advanced curve creation tools
+   * and allows multiple tools to be used in combination to define a single geometry.
+   *
+   * As of 5.0, this experience is only available in 2D (e.g. [`arcgis-map`](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map)).
+   *
+   * This property is available to allow 2D applications to temporarily
+   * opt out of this experience.
+   *
+   * > [!CAUTION]
+   * >
+   * > This option will be removed in an upcoming release.
+   *
+   * @deprecated
+   * @default false
+   * @since 5.0
+   */
+  accessor useLegacyCreateTools: boolean;
   /**
    * The view associated with the component. 
    *   > **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.
@@ -305,6 +332,40 @@ export abstract class ArcgisEditor extends LitElement {
   /** @param info */
   startCreateFeaturesWorkflowAtFeatureCreation(info: CreateFeaturesCreationInfo): Promise<void>;
   startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise<void>;
+  /**
+   * Starts a [MergeFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/MergeFeaturesWorkflow/) using
+   * the provided features. All features must belong to the same layer.
+   *
+   * @param features - The features to be merged. These can be supplied
+   * either as an array of [Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) instances or as a single
+   * [FeatureInfo](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/types/#FeatureInfo) object specifying a layer
+   * and the object IDs of the features.
+   * @param options - Options for the merge features workflow.
+   * @returns Resolves once the workflow has been initialized and is active.
+   * @since 5.0
+   */
+  startMergeFeaturesWorkflow(features: FeatureInfo | Graphic[], options: EditorStartMergeFeaturesWorkflowOptions): Promise<void>;
+  /**
+   * Starts a [SplitFeatureWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/SplitFeatureWorkflow/) using the provided feature.
+   *
+   * @param feature - The feature to be split.
+   * @param options - Options for the split feature workflow.
+   * @returns Resolves once the workflow has been initialized and is active.
+   * @since 5.0
+   */
+  startSplitFeatureWorkflow(feature: Graphic, options: EditorStartSplitFeatureWorkflowOptions): Promise<void>;
+  /**
+   * Starts an [UpdateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/UpdateFeaturesWorkflow/) using
+   * the provided features.
+   *
+   * @param features - The features to be updated. These can be supplied
+   * either as an array of [Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) instances or as a single
+   * [FeatureInfo](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/types/#FeatureInfo) object specifying a layer
+   * and the object IDs of the features.
+   * @returns Resolves once the workflow has been initialized and is active.
+   * @since 5.0
+   */
+  startUpdateFeaturesWorkflow(features: FeatureInfo | Graphic[]): Promise<void>;
   /** @param feature */
   startUpdateWorkflowAtFeatureEdit(feature: Graphic): Promise<void>;
   startUpdateWorkflowAtFeatureSelection(): Promise<void>;