@arcgis/core 5.0.0-next.84 → 5.0.0-next.86

package/applications/Components/applySetUtils.d.ts

@@ -0,0 +1,237 @@
+/**
+ * Shared ApplySet utils for Components.
+ *
+ * @experimental
+ * @internal
+ */
+import type Graphic from "../../Graphic.js";
+import type FeatureLayer from "../../layers/FeatureLayer.js";
+import type SubtypeGroupLayer from "../../layers/SubtypeGroupLayer.js";
+import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
+
+/**
+ * @experimental
+ * @internal
+ */
+export type ApplySetItem = ApplySetAddItem | ApplySetModifyItem | ApplySetDeleteItem;
+
+/**
+ * @experimental
+ * @internal
+ */
+export type ApplySetSupportedLayer = FeatureLayer | SubtypeGroupLayer;
+
+/**
+ * The set of changes which are to be applied to different features and services.
+ *
+ * @experimental
+ * @internal
+ */
+export interface ApplySet {
+  /**
+   * A feature state provider which will automatically show temporary edits
+   *
+   * @experimental
+   */
+  featureState: FeatureStateProvider | null;
+  /**
+   * The list of edits held in the ApplySet
+   *
+   * @experimental
+   */
+  get items(): ApplySetItem[];
+  /**
+   * Add an edit to the ApplySet
+   *
+   * @param item
+   * @experimental
+   */
+  push(item: ApplySetItem): void;
+  /**
+   * Remove all edits from the ApplySet.
+   *
+   * @experimental
+   */
+  revert(): void;
+}
+
+/**
+ * Creates an ApplySet to hold edits across multiple layers
+ *
+ * @experimental
+ * @internal
+ */
+export function createApplySet(): ApplySet;
+
+/**
+ * The properties required to create an ApplySetItem
+ *
+ * @experimental
+ * @internal
+ */
+export interface ApplySetItemProperties {
+  /**
+   * The graphic that is affected
+   *
+   * @experimental
+   */
+  graphic: Graphic;
+  /**
+   * The layer on which this change is occurring
+   *
+   * @experimental
+   */
+  layer: ApplySetSupportedLayer;
+  /**
+   * The reason the change is being applied
+   *
+   * @experimental
+   */
+  reason?: string;
+}
+
+/**
+ * An ApplySet item that represents adding a feature to a layer
+ *
+ * @experimental
+ * @internal
+ */
+export interface ApplySetAddItem extends Omit<ApplySetItemProperties, "reason"> {
+  /**
+   * The type of change
+   *
+   * @experimental
+   */
+  type: "add";
+}
+
+/**
+ * Create an ApplySet Add Item
+ *
+ * @param properties
+ * @experimental
+ * @internal
+ */
+export function createApplySetAddItem(properties: ApplySetItemProperties): ApplySetAddItem;
+
+/**
+ * The properties required to create an ApplySetItem modify item
+ *
+ * @experimental
+ * @internal
+ */
+export interface ApplySetModifyItemProperties {
+  /**
+   * The graphic that is affected
+   *
+   * @experimental
+   */
+  graphic: Graphic;
+  /**
+   * The layer on which this change is occurring
+   *
+   * @experimental
+   */
+  layer: ApplySetSupportedLayer;
+  /**
+   * The original version of the graphic, before applying the change
+   *
+   * @experimental
+   */
+  originalGraphic: Graphic;
+  /**
+   * The reason the change is being applied
+   *
+   * @experimental
+   */
+  reason?: string;
+}
+
+/**
+ * An ApplySet item that represents modifying a feature in a layer
+ *
+ * @experimental
+ * @internal
+ */
+export interface ApplySetModifyItem extends Omit<ApplySetItemProperties, "reason" | "originalGraphic"> {
+  /**
+   * The original version of the graphic, before applying the change
+   *
+   * @experimental
+   */
+  revertGraphic: Graphic;
+  /**
+   * The type of change
+   *
+   * @experimental
+   */
+  type: "modify";
+}
+
+/**
+ * Create an ApplySet Modify Item
+ *
+ * @param properties
+ * @experimental
+ * @internal
+ */
+export function createApplySetModifyItem(properties: ApplySetModifyItemProperties): ApplySetModifyItem;
+
+/**
+ * An ApplySet item that represents deleting a feature in a layer
+ *
+ * @experimental
+ * @internal
+ */
+export interface ApplySetDeleteItem extends Omit<ApplySetItemProperties, "reason"> {
+  /**
+   * The type of change
+   *
+   * @experimental
+   */
+  type: "delete";
+}
+
+/**
+ * Create an ApplySet Delete Item
+ *
+ * @param properties
+ * @experimental
+ * @internal
+ */
+export function createApplySetDeleteItem(properties: ApplySetItemProperties): ApplySetDeleteItem;
+
+/**
+ * Writes all the changes listed in an ApplySet, to their respective services.
+ *
+ * @param applySet
+ * @param view
+ * @experimental
+ * @internal
+ */
+export function writeApplySetToService(applySet: ApplySet, view: MapViewOrSceneView): Promise<void>;
+
+/**
+ * Manages temporary feature edits which are displayed in LayerViews.
+ *
+ * @experimental
+ * @internal
+ */
+export interface FeatureStateProvider {
+  /**
+   * Clears all temporary feature state from the map
+   *
+   * @experimental
+   */
+  clearAll: () => void;
+}
+
+/**
+ * Creates a feature state provider, that will automatically show temporary feature changes
+ * on a map.
+ *
+ * @param view
+ * @experimental
+ * @internal
+ */
+export function createFeatureStateProvider(view: MapViewOrSceneView): FeatureStateProvider | null;

