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

      • IApiModelConfig interface
      • Properties

      IApiModelConfig

      On this page

      • IApiModelConfig interface
      • Properties

      @vulp/js-api > IApiModelConfig

      IApiModelConfig interface #

      Interface for model configuration.

      Signature:

      export interface IApiModelConfig 
      

      Properties #

      Property

      Modifiers

      Type

      Description

      colorGroups

      Record<string, IApiModelColorGroupConfig>

      The color groups of the model.

      customizeGroups?

      Record<string, IApiModelCustomizeGroupConfig>

      (Optional) The customize groups of the model (optional).

      modelId

      string

      Model identifier.

      overlays?

      Record<string, Record<PropertyKey, never>>

      (Optional) The overlays of the model (optional).

      ← IApiModelColorGroupConfig
      IApiModelCustomColorConfig →
      • Powered by Hugo and Doks