Class: MapGenericLayer<M>

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:34

A generic map layer which renders its children.

Extends

• MapLayer<MapGenericLayerProps<M>>

Type Parameters

Type Parameter	Default type
M	any

Constructors

Constructor

new MapGenericLayer<M>(props): MapGenericLayer<M>

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	MapGenericLayerProps	The propertis of the component.

Returns

MapGenericLayer<M>

Inherited from

MapLayer.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

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

MapLayer.contextType

---

props

props: MapGenericLayerProps<M> & ComponentProps

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

The properties of the component.

Inherited from

MapLayer.props

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

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

MapLayer.getContext

---

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

MapLayer.isVisible

---

onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

MapLayer.onAfterRender

---

onAttached()

onAttached(): void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:41

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

Returns

void

Overrides

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

MapLayer.onBeforeRender

---

onDetached()

onDetached(): void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:66

This method is called when this layer is detached from its parent map component.

Returns

void

Overrides

MapLayer.onDetached

---

onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:56

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

MapLayer.onMapProjectionChanged

---

onSleep()

onSleep(): void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:51

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

Returns

void

Overrides

MapLayer.onSleep

---

onUpdated()

onUpdated(time, elapsed): void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:61

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

MapLayer.onUpdated

---

onVisibilityChanged()

onVisibilityChanged(isVisible): void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:36

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

MapLayer.onVisibilityChanged

---

onWake()

onWake(): void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:46

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

Returns

void

Overrides

MapLayer.onWake

---

render()

render(): VNode

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:71

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

MapLayer.render

---

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

MapLayer.setVisible