CSV Layer (CSV)

The CSV layer type references a CSV or TXT file from a publicly-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
attributeTableInfo An attributeTableInfo object defining how the data will be presented in tabular format.
blendMode Blend modes are used to create various effects by blending colors of top and background layers. normal blend mode is the default.
Valid values: average, color, color-burn, color-dodge, 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.
Valid values:
  • \t (tab)
  •   (space)
  • , (comma)
  • ; (semicolon)
  • | (pipe)
customParameters A sequence of custom parameters appended to the URL of all requests related to a layer.
disablePopup Indicates whether to allow a client to ignore popups defined by the service item.
effect Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.
featureEffect Feature Effect emphasizes or deemphasizes features that satisfy a filter using graphical effects
id A unique identifying string for the layer.
itemId Optional string containing the item ID if it's registered on ArcGIS Online or your organization's portal.
layerDefinition A layerDefinition object defining the attribute schema and drawing information for the layer.
layerType String indicating the layer type.
Valid value of this property CSV
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 Boolean value indicating whether to display the layer in the legend. Default value is true.
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.
visibilityTimeExtent Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.

Example

{
  "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"
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.