package/applications/Components/applySetUtils.js

@@ -0,0 +1,5 @@
+/*
+All material copyright Esri, All Rights Reserved, unless otherwise specified.
+See https://js.arcgis.com/5.0/esri/copyright.txt for details.
+*/
+import e from"../../core/Error.js";import t from"../../core/Logger.js";import{getOrCreateMapValue as a}from"../../core/MapUtils.js";import{ApplySet as r}from"../../undoredo/support/ApplySet.js";import{ApplySetAddItem as i,ApplySetModifyItem as s,ApplySetDeleteItem as l}from"../../undoredo/support/ApplySetItem.js";import{getServices as d}from"../../undoredo/support/Services.js";function o(){return new r}function n(e){return new i(e)}function h(e){return new s(e)}function u(e){return new l(e)}async function c(e,t){const a=await y(e,t);for(const r of a)if(r.layer){const e=[],t=[],a=[];r.items.forEach(r=>{switch(r.type){case"add":e.push(r.graphic);break;case"delete":t.push(r.graphic);break;case"modify":a.push(r.graphic)}}),await r.layer.applyEdits({addFeatures:e,deleteFeatures:t,updateFeatures:a})}else{const e=[],t=new Map;for(const a of r.items){let r=null;t.has(a.layer.layerId)?r=t.get(a.layer.layerId):(r={id:a.layer.layerId,addFeatures:[],deleteFeatures:[],updateFeatures:[]},t.set(r.id,r),e.push(r)),"add"===a.type?r.addFeatures.push(a.graphic):"delete"===a.type?r.deleteFeatures.push(a.graphic):"modify"===a.type&&r.updateFeatures.push(a.graphic)}for(const a of e)0===a.addFeatures.length&&delete a.addFeatures,0===a.deleteFeatures.length&&delete a.deleteFeatures,0===a.updateFeatures.length&&delete a.updateFeatures;await r.featureService.applyEdits(e)}}async function y(t,r){const i=d(r),s=[],l=new Map;for(const d of t.items)if("feature"!==d.layer.type&&"subtype-group"!==d.layer.type||!d.layer.url){if(!l.has(d.layer.id)){const e=i.tablesAndLayersLookup.get(d.layer)??null;e&&await e.load();const t={service:null,items:[],canUseGlobalId:!1,layer:d.layer,featureService:null};l.set(d.layer.id,t),s.push(t)}l.get(d.layer.id).items.push(d)}else{const t=i.tablesAndLayersLookup.get(d.layer);if(!t)throw new e("getservices:metadata-not-found","Meta data for the layer not found");await t.load();const r=t.featureService.url,o=a(l,r,()=>{const e={items:[],layer:null,canUseGlobalId:!0,featureService:t.featureService};return s.push(e),e});d.layer.capabilities?.editing.supportsGlobalId||(o.canUseGlobalId=!1),d.layer.globalIdField||(o.canUseGlobalId=!1),o.items.push(d)}return s}const p=()=>t.getLogger("esri.applications.Components.applySetUtils.FeatureState2D");class f{constructor(e){this._view=e,this._featureState=new Map,this.sealed=!1,this._hiddenFeatures=[]}ensureHighlighted(e){const t=this._featureState.get(e.featureChangeId);t&&!t.highlighted&&(t.highlighted=t.layerView?.highlight([t.objectId]))}hideFeatures(e){const t=this._view.allLayerViews.find(t=>t.layer===e.layer);if(t)for(const a of e.objectIds)t.setVisibility(a,!1),this._hiddenFeatures.push({layer:e.layer,objectId:a,layerView:t})}applyLocalState(e){if(!e.layer.isTable&&!this.sealed)switch(e.type){case"modify":{const t={change:e,layerView:null},a=this._view.allLayerViews.find(t=>t.layer===e.layer),r=e.revertGraphic.attributes[e.layer.objectIdField];t.layerView=a,t.objectId=r,t.layerView&&t.layerView.addOverrides({added:[],removed:[],updated:[t.change.graphic.clone()]}),this._featureState.set(e.featureChangeId,t)}break;case"add":{const t={change:e,layerView:null},a=this._view.allLayerViews.find(t=>t.layer===e.layer),r=e.graphic.attributes[e.layer.objectIdField];t.layerView=a,t.objectId=r,t.layerView&&t.layerView.addOverrides({added:[t.change.graphic.clone()],removed:[],updated:[]}),this._featureState.set(e.featureChangeId,t)}break;case"delete":{const t=this._view.allLayerViews.find(t=>t.layer===e.layer),a=e.graphic.attributes[e.layer.objectIdField],r={objectId:a,layerView:t??null,change:e,graphic:null};r.layerView&&r.layerView.addOverrides({added:[],removed:[a],updated:[]}),this._featureState.set(e.featureChangeId,r)}}}removeLocalState(e){if(e.layer.isTable||this.sealed)return;const t=this._featureState.get(e.featureChangeId);if(t&&(this._featureState.delete(e.featureChangeId),t.layerView&&t.layerView.removeOverrides([t.objectId]),t.highlighted))try{t.highlighted.remove(),t.highlighted=void 0}catch(a){p().warn("Failed removing highlight",a)}}updateLocalState(e){if(e.layer.isTable||this.sealed)return;const t=this._featureState.get(e.featureChangeId);t&&(t.change=e,t.layerView&&t.layerView.addOverrides({added:[],removed:[],updated:[t.change.graphic]}))}objectIdChanged(e,t,a){if(e.layer.isTable||this.sealed)return;const r=this._featureState.get(t);r&&(this._featureState.delete(t),this._featureState.set(e.featureChangeId,r),r.layerView?.removeOverrides([a]),r.layerView?.addOverrides({added:[],removed:[],updated:[r.change.graphic.clone()]}))}clearAll(){try{for(const t of this._hiddenFeatures)t.layerView.setVisibility(t.objectId,!0);this._hiddenFeatures=[];const e=new Map;this._featureState.forEach(t=>{if(t.layerView){a(e,t.layerView,()=>[]).push(t.objectId)}t.highlighted&&(t.highlighted.remove(),delete t.highlighted)});for(const[t,a]of e)t.removeOverrides(a);this._featureState.clear()}catch(e){p().warn("Failed during feature state clear",e)}}}function g(e){return"3d"===e.type?null:new f(e)}export{o as createApplySet,n as createApplySetAddItem,u as createApplySetDeleteItem,h as createApplySetModifyItem,g as createFeatureStateProvider,c as writeApplySetToService};

