import FeatureService from "@arcgis/core/rest/featureService/FeatureService.js";
Inheritance
FeatureService→Accessor
Since
ArcGIS Maps SDK for JavaScript 4.28

This class contains metadata about the feature service. The class can be constructed via a url to a feature service or from the class utils using the createFeatureServices() method.

Constructors

Constructor

Constructor

Parameters

ParameterTypeDescriptionRequired
properties
See the properties table for a list of all the properties that may be passed into the constructor.
Examples
// Create a FeatureService from a url
const featureService = new FeatureService({
url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Wildfire/FeatureServer"
});
// Create a FeatureService using [createFeatureServices()](https://next.gha.afd.arcgis.com/javascript/latest/references/core/rest/featureService/utils/#createFeatureServices)
const layer1 = new FeatureLayer({url: `https://sampleserver6.arcgisonline.com/arcgis/rest/services/TestService/FeatureServer/12`});
const layer2 = new FeatureLayer({url: `https://sampleserver6.arcgisonline.com/arcgis/rest/services/TestService/FeatureServer/13`});
const layers = [layer1, layer2];
const mapOfServices = createFeatureServices(layers);
//loading featureService from map object.
const featureService = await mapOfServices.get(`https://sampleserver6.arcgisonline.com/arcgis/rest/services/TestService/FeatureServer`).featureService.load();

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
PropertyTypeClass
readonly
readonly inherited
readonly
readonly inherited
readonly inherited
"not-loaded" | "loading" | "failed" | "loaded"
readonly inherited
any[]
uid
readonly inherited
url
string[]

capabilities

readonly Property
Type
ServiceCapabilities | null | undefined

Describes the layer's supported capabilities.

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor

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

effectiveCapabilities

readonly Property
Type
ServiceCapabilities | null
Since
ArcGIS Maps SDK for JavaScript 4.30

Describes effective capabilities of the service taking in to consideration privileges of the currently signed-in user.

layerInfos

Property
Type
LayerInfo[]

Contains info of all layers in the Feature Service.

loaded

readonly Property
Type
boolean

Indicates whether the instance has loaded. When true, the properties of the object can be accessed. A WebMap is considered loaded when its WebDocument2D.layers and WebDocument2D.basemap are created, but not yet loaded.

Default value
false

loadError

readonlyinherited Property
Type
EsriError | null | undefined
Inherited from: LoadableMixin

The Error object returned if an error occurred while loading.

loadStatus

readonlyinherited Property
Type
"not-loaded" | "loading" | "failed" | "loaded"
Inherited from: LoadableMixin

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

readonlyinherited Property
Type
any[]
Inherited from: LoadableMixin

A list of warnings which occurred while loading.

tableInfos

Property
Type
TableInfo[]

Contains info of all tables in the Feature Service.

uid

readonlyinherited Property
Type
string
Inherited from: IdentifiableMixin
Since
ArcGIS Maps SDK for JavaScript 4.33

An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.

url

Property
Type
string

The absolute URL of the REST endpoint for the feature service. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online.

userTypeExtensions

Property
Type
string[]

Describes the service's userTypeExtensions.

utilityNetworkUrl

readonly Property
Type
string | null

The url that points to the utility network layer, if it exists.

versionManagementServiceUrl

readonly Property
Type
string | null

The url to the version management service, if the data is versioned.

Methods

MethodSignatureClass
inherited static
fromJSON(json: any): any
addEditOperation(serviceEditResults: ServiceEditsResult[], versionIdentifier?: VersionIdentifier): void
applyEdits(edits: ServiceEdits[], options?: ServiceEditOptions): Promise<ServiceEditsResult[]>
inherited
cancelLoad(): this
inherited
emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
fetchAllLayersAndTables(options?: AbortOptions | null | undefined): Promise<ServiceContents>
getMoment(versionIdentifier: VersionIdentifier): Date | null | undefined
getSessionId(): string
inherited
hasEventListener<Type extends EventNames<this>>(type: Type): boolean
inherited
isFulfilled(): boolean
inherited
isRejected(): boolean
inherited
isResolved(): boolean
load(options?: AbortOptions | null | undefined): Promise<this>
on
inherited
on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
inherited
toJSON(): any
inherited
when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>

fromJSON

inheritedstatic Method
Signature
fromJSON (json: any): any
Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

ParameterTypeDescriptionRequired
json
any

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns
any

Returns a new instance of this class.

addEditOperation

Method
Signature
addEditOperation (serviceEditResults: ServiceEditsResult[], versionIdentifier?: VersionIdentifier): void

