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
MapLayer
<MapCanvasLayerProps
<any
>>↳
MapSharedCanvasLayer
Constructors
constructor
• new MapSharedCanvasLayer(props
): MapSharedCanvasLayer
Creates an instance of a DisplayComponent.
Parameters
Name | Type | Description |
---|---|---|
props | MapCanvasLayerProps <any > | The propertis of the component. |
Returns
Inherited from
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional
context: [] = undefined
The context on this component, if any.
Inherited from
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
Defined in
src/sdk/components/FSComponent.ts:67
props
• props: MapCanvasLayerProps
<any
> & ComponentProps
The properties of the component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Overrides
Defined in
src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:153
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
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
Defined in
src/sdk/components/map/MapLayer.ts:38
onAfterRender
▸ onAfterRender(thisNode
): void
A callback that is called after the component is rendered.
Parameters
Name | Type | Description |
---|---|---|
thisNode | VNode | The component's VNode. |
Returns
void
Overrides
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
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
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
Defined in
src/sdk/components/map/MapLayer.ts:108
onMapProjectionChanged
▸ onMapProjectionChanged(projection
, changeFlags
): void
This method is called when the map projection changes.
Parameters
Name | Type | Description |
---|---|---|
projection | MapProjection | this layer's map projection. |
changeFlags | number | The 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
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
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
Overrides
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
Name | Type | Description |
---|---|---|
isVisible | boolean | Whether the layer is now visible. |
Returns
void
Overrides
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
Defined in
src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:94
render
▸ render(): VNode
Renders the component.
Returns
A JSX element to be rendered.
Overrides
Defined in
src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:139
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
Defined in
src/sdk/components/map/MapLayer.ts:46