Options
All
  • Public
  • Public/Protected
  • All
Menu

@byondrnd/byondxr-web-visualizer

Index

Type aliases

ICameraEventType

ICameraEventType: "zoom" | "move"

IConfigurationFilter

IConfigurationFilter: Infer<typeof configurationFilterValidator>

IFacet

IFacet: Infer<typeof facetValidator>

IFavorite

IFavorite: Infer<typeof favoriteValidator>

IFavoriteProductList

IFavoriteProductList: Infer<typeof favoriteProductListValidator>

IFavoriteProductShortList

IFavoriteProductShortList: Infer<typeof favoriteProductShortListValidator>

IFavoriteScene

IFavoriteScene: Infer<typeof favoriteSceneValidator>

IFavoriteSceneList

IFavoriteSceneList: Infer<typeof favoriteSceneListValidator>

IFavoriteShort

IFavoriteShort: Infer<typeof favoriteShortValidator>

IProduct

IProduct: Infer<typeof productValidator>

IProductShort

IProductShort: Infer<typeof productShortValidator>

IScene

IScene: Infer<typeof sceneValidator>

TAnalyticsEvent

TAnalyticsEvent: Partial<{}>

Variables

Const configurationFilterValidator

configurationFilterValidator: ObjectValidator<{ customFieldName: StringValidator; name: StringValidator; operator: ConstantValidator<["not"]>; options: OrValidator<any> }, "name" | "options", false> = jointz.object({name: jointz.string(),customFieldName: jointz.string(),operator: jointz.constant('not'),options: jointz.or(jointz.array(jointz.string()), jointz.constant(null)),}).requiredKeys(['name', 'options'])

Const facetValidator

facetValidator: ObjectValidator<{ name: StringValidator; options: OrValidator<any> }, "name" | "options", false> = jointz.object({name: jointz.string(),options: jointz.or(jointz.array(jointz.string()), jointz.constant(null)),}).requiredKeys(['name', 'options'])

Const favoriteProductListValidator

favoriteProductListValidator: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ product: ObjectValidator<{ application: StringValidator; description: StringValidator; facets: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ name: StringValidator; options: OrValidator<any> }>, "name" | "options">>; image: StringValidator; name: StringValidator; price: StringValidator; sku: StringValidator; title: StringValidator }, "sku" | "title" | "image" | "application", false> }>, "product">> = jointz.array(favoriteValidator)

Const favoriteProductShortListValidator

favoriteProductShortListValidator: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ product: ObjectValidator<{ application: StringValidator; sku: StringValidator }, "sku" | "application", false> }>, "product">> = jointz.array(favoriteShortValidator)

Const favoriteSceneListValidator

favoriteSceneListValidator: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ favorites: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ product: ObjectValidator<{ application: StringValidator; description: StringValidator; facets: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ name: StringValidator; options: OrValidator<any> }>, "name" | "options">>; image: StringValidator; name: StringValidator; price: StringValidator; sku: StringValidator; title: StringValidator }, "sku" | "title" | "image" | "application", false> }>, "product">>; id: StringValidator; image: StringValidator; scene: ObjectValidator<{ experienceId: StringValidator; filters: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ customFieldName: StringValidator; name: StringValidator; operator: ConstantValidator<["not"]>; options: OrValidator<any> }>, "name" | "options">>; image: StringValidator; sceneId: StringValidator; subtitle: StringValidator; title: StringValidator }, "image" | "experienceId" | "sceneId", false> }>, "image" | "id" | "favorites">> = jointz.array(favoriteSceneValidator)

Const favoriteSceneValidator

favoriteSceneValidator: ObjectValidator<{ favorites: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ product: ObjectValidator<{ application: StringValidator; description: StringValidator; facets: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ name: StringValidator; options: OrValidator<any> }>, "name" | "options">>; image: StringValidator; name: StringValidator; price: StringValidator; sku: StringValidator; title: StringValidator }, "sku" | "title" | "image" | "application", false> }>, "product">>; id: StringValidator; image: StringValidator; scene: ObjectValidator<{ experienceId: StringValidator; filters: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ customFieldName: StringValidator; name: StringValidator; operator: ConstantValidator<["not"]>; options: OrValidator<any> }>, "name" | "options">>; image: StringValidator; sceneId: StringValidator; subtitle: StringValidator; title: StringValidator }, "image" | "experienceId" | "sceneId", false> }, "image" | "id" | "favorites", false> = jointz.object({id: jointz.string(),image: jointz.string(),favorites: jointz.array(favoriteValidator),scene: sceneValidator,}).requiredKeys(['id', 'image', 'favorites'])

Const favoriteShortValidator

favoriteShortValidator: ObjectValidator<{ product: ObjectValidator<{ application: StringValidator; sku: StringValidator }, "sku" | "application", false> }, "product", false> = jointz.object({product: productShortValidator,}).requiredKeys(['product'])

Const favoriteValidator

favoriteValidator: ObjectValidator<{ product: ObjectValidator<{ application: StringValidator; description: StringValidator; facets: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ name: StringValidator; options: OrValidator<any> }>, "name" | "options">>; image: StringValidator; name: StringValidator; price: StringValidator; sku: StringValidator; title: StringValidator }, "sku" | "title" | "image" | "application", false> }, "product", false> = jointz.object({product: productValidator,}).requiredKeys(['product'])

