Class: WeatherRadar
A Garmin weather radar display.
Hierarchy
DisplayComponent<WeatherRadarProps>↳
WeatherRadar
Constructors
constructor
• new WeatherRadar(props): WeatherRadar
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | WeatherRadarProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<WeatherRadarProps>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.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
DisplayComponent.contextType
Defined in
src/sdk/components/FSComponent.ts:67
props
• props: WeatherRadarProps & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/garminsdk/components/weatherradar/WeatherRadar.tsx:799
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
DisplayComponent.getContext
Defined in
src/sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
src/garminsdk/components/weatherradar/WeatherRadar.tsx:273
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/garminsdk/components/weatherradar/WeatherRadar.tsx:742
sleep
▸ sleep(): void
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.
Defined in
src/garminsdk/components/weatherradar/WeatherRadar.tsx:370
update
▸ update(): void
Updates this weather radar.
Returns
void
Throws
Error if this weather radar is dead.
Defined in
src/garminsdk/components/weatherradar/WeatherRadar.tsx:392
wake
▸ wake(): void
Wakes this weather radar. Once awake, this radar will be able to update.
Returns
void
Throws
Error if this weather radar is dead.
Defined in
src/garminsdk/components/weatherradar/WeatherRadar.tsx:348