Class: MapRangeCompassLayer
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:158
A map layer which draws a range compass in front of the map target.
Extends
MapLayer
<MapRangeCompassLayerProps
>
Constructors
Constructor
new MapRangeCompassLayer(
props
):MapRangeCompassLayer
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | MapRangeCompassLayerProps | The propertis of the component. |
Returns
MapRangeCompassLayer
Inherited from
MapLayer<MapRangeCompassLayerProps>.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:
MapRangeCompassLayerProps
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
MapLayer.props
ARC_ANGULAR_WIDTH
readonly
static
ARC_ANGULAR_WIDTH:120
=120
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:160
The angular width of the compass arc, in degrees.
BEARING_TICK_MAJOR_INTERVAL
readonly
static
BEARING_TICK_MAJOR_INTERVAL:30
=30
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:163
The angular interval, in degrees, between major bearing ticks.
BEARING_TICK_MINOR_FACTOR
readonly
static
BEARING_TICK_MINOR_FACTOR:3
=3
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:166
The number of minor bearing ticks per major bearing tick.
RANGE_LABEL_RADIAL_ANGLE
readonly
static
RANGE_LABEL_RADIAL_ANGLE:-135
=-135
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:169
The radial on which the range label is positioned, in degrees.
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:738
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(
thisNode
):void
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:248
Parameters
Parameter | Type |
---|---|
thisNode | VNode |
Returns
void
Inherit Doc
Overrides
MapLayer.onAfterRender
onAttached()
onAttached():
void
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:274
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/MapRangeCompassLayer.tsx:312
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/MapRangeCompassLayer.tsx:332
Parameters
Parameter | Type |
---|---|
time | number |
elapsed | number |
Returns
void
Inherit Doc
Overrides
MapLayer.onUpdated
onVisibilityChanged()
onVisibilityChanged(
isVisible
):void
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:253
Parameters
Parameter | Type |
---|---|
isVisible | boolean |
Returns
void
Inherit Doc
Overrides
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/MapRangeCompassLayer.tsx:652
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