package/applications/Components/editUtils.d.ts

@@ -0,0 +1,92 @@
+import type Graphic from "../../Graphic.js";
+import type MapView from "../../views/MapView.js";
+
+/**
+ * @experimental
+ * @internal
+ */
+export interface GraphicMover {
+  /**
+   * Destroys the graphics mover, and releases resources.
+   *
+   * @experimental
+   */
+  destroy: () => void;
+}
+
+/**
+ * @experimental
+ * @internal
+ */
+export interface GraphicMoverCallbacks {
+  /**
+   * Callback for `"graphic-move-stop"` event.
+   *
+   * @experimental
+   */
+  onGraphicMoveStop: () => Promise<void>;
+  /**
+   * Callback for `"graphic-pointer-out"` event.
+   *
+   * @experimental
+   */
+  onGraphicPointerOut: () => void;
+  /**
+   * Callback for `"graphic-pointer-over"` event.
+   *
+   * @experimental
+   */
+  onGraphicPointerOver: () => void;
+}
+
+/**
+ * @experimental
+ * @internal
+ */
+export interface GraphicMoverProperties {
+  /**
+   * Set of callbacks which can be used to respond to graphic move events
+   *
+   * @experimental
+   */
+  callbacks: GraphicMoverCallbacks;
+  /**
+   * Flag to decide if all graphics should be moved
+   *
+   * @experimental
+   */
+  enableMoveAllGraphics: boolean;
+  /**
+   * The graphics to move
+   *
+   * @experimental
+   */
+  graphics: Graphic[];
+  /**
+   * Flag whether highlights are enabled
+   *
+   * @experimental
+   */
+  highlightsEnabled: boolean;
+  /**
+   * Flag whether indicators are enabled
+   *
+   * @experimental
+   */
+  indicatorsEnabled: boolean;
+  /**
+   * The view on which to move graphics
+   *
+   * @experimental
+   */
+  view: MapView;
+}
+
+/**
+ * creates a graphics mover to move several graphics on a Graphics layer all at once.
+ *
+ * @param props
+ * @experimental
+ * @internal
+ */
+export function createGraphicsMover(props: GraphicMoverProperties): GraphicMover;

