FeatureLayerHandle
FeatureLayerHandle =
object
Defined in: src/ExpoArcgis.types.ts:736
Methods
Section titled “Methods”addAttachment()
Section titled “addAttachment()”addAttachment(
objectId,name,contentType,dataBase64):Promise<void>
Defined in: src/ExpoArcgis.types.ts:845
Adds an attachment to the feature with objectId and immediately persists the edit.
Parameters
Section titled “Parameters”objectId
Section titled “objectId”number
string
File name (e.g. "photo.jpg").
contentType
Section titled “contentType”string
MIME type (e.g. "image/jpeg").
dataBase64
Section titled “dataBase64”string
Base64-encoded file contents.
Returns
Section titled “Returns”Promise<void>
addFeature()
Section titled “addFeature()”addFeature(
attributes,geometry?,apply?):Promise<number|null>
Defined in: src/ExpoArcgis.types.ts:752
Adds a feature (attributes + optional geometry) to the layer’s table. By default pushes the
edit to the service and resolves to the new object id; pass apply: false to make a local-only
edit, then batch with applyEdits. Resolves to null for non-service tables or local edits.
Parameters
Section titled “Parameters”attributes
Section titled “attributes”Record<string, unknown>
geometry?
Section titled “geometry?”apply?
Section titled “apply?”boolean
Returns
Section titled “Returns”Promise<number | null>
addFeatureWithSubtype()
Section titled “addFeatureWithSubtype()”addFeatureWithSubtype(
subtypeName,attributes?,geometry?,apply?):Promise<number|null>
Defined in: src/ExpoArcgis.types.ts:797
Creates a feature from the named feature subtype (sets the subtype field and inherits the
subtype’s default attribute values), then optionally overrides attributes on top and sets
geometry. By default pushes the edit to the service and resolves to the new object id;
pass apply: false to make a local-only edit. Rejects if no subtype with that name exists.
Requires an ArcGIS feature table (service or mobile geodatabase) — rejects for shapefiles
and WFS tables, which do not expose feature subtypes.
Parameters
Section titled “Parameters”subtypeName
Section titled “subtypeName”string
attributes?
Section titled “attributes?”Record<string, unknown>
geometry?
Section titled “geometry?”apply?
Section titled “apply?”boolean
Returns
Section titled “Returns”Promise<number | null>
Example
Section titled “Example”const id = await layer.current.addFeatureWithSubtype( 'Arterial', { ROADNAME: 'Main St' }, { type: 'point', x: -117.19, y: 34.05 });addFeatureWithTemplate()
Section titled “addFeatureWithTemplate()”addFeatureWithTemplate(
templateName,attributes?,geometry?,apply?):Promise<number|null>
Defined in: src/ExpoArcgis.types.ts:774
Creates a feature from the named editing template (so the new feature inherits the template’s
prototype attributes), then optionally overrides attributes on top and sets geometry.
By default pushes the edit to the service and resolves to the new object id; pass
apply: false to make a local-only edit. Rejects if no template with that name exists.
Requires an ArcGIS feature table (service or mobile geodatabase) — rejects for shapefiles
and WFS tables, which do not expose editing templates.
Parameters
Section titled “Parameters”templateName
Section titled “templateName”string
attributes?
Section titled “attributes?”Record<string, unknown>
geometry?
Section titled “geometry?”apply?
Section titled “apply?”boolean
Returns
Section titled “Returns”Promise<number | null>
Example
Section titled “Example”const id = await layer.current.addFeatureWithTemplate( 'Residential', { ADDRESS: '1 Main St' }, { type: 'point', x: -117.19, y: 34.05 });applyEdits()
Section titled “applyEdits()”applyEdits():
Promise<EditResult[]>
Defined in: src/ExpoArcgis.types.ts:812
Pushes all pending local edits to the service in one batch; resolves to each edit’s result.
Returns
Section titled “Returns”Promise<EditResult[]>
clearSelection()
Section titled “clearSelection()”clearSelection():
void
Defined in: src/ExpoArcgis.types.ts:836
Clears the layer’s selection.
Returns
Section titled “Returns”void
contingentValues()
Section titled “contingentValues()”contingentValues(
attributes,fieldName):Promise<object[]>
Defined in: src/ExpoArcgis.types.ts:882
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 defined on the table.
The table and its ContingentValuesDefinition are loaded automatically. A temporary feature
is built from attributes (no server round-trip for the feature itself); only ArcGISFeature
tables are supported — rejects for shapefiles and WFS tables.
Parameters
Section titled “Parameters”attributes
Section titled “attributes”Record<string, unknown>
fieldName
Section titled “fieldName”string
Returns
Section titled “Returns”Promise<object[]>
Example
Section titled “Example”const options = await layer.current.contingentValues({ habitat: 'oak' }, 'species');// options → [{ name: 'Red Oak', code: 1 }, { name: 'White Oak', code: 2 }]deleteAttachment()
Section titled “deleteAttachment()”deleteAttachment(
objectId,attachmentId):Promise<void>
Defined in: src/ExpoArcgis.types.ts:852
Deletes the attachment with attachmentId from the feature with objectId and persists.
Parameters
Section titled “Parameters”objectId
Section titled “objectId”number
attachmentId
Section titled “attachmentId”number
Returns
Section titled “Returns”Promise<void>
deleteFeature()
Section titled “deleteFeature()”deleteFeature(
objectId,apply?):Promise<void>
Defined in: src/ExpoArcgis.types.ts:810
Deletes the feature with objectId. Pass apply: false for a local-only edit.
Parameters
Section titled “Parameters”objectId
Section titled “objectId”number
apply?
Section titled “apply?”boolean
Returns
Section titled “Returns”Promise<void>
fetchAttachment()
Section titled “fetchAttachment()”fetchAttachment(
objectId,attachmentId):Promise<string>
Defined in: src/ExpoArcgis.types.ts:850
Fetches the binary data for the attachment with attachmentId on the feature with objectId
and returns it as a base64 string.
Parameters
Section titled “Parameters”objectId
Section titled “objectId”number
attachmentId
Section titled “attachmentId”number
Returns
Section titled “Returns”Promise<string>
getContingentValues()
Section titled “getContingentValues()”getContingentValues(
objectId,fieldName):Promise<ContingentValuesResult>
Defined in: src/ExpoArcgis.types.ts:898
Returns the valid contingent values for fieldName on the feature with objectId, given
the feature’s current attribute state. Contingent values constrain which attribute values
are valid based on the values of other fields (e.g. “species” options depend on “habitat”).
Requires an ArcGIS feature table (service or mobile geodatabase) — rejects for shapefiles
and WFS tables. Resolves with an empty contingentValues list when no constraints apply.
Parameters
Section titled “Parameters”objectId
Section titled “objectId”number
fieldName
Section titled “fieldName”string
Returns
Section titled “Returns”Promise<ContingentValuesResult>
Example
Section titled “Example”const result = await layer.current.getContingentValues(42, 'species');// result.contingentValues[0] → { type: 'coded', fieldGroupName: 'HabitatGroup',// codedValue: { name: 'Oak', code: 1 } }getDictionarySymbolStyleSchema()
Section titled “getDictionarySymbolStyleSchema()”getDictionarySymbolStyleSchema():
Promise<string|null>
Defined in: src/ExpoArcgis.types.ts:825
The UI schema of the layer’s dictionaryRenderer style, as a JSON string, or null when the
layer has no dictionary renderer (ArcGIS 300.1).
The schema lists the style’s configuration rules and each symbology field’s allowed values — what you need to build a symbol picker for military or utility symbology instead of asking the user to type raw SIDC-style codes.
Returns
Section titled “Returns”Promise<string | null>
getServiceGeodatabase()
Section titled “getServiceGeodatabase()”getServiceGeodatabase():
Promise<ServiceGeodatabaseHandle>
Defined in: src/ExpoArcgis.types.ts:865
Returns the branch-versioning handle for this layer’s service geodatabase (ArcGIS Enterprise branch-versioned services only). Loads the table first; rejects if the layer is not a service feature layer. The same handle is returned on repeat calls.
Returns
Section titled “Returns”Promise<ServiceGeodatabaseHandle>
queryAttachments()
Section titled “queryAttachments()”queryAttachments(
objectId):Promise<AttachmentInfo[]>
Defined in: src/ExpoArcgis.types.ts:838
Returns the metadata for all attachments on the feature with objectId.
Parameters
Section titled “Parameters”objectId
Section titled “objectId”number
Returns
Section titled “Returns”Promise<AttachmentInfo[]>
queryExtent()
Section titled “queryExtent()”queryExtent(
query?):Promise<Geometry|null>
Defined in: src/ExpoArcgis.types.ts:742
Returns the combined extent (envelope) of the features matching query.
Parameters
Section titled “Parameters”query?
Section titled “query?”Returns
Section titled “Returns”Promise<Geometry | null>
queryFeatureCount()
Section titled “queryFeatureCount()”queryFeatureCount(
query?):Promise<number>
Defined in: src/ExpoArcgis.types.ts:740
Returns the number of features matching query.
Parameters
Section titled “Parameters”query?
Section titled “query?”Returns
Section titled “Returns”Promise<number>
queryFeatures()
Section titled “queryFeatures()”queryFeatures(
query?):Promise<Feature[]>
Defined in: src/ExpoArcgis.types.ts:738
Returns the features matching query (all features when omitted).
Parameters
Section titled “Parameters”query?
Section titled “query?”Returns
Section titled “Returns”Promise<Feature[]>
queryFeatureTemplates()
Section titled “queryFeatureTemplates()”queryFeatureTemplates():
Promise<FeatureTemplate[]>
Defined in: src/ExpoArcgis.types.ts:746
Returns the table’s editing templates (name + prototype attributes), for building edit UIs.
Returns
Section titled “Returns”Promise<FeatureTemplate[]>
queryRelatedFeatures()
Section titled “queryRelatedFeatures()”queryRelatedFeatures(
objectId):Promise<RelatedFeaturesResult[]>
Defined in: src/ExpoArcgis.types.ts:816
Queries features related to objectId across all relationships, grouped by relationship.
Parameters
Section titled “Parameters”objectId
Section titled “objectId”number
Returns
Section titled “Returns”Promise<RelatedFeaturesResult[]>
queryStatistics()
Section titled “queryStatistics()”queryStatistics(
query):Promise<StatisticRecord[]>
Defined in: src/ExpoArcgis.types.ts:744
Computes aggregate statistics over the layer’s features.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<StatisticRecord[]>
selectFeatures()
Section titled “selectFeatures()”selectFeatures(
objectIds):Promise<void>
Defined in: src/ExpoArcgis.types.ts:834
Highlights the features with objectIds, replacing any current selection.
The SDK draws the highlight above the layer, which a <Graphic> in a <GraphicsOverlay>
cannot be made to do: overlays and layers are depth-sorted against one another in a
<SceneView>, so a marker placed at a feature’s own location is as likely to land behind it
as in front. The highlight colour is a property of the view rather than the layer.
Parameters
Section titled “Parameters”objectIds
Section titled “objectIds”number[]
Returns
Section titled “Returns”Promise<void>
undoLocalEdits()
Section titled “undoLocalEdits()”undoLocalEdits():
Promise<void>
Defined in: src/ExpoArcgis.types.ts:814
Discards all pending local edits made since the last applyEdits.
Returns
Section titled “Returns”Promise<void>
updateAttachment()
Section titled “updateAttachment()”updateAttachment(
objectId,attachmentId,name,contentType,dataBase64):Promise<void>
Defined in: src/ExpoArcgis.types.ts:859
Updates the attachment with attachmentId on the feature with objectId and persists.
Parameters
Section titled “Parameters”objectId
Section titled “objectId”number
attachmentId
Section titled “attachmentId”number
string
New file name (e.g. "photo.jpg").
contentType
Section titled “contentType”string
New MIME type (e.g. "image/jpeg").
dataBase64
Section titled “dataBase64”string
New base64-encoded file contents.
Returns
Section titled “Returns”Promise<void>
updateFeature()
Section titled “updateFeature()”updateFeature(
objectId,changes,apply?):Promise<void>
Defined in: src/ExpoArcgis.types.ts:804
Updates the feature with objectId. Pass apply: false for a local-only edit.
Parameters
Section titled “Parameters”objectId
Section titled “objectId”number
changes
Section titled “changes”attributes?
Section titled “attributes?”Record<string, unknown>
geometry?
Section titled “geometry?”apply?
Section titled “apply?”boolean
Returns
Section titled “Returns”Promise<void>