Preparing search index...
The search index is not available
@tscircuit/builder
@tscircuit/builder
ConstrainedLayoutBuilderClass
Class ConstrainedLayoutBuilderClass
Hierarchy
GroupBuilderClass
ConstrainedLayoutBuilderClass
Implements
ConstrainedLayoutBuilder
Index
Constructors
constructor
Properties
addables
builder_
type
components
constraints
groups
name
project_
builder
traces
Methods
add
add
Bug
add
Capacitor
add
Component
add
Constraint
add
Diode
add
Ground
add
Group
add
Inductor
add
Power
Source
add
Resistor
add
Trace
append
Child
build
reset
set
Name
Constructors
constructor
new
Constrained
Layout
Builder
Class
(
project_builder
?:
ProjectBuilder
)
:
ConstrainedLayoutBuilderClass
Parameters
Optional
project_builder:
ProjectBuilder
Returns
ConstrainedLayoutBuilderClass
Properties
addables
addables
:
{
bug
:
(
(
project_builder
:
ProjectBuilder
)
=>
BugBuilder
)
;
capacitor
:
(
(
project_builder
:
ProjectBuilder
)
=>
CapacitorBuilder
)
;
component
:
(
(
project_builder
:
ProjectBuilder
)
=>
GenericComponentBuilder
)
;
diode
:
(
(
project_builder
:
ProjectBuilder
)
=>
DiodeBuilder
)
;
generic_component
:
(
(
project_builder
:
ProjectBuilder
)
=>
GenericComponentBuilder
)
;
ground
:
(
(
project_builder
:
ProjectBuilder
)
=>
GroundBuilder
)
;
group
:
(
(
project_builder
?:
ProjectBuilder
)
=>
GroupBuilder
)
;
inductor
:
(
(
project_builder
:
ProjectBuilder
)
=>
InductorBuilder
)
;
power_source
:
(
(
project_builder
:
ProjectBuilder
)
=>
PowerSourceBuilder
)
;
resistor
:
(
(
project_builder
:
ProjectBuilder
)
=>
ResistorBuilder
)
;
trace
:
(
(
project_builder
:
ProjectBuilder
)
=>
TraceBuilder
)
}
Type declaration
bug
:
(
(
project_builder
:
ProjectBuilder
)
=>
BugBuilder
)
(
project_builder
:
ProjectBuilder
)
:
BugBuilder
Parameters
project_builder:
ProjectBuilder
Returns
BugBuilder
capacitor
:
(
(
project_builder
:
ProjectBuilder
)
=>
CapacitorBuilder
)
(
project_builder
:
ProjectBuilder
)
:
CapacitorBuilder
Parameters
project_builder:
ProjectBuilder
Returns
CapacitorBuilder
component
:
(
(
project_builder
:
ProjectBuilder
)
=>
GenericComponentBuilder
)
(
project_builder
:
ProjectBuilder
)
:
GenericComponentBuilder
Parameters
project_builder:
ProjectBuilder
Returns
GenericComponentBuilder
diode
:
(
(
project_builder
:
ProjectBuilder
)
=>
DiodeBuilder
)
(
project_builder
:
ProjectBuilder
)
:
DiodeBuilder
Parameters
project_builder:
ProjectBuilder
Returns
DiodeBuilder
generic_
component
:
(
(
project_builder
:
ProjectBuilder
)
=>
GenericComponentBuilder
)
(
project_builder
:
ProjectBuilder
)
:
GenericComponentBuilder
Parameters
project_builder:
ProjectBuilder
Returns
GenericComponentBuilder
ground
:
(
(
project_builder
:
ProjectBuilder
)
=>
GroundBuilder
)
(
project_builder
:
ProjectBuilder
)
:
GroundBuilder
Parameters
project_builder:
ProjectBuilder
Returns
GroundBuilder
group
:
(
(
project_builder
?:
ProjectBuilder
)
=>
GroupBuilder
)
(
project_builder
?:
ProjectBuilder
)
:
GroupBuilder
This uses an old construction pattern that's been tested.
Parameters
Optional
project_builder:
ProjectBuilder
Returns
GroupBuilder
inductor
:
(
(
project_builder
:
ProjectBuilder
)
=>
InductorBuilder
)
(
project_builder
:
ProjectBuilder
)
:
InductorBuilder
Parameters
project_builder:
ProjectBuilder
Returns
InductorBuilder
power_
source
:
(
(
project_builder
:
ProjectBuilder
)
=>
PowerSourceBuilder
)
(
project_builder
:
ProjectBuilder
)
:
PowerSourceBuilder
Parameters
project_builder:
ProjectBuilder
Returns
PowerSourceBuilder
resistor
:
(
(
project_builder
:
ProjectBuilder
)
=>
ResistorBuilder
)
(
project_builder
:
ProjectBuilder
)
:
ResistorBuilder
Parameters
project_builder:
ProjectBuilder
Returns
ResistorBuilder
trace
:
(
(
project_builder
:
ProjectBuilder
)
=>
TraceBuilder
)
(
project_builder
:
ProjectBuilder
)
:
TraceBuilder
Parameters
project_builder:
ProjectBuilder
Returns
TraceBuilder
builder_
type
builder_
type
:
"group_builder"
= "group_builder"
components
components
:
BaseComponentBuilder
<
any
>
[]
constraints
constraints
:
ConstraintBuilder
[]
= []
groups
groups
:
GroupBuilder
[]
name
name
:
string
project_
builder
project_
builder
:
ProjectBuilder
traces
traces
:
TraceBuilder
[]
Methods
add
add
(
builder_type
:
any
, callback
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
builder_type:
any
callback:
any
Returns
ConstrainedLayoutBuilderClass
add
Bug
add
Bug
(
cb
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
cb:
any
Returns
ConstrainedLayoutBuilderClass
add
Capacitor
add
Capacitor
(
cb
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
cb:
any
Returns
ConstrainedLayoutBuilderClass
add
Component
add
Component
(
cb
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
cb:
any
Returns
ConstrainedLayoutBuilderClass
add
Constraint
add
Constraint
(
props
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
props:
any
Returns
ConstrainedLayoutBuilderClass
add
Diode
add
Diode
(
cb
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
cb:
any
Returns
ConstrainedLayoutBuilderClass
add
Ground
add
Ground
(
cb
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
cb:
any
Returns
ConstrainedLayoutBuilderClass
add
Group
add
Group
(
gb
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
gb:
any
Returns
ConstrainedLayoutBuilderClass
add
Inductor
add
Inductor
(
cb
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
cb:
any
Returns
ConstrainedLayoutBuilderClass
add
Power
Source
add
Power
Source
(
cb
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
cb:
any
Returns
ConstrainedLayoutBuilderClass
add
Resistor
add
Resistor
(
cb
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
cb:
any
Returns
ConstrainedLayoutBuilderClass
add
Trace
add
Trace
(
tb
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
tb:
any
Returns
ConstrainedLayoutBuilderClass
append
Child
append
Child
(
child
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
child:
any
Returns
ConstrainedLayoutBuilderClass
build
build
(
bc
:
any
)
:
Promise
<
any
[]
>
Parameters
bc:
any
Returns
Promise
<
any
[]
>
reset
reset
(
)
:
ConstrainedLayoutBuilderClass
Returns
ConstrainedLayoutBuilderClass
set
Name
set
Name
(
name
:
any
)
:
ConstrainedLayoutBuilderClass
Parameters
name:
any
Returns
ConstrainedLayoutBuilderClass
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
@tscircuit/builder
Constrained
Layout
Builder
Class
constructor
addables
builder_
type
components
constraints
groups
name
project_
builder
traces
add
add
Bug
add
Capacitor
add
Component
add
Constraint
add
Diode
add
Ground
add
Group
add
Inductor
add
Power
Source
add
Resistor
add
Trace
append
Child
build
reset
set
Name
Generated using
TypeDoc
This uses an old construction pattern that's been tested.