.. Automatically generated by KiBot, please don't edit this file .. index:: pair: IBoM (Interactive HTML BoM); ibom IBoM (Interactive HTML BoM) ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Generates an interactive web page useful to identify the position of the components in the PCB. For more information: https://github.com/INTI-CMNB/InteractiveHtmlBom This output is what you get from the InteractiveHtmlBom plug-in (pcbnew). |br| Type: ``ibom`` Categories: **Schematic/BoM**, **PCB/fabrication/assembly** Parameters: - **comment** :index:`: ` [string=''] A comment for documentation purposes. It helps to identify the output. - **dir** :index:`: ` [string='./'] Output directory for the generated files. If it starts with `+` the rest is concatenated to the default dir. - **name** :index:`: ` [string=''] Used to identify this particular output definition. Avoid using `_` as first character. These names are reserved for KiBot. - **options** :index:`: ` [dict] Options for the `ibom` output. - Valid keys: - **board_rotation** :index:`: ` [number=0] Board rotation in degrees (-180 to 180). Will be rounded to multiple of 5. - **bom_view** :index:`: ` [string='left-right'] [bom-only,left-right,top-bottom] Default BOM view. - **extra_fields** :index:`: ` [string=''] 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** :index:`: ` [boolean=false] Include track/zone information in output. F.Cu and B.Cu layers only. - **layer_view** :index:`: ` [string='FB'] [F,FB,B] Default layer view. - **normalize_field_case** :index:`: ` [boolean=false] Normalize extra field name case. E.g. 'MPN' and 'mpn' will be considered the same field. - **output** :index:`: ` [string='%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** :index:`: ` [string=''] Comma separated list of fields to show in the BOM. Value and Footprint are displayed when nothing is specified. - ``blacklist`` :index:`: ` [string=''] 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`` :index:`: ` [boolean=false] Blacklist components with empty value. IBoM option, avoid using in conjunction with KiBot variants/filters. - ``checkboxes`` :index:`: ` [string='Sourced,Placed'] Comma separated list of checkbox columns. - ``dark_mode`` :index:`: ` [boolean=false] Default to dark mode. - ``dnf_filter`` :index:`: ` [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. Avoid using it in conjunction with IBoM native filtering options. - ``dnp_field`` :index:`: ` [string=''] 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. - ``extra_data_file`` :index:`: ` [string=''] 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`` :index:`: ` [string=''] Name to be used for the PCB/project (no file extension). This will affect the name iBoM displays in the generated HTML. - ``group_fields`` :index:`: ` [string=''] Comma separated list of fields that components will be grouped by. Value and Footprint are used when nothing is specified. - ``hide_excluded`` :index:`: ` [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant. Affected by global options. - ``hide_pads`` :index:`: ` [boolean=false] Hide footprint pads by default. - ``hide_silkscreen`` :index:`: ` [boolean=false] Hide silkscreen by default. - ``highlight_pin1`` :index:`: ` [boolean|none,all,selected] Highlight pin1 by default. - ``include_nets`` :index:`: ` [boolean=false] Include netlist information in output.. - ``name_format`` :index:`: ` [string='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* :index:`: ` Alias for extra_data_file. - ``no_blacklist_virtual`` :index:`: ` [boolean=false] Do not blacklist virtual components. IBoM option, avoid using in conjunction with KiBot variants/filters. - ``no_compression`` :index:`: ` [boolean=false] Disable compression of pcb data. - ``no_redraw_on_drag`` :index:`: ` [boolean=false] Do not redraw pcb on drag by default. - ``offset_back_rotation`` :index:`: ` [boolean=false] Offset the back of the pcb by 180 degrees. - ``pre_transform`` :index:`: ` [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. - ``show_fabrication`` :index:`: ` [boolean=false] Show fabrication layer by default. - ``sort_order`` :index:`: ` [string='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`` :index:`: ` [string=''] Board variant to apply. Avoid using it in conjunction with IBoM native filtering options. - ``variant_field`` :index:`: ` [string=''] Name of the extra field that stores board variant for component. IBoM option, avoid using in conjunction with KiBot variants/filters. - ``variants_blacklist`` :index:`: ` [string=''] List of board variants to exclude from the BOM. IBoM option, avoid using in conjunction with KiBot variants/filters. - ``variants_whitelist`` :index:`: ` [string=''] List of board variants to include in the BOM. IBoM option, avoid using in conjunction with KiBot variants/filters. - **type** :index:`: ` [string=''] Type of output. - ``category`` :index:`: ` [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`` :index:`: ` [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`` :index:`: ` [string=''] Copy the `options` section from the indicated output. Used to inherit options from another output of the same type. - ``groups`` :index:`: ` [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`` :index:`: ` [string=''] Text to use for the %I expansion content. To differentiate variations of this output. - ``priority`` :index:`: ` [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`` :index:`: ` [boolean=true] When enabled this output will be created when no specific outputs are requested.