Skip To Content ArcGIS for Developers Sign In Dashboard

Web Map Specification

CSV Layer (CSV)

The CSV layer type references a CSV or TXT file from a publically-accessible web server. It then dynamically loads into the map at run time. The CSV layer will maintain a reference to the CSV resource.

Referenced by: operationalLayers

Properties

Property Details
blendMode Blend modes are used to create various effects by blending colors of top and background layers. normal blend mode is the default.
If property is present, must be one of the following values: average, color-burn, color-dodge, color, darken, destination-atop, destination-in, destination-out, destination-over, difference, exclusion, hard-light, hue, invert, lighten, lighter, luminosity, minus, multiply, normal, overlay, plus, reflect, saturation, screen, soft-light, source-atop, source-in, source-out, vivid-light, xor
columnDelimiter A string defining the character used to separate columns in a CSV file.
If property is present, must be one of the following values:
  • \t (tab)
  • (space)
  • , (comma)
  • ; (semicolon)
  • | (pipe)
disablePopup Indicates whether to allow a client to ignore popups defined by the service item.
id A unique identifying string for the layer.
layerDefinition A layerDefinition object defining the attribute schema and drawing information for the layer.
layerType String indicating the layer type.
Value of this property must be CSV
listMode To show or hide the layer in the layer list
If property is present, must be one of the following values:
  • hide
  • show
locationInfo A locationInfo object defining how location information will be retrieved from a CSV file.
opacity The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
popupInfo A popupInfo object defining the content of popup windows when you click or query a feature.
refreshInterval Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.
showLabels Labels will display if this property is set to true and the layer also has a labelingInfo property associated with it. This property can get stored in the web scene config.
showLegend Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.
title A user-friendly string title for the layer that can be used in a table of contents.
type Deprecated, use layerType instead.
url The URL to the layer.
visibility Boolean property determining whether the layer is initially visible in the web map.

Example

Live sample web map showing the CSV as operationalLayer

{
  "operationalLayers": [
    {
      "id": "csv_7927",
      "layerType": "CSV",
      "title": "Earthquakes",
      "visibility": true,
      "opacity": 1,
      "url": "http://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_month.csv",
      "columnDelimiter": ",",
      "blendMode": "overlay",
      "layerDefinition": {
        "geometryType": "esriGeometryPoint",
        "objectIdField": "__OBJECTID",
        "typeIdField": "",
        "fields": [],
        "types": [],
        "capabilities": "Query",
        "name": "csv",
        "extent": {
          "xmin": -20034970.25849882,
          "ymin": -9494815.985282788,
          "xmax": 20026086.963133518,
          "ymax": 14269743.874052156,
          "spatialReference": {
            "wkid": 102100
          }
        }
      },
      "popupInfo": {},
      "locationInfo": {
        "locationType": "coordinates",
        "latitudeFieldName": "latitude",
        "longitudeFieldName": "longitude"
      }
    }
  ]
}

Feedback on this topic?