Skip to main content

Class: MapSharedCanvasLayer

A map layer containing a single canvas synced to the map's projected size that can be shared amongst multiple sublayers for rendering.

All of the layer's children are rendered on top of the shared canvas element. All children that extend MapSharedCanvasSubLayer are treated as sublayers and can render to the shared canvas element.

Hierarchy

Constructors

constructor

new MapSharedCanvasLayer(props): MapSharedCanvasLayer

Creates an instance of a DisplayComponent.

Parameters

NameTypeDescription
propsMapCanvasLayerProps<any>The propertis of the component.

Returns

MapSharedCanvasLayer

Inherited from

MapLayer.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

Optional context: [] = undefined

The context on this component, if any.

Inherited from

MapLayer.context

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

MapLayer.contextType

Defined in

src/sdk/components/FSComponent.ts:67


props

props: MapCanvasLayerProps<any> & ComponentProps

The properties of the component.

Inherited from

MapLayer.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

destroy

destroy(): void

Destroys this component.

Returns

void

Overrides

MapLayer.destroy

Defined in

src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:153


getContext

getContext(context): never

Gets a context data subscription from the context collection.

Parameters

NameTypeDescription
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

Defined in

src/sdk/components/FSComponent.ts:106


isVisible

isVisible(): boolean

Checks whether this layer is visible.

Returns

boolean

whether this layer is visible.

Inherited from

MapLayer.isVisible

Defined in

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


onAfterRender

onAfterRender(thisNode): void

A callback that is called after the component is rendered.

Parameters

NameTypeDescription
thisNodeVNodeThe component's VNode.

Returns

void

Overrides

MapLayer.onAfterRender

Defined in

src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:57


onAttached

onAttached(): void

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

Returns

void

Overrides

MapLayer.onAttached

Defined in

src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:75


onBeforeRender

onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

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

MapLayer.onDetached

Defined in

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


onMapProjectionChanged

onMapProjectionChanged(projection, changeFlags): void

This method is called when the map projection changes.

Parameters

NameTypeDescription
projectionMapProjectionthis layer's map projection.
changeFlagsnumberThe types of changes made to the projection.

Returns

void

Overrides

MapLayer.onMapProjectionChanged

Defined in

src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:108


onSleep

onSleep(): void

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

Returns

void

Overrides

MapLayer.onSleep

Defined in

src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:101


onUpdated

onUpdated(time, elapsed): void

This method is called once every map update cycle.

Parameters

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

Returns

void

Overrides

MapLayer.onUpdated

Defined in

src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:121


onVisibilityChanged

onVisibilityChanged(isVisible): void

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

Parameters

NameTypeDescription
isVisiblebooleanWhether the layer is now visible.

Returns

void

Overrides

MapLayer.onVisibilityChanged

Defined in

src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:44


onWake

onWake(): void

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

Returns

void

Overrides

MapLayer.onWake

Defined in

src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:94


render

render(): VNode

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

MapLayer.render

Defined in

src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:139


setVisible

setVisible(val): void

Sets this layer's visibility.

Parameters

NameTypeDescription
valbooleanWhether this layer should be visible.

Returns

void

Inherited from

MapLayer.setVisible

Defined in

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