Interface: MapLineLayerProps
Defined in: src/sdk/components/map/layers/MapLineLayer.tsx:11
Component props for MapLineLayer.
Extends
MapLayerProps
<any
>
Properties
children?
optional
children:DisplayChildren
[]
Defined in: src/sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
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
end
end:
Subscribable
<null
|Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>> |LatLonInterface
>
Defined in: src/sdk/components/map/layers/MapLineLayer.tsx:22
A subscribable which provides the end point of the line, as a set of lat/lon coordinates or a 2D vector in
projected coordinates. If the end point is null
, a line will not be drawn.
mapProjection
mapProjection:
MapProjection
Defined in: src/sdk/components/map/MapLayer.ts:15
A map projection model.
Inherited from
model
model:
MapModel
<any
>
Defined in: src/sdk/components/map/MapLayer.ts:12
A map model.
Inherited from
outlineDash?
optional
outlineDash: readonlynumber
[]
Defined in: src/sdk/components/map/layers/MapLineLayer.tsx:40
The dash array of the line outline. Defaults to []
.
outlineStyle?
optional
outlineStyle:string
|CanvasPattern
|CanvasGradient
Defined in: src/sdk/components/map/layers/MapLineLayer.tsx:37
The style of the line outline. Defaults to 'black'
.
outlineWidth?
optional
outlineWidth:number
Defined in: src/sdk/components/map/layers/MapLineLayer.tsx:34
The width of the line outline, in pixels. Defaults to 0 pixels.
ref?
optional
ref:NodeReference
<any
>
Defined in: src/sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
start
start:
Subscribable
<null
|Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>> |LatLonInterface
>
Defined in: src/sdk/components/map/layers/MapLineLayer.tsx:16
A subscribable which provides the start point of the line, as a set of lat/lon coordinates or a 2D vector in
projected coordinates. If the start point is null
, a line will not be drawn.
strokeDash?
optional
strokeDash: readonlynumber
[]
Defined in: src/sdk/components/map/layers/MapLineLayer.tsx:31
The dash array of the line stroke. Defaults to []
.
strokeStyle?
optional
strokeStyle:string
|CanvasPattern
|CanvasGradient
Defined in: src/sdk/components/map/layers/MapLineLayer.tsx:28
The style of the line stroke. Defaults to 'white'
.
strokeWidth?
optional
strokeWidth:number
Defined in: src/sdk/components/map/layers/MapLineLayer.tsx:25
The width of the line stroke, 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.