Preparing search index...
The search index is not available
@tscircuit/builder
@tscircuit/builder
GroundBuilderClass
Class GroundBuilderClass
Hierarchy
ComponentBuilderClass
GroundBuilderClass
Implements
GroundBuilder
Index
Constructors
constructor
Properties
builder_
type
footprint
name
ports
project_
builder
schematic_
position
schematic_
properties
schematic_
rotation
schematic_
symbol
source_
properties
tags
Methods
append
Child
build
label
Port
modify
Footprint
setFType
set
Footprint
set
Footprint
Center
set
Name
set
Schematic
Center
set
Schematic
Properties
set
Schematic
Rotation
set
Source
Properties
set
Tag
set
Tags
Constructors
constructor
new
Ground
Builder
Class
(
project_builder
:
ProjectBuilder
)
:
GroundBuilderClass
Parameters
project_builder:
ProjectBuilder
Returns
GroundBuilderClass
Properties
builder_
type
builder_
type
:
"ground_builder"
= ...
footprint
footprint
:
FootprintBuilder
name
name
:
string
= null
ports
ports
:
PortsBuilder
project_
builder
project_
builder
:
ProjectBuilder
schematic_
position
schematic_
position
:
Point
= ...
schematic_
properties
schematic_
properties
:
any
= {}
schematic_
rotation
schematic_
rotation
:
number
= 0
schematic_
symbol
schematic_
symbol
:
SchematicSymbolBuilder
source_
properties
source_
properties
:
any
= {}
tags
tags
:
string
[]
= []
Methods
append
Child
append
Child
(
child
:
any
)
:
GroundBuilderClass
Parameters
child:
any
Returns
GroundBuilderClass
build
build
(
bc
:
BuildContext
)
:
Promise
<
AnyElement
[]
>
Parameters
bc:
BuildContext
Returns
Promise
<
AnyElement
[]
>
label
Port
label
Port
(
position
:
any
, name
:
any
)
:
GroundBuilderClass
Parameters
position:
any
name:
any
Returns
GroundBuilderClass
modify
Footprint
modify
Footprint
(
fn
:
any
)
:
GroundBuilderClass
Parameters
fn:
any
Returns
GroundBuilderClass
setFType
setFType
(
ftype
:
string
)
:
GroundBuilderClass
Parameters
ftype:
string
Returns
GroundBuilderClass
set
Footprint
set
Footprint
(
fp
:
string
|
FootprintBuilder
)
:
GroundBuilderClass
Parameters
fp:
string
|
FootprintBuilder
Returns
GroundBuilderClass
set
Footprint
Center
set
Footprint
Center
(
x
:
any
, y
:
any
)
:
GroundBuilderClass
Parameters
x:
any
y:
any
Returns
GroundBuilderClass
set
Name
set
Name
(
name
:
any
)
:
GroundBuilderClass
Parameters
name:
any
Returns
GroundBuilderClass
set
Schematic
Center
set
Schematic
Center
(
x
:
any
, y
:
any
)
:
GroundBuilderClass
Parameters
x:
any
y:
any
Returns
GroundBuilderClass
set
Schematic
Properties
set
Schematic
Properties
(
props
:
any
)
:
GroundBuilderClass
Parameters
props:
any
Returns
GroundBuilderClass
set
Schematic
Rotation
set
Schematic
Rotation
(
rotation
:
any
)
:
GroundBuilderClass
Parameters
rotation:
any
Returns
GroundBuilderClass
set
Source
Properties
set
Source
Properties
(
props
:
SimpleGround
)
:
GroundBuilderClass
Parameters
props:
SimpleGround
Returns
GroundBuilderClass
set
Tag
set
Tag
(
tag
:
any
)
:
GroundBuilderClass
Parameters
tag:
any
Returns
GroundBuilderClass
set
Tags
set
Tags
(
tags
:
any
)
:
GroundBuilderClass
Parameters
tags:
any
Returns
GroundBuilderClass
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
@tscircuit/builder
Ground
Builder
Class
constructor
builder_
type
footprint
name
ports
project_
builder
schematic_
position
schematic_
properties
schematic_
rotation
schematic_
symbol
source_
properties
tags
append
Child
build
label
Port
modify
Footprint
setFType
set
Footprint
set
Footprint
Center
set
Name
set
Schematic
Center
set
Schematic
Properties
set
Schematic
Rotation
set
Source
Properties
set
Tag
set
Tags
Generated using
TypeDoc