changeOverlay

VulpApiModel.changeOverlay() method

Show or hide overlay.

Signature:

changeOverlay(overlayId: string, active: boolean): Promise<{
        active: boolean;
    }>;

Parameter	Type	Description
overlayId	string	The overlay to change.
active	boolean	Whether the overlay should be displayed.

**Returns:**

Promise<{ active: boolean; }>

Promise that resolves to an object with the active property, indicating whether the overlay is active.