Class: MapLineLayer
A map layer that draws a line between two points. The line is drawn in projected coordinate space, so it will always be straight on the projected map.
Hierarchy
MapSyncedCanvasLayer<MapLineLayerProps>↳
MapLineLayer
Constructors
constructor
• new MapLineLayer(props): MapLineLayer
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | MapLineLayerProps | The propertis of the component. |
Returns
Inherited from
MapSyncedCanvasLayer.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:64
contextType
• Optional Readonly contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
MapSyncedCanvasLayer.contextType
Defined in
src/sdk/components/FSComponent.ts:67
isInit
• Protected isInit: boolean = false
Inherited from
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:78
props
• props: MapLineLayerProps & ComponentProps
The properties of the component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:61
Accessors
buffer
• get buffer(): C
Gets this layer's buffer canvas instance.
Returns
C
This layer's buffer canvas instance.
Throws
Error if this layer's buffer canvas instance has not been initialized.
Inherited from
MapSyncedCanvasLayer.buffer
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:98
display
• get display(): C
Gets this layer's display canvas instance.
Returns
C
This layer's display canvas instance.
Throws
Error if this layer's display canvas instance has not been initialized.
Inherited from
MapSyncedCanvasLayer.display
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:85
Methods
copyBufferToDisplay
▸ copyBufferToDisplay(): void
Copies the contents of the buffer to the display. Has no effect if this layer does not have a buffer.
Returns
void
Inherited from
MapSyncedCanvasLayer.copyBufferToDisplay
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:171
createCanvasInstance
▸ createCanvasInstance(canvas, context, isDisplayed): MapCanvasLayerCanvasInstance
Creates a canvas instance.
Parameters
| Name | Type | Description |
|---|---|---|
canvas | HTMLCanvasElement | The canvas element. |
context | CanvasRenderingContext2D | The canvas 2D rendering context. |
isDisplayed | boolean | Whether the canvas is displayed. |
Returns
a canvas instance.
Inherited from
MapSyncedCanvasLayer.createCanvasInstance
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:227
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Inherited from
Defined in
src/sdk/components/FSComponent.ts:98
getContext
▸ getContext(context): never
Gets a context data subscription from the context collection.
Parameters
| Name | Type | Description |
|---|---|---|
context | never | The context to get the subscription for. |
Returns
never
The requested context.
Throws
An error if no data for the specified context type could be found.
Inherited from
MapSyncedCanvasLayer.getContext
Defined in
src/sdk/components/FSComponent.ts:106
getHeight
▸ getHeight(): number
Gets the height of the canvas element, in pixels.
Returns
number
the height of the canvas element.
Inherited from
MapSyncedCanvasLayer.getHeight
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:134
getWidth
▸ getWidth(): number
Gets the width of the canvas element, in pixels.
Returns
number
the width of the canvas element.
Inherited from
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:126
isVisible
▸ isVisible(): boolean
Checks whether this layer is visible.
Returns
boolean
whether this layer is visible.
Inherited from
MapSyncedCanvasLayer.isVisible
Defined in
src/sdk/components/map/MapLayer.ts:38
onAfterRender
▸ onAfterRender(): void
A callback called after the component renders.
Returns
void
Inherited from
MapSyncedCanvasLayer.onAfterRender
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:182
onAttached
▸ onAttached(): void
This method is called when this layer is attached to its parent map component.
Returns
void
Overrides
MapSyncedCanvasLayer.onAttached
Defined in
src/sdk/components/map/layers/MapLineLayer.tsx:67
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
MapSyncedCanvasLayer.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
onDetached
▸ onDetached(): void
This method is called when this layer is detached from its parent map component.
Returns
void
Inherited from
MapSyncedCanvasLayer.onDetached
Defined in
src/sdk/components/map/MapLayer.ts:108
onMapProjectionChanged
▸ onMapProjectionChanged(mapProjection, changeFlags): void
This method is called when the map projection changes.
Parameters
| Name | Type | Description |
|---|---|---|
mapProjection | MapProjection | this layer's map projection. |
changeFlags | number | The types of changes made to the projection. |
Returns
void
Overrides
MapSyncedCanvasLayer.onMapProjectionChanged
Defined in
src/sdk/components/map/layers/MapLineLayer.tsx:77
onSleep
▸ onSleep(): void
This method is called when this layer's parent map is put to sleep.
Returns
void
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:81
onUpdated
▸ onUpdated(time, elapsed): void
This method is called once every map update cycle.
Parameters
| Name | Type | Description |
|---|---|---|
time | number | The current time as a UNIX timestamp. |
elapsed | number | The elapsed time, in milliseconds, since the last update. |
Returns
void
Overrides
MapSyncedCanvasLayer.onUpdated
Defined in
src/sdk/components/map/layers/MapLineLayer.tsx:90
onVisibilityChanged
▸ onVisibilityChanged(isVisible): void
This method is called when this layer's visibility changes.
Parameters
| Name | Type | Description |
|---|---|---|
isVisible | boolean | Whether the layer is now visible. |
Returns
void
Inherited from
MapSyncedCanvasLayer.onVisibilityChanged
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:187
onWake
▸ onWake(): void
This method is called when this layer's parent map is woken.
Returns
void
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:74
render
▸ render(): null | VNode
Renders the component.
Returns
null | VNode
A JSX element to be rendered.
Inherited from
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:256
setHeight
▸ setHeight(height): void
Sets the height of the canvas element, in pixels.
Parameters
| Name | Type | Description |
|---|---|---|
height | number | The new height. |
Returns
void
Inherited from
MapSyncedCanvasLayer.setHeight
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:157
setVisible
▸ setVisible(val): void
Sets this layer's visibility.
Parameters
| Name | Type | Description |
|---|---|---|
val | boolean | Whether this layer should be visible. |
Returns
void
Inherited from
MapSyncedCanvasLayer.setVisible
Defined in
src/sdk/components/map/MapLayer.ts:46
setWidth
▸ setWidth(width): void
Sets the width of the canvas element, in pixels.
Parameters
| Name | Type | Description |
|---|---|---|
width | number | The new width. |
Returns
void
Inherited from
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:142
tryGetBuffer
▸ tryGetBuffer(): undefined | MapCanvasLayerCanvasInstance
Attempts to get this layer's buffer canvas instance.
Returns
undefined | MapCanvasLayerCanvasInstance
This layer's buffer canvas instance, or undefined if it has not been initialized.
Inherited from
MapSyncedCanvasLayer.tryGetBuffer
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:118
tryGetDisplay
▸ tryGetDisplay(): undefined | MapCanvasLayerCanvasInstance
Attempts to get this layer's display canvas instance.
Returns
undefined | MapCanvasLayerCanvasInstance
This layer's display canvas instance, or undefined if it has not been initialized.
Inherited from
MapSyncedCanvasLayer.tryGetDisplay
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:110
updateCanvasSize
▸ updateCanvasSize(): void
Updates the canvas element's size.
Returns
void
Inherited from
MapSyncedCanvasLayer.updateCanvasSize
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:234
updateFromProjectedSize
▸ updateFromProjectedSize(projectedSize): void
Updates this layer according to the current size of the projected map window.
Parameters
| Name | Type | Description |
|---|---|---|
projectedSize | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | The size of the projected map window. |
Returns
void
Inherited from
MapSyncedCanvasLayer.updateFromProjectedSize
Defined in
src/sdk/components/map/layers/MapSyncedCanvasLayer.ts:20
updateFromVisibility
▸ updateFromVisibility(): void
Updates this layer according to its current visibility.
Returns
void
Inherited from
MapSyncedCanvasLayer.updateFromVisibility
Defined in
src/sdk/components/map/layers/MapCanvasLayer.tsx:196