Class: TrafficMapRangeLayer
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:117
A map layer which displays inner and outer range rings for traffic maps.
Extends
MapLayer
<TrafficMapRangeLayerProps
>
Constructors
Constructor
new TrafficMapRangeLayer(
props
):TrafficMapRangeLayer
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | TrafficMapRangeLayerProps | The propertis of the component. |
Returns
TrafficMapRangeLayer
Inherited from
MapLayer<TrafficMapRangeLayerProps>.constructor
Properties
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
MapLayer.context
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: src/sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
MapLayer.contextType
props
props:
TrafficMapRangeLayerProps
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
MapLayer.props
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:405
Returns
void
Inherit Doc
Overrides
MapLayer.destroy
getContext()
protected
getContext(context
):never
Defined in: src/sdk/components/FSComponent.ts:106
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
MapLayer.getContext
isVisible()
isVisible():
boolean
Defined in: src/sdk/components/map/MapLayer.ts:38
Checks whether this layer is visible.
Returns
boolean
whether this layer is visible.
Inherited from
MapLayer.isVisible
onAfterRender()
onAfterRender(
node
):void
Defined in: src/sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
MapLayer.onAfterRender
onAttached()
onAttached():
void
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:175
Returns
void
Inherit Doc
Overrides
MapLayer.onAttached
onBeforeRender()
onBeforeRender():
void
Defined in: src/sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
MapLayer.onBeforeRender
onDetached()
onDetached():
void
Defined in: src/sdk/components/map/MapLayer.ts:108
This method is called when this layer is detached from its parent map component.
Returns
void
Inherited from
MapLayer.onDetached
onMapProjectionChanged()
onMapProjectionChanged(
mapProjection
,changeFlags
):void
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:243
Parameters
Parameter | Type |
---|---|
mapProjection | MapProjection |
changeFlags | number |
Returns
void
Inherit Doc
Overrides
MapLayer.onMapProjectionChanged
onSleep()
onSleep():
void
Defined in: src/sdk/components/map/MapLayer.ts:81
This method is called when this layer's parent map is put to sleep.
Returns
void
Inherited from
MapLayer.onSleep
onUpdated()
onUpdated(
time
,elapsed
):void
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:250
Parameters
Parameter | Type |
---|---|
time | number |
elapsed | number |
Returns
void
Inherit Doc
Overrides
MapLayer.onUpdated
onVisibilityChanged()
onVisibilityChanged(
isVisible
):void
Defined in: src/sdk/components/map/MapLayer.ts:60
This method is called when this layer's visibility changes.
Parameters
Parameter | Type | Description |
---|---|---|
isVisible | boolean | Whether the layer is now visible. |
Returns
void
Inherited from
MapLayer.onVisibilityChanged
onWake()
onWake():
void
Defined in: src/sdk/components/map/MapLayer.ts:74
This method is called when this layer's parent map is woken.
Returns
void
Inherited from
MapLayer.onWake
render()
render():
VNode
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:374
Returns
VNode
Inherit Doc
Overrides
MapLayer.render
setVisible()
setVisible(
val
):void
Defined in: src/sdk/components/map/MapLayer.ts:46
Sets this layer's visibility.
Parameters
Parameter | Type | Description |
---|---|---|
val | boolean | Whether this layer should be visible. |
Returns
void
Inherited from
MapLayer.setVisible