Skip to content
GuidesToolkitAPI

KmlLayerRef

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

Reference to a native KmlLayer — a LayerRef plus getNodes and tour controls (mirrors KmlLayerHandle).

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


applyProps(changed): void

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

Record<string, unknown>

void

LayerRef.applyProps


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


getNodes(): Promise<KmlNodeInfo[]>

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

Promise<KmlNodeInfo[]>


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


pauseTour(): void

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

void


playTour(): void

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

void


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


resetTour(): void

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

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