API

Properties

• {{host}} -- domain where your script is hosted (eg, "tenant.solidworks-sell.com")
• /*iframeid*/ -- id of your widget iframe (eg, "swsellwidget") [REQUIRED]
• /*product*/ -- unique identifier of your product (eg, "eyeglasses", "123ABC") [REQUIRED]
• /*customer*/ -- unique identifier of your customer (eg, cart id, user id, session id) [REQUIRED]
• /*template*/ -- unique id, name or template url slug in your SOLIDWORKS Sell environment [REQUIRED]
• /*selection*/ -- object highlighting true/false [OPTIONAL]

HTML SETUP

    <!-- START place between BODY element -->
        <iframe id='/*iframeid*/' width='650' height='650' frameborder='0' scrolling='no' src="//{{host}}/client/widget">
        </iframe>
        <ul data-controls="groups"></ul>
        <ul data-controls="options"></ul>
        <ul data-controls="parts"></ul>
        <ul data-controls="materials"></ul>
        <script src="//{{host}}/widget/api.js"></script>
        <script type="text/javascript">
            SWSELL.init(
                {iframeid: /*iframeid*/, 
                 product: /*product*/, 
                 customer: /*customer*/, 
                 template: /*template*/, 
                 selection: /*true/false*/
                 }
            );
        </script>
    <!-- END place between BODY element -->

HTML SETUP -- "Tooling" Controls

The following DOM elements can be added to your page to implement tooling controls:

• toggleThreeSixty -- toggles 360 degree animation
• toggleRulerVisible -- toggles the ruler visible
  • use with toggleUnitOfLength -- imperial/metric indicator
• setView -- sets the view (requires data attribute 'data-view')
• showHelpVideo -- help I need someone, not just anyone
• history buttons -- for undo, redo and reset
• fullScreen -- because I have bad eyesight
• arQuickLook -- "AR" button for AR-enabled templates

Examples:

    <div class="toggleThreeSixty"></div>

    <div class="toggleRulerVisible"></div>
    <div class="toggleUnitOfLength action-btn-unit-system imperial"></div>

    <div data-view="X-" class="setView"></div>
    <div data-view="Z+" class="setView"></div>
    <div data-view="X+" class="setView"></div>
    <div data-view="Y+" class="setView"></div>
    <div data-view="Default" class="setView"></div>
    <div data-view="Z-" class="setView"></div>

    <div class="showHelpVideo">HELP</div>

     <div class="historyButton undo">UNDO</div>
     <div class="reset"></div>
     <div class="historyButton redo">REDO</div>

     <div class="fullScreen"></div>

     <a class="arQuickLook"></a>

API Functions

• init(options) -- initializes widget and binds control elements

JavaScript

SWSELL.init({
    iframeid: /*iframeid*/,
    product: /*product*/,
    customer: /*customer*/,
    template: /*template*/,
    selection: /*true/false*/
});

* reloadWidget(options) -- same options as init(), but reinitializes the widget iframe (eg, switching templates). Note: To transfer configurations between templates that share the same materials, you would need to implement the 'transferConfig:true' setting:

JavaScript

SWSELL.reloadWidget(
    {template:/*template*/,
     customer:/*customer*/, 
     product:/*product*/,
     transferConfig: true}
);

• getBOM -- getter for the Bill of Materials of the current, in scene, configuration
  • Optionally, you can query the BOM for a specific group with a {group: "group-name"} object

JavaScript

SWSELL.getBOM(/*optional group query*/);

randomize -- fun for the kiddos!

JavaScript

SWSELL.randomize();

* takeSnapshot -- "camera" screen-grab control * requires an event listener(https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) for the 'takesnapshot' message

JavaScript

SWSELL.takeSnapshot();

* order(options) -- place an order (default:true). This is also available via the Server API. * options not required; returns an orderId

JavaScript

SWSELL.order({isTest:/*true/false*/});

* orderConfirm -- use this to confirm your order. This is also available via the Server API.

JavaScript

SWSELL.orderConfirm({orderId:/*orderId from above*/})

* orderCancel -- use this to cancel your order. This is also available via the Server API.

JavaScript

SWSELL.orderCancel({orderId:/*orderId from above*/})

* toggleSelection -- Deprecated? * getView()/setView({view}) -- Programmatically allows you to get a view and come back to that view

JavaScript

var view = await SWSELL.getView();
SWSELL.setView(view);

• exportSceneAsGLTF -- downloads a GLTF binary resource in your browser

JavaScript

SWSELL.exportSceneAsGLTF({binary:true});

* fullScreen -- Expands page to full screen

JavaScript

SWSELL.fullScreen();