Class: MapWindVectorLayer

A map layer which displays a readout of wind speed and an arrow depicting wind direction.

Hierarchy

• MapLayer<MapWindVectorLayerProps>

  ↳ MapWindVectorLayer

Constructors

constructor

• new MapWindVectorLayer(props): MapWindVectorLayer

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	MapWindVectorLayerProps	The propertis of the component.

Returns

MapWindVectorLayer

Inherited from

MapLayer<MapWindVectorLayerProps>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

MapLayer.context

Defined in

src/sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

MapLayer.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

props

• props: MapWindVectorLayerProps & ComponentProps

The properties of the component.

Inherited from

MapLayer.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

destroy

▸ destroy(): void

Returns

void

Inherit Doc

Overrides

MapLayer.destroy

Defined in

src/garminsdk/components/map/layers/MapWindVectorLayer.tsx:178

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	Type	Description
context	never	The context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

MapLayer.getContext

Defined in

src/sdk/components/FSComponent.ts:106

---

isVisible

▸ isVisible(): boolean

Checks whether this layer is visible.

Returns

boolean

whether this layer is visible.

Inherited from

MapLayer.isVisible

Defined in

src/sdk/components/map/MapLayer.ts:38

---

onAfterRender

▸ onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

Name	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

MapLayer.onAfterRender

Defined in

src/sdk/components/FSComponent.ts:87

---

onAttached

▸ onAttached(): void

Returns

void

Inherit Doc

Overrides

MapLayer.onAttached

Defined in

src/garminsdk/components/map/layers/MapWindVectorLayer.tsx:64

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

MapLayer.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

onDetached

▸ onDetached(): void

This method is called when this layer is detached from its parent map component.

Returns

void

Inherited from

MapLayer.onDetached

Defined in

src/sdk/components/map/MapLayer.ts:108

---

onMapProjectionChanged

▸ onMapProjectionChanged(mapProjection, changeFlags): void

Parameters

Name	Type
mapProjection	MapProjection
changeFlags	number

Returns

void

Inherit Doc

Overrides

MapLayer.onMapProjectionChanged

Defined in

src/garminsdk/components/map/layers/MapWindVectorLayer.tsx:88

---

onSleep

▸ onSleep(): void

Returns

void

Inherit Doc

Overrides

MapLayer.onSleep

Defined in

src/garminsdk/components/map/layers/MapWindVectorLayer.tsx:100

---

onUpdated

▸ onUpdated(): void

Returns

void

Inherit Doc

Overrides

MapLayer.onUpdated

Defined in

src/garminsdk/components/map/layers/MapWindVectorLayer.tsx:127

---

onVisibilityChanged

▸ onVisibilityChanged(isVisible): void

Parameters

Name	Type
isVisible	boolean

Returns

void

Inherit Doc

Overrides

MapLayer.onVisibilityChanged

Defined in

src/garminsdk/components/map/layers/MapWindVectorLayer.tsx:58

---

onWake

▸ onWake(): void

Returns

void

Inherit Doc

Overrides

MapLayer.onWake

Defined in

src/garminsdk/components/map/layers/MapWindVectorLayer.tsx:93

---

render

▸ render(): VNode

Returns

VNode

Inherit Doc

Overrides

MapLayer.render

Defined in

src/garminsdk/components/map/layers/MapWindVectorLayer.tsx:147

---

setVisible

▸ setVisible(val): void

Sets this layer's visibility.

Parameters

Name	Type	Description
val	boolean	Whether this layer should be visible.

Returns

void

Inherited from

MapLayer.setVisible

Defined in

src/sdk/components/map/MapLayer.ts:46