Need help reading this?

setVrmValue

Set Vrm Value

setVrmValue(vrmVal: string)
Parameters
vrmVal (string) VRM Value

pageView

Analytics Event AOS

pageView(title: string, tabName: string, vrmValue: string, assetId: string)
Parameters
title (string) title
tabName (string) tabName
vrmValue (string) vrmValue
assetId (string) assetId

analyticsEventAOS

Analytics Event AOS

analyticsEventAOS(event: string, category: string, label: string, actionType: string, section: string, assetId: string)
Parameters
event (string) event name
category (string) category name
label (string) label
actionType (string) actionType
section (string) section
assetId (string) assetId

broadcastAOSEvent

Broadcast AOS Event

broadcastAOSEvent(detail: object)
Parameters
detail (object)

broadcastAOSEventForAnalytics

Broadcast AOS Event For Analytics

broadcastAOSEventForAnalytics(detail: object)
Parameters
detail (object)

fullscreenGallery

Full Screen AOS Gallery

fullscreenGallery(playerDiv: String)
Parameters
playerDiv (String = '')

exitFullscreenGallery

Exit Full Screen AOS Gallery

exitFullscreenGallery(playerDiv: String)
Parameters
playerDiv (String = '')

getGalleryComponent

Get Gallery Componenet Element

getGalleryComponent(element: Element): Element
Parameters
element (Element)
Returns
Element:

TagFactory

Factory for creating Tags

new TagFactory(tags: Array)
Parameters
tags (Array)
Instance Members
▸ tagsBelongingTo(parentMedia)

tagview

Class for displaying tags visually

tagview(div: String, tags: Array, galleryManager: GalleryManager, interactive: Boolean, shouldFocus: Boolean)
Parameters
div (String) element name to inject
tags (Array) to add to the view
galleryManager (GalleryManager)
interactive (Boolean = true) whether the view is interactive
shouldFocus (Boolean = false) whether the tag should cause a focus on the parent image

hideToolTip

function to hide tooltip if mobile device change its orientation

hideToolTip()

Library

SDK for AutosOnShow Vehicle Assets

new Library(apiKey: String)
Parameters
apiKey (String) AOS Access Key
Instance Members
▸ vehicle(identifier)

getVehicle

Return a vehicle from AOS containing all assets

getVehicle(identifier: String, authToken: String): Promise
Parameters
identifier (String) Vehicle Identifier (AOS)
authToken (String) Authentication Token for the Request
Returns
Promise: promise Promise contaiting the resulting vehicle

Vehicle

Validation Class

new Vehicle()
Static Members
▸ getPoster()
▸ getVideoPlaylist()
Instance Members
▸ getTitle()
▸ getDescription()
▸ getThumbnail()
▸ getThumbnailLarge()
▸ getThumbnailPlay()
▸ getLibraryId()
▸ getAssetId()
▸ getDateCreated()
▸ getDateModified()
▸ getImages()
▸ getImageSet()
▸ getSmallImages()
▸ getMediumImages()
▸ getLargeImages()
▸ hasImages()
▸ getInternalPanorama()
▸ hasInternalPanorama()
▸ getVideo()
▸ hasVideo()
▸ getThreeSixtyImages()
▸ hasThreeSixtyImages()
▸ getExplodedThreeSixtyImages()
▸ hasThreeExplodedSixtyImages()
▸ getAllThreeSixtyImages()
▸ hasPoster()
▸ getTags()
▸ getTagSet()
▸ hasTags()
▸ getTopVideo()
▸ getTailVideo()
▸ hasTopVideo()
▸ hasTailVideo()
▸ hasVideoPlaylist()
▸ getVideoOptions()
▸ getGalleryOptions()
▸ getPanoramaOptions()
▸ getSpinnerOptions()
▸ getStartComponent(dataAttrSequenceMap)
▸ getAnalyticsSettings()
▸ hasAnalytics()
▸ hasPersonalVideoRequest()
▸ getPersonalVideoForm()
▸ isPersonalVideo()
▸ getAOSAuthToken()
▸ getOverview()

Vehicle

Represents a Vehicle and its asset pack

new Vehicle()
Static Members
▸ getPoster()
▸ getVideoPlaylist()
Instance Members
▸ getTitle()
▸ getDescription()
▸ getThumbnail()
▸ getThumbnailLarge()
▸ getThumbnailPlay()
▸ getLibraryId()
▸ getAssetId()
▸ getDateCreated()
▸ getDateModified()
▸ getImages()
▸ getImageSet()
▸ getSmallImages()
▸ getMediumImages()
▸ getLargeImages()
▸ hasImages()
▸ getInternalPanorama()
▸ hasInternalPanorama()
▸ getVideo()
▸ hasVideo()
▸ getThreeSixtyImages()
▸ hasThreeSixtyImages()
▸ getExplodedThreeSixtyImages()
▸ hasThreeExplodedSixtyImages()
▸ getAllThreeSixtyImages()
▸ hasPoster()
▸ getTags()
▸ getTagSet()
▸ hasTags()
▸ getTopVideo()
▸ getTailVideo()
▸ hasTopVideo()
▸ hasTailVideo()
▸ hasVideoPlaylist()
▸ getVideoOptions()
▸ getGalleryOptions()
▸ getPanoramaOptions()
▸ getSpinnerOptions()
▸ getStartComponent(dataAttrSequenceMap)
▸ getAnalyticsSettings()
▸ hasAnalytics()
▸ hasPersonalVideoRequest()
▸ getPersonalVideoForm()
▸ isPersonalVideo()
▸ getAOSAuthToken()
▸ getOverview()

isValidUrl

Check Url is valida or not

isValidUrl(url: String): Boolean
Parameters
url (String)
Returns
Boolean:

fullscreenPanorama

Full Screen AOS Panorama

fullscreenPanorama(playerDiv: String)
Parameters
playerDiv (String = '')

exitFullscreenPanorama

Exit Full Screen AOS Panorama

exitFullscreenPanorama(playerDiv: String)
Parameters
playerDiv (String = '')

getPanoramaComponent

Get Panorama Componenet Element

getPanoramaComponent(element: Element): Element
Parameters
element (Element)
Returns
Element:

showMoveIcon

Show move icon

showMoveIcon()

hideMoveIcon

Hide move icon

hideMoveIcon()

fullscreenSpinner

Full Screen AOS Spinner

fullscreenSpinner(playerDiv: String)
Parameters
playerDiv (String = '')

exitFullscreenSpinner

Exit Full Screen AOS Spinner

exitFullscreenSpinner(playerDiv: String)
Parameters
playerDiv (String = '')

getSpinnerComponent

Get Spinner Componenet Element

getSpinnerComponent(element: Element): Element
Parameters
element (Element)
Returns
Element:

fullscreenVideo

Full Screen AOS Video

fullscreenVideo(playerDiv: String)
Parameters
playerDiv (String = '')

exitFullscreenVideo

Exit Full Screen AOS Gallery

exitFullscreenVideo(playerDiv: String)
Parameters
playerDiv (String = '')

getVideoComponent

Get Video Componenet Element

getVideoComponent(element: Element): Element
Parameters
element (Element)
Returns
Element: