Skip To ContentArcGIS for DevelopersSign In Dashboard
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.

var url = "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_week.csv";

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
Object

Describes the layer's supported capabilities.

more details
more detailsCSVLayer
String

Copyright information for the layer.

more details
more detailsCSVLayer
String

The name of the class.

more details
more detailsAccessor
String

The SQL where clause used to filter features on the client.

more details
more detailsCSVLayer
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
FieldsIndex

A convenient property that can be used to make case-insensitive lookups for a field by name.

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
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 (most zoomed in) at which the layer is visible in the view.

more details
more detailsCSVLayer
Number

The maximum scale (most zoomed in) at which the layer is visible in the view.

more details
more detailsCSVLayer
Number

The minimum scale (most zoomed out) at which the layer is visible in the view.

more details
more detailsCSVLayer
Number

The minimum scale (most zoomed out) at which the layer is visible in the view.

more details
more detailsCSVLayer
String

The name of an oidfield containing a unique value or identifier for each feature in the layer.

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
PortalItem

The portal item from which the layer is loaded.

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
SpatialReference

The spatial reference of the layer.

more details
more detailsCSVLayer
TimeInfo

The time info provides information such as date fields that store start and end time for each feature and the full time extent for the layer.

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

For CSVLayer the type is csv.

more details
more detailsCSVLayer
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

capabilities Objectreadonly

Describes the layer's supported capabilities.

Properties:
data Object

Describes characteristics of the data in the layer.

Specification:
supportsAttachment Boolean

Indicates if the attachment is enabled on the layer. At this current time, the CSVLayer doesn’t support attachments.

supportsM Boolean

Indicates if the features in the layer support M values. Requires ArcGIS Server service 10.1 or greater.

supportsZ Boolean

Indicates if the features in the layer support Z values. Requires ArcGIS Server service 10.1 or greater. See elevationInfo for details regarding placement and rendering of features with z-values in 3D SceneViews.

editing Object

Describes editing capabilities that can be performed on the features in the layer.

Specification:
supportsDeleteByAnonymous Boolean

Indicates if anonymous users can delete features created by others.

supportsDeleteByOthers Boolean

Indicates if logged in users can delete features created by others.

supportsGeometryUpdate Boolean

Indicates if the geometry of the features in the layer can be edited.

supportsGlobalId Boolean

Indicates if the globalid values provided by the client are used in applyEdits.

supportsRollbackOnFailure Boolean

Indicates if the rollbackOnFailure parameter can be set to true or false when running the synchronizeReplica operation.

supportsUpdateByAnonymous Boolean

Indicates if anonymous users can update features created by others.

supportsUpdateByOthers Boolean

Indicates if logged in users can update features created by others.

supportsUpdateWithoutM Boolean

Indicates if m-values must be provided when updating features.

supportsUploadWithItemId Boolean

Indicates if the layer supports uploading attachments by UploadId.

operations Object

Describes operations that can be performed on features in the layer.

Specification:
supportsAdd Boolean

Indicates if new features can be added to the layer.

supportsDelete Boolean

Indicates if features can be deleted from the layer.

supportsUpdate Boolean

Indicates if features in the layer can be updated.

supportsEditing Boolean

Indicates if features in the layer can be edited. Use supportsAdd, supportsUpdate and supportsDelete to determine which editing operations are supported.

supportsCalculate Boolean

Indicates if values of one or more field values in the layer can be updated. See the Calculate REST operation document for more information.

supportsQuery Boolean

Indicates if features in the layer can be queried.

supportsQueryAttachments Boolean

Indicates if the layer supports REST API queryAttachments operation, which is supported with hosted feature services at version 10.5 and greater. If false, queryAttachments() method can only return attachments for one feature at a time. If true, queryAttachments() can return attachments for array of objectIds.

supportsValidateSql Boolean

Indicates if the layer supports a SQL-92 expression or where clause. This operation is only supported in ArcGIS Online hosted feature services.

supportsResizeAttachments Boolean

Indicates if resized attachments are supported in the layer. This is useful for showing thumbnails in Popups.

query Object

Describes query operations that can be performed on features in the layer.

Specification:
supportsCentroid Boolean

Indicates if the geometry centroid associated with each polygon feature can be returned. This operation is only supported in ArcGIS Online hosted feature services.

supportsDistance Boolean

Indicates if the layer's query operation supports a buffer distance for input geometries.

supportsDistinct Boolean

Indicates if the layer supports queries for distinct values based on fields specified in the outFields.

