L.esri.FeatureLayerService

Extends L.esri.Service

L.esri.FeatureLayerService is an abstraction for interacting with Feature Layers running on ArcGIS Online and ArcGIS Server that allows you to make requests to the API, as well as query, add, update and remove features from the service.

Constructor

ConstructorDescription
L.esri.featureLayerService(<Object>options)options for configuring the ArcGIS Server or ArcGIS Online feature layer you would like to consume. Options include a `url` parameter which refers to the ArcGIS Server or ArcGIS Online service you would like to consume.

Options

L.esri.FeatureLayerService accepts all L.esri.Service options.

Events

L.esri.FeatureLayerService fires all L.esri.service events.

Methods

MethodReturnsDescription
query()thisReturns a new L.esri.Query object that can be used to query this layer.
Use dark colors for code blocksCopy
      
1
2
3
4
5
6
featureLayer.query()
.within(latlngbounds)
.where("Direction = 'WEST'")
.run(function (error, featureCollection, response) {
    console.log(featureCollection);
});
addFeature(<GeoJSON Feature>feature, <Function>callback, <Object>context)thisAdds a new feature to the feature layer. this also adds the feature to the map if creation is successful.
  • Requires authentication as a user who has permission to edit the service in ArcGIS Online or the user who created the service.
  • Requires the Create capability be enabled on the service. You can check if creation exists by checking the metadata of your service under capabilities.
updateFeature(<GeoJSON Feature>feature, <Function>callback, <Object>context)thisUpdate the provided feature on the Feature Layer. This also updates the feature on the map.
  • Requires authentication as a user who has permission to edit the service in ArcGIS Online or the user who created the service.
  • Requires the Update capability be enabled on the service. You can check if this operation exists by checking the metadata of your service under capabilities.
deleteFeature(<String or Integer>id, <Function>callback, <Object>context)thisRemove the feature with the provided id from the feature layer. This will also remove the feature from the map if it exists.
  • Requires authentication as a user who has permission to edit the service in ArcGIS Online or the user who created the service.
  • Requires the Delete capability be enabled on the service. You can check if this operation exists by checking the metadata of your service under capabilities.
deleteFeatures(<Array of String or Integers>ids, <Function>callback, <Object>context)thisRemoves an array of features with the provided ids from the feature layer. This will also remove the features from the map if they exist.
  • Requires authentication as a user who has permission to edit the service in ArcGIS Online or the user who created the service.
  • Requires the Delete capability be enabled on the service. You can check if this operation exists by checking the metadata of your service under capabilities.

Examples

Note: These samples use a public feature service on ArcGIS Online that does not require authentication.

Adding Features
Use dark colors for code blocksCopy
                       
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
var service = L.esri.featureLayerService({
    url: 'https://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Pubic_Feature_Service/FeatureServer/0'
});

var feature = {
    type: 'Feature',
    geometry: {
    type: 'Point',
        coordinates: [-122, 45]
    },
    properties: {
        name: 'Hello World'
    }
};

service.addFeature(feature, function (error, response) {
    if (error) {
    console.log('error creating feature' + error.message);
    }
    else {
    console.log('Successfully created feature with id ' + response.objectId);
    }
});
Updating Features
Use dark colors for code blocksCopy
                        
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
var service = L.esri.featureLayerService({
    url: 'https://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Pubic_Feature_Service/FeatureServer/0'
});

var feature = {
    type: 'Feature',
    id: 2,
    geometry: {
        type: 'Point',
        coordinates: [-122, 45]
    },
    properties: {
        name: 'Hi I'm Feature 2'
    }
};

service.updateFeature(feature, function (error, response) {
    if (error) {
    console.log('error updating feature' + error.message);
    }
    else {
    console.log('Successfully updated feature ' + feature.id);
    }
});
Deleting Features
Use dark colors for code blocksCopy
            
1
2
3
4
5
6
7
8
9
10
11
12
var service = L.esri.featureLayerService({
    url: 'https://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Pubic_Feature_Service/FeatureServer/0'
});

service.deleteFeature(2, function (error, response) {
    if (error) {
    console.log('error deleting feature' + error.message);
    }
    else {
    console.log('Successfully deleted feature ' + response.objectId);
    }
});
Querying Features
Use dark colors for code blocksCopy
           
1
2
3
4
5
6
7
8
9
10
11
var service = L.esri.featureLayerService({
    url: 'https://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Pubic_Feature_Service/FeatureServer/0'
});

service.query().where("name='Hello World'").run(function (error, featureCollection, response) {
    if (error) {
    console.log(error);
    return;
    }
    console.log(featureCollection.features[0].properties.name);
});

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