FitPhoto Developer Documentation

JSDoc reference

Class Fb.FitPhoto

Method Attributes Method Name and Description
 
GetImageURL(pDownload)
Get URL of composed image
<static>  
Fb.FitPhoto.GetInstance(pConfig)
 
Remove FitPhoto
 
SetFrame(pSkunumber)
Set frame id for try on

Method Detail

{String} GetImageURL(pDownload)
Get URL of composed image
Parameters:
{Boolean} pDownload Optional
URL with force-download header
Returns:
{String}

<static> {Object} Fb.FitPhoto.GetInstance(pConfig)
Parameters:
{JSON} pConfig
Global config used by the class and referenced classes
{JSON} pConfig.FitPhoto
Local config used by the class only
{String|DOM Element} pConfig.FitPhoto.container
DOM element or element id where the product has to be
{Integer} pConfig.FitPhoto.width Optional, Default: 315
Width of the product
{Integer} pConfig.FitPhoto.height Optional, Default: 420
Height of the product
{String} pConfig.FitPhoto.language Optional, Default: 'en'
Application language
{String} pConfig.FitPhoto.css Optional
Custom CSS file
{String} pConfig.FitPhoto.zoommode Optional, Default: 'popup'
Zoom mode (values: 'inner'|'magnifier'|'popup')
{JSON} pConfig.FitPhoto.messages Optional
Custom messages
{JSON} pConfig.FitPhoto.messages.fr Optional
Custom french messages
{String} pConfig.FitPhoto.messages.fr.MenuModelsTitle Optional
Custom message for menu model title
{Boolean} pConfig.FitPhoto.menualwaysopened Optional, Default: false
Define if menu is always opened or not
{Boolean} pConfig.FitPhoto.standardmodels Optional, Default: true
Define standard models loading
{Array of JSON} pConfig.FitPhoto.models Optional
Custom models
{Integer} pConfig.FitPhoto.cookieduration Optional, Default: 30
Duration of cookie (in days)
{String} pConfig.FitPhoto.watermark Optional, Default: 'default'
Absolute URL for watermark image file or 'none'
{Function} pConfig.FitPhoto.onCallToActionClick Optional
Function called when callToAction element is clicked
Returns:
{Object} Fb.FitPhoto instance

Remove()
Remove FitPhoto

SetFrame(pSkunumber)
Set frame id for try on
Parameters:
{String} pSkunumber