THPDFLayoutDiagnosticStatistics Record

Counters describing what the layout diagnostic machinery retained, dropped, compared, detected, drew, and notified

Declaration

THPDFLayoutDiagnosticStatistics= record
  RetainedCount: Integer;
  DroppedCount: Integer;
  TrackedBounds: Int64;
  DroppedBounds: Int64;
  OverlapComparisons: Int64;
  OverlapCount: Int64;
  OverlaysDrawn: Int64;
  LivePreviewNotifications: Int64;
end;

Unit

HPDFDoc

Fields

Field	Purpose
`RetainedCount`	Diagnostic records currently retrievable through the diagnostic accessors
`DroppedCount`	Diagnostic records discarded because the retention budget was exhausted
`TrackedBounds`	Placement rectangles registered for tracking and overlap detection
`DroppedBounds`	Rectangles discarded because `MaxTrackedBounds` was reached
`OverlapComparisons`	Pairwise rectangle comparisons performed, against `MaxOverlapComparisons`
`OverlapCount`	Overlaps actually detected by the comparisons
`OverlaysDrawn`	Diagnostic overlays rendered onto pages
`LivePreviewNotifications`	Notifications emitted while live preview was enabled

Usage notes

Read it with THotPDF.GetLayoutDiagnosticStatistics after a layout run to confirm the diagnostics budget was sufficient
A nonzero DroppedCount or DroppedBounds means reporting was incomplete: raise the limits in THPDFLayoutDiagnosticOptions and rerun
Compare OverlapCount against OverlapComparisons to judge how productive the detection pass was

THPDFLayoutDiagnosticStatistics Record

Declaration

Unit

Fields

Usage notes

Related APIs