package/applications/Components/editUtils.js

@@ -0,0 +1,5 @@
+/*
+All material copyright Esri, All Rights Reserved, unless otherwise specified.
+See https://js.arcgis.com/5.0/esri/copyright.txt for details.
+*/
+import r from"../../views/draw/support/GraphicMover.js";function o(o){return new r(o)}export{o as createGraphicsMover};

package/applications/Components/symbolUtils.d.ts

@@ -0,0 +1,37 @@
+import type Graphic from "../../Graphic.js";
+import type { SymbolUnion } from "../../symbols/types.js";
+
+/**
+ * @experimental
+ * @internal
+ */
+export interface PreviewGraphicOptions {
+  /** Symbol to use, if no symbol is found. */
+  fallbackSymbol?: null | undefined | SymbolUnion;
+  /** Format of generated preview image */
+  format?: null | undefined | "element" | "string";
+  /** Height in pixels for the generated preview image */
+  heightInPixels?: number;
+  /** Ignore opacity of symbol */
+  ignoreOpacity?: boolean;
+  /** Ignore rotation variables */
+  ignoreRotationVariables?: boolean;
+  /** Ignore size variables */
+  ignoreSizeVariables?: boolean;
+  /** Use actual graphic geometry for swatch */
+  useGeometryForShape: boolean;
+  /** Use marker symbol size */
+  useMarkerSymbolSize?: boolean;
+  /** Width in pixels for the generated preview image */
+  widthInPixels?: number;
+}
+
+/**
+ * Calculates a preview image for a Graphic, either as a string or html element.
+ *
+ * @param graphic
+ * @param options
+ * @experimental
+ * @internal
+ */
+export function previewGraphic(graphic: Graphic | null, options: PreviewGraphicOptions): Promise<HTMLElement | string | null>;

package/applications/Components/symbolUtils.js

@@ -0,0 +1,5 @@
+/*
+All material copyright Esri, All Rights Reserved, unless otherwise specified.
+See https://js.arcgis.com/5.0/esri/copyright.txt for details.
+*/
+import{previewGraphic as r}from"../../symbols/support/symbolUtils.js";function o(o,s){return r(o,s)}export{o as previewGraphic};

