Skip to content

Reference

phil/print-preflight
TypeKindRole
Phil\PrintPreflight\Preflightfinal readonly classRuns the checks on a document against a profile and returns the report
Phil\PrintPreflight\PrintProfilefinal readonly classWhat a printer asks of a file, and the severity of each rule for it
Phil\PrintPreflight\ColourWorkflowenumCMYK or RGB
Phil\PrintPreflight\Documentfinal readonly classThe pages of a document and the fonts it prints with
Phil\PrintPreflight\Pagefinal readonly classA trim size, a bleed, images and boxes
Phil\PrintPreflight\PlacedImagefinal readonly classA raster image placed on a page, its effective resolution, ink coverage and transparency
Phil\PrintPreflight\Boxfinal readonly classAny other element placed on a page, its ink coverage, overprint, line width and transparency
Phil\PrintPreflight\UsedFontfinal readonly classA font, its embedding permissions from phil/fonts, whether it is embedded and subset
Phil\PrintPreflight\ColourSpaceenumGray, RGB, CMYK or spot; read from a PDF colour space name
Phil\PrintPreflight\Lengthfinal readonly classA length in points, from millimetres, inches or CSS pixels; described in millimetres or points
Phil\PrintPreflight\Sizefinal readonly classA trim size
Phil\PrintPreflight\Rectanglefinal readonly classThe frame of an element from the top left corner of the trim box; from PDF coordinates
Phil\PrintPreflight\EdgeenumTop, right, bottom, left
Phil\PrintPreflight\Reportfinal readonly classThe findings, document first then page by page
Phil\PrintPreflight\Findingfinal readonly classOne finding: severity, code, sentence, page, subject, parameters
Phil\PrintPreflight\SeverityenumError, warning, notice
Phil\PrintPreflight\RuleenumThe codes of the built-in rules and their default severities
Phil\PrintPreflight\Check\CheckinterfaceOne family of rules
Phil\PrintPreflight\Check\PageCountfinal readonly classThe page count against the minimum, maximum and multiple
Phil\PrintPreflight\Check\PageGeometryfinal readonly classTrim sizes and bleeds
Phil\PrintPreflight\Check\Fontsfinal readonly classEmbedding and embedding permissions of fonts
Phil\PrintPreflight\Check\ImageResolutionfinal readonly classEffective resolution of images
Phil\PrintPreflight\Check\Coloursfinal readonly classColour spaces against the workflow
Phil\PrintPreflight\Check\InkCoveragefinal readonly classTotal ink coverage of images and flat colours
Phil\PrintPreflight\Check\Overprintfinal readonly classElements set to overprint
Phil\PrintPreflight\Check\Transparencyfinal readonly classElements drawn with transparency
Phil\PrintPreflight\Check\Hairlinesfinal readonly classLines thinner than the printer reproduces
Phil\PrintPreflight\Check\Placementfinal readonly classElements against the trim box, the safety margin and the bleed
Phil\PrintPreflight\Exception\PrintPreflightExceptioninterfaceEvery exception of the library
Phil\PrintPreflight\Exception\InvalidDocumentfinal classA document description that cannot be checked
Phil\PrintPreflight\Exception\InvalidProfilefinal classA profile whose rules contradict each other