Engine Configuration Settings of PhotoEditor SDK

In this example, we will show you how to configure the PhotoEditor SDK.

Engine Configuration#

The PE.SDK comes with a set of configuration parameters that let's you restrict the maximum dimensions of the loaded image.

crossOrigin#

Sets the global crossOrigin loading mode. Available are anonymous, use-credentials or none.

downscaleOptions#

Images whose sizes exceed these megapixel limits will be downscaled by the engine.

maxMegaPixels#

Specifies the maximum amount of megapixels per device type.

desktop#

Limits the maximum megapixels on a desktop device.

mobile#

Limits the maximum megapixels on a mobile device.

maxDimensions#

Specifies max height or width for the image.

height#

Defaults to height of given image

width#

Defaults to width of given image

backgroundColor#

Defines a color for the background of the image if the image contains transparency. Default color is black.


PhotoEditorSDK.PhotoEditorSDKUI.init({
  license: '',
  container: '#editor',
  image: 'https://cdn.img.ly/...',
  engine: {
    crossOrigin: 'anonymous',
    downscaleOptions: {
      maxMegaPixels: {
        desktop: 10,
        mobile: 5,
      },
      maxDimensions: {
        height: 1920,
        width: 1080,
      },
    },
    backgroundColor: [0,0,0,0],
  },
});