Skip to main content

Interface: TrafficMapRangeLayerProps

Component props for TrafficMapRangeLayer.

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

innerLabelRadial​

• Optional innerLabelRadial: null | number

The radial on which the inner range label is positioned, in degrees. A value of 0 degrees is in the direction of the positive x axis. If null, the inner range label will not be displayed. Defaults to null.

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:105

innerMajorTickColor​

• Optional innerMajorTickColor: string

The color of the major inner ring ticks. Defaults to the value of tickColor.

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:84

innerMajorTickSize​

• Optional innerMajorTickSize: number

The size of the major inner ring ticks, in pixels. Defaults to 10 pixels.

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:87

innerMinorTickColor​

• Optional innerMinorTickColor: string

The color of the minor inner ring ticks. Defaults to the value of tickColor.

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:90

innerMinorTickSize​

• Optional innerMinorTickSize: number

The size of the minor inner ring ticks, in pixels. Defaults to 5 pixels.

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:93

innerOutlineDash​

• Optional innerOutlineDash: readonly number[]

The outline dash of the inner range ring. Defaults to [].

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:66

innerOutlineStyle​

• Optional innerOutlineStyle: string | CanvasPattern | CanvasGradient

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

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:63

innerOutlineWidth​

• Optional innerOutlineWidth: number

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

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:60

innerStrokeDash​

• Optional innerStrokeDash: readonly number[]

The stroke dash of the inner range ring. Defaults to [4, 4].

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:57

innerStrokeStyle​

• Optional innerStrokeStyle: string | CanvasPattern | CanvasGradient

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

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:54

innerStrokeWidth​

• Optional innerStrokeWidth: number

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

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:51

mapProjection​

• mapProjection: MapProjection

A map projection model.

Inherited from​

MapLayerProps.mapProjection

Defined in​

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

model​

• model: MapModel<TrafficMapRangeLayerModules>

A map model.

Inherited from​

MapLayerProps.model

Defined in​

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

outerLabelRadial​

• Optional outerLabelRadial: null | number

The radial on which the outer range label is positioned, in degrees. A value of 0 degrees is in the direction of the positive x axis. If null, the outer range label will not be displayed. Defaults to null.

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:99

outerMajorTickColor​

• Optional outerMajorTickColor: string

The color of the major outer ring ticks. Defaults to the value of tickColor.

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:72

outerMajorTickSize​

• Optional outerMajorTickSize: number

The size of the major outer ring ticks, in pixels. Defaults to 10 pixels.

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:75

outerMinorTickColor​

• Optional outerMinorTickColor: string

The color of the minor outer ring ticks. Defaults to the value of tickColor.

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:78

outerMinorTickSize​

• Optional outerMinorTickSize: number

The size of the minor outer ring ticks, in pixels. Defaults to 5 pixels.

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:81

outerOutlineDash​

• Optional outerOutlineDash: readonly number[]

The outline dash of the outer range ring. Defaults to [].

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:48

outerOutlineStyle​

• Optional outerOutlineStyle: string | CanvasPattern | CanvasGradient

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

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:45

outerOutlineWidth​

• Optional outerOutlineWidth: number

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

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:42

outerStrokeDash​

• Optional outerStrokeDash: readonly number[]

The stroke dash of the outer range ring. Defaults to [4, 4].

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:39

outerStrokeStyle​

• Optional outerStrokeStyle: string | CanvasPattern | CanvasGradient

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

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:36

outerStrokeWidth​

• Optional outerStrokeWidth: number

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

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:33

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: TrafficMapRangeLabelRenderer

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/TrafficMapRangeLayer.tsx:111

tickColor​

• Optional tickColor: string

The color of the ring ticks. Defaults to 'white'.

Defined in​

src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:69

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