Adds edit operation results to the feature service and emits the corresponding edit operation event.

Parameters

ParameterTypeDescriptionRequired
serviceEditResults

Results to associate with the edit operation.

versionIdentifier

Identifier of the branch version associated with the edit operation.

Returns
void
Examples
const serviceEditResults = await featureService.applyEdits([
{
id: 0,
identifierFields: { objectIdField: "OBJECTID" },
addFeatures: [graphic],
},
]);
featureService.addEditOperation(serviceEditResults);
const versionIdentifier: VersionIdentifier = {
name: "user.version",
guid: "{6F5C18F2-6A3E-4C65-9C8D-538CF93D3D0D}",
};
featureService.addEditOperation(serviceEditResults, versionIdentifier);

applyEdits

Method
Signature
applyEdits (edits: ServiceEdits[], options?: ServiceEditOptions): Promise<ServiceEditsResult[]>

Applies edits to features in the feature service layers. New features can be created and existing features can be updated or deleted. Feature geometries and/or attributes may be modified. Only applicable to layers in a feature service.

When calling the applyEdits method on a service that does not have vertical coordinate system information, the z-values of the geometries in the edits object will automatically be converted to match the spatial reference of the layer. Example: The service has a horizontal spatial reference with feet units, and applyEdits() is called with z-values based on meter units, then the method will automatically convert the z values from meter to feet units. applyEdits() will pass in a sessionId during an active edit session.

Parameters

ParameterTypeDescriptionRequired
edits

Object containing features and attachments to be added, updated or deleted.

options

Additional edit options to specify when editing features or attachments.

Returns
Promise<ServiceEditsResult[]>

Results returned from the applyEdits() method. It contains features that were added, deleted or updated in different feature layers. It also contains the edit moment.

Example
// Adding multiple features with a single edit object
import Graphic from "esri/Graphic";
import Point from "esri/geometry/Point";
import FeatureService from "esri/rest/featureService/FeatureService";
const featureService = new FeatureService({
url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Wildfire/FeatureServer",
});
await featureService.load();
featureService.applyEdits(
[
{
id: 0, // The layer ID, or layer index, of a Feature Service layer
identifierFields: { objectIdField: "OBJECTID" },
addFeatures: [
new Graphic({
geometry: new Point({
x: -1329300,
y: 4038900,
spatialReference: {
wkid: 102100,
},
}),
attributes: {
description: "Feature description",
},
}),
new Graphic({
geometry: new Point({
x: -13300000,
y: 4039000,
spatialReference: {
wkid: 102100,
},
}),
attributes: {
description: "Feature description",
},
}),
],
},
],
{
gdbVersion: null,
globalIdUsed: false,
honorSequenceOfEdits: false,
usePreviousEditMoment: false,
},
);
// Adding multiple features with multiple edit objects
await featureService.applyEdits(
[
{
id: 0, // The layer ID, or layer index, of a Feature Service layer
identifierFields: { objectIdField: "OBJECTID" },
addFeatures: [
new Graphic({
geometry: new Point({
x: -13294000,
y: 4038800,
spatialReference: {
wkid: 102100,
},
}),
attributes: {
description: "Feature description",
},
}),
],
},
{
id: 0, // The layer ID, or layer index, of a Feature Service layer
identifierFields: { objectIdField: "OBJECTID" },
addFeatures: [
new Graphic({
geometry: new Point({
x: -13292000,
y: 4038800,
spatialReference: {
wkid: 102100,
},
}),
attributes: {
description: "Feature description",
},
}),
],
},
],
{
gdbVersion: null,
globalIdUsed: false,
honorSequenceOfEdits: true,
usePreviousEditMoment: false,
},
);

cancelLoad

inherited Method
Signature
cancelLoad (): this
Inherited from: LoadableMixin

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

Returns
this

emit

inherited Method
Signature
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
Type parameters
<Type extends EventNames<this>>
Inherited from: EventedMixin

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

Parameters

ParameterTypeDescriptionRequired
type
Type

The name of the event.

event
this["@eventTypes"][Type]

The event payload.

Returns
boolean

true if a listener was notified

fetchAllLayersAndTables

Method
Signature
fetchAllLayersAndTables (options?: AbortOptions | null | undefined): Promise<ServiceContents>

Triggers the loading of the feature service instance and fetches all layers and tables.

Fully loads the Feature Service definition.

Parameters

ParameterTypeDescriptionRequired
options

Additional options.

Returns
Promise<ServiceContents>

Resolves when the Feature Service is loaded.

getMoment

Method
Signature
getMoment (versionIdentifier: VersionIdentifier): Date | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.2

