Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

GISMapApp

ArcGIS

  • Last UpdatedFeb 27, 2025
  • 3 minute read

ArcGIS loads images from an ArcGIS Map Service. Optionally, feature properties can be retrieved on click. You can find the Terms of Use, Master Agreements, and other legal documents pertaining to licensing on the Esri legal website: https://www.esri.com/en-us/legal/overview.

The following table provides the specific configurable options available for this layer:

Property

Type

Description

assetNameTemplate [Optional]

String

Defines template string to generate each feature asset name which is used to set CurrentAsset control property when clicked.

When merge is enabled, the generated asset name is used to match the properties derived from the Features control property.

cacheSize [Optional]

Number

Defines the initial tile cache size.
It is used only when tiled is true.

crossOrigin [Optional]

String

Defines the crossOrigin attribute for loaded images. Set the property to "anonymous", if CORS issues are encountered.

For more information, refer https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.

popup [Optional]

popup

Defines layer popup configuration.
For more information, refer Popup.

ratio [Optional]

Number

A value 1 indicates image requests matching the size of the map viewport, 2 indicates an image twice the width and height of the viewport, and so on.

  • Min: 1

  • Default: 1.5

resolutions [Optional]

Number[]

If specified, requests are made only for these resolutions .
It is used when tiled is not true.

tiled [Optional]

Boolean

Gets images in tile mode (small pieces).

time [Optional]

TimeOrRange

Provides time value or range for layers data.

  • Time

    • TimeNumber (Number): Number of Milliseconds since 1970-1-1.

    • TimeString (String): Represents date and time in ISO 8601 format. Other formats might be supported depending on the browser used.

  • TimeRange

    • [Time, Time]

getFeatureOnClick [Optional]

Boolean

Enables feature information lookup on click (issuing a server request).

params [Optional]

ArcGISExportParams

ArcGIS that exports rest parameters.

For more information, refer https://developers.arcgis.com/rest/services-reference/enterprise/export-map.htm

Below are the configurable options for ArcGISExportParams:

Format [Optional]: String

Defines the format of the exported image.

layerDefs [Optional]: String

Allows you to filter the features of individual layers in the exported map by specifying definition expressions for those layers.

layers [Optional]: String

Determines which layers appear on the exported map. There are four ways to specify which layers are shown:

  • show: Only the layers specified in the list is exported.

  • hide: All layers except those specified in the list is exported.

  • include: In addition to the layers exported by default, the layers specified in the list will also be exported.

  • exclude: The layers exported by default excluding those specified in the list will be exported.
    For example: show: 2,4,7

timeRelation [Optional]: timeRelation

Allows you to control whether to include or exclude features that are at the beginning or the end of a time window.

  • Values: "esriTimeRelationOverlaps" | "esriTimeRelationOverlapsStartWithinEnd" | "esriTimeRelationAfterStartOverlapsEnd" | "esriTimeRelationWithin"

transparent [Optional]: Boolean

If true, the image is exported with the map background color set as transparent color.

Type

arcgis

A type of Layer.

url

String

Defines ArcGIS Rest service URL for a Map Service or Image Service.

The url must include /MapServer or /ImageServer.

Format [Optional]

String

Defines the format of the exported image.

layerDefs [Optional]

String

Allows you to filter the features of individual layers in the exported map by specifying definition expressions for those layers.

layers [Optional]

String

Determines which layers appear on the exported map. There are four ways to specify which layers are shown:

  • show: Only the layers specified in the list is exported.

  • hide: All layers except those specified in the list is exported.

  • include: In addition to the layers exported by default, the layers specified in the list will be exported.

  • exclude: The layers exported by default excluding those specified in the list will be exported. For example: show: 2,4,7.

timeRelation [Optional]

Allows you to control whether to include or exclude features that are at the beginning or the end of a time window.

  • Values: "esriTimeRelationOverlaps" | "esriTimeRelationOverlapsStartWithinEnd" | "esriTimeRelationAfterStartOverlapsEnd" | "esriTimeRelationWithin"

transparent [Optional]

Boolean

If true, the image is exported with the map background color set as transparent color.

Examples of ArcGIS

Below is an example of ArcGIS layer configuration:

  • Configuration and map preview

    ArcGIS configuration and map preview

  • JSON string configuration

    {

    "title": "Arcgis world imagery",

    "type": "arcgis",

    "url": "https://services.arcgisonline.com/arcgis/rest/services/World_Imagery/MapServer",

    "isBaseMap": true

    }

Related Links
TitleResults for “How to create a CRG?”Also Available in