@3dsource/metabox-front-api
    Preparing search index...

    Class StopShowcase

    Represents a command to stop Showcase for a product when it is already initialized, and you want to destroy it. This class sends a command to the Metabox API to stop showcase for a product if it is already initialized.

    To listen for changes after sending this command, listen to the 'showcaseStatusChanged' event.

    Stops the showcase/timeline playback and closes the showcase mode. Returns to normal configurator view.

    Stops showcase playback and exits showcase mode entirely. Returns to normal interactive configurator view. Use for 'Exit Demo' buttons or auto-trigger when the user starts actively configuring the product.

    Call api.sendCommandToMetabox(new StopShowcase()). Fully resets the showcase state. Subscribe to showcaseStatusChanged to confirm 'stopped' status. After stopping, the configurator returns to full interactive mode — re-enable configuration controls.

    import { Communicator,ShowCaseStatus } from '@3dsource/metabox-front-api';
    window.env3DSource.apiReady = (api: Communicator) => {

        //Subscribe to the event before sending the command to ensure you capture the response
        api.addEventListener('showcaseStatusChanged', (data:ShowCaseStatus) => {
          console.log('Showcase status value after changed:', data);
        });

         api.sendCommandToMetabox(new StopShowcase());
    };
    Index

    Constructors

    constructor

    Properties

    data

    Constructors

    Properties

    data: ToMetaBoxMessageEnvelope

    The message envelope populated by subclass constructors and sent via Communicator.sendCommandToMetabox.

    Settings

    Member Visibility

    On This Page

    What does it unlock?Practical ApplicationAI Coding Best Practices
    Constructors
    Properties