sch_place_dblib_component
Places a DbLib part on a schematic sheet at specified coordinates using a database row key, verifying the part's database link upon placement.
Instructions
Place one database library (DbLib) part on a schematic sheet.
Acts on a .SchDoc: the active sheet, or sheet_path. The part
is built by Altium from the database row (symbol, footprints and
parameters, with its database link) and dropped at (x, y). NOT
INTERACTIVE: nothing is attached to the cursor and nothing waits
for a click.
THE DbLib MUST BE AVAILABLE TO ALTIUM. Altium finds a DbLib part
by the library's file name among its available libraries, so the
DbLib has to be installed (lib_install_library) or in the
project. The call refuses before touching the sheet when it is
not, or when table is not one the DbLib declares.
database_linked reads the placed part's DatabaseTableName
back: True means the part carries its database link, False that
Altium built it without one. lib_reference is the symbol it
used.
Do not draw a schematic part by part with this. A sheet comes from a DesignPlan through design_execute_plan; this is for adding a part a person picked from their company library.
Args:
library_path: Full path of the .DbLib file.
table: A table the DbLib declares.
key: The row's key value (key in a lib_dblib_search
result).
x, y: Location in mils.
rotation: 0, 90, 180 or 270.
designator: Optional designator to stamp on the part.
sheet_path: Optional .SchDoc path; default the active sheet.
part_id: Which part of a multi-part component to place, from
1 (A). Left out, Altium's default part is placed.
Returns:
{"placed", "library_path", "table", "key", "lib_reference",
"database_table", "database_linked", "x", "y", "rotation",
"part_id", "part_count", "part_id_applied", "designator"}.
part_id is read back off the placed part; a part_id
above part_count is not applied and
part_id_applied says so.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | Yes | ||
| y | Yes | ||
| key | Yes | ||
| table | Yes | ||
| part_id | No | ||
| rotation | No | ||
| designator | No | ||
| sheet_path | No | ||
| library_path | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||