Pdfviewer - CommentFilterSettings

30 Sep 20261 minute to read

The CommentFilterSettings module is used to provide filter configuration for comments and annotations.

Properties

applyToDocument boolean

Apply filtering to both comment panel and document annotations.

  • false: Comment Panel only (default)
  • true: Comment Panel + Document annotations

Defaults to false

author string[]

Filter by comment author name.

Defaults to null

color string[]

Filter by annotation color (hex or named).
Examples: ‘#FF0000’, ‘red’, ‘#FFC000’

Defaults to null

includeReplies boolean

When author filtering is active, include reply threads by any author or only parent author.

  • true: Show threads if parent OR any reply matches author filter
  • false: Show threads only if parent matches author filter

Defaults to true

modifiedDate string[]

Filter by collection of specific modified dates (ISO 8601).
Format: [‘2026-05-01’, ‘2026-05-04’, ‘2026-05-10’]
Annotations matching any date in the collection are shown.

Defaults to null

status CommentStatus

Filter by comment status.

Defaults to ‘None’

type AnnotationType

Filter by annotation type.
Supported values: ‘Highlight’, ‘StickNote’, ‘Rectangle’, ‘Circle’,
‘Polygon’, ‘Polyline’, ‘Line’, ‘Arrow’, ‘FreeText’, ‘Measure’, ‘Stamp’, ‘Ink’, ‘Redaction’, ‘Signature’, ‘InkSignature’

Defaults to ‘None’