Class: MapSystemComponent<P>

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:52

A component that encompasses the compiled map system.

Extends

• MapComponent<P>

Type Parameters

Type Parameter	Default type
P extends MapSystemComponentProps<any>	MapSystemComponentProps<any>

Constructors

Constructor

new MapSystemComponent<P>(props): MapSystemComponent<P>

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:61

Parameters

Parameter	Type
props	P

Returns

MapSystemComponent<P>

Inherit Doc

Overrides

MapComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

MapComponent.context

---

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

MapComponent.contextType

---

deadZone

protected readonly deadZone: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:58

---

mapProjection

readonly mapProjection: MapProjection

Defined in: src/sdk/components/map/MapComponent.ts:42

This map component's projection model.

Inherited from

MapComponent.mapProjection

---

props

props: P & ComponentProps

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

The properties of the component.

Inherited from

MapComponent.props

---

rootStyles

protected readonly rootStyles: ObjectSubject<{ height: string; width: string; }>

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:53

Accessors

isAwake

Get Signature

get isAwake(): boolean

Defined in: src/sdk/components/map/MapComponent.ts:82

Whether this map is awake.

Returns

boolean

Inherited from

MapComponent.isAwake

Methods

attachLayer()

protected attachLayer(layer): void

Defined in: src/sdk/components/map/MapComponent.ts:209

Attaches a layer to this map component. If the layer is already attached, then this method has no effect.

Parameters

Parameter	Type	Description
layer	MapLayer	The layer to attach.

Returns

void

Inherited from

MapComponent.attachLayer

---

attachLayers()

protected attachLayers(thisNode): void

Defined in: src/sdk/components/map/MapComponent.ts:140

Scans this component's VNode sub-tree for MapLayer components and attaches them when found. Only the top-most level of MapLayer components are attached; layers that are themselves children of other layers are not attached.

Parameters

Parameter	Type	Description
thisNode	VNode	This component's VNode.

Returns

void

Inherited from

MapComponent.attachLayers

---

destroy()

destroy(): void

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:139

Destroys this component.

Returns

void

Overrides

MapComponent.destroy

---

detachLayer()

protected detachLayer(layer): boolean

Defined in: src/sdk/components/map/MapComponent.ts:224

Detaches a layer from this map component.

Parameters

Parameter	Type	Description
layer	MapLayer	The layer to detach.

Returns

boolean

Whether the layer was succesfully detached.

Inherited from

MapComponent.detachLayer

---

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

MapComponent.getContext

---

getProjectedSize()

getProjectedSize(): ReadonlyFloat64Array

Defined in: src/sdk/components/map/MapComponent.ts:74

Gets the size of this map's projected window, in pixels.

Returns

ReadonlyFloat64Array

The size of this map's projected window.

Inherited from

MapComponent.getProjectedSize

---

onAfterRender()

onAfterRender(thisNode): void

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:69

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
thisNode	VNode	The component's VNode.

Returns

void

Overrides

MapComponent.onAfterRender

---

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

MapComponent.onBeforeRender

---

onDeadZoneChanged()

protected onDeadZoneChanged(deadZone): void

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:81

This method is called when the size of this map's dead zone changes.

Parameters

Parameter	Type	Description
deadZone	ReadonlyFloat64Array	The dead zone.

Returns

void

---

onMapProjectionChanged()

protected onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:86

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

MapComponent.onMapProjectionChanged

---

onProjectedSizeChanged()

protected onProjectedSizeChanged(): void

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:102

This method is called when the size of this map's projected window changes.

Returns

void

Overrides

MapComponent.onProjectedSizeChanged

---

onSleep()

protected onSleep(): void

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:123

This method is called when the map is put to sleep.

Returns

void

Overrides

MapComponent.onSleep

---

onUpdated()

protected onUpdated(time, elapsed): void

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:107

This method is called once every update cycle.

Parameters

Parameter	Type	Description
time	number	The current real time as a UNIX timestamp in milliseconds.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Overrides

MapComponent.onUpdated

---

onWake()

protected onWake(): void

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:116

This method is called when the map is awakened.

Returns

void

Overrides

MapComponent.onWake

---

render()

render(): VNode

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:130

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

MapComponent.render

---

setRootSize()

protected setRootSize(size): void

Defined in: src/sdk/components/mapsystem/MapSystemComponent.tsx:96

Sets the size of this map's root HTML element.

Parameters

Parameter	Type	Description
size	ReadonlyFloat64Array	The new size, in pixels.

Returns

void

---

sleep()

sleep(): void

Defined in: src/sdk/components/map/MapComponent.ts:89

Puts this map to sleep. While asleep, this map will not be updated.

Returns

void

Inherited from

MapComponent.sleep

---

sleepLayers()

protected sleepLayers(): void

Defined in: src/sdk/components/map/MapComponent.ts:177

Calls the onSleep() method of this map's layers.

Returns

void

Inherited from

MapComponent.sleepLayers

---

update()

update(time): void

Defined in: src/sdk/components/map/MapComponent.ts:240

Updates this map.

Parameters

Parameter	Type	Description
time	number	The current real time as a UNIX timestamp in milliseconds.

Returns

void

Inherited from

MapComponent.update

---

updateLayers()

protected updateLayers(time, elapsed): void

Defined in: src/sdk/components/map/MapComponent.ts:264

Updates this map's attached layers.

Parameters

Parameter	Type	Description
time	number	The current real time as a UNIX timestamp in milliseconds.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Inherited from

MapComponent.updateLayers

---

wake()

wake(): void

Defined in: src/sdk/components/map/MapComponent.ts:96

Wakes this map, allowing it to be updated.

Returns

void

Inherited from

MapComponent.wake

---

wakeLayers()

protected wakeLayers(): void

Defined in: src/sdk/components/map/MapComponent.ts:160

Calls the onWake() method of this map's layers.

Returns

void

Inherited from

MapComponent.wakeLayers