@vulp/js-api

js-api package

A JavaScript library for interacting with a Vulp model.

Remarks

Please note that the Vulp API needs to be enabled for a model for this library to work.

Please report any issues to the Vulp team.

Classes

Class	Description
VulpApi	Vulp API library (singleton).
VulpApiModel	Vulp API model class. Represents a single Vulp API model instance (enclosed in an iframe).

Enumerations

Enumeration	Description
ApiErrorCodes	The error codes that can be thrown by the Vulp API.

Interfaces

Interface	Description
IApiHotspotViewConfig	Interface for hotspot configuration.
IApiLinks	Interface for links.
IApiModelColorConfig	Interface for model color configuration.
IApiModelColorGroupConfig	Interface for model color group configuration.
IApiModelConfig	Interface for model configuration.
IApiModelCustomColorConfig	Interface for model custom color configuration.
IApiModelCustomizeGroupConfig	Interface for customize groups configuration.
IApiModelCustomizeOptionConfig	Interface for customize option configuration.
IApiOverlayViewConfig	Interface for overlay configuration.
IApiViewConfig	Interface for view configuration.

Type Aliases

Type Alias	Description
ApiARActivatedMessageHandler	Handler for incoming AR activated message (called on every activation).
ApiARActivatedMessagePayload	Payload for the AR activated message.
ApiModelUpdatedMessageHandler	Handler for incoming model updates (called on every update).
ApiModelUpdatedMessagePayload	Payload for the model updated message.
ApiReadyMessageHandler	Handler for incoming ready message (called once).
ApiReadyMessagePayload	Payload for the ready message.
ApiViewUpdatedMessageHandler	Handler for incoming view updates (called on every update).
ApiViewUpdatedMessagePayload	Payload for the view updated message.