sch_place_vault_components
Place multiple managed Workspace components on a schematic sheet in one call using Design Item IDs and coordinates, keeping each part linked to its Workspace item.
Instructions
Place MANY managed (Workspace) components in ONE call.
sch_place_components for parts that live in an Altium
Workspace rather than a library file. Such a part has no library
path; it is placed by its Design Item ID and stays linked to its
Workspace item. The hand-drawing rule of sch_place_components
applies here too: four or more parts onto a sheet with two or
fewer is refused unless allow_manual_layout=True.
A part number is not looked up here, so bring the Design Item ID.
lib_get_vault_component checks one without placing it.
Args:
placements: List of dicts, each with "design_item_id"
(required), x and y in mils, and optionally
designator and rotation (0, 90, 180 or 270).
vault: The Workspace name, for the whole batch. Usually left
out: it is read off managed parts already on an open
sheet of the design, where Altium wrote it. When no open
sheet has one, the call is refused and says what to do.
Ask the user for the name rather than making one up.
document_path: Absolute path of the .SchDoc to place onto. It
is focused first; without it the active sheet is used,
and a sheet just created is not active yet.
lib_identifier_kind: The identifier kind to load by, 4
(VaultName) when left out. lib_get_vault_component
reports the kind that loaded.
allow_manual_layout: Place onto a near-empty sheet anyway.
Returns:
placed, linked, failed, total, vault,
lib_identifier_kind, loader_callable, note and one
items entry per placement. linked counts the parts
that read back a VaultGUID and ItemGUID, the link the file
saves; a part placed but not linked is a plain copy of the
symbol (reason PLACED_WITHOUT_LINK). NOT_FOUND_IN_VAULT
means that ID did not load; LOAD_RAISED means this Altium
cannot load managed parts at all.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vault | No | ||
| placements | Yes | ||
| document_path | No | ||
| allow_manual_layout | No | ||
| lib_identifier_kind | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||