Class Vps

Primary interface for the AutoSync Vps library. Provides a complete API for Products visualization including:

Products data loading and management
Wheel and Tire configuration
Image rendering and export

The class can be instantiated multiple times via initVps function as long as a different element is passed each time.

Hierarchy

Vps

Constructors

constructor

new Vps(c: AppConfigInput): Vps
Creates a new Vps instance
Parameters
- c: AppConfigInput
  
  Application configuration input
Returns Vps

Methods

getTireData

getTireData(): TiresResponse
Gets a copy of the current tire data fetched from the API

Returns
Tire data response object

Throws
Error if no tire is loaded

Returns TiresResponse

getWheelData

getWheelData(): WheelsResponse
Gets a copy of the current wheel data fetched from the API

Returns
Wheel data response object

Throws
Error if no wheel is loaded

Returns WheelsResponse

goToNextAngle

goToNextAngle(): void
Transition to the next available angle

Returns void

goToPreviousAngle

goToPreviousAngle(): void
Transition to the previous available angle

Returns void

loadTireByDescription

loadTireByDescription(tireDesc: string): Promise<void>
Loads a tire by description

Returns
Promise resolving to success state
Parameters
- tireDesc: string
  
  Tire description
Returns Promise<void>

loadTireById

loadTireById(tireId: any): Promise<void>
Loads a tire by AutoSync tire ID

Returns
Promise resolving to success state
Parameters
- tireId: any
  
  AutoSync tire identifier
Returns Promise<void>

loadTireByPn

loadTireByPn(tirePn: string): Promise<void>
Loads a tire by vendor part number

Returns
Promise resolving to success state
Parameters
- tirePn: string
  
  Tire part number
Returns Promise<void>

loadTireData

loadTireData(tireData: TiresResponse): Promise<void>
Loads and processes tire data using the provided TiresResponse.

Returns
A promise that resolves to an array of void upon successful processing.
Parameters
- tireData: TiresResponse
  
  The response object containing tire-related data.
Returns Promise<void>

loadWheelByDescription

loadWheelByDescription(wheelDesc: string): Promise<void>
Loads a wheel by description

Returns
Promise resolving to success state
Parameters
- wheelDesc: string
  
  Wheel description
Returns Promise<void>

loadWheelByDtArticleNumber

loadWheelByDtArticleNumber(dtArticleNumber: any): Promise<void>
Loads a wheel by DT article number

Returns
Promise resolving to success state
Parameters
- dtArticleNumber: any
  
  DT article identifier
Returns Promise<void>

loadWheelById

loadWheelById(wheelId: any): Promise<void>
Loads a wheel by AutoSync wheel ID

Returns
Promise resolving to success state
Parameters
- wheelId: any
  
  AutoSync wheel identifier
Returns Promise<void>

loadWheelByPn

loadWheelByPn(wheelPn: string): Promise<void>
Loads a wheel by vendor part number

Returns
Promise resolving to success state
Parameters
- wheelPn: string
  
  Wheel part number
Returns Promise<void>

loadWheelData

loadWheelData(wheelData: WheelsResponse): Promise<void>
Loads and processes wheel data using the provided WheelsResponse.

Returns
A promise that resolves to an array of void upon successful processing.
Parameters
- wheelData: WheelsResponse
  
  The response object containing wheel-related data.
Returns Promise<void>

setHeight

setHeight(height: string): void
Sets the container height
Parameters
- height: string
  
  Any valid CSS height value
Returns void

setShowArrows

setShowArrows(value: boolean): void
Parameters
- value: boolean
Returns void

setShowThumbs

setShowThumbs(value: boolean): void
Parameters
- value: boolean
Returns void

setViewAngle

setViewAngle(angle: ViewAngle): void
Sets the angle view
Parameters
- angle: ViewAngle
  
  Any valid angle value
Returns void

setWidthAdjustment

setWidthAdjustment(value: AppConfigWidthAdjustmentType): void
Parameters
- value: AppConfigWidthAdjustmentType
Returns void

toDataURL

toDataURL(): string
Gets a URL representation of the current visualization

Returns
Data URL containing the image

Returns string

unloadTireData

unloadTireData(): Promise<void>
Unloads the tire data by initiating a process with an undefined data parameter.

Returns
A promise that resolves when the unloading process is complete.

Returns Promise<void>

unloadWheelData

unloadWheelData(): Promise<void>
Unloads the wheel data by initiating a process with an undefined data parameter.

Returns
A promise that resolves when the unloading process is complete.

Returns Promise<void>

Generated using TypeDoc