@vertigis/arcgis-extensions 32.8.5 → 32.10.0

package/portal/FormInfo.d.ts

@@ -0,0 +1,391 @@
+import type { Domain } from "./Domain.js";
+/**
+ * Defines the form configuration when a user edits a feature.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formInfo/}.
+ */
+export interface FormInfo {
+    /**
+     * A string that appears in the body of the form as a description.
+     */
+    description?: string;
+    /**
+     * List of Arcade expressions used in the form.
+     */
+    expressionInfos?: FormExpressionInfo[];
+    /**
+     * An array of formElement objects that represent an ordered list of form
+     * elements.
+     */
+    formElements?: (FormAttachmentElement | FormFieldElement | FormGroupElement | FormRelationshipElement)[];
+    /**
+     * A string that appears at the top of the form as a title.
+     */
+    title?: string;
+}
+/**
+ * Arcade expression used in the form.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formExpressionInfo/}.
+ */
+export interface FormExpressionInfo {
+    /**
+     * The Arcade expression.
+     */
+    expression?: string;
+    /**
+     * 	Unique identifier for the expression.
+     */
+    name?: string;
+    /**
+     * Return type of the Arcade expression. This can be determined by the
+     * authoring client by executing the expression using a sample feature(s),
+     * although it can be corrected by the user.
+     */
+    returnType?: "boolean";
+    /**
+     * Title of the expression.
+     */
+    title?: string;
+}
+/**
+ * Defines how one or more attachments can participate in the form. When present
+ * in the form, the user has the ability to upload an attachment specific to the
+ * form element.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formAttachmentElement/}.
+ */
+export interface FormAttachmentElement {
+    /**
+     * A string to identify the attachment(s). When a file is attached using the
+     * form, this property is used to set the value of the keywords field for
+     * the attachment. When a form is displaying existing attachments, this
+     * property is used to query attachments using an exact match on the
+     * keywords field.
+     */
+    attachmentKeyword?: string;
+    /**
+     * A string that describes the element in detail.
+     */
+    description?: string;
+    /**
+     * Indicates whether the attachments can be edited. If not present, the
+     * default is true.
+     */
+    editable?: boolean;
+    /**
+     * The input user interface to use for the attachment.
+     */
+    inputType?: {
+        /**
+         * The input type identifier.
+         */
+        type: "attachment" | "audio" | "document" | "image" | "signature" | "video";
+    };
+    /**
+     * A string value indicating what the element represents.
+     */
+    label?: string;
+    /**
+     * String value indicating which type of element to use.
+     */
+    type: "attachment";
+    /**
+     * A reference to an Arcade expression that returns a boolean value. When
+     * this expression evaluates to true, the element is displayed. When the
+     * expression evaluates to false the element is not displayed. If no
+     * expression is provided, the default behavior is that the element is
+     * displayed.
+     */
+    visibilityExpression?: string;
+}
+/**
+ * Defines how a field in the dataset participates in the form.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formFieldElement/}.
+ */
+export interface FormFieldElement {
+    /**
+     * A string that describes the element in detail.
+     */
+    description?: string;
+    /**
+     * The domain to apply to this field. If defined, it takes precedence over
+     * domains defined in field, type, or subtype.
+     */
+    domain?: Domain;
+    /**
+     * A Boolean determining whether users can edit this form element. If not
+     * supplied, the editable state is derived from the editable property of
+     * referenced field in the service.
+     */
+    editable?: boolean;
+    /**
+     * A string containing the field name as defined by the feature layer.
+     */
+    fieldName?: string;
+    /**
+     * The input user interface to use for the element. If an input type is not
+     * supplied or the client application does not understand the supplied input
+     * type, the client application is responsible for defining the default user
+     * interface.
+     */
+    inputType?: FormBarcodeScannerInput | FormComboBoxInput | FormDateTimePickerInput | FormRadioButtonsInput | FormSwitchInput | FormTextAreaInput | FormTextBoxInput;
+    /**
+     * A string indicating what the element represents. If not supplied, the
+     * label is derived from the alias property in the referenced field in
+     * the service.
+     */
+    label?: string;
+    /**
+     * A reference to an Arcade expression that returns a boolean value. When
+     * this expression evaluates to true and the element is visible, the
+     * element must have a valid value in order for the feature to be created
+     * or edited. When the expression evaluates to false the element is not
+     * required. If no expression is provided, the default behavior is that the
+     * element is not required. If the referenced field is non-nullable, the
+     * required expression is ignored and the element is always required.
+     */
+    requiredExpression?: string;
+    /**
+     * A string indicating which type of element to use.
+     */
+    type: "field";
+    /**
+     * A reference to an Arcade expression that returns a boolean value. When
+     * this expression evaluates to true, the element is displayed. When the
+     * expression evaluates to false the element is not displayed. If no
+     * expression is provided, the default behavior is that the element is
+     * displayed. Care must be taken when defining a visibility expression for a
+     * non-nullable field i.e. to make sure that such fields either have default
+     * values or are made visible to users so that they can provide a value
+     * before submitting the form.
+     */
+    visibilityExpression?: string;
+}
+/**
+ * Defines a container that holds a set of form elements that can be expanded,
+ * collapsed, or displayed together.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formGroupElement/}.
+ */
+export interface FormGroupElement {
+    /**
+     * A string that describes the element in detail.
+     */
+    description?: string;
+    /**
+     * An array of Form Element objects that represent an ordered list of form
+     * elements. Nested group elements are not supported.
+     */
+    formElements?: (FormAttachmentElement | FormFieldElement | FormRelationshipElement)[];
+    /**
+     * Defines if the group should be expanded or collapsed when the form is
+     * initially displayed. If not provided, the default value is expanded.
+     */
+    initialState?: "collapsed" | "expanded";
+    /**
+     * A string value indicating what the element represents.
+     */
+    label?: string;
+    /**
+     * String value indicating which type of element to use.
+     */
+    type: "group";
+    /**
+     * A reference to an Arcade expression that returns a boolean value. When
+     * this expression evaluates to true, the element is displayed. When the
+     * expression evaluates to false the element is not displayed. If no
+     * expression is provided, the default behavior is that the element is
+     * displayed.
+     */
+    visibilityExpression?: string;
+}
+/**
+ * Defines how a relationship between feature layers and tables can participate
+ * in the form. When present in the form, the user may have the option to add or
+ * edit related records.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formRelationshipElement/}.
+ */
+export interface FormRelationshipElement {
+    /**
+     * A string that describes the element in detail.
+     */
+    description?: string;
+    /**
+     * An integer that indicates the maximum number of records to display.
+     */
+    displayCount?: number;
+    /**
+     * A string that defines how the related records should be displayed.
+     */
+    displayType?: "list";
+    /**
+     * A Boolean determining whether users can edit this form element. If not
+     * supplied the default value is true.
+     */
+    editable?: boolean;
+    /**
+     * A string value indicating what the element represents.
+     */
+    label?: string;
+    /**
+     * String value indicating which type of element to use.
+     */
+    type: "relationship";
+    /**
+     * A reference to an Arcade expression that returns a boolean value. When
+     * this expression evaluates to true, the element is displayed. When the
+     * expression evaluates to false the element is not displayed. If no
+     * expression is provided, the default behavior is that the element is
+     * displayed.
+     */
+    visibilityExpression?: string;
+}
+/**
+ * Defines the desired user interface is a barcode or QR code scanner. If the
+ * client does not support barcode scanning, a single-line text box should be
+ * used.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formBarcodeScannerInput/}.
+ */
+export interface FormBarcodeScannerInput {
+    /**
+     * This represents the maximum number of characters allowed. This only
+     * applies for string fields. If not supplied, the value is derived from the
+     * length property of the referenced field in the service.
+     */
+    maxLength?: number;
+    /**
+     * This represents the minimum number of characters allowed. This only
+     * applies for string fields. If not supplied, the value is 0, meaning there
+     * is no minimum constraint.
+     */
+    minLength?: number;
+    /**
+     * The input type identifier.
+     */
+    type: "barcode-scanner";
+}
+/**
+ * Defines the desired user interface is a list of values in a drop-down that
+ * supports typing to filter. Only one value can be selected at a time.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formComboBoxInput/}.
+ */
+export interface FormComboBoxInput {
+    /**
+     * The text used to represent a null value.
+     */
+    noValueOptionLabel?: string;
+    /**
+     * Determines whether null value option is displayed. This only applies to
+     * fields that support null values. If not provided, the default value is
+     * false.
+     */
+    showNoValueOption?: boolean;
+    /**
+     * The input type identifier.
+     */
+    type: "combo-box";
+}
+/**
+ * Defines the desired user interface is a calendar date picker.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formDatetimePickerInput/}.
+ */
+export interface FormDateTimePickerInput {
+    /**
+     * Indicates if the datetime picker should provide an option to select the
+     * time. If not provided, the default value is false.
+     */
+    includeTime?: boolean;
+    /**
+     * 	The maximum date to allow. The number represents the number of
+     * 	milliseconds since epoch (January 1, 1970) in UTC.
+     */
+    max?: number;
+    /**
+     * The minimum date to allow. The number represents the number of
+     * milliseconds since epoch (January 1, 1970) in UTC.
+     */
+    min?: number;
+    /**
+     * The input type identifier.
+     */
+    type: "datetime-picker";
+}
+/**
+ * Defines the desired user interface is a radio button group.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formRadioButtonsInput/}.
+ */
+export interface FormRadioButtonsInput {
+    /**
+     * The text used to represent a null value.
+     */
+    noValueOptionLabel?: string;
+    /**
+     * Determines whether null value option is displayed. This only applies to
+     * fields that support null values. If not provided, the default value is
+     * false.
+     */
+    showNoValueOption?: boolean;
+    /**
+     * The input type identifier.
+     */
+    type: "radio-buttons";
+}
+/**
+ * Defines a desired user interface to present a binary switch, or toggle. This
+ * should be used when selecting between two options.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formSwitchInput/}.
+ */
+export interface FormSwitchInput {
+    /**
+     * The coded value when switch state is off.
+     */
+    offValue?: string | number;
+    /**
+     * The coded value when switch state is on.
+     */
+    onValue?: string | number;
+    /**
+     * The input type identifier.
+     */
+    type: "switch";
+}
+/**
+ * Defines the desired user interface is a multi-line text area.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formTextAreaInput/}.
+ */
+export interface FormTextAreaInput {
+    /**
+     * This represents the maximum number of characters allowed. If not
+     * supplied, the value is derived from the length property of the referenced
+     * field in the service.
+     */
+    maxLength?: number;
+    /**
+     * This represents the minimum number of characters allowed. If not
+     * supplied, the value is 0, meaning there is no minimum constraint.
+     */
+    minLength?: number;
+    /**
+     * The input type identifier.
+     */
+    type: "text-area";
+}
+/**
+ * Defines the desired user interface is a single-line text box.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/formTextBoxInput/}.
+ */
+export interface FormTextBoxInput {
+    /**
+     * This represents the maximum number of characters allowed. This only
+     * applies for string fields. If not supplied, the value is derived from the
+     * length property of the referenced field in the service.
+     */
+    maxLength?: number;
+    /**
+     * This represents the minimum number of characters allowed. This only
+     * applies for string fields. If not supplied, the value is 0, meaning there
+     * is no minimum constraint.
+     */
+    minLength?: number;
+    /**
+     * The input type identifier.
+     */
+    type: "text-box";
+}