Const productShortValidator

productShortValidator: ObjectValidator<{ application: StringValidator; sku: StringValidator }, "sku" | "application", false> = jointz.object({sku: jointz.string(),application: jointz.string(),}).requiredKeys(['sku', 'application'])

Const productValidator

productValidator: ObjectValidator<{ application: StringValidator; description: StringValidator; facets: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ name: StringValidator; options: OrValidator<any> }>, "name" | "options">>; image: StringValidator; name: StringValidator; price: StringValidator; sku: StringValidator; title: StringValidator }, "sku" | "title" | "image" | "application", false> = jointz.object({sku: jointz.string(),name: jointz.string(),title: jointz.string(),description: jointz.string(),application: jointz.string(),image: jointz.string(),price: jointz.string(),facets: jointz.array(facetValidator),}).requiredKeys(['sku', 'title', 'image', 'application'])

Const sceneValidator

sceneValidator: ObjectValidator<{ experienceId: StringValidator; filters: ArrayValidator<WithRequiredKeys<ExtractObjectType<{ customFieldName: StringValidator; name: StringValidator; operator: ConstantValidator<["not"]>; options: OrValidator<any> }>, "name" | "options">>; image: StringValidator; sceneId: StringValidator; subtitle: StringValidator; title: StringValidator }, "image" | "experienceId" | "sceneId", false> = jointz.object({experienceId: jointz.string(),sceneId: jointz.string(),title: jointz.string(),subtitle: jointz.string(),image: jointz.string(),filters: jointz.array(configurationFilterValidator),}).requiredKeys(['experienceId', 'sceneId', 'image'])

Object literals

Const analyticsEvents

analyticsEvents: object

property names are assigned to action

evenParamsPaths are serialized into label (and delimited with ':')

applicationHotspotClicked

applicationHotspotClicked: object

category

category: string = "appplications"

eventParamsPaths

eventParamsPaths: string[] = ['application.application']

applicationsStripButtonClicked

applicationsStripButtonClicked: object

category

category: string = "appplications"

eventParamsPaths

eventParamsPaths: string[] = ['application.application']

applicationsStripOpened

applicationsStripOpened: object

category

category: string = "appplications"

eventParamsPaths

eventParamsPaths: undefined[] = []

closeFullscreenClicked

closeFullscreenClicked: object

category

category: string = "visualizer"

eventParamsPaths

eventParamsPaths: undefined[] = []

favoriteSceneClicked

favoriteSceneClicked: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: undefined[] = []

favoritesPanelClosed

favoritesPanelClosed: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: undefined[] = []

favoritesPanelOpened

favoritesPanelOpened: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: undefined[] = []

favoritesSceneDisplayed

favoritesSceneDisplayed: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: string[] = ['scene.scene.sceneId', 'scene.scene.title', 'scene.subtitle']

fullscreenClicked

fullscreenClicked: object

category

category: string = "visualizer"

eventParamsPaths

eventParamsPaths: undefined[] = []

orderSample

orderSample: object

category

category: string = "conversion"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

productAddedToCart

productAddedToCart: object

category

category: string = "conversion"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

productAddedToFavorites

productAddedToFavorites: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

productChanged

productChanged: object

category

category: string = "products"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

productRemovedFromFavorites

productRemovedFromFavorites: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

sceneAddedToFavorites

sceneAddedToFavorites: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: string[] = ['scene.scene.sceneId', 'scene.scene.title', 'scene.subtitle']

sceneLoaded

sceneLoaded: object

category

category: string = "scenes"

eventParamsPaths

eventParamsPaths: string[] = ['scene.sceneId', 'scene.title', 'scene.subtitle']

sceneLoading

sceneLoading: object

category

category: string = "scenes"

eventParamsPaths

eventParamsPaths: string[] = ['scene.sceneId', 'scene.title', 'scene.subtitle']

sceneRemovedFromFavorites

sceneRemovedFromFavorites: object

category

category: string = "favorites"

eventParamsPaths

eventParamsPaths: string[] = ['scene.scene.sceneId', 'scene.scene.title', 'scene.subtitle']

sceneTouched

sceneTouched: object

category

category: string = "visualizer"

eventParamsPaths

eventParamsPaths: string[] = ['scene.sceneId', 'scene.title', 'scene.subtitle']

scenesPanelClosed

scenesPanelClosed: object

category

category: string = "scenes"

eventParamsPaths

eventParamsPaths: undefined[] = []

scenesPanelOpened

scenesPanelOpened: object

category

category: string = "scenes"

eventParamsPaths

eventParamsPaths: undefined[] = []

summaryClicked

summaryClicked: object

category

category: string = "visualizer"

eventParamsPaths

eventParamsPaths: string[] = ['scene.scene.sceneId', 'scene.scene.title', 'scene.subtitle']

userChangedProduct

userChangedProduct: object

category

category: string = "products"

eventParamsPaths

eventParamsPaths: string[] = ['product.sku', 'product.title']

visualizerLoaded

visualizerLoaded: object

category

category: string = "visualizer"

eventParamsPaths

eventParamsPaths: string[] = ['visualizer.experienceId']

Generated using TypeDoc