Interface: MapOwnAirplaneWithGhostIconLayerProps<M>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:29

Props for MapOwnAirplaneWithGhostIconLayer

Extends

• MapOwnAirplaneLayerProps<M>

Type Parameters

Type Parameter
M extends MapOwnAirplaneLayerModules

Properties

children?

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:125

The children of the display component.

Inherited from

MapOwnAirplaneLayerProps.children

---

class?

optional class: string | SubscribableSet<string>

Defined in: src/sdk/components/map/MapLayer.ts:25

The CSS class(es) to apply to the root of this layer.

Inherited from

MapOwnAirplaneLayerProps.class

---

enableGhostIcon?

optional enableGhostIcon: Subscribable<boolean>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:35

Whether the ghost icon is enabled. The ghost icon appears when the main airplane icon is out of bounds and is located where a great circle path originating from the map center and ending at the airplane's position intersects one of the map edges. Its rotation mode is controlled by ghostIconBearingReferenceMode.

---

ghostIconAnchor?

optional ghostIconAnchor: Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:54

The point on the ghost icon which is anchored to the edge of the screen, expressed relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right. If undefined, iconAnchor will be used.

---

ghostIconBearingReferenceMode?

optional ghostIconBearingReferenceMode: GhostIconRotationMode

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:38

The rotation mode of the ghost icon. Defaults to GhostIconRotationMode.BearingFromEdge.

---

ghostIconClamp?

optional ghostIconClamp: boolean

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:41

Whether to clamp the ghost icon so that it's axis-aligned bounding box (AABB) is always within the map viewport.

---

ghostIconImageFilePath?

optional ghostIconImageFilePath: string | Subscribable<string>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:45

The path to the ghost icon's image file. If undefined, imageFilePath will be used.

---

ghostIconSize?

optional ghostIconSize: number | Subscribable<number>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:48

The size of the ghost airplane icon, in pixels. If undefined, iconSize will be used.

---

iconAnchor

iconAnchor: Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:42

The point on the icon which is anchored to the airplane's position, expressed relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.

Inherited from

MapOwnAirplaneLayerProps.iconAnchor

---

iconSize

iconSize: number | Subscribable<number>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:36

The size of the airplane icon, in pixels.

Inherited from

MapOwnAirplaneLayerProps.iconSize

---

imageFilePath

imageFilePath: string | Subscribable<string>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:33

The path to the icon's image file.

Inherited from

MapOwnAirplaneLayerProps.imageFilePath

---

mapProjection

mapProjection: MapProjection

Defined in: src/sdk/components/map/MapLayer.ts:15

A map projection model.

Inherited from

MapOwnAirplaneLayerProps.mapProjection

---

model

model: MapModel<M>

Defined in: src/sdk/components/map/MapLayer.ts:12

A map model.

Inherited from

MapOwnAirplaneLayerProps.model

---

ref?

optional ref: NodeReference<any>

Defined in: src/sdk/components/FSComponent.ts:128

A reference to the display component.

Inherited from

MapOwnAirplaneLayerProps.ref

---

updateFreq?

optional updateFreq: Subscribable<number>

Defined in: src/sdk/components/map/MapLayer.ts:22

A subscribable which provides the maximum update frequency of the layer, in hertz. Note that the actual update frequency will not exceed the update frequency of the layer's parent map. If not defined, the frequency will default to that of the layer's parent map.

Inherited from

MapOwnAirplaneLayerProps.updateFreq