require(["esri/layers/CSVLayer"], function(CSVLayer) { /* code goes here */ });
Class: esri/layers/CSVLayer
Inheritance: CSVLayer Layer Accessor
Since: ArcGIS API for JavaScript 4.1

The CSVLayer is a point layer based on a CSV file (.csv, .txt). CSV is a plain-text file format used to represent tabular data, including geographic point features (latitude, longitude). Typically the latitude coordinate is the Y value, and the longitude coordinate is the X value. Features from the CSV file are accessible via the API so you can query features and use them as input to geometry or geoprocessing services.

If CSV files are not on the same domain as your website, a CORS enabled server or a proxy is required. The following snippet shows how to add a new CSVLayer instance to a map if the CSV file is not on the same domain as your website.

var url = "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_week.csv";
esriConfig.request.corsEnabledServers.push(url);

var csvLayer = new CSVLayer({
 url: url,
 copyright: "USGS Earthquakes"
});
map.add(csvLayer);  // adds the layer to the map
See also:

Constructors

new CSVLayer(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Example:
// Typical usage
var layer = new CSVLayer({
  // URL to the CSV file
  url: "https://mydomain.com/files/POIs.csv"
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

Copyright information for the layer.

more details
more detailsCSVLayer
String

The name of the class.

more details
more detailsAccessor
String

The column delimiter.

more details
more detailsCSVLayer
Object

Specifies how graphics are placed on the vertical axis (z).

more details
more detailsCSVLayer
Object

Configures the method for decluttering overlapping features in the view.

more details
more detailsCSVLayer
Field[]

An array of fields in the layer.

more details
more detailsCSVLayer
Extent

The full extent of the layer.

more details
more detailsLayer
String

The unique ID assigned to the layer.

more details
more detailsLayer
LabelClass[]

The label definition for this layer, specified as an array of LabelClass.

more details
more detailsCSVLayer
Boolean

Indicates whether to display labels for this layer.

more details
more detailsCSVLayer
String

The latitude field name.

more details
more detailsCSVLayer
Boolean

Indicates whether the layer will be included in the legend.

more details
more detailsCSVLayer
String

Indicates how the layer should display in the LayerList widget.

more details
more detailsLayer
Boolean

Indicates whether the layer's resources have loaded.

more details
more detailsLayer
Error

The Error object returned if an error occurred while loading.

more details
more detailsLayer
String

Represents the status of a load operation.

more details
more detailsLayer
Object[]

A list of warnings which occurred while loading.

more details
more detailsLayer
String

The longitude field name.

more details
more detailsCSVLayer
Number

The maximum scale at which the layer is visible in the view.

more details
more detailsCSVLayer
Number

The minimum scale at which the layer is visible in the view.

more details
more detailsCSVLayer
Number

The opacity of the layer.

more details
more detailsLayer
String[]

An array of field names to include in the CSVLayer.

more details
more detailsCSVLayer
Boolean

Indicates whether to display popups when features in the layer are clicked.

more details
more detailsCSVLayer
PopupTemplate

The popup template for the layer.

more details
more detailsCSVLayer
Renderer

The renderer assigned to the layer.

more details
more detailsCSVLayer
Boolean

Apply perspective scaling to screen-size point symbols in a SceneView.

more details
more detailsCSVLayer
String

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

more details
more detailsCSVLayer
String

The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules.

more details
more detailsLayer
String

The URL of the CSV file.

more details
more detailsCSVLayer
Boolean

Indicates if the layer is visible in the View.

more details
more detailsLayer

Property Details

Copyright information for the layer.

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

delimiterString

The column delimiter. See the table below for possible values.

ValueDescription
,comma
space
;semicolon
|pipe
\ttab-delimited

elevationInfoObject

Specifies how graphics are placed on the vertical axis (z). This property may only be used in a SceneView. See the ElevationInfo sample for an example of how this property may be used.

Properties:
mode String

Defines how the graphic is placed with respect to the terrain surface. See the table below for a list of possible values.

ModeDescription
on-the-groundGraphics are draped on the terrain surface. This is the default value for Point

geometries rendered with ObjectSymbol3DLayers. relative-to-ground | Graphics are placed at an elevation relative to the terrain surface. The graphic's elevation is determined by summing up the terrain elevation and the result of featureExpressionInfo (if defined). This is the default value for Point geometries rendered with IconSymbol3DLayers. absolute-height | Graphics are placed at an absolute height above sea level. This height is determined by the result of featureExpressionInfo (if defined). This mode doesn't take the elevation of the terrain into account. relative-to-scene | Graphics are aligned to buildings and other objects part of 3D Object SceneLayers or IntegratedMeshLayers, depending on which has higher elevation. If the graphic is not directly above a building or any other feature, it is aligned to the terrain surface elevation. If defined, the result of featureExpressionInfo is added to the 3D Object/terrain surface elevation.

offset Number
optional

An elevation offset, which is added to the vertical position of the graphic. If unit is not defined, the offset is in meters. When mode = "on-the-ground", this property has no effect.

featureExpressionInfo Object
optional

This object contains information about setting a custom height on the graphic. If this property is set, then z values are not considered for calculating graphic height.

Specification:
expression String
optional

An Arcade expression evaluating to a number that determines the height of the graphic. When mode = "on-the-ground", this property has no effect. For line and polygon geometries the result of the expression is the same for all vertices of a feature.

unit String
optional

The unit for featureExpressionInfo and offset values.

Possible Values: feet | meters | kilometers | miles | us-feet | yards

featureReductionObject

Since: ArcGIS API for JavaScript 4.4

Configures the method for decluttering overlapping features in the view. If this property is not set (or set to null), every feature is drawn individually.

Currently this property is only supported in 3D SceneViews for point features with non-draped Icons or Text symbol layers.

declutter

Property:
type String

Type of the decluttering method. The only supported type at the moment is "selection". In this method, some of the overlapping features are hidden such that none of the remaining features intersect on screen. Label deconfliction also respects this option and hides labels that would overlap with the features of this layer.

See also:
Example:
layer.featureReduction = {
  type: "selection"
};

fieldsField[]

An array of fields in the layer.

Example:
// define each field's schema
var fields = [
 new Field({
   "name": "ObjectID",
   "alias": "ObjectID",
   "type": "oid"
 }), new Field({
   "name": "description",
   "alias": "Description",
   "type": "string"
 }), new Field ({
   "name": "title",
   "alias": "Title",
   "type": "string"
 })
];

The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below.

Example:
// Once the layer loads, set the view's extent to the layer's fullextent
layer.then(function(){
  view.extent = layer.fullExtent;
});

The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.

labelingInfoLabelClass[]

The label definition for this layer, specified as an array of LabelClass. Use this property to specify labeling properties for the layer.

For labels to display in the view, the labelsVisible property of this layer must be set to true.

Known Limitations

There is no support for labeling in 2D. Labeling is only supported in 3D SceneViews.

Each graphic can have only one label. Multiple Label classes with different where clauses can be used to have different label styles on different features that belong to the same layer (for example blue labels for lakes and green labels for parks).

See also:

labelsVisibleBoolean

Indicates whether to display labels for this layer. If true, labels will appear as defined in the labelingInfo property.

Known Limitations

There is no support for labeling in 2D. Labeling is only supported in 3D SceneViews.

Default Value: false
See also:

latitudeFieldString

The latitude field name. If not specified, the API will look for following field names in the CSV source: "lat", "latitude", "y", "ycenter", "latitude83", "latdecdeg", "POINT-Y".

legendEnabledBoolean

Indicates whether the layer will be included in the legend.

Default Value: true

Indicates how the layer should display in the LayerList widget. The known values are listed below.

ValueDescription
showThe layer is visible in the table of contents.
hideThe layer is hidden in the table of contents.
hide-childrenIf the layer is a GroupLayer, hide the children layers from the table of contents.
Default Value: show

loadedBooleanreadonly inherited

Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.

Default Value: false

loadErrorErrorreadonly inherited

The Error object returned if an error occurred while loading.

Default Value: null

loadStatusStringreadonly inherited

Represents the status of a load operation.

ValueDescription
not-loadedThe object's resources have not loaded.
loadingThe object's resources are currently loading.
loadedThe object's resources have loaded without errors.
failedThe object's resources failed to load. See loadError for more details.
Default Value: not-loaded

loadWarningsObject[]readonly inherited

A list of warnings which occurred while loading.

longitudeFieldString

The longitude field name. If not specified, the API will look for following field names in the CSV source: "lon", "lng", "long", "longitude", "x", "xcenter", "longitude83", "longdecdeg", "POINT-X".

maxScaleNumber

The maximum scale at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale.

Default Value: 0
Examples:
//The layer will not be visible when the
//view is zoomed beyond a scale of 1:1,000
layer.maxScale = 1000;
//The layer's visibility is not restricted to a maximum scale.
layer.maxScale = 0;

minScaleNumber

The minimum scale at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale.

Default Value: 0
Examples:
//The layer will not be visible when the view
//is zoomed beyond a scale of 1:3,000,000
layer.minScale = 3000000;
//The layer's visibility is not restricted to a minimum scale.
layer.minScale = 0;

The opacity of the layer. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.

Default Value: 1
Example:
// Makes the layer 50% transparent
layer.opacity = 0.5;

outFieldsString[]

An array of field names to include in the CSVLayer. If not specified, the layer will include all fields.

Examples:
// Use all fields (the default)
layer.outFields = ["*"];
// Use a subset of fields
layer.outFields = ["NAME", "POP_2016", "FIPS"];

popupEnabledBoolean

Indicates whether to display popups when features in the layer are clicked.

Default Value: true

popupTemplatePopupTemplate autocast

The popup template for the layer. When set on the layer, the popupTemplate allows users to access attributes and display their values in the view's popup when a feature is selected using text and/or charts. See the PopupTemplate sample for an example of how PopupTemplate interacts with a FeatureLayer.

The renderer assigned to the layer. The renderer defines how to visualize each feature in the layer. Depending on the renderer type, features may be visualized with the same symbol, or with varying symbols based on the values of provided attribute fields or functions.

See also:
Example:
// all features in the layer will be visualized with
// a 6pt black marker symbol and a thin, white outline
layer.renderer = {
  type: "simple",  // autocasts as new SimpleRenderer()
  symbol: {
    type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
    size: 6,
    color: "black",
    outline: {  // autocasts as new SimpleLineSymbol()
      width: 0.5,
      color: "white"
    }
  }
};

screenSizePerspectiveEnabledBoolean

Since: ArcGIS API for JavaScript 4.4

Apply perspective scaling to screen-size point symbols in a SceneView. When true, screen sized objects such as icons, labels or callouts integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a SceneView.

layer.screenSizePerspectiveEnabled = true

screen-size-perspective

layer.screenSizePerspectiveEnabled = false

no-screen-size-perspective

Known Limitations

Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with point features located far from the ground surface. In these cases it may be better to turn off screen size perspective. As screen size perspective changes the size based on distance to the camera, it should be set to false when using size visual variables.

Default Value: true

titleString

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

When the layer is loaded from a portal item, the title of the portal item will be used. If a layer is loaded as part of a webmap or a webscene, then the title of the layer as stored in the webmap/webscene will be used.

typeStringreadonly inherited

The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules.

Possible values: base-dynamic | base-elevation | base-tile | elevation | feature | graphics | group | imagery | integrated-mesh | map-image | open-street-map | point-cloud | scene | stream | tile | unknown | unsupported | vector-tile | web-tile

The URL of the CSV file.

Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.

Default Value: true
Example:
// The layer is no longer visible in the view
layer.visible = false;

Method Overview

NameReturn TypeSummaryClass
Promise

An instance of this class is a Promise.

more details
more detailsLayer

Cancels a load() operation if it is already in progress.

more details
more detailsLayer

Emits an event on the instance.

more details
more detailsLayer
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more detailsLayer
Boolean

An instance of this class is a Promise.

more details
more detailsLayer
Boolean

An instance of this class is a Promise.

more details
more detailsLayer
Boolean

An instance of this class is a Promise.

more details
more detailsLayer
Promise

Loads the resources referenced by this class.

more details
more detailsLayer
Object

Registers an event handler on the instance.

more details
more detailsLayer
Promise

An instance of this class is a Promise.

more details
more detailsLayer
Promise

An instance of this class is a Promise.

more details
more detailsLayer

Method Details

always(callbackOrErrback){Promise}inherited

An instance of this class is a Promise. Therefore always() may be used to execute a function if the promise is rejected or resolved. The input function will always execute no matter the response. For more information about promises, see the Working with Promises guide page.

Parameter:
callbackOrErrback Function
optional

The function to execute when the promise is rejected or resolved.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callbackOrErrback.
Example:
// Although this example uses MapView, any class instance that is a promise may use always() in the same way
var view = new MapView();
view.always(function(){
  // This function will always execute whether or not the promise is resolved or rejected
});

cancelLoad()inherited

Cancels a load() operation if it is already in progress.

emit(type, event)protectedinherited

Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses that inherit from Evented.

Parameters:
type String

The name of the event.

event Object

The event payload.

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
TypeDescription
BooleanReturns true if the class supports the input event.

isFulfilled(){Boolean}inherited

An instance of this class is a Promise. Therefore isFulfilled() may be used to verify if the promise is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

An instance of this class is a Promise. Therefore isRejected() may be used to verify if the promise is rejected. If it is rejected, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been rejected.

isResolved(){Boolean}inherited

An instance of this class is a Promise. Therefore isResolved() may be used to verify if the promise is resolved. If it is resolved, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been resolved.

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

Returns:
TypeDescription
PromiseResolves when the resources have loaded.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.

Parameters:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

otherwise(errback){Promise}inherited

An instance of this class is a Promise. Use otherwise() to call a function once the promise is rejected.

Parameter:
errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of errback.
Example:
// Although this example uses MapView, any class instance that is a promise may use otherwise() in the same way
var view = new MapView();
view.otherwise(function(error){
  // This function will execute if the promise is rejected due to an error
});

then(callback, errback, progback){Promise}inherited

An instance of this class is a Promise. Therefore then() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the promise resolves (when the instance of the class loads). The errback executes if the promise fails. See the Working with Promises guide page for additional details.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

progback Function
optional

The function to invoke when the promise emits a progress update.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses MapView, any class instance that is a promise may use then() in the same way
var view = new MapView();
view.then(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Event Overview

NameTypeSummaryClass
{view: View,layerView: LayerView}

Fires after the layer's LayerView is created and rendered in a view.

more details
more detailsLayer
{view: View,layerView: LayerView}

Fires after the layer's LayerView is destroyed and no longer renders in a view.

more details
more detailsLayer

Event Details

layerview-createinherited

Fires after the layer's LayerView is created and rendered in a view.

Properties:
view View

The view in which the layerView was created.

layerView LayerView

The LayerView rendered in the view representing the layer in layer.

See also:
Example:
// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
  // The LayerView for the layer that emitted this event
  event.layerView;
});

layerview-destroyinherited

Fires after the layer's LayerView is destroyed and no longer renders in a view.

Properties:
view View

The view in which the layerView was destroyed.

layerView LayerView

The destroyed LayerView representing the layer.

API Reference search results

NameTypeModule

There were no match results from your search criteria.