Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

IConstants

IConstants: { cssVariables: ICssVariables; download: IConstantsDownload; fullscreen: IConstantsFullscreen; general: ICustomGeneral; hotspot_area_tooltip: IHotspotAreaTooltip; hotspot_points: IHotspotPoints; menu: IConstantsMenu; mobileMenu: IConstantsMobileMenu; panels: IConstantsPanels }

for each section in the ui u can customize labels, titles and icons all optional

Type declaration

IConstantsButtons

IConstantsButtons: { add_to_cart: { label: ILabel; visible: boolean }; cancel: { label: ILabel }; clear: { label: ILabel }; fullscreen: { icon: ICustomIcon; visible: boolean }; fullscreen_exit: { icon: ICustomIcon; visible: boolean }; order_sample: { label: ILabel; visible: boolean }; save_product: { icon: ICustomIcon; icon_selected: ICustomIcon; visible: boolean }; save_scene: { icon: ICustomIcon; icon_selected: ICustomIcon; label: string; visible: boolean } }

Type declaration

  • add_to_cart: { label: ILabel; visible: boolean }
    • label: ILabel
    • visible: boolean

      will hide/show the ui element - default: true

  • cancel: { label: ILabel }
  • clear: { label: ILabel }
  • fullscreen: { icon: ICustomIcon; visible: boolean }
    • icon: ICustomIcon
    • visible: boolean

      will hide/show the ui element - default: true

  • fullscreen_exit: { icon: ICustomIcon; visible: boolean }
    • icon: ICustomIcon
    • visible: boolean

      will hide/show the ui element - default: true

  • order_sample: { label: ILabel; visible: boolean }
    • label: ILabel
    • visible: boolean

      will hide/show the ui element - default: true

  • save_product: { icon: ICustomIcon; icon_selected: ICustomIcon; visible: boolean }
  • save_scene: { icon: ICustomIcon; icon_selected: ICustomIcon; label: string; visible: boolean }
    • icon: ICustomIcon
    • icon_selected: ICustomIcon
    • label: string
    • visible: boolean

      will hide/show the ui element - default: true

IConstantsDownload

IConstantsDownload: { copyright: { label: ILabel; visible: boolean }; logo: { icon: ICustomIcon; visible: boolean }; save_button: { label: ILabel }; width: number }

Type declaration

  • copyright: { label: ILabel; visible: boolean }
    • label: ILabel

      the label of the copyright in the download page

    • visible: boolean

      will hide/show the ui element - default: true

  • logo: { icon: ICustomIcon; visible: boolean }
    • icon: ICustomIcon
    • visible: boolean

      will hide/show the ui element - default: true

  • save_button: { label: ILabel }
  • width: number

    width of the downloaded image in px as a number

IConstantsFullscreen

IConstantsFullscreen: { element: { selector: string } }

Type declaration

  • element: { selector: string }
    • selector: string

IConstantsMenu

IConstantsMenu: { favorites: ICustomMenu; saveScene: ICustomMenu; scenes: ICustomMenu; summary: ICustomMenu }

Type declaration

IConstantsMobileMenu

IConstantsMobileMenu: { editScene: { icon: ICustomIcon; label: ILabel; visible: boolean }; openMenu: { icon: ICustomIcon; visible: boolean } }

Type declaration

IConstantsPanels

IConstantsPanels: { download: { title: ILabel }; favorites: { empty_icon: ICustomIcon; empty_label: ILabel; empty_sublabel: ILabel; title: ILabel }; products: { empty_label: ILabel; filters: { visibleAtFirst: boolean }; headers: { hotspots: { label: ILabel }; products: { label: ILabel } }; keep_open: boolean; portraitTitle: { label: ILabel }; product: IProduct }; savedScenes: { empty_icon: ICustomIcon; empty_label: ILabel; empty_sublabel: ILabel; title: ILabel }; scenes: { level1: { title: ILabel }; level2: { title: ILabel } } }

