Image redactions

View as MarkdownMarkdown

Set up your AI agent

Give your coding agent live access to the GroupDocs documentation and API reference through the GroupDocs Docs MCP server — no install, no API key. Learn more

claude mcp add --transport http groupdocs-docs https://docs.groupdocs.com/mcp

Also process documents locally

The GroupDocs.Redaction MCP server lets your agent work with files on your machine; they are never uploaded. It needs the .NET 10 SDK or Docker.

claude mcp add groupdocs-redaction -- dnx GroupDocs.Redaction.Mcp --yes
Folders, licensing and more →

Redact image area

GroupDocs.Redaction provides features to redact sensitive data from images (JPG, PNG, TIFF, BMP, GIF, and others). See the full list in Supported document formats.

You can redact images both as separate files and as embedded images inside documents:

  • Put a colored box over a given area (header, footer, or a region where customer data appears).
  • Use a third-party OCR engine to search text on the image and redact matches.

You can also change image metadata (for example edit EXIF or act as an “EXIF eraser”) where the format exposes metadata.

For multi-page or layout-aware scenarios, combine image-area redaction with page filters (PageRangeFilter, PageAreaFilter). Coordinates follow the page (or visible image) placement when the bitmap size differs from the on-page shape.

Redact image area

In order to redact image area, you have to use ImageAreaRedaction class:

Node.js

const redaction = require('@groupdocs/groupdocs.redaction');
const java = require('java');
const Color = java.import('java.awt.Color');
const Dimension = java.import('java.awt.Dimension');
const Point = java.import('java.awt.Point');

const redactor = new redaction.Redactor('D:\\test.jpg');
try 
{
    //Define the position on image
const samplePoint = new Point(385, 485);
    //Define the size of the area which need to be redacted
const sampleSize = new Dimension(1793, 2069);
    //Perform redaction
const result = redactor.apply(new redaction.ImageAreaRedaction(samplePoint,
        new redaction.RegionReplacementOptions(Color.BLUE, sampleSize)));
    if (result.getStatus() !== redaction.RedactionStatus.Failed)
    {
       //The redacted output will save as PDF 
       redactor.save();
    };
}
finally {
  redactor.close();
}

sample.jpg is the sample file used in this example. Click here to download it.

Binary file (PDF, 2.6 MB)

Download full output

If the redaction cannot be applied to this type of files, e.g. MS Word document without embedded images, RedactorChangeLog.getStatus() will be RedactionStatus.Skipped.

Redact recognized text from an image

To enable OCR-processing and search for a text using regular expressions, you have to implement IOcrConnector interface and pass the instance to RedactorSettings constructor. For more details, see OCR Usage Basics article.

Node.js

const redaction = require('@groupdocs/groupdocs.redaction');
const java = require('java');
const Color = java.import('java.awt.Color');

const redactor = new redaction.Redactor('D:\\test.jpg', new redaction.LoadOptions(), new redaction.RedactorSettings(new MyCustomOcrConnector()));
try {
const result = redactor.apply(new redaction.RegexRedaction('\\d{4}', new redaction.ReplacementOptions(Color.BLUE)));
   if (result.getStatus() !== redaction.RedactionStatus.Failed)
   {
      redactor.save();
   };

} finally {
  redactor.close();
}

sample.jpg is the sample file used in this example. Click here to download it.

In the example above MyCustomOcrConnector class implements IOcrConnector interface.

Clean image metadata

GroupDocs.Redaction for Node.js via Java allows you to change image metadata (e.g. edit EXIF data of an image or act as an “EXIF eraser”).

The following example demonstrates how to edit exif data (erase them) from a photo or any other image:

const redaction = require('@groupdocs/groupdocs.redaction');

const redactor = new redaction.Redactor('D:\\photo.jpg');
try 
{
const result = redactor.apply(new redaction.EraseMetadataRedaction(redaction.MetadataFilters.All));
    if (result.getStatus() !== redaction.RedactionStatus.Failed)
    {
       //The redacted output will save as PDF 
       redactor.save();
    };
}
finally {
  redactor.close();
}

sample.jpg is the sample file used in this example. Click here to download it.

Binary file (PDF, 4.3 MB)

Download full output

If the redaction cannot be applied to this type of files, e.g. BMP image, RedactorChangeLog.getStatus() will be RedactionStatus.Skipped.

Redact embedded images

You can redact image area within all kinds of embedded images inside a document. You can both use ImageAreaRedaction class and any type of TextRedaction (regular expression, exact phrase), if the OCR is enabled in RedactorSettings (see OCR Usage Basics article).

The following example demonstrates how to redact all embedded images within a Microsoft Word document:

const redaction = require('@groupdocs/groupdocs.redaction');
const java = require('java');
const Color = java.import('java.awt.Color');
const Dimension = java.import('java.awt.Dimension');
const Point = java.import('java.awt.Point');

const redactor = new redaction.Redactor('D:\\sample.docx');
try 
{
const samplePoint = new Point(516, 311);
const sampleSize = new Dimension(170, 35);
const result = redactor.apply(new redaction.ImageAreaRedaction(samplePoint,
        new redaction.RegionReplacementOptions(Color.BLUE, sampleSize)));
    if (result.getStatus() !== redaction.RedactionStatus.Failed)
    {
        redactor.save();
    };
}
finally {
  redactor.close();
}

sample.docx is the sample file used in this example. Click here to download it.

Binary file (PDF, 1010 KB)

Download full output

If the redaction cannot be applied to this type of files, e.g. a spreadsheet document, RedactorChangeLog.getStatus() will be RedactionStatus.Skipped.

To limit image redaction to a page range or rectangle, set filters on ReplacementOptions or use PageAreaRedaction.

Multi-frame images

You can remove frames from a multi-frame image with a given origin and frame count. For additional information look at remove page redactions article.

Some image formats, such as DjVu documents, require pre-rasterization and further saving in PDF format.