Class: WeatherRadar

Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:116

A Garmin weather radar display.

Extends

• DisplayComponent<WeatherRadarProps>

Constructors

Constructor

new WeatherRadar(props): WeatherRadar

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	WeatherRadarProps	The propertis of the component.

Returns

WeatherRadar

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

props

props: WeatherRadarProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:799

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

Parameter	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

DisplayComponent.getContext

---

onAfterRender()

onAfterRender(): void

Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:273

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

render()

render(): VNode

Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:742

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

sleep()

sleep(): void

Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:370

Puts this weather radar to sleep. Once asleep, this radar will not be able to update until it is awakened.

Returns

void

Throws

Error if this weather radar is dead.

---

update()

update(): void

Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:392

Updates this weather radar.

Returns

void

Throws

Error if this weather radar is dead.

---

wake()

wake(): void

Defined in: src/garminsdk/components/weatherradar/WeatherRadar.tsx:348

Wakes this weather radar. Once awake, this radar will be able to update.

Returns

void

Throws

Error if this weather radar is dead.