Skip to main content

Interface: MapComponentProps<M>

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

Component props for MapComponent.

Extends​

Extended by​

Type Parameters​

Type Parameter
M

Properties​

bus​

bus: EventBus

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

The event bus.

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

ComponentProps.children

model​

model: MapModel<M>

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

A map model.

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.

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.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref

updateFreq?​

optional updateFreq: Subscribable<number>

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

The update frequency of the map, in hertz.