@arcgis/map-components/dist/components/arcgis-editor/customElement.d.ts

ArcGIS Map Components

/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../index.d.ts" />
import { Use } from '@arcgis/lumina/controllers';
import { default as Editor } from '@arcgis/core/widgets/Editor.js';
import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
import { ArcgisReferenceElement } from '../../utils/component-utils';

declare const useEditorWidget: (component: LitElement & Pick<Editor, "icon" | "label" | "viewModel" | "headingLevel" | "labelOptions" | "snappingOptions" | "tooltipOptions" | "layerInfos" | "supportingWidgetDefaults"> & {
    state?: unknown;
    viewModel?: __esri.EditorViewModel | undefined;
    closed?: boolean;
    icon: import('@arcgis/components-utils').Nil | string;
    label: import('@arcgis/components-utils').Nil | string;
    referenceElement?: ArcgisReferenceElement | string;
    position: __esri.UIPosition;
    arcgisReady: import('@arcgis/lumina').EventEmitter;
    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
        name: string;
    }> | undefined;
    el: HTMLElement & {
        childElem?: HTMLElement & {
            ownedBy?: HTMLElement;
        };
        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
    };
    autoDestroyDisabled: boolean;
    destroy: () => Promise<void>;
}) => Editor;
/**
 * The Editor component provides an out-of-the-box editing experience to help streamline editing within a web application.
 *
 * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-editor/)
 */
export declare class ArcgisEditor extends LitElement {
    /**
     * A property indicating the current active workflow.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#activeWorkflow)
     */
    readonly activeWorkflow: nullish | __esri.CreateFeaturesWorkflow | __esri.UpdateWorkflow | __esri.UpdateFeaturesWorkflow;
    /**
     * If true, the component will not be destroyed automatically when it is
     * disconnected from the document. This is useful when you want to move the
     * component to a different place on the page, or temporarily hide it. If this
     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-editor/#destroy) method when you are done to
     * prevent memory leaks.
     *
     * @default false
     */
    autoDestroyDisabled: boolean;
    /**
     * Indicates the heading level to use for title of the widget.
     *
     * @default 4
     */
    headingLevel: number;
    /** @default false */
    hideCreateFeaturesSection: boolean;
    /** @default false */
    hideEditFeaturesSection: boolean;
    /** @default false */
    hideLabelsToggle: boolean;
    /** @default false */
    hideSnappingControlsElementsEnabledToggle: boolean;
    /** @default false */
    hideSnappingControlsElementsFeatureEnabledToggle: boolean;
    /** @default false */
    hideSnappingControlsElementsLayerList: boolean;
    /** @default false */
    hideSnappingControlsElementsSelfEnabledToggle: boolean;
    /** @default false */
    hideTooltipsToggle: boolean;
    /**
     * Icon which represents the component.
     * Typically used when the component is controlled by another component (e.g. by the Expand component).
     *
     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
     * @default "pencil"
     */
    icon: string;
    /**
     * The widget's default label.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#label)
     */
    label: string;
    /**
     * Options to configure the sketch labels shown next to each segment of the geometry being created or updated.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#labelOptions)
     */
    labelOptions: __esri.SketchLabelOptions;
    /**
     * An array of editing configurations for individual layers.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#layerInfos)
     */
    layerInfos: nullish | __esri.EditorLayerInfo[];
    /** @default "bottom-left" */
    position: __esri.UIPosition;
    /**
     * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
     *
     * @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)
     */
    referenceElement?: ArcgisReferenceElement | string;
    /** @default false */
    showSnappingControlsElementsHeader: boolean;
    /**
     * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for editing.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#snappingOptions)
     */
    snappingOptions: __esri.SnappingOptions;
    /** The current state of the component. */
    readonly state: "ready" | "disabled" | "add-association-create-association" | "add-association-select-feature" | "add-association-select-layer" | "adding-attachment" | "awaiting-feature-creation-info" | "awaiting-feature-to-create" | "awaiting-feature-to-update" | "awaiting-update-feature-candidate" | "creating-features" | "editing-attributes" | "editing-attachment" | "editing-existing-feature" | "editing-features" | "viewing-selection-list";
    /**
     * This property allows customization of supporting Editor widgets and their default behavior.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#supportingWidgetDefaults)
     */
    supportingWidgetDefaults: nullish | __esri.SupportingWidgetDefaults;
    /**
     * Options to configure the tooltip shown next to the cursor when creating or updating graphics.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#tooltipOptions)
     */
    tooltipOptions: __esri.SketchTooltipOptions;
    cancelWorkflow(): Promise<void>;
    deleteFeatureFromWorkflow(): Promise<void>;
    /** Permanently destroy the component. */
    destroy(): Promise<void>;
    startCreateFeaturesWorkflowAtFeatureCreation(info: __esri.CreateFeaturesCreationInfo): Promise<void>;
    startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise<void>;
    startUpdateWorkflowAtFeatureEdit(feature: __esri.Graphic): Promise<void>;
    startUpdateWorkflowAtFeatureSelection(): Promise<void>;
    startUpdateWorkflowAtMultipleFeatureSelection(candidates: __esri.Graphic[]): Promise<void>;
    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
    readonly arcgisPropertyChange: TargetedEvent<this, {
        name: "state" | "activeWorkflow";
    }>;
    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
    readonly arcgisReady: TargetedEvent<this, void>;
}
export {};