This is the documentation of version 1.0.0-rc.4. Go to the latest version, 1.0.0-rc.5.

Type Alias CustomLayerOptions<HIT>

CustomLayerOptions: { beforeLayerConfig?: BeforeLayerConfig } & (
| CustomLayerEventsOptions<HIT>
| { events?: never; hitTest?: never; setState?: never }
)

How TomTomMap.addCustomLayer places a custom layer, and whether its objects take user events.

Type Parameters

HIT extends CustomLayerHit = CustomLayerHit
What the hit tester returns, and so what the event handlers receive.

Type Declaration

OptionalbeforeLayerConfig?: BeforeLayerConfig

Where the layer goes in the map's layer stack, as with a module's beforeLayerConfig.
Remarks
Use 'lowest3D' for a 3D layer: it goes under the style's 3D buildings, otherwise under the POIs, otherwise on top. Module layers placed at 'lowest3D' or below, such as before lowestLabel, stay under it however late they're added. Those placed higher, at 'poi', 'lowestPlaceLabel', 'country' or 'top', go over it.
Default
```
'top'
```

CustomLayerEventsOptions<HIT>
{ events?: never; hitTest?: never; setState?: never }

Example

const options: CustomLayerOptions = { beforeLayerConfig: 'lowest3D', hitTest: pickVehicles };