Skip to main content

Type Alias: GeometryLoaderFn()

GeometryLoaderFn: (geometryId, options?) => object

Any geometryLoader function should implement a loading given the geometryId and returns a mandatory promise which will resolve to the loaded geometry object. Additional cancelFn and decache can be implemented.

Parameters​

• geometryId: string

• options?: Record<string, unknown>

Returns​

object

cancelFn()?​

optional cancelFn: () => void | undefined

cancel function

Returns​

void | undefined

decache()?​

optional decache: () => void | undefined

decache function

Returns​

void | undefined

promise​

promise: Promise<IGeometry>

promise that resolves to the geometry object

Defined in​

packages/core/src/types/GeometryLoaderFn.ts:8