Interface GroundBuilder

Hierarchy

BaseComponentBuilder<GroundBuilder>
- GroundBuilder

Implemented by

GroundBuilderClass

Index

Properties

builder_type footprint ports project_builder schematic_symbol setName setTag setTags

Methods

appendChild build labelPort modifyFootprint setFootprint setFootprintCenter setSchematicCenter setSchematicProperties setSchematicRotation setSourceProperties

Properties

builder_type

builder_type: "ground_builder"

footprint

footprint: FootprintBuilder

ports

ports: PortsBuilder

project_builder

project_builder: ProjectBuilder

schematic_symbol

schematic_symbol: SchematicSymbolBuilder

setName

setName: ((name: string) => BaseComponentBuilder<GroundBuilder>)

Type declaration

- (name: string): BaseComponentBuilder<GroundBuilder>
- Parameters
  - name: string
  Returns BaseComponentBuilder<GroundBuilder>

setTag

setTag: ((tag: string) => BaseComponentBuilder<GroundBuilder>)

Type declaration

- (tag: string): BaseComponentBuilder<GroundBuilder>
- Parameters
  - tag: string
  Returns BaseComponentBuilder<GroundBuilder>

setTags

setTags: ((tags: string[]) => BaseComponentBuilder<GroundBuilder>)

Type declaration

- (tags: string[]): BaseComponentBuilder<GroundBuilder>
- Parameters
  - tags: string[]
  Returns BaseComponentBuilder<GroundBuilder>

Methods

appendChild

appendChild(child: { builder_type: string }): BaseComponentBuilder<GroundBuilder>
Parameters
- child: { builder_type: string }
  - builder_type: string
Returns BaseComponentBuilder<GroundBuilder>
Inherited from BaseComponentBuilder.appendChild
- Defined in lib/builder/component-builder/ComponentBuilder.ts:30

build

build(build_context: BuildContext): Promise<AnyElement[]>
Parameters
- build_context: BuildContext
Returns Promise<AnyElement[]>
Inherited from BaseComponentBuilder.build
- Defined in lib/builder/component-builder/ComponentBuilder.ts:56

labelPort

labelPort(position: number, name: string): BaseComponentBuilder<GroundBuilder>
Parameters
- position: number
- name: string
Returns BaseComponentBuilder<GroundBuilder>
Inherited from BaseComponentBuilder.labelPort
- Defined in lib/builder/component-builder/ComponentBuilder.ts:55

modifyFootprint

modifyFootprint(cb: ((fb: FootprintBuilder) => any)): BaseComponentBuilder<GroundBuilder>
Parameters
- cb: ((fb: FootprintBuilder) => any)
  - - (fb: FootprintBuilder): any
    - Parameters
      
      fb: FootprintBuilder
      
      Returns any
Returns BaseComponentBuilder<GroundBuilder>
Inherited from BaseComponentBuilder.modifyFootprint
- Defined in lib/builder/component-builder/ComponentBuilder.ts:54

setFootprint

setFootprint(fp: string | FootprintBuilder): BaseComponentBuilder<GroundBuilder>
Parameters
- fp: string | FootprintBuilder
Returns BaseComponentBuilder<GroundBuilder>
Inherited from BaseComponentBuilder.setFootprint
- Defined in lib/builder/component-builder/ComponentBuilder.ts:53

setFootprintCenter

setFootprintCenter(x: string | number, y: string | number): BaseComponentBuilder<GroundBuilder>
Parameters
- x: string | number
- y: string | number
Returns BaseComponentBuilder<GroundBuilder>
Inherited from BaseComponentBuilder.setFootprintCenter
- Defined in lib/builder/component-builder/ComponentBuilder.ts:49

setSchematicCenter

setSchematicCenter(x: string | number, y: string | number): BaseComponentBuilder<GroundBuilder>
Parameters
- x: string | number
- y: string | number
Returns BaseComponentBuilder<GroundBuilder>
Inherited from BaseComponentBuilder.setSchematicCenter
- Defined in lib/builder/component-builder/ComponentBuilder.ts:39

setSchematicProperties

setSchematicProperties(properties: Partial<SchematicComponent>): BaseComponentBuilder<GroundBuilder>
Parameters
- properties: Partial<SchematicComponent>
Returns BaseComponentBuilder<GroundBuilder>
Inherited from BaseComponentBuilder.setSchematicProperties
- Defined in lib/builder/component-builder/ComponentBuilder.ts:46

setSchematicRotation

setSchematicRotation(rotation: number | `${number}deg`): BaseComponentBuilder<GroundBuilder>
Parameters
- rotation: number | `${number}deg`
Returns BaseComponentBuilder<GroundBuilder>
Inherited from BaseComponentBuilder.setSchematicRotation
- Defined in lib/builder/component-builder/ComponentBuilder.ts:43

setSourceProperties

setSourceProperties(properties: Except<SimpleGround, "ftype" | "type" | "name" | "source_component_id"> & { name?: string }): GroundBuilder
Parameters
- properties: Except<SimpleGround, "ftype" | "type" | "name" | "source_component_id"> & { name?: string }
Returns GroundBuilder
Overrides BaseComponentBuilder.setSourceProperties
- Defined in lib/builder/component-builder/GroundBuilder.ts:12

Generated using TypeDoc