WatermarkOptions

Configure watermark image.

export class WatermarkOptions {

  visibleInPreview?: boolean;

  positionInLandscapeMode?: Rectangle;

  positionInPortraitMode?: Rectangle;

  watermarkRatio?: WatermarkRatio;

  mode?: WatermarkFitMode;

  zOrder?: number;
}

Used to configure the watermark image to be added.

Properties

visibleInPreview
Whether the watermark is 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 watermark fit mode is FitModeCoverPosition, this sets the watermark image area in landscape mode. See Rectangle.
positionInPortraitMode
When the watermark fit mode is FitModeCoverPosition, this sets the watermark image area in portrait mode. See Rectangle.
watermarkRatio
When the watermark fit mode is FitModeUseImageRatio, this parameter sets the watermark coordinates in scaling mode. See WatermarkRatio.
mode
Watermark fit mode. See WatermarkFitMode.
zOrder
Z-order of the watermark image. The default value is 0.