KiCanvasOptions parameters

  • local_script : [boolean] (default: true) Download the script and use a copy.

  • source : [string | list(string)] (choices: “schematic”, “pcb”, “project”) Source to display.

  • controls : [string] (default: 'full') (choices: “full”, “basic”, “none”) Which controls are displayed.

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

  • download : [boolean] (default: true) Show the download button.

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

  • overlay : [boolean] (default: true) Show the overlay asking to click.

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

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

  • url_script : [string] (default: 'https://kicanvas.org/kicanvas/kicanvas.js') URL for the KiCanvas script.

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