Skip to main content

Interface: MapLayerProps<M>

Defined in: src/sdk/components/map/MapLayer.ts:10

An interface for basic map layer properties.

Extends

Extended by

Type Parameters

Type Parameter
M

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

ComponentProps.children


class?

optional class: string | SubscribableSet<string>

Defined in: src/sdk/components/map/MapLayer.ts:25

The CSS class(es) to apply to the root of this layer.


mapProjection

mapProjection: MapProjection

Defined in: src/sdk/components/map/MapLayer.ts:15

A map projection model.


model

model: MapModel<M>

Defined in: src/sdk/components/map/MapLayer.ts:12

A map model.


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/MapLayer.ts:22

A subscribable which provides the maximum update frequency of the layer, in hertz. Note that the actual update frequency will not exceed the update frequency of the layer's parent map. If not defined, the frequency will default to that of the layer's parent map.