@arcgis/portal-components 5.2.0-next.12 → 5.2.0-next.121

package/dist/components/arcgis-portal-add-gps-metadata/customElement.d.ts

@@ -0,0 +1,55 @@
+/// <reference path="../../index.d.ts" />
+import type PortalItem from "@arcgis/core/portal/PortalItem.js";
+import type Portal from "@arcgis/core/portal/Portal.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+
+/**
+ * Checks for, and allows adding missing GPS metadata fields to all layers within a feature layer.
+ * `Enable GPS metadata fields` MUST be true for the other sets of fields to be enabled.
+ *
+ * Clicking the `Add fields` button will call `/addToDefinition` on each layer in the service
+ * that is missing any fields from the corresponding set.
+ *
+ * The base set of fields (`Enable GPS metadata fields`) applies to point, line, and polygon layers.
+ * Line and polygon layers use a different set of fields than point layers (see `gps-fields.ts`).
+ * The more complete set of base fields, as well as GNSS and rangefinder sets of fields only apply
+ * to point layers.
+ *
+ * Example: A feature service contains a point layer, a polygon layer, and a table. The point and polygon layers
+ * only have the base set of GPS fields added. The UI should show `Enable GPS metadata fields` as "Added", with
+ * the ability to add the other two sets of fields. If Laser rangefinder fields are added, the point layer will
+ * be updated with the rangefinder fields, and the table and polygon will be ignored as those fields do not apply.
+ */
+export abstract class ArcgisPortalAddGpsMetadata extends LitElement {
+  /** Takes precedence over `itemId` when both are provided. */
+  accessor item: PortalItem | null;
+  /** The ID of the item to load when an `item` is not provided. */
+  accessor itemId: string | null;
+  /** @internal */
+  protected messages: {
+      addFields: string;
+      accordionHeading: string;
+      accordionDescription: string;
+      added: string;
+      gpsOptions: string;
+      gnssReceiverFields: string;
+      laserRangefinderFields: string;
+  } & T9nMeta<{
+      addFields: string;
+      accordionHeading: string;
+      accordionDescription: string;
+      added: string;
+      gpsOptions: string;
+      gnssReceiverFields: string;
+      laserRangefinderFields: string;
+  }>;
+  accessor portal: Portal;
+  /** Emitted when fields are successfully added. */
+  readonly arcgisGPSMetadataFieldsAdded: import("@arcgis/lumina").TargetedEvent<this, GPSMetadataFieldSet>;
+  readonly "@eventTypes": {
+    arcgisGPSMetadataFieldsAdded: ArcgisPortalAddGpsMetadata["arcgisGPSMetadataFieldsAdded"]["detail"];
+  };
+}
+
+export type GPSMetadataFieldSet = "base" | "gnss" | "rangefinder";