Type Alias: MapSystemSharedFlightPlansOptions
MapSystemSharedFlightPlansOptions =
object
Defined in: src/sdk/components/mapsystem/MapSystemBuilder.tsx:183
Configuration options for displaying flight plans in a shared layer.
Properties
enableTextCulling?
optionalenableTextCulling:boolean
Defined in: src/sdk/components/mapsystem/MapSystemBuilder.tsx:211
Whether to enable text culling on the text manager that is added to the map to display flight plan waypoint
labels. Defaults to false.
getWaypointRenderToContext()?
optionalgetWaypointRenderToContext: <Modules,Layers,Controllers,Context>(context,planIndex,renderRole) =>CanvasRenderingContext2D|null
Defined in: src/sdk/components/mapsystem/MapSystemBuilder.tsx:196
A function that gets the canvas 2D rendering context to use to render flight plan waypoints for a given flight
plan and render role. This function is called after all map layers have been attached. If not defined, then a
MapSyncedCanvasLayer will be added to the map and its canvas context will be used to render all flight
plan waypoints. This layer will be added under the MapSystemKeys.FlightPlanWaypoints key and placed just above
the layer that displays the flight paths of the flight plans.
Type Parameters
| Type Parameter | Default type |
|---|---|
Modules extends ModuleRecord | EmptyRecord |
Layers extends LayerRecord | EmptyRecord |
Controllers extends ControllerRecord | EmptyRecord |
Context extends ContextRecord | EmptyRecord |
Parameters
| Parameter | Type | Description |
|---|---|---|
context | MapSystemContext<Modules, Layers, Controllers, Context> | The map context. |
planIndex | number | The index of the flight plan for which to get the canvas context. |
renderRole | number | The render role for which to get the canvas context. |
Returns
CanvasRenderingContext2D | null
The canvas 2D rendering context to use to render flight plan waypoints for the specified flight plan and
render role, or null if flight plan waypoints should not be rendered.
waypointLayerCssClass?
optionalwaypointLayerCssClass:string|SubscribableSet<string>
Defined in: src/sdk/components/mapsystem/MapSystemBuilder.tsx:217
CSS class(es) to apply to the canvas layer added to the map to display flight plan waypoints. Ignored if
getWaypointRenderToContext is defined.