Skip to main content

Interface: MapRangeRingLayerProps

Defined in: src/garminsdk/components/map/layers/MapRangeRingLayer.tsx:33

Component props for MapRangeRingLayer.

Extends​

Properties​

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

MapLayerProps.children

class?​

optional class: string | SubscribableSet<string>

Defined in: src/sdk/components/map/MapLayer.ts:25

The CSS class(es) to apply to the root of this layer.

Inherited from​

MapLayerProps.class

labelRadial?​

optional labelRadial: number

Defined in: src/garminsdk/components/map/layers/MapRangeRingLayer.tsx:41

The radial on which the range label is positioned, in degrees. A value of zero is in the positive x direction. Defaults to 225 degrees.

mapProjection​

mapProjection: MapProjection

Defined in: src/sdk/components/map/MapLayer.ts:15

A map projection model.

Inherited from​

MapLayerProps.mapProjection

model​

model: MapModel<MapRangeRingLayerModules>

Defined in: src/sdk/components/map/MapLayer.ts:12

A map model.

Inherited from​

MapLayerProps.model

outlineDash?​

optional outlineDash: readonly number[]

Defined in: src/garminsdk/components/map/layers/MapRangeRingLayer.tsx:65

The outline dash of the range ring. Defaults to no dash.

outlineStyle?​

optional outlineStyle: string | CanvasPattern | CanvasGradient

Defined in: src/garminsdk/components/map/layers/MapRangeRingLayer.tsx:62

The outline style of the range ring. Defaults to 'black'.

outlineWidth?​

optional outlineWidth: number

Defined in: src/garminsdk/components/map/layers/MapRangeRingLayer.tsx:59

The outline width of the range ring, in pixels. Defaults to 0.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

MapLayerProps.ref

renderLabel?​

optional renderLabel: MapRangeRingLabelRenderer

Defined in: src/garminsdk/components/map/layers/MapRangeRingLayer.tsx:47

A function which renders labels for the rings. If not defined, a default label of type MapRangeDisplay will be rendered.

showLabel​

showLabel: boolean

Defined in: src/garminsdk/components/map/layers/MapRangeRingLayer.tsx:35

Whether to show the range label.

strokeDash?​

optional strokeDash: readonly number[]

Defined in: src/garminsdk/components/map/layers/MapRangeRingLayer.tsx:56

The stroke dash of the range ring. Defaults to no dash.

strokeStyle?​

optional strokeStyle: string | CanvasPattern | CanvasGradient

Defined in: src/garminsdk/components/map/layers/MapRangeRingLayer.tsx:53

The stroke style of the range ring. Defaults to 'white'.

strokeWidth?​

optional strokeWidth: number

Defined in: src/garminsdk/components/map/layers/MapRangeRingLayer.tsx:50

The stroke width of the range ring, in pixels. Defaults to 2 pixels.

updateFreq?​

optional updateFreq: Subscribable<number>

Defined in: src/sdk/components/map/MapLayer.ts:22

A subscribable which provides the maximum update frequency of the layer, in hertz. Note that the actual update frequency will not exceed the update frequency of the layer's parent map. If not defined, the frequency will default to that of the layer's parent map.

Inherited from​

MapLayerProps.updateFreq