Class: ComponentGlobal

Members

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

@private

Type:

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

Inherited From:

• up.api.core.ProxyObject#ctx_

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) localUser :up.api.common.User

Type:

• up.api.common.User

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

Type:

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

Inherited From:

• up.api.core.ProxyObject#nets

Methods

(static) create(workspacenon-null) → (non-null) {up.api.ComponentGlobal}

Parameters:

Name	Type	Description
workspace	up.workspace.Workspace

Returns:

A new API proxy with a new context.

Type

up.api.ComponentGlobal

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()

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