options.md

Data Section Options

This file was automatically generated by scripts/docs.py on Tue Apr 15 08:28:35 2025

Scope :ANNOTATION

Option	Value	Description	Default
font	str	Text font	'sans-serif'

Inherits scale from: DataConsumer

Scope :ANNOTATION OR :ANNOTATION-LINE

Option	Value	Description	Default
font	str	Text font	'sans-serif'

Inherits scale from: DataConsumer

Component :COMPONENT OR :BATTERY

Reference Designators: B, BT, BAT

Option	Value	Description	Default
value	str	Battery voltage	required
capacity	str	Battery capacity in amp-hours	(no value)

Inherits values from: PolarizedTwoTerminalComponent

Component :COMPONENT OR :CAPACITOR

Reference Designators: C

Option	Value	Description	Default
value	str	Capacitance in farads	required
voltage	str	Maximum voltage tolerance in volts	(no value)

Inherits values from: PolarizedTwoTerminalComponent

Scope :COMPONENT

Option	Value	Description	Default
offset_scale	float	How far to offset the label from the center of the component. Relative to the global scale option.	1
font	str	Text font for labels	'monospace'

Inherits values from: DataConsumer

Component :COMPONENT OR :DIODE

Reference Designators: D, CR

Option	Value	Description	Default
part-number	str	The manufacturer-specified part number (e.g. NE555P, 2N7000, L293D, ATtiny85, etc.)	required

Inherits values from: PolarizedTwoTerminalComponent, SiliconComponent

Scope :ROOT

Option	Value	Description	Default
padding	float	Margin around the border of the drawing	10

Inherits scale from: DataConsumer

Component :COMPONENT OR :INDUCTOR

Reference Designators: L

Option	Value	Description	Default
value	str	Inductance in henries	required
current	str	Maximum current rating in amps	(no value)

Inherits values from: PolarizedTwoTerminalComponent

Component :COMPONENT OR :DIODE OR D OR CR

Reference Designators: LED, IR

Option	Value	Description	Default
part-number	str	The manufacturer-specified part number (e.g. NE555P, 2N7000, L293D, ATtiny85, etc.)	required

Inherits values from: PolarizedTwoTerminalComponent, SiliconComponent

Scope :NET

Option	Value	Description	Default
scale	float	Scale by which to enlarge the entire diagram by	15
linewidth	float	Width of drawn lines	2
color	str	Default color for everything	'black'

Component :COMPONENT OR :RESISTOR

Reference Designators: R

Option	Value	Description	Default
value	str	Resistance in ohms	required
wattage	str	Maximum power dissipation in watts (i.e. size of the resistor)	(no value)

Inherits values from: TwoTerminalComponent

Component :COMPONENT OR :VARIABLE OR :CAPACITOR OR C

Reference Designators: VC, CV

Option	Value	Description	Default
value	str	Capacitance in farads	required
voltage	str	Maximum voltage tolerance in volts	(no value)

Inherits values from: PolarizedTwoTerminalComponent

Component :COMPONENT OR :VARIABLE OR :INDUCTOR OR L

Reference Designators: VL, LV

Option	Value	Description	Default
value	str	Inductance in henries	required
current	str	Maximum current rating in amps	(no value)

Inherits values from: PolarizedTwoTerminalComponent

Component :COMPONENT OR :VARIABLE OR :RESISTOR OR R

Reference Designators: VR, RV

Option	Value	Description	Default
value	str	Resistance in ohms	required
wattage	str	Maximum power dissipation in watts (i.e. size of the resistor)	(no value)

Inherits values from: TwoTerminalComponent

Scope :WIRE

Option	Value	Description	Default
scale	float	Scale by which to enlarge the entire diagram by	15
linewidth	float	Width of drawn lines	2
color	str	Default color for everything	'black'

Scope :WIRE-TAG

Option	Value	Description	Default
scale	float	Scale by which to enlarge the entire diagram by	15
linewidth	float	Width of drawn lines	2
color	str	Default color for everything	'black'