Skip to content
GuidesToolkitAPI

FeatureLayerRef

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:99

Reference to a native FeatureLayer — a LayerRef plus the async query methods (these match FeatureLayerHandle, so the component just hands this ref over via useImperativeHandle).

addAttachment(objectId, name, contentType, dataBase64): Promise<void>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:131

number

string

string

string

Promise<void>


addFeature(attributes, geometry?, apply?): Promise<number | null>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:105

Record<string, unknown>

Geometry

boolean

Promise<number | null>


addFeatureWithSubtype(subtypeName, attributes?, geometry?, apply?): Promise<number | null>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:116

string

Record<string, unknown>

Geometry

boolean

Promise<number | null>


addFeatureWithTemplate(templateName, attributes?, geometry?, apply?): Promise<number | null>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:110

string

Record<string, unknown>

Geometry

boolean

Promise<number | null>


addListener<EventName>(eventName, listener): EventSubscription

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:44

Adds a listener for the given event name.

EventName extends never

EventName

Record<never, never>[EventName]

EventSubscription

LayerRef.addListener


applyEdits(): Promise<EditResult[]>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:124

Promise<EditResult[]>


applyProps(changed): void

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:65

Record<string, unknown>

void

LayerRef.applyProps


clearSelection(): void

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:129

void


contingentValues(attributes, fieldName): Promise<object[]>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:145

Returns the valid coded values for fieldName given the feature’s current attributes. Use this to drive editing-form dropdowns: pass the feature’s current attribute state and the name of the field being edited; returns [{ name, code }] for coded values that satisfy all contingent-value constraints.

Requires an ArcGIS feature table; rejects for shapefiles and WFS tables. Resolves with an empty array when no constraints are defined for fieldName.

Record<string, unknown>

string

Promise<object[]>


deleteAttachment(objectId, attachmentId): Promise<void>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:133

number

number

Promise<void>


deleteFeature(objectId, apply?): Promise<void>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:123

number

boolean

Promise<void>


emit<EventName>(eventName, …args): void

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:57

Synchronously calls all the listeners attached to that specific event. The event can include any number of arguments that will be passed to the listeners.

EventName extends never

EventName

…Parameters<Record<never, never>[EventName]>

void

LayerRef.emit


fetchAttachment(objectId, attachmentId): Promise<string>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:132

number

number

Promise<string>


getContingentValues(objectId, fieldName): Promise<ContingentValuesResult>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:152

Returns the valid contingent values for fieldName on the feature with objectId. The fieldName is the name of an attribute field whose valid values may be constrained by contingent-value rules (e.g. a “species” field whose options depend on “habitat”). Requires an ArcGIS feature table; rejects for shapefiles and WFS tables.

number

string

Promise<ContingentValuesResult>


getDictionarySymbolStyleSchema(): Promise<string | null>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:127

Promise<string | null>


getServiceGeodatabase(): Promise<ServiceGeodatabaseRef>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:135

Promise<ServiceGeodatabaseRef>


listenerCount<EventName>(eventName): number

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:61

Returns a number of listeners added to the given event.

EventName extends never

EventName

number

LayerRef.listenerCount


queryAttachments(objectId): Promise<AttachmentInfo[]>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:130

number

Promise<AttachmentInfo[]>


queryExtent(query?): Promise<Geometry | null>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:102

QueryParameters

Promise<Geometry | null>


queryFeatureCount(query?): Promise<number>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:101

QueryParameters

Promise<number>


queryFeatures(query?): Promise<Feature[]>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:100

QueryParameters

Promise<Feature[]>


queryFeatureTemplates(): Promise<FeatureTemplate[]>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:104

Promise<FeatureTemplate[]>


queryRelatedFeatures(objectId): Promise<RelatedFeaturesResult[]>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:126

number

Promise<RelatedFeaturesResult[]>


queryStatistics(query): Promise<StatisticRecord[]>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:103

StatisticsQueryParameters

Promise<StatisticRecord[]>


release(): void

Defined in: node_modules/expo-modules-core/build/ts-declarations/SharedObject.d.ts:18

A function that detaches the JS and native objects to let the native object deallocate before the JS object gets deallocated by the JS garbage collector. Any subsequent calls to native functions of the object will throw an error as it is no longer associated with its native counterpart.

In most cases, you should never need to use this function, except some specific performance-critical cases when manual memory management makes sense and the native object is known to exclusively retain some native memory (such as binary data or image bitmap). Before calling this function, you should ensure that nothing else will use this object later on. Shared objects created by React hooks are usually automatically released in the effect’s cleanup phase, for example: useVideoPlayer() from expo-video and useImage() from expo-image.

void

LayerRef.release


removeAllListeners(eventName): void

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:52

Removes all listeners for the given event name.

never

void

LayerRef.removeAllListeners


removeListener<EventName>(eventName, listener): void

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:48

Removes a listener for the given event name.

EventName extends never

EventName

Record<never, never>[EventName]

void

LayerRef.removeListener


selectFeatures(objectIds): Promise<void>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:128

number[]

Promise<void>


optional startObserving<EventName>(eventName): void

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:66

Function that is automatically invoked when the first listener for an event with the given name is added. Override it in a subclass to perform some additional setup once the event started being observed.

EventName extends never

EventName

void

LayerRef.startObserving


optional stopObserving<EventName>(eventName): void

Defined in: node_modules/expo-modules-core/build/ts-declarations/EventEmitter.d.ts:71

Function that is automatically invoked when the last listener for an event with the given name is removed. Override it in a subclass to perform some additional cleanup once the event is no longer observed.

EventName extends never

EventName

void

LayerRef.stopObserving


undoLocalEdits(): Promise<void>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:125

Promise<void>


updateAttachment(objectId, attachmentId, name, contentType, dataBase64): Promise<void>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:134

number

number

string

string

string

Promise<void>


updateFeature(objectId, changes, apply?): Promise<void>

Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:122

number

Record<string, unknown>

boolean

Promise<void>