SVGOptions parameters

  • output : [string] (default: '%f-%i%I%v.%x') Output file name, the default KiCad name if empty.

Note

KiCad will always create the file using its own name and then we can rename it.

For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options.

  • plot_sheet_reference : [boolean] (default: false) Include the frame and title block. Only available for KiCad 6+ and you get a poor result (i.e. always the default worksheet style, also problems expanding text variables).
    The pcb_print output can do a better job for PDF, SVG, PS, EPS and PNG outputs.

  • scaling : [number] (default: 1) Scale factor (0 means autoscaling).

  • custom_reports : [CustomReport parameters] [list(dict)] (default: []) A list of customized reports for the manufacturer.

  • dnf_filter : [string | list(string)] (default: '_null') Name of the filter to mark components as not fitted. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • drill_marks : [string] (default: 'full') (choices: “none”, “small”, “full”) What to use to indicate the drill places, can be none, small or full (for real scale).

  • edge_cut_extension : [string] (default: '') Used to configure the edge cuts layer extension for Protel mode. Include the dot.

  • exclude_edge_layer : [boolean] (default: true) Do not include the PCB edge layer.

  • exclude_filter : [string | list(string)] (default: '_null') Name of the filter to exclude components from processing. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • exclude_pads_from_silkscreen : [boolean] (default: false) Do not plot the component pads in the silk screen (KiCad 5.x only).

  • force_plot_invisible_refs_vals : [boolean] (default: false) Include references and values even when they are marked as invisible. Not available on KiCad 9.0.1 and newer.

  • individual_page_scaling : [boolean] (default: true) Tell KiCad to apply the scaling for each layer as a separated entity. Disabling it the pages are coherent and can be superposed.

  • inner_extension_pattern : [string] (default: '') Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number.
    Example ‘.g%n’.

Note

this numbering is consistent and the first inner layer is %n = 1 and %N = 2. Which

isn’t true for KiCad. KiCad 8 uses 2 for the first inner and KiCad 9 uses 1.

  • limit_viewbox : [boolean] (default: false) When enabled the view box is limited to a selected area. This option can’t be enabled when using a scale.

  • line_width : [number] (default: 0.25) (range: 0.02 to 2) For objects without width [mm] (KiCad 5).

  • margin : [PcbMargin parameters] [number | dict] (default: 0) Margin around the view box [mm]. Using a number the margin is the same in the four directions.
    See limit_viewbox option.

  • mirror_plot : [boolean] (default: false) Plot mirrored.

  • negative_plot : [boolean] (default: false) Invert black and white.

  • plot_footprint_refs : [boolean] (default: true) Include the footprint references.

  • plot_footprint_values : [boolean] (default: true) Include the footprint values.

  • pre_transform : [string | list(string)] (default: '_null') Name of the filter to transform fields before applying other filters. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • size_detection : [string] (default: 'kicad_edge') (choices: “kicad_edge”, “kicad_all”) Method used to detect the size of the view box. The kicad_edge method uses the size of the board as reported by KiCad, components that extend beyond the PCB limit will be cropped. You can manually adjust the margin to make them visible.
    The kicad_all method uses the whole size reported by KiCad. Usually includes extra space.
    See limit_viewbox option.

  • sketch_pad_line_width : [number] (default: 0.1) Line width for the sketched pads [mm], see sketch_pads_on_fab_layers (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9).

  • sketch_pads_on_fab_layers : [boolean] (default: false) Draw only the outline of the pads on the \*.Fab layers (KiCad 6+).

  • svg_precision : [number] (default: 4) (range: 0 to 6) Scale factor used to represent 1 mm in the SVG (KiCad 6). The value is how much zeros has the multiplier (1 mm = 10 power svg_precision units).
    Note that for an A4 paper Firefox 91 and Chrome 105 can’t handle more than 5.

  • tent_vias : [boolean] (default: true) Cover the vias. Usable for KiCad versions older than 9.

Warning

KiCad 8 has a bug that ignores this option. Set it from KiCad GUI.

  • uppercase_extensions : [boolean] (default: false) Use uppercase names for the extensions.

  • use_aux_axis_as_origin : [boolean] (default: false) Use the auxiliary axis as origin for coordinates.

  • variant : [string] (default: '') Board variant to apply.

Used dicts