Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExportConfiguration

Hierarchy

  • ExportConfiguration

Index

Properties

Properties

Optional filename

filename: string | null

The filename for the exported data if the exportType is not ImageExportType.DATA_URL. The correct filename extension will be automatically added based on the selected export format. It can be an absolute path or file URL or a relative path. If some relative path is chosen it will be created in a temporary system directory and overwritten if the corresponding file already exists. If the value is null an new temporary file will be created for every export.

example

// Defaults to:

'photoeditorsdk-export'

Optional image

image: { enableDownload?: boolean; exportType?: ExportFormat; format?: ImageFormat; quality?: number }

Image export configuration if the editor supports image editing.

Type declaration

  • Optional enableDownload?: boolean
  • Optional exportType?: ExportFormat
    example

    // Defaults to:

    ExportFormat.Image
  • Optional format?: ImageFormat

    The image file format of the generated high resolution image.

    example

    // Defaults to:

    ImageFormat.JPEG
  • Optional quality?: number

    The compression quality to use when creating the output image with a lossy file format.

    example

    // Defaults to:

    0.9

Optional serialization

serialization: { embedSourceImage?: boolean; enabled?: boolean; exportType?: SerializationExportType; filename?: string | null }

Export configuration of the serialized image editing operations that were applied to the input media loaded into the editor. This also allows to recover these operations the next time the editor is opened again.

Type declaration

  • Optional embedSourceImage?: boolean

    Whether the serialization data should include the original input image data.

    example

    // Defaults to:

    false
  • Optional enabled?: boolean

    Whether the serialization of the editing operations should be exported.

    example

    // Defaults to:

    false
  • Optional exportType?: SerializationExportType
    example

    // Defaults to:

    SerializationExportType.FILE_URL
  • Optional filename?: string | null

    The filename for the exported serialization data if the exportType is SerializationExportType.FILE_URL. The filename extension for JSON will be automatically added. It can be an absolute path or file URL or a relative path. If some relative path is chosen it will be created in a temporary system directory and overwritten if the corresponding file already exists. If the value is null an new temporary file will be created for every export based on the filename for the exported image data.

    example

    // Defaults to:

    null