@arcgis/map-components/dist/components/arcgis-multi-feature-form/customElement.d.ts

ArcGIS Map Components

/// <reference path="../../index.d.ts" />
import type Graphic from "@arcgis/core/Graphic.js";
import type MapView from "@arcgis/core/views/MapView.js";
import type SceneView from "@arcgis/core/views/SceneView.js";
import type Collection from "@arcgis/core/core/Collection.js";
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { ArcgisReferenceElement } from "../types.js";
import type { ValueChangeEvent, BatchAttributeFormState } from "@arcgis/core/widgets/BatchAttributeForm/types.js";
import type { Icon } from "@esri/calcite-components/components/calcite-icon";
import type { SubmitEvent } from "@arcgis/core/widgets/FeatureForm/FeatureFormViewModel.js";
import type { UIPosition } from "@arcgis/core/views/ui/types.js";
import type { EditType } from "@arcgis/core/widgets/support/forms/types.js";
import type { HeadingLevel } from "@arcgis/core/widgets/support/types.js";

/**
 * The Multi Feature Form component provides a Feature Form which works with
 * layer FeatureForm templates. It allows for multiple features to be edited at once.
 *
 * @since 5.0
 * @internal
 */
export abstract class ArcgisMultiFeatureForm extends LitElement {
  accessor activeFeatureIndex: number;
  /**
   * 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/components/arcgis-multi-feature-form/#destroy) method when you are done to
   * prevent memory leaks.
   *
   * @default false
   */
  accessor autoDestroyDisabled: boolean;
  /** @default false */
  accessor disabled: boolean;
  accessor editType: EditType;
  accessor features: Collection<Graphic>;
  accessor groupDisplay: "all" | "sequential";
  /** @default false */
  accessor hasTooManyComplexFeatures: boolean;
  /** @default false */
  accessor hasTooManyFeatures: boolean;
  /** Indicates the heading level to use for the headings in the component. */
  accessor headingLevel: HeadingLevel;
  /**
   * 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/)
   */
  get icon(): Icon["icon"];
  set icon(value: Icon["icon"]);
  get invalidFeatures(): Graphic[];
  /** The component's default label. */
  accessor label: string | null | undefined;
  accessor maximumFeatureCount: number;
  accessor maximumFeatureCountWithComplexForms: number;
  /** @deprecated since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead. */
  accessor position: UIPosition | undefined;
  /** @default false */
  accessor readOnly: boolean;
  /**
   * 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)
   */
  accessor referenceElement: ArcgisReferenceElement | string | undefined;
  accessor status: BatchAttributeFormState;
  /** @default false */
  accessor submitHasBeenAttempted: boolean;
  accessor timeZone: string | null | undefined;
  /** @default false */
  accessor updating: boolean;
  /** @default false */
  accessor valid: 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-multi-feature-form component will be associated with a map or scene component rather than using the `view` property.
   */
  accessor view: MapView | SceneView | undefined;
  /** Permanently destroy the component. */
  destroy(): Promise<void>;
  /** @param graphic */
  getValues(graphic: Graphic): Record<string, unknown>;
  goToFirstError(): void;
  /** @param feature */
  userChangesHaveMadeFeatureInvalid(feature: Graphic): boolean;
  "@setterTypes": {
    icon?: Icon["icon"];
  };
  /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "status" | "valid" | "updating" | "submitHasBeenAttempted" | "activeFeatureIndex"; }>;
  /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
  readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
  /** Fires when the [submit()](https://developers.arcgis.com/javascript/latest/references/core/widgets/BatchAttributeForm/#submit) method is called. */
  readonly arcgisSubmit: import("@arcgis/lumina").TargetedEvent<this, SubmitEvent>;
  /** Fires when a field value is updated. */
  readonly arcgisValueChange: import("@arcgis/lumina").TargetedEvent<this, ValueChangeEvent>;
  readonly "@eventTypes": {
    arcgisPropertyChange: ArcgisMultiFeatureForm["arcgisPropertyChange"]["detail"];
    arcgisReady: ArcgisMultiFeatureForm["arcgisReady"]["detail"];
    arcgisSubmit: ArcgisMultiFeatureForm["arcgisSubmit"]["detail"];
    arcgisValueChange: ArcgisMultiFeatureForm["arcgisValueChange"]["detail"];
  };
}