Class: Hole

Members

attachedNetName :string

Type:

• string

(non-null) ctx_ :up.api.Context

@private

Type:

• up.api.Context

Inherited From:

• up.api.pcb.PcbObject#ctx_

isFootprint :boolean

Type:

• boolean

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>

(non-null) obj_ :up.design.pcb.Pour|up.design.pcb.TraceSegment|up.design.pcb.Path|up.genObj.GeneratedObject|up.design.pcb.LayoutElementBody|up.pcb.Flood

@private

Type:

• up.design.pcb.Pour | up.design.pcb.TraceSegment | up.design.pcb.Path | up.genObj.GeneratedObject | up.design.pcb.LayoutElementBody | up.pcb.Flood

Inherited From:

• up.api.pcb.PcbObject#obj_

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

Position, in nanometers.

Type:

• up.api.core.Point

rotation :number

Type:

• number

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

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}

Inherited From:

• up.api.core.ProxyObject#isValid

Returns:

Type

boolean

onLayer(layer) → {boolean}

Returns true <=> the pcb object is on the provided layer.

This:

• {!up.api.pcb.PcbObject}

Parameters:

Name	Type	Description
layer	string

Inherited From:

• up.api.pcb.PcbObject#onLayer

Returns:

Type

boolean