Type declaration

  • download: { title: ILabel }
  • favorites: { empty_icon: ICustomIcon; empty_label: ILabel; empty_sublabel: ILabel; title: ILabel }
    • empty_icon: ICustomIcon

      the icon that will be shown when there are no favorites

    • empty_label: ILabel

      the label that will be shown when there are no favorites

    • empty_sublabel: ILabel

      the subtitle that will be shown when there are no favorites

    • title: ILabel

      the title of the favorite panel

  • products: { empty_label: ILabel; filters: { visibleAtFirst: boolean }; headers: { hotspots: { label: ILabel }; products: { label: ILabel } }; keep_open: boolean; portraitTitle: { label: ILabel }; product: IProduct }
    • empty_label: ILabel
    • filters: { visibleAtFirst: boolean }
      • visibleAtFirst: boolean

        default to open filters

    • headers: { hotspots: { label: ILabel }; products: { label: ILabel } }
    • keep_open: boolean
    • portraitTitle: { label: ILabel }
    • product: IProduct
  • savedScenes: { empty_icon: ICustomIcon; empty_label: ILabel; empty_sublabel: ILabel; title: ILabel }
    • empty_icon: ICustomIcon

      the icon that will be shown when there are no favorites

    • empty_label: ILabel

      the label that will be shown when there are no favorites

    • empty_sublabel: ILabel

      the subtitle that will be shown when there are no favorites

    • title: ILabel

      the title of the favorite panel

  • scenes: { level1: { title: ILabel }; level2: { title: ILabel } }
    • level1: { title: ILabel }

      display scenes panel on visualizer start

    • level2: { title: ILabel }

ICssVariables

ICssVariables: {}

Type declaration

  • [cssVariable: string]: string

ICustomDropdowns

ICustomDropdowns: { check_container: { icon: ICustomIcon; icon_selected: ICustomIcon }; trigger: { icon: ICustomIcon; icon_selected: ICustomIcon; visible: boolean } }

Type declaration

ICustomGeneral

ICustomGeneral: { buttons: IConstantsButtons; dropdowns: ICustomDropdowns; loader: { icon: ICustomIcon; lottie?: { src: string; style?: { height: string; width: string } }; visible?: boolean }; powered_by: { icon: ICustomIcon; visible: boolean }; search_placeholder: string }

Type declaration

  • buttons: IConstantsButtons
  • dropdowns: ICustomDropdowns
  • loader: { icon: ICustomIcon; lottie?: { src: string; style?: { height: string; width: string } }; visible?: boolean }
    • icon: ICustomIcon
    • Optional lottie?: { src: string; style?: { height: string; width: string } }
      • src: string
      • Optional style?: { height: string; width: string }
        • height: string
        • width: string
    • Optional visible?: boolean
  • powered_by: { icon: ICustomIcon; visible: boolean }
  • search_placeholder: string

ICustomIcon

ICustomIcon: { Icon: VNode; style?: { height?: string; width?: string }; url: string }

Type declaration

  • Icon: VNode
  • Optional style?: { height?: string; width?: string }

    width in pixels like 100px

    • Optional height?: string

      height in pixels like 100px

    • Optional width?: string
  • url: string
    param

    the url/path to an svg

ICustomMenu

ICustomMenu: { icon: ICustomIcon; label: ILabel; visible: boolean }

Type declaration

  • icon: ICustomIcon
  • label: ILabel

    the label of the menu item

  • visible: boolean

    will hide/show the ui element - default: true

IHotspotAreaTooltip

IHotspotAreaTooltip: { visible: boolean }

Type declaration

  • visible: boolean

IHotspotPointLabel

IHotspotPointLabel: { visible: boolean }

Type declaration

  • visible: boolean

    will hide/show the label of hotspot point - default: true

IHotspotPoints

IHotspotPoints: { idle_timeout_ms: number; label: IHotspotPointLabel }

Type declaration

  • idle_timeout_ms: number

    time of inactivity after which the hotspots disappear

  • label: IHotspotPointLabel

    the label of hotspot point

ILabel

ILabel: string | { style: {}; text: string }

IProduct

IProduct: { title: { desktop: { visible: boolean }; landscape: { visible: boolean }; portrait: { visible: boolean } } }

Type declaration

  • title: { desktop: { visible: boolean }; landscape: { visible: boolean }; portrait: { visible: boolean } }
    • desktop: { visible: boolean }
      • visible: boolean
    • landscape: { visible: boolean }
      • visible: boolean
    • portrait: { visible: boolean }
      • visible: boolean

Generated using TypeDoc