getWatermark method

Future<CPDFWatermark?> getWatermark(
  1. int index, {
  2. bool exportImage = false,
})

Gets the watermark at index.

Parameters:
index - The watermark index.
exportImage - Whether to export image watermark bitmap to a cache file.

Returns: The watermark, or null if index is out of range.

Since v2.6.8

example:

final CPDFWatermark? watermark =
    await controller.document.getWatermark(0, exportImage: true);

if (watermark != null) {
  print('Watermark type: ${watermark.type.name}');
  print('Watermark pages: ${watermark.pages}');
  print('Exported image path: ${watermark.imagePath}');
}

Implementation

Future<CPDFWatermark?> getWatermark(
  int index, {
  bool exportImage = false,
}) async {
  final result = await _channel.invokeMethod('get_watermark', {
    'index': index,
    'export_image': exportImage,
  });
  _debugPrintWatermarkData('getWatermark result', result);
  if (result is! Map) {
    return null;
  }
  return CPDFWatermark.fromJson(Map<String, dynamic>.from(result));
}