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

openGalleryForBackground Method

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

Callable

  • openGalleryForBackground(params?: object ) : Promise < void >

  • Opens the Asset Manager to select an image for the background layer.

    example
    let editor = await CustomersCanvas.IframeApi.loadEditor(iframe, product, config);
editor.openGalleryForBackground({ tabs: ["Backgrounds"] });

    Parameters

    • Optional params: object

      Parameters defining the appearance of the Asset Manager.

      • Optional tabs: string []

        An array of tabs available for selecting images.

    Returns Promise < void >