NamedPendantApi

Name pendant (the ArtisanNamedPendant tool): a written name as a solid pendant, editable afterwards (smart component with parameter user data).

from ArtisanPlugin.Scripting import NamedPendantApi

See also the guide, Accessories › Named pendant, and the Python package, ra.named_pendant.

Methods

Method
Create	Defaults: font Arial bold, height 5, thickness 0.4, spacing 0.5.

Create

IReadOnlyList<Guid> NamedPendantApi.Create(
    string text,
    Plane? plane = null,
    double height = 0,
    double thickness = 0,
    string font = null,
    string element = null)

Defaults: font Arial bold, height 5, thickness 0.4, spacing 0.5. Returns the ids of the created breps (letters + plate/rail). element = name of a saved NamedPendant element (ElementsApi.List(“NamedPendant”)) to start from; text and the explicit arguments override it.

Parameter	Type	Default
text	string	required
plane	Plane?	null
height	double	0
thickness	double	0
font	string	null
element	string	null

Returns IReadOnlyList<Guid>.