Interface MxtModularConfiguratorOptions

Hierarchy

  • MxtModularConfiguratorOptions

Properties

apiKey assetEnvironment callbacks? camera? customIcons? customText? defaultProductLoad? disableProgressiveLoad? element fitToScreenMultiplier? font? initialProjectCode? loadModifiers? loadPaused? logging? maxDistanceMultiplier? menuId? plugins? pricingAndAvailability? primaryColor? productDetail? responsive? rotateDelta? screenshot? services? unitType? zoomDelta?

Methods

addToCart

Properties

apiKey

apiKey: string

private access key to spins

assetEnvironment

assetEnvironment: MxtAssetEnvironment

The environment to pull assets from

Optional callbacks

callbacks?: {
    onFullscreenEnter?: (() => void);
    onFullscreenExit?: (() => void);
}

Type declaration

  • Optional onFullscreenEnter?: (() => void)
      • (): void

      • Returns void

  • Optional onFullscreenExit?: (() => void)
      • (): void

      • Returns void

Optional camera

camera?: {
    allowPanning?: boolean;
    defaultAlpha?: number;
    defaultBeta?: number;
    embeddedReflectionCubeTextureUrls?: {
        nx: string;
        ny: string;
        nz: string;
        px: string;
        py: string;
        pz: string;
    };
    fieldOfView?: number;
    lighting?: Lighting;
    lowerAlphaLimit?: number;
    lowerBetaLimit?: number;
    upperAlphaLimit?: number;
    upperBetaLimit?: number;
}

Advanced camera options

Type declaration

  • Optional allowPanning?: boolean
  • Optional defaultAlpha?: number
  • Optional defaultBeta?: number
  • Optional embeddedReflectionCubeTextureUrls?: {
        nx: string;
        ny: string;
        nz: string;
        px: string;
        py: string;
        pz: string;
    }
    • nx: string
    • ny: string
    • nz: string
    • px: string
    • py: string
    • pz: string
  • Optional fieldOfView?: number
  • Optional lighting?: Lighting

    Lighting app config; only applicable when using spins in a stand-alone context; from within product config or other application, use manifest app config to set lighting config

  • Optional lowerAlphaLimit?: number
  • Optional lowerBetaLimit?: number
  • Optional upperAlphaLimit?: number
  • Optional upperBetaLimit?: number

Optional customIcons

customIcons?: {
    place?: MxtModularConfigPlacingIcons;
}

Type declaration

Optional customText

customText?: {
    [language: string]: any;
}

Type declaration

  • [language: string]: any

Optional defaultProductLoad

defaultProductLoad?: {
    product?: Product;
    productConfigSku?: {
        productId: string;
        skuOverride: string[];
    };
    productId?: string;
    productIdAndAssembly?: {
        assembly: {
            productId: string;
            stepType: string;
        }[];
        productId: string;
    };
    sku?: string;
    skuAndAssembly?: {
        assembly: {
            sku: string;
            stepType: string;
        }[];
        sku: string;
    };
}

Options around the default product to load, only provide one of the following

Type declaration

  • Optional product?: Product
  • Optional productConfigSku?: {
        productId: string;
        skuOverride: string[];
    }
    • productId: string
    • skuOverride: string[]
  • Optional productId?: string
  • Optional productIdAndAssembly?: {
        assembly: {
            productId: string;
            stepType: string;
        }[];
        productId: string;
    }
    • assembly: {
          productId: string;
          stepType: string;
      }[]
    • productId: string
  • Optional sku?: string
  • Optional skuAndAssembly?: {
        assembly: {
            sku: string;
            stepType: string;
        }[];
        sku: string;
    }
    • assembly: {
          sku: string;
          stepType: string;
      }[]
    • sku: string

Optional disableProgressiveLoad

disableProgressiveLoad?: boolean

disable the progressive loading if true

element

element: HTMLElement

Element to place the spins inside of

Optional fitToScreenMultiplier

fitToScreenMultiplier?: number

Multiplier; amount of space product takes up in screen by default; defaults to 1.2 (leaves 20% of space on edges).

Optional font

font?: {
    color?: IColor3;
    family?: string;
    sizeBody?: string | number;
    sizeBodyLg?: string | number;
    sizeBodySm?: string | number;
    sizeBodyXs?: string | number;
    sizeHeader?: string | number;
    sizeHeaderLg?: string | number;
    sizeSubHeader?: string | number;
}

Type declaration

  • Optional color?: IColor3

    RGB values 0-255

  • Optional family?: string

    Reflects CSS font-family, assuming values are browser-supported or already imported

  • Optional sizeBody?: string | number
  • Optional sizeBodyLg?: string | number
  • Optional sizeBodySm?: string | number
  • Optional sizeBodyXs?: string | number
  • Optional sizeHeader?: string | number
  • Optional sizeHeaderLg?: string | number

    Number values are treated as pixels, otherwise as string unit values

  • Optional sizeSubHeader?: string | number

Optional initialProjectCode

initialProjectCode?: string

Code to load into the scene on startup

Optional loadModifiers

loadModifiers?: IProductLoadModifierPlugin[]

provides client-specific way of modifying the load of a product

Optional loadPaused

loadPaused?: boolean

If true, init will NOT start the renderer. Use this if you want to create the spin viewer prior to actually displaying it. Use .run() to start the renderer

Optional logging

logging?: LogLevel

Log level; defaults to WARN (3)

Optional maxDistanceMultiplier

maxDistanceMultiplier?: number

Multiplier; How much you can zoom out past the initial zoom. Defaults to 2. A value of 1 would mean that the initial zoom distance is the farthest you can zoom out

Optional menuId

menuId?: string

ID to match menu data; use this if you have multiple different categories of products and you need to specify which one

Optional plugins

plugins?: IPlugin[]

Optional pricingAndAvailability

pricingAndAvailability?: {
    hidePricing?: boolean;
    showAvailability?: boolean;
}

Type declaration

  • Optional hidePricing?: boolean
  • Optional showAvailability?: boolean

Optional primaryColor

primaryColor?: IColor3

Primary color, rgb 0->255

Optional productDetail

productDetail?: {
    descriptionLineHeight?: number;
}

Type declaration

  • Optional descriptionLineHeight?: number

Optional responsive

responsive?: {
    minDesktopWidth?: number;
}

Type declaration

  • Optional minDesktopWidth?: number

Optional rotateDelta

rotateDelta?: number

Rotate Delta - in radians; defaults to .3

Optional screenshot

screenshot?: MxtModularConfigScreenshotOptions

Return the name to give the screenshot

Param

Optional services

services?: {
    environment?: MSServiceEnvironment;
}

Type declaration

  • Optional environment?: MSServiceEnvironment

Optional unitType

unitType?: UnitType

Unit type to display values in

Optional zoomDelta

zoomDelta?: number

Zoom Delta - in meters; defaults to .3

Methods

addToCart

Settings

Member Visibility

Theme

Generated using TypeDoc