ExpoArcgisModule
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:393
Extends
Section titled “Extends”NativeModule
Properties
Section titled “Properties”AnalysisOverlayRef
Section titled “AnalysisOverlayRef”AnalysisOverlayRef: () =>
AnalysisOverlayRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:448
Returns
Section titled “Returns”DistanceMeasurementRef
Section titled “DistanceMeasurementRef”DistanceMeasurementRef: (
props) =>DistanceMeasurementRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:453
Parameters
Section titled “Parameters”Pick<DistanceMeasurementProps, "startLocation" | "endLocation">
Returns
Section titled “Returns”DynamicEntityLayerRef
Section titled “DynamicEntityLayerRef”DynamicEntityLayerRef: (
props) =>DynamicEntityLayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:444
Parameters
Section titled “Parameters”Returns
Section titled “Returns”FeatureLayerRef
Section titled “FeatureLayerRef”FeatureLayerRef: (
props) =>FeatureLayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:428
Parameters
Section titled “Parameters”Returns
Section titled “Returns”GeoElementLineOfSightRef
Section titled “GeoElementLineOfSightRef”GeoElementLineOfSightRef: (
observer,target) =>GeoElementLineOfSightRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:452
Parameters
Section titled “Parameters”observer
Section titled “observer”target
Section titled “target”Returns
Section titled “Returns”GeoElementViewshedRef
Section titled “GeoElementViewshedRef”GeoElementViewshedRef: (
graphic,props) =>GeoElementViewshedRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:450
Parameters
Section titled “Parameters”graphic
Section titled “graphic”Returns
Section titled “Returns”GeometryEditorRef
Section titled “GeometryEditorRef”GeometryEditorRef: () =>
GeometryEditorRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:447
Returns
Section titled “Returns”GraphicRef
Section titled “GraphicRef”GraphicRef: (
props) =>GraphicRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:446
Parameters
Section titled “Parameters”Returns
Section titled “Returns”GraphicsOverlayRef
Section titled “GraphicsOverlayRef”GraphicsOverlayRef: () =>
GraphicsOverlayRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:445
Returns
Section titled “Returns”IntegratedMeshLayerRef
Section titled “IntegratedMeshLayerRef”IntegratedMeshLayerRef: (
props) =>LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:433
Parameters
Section titled “Parameters”Returns
Section titled “Returns”KmlLayerRef
Section titled “KmlLayerRef”KmlLayerRef: (
props) =>KmlLayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:441
Parameters
Section titled “Parameters”Returns
Section titled “Returns”LineOfSightRef
Section titled “LineOfSightRef”LineOfSightRef: (
props) =>LineOfSightRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:451
Parameters
Section titled “Parameters”Pick<LineOfSightProps, "observer" | "target">
Returns
Section titled “Returns”MapImageLayerRef
Section titled “MapImageLayerRef”MapImageLayerRef: (
props) =>LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:430
Parameters
Section titled “Parameters”Returns
Section titled “Returns”MapRef
Section titled “MapRef”MapRef: (
props?) =>MapRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:426
Parameters
Section titled “Parameters”props?
Section titled “props?”Returns
Section titled “Returns”Ogc3DTilesLayerRef
Section titled “Ogc3DTilesLayerRef”Ogc3DTilesLayerRef: (
props) =>LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:435
Parameters
Section titled “Parameters”Returns
Section titled “Returns”OgcFeatureLayerRef
Section titled “OgcFeatureLayerRef”OgcFeatureLayerRef: (
props) =>LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:443
Parameters
Section titled “Parameters”Returns
Section titled “Returns”OpenStreetMapLayerRef
Section titled “OpenStreetMapLayerRef”OpenStreetMapLayerRef: () =>
LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:437
Returns
Section titled “Returns”PointCloudLayerRef
Section titled “PointCloudLayerRef”PointCloudLayerRef: (
props) =>PointCloudLayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:434
Parameters
Section titled “Parameters”Returns
Section titled “Returns”RasterLayerRef
Section titled “RasterLayerRef”RasterLayerRef: (
props) =>RasterLayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:440
Parameters
Section titled “Parameters”Returns
Section titled “Returns”SceneLayerRef
Section titled “SceneLayerRef”SceneLayerRef: (
props) =>LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:431
Parameters
Section titled “Parameters”Returns
Section titled “Returns”SceneRef
Section titled “SceneRef”SceneRef: (
props?) =>SceneRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:427
Parameters
Section titled “Parameters”props?
Section titled “props?”Returns
Section titled “Returns”TiledLayerRef
Section titled “TiledLayerRef”TiledLayerRef: (
props) =>LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:429
Parameters
Section titled “Parameters”Returns
Section titled “Returns”VectorTiledLayerRef
Section titled “VectorTiledLayerRef”VectorTiledLayerRef: (
props) =>LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:432
Parameters
Section titled “Parameters”Returns
Section titled “Returns”ViewshedRef
Section titled “ViewshedRef”ViewshedRef: (
props) =>ViewshedRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:449
Parameters
Section titled “Parameters”Returns
Section titled “Returns”WebTiledLayerRef
Section titled “WebTiledLayerRef”WebTiledLayerRef: (
props) =>LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:436
Parameters
Section titled “Parameters”Returns
Section titled “Returns”WfsLayerRef
Section titled “WfsLayerRef”WfsLayerRef: (
props) =>LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:442
Parameters
Section titled “Parameters”Returns
Section titled “Returns”WmsLayerRef
Section titled “WmsLayerRef”WmsLayerRef: (
props) =>LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:438
Parameters
Section titled “Parameters”Returns
Section titled “Returns”WmtsLayerRef
Section titled “WmtsLayerRef”WmtsLayerRef: (
props) =>LayerRef
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:439
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Methods
Section titled “Methods”addListener()
Section titled “addListener()”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.
Type Parameters
Section titled “Type Parameters”EventName
Section titled “EventName”EventName extends never
Parameters
Section titled “Parameters”eventName
Section titled “eventName”EventName
listener
Section titled “listener”Record<never, never>[EventName]
Returns
Section titled “Returns”EventSubscription
Inherited from
Section titled “Inherited from”NativeModule.addListener
emit()
Section titled “emit()”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.
Type Parameters
Section titled “Type Parameters”EventName
Section titled “EventName”EventName extends never
Parameters
Section titled “Parameters”eventName
Section titled “eventName”EventName
…Parameters<Record<never, never>[EventName]>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”NativeModule.emit
listenerCount()
Section titled “listenerCount()”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.
Type Parameters
Section titled “Type Parameters”EventName
Section titled “EventName”EventName extends never
Parameters
Section titled “Parameters”eventName
Section titled “eventName”EventName
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”NativeModule.listenerCount
oauthComplete()
Section titled “oauthComplete()”oauthComplete(
redirectUrl):Promise<void>
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:422
Android OAuth step 2: completes the flow with the browser redirect URL.
Parameters
Section titled “Parameters”redirectUrl
Section titled “redirectUrl”string
Returns
Section titled “Returns”Promise<void>
oauthStart()
Section titled “oauthStart()”oauthStart(
portalUrl,clientId,redirectUrl):Promise<string>
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:420
Android OAuth step 1: starts the flow and returns the authorize URL to open in a browser.
Parameters
Section titled “Parameters”portalUrl
Section titled “portalUrl”string
clientId
Section titled “clientId”string
redirectUrl
Section titled “redirectUrl”string
Returns
Section titled “Returns”Promise<string>
removeAllListeners()
Section titled “removeAllListeners()”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.
Parameters
Section titled “Parameters”eventName
Section titled “eventName”never
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”NativeModule.removeAllListeners
removeListener()
Section titled “removeListener()”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.
Type Parameters
Section titled “Type Parameters”EventName
Section titled “EventName”EventName extends never
Parameters
Section titled “Parameters”eventName
Section titled “eventName”EventName
listener
Section titled “listener”Record<never, never>[EventName]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”NativeModule.removeListener
setAllowUntrustedHosts()
Section titled “setAllowUntrustedHosts()”setAllowUntrustedHosts(
allow):void
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:414
Installs (true) or removes (false) a network-layer handler that trusts every TLS
server-trust challenge, including self-signed certificates.
Dev/on-prem only — disables TLS validation; never call with true in production.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
setApiKey()
Section titled “setApiKey()”setApiKey(
apiKey):void
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:395
Sets the ArcGIS API key (access token) used to authenticate with ArcGIS services.
Parameters
Section titled “Parameters”apiKey
Section titled “apiKey”string
Returns
Section titled “Returns”void
setAppCredential()
Section titled “setAppCredential()”setAppCredential(
portalUrl,clientId,clientSecret):Promise<void>
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:424
App authentication (client id + secret, no user login) — caches an app token credential.
Parameters
Section titled “Parameters”portalUrl
Section titled “portalUrl”string
clientId
Section titled “clientId”string
clientSecret
Section titled “clientSecret”string
Returns
Section titled “Returns”Promise<void>
setLicense()
Section titled “setLicense()”setLicense(
licenseKey):string
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:401
Applies a deployment license string, removing the “Licensed for Developer Use Only” watermark.
Returns the resulting license status ("valid", "invalid", "expired" or "loginRequired").
Separate from setApiKey: the key authenticates services, the license unlocks deployment.
Parameters
Section titled “Parameters”licenseKey
Section titled “licenseKey”string
Returns
Section titled “Returns”string
setTokenCredential()
Section titled “setTokenCredential()”setTokenCredential(
username,password,tokenExpirationMinutes):void
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:408
Stores a login used to authenticate token-secured services (e.g. a utility-network feature
service). The challenge handler mints a TokenCredential for the exact resource the SDK
challenges for — no service URL or up-front timing needed.
tokenExpirationMinutes sets the token lifetime; pass null to use the server’s default.
Parameters
Section titled “Parameters”username
Section titled “username”string
password
Section titled “password”string
tokenExpirationMinutes
Section titled “tokenExpirationMinutes”number | null
Returns
Section titled “Returns”void
signInWithOAuth()
Section titled “signInWithOAuth()”signInWithOAuth(
portalUrl,clientId,redirectUrl):Promise<void>
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:418
iOS-only OAuth sign-in: the SDK presents the auth browser, then caches the credential.
Parameters
Section titled “Parameters”portalUrl
Section titled “portalUrl”string
clientId
Section titled “clientId”string
redirectUrl
Section titled “redirectUrl”string
Returns
Section titled “Returns”Promise<void>
signOut()
Section titled “signOut()”signOut():
Promise<void>
Defined in: packages/expo-arcgis/src/ExpoArcgisModule.ts:416
Clears the stored login and all cached credentials (token + OAuth).
Returns
Section titled “Returns”Promise<void>
startObserving()?
Section titled “startObserving()?”
optionalstartObserving<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.
Type Parameters
Section titled “Type Parameters”EventName
Section titled “EventName”EventName extends never
Parameters
Section titled “Parameters”eventName
Section titled “eventName”EventName
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”NativeModule.startObserving
stopObserving()?
Section titled “stopObserving()?”
optionalstopObserving<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.
Type Parameters
Section titled “Type Parameters”EventName
Section titled “EventName”EventName extends never
Parameters
Section titled “Parameters”eventName
Section titled “eventName”EventName
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”NativeModule.stopObserving