pdftoolbox-js

pdfToolbox JavaScript guide

How "Arbitrary JavaScript controlled Checks" and "Arbitrary JavaScript controlled Fixups" work: the shape of the object you must hand back to pdfToolbox, the common parameters, the resource area, and the pdfToolbox 12 -> 13 property renames. Read this before writing such a Check or Fixup.

List Check property groups

List the groups every Check property id is prefixed with (DOC::, PAGE::, CSIMAGE::, SIFTER:: ...), with a description and the number of properties in each. Use as an entry point before searching.

Search Check properties

Search the base Check catalog. Matches property id, display name and description. Returns id, name, group, value type, default operator and the available operators for each hit.

Get a Check property

Full detail for one Check property: description, every operator it supports, and the parameters each operator adds to the condition (with defaults and allowed values). Also returns a ready to use condition object and a complete JavaScript snippet. Accepts "GROUP::Name" or just the name.

Get common Check parameters

The parameters every Check has besides its conditions (name, comment, custom_id, severity, condition_logic, invert, report_no_match, scope), with defaults and allowed values.

Build a Check as JavaScript

For "Include other check" (PAGE::BooleanCheck) and the Sifter properties, put the included Checks INLINE as Check objects in "checks" (each with a name); a JavaScript based Check cannot be referenced by name, only a native Check that exists in the profile can. Assemble one or more Checks and return them as JSON plus ready to paste JavaScript, wrapped in the "checks" array pdfToolbox expects (a single script may define several Checks). For one Check pass "conditions" and its common parameters dir

Validate a Check configuration

Validate a hand written Check configuration against the base Check catalog, including Checks nested inline in "checks" (Include other check, Sifter). Accepts the two shapes a script may evaluate to - {"checks":[...]} (fully specified) or {"condition_logic","conditions"} (inline; name and settings come from the Check editor) - as an object, JSON, or the pasted JavaScript. Reports unknown properties/operators/parameters, illegal values and legacy names.

List / search Fixups

List the base Fixups. Matches Fixup id, name and description. Each hit reports whether the Fixup supports several configurations (config as an array) and how many parameters it has.

Get a Fixup

Full detail for one Fixup: every parameter with label, value type, default and allowed values (including nested configuration blocks), which parameters reference a resource, plus the default configuration object and a ready to paste JavaScript snippet.

Search Fixup parameters

Find a parameter by name or label across all Fixups (or inside one Fixup). Useful when you know the setting you want ("resolution", "spot color", "bleed") but not which Fixup provides it.

Build a Fixup configuration as JavaScript

Assemble the configuration object for one or more Fixups and return it as JSON plus ready to paste JavaScript. Parameters you do not set keep their catalog default. Values are validated, duplicate Fixup types are rejected, and referenced resources are reported. To apply a Fixup only to certain objects, give a parameter marked has_apply_to an INLINE Check - { "name": "...", "condition_logic": "and", "conditions": [...] } - and always give it a "name": it is required here, because a nameless Check

Validate a Fixup configuration

Validate a hand written Fixup configuration object ({ "<fixup_id>": { "config": ... } }) against the base Fixup catalog, as an object or a JSON string. Reports unknown Fixups and parameters, illegal values, wrong config shape (array vs object) and legacy property names.

Search real-world examples

Search the Checks and Fixups exported from the profiles that ship with pdfToolbox - real, working configurations covering common prepress tasks. Use them as patterns: they show how properties are combined, how "Include other check" and Sifter conditions reference other Checks, and how Fixups are applied to objects found by a Check. Filter by property id or Fixup id to see how a specific feature is used in practice.

Get a real-world example

Return one shipped Check or Fixup in full - the exact configuration pdfToolbox uses - plus the same thing as ready to paste JavaScript. Look it up by id (the file name) or by its exact name, as returned by search_examples.