Interface: MapSystemComponentProps<Modules>

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

Component props for MapSystemComponent.

Extends

• MapComponentProps<Modules>

Type Parameters

Type Parameter
Modules

Properties

bus

bus: EventBus

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

The event bus.

Inherited from

MapComponentProps.bus

---

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

MapComponentProps.children

---

class?

optional class: string | SubscribableSet<string>

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

CSS class(es) to apply to the root of the component.

---

deadZone?

optional deadZone: Subscribable<Float64Array>

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

A subscribable which provides the size of the dead zone around each edge of the map projection window, which is displayed but excluded in map range calculations. Expressed as [left, top, right, bottom] in pixels. Defaults to 0 on all sides.

---

model

model: MapModel<Modules>

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

A map model.

Inherited from

MapComponentProps.model

---

onAfterRender()

onAfterRender: () => void

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

A function to be called after the map is rendered.

Returns

void

---

onAfterUpdated()

onAfterUpdated: (time, elapsed) => void

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

A function to be called immediately after the map's layers are updated.

Parameters

Parameter	Type
time	number
elapsed	number

Returns

void

---

onBeforeUpdated()

onBeforeUpdated: (time, elapsed) => void

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

A function to be called immediately before the map's layers are updated.

Parameters

Parameter	Type
time	number
elapsed	number

Returns

void

---

onDeadZoneChanged()

onDeadZoneChanged: (deadZone) => void

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

A function to be called when the size of the map's dead zone changes.

Parameters

Parameter	Type
deadZone	ReadonlyFloat64Array

Returns

void

---

onDestroy()

onDestroy: () => void

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

A function to be called when the map is destroyed.

Returns

void

---

onMapProjectionChanged()

onMapProjectionChanged: (mapProjection, changeFlags) => void

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

A function to be called when the map's projection changes.

Parameters

Parameter	Type
mapProjection	MapProjection
changeFlags	number

Returns

void

---

onSleep()

onSleep: () => void

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

A function to be called when the map is put to sleep.

Returns

void

---

onWake()

onWake: () => void

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

A function to be called when the map is awakened.

Returns

void

---

projectedSize

projectedSize: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

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

The size, as [width, height] in pixels, of the map component's projected window.

Inherited from

MapComponentProps.projectedSize

---

projection?

optional projection: MapProjection

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

A projection to inject. A default will be used if none is provided.

Inherited from

MapComponentProps.projection

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

MapComponentProps.ref

---

updateFreq?

optional updateFreq: Subscribable<number>

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

The update frequency of the map, in hertz.

Inherited from

MapComponentProps.updateFreq