Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IVisualizer

Hierarchy

  • IVisualizer

Index

Methods

Abstract GetApplicationsList

  • will return applications available on this experience

    Returns Array<IApplication>

Abstract GetCurrentApplication

Abstract GetCurrentFilters

  • GetCurrentFilters(): Array<IFilter>
  • will return the current filters

    Returns Array<IFilter>

Abstract GetFilters

  • will return the available filters

    Returns Array<IFilter>

Abstract GetProductList

  • will return products list according to the current application and filters

    Returns Array<IProduct>

Abstract GetSceneCurrentFilters

  • GetSceneCurrentFilters(): Array<IFilter>
  • will return the current scene filters

    Returns Array<IFilter>

Abstract GetSceneFilters

  • GetSceneFilters(): Array<IFilter>
  • will return the available scene filters

    Returns Array<IFilter>

Abstract SetCurrentApplication

Abstract SetFilter

  • will set the current filters

    Parameters

    • filters: Array<IFilter>

      the filters to set

    Returns Array<IFilter>

Abstract SetSceneFilter

  • will set the current scene filters

    Parameters

    • filters: Array<IFilter>

      the scene filters to set

    Returns Array<IFilter>

Abstract addFavoriteScene

  • will add a scene to favorites will emit a "sceneAddedToFavorites" event

    Returns Promise<IFavoriteSceneList>

Abstract addProductToCart

  • addProductToCart(product: IProduct): void
  • will emit a "productAddedToCart" event

    Parameters

    Returns void

Abstract addProductToFavorites

  • will add a product to favorites will emit a "productAddedToFavorites" event

    Parameters

    Returns IFavoriteProductList

Abstract displayProduct

  • displayProduct(productSku: string, application: IApplication): Promise<void>
  • will set a product on a specific application will emit a "productChanged" event after complete

    Parameters

    Returns Promise<void>

Abstract displayScene

  • displayScene(setId: string): Promise<void>
  • will display a saved scene will emit a "sceneDisplayed" event after complete

    Parameters

    • setId: string

    Returns Promise<void>

Abstract getDisplayedProduct

  • will return the product displayed on an application in the current scene

    Parameters

    Returns IProduct

Abstract getDisplayedProducts

  • getDisplayedProducts(): Array<IProduct>
  • will return all displayed products in the current scene

    Returns Array<IProduct>

Abstract getFavoriteProducts

Abstract getFavoriteScenes

Abstract getSceneList

  • getSceneList(): Array<IScene>
  • will return the scene list available in this experience

    Returns Array<IScene>

Abstract initAndLoad

  • initAndLoad(): any
  • start and load the visualizer app, will be triggered automatically on [data-role="visualizer"] elements after complete will emit a "visualizerLoaded" event

    Returns any

Abstract orderSample

  • will emit a "orderSample" event

    Parameters

    Returns void

Abstract removeFavoriteScene

  • will remove a scene from favorites will emit a "sceneRemovedFromFavorites" event

    Parameters

    • setId: string

    Returns IFavoriteSceneList

Abstract removeProductFromFavorites

  • will remove a product from favorites will emit a "productRemovedFromFavorites" event

    Parameters

    Returns IFavoriteProductList

Abstract setScene

  • setScene(sceneId: string): Promise<void>
  • will set the current scene after complete will emit a "sceneLoaded" event

    Parameters

    • sceneId: string

      the sceneId to lunch

    Returns Promise<void>

Generated using TypeDoc