supportsDisjointSpatialRelationship Boolean

Indicates if the query operation supports disjoint spatial relationship. This is valid only for hosted feature services.

supportsExtent Boolean

Indicates if the layer's query response includes the extent of features. At 10.3, this option is only available for hosted feature services. At 10.3.1, it is available for hosted and non-hosted feature services.

supportsGeometryProperties Boolean

Indicates if the layer's query response contains geometry attributes, including shape area and length attributes. This operation is only supported in ArcGIS Online hosted feature services.

supportsHavingClause Boolean

Indicates if the layer supports the having clause on the service. Requires an ArcGIS Server service 10.6.1 or greater.

supportsOrderBy Boolean

Indicates if features returned in the query response can be ordered by one or more fields. Requires an ArcGIS Server service 10.3 or greater.

supportsPagination Boolean

Indicates if the query response supports pagination. Requires an ArcGIS Server service 10.3 or greater.

supportsQueryGeometry Boolean

Indicates if the query response includes the query geometry. This is valid only for hosted feature services.

supportsQuantization Boolean

Indicates if the query operation supports the projection of geometries onto a virtual grid. Requires an ArcGIS Server service 10.6.1 or greater.

supportsQuantizationEditMode Boolean

Indicates if the query operation supports quantization designed to be used in edit mode (highest resolution at the given spatial reference). Requires an ArcGIS Server service 10.6.1 or greater.

supportsResultType Boolean

Indicates if the number of features returned by the query operation can be controlled.

supportsSqlExpression Boolean

Indicates if the query operation supports SQL expressions.

supportsStandardizedQueriesOnly Boolean

Indicates if the query operation supports using standardized queries. Learn more about standardized queries here.

supportsStatistics Boolean

Indicates if the layer supports field-based statistical functions. Requires ArcGIS Server service 10.1 or greater.

supportsHistoricMoment Boolean

Indicates if the layer supports historic moment query. Requires ArcGIS Server service 10.5 or greater.

queryRelated Object

Indicates if the layer's query operation supports querying features or records related to features in the layer.

Specification:
supportsCount Boolean

Indicates if the layer's query response includes the number of features or records related to features in the layer.

supportsOrderBy Boolean

Indicates if the related features or records returned in the query response can be ordered by one or more fields. Requires ArcGIS Server service 10.3 or greater.

supportsPagination Boolean

Indicates if the query response supports pagination for related features or records. Requires ArcGIS Server service 10.3 or greater.

Example:
// Once the layer loads, check if the
// supportsAdd operations is enabled on the layer
layer.when(function(){
  if (layer.capabilities.operations.supportsAdd) {
    // if new features can be created in the layer
    // set up the UI for editing
    setupEditing();
  }
});

Copyright information for the layer.

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

definitionExpression String
Since: ArcGIS API for JavaScript 4.7

The SQL where clause used to filter features on the client. Only the features that satisfy the definition expression are displayed in the View. Setting a definition expression is useful when the dataset is large and you don't want to bring all features to the client for analysis. Definition expressions may be set when a layer is constructed prior to it loading in the view or after it has been added to the map. If the definition expression is set after the layer has been added to the map, the view will automatically refresh itself to display the features that satisfy the new definition expression.

Examples:
// Set definition expression in constructor to only display earthquakes magnitude 5.0 and greater
const layer = new CSVLayer({
  url: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_week.csv",
  definitionExpression: "mag >= 5"
});
// Set the definition expression directly on layer instance after it has loaded
layer.definitionExpression = "mag >= 5";
delimiter String

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

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

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-groundGraphics 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-heightGraphics are placed at an absolute elevation (z-value) above sea level. This z-value is determined by the result of featureExpressionInfo (if defined). This mode doesn't take the elevation of the terrain into account.
relative-to-sceneGraphics 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 z-value on the feature.

Specification:
expression String
optional

An Arcade expression evaluating to a number that determines the z-value of the feature. 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

featureReduction Object
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"
};
fields Field[]

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"
 })
];
fieldsIndex FieldsIndexreadonly
Since: ArcGIS API for JavaScript 4.12

A convenient property that can be used to make case-insensitive lookups for a field by name. It can also provide a list of the date fields in a layer.

Example:
// lookup a field by name. name is case-insensitive
const field = layer.fieldsIndex.get("SoMeFiEld");

