IframeApi Module

The API module. It provides data and methods for a product handling.

Modules

Name Description
Configuration

The Customer's Canvas configuration. These settings are defined in the ~\Configuration\clientConfig.json file. You can find an example of this file in the corresponding topic.

ObjectModel

Object model of Customer's Canvas product.

PostMessage

This module carries out the Events processing.

Classes

Name Description
Editor

Represents the web-to-print editor.

RuntimeConfiguration

Allows you to get/set the user ID and PDF metadata at runtime.

Functions

Name Description
loadEditor

Loads the web-to-print editor.

loadEditorByQueryString

Outdated, use loadEditor instead. Loads the web-to-print editor through HTTP GET request.

Variables

editorUrl

editorUrl: string

URL to your Customer's Canvas instance.

Typically, you do not have to specify this URL explicitly. If you add id="CcIframeApiScript" to the script tag which links the IframeApi.js, Customer's Canvas automatically detects this URL from the script source. However, if for any reasons you do not want to use the id in the script tag, you can use this property to specify the URL to the Customer's Canvas instance explicitly.

example
<script> 
    CustomersCanvas = {
        IframeApi: {
            editorUrl: "http://example.com/" 
        }
    }; 
</script> 

<script type="text/javascript" src="http://example.com/Resources/SPEditor/Scripts/IFrame/IframeApi.js">
</script>

<script>
    //....
    var editor = null;
    CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition)
        .then(function(e) {
            editor = e
        });
</script>