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 retrievable at present through the diagnostic accessors |
DroppedCount | Diagnostic records thrown away because the retention budget was exhausted |
TrackedBounds | Placement rectangles registered for tracking and overlap detection |
DroppedBounds | Rectangles discarded once MaxTrackedBounds had been reached |
OverlapComparisons | Pairwise rectangle comparisons performed, against MaxOverlapComparisons |
OverlapCount | Overlaps actually picked up by the comparisons |
OverlaysDrawn | Diagnostic overlays rendered onto pages |
LivePreviewNotifications | Notifications emitted whilst live preview was enabled |
Usage notes
- Read it with
THotPDF.GetLayoutDiagnosticStatisticsafter a layout run to confirm the diagnostics budget proved sufficient - A non-zero
DroppedCountorDroppedBoundsmeans reporting was incomplete: raise the limits inTHPDFLayoutDiagnosticOptionsand run the layout again - Compare
OverlapCountagainstOverlapComparisonsto judge how fruitful the detection pass was