Skip to main content

Interface: MapComponentProps<M>

Component props for MapComponent.

Type parameters

Name
M

Hierarchy

Properties

bus

bus: EventBus

The event bus.

Defined in

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


children

Optional children: DisplayChildren[]

The children of the display component.

Inherited from

ComponentProps.children

Defined in

src/sdk/components/FSComponent.ts:122


model

model: MapModel<M>

A map model.

Defined in

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


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.

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.

Defined in

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


ref

Optional ref: NodeReference<any>

A reference to the display component.

Inherited from

ComponentProps.ref

Defined in

src/sdk/components/FSComponent.ts:125


updateFreq

Optional updateFreq: Subscribable<number>

The update frequency of the map, in hertz.

Defined in

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