Class: Component

Component

Members

(non-null) attributes :Object.<string, string>

A mapping of attribute name to attribute value.
Type:
  • Object.<string, string>

(nullable) capacitance :string

Type:
  • string

(non-null) connections :Array.<up.api.core.Connection>

The connections of the component
Type:

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

@private
Type:
Inherited From:

(nullable) dataSheetURL :string

Type:
  • string

footprint_parameters :Object.<string, string>

An object representing the parameters used to generate the footprint.
Type:
  • Object.<string, string>

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

The x,y coords of the footprint.
Type:

footprint_rotation :number

The rotation of the footprint in degrees.
Type:
  • number

footprint_side :string

The side of the board the footprint is on.
Type:
  • string

(nullable) genericFootprintType :string

Type:
  • string

hasFootprint :boolean

True if the component has an associated footprint.
Type:
  • boolean

importedFromFile :boolean

Type:
  • boolean

importedFromOctopart :boolean

Type:
  • boolean

(nullable) inductance :string

Type:
  • string

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:

(nullable) leadFree :boolean

Type:
  • boolean

(nullable) manufacturer :string

Type:
  • string

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

Type:
Inherited From:

(nullable) octopartPartNumber :string

Type:
  • string

(nullable) packaging :string

Type:
  • string

(non-null) part :up.api.core.Part

The Part that this component is based off of.
Type:

(nullable) partNumber :string

Type:
  • string

(nullable) refDes :string

Type:
  • string

(nullable) resistance :string

Type:
  • string

(nullable) RoHS :boolean

Type:
  • boolean

(non-null) sketch_symbols :Array.<up.api.sketch.Symbol>

The schematic symbols for this component instance.
Type:

symbol_variant_idx :number

Type:
  • number

Methods

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:

getConnectionType(connectionIdx) → (nullable) {string}

Determines connection type.
Parameters:
Name Type Description
connectionIdx number The connection index to look up.
Returns:
The connection type (digital/analog). Null if unspecified.
Type
string

isNet(netName) → {boolean}

Returns true <=> the object is in the provided net.
Parameters:
Name Type Description
netName string
Inherited From:
Returns:
Type
boolean

isValid() → {boolean}

This:
Returns:
Type
boolean

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

openDatasheet()

This:

setAttribute(keynon-null, opt_valopt)

This:
Parameters:
Name Type Attributes Description
key string The key to set the attribute on.
opt_val string <optional>
 The value to set on the attribute.