IBoMOptions parameters

• board_rotation : [number] (default: 0) Board rotation in degrees (-180 to 180). Will be rounded to multiple of 5.

• bom_view : [string] (default: 'left-right') (choices: “bom-only”, “left-right”, “top-bottom”) Default BOM view.

• extra_fields : [string] (default: '') Comma separated list of extra fields to pull from netlist or xml file. Using ‘X,Y’ is a shortcut for show_fields and group_fields with values ‘Value,Footprint,X,Y’.

• include_tracks : [boolean] (default: false) Include track/zone information in output. F.Cu and B.Cu layers only.

• layer_view : [string] (default: 'FB') (choices: “F”, “FB”, “B”) Default layer view.

• normalize_field_case : [boolean] (default: false) Normalize extra field name case. E.g. ‘MPN’ and ‘mpn’ will be considered the same field.

• output : [string] (default: '%f-%i%I%v.%x') Filename for the output, use ‘’ to use the IBoM filename (%i=ibom, %x=html). Affected by global options.

• show_fields : [string] (default: '') Comma separated list of fields to show in the BOM. Value and Footprint are displayed when nothing is specified.

• blacklist : [string] (default: '') List of comma separated blacklisted components or prefixes with . E.g. ‘X1,MH’. IBoM option, avoid using in conjunction with KiBot variants/filters.

• blacklist_empty_val : [boolean] (default: false) Blacklist components with empty value. IBoM option, avoid using in conjunction with KiBot variants/filters.

• checkboxes : [string] (default: 'Sourced,Placed') Comma separated list of checkbox columns.

• dark_mode : [boolean] (default: false) Default to dark mode.

• 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.
  Avoid using it in conjunction with IBoM native filtering options.

• dnp_field : [string] (default: '') Name of the extra field that indicates do not populate status. Components with this field not empty will be blacklisted.
  IBoM option, avoid using in conjunction with KiBot variants/filters.

• 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.

• extra_data_file : [string] (default: '') Path to netlist or xml file. You can use ‘%F.xml’ to avoid specifying the project name. Leave it blank for most uses, data will be extracted from the PCB.

• forced_name : [string] (default: '') Name to be used for the PCB/project (no file extension). This will affect the name iBoM displays in the generated HTML.

• group_fields : [string] (default: '') Comma separated list of fields that components will be grouped by. Value and Footprint are used when nothing is specified.

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

• hide_pads : [boolean] (default: false) Hide footprint pads by default.

• hide_silkscreen : [boolean] (default: false) Hide silkscreen by default.

• highlight_pin1 : [boolean | string] (default: false) (choices: “none”, “all”, “selected”) Highlight pin1 by default.

• include_nets : [boolean] (default: false) Include netlist information in output..

• mark_when_checked : [string] (default: '') Name of the checkbox column used to mark components when checked. When enabled components checked in this column will be displayed in green.
  Leave empty to disable it.
  Needs iBoM newer than 2.10.0.
  .

• name_format : [string] (default: 'ibom') Output file name format supports substitutions: %f : original pcb file name without extension.
  %p : pcb/project title from pcb metadata.
  %c : company from pcb metadata.
  %r : revision from pcb metadata.
  %d : pcb date from metadata if available, file modification date otherwise.
  %D : bom generation date.
  %T : bom generation time.
  Extension .html will be added automatically.
  Note that this name is used only when output is ‘’.

• netlist_file : Alias for extra_data_file.

• no_blacklist_virtual : [boolean] (default: false) Do not blacklist virtual components. IBoM option, avoid using in conjunction with KiBot variants/filters.

• no_compression : [boolean] (default: false) Disable compression of pcb data.

• no_redraw_on_drag : [boolean] (default: false) Do not redraw pcb on drag by default.

• offset_back_rotation : [boolean] (default: false) Offset the back of the pcb by 180 degrees.

• 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.

• show_fabrication : [boolean] (default: false) Show fabrication layer by default.

• sort_order : [string] (default: 'C,R,L,D,U,Y,X,F,SW,A,~,HS,CNN,J,P,NT,MH') Default sort order for components. Must contain ‘~’ once.

• variant : [string] (default: '') Board variant to apply. Avoid using it in conjunction with IBoM native filtering options.

• variant_field : [string] (default: '') Name of the extra field that stores board variant for component. IBoM option, avoid using in conjunction with KiBot variants/filters.

• variants_blacklist : [string] (default: '') List of board variants to exclude from the BOM. IBoM option, avoid using in conjunction with KiBot variants/filters.

• variants_whitelist : [string] (default: '') List of board variants to include in the BOM. IBoM option, avoid using in conjunction with KiBot variants/filters.