Class: MapSharedCanvasSubLayer<P>
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:171
A sublayer of MapSharedCanvasLayer.
Extends
Extended by
Type Parameters
Type Parameter |
---|
P extends MapSharedCanvasSubLayerProps <any > |
Constructors
Constructor
new MapSharedCanvasSubLayer<
P
>(props
):MapSharedCanvasSubLayer
<P
>
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | P | The propertis of the component. |
Returns
MapSharedCanvasSubLayer
<P
>
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:
P
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Accessors
display
Get Signature
get
protected
display():MapSharedCanvasInstance
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:196
This sublayer's shared canvas instance.
Throws
Error if this sublayer is not attached.
Returns
projection
Get Signature
get
protected
projection():MapProjection
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:183
This sublayer's map projection.
Throws
Error if this sublayer is not attached.
Returns
Methods
attach()
attach(
projection
,display
):void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:225
Attaches this sublayer to a parent layer.
Parameters
Parameter | Type | Description |
---|---|---|
projection | MapProjection | The map projection used by this sublayer. |
display | MapSharedCanvasInstance | The canvas instance shared by this sublayer. |
Returns
void
destroy()
destroy():
void
Defined in: src/sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
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
isAttached()
protected
isAttached():boolean
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:208
Checks whether this sublayer is attached to a parent layer.
Returns
boolean
Whether this sublayer is attached to a parent layer.
isVisible()
protected
isVisible():boolean
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:216
Checks whether this sublayer is visible.
Returns
boolean
Whether this sublayer is visible.
onAfterRender()
onAfterRender(
node
):void
Defined in: src/sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
DisplayComponent
.onAfterRender
onAttached()
onAttached():
void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:263
This method is called when this sublayer is attached to its parent layer.
Returns
void
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
DisplayComponent
.onBeforeRender
onMapProjectionChanged()
onMapProjectionChanged(
projection
,changeFlags
):void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:287
This method is called when this sublayer's map projection changes.
Parameters
Parameter | Type | Description |
---|---|---|
projection | MapProjection | This sublayer's map projection. |
changeFlags | number | The types of changes made to the projection. |
Returns
void
onSleep()
onSleep():
void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:277
This method is called when this sublayer's parent layer is put to sleep.
Returns
void
onUpdated()
onUpdated(
time
,elapsed
):void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:310
This method is called once every update cycle after this sublayer's shared canvas instance has had a chance to be invalidated.
Parameters
Parameter | Type | Description |
---|---|---|
time | number | The current time as a UNIX timestamp in milliseconds. |
elapsed | number | The elapsed time, in milliseconds, since the last update. |
Returns
void
onVisibilityChanged()
protected
onVisibilityChanged(isVisible
):void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:256
This method is called when this layer's visibility changes.
Parameters
Parameter | Type | Description |
---|---|---|
isVisible | boolean | Whether the layer is now visible. |
Returns
void
onWake()
onWake():
void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:270
This method is called when this sublayer's parent layer is awakened.
Returns
void
render()
render():
null
|VNode
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:315
Renders the component.
Returns
null
| VNode
A JSX element to be rendered.
Overrides
setVisible()
setVisible(
val
):void
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:240
Sets this sublayer's visibility.
Parameters
Parameter | Type | Description |
---|---|---|
val | boolean | Whether this sublayer should be visible. |
Returns
void
shouldInvalidate()
shouldInvalidate(
time
,elapsed
):boolean
Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:299
This method is called at the beginning of every update cycle to check whether this sublayer's shared canvas instance should be invalidated. If the canvas is already invalidated, then this method will not be called.
Parameters
Parameter | Type | Description |
---|---|---|
time | number | The current time as a UNIX timestamp in milliseconds. |
elapsed | number | The elapsed time, in milliseconds, since the last update. |
Returns
boolean
Whether this sublayer's shared canvas instance should be invalidated.