if (field) {
  console.log(field.name); // SomeField
}

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.when(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.

Autocasts from Object[]

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

Multiple Label classes with different where clauses can be used to define several labels with varying styles on the same feature. Likewise, multiple label classes may be used to label different types of features (for example blue labels for lakes and green labels for parks).

Known Limitations

Currently only one LabelClass is supported in 3D SceneViews.

See also:
Example:
const statesLabelClass = new LabelClass({
  labelExpressionInfo: { expression: "$feature.NAME" },
  symbol: {
    type: "text",  // autocasts as new TextSymbol()
    color: "black",
    haloSize: 1,
    haloColor: "white"
  }
});

csvLayer.labelingInfo = [ statesLabelClass ];
labelsVisible Boolean

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

Known Limitations

Default Value:true
See also:
latitudeField String

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".

listMode String inherited

Indicates how the layer should display in the LayerList widget. The possible 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, BuildingSceneLayer, KMLLayer, MapImageLayer, TileLayer or WMSLayer, hide the children layers from the table of contents.
Default Value:show
loaded Booleanreadonly inherited

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

Default Value:false
loadError Errorreadonly inherited

The Error object returned if an error occurred while loading.

Default Value:null
loadStatus Stringreadonly 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
loadWarnings Object[]readonly inherited

A list of warnings which occurred while loading.

longitudeField String

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".

maxScale Number

The maximum scale (most zoomed in) 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. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.

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

The maximum scale (most zoomed in) 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. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.

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

The minimum scale (most zoomed out) 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. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.

Default Value:0
Examples:
// The layer will not be visible when the view
// is zoomed out 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;
minScale Number

The minimum scale (most zoomed out) 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. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.

Default Value:0
Examples:
// The layer will not be visible when the view is zoomed out 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;
objectIdField String
Since: ArcGIS API for JavaScript 4.11

The name of an oid field containing a unique value or identifier for each feature in the layer.

See also:

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;
outFields String[]

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"];
popupEnabled Boolean

Indicates whether to display popups when features in the layer are clicked. The layer needs to have a popupTemplate to define what information should be displayed in the popup. Alternatively, a default popup template may be automatically used if Popup.defaultPopupTemplateEnabled is set to true.

Default Value:true
See also:
popupTemplate PopupTemplateautocast

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.

A default popup template is automatically used if no popupTemplate has been defined when Popup.defaultPopupTemplateEnabled is set to true.

See also:
portalItem PortalItem

The portal item from which the layer is loaded. If the portal item references a Feature Service or Scene Service, then you can specify a single layer to load with the layerId property.

Examples:
// while this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }  // the first layer in the service is returned
});
// set hostname when using an on-premise portal (default is ArcGIS Online)
// esriConfig.portalUrl = "http://myHostName.esri.com/arcgis";

// while this example uses FeatureLayer, this same pattern can be
// used for SceneLayers
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});

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"
    }
  }
};
screenSizePerspectiveEnabled Boolean
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
spatialReference SpatialReferenceautocast
Since: ArcGIS API for JavaScript 4.7

The spatial reference of the layer. The default value is WGS84. This property can be set explicitly to project the longitude and latitude coordinates when the layer parses the CSV file. While not required, explicitly setting the spatial reference of the layer will improve the performance when projecting to a spatial reference other than the one used by the coordinates in the raw data.

Known Limitations

The browser must support WebAssembly if a spatial reference other than WGS84 or Web Mercator is specified.

Default Value:SpatialReference.WGS84
See also:
Example:
const csvLayer = new CSVLayer({
  url: "example.csv",
  spatialReference: {
    wkid: 5936
  }
});
Since: ArcGIS API for JavaScript 4.11

The time info provides information such as date fields that store start and end time for each feature and the full time extent for the layer. The timeInfo along with its startField and endField properties must be set at the time of layer initialization if it is being set for GeoJSONLayer, CSVLayer or FeatureLayer initialized from client-side features. The full time extent for the timeInfo is automatically calculated based on start and end fields. The timeInfo parameters cannot be changed after the layer is loaded.

Default Value:null
Example:
// create geojson layer from usgs earthquakes geojson feed
const geojsonLayer = new GeoJSONLayer({
  url: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_month.geojson",
  copyright: "USGS Earthquakes",
  fields: [
    { "name": "mag", "type": "double" },
    { "name": "place", "type": "string" },
    { "name": "time", "type": "date" }, // date field
    { "name": "depth", "type": "double" }
  ],
  // timeInfo can be used to do temporal queries
  // set the startField and endField.
  // timeExtent is automatically calculated from the
  // the start and end date fields
  timeInfo: {
    startField: "time"
  }
});
title String

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.