package/portal/FormInfo.js

@@ -0,0 +1 @@
+export{};

package/portal/GroupLayer.d.ts

@@ -1,6 +1,7 @@
 import type EsriGroupLayer from "@arcgis/core/layers/GroupLayer";
 import type Portal from "@arcgis/core/portal/Portal";
 import type { ListMode } from "../support/esri.js";
+import type { FeatureLayer } from "./FeatureLayer.js";
 import type { OperationalLayerBase, OperationalLayer } from "./OperationalLayer.js";
 export declare namespace GroupLayer {
     /**
@@ -59,6 +60,30 @@ export interface GroupLayer extends OperationalLayerBase {
      */
     visibilityMode?: GroupLayerVisibilityMode;
 }
+/**
+ * Subtype group layers can be created by referencing a layer from a feature
+ * service that contains subtypes. Each subtype in the feature service layer can
+ * be a separate layer in the subtype group layer, and be given its own display
+ * and editing properties. With respect to layer blending, subtype group layers
+ * follow the same rules as group layers.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/subtypeGroupLayer/}.
+ */
+export interface SubtypeGroupLayer extends Omit<GroupLayer, "layerType" | "layers"> {
+    /**
+     * A sequence of custom parameters appended to the URL of all requests
+     * related to supporting ArcGIS layer types.
+     */
+    customParameters?: Record<string, unknown>;
+    /**
+     * 	String indicating the layer type.
+     */
+    layerType: "SubtypeGroupLayer";
+    /**
+     * An array of feature layers, each describing the properties for a subtype
+     * in the feature service layer.
+     */
+    layers: FeatureLayer[];
+}
 /**
  * Group layer visibility mode which indicates how visibility of children is
  * affected.

package/portal/ImageServiceLayer.d.ts

@@ -72,6 +72,11 @@ export interface ImageServiceLayer extends OperationalLayerBase, BaseMapLayerBas
      * algorithm (from image service).
      */
     compressionQuality?: number;
