Skip to main content

Interface: MapRangeRingLayerProps

Component props for MapRangeRingLayer.

Hierarchy​

Properties​

children​

• Optional children: DisplayChildren[]

The children of the display component.

Inherited from​

MapLayerProps.children

Defined in​

src/sdk/components/FSComponent.ts:122

class​

• Optional class: string | SubscribableSet<string>

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

Inherited from​

MapLayerProps.class

Defined in​

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

labelRadial​

• Optional labelRadial: number

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.

Defined in​

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

mapProjection​

• mapProjection: MapProjection

A map projection model.

Inherited from​

MapLayerProps.mapProjection

Defined in​

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

model​

• model: MapModel<MapRangeRingLayerModules>

A map model.

Inherited from​

MapLayerProps.model

Defined in​

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

outlineDash​

• Optional outlineDash: readonly number[]

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

Defined in​

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

outlineStyle​

• Optional outlineStyle: string | CanvasPattern | CanvasGradient

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

Defined in​

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

outlineWidth​

• Optional outlineWidth: number

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

Defined in​

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

ref​

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from​

MapLayerProps.ref

Defined in​

src/sdk/components/FSComponent.ts:125

renderLabel​

• Optional renderLabel: MapRangeRingLabelRenderer

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

Defined in​

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

showLabel​

• showLabel: boolean

Whether to show the range label.

Defined in​

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

strokeDash​

• Optional strokeDash: readonly number[]

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

Defined in​

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

strokeStyle​

• Optional strokeStyle: string | CanvasPattern | CanvasGradient

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

Defined in​

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

strokeWidth​

• Optional strokeWidth: number

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

Defined in​

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

updateFreq​

• Optional updateFreq: Subscribable<number>

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

Defined in​

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