Class: PCB

Members

(non-null) activeLayer :up.api.pcb.Layer

Type:

• up.api.pcb.Layer

(non-null) allTheThings :Array.<Object>

Type:

• Array.<Object>

(non-null) boardOutlines :Array.<up.api.pcb.Path>

Type:

• Array.<up.api.pcb.Path>

(non-null) boardSize :up.api.core.Point

Type:

• up.api.core.Point

(non-null) camera :Array.<up.api.common.Camera>

Type:

• Array.<up.api.common.Camera>

(non-null) copperLayers :Array.<up.api.pcb.Layer>

Type:

• Array.<up.api.pcb.Layer>

ctx_ :up.api.Context|up.api.ComponentContext

@private

Type:

• up.api.Context | up.api.ComponentContext

Inherited From:

• up.api.core.ProxyObject#ctx_

(non-null) displayedNets :Array.<string>

Type:

• Array.<string>

(non-null) hiddenNets :Array.<string>

Type:

• Array.<string>

(non-null) hover :Object.<string, !Array.<!up.api.core.ProxyObject>>

Type:

• Object.<string, !Array.<!up.api.core.ProxyObject>>

isFootprint :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isFootprint

isPadstack :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isPadstack

isPlatedThroughHole :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isPlatedThroughHole

isPour :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isPour

isTrace :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isTrace

isVia :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isVia

(non-null) layers :Array.<up.api.pcb.Layer>

Type:

• Array.<up.api.pcb.Layer>

(non-null) nets :Array.<up.api.core.Net>

Type:

• Array.<up.api.core.Net>

Inherited From:

• up.api.core.ProxyObject#nets

(non-null) padstacks :Array.<up.api.pcb.Padstack>

Type:

• Array.<up.api.pcb.Padstack>

(non-null) platedThroughHoles :Array.<up.api.pcb.PlatedThroughHole>

Type:

• Array.<up.api.pcb.PlatedThroughHole>

(non-null) pours :Array.<up.api.pcb.Pour>

Type:

• Array.<up.api.pcb.Pour>

(non-null) selection :Object.<string, !Array.<!up.api.core.ProxyObject>>

Type:

• Object.<string, !Array.<!up.api.core.ProxyObject>>

(non-null) traces :Array.<up.api.pcb.Trace>

Type:

• Array.<up.api.pcb.Trace>

(non-null) vias :Array.<up.api.pcb.Via>

Type:

• Array.<up.api.pcb.Via>

Methods

closeCheckAndCall(toCall) → {function}

Parameters:

Name	Type	Description
toCall	function

Inherited From:

• up.api.core.ProxyObject#closeCheckAndCall

Returns:

Type

function

defineGetAndSetFunctions(propertyName, getFunction, setFunction)

Parameters:

Name	Type	Description
propertyName	string
getFunction	function
setFunction	function

Inherited From:

• up.api.core.ProxyObject#defineGetAndSetFunctions

defineGetFunction(propertyName, getFunction)

Parameters:

Name	Type	Description
propertyName	string
getFunction	function

Inherited From:

• up.api.core.ProxyObject#defineGetFunction

deleteLayer(layernon-null)

Parameters:

Name	Type	Description
layer	up.api.pcb.Layer	The layer to remove.

deleteSelection()

Delete the selection.

isNet(netName) → {boolean}

Returns true <=> the object is in the provided net.

Parameters:

Name	Type	Description
netName	string

Inherited From:

• up.api.core.ProxyObject#isNet

Returns:

Type

boolean

isValid() → {boolean}

This:

• {!up.api.pcb.PCB}

Returns:

Type

boolean

moveSelection(startLocnon-null, targetLocnon-null)

This:

• {!up.api.pcb.PCB}

Parameters:

Name	Type	Description
startLoc	up.api.core.Point
targetLoc	up.api.core.Point

onLayer(layer) → {boolean}

Returns true <=> the pcb object is on the provided layer. Default False for proxyobjects.

Parameters:

Name	Type	Description
layer	string

Inherited From:

• up.api.core.ProxyObject#onLayer

Returns:

Type

boolean

selectAll()

Select all things.

showAllNets()

Show all nets.

showOnlyNet(netNamenon-null)

Parameters:

Name	Type	Description
netName	up.design.NetName	The name of the net to show.