type Stringreadonly

For CSVLayer the type is csv.

url String

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

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

more details
more detailsLayer

Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it.

more details
more detailsLayer
PopupTemplate

Creates a popup template for the layer, populated with all the fields of the layer.

more details
more detailsCSVLayer
Query

Creates query parameters that can be used to fetch features that satisfy the layer's current filters, and definitions.

more details
more detailsCSVLayer
Boolean

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

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more details
more detailsLayer
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.

more details
more detailsLayer
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.

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<Object>

Executes a Query against the CSV data and returns the Extent of features that satisfy the query.

more details
more detailsCSVLayer
Promise<Number>

Executes a Query against the CSV data and returns the number of features that satisfy the query.

more details
more detailsCSVLayer
Promise<FeatureSet>

Executes a Query against the CSV data and returns a FeatureSet, which can be accessed using the .then() method once the promise resolves.

more details
more detailsCSVLayer
Promise<Number[]>

Executes a Query against the CSV data and returns an array of Object IDs for features that satisfy the input query.

more details
more detailsCSVLayer
Promise

when() may be leveraged once an instance of the class is created.

more details
more detailsLayer

Method Details

cancelLoad()inherited

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

createLayerView(view, options)inherited

Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. This method is used internally and there is no use case for invoking it directly.

Parameters:
view *

The parent view.

options Object
optional

An object specifying additional options. See the object specification table below for the required properties of this object.

Specification:
optional

A signal to abort the creation of the layerview.

createPopupTemplate(options){PopupTemplate}
Since: ArcGIS API for JavaScript 4.11

Creates a popup template for the layer, populated with all the fields of the layer.

Parameters:
Specification:
options Object
optional

Options for creating the popup template.

Specification:
maximumFields Number
optional
Default Value: 75

The maximum number of fields to include in the popup template.

ignoreFieldTypes String[]
optional

Field types to ignore when creating the popup. By default the geometry, blob, raster, guid and xml field types are ignored.

Returns:
TypeDescription
PopupTemplateThe popup template, or null if the layer does not have any fields.
createQuery(){Query}
Since: ArcGIS API for JavaScript 4.7

Creates query parameters that can be used to fetch features that satisfy the layer's current filters, and definitions.

Returns:
TypeDescription
QueryThe query object representing the layer's filters and other definitions.
Example:
// Get a query object for the layer's current configuration
const queryParams = layer.createQuery();
// set a geometry for querying features by the view's extent
queryParams.geometry = view.extent;
// Add to the layer's current definitionExpression
queryParams.where = queryParams.where + " AND TYPE = 'Extreme'";

// query the layer with the modified params object
layer.queryFeatures(queryParams)
  .then(function(results){
    // prints the array of result graphics to the console
    console.log(results.features);
  });
emit(type, event){Boolean}inherited
Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object
optional

The event payload.

Returns:
TypeDescription
Booleantrue if a listener was notified
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

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}inherited

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}inherited

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been resolved.
load(signal){Promise}inherited

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.

It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.

Parameter:
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

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.

Parameters:

A event type, or an array of event types, 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(s).
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
queryExtent(query, options){Promise<Object>}
Since: ArcGIS API for JavaScript 4.7

Executes a Query against the CSV data and returns the Extent of features that satisfy the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned.

Known Limitations

  • Spatial queries have the same limitations as those listed in the projection engine documentation.
  • Spatial queries are currently not supported if the layer view has any of the following SpatialReferences:
    • GDM 2000 (4742) – Malaysia
    • Gusterberg (Ferro) (8042) – Austria/Czech Republic
    • ISN2016 (8086) - Iceland
    • SVY21 (4757) - Singapore
Parameters:
optional
Autocasts from Object

Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the geometry parameter in the query object to the view's extent.

options Object
optional

An object with the following properties.

Specification:
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:
TypeDescription
Promise<Object>When resolved, returns the extent and count of the features that satisfy the input query. See the object specification table below for details.
PropertyTypeDescription
countNumberThe number of features that satisfy the input query.
extentExtentThe extent of the features that satisfy the query.
Example:
// Queries for the extent of all features
// zooms to the extent
csvLayer.when(function () {
  csvLayer.queryExtent().then(function (results) {
    view.goTo(results.extent);
  })
  .catch(function (error) {
    console.log(error)
  });
});
queryFeatureCount(query, options){Promise<Number>}
Since: ArcGIS API for JavaScript 4.7

