Class: ComponentGlobal

ComponentGlobal

Top-level global for the API

Members

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

@private
Type:
Inherited From:

isFootprint :boolean

Type:
  • boolean
Inherited From:

isPadstack :boolean

Type:
  • boolean
Inherited From:

isPlatedThroughHole :boolean

Type:
  • boolean
Inherited From:

isPour :boolean

Type:
  • boolean
Inherited From:

isTrace :boolean

Type:
  • boolean
Inherited From:

isVia :boolean

Type:
  • boolean
Inherited From:

(non-null) localUser :up.api.common.User

Type:

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

Type:
Inherited From:

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:
Returns:
Type
function

defineGetAndSetFunctions(propertyName, getFunction, setFunction)

Parameters:
Name Type Description
propertyName string
getFunction function
setFunction function
Inherited From:

defineGetFunction(propertyName, getFunction)

Parameters:
Name Type Description
propertyName string
getFunction function
Inherited From:

isNet(netName) → {boolean}

Returns true <=> the object is in the provided net.
Parameters:
Name Type Description
netName string
Inherited From:
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:
Returns:
Type
boolean