Returns the current edit moment for a branch version.

Parameters

ParameterTypeDescriptionRequired
versionIdentifier

Identifier of the branch version.

Returns
Date | null | undefined

The current edit moment for the specified version, or null if unavailable.

Example
const versionIdentifier: VersionIdentifier = {
name: "user.version",
guid: "{6F5C18F2-6A3E-4C65-9C8D-538CF93D3D0D}",
};
const moment = featureService.getMoment(versionIdentifier);
if (moment) {
console.log(moment.toISOString());
}

getSessionId

Method
Signature
getSessionId (): string
Since
ArcGIS Maps SDK for JavaScript 5.2

Returns the current edit session ID.

Returns
string

The current edit session ID.

Example
const sessionId = featureService.getSessionId();
console.log(sessionId);

hasEventListener

inherited Method
Signature
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
Type parameters
<Type extends EventNames<this>>
Inherited from: EventedMixin

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

Parameters

ParameterTypeDescriptionRequired
type
Type

The name of the event.

Returns
boolean

Returns true if the class supports the input event.

isFulfilled

inherited Method
Signature
isFulfilled (): boolean
Inherited from: EsriPromiseMixin

isFulfilled() may be used to verify whether the promise has been fulfilled (either resolved or rejected).

Returns
boolean

Whether the promise has been fulfilled (either resolved or rejected).

isRejected

inherited Method
Signature
isRejected (): boolean
Inherited from: EsriPromiseMixin

isRejected() may be used to verify whether the promise has been rejected.

Returns
boolean

Whether the promise has been rejected.

isResolved

inherited Method
Signature
isResolved (): boolean
Inherited from: EsriPromiseMixin

isResolved() may be used to verify whether the promise has resolved.

Returns
boolean

Whether the promise has resolved.

load

Method
Signature
load (options?: AbortOptions | null | undefined): Promise<this>

Triggers the loading of the feature service instance.

Fully loads the Feature Service definition.

Parameters

ParameterTypeDescriptionRequired
options

Additional options.

Returns
Promise<this>

Resolves when the Feature Service is loaded.

on

inherited Method
Signature
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
Type parameters
<Type extends EventNames<this>>
Inherited from: EventedMixin

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

ParameterTypeDescriptionRequired
type
Type

An event or an array of events to listen for.

listener
EventedCallback<this["@eventTypes"][Type]>

The function to call when the event fires.

Returns
ResourceHandle

Returns an event handler with a remove() method that should 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);
});

toJSON

inherited Method
Signature
toJSON (): any
Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
any

The ArcGIS portal JSON representation of an instance of this class.

when

inherited Method
Signature
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
Type parameters
<TResult1 = this, TResult2 = never>
Inherited from: EsriPromiseMixin

when() may be used with an instance of this class. This method takes two input parameters: an onFulfilled function and an onRejected function. The onFulfilled function executes when the promise resolves. The onRejected function executes if the promise is rejected.

Parameters

ParameterTypeDescriptionRequired
onFulfilled

The function to call when the promise resolves.

onRejected

The function to execute when the promise fails.

Returns
Promise<TResult1 | TResult2>

Returns a new promise for the result of onFulfilled that may be used to chain additional functions.

Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let 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
});

Type definitions

FeatureServiceApplyEditsEvent

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.2

The payload for the apply-edits event. This payload describes an event emitted after applyEdits().

layerId

Property
Type
number | null

ID of the layer whose applyEdits() operation produced this event.

mayReceiveServiceEdits

Property
Type
boolean

If true, FeatureServiceApplyEditsEvent may include features edited due to the geodatabase behavior that results from applying the edits. For example, if a feature is deleted and it is the origin in a composite relationship, the destination feature is automatically deleted in the geodatabase.

If false, FeatureServiceApplyEditsEvent includes only features directly edited by applyEdits.

gdbVersion

Property
Type
string | null

Geodatabase version on which the edit moment was updated, if provided. A null value indicates the edit occurred on the service's default version.

result

Property
Type
Promise<EditsResultEvent>

Resolves to the results of the edits for layer FeatureServiceApplyEditsEvent.

FeatureServiceUpdateMomentEvent

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.2

This payload describes the new edit moment being used by the feature service's FeatureServiceUpdateMomentEvent. If FeatureServiceUpdateMomentEvent is null, this payload describes the new historic moment used by the feature service's default version.

gdbVersion

Property
Type
string | null

Geodatabase version on which the edit moment was updated, if provided. A null value indicates the edit occurred on the service's default version.

moment

Property
Type
Date | null

The updated edit moment.