Interface: MapSystemComponentProps<Modules>
Component props for MapSystemComponent.
Type parameters
| Name |
|---|
Modules |
Hierarchy
MapComponentProps<Modules>↳
MapSystemComponentProps
Properties
bus
• bus: EventBus
The event bus.
Inherited from
Defined in
src/sdk/components/map/MapComponent.ts:21
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string | SubscribableSet<string>
CSS class(es) to apply to the root of the component.
Defined in
src/sdk/components/mapsystem/MapSystemComponent.tsx:46
deadZone
• Optional deadZone: Subscribable<Float64Array>
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.
Defined in
src/sdk/components/mapsystem/MapSystemComponent.tsx:19
model
• model: MapModel<Modules>
A map model.
Inherited from
Defined in
src/sdk/components/map/MapComponent.ts:18
onAfterRender
• onAfterRender: () => void
A function to be called after the map is rendered.
Type declaration
▸ (): void
A function to be called after the map is rendered.
Returns
void
Defined in
src/sdk/components/mapsystem/MapSystemComponent.tsx:22
onAfterUpdated
• onAfterUpdated: (time: number, elapsed: number) => void
A function to be called immediately after the map's layers are updated.
Type declaration
▸ (time, elapsed): void
A function to be called immediately after the map's layers are updated.
Parameters
| Name | Type |
|---|---|
time | number |
elapsed | number |
Returns
void
Defined in
src/sdk/components/mapsystem/MapSystemComponent.tsx:34
onBeforeUpdated
• onBeforeUpdated: (time: number, elapsed: number) => void
A function to be called immediately before the map's layers are updated.
Type declaration
▸ (time, elapsed): void
A function to be called immediately before the map's layers are updated.
Parameters
| Name | Type |
|---|---|
time | number |
elapsed | number |
Returns
void
Defined in
src/sdk/components/mapsystem/MapSystemComponent.tsx:31
onDeadZoneChanged
• onDeadZoneChanged: (deadZone: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>) => void
A function to be called when the size of the map's dead zone changes.
Type declaration
▸ (deadZone): void
A function to be called when the size of the map's dead zone changes.
Parameters
| Name | Type |
|---|---|
deadZone | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> |
Returns
void
Defined in
src/sdk/components/mapsystem/MapSystemComponent.tsx:25
onDestroy
• onDestroy: () => void
A function to be called when the map is destroyed.
Type declaration
▸ (): void
A function to be called when the map is destroyed.
Returns
void
Defined in
src/sdk/components/mapsystem/MapSystemComponent.tsx:43
onMapProjectionChanged
• onMapProjectionChanged: (mapProjection: MapProjection, changeFlags: number) => void
A function to be called when the map's projection changes.
Type declaration
▸ (mapProjection, changeFlags): void
A function to be called when the map's projection changes.
Parameters
| Name | Type |
|---|---|
mapProjection | MapProjection |
changeFlags | number |
Returns
void
Defined in
src/sdk/components/mapsystem/MapSystemComponent.tsx:28
onSleep
• onSleep: () => void
A function to be called when the map is put to sleep.
Type declaration
▸ (): void
A function to be called when the map is put to sleep.
Returns
void
Defined in
src/sdk/components/mapsystem/MapSystemComponent.tsx:40
onWake
• onWake: () => void
A function to be called when the map is awakened.
Type declaration
▸ (): void
A function to be called when the map is awakened.
Returns
void
Defined in
src/sdk/components/mapsystem/MapSystemComponent.tsx:37
projectedSize
• projectedSize: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
The size, as [width, height] in pixels, of the map component's projected window.
Inherited from
MapComponentProps.projectedSize
Defined in
src/sdk/components/map/MapComponent.ts:27
projection
• Optional projection: MapProjection
A projection to inject. A default will be used if none is provided.
Inherited from
Defined in
src/sdk/components/map/MapComponent.ts:30
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
updateFreq
• Optional updateFreq: Subscribable<number>
The update frequency of the map, in hertz.
Inherited from
Defined in
src/sdk/components/map/MapComponent.ts:24