Variable: editorUrl

editorUrl: string

URL to your Customer's Canvas instance.

Remarks

Typically, you do not have to specify this URL explicitly. If you add id="CcIframeApiScript" to the script tag which links the IframeApi.js, Design Editor 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 Design Editor instance explicitly.

Example

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

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

<script>
  //....
  const editor = await CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition);
</script>