add_layout_component_definition

Modeler3D.add_layout_component_definition(file_path: str | Path, name: str = '') → str

Add a layout submodel definition to the design.

Parameters:

file_pathstr

Path to the submodel definition file.

namestr, optional

Name to assign to the submodel definition. Default is an empty string.

Returns:

bool

True if the submodel definition was added successfully, False otherwise.

Examples

>>> from ansys.aedt.core.modeler.cad.primitives_3d import Primitives3D
>>> obj = Primitives3D()
>>> obj.add_layout_component_definition(file_path="example.txt")