SubPCBOptions parameters

  • name : [string] (default: '') Name for this sub-pcb.

  • ref : Alias for reference.

  • reference : [string] (default: '') Use it for the annotations method. This is the reference for the kikit:Board footprint used to identify the sub-PCB.
    Note that you can use any footprint as long as its position is inside the PCB outline.
    When empty the sub-PCB is specified using a rectangle.

  • bottom_right_x : Alias for brx.

  • bottom_right_y : Alias for bry.

  • brx : [number | string] The X position of the bottom right corner for the rectangle that contains the sub-PCB.

  • bry : [number | string] The Y position of the bottom right corner for the rectangle that contains the sub-PCB.

  • center_result : [boolean] (default: true) Move the resulting PCB to the center of the page. You can disable it only for the internal tool, KiKit should always do it.

  • file_id : [string] (default: '') Text to use as the replacement for %v expansion. When empty we use the parent file_id plus the name of the sub-PCB.

  • ref_layer : [string] (default: 'Edge.Cuts') Layer where the PCB outline indicated by reference is found. So you can use an outline that is not the real PCB contour.

  • strip_annotation : [boolean] (default: false) Remove the annotation footprint. Note that KiKit will remove all annotations, but the internal implementation just the one indicated by ref.
    If you need to remove other annotations use an exclude filter.

  • tlx : [number | string] The X position of the top left corner for the rectangle that contains the sub-PCB.

  • tly : [number | string] The Y position of the top left corner for the rectangle that contains the sub-PCB.

  • tolerance : [number | string] Used to enlarge the selected rectangle to include elements outside the board. KiCad 5: To avoid rounding issues this value is set to 0.000002 mm when 0 is specified.

  • tool : [string] (default: 'internal') (choices: “internal”, “kikit”) Tool used to extract the sub-PCB..

  • top_left_x : Alias for tlx.

  • top_left_y : Alias for tly.

  • units : [string] (default: 'mm') (choices: “millimeters”, “inches”, “mils”, “mm”, “cm”, “dm”, “m”, “mil”, “inch”, “in”) Units used when omitted.