Interface: TrafficMapRangeLayerProps
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:31
Component props for TrafficMapRangeLayer.
Extends
MapLayerProps
<TrafficMapRangeLayerModules
>
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
innerLabelRadial?
optional
innerLabelRadial:null
|number
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:105
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
.
innerMajorTickColor?
optional
innerMajorTickColor:string
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:84
The color of the major inner ring ticks. Defaults to the value of tickColor
.
innerMajorTickSize?
optional
innerMajorTickSize:number
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:87
The size of the major inner ring ticks, in pixels. Defaults to 10 pixels.
innerMinorTickColor?
optional
innerMinorTickColor:string
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:90
The color of the minor inner ring ticks. Defaults to the value of tickColor
.
innerMinorTickSize?
optional
innerMinorTickSize:number
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:93
The size of the minor inner ring ticks, in pixels. Defaults to 5 pixels.
innerOutlineDash?
optional
innerOutlineDash: readonlynumber
[]
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:66
The outline dash of the inner range ring. Defaults to []
.
innerOutlineStyle?
optional
innerOutlineStyle:string
|CanvasPattern
|CanvasGradient
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:63
The outline style of the inner range ring. Defaults to 'black'
.
innerOutlineWidth?
optional
innerOutlineWidth:number
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:60
The outline width of the inner range ring, in pixels. Defaults to 0 pixels.
innerStrokeDash?
optional
innerStrokeDash: readonlynumber
[]
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:57
The stroke dash of the inner range ring. Defaults to [4, 4]
.
innerStrokeStyle?
optional
innerStrokeStyle:string
|CanvasPattern
|CanvasGradient
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:54
The stroke style of the inner range ring. Defaults to 'white'
.
innerStrokeWidth?
optional
innerStrokeWidth:number
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:51
The stroke width of the inner range ring, in pixels. Defaults to 2 pixels.
mapProjection
mapProjection:
MapProjection
Defined in: src/sdk/components/map/MapLayer.ts:15
A map projection model.
Inherited from
MapLayerProps.mapProjection
model
model:
MapModel
<TrafficMapRangeLayerModules
>
Defined in: src/sdk/components/map/MapLayer.ts:12
A map model.
Inherited from
MapLayerProps.model
outerLabelRadial?
optional
outerLabelRadial:null
|number
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:99
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
.
outerMajorTickColor?
optional
outerMajorTickColor:string
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:72
The color of the major outer ring ticks. Defaults to the value of tickColor
.
outerMajorTickSize?
optional
outerMajorTickSize:number
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:75
The size of the major outer ring ticks, in pixels. Defaults to 10 pixels.
outerMinorTickColor?
optional
outerMinorTickColor:string
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:78
The color of the minor outer ring ticks. Defaults to the value of tickColor
.
outerMinorTickSize?
optional
outerMinorTickSize:number
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:81
The size of the minor outer ring ticks, in pixels. Defaults to 5 pixels.
outerOutlineDash?
optional
outerOutlineDash: readonlynumber
[]
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:48
The outline dash of the outer range ring. Defaults to []
.
outerOutlineStyle?
optional
outerOutlineStyle:string
|CanvasPattern
|CanvasGradient
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:45
The outline style of the outer range ring. Defaults to 'black'
.
outerOutlineWidth?
optional
outerOutlineWidth:number
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:42
The outline width of the outer range ring, in pixels. Defaults to 0 pixels.
outerStrokeDash?
optional
outerStrokeDash: readonlynumber
[]
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:39
The stroke dash of the outer range ring. Defaults to [4, 4]
.
outerStrokeStyle?
optional
outerStrokeStyle:string
|CanvasPattern
|CanvasGradient
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:36
The stroke style of the outer range ring. Defaults to 'white'
.
outerStrokeWidth?
optional
outerStrokeWidth:number
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:33
The stroke width of the outer range ring, in pixels. Defaults to 2 pixels.
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:TrafficMapRangeLabelRenderer
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:111
A function which renders labels for the rings. If not defined, a default label of type MapRangeDisplay will be rendered.
tickColor?
optional
tickColor:string
Defined in: src/garminsdk/components/map/layers/TrafficMapRangeLayer.tsx:69
The color of the ring ticks. Defaults to 'white'
.
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