WatermarkOptions

Configurations of the watermark image.

export class WatermarkOptions {
  
  visibleInPreview?: boolean;
  
  positionInLandscapeMode?: Rectangle;
  
  positionInPortraitMode?: Rectangle;
  
  watermarkRatio?: WatermarkRatio;
  
  mode?: WatermarkFitMode;
}

Attributes

visibleInPreview
Is the watermark visible in the local preview view?
  • true: (Default) The watermark is visible in the local preview view.
  • false: The watermark is not visible in the local preview view.
positionInLandscapeMode
When the adaptation mode of the watermark is FitModeCoverPosition, it is used to set the area of the watermark image in landscape mode. See Rectangle.
positionInPortraitMode
When the adaptation mode of the watermark is FitModeCoverPosition, it is used to set the area of the watermark image in portrait mode. See Rectangle.
watermarkRatio
When the watermark adaptation mode is FitModeUseImageRatio, this parameter is used to set the watermark coordinates. See WatermarkRatio.
mode
The adaptation mode of the watermark. See WatermarkFitMode.