For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages are available by appending .md to any URL.
Class Actor
Implements
Index
Constructors
constructor
-
Parameters
- target: ActorTarget
The target
OptionalmapId: string | numberA unique identifier for the Map instance using this Actor.
Returns Actor
- target: ActorTarget
Properties
abortControllers
abortControllers: { [x: string | number]: AbortController }
globalScope
invoker
mapId
mapId: string | number | null
messageHandlers
messageHandlers: {
AT?: MessageHandler<abortTile>;
GCC?: MessageHandler<getClusterChildren>;
GCEZ?: MessageHandler<getClusterExpansionZoom>;
GCL?: MessageHandler<getClusterLeaves>;
GDA?: MessageHandler<getDashes>;
GG?: MessageHandler<getGlyphs>;
GI?: MessageHandler<getImages>;
GR?: MessageHandler<getResource>;
IS?: MessageHandler<importScript>;
LD?: MessageHandler<loadData>;
LDT?: MessageHandler<loadDEMTile>;
LT?: MessageHandler<loadTile>;
RDT?: MessageHandler<removeDEMTile>;
RM?: MessageHandler<removeMap>;
RMT?: MessageHandler<removeTile>;
RS?: MessageHandler<removeSource>;
RT?: MessageHandler<reloadTile>;
SI?: MessageHandler<setImages>;
SL?: MessageHandler<setLayers>;
SR?: MessageHandler<setReferrer>;
SRPS?: MessageHandler<syncRTLPluginState>;
UGS?: MessageHandler<updateGlobalState>;
UL?: MessageHandler<updateLayers>;
}
AT?: MessageHandler<abortTile>;
GCC?: MessageHandler<getClusterChildren>;
GCEZ?: MessageHandler<getClusterExpansionZoom>;
GCL?: MessageHandler<getClusterLeaves>;
GDA?: MessageHandler<getDashes>;
GG?: MessageHandler<getGlyphs>;
GI?: MessageHandler<getImages>;
GR?: MessageHandler<getResource>;
IS?: MessageHandler<importScript>;
LD?: MessageHandler<loadData>;
LDT?: MessageHandler<loadDEMTile>;
LT?: MessageHandler<loadTile>;
RDT?: MessageHandler<removeDEMTile>;
RM?: MessageHandler<removeMap>;
RMT?: MessageHandler<removeTile>;
RS?: MessageHandler<removeSource>;
RT?: MessageHandler<reloadTile>;
SI?: MessageHandler<setImages>;
SL?: MessageHandler<setLayers>;
SR?: MessageHandler<setReferrer>;
SRPS?: MessageHandler<syncRTLPluginState>;
UGS?: MessageHandler<updateGlobalState>;
UL?: MessageHandler<updateLayers>;
}
name
name: string
resolveRejects
subscription
target
taskQueue
taskQueue: string[]
tasks
Methods
completeTask
-
completeTask(
id: string,
err: Error,
data?:
| number
| void
| Feature<Geometry, GeoJsonProperties>[]
| DEMData
| WorkerTileResult
| GetImagesResponse
| GeoJSONWorkerSourceLoadDataResult
| GetGlyphsResponse
| PluginState
| GetResourceResponse<any>
| GetDashesResponse,
): voidParameters
- id: string
- err: Error
Optionaldata:
| number
| void
| Feature<Geometry, GeoJsonProperties>[]
| DEMData
| WorkerTileResult
| GetImagesResponse
| GeoJSONWorkerSourceLoadDataResult
| GetGlyphsResponse
| PluginState
| GetResourceResponse<any>
| GetDashesResponse
Returns void
process
-
Returns void
processTask
-
Parameters
- id: string
- task: MessageData
Returns Promise<void>
receive
-
Parameters
- message: { data: MessageData }
Returns void
registerMessageHandler
remove
-
Returns void
sendAsync
-
sendAsync<T extends MessageType>(
message: ActorMessage<T>,
abortController?: AbortController,
): Promise<RequestResponseMessageMap[T][1]>Sends a message from a main-thread map to a Worker or from a Worker back to a main-thread map instance.
Type Parameters
- T extends MessageType
Parameters
- message: ActorMessage<T>
the message to send
OptionalabortController: AbortControlleran optional AbortController to abort the request
Returns Promise<RequestResponseMessageMap[T][1]>
a promise that will be resolved with the response data
An implementation of the Actor design pattern that maintains the relationship between asynchronous tasks and the objects that spin them off - in this case, tasks like parsing parts of styles, owned by the styles