Class: MapSharedCanvasLayer
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:32
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.
Extends
MapLayer
<MapCanvasLayerProps
<any
>>
Constructors
Constructor
new MapSharedCanvasLayer(
props
):MapSharedCanvasLayer
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | MapCanvasLayerProps | The propertis of the component. |
Returns
MapSharedCanvasLayer
Inherited from
Properties
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
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
props
props:
MapCanvasLayerProps
<any
> &ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Methods
destroy()
destroy():
void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:153
Destroys this component.
Returns
void
Overrides
getContext()
protected
getContext(context
):never
Defined in: src/sdk/components/FSComponent.ts:106
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
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
onAfterRender()
onAfterRender(
thisNode
):void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:57
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
thisNode | VNode | The component's VNode. |
Returns
void
Overrides
onAttached()
onAttached():
void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:75
This method is called when this layer is attached to its parent map component.
Returns
void
Overrides
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
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
onMapProjectionChanged()
onMapProjectionChanged(
projection
,changeFlags
):void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:108
This method is called when the map projection changes.
Parameters
Parameter | Type | Description |
---|---|---|
projection | MapProjection | this layer's map projection. |
changeFlags | number | The types of changes made to the projection. |
Returns
void
Overrides
MapLayer
.onMapProjectionChanged
onSleep()
onSleep():
void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:101
This method is called when this layer's parent map is put to sleep.
Returns
void
Overrides
onUpdated()
onUpdated(
time
,elapsed
):void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:121
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
onVisibilityChanged()
onVisibilityChanged(
isVisible
):void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:44
This method is called when this layer's visibility changes.
Parameters
Parameter | Type | Description |
---|---|---|
isVisible | boolean | Whether the layer is now visible. |
Returns
void
Overrides
onWake()
onWake():
void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:94
This method is called when this layer's parent map is woken.
Returns
void
Overrides
render()
render():
VNode
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:139
Renders the component.
Returns
A JSX element to be rendered.
Overrides
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