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

      • VulpApi class
      • Methods

      VulpApi

      On this page

      • VulpApi class
      • Methods

      @vulp/js-api > VulpApi

      VulpApi class #

      Vulp API library (singleton).

      Signature:

      export declare class VulpApi 
      

      Methods #

      Method

      Modifiers

      Description

      destroy()

      static

      Destroys the Vulp API library.

      initialize()

      static

      Initializes the VULP API library.

      registerModel(iframe)

      static

      Connects an iframe containing a Vulp model.

      unregisterModel(iframe)

      static

      Disconnects an iframe containing a Vulp model. Can be called to free up resources when a model is no longer needed.

      ← @vulp/js-api
      VulpApiModel →
      • Powered by Hugo and Doks