Skip to content

.NET API

BeadApi

Pierced bead (the ArtisanBead tool).

from ArtisanPlugin.Scripting import BeadApi

See also the guide, Accessories › Bead, and the Python package, ra.bead.

Methods

Method
Createprofile is “SQUARE” (default) or “ROUND”.

Create

Guid BeadApi.Create(
    Plane? plane = null,
    double width = 0,
    double height = 0,
    double holeDiameter = 0,
    string profile = null,
    string element = null)

profile is “SQUARE” (default) or “ROUND”. Defaults: width 10, height 10, holeDiameter 3. element = name of a saved Bead element (ElementsApi.List(“Bead”)) to start from; explicit arguments override it.

ParameterTypeDefault
planePlane?null
widthdouble0
heightdouble0
holeDiameterdouble0
profilestringnull
elementstringnull

Returns Guid.