Executes a Query against the CSV data and returns the number of features that satisfy the query. If no parameters are specified, then the total number of features satisfying the layer's configuration/filters is returned.

Known Limitations

  • Spatial queries have the same limitations as those listed in the projection engine documentation.
  • Spatial queries are currently not supported if the layer view has any of the following SpatialReferences:
    • GDM 2000 (4742) – Malaysia
    • Gusterberg (Ferro) (8042) – Austria/Czech Republic
    • ISN2016 (8086) - Iceland
    • SVY21 (4757) - Singapore
Parameters:
optional
Autocasts from Object

Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the geometry parameter in the query object to the view's extent.

options Object
optional

An object with the following properties.

Specification:
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:
TypeDescription
Promise<Number>When resolved, returns an the number of features satisfying the query.
Example:
// returns all features in the CSVLayer
csvLayer.queryFeatureCount().then(function (count) {
  console.log("Feature count: ", count);
})
.catch(function (error) {
  console.log(error)
});
queryFeatures(query, options){Promise<FeatureSet>}
Since: ArcGIS API for JavaScript 4.7

Executes a Query against the CSV data and returns a FeatureSet, which can be accessed using the .then() method once the promise resolves. A FeatureSet contains an array of Graphic features, which can be added to the view's graphics. This array will not be populated if zero results are found.

Known Limitations

  • Attribute values used in attribute queries executed against layer views are case sensitive.
  • Spatial queries have the same limitations as those listed in the projection engine documentation.
  • Spatial queries are not currently supported if the layer view has any of the following SpatialReferences:
    • GDM 2000 (4742) – Malaysia
    • Gusterberg (Ferro) (8042) – Austria/Czech Republic
    • ISN2016 (8086) - Iceland
    • SVY21 (4757) - Singapore
Parameters:
optional
Autocasts from Object

Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the geometry parameter in the query object to the view's extent.

options Object
optional

An object with the following properties.

Specification:
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:
TypeDescription
Promise<FeatureSet>When resolved, a FeatureSet containing an array of graphic features is returned.
Examples:
// Queries for all the features
csvLayer.queryFeatures().then(function(results){
  // prints the array of result graphics to the console
  console.log(results.features);
});
// Queries for all the features that matches the where clause
var csvLayer = new CSVLayer({
  url: "urlToService"
});

csvLayer.load().then(function(){
  var query = new Query({
    where: "mag > 5",
    returnGeometry: true
  });

  return csvLayer.queryFeatures(query);
})
.then(function(results){
  displayResults(results);
})
.catch(function (error) {
  console.log(error)
});
queryObjectIds(query, options){Promise<Number[]>}
Since: ArcGIS API for JavaScript 4.7

Executes a Query against the CSV data and returns an array of Object IDs for features that satisfy the input query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned.

Known Limitations

  • Spatial queries have the same limitations as those listed in the projection engine documentation.
  • Spatial queries are currently not supported if the layer view has any of the following SpatialReferences:
    • GDM 2000 (4742) – Malaysia
    • Gusterberg (Ferro) (8042) – Austria/Czech Republic
    • ISN2016 (8086) - Iceland
    • SVY21 (4757) - Singapore
Parameters:
optional
Autocasts from Object

Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the geometry parameter in the query object to the view's extent.

options Object
optional

An object with the following properties.

Specification:
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:
TypeDescription
Promise<Number[]>When resolved, returns an array of numbers representing the object IDs of the features satisfying the query.
Examples:
// Queries for all the Object IDs of features
csvLayer.queryObjectIds().then(function(results){
  // prints the array of Object IDs to the console
  console.log(results);
});
const query = new Query({
  where: "state = California"
});

//query objectIds of features belonging to California
csvLayer.queryObjectIds(query).then(function(ids){
  console.log(ids);  // an array of object IDs
});
when(callback, errback){Promise}inherited
Since: ArcGIS API for JavaScript 4.6

when() 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 instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

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.when(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,error: Error}

Fires when an error emits during the creation of a LayerView after a layer has been added to the map.

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-create-errorinherited

Fires when an error emits during the creation of a LayerView after a layer has been added to the map.

Properties:
view View

The view that failed to create a layerview for the layer emitting this event.

error Error

An error object describing why the layer view failed to create.

See also:
Example:
// This function fires when an error occurs during the creation of the layer's layerview
layer.on("layerview-create-error", function(event) {
  console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view);
});
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
Loading...