CPDFWatermark.image constructor

CPDFWatermark.image({
  1. required String imagePath,
  2. required List<int> pages,
  3. double scale = 1.0,
  4. double rotation = 45.0,
  5. double opacity = 1.0,
  6. CPDFWatermarkVerticalAlignment verticalAlignment = CPDFWatermarkVerticalAlignment.center,
  7. CPDFWatermarkHorizontalAlignment horizontalAlignment = CPDFWatermarkHorizontalAlignment.center,
  8. double verticalOffset = 0.0,
  9. double horizontalOffset = 0.0,
  10. bool isFront = true,
  11. bool isTilePage = false,
  12. double horizontalSpacing = 0.0,
  13. double verticalSpacing = 0.0,
})

Image watermark constructor

This constructor creates an image watermark with customizable properties.

  • imagePath: The file path of the image to be used as the watermark. (Required)
  • pages: A list of page indices where the watermark should be applied, e.g., 0, 1, 2, 3 represents pages 1 through 4. (Required)
  • scale: The scaling factor for the image. Default is 1.0.
  • rotation: The rotation angle of the watermark in degrees. Default is 45.0.
  • opacity: The transparency of the watermark, where 1.0 is fully opaque and 0.0 is fully transparent. Default is 1.0.
  • verticalAlignment: The vertical alignment of the watermark on the page. Default is CPDFWatermarkVerticalAlignment.center.
  • horizontalAlignment: The horizontal alignment of the watermark on the page. Default is CPDFWatermarkHorizontalAlignment.center.
  • verticalOffset: The vertical offset of the watermark relative to the alignment position. Default is 0.0.
  • horizontalOffset: The horizontal offset of the watermark relative to the alignment position. Default is 0.0.
  • isFront: Whether the watermark should appear in front of the page content. Default is true.
  • isTilePage: Whether the watermark should be tiled across the page. Default is false.
  • horizontalSpacing: The horizontal spacing between tiled watermarks. Default is 0.0.
  • verticalSpacing: The vertical spacing between tiled watermarks. Default is 0.0.

Implementation

CPDFWatermark.image({
  required String imagePath,
  required List<int> pages,
  double scale = 1.0,
  double rotation = 45.0,
  double opacity = 1.0,
  CPDFWatermarkVerticalAlignment verticalAlignment =
      CPDFWatermarkVerticalAlignment.center,
  CPDFWatermarkHorizontalAlignment horizontalAlignment =
      CPDFWatermarkHorizontalAlignment.center,
  double verticalOffset = 0.0,
  double horizontalOffset = 0.0,
  bool isFront = true,
  bool isTilePage = false,
  double horizontalSpacing = 0.0,
  double verticalSpacing = 0.0,
}) : this(
        type: CPDFWatermarkType.image,
        imagePath: imagePath,
        pages: pages,
        scale: scale,
        rotation: rotation,
        opacity: opacity,
        verticalAlignment: verticalAlignment,
        horizontalAlignment: horizontalAlignment,
        verticalOffset: verticalOffset,
        horizontalOffset: horizontalOffset,
        isFront: isFront,
        isTilePage: isTilePage,
        horizontalSpacing: horizontalSpacing,
        verticalSpacing: verticalSpacing,
      );