Class: MapCachedCanvasLayer<P>

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:312

A canvas map layer whose image can be cached and transformed as the map projection changes.

Extends

• MapCanvasLayer<P, MapCachedCanvasLayerCanvasInstance>

Type Parameters

Type Parameter	Default type
P extends MapCachedCanvasLayerProps<any>	MapCachedCanvasLayerProps<any>

Constructors

Constructor

new MapCachedCanvasLayer<P>(props): MapCachedCanvasLayer<P>

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:324

Parameters

Parameter	Type
props	P

Returns

MapCachedCanvasLayer<P>

Inherit Doc

Overrides

MapCanvasLayer.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

MapCanvasLayer.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

MapCanvasLayer.contextType

---

isAwake

protected isAwake: boolean = true

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:321

---

isInit

protected isInit: boolean = false

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

Inherited from

MapCanvasLayer.isInit

---

props

props: P & ComponentProps

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

The properties of the component.

Inherited from

MapCanvasLayer.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.

Inherited from

MapCanvasLayer.buffer

---

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.

Inherited from

MapCanvasLayer.display

Methods

copyBufferToDisplay()

copyBufferToDisplay(): void

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

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

Returns

void

Inherited from

MapCanvasLayer.copyBufferToDisplay

---

createCanvasInstance()

protected createCanvasInstance(canvas, context, isDisplayed): MapCachedCanvasLayerCanvasInstanceClass

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:356

Creates a canvas instance.

Parameters

Parameter	Type	Description
canvas	HTMLCanvasElement	The canvas element.
context	CanvasRenderingContext2D	The canvas 2D rendering context.
isDisplayed	boolean	Whether the canvas is displayed.

Returns

MapCachedCanvasLayerCanvasInstanceClass

a canvas instance.

Overrides

MapCanvasLayer.createCanvasInstance

---

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

MapCanvasLayer.destroy

---

getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

Parameter	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

MapCanvasLayer.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.

Inherited from

MapCanvasLayer.getHeight

---

getReferenceMargin()

getReferenceMargin(): number

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:343

Gets the reference translation margin, in pixels, of this layer's display canvas. This value is the maximum amount the display canvas can be translated in the x or y direction at a scale factor of 1 without invalidation.

Returns

number

the reference translation margin of this layer's display canvas.

---

getSize()

getSize(): number

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:334

Gets the size, in pixels, of this layer's canvas.

Returns

number

the size of this layer's canvas.

---

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.

Inherited from

MapCanvasLayer.getWidth

---

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

MapCanvasLayer.isVisible

---

onAfterRender()

onAfterRender(): void

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

A callback called after the component renders.

Returns

void

Inherited from

MapCanvasLayer.onAfterRender

---

onAttached()

onAttached(): void

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:348

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

Returns

void

Overrides

MapCanvasLayer.onAttached

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

MapCanvasLayer.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

MapCanvasLayer.onDetached

---

onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:407

This method is called when the map projection changes.

Parameters

Parameter	Type	Description
mapProjection	MapProjection	this layer's map projection.
changeFlags	number	The types of changes made to the projection.

Returns

void

Overrides

MapCanvasLayer.onMapProjectionChanged

---

onSleep()

onSleep(): void

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:396

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

Returns

void

Overrides

MapCanvasLayer.onSleep

---

onUpdated()

onUpdated(time, elapsed): void

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:418

This method is called once every map update cycle.

Parameters

Parameter	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

MapCanvasLayer.onUpdated

---

onVisibilityChanged()

onVisibilityChanged(isVisible): void

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

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

Parameters

Parameter	Type	Description
isVisible	boolean	Whether the layer is now visible.

Returns

void

Inherited from

MapCanvasLayer.onVisibilityChanged

---

onWake()

onWake(): void

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:383

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

Returns

void

Overrides

MapCanvasLayer.onWake

---

render()

render(): VNode | null

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

Renders the component.

Returns

VNode | null

A JSX element to be rendered.

Inherited from

MapCanvasLayer.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

Parameter	Type	Description
height	number	The new height.

Returns

void

Inherited from

MapCanvasLayer.setHeight

---

setSize()

setSize(width, height): void

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

Sets the size of the canvas element.

Parameters

Parameter	Type	Description
width	number	The new width, in pixels.
height	number	The new height, in pixels.

Returns

void

Inherited from

MapCanvasLayer.setSize

---

setVisible()

setVisible(val): void

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

Sets this layer's visibility.

Parameters

Parameter	Type	Description
val	boolean	Whether this layer should be visible.

Returns

void

Inherited from

MapCanvasLayer.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

Parameter	Type	Description
width	number	The new width.

Returns

void

Inherited from

MapCanvasLayer.setWidth

---

tryGetBuffer()

tryGetBuffer(): MapCachedCanvasLayerCanvasInstance | undefined

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

Attempts to get this layer's buffer canvas instance.

Returns

MapCachedCanvasLayerCanvasInstance | undefined

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

Inherited from

MapCanvasLayer.tryGetBuffer

---

tryGetDisplay()

tryGetDisplay(): MapCachedCanvasLayerCanvasInstance | undefined

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

Attempts to get this layer's display canvas instance.

Returns

MapCachedCanvasLayerCanvasInstance | undefined

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

Inherited from

MapCanvasLayer.tryGetDisplay

---

updateCanvasSize()

protected updateCanvasSize(): void

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

Updates the canvas element's size.

Returns

void

Inherited from

MapCanvasLayer.updateCanvasSize

---

updateFromProjectedSize()

protected updateFromProjectedSize(projectedSize): void

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:364

Updates this layer according to the current size of the projected map window.

Parameters

Parameter	Type	Description
projectedSize	ReadonlyFloat64Array	The size of the projected map window.

Returns

void

---

updateFromVisibility()

protected updateFromVisibility(): void

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

Updates this layer according to its current visibility.

Returns

void

Inherited from

MapCanvasLayer.updateFromVisibility

---

updateTransforms()

protected updateTransforms(): void

Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:431

Updates this layer's canvas instances' transforms.

Returns

void