changeOverlay

@vulp/js-api > VulpApiModel > changeOverlay

VulpApiModel.changeOverlay() method

Show or hide overlay.

Signature:

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

Parameters

ParameterTypeDescription
overlayIdstringThe overlay to change.
activebooleanWhether 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.