Interface: MapLineLayerProps
Component props for MapLineLayer.
Hierarchy
MapLayerProps<any>↳
MapLineLayerProps
Properties
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
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
Defined in
src/sdk/components/map/MapLayer.ts:25
end
• end: Subscribable<null | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | LatLonInterface>
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.
Defined in
src/sdk/components/map/layers/MapLineLayer.tsx:22
mapProjection
• mapProjection: MapProjection
A map projection model.
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:15
model
• model: MapModel<any>
A map model.
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:12
outlineDash
• Optional outlineDash: readonly number[]
The dash array of the line outline. Defaults to [].
Defined in
src/sdk/components/map/layers/MapLineLayer.tsx:40
outlineStyle
• Optional outlineStyle: string | CanvasPattern | CanvasGradient
The style of the line outline. Defaults to 'black'.
Defined in
src/sdk/components/map/layers/MapLineLayer.tsx:37
outlineWidth
• Optional outlineWidth: number
The width of the line outline, in pixels. Defaults to 0 pixels.
Defined in
src/sdk/components/map/layers/MapLineLayer.tsx:34
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
start
• start: Subscribable<null | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | LatLonInterface>
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.
Defined in
src/sdk/components/map/layers/MapLineLayer.tsx:16
strokeDash
• Optional strokeDash: readonly number[]
The dash array of the line stroke. Defaults to [].
Defined in
src/sdk/components/map/layers/MapLineLayer.tsx:31
strokeStyle
• Optional strokeStyle: string | CanvasPattern | CanvasGradient
The style of the line stroke. Defaults to 'white'.
Defined in
src/sdk/components/map/layers/MapLineLayer.tsx:28
strokeWidth
• Optional strokeWidth: number
The width of the line stroke, in pixels. Defaults to 2 pixels.
Defined in
src/sdk/components/map/layers/MapLineLayer.tsx:25
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
Defined in
src/sdk/components/map/MapLayer.ts:22