+    /**
+     * A sequence of custom parameters appended to the URL of all requests
+     * related to supporting ArcGIS layer types.
+     */
+    customParameters?: Record<string, unknown>;
     /**
      * Stores interactive filters.
      */

package/portal/ImageServiceVectorLayer.d.ts

@@ -12,6 +12,11 @@ import type { OperationalLayerBase } from "./OperationalLayer.js";
  * {@link https://developers.arcgis.com/web-map-specification/objects/imageServiceVectorLayer/}.
  */
 export interface ImageServiceVectorLayer extends OperationalLayerBase, BaseMapLayerBase {
+    /**
+     * A sequence of custom parameters appended to the URL of all requests
+     * related to supporting ArcGIS layer types.
+     */
+    customParameters?: Record<string, unknown>;
     /**
      * Stores interactive filters.
      */

package/portal/Item.d.ts

@@ -39,19 +39,14 @@ export interface Item {
      */
     owner?: string;
     /**
-     * <not in spec>.
-     */
-    orgId?: string;
-    /**
-     * <not in spec>.
-     */
-    guid?: string;
-    /**
-     * <not in spec>.
+     * A JSON object that primarily applies to system requirements, Terms and
+     * Conditions, version, supported platforms, YouTube video ID, etc
+     * associated with the application.
      */
     properties?: string;
     /**
-     * <not in spec>.
+     * An array that primarily applies to a list of categories that the
+     * application item is applicable to.
      */
     appCategories?: string[];
     /**
@@ -208,6 +203,38 @@ export interface Item {
      * description, title, tags etc.
      */
     scoreCompleteness?: number;
+    /**
+     * <not in spec>.
+     */
+    orgId?: string;
+    /**
+     * <not in spec>.
+     */
+    isOrgItem?: boolean;
+    /**
+     * <not in spec>.
+     */
+    guid?: string;
+    /**
+     * <not in spec>.
+     */
+    documentation?: unknown;
+    /**
+     * <not in spec>.
+     */
+    advancedSettings?: unknown;
+    /**
+     * <not in spec>.
+     */
+    subInfo?: number;
+    /**
+     * <not in spec>.
+     */
+    groupDesignations?: unknown;
+    /**
+     * <not in spec>.
+     */
+    contentOrigin?: string;
     /**
      * The portal to load the item from.
      */

package/portal/LabelingInfo.d.ts

@@ -37,9 +37,14 @@ export interface LabelingInfo {
      */
     labelExpressionInfo?: {
         /**
-         * Represents a simple template string.
+         * The title of the expression.
          */
-        value: string;
+        title?: string;
+        /**
+         * Represents a simple template string. This property is deprecated as
+         * of version 2.7 of the web map in favor of 'expression'.
+         */
+        value?: string;
         /**
          * An Arcade expression evaluating to either a string or a number.
          */

package/portal/LayerDefinition.d.ts

@@ -148,11 +148,27 @@ export interface LayerDefinition {
      * otherwise intersect with other features on screen.
      */
     featureReduction?: FeatureReduction;
+    /**
+     * The layer-specific overrides of field properties. Used by
+     * SubtypeGroupLayer to modify field information for each subtype. Any field
+     * missing from this array should be hidden.
+     */
+    fieldOverrides?: FieldOverride[];
     /**
      * An array of Field objects containing information about the attribute
      * fields for the feature collection or layer.
      */
     fields?: PortalField[];
+    /**
+     * Contains floor-awareness information for the layer.
+     * {@link https://developers.arcgis.com/web-map-specification/objects/layerFloorInfo/}.
+     */
+    floorInfo?: {
+        /**
+         * The name of the attribute field that contains a floor's level ID used for floor filtering.
+         */
+        floorField: string;
+    };
     /**
      * The type of geometry used in the layer definition. One of the
      * GeometryType constants.
@@ -284,6 +300,10 @@ export interface LayerDefinition {
      * the types.
      */
     templates?: Template[];
+    /**
+     * The time info metadata of the layer. May be set for feature layers inside a feature collection item.
+     */
+    timeInfo?: LayerTimeInfo;
     /**
      * Indicates whether the layerDefinition applies to a "Feature Layer" or a
      * "Table".
@@ -312,6 +332,107 @@ export interface LayerDefinition {
      */
     visibilityField?: string;
 }
+/**
+ * Defines overridden properties on a field for a specific view of the data.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/fieldOverride/}.
+ */
+export interface FieldOverride {
+    /**
+     * A string containing the overridden field alias.
+     */
+    alias?: string;
+    /**
+     * A Boolean determining whether users can edit this field.
+     */
+    editable?: boolean;
+    /**
+     * A string containing the field name as defined by the service.
+     */
+    name?: string;
+}
+/**
+ * Time info if the layer/table supports querying and exporting maps based on time.
+ * {@link https://developers.arcgis.com/web-map-specification/objects/layerTimeInfo/}.
+ */
+export interface LayerTimeInfo {
+    /**
+     * The name of the attribute field that contains the end time information.
+     */
+    endTimeField?: string;
+    /**
+     * The default time-related export options for this layer.
+     */
+    exportOptions?: TimeInfoExportOptions;
+    /**
+     * Indicates whether service has live data.
+     */
+    hasLiveData?: boolean;
+    /**
+     * The name of the attribute field that contains the start time
+     * information.
+     */
+    startTimeField?: string;
+    /**
+     * The time extent for all the data in the layer.
+     */
+    timeExtent?: [number, number];
+    /**
+     * Time interval of the data in the layer. Typically used for the TimeSlider
+     * when animating the layer.
+     */
+    timeInterval?: number;
+    /**
+     * Temporal unit in which the time interval is measured.
+     */
+    timeIntervalUnits?: TemporalUnit;
+    /**
+     * Defines information about daylight savings time and the time zone in
+     * which data was collected.
+     * {@link https://developers.arcgis.com/web-map-specification/objects/timeReference/}.
+     */
+    timeReference?: {
+        /**
+         * Indicates whether the time reference takes into account daylight
+         * savings time.
+         */
+        respectsDaylightSaving: boolean;
+        /**
+         * The time zone in which the data was captured.
+         */
+        timeZone?: string;
+    };
+    /**
+     * The field that contains the trackId.
+     */
+    trackIdField: string;
+}
+/**
+ * The default time-related export options for a layer.
+ * {@link: https://developers.arcgis.com/web-map-specification/objects/timeInfoExportOptions/}.
+ */
+export interface TimeInfoExportOptions {
+    /**
+     * If true, draw all the features from the beginning of time for that data.
+     */
+    timeDataCumulative?: boolean;
+    /**
+     * 	Time offset value for this layer so that it can be overlaid on the top
+     * 	of a previous or future time period.
+     */
+    timeOffset?: number;
+    /**
+     * Temporal unit in which the time offset is measured.
+     */
+    timeOffsetUnits?: TemporalUnit;
+    /**
+     * If true, use the time extent specified by the time parameter.
+     */
+    useTime?: boolean;
+}
+/**
+ * Temporal units in which a time value can be measured.
+ */
+export declare type TemporalUnit = "esriTimeUnitsCenturies" | "esriTimeUnitsDays" | "esriTimeUnitsDecades" | "esriTimeUnitsHours" | "esriTimeUnitsMilliseconds" | "esriTimeUnitsMinutes" | "esriTimeUnitsMonths" | "esriTimeUnitsSeconds" | "esriTimeUnitsUnknown" | "esriTimeUnitsWeeks" | "esriTimeUnitsYears";
 /**
  * The HTML popup type for the LayerDefinition.
  */