Class ProjectClass

Representation of a project with more utilities

Hierarchy

ProjectClass

Index

Constructors

Properties

Methods

get getElements getRelated getSourceComponent getSourcePort getSourceTrace

Constructors

constructor

new ProjectClass(project: Project): ProjectClass
Parameters
- project: Project
Returns ProjectClass
- Defined in lib/project/project-class.ts:22

Properties

project

project: Project

Methods

get

get(id: string): AnyElement
Parameters
- id: string
Returns AnyElement
- Defined in lib/project/project-class.ts:28

getElements

getElements(): AnyElement[]
Returns AnyElement[]
- Defined in lib/project/project-class.ts:25

getRelated

getRelated<T>(type: T, id: string): ElementOfType<T>[]
Type Parameters
- T extends "source_component" | "schematic_config" | "source_config" | "schematic_group" | "schematic_box" | "schematic_line" | "schematic_drawing" | "schematic_component" | "schematic_trace" | "schematic_text" | "schematic_port" | "pcb_trace" | "pcb_via" | "pcb_plated_hole" | "pcb_hole" | "pcb_smtpad" | "pcb_drill" | "pcb_component" | "pcb_port" | "pcb_group" | "pcb_config" | "source_trace" | "source_group" | "source_port" | "project"
Parameters
- type: T
- id: string
Returns ElementOfType<T>[]
- Defined in lib/project/project-class.ts:31

getSourceComponent

getSourceComponent(id: string): SourceComponent<"simple_resistor" | "simple_capacitor" | "simple_inductor" | "simple_diode" | "simple_bug" | "simple_power_source" | "simple_ground">
Parameters
- id: string
Returns SourceComponent<"simple_resistor" | "simple_capacitor" | "simple_inductor" | "simple_diode" | "simple_bug" | "simple_power_source" | "simple_ground">
- Defined in lib/project/project-class.ts:41

getSourcePort

getSourcePort(id: string): SourcePort
Parameters
- id: string
Returns SourcePort
- Defined in lib/project/project-class.ts:46

getSourceTrace

getSourceTrace(id: string): SourceTrace
Parameters
- id: string
Returns SourceTrace
- Defined in lib/project/project-class.ts:49

Generated using TypeDoc