Skip to main content

Abstract Class: MapCanvasLayer<P, C>

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:68

A layer which uses a canvas to draw graphics.

Extends

Extended by

Type Parameters

Type ParameterDefault type
P extends MapCanvasLayerProps<any>MapCanvasLayerProps<any>
C extends MapCanvasLayerCanvasInstanceMapCanvasLayerCanvasInstance

Constructors

Constructor

new MapCanvasLayer<P, C>(props): MapCanvasLayer<P, C>

Defined in: src/sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsPThe propertis of the component.

Returns

MapCanvasLayer<P, C>

Inherited from

MapLayer.constructor

Properties

context?

optional context: [] = undefined

Defined in: src/sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

MapLayer.context


contextType?

readonly optional contextType: readonly [] = undefined

Defined in: src/sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

MapLayer.contextType


isInit

protected isInit: boolean = false

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:78


props

props: P & ComponentProps

Defined in: src/sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

MapLayer.props

Accessors

buffer

Get Signature

get buffer(): C

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:98

Gets this layer's buffer canvas instance.

Throws

Error if this layer's buffer canvas instance has not been initialized.

Returns

C

This layer's buffer canvas instance.


display

Get Signature

get display(): C

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:85

Gets this layer's display canvas instance.

Throws

Error if this layer's display canvas instance has not been initialized.

Returns

C

This layer's display canvas instance.

Methods

copyBufferToDisplay()

copyBufferToDisplay(): void

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:171

Copies the contents of the buffer to the display. Has no effect if this layer does not have a buffer.

Returns

void


createCanvasInstance()

protected createCanvasInstance(canvas, context, isDisplayed): C

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:227

Creates a canvas instance.

Parameters

ParameterTypeDescription
canvasHTMLCanvasElementThe canvas element.
contextCanvasRenderingContext2DThe canvas 2D rendering context.
isDisplayedbooleanWhether the canvas is displayed.

Returns

C

a canvas instance.


destroy()

destroy(): void

Defined in: src/sdk/components/FSComponent.ts:98

Destroys this component.

Returns

void

Inherited from

MapLayer.destroy


getContext()

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

ParameterTypeDescription
contextneverThe 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

MapLayer.getContext


getHeight()

getHeight(): number

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:134

Gets the height of the canvas element, in pixels.

Returns

number

the height of the canvas element.


getWidth()

getWidth(): number

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:126

Gets the width of the canvas element, in pixels.

Returns

number

the width of the canvas element.


isVisible()

isVisible(): boolean

Defined in: src/sdk/components/map/MapLayer.ts:38

Checks whether this layer is visible.

Returns

boolean

whether this layer is visible.

Inherited from

MapLayer.isVisible


onAfterRender()

onAfterRender(): void

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:182

A callback called after the component renders.

Returns

void

Overrides

MapLayer.onAfterRender


onAttached()

onAttached(): void

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:201

This method is called when this layer is attached to its parent map component.

Returns

void

Overrides

MapLayer.onAttached


onBeforeRender()

onBeforeRender(): void

Defined in: src/sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

MapLayer.onBeforeRender


onDetached()

onDetached(): void

Defined in: src/sdk/components/map/MapLayer.ts:108

This method is called when this layer is detached from its parent map component.

Returns

void

Inherited from

MapLayer.onDetached


onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/sdk/components/map/MapLayer.ts:91

This method is called when the map projection changes.

Parameters

ParameterTypeDescription
mapProjectionMapProjectionthis layer's map projection.
changeFlagsnumberThe types of changes made to the projection.

Returns

void

Inherited from

MapLayer.onMapProjectionChanged


onSleep()

onSleep(): void

Defined in: src/sdk/components/map/MapLayer.ts:81

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

Returns

void

Inherited from

MapLayer.onSleep


onUpdated()

onUpdated(time, elapsed): void

Defined in: src/sdk/components/map/MapLayer.ts:101

This method is called once every map update cycle.

Parameters

ParameterTypeDescription
timenumberThe current time as a UNIX timestamp.
elapsednumberThe elapsed time, in milliseconds, since the last update.

Returns

void

Inherited from

MapLayer.onUpdated


onVisibilityChanged()

onVisibilityChanged(isVisible): void

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:187

This method is called when this layer's visibility changes.

Parameters

ParameterTypeDescription
isVisiblebooleanWhether the layer is now visible.

Returns

void

Overrides

MapLayer.onVisibilityChanged


onWake()

onWake(): void

Defined in: src/sdk/components/map/MapLayer.ts:74

This method is called when this layer's parent map is woken.

Returns

void

Inherited from

MapLayer.onWake


render()

render(): null | VNode

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:256

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Overrides

MapLayer.render


setHeight()

setHeight(height): void

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:157

Sets the height of the canvas element, in pixels.

Parameters

ParameterTypeDescription
heightnumberThe new height.

Returns

void


setVisible()

setVisible(val): void

Defined in: src/sdk/components/map/MapLayer.ts:46

Sets this layer's visibility.

Parameters

ParameterTypeDescription
valbooleanWhether this layer should be visible.

Returns

void

Inherited from

MapLayer.setVisible


setWidth()

setWidth(width): void

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:142

Sets the width of the canvas element, in pixels.

Parameters

ParameterTypeDescription
widthnumberThe new width.

Returns

void


tryGetBuffer()

tryGetBuffer(): undefined | C

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:118

Attempts to get this layer's buffer canvas instance.

Returns

undefined | C

This layer's buffer canvas instance, or undefined if it has not been initialized.


tryGetDisplay()

tryGetDisplay(): undefined | C

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:110

Attempts to get this layer's display canvas instance.

Returns

undefined | C

This layer's display canvas instance, or undefined if it has not been initialized.


updateCanvasSize()

protected updateCanvasSize(): void

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:234

Updates the canvas element's size.

Returns

void


updateFromVisibility()

protected updateFromVisibility(): void

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:196

Updates this layer according to its current visibility.

Returns

void