Type Alias ArcGISWebMapElement

ArcGISWebMapElement: {
    addressSearchWidgetEnabled?: boolean;
    allowedDrawingTools?: {
        graphicAttributeOptions?: {
            description?: string;
            id: string;
            label: string;
            value: string;
        }[];
        type: string;
    }[];
    autoSnapshotButton?: ButtonConfiguration;
    autoSnapshotViews?: NonNullable<ArcGISWebMapElementValue["view"]>[];
    basemapId?: string;
    defaultValue?: ArcGISWebMapElementValue;
    homeWidgetEnabled?: boolean;
    manualSnapshotButton?: ButtonConfiguration;
    manualSnapshotsEnabled?: boolean;
    maxManualSnapshots?: number;
    measurementDimensionsEnabled?: boolean;
    minManualSnapshots?: number;
    showLayerPanel: boolean;
    type: "arcGISWebMap";
    webMapId?: string;
} & LookupFormElement & FormElementBinaryStorage & FormElementRequired & FormElementReadOnly

An element to display an information map to the user.

The element must have an id property that contains a universally unique identifier (UUID). The identifier must be a Version 4 (V4) UUID and must conform to the formatting requirements defined in this RFC 9562 specification: https://www.rfc-editor.org/rfc/rfc9562.html

Type declaration

  • OptionaladdressSearchWidgetEnabled?: boolean

    Show and allow the user to enter an address via the address search widget

  • OptionalallowedDrawingTools?: {
        graphicAttributeOptions?: {
            description?: string;
            id: string;
            label: string;
            value: string;
        }[];
        type: string;
    }[]

    Configure to allow which drawing tools are available to the user (https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#availableCreateTools)

  • OptionalautoSnapshotButton?: ButtonConfiguration

    The text and icon displayed on the button to take a snapshot image(s) of the map

  • OptionalautoSnapshotViews?: NonNullable<ArcGISWebMapElementValue["view"]>[]

    The zoom, latitude and longitude of the view to be used for auto-snapshotting.

  • OptionalbasemapId?: string

    The id of the basemap to be displayed to the user (https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap)

  • OptionaldefaultValue?: ArcGISWebMapElementValue
  • OptionalhomeWidgetEnabled?: boolean

    Show and allow the user to use the home widget

  • OptionalmanualSnapshotButton?: ButtonConfiguration

    The text displayed on the button to capture a snapshot image of the map

  • OptionalmanualSnapshotsEnabled?: boolean

    Allow users to upload snapshot images if enabled

  • OptionalmaxManualSnapshots?: number

    The minimum number of images the user is allowed to upload

  • OptionalmeasurementDimensionsEnabled?: boolean

    Show dimensions on drawing lines if enabled

  • OptionalminManualSnapshots?: number

    The minimum number of images the user is allowed to upload

  • showLayerPanel: boolean
  • type: "arcGISWebMap"
  • OptionalwebMapId?: string

Settings

Member Visibility