View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

loadEditorByQueryString Function

Applies to: Customer's Canvas On-Premises; Design Editor 4.4.25, 4.x (may differ) · Archived documentation

Callable

  • loadEditorByQueryString(editorFrame: HTMLIFrameElement, queryString: string, onFirstLoad?: function ) : Promise < Editor >

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

    Parameters

    • editorFrame: HTMLIFrameElement

      The iframe element to place the editor to.

    • queryString: string

      Arguments configuring the editor. For details, see the Old Query-string API topic.

    • Optional onFirstLoad: function

      A function that handles the first product launch. For details, see The Product Loading Screen topic.

        • ( ) : void

        • Returns void

    Returns Promise < Editor >