Class: MapSelectWaypointLayer

A map layer for displaying a selected waypoint.

Hierarchy

• MapSyncedCanvasLayer<MapSelectWaypointLayerProps>

  ↳ MapSelectWaypointLayer

Constructors

constructor

• new MapSelectWaypointLayer(props): MapSelectWaypointLayer

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	MapSelectWaypointLayerProps	The propertis of the component.

Returns

MapSelectWaypointLayer

Inherited from

MapSyncedCanvasLayer<MapSelectWaypointLayerProps>.constructor

Defined in

sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

MapSyncedCanvasLayer.context

Defined in

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

sdk/components/FSComponent.ts:67

---

displayWaypoint

• Protected displayWaypoint: undefined | FacilityWaypoint<Facility>

Defined in

workingtitle-instruments-wt21/shared/Map/MapSelectWaypointLayer.tsx:36

---

isInit

• Protected isInit: boolean = false

Inherited from

MapSyncedCanvasLayer.isInit

Defined in

sdk/components/map/layers/MapCanvasLayer.tsx:78

---

props

• props: MapSelectWaypointLayerProps & ComponentProps

The properties of the component.

Inherited from

MapSyncedCanvasLayer.props

Defined in

sdk/components/FSComponent.ts:61

---

CtrWaypointRole

▪ Static Readonly CtrWaypointRole: "CtrWptRole"

Defined in

workingtitle-instruments-wt21/shared/Map/MapSelectWaypointLayer.tsx:32

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

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

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

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

MapCanvasLayerCanvasInstance

a canvas instance.

Inherited from

MapSyncedCanvasLayer.createCanvasInstance

Defined in

sdk/components/map/layers/MapCanvasLayer.tsx:227

---

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Inherited from

MapSyncedCanvasLayer.destroy

Defined in

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

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

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

MapSyncedCanvasLayer.getWidth

Defined in

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

sdk/components/map/MapLayer.ts:38

---

onAfterRender

▸ onAfterRender(): void

A callback called after the component renders.

Returns

void

Inherited from

MapSyncedCanvasLayer.onAfterRender

Defined in

sdk/components/map/layers/MapCanvasLayer.tsx:182

---

onAttached

▸ onAttached(): void

Returns

void

Inherit Doc

Overrides

MapSyncedCanvasLayer.onAttached

Defined in

workingtitle-instruments-wt21/shared/Map/MapSelectWaypointLayer.tsx:39

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

MapSyncedCanvasLayer.onBeforeRender

Defined in

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

sdk/components/map/MapLayer.ts:108

---

onMapProjectionChanged

▸ onMapProjectionChanged(mapProjection, changeFlags): void

Parameters

Name	Type
mapProjection	MapProjection
changeFlags	number

Returns

void

Inherited from

MapSyncedCanvasLayer.onMapProjectionChanged

Defined in

sdk/components/map/layers/MapSyncedCanvasLayer.ts:30

---

onSleep

▸ onSleep(): void

This method is called when this layer's parent map is put to sleep.

Returns

void

Inherited from

MapSyncedCanvasLayer.onSleep

Defined in

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

Inherited from

MapSyncedCanvasLayer.onUpdated

Defined in

sdk/components/map/MapLayer.ts:101

---

onVisibilityChanged

▸ onVisibilityChanged(isVisible): void

Parameters

Name	Type
isVisible	boolean

Returns

void

Inherited from

MapSyncedCanvasLayer.onVisibilityChanged

Defined in

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

MapSyncedCanvasLayer.onWake

Defined in

sdk/components/map/MapLayer.ts:74

---

render

▸ render(): null | VNode

Returns

null | VNode

Inherit Doc

Inherited from

MapSyncedCanvasLayer.render

Defined in

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

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

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

MapSyncedCanvasLayer.setWidth

Defined in

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

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

sdk/components/map/layers/MapCanvasLayer.tsx:110

---

updateCanvasSize

▸ updateCanvasSize(): void

Updates the canvas element's size.

Returns

void

Inherited from

MapSyncedCanvasLayer.updateCanvasSize

Defined in

sdk/components/map/layers/MapCanvasLayer.tsx:234

---

updateDisplayWaypoint

▸ updateDisplayWaypoint(facility): Promise<void>

Updates the displayed facility.

Parameters

Name	Type	Description
facility	null | Facility	The facility to display.

Returns

Promise<void>

Defined in

workingtitle-instruments-wt21/shared/Map/MapSelectWaypointLayer.tsx:49

---

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

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

sdk/components/map/layers/MapCanvasLayer.tsx:196