OverlayInfo - @magiclane/maps-sdk API Reference

OverlayInfo class

Overlay info class

This class should not be instantiated directly.

Maps & 3D Scene

Signature:

export declare class OverlayInfo extends GemAutoreleaseObject

Extends: GemAutoreleaseObject

Constructor	Modifiers	Description
(constructor)(pointerId)	`protected`	Constructs a new instance of the `OverlayInfo` class

Property	Modifiers	Type	Description
categories	`readonly`	OverlayCategory[]	Get the overlay categories.
image	`readonly`	Uint8Array \| null	Get the image of the overlay
img	`readonly`	Img	Get the Img object of the overlay
name	`readonly`	string	Get the name of the overlay
pointerId	`readonly`	number \| bigint
uid	`readonly`	number	Get the unique ID of the overlay

Method	Modifiers	Description
getCategory(categId)		Get the overlay category by ID
hasCategories(categId)		Check if a category has subcategories