Vulp

Vulp

Main


    Socials

      Setup

      • Introduction
      • Quick Start
      • Attributes

      Parameters

      • Model style
      • Model customization
      • Viewer style
      • Camera
      • Buttons and overlays
      • Animation

      API

        Introduction

        • Getting Started
        • Demo application
        • API FAQ

        Package

        • @vulp/js-api

        Classes

        • VulpApi
        • VulpApiModel

        Interfaces

        • IApiHotspotViewConfig
        • IApiLinks
        • IApiModelColorConfig
        • IApiModelColorGroupConfig
        • IApiModelConfig
        • IApiModelCustomColorConfig
        • IApiModelCustomizeGroupConfig
        • IApiModelCustomizeOptionConfig
        • IApiOverlayViewConfig
        • IApiViewConfig

        Enums

        • ApiErrorCodes

        Type aliases

        • ApiARActivatedMessageHandler
        • ApiARActivatedMessagePayload
        • ApiModelUpdatedMessageHandler
        • ApiModelUpdatedMessagePayload
        • ApiReadyMessageHandler
        • ApiReadyMessagePayload
        • ApiViewUpdatedMessageHandler
        • ApiViewUpdatedMessagePayload

      Help

      • FAQ

      Setup

      • Introduction
      • Quick Start
      • Attributes

      Parameters

      • Model style
      • Model customization
      • Viewer style
      • Camera
      • Buttons and overlays
      • Animation

      API

        Introduction

        • Getting Started
        • Demo application
        • API FAQ

        Package

        • @vulp/js-api

        Classes

        • VulpApi
        • VulpApiModel

        Interfaces

        • IApiHotspotViewConfig
        • IApiLinks
        • IApiModelColorConfig
        • IApiModelColorGroupConfig
        • IApiModelConfig
        • IApiModelCustomColorConfig
        • IApiModelCustomizeGroupConfig
        • IApiModelCustomizeOptionConfig
        • IApiOverlayViewConfig
        • IApiViewConfig

        Enums

        • ApiErrorCodes

        Type aliases

        • ApiARActivatedMessageHandler
        • ApiARActivatedMessagePayload
        • ApiModelUpdatedMessageHandler
        • ApiModelUpdatedMessagePayload
        • ApiReadyMessageHandler
        • ApiReadyMessagePayload
        • ApiViewUpdatedMessageHandler
        • ApiViewUpdatedMessagePayload

      Help

      • FAQ

      On this page

      • VulpApiModel.toggleHotspots() method
      • Parameters

      toggleHotspots

      On this page

      • VulpApiModel.toggleHotspots() method
      • Parameters

      @vulp/js-api > VulpApiModel > toggleHotspots

      VulpApiModel.toggleHotspots() method #

      Shows or hides all hotspots.

      Signature:

      toggleHotspots(active: boolean): Promise<{
              active: boolean;
          }>;
      

      Parameters #

      Parameter

      Type

      Description

      active

      boolean

      Whether all hotspots should be displayed.

      **Returns:**

      Promise<{ active: boolean; }>

      Promise that resolves to an object with the active property, indicating whether the hotspots are active.

      • Powered by Hugo and Doks