package/applications/Components/templateUtils.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Shared template utils for Components.
+ *
+ * @experimental
+ * @internal
+ */
+import type SharedTemplate from "../../editing/sharedTemplates/SharedTemplate.js";
+import type SharedTemplateMetadata from "../../editing/sharedTemplates/SharedTemplateMetadata.js";
+import type FeatureLayer from "../../layers/FeatureLayer.js";
+import type SubtypeGroupLayer from "../../layers/SubtypeGroupLayer.js";
+import type FeatureTemplate from "../../layers/support/FeatureTemplate.js";
+import type FeatureService from "../../rest/featureService/FeatureService.js";
+import type { AnyEditingTemplate, AnyEditingTemplateInfo } from "../../editing/types.js";
+import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
+
+/**
+ * @experimental
+ * @internal
+ */
+export type AnyLoadedEditingTemplate = FeatureTemplate | LoadedSharedTemplate;
+
+/**
+ * @experimental
+ * @internal
+ */
+export type LoadedSharedTemplate = SharedTemplate
+  & {
+  /**
+   * The definition of the template
+   *
+   * @experimental
+   */
+  definition: object;
+  /**
+   * The feature service from which the template was loaded
+   *
+   * @experimental
+   */
+  featureService: FeatureService;
+  /**
+   * The layer which the template is associated with.
+   *
+   * @experimental
+   */
+  layer: FeatureLayer | SubtypeGroupLayer | null;
+  /**
+   * The view for which the template has been loaded for.
+   *
+   * @experimental
+   */
+  view: MapViewOrSceneView;
+};
+
+/**
+ * Test if template is a Shared Group Template
+ *
+ * @param template
+ * @experimental
+ * @internal
+ */
+export function isSharedGroupTemplate(template: AnyEditingTemplate | null | undefined): boolean;
+
+/**
+ * Test if template is a Shared Preset Template
+ *
+ * @param template
+ * @experimental
+ * @internal
+ */
+export function isSharedPresetTemplate(template: AnyEditingTemplate | null | undefined): boolean;
+
+/**
+ * Test if template is a standard Feature Template
+ *
+ * @param template
+ * @experimental
+ * @internal
+ */
+export function isStandardFeatureTemplate(template: AnyEditingTemplateInfo | null | undefined): template is FeatureTemplate;
+
+/**
+ * Test if template is a shared feature template
+ *
+ * @param template
+ * @experimental
+ * @internal
+ */
+export function isSharedFeatureTemplate(template: AnyEditingTemplate | null | undefined): template is FeatureTemplate;
+
+/**
+ * Test if template info is Meta data for a Shared Template
+ *
+ * @param template
+ * @experimental
+ * @internal
+ */
+export function isSharedTemplateMetadata(template: AnyEditingTemplateInfo | null | undefined): template is SharedTemplateMetadata;
+
+/**
+ * Test if template is a Shared Template
+ *
+ * @param template
+ * @experimental
+ * @internal
+ */
+export function isSharedTemplate(template: AnyEditingTemplateInfo | null | undefined): template is SharedTemplate;
+
+/**
+ * Test if template is a Template or Template Info
+ *
+ * @param template
+ * @experimental
+ * @internal
+ */
+export function isSharedTemplateOrMetadata(template: AnyEditingTemplateInfo | null | undefined): template is SharedTemplateMetadata;
+
+/**
+ * Load a full template definition from its meta data
+ *
+ * @param view
+ * @param templateInfo
+ * @experimental
+ * @internal
+ */
+export function getFullTemplate(view: MapViewOrSceneView, templateInfo: AnyEditingTemplateInfo): Promise<AnyLoadedEditingTemplate | null>;
+
+/**
+ * Create the set of attributes specified in a template
+ *
+ * @param template
+ * @param overrides
+ * @experimental
+ * @internal
+ */
+export function getCreationAttributes(template: AnyEditingTemplate | null | undefined, overrides?: Record<string, unknown>): Record<string, unknown>;

package/applications/Components/templateUtils.js

@@ -0,0 +1,5 @@
+/*
+All material copyright Esri, All Rights Reserved, unless otherwise specified.
+See https://js.arcgis.com/5.0/esri/copyright.txt for details.
+*/
+import{isSharedGroupTemplate as e,isSharedPresetTemplate as t,isStandardFeatureTemplate as a,isSharedFeatureTemplate as r,isSharedTemplateMetadata as n,isSharedTemplate as i,isSharedTemplateOrMetadata as s,getCreationAttributes as u}from"../../editing/templateUtils.js";import{getFullTemplate as o}from"../../editing/sharedTemplates/templateLoader.js";function m(t){return e(t)}function p(e){return t(e)}function d(e){return a(e)}function l(e){return r(e)}function f(e){return n(e)}function c(e){return i(e)}function T(e){return s(e)}async function h(e,t){return await o(e,t)}function S(e,t={}){return u(e,t)}export{S as getCreationAttributes,h as getFullTemplate,l as isSharedFeatureTemplate,m as isSharedGroupTemplate,p as isSharedPresetTemplate,c as isSharedTemplate,f as isSharedTemplateMetadata,T as isSharedTemplateOrMetadata,d as isStandardFeatureTemplate};