PDF PCB Print (Portable Document Format) Deprecated

Exports the PCB to the most common exchange format. Suitable for printing. This is the main format to document your PCB.
This output is what you get from the ‘File/Print’ menu in pcbnew.
The pcb_print is usually a better alternative.
If you use custom fonts and/or colors please consult the resources_dir global variable.

Type: pdf_pcb_print

Category: PCB/docs

Parameters:

  • comment : [string=’’] A comment for documentation purposes. It helps to identify the output.

  • dir : [string=’./’] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.

  • layers : [list(dict)|list(string)|string] [all,selected,copper,technical,user,inners,outers] List of PCB layers to include in the PDF.

    • Valid keys:

      • description : [string=’’] A description for the layer, for documentation purposes. A default can be specified using the layer_defaults global option.

      • layer : [string=’’] Name of the layer. As you see it in KiCad.

      • suffix : [string=’’] Suffix used in file names related to this layer. Derived from the name if not specified. A default can be specified using the layer_defaults global option.

  • name : [string=’’] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.

  • options : [dict] Options for the pdf_pcb_print output.

    • Valid keys:

      • plot_sheet_reference : [boolean=true] Include the title-block.

      • scaling : [number=1.0] Scale factor (0 means autoscaling). You should disable plot_sheet_reference when using it.

      • separated : [boolean=false] Print layers in separated pages.

      • color_theme : [string=’_builtin_classic’] Selects the color theme. Onlyu applies to KiCad 6. To use the KiCad 6 default colors select _builtin_default. Usually user colors are stored as user, but you can give it another name.

      • dnf_filter : [string|list(string)=’_none’] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.

      • drill_marks : [string=’full’] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale).

      • force_edge_cuts : [boolean=true] Only useful for KiCad 6 when printing in one page, you can disable the edge here. KiCad 5 forces it by default, and you can’t control it from config files. Same for KiCad 6 when printing to separated pages.

      • hide_excluded : [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant. Affected by global options.

      • mirror : [boolean=false] Print mirrored (X axis inverted). ONLY for KiCad 6.

      • monochrome : [boolean=false] Print in black and white.

      • output : [string=’%f-%i%I%v.%x’] Filename for the output PDF (%i=layers, %x=pdf). Affected by global options.

      • output_name : Alias for output.

      • pre_transform : [string|list(string)=’_none’] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.

      • title : [string=’’] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.

      • variant : [string=’’] Board variant to apply.

  • type : ‘pdf_pcb_print’

  • category : [string|list(string)=’’] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.

  • disable_run_by_default : [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don’t want to generate the original. Use the boolean true value to disable the output you are extending.

  • extends : [string=’’] Copy the options section from the indicated output. Used to inherit options from another output of the same type.

  • groups : [string|list(string)=’’] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.

  • output_id : [string=’’] Text to use for the %I expansion content. To differentiate variations of this output.

  • priority : [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.

  • run_by_default : [boolean=true] When enabled this output will be